@opencx/mcp 1.15.2 → 1.15.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/schema.d.ts +427 -219
- package/dist/schema.d.ts.map +1 -1
- package/dist/server.spec.js +54 -0
- package/dist/server.spec.js.map +1 -1
- package/dist/tools/csat.d.ts.map +1 -1
- package/dist/tools/csat.js +44 -0
- package/dist/tools/csat.js.map +1 -1
- package/package.json +1 -1
package/dist/schema.d.ts
CHANGED
|
@@ -1019,6 +1019,30 @@ export interface paths {
|
|
|
1019
1019
|
patch?: never;
|
|
1020
1020
|
trace?: never;
|
|
1021
1021
|
};
|
|
1022
|
+
"/csat/settings": {
|
|
1023
|
+
parameters: {
|
|
1024
|
+
query?: never;
|
|
1025
|
+
header?: never;
|
|
1026
|
+
path?: never;
|
|
1027
|
+
cookie?: never;
|
|
1028
|
+
};
|
|
1029
|
+
/**
|
|
1030
|
+
* Get CSAT settings
|
|
1031
|
+
* @description Retrieve the CSAT settings for your organization: per-channel toggles plus the custom feedback-page and request-email template overrides (web_template_html, email_template_html, email_template_subject). A null template field means the default OpenCX design is used.
|
|
1032
|
+
*/
|
|
1033
|
+
get: operations["getCsatSettings"];
|
|
1034
|
+
put?: never;
|
|
1035
|
+
post?: never;
|
|
1036
|
+
delete?: never;
|
|
1037
|
+
options?: never;
|
|
1038
|
+
head?: never;
|
|
1039
|
+
/**
|
|
1040
|
+
* Update CSAT settings
|
|
1041
|
+
* @description Partially update the CSAT settings for your organization. Omitted keys are preserved; sending an explicit null (or a whitespace-only string) for a template field clears it back to the default OpenCX design. The web template must include a submit affordance (data-csat-score, data-csat-submit, or OpenCX.csat.submit(...)) and the email template must reference at least one rating link variable ({{score_link_1}}–{{score_link_5}} or {{csat_link}}), otherwise the request is rejected with 400.
|
|
1042
|
+
*/
|
|
1043
|
+
patch: operations["updateCsatSettings"];
|
|
1044
|
+
trace?: never;
|
|
1045
|
+
};
|
|
1022
1046
|
"/autopilot": {
|
|
1023
1047
|
parameters: {
|
|
1024
1048
|
query?: never;
|
|
@@ -4480,12 +4504,43 @@ export interface components {
|
|
|
4480
4504
|
})[];
|
|
4481
4505
|
};
|
|
4482
4506
|
FileUploadDto: {
|
|
4483
|
-
/**
|
|
4484
|
-
* Format: binary
|
|
4485
|
-
* @description The file to upload. 5MB max.
|
|
4486
|
-
*/
|
|
4507
|
+
/** Format: binary */
|
|
4487
4508
|
file: string;
|
|
4488
4509
|
} | null;
|
|
4510
|
+
UpdateCsatSettingsDto: {
|
|
4511
|
+
/** @description Whether CSAT collection is enabled for web channel */
|
|
4512
|
+
web_enabled?: boolean;
|
|
4513
|
+
/** @description Whether CSAT collection is enabled for email channel */
|
|
4514
|
+
email_enabled?: boolean;
|
|
4515
|
+
/** @description Whether CSAT collection is enabled for phone channel */
|
|
4516
|
+
phone_enabled?: boolean;
|
|
4517
|
+
/** @description Whether CSAT collection is enabled for WhatsApp channel */
|
|
4518
|
+
whatsapp_enabled?: boolean;
|
|
4519
|
+
/** @description Whether CSAT collection is enabled for SMS channel */
|
|
4520
|
+
sms_enabled?: boolean;
|
|
4521
|
+
/** @description Whether CSAT collection is enabled for Slack channel */
|
|
4522
|
+
slack_enabled?: boolean;
|
|
4523
|
+
/** @description Whether CSAT collection is enabled for API channel */
|
|
4524
|
+
api_enabled?: boolean;
|
|
4525
|
+
/** @description Whether CSAT collection is enabled for web voice channel */
|
|
4526
|
+
web_voice_enabled?: boolean;
|
|
4527
|
+
/** @description Whether CSAT collection is enabled for Instagram channel */
|
|
4528
|
+
instagram_enabled?: boolean;
|
|
4529
|
+
/** @description Whether CSAT collection is enabled for Facebook Messenger channel */
|
|
4530
|
+
messenger_enabled?: boolean;
|
|
4531
|
+
/** @description Custom message to display with CSAT request */
|
|
4532
|
+
custom_message?: string;
|
|
4533
|
+
/** @description Whether to automatically send CSAT after session closes */
|
|
4534
|
+
auto_send_on_close?: boolean;
|
|
4535
|
+
/** @description Delay in minutes before sending CSAT after session closes */
|
|
4536
|
+
send_delay_minutes?: number;
|
|
4537
|
+
/** @description Full-HTML template for the public CSAT feedback page. Null/empty clears it (default page). */
|
|
4538
|
+
web_template_html?: string | null;
|
|
4539
|
+
/** @description Full-HTML template for the CSAT request email. Null/empty clears it (default email). */
|
|
4540
|
+
email_template_html?: string | null;
|
|
4541
|
+
/** @description Subject line for the custom CSAT request email. Null falls back to the default. */
|
|
4542
|
+
email_template_subject?: string | null;
|
|
4543
|
+
};
|
|
4489
4544
|
CreateEmailTemplateBodyDto: {
|
|
4490
4545
|
body: string;
|
|
4491
4546
|
name: string;
|
|
@@ -5717,6 +5772,260 @@ export interface components {
|
|
|
5717
5772
|
url: string;
|
|
5718
5773
|
openai_file_id?: string;
|
|
5719
5774
|
};
|
|
5775
|
+
PhoneAgentDto: {
|
|
5776
|
+
id: string;
|
|
5777
|
+
org_id: string;
|
|
5778
|
+
phone_number: string | null;
|
|
5779
|
+
name: string | null;
|
|
5780
|
+
/** @enum {string} */
|
|
5781
|
+
type: "inbound" | "outbound";
|
|
5782
|
+
language: string[];
|
|
5783
|
+
accent: string | null;
|
|
5784
|
+
handoff_phone_number: string | null;
|
|
5785
|
+
speed: number | null;
|
|
5786
|
+
interruptible: boolean;
|
|
5787
|
+
actionIds: string[] | null;
|
|
5788
|
+
instructions: string[] | null;
|
|
5789
|
+
data_collection_fields: string[] | null;
|
|
5790
|
+
data_collection_webhook_url: string | null;
|
|
5791
|
+
/** @enum {string} */
|
|
5792
|
+
model: "oppie-vox" | "oppie-vox-turbo" | "oppie-vox-2" | "oppie-vox-livekit";
|
|
5793
|
+
voice_id: string | null;
|
|
5794
|
+
first_message: string | null;
|
|
5795
|
+
/** Format: date-time */
|
|
5796
|
+
created_at: string;
|
|
5797
|
+
/** Format: date-time */
|
|
5798
|
+
updated_at: string;
|
|
5799
|
+
provider_external_id: string | null;
|
|
5800
|
+
flow: unknown | null;
|
|
5801
|
+
custom_llm: string | null;
|
|
5802
|
+
use_org_knowledgebase: boolean;
|
|
5803
|
+
background_noise_preset: ("office" | "bar" | "city-street") | null;
|
|
5804
|
+
recording_enabled: boolean;
|
|
5805
|
+
stt_keyterms: string[];
|
|
5806
|
+
stt_model: ("deepgram/flux-general" | "deepgram/nova-3" | "deepgram/nova-3-medical" | "cartesia/ink-whisper" | "elevenlabs/scribe_v2_realtime" | "xai/stt-1" | "assemblyai/universal-3-5-pro" | "speechmatics/enhanced") | null;
|
|
5807
|
+
tts_speed_pct: number | null;
|
|
5808
|
+
failover_transfer_destination_id: string | null;
|
|
5809
|
+
};
|
|
5810
|
+
PhoneAgentVoiceDto: {
|
|
5811
|
+
voice_id: string;
|
|
5812
|
+
name: string;
|
|
5813
|
+
labels: {
|
|
5814
|
+
accent: string | null;
|
|
5815
|
+
description: string | null;
|
|
5816
|
+
age: string | null;
|
|
5817
|
+
gender: string | null;
|
|
5818
|
+
use_case: string | null;
|
|
5819
|
+
language: string | null;
|
|
5820
|
+
};
|
|
5821
|
+
description: string | null;
|
|
5822
|
+
preview_url: string | null;
|
|
5823
|
+
};
|
|
5824
|
+
PhoneCallEventDto: {
|
|
5825
|
+
/** Format: uuid */
|
|
5826
|
+
id: string;
|
|
5827
|
+
/** Format: uuid */
|
|
5828
|
+
phone_call_id: string;
|
|
5829
|
+
/** @enum {string} */
|
|
5830
|
+
event_type: "ring_started" | "ring_accepted" | "ring_declined" | "ring_missed" | "dial_started" | "customer_answered" | "human_joined" | "transfer_initiated" | "transfer_accepted" | "transfer_completed" | "transfer_cancelled" | "transfer_declined" | "call_ended" | "call_failed";
|
|
5831
|
+
actor_user_id: number | null;
|
|
5832
|
+
actor_name: string | null;
|
|
5833
|
+
detail: string | null;
|
|
5834
|
+
/** Format: date-time */
|
|
5835
|
+
created_at: string;
|
|
5836
|
+
};
|
|
5837
|
+
PhoneCallDto: {
|
|
5838
|
+
/** Format: uuid */
|
|
5839
|
+
id: string;
|
|
5840
|
+
session_id: string;
|
|
5841
|
+
/** @enum {string} */
|
|
5842
|
+
direction: "inbound" | "outbound";
|
|
5843
|
+
/** @enum {string} */
|
|
5844
|
+
status: "initiating" | "ringing" | "in_progress" | "completed" | "no_answer" | "busy" | "rejected" | "failed" | "missed" | "canceled";
|
|
5845
|
+
initiated_by_user_id: number | null;
|
|
5846
|
+
phone_agent_id: string | null;
|
|
5847
|
+
from_number: string | null;
|
|
5848
|
+
to_number: string | null;
|
|
5849
|
+
failure_reason: string | null;
|
|
5850
|
+
livekit_disconnect_reason: string | null;
|
|
5851
|
+
ring_started_at: string | null;
|
|
5852
|
+
ring_expires_at: string | null;
|
|
5853
|
+
accepted_by_user_id: number | null;
|
|
5854
|
+
answered_at: string | null;
|
|
5855
|
+
ended_at: string | null;
|
|
5856
|
+
ended_by_user_id: number | null;
|
|
5857
|
+
duration_seconds: number | null;
|
|
5858
|
+
ring_duration_seconds: number | null;
|
|
5859
|
+
recording_status: ("pending" | "completed" | "failed") | null;
|
|
5860
|
+
has_recording: boolean;
|
|
5861
|
+
is_session_latest_call: boolean;
|
|
5862
|
+
/** Format: date-time */
|
|
5863
|
+
created_at: string;
|
|
5864
|
+
events: components["schemas"]["PhoneCallEventDto"][];
|
|
5865
|
+
};
|
|
5866
|
+
KnowledgeSourceTreeItemDto: {
|
|
5867
|
+
id: string;
|
|
5868
|
+
/** @description The scenario/title of the instruction */
|
|
5869
|
+
question: string;
|
|
5870
|
+
/** @description The content of the instruction */
|
|
5871
|
+
answer: string;
|
|
5872
|
+
directory_id: string | null;
|
|
5873
|
+
/** @description Whether this instruction is individually selected */
|
|
5874
|
+
selected: boolean;
|
|
5875
|
+
};
|
|
5876
|
+
KnowledgeSourceDirectoryDto: {
|
|
5877
|
+
id: string;
|
|
5878
|
+
name: string;
|
|
5879
|
+
items: components["schemas"]["KnowledgeSourceTreeItemDto"][];
|
|
5880
|
+
/** @description Whether the entire directory is selected (all current and future instructions included) */
|
|
5881
|
+
selected: boolean;
|
|
5882
|
+
};
|
|
5883
|
+
KnowledgeSourceTreeDto: {
|
|
5884
|
+
directories: components["schemas"]["KnowledgeSourceDirectoryDto"][];
|
|
5885
|
+
uncategorized: components["schemas"]["KnowledgeSourceTreeItemDto"][];
|
|
5886
|
+
/** @description Estimated tokens for all selected instructions */
|
|
5887
|
+
totalTokens: number;
|
|
5888
|
+
};
|
|
5889
|
+
UpdateKnowledgeSourcesResponseDto: {
|
|
5890
|
+
success: boolean;
|
|
5891
|
+
/** @description Estimated tokens for all selected instructions */
|
|
5892
|
+
totalTokens: number;
|
|
5893
|
+
};
|
|
5894
|
+
AgentWorkflowItemDto: {
|
|
5895
|
+
/** @description The logical workflow UUID */
|
|
5896
|
+
workflowId: string;
|
|
5897
|
+
/** @description Display name of the workflow */
|
|
5898
|
+
name: string;
|
|
5899
|
+
/** @description Description of the workflow */
|
|
5900
|
+
description: string | null;
|
|
5901
|
+
/** @description The goal of the workflow from AI trigger config */
|
|
5902
|
+
goal: string | null;
|
|
5903
|
+
/** @description Whether this workflow is selected for the agent */
|
|
5904
|
+
selected: boolean;
|
|
5905
|
+
};
|
|
5906
|
+
AgentWorkflowListDto: {
|
|
5907
|
+
workflows: components["schemas"]["AgentWorkflowItemDto"][];
|
|
5908
|
+
};
|
|
5909
|
+
UpdateAgentWorkflowsResponseDto: {
|
|
5910
|
+
success: boolean;
|
|
5911
|
+
};
|
|
5912
|
+
GroupUsersDto: {
|
|
5913
|
+
id: number;
|
|
5914
|
+
name: string;
|
|
5915
|
+
email: string;
|
|
5916
|
+
is_available: boolean;
|
|
5917
|
+
group_capacity: number | null;
|
|
5918
|
+
global_capacity: number;
|
|
5919
|
+
};
|
|
5920
|
+
GroupDto: {
|
|
5921
|
+
id: string;
|
|
5922
|
+
organization_id: string;
|
|
5923
|
+
name: string;
|
|
5924
|
+
description: string | null;
|
|
5925
|
+
is_support_enabled: boolean;
|
|
5926
|
+
support_office_hours_id: string | null;
|
|
5927
|
+
/** @enum {string} */
|
|
5928
|
+
support_assignment_strategy: "least-busy" | "round-robin" | "unassigned";
|
|
5929
|
+
zendesk_group_id: string | null;
|
|
5930
|
+
zendesk_group_channels: components["schemas"]["SessionChannel"][] | null;
|
|
5931
|
+
created_at: string | null;
|
|
5932
|
+
updated_at: string | null;
|
|
5933
|
+
deleted_at: string | null;
|
|
5934
|
+
};
|
|
5935
|
+
VersionHistoryItemDto: {
|
|
5936
|
+
/** Format: uuid */
|
|
5937
|
+
id: string;
|
|
5938
|
+
instruction_id: string;
|
|
5939
|
+
version_number: number;
|
|
5940
|
+
question: string;
|
|
5941
|
+
answer: string;
|
|
5942
|
+
/** @enum {string} */
|
|
5943
|
+
type: "BEHAVIORAL" | "SCENARIO_SPECIFIC";
|
|
5944
|
+
/** Format: date-time */
|
|
5945
|
+
published_at: string;
|
|
5946
|
+
published_by: number | null;
|
|
5947
|
+
published_by_name: string | null;
|
|
5948
|
+
/** Format: date-time */
|
|
5949
|
+
created_at: string;
|
|
5950
|
+
start_time: string | null;
|
|
5951
|
+
end_time: string | null;
|
|
5952
|
+
};
|
|
5953
|
+
CustomTrainingDirectoriesDto: {
|
|
5954
|
+
id: string;
|
|
5955
|
+
name: string;
|
|
5956
|
+
org_id: string;
|
|
5957
|
+
};
|
|
5958
|
+
SequenceStep: {
|
|
5959
|
+
action: {
|
|
5960
|
+
/** @constant */
|
|
5961
|
+
type: "send_emails";
|
|
5962
|
+
data: {
|
|
5963
|
+
from_email: string;
|
|
5964
|
+
email_subject: string;
|
|
5965
|
+
email_body: string;
|
|
5966
|
+
email_sender_name: string;
|
|
5967
|
+
email_is_transactional: boolean;
|
|
5968
|
+
};
|
|
5969
|
+
} | {
|
|
5970
|
+
/** @constant */
|
|
5971
|
+
type: "make_phone_calls";
|
|
5972
|
+
data: {
|
|
5973
|
+
aiPhoneAgentId: string;
|
|
5974
|
+
};
|
|
5975
|
+
} | {
|
|
5976
|
+
/** @constant */
|
|
5977
|
+
type: "send_sms_messages";
|
|
5978
|
+
data: {
|
|
5979
|
+
message: string;
|
|
5980
|
+
};
|
|
5981
|
+
} | {
|
|
5982
|
+
/** @constant */
|
|
5983
|
+
type: "send_whatsapp_messages";
|
|
5984
|
+
data: {
|
|
5985
|
+
phone_number_id: string;
|
|
5986
|
+
template: {
|
|
5987
|
+
name: string;
|
|
5988
|
+
language: string;
|
|
5989
|
+
parameters: components["schemas"]["WhatsAppTemplateMappingDto"];
|
|
5990
|
+
};
|
|
5991
|
+
};
|
|
5992
|
+
};
|
|
5993
|
+
delay_in_minutes?: number;
|
|
5994
|
+
/** Format: date-time */
|
|
5995
|
+
started_at?: string;
|
|
5996
|
+
/** Format: date-time */
|
|
5997
|
+
ended_at?: string;
|
|
5998
|
+
};
|
|
5999
|
+
/** @enum {string} */
|
|
6000
|
+
SequenceStatus: "pending" | "complete" | "canceled" | "active";
|
|
6001
|
+
SequenceDto: {
|
|
6002
|
+
id: string;
|
|
6003
|
+
name: string;
|
|
6004
|
+
org_id: string;
|
|
6005
|
+
custom_id: string | null;
|
|
6006
|
+
filter: {
|
|
6007
|
+
or: {
|
|
6008
|
+
and: components["schemas"]["ContactsFilter"][];
|
|
6009
|
+
}[];
|
|
6010
|
+
} | null;
|
|
6011
|
+
steps: components["schemas"]["SequenceStep"][];
|
|
6012
|
+
is_continuous: boolean;
|
|
6013
|
+
started_at: string | null;
|
|
6014
|
+
canceled_at: string | null;
|
|
6015
|
+
ended_at: string | null;
|
|
6016
|
+
status: components["schemas"]["SequenceStatus"] | null;
|
|
6017
|
+
};
|
|
6018
|
+
StartOneOffSequenceOutputDto: {
|
|
6019
|
+
data?: {
|
|
6020
|
+
success: boolean;
|
|
6021
|
+
};
|
|
6022
|
+
error?: {
|
|
6023
|
+
/** @enum {string} */
|
|
6024
|
+
code: "sequence_not_found" | "one_off_sequence_is_canceled" | "sequence_already_started";
|
|
6025
|
+
status: 400 | 404;
|
|
6026
|
+
message: string;
|
|
6027
|
+
};
|
|
6028
|
+
};
|
|
5720
6029
|
AgentChangedPayload: {
|
|
5721
6030
|
/** @constant */
|
|
5722
6031
|
from: "ai";
|
|
@@ -5781,7 +6090,7 @@ export interface components {
|
|
|
5781
6090
|
/** @constant */
|
|
5782
6091
|
type: "response_skipped";
|
|
5783
6092
|
/** @enum {string} */
|
|
5784
|
-
reason?: "empty_response" | "potential_answers_dead_end" | "silent_handoff" | "superseded_by_newer_run";
|
|
6093
|
+
reason?: "empty_response" | "potential_answers_dead_end" | "silent_handoff" | "superseded_by_newer_run" | "flagged_as_spam";
|
|
5785
6094
|
reasoning?: ({
|
|
5786
6095
|
/** @constant */
|
|
5787
6096
|
type: "reasoning";
|
|
@@ -6104,217 +6413,8 @@ export interface components {
|
|
|
6104
6413
|
comment_thread_id?: string | null;
|
|
6105
6414
|
edited_at?: string | null;
|
|
6106
6415
|
deleted_at?: string | null;
|
|
6107
|
-
|
|
6108
|
-
|
|
6109
|
-
id: string;
|
|
6110
|
-
org_id: string;
|
|
6111
|
-
phone_number: string | null;
|
|
6112
|
-
name: string | null;
|
|
6113
|
-
/** @enum {string} */
|
|
6114
|
-
type: "inbound" | "outbound";
|
|
6115
|
-
language: string[];
|
|
6116
|
-
accent: string | null;
|
|
6117
|
-
handoff_phone_number: string | null;
|
|
6118
|
-
speed: number | null;
|
|
6119
|
-
interruptible: boolean;
|
|
6120
|
-
actionIds: string[] | null;
|
|
6121
|
-
instructions: string[] | null;
|
|
6122
|
-
data_collection_fields: string[] | null;
|
|
6123
|
-
data_collection_webhook_url: string | null;
|
|
6124
|
-
/** @enum {string} */
|
|
6125
|
-
model: "oppie-vox" | "oppie-vox-turbo" | "oppie-vox-2" | "oppie-vox-livekit";
|
|
6126
|
-
voice_id: string | null;
|
|
6127
|
-
first_message: string | null;
|
|
6128
|
-
/** Format: date-time */
|
|
6129
|
-
created_at: string;
|
|
6130
|
-
/** Format: date-time */
|
|
6131
|
-
updated_at: string;
|
|
6132
|
-
provider_external_id: string | null;
|
|
6133
|
-
flow: unknown | null;
|
|
6134
|
-
custom_llm: string | null;
|
|
6135
|
-
use_org_knowledgebase: boolean;
|
|
6136
|
-
background_noise_preset: ("office" | "bar" | "city-street") | null;
|
|
6137
|
-
recording_enabled: boolean;
|
|
6138
|
-
stt_keyterms: string[];
|
|
6139
|
-
stt_model: ("deepgram/flux-general" | "deepgram/nova-3" | "deepgram/nova-3-medical" | "cartesia/ink-whisper" | "elevenlabs/scribe_v2_realtime" | "xai/stt-1" | "assemblyai/universal-3-5-pro" | "speechmatics/enhanced") | null;
|
|
6140
|
-
tts_speed_pct: number | null;
|
|
6141
|
-
failover_transfer_destination_id: string | null;
|
|
6142
|
-
};
|
|
6143
|
-
PhoneAgentVoiceDto: {
|
|
6144
|
-
voice_id: string;
|
|
6145
|
-
name: string;
|
|
6146
|
-
labels: {
|
|
6147
|
-
accent: string | null;
|
|
6148
|
-
description: string | null;
|
|
6149
|
-
age: string | null;
|
|
6150
|
-
gender: string | null;
|
|
6151
|
-
use_case: string | null;
|
|
6152
|
-
language: string | null;
|
|
6153
|
-
};
|
|
6154
|
-
description: string | null;
|
|
6155
|
-
preview_url: string | null;
|
|
6156
|
-
};
|
|
6157
|
-
KnowledgeSourceTreeItemDto: {
|
|
6158
|
-
id: string;
|
|
6159
|
-
/** @description The scenario/title of the instruction */
|
|
6160
|
-
question: string;
|
|
6161
|
-
/** @description The content of the instruction */
|
|
6162
|
-
answer: string;
|
|
6163
|
-
directory_id: string | null;
|
|
6164
|
-
/** @description Whether this instruction is individually selected */
|
|
6165
|
-
selected: boolean;
|
|
6166
|
-
};
|
|
6167
|
-
KnowledgeSourceDirectoryDto: {
|
|
6168
|
-
id: string;
|
|
6169
|
-
name: string;
|
|
6170
|
-
items: components["schemas"]["KnowledgeSourceTreeItemDto"][];
|
|
6171
|
-
/** @description Whether the entire directory is selected (all current and future instructions included) */
|
|
6172
|
-
selected: boolean;
|
|
6173
|
-
};
|
|
6174
|
-
KnowledgeSourceTreeDto: {
|
|
6175
|
-
directories: components["schemas"]["KnowledgeSourceDirectoryDto"][];
|
|
6176
|
-
uncategorized: components["schemas"]["KnowledgeSourceTreeItemDto"][];
|
|
6177
|
-
/** @description Estimated tokens for all selected instructions */
|
|
6178
|
-
totalTokens: number;
|
|
6179
|
-
};
|
|
6180
|
-
UpdateKnowledgeSourcesResponseDto: {
|
|
6181
|
-
success: boolean;
|
|
6182
|
-
/** @description Estimated tokens for all selected instructions */
|
|
6183
|
-
totalTokens: number;
|
|
6184
|
-
};
|
|
6185
|
-
AgentWorkflowItemDto: {
|
|
6186
|
-
/** @description The logical workflow UUID */
|
|
6187
|
-
workflowId: string;
|
|
6188
|
-
/** @description Display name of the workflow */
|
|
6189
|
-
name: string;
|
|
6190
|
-
/** @description Description of the workflow */
|
|
6191
|
-
description: string | null;
|
|
6192
|
-
/** @description The goal of the workflow from AI trigger config */
|
|
6193
|
-
goal: string | null;
|
|
6194
|
-
/** @description Whether this workflow is selected for the agent */
|
|
6195
|
-
selected: boolean;
|
|
6196
|
-
};
|
|
6197
|
-
AgentWorkflowListDto: {
|
|
6198
|
-
workflows: components["schemas"]["AgentWorkflowItemDto"][];
|
|
6199
|
-
};
|
|
6200
|
-
UpdateAgentWorkflowsResponseDto: {
|
|
6201
|
-
success: boolean;
|
|
6202
|
-
};
|
|
6203
|
-
GroupUsersDto: {
|
|
6204
|
-
id: number;
|
|
6205
|
-
name: string;
|
|
6206
|
-
email: string;
|
|
6207
|
-
is_available: boolean;
|
|
6208
|
-
group_capacity: number | null;
|
|
6209
|
-
global_capacity: number;
|
|
6210
|
-
};
|
|
6211
|
-
GroupDto: {
|
|
6212
|
-
id: string;
|
|
6213
|
-
organization_id: string;
|
|
6214
|
-
name: string;
|
|
6215
|
-
description: string | null;
|
|
6216
|
-
is_support_enabled: boolean;
|
|
6217
|
-
support_office_hours_id: string | null;
|
|
6218
|
-
/** @enum {string} */
|
|
6219
|
-
support_assignment_strategy: "least-busy" | "round-robin" | "unassigned";
|
|
6220
|
-
zendesk_group_id: string | null;
|
|
6221
|
-
created_at: string | null;
|
|
6222
|
-
updated_at: string | null;
|
|
6223
|
-
deleted_at: string | null;
|
|
6224
|
-
};
|
|
6225
|
-
VersionHistoryItemDto: {
|
|
6226
|
-
/** Format: uuid */
|
|
6227
|
-
id: string;
|
|
6228
|
-
instruction_id: string;
|
|
6229
|
-
version_number: number;
|
|
6230
|
-
question: string;
|
|
6231
|
-
answer: string;
|
|
6232
|
-
/** @enum {string} */
|
|
6233
|
-
type: "BEHAVIORAL" | "SCENARIO_SPECIFIC";
|
|
6234
|
-
/** Format: date-time */
|
|
6235
|
-
published_at: string;
|
|
6236
|
-
published_by: number | null;
|
|
6237
|
-
published_by_name: string | null;
|
|
6238
|
-
/** Format: date-time */
|
|
6239
|
-
created_at: string;
|
|
6240
|
-
start_time: string | null;
|
|
6241
|
-
end_time: string | null;
|
|
6242
|
-
};
|
|
6243
|
-
CustomTrainingDirectoriesDto: {
|
|
6244
|
-
id: string;
|
|
6245
|
-
name: string;
|
|
6246
|
-
org_id: string;
|
|
6247
|
-
};
|
|
6248
|
-
SequenceStep: {
|
|
6249
|
-
action: {
|
|
6250
|
-
/** @constant */
|
|
6251
|
-
type: "send_emails";
|
|
6252
|
-
data: {
|
|
6253
|
-
from_email: string;
|
|
6254
|
-
email_subject: string;
|
|
6255
|
-
email_body: string;
|
|
6256
|
-
email_sender_name: string;
|
|
6257
|
-
email_is_transactional: boolean;
|
|
6258
|
-
};
|
|
6259
|
-
} | {
|
|
6260
|
-
/** @constant */
|
|
6261
|
-
type: "make_phone_calls";
|
|
6262
|
-
data: {
|
|
6263
|
-
aiPhoneAgentId: string;
|
|
6264
|
-
};
|
|
6265
|
-
} | {
|
|
6266
|
-
/** @constant */
|
|
6267
|
-
type: "send_sms_messages";
|
|
6268
|
-
data: {
|
|
6269
|
-
message: string;
|
|
6270
|
-
};
|
|
6271
|
-
} | {
|
|
6272
|
-
/** @constant */
|
|
6273
|
-
type: "send_whatsapp_messages";
|
|
6274
|
-
data: {
|
|
6275
|
-
phone_number_id: string;
|
|
6276
|
-
template: {
|
|
6277
|
-
name: string;
|
|
6278
|
-
language: string;
|
|
6279
|
-
parameters: components["schemas"]["WhatsAppTemplateMappingDto"];
|
|
6280
|
-
};
|
|
6281
|
-
};
|
|
6282
|
-
};
|
|
6283
|
-
delay_in_minutes?: number;
|
|
6284
|
-
/** Format: date-time */
|
|
6285
|
-
started_at?: string;
|
|
6286
|
-
/** Format: date-time */
|
|
6287
|
-
ended_at?: string;
|
|
6288
|
-
};
|
|
6289
|
-
/** @enum {string} */
|
|
6290
|
-
SequenceStatus: "pending" | "complete" | "canceled" | "active";
|
|
6291
|
-
SequenceDto: {
|
|
6292
|
-
id: string;
|
|
6293
|
-
name: string;
|
|
6294
|
-
org_id: string;
|
|
6295
|
-
custom_id: string | null;
|
|
6296
|
-
filter: {
|
|
6297
|
-
or: {
|
|
6298
|
-
and: components["schemas"]["ContactsFilter"][];
|
|
6299
|
-
}[];
|
|
6300
|
-
} | null;
|
|
6301
|
-
steps: components["schemas"]["SequenceStep"][];
|
|
6302
|
-
is_continuous: boolean;
|
|
6303
|
-
started_at: string | null;
|
|
6304
|
-
canceled_at: string | null;
|
|
6305
|
-
ended_at: string | null;
|
|
6306
|
-
status: components["schemas"]["SequenceStatus"] | null;
|
|
6307
|
-
};
|
|
6308
|
-
StartOneOffSequenceOutputDto: {
|
|
6309
|
-
data?: {
|
|
6310
|
-
success: boolean;
|
|
6311
|
-
};
|
|
6312
|
-
error?: {
|
|
6313
|
-
/** @enum {string} */
|
|
6314
|
-
code: "sequence_not_found" | "one_off_sequence_is_canceled" | "sequence_already_started";
|
|
6315
|
-
status: 400 | 404;
|
|
6316
|
-
message: string;
|
|
6317
|
-
};
|
|
6416
|
+
phone_call_id?: string | null;
|
|
6417
|
+
phone_call?: components["schemas"]["PhoneCallDto"] | null;
|
|
6318
6418
|
};
|
|
6319
6419
|
SankeyReportResDto: {
|
|
6320
6420
|
nodes: {
|
|
@@ -6357,6 +6457,52 @@ export interface components {
|
|
|
6357
6457
|
customDataKeys?: string[];
|
|
6358
6458
|
}[];
|
|
6359
6459
|
};
|
|
6460
|
+
CsatSettingsResponseDto: {
|
|
6461
|
+
/** @description The ID of the organization */
|
|
6462
|
+
organization_id: string;
|
|
6463
|
+
/** @description Whether CSAT collection is enabled for web channel */
|
|
6464
|
+
web_enabled: boolean;
|
|
6465
|
+
/** @description Whether CSAT collection is enabled for email channel */
|
|
6466
|
+
email_enabled: boolean;
|
|
6467
|
+
/** @description Whether CSAT collection is enabled for phone channel */
|
|
6468
|
+
phone_enabled: boolean;
|
|
6469
|
+
/** @description Whether CSAT collection is enabled for WhatsApp channel */
|
|
6470
|
+
whatsapp_enabled: boolean;
|
|
6471
|
+
/** @description Whether CSAT collection is enabled for SMS channel */
|
|
6472
|
+
sms_enabled: boolean;
|
|
6473
|
+
/** @description Whether CSAT collection is enabled for Slack channel */
|
|
6474
|
+
slack_enabled: boolean;
|
|
6475
|
+
/** @description Whether CSAT collection is enabled for API channel */
|
|
6476
|
+
api_enabled: boolean;
|
|
6477
|
+
/** @description Whether CSAT collection is enabled for web voice channel */
|
|
6478
|
+
web_voice_enabled: boolean;
|
|
6479
|
+
/** @description Whether CSAT collection is enabled for Instagram channel */
|
|
6480
|
+
instagram_enabled: boolean;
|
|
6481
|
+
/** @description Whether CSAT collection is enabled for Facebook Messenger channel */
|
|
6482
|
+
messenger_enabled: boolean;
|
|
6483
|
+
/** @description Custom message to display with CSAT request */
|
|
6484
|
+
custom_message: string | null;
|
|
6485
|
+
/** @description Whether to automatically send CSAT after session closes */
|
|
6486
|
+
auto_send_on_close: boolean;
|
|
6487
|
+
/** @description Delay in minutes before sending CSAT after session closes */
|
|
6488
|
+
send_delay_minutes: number;
|
|
6489
|
+
/** @description Full-HTML template for the public CSAT feedback page (null = default page) */
|
|
6490
|
+
web_template_html: string | null;
|
|
6491
|
+
/** @description Full-HTML template for the CSAT request email (null = default email) */
|
|
6492
|
+
email_template_html: string | null;
|
|
6493
|
+
/** @description Subject line for the custom CSAT request email (null = default subject) */
|
|
6494
|
+
email_template_subject: string | null;
|
|
6495
|
+
/**
|
|
6496
|
+
* Format: date-time
|
|
6497
|
+
* @description When the settings were created
|
|
6498
|
+
*/
|
|
6499
|
+
created_at: string;
|
|
6500
|
+
/**
|
|
6501
|
+
* Format: date-time
|
|
6502
|
+
* @description When the settings were last updated
|
|
6503
|
+
*/
|
|
6504
|
+
updated_at: string;
|
|
6505
|
+
};
|
|
6360
6506
|
EmailTemplateActivityItemDto: {
|
|
6361
6507
|
id: string;
|
|
6362
6508
|
from_email: string;
|
|
@@ -7169,7 +7315,7 @@ export interface components {
|
|
|
7169
7315
|
} | ({
|
|
7170
7316
|
/** @constant */
|
|
7171
7317
|
success: true;
|
|
7172
|
-
code?: string | "session_assigned_to_human_agent" | "response_cancelled" | "skipping_unuseful_response" | "duplicate_message_ignored" | "ai_response_skipped_by_workflow";
|
|
7318
|
+
code?: string | "session_assigned_to_human_agent" | "response_cancelled" | "skipping_unuseful_response" | "duplicate_message_ignored" | "ai_response_skipped_by_workflow" | "ai_skipped_spam";
|
|
7173
7319
|
autopilotResponse?: {
|
|
7174
7320
|
/** @constant */
|
|
7175
7321
|
type: "text";
|
|
@@ -8112,7 +8258,7 @@ export interface components {
|
|
|
8112
8258
|
/** Format: email */
|
|
8113
8259
|
email: string;
|
|
8114
8260
|
avatar_url?: string | null;
|
|
8115
|
-
permissions?: ("*" | "sessions:read" | "sessions:write" | "sessions-shared-views:read" | "sessions-shared-views:write" | "contacts:read" | "contacts:write" | "sequences:read" | "sequences:write" | "ai-training:read" | "ai-training:write" | "reports:read" | "reports:write" | "help-center:read" | "help-center:write" | "workflows:read" | "workflows:write" | "actions:read" | "actions:write" | "mini-apps:read" | "mini-apps:write" | "redaction:read" | "redaction:write" | "voc:read" | "voc:write" | "audit-logs:read" | "audit-logs:write" | "settings:read" | "settings:write" | "settings-billing:read" | "settings-billing:write" | "settings-api-keys:read" | "settings-api-keys:write" | "settings-autopilot:read" | "settings-autopilot:write" | "settings-integrations:read" | "settings-integrations:write" | "settings-members:read" | "settings-members:write" | "settings-tags:read" | "settings-tags:write" | "settings-sla:read" | "settings-sla:write" | "settings-csat:read" | "settings-csat:write" | "settings-office-hours:read" | "settings-office-hours:write" | "settings-channels:read" | "settings-channels:write" | "settings-channels-voice:read" | "settings-channels-voice:write" | "settings-helpdesk:read" | "settings-helpdesk:write" | "settings-groups:read" | "settings-groups:write" | "settings-roles:read" | "settings-roles:write" | "settings-macros:read" | "settings-macros:write" | "settings-skills:read" | "settings-skills:write")[] | null;
|
|
8261
|
+
permissions?: ("*" | "sessions:read" | "sessions:write" | "sessions-shared-views:read" | "sessions-shared-views:write" | "contacts:read" | "contacts:write" | "sequences:read" | "sequences:write" | "ai-training:read" | "ai-training:write" | "reports:read" | "reports:write" | "help-center:read" | "help-center:write" | "workflows:read" | "workflows:write" | "actions:read" | "actions:write" | "mini-apps:read" | "mini-apps:write" | "companion:read" | "companion:write" | "redaction:read" | "redaction:write" | "voc:read" | "voc:write" | "audit-logs:read" | "audit-logs:write" | "settings:read" | "settings:write" | "settings-billing:read" | "settings-billing:write" | "settings-api-keys:read" | "settings-api-keys:write" | "settings-autopilot:read" | "settings-autopilot:write" | "settings-webhooks:read" | "settings-webhooks:write" | "settings-secrets:read" | "settings-secrets:write" | "settings-handoff:read" | "settings-handoff:write" | "settings-translations:read" | "settings-translations:write" | "settings-sso:read" | "settings-sso:write" | "settings-integrations:read" | "settings-integrations:write" | "settings-members:read" | "settings-members:write" | "settings-tags:read" | "settings-tags:write" | "settings-sla:read" | "settings-sla:write" | "settings-csat:read" | "settings-csat:write" | "settings-reports:read" | "settings-reports:write" | "settings-office-hours:read" | "settings-office-hours:write" | "settings-channels:read" | "settings-channels:write" | "settings-channels-voice:read" | "settings-channels-voice:write" | "settings-helpdesk:read" | "settings-helpdesk:write" | "settings-groups:read" | "settings-groups:write" | "settings-roles:read" | "settings-roles:write" | "settings-macros:read" | "settings-macros:write" | "settings-skills:read" | "settings-skills:write")[] | null;
|
|
8116
8262
|
};
|
|
8117
8263
|
OrgUserDetail: {
|
|
8118
8264
|
id: number;
|
|
@@ -8121,7 +8267,7 @@ export interface components {
|
|
|
8121
8267
|
/** Format: email */
|
|
8122
8268
|
email: string;
|
|
8123
8269
|
avatar_url?: string | null;
|
|
8124
|
-
permissions?: ("*" | "sessions:read" | "sessions:write" | "sessions-shared-views:read" | "sessions-shared-views:write" | "contacts:read" | "contacts:write" | "sequences:read" | "sequences:write" | "ai-training:read" | "ai-training:write" | "reports:read" | "reports:write" | "help-center:read" | "help-center:write" | "workflows:read" | "workflows:write" | "actions:read" | "actions:write" | "mini-apps:read" | "mini-apps:write" | "redaction:read" | "redaction:write" | "voc:read" | "voc:write" | "audit-logs:read" | "audit-logs:write" | "settings:read" | "settings:write" | "settings-billing:read" | "settings-billing:write" | "settings-api-keys:read" | "settings-api-keys:write" | "settings-autopilot:read" | "settings-autopilot:write" | "settings-integrations:read" | "settings-integrations:write" | "settings-members:read" | "settings-members:write" | "settings-tags:read" | "settings-tags:write" | "settings-sla:read" | "settings-sla:write" | "settings-csat:read" | "settings-csat:write" | "settings-office-hours:read" | "settings-office-hours:write" | "settings-channels:read" | "settings-channels:write" | "settings-channels-voice:read" | "settings-channels-voice:write" | "settings-helpdesk:read" | "settings-helpdesk:write" | "settings-groups:read" | "settings-groups:write" | "settings-roles:read" | "settings-roles:write" | "settings-macros:read" | "settings-macros:write" | "settings-skills:read" | "settings-skills:write")[] | null;
|
|
8270
|
+
permissions?: ("*" | "sessions:read" | "sessions:write" | "sessions-shared-views:read" | "sessions-shared-views:write" | "contacts:read" | "contacts:write" | "sequences:read" | "sequences:write" | "ai-training:read" | "ai-training:write" | "reports:read" | "reports:write" | "help-center:read" | "help-center:write" | "workflows:read" | "workflows:write" | "actions:read" | "actions:write" | "mini-apps:read" | "mini-apps:write" | "companion:read" | "companion:write" | "redaction:read" | "redaction:write" | "voc:read" | "voc:write" | "audit-logs:read" | "audit-logs:write" | "settings:read" | "settings:write" | "settings-billing:read" | "settings-billing:write" | "settings-api-keys:read" | "settings-api-keys:write" | "settings-autopilot:read" | "settings-autopilot:write" | "settings-webhooks:read" | "settings-webhooks:write" | "settings-secrets:read" | "settings-secrets:write" | "settings-handoff:read" | "settings-handoff:write" | "settings-translations:read" | "settings-translations:write" | "settings-sso:read" | "settings-sso:write" | "settings-integrations:read" | "settings-integrations:write" | "settings-members:read" | "settings-members:write" | "settings-tags:read" | "settings-tags:write" | "settings-sla:read" | "settings-sla:write" | "settings-csat:read" | "settings-csat:write" | "settings-reports:read" | "settings-reports:write" | "settings-office-hours:read" | "settings-office-hours:write" | "settings-channels:read" | "settings-channels:write" | "settings-channels-voice:read" | "settings-channels-voice:write" | "settings-helpdesk:read" | "settings-helpdesk:write" | "settings-groups:read" | "settings-groups:write" | "settings-roles:read" | "settings-roles:write" | "settings-macros:read" | "settings-macros:write" | "settings-skills:read" | "settings-skills:write")[] | null;
|
|
8125
8271
|
teams: {
|
|
8126
8272
|
group: components["schemas"]["GroupDto"];
|
|
8127
8273
|
is_user_available_on_group: boolean;
|
|
@@ -10801,6 +10947,68 @@ export interface operations {
|
|
|
10801
10947
|
};
|
|
10802
10948
|
};
|
|
10803
10949
|
};
|
|
10950
|
+
getCsatSettings: {
|
|
10951
|
+
parameters: {
|
|
10952
|
+
query?: never;
|
|
10953
|
+
header?: never;
|
|
10954
|
+
path?: never;
|
|
10955
|
+
cookie?: never;
|
|
10956
|
+
};
|
|
10957
|
+
requestBody?: never;
|
|
10958
|
+
responses: {
|
|
10959
|
+
/** @description Default Response */
|
|
10960
|
+
200: {
|
|
10961
|
+
headers: {
|
|
10962
|
+
[name: string]: unknown;
|
|
10963
|
+
};
|
|
10964
|
+
content: {
|
|
10965
|
+
"application/json": components["schemas"]["CsatSettingsResponseDto"];
|
|
10966
|
+
};
|
|
10967
|
+
};
|
|
10968
|
+
/** @description Internal Server Error */
|
|
10969
|
+
500: {
|
|
10970
|
+
headers: {
|
|
10971
|
+
[name: string]: unknown;
|
|
10972
|
+
};
|
|
10973
|
+
content: {
|
|
10974
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
10975
|
+
};
|
|
10976
|
+
};
|
|
10977
|
+
};
|
|
10978
|
+
};
|
|
10979
|
+
updateCsatSettings: {
|
|
10980
|
+
parameters: {
|
|
10981
|
+
query?: never;
|
|
10982
|
+
header?: never;
|
|
10983
|
+
path?: never;
|
|
10984
|
+
cookie?: never;
|
|
10985
|
+
};
|
|
10986
|
+
requestBody: {
|
|
10987
|
+
content: {
|
|
10988
|
+
"application/json": components["schemas"]["UpdateCsatSettingsDto"];
|
|
10989
|
+
};
|
|
10990
|
+
};
|
|
10991
|
+
responses: {
|
|
10992
|
+
/** @description Default Response */
|
|
10993
|
+
200: {
|
|
10994
|
+
headers: {
|
|
10995
|
+
[name: string]: unknown;
|
|
10996
|
+
};
|
|
10997
|
+
content: {
|
|
10998
|
+
"application/json": components["schemas"]["CsatSettingsResponseDto"];
|
|
10999
|
+
};
|
|
11000
|
+
};
|
|
11001
|
+
/** @description Internal Server Error */
|
|
11002
|
+
500: {
|
|
11003
|
+
headers: {
|
|
11004
|
+
[name: string]: unknown;
|
|
11005
|
+
};
|
|
11006
|
+
content: {
|
|
11007
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
11008
|
+
};
|
|
11009
|
+
};
|
|
11010
|
+
};
|
|
11011
|
+
};
|
|
10804
11012
|
getAutopilotStatus: {
|
|
10805
11013
|
parameters: {
|
|
10806
11014
|
query?: never;
|