@opencx/mcp 1.15.1 → 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 +774 -466
- 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/dist/tools/insights.d.ts.map +1 -1
- package/dist/tools/insights.js +25 -0
- package/dist/tools/insights.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;
|
|
@@ -3059,6 +3083,30 @@ export interface paths {
|
|
|
3059
3083
|
patch?: never;
|
|
3060
3084
|
trace?: never;
|
|
3061
3085
|
};
|
|
3086
|
+
"/insights/settings": {
|
|
3087
|
+
parameters: {
|
|
3088
|
+
query?: never;
|
|
3089
|
+
header?: never;
|
|
3090
|
+
path?: never;
|
|
3091
|
+
cookie?: never;
|
|
3092
|
+
};
|
|
3093
|
+
/**
|
|
3094
|
+
* Get VOC settings
|
|
3095
|
+
* @description Public subset of Voice-of-Customer settings (mirrors dashboard field names). Currently returns only `custom_analysis_instructions` (Customer Insights → Settings → AI Instructions). Does not return webhooks, notify lists, alert/merge toggles, category-suggestion settings, or other internal fields.
|
|
3096
|
+
*/
|
|
3097
|
+
get: operations["getVocSettings"];
|
|
3098
|
+
/**
|
|
3099
|
+
* Update VOC settings
|
|
3100
|
+
* @description Partial update of the public VOC settings subset. Accepts only `custom_analysis_instructions` (max 1000 chars; null clears). Unknown keys are rejected. Prompt changes apply to future analyses only. Non-public settings remain dashboard-only.
|
|
3101
|
+
*/
|
|
3102
|
+
put: operations["updateVocSettings"];
|
|
3103
|
+
post?: never;
|
|
3104
|
+
delete?: never;
|
|
3105
|
+
options?: never;
|
|
3106
|
+
head?: never;
|
|
3107
|
+
patch?: never;
|
|
3108
|
+
trace?: never;
|
|
3109
|
+
};
|
|
3062
3110
|
"/insights/categories/{categoryId}": {
|
|
3063
3111
|
parameters: {
|
|
3064
3112
|
query?: never;
|
|
@@ -4456,12 +4504,43 @@ export interface components {
|
|
|
4456
4504
|
})[];
|
|
4457
4505
|
};
|
|
4458
4506
|
FileUploadDto: {
|
|
4459
|
-
/**
|
|
4460
|
-
* Format: binary
|
|
4461
|
-
* @description The file to upload. 5MB max.
|
|
4462
|
-
*/
|
|
4507
|
+
/** Format: binary */
|
|
4463
4508
|
file: string;
|
|
4464
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
|
+
};
|
|
4465
4544
|
CreateEmailTemplateBodyDto: {
|
|
4466
4545
|
body: string;
|
|
4467
4546
|
name: string;
|
|
@@ -5318,6 +5397,10 @@ export interface components {
|
|
|
5318
5397
|
*/
|
|
5319
5398
|
fallbackCategoryId: string;
|
|
5320
5399
|
};
|
|
5400
|
+
UpdatePublicVocSettingsDto: {
|
|
5401
|
+
/** @description Full replacement for AI Instructions (≤1000 chars), or null to clear. Applies to future analyses only — existing insights are not re-run. */
|
|
5402
|
+
custom_analysis_instructions?: string | null;
|
|
5403
|
+
};
|
|
5321
5404
|
AssignInsightDto: {
|
|
5322
5405
|
/** Format: uuid */
|
|
5323
5406
|
groupId: string;
|
|
@@ -5346,7 +5429,7 @@ export interface components {
|
|
|
5346
5429
|
* @description What starts the workflow. Use "manual-trigger" for on-demand execution, "ai-trigger" for AI-initiated, "webhook" for external HTTP triggers, "cron-trigger" for scheduled runs, or event-based triggers like "ticket-created", "contact-created", etc.
|
|
5347
5430
|
* @enum {string}
|
|
5348
5431
|
*/
|
|
5349
|
-
trigger_type: "manual-trigger" | "ai-trigger" | "cron-trigger" | "form-trigger" | "webhook" | "contact-created" | "phone-call-started" | "phone-call-finished" | "ticket-created" | "ticket-reassigned" | "ticket-resolved" | "ticket-handoff" | "pre-ticket-handoff" | "ticket-tag-added" | "ticket-inactive" | "agent-inactive" | "sequence-completed" | "csat-score-submit" | "prohibited-topic-detected" | "sla-first-reply-breached" | "sla-next-reply-breached" | "sla-resolution-breached" | "voice-call-transferred" | "pre-voice-call-transfer" | "pre-phone-call-finished" | "manual-ticket-trigger" | "contact-message-received" | "first-contact-message-received" | "macro-called" | "ai-response-completed" | "agent-availability-changed" | "agent-avail-in-team-changed" | "ai-response-requested" | "ticket-reopened";
|
|
5432
|
+
trigger_type: "manual-trigger" | "ai-trigger" | "cron-trigger" | "form-trigger" | "webhook" | "contact-created" | "contact-updated" | "phone-call-started" | "phone-call-finished" | "ticket-created" | "ticket-reassigned" | "ticket-resolved" | "ticket-handoff" | "pre-ticket-handoff" | "ticket-tag-added" | "ticket-inactive" | "agent-inactive" | "sequence-completed" | "csat-score-submit" | "prohibited-topic-detected" | "sla-first-reply-breached" | "sla-next-reply-breached" | "sla-resolution-breached" | "voice-call-transferred" | "pre-voice-call-transfer" | "pre-phone-call-finished" | "manual-ticket-trigger" | "contact-message-received" | "first-contact-message-received" | "macro-called" | "ai-response-completed" | "agent-availability-changed" | "agent-avail-in-team-changed" | "ai-response-requested" | "ticket-reopened";
|
|
5350
5433
|
/** @description Trigger-specific configuration (e.g. cron expression for cron-trigger) */
|
|
5351
5434
|
trigger_configuration?: unknown | null;
|
|
5352
5435
|
/** @description Array of workflow steps and control-flow blocks. Each step is an object with { "$kind": "Action", "id": "<unique-step-id>", "type": "<action-type>", "name": "<display-name>", "input": { ... } }. Control-flow blocks use { "$kind": "Block", "type": "if-else", "id": "<unique-id>", "inputs": { "condition": { "operatorName": "equals", "left": "{{step_id.field}}", "right": "value" } }, "branches": { "then": [...steps], "else": [...steps] } }. Use {{step_id.field}} to reference outputs from previous steps (no `.output.` segment — the field sits directly under the step id). */
|
|
@@ -5363,7 +5446,7 @@ export interface components {
|
|
|
5363
5446
|
* @description New trigger type
|
|
5364
5447
|
* @enum {string}
|
|
5365
5448
|
*/
|
|
5366
|
-
trigger_type?: "manual-trigger" | "ai-trigger" | "cron-trigger" | "form-trigger" | "webhook" | "contact-created" | "phone-call-started" | "phone-call-finished" | "ticket-created" | "ticket-reassigned" | "ticket-resolved" | "ticket-handoff" | "pre-ticket-handoff" | "ticket-tag-added" | "ticket-inactive" | "agent-inactive" | "sequence-completed" | "csat-score-submit" | "prohibited-topic-detected" | "sla-first-reply-breached" | "sla-next-reply-breached" | "sla-resolution-breached" | "voice-call-transferred" | "pre-voice-call-transfer" | "pre-phone-call-finished" | "manual-ticket-trigger" | "contact-message-received" | "first-contact-message-received" | "macro-called" | "ai-response-completed" | "agent-availability-changed" | "agent-avail-in-team-changed" | "ai-response-requested" | "ticket-reopened";
|
|
5449
|
+
trigger_type?: "manual-trigger" | "ai-trigger" | "cron-trigger" | "form-trigger" | "webhook" | "contact-created" | "contact-updated" | "phone-call-started" | "phone-call-finished" | "ticket-created" | "ticket-reassigned" | "ticket-resolved" | "ticket-handoff" | "pre-ticket-handoff" | "ticket-tag-added" | "ticket-inactive" | "agent-inactive" | "sequence-completed" | "csat-score-submit" | "prohibited-topic-detected" | "sla-first-reply-breached" | "sla-next-reply-breached" | "sla-resolution-breached" | "voice-call-transferred" | "pre-voice-call-transfer" | "pre-phone-call-finished" | "manual-ticket-trigger" | "contact-message-received" | "first-contact-message-received" | "macro-called" | "ai-response-completed" | "agent-availability-changed" | "agent-avail-in-team-changed" | "ai-response-requested" | "ticket-reopened";
|
|
5367
5450
|
/** @description New trigger configuration */
|
|
5368
5451
|
trigger_configuration?: unknown | null;
|
|
5369
5452
|
/** @description New workflow step/block definitions (replaces existing blocks) */
|
|
@@ -5376,7 +5459,7 @@ export interface components {
|
|
|
5376
5459
|
* @description Trigger type to validate against
|
|
5377
5460
|
* @enum {string}
|
|
5378
5461
|
*/
|
|
5379
|
-
trigger_type: "manual-trigger" | "ai-trigger" | "cron-trigger" | "form-trigger" | "webhook" | "contact-created" | "phone-call-started" | "phone-call-finished" | "ticket-created" | "ticket-reassigned" | "ticket-resolved" | "ticket-handoff" | "pre-ticket-handoff" | "ticket-tag-added" | "ticket-inactive" | "agent-inactive" | "sequence-completed" | "csat-score-submit" | "prohibited-topic-detected" | "sla-first-reply-breached" | "sla-next-reply-breached" | "sla-resolution-breached" | "voice-call-transferred" | "pre-voice-call-transfer" | "pre-phone-call-finished" | "manual-ticket-trigger" | "contact-message-received" | "first-contact-message-received" | "macro-called" | "ai-response-completed" | "agent-availability-changed" | "agent-avail-in-team-changed" | "ai-response-requested" | "ticket-reopened";
|
|
5462
|
+
trigger_type: "manual-trigger" | "ai-trigger" | "cron-trigger" | "form-trigger" | "webhook" | "contact-created" | "contact-updated" | "phone-call-started" | "phone-call-finished" | "ticket-created" | "ticket-reassigned" | "ticket-resolved" | "ticket-handoff" | "pre-ticket-handoff" | "ticket-tag-added" | "ticket-inactive" | "agent-inactive" | "sequence-completed" | "csat-score-submit" | "prohibited-topic-detected" | "sla-first-reply-breached" | "sla-next-reply-breached" | "sla-resolution-breached" | "voice-call-transferred" | "pre-voice-call-transfer" | "pre-phone-call-finished" | "manual-ticket-trigger" | "contact-message-received" | "first-contact-message-received" | "macro-called" | "ai-response-completed" | "agent-availability-changed" | "agent-avail-in-team-changed" | "ai-response-requested" | "ticket-reopened";
|
|
5380
5463
|
/** @description Trigger configuration to validate against the trigger's configuration_def. When omitted, the trigger is validated as if unconfigured — triggers with required configuration (e.g. cron-trigger, ai-trigger) will report errors. */
|
|
5381
5464
|
trigger_configuration?: unknown | null;
|
|
5382
5465
|
/** @description Workflow blocks to validate */
|
|
@@ -5389,7 +5472,7 @@ export interface components {
|
|
|
5389
5472
|
* @description Trigger type whose payload shape this synthetic payload should match
|
|
5390
5473
|
* @enum {string}
|
|
5391
5474
|
*/
|
|
5392
|
-
type: "manual-trigger" | "ai-trigger" | "cron-trigger" | "form-trigger" | "webhook" | "contact-created" | "phone-call-started" | "phone-call-finished" | "ticket-created" | "ticket-reassigned" | "ticket-resolved" | "ticket-handoff" | "pre-ticket-handoff" | "ticket-tag-added" | "ticket-inactive" | "agent-inactive" | "sequence-completed" | "csat-score-submit" | "prohibited-topic-detected" | "sla-first-reply-breached" | "sla-next-reply-breached" | "sla-resolution-breached" | "voice-call-transferred" | "pre-voice-call-transfer" | "pre-phone-call-finished" | "manual-ticket-trigger" | "contact-message-received" | "first-contact-message-received" | "macro-called" | "ai-response-completed" | "agent-availability-changed" | "agent-avail-in-team-changed" | "ai-response-requested" | "ticket-reopened";
|
|
5475
|
+
type: "manual-trigger" | "ai-trigger" | "cron-trigger" | "form-trigger" | "webhook" | "contact-created" | "contact-updated" | "phone-call-started" | "phone-call-finished" | "ticket-created" | "ticket-reassigned" | "ticket-resolved" | "ticket-handoff" | "pre-ticket-handoff" | "ticket-tag-added" | "ticket-inactive" | "agent-inactive" | "sequence-completed" | "csat-score-submit" | "prohibited-topic-detected" | "sla-first-reply-breached" | "sla-next-reply-breached" | "sla-resolution-breached" | "voice-call-transferred" | "pre-voice-call-transfer" | "pre-phone-call-finished" | "manual-ticket-trigger" | "contact-message-received" | "first-contact-message-received" | "macro-called" | "ai-response-completed" | "agent-availability-changed" | "agent-avail-in-team-changed" | "ai-response-requested" | "ticket-reopened";
|
|
5393
5476
|
payload: unknown;
|
|
5394
5477
|
};
|
|
5395
5478
|
};
|
|
@@ -5588,8 +5671,8 @@ export interface components {
|
|
|
5588
5671
|
/** @default 10 */
|
|
5589
5672
|
limit: number;
|
|
5590
5673
|
visibility?: ("internal" | "public")[];
|
|
5591
|
-
sourceTypes?: ("custom_training" | "help_center" | "integration" | "website")[];
|
|
5592
|
-
dataSources?: ("confluence" | "notion" | "zendesk_support" | "shopify" | "gitbook" | "intercom" | "front" | "freshdesk" | "hubspot_kb" | "ai_instructions" | "custom_training" | "website")[];
|
|
5674
|
+
sourceTypes?: ("custom_training" | "help_center" | "integration" | "website" | "workflow")[];
|
|
5675
|
+
dataSources?: ("confluence" | "notion" | "zendesk_support" | "shopify" | "gitbook" | "intercom" | "front" | "freshdesk" | "hubspot_kb" | "ai_instructions" | "custom_training" | "website" | "workflow")[];
|
|
5593
5676
|
/**
|
|
5594
5677
|
* @default relevance
|
|
5595
5678
|
* @enum {string}
|
|
@@ -5689,442 +5772,96 @@ export interface components {
|
|
|
5689
5772
|
url: string;
|
|
5690
5773
|
openai_file_id?: string;
|
|
5691
5774
|
};
|
|
5692
|
-
|
|
5693
|
-
|
|
5694
|
-
|
|
5695
|
-
|
|
5696
|
-
|
|
5697
|
-
|
|
5698
|
-
|
|
5699
|
-
|
|
5700
|
-
|
|
5701
|
-
|
|
5702
|
-
|
|
5703
|
-
|
|
5704
|
-
|
|
5705
|
-
|
|
5706
|
-
|
|
5707
|
-
|
|
5708
|
-
|
|
5709
|
-
|
|
5710
|
-
|
|
5711
|
-
|
|
5712
|
-
/**
|
|
5713
|
-
|
|
5714
|
-
/**
|
|
5715
|
-
|
|
5716
|
-
|
|
5717
|
-
|
|
5718
|
-
|
|
5719
|
-
|
|
5720
|
-
|
|
5721
|
-
|
|
5722
|
-
|
|
5723
|
-
|
|
5724
|
-
|
|
5725
|
-
|
|
5726
|
-
agent_id: number;
|
|
5727
|
-
} | {
|
|
5728
|
-
/** @constant */
|
|
5729
|
-
from: "unassigned";
|
|
5730
|
-
/** @constant */
|
|
5731
|
-
to: "ai";
|
|
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;
|
|
5732
5809
|
};
|
|
5733
|
-
|
|
5734
|
-
|
|
5735
|
-
|
|
5736
|
-
|
|
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;
|
|
5737
5840
|
session_id: string;
|
|
5738
|
-
from_user?: boolean | null;
|
|
5739
|
-
message?: string | null;
|
|
5740
|
-
original_message?: string | null;
|
|
5741
|
-
original_language?: string | null;
|
|
5742
|
-
translated_message?: string | null;
|
|
5743
|
-
translated_language?: string | null;
|
|
5744
|
-
created_at?: string | null;
|
|
5745
|
-
updated_at?: string | null;
|
|
5746
|
-
debug_json?: ({
|
|
5747
|
-
v2: {
|
|
5748
|
-
response: ({
|
|
5749
|
-
/** @constant */
|
|
5750
|
-
type: "prohibited_topic";
|
|
5751
|
-
topic: string;
|
|
5752
|
-
} | {
|
|
5753
|
-
/** @constant */
|
|
5754
|
-
type: "response_skipped";
|
|
5755
|
-
/** @enum {string} */
|
|
5756
|
-
reason?: "empty_response" | "potential_answers_dead_end" | "silent_handoff" | "superseded_by_newer_run";
|
|
5757
|
-
reasoning?: ({
|
|
5758
|
-
/** @constant */
|
|
5759
|
-
type: "reasoning";
|
|
5760
|
-
content: string;
|
|
5761
|
-
} | {
|
|
5762
|
-
/** @constant */
|
|
5763
|
-
type: "tool_call";
|
|
5764
|
-
call_id: string;
|
|
5765
|
-
tool_name: string;
|
|
5766
|
-
action?: {
|
|
5767
|
-
name: string;
|
|
5768
|
-
id: string;
|
|
5769
|
-
openapi?: {
|
|
5770
|
-
openapi_spec_id?: string;
|
|
5771
|
-
operation_spec: unknown;
|
|
5772
|
-
operation_id?: string;
|
|
5773
|
-
operation_method?: string;
|
|
5774
|
-
};
|
|
5775
|
-
metadata: unknown;
|
|
5776
|
-
required_form_submission?: boolean;
|
|
5777
|
-
is_handoff_like?: boolean;
|
|
5778
|
-
};
|
|
5779
|
-
call_arguments: string;
|
|
5780
|
-
call_result: string;
|
|
5781
|
-
})[];
|
|
5782
|
-
context?: {
|
|
5783
|
-
knowledgeBaseItems: {
|
|
5784
|
-
itemId: string;
|
|
5785
|
-
chunkIndex: number;
|
|
5786
|
-
title: string;
|
|
5787
|
-
url?: string;
|
|
5788
|
-
}[];
|
|
5789
|
-
instructions: {
|
|
5790
|
-
id: string;
|
|
5791
|
-
title: string;
|
|
5792
|
-
}[];
|
|
5793
|
-
tools: {
|
|
5794
|
-
name: string;
|
|
5795
|
-
}[];
|
|
5796
|
-
};
|
|
5797
|
-
suppressedResponseText?: string;
|
|
5798
|
-
reasoningSummary?: string;
|
|
5799
|
-
} | {
|
|
5800
|
-
/** @constant */
|
|
5801
|
-
type: "response";
|
|
5802
|
-
responseText: string;
|
|
5803
|
-
responseTextWithReferences: string;
|
|
5804
|
-
context: {
|
|
5805
|
-
knowledgeBaseItems: {
|
|
5806
|
-
itemId: string;
|
|
5807
|
-
chunkIndex: number;
|
|
5808
|
-
title: string;
|
|
5809
|
-
url?: string;
|
|
5810
|
-
}[];
|
|
5811
|
-
instructions: {
|
|
5812
|
-
id: string;
|
|
5813
|
-
title: string;
|
|
5814
|
-
}[];
|
|
5815
|
-
tools: {
|
|
5816
|
-
name: string;
|
|
5817
|
-
}[];
|
|
5818
|
-
};
|
|
5819
|
-
reasoning: ({
|
|
5820
|
-
/** @constant */
|
|
5821
|
-
type: "reasoning";
|
|
5822
|
-
content: string;
|
|
5823
|
-
} | {
|
|
5824
|
-
/** @constant */
|
|
5825
|
-
type: "tool_call";
|
|
5826
|
-
call_id: string;
|
|
5827
|
-
tool_name: string;
|
|
5828
|
-
action?: {
|
|
5829
|
-
name: string;
|
|
5830
|
-
id: string;
|
|
5831
|
-
openapi?: {
|
|
5832
|
-
openapi_spec_id?: string;
|
|
5833
|
-
operation_spec: unknown;
|
|
5834
|
-
operation_id?: string;
|
|
5835
|
-
operation_method?: string;
|
|
5836
|
-
};
|
|
5837
|
-
metadata: unknown;
|
|
5838
|
-
required_form_submission?: boolean;
|
|
5839
|
-
is_handoff_like?: boolean;
|
|
5840
|
-
};
|
|
5841
|
-
call_arguments: string;
|
|
5842
|
-
call_result: string;
|
|
5843
|
-
})[];
|
|
5844
|
-
reasoningSummary?: string;
|
|
5845
|
-
/** @description Quick reply suggestions for the user */
|
|
5846
|
-
quickReplySuggestions: {
|
|
5847
|
-
toolName?: string | null;
|
|
5848
|
-
suggestions: string[];
|
|
5849
|
-
}[];
|
|
5850
|
-
/** @description If your answer might solve the user's issue, return true, otherwise false. Note: once the user confirms it is solved, stop returning true */
|
|
5851
|
-
mightSolveUserIssue: boolean;
|
|
5852
|
-
/** @description True if your answer to the user completely covers the issue from knowledge and tools, and no further user input is needed. False if your answer is generic or is not specific to the issue. */
|
|
5853
|
-
completelyAndFullyCoveredUserIssue?: boolean;
|
|
5854
|
-
}) & {
|
|
5855
|
-
/** @enum {string} */
|
|
5856
|
-
language: "en" | "fr" | "de" | "nl" | "pl" | "pt" | "es" | "it" | "ru" | "ja" | "ko" | "zh" | "ar" | "tr" | "sv" | "da" | "no" | "fi" | "el" | "cs" | "hu" | "th" | "vi" | "id" | "he" | "hi" | "uk" | "ro" | "bg" | "hr" | "sk" | "sl" | "sr" | "et" | "lv" | "lt" | "is" | "ga" | "ms" | "tl" | "fa" | "bn" | "ta" | "te" | "ur" | "sw" | "zu" | "af" | "sq" | "hy" | "az" | "eu" | "be" | "bs" | "ca" | "cy" | "ku" | "ckb" | "kmr";
|
|
5857
|
-
};
|
|
5858
|
-
};
|
|
5859
|
-
actionCalls?: {
|
|
5860
|
-
action: {
|
|
5861
|
-
name: string;
|
|
5862
|
-
id: string;
|
|
5863
|
-
openapi?: {
|
|
5864
|
-
openapi_spec_id?: string;
|
|
5865
|
-
operation_spec: unknown;
|
|
5866
|
-
operation_id?: string;
|
|
5867
|
-
operation_method?: string;
|
|
5868
|
-
};
|
|
5869
|
-
metadata: unknown;
|
|
5870
|
-
required_form_submission?: boolean;
|
|
5871
|
-
is_handoff_like?: boolean;
|
|
5872
|
-
};
|
|
5873
|
-
arguments: unknown;
|
|
5874
|
-
result: unknown;
|
|
5875
|
-
}[];
|
|
5876
|
-
/** @default null */
|
|
5877
|
-
assignment_choice_summary: {
|
|
5878
|
-
/** @constant */
|
|
5879
|
-
strategy: "least-busy";
|
|
5880
|
-
selected: {
|
|
5881
|
-
agent_id: number;
|
|
5882
|
-
agent_name: string;
|
|
5883
|
-
active_sessions: number;
|
|
5884
|
-
active_sessions_in_group: number;
|
|
5885
|
-
pending_sessions: number;
|
|
5886
|
-
remaining_capacity: number;
|
|
5887
|
-
max_capacity: number;
|
|
5888
|
-
max_capacity_in_group: number | null;
|
|
5889
|
-
is_available_globally: boolean;
|
|
5890
|
-
is_available_in_group: boolean;
|
|
5891
|
-
/** @default [] */
|
|
5892
|
-
missing_required_skills: {
|
|
5893
|
-
id: string;
|
|
5894
|
-
name: string;
|
|
5895
|
-
}[];
|
|
5896
|
-
} | null;
|
|
5897
|
-
peers: {
|
|
5898
|
-
agent_id: number;
|
|
5899
|
-
agent_name: string;
|
|
5900
|
-
active_sessions: number;
|
|
5901
|
-
active_sessions_in_group: number;
|
|
5902
|
-
pending_sessions: number;
|
|
5903
|
-
remaining_capacity: number;
|
|
5904
|
-
max_capacity: number;
|
|
5905
|
-
max_capacity_in_group: number | null;
|
|
5906
|
-
is_available_globally: boolean;
|
|
5907
|
-
is_available_in_group: boolean;
|
|
5908
|
-
/** @default [] */
|
|
5909
|
-
missing_required_skills: {
|
|
5910
|
-
id: string;
|
|
5911
|
-
name: string;
|
|
5912
|
-
}[];
|
|
5913
|
-
}[];
|
|
5914
|
-
/** @default [] */
|
|
5915
|
-
required_skills: {
|
|
5916
|
-
id: string;
|
|
5917
|
-
name: string;
|
|
5918
|
-
}[];
|
|
5919
|
-
} | null;
|
|
5920
|
-
custom_data?: {
|
|
5921
|
-
[key: string]: unknown;
|
|
5922
|
-
} | null;
|
|
5923
|
-
} | {
|
|
5924
|
-
actionCalls?: {
|
|
5925
|
-
action: {
|
|
5926
|
-
name: string;
|
|
5927
|
-
id: string;
|
|
5928
|
-
openapi?: {
|
|
5929
|
-
openapi_spec_id?: string;
|
|
5930
|
-
operation_spec: unknown;
|
|
5931
|
-
operation_id?: string;
|
|
5932
|
-
operation_method?: string;
|
|
5933
|
-
};
|
|
5934
|
-
metadata: unknown;
|
|
5935
|
-
required_form_submission?: boolean;
|
|
5936
|
-
is_handoff_like?: boolean;
|
|
5937
|
-
};
|
|
5938
|
-
arguments: unknown;
|
|
5939
|
-
result: unknown;
|
|
5940
|
-
}[];
|
|
5941
|
-
actionSearchQuery?: string;
|
|
5942
|
-
knowledge?: {
|
|
5943
|
-
source: string;
|
|
5944
|
-
source_type: string;
|
|
5945
|
-
url: string;
|
|
5946
|
-
}[];
|
|
5947
|
-
knowledge_used?: {
|
|
5948
|
-
content: string;
|
|
5949
|
-
source: string;
|
|
5950
|
-
}[];
|
|
5951
|
-
work_instructions_scanned?: {
|
|
5952
|
-
content: string;
|
|
5953
|
-
}[];
|
|
5954
|
-
/** @description Context provided from the client. For example, dynamic metadata sent from the widget such as: the current product name on the page, the current Shopify shop domain, etc etc. */
|
|
5955
|
-
client_context?: {
|
|
5956
|
-
[key: string]: unknown;
|
|
5957
|
-
} | null;
|
|
5958
|
-
/** @description Org-specific or message-type-specific debug data. */
|
|
5959
|
-
additional_debug_data?: {
|
|
5960
|
-
[key: string]: unknown;
|
|
5961
|
-
} | null;
|
|
5962
|
-
custom_data?: {
|
|
5963
|
-
[key: string]: unknown;
|
|
5964
|
-
} | null;
|
|
5965
|
-
whatsapp_template_request?: unknown | null;
|
|
5966
|
-
rule_violation_reflections?: {
|
|
5967
|
-
rule_name: string;
|
|
5968
|
-
/** @description How the rule was violated */
|
|
5969
|
-
violation_description: string;
|
|
5970
|
-
}[];
|
|
5971
|
-
tool_call_results_quick_reply_suggestions?: {
|
|
5972
|
-
tool_name: string;
|
|
5973
|
-
suggestions: string[];
|
|
5974
|
-
}[];
|
|
5975
|
-
/** @default null */
|
|
5976
|
-
assignment_choice_summary: {
|
|
5977
|
-
/** @constant */
|
|
5978
|
-
strategy: "least-busy";
|
|
5979
|
-
selected: {
|
|
5980
|
-
agent_id: number;
|
|
5981
|
-
agent_name: string;
|
|
5982
|
-
active_sessions: number;
|
|
5983
|
-
active_sessions_in_group: number;
|
|
5984
|
-
pending_sessions: number;
|
|
5985
|
-
remaining_capacity: number;
|
|
5986
|
-
max_capacity: number;
|
|
5987
|
-
max_capacity_in_group: number | null;
|
|
5988
|
-
is_available_globally: boolean;
|
|
5989
|
-
is_available_in_group: boolean;
|
|
5990
|
-
/** @default [] */
|
|
5991
|
-
missing_required_skills: {
|
|
5992
|
-
id: string;
|
|
5993
|
-
name: string;
|
|
5994
|
-
}[];
|
|
5995
|
-
} | null;
|
|
5996
|
-
peers: {
|
|
5997
|
-
agent_id: number;
|
|
5998
|
-
agent_name: string;
|
|
5999
|
-
active_sessions: number;
|
|
6000
|
-
active_sessions_in_group: number;
|
|
6001
|
-
pending_sessions: number;
|
|
6002
|
-
remaining_capacity: number;
|
|
6003
|
-
max_capacity: number;
|
|
6004
|
-
max_capacity_in_group: number | null;
|
|
6005
|
-
is_available_globally: boolean;
|
|
6006
|
-
is_available_in_group: boolean;
|
|
6007
|
-
/** @default [] */
|
|
6008
|
-
missing_required_skills: {
|
|
6009
|
-
id: string;
|
|
6010
|
-
name: string;
|
|
6011
|
-
}[];
|
|
6012
|
-
}[];
|
|
6013
|
-
/** @default [] */
|
|
6014
|
-
required_skills: {
|
|
6015
|
-
id: string;
|
|
6016
|
-
name: string;
|
|
6017
|
-
}[];
|
|
6018
|
-
} | null;
|
|
6019
|
-
destination_id?: string;
|
|
6020
|
-
destination_name?: string;
|
|
6021
|
-
/** @enum {string} */
|
|
6022
|
-
destination_type?: "phone" | "sip" | "hangup";
|
|
6023
|
-
transfer_reason?: string | null;
|
|
6024
|
-
is_failover?: boolean;
|
|
6025
|
-
/** @enum {string} */
|
|
6026
|
-
failover_source?: "stt" | "llm" | "tts";
|
|
6027
|
-
/** @enum {string} */
|
|
6028
|
-
hangup_initiator?: "user" | "agent" | "system";
|
|
6029
|
-
hangup_reason?: string;
|
|
6030
|
-
duration_seconds?: number;
|
|
6031
|
-
/** @enum {string} */
|
|
6032
|
-
call_direction?: "inbound" | "outbound";
|
|
6033
|
-
}) | null;
|
|
6034
|
-
knowledgebase_called?: boolean | null;
|
|
6035
|
-
/** @enum {string} */
|
|
6036
|
-
type: "agent_assigned_by_integration" | "agent_assigned_by_system" | "agent_assigned_by_user" | "agent_changed" | "agent_comment" | "agent_initiated_session" | "agent_joined" | "agent_message" | "agent_reopened_session" | "agent_took_session_from_ai" | "agent_unassigned_by_integration" | "agent_unassigned_by_system" | "agent_unassigned_by_user" | "ai_assumed_the_session_resolved" | "ai_decided_to_not_reply" | "ai_decided_to_resolve_the_issue" | "ai_reopened_session" | "ai_response_cancelled" | "ai_resumed_by_system" | "call_history" | "call_transferred" | "closed_resolved_by_agent" | "closed_resolved_by_api" | "closed_resolved_by_contact" | "closed_resolved_by_integration" | "closed_resolved_by_system" | "closed_unresolved_by_agent" | "closed_unresolved_by_api" | "closed_unresolved_by_system" | "contact_data_updated" | "csat_requested" | "csat_submitted" | "email_draft_message" | "handoff" | "handoff_to_salesforce_miaw" | "handoff_to_zendesk" | "integration_reopened_session" | "message" | "prohibited_topic_detected" | "sequence_message" | "skills_added_by_system" | "sla_applied_by_agent" | "sla_applied_by_system" | "sla_first_reply_breached" | "sla_first_reply_completed_after_breach" | "sla_first_reply_fulfilled" | "sla_first_reply_metric_started" | "sla_freezed_office_hours_ended" | "sla_freezed_snoozed" | "sla_next_reply_breached" | "sla_next_reply_completed_after_breach" | "sla_next_reply_fulfilled" | "sla_next_reply_metric_started" | "sla_removed_by_agent" | "sla_removed_by_system" | "sla_resolution_breached" | "sla_resolution_completed_after_breach" | "sla_resolution_fulfilled" | "sla_resolution_metric_started" | "sla_resolution_paused_resolved" | "sla_resolution_paused_waiting_on_customer" | "sla_resolution_resumed_customer_replied" | "sla_resolution_resumed_reopened" | "sla_resumed_office_hours_started" | "sla_resumed_snooze_cancelled" | "sla_resumed_snooze_expired" | "state_checkpoint" | "sub_status_removed_by_agent" | "sub_status_removed_by_api" | "sub_status_removed_by_integration" | "sub_status_removed_by_system" | "sub_status_set_by_agent" | "sub_status_set_by_api" | "sub_status_set_by_integration" | "sub_status_set_by_system" | "system_reopened_session" | "tag_added_by_agent" | "tag_added_by_api" | "tag_added_by_integration" | "tag_added_by_system" | "tag_removed_by_agent" | "tag_removed_by_api" | "tag_removed_by_integration" | "tag_removed_by_system" | "team_assigned_by_integration" | "team_assigned_by_system" | "team_assigned_by_user" | "team_unassigned_by_integration" | "team_unassigned_by_system" | "team_unassigned_by_user" | "user_confirmed_the_session_resolved" | "workflow_message" | "workflow_note" | "workflow_triggered";
|
|
6037
|
-
extra_params?: {
|
|
6038
|
-
[key: string]: unknown;
|
|
6039
|
-
} | null;
|
|
6040
|
-
agent_id?: number | null;
|
|
6041
|
-
agent_name?: string | null;
|
|
6042
|
-
agent_avatar?: string | null;
|
|
6043
|
-
handoff_happened_during_office_hours?: boolean | null;
|
|
6044
|
-
sender_display_name?: string | null;
|
|
6045
|
-
plan_executed?: boolean | null;
|
|
6046
|
-
contact_id?: string | null;
|
|
6047
|
-
contact_name?: string | null;
|
|
6048
|
-
contact_avatar_url?: string | null;
|
|
6049
|
-
contact_source?: ("csv" | "form" | "freshchat" | "hubspot" | "intercom" | "pipedream" | "salesforce" | "slack") | null;
|
|
6050
|
-
contact_slack_data?: string | null;
|
|
6051
|
-
attachments?: components["schemas"]["ChatAttachmentDto"][] | null;
|
|
6052
|
-
email_rfc_message_id?: string | null;
|
|
6053
|
-
email_to?: string[] | null;
|
|
6054
|
-
email_cc?: string[] | null;
|
|
6055
|
-
external_message_id?: string | null;
|
|
6056
|
-
csat_score?: number | null;
|
|
6057
|
-
csat_feedback?: string | null;
|
|
6058
|
-
state_checkpoint_payload?: unknown | null;
|
|
6059
|
-
client_context?: {
|
|
6060
|
-
[key: string]: unknown;
|
|
6061
|
-
} | null;
|
|
6062
|
-
workflow_id?: string | null;
|
|
6063
|
-
workflow_run_id?: string | null;
|
|
6064
|
-
sequence_id?: string | null;
|
|
6065
|
-
whatsapp_template_name?: string | null;
|
|
6066
|
-
from_opencx_public_api?: boolean | null;
|
|
6067
|
-
sub_status_id?: string | null;
|
|
6068
|
-
whatsapp_sent_at?: string | null;
|
|
6069
|
-
whatsapp_delivered_at?: string | null;
|
|
6070
|
-
whatsapp_read_at?: string | null;
|
|
6071
|
-
whatsapp_failed_at?: string | null;
|
|
6072
|
-
whatsapp_error_title?: string | null;
|
|
6073
|
-
whatsapp_error_details?: string | null;
|
|
6074
|
-
session_closed_payload: unknown;
|
|
6075
|
-
agent_changed_payload?: components["schemas"]["AgentChangedPayload"] | null;
|
|
6076
|
-
comment_thread_id?: string | null;
|
|
6077
|
-
edited_at?: string | null;
|
|
6078
|
-
deleted_at?: string | null;
|
|
6079
|
-
};
|
|
6080
|
-
PhoneAgentDto: {
|
|
6081
|
-
id: string;
|
|
6082
|
-
org_id: string;
|
|
6083
|
-
phone_number: string | null;
|
|
6084
|
-
name: string | null;
|
|
6085
5841
|
/** @enum {string} */
|
|
6086
|
-
|
|
6087
|
-
language: string[];
|
|
6088
|
-
accent: string | null;
|
|
6089
|
-
handoff_phone_number: string | null;
|
|
6090
|
-
speed: number | null;
|
|
6091
|
-
interruptible: boolean;
|
|
6092
|
-
actionIds: string[] | null;
|
|
6093
|
-
instructions: string[] | null;
|
|
6094
|
-
data_collection_fields: string[] | null;
|
|
6095
|
-
data_collection_webhook_url: string | null;
|
|
5842
|
+
direction: "inbound" | "outbound";
|
|
6096
5843
|
/** @enum {string} */
|
|
6097
|
-
|
|
6098
|
-
|
|
6099
|
-
|
|
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;
|
|
6100
5862
|
/** Format: date-time */
|
|
6101
5863
|
created_at: string;
|
|
6102
|
-
|
|
6103
|
-
updated_at: string;
|
|
6104
|
-
provider_external_id: string | null;
|
|
6105
|
-
flow: unknown | null;
|
|
6106
|
-
custom_llm: string | null;
|
|
6107
|
-
use_org_knowledgebase: boolean;
|
|
6108
|
-
background_noise_preset: ("office" | "bar" | "city-street") | null;
|
|
6109
|
-
recording_enabled: boolean;
|
|
6110
|
-
stt_keyterms: string[];
|
|
6111
|
-
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;
|
|
6112
|
-
tts_speed_pct: number | null;
|
|
6113
|
-
failover_transfer_destination_id: string | null;
|
|
6114
|
-
};
|
|
6115
|
-
PhoneAgentVoiceDto: {
|
|
6116
|
-
voice_id: string;
|
|
6117
|
-
name: string;
|
|
6118
|
-
labels: {
|
|
6119
|
-
accent: string | null;
|
|
6120
|
-
description: string | null;
|
|
6121
|
-
age: string | null;
|
|
6122
|
-
gender: string | null;
|
|
6123
|
-
use_case: string | null;
|
|
6124
|
-
language: string | null;
|
|
6125
|
-
};
|
|
6126
|
-
description: string | null;
|
|
6127
|
-
preview_url: string | null;
|
|
5864
|
+
events: components["schemas"]["PhoneCallEventDto"][];
|
|
6128
5865
|
};
|
|
6129
5866
|
KnowledgeSourceTreeItemDto: {
|
|
6130
5867
|
id: string;
|
|
@@ -6190,6 +5927,7 @@ export interface components {
|
|
|
6190
5927
|
/** @enum {string} */
|
|
6191
5928
|
support_assignment_strategy: "least-busy" | "round-robin" | "unassigned";
|
|
6192
5929
|
zendesk_group_id: string | null;
|
|
5930
|
+
zendesk_group_channels: components["schemas"]["SessionChannel"][] | null;
|
|
6193
5931
|
created_at: string | null;
|
|
6194
5932
|
updated_at: string | null;
|
|
6195
5933
|
deleted_at: string | null;
|
|
@@ -6269,24 +6007,414 @@ export interface components {
|
|
|
6269
6007
|
or: {
|
|
6270
6008
|
and: components["schemas"]["ContactsFilter"][];
|
|
6271
6009
|
}[];
|
|
6272
|
-
} | null;
|
|
6273
|
-
steps: components["schemas"]["SequenceStep"][];
|
|
6274
|
-
is_continuous: boolean;
|
|
6275
|
-
started_at: string | null;
|
|
6276
|
-
canceled_at: string | null;
|
|
6277
|
-
ended_at: string | null;
|
|
6278
|
-
status: components["schemas"]["SequenceStatus"] | null;
|
|
6279
|
-
};
|
|
6280
|
-
StartOneOffSequenceOutputDto: {
|
|
6281
|
-
data?: {
|
|
6282
|
-
success: boolean;
|
|
6283
|
-
};
|
|
6284
|
-
error?: {
|
|
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
|
+
};
|
|
6029
|
+
AgentChangedPayload: {
|
|
6030
|
+
/** @constant */
|
|
6031
|
+
from: "ai";
|
|
6032
|
+
/** @constant */
|
|
6033
|
+
to: "human_agent";
|
|
6034
|
+
agent_id: number | null;
|
|
6035
|
+
} | {
|
|
6036
|
+
/** @constant */
|
|
6037
|
+
from: "human_agent";
|
|
6038
|
+
/** @constant */
|
|
6039
|
+
to: "ai";
|
|
6040
|
+
agent_id: number;
|
|
6041
|
+
} | {
|
|
6042
|
+
/** @constant */
|
|
6043
|
+
from: "human_agent";
|
|
6044
|
+
/** @constant */
|
|
6045
|
+
to: "human_agent";
|
|
6046
|
+
agent_id: number;
|
|
6047
|
+
old_agent_id: number;
|
|
6048
|
+
} | {
|
|
6049
|
+
/** @constant */
|
|
6050
|
+
from: "human_agent";
|
|
6051
|
+
/** @constant */
|
|
6052
|
+
to: "unassigned";
|
|
6053
|
+
} | {
|
|
6054
|
+
/** @constant */
|
|
6055
|
+
from: "ai";
|
|
6056
|
+
/** @constant */
|
|
6057
|
+
to: "unassigned";
|
|
6058
|
+
} | {
|
|
6059
|
+
/** @constant */
|
|
6060
|
+
from: "unassigned";
|
|
6061
|
+
/** @constant */
|
|
6062
|
+
to: "human_agent";
|
|
6063
|
+
agent_id: number;
|
|
6064
|
+
} | {
|
|
6065
|
+
/** @constant */
|
|
6066
|
+
from: "unassigned";
|
|
6067
|
+
/** @constant */
|
|
6068
|
+
to: "ai";
|
|
6069
|
+
};
|
|
6070
|
+
ChatHistoryDto: {
|
|
6071
|
+
id: number;
|
|
6072
|
+
uuid: string;
|
|
6073
|
+
chatbot_id?: string | null;
|
|
6074
|
+
session_id: string;
|
|
6075
|
+
from_user?: boolean | null;
|
|
6076
|
+
message?: string | null;
|
|
6077
|
+
original_message?: string | null;
|
|
6078
|
+
original_language?: string | null;
|
|
6079
|
+
translated_message?: string | null;
|
|
6080
|
+
translated_language?: string | null;
|
|
6081
|
+
created_at?: string | null;
|
|
6082
|
+
updated_at?: string | null;
|
|
6083
|
+
debug_json?: ({
|
|
6084
|
+
v2: {
|
|
6085
|
+
response: ({
|
|
6086
|
+
/** @constant */
|
|
6087
|
+
type: "prohibited_topic";
|
|
6088
|
+
topic: string;
|
|
6089
|
+
} | {
|
|
6090
|
+
/** @constant */
|
|
6091
|
+
type: "response_skipped";
|
|
6092
|
+
/** @enum {string} */
|
|
6093
|
+
reason?: "empty_response" | "potential_answers_dead_end" | "silent_handoff" | "superseded_by_newer_run" | "flagged_as_spam";
|
|
6094
|
+
reasoning?: ({
|
|
6095
|
+
/** @constant */
|
|
6096
|
+
type: "reasoning";
|
|
6097
|
+
content: string;
|
|
6098
|
+
} | {
|
|
6099
|
+
/** @constant */
|
|
6100
|
+
type: "tool_call";
|
|
6101
|
+
call_id: string;
|
|
6102
|
+
tool_name: string;
|
|
6103
|
+
action?: {
|
|
6104
|
+
name: string;
|
|
6105
|
+
id: string;
|
|
6106
|
+
openapi?: {
|
|
6107
|
+
openapi_spec_id?: string;
|
|
6108
|
+
operation_spec: unknown;
|
|
6109
|
+
operation_id?: string;
|
|
6110
|
+
operation_method?: string;
|
|
6111
|
+
};
|
|
6112
|
+
metadata: unknown;
|
|
6113
|
+
required_form_submission?: boolean;
|
|
6114
|
+
is_handoff_like?: boolean;
|
|
6115
|
+
};
|
|
6116
|
+
call_arguments: string;
|
|
6117
|
+
call_result: string;
|
|
6118
|
+
})[];
|
|
6119
|
+
context?: {
|
|
6120
|
+
knowledgeBaseItems: {
|
|
6121
|
+
itemId: string;
|
|
6122
|
+
chunkIndex: number;
|
|
6123
|
+
title: string;
|
|
6124
|
+
url?: string;
|
|
6125
|
+
}[];
|
|
6126
|
+
instructions: {
|
|
6127
|
+
id: string;
|
|
6128
|
+
title: string;
|
|
6129
|
+
}[];
|
|
6130
|
+
tools: {
|
|
6131
|
+
name: string;
|
|
6132
|
+
}[];
|
|
6133
|
+
};
|
|
6134
|
+
suppressedResponseText?: string;
|
|
6135
|
+
reasoningSummary?: string;
|
|
6136
|
+
} | {
|
|
6137
|
+
/** @constant */
|
|
6138
|
+
type: "response";
|
|
6139
|
+
responseText: string;
|
|
6140
|
+
responseTextWithReferences: string;
|
|
6141
|
+
context: {
|
|
6142
|
+
knowledgeBaseItems: {
|
|
6143
|
+
itemId: string;
|
|
6144
|
+
chunkIndex: number;
|
|
6145
|
+
title: string;
|
|
6146
|
+
url?: string;
|
|
6147
|
+
}[];
|
|
6148
|
+
instructions: {
|
|
6149
|
+
id: string;
|
|
6150
|
+
title: string;
|
|
6151
|
+
}[];
|
|
6152
|
+
tools: {
|
|
6153
|
+
name: string;
|
|
6154
|
+
}[];
|
|
6155
|
+
};
|
|
6156
|
+
reasoning: ({
|
|
6157
|
+
/** @constant */
|
|
6158
|
+
type: "reasoning";
|
|
6159
|
+
content: string;
|
|
6160
|
+
} | {
|
|
6161
|
+
/** @constant */
|
|
6162
|
+
type: "tool_call";
|
|
6163
|
+
call_id: string;
|
|
6164
|
+
tool_name: string;
|
|
6165
|
+
action?: {
|
|
6166
|
+
name: string;
|
|
6167
|
+
id: string;
|
|
6168
|
+
openapi?: {
|
|
6169
|
+
openapi_spec_id?: string;
|
|
6170
|
+
operation_spec: unknown;
|
|
6171
|
+
operation_id?: string;
|
|
6172
|
+
operation_method?: string;
|
|
6173
|
+
};
|
|
6174
|
+
metadata: unknown;
|
|
6175
|
+
required_form_submission?: boolean;
|
|
6176
|
+
is_handoff_like?: boolean;
|
|
6177
|
+
};
|
|
6178
|
+
call_arguments: string;
|
|
6179
|
+
call_result: string;
|
|
6180
|
+
})[];
|
|
6181
|
+
reasoningSummary?: string;
|
|
6182
|
+
/** @description Quick reply suggestions for the user */
|
|
6183
|
+
quickReplySuggestions: {
|
|
6184
|
+
toolName?: string | null;
|
|
6185
|
+
suggestions: string[];
|
|
6186
|
+
}[];
|
|
6187
|
+
/** @description If your answer might solve the user's issue, return true, otherwise false. Note: once the user confirms it is solved, stop returning true */
|
|
6188
|
+
mightSolveUserIssue: boolean;
|
|
6189
|
+
/** @description True if your answer to the user completely covers the issue from knowledge and tools, and no further user input is needed. False if your answer is generic or is not specific to the issue. */
|
|
6190
|
+
completelyAndFullyCoveredUserIssue?: boolean;
|
|
6191
|
+
}) & {
|
|
6192
|
+
/** @enum {string} */
|
|
6193
|
+
language: "en" | "fr" | "de" | "nl" | "pl" | "pt" | "es" | "it" | "ru" | "ja" | "ko" | "zh" | "ar" | "tr" | "sv" | "da" | "no" | "fi" | "el" | "cs" | "hu" | "th" | "vi" | "id" | "he" | "hi" | "uk" | "ro" | "bg" | "hr" | "sk" | "sl" | "sr" | "et" | "lv" | "lt" | "is" | "ga" | "ms" | "tl" | "fa" | "bn" | "ta" | "te" | "ur" | "sw" | "zu" | "af" | "sq" | "hy" | "az" | "eu" | "be" | "bs" | "ca" | "cy" | "ku" | "ckb" | "kmr";
|
|
6194
|
+
};
|
|
6195
|
+
};
|
|
6196
|
+
actionCalls?: {
|
|
6197
|
+
action: {
|
|
6198
|
+
name: string;
|
|
6199
|
+
id: string;
|
|
6200
|
+
openapi?: {
|
|
6201
|
+
openapi_spec_id?: string;
|
|
6202
|
+
operation_spec: unknown;
|
|
6203
|
+
operation_id?: string;
|
|
6204
|
+
operation_method?: string;
|
|
6205
|
+
};
|
|
6206
|
+
metadata: unknown;
|
|
6207
|
+
required_form_submission?: boolean;
|
|
6208
|
+
is_handoff_like?: boolean;
|
|
6209
|
+
};
|
|
6210
|
+
arguments: unknown;
|
|
6211
|
+
result: unknown;
|
|
6212
|
+
}[];
|
|
6213
|
+
/** @default null */
|
|
6214
|
+
assignment_choice_summary: {
|
|
6215
|
+
/** @constant */
|
|
6216
|
+
strategy: "least-busy";
|
|
6217
|
+
selected: {
|
|
6218
|
+
agent_id: number;
|
|
6219
|
+
agent_name: string;
|
|
6220
|
+
active_sessions: number;
|
|
6221
|
+
active_sessions_in_group: number;
|
|
6222
|
+
pending_sessions: number;
|
|
6223
|
+
remaining_capacity: number;
|
|
6224
|
+
max_capacity: number;
|
|
6225
|
+
max_capacity_in_group: number | null;
|
|
6226
|
+
is_available_globally: boolean;
|
|
6227
|
+
is_available_in_group: boolean;
|
|
6228
|
+
/** @default [] */
|
|
6229
|
+
missing_required_skills: {
|
|
6230
|
+
id: string;
|
|
6231
|
+
name: string;
|
|
6232
|
+
}[];
|
|
6233
|
+
} | null;
|
|
6234
|
+
peers: {
|
|
6235
|
+
agent_id: number;
|
|
6236
|
+
agent_name: string;
|
|
6237
|
+
active_sessions: number;
|
|
6238
|
+
active_sessions_in_group: number;
|
|
6239
|
+
pending_sessions: number;
|
|
6240
|
+
remaining_capacity: number;
|
|
6241
|
+
max_capacity: number;
|
|
6242
|
+
max_capacity_in_group: number | null;
|
|
6243
|
+
is_available_globally: boolean;
|
|
6244
|
+
is_available_in_group: boolean;
|
|
6245
|
+
/** @default [] */
|
|
6246
|
+
missing_required_skills: {
|
|
6247
|
+
id: string;
|
|
6248
|
+
name: string;
|
|
6249
|
+
}[];
|
|
6250
|
+
}[];
|
|
6251
|
+
/** @default [] */
|
|
6252
|
+
required_skills: {
|
|
6253
|
+
id: string;
|
|
6254
|
+
name: string;
|
|
6255
|
+
}[];
|
|
6256
|
+
} | null;
|
|
6257
|
+
custom_data?: {
|
|
6258
|
+
[key: string]: unknown;
|
|
6259
|
+
} | null;
|
|
6260
|
+
} | {
|
|
6261
|
+
actionCalls?: {
|
|
6262
|
+
action: {
|
|
6263
|
+
name: string;
|
|
6264
|
+
id: string;
|
|
6265
|
+
openapi?: {
|
|
6266
|
+
openapi_spec_id?: string;
|
|
6267
|
+
operation_spec: unknown;
|
|
6268
|
+
operation_id?: string;
|
|
6269
|
+
operation_method?: string;
|
|
6270
|
+
};
|
|
6271
|
+
metadata: unknown;
|
|
6272
|
+
required_form_submission?: boolean;
|
|
6273
|
+
is_handoff_like?: boolean;
|
|
6274
|
+
};
|
|
6275
|
+
arguments: unknown;
|
|
6276
|
+
result: unknown;
|
|
6277
|
+
}[];
|
|
6278
|
+
actionSearchQuery?: string;
|
|
6279
|
+
knowledge?: {
|
|
6280
|
+
source: string;
|
|
6281
|
+
source_type: string;
|
|
6282
|
+
url: string;
|
|
6283
|
+
}[];
|
|
6284
|
+
knowledge_used?: {
|
|
6285
|
+
content: string;
|
|
6286
|
+
source: string;
|
|
6287
|
+
}[];
|
|
6288
|
+
work_instructions_scanned?: {
|
|
6289
|
+
content: string;
|
|
6290
|
+
}[];
|
|
6291
|
+
/** @description Context provided from the client. For example, dynamic metadata sent from the widget such as: the current product name on the page, the current Shopify shop domain, etc etc. */
|
|
6292
|
+
client_context?: {
|
|
6293
|
+
[key: string]: unknown;
|
|
6294
|
+
} | null;
|
|
6295
|
+
/** @description Org-specific or message-type-specific debug data. */
|
|
6296
|
+
additional_debug_data?: {
|
|
6297
|
+
[key: string]: unknown;
|
|
6298
|
+
} | null;
|
|
6299
|
+
custom_data?: {
|
|
6300
|
+
[key: string]: unknown;
|
|
6301
|
+
} | null;
|
|
6302
|
+
whatsapp_template_request?: unknown | null;
|
|
6303
|
+
rule_violation_reflections?: {
|
|
6304
|
+
rule_name: string;
|
|
6305
|
+
/** @description How the rule was violated */
|
|
6306
|
+
violation_description: string;
|
|
6307
|
+
}[];
|
|
6308
|
+
tool_call_results_quick_reply_suggestions?: {
|
|
6309
|
+
tool_name: string;
|
|
6310
|
+
suggestions: string[];
|
|
6311
|
+
}[];
|
|
6312
|
+
/** @default null */
|
|
6313
|
+
assignment_choice_summary: {
|
|
6314
|
+
/** @constant */
|
|
6315
|
+
strategy: "least-busy";
|
|
6316
|
+
selected: {
|
|
6317
|
+
agent_id: number;
|
|
6318
|
+
agent_name: string;
|
|
6319
|
+
active_sessions: number;
|
|
6320
|
+
active_sessions_in_group: number;
|
|
6321
|
+
pending_sessions: number;
|
|
6322
|
+
remaining_capacity: number;
|
|
6323
|
+
max_capacity: number;
|
|
6324
|
+
max_capacity_in_group: number | null;
|
|
6325
|
+
is_available_globally: boolean;
|
|
6326
|
+
is_available_in_group: boolean;
|
|
6327
|
+
/** @default [] */
|
|
6328
|
+
missing_required_skills: {
|
|
6329
|
+
id: string;
|
|
6330
|
+
name: string;
|
|
6331
|
+
}[];
|
|
6332
|
+
} | null;
|
|
6333
|
+
peers: {
|
|
6334
|
+
agent_id: number;
|
|
6335
|
+
agent_name: string;
|
|
6336
|
+
active_sessions: number;
|
|
6337
|
+
active_sessions_in_group: number;
|
|
6338
|
+
pending_sessions: number;
|
|
6339
|
+
remaining_capacity: number;
|
|
6340
|
+
max_capacity: number;
|
|
6341
|
+
max_capacity_in_group: number | null;
|
|
6342
|
+
is_available_globally: boolean;
|
|
6343
|
+
is_available_in_group: boolean;
|
|
6344
|
+
/** @default [] */
|
|
6345
|
+
missing_required_skills: {
|
|
6346
|
+
id: string;
|
|
6347
|
+
name: string;
|
|
6348
|
+
}[];
|
|
6349
|
+
}[];
|
|
6350
|
+
/** @default [] */
|
|
6351
|
+
required_skills: {
|
|
6352
|
+
id: string;
|
|
6353
|
+
name: string;
|
|
6354
|
+
}[];
|
|
6355
|
+
} | null;
|
|
6356
|
+
destination_id?: string;
|
|
6357
|
+
destination_name?: string;
|
|
6285
6358
|
/** @enum {string} */
|
|
6286
|
-
|
|
6287
|
-
|
|
6288
|
-
|
|
6289
|
-
|
|
6359
|
+
destination_type?: "phone" | "sip" | "hangup";
|
|
6360
|
+
transfer_reason?: string | null;
|
|
6361
|
+
is_failover?: boolean;
|
|
6362
|
+
/** @enum {string} */
|
|
6363
|
+
failover_source?: "stt" | "llm" | "tts";
|
|
6364
|
+
/** @enum {string} */
|
|
6365
|
+
hangup_initiator?: "user" | "agent" | "system";
|
|
6366
|
+
hangup_reason?: string;
|
|
6367
|
+
duration_seconds?: number;
|
|
6368
|
+
/** @enum {string} */
|
|
6369
|
+
call_direction?: "inbound" | "outbound";
|
|
6370
|
+
}) | null;
|
|
6371
|
+
knowledgebase_called?: boolean | null;
|
|
6372
|
+
/** @enum {string} */
|
|
6373
|
+
type: "agent_assigned_by_integration" | "agent_assigned_by_system" | "agent_assigned_by_user" | "agent_changed" | "agent_comment" | "agent_initiated_session" | "agent_joined" | "agent_message" | "agent_reopened_session" | "agent_took_session_from_ai" | "agent_unassigned_by_integration" | "agent_unassigned_by_system" | "agent_unassigned_by_user" | "ai_assumed_the_session_resolved" | "ai_decided_to_not_reply" | "ai_decided_to_resolve_the_issue" | "ai_reopened_session" | "ai_response_cancelled" | "ai_resumed_by_system" | "call_history" | "call_transferred" | "closed_resolved_by_agent" | "closed_resolved_by_api" | "closed_resolved_by_contact" | "closed_resolved_by_integration" | "closed_resolved_by_system" | "closed_unresolved_by_agent" | "closed_unresolved_by_api" | "closed_unresolved_by_system" | "contact_data_updated" | "csat_requested" | "csat_submitted" | "email_draft_message" | "handoff" | "handoff_to_salesforce_miaw" | "handoff_to_zendesk" | "integration_reopened_session" | "message" | "prohibited_topic_detected" | "sequence_message" | "skills_added_by_system" | "sla_applied_by_agent" | "sla_applied_by_system" | "sla_first_reply_breached" | "sla_first_reply_completed_after_breach" | "sla_first_reply_fulfilled" | "sla_first_reply_metric_started" | "sla_freezed_office_hours_ended" | "sla_freezed_snoozed" | "sla_next_reply_breached" | "sla_next_reply_completed_after_breach" | "sla_next_reply_fulfilled" | "sla_next_reply_metric_started" | "sla_removed_by_agent" | "sla_removed_by_system" | "sla_resolution_breached" | "sla_resolution_completed_after_breach" | "sla_resolution_fulfilled" | "sla_resolution_metric_started" | "sla_resolution_paused_resolved" | "sla_resolution_paused_waiting_on_customer" | "sla_resolution_resumed_customer_replied" | "sla_resolution_resumed_reopened" | "sla_resumed_office_hours_started" | "sla_resumed_snooze_cancelled" | "sla_resumed_snooze_expired" | "state_checkpoint" | "sub_status_removed_by_agent" | "sub_status_removed_by_api" | "sub_status_removed_by_integration" | "sub_status_removed_by_system" | "sub_status_set_by_agent" | "sub_status_set_by_api" | "sub_status_set_by_integration" | "sub_status_set_by_system" | "system_reopened_session" | "tag_added_by_agent" | "tag_added_by_api" | "tag_added_by_integration" | "tag_added_by_system" | "tag_removed_by_agent" | "tag_removed_by_api" | "tag_removed_by_integration" | "tag_removed_by_system" | "team_assigned_by_integration" | "team_assigned_by_system" | "team_assigned_by_user" | "team_unassigned_by_integration" | "team_unassigned_by_system" | "team_unassigned_by_user" | "user_confirmed_the_session_resolved" | "workflow_message" | "workflow_note" | "workflow_triggered";
|
|
6374
|
+
extra_params?: {
|
|
6375
|
+
[key: string]: unknown;
|
|
6376
|
+
} | null;
|
|
6377
|
+
agent_id?: number | null;
|
|
6378
|
+
agent_name?: string | null;
|
|
6379
|
+
agent_avatar?: string | null;
|
|
6380
|
+
handoff_happened_during_office_hours?: boolean | null;
|
|
6381
|
+
sender_display_name?: string | null;
|
|
6382
|
+
plan_executed?: boolean | null;
|
|
6383
|
+
contact_id?: string | null;
|
|
6384
|
+
contact_name?: string | null;
|
|
6385
|
+
contact_avatar_url?: string | null;
|
|
6386
|
+
contact_source?: ("csv" | "form" | "freshchat" | "hubspot" | "intercom" | "pipedream" | "salesforce" | "slack") | null;
|
|
6387
|
+
contact_slack_data?: string | null;
|
|
6388
|
+
attachments?: components["schemas"]["ChatAttachmentDto"][] | null;
|
|
6389
|
+
email_rfc_message_id?: string | null;
|
|
6390
|
+
email_to?: string[] | null;
|
|
6391
|
+
email_cc?: string[] | null;
|
|
6392
|
+
external_message_id?: string | null;
|
|
6393
|
+
csat_score?: number | null;
|
|
6394
|
+
csat_feedback?: string | null;
|
|
6395
|
+
state_checkpoint_payload?: unknown | null;
|
|
6396
|
+
client_context?: {
|
|
6397
|
+
[key: string]: unknown;
|
|
6398
|
+
} | null;
|
|
6399
|
+
workflow_id?: string | null;
|
|
6400
|
+
workflow_run_id?: string | null;
|
|
6401
|
+
sequence_id?: string | null;
|
|
6402
|
+
whatsapp_template_name?: string | null;
|
|
6403
|
+
from_opencx_public_api?: boolean | null;
|
|
6404
|
+
sub_status_id?: string | null;
|
|
6405
|
+
whatsapp_sent_at?: string | null;
|
|
6406
|
+
whatsapp_delivered_at?: string | null;
|
|
6407
|
+
whatsapp_read_at?: string | null;
|
|
6408
|
+
whatsapp_failed_at?: string | null;
|
|
6409
|
+
whatsapp_error_title?: string | null;
|
|
6410
|
+
whatsapp_error_details?: string | null;
|
|
6411
|
+
session_closed_payload: unknown;
|
|
6412
|
+
agent_changed_payload?: components["schemas"]["AgentChangedPayload"] | null;
|
|
6413
|
+
comment_thread_id?: string | null;
|
|
6414
|
+
edited_at?: string | null;
|
|
6415
|
+
deleted_at?: string | null;
|
|
6416
|
+
phone_call_id?: string | null;
|
|
6417
|
+
phone_call?: components["schemas"]["PhoneCallDto"] | null;
|
|
6290
6418
|
};
|
|
6291
6419
|
SankeyReportResDto: {
|
|
6292
6420
|
nodes: {
|
|
@@ -6329,6 +6457,52 @@ export interface components {
|
|
|
6329
6457
|
customDataKeys?: string[];
|
|
6330
6458
|
}[];
|
|
6331
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
|
+
};
|
|
6332
6506
|
EmailTemplateActivityItemDto: {
|
|
6333
6507
|
id: string;
|
|
6334
6508
|
from_email: string;
|
|
@@ -7141,7 +7315,7 @@ export interface components {
|
|
|
7141
7315
|
} | ({
|
|
7142
7316
|
/** @constant */
|
|
7143
7317
|
success: true;
|
|
7144
|
-
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";
|
|
7145
7319
|
autopilotResponse?: {
|
|
7146
7320
|
/** @constant */
|
|
7147
7321
|
type: "text";
|
|
@@ -7749,9 +7923,9 @@ export interface components {
|
|
|
7749
7923
|
/** @enum {string} */
|
|
7750
7924
|
visibility: "internal" | "public";
|
|
7751
7925
|
/** @enum {string} */
|
|
7752
|
-
source_type: "custom_training" | "help_center" | "integration" | "website";
|
|
7926
|
+
source_type: "custom_training" | "help_center" | "integration" | "website" | "workflow";
|
|
7753
7927
|
/** @description External source the item was synced from (present when listing). */
|
|
7754
|
-
data_source?: ("confluence" | "notion" | "zendesk_support" | "shopify" | "gitbook" | "intercom" | "front" | "freshdesk" | "hubspot_kb" | "ai_instructions" | "custom_training" | "website") | null;
|
|
7928
|
+
data_source?: ("confluence" | "notion" | "zendesk_support" | "shopify" | "gitbook" | "intercom" | "front" | "freshdesk" | "hubspot_kb" | "ai_instructions" | "custom_training" | "website" | "workflow") | null;
|
|
7755
7929
|
stream?: string | null;
|
|
7756
7930
|
source_url: string | null;
|
|
7757
7931
|
/** @description Contact segment ids this item is restricted to. Empty = available to all contacts. */
|
|
@@ -8084,7 +8258,7 @@ export interface components {
|
|
|
8084
8258
|
/** Format: email */
|
|
8085
8259
|
email: string;
|
|
8086
8260
|
avatar_url?: string | null;
|
|
8087
|
-
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;
|
|
8088
8262
|
};
|
|
8089
8263
|
OrgUserDetail: {
|
|
8090
8264
|
id: number;
|
|
@@ -8093,7 +8267,7 @@ export interface components {
|
|
|
8093
8267
|
/** Format: email */
|
|
8094
8268
|
email: string;
|
|
8095
8269
|
avatar_url?: string | null;
|
|
8096
|
-
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;
|
|
8097
8271
|
teams: {
|
|
8098
8272
|
group: components["schemas"]["GroupDto"];
|
|
8099
8273
|
is_user_available_on_group: boolean;
|
|
@@ -8171,6 +8345,10 @@ export interface components {
|
|
|
8171
8345
|
error: string;
|
|
8172
8346
|
}[];
|
|
8173
8347
|
};
|
|
8348
|
+
PublicVocSettingsDto: {
|
|
8349
|
+
/** @description Dashboard: Customer Insights → Settings → AI Instructions. Org-specific analysis constraints injected into the VOC insights analyzer for future runs. Max 1000 chars. Null means unset. */
|
|
8350
|
+
custom_analysis_instructions: string | null;
|
|
8351
|
+
};
|
|
8174
8352
|
SendTemplateOutputDto: {
|
|
8175
8353
|
whatsapp_message_id: string;
|
|
8176
8354
|
opencx_message_id: string;
|
|
@@ -8528,12 +8706,18 @@ export interface components {
|
|
|
8528
8706
|
/** Format: date-time */
|
|
8529
8707
|
created_at: string;
|
|
8530
8708
|
}[];
|
|
8531
|
-
/** @description Domains that
|
|
8709
|
+
/** @description Domains that needed no action — already blocked, or not a valid domain */
|
|
8532
8710
|
skipped: string[];
|
|
8711
|
+
/** @description Domains that could NOT be blocked — these are still unblocked */
|
|
8712
|
+
failed: {
|
|
8713
|
+
domain: string;
|
|
8714
|
+
error: string;
|
|
8715
|
+
}[];
|
|
8533
8716
|
summary: {
|
|
8534
8717
|
total: number;
|
|
8535
8718
|
blocked: number;
|
|
8536
8719
|
skipped: number;
|
|
8720
|
+
failed: number;
|
|
8537
8721
|
};
|
|
8538
8722
|
};
|
|
8539
8723
|
DomainBlockStatusOutput: {
|
|
@@ -8633,13 +8817,13 @@ export interface components {
|
|
|
8633
8817
|
/** @enum {string} */
|
|
8634
8818
|
visibility: "internal" | "public";
|
|
8635
8819
|
/** @enum {string} */
|
|
8636
|
-
source_type: "custom_training" | "help_center" | "integration" | "website";
|
|
8820
|
+
source_type: "custom_training" | "help_center" | "integration" | "website" | "workflow";
|
|
8637
8821
|
source_url: string | null;
|
|
8638
8822
|
/** Format: date-time */
|
|
8639
8823
|
updated_at: string;
|
|
8640
8824
|
content?: string;
|
|
8641
8825
|
/** @enum {string} */
|
|
8642
|
-
data_source: "confluence" | "notion" | "zendesk_support" | "shopify" | "gitbook" | "intercom" | "front" | "freshdesk" | "hubspot_kb" | "ai_instructions" | "custom_training" | "website";
|
|
8826
|
+
data_source: "confluence" | "notion" | "zendesk_support" | "shopify" | "gitbook" | "intercom" | "front" | "freshdesk" | "hubspot_kb" | "ai_instructions" | "custom_training" | "website" | "workflow";
|
|
8643
8827
|
stream: string | null;
|
|
8644
8828
|
relevance_score: number;
|
|
8645
8829
|
directory_id: string | null;
|
|
@@ -10534,7 +10718,7 @@ export interface operations {
|
|
|
10534
10718
|
/** @description Full-text search over item titles/content */
|
|
10535
10719
|
search?: string;
|
|
10536
10720
|
/** @description Filter to a specific external data source (e.g. website, confluence, notion) */
|
|
10537
|
-
data_source?: "confluence" | "notion" | "zendesk_support" | "shopify" | "gitbook" | "intercom" | "front" | "freshdesk" | "hubspot_kb" | "ai_instructions" | "custom_training" | "website";
|
|
10721
|
+
data_source?: "confluence" | "notion" | "zendesk_support" | "shopify" | "gitbook" | "intercom" | "front" | "freshdesk" | "hubspot_kb" | "ai_instructions" | "custom_training" | "website" | "workflow";
|
|
10538
10722
|
visibility?: "internal" | "public";
|
|
10539
10723
|
page?: number;
|
|
10540
10724
|
limit?: number;
|
|
@@ -10763,6 +10947,68 @@ export interface operations {
|
|
|
10763
10947
|
};
|
|
10764
10948
|
};
|
|
10765
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
|
+
};
|
|
10766
11012
|
getAutopilotStatus: {
|
|
10767
11013
|
parameters: {
|
|
10768
11014
|
query?: never;
|
|
@@ -15212,6 +15458,68 @@ export interface operations {
|
|
|
15212
15458
|
};
|
|
15213
15459
|
};
|
|
15214
15460
|
};
|
|
15461
|
+
getVocSettings: {
|
|
15462
|
+
parameters: {
|
|
15463
|
+
query?: never;
|
|
15464
|
+
header?: never;
|
|
15465
|
+
path?: never;
|
|
15466
|
+
cookie?: never;
|
|
15467
|
+
};
|
|
15468
|
+
requestBody?: never;
|
|
15469
|
+
responses: {
|
|
15470
|
+
/** @description Default Response */
|
|
15471
|
+
200: {
|
|
15472
|
+
headers: {
|
|
15473
|
+
[name: string]: unknown;
|
|
15474
|
+
};
|
|
15475
|
+
content: {
|
|
15476
|
+
"application/json": components["schemas"]["PublicVocSettingsDto"];
|
|
15477
|
+
};
|
|
15478
|
+
};
|
|
15479
|
+
/** @description Internal Server Error */
|
|
15480
|
+
500: {
|
|
15481
|
+
headers: {
|
|
15482
|
+
[name: string]: unknown;
|
|
15483
|
+
};
|
|
15484
|
+
content: {
|
|
15485
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
15486
|
+
};
|
|
15487
|
+
};
|
|
15488
|
+
};
|
|
15489
|
+
};
|
|
15490
|
+
updateVocSettings: {
|
|
15491
|
+
parameters: {
|
|
15492
|
+
query?: never;
|
|
15493
|
+
header?: never;
|
|
15494
|
+
path?: never;
|
|
15495
|
+
cookie?: never;
|
|
15496
|
+
};
|
|
15497
|
+
requestBody: {
|
|
15498
|
+
content: {
|
|
15499
|
+
"application/json": components["schemas"]["UpdatePublicVocSettingsDto"];
|
|
15500
|
+
};
|
|
15501
|
+
};
|
|
15502
|
+
responses: {
|
|
15503
|
+
/** @description Default Response */
|
|
15504
|
+
200: {
|
|
15505
|
+
headers: {
|
|
15506
|
+
[name: string]: unknown;
|
|
15507
|
+
};
|
|
15508
|
+
content: {
|
|
15509
|
+
"application/json": components["schemas"]["PublicVocSettingsDto"];
|
|
15510
|
+
};
|
|
15511
|
+
};
|
|
15512
|
+
/** @description Internal Server Error */
|
|
15513
|
+
500: {
|
|
15514
|
+
headers: {
|
|
15515
|
+
[name: string]: unknown;
|
|
15516
|
+
};
|
|
15517
|
+
content: {
|
|
15518
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
15519
|
+
};
|
|
15520
|
+
};
|
|
15521
|
+
};
|
|
15522
|
+
};
|
|
15215
15523
|
updateCategory: {
|
|
15216
15524
|
parameters: {
|
|
15217
15525
|
query?: never;
|