@opencx/mcp 1.15.37 → 1.15.39
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/contact-segments.spec.d.ts +2 -0
- package/dist/contact-segments.spec.d.ts.map +1 -0
- package/dist/contact-segments.spec.js +137 -0
- package/dist/contact-segments.spec.js.map +1 -0
- package/dist/schema.d.ts +1633 -586
- package/dist/schema.d.ts.map +1 -1
- package/dist/server.spec.js +3 -0
- package/dist/server.spec.js.map +1 -1
- package/dist/tools/contact-segment-schemas.d.ts +612 -0
- package/dist/tools/contact-segment-schemas.d.ts.map +1 -0
- package/dist/tools/contact-segment-schemas.js +49 -0
- package/dist/tools/contact-segment-schemas.js.map +1 -0
- package/dist/tools/contact-segments.d.ts +1 -1
- package/dist/tools/contact-segments.d.ts.map +1 -1
- package/dist/tools/contact-segments.js +49 -0
- package/dist/tools/contact-segments.js.map +1 -1
- package/package.json +1 -1
package/dist/schema.d.ts
CHANGED
|
@@ -239,6 +239,26 @@ export interface paths {
|
|
|
239
239
|
patch?: never;
|
|
240
240
|
trace?: never;
|
|
241
241
|
};
|
|
242
|
+
"/chat/sessions/events": {
|
|
243
|
+
parameters: {
|
|
244
|
+
query?: never;
|
|
245
|
+
header?: never;
|
|
246
|
+
path?: never;
|
|
247
|
+
cookie?: never;
|
|
248
|
+
};
|
|
249
|
+
/**
|
|
250
|
+
* Export session events
|
|
251
|
+
* @description Pull existing session history across your organization, including system events and internal notes. Uses the same id, created_at and typed event structure as GET /chat/sessions/{session_id}/history, with session/contact IDs, the stored message_type and export metadata. Types without a history mapping are retained as unmapped_event; checkpoint payloads are omitted. created_after is inclusive; created_before is exclusive. Both date bounds are optional. include_message_types overrides exclude_message_types; neither filter returns all message types. Returns recorded actor identities, assignment targets, sub-status IDs and workflow details when available. Does not reconstruct missing historical identities or track session/contact attribute changes. Use a fixed date window when paging, retain the same filters, and deduplicate by event ID. Timestamps are event times: historical imports can arrive later and edits do not change original creation times; reconcile previously exported windows to pick up late or edited history. Requires chat-sessions:read.
|
|
252
|
+
*/
|
|
253
|
+
get: operations["listSessionEvents"];
|
|
254
|
+
put?: never;
|
|
255
|
+
post?: never;
|
|
256
|
+
delete?: never;
|
|
257
|
+
options?: never;
|
|
258
|
+
head?: never;
|
|
259
|
+
patch?: never;
|
|
260
|
+
trace?: never;
|
|
261
|
+
};
|
|
242
262
|
"/chat/sessions": {
|
|
243
263
|
parameters: {
|
|
244
264
|
query?: never;
|
|
@@ -837,7 +857,11 @@ export interface paths {
|
|
|
837
857
|
*/
|
|
838
858
|
get: operations["listContactSegments"];
|
|
839
859
|
put?: never;
|
|
840
|
-
|
|
860
|
+
/**
|
|
861
|
+
* Create a contact segment
|
|
862
|
+
* @description Create a saved contact filter. Requires segments:write. Membership is calculated in the background.
|
|
863
|
+
*/
|
|
864
|
+
post: operations["createContactSegment"];
|
|
841
865
|
delete?: never;
|
|
842
866
|
options?: never;
|
|
843
867
|
head?: never;
|
|
@@ -858,10 +882,18 @@ export interface paths {
|
|
|
858
882
|
get: operations["getContactSegment"];
|
|
859
883
|
put?: never;
|
|
860
884
|
post?: never;
|
|
861
|
-
|
|
885
|
+
/**
|
|
886
|
+
* Delete a contact segment
|
|
887
|
+
* @description Permanently delete a segment definition and its stored memberships, without deleting contacts. Requires segments:write.
|
|
888
|
+
*/
|
|
889
|
+
delete: operations["deleteContactSegment"];
|
|
862
890
|
options?: never;
|
|
863
891
|
head?: never;
|
|
864
|
-
|
|
892
|
+
/**
|
|
893
|
+
* Update a contact segment
|
|
894
|
+
* @description Update only supplied fields. A supplied definition replaces all filter rules; membership is recalculated in the background when rules change. Requires segments:write.
|
|
895
|
+
*/
|
|
896
|
+
patch: operations["updateContactSegment"];
|
|
865
897
|
trace?: never;
|
|
866
898
|
};
|
|
867
899
|
"/contacts/segments/contacts/{contact_id}": {
|
|
@@ -2954,12 +2986,12 @@ export interface paths {
|
|
|
2954
2986
|
};
|
|
2955
2987
|
/**
|
|
2956
2988
|
* Get phone agent knowledge-source tree
|
|
2957
|
-
* @description Returns
|
|
2989
|
+
* @description Returns independently configurable instruction and knowledge search scopes.
|
|
2958
2990
|
*/
|
|
2959
2991
|
get: operations["getPhoneAgentKnowledgeSources"];
|
|
2960
2992
|
/**
|
|
2961
2993
|
* Update phone agent knowledge sources
|
|
2962
|
-
* @description
|
|
2994
|
+
* @description Set independent instruction and knowledge search scopes. Use all mode with empty selections to search all eligible sources.
|
|
2963
2995
|
*/
|
|
2964
2996
|
put: operations["updatePhoneAgentKnowledgeSources"];
|
|
2965
2997
|
post?: never;
|
|
@@ -2969,6 +3001,26 @@ export interface paths {
|
|
|
2969
3001
|
patch?: never;
|
|
2970
3002
|
trace?: never;
|
|
2971
3003
|
};
|
|
3004
|
+
"/phone/{phone_agent_id}/knowledge-sources/items": {
|
|
3005
|
+
parameters: {
|
|
3006
|
+
query?: never;
|
|
3007
|
+
header?: never;
|
|
3008
|
+
path?: never;
|
|
3009
|
+
cookie?: never;
|
|
3010
|
+
};
|
|
3011
|
+
/**
|
|
3012
|
+
* List knowledge items in a phone agent source folder
|
|
3013
|
+
* @description Returns one page of public knowledge items for a canonical folder key.
|
|
3014
|
+
*/
|
|
3015
|
+
get: operations["listPhoneAgentKnowledgeSourceItems"];
|
|
3016
|
+
put?: never;
|
|
3017
|
+
post?: never;
|
|
3018
|
+
delete?: never;
|
|
3019
|
+
options?: never;
|
|
3020
|
+
head?: never;
|
|
3021
|
+
patch?: never;
|
|
3022
|
+
trace?: never;
|
|
3023
|
+
};
|
|
2972
3024
|
"/phone/{phone_agent_id}/caller-number": {
|
|
2973
3025
|
parameters: {
|
|
2974
3026
|
query?: never;
|
|
@@ -4500,6 +4552,46 @@ export interface paths {
|
|
|
4500
4552
|
patch?: never;
|
|
4501
4553
|
trace?: never;
|
|
4502
4554
|
};
|
|
4555
|
+
"/roles": {
|
|
4556
|
+
parameters: {
|
|
4557
|
+
query?: never;
|
|
4558
|
+
header?: never;
|
|
4559
|
+
path?: never;
|
|
4560
|
+
cookie?: never;
|
|
4561
|
+
};
|
|
4562
|
+
/**
|
|
4563
|
+
* List roles
|
|
4564
|
+
* @description Retrieve the roles defined in the organization (built-in and custom) with their permissions. Match `id` against the `roles` array on organization users.
|
|
4565
|
+
*/
|
|
4566
|
+
get: operations["listRoles"];
|
|
4567
|
+
put?: never;
|
|
4568
|
+
post?: never;
|
|
4569
|
+
delete?: never;
|
|
4570
|
+
options?: never;
|
|
4571
|
+
head?: never;
|
|
4572
|
+
patch?: never;
|
|
4573
|
+
trace?: never;
|
|
4574
|
+
};
|
|
4575
|
+
"/roles/{role_id}": {
|
|
4576
|
+
parameters: {
|
|
4577
|
+
query?: never;
|
|
4578
|
+
header?: never;
|
|
4579
|
+
path?: never;
|
|
4580
|
+
cookie?: never;
|
|
4581
|
+
};
|
|
4582
|
+
/**
|
|
4583
|
+
* Get role
|
|
4584
|
+
* @description Retrieve a single role by ID with its permissions.
|
|
4585
|
+
*/
|
|
4586
|
+
get: operations["getRole"];
|
|
4587
|
+
put?: never;
|
|
4588
|
+
post?: never;
|
|
4589
|
+
delete?: never;
|
|
4590
|
+
options?: never;
|
|
4591
|
+
head?: never;
|
|
4592
|
+
patch?: never;
|
|
4593
|
+
trace?: never;
|
|
4594
|
+
};
|
|
4503
4595
|
"/insights": {
|
|
4504
4596
|
parameters: {
|
|
4505
4597
|
query?: never;
|
|
@@ -4828,6 +4920,40 @@ export interface paths {
|
|
|
4828
4920
|
patch?: never;
|
|
4829
4921
|
trace?: never;
|
|
4830
4922
|
};
|
|
4923
|
+
"/widget/connections/{connectionId}/access-token": {
|
|
4924
|
+
parameters: {
|
|
4925
|
+
query?: never;
|
|
4926
|
+
header?: never;
|
|
4927
|
+
path?: never;
|
|
4928
|
+
cookie?: never;
|
|
4929
|
+
};
|
|
4930
|
+
get?: never;
|
|
4931
|
+
put?: never;
|
|
4932
|
+
/** Retrieve a personal connection access token from your backend */
|
|
4933
|
+
post: operations["getWidgetConnectionAccessToken"];
|
|
4934
|
+
delete?: never;
|
|
4935
|
+
options?: never;
|
|
4936
|
+
head?: never;
|
|
4937
|
+
patch?: never;
|
|
4938
|
+
trace?: never;
|
|
4939
|
+
};
|
|
4940
|
+
"/widget/connections/{serverId}/call": {
|
|
4941
|
+
parameters: {
|
|
4942
|
+
query?: never;
|
|
4943
|
+
header?: never;
|
|
4944
|
+
path?: never;
|
|
4945
|
+
cookie?: never;
|
|
4946
|
+
};
|
|
4947
|
+
get?: never;
|
|
4948
|
+
put?: never;
|
|
4949
|
+
/** Use a user connection from your backend */
|
|
4950
|
+
post: operations["callWidgetConnectionTool"];
|
|
4951
|
+
delete?: never;
|
|
4952
|
+
options?: never;
|
|
4953
|
+
head?: never;
|
|
4954
|
+
patch?: never;
|
|
4955
|
+
trace?: never;
|
|
4956
|
+
};
|
|
4831
4957
|
"/widget/authenticate-user": {
|
|
4832
4958
|
parameters: {
|
|
4833
4959
|
query?: never;
|
|
@@ -6255,6 +6381,98 @@ export interface components {
|
|
|
6255
6381
|
/** @description To address of the AI agent's autopilot Case email: a literal address, a {{session attribute}} such as {{reservation_email}}, or an {{#if …}} branch, resolved per session. Used only when it resolves to an email address; otherwise the Case contact's address applies. Empty or null clears it. */
|
|
6256
6382
|
to_address?: string | null;
|
|
6257
6383
|
};
|
|
6384
|
+
ContactsFilter: {
|
|
6385
|
+
/** @constant */
|
|
6386
|
+
type: "all_contacts";
|
|
6387
|
+
} | {
|
|
6388
|
+
/** @constant */
|
|
6389
|
+
type: "contact_id_in";
|
|
6390
|
+
contact_ids: string[];
|
|
6391
|
+
} | {
|
|
6392
|
+
/** @constant */
|
|
6393
|
+
type: "contacts_created_at_between";
|
|
6394
|
+
/** Format: date-time */
|
|
6395
|
+
after?: string;
|
|
6396
|
+
/** Format: date-time */
|
|
6397
|
+
before?: string;
|
|
6398
|
+
} | {
|
|
6399
|
+
/** @constant */
|
|
6400
|
+
type: "contacts_email_domain_name_in";
|
|
6401
|
+
domain_name_in: string[];
|
|
6402
|
+
} | {
|
|
6403
|
+
/** @constant */
|
|
6404
|
+
type: "contacts_affected_by_sequence";
|
|
6405
|
+
sequence_id: string;
|
|
6406
|
+
} | {
|
|
6407
|
+
/** @constant */
|
|
6408
|
+
type: "contacts_name_in";
|
|
6409
|
+
name_in: string[];
|
|
6410
|
+
} | {
|
|
6411
|
+
/** @constant */
|
|
6412
|
+
type: "contacts_phone_number_in";
|
|
6413
|
+
/** @description Full phone numbers, matched exactly on digits (formatting like +, spaces, and dashes is ignored). Use * inside an entry for partial/substring matching. */
|
|
6414
|
+
phone_number_in: string[];
|
|
6415
|
+
} | {
|
|
6416
|
+
/** @constant */
|
|
6417
|
+
type: "contacts_email_in";
|
|
6418
|
+
email_in: string[];
|
|
6419
|
+
} | {
|
|
6420
|
+
/** @constant */
|
|
6421
|
+
type: "contacts_attributes_in";
|
|
6422
|
+
attributes?: {
|
|
6423
|
+
[key: string]: string;
|
|
6424
|
+
}[];
|
|
6425
|
+
} | {
|
|
6426
|
+
/** @constant */
|
|
6427
|
+
type: "contacts_sessions_attributes_in";
|
|
6428
|
+
attributes?: {
|
|
6429
|
+
[key: string]: string;
|
|
6430
|
+
}[];
|
|
6431
|
+
} | {
|
|
6432
|
+
/** @constant */
|
|
6433
|
+
type: "contact_belongs_to_segment";
|
|
6434
|
+
segment_id: string;
|
|
6435
|
+
belongs?: boolean;
|
|
6436
|
+
} | {
|
|
6437
|
+
/** @constant */
|
|
6438
|
+
type: "last_contacted_at_between";
|
|
6439
|
+
/** Format: date-time */
|
|
6440
|
+
after?: string;
|
|
6441
|
+
/** Format: date-time */
|
|
6442
|
+
before?: string;
|
|
6443
|
+
} | {
|
|
6444
|
+
/** @constant */
|
|
6445
|
+
type: "last_contacted_at_with_handoff_between";
|
|
6446
|
+
/** Format: date-time */
|
|
6447
|
+
after?: string;
|
|
6448
|
+
/** Format: date-time */
|
|
6449
|
+
before?: string;
|
|
6450
|
+
} | {
|
|
6451
|
+
/** @constant */
|
|
6452
|
+
type: "contact_has_phone";
|
|
6453
|
+
has: boolean;
|
|
6454
|
+
} | {
|
|
6455
|
+
/** @constant */
|
|
6456
|
+
type: "contact_has_email";
|
|
6457
|
+
has: boolean;
|
|
6458
|
+
} | {
|
|
6459
|
+
/** @constant */
|
|
6460
|
+
type: "contact_is_blocked";
|
|
6461
|
+
blocked: boolean;
|
|
6462
|
+
} | {
|
|
6463
|
+
/** @constant */
|
|
6464
|
+
type: "contact_is_unsubscribed";
|
|
6465
|
+
unsubscribed: boolean;
|
|
6466
|
+
} | {
|
|
6467
|
+
/** @constant */
|
|
6468
|
+
type: "contacts_custom_data";
|
|
6469
|
+
conditions: {
|
|
6470
|
+
key: string;
|
|
6471
|
+
/** @enum {string} */
|
|
6472
|
+
op: "exists" | "not_exists" | "eq" | "neq" | "contains";
|
|
6473
|
+
value?: string;
|
|
6474
|
+
}[];
|
|
6475
|
+
};
|
|
6258
6476
|
CreateSlaPolicyDto: {
|
|
6259
6477
|
name: string;
|
|
6260
6478
|
office_hours_id?: string | null;
|
|
@@ -6283,6 +6501,14 @@ export interface components {
|
|
|
6283
6501
|
} | null;
|
|
6284
6502
|
/** @enum {string} */
|
|
6285
6503
|
PhoneHandoffReason: "ai_initiated" | "no_agent_assigned" | "agent_unavailable" | "caller_requested" | "timeout" | "unknown";
|
|
6504
|
+
SessionStructuredFieldValueInputDto: {
|
|
6505
|
+
/** Format: uuid */
|
|
6506
|
+
field_id: string;
|
|
6507
|
+
value: string | null;
|
|
6508
|
+
};
|
|
6509
|
+
SetSessionStructuredFieldValuesDto: {
|
|
6510
|
+
values: components["schemas"]["SessionStructuredFieldValueInputDto"][];
|
|
6511
|
+
};
|
|
6286
6512
|
/** @enum {string} */
|
|
6287
6513
|
StructuredFieldTypeDto: "enum" | "text" | "number" | "boolean" | "date" | "user" | "team" | "tag";
|
|
6288
6514
|
StructuredFieldShowWhenDto: {
|
|
@@ -6313,14 +6539,6 @@ export interface components {
|
|
|
6313
6539
|
variant_description?: string;
|
|
6314
6540
|
parent_id?: string | null;
|
|
6315
6541
|
};
|
|
6316
|
-
SessionStructuredFieldValueInputDto: {
|
|
6317
|
-
/** Format: uuid */
|
|
6318
|
-
field_id: string;
|
|
6319
|
-
value: string | null;
|
|
6320
|
-
};
|
|
6321
|
-
SetSessionStructuredFieldValuesDto: {
|
|
6322
|
-
values: components["schemas"]["SessionStructuredFieldValueInputDto"][];
|
|
6323
|
-
};
|
|
6324
6542
|
CompanyOwnerInput: {
|
|
6325
6543
|
/** @description OpenCX user id of the owning teammate */
|
|
6326
6544
|
id?: number;
|
|
@@ -6495,10 +6713,24 @@ export interface components {
|
|
|
6495
6713
|
workflowIds: string[];
|
|
6496
6714
|
};
|
|
6497
6715
|
UpdateKnowledgeSourcesDto: {
|
|
6716
|
+
/**
|
|
6717
|
+
* @description Explicit instruction scope mode. Omit only for compatibility with older clients.
|
|
6718
|
+
* @enum {string}
|
|
6719
|
+
*/
|
|
6720
|
+
instructionMode?: "all" | "selected";
|
|
6721
|
+
/**
|
|
6722
|
+
* @description Explicit knowledge scope mode. Omit only for compatibility with older clients.
|
|
6723
|
+
* @enum {string}
|
|
6724
|
+
*/
|
|
6725
|
+
knowledgeMode?: "all" | "selected";
|
|
6498
6726
|
/** @description IDs of individual instructions to select (outside of selected directories) */
|
|
6499
6727
|
instructionIds: string[];
|
|
6500
6728
|
/** @description IDs of directories to select (all instructions in these directories are included) */
|
|
6501
6729
|
directoryIds: string[];
|
|
6730
|
+
/** @description IDs of individual knowledge items to search. Omit to leave knowledge selections unchanged. */
|
|
6731
|
+
knowledgeItemIds?: string[];
|
|
6732
|
+
/** @description Canonical knowledge folder keys to search. Omit to leave knowledge selections unchanged. */
|
|
6733
|
+
knowledgeFolderKeys?: string[];
|
|
6502
6734
|
};
|
|
6503
6735
|
MakeOutboundCallDto: {
|
|
6504
6736
|
phoneAgentId: string;
|
|
@@ -7268,7 +7500,7 @@ export interface components {
|
|
|
7268
7500
|
* @enum {string}
|
|
7269
7501
|
*/
|
|
7270
7502
|
request_type: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
|
|
7271
|
-
/** @description Unique operation ID (auto-generated from name if omitted) */
|
|
7503
|
+
/** @description Unique operation ID (auto-generated from name if omitted). 1-64 characters of [a-zA-Z0-9_-]: it is the tool name the AI agent calls, and phone agents reject anything else. */
|
|
7272
7504
|
operation_id?: string;
|
|
7273
7505
|
/** @description OpenAPI-style operation spec: parameters, requestBody, responses, etc. */
|
|
7274
7506
|
payload: {
|
|
@@ -7347,7 +7579,7 @@ export interface components {
|
|
|
7347
7579
|
* @enum {string}
|
|
7348
7580
|
*/
|
|
7349
7581
|
request_type?: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
|
|
7350
|
-
/** @description Unique operation ID (auto-generated from name if omitted) */
|
|
7582
|
+
/** @description Unique operation ID (auto-generated from name if omitted). 1-64 characters of [a-zA-Z0-9_-]: it is the tool name the AI agent calls, and phone agents reject anything else. */
|
|
7351
7583
|
operation_id?: string;
|
|
7352
7584
|
/** @description OpenAPI-style operation spec: parameters, requestBody, responses, etc. */
|
|
7353
7585
|
payload?: {
|
|
@@ -7535,6 +7767,10 @@ export interface components {
|
|
|
7535
7767
|
AuthenticateUserPayloadDto: {
|
|
7536
7768
|
/** Format: email */
|
|
7537
7769
|
email: string;
|
|
7770
|
+
mcp_access?: {
|
|
7771
|
+
server_ids?: string[];
|
|
7772
|
+
account_id?: string;
|
|
7773
|
+
};
|
|
7538
7774
|
name?: string;
|
|
7539
7775
|
avatar_url?: string | null;
|
|
7540
7776
|
phone?: string;
|
|
@@ -7725,6 +7961,10 @@ export interface components {
|
|
|
7725
7961
|
custom_data?: {
|
|
7726
7962
|
[key: string]: string;
|
|
7727
7963
|
}[];
|
|
7964
|
+
/** @description Deprecated compatibility alias for custom_data */
|
|
7965
|
+
customData?: {
|
|
7966
|
+
[key: string]: string;
|
|
7967
|
+
}[] | null;
|
|
7728
7968
|
};
|
|
7729
7969
|
/**
|
|
7730
7970
|
* @description Sort field (default: last_message_at)
|
|
@@ -7753,6 +7993,25 @@ export interface components {
|
|
|
7753
7993
|
/** @description Guidance for the fired reply — what to check or say when the session is continued. Not shown to the contact. */
|
|
7754
7994
|
prompt: string;
|
|
7755
7995
|
};
|
|
7996
|
+
CreateContactSegmentInput: {
|
|
7997
|
+
name: string;
|
|
7998
|
+
/** @description Optional description; defaults to null */
|
|
7999
|
+
description?: string | null;
|
|
8000
|
+
definition: {
|
|
8001
|
+
or: {
|
|
8002
|
+
and: components["schemas"]["ContactsFilter"][];
|
|
8003
|
+
}[];
|
|
8004
|
+
} | null;
|
|
8005
|
+
};
|
|
8006
|
+
UpdateContactSegmentInput: {
|
|
8007
|
+
name?: string;
|
|
8008
|
+
description?: string | null;
|
|
8009
|
+
definition?: {
|
|
8010
|
+
or: {
|
|
8011
|
+
and: components["schemas"]["ContactsFilter"][];
|
|
8012
|
+
}[];
|
|
8013
|
+
} | null;
|
|
8014
|
+
};
|
|
7756
8015
|
UpdatePublicKnowledgebaseItem: {
|
|
7757
8016
|
/** @description Contact segment ids this item should be restricted to. Pass [] to make it available to all contacts. */
|
|
7758
8017
|
restricted_to_segments?: string[];
|
|
@@ -8544,7 +8803,7 @@ export interface components {
|
|
|
8544
8803
|
limit: number;
|
|
8545
8804
|
visibility?: ("internal" | "public")[];
|
|
8546
8805
|
sourceTypes?: ("custom_training" | "help_center" | "integration" | "website" | "workflow")[];
|
|
8547
|
-
dataSources?: ("confluence" | "notion" | "zendesk_support" | "shopify" | "gitbook" | "intercom" | "front" | "freshdesk" | "hubspot_kb" | "ai_instructions" | "custom_training" | "website" | "workflow")[];
|
|
8806
|
+
dataSources?: ("confluence" | "notion" | "zendesk_support" | "shopify" | "gitbook" | "intercom" | "front" | "freshdesk" | "hubspot_kb" | "ai_instructions" | "custom_training" | "website" | "workflow" | "help_center")[];
|
|
8548
8807
|
/**
|
|
8549
8808
|
* @default relevance
|
|
8550
8809
|
* @enum {string}
|
|
@@ -8777,7 +9036,7 @@ export interface components {
|
|
|
8777
9036
|
/** Format: uuid */
|
|
8778
9037
|
phone_call_id: string;
|
|
8779
9038
|
/** @enum {string} */
|
|
8780
|
-
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";
|
|
9039
|
+
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" | "participant_invited" | "participant_joined" | "participant_left" | "participant_removed" | "participant_declined" | "call_ended" | "call_failed";
|
|
8781
9040
|
actor_user_id: number | null;
|
|
8782
9041
|
actor_name: string | null;
|
|
8783
9042
|
detail: string | null;
|
|
@@ -9200,6 +9459,16 @@ export interface components {
|
|
|
9200
9459
|
name: string;
|
|
9201
9460
|
}[];
|
|
9202
9461
|
} | null;
|
|
9462
|
+
integration_actor?: {
|
|
9463
|
+
/** @enum {string} */
|
|
9464
|
+
system: "intercom";
|
|
9465
|
+
/** @enum {string} */
|
|
9466
|
+
kind: "admin" | "bot" | "team" | "workflow" | "balanced" | "unknown";
|
|
9467
|
+
name: string | null;
|
|
9468
|
+
external_id: string | null;
|
|
9469
|
+
part_type?: string | null;
|
|
9470
|
+
open_cx_user_id?: number | null;
|
|
9471
|
+
} | null;
|
|
9203
9472
|
destination_id?: string;
|
|
9204
9473
|
destination_name?: string;
|
|
9205
9474
|
/** @enum {string} */
|
|
@@ -9214,10 +9483,26 @@ export interface components {
|
|
|
9214
9483
|
duration_seconds?: number;
|
|
9215
9484
|
/** @enum {string} */
|
|
9216
9485
|
call_direction?: "inbound" | "outbound";
|
|
9486
|
+
voice_call?: {
|
|
9487
|
+
/** @enum {string} */
|
|
9488
|
+
source: "backend" | "livekit" | "voice_worker" | "twilio" | "vapi";
|
|
9489
|
+
occurrence_id?: string;
|
|
9490
|
+
failure?: {
|
|
9491
|
+
/** @enum {string} */
|
|
9492
|
+
stage: "dispatch" | "sip" | "provider";
|
|
9493
|
+
code: string;
|
|
9494
|
+
};
|
|
9495
|
+
participant?: {
|
|
9496
|
+
id: string;
|
|
9497
|
+
name?: string;
|
|
9498
|
+
userId?: number;
|
|
9499
|
+
phoneNumber?: string;
|
|
9500
|
+
};
|
|
9501
|
+
};
|
|
9217
9502
|
}) | null;
|
|
9218
9503
|
knowledgebase_called?: boolean | null;
|
|
9219
9504
|
/** @enum {string} */
|
|
9220
|
-
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_follow_up_cancelled" | "ai_follow_up_fired" | "ai_follow_up_scheduled" | "ai_reopened_session" | "ai_response_cancelled" | "ai_resumed_by_system" | "ai_suggestion" | "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_request_cancelled" | "csat_requested" | "csat_submitted" | "email_draft_message" | "handoff" | "handoff_to_salesforce_miaw" | "handoff_to_third_party_failed" | "handoff_to_zendesk" | "integration_reopened_session" | "message" | "pii_attachment_removed" | "prohibited_topic_detected" | "quoted_content_modified" | "salesforce_fields_updated" | "sequence_message" | "session_forwarded" | "session_language_changed_by_agent" | "session_language_changed_by_api" | "session_language_changed_by_integration" | "session_language_changed_by_system" | "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_session_created" | "sub_session_linked_by_agent" | "sub_session_linked_by_api" | "sub_session_linked_by_integration" | "sub_session_linked_by_system" | "sub_session_unlinked_by_agent" | "sub_session_unlinked_by_api" | "sub_session_unlinked_by_integration" | "sub_session_unlinked_by_system" | "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";
|
|
9505
|
+
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_follow_up_cancelled" | "ai_follow_up_fired" | "ai_follow_up_scheduled" | "ai_reopened_session" | "ai_response_cancelled" | "ai_resumed_by_system" | "ai_suggestion" | "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_request_cancelled" | "csat_requested" | "csat_submitted" | "email_draft_message" | "handoff" | "handoff_to_salesforce_miaw" | "handoff_to_third_party_failed" | "handoff_to_zendesk" | "integration_reopened_session" | "message" | "pii_attachment_removed" | "prohibited_topic_detected" | "quoted_content_modified" | "salesforce_fields_updated" | "sequence_message" | "session_forwarded" | "session_language_changed_by_agent" | "session_language_changed_by_api" | "session_language_changed_by_integration" | "session_language_changed_by_system" | "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_session_created" | "sub_session_linked_by_agent" | "sub_session_linked_by_api" | "sub_session_linked_by_integration" | "sub_session_linked_by_system" | "sub_session_unlinked_by_agent" | "sub_session_unlinked_by_api" | "sub_session_unlinked_by_integration" | "sub_session_unlinked_by_system" | "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" | "voice_call_ai_joined" | "voice_call_ai_left" | "voice_call_contact_answered" | "voice_call_contact_joined" | "voice_call_contact_left" | "voice_call_ended" | "voice_call_failed_to_start" | "voice_call_human_answered" | "voice_call_human_joined" | "voice_call_human_left" | "voice_call_started" | "workflow_message" | "workflow_note" | "workflow_triggered";
|
|
9221
9506
|
extra_params?: {
|
|
9222
9507
|
[key: string]: unknown;
|
|
9223
9508
|
} | null;
|
|
@@ -9296,98 +9581,6 @@ export interface components {
|
|
|
9296
9581
|
from_address: string | null;
|
|
9297
9582
|
to_address: string | null;
|
|
9298
9583
|
};
|
|
9299
|
-
ContactsFilter: {
|
|
9300
|
-
/** @constant */
|
|
9301
|
-
type: "all_contacts";
|
|
9302
|
-
} | {
|
|
9303
|
-
/** @constant */
|
|
9304
|
-
type: "contact_id_in";
|
|
9305
|
-
contact_ids: string[];
|
|
9306
|
-
} | {
|
|
9307
|
-
/** @constant */
|
|
9308
|
-
type: "contacts_created_at_between";
|
|
9309
|
-
/** Format: date-time */
|
|
9310
|
-
after?: string;
|
|
9311
|
-
/** Format: date-time */
|
|
9312
|
-
before?: string;
|
|
9313
|
-
} | {
|
|
9314
|
-
/** @constant */
|
|
9315
|
-
type: "contacts_email_domain_name_in";
|
|
9316
|
-
domain_name_in: string[];
|
|
9317
|
-
} | {
|
|
9318
|
-
/** @constant */
|
|
9319
|
-
type: "contacts_affected_by_sequence";
|
|
9320
|
-
sequence_id: string;
|
|
9321
|
-
} | {
|
|
9322
|
-
/** @constant */
|
|
9323
|
-
type: "contacts_name_in";
|
|
9324
|
-
name_in: string[];
|
|
9325
|
-
} | {
|
|
9326
|
-
/** @constant */
|
|
9327
|
-
type: "contacts_phone_number_in";
|
|
9328
|
-
/** @description Full phone numbers, matched exactly on digits (formatting like +, spaces, and dashes is ignored). Use * inside an entry for partial/substring matching. */
|
|
9329
|
-
phone_number_in: string[];
|
|
9330
|
-
} | {
|
|
9331
|
-
/** @constant */
|
|
9332
|
-
type: "contacts_email_in";
|
|
9333
|
-
email_in: string[];
|
|
9334
|
-
} | {
|
|
9335
|
-
/** @constant */
|
|
9336
|
-
type: "contacts_attributes_in";
|
|
9337
|
-
attributes?: {
|
|
9338
|
-
[key: string]: string;
|
|
9339
|
-
}[];
|
|
9340
|
-
} | {
|
|
9341
|
-
/** @constant */
|
|
9342
|
-
type: "contacts_sessions_attributes_in";
|
|
9343
|
-
attributes?: {
|
|
9344
|
-
[key: string]: string;
|
|
9345
|
-
}[];
|
|
9346
|
-
} | {
|
|
9347
|
-
/** @constant */
|
|
9348
|
-
type: "contact_belongs_to_segment";
|
|
9349
|
-
segment_id: string;
|
|
9350
|
-
belongs?: boolean;
|
|
9351
|
-
} | {
|
|
9352
|
-
/** @constant */
|
|
9353
|
-
type: "last_contacted_at_between";
|
|
9354
|
-
/** Format: date-time */
|
|
9355
|
-
after?: string;
|
|
9356
|
-
/** Format: date-time */
|
|
9357
|
-
before?: string;
|
|
9358
|
-
} | {
|
|
9359
|
-
/** @constant */
|
|
9360
|
-
type: "last_contacted_at_with_handoff_between";
|
|
9361
|
-
/** Format: date-time */
|
|
9362
|
-
after?: string;
|
|
9363
|
-
/** Format: date-time */
|
|
9364
|
-
before?: string;
|
|
9365
|
-
} | {
|
|
9366
|
-
/** @constant */
|
|
9367
|
-
type: "contact_has_phone";
|
|
9368
|
-
has: boolean;
|
|
9369
|
-
} | {
|
|
9370
|
-
/** @constant */
|
|
9371
|
-
type: "contact_has_email";
|
|
9372
|
-
has: boolean;
|
|
9373
|
-
} | {
|
|
9374
|
-
/** @constant */
|
|
9375
|
-
type: "contact_is_blocked";
|
|
9376
|
-
blocked: boolean;
|
|
9377
|
-
} | {
|
|
9378
|
-
/** @constant */
|
|
9379
|
-
type: "contact_is_unsubscribed";
|
|
9380
|
-
unsubscribed: boolean;
|
|
9381
|
-
} | {
|
|
9382
|
-
/** @constant */
|
|
9383
|
-
type: "contacts_custom_data";
|
|
9384
|
-
conditions: {
|
|
9385
|
-
key: string;
|
|
9386
|
-
/** @enum {string} */
|
|
9387
|
-
op: "exists" | "not_exists" | "eq" | "neq" | "contains";
|
|
9388
|
-
value?: string;
|
|
9389
|
-
}[];
|
|
9390
|
-
};
|
|
9391
9584
|
VersionHistoryItemDto: {
|
|
9392
9585
|
/** Format: uuid */
|
|
9393
9586
|
id: string;
|
|
@@ -9485,6 +9678,21 @@ export interface components {
|
|
|
9485
9678
|
/** Format: date-time */
|
|
9486
9679
|
updated_at: string;
|
|
9487
9680
|
};
|
|
9681
|
+
SessionStructuredFieldValueDto: {
|
|
9682
|
+
org_id: string;
|
|
9683
|
+
session_id: string;
|
|
9684
|
+
/** Format: uuid */
|
|
9685
|
+
field_id: string;
|
|
9686
|
+
value: string;
|
|
9687
|
+
/** Format: date-time */
|
|
9688
|
+
created_at: string;
|
|
9689
|
+
/** Format: date-time */
|
|
9690
|
+
updated_at: string;
|
|
9691
|
+
};
|
|
9692
|
+
SessionStructuredFieldValueListDto: {
|
|
9693
|
+
data: components["schemas"]["SessionStructuredFieldValueDto"][];
|
|
9694
|
+
applicable_field_ids: string[];
|
|
9695
|
+
};
|
|
9488
9696
|
StructuredFieldSystemOptionDto: {
|
|
9489
9697
|
value: string;
|
|
9490
9698
|
label: string;
|
|
@@ -9529,21 +9737,6 @@ export interface components {
|
|
|
9529
9737
|
system_options: components["schemas"]["StructuredFieldSystemOptionDto"][];
|
|
9530
9738
|
};
|
|
9531
9739
|
StructuredFieldListDto: components["schemas"]["StructuredFieldTreeDto"][];
|
|
9532
|
-
SessionStructuredFieldValueDto: {
|
|
9533
|
-
org_id: string;
|
|
9534
|
-
session_id: string;
|
|
9535
|
-
/** Format: uuid */
|
|
9536
|
-
field_id: string;
|
|
9537
|
-
value: string;
|
|
9538
|
-
/** Format: date-time */
|
|
9539
|
-
created_at: string;
|
|
9540
|
-
/** Format: date-time */
|
|
9541
|
-
updated_at: string;
|
|
9542
|
-
};
|
|
9543
|
-
SessionStructuredFieldValueListDto: {
|
|
9544
|
-
data: components["schemas"]["SessionStructuredFieldValueDto"][];
|
|
9545
|
-
applicable_field_ids: string[];
|
|
9546
|
-
};
|
|
9547
9740
|
GenericResponseDto: {
|
|
9548
9741
|
data?: {
|
|
9549
9742
|
success: boolean;
|
|
@@ -9954,6 +10147,8 @@ export interface components {
|
|
|
9954
10147
|
/** @enum {string} */
|
|
9955
10148
|
model: "oppie-vox" | "oppie-vox-turbo" | "oppie-vox-livekit";
|
|
9956
10149
|
voice_id: string | null;
|
|
10150
|
+
/** @enum {string} */
|
|
10151
|
+
voice_mode: "modular" | "live";
|
|
9957
10152
|
first_message: string | null;
|
|
9958
10153
|
/** Format: date-time */
|
|
9959
10154
|
created_at: string;
|
|
@@ -9964,6 +10159,7 @@ export interface components {
|
|
|
9964
10159
|
use_org_knowledgebase: boolean;
|
|
9965
10160
|
background_noise_preset: ("office" | "bar" | "city-street") | null;
|
|
9966
10161
|
recording_enabled: boolean;
|
|
10162
|
+
search_enabled: boolean;
|
|
9967
10163
|
stt_keyterms: string[];
|
|
9968
10164
|
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" | "google/gemini-3.5-transcribe-live" | "soniox/stt-rt-v5") | null;
|
|
9969
10165
|
tts_speed_pct: number | null;
|
|
@@ -9975,7 +10171,9 @@ export interface components {
|
|
|
9975
10171
|
};
|
|
9976
10172
|
PhoneAgentVoiceDto: {
|
|
9977
10173
|
/** @enum {string} */
|
|
9978
|
-
provider: "elevenlabs" | "cartesia" | "vapi";
|
|
10174
|
+
provider: "elevenlabs" | "cartesia" | "vapi" | "live";
|
|
10175
|
+
/** @enum {string} */
|
|
10176
|
+
voice_mode: "modular" | "live";
|
|
9979
10177
|
voice_id: string;
|
|
9980
10178
|
name: string;
|
|
9981
10179
|
labels: {
|
|
@@ -9988,8 +10186,55 @@ export interface components {
|
|
|
9988
10186
|
};
|
|
9989
10187
|
description: string | null;
|
|
9990
10188
|
preview_url: string | null;
|
|
10189
|
+
preview_urls?: {
|
|
10190
|
+
[key: string]: string;
|
|
10191
|
+
};
|
|
9991
10192
|
default_speed_pct: number | null;
|
|
9992
10193
|
};
|
|
10194
|
+
KnowledgeSourceRoutingGuideDto: {
|
|
10195
|
+
/** @enum {string} */
|
|
10196
|
+
status: "fresh" | "stale" | "invalid";
|
|
10197
|
+
/** Format: date-time */
|
|
10198
|
+
generatedAt: string;
|
|
10199
|
+
generationDurationMs: number;
|
|
10200
|
+
schemaVersion: number;
|
|
10201
|
+
sourceCount: number;
|
|
10202
|
+
concepts: {
|
|
10203
|
+
id: string;
|
|
10204
|
+
/** @enum {string} */
|
|
10205
|
+
kind: "audience" | "product" | "intent_family" | "state_axis" | "vocabulary";
|
|
10206
|
+
label: string;
|
|
10207
|
+
description: string;
|
|
10208
|
+
aliases: string[];
|
|
10209
|
+
sourceCount: number;
|
|
10210
|
+
confidence: number;
|
|
10211
|
+
}[];
|
|
10212
|
+
distinctions: {
|
|
10213
|
+
conceptIds: string[];
|
|
10214
|
+
/** @enum {string} */
|
|
10215
|
+
relationship: "confusable" | "overlapping" | "narrower_broader" | "complementary" | "mutually_exclusive";
|
|
10216
|
+
distinction: string;
|
|
10217
|
+
clarifyingQuestion: string | null;
|
|
10218
|
+
confidence: number;
|
|
10219
|
+
}[];
|
|
10220
|
+
toolTransitions: {
|
|
10221
|
+
toolName: string;
|
|
10222
|
+
outcomeFields: string[];
|
|
10223
|
+
conditions: {
|
|
10224
|
+
field: string;
|
|
10225
|
+
/** @enum {string} */
|
|
10226
|
+
operator: "equals" | "not_equals" | "one_of" | "present" | "absent" | "truthy" | "falsy";
|
|
10227
|
+
values: string[];
|
|
10228
|
+
}[];
|
|
10229
|
+
searchIntent: string;
|
|
10230
|
+
confidence: number;
|
|
10231
|
+
}[];
|
|
10232
|
+
changeSet: {
|
|
10233
|
+
addedConceptIds: string[];
|
|
10234
|
+
updatedConceptIds: string[];
|
|
10235
|
+
removedConceptIds: string[];
|
|
10236
|
+
};
|
|
10237
|
+
};
|
|
9993
10238
|
KnowledgeSourceTreeItemDto: {
|
|
9994
10239
|
id: string;
|
|
9995
10240
|
/** @description The scenario/title of the instruction */
|
|
@@ -9999,6 +10244,10 @@ export interface components {
|
|
|
9999
10244
|
directory_id: string | null;
|
|
10000
10245
|
/** @description Whether this instruction is individually selected */
|
|
10001
10246
|
selected: boolean;
|
|
10247
|
+
/** @description Whether this source can be selected for a voice agent */
|
|
10248
|
+
selectable: boolean;
|
|
10249
|
+
/** @description User-facing explanation when the source cannot be selected */
|
|
10250
|
+
unavailableReason: string | null;
|
|
10002
10251
|
};
|
|
10003
10252
|
KnowledgeSourceDirectoryDto: {
|
|
10004
10253
|
id: string;
|
|
@@ -10008,17 +10257,57 @@ export interface components {
|
|
|
10008
10257
|
items: components["schemas"]["KnowledgeSourceTreeItemDto"][];
|
|
10009
10258
|
/** @description Whether the entire directory is selected (all current and future instructions included) */
|
|
10010
10259
|
selected: boolean;
|
|
10260
|
+
/** @description Whether this source can be selected for a voice agent */
|
|
10261
|
+
selectable: boolean;
|
|
10262
|
+
/** @description User-facing explanation when the source cannot be selected */
|
|
10263
|
+
unavailableReason: string | null;
|
|
10011
10264
|
};
|
|
10012
10265
|
KnowledgeSourceTreeDto: {
|
|
10013
10266
|
directories: components["schemas"]["KnowledgeSourceDirectoryDto"][];
|
|
10014
10267
|
uncategorized: components["schemas"]["KnowledgeSourceTreeItemDto"][];
|
|
10015
10268
|
/** @description Estimated tokens for all selected instructions */
|
|
10016
10269
|
totalTokens: number;
|
|
10270
|
+
/**
|
|
10271
|
+
* @description All eligible instructions are searchable when all; otherwise only explicit selections
|
|
10272
|
+
* @enum {string}
|
|
10273
|
+
*/
|
|
10274
|
+
instructionMode: "all" | "selected";
|
|
10275
|
+
/**
|
|
10276
|
+
* @description All eligible knowledge is searchable when all; otherwise only explicit selections
|
|
10277
|
+
* @enum {string}
|
|
10278
|
+
*/
|
|
10279
|
+
knowledgeMode: "all" | "selected";
|
|
10280
|
+
selectedInstructionIds: string[];
|
|
10281
|
+
selectedDirectoryIds: string[];
|
|
10282
|
+
selectedKnowledgeItemIds: string[];
|
|
10283
|
+
selectedKnowledgeFolderKeys: string[];
|
|
10284
|
+
routingGuide: components["schemas"]["KnowledgeSourceRoutingGuideDto"] | null;
|
|
10285
|
+
knowledgeFolders: {
|
|
10286
|
+
key: string;
|
|
10287
|
+
/** @enum {string} */
|
|
10288
|
+
dataSource: "confluence" | "notion" | "zendesk_support" | "shopify" | "gitbook" | "intercom" | "front" | "freshdesk" | "hubspot_kb" | "ai_instructions" | "custom_training" | "website" | "workflow" | "help_center";
|
|
10289
|
+
stream: string | null;
|
|
10290
|
+
label: string | null;
|
|
10291
|
+
documentCount: number;
|
|
10292
|
+
selected: boolean;
|
|
10293
|
+
/** @description Whether this source can be selected for a voice agent */
|
|
10294
|
+
selectable: boolean;
|
|
10295
|
+
/** @description User-facing explanation when the source cannot be selected */
|
|
10296
|
+
unavailableReason: string | null;
|
|
10297
|
+
}[];
|
|
10017
10298
|
};
|
|
10018
10299
|
UpdateKnowledgeSourcesResponseDto: {
|
|
10019
10300
|
success: boolean;
|
|
10020
10301
|
/** @description Estimated tokens for all selected instructions */
|
|
10021
10302
|
totalTokens: number;
|
|
10303
|
+
/** @enum {string} */
|
|
10304
|
+
instructionMode: "all" | "selected";
|
|
10305
|
+
/** @enum {string} */
|
|
10306
|
+
knowledgeMode: "all" | "selected";
|
|
10307
|
+
selectedInstructionIds: string[];
|
|
10308
|
+
selectedDirectoryIds: string[];
|
|
10309
|
+
selectedKnowledgeItemIds: string[];
|
|
10310
|
+
selectedKnowledgeFolderKeys: string[];
|
|
10022
10311
|
};
|
|
10023
10312
|
MakeOutboundCallResponseDto: {
|
|
10024
10313
|
/** @description Error details if the call failed */
|
|
@@ -10256,7 +10545,7 @@ export interface components {
|
|
|
10256
10545
|
updated_at: string;
|
|
10257
10546
|
};
|
|
10258
10547
|
/** @enum {string} */
|
|
10259
|
-
SavedReplyVariableEnum: "agent.full_name" | "agent.email" | "contact.full_name" | "contact.first_name" | "contact.email" | "contact.phone" | "session.number" | "session.status" | "session.language" | "org.name";
|
|
10548
|
+
SavedReplyVariableEnum: "agent.full_name" | "agent.email" | "contact.full_name" | "contact.first_name" | "contact.last_name" | "contact.email" | "contact.phone" | "session.number" | "session.status" | "session.language" | "org.name";
|
|
10260
10549
|
SavedReplyVariablesResponseDto: {
|
|
10261
10550
|
enums: components["schemas"]["SavedReplyVariableEnum"][];
|
|
10262
10551
|
custom: components["schemas"]["SavedReplyVariableDto"][];
|
|
@@ -12213,115 +12502,740 @@ export interface components {
|
|
|
12213
12502
|
available: boolean;
|
|
12214
12503
|
}[];
|
|
12215
12504
|
};
|
|
12216
|
-
|
|
12217
|
-
/**
|
|
12218
|
-
|
|
12219
|
-
|
|
12220
|
-
|
|
12221
|
-
/**
|
|
12222
|
-
|
|
12223
|
-
|
|
12224
|
-
|
|
12225
|
-
|
|
12226
|
-
|
|
12227
|
-
|
|
12228
|
-
} | null;
|
|
12229
|
-
/** @description ISO 8601 timestamp of when the contact was created */
|
|
12230
|
-
created_at: string;
|
|
12231
|
-
/** @description ISO 8601 timestamp of when the contact was last updated */
|
|
12232
|
-
updated_at: string;
|
|
12233
|
-
};
|
|
12234
|
-
InvestigationContact: {
|
|
12235
|
-
/** Format: uuid */
|
|
12236
|
-
id: string;
|
|
12237
|
-
email: string | null;
|
|
12238
|
-
phone_number: string | null;
|
|
12239
|
-
name: string | null;
|
|
12240
|
-
custom_data: {
|
|
12241
|
-
[key: string]: string;
|
|
12242
|
-
} | null;
|
|
12243
|
-
/** @description ISO 8601 timestamp of when the contact was created */
|
|
12244
|
-
created_at: string;
|
|
12245
|
-
/** @description ISO 8601 timestamp of when the contact was last updated */
|
|
12246
|
-
updated_at: string;
|
|
12247
|
-
non_verified_name: string | null;
|
|
12248
|
-
non_verified_email: string | null;
|
|
12249
|
-
non_verified_custom_data: {
|
|
12250
|
-
[key: string]: string | number | boolean;
|
|
12251
|
-
} | null;
|
|
12252
|
-
};
|
|
12253
|
-
InvestigationAssignee: {
|
|
12254
|
-
id: number;
|
|
12255
|
-
name: string | null;
|
|
12256
|
-
email: string | null;
|
|
12257
|
-
avatar_url: string | null;
|
|
12505
|
+
ChatMessageSender: {
|
|
12506
|
+
/** @constant */
|
|
12507
|
+
type: "contact";
|
|
12508
|
+
name?: string;
|
|
12509
|
+
} | {
|
|
12510
|
+
/** @constant */
|
|
12511
|
+
type: "ai";
|
|
12512
|
+
name?: string;
|
|
12513
|
+
} | {
|
|
12514
|
+
/** @constant */
|
|
12515
|
+
type: "human_agent";
|
|
12516
|
+
name?: string;
|
|
12258
12517
|
};
|
|
12259
|
-
|
|
12260
|
-
/** Format: uuid */
|
|
12518
|
+
PublicChatAttachment: {
|
|
12261
12519
|
id: string;
|
|
12262
12520
|
name: string;
|
|
12263
|
-
|
|
12264
|
-
|
|
12265
|
-
|
|
12266
|
-
/** @enum {string} */
|
|
12267
|
-
name: "dynamics365" | "freshchat" | "freshdesk" | "freshdesk_ticketing" | "front" | "gorgias" | "hubspot" | "infobip" | "intercom" | "open" | "salesforce" | "salesforce_v2" | "twilio_flex" | "zendesk" | "zendesk_v2";
|
|
12268
|
-
external_id: string;
|
|
12269
|
-
/** @enum {string} */
|
|
12270
|
-
id_type: "conversation_id" | "ticket_id" | "case_id" | "conversation_sid";
|
|
12271
|
-
};
|
|
12272
|
-
InvestigationSessionSummary: {
|
|
12273
|
-
/** Format: uuid */
|
|
12274
|
-
id: string;
|
|
12275
|
-
ticket_number: number;
|
|
12276
|
-
/** @enum {string} */
|
|
12277
|
-
status: "open" | "closed_resolved" | "closed_unresolved";
|
|
12278
|
-
ai_closure_type: ("assumed_resolved" | "handed_off" | "resolved") | null;
|
|
12279
|
-
sentiment: ("angry" | "happy" | "neutral") | null;
|
|
12280
|
-
channel: {
|
|
12281
|
-
type: components["schemas"]["SessionChannel"];
|
|
12282
|
-
};
|
|
12283
|
-
assist_mode: boolean;
|
|
12284
|
-
language: string | null;
|
|
12285
|
-
/** Format: date-time */
|
|
12286
|
-
created_at: string;
|
|
12287
|
-
/** Format: date-time */
|
|
12288
|
-
updated_at: string;
|
|
12289
|
-
contact: components["schemas"]["InvestigationContact"] | null;
|
|
12290
|
-
team: components["schemas"]["InvestigationTeam"] | null;
|
|
12291
|
-
assignee: components["schemas"]["InvestigationAssignee"] | null;
|
|
12292
|
-
ticketing_system: components["schemas"]["InvestigationTicketingSystem"] | null;
|
|
12521
|
+
size: number;
|
|
12522
|
+
type: string;
|
|
12523
|
+
url: string;
|
|
12293
12524
|
};
|
|
12294
|
-
|
|
12525
|
+
ChatHistoryOutput: {
|
|
12295
12526
|
/** Format: uuid */
|
|
12296
12527
|
id: string;
|
|
12297
|
-
/** Format: date-time */
|
|
12298
12528
|
created_at: string;
|
|
12299
|
-
|
|
12300
|
-
|
|
12301
|
-
|
|
12302
|
-
|
|
12303
|
-
|
|
12304
|
-
|
|
12305
|
-
|
|
12306
|
-
|
|
12307
|
-
|
|
12308
|
-
|
|
12309
|
-
|
|
12310
|
-
|
|
12311
|
-
|
|
12312
|
-
|
|
12313
|
-
|
|
12314
|
-
|
|
12315
|
-
|
|
12316
|
-
|
|
12317
|
-
|
|
12318
|
-
|
|
12319
|
-
|
|
12320
|
-
|
|
12321
|
-
|
|
12322
|
-
|
|
12323
|
-
|
|
12324
|
-
|
|
12529
|
+
event: {
|
|
12530
|
+
/**
|
|
12531
|
+
* @description A recorded event without a typed history mapping. Included in organization exports so no history rows are lost.
|
|
12532
|
+
* @constant
|
|
12533
|
+
*/
|
|
12534
|
+
type: "unmapped_event";
|
|
12535
|
+
/** @enum {string} */
|
|
12536
|
+
message_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_follow_up_cancelled" | "ai_follow_up_fired" | "ai_follow_up_scheduled" | "ai_reopened_session" | "ai_response_cancelled" | "ai_resumed_by_system" | "ai_suggestion" | "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_request_cancelled" | "csat_requested" | "csat_submitted" | "email_draft_message" | "handoff" | "handoff_to_salesforce_miaw" | "handoff_to_third_party_failed" | "handoff_to_zendesk" | "integration_reopened_session" | "message" | "pii_attachment_removed" | "prohibited_topic_detected" | "quoted_content_modified" | "salesforce_fields_updated" | "sequence_message" | "session_forwarded" | "session_language_changed_by_agent" | "session_language_changed_by_api" | "session_language_changed_by_integration" | "session_language_changed_by_system" | "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_session_created" | "sub_session_linked_by_agent" | "sub_session_linked_by_api" | "sub_session_linked_by_integration" | "sub_session_linked_by_system" | "sub_session_unlinked_by_agent" | "sub_session_unlinked_by_api" | "sub_session_unlinked_by_integration" | "sub_session_unlinked_by_system" | "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" | "voice_call_ai_joined" | "voice_call_ai_left" | "voice_call_contact_answered" | "voice_call_contact_joined" | "voice_call_contact_left" | "voice_call_ended" | "voice_call_failed_to_start" | "voice_call_human_answered" | "voice_call_human_joined" | "voice_call_human_left" | "voice_call_started" | "workflow_message" | "workflow_note" | "workflow_triggered";
|
|
12537
|
+
content: {
|
|
12538
|
+
/** @constant */
|
|
12539
|
+
type: "text";
|
|
12540
|
+
text: string;
|
|
12541
|
+
} | null;
|
|
12542
|
+
} | {
|
|
12543
|
+
/**
|
|
12544
|
+
* @description An internal note authored by AI.
|
|
12545
|
+
* @constant
|
|
12546
|
+
*/
|
|
12547
|
+
type: "ai_comment";
|
|
12548
|
+
content: {
|
|
12549
|
+
/** @constant */
|
|
12550
|
+
type: "text";
|
|
12551
|
+
text: string;
|
|
12552
|
+
};
|
|
12553
|
+
comment_thread_id: string | null;
|
|
12554
|
+
} | {
|
|
12555
|
+
/** @constant */
|
|
12556
|
+
type: "message";
|
|
12557
|
+
sender: components["schemas"]["ChatMessageSender"];
|
|
12558
|
+
content: {
|
|
12559
|
+
/** @constant */
|
|
12560
|
+
type: "text";
|
|
12561
|
+
text: string;
|
|
12562
|
+
};
|
|
12563
|
+
context?: {
|
|
12564
|
+
[key: string]: unknown;
|
|
12565
|
+
};
|
|
12566
|
+
/** @description Custom data attached to this message by the sender (e.g. via the widget SDK) */
|
|
12567
|
+
custom_data?: {
|
|
12568
|
+
[key: string]: unknown;
|
|
12569
|
+
};
|
|
12570
|
+
attachments: components["schemas"]["PublicChatAttachment"][];
|
|
12571
|
+
} | {
|
|
12572
|
+
/**
|
|
12573
|
+
* @description An AI draft reply produced in assist mode — suggested to the human support team, never delivered to the contact.
|
|
12574
|
+
* @constant
|
|
12575
|
+
*/
|
|
12576
|
+
type: "ai_suggestion";
|
|
12577
|
+
content: {
|
|
12578
|
+
/** @constant */
|
|
12579
|
+
type: "text";
|
|
12580
|
+
text: string;
|
|
12581
|
+
};
|
|
12582
|
+
attachments: components["schemas"]["PublicChatAttachment"][];
|
|
12583
|
+
} | {
|
|
12584
|
+
/** @constant */
|
|
12585
|
+
type: "workflow_message";
|
|
12586
|
+
workflow_id: string | null;
|
|
12587
|
+
workflow_run_id: string | null;
|
|
12588
|
+
content: {
|
|
12589
|
+
/** @constant */
|
|
12590
|
+
type: "text";
|
|
12591
|
+
text: string;
|
|
12592
|
+
};
|
|
12593
|
+
} | {
|
|
12594
|
+
/** @constant */
|
|
12595
|
+
type: "sequence_message";
|
|
12596
|
+
sequence_id: string | null;
|
|
12597
|
+
content: {
|
|
12598
|
+
/** @constant */
|
|
12599
|
+
type: "text";
|
|
12600
|
+
text: string;
|
|
12601
|
+
};
|
|
12602
|
+
} | {
|
|
12603
|
+
/** @constant */
|
|
12604
|
+
type: "handoff";
|
|
12605
|
+
integration?: {
|
|
12606
|
+
/** @enum {string} */
|
|
12607
|
+
type: "zendesk" | "salesforce-miaw";
|
|
12608
|
+
};
|
|
12609
|
+
} | {
|
|
12610
|
+
/** @constant */
|
|
12611
|
+
type: "closed_resolved_by_agent";
|
|
12612
|
+
} | {
|
|
12613
|
+
/** @constant */
|
|
12614
|
+
type: "closed_resolved_by_system";
|
|
12615
|
+
} | {
|
|
12616
|
+
/** @constant */
|
|
12617
|
+
type: "closed_resolved_by_api";
|
|
12618
|
+
} | {
|
|
12619
|
+
/** @constant */
|
|
12620
|
+
type: "closed_unresolved_by_agent";
|
|
12621
|
+
} | {
|
|
12622
|
+
/** @constant */
|
|
12623
|
+
type: "closed_unresolved_by_system";
|
|
12624
|
+
} | {
|
|
12625
|
+
/** @constant */
|
|
12626
|
+
type: "closed_unresolved_by_api";
|
|
12627
|
+
} | {
|
|
12628
|
+
/** @constant */
|
|
12629
|
+
type: "closed_resolved_by_contact";
|
|
12630
|
+
} | {
|
|
12631
|
+
/** @constant */
|
|
12632
|
+
type: "closed_resolved_by_integration";
|
|
12633
|
+
} | {
|
|
12634
|
+
/** @constant */
|
|
12635
|
+
type: "sub_status_set_by_agent";
|
|
12636
|
+
sub_status_id: string | null;
|
|
12637
|
+
} | {
|
|
12638
|
+
/** @constant */
|
|
12639
|
+
type: "sub_status_set_by_system";
|
|
12640
|
+
sub_status_id: string | null;
|
|
12641
|
+
} | {
|
|
12642
|
+
/** @constant */
|
|
12643
|
+
type: "sub_status_set_by_api";
|
|
12644
|
+
sub_status_id: string | null;
|
|
12645
|
+
} | {
|
|
12646
|
+
/** @constant */
|
|
12647
|
+
type: "sub_status_removed_by_agent";
|
|
12648
|
+
sub_status_id: string | null;
|
|
12649
|
+
} | {
|
|
12650
|
+
/** @constant */
|
|
12651
|
+
type: "sub_status_removed_by_system";
|
|
12652
|
+
sub_status_id: string | null;
|
|
12653
|
+
} | {
|
|
12654
|
+
/** @constant */
|
|
12655
|
+
type: "sub_status_removed_by_api";
|
|
12656
|
+
sub_status_id: string | null;
|
|
12657
|
+
} | {
|
|
12658
|
+
/** @constant */
|
|
12659
|
+
type: "sub_status_set_by_integration";
|
|
12660
|
+
sub_status_id: string | null;
|
|
12661
|
+
} | {
|
|
12662
|
+
/** @constant */
|
|
12663
|
+
type: "sub_status_removed_by_integration";
|
|
12664
|
+
sub_status_id: string | null;
|
|
12665
|
+
} | {
|
|
12666
|
+
/** @enum {string} */
|
|
12667
|
+
type: "tag_added_by_system" | "tag_added_by_agent" | "tag_added_by_api" | "tag_added_by_integration" | "tag_removed_by_system" | "tag_removed_by_agent" | "tag_removed_by_api" | "tag_removed_by_integration";
|
|
12668
|
+
tags: {
|
|
12669
|
+
name: string;
|
|
12670
|
+
}[];
|
|
12671
|
+
} | {
|
|
12672
|
+
/** @constant */
|
|
12673
|
+
type: "ai_resolved_issue";
|
|
12674
|
+
} | {
|
|
12675
|
+
/** @constant */
|
|
12676
|
+
type: "ai_assumed_issue_resolved";
|
|
12677
|
+
} | {
|
|
12678
|
+
/** @constant */
|
|
12679
|
+
type: "user_confirmed_issue_resolved";
|
|
12680
|
+
} | {
|
|
12681
|
+
/** @constant */
|
|
12682
|
+
type: "human_agent_comment";
|
|
12683
|
+
human_agent_id: number;
|
|
12684
|
+
content: {
|
|
12685
|
+
/** @constant */
|
|
12686
|
+
type: "text";
|
|
12687
|
+
text: string;
|
|
12688
|
+
};
|
|
12689
|
+
comment_thread_id: string | null;
|
|
12690
|
+
} | {
|
|
12691
|
+
/** @constant */
|
|
12692
|
+
type: "workflow_note";
|
|
12693
|
+
workflow_id: string | null;
|
|
12694
|
+
workflow_run_id: string | null;
|
|
12695
|
+
content: {
|
|
12696
|
+
/** @constant */
|
|
12697
|
+
type: "text";
|
|
12698
|
+
text: string;
|
|
12699
|
+
};
|
|
12700
|
+
} | {
|
|
12701
|
+
/** @constant */
|
|
12702
|
+
type: "human_agent_joined";
|
|
12703
|
+
human_agent_id: number;
|
|
12704
|
+
} | {
|
|
12705
|
+
/** @constant */
|
|
12706
|
+
type: "human_agent_takeover";
|
|
12707
|
+
human_agent_id: number;
|
|
12708
|
+
} | {
|
|
12709
|
+
/** @constant */
|
|
12710
|
+
type: "human_agent_reopened_session";
|
|
12711
|
+
human_agent_id: number;
|
|
12712
|
+
} | {
|
|
12713
|
+
/** @constant */
|
|
12714
|
+
type: "system_reopened_session";
|
|
12715
|
+
workflow_id: string | null;
|
|
12716
|
+
workflow_run_id: string | null;
|
|
12717
|
+
} | {
|
|
12718
|
+
/** @constant */
|
|
12719
|
+
type: "integration_reopened_session";
|
|
12720
|
+
} | {
|
|
12721
|
+
/** @constant */
|
|
12722
|
+
type: "ai_reopened_session";
|
|
12723
|
+
} | {
|
|
12724
|
+
/** @constant */
|
|
12725
|
+
type: "state_checkpoint";
|
|
12726
|
+
payload: unknown;
|
|
12727
|
+
} | {
|
|
12728
|
+
/** @constant */
|
|
12729
|
+
type: "csat_requested";
|
|
12730
|
+
} | {
|
|
12731
|
+
/** @constant */
|
|
12732
|
+
type: "csat_submitted";
|
|
12733
|
+
payload: {
|
|
12734
|
+
score: number;
|
|
12735
|
+
feedback: string | null;
|
|
12736
|
+
};
|
|
12737
|
+
} | {
|
|
12738
|
+
/** @constant */
|
|
12739
|
+
type: "agent_changed";
|
|
12740
|
+
} | {
|
|
12741
|
+
/** @constant */
|
|
12742
|
+
type: "prohibited_topic_detected";
|
|
12743
|
+
topic: string | null;
|
|
12744
|
+
} | {
|
|
12745
|
+
/** @constant */
|
|
12746
|
+
type: "agent_assigned_by_system";
|
|
12747
|
+
assigned_agent_id?: number;
|
|
12748
|
+
} | {
|
|
12749
|
+
/** @constant */
|
|
12750
|
+
type: "agent_assigned_by_integration";
|
|
12751
|
+
assigned_agent_id?: number;
|
|
12752
|
+
} | {
|
|
12753
|
+
/** @constant */
|
|
12754
|
+
type: "agent_assigned_by_user";
|
|
12755
|
+
assigned_agent_id?: number;
|
|
12756
|
+
actor_id?: number;
|
|
12757
|
+
} | {
|
|
12758
|
+
/** @constant */
|
|
12759
|
+
type: "agent_unassigned_by_system";
|
|
12760
|
+
unassigned_agent_id?: number;
|
|
12761
|
+
} | {
|
|
12762
|
+
/** @constant */
|
|
12763
|
+
type: "agent_unassigned_by_integration";
|
|
12764
|
+
unassigned_agent_id?: number;
|
|
12765
|
+
} | {
|
|
12766
|
+
/** @constant */
|
|
12767
|
+
type: "agent_unassigned_by_user";
|
|
12768
|
+
unassigned_agent_id?: number;
|
|
12769
|
+
actor_id?: number;
|
|
12770
|
+
} | {
|
|
12771
|
+
/** @constant */
|
|
12772
|
+
type: "team_assigned_by_system";
|
|
12773
|
+
assigned_team_id?: string;
|
|
12774
|
+
} | {
|
|
12775
|
+
/** @constant */
|
|
12776
|
+
type: "team_assigned_by_integration";
|
|
12777
|
+
assigned_team_id?: string;
|
|
12778
|
+
} | {
|
|
12779
|
+
/** @constant */
|
|
12780
|
+
type: "team_assigned_by_user";
|
|
12781
|
+
assigned_team_id?: string;
|
|
12782
|
+
actor_id?: number;
|
|
12783
|
+
} | {
|
|
12784
|
+
/** @constant */
|
|
12785
|
+
type: "team_unassigned_by_system";
|
|
12786
|
+
unassigned_team_id?: string;
|
|
12787
|
+
} | {
|
|
12788
|
+
/** @constant */
|
|
12789
|
+
type: "team_unassigned_by_integration";
|
|
12790
|
+
unassigned_team_id?: string;
|
|
12791
|
+
} | {
|
|
12792
|
+
/** @constant */
|
|
12793
|
+
type: "team_unassigned_by_user";
|
|
12794
|
+
unassigned_team_id?: string;
|
|
12795
|
+
actor_id?: number;
|
|
12796
|
+
} | {
|
|
12797
|
+
/** @enum {string} */
|
|
12798
|
+
type: "sla_applied_by_system" | "sla_applied_by_agent" | "sla_removed_by_agent" | "sla_removed_by_system" | "sla_first_reply_metric_started" | "sla_first_reply_fulfilled" | "sla_first_reply_breached" | "sla_first_reply_completed_after_breach" | "sla_next_reply_metric_started" | "sla_next_reply_fulfilled" | "sla_next_reply_breached" | "sla_next_reply_completed_after_breach" | "sla_resolution_metric_started" | "sla_resolution_paused_waiting_on_customer" | "sla_resolution_paused_resolved" | "sla_resolution_resumed_customer_replied" | "sla_resolution_resumed_reopened" | "sla_resolution_fulfilled" | "sla_resolution_breached" | "sla_resolution_completed_after_breach" | "sla_freezed_office_hours_ended" | "sla_resumed_office_hours_started" | "sla_freezed_snoozed" | "sla_resumed_snooze_expired" | "sla_resumed_snooze_cancelled";
|
|
12799
|
+
elapsed_ms: number | null;
|
|
12800
|
+
} | {
|
|
12801
|
+
/** @constant */
|
|
12802
|
+
type: "workflow_triggered";
|
|
12803
|
+
workflow_id: string | null;
|
|
12804
|
+
workflow_run_id: string | null;
|
|
12805
|
+
} | {
|
|
12806
|
+
/** @constant */
|
|
12807
|
+
type: "contact_data_updated";
|
|
12808
|
+
fields: {
|
|
12809
|
+
[key: string]: string;
|
|
12810
|
+
};
|
|
12811
|
+
};
|
|
12812
|
+
};
|
|
12813
|
+
SessionEventsPublicResponse: {
|
|
12814
|
+
items: {
|
|
12815
|
+
/** Format: uuid */
|
|
12816
|
+
id: string;
|
|
12817
|
+
created_at: string;
|
|
12818
|
+
event: {
|
|
12819
|
+
/**
|
|
12820
|
+
* @description A recorded event without a typed history mapping. Included in organization exports so no history rows are lost.
|
|
12821
|
+
* @constant
|
|
12822
|
+
*/
|
|
12823
|
+
type: "unmapped_event";
|
|
12824
|
+
/** @enum {string} */
|
|
12825
|
+
message_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_follow_up_cancelled" | "ai_follow_up_fired" | "ai_follow_up_scheduled" | "ai_reopened_session" | "ai_response_cancelled" | "ai_resumed_by_system" | "ai_suggestion" | "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_request_cancelled" | "csat_requested" | "csat_submitted" | "email_draft_message" | "handoff" | "handoff_to_salesforce_miaw" | "handoff_to_third_party_failed" | "handoff_to_zendesk" | "integration_reopened_session" | "message" | "pii_attachment_removed" | "prohibited_topic_detected" | "quoted_content_modified" | "salesforce_fields_updated" | "sequence_message" | "session_forwarded" | "session_language_changed_by_agent" | "session_language_changed_by_api" | "session_language_changed_by_integration" | "session_language_changed_by_system" | "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_session_created" | "sub_session_linked_by_agent" | "sub_session_linked_by_api" | "sub_session_linked_by_integration" | "sub_session_linked_by_system" | "sub_session_unlinked_by_agent" | "sub_session_unlinked_by_api" | "sub_session_unlinked_by_integration" | "sub_session_unlinked_by_system" | "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" | "voice_call_ai_joined" | "voice_call_ai_left" | "voice_call_contact_answered" | "voice_call_contact_joined" | "voice_call_contact_left" | "voice_call_ended" | "voice_call_failed_to_start" | "voice_call_human_answered" | "voice_call_human_joined" | "voice_call_human_left" | "voice_call_started" | "workflow_message" | "workflow_note" | "workflow_triggered";
|
|
12826
|
+
content: {
|
|
12827
|
+
/** @constant */
|
|
12828
|
+
type: "text";
|
|
12829
|
+
text: string;
|
|
12830
|
+
} | null;
|
|
12831
|
+
} | {
|
|
12832
|
+
/**
|
|
12833
|
+
* @description An internal note authored by AI.
|
|
12834
|
+
* @constant
|
|
12835
|
+
*/
|
|
12836
|
+
type: "ai_comment";
|
|
12837
|
+
content: {
|
|
12838
|
+
/** @constant */
|
|
12839
|
+
type: "text";
|
|
12840
|
+
text: string;
|
|
12841
|
+
};
|
|
12842
|
+
comment_thread_id: string | null;
|
|
12843
|
+
} | {
|
|
12844
|
+
/** @constant */
|
|
12845
|
+
type: "message";
|
|
12846
|
+
sender: components["schemas"]["ChatMessageSender"];
|
|
12847
|
+
content: {
|
|
12848
|
+
/** @constant */
|
|
12849
|
+
type: "text";
|
|
12850
|
+
text: string;
|
|
12851
|
+
};
|
|
12852
|
+
context?: {
|
|
12853
|
+
[key: string]: unknown;
|
|
12854
|
+
};
|
|
12855
|
+
/** @description Custom data attached to this message by the sender (e.g. via the widget SDK) */
|
|
12856
|
+
custom_data?: {
|
|
12857
|
+
[key: string]: unknown;
|
|
12858
|
+
};
|
|
12859
|
+
attachments: components["schemas"]["PublicChatAttachment"][];
|
|
12860
|
+
} | {
|
|
12861
|
+
/**
|
|
12862
|
+
* @description An AI draft reply produced in assist mode — suggested to the human support team, never delivered to the contact.
|
|
12863
|
+
* @constant
|
|
12864
|
+
*/
|
|
12865
|
+
type: "ai_suggestion";
|
|
12866
|
+
content: {
|
|
12867
|
+
/** @constant */
|
|
12868
|
+
type: "text";
|
|
12869
|
+
text: string;
|
|
12870
|
+
};
|
|
12871
|
+
attachments: components["schemas"]["PublicChatAttachment"][];
|
|
12872
|
+
} | {
|
|
12873
|
+
/** @constant */
|
|
12874
|
+
type: "workflow_message";
|
|
12875
|
+
workflow_id: string | null;
|
|
12876
|
+
workflow_run_id: string | null;
|
|
12877
|
+
content: {
|
|
12878
|
+
/** @constant */
|
|
12879
|
+
type: "text";
|
|
12880
|
+
text: string;
|
|
12881
|
+
};
|
|
12882
|
+
} | {
|
|
12883
|
+
/** @constant */
|
|
12884
|
+
type: "sequence_message";
|
|
12885
|
+
sequence_id: string | null;
|
|
12886
|
+
content: {
|
|
12887
|
+
/** @constant */
|
|
12888
|
+
type: "text";
|
|
12889
|
+
text: string;
|
|
12890
|
+
};
|
|
12891
|
+
} | {
|
|
12892
|
+
/** @constant */
|
|
12893
|
+
type: "handoff";
|
|
12894
|
+
integration?: {
|
|
12895
|
+
/** @enum {string} */
|
|
12896
|
+
type: "zendesk" | "salesforce-miaw";
|
|
12897
|
+
};
|
|
12898
|
+
} | {
|
|
12899
|
+
/** @constant */
|
|
12900
|
+
type: "closed_resolved_by_agent";
|
|
12901
|
+
} | {
|
|
12902
|
+
/** @constant */
|
|
12903
|
+
type: "closed_resolved_by_system";
|
|
12904
|
+
} | {
|
|
12905
|
+
/** @constant */
|
|
12906
|
+
type: "closed_resolved_by_api";
|
|
12907
|
+
} | {
|
|
12908
|
+
/** @constant */
|
|
12909
|
+
type: "closed_unresolved_by_agent";
|
|
12910
|
+
} | {
|
|
12911
|
+
/** @constant */
|
|
12912
|
+
type: "closed_unresolved_by_system";
|
|
12913
|
+
} | {
|
|
12914
|
+
/** @constant */
|
|
12915
|
+
type: "closed_unresolved_by_api";
|
|
12916
|
+
} | {
|
|
12917
|
+
/** @constant */
|
|
12918
|
+
type: "closed_resolved_by_contact";
|
|
12919
|
+
} | {
|
|
12920
|
+
/** @constant */
|
|
12921
|
+
type: "closed_resolved_by_integration";
|
|
12922
|
+
} | {
|
|
12923
|
+
/** @constant */
|
|
12924
|
+
type: "sub_status_set_by_agent";
|
|
12925
|
+
sub_status_id: string | null;
|
|
12926
|
+
} | {
|
|
12927
|
+
/** @constant */
|
|
12928
|
+
type: "sub_status_set_by_system";
|
|
12929
|
+
sub_status_id: string | null;
|
|
12930
|
+
} | {
|
|
12931
|
+
/** @constant */
|
|
12932
|
+
type: "sub_status_set_by_api";
|
|
12933
|
+
sub_status_id: string | null;
|
|
12934
|
+
} | {
|
|
12935
|
+
/** @constant */
|
|
12936
|
+
type: "sub_status_removed_by_agent";
|
|
12937
|
+
sub_status_id: string | null;
|
|
12938
|
+
} | {
|
|
12939
|
+
/** @constant */
|
|
12940
|
+
type: "sub_status_removed_by_system";
|
|
12941
|
+
sub_status_id: string | null;
|
|
12942
|
+
} | {
|
|
12943
|
+
/** @constant */
|
|
12944
|
+
type: "sub_status_removed_by_api";
|
|
12945
|
+
sub_status_id: string | null;
|
|
12946
|
+
} | {
|
|
12947
|
+
/** @constant */
|
|
12948
|
+
type: "sub_status_set_by_integration";
|
|
12949
|
+
sub_status_id: string | null;
|
|
12950
|
+
} | {
|
|
12951
|
+
/** @constant */
|
|
12952
|
+
type: "sub_status_removed_by_integration";
|
|
12953
|
+
sub_status_id: string | null;
|
|
12954
|
+
} | {
|
|
12955
|
+
/** @enum {string} */
|
|
12956
|
+
type: "tag_added_by_system" | "tag_added_by_agent" | "tag_added_by_api" | "tag_added_by_integration" | "tag_removed_by_system" | "tag_removed_by_agent" | "tag_removed_by_api" | "tag_removed_by_integration";
|
|
12957
|
+
tags: {
|
|
12958
|
+
name: string;
|
|
12959
|
+
}[];
|
|
12960
|
+
} | {
|
|
12961
|
+
/** @constant */
|
|
12962
|
+
type: "ai_resolved_issue";
|
|
12963
|
+
} | {
|
|
12964
|
+
/** @constant */
|
|
12965
|
+
type: "ai_assumed_issue_resolved";
|
|
12966
|
+
} | {
|
|
12967
|
+
/** @constant */
|
|
12968
|
+
type: "user_confirmed_issue_resolved";
|
|
12969
|
+
} | {
|
|
12970
|
+
/** @constant */
|
|
12971
|
+
type: "human_agent_comment";
|
|
12972
|
+
human_agent_id: number;
|
|
12973
|
+
content: {
|
|
12974
|
+
/** @constant */
|
|
12975
|
+
type: "text";
|
|
12976
|
+
text: string;
|
|
12977
|
+
};
|
|
12978
|
+
comment_thread_id: string | null;
|
|
12979
|
+
} | {
|
|
12980
|
+
/** @constant */
|
|
12981
|
+
type: "workflow_note";
|
|
12982
|
+
workflow_id: string | null;
|
|
12983
|
+
workflow_run_id: string | null;
|
|
12984
|
+
content: {
|
|
12985
|
+
/** @constant */
|
|
12986
|
+
type: "text";
|
|
12987
|
+
text: string;
|
|
12988
|
+
};
|
|
12989
|
+
} | {
|
|
12990
|
+
/** @constant */
|
|
12991
|
+
type: "human_agent_joined";
|
|
12992
|
+
human_agent_id: number;
|
|
12993
|
+
} | {
|
|
12994
|
+
/** @constant */
|
|
12995
|
+
type: "human_agent_takeover";
|
|
12996
|
+
human_agent_id: number;
|
|
12997
|
+
} | {
|
|
12998
|
+
/** @constant */
|
|
12999
|
+
type: "human_agent_reopened_session";
|
|
13000
|
+
human_agent_id: number;
|
|
13001
|
+
} | {
|
|
13002
|
+
/** @constant */
|
|
13003
|
+
type: "system_reopened_session";
|
|
13004
|
+
workflow_id: string | null;
|
|
13005
|
+
workflow_run_id: string | null;
|
|
13006
|
+
} | {
|
|
13007
|
+
/** @constant */
|
|
13008
|
+
type: "integration_reopened_session";
|
|
13009
|
+
} | {
|
|
13010
|
+
/** @constant */
|
|
13011
|
+
type: "ai_reopened_session";
|
|
13012
|
+
} | {
|
|
13013
|
+
/** @constant */
|
|
13014
|
+
type: "state_checkpoint";
|
|
13015
|
+
payload: unknown;
|
|
13016
|
+
} | {
|
|
13017
|
+
/** @constant */
|
|
13018
|
+
type: "csat_requested";
|
|
13019
|
+
} | {
|
|
13020
|
+
/** @constant */
|
|
13021
|
+
type: "csat_submitted";
|
|
13022
|
+
payload: {
|
|
13023
|
+
score: number;
|
|
13024
|
+
feedback: string | null;
|
|
13025
|
+
};
|
|
13026
|
+
} | {
|
|
13027
|
+
/** @constant */
|
|
13028
|
+
type: "agent_changed";
|
|
13029
|
+
} | {
|
|
13030
|
+
/** @constant */
|
|
13031
|
+
type: "prohibited_topic_detected";
|
|
13032
|
+
topic: string | null;
|
|
13033
|
+
} | {
|
|
13034
|
+
/** @constant */
|
|
13035
|
+
type: "agent_assigned_by_system";
|
|
13036
|
+
assigned_agent_id?: number;
|
|
13037
|
+
} | {
|
|
13038
|
+
/** @constant */
|
|
13039
|
+
type: "agent_assigned_by_integration";
|
|
13040
|
+
assigned_agent_id?: number;
|
|
13041
|
+
} | {
|
|
13042
|
+
/** @constant */
|
|
13043
|
+
type: "agent_assigned_by_user";
|
|
13044
|
+
assigned_agent_id?: number;
|
|
13045
|
+
actor_id?: number;
|
|
13046
|
+
} | {
|
|
13047
|
+
/** @constant */
|
|
13048
|
+
type: "agent_unassigned_by_system";
|
|
13049
|
+
unassigned_agent_id?: number;
|
|
13050
|
+
} | {
|
|
13051
|
+
/** @constant */
|
|
13052
|
+
type: "agent_unassigned_by_integration";
|
|
13053
|
+
unassigned_agent_id?: number;
|
|
13054
|
+
} | {
|
|
13055
|
+
/** @constant */
|
|
13056
|
+
type: "agent_unassigned_by_user";
|
|
13057
|
+
unassigned_agent_id?: number;
|
|
13058
|
+
actor_id?: number;
|
|
13059
|
+
} | {
|
|
13060
|
+
/** @constant */
|
|
13061
|
+
type: "team_assigned_by_system";
|
|
13062
|
+
assigned_team_id?: string;
|
|
13063
|
+
} | {
|
|
13064
|
+
/** @constant */
|
|
13065
|
+
type: "team_assigned_by_integration";
|
|
13066
|
+
assigned_team_id?: string;
|
|
13067
|
+
} | {
|
|
13068
|
+
/** @constant */
|
|
13069
|
+
type: "team_assigned_by_user";
|
|
13070
|
+
assigned_team_id?: string;
|
|
13071
|
+
actor_id?: number;
|
|
13072
|
+
} | {
|
|
13073
|
+
/** @constant */
|
|
13074
|
+
type: "team_unassigned_by_system";
|
|
13075
|
+
unassigned_team_id?: string;
|
|
13076
|
+
} | {
|
|
13077
|
+
/** @constant */
|
|
13078
|
+
type: "team_unassigned_by_integration";
|
|
13079
|
+
unassigned_team_id?: string;
|
|
13080
|
+
} | {
|
|
13081
|
+
/** @constant */
|
|
13082
|
+
type: "team_unassigned_by_user";
|
|
13083
|
+
unassigned_team_id?: string;
|
|
13084
|
+
actor_id?: number;
|
|
13085
|
+
} | {
|
|
13086
|
+
/** @enum {string} */
|
|
13087
|
+
type: "sla_applied_by_system" | "sla_applied_by_agent" | "sla_removed_by_agent" | "sla_removed_by_system" | "sla_first_reply_metric_started" | "sla_first_reply_fulfilled" | "sla_first_reply_breached" | "sla_first_reply_completed_after_breach" | "sla_next_reply_metric_started" | "sla_next_reply_fulfilled" | "sla_next_reply_breached" | "sla_next_reply_completed_after_breach" | "sla_resolution_metric_started" | "sla_resolution_paused_waiting_on_customer" | "sla_resolution_paused_resolved" | "sla_resolution_resumed_customer_replied" | "sla_resolution_resumed_reopened" | "sla_resolution_fulfilled" | "sla_resolution_breached" | "sla_resolution_completed_after_breach" | "sla_freezed_office_hours_ended" | "sla_resumed_office_hours_started" | "sla_freezed_snoozed" | "sla_resumed_snooze_expired" | "sla_resumed_snooze_cancelled";
|
|
13088
|
+
elapsed_ms: number | null;
|
|
13089
|
+
} | {
|
|
13090
|
+
/** @constant */
|
|
13091
|
+
type: "workflow_triggered";
|
|
13092
|
+
workflow_id: string | null;
|
|
13093
|
+
workflow_run_id: string | null;
|
|
13094
|
+
} | {
|
|
13095
|
+
/** @constant */
|
|
13096
|
+
type: "contact_data_updated";
|
|
13097
|
+
fields: {
|
|
13098
|
+
[key: string]: string;
|
|
13099
|
+
};
|
|
13100
|
+
};
|
|
13101
|
+
session_id: string | null;
|
|
13102
|
+
contact_id: string | null;
|
|
13103
|
+
/**
|
|
13104
|
+
* @description Stored event type used by include/exclude filters; it can differ from the normalized event.type.
|
|
13105
|
+
* @enum {string}
|
|
13106
|
+
*/
|
|
13107
|
+
message_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_follow_up_cancelled" | "ai_follow_up_fired" | "ai_follow_up_scheduled" | "ai_reopened_session" | "ai_response_cancelled" | "ai_resumed_by_system" | "ai_suggestion" | "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_request_cancelled" | "csat_requested" | "csat_submitted" | "email_draft_message" | "handoff" | "handoff_to_salesforce_miaw" | "handoff_to_third_party_failed" | "handoff_to_zendesk" | "integration_reopened_session" | "message" | "pii_attachment_removed" | "prohibited_topic_detected" | "quoted_content_modified" | "salesforce_fields_updated" | "sequence_message" | "session_forwarded" | "session_language_changed_by_agent" | "session_language_changed_by_api" | "session_language_changed_by_integration" | "session_language_changed_by_system" | "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_session_created" | "sub_session_linked_by_agent" | "sub_session_linked_by_api" | "sub_session_linked_by_integration" | "sub_session_linked_by_system" | "sub_session_unlinked_by_agent" | "sub_session_unlinked_by_api" | "sub_session_unlinked_by_integration" | "sub_session_unlinked_by_system" | "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" | "voice_call_ai_joined" | "voice_call_ai_left" | "voice_call_contact_answered" | "voice_call_contact_joined" | "voice_call_contact_left" | "voice_call_ended" | "voice_call_failed_to_start" | "voice_call_human_answered" | "voice_call_human_joined" | "voice_call_human_left" | "voice_call_started" | "workflow_message" | "workflow_note" | "workflow_triggered";
|
|
13108
|
+
actor: {
|
|
13109
|
+
/** @enum {string} */
|
|
13110
|
+
type: "human" | "api" | "workflow" | "system" | "integration" | "ai" | "contact" | "unknown";
|
|
13111
|
+
id?: string;
|
|
13112
|
+
workflow_run_id?: string;
|
|
13113
|
+
};
|
|
13114
|
+
details: {
|
|
13115
|
+
message: string | null;
|
|
13116
|
+
target: {
|
|
13117
|
+
/** @enum {string} */
|
|
13118
|
+
type: "human" | "ai" | "team" | "none";
|
|
13119
|
+
id?: string;
|
|
13120
|
+
} | null;
|
|
13121
|
+
sub_status_id: string | null;
|
|
13122
|
+
workflow_id: string | null;
|
|
13123
|
+
workflow_run_id: string | null;
|
|
13124
|
+
edited_at: string | null;
|
|
13125
|
+
deleted_at: string | null;
|
|
13126
|
+
};
|
|
13127
|
+
}[];
|
|
13128
|
+
next: string | null;
|
|
13129
|
+
};
|
|
13130
|
+
SaveContactOutput: {
|
|
13131
|
+
/** Format: uuid */
|
|
13132
|
+
id?: string;
|
|
13133
|
+
};
|
|
13134
|
+
Contact: {
|
|
13135
|
+
/** Format: uuid */
|
|
13136
|
+
id: string;
|
|
13137
|
+
email: string | null;
|
|
13138
|
+
phone_number: string | null;
|
|
13139
|
+
name: string | null;
|
|
13140
|
+
custom_data: {
|
|
13141
|
+
[key: string]: string;
|
|
13142
|
+
} | null;
|
|
13143
|
+
/** @description ISO 8601 timestamp of when the contact was created */
|
|
13144
|
+
created_at: string;
|
|
13145
|
+
/** @description ISO 8601 timestamp of when the contact was last updated */
|
|
13146
|
+
updated_at: string;
|
|
13147
|
+
};
|
|
13148
|
+
InvestigationContact: {
|
|
13149
|
+
/** Format: uuid */
|
|
13150
|
+
id: string;
|
|
13151
|
+
email: string | null;
|
|
13152
|
+
phone_number: string | null;
|
|
13153
|
+
name: string | null;
|
|
13154
|
+
custom_data: {
|
|
13155
|
+
[key: string]: string;
|
|
13156
|
+
} | null;
|
|
13157
|
+
/** @description ISO 8601 timestamp of when the contact was created */
|
|
13158
|
+
created_at: string;
|
|
13159
|
+
/** @description ISO 8601 timestamp of when the contact was last updated */
|
|
13160
|
+
updated_at: string;
|
|
13161
|
+
non_verified_name: string | null;
|
|
13162
|
+
non_verified_email: string | null;
|
|
13163
|
+
non_verified_custom_data: {
|
|
13164
|
+
[key: string]: string | number | boolean;
|
|
13165
|
+
} | null;
|
|
13166
|
+
};
|
|
13167
|
+
InvestigationAssignee: {
|
|
13168
|
+
id: number;
|
|
13169
|
+
name: string | null;
|
|
13170
|
+
email: string | null;
|
|
13171
|
+
avatar_url: string | null;
|
|
13172
|
+
};
|
|
13173
|
+
InvestigationTeam: {
|
|
13174
|
+
/** Format: uuid */
|
|
13175
|
+
id: string;
|
|
13176
|
+
name: string;
|
|
13177
|
+
description: string | null;
|
|
13178
|
+
};
|
|
13179
|
+
InvestigationTicketingSystem: {
|
|
13180
|
+
/** @enum {string} */
|
|
13181
|
+
name: "dynamics365" | "freshchat" | "freshdesk" | "freshdesk_ticketing" | "front" | "gorgias" | "hubspot" | "infobip" | "intercom" | "open" | "salesforce" | "salesforce_v2" | "twilio_flex" | "zendesk" | "zendesk_v2";
|
|
13182
|
+
external_id: string;
|
|
13183
|
+
/** @enum {string} */
|
|
13184
|
+
id_type: "conversation_id" | "ticket_id" | "case_id" | "conversation_sid";
|
|
13185
|
+
};
|
|
13186
|
+
InvestigationSessionSummary: {
|
|
13187
|
+
/** Format: uuid */
|
|
13188
|
+
id: string;
|
|
13189
|
+
ticket_number: number;
|
|
13190
|
+
/** @enum {string} */
|
|
13191
|
+
status: "open" | "closed_resolved" | "closed_unresolved";
|
|
13192
|
+
ai_closure_type: ("assumed_resolved" | "handed_off" | "resolved") | null;
|
|
13193
|
+
sentiment: ("angry" | "happy" | "neutral") | null;
|
|
13194
|
+
channel: {
|
|
13195
|
+
type: components["schemas"]["SessionChannel"];
|
|
13196
|
+
};
|
|
13197
|
+
assist_mode: boolean;
|
|
13198
|
+
language: string | null;
|
|
13199
|
+
/** Format: date-time */
|
|
13200
|
+
created_at: string;
|
|
13201
|
+
/** Format: date-time */
|
|
13202
|
+
updated_at: string;
|
|
13203
|
+
contact: components["schemas"]["InvestigationContact"] | null;
|
|
13204
|
+
team: components["schemas"]["InvestigationTeam"] | null;
|
|
13205
|
+
assignee: components["schemas"]["InvestigationAssignee"] | null;
|
|
13206
|
+
ticketing_system: components["schemas"]["InvestigationTicketingSystem"] | null;
|
|
13207
|
+
};
|
|
13208
|
+
InvestigationHistoryItem: {
|
|
13209
|
+
/** Format: uuid */
|
|
13210
|
+
id: string;
|
|
13211
|
+
/** Format: date-time */
|
|
13212
|
+
created_at: string;
|
|
13213
|
+
event_type: string;
|
|
13214
|
+
sender_type: ("contact" | "ai" | "human_agent") | null;
|
|
13215
|
+
sender_name: string | null;
|
|
13216
|
+
text: string | null;
|
|
13217
|
+
};
|
|
13218
|
+
InvestigationHistoryStats: {
|
|
13219
|
+
total_events_loaded: number;
|
|
13220
|
+
last_customer_message_at: string | null;
|
|
13221
|
+
last_ai_message_at: string | null;
|
|
13222
|
+
last_human_message_at: string | null;
|
|
13223
|
+
};
|
|
13224
|
+
InvestigationReferenceItem: {
|
|
13225
|
+
/** @enum {string} */
|
|
13226
|
+
reference_type: "ai_profile" | "instruction" | "knowledge" | "prohibited_topic" | "tool";
|
|
13227
|
+
reference_id: string;
|
|
13228
|
+
};
|
|
13229
|
+
InvestigationReferenceBuckets: {
|
|
13230
|
+
knowledge: string[];
|
|
13231
|
+
tools: string[];
|
|
13232
|
+
instructions: string[];
|
|
13233
|
+
ai_profile: string[];
|
|
13234
|
+
prohibited_topics: string[];
|
|
13235
|
+
};
|
|
13236
|
+
InvestigationHandoff: {
|
|
13237
|
+
/** Format: uuid */
|
|
13238
|
+
id: string;
|
|
12325
13239
|
/** Format: date-time */
|
|
12326
13240
|
created_at: string;
|
|
12327
13241
|
summary: string;
|
|
@@ -12405,6 +13319,8 @@ export interface components {
|
|
|
12405
13319
|
sentiment: ("angry" | "happy" | "neutral") | null;
|
|
12406
13320
|
/** @description AI-generated summary of the conversation. Populated for both AI-resolved and handed-off sessions once the session has been summarized; null otherwise. */
|
|
12407
13321
|
summary: string | null;
|
|
13322
|
+
/** @description Session title: the email subject, a subject set by an agent, or an AI-generated title. Null until one is set. */
|
|
13323
|
+
title: string | null;
|
|
12408
13324
|
channel: {
|
|
12409
13325
|
type: components["schemas"]["SessionChannel"];
|
|
12410
13326
|
};
|
|
@@ -12617,6 +13533,16 @@ export interface components {
|
|
|
12617
13533
|
name: string;
|
|
12618
13534
|
}[];
|
|
12619
13535
|
} | null;
|
|
13536
|
+
integration_actor?: {
|
|
13537
|
+
/** @enum {string} */
|
|
13538
|
+
system: "intercom";
|
|
13539
|
+
/** @enum {string} */
|
|
13540
|
+
kind: "admin" | "bot" | "team" | "workflow" | "balanced" | "unknown";
|
|
13541
|
+
name: string | null;
|
|
13542
|
+
external_id: string | null;
|
|
13543
|
+
part_type?: string | null;
|
|
13544
|
+
open_cx_user_id?: number | null;
|
|
13545
|
+
} | null;
|
|
12620
13546
|
destination_id?: string;
|
|
12621
13547
|
destination_name?: string;
|
|
12622
13548
|
/** @enum {string} */
|
|
@@ -12627,326 +13553,68 @@ export interface components {
|
|
|
12627
13553
|
failover_source?: "stt" | "llm" | "tts";
|
|
12628
13554
|
/** @enum {string} */
|
|
12629
13555
|
hangup_initiator?: "user" | "agent" | "system";
|
|
12630
|
-
hangup_reason?: string;
|
|
12631
|
-
duration_seconds?: number;
|
|
12632
|
-
/** @enum {string} */
|
|
12633
|
-
call_direction?: "inbound" | "outbound";
|
|
12634
|
-
|
|
12635
|
-
|
|
12636
|
-
|
|
12637
|
-
|
|
12638
|
-
|
|
12639
|
-
|
|
12640
|
-
|
|
12641
|
-
|
|
12642
|
-
|
|
12643
|
-
|
|
12644
|
-
|
|
12645
|
-
|
|
12646
|
-
|
|
12647
|
-
|
|
12648
|
-
|
|
12649
|
-
|
|
12650
|
-
|
|
12651
|
-
|
|
12652
|
-
|
|
12653
|
-
|
|
12654
|
-
|
|
12655
|
-
|
|
12656
|
-
|
|
12657
|
-
|
|
12658
|
-
resolveArgs?: {
|
|
12659
|
-
/** @description Summary of the conversation with the user to be viewed by a human agent. */
|
|
12660
|
-
summary: string;
|
|
12661
|
-
/** @enum {string} */
|
|
12662
|
-
sentiment: "angry" | "happy" | "neutral";
|
|
12663
|
-
};
|
|
12664
|
-
toolCallResultsQuickReplySuggestions?: {
|
|
12665
|
-
tool_name: string;
|
|
12666
|
-
suggestions: string[];
|
|
12667
|
-
}[];
|
|
12668
|
-
} | {
|
|
12669
|
-
/** @constant */
|
|
12670
|
-
success: false;
|
|
12671
|
-
error: {
|
|
12672
|
-
code?: string;
|
|
12673
|
-
message?: string;
|
|
12674
|
-
};
|
|
12675
|
-
});
|
|
12676
|
-
};
|
|
12677
|
-
ChatMessageSender: {
|
|
12678
|
-
/** @constant */
|
|
12679
|
-
type: "contact";
|
|
12680
|
-
name?: string;
|
|
12681
|
-
} | {
|
|
12682
|
-
/** @constant */
|
|
12683
|
-
type: "ai";
|
|
12684
|
-
name?: string;
|
|
12685
|
-
} | {
|
|
12686
|
-
/** @constant */
|
|
12687
|
-
type: "human_agent";
|
|
12688
|
-
name?: string;
|
|
12689
|
-
};
|
|
12690
|
-
PublicChatAttachment: {
|
|
12691
|
-
id: string;
|
|
12692
|
-
name: string;
|
|
12693
|
-
size: number;
|
|
12694
|
-
type: string;
|
|
12695
|
-
url: string;
|
|
12696
|
-
};
|
|
12697
|
-
ChatHistoryOutput: {
|
|
12698
|
-
/** Format: uuid */
|
|
12699
|
-
id: string;
|
|
12700
|
-
/** Format: date-time */
|
|
12701
|
-
created_at: string;
|
|
12702
|
-
event: {
|
|
12703
|
-
/** @constant */
|
|
12704
|
-
type: "message";
|
|
12705
|
-
sender: components["schemas"]["ChatMessageSender"];
|
|
12706
|
-
content: {
|
|
12707
|
-
/** @constant */
|
|
12708
|
-
type: "text";
|
|
12709
|
-
text: string;
|
|
12710
|
-
};
|
|
12711
|
-
context?: {
|
|
12712
|
-
[key: string]: unknown;
|
|
12713
|
-
};
|
|
12714
|
-
/** @description Custom data attached to this message by the sender (e.g. via the widget SDK) */
|
|
12715
|
-
custom_data?: {
|
|
12716
|
-
[key: string]: unknown;
|
|
12717
|
-
};
|
|
12718
|
-
attachments: components["schemas"]["PublicChatAttachment"][];
|
|
12719
|
-
} | {
|
|
12720
|
-
/**
|
|
12721
|
-
* @description An AI draft reply produced in assist mode — suggested to the human support team, never delivered to the contact.
|
|
12722
|
-
* @constant
|
|
12723
|
-
*/
|
|
12724
|
-
type: "ai_suggestion";
|
|
12725
|
-
content: {
|
|
12726
|
-
/** @constant */
|
|
12727
|
-
type: "text";
|
|
12728
|
-
text: string;
|
|
12729
|
-
};
|
|
12730
|
-
attachments: components["schemas"]["PublicChatAttachment"][];
|
|
12731
|
-
} | {
|
|
12732
|
-
/** @constant */
|
|
12733
|
-
type: "workflow_message";
|
|
12734
|
-
workflow_id: string | null;
|
|
12735
|
-
workflow_run_id: string | null;
|
|
12736
|
-
content: {
|
|
12737
|
-
/** @constant */
|
|
12738
|
-
type: "text";
|
|
12739
|
-
text: string;
|
|
12740
|
-
};
|
|
12741
|
-
} | {
|
|
12742
|
-
/** @constant */
|
|
12743
|
-
type: "sequence_message";
|
|
12744
|
-
sequence_id: string | null;
|
|
12745
|
-
content: {
|
|
12746
|
-
/** @constant */
|
|
12747
|
-
type: "text";
|
|
12748
|
-
text: string;
|
|
12749
|
-
};
|
|
12750
|
-
} | {
|
|
12751
|
-
/** @constant */
|
|
12752
|
-
type: "handoff";
|
|
12753
|
-
integration?: {
|
|
12754
|
-
/** @enum {string} */
|
|
12755
|
-
type: "zendesk" | "salesforce-miaw";
|
|
12756
|
-
};
|
|
12757
|
-
} | {
|
|
12758
|
-
/** @constant */
|
|
12759
|
-
type: "closed_resolved_by_agent";
|
|
12760
|
-
} | {
|
|
12761
|
-
/** @constant */
|
|
12762
|
-
type: "closed_resolved_by_system";
|
|
12763
|
-
} | {
|
|
12764
|
-
/** @constant */
|
|
12765
|
-
type: "closed_resolved_by_api";
|
|
12766
|
-
} | {
|
|
12767
|
-
/** @constant */
|
|
12768
|
-
type: "closed_unresolved_by_agent";
|
|
12769
|
-
} | {
|
|
12770
|
-
/** @constant */
|
|
12771
|
-
type: "closed_unresolved_by_system";
|
|
12772
|
-
} | {
|
|
12773
|
-
/** @constant */
|
|
12774
|
-
type: "closed_unresolved_by_api";
|
|
12775
|
-
} | {
|
|
12776
|
-
/** @constant */
|
|
12777
|
-
type: "closed_resolved_by_contact";
|
|
12778
|
-
} | {
|
|
12779
|
-
/** @constant */
|
|
12780
|
-
type: "closed_resolved_by_integration";
|
|
12781
|
-
} | {
|
|
12782
|
-
/** @constant */
|
|
12783
|
-
type: "sub_status_set_by_agent";
|
|
12784
|
-
sub_status_id: string | null;
|
|
12785
|
-
} | {
|
|
12786
|
-
/** @constant */
|
|
12787
|
-
type: "sub_status_set_by_system";
|
|
12788
|
-
sub_status_id: string | null;
|
|
12789
|
-
} | {
|
|
12790
|
-
/** @constant */
|
|
12791
|
-
type: "sub_status_set_by_api";
|
|
12792
|
-
sub_status_id: string | null;
|
|
12793
|
-
} | {
|
|
12794
|
-
/** @constant */
|
|
12795
|
-
type: "sub_status_removed_by_agent";
|
|
12796
|
-
sub_status_id: string | null;
|
|
12797
|
-
} | {
|
|
12798
|
-
/** @constant */
|
|
12799
|
-
type: "sub_status_removed_by_system";
|
|
12800
|
-
sub_status_id: string | null;
|
|
12801
|
-
} | {
|
|
12802
|
-
/** @constant */
|
|
12803
|
-
type: "sub_status_removed_by_api";
|
|
12804
|
-
sub_status_id: string | null;
|
|
12805
|
-
} | {
|
|
12806
|
-
/** @constant */
|
|
12807
|
-
type: "sub_status_set_by_integration";
|
|
12808
|
-
sub_status_id: string | null;
|
|
12809
|
-
} | {
|
|
12810
|
-
/** @constant */
|
|
12811
|
-
type: "sub_status_removed_by_integration";
|
|
12812
|
-
sub_status_id: string | null;
|
|
12813
|
-
} | {
|
|
12814
|
-
/** @enum {string} */
|
|
12815
|
-
type: "tag_added_by_system" | "tag_added_by_agent" | "tag_added_by_api" | "tag_added_by_integration" | "tag_removed_by_system" | "tag_removed_by_agent" | "tag_removed_by_api" | "tag_removed_by_integration";
|
|
12816
|
-
tags: {
|
|
12817
|
-
name: string;
|
|
12818
|
-
}[];
|
|
12819
|
-
} | {
|
|
12820
|
-
/** @constant */
|
|
12821
|
-
type: "ai_resolved_issue";
|
|
12822
|
-
} | {
|
|
12823
|
-
/** @constant */
|
|
12824
|
-
type: "ai_assumed_issue_resolved";
|
|
12825
|
-
} | {
|
|
12826
|
-
/** @constant */
|
|
12827
|
-
type: "user_confirmed_issue_resolved";
|
|
12828
|
-
} | {
|
|
12829
|
-
/** @constant */
|
|
12830
|
-
type: "human_agent_comment";
|
|
12831
|
-
human_agent_id: number;
|
|
12832
|
-
content: {
|
|
12833
|
-
/** @constant */
|
|
12834
|
-
type: "text";
|
|
12835
|
-
text: string;
|
|
12836
|
-
};
|
|
12837
|
-
comment_thread_id: string | null;
|
|
12838
|
-
} | {
|
|
12839
|
-
/** @constant */
|
|
12840
|
-
type: "human_agent_joined";
|
|
12841
|
-
human_agent_id: number;
|
|
12842
|
-
} | {
|
|
12843
|
-
/** @constant */
|
|
12844
|
-
type: "human_agent_takeover";
|
|
12845
|
-
human_agent_id: number;
|
|
12846
|
-
} | {
|
|
12847
|
-
/** @constant */
|
|
12848
|
-
type: "human_agent_reopened_session";
|
|
12849
|
-
human_agent_id: number;
|
|
12850
|
-
} | {
|
|
12851
|
-
/** @constant */
|
|
12852
|
-
type: "system_reopened_session";
|
|
12853
|
-
workflow_id: string | null;
|
|
12854
|
-
workflow_run_id: string | null;
|
|
12855
|
-
} | {
|
|
12856
|
-
/** @constant */
|
|
12857
|
-
type: "integration_reopened_session";
|
|
12858
|
-
} | {
|
|
12859
|
-
/** @constant */
|
|
12860
|
-
type: "ai_reopened_session";
|
|
12861
|
-
} | {
|
|
12862
|
-
/** @constant */
|
|
12863
|
-
type: "state_checkpoint";
|
|
12864
|
-
payload: unknown;
|
|
12865
|
-
} | {
|
|
12866
|
-
/** @constant */
|
|
12867
|
-
type: "csat_requested";
|
|
12868
|
-
} | {
|
|
12869
|
-
/** @constant */
|
|
12870
|
-
type: "csat_submitted";
|
|
12871
|
-
payload: {
|
|
12872
|
-
score: number;
|
|
12873
|
-
feedback: string | null;
|
|
13556
|
+
hangup_reason?: string;
|
|
13557
|
+
duration_seconds?: number;
|
|
13558
|
+
/** @enum {string} */
|
|
13559
|
+
call_direction?: "inbound" | "outbound";
|
|
13560
|
+
voice_call?: {
|
|
13561
|
+
/** @enum {string} */
|
|
13562
|
+
source: "backend" | "livekit" | "voice_worker" | "twilio" | "vapi";
|
|
13563
|
+
occurrence_id?: string;
|
|
13564
|
+
failure?: {
|
|
13565
|
+
/** @enum {string} */
|
|
13566
|
+
stage: "dispatch" | "sip" | "provider";
|
|
13567
|
+
code: string;
|
|
13568
|
+
};
|
|
13569
|
+
participant?: {
|
|
13570
|
+
id: string;
|
|
13571
|
+
name?: string;
|
|
13572
|
+
userId?: number;
|
|
13573
|
+
phoneNumber?: string;
|
|
13574
|
+
};
|
|
13575
|
+
};
|
|
13576
|
+
};
|
|
13577
|
+
assistMode: boolean;
|
|
13578
|
+
mode?: {
|
|
13579
|
+
id: string;
|
|
13580
|
+
name: string;
|
|
13581
|
+
slug?: string;
|
|
13582
|
+
};
|
|
13583
|
+
didExitMode?: boolean;
|
|
12874
13584
|
};
|
|
13585
|
+
uiResponse?: {
|
|
13586
|
+
/** @constant */
|
|
13587
|
+
type: "ui";
|
|
13588
|
+
value: {
|
|
13589
|
+
/** @constant */
|
|
13590
|
+
type: "ui_component";
|
|
13591
|
+
request_response: unknown;
|
|
13592
|
+
name: string;
|
|
13593
|
+
content?: string;
|
|
13594
|
+
};
|
|
13595
|
+
mightSolveUserIssue: boolean;
|
|
13596
|
+
};
|
|
13597
|
+
sessionIsHandedOff?: boolean;
|
|
13598
|
+
steeredIntoTurnId?: string;
|
|
13599
|
+
workflowRunIds?: string[];
|
|
13600
|
+
resolveArgs?: {
|
|
13601
|
+
/** @description Summary of the conversation with the user to be viewed by a human agent. */
|
|
13602
|
+
summary: string;
|
|
13603
|
+
/** @enum {string} */
|
|
13604
|
+
sentiment: "angry" | "happy" | "neutral";
|
|
13605
|
+
};
|
|
13606
|
+
toolCallResultsQuickReplySuggestions?: {
|
|
13607
|
+
tool_name: string;
|
|
13608
|
+
suggestions: string[];
|
|
13609
|
+
}[];
|
|
12875
13610
|
} | {
|
|
12876
13611
|
/** @constant */
|
|
12877
|
-
|
|
12878
|
-
|
|
12879
|
-
|
|
12880
|
-
|
|
12881
|
-
topic: string | null;
|
|
12882
|
-
} | {
|
|
12883
|
-
/** @constant */
|
|
12884
|
-
type: "agent_assigned_by_system";
|
|
12885
|
-
assigned_agent_id?: number;
|
|
12886
|
-
} | {
|
|
12887
|
-
/** @constant */
|
|
12888
|
-
type: "agent_assigned_by_integration";
|
|
12889
|
-
assigned_agent_id?: number;
|
|
12890
|
-
} | {
|
|
12891
|
-
/** @constant */
|
|
12892
|
-
type: "agent_assigned_by_user";
|
|
12893
|
-
assigned_agent_id?: number;
|
|
12894
|
-
actor_id?: number;
|
|
12895
|
-
} | {
|
|
12896
|
-
/** @constant */
|
|
12897
|
-
type: "agent_unassigned_by_system";
|
|
12898
|
-
unassigned_agent_id?: number;
|
|
12899
|
-
} | {
|
|
12900
|
-
/** @constant */
|
|
12901
|
-
type: "agent_unassigned_by_integration";
|
|
12902
|
-
unassigned_agent_id?: number;
|
|
12903
|
-
} | {
|
|
12904
|
-
/** @constant */
|
|
12905
|
-
type: "agent_unassigned_by_user";
|
|
12906
|
-
unassigned_agent_id?: number;
|
|
12907
|
-
actor_id?: number;
|
|
12908
|
-
} | {
|
|
12909
|
-
/** @constant */
|
|
12910
|
-
type: "team_assigned_by_system";
|
|
12911
|
-
assigned_team_id?: string;
|
|
12912
|
-
} | {
|
|
12913
|
-
/** @constant */
|
|
12914
|
-
type: "team_assigned_by_integration";
|
|
12915
|
-
assigned_team_id?: string;
|
|
12916
|
-
} | {
|
|
12917
|
-
/** @constant */
|
|
12918
|
-
type: "team_assigned_by_user";
|
|
12919
|
-
assigned_team_id?: string;
|
|
12920
|
-
actor_id?: number;
|
|
12921
|
-
} | {
|
|
12922
|
-
/** @constant */
|
|
12923
|
-
type: "team_unassigned_by_system";
|
|
12924
|
-
unassigned_team_id?: string;
|
|
12925
|
-
} | {
|
|
12926
|
-
/** @constant */
|
|
12927
|
-
type: "team_unassigned_by_integration";
|
|
12928
|
-
unassigned_team_id?: string;
|
|
12929
|
-
} | {
|
|
12930
|
-
/** @constant */
|
|
12931
|
-
type: "team_unassigned_by_user";
|
|
12932
|
-
unassigned_team_id?: string;
|
|
12933
|
-
actor_id?: number;
|
|
12934
|
-
} | {
|
|
12935
|
-
/** @enum {string} */
|
|
12936
|
-
type: "sla_applied_by_system" | "sla_applied_by_agent" | "sla_removed_by_agent" | "sla_removed_by_system" | "sla_first_reply_metric_started" | "sla_first_reply_fulfilled" | "sla_first_reply_breached" | "sla_first_reply_completed_after_breach" | "sla_next_reply_metric_started" | "sla_next_reply_fulfilled" | "sla_next_reply_breached" | "sla_next_reply_completed_after_breach" | "sla_resolution_metric_started" | "sla_resolution_paused_waiting_on_customer" | "sla_resolution_paused_resolved" | "sla_resolution_resumed_customer_replied" | "sla_resolution_resumed_reopened" | "sla_resolution_fulfilled" | "sla_resolution_breached" | "sla_resolution_completed_after_breach" | "sla_freezed_office_hours_ended" | "sla_resumed_office_hours_started" | "sla_freezed_snoozed" | "sla_resumed_snooze_expired" | "sla_resumed_snooze_cancelled";
|
|
12937
|
-
elapsed_ms: number | null;
|
|
12938
|
-
} | {
|
|
12939
|
-
/** @constant */
|
|
12940
|
-
type: "workflow_triggered";
|
|
12941
|
-
workflow_id: string | null;
|
|
12942
|
-
workflow_run_id: string | null;
|
|
12943
|
-
} | {
|
|
12944
|
-
/** @constant */
|
|
12945
|
-
type: "contact_data_updated";
|
|
12946
|
-
fields: {
|
|
12947
|
-
[key: string]: string;
|
|
13612
|
+
success: false;
|
|
13613
|
+
error: {
|
|
13614
|
+
code?: string;
|
|
13615
|
+
message?: string;
|
|
12948
13616
|
};
|
|
12949
|
-
};
|
|
13617
|
+
});
|
|
12950
13618
|
};
|
|
12951
13619
|
ChatSessionFollowUpOutput: {
|
|
12952
13620
|
/** @description Follow-up id — stable across the follow-up’s lifetime */
|
|
@@ -13165,7 +13833,7 @@ export interface components {
|
|
|
13165
13833
|
/** @enum {string} */
|
|
13166
13834
|
source_type: "custom_training" | "help_center" | "integration" | "website" | "workflow";
|
|
13167
13835
|
/** @description External source the item was synced from (present when listing). */
|
|
13168
|
-
data_source?: ("confluence" | "notion" | "zendesk_support" | "shopify" | "gitbook" | "intercom" | "front" | "freshdesk" | "hubspot_kb" | "ai_instructions" | "custom_training" | "website" | "workflow") | null;
|
|
13836
|
+
data_source?: ("confluence" | "notion" | "zendesk_support" | "shopify" | "gitbook" | "intercom" | "front" | "freshdesk" | "hubspot_kb" | "ai_instructions" | "custom_training" | "website" | "workflow" | "help_center") | null;
|
|
13169
13837
|
stream?: string | null;
|
|
13170
13838
|
source_url: string | null;
|
|
13171
13839
|
/** @description Contact segment ids this item is restricted to. Empty = available to all contacts. */
|
|
@@ -13909,6 +14577,11 @@ export interface components {
|
|
|
13909
14577
|
directories: components["schemas"]["DirectoryTreeItem"][];
|
|
13910
14578
|
uncategorized: components["schemas"]["TrainingPublicResponseDto"][];
|
|
13911
14579
|
};
|
|
14580
|
+
OrgUserRole: {
|
|
14581
|
+
/** Format: uuid */
|
|
14582
|
+
id: string;
|
|
14583
|
+
name: string;
|
|
14584
|
+
};
|
|
13912
14585
|
OrgUserSummary: {
|
|
13913
14586
|
id: number;
|
|
13914
14587
|
uuid?: string | null;
|
|
@@ -13917,6 +14590,7 @@ export interface components {
|
|
|
13917
14590
|
email: string;
|
|
13918
14591
|
avatar_url?: string | null;
|
|
13919
14592
|
permissions?: ("*" | "sessions:read" | "sessions:write" | "sessions-personal-views:write" | "sessions-shared-views:read" | "sessions-shared-views:write" | "sessions-create:write" | "sessions-sub-sessions:write" | "contacts:read" | "contacts:write" | "companies:read" | "companies: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" | "workflows:execute" | "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" | "settings:read" | "settings:write" | "settings-general:read" | "settings-general:write" | "settings-billing:read" | "settings-billing:write" | "settings-api-keys:read" | "settings-api-keys:write" | "settings-autopilot:read" | "settings-autopilot:write" | "settings-structured-fields:read" | "settings-structured-fields: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-email-fleet:read" | "settings-email-fleet:write" | "settings-helpdesk:read" | "settings-helpdesk:write" | "settings-custom-statuses:read" | "settings-custom-statuses:write" | "settings-availability-statuses:read" | "settings-availability-statuses:write" | "settings-personal-profile:read" | "settings-personal-profile: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;
|
|
14593
|
+
roles: components["schemas"]["OrgUserRole"][];
|
|
13920
14594
|
};
|
|
13921
14595
|
OrgUserDetail: {
|
|
13922
14596
|
id: number;
|
|
@@ -13926,6 +14600,7 @@ export interface components {
|
|
|
13926
14600
|
email: string;
|
|
13927
14601
|
avatar_url?: string | null;
|
|
13928
14602
|
permissions?: ("*" | "sessions:read" | "sessions:write" | "sessions-personal-views:write" | "sessions-shared-views:read" | "sessions-shared-views:write" | "sessions-create:write" | "sessions-sub-sessions:write" | "contacts:read" | "contacts:write" | "companies:read" | "companies: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" | "workflows:execute" | "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" | "settings:read" | "settings:write" | "settings-general:read" | "settings-general:write" | "settings-billing:read" | "settings-billing:write" | "settings-api-keys:read" | "settings-api-keys:write" | "settings-autopilot:read" | "settings-autopilot:write" | "settings-structured-fields:read" | "settings-structured-fields: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-email-fleet:read" | "settings-email-fleet:write" | "settings-helpdesk:read" | "settings-helpdesk:write" | "settings-custom-statuses:read" | "settings-custom-statuses:write" | "settings-availability-statuses:read" | "settings-availability-statuses:write" | "settings-personal-profile:read" | "settings-personal-profile: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;
|
|
14603
|
+
roles: components["schemas"]["OrgUserRole"][];
|
|
13929
14604
|
teams: {
|
|
13930
14605
|
group: components["schemas"]["GroupDto"];
|
|
13931
14606
|
is_user_available_on_group: boolean;
|
|
@@ -13941,6 +14616,13 @@ export interface components {
|
|
|
13941
14616
|
status: "deleted" | "not_found" | "owner_blocked" | "error";
|
|
13942
14617
|
}[];
|
|
13943
14618
|
};
|
|
14619
|
+
RolePublicDto: {
|
|
14620
|
+
/** Format: uuid */
|
|
14621
|
+
id: string;
|
|
14622
|
+
name: string;
|
|
14623
|
+
description: string | null;
|
|
14624
|
+
permissions: ("*" | "sessions:read" | "sessions:write" | "sessions-personal-views:write" | "sessions-shared-views:read" | "sessions-shared-views:write" | "sessions-create:write" | "sessions-sub-sessions:write" | "contacts:read" | "contacts:write" | "companies:read" | "companies: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" | "workflows:execute" | "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" | "settings:read" | "settings:write" | "settings-general:read" | "settings-general:write" | "settings-billing:read" | "settings-billing:write" | "settings-api-keys:read" | "settings-api-keys:write" | "settings-autopilot:read" | "settings-autopilot:write" | "settings-structured-fields:read" | "settings-structured-fields: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-email-fleet:read" | "settings-email-fleet:write" | "settings-helpdesk:read" | "settings-helpdesk:write" | "settings-custom-statuses:read" | "settings-custom-statuses:write" | "settings-availability-statuses:read" | "settings-availability-statuses:write" | "settings-personal-profile:read" | "settings-personal-profile: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")[];
|
|
14625
|
+
};
|
|
13944
14626
|
PublicInsight: {
|
|
13945
14627
|
/** Format: uuid */
|
|
13946
14628
|
id: string;
|
|
@@ -14434,7 +15116,7 @@ export interface components {
|
|
|
14434
15116
|
updated_at: string;
|
|
14435
15117
|
content?: string;
|
|
14436
15118
|
/** @enum {string} */
|
|
14437
|
-
data_source: "confluence" | "notion" | "zendesk_support" | "shopify" | "gitbook" | "intercom" | "front" | "freshdesk" | "hubspot_kb" | "ai_instructions" | "custom_training" | "website" | "workflow";
|
|
15119
|
+
data_source: "confluence" | "notion" | "zendesk_support" | "shopify" | "gitbook" | "intercom" | "front" | "freshdesk" | "hubspot_kb" | "ai_instructions" | "custom_training" | "website" | "workflow" | "help_center";
|
|
14438
15120
|
stream: string | null;
|
|
14439
15121
|
relevance_score: number;
|
|
14440
15122
|
directory_id: string | null;
|
|
@@ -14984,6 +15666,46 @@ export interface operations {
|
|
|
14984
15666
|
};
|
|
14985
15667
|
};
|
|
14986
15668
|
};
|
|
15669
|
+
listSessionEvents: {
|
|
15670
|
+
parameters: {
|
|
15671
|
+
query?: {
|
|
15672
|
+
/** @description Inclusive event timestamp lower bound. */
|
|
15673
|
+
created_after?: string;
|
|
15674
|
+
/** @description Exclusive event timestamp upper bound. */
|
|
15675
|
+
created_before?: string;
|
|
15676
|
+
/** @description Comma-separated types to include. When present, exclude_message_types is ignored. */
|
|
15677
|
+
include_message_types?: string | string[];
|
|
15678
|
+
/** @description Comma-separated types to exclude. With neither filter, all event types are returned. */
|
|
15679
|
+
exclude_message_types?: string | string[];
|
|
15680
|
+
limit?: number;
|
|
15681
|
+
cursor?: string;
|
|
15682
|
+
};
|
|
15683
|
+
header?: never;
|
|
15684
|
+
path?: never;
|
|
15685
|
+
cookie?: never;
|
|
15686
|
+
};
|
|
15687
|
+
requestBody?: never;
|
|
15688
|
+
responses: {
|
|
15689
|
+
/** @description Default Response */
|
|
15690
|
+
200: {
|
|
15691
|
+
headers: {
|
|
15692
|
+
[name: string]: unknown;
|
|
15693
|
+
};
|
|
15694
|
+
content: {
|
|
15695
|
+
"application/json": components["schemas"]["SessionEventsPublicResponse"];
|
|
15696
|
+
};
|
|
15697
|
+
};
|
|
15698
|
+
/** @description Internal Server Error */
|
|
15699
|
+
500: {
|
|
15700
|
+
headers: {
|
|
15701
|
+
[name: string]: unknown;
|
|
15702
|
+
};
|
|
15703
|
+
content: {
|
|
15704
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
15705
|
+
};
|
|
15706
|
+
};
|
|
15707
|
+
};
|
|
15708
|
+
};
|
|
14987
15709
|
listChatSessions: {
|
|
14988
15710
|
parameters: {
|
|
14989
15711
|
query?: {
|
|
@@ -16169,7 +16891,102 @@ export interface operations {
|
|
|
16169
16891
|
[name: string]: unknown;
|
|
16170
16892
|
};
|
|
16171
16893
|
content: {
|
|
16172
|
-
"application/json": components["schemas"]["SaveContactOutput"];
|
|
16894
|
+
"application/json": components["schemas"]["SaveContactOutput"];
|
|
16895
|
+
};
|
|
16896
|
+
};
|
|
16897
|
+
/** @description Internal Server Error */
|
|
16898
|
+
500: {
|
|
16899
|
+
headers: {
|
|
16900
|
+
[name: string]: unknown;
|
|
16901
|
+
};
|
|
16902
|
+
content: {
|
|
16903
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
16904
|
+
};
|
|
16905
|
+
};
|
|
16906
|
+
};
|
|
16907
|
+
};
|
|
16908
|
+
deleteContact: {
|
|
16909
|
+
parameters: {
|
|
16910
|
+
query?: never;
|
|
16911
|
+
header?: never;
|
|
16912
|
+
path: {
|
|
16913
|
+
contact_id: string;
|
|
16914
|
+
};
|
|
16915
|
+
cookie?: never;
|
|
16916
|
+
};
|
|
16917
|
+
requestBody?: never;
|
|
16918
|
+
responses: {
|
|
16919
|
+
/** @description Default Response */
|
|
16920
|
+
200: {
|
|
16921
|
+
headers: {
|
|
16922
|
+
[name: string]: unknown;
|
|
16923
|
+
};
|
|
16924
|
+
content?: never;
|
|
16925
|
+
};
|
|
16926
|
+
/** @description Internal Server Error */
|
|
16927
|
+
500: {
|
|
16928
|
+
headers: {
|
|
16929
|
+
[name: string]: unknown;
|
|
16930
|
+
};
|
|
16931
|
+
content: {
|
|
16932
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
16933
|
+
};
|
|
16934
|
+
};
|
|
16935
|
+
};
|
|
16936
|
+
};
|
|
16937
|
+
updateContact: {
|
|
16938
|
+
parameters: {
|
|
16939
|
+
query?: never;
|
|
16940
|
+
header?: never;
|
|
16941
|
+
path: {
|
|
16942
|
+
contact_id: string;
|
|
16943
|
+
};
|
|
16944
|
+
cookie?: never;
|
|
16945
|
+
};
|
|
16946
|
+
requestBody: {
|
|
16947
|
+
content: {
|
|
16948
|
+
"application/json": components["schemas"]["UpdateContactInput"];
|
|
16949
|
+
};
|
|
16950
|
+
};
|
|
16951
|
+
responses: {
|
|
16952
|
+
/** @description Default Response */
|
|
16953
|
+
200: {
|
|
16954
|
+
headers: {
|
|
16955
|
+
[name: string]: unknown;
|
|
16956
|
+
};
|
|
16957
|
+
content?: never;
|
|
16958
|
+
};
|
|
16959
|
+
/** @description Internal Server Error */
|
|
16960
|
+
500: {
|
|
16961
|
+
headers: {
|
|
16962
|
+
[name: string]: unknown;
|
|
16963
|
+
};
|
|
16964
|
+
content: {
|
|
16965
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
16966
|
+
};
|
|
16967
|
+
};
|
|
16968
|
+
};
|
|
16969
|
+
};
|
|
16970
|
+
searchContacts: {
|
|
16971
|
+
parameters: {
|
|
16972
|
+
query?: never;
|
|
16973
|
+
header?: never;
|
|
16974
|
+
path?: never;
|
|
16975
|
+
cookie?: never;
|
|
16976
|
+
};
|
|
16977
|
+
requestBody: {
|
|
16978
|
+
content: {
|
|
16979
|
+
"application/json": components["schemas"]["SearchContactsInput"];
|
|
16980
|
+
};
|
|
16981
|
+
};
|
|
16982
|
+
responses: {
|
|
16983
|
+
/** @description Default Response */
|
|
16984
|
+
200: {
|
|
16985
|
+
headers: {
|
|
16986
|
+
[name: string]: unknown;
|
|
16987
|
+
};
|
|
16988
|
+
content: {
|
|
16989
|
+
"application/json": components["schemas"]["SearchContactsOutput"];
|
|
16173
16990
|
};
|
|
16174
16991
|
};
|
|
16175
16992
|
/** @description Internal Server Error */
|
|
@@ -16183,13 +17000,14 @@ export interface operations {
|
|
|
16183
17000
|
};
|
|
16184
17001
|
};
|
|
16185
17002
|
};
|
|
16186
|
-
|
|
17003
|
+
listContactSegments: {
|
|
16187
17004
|
parameters: {
|
|
16188
|
-
query?:
|
|
16189
|
-
|
|
16190
|
-
|
|
16191
|
-
contact_id: string;
|
|
17005
|
+
query?: {
|
|
17006
|
+
page?: number;
|
|
17007
|
+
limit?: number;
|
|
16192
17008
|
};
|
|
17009
|
+
header?: never;
|
|
17010
|
+
path?: never;
|
|
16193
17011
|
cookie?: never;
|
|
16194
17012
|
};
|
|
16195
17013
|
requestBody?: never;
|
|
@@ -16199,7 +17017,9 @@ export interface operations {
|
|
|
16199
17017
|
headers: {
|
|
16200
17018
|
[name: string]: unknown;
|
|
16201
17019
|
};
|
|
16202
|
-
content
|
|
17020
|
+
content: {
|
|
17021
|
+
"application/json": components["schemas"]["ListContactSegmentsOutput"];
|
|
17022
|
+
};
|
|
16203
17023
|
};
|
|
16204
17024
|
/** @description Internal Server Error */
|
|
16205
17025
|
500: {
|
|
@@ -16212,27 +17032,27 @@ export interface operations {
|
|
|
16212
17032
|
};
|
|
16213
17033
|
};
|
|
16214
17034
|
};
|
|
16215
|
-
|
|
17035
|
+
createContactSegment: {
|
|
16216
17036
|
parameters: {
|
|
16217
17037
|
query?: never;
|
|
16218
17038
|
header?: never;
|
|
16219
|
-
path
|
|
16220
|
-
contact_id: string;
|
|
16221
|
-
};
|
|
17039
|
+
path?: never;
|
|
16222
17040
|
cookie?: never;
|
|
16223
17041
|
};
|
|
16224
17042
|
requestBody: {
|
|
16225
17043
|
content: {
|
|
16226
|
-
"application/json": components["schemas"]["
|
|
17044
|
+
"application/json": components["schemas"]["CreateContactSegmentInput"];
|
|
16227
17045
|
};
|
|
16228
17046
|
};
|
|
16229
17047
|
responses: {
|
|
16230
17048
|
/** @description Default Response */
|
|
16231
|
-
|
|
17049
|
+
201: {
|
|
16232
17050
|
headers: {
|
|
16233
17051
|
[name: string]: unknown;
|
|
16234
17052
|
};
|
|
16235
|
-
content
|
|
17053
|
+
content: {
|
|
17054
|
+
"application/json": components["schemas"]["ContactSegment"];
|
|
17055
|
+
};
|
|
16236
17056
|
};
|
|
16237
17057
|
/** @description Internal Server Error */
|
|
16238
17058
|
500: {
|
|
@@ -16245,18 +17065,16 @@ export interface operations {
|
|
|
16245
17065
|
};
|
|
16246
17066
|
};
|
|
16247
17067
|
};
|
|
16248
|
-
|
|
17068
|
+
getContactSegment: {
|
|
16249
17069
|
parameters: {
|
|
16250
17070
|
query?: never;
|
|
16251
17071
|
header?: never;
|
|
16252
|
-
path
|
|
16253
|
-
|
|
16254
|
-
};
|
|
16255
|
-
requestBody: {
|
|
16256
|
-
content: {
|
|
16257
|
-
"application/json": components["schemas"]["SearchContactsInput"];
|
|
17072
|
+
path: {
|
|
17073
|
+
segment_id: string;
|
|
16258
17074
|
};
|
|
17075
|
+
cookie?: never;
|
|
16259
17076
|
};
|
|
17077
|
+
requestBody?: never;
|
|
16260
17078
|
responses: {
|
|
16261
17079
|
/** @description Default Response */
|
|
16262
17080
|
200: {
|
|
@@ -16264,7 +17082,7 @@ export interface operations {
|
|
|
16264
17082
|
[name: string]: unknown;
|
|
16265
17083
|
};
|
|
16266
17084
|
content: {
|
|
16267
|
-
"application/json": components["schemas"]["
|
|
17085
|
+
"application/json": components["schemas"]["ContactSegment"];
|
|
16268
17086
|
};
|
|
16269
17087
|
};
|
|
16270
17088
|
/** @description Internal Server Error */
|
|
@@ -16278,26 +17096,23 @@ export interface operations {
|
|
|
16278
17096
|
};
|
|
16279
17097
|
};
|
|
16280
17098
|
};
|
|
16281
|
-
|
|
17099
|
+
deleteContactSegment: {
|
|
16282
17100
|
parameters: {
|
|
16283
|
-
query?:
|
|
16284
|
-
page?: number;
|
|
16285
|
-
limit?: number;
|
|
16286
|
-
};
|
|
17101
|
+
query?: never;
|
|
16287
17102
|
header?: never;
|
|
16288
|
-
path
|
|
17103
|
+
path: {
|
|
17104
|
+
segment_id: string;
|
|
17105
|
+
};
|
|
16289
17106
|
cookie?: never;
|
|
16290
17107
|
};
|
|
16291
17108
|
requestBody?: never;
|
|
16292
17109
|
responses: {
|
|
16293
17110
|
/** @description Default Response */
|
|
16294
|
-
|
|
17111
|
+
204: {
|
|
16295
17112
|
headers: {
|
|
16296
17113
|
[name: string]: unknown;
|
|
16297
17114
|
};
|
|
16298
|
-
content
|
|
16299
|
-
"application/json": components["schemas"]["ListContactSegmentsOutput"];
|
|
16300
|
-
};
|
|
17115
|
+
content?: never;
|
|
16301
17116
|
};
|
|
16302
17117
|
/** @description Internal Server Error */
|
|
16303
17118
|
500: {
|
|
@@ -16310,7 +17125,7 @@ export interface operations {
|
|
|
16310
17125
|
};
|
|
16311
17126
|
};
|
|
16312
17127
|
};
|
|
16313
|
-
|
|
17128
|
+
updateContactSegment: {
|
|
16314
17129
|
parameters: {
|
|
16315
17130
|
query?: never;
|
|
16316
17131
|
header?: never;
|
|
@@ -16319,7 +17134,11 @@ export interface operations {
|
|
|
16319
17134
|
};
|
|
16320
17135
|
cookie?: never;
|
|
16321
17136
|
};
|
|
16322
|
-
requestBody
|
|
17137
|
+
requestBody: {
|
|
17138
|
+
content: {
|
|
17139
|
+
"application/json": components["schemas"]["UpdateContactSegmentInput"];
|
|
17140
|
+
};
|
|
17141
|
+
};
|
|
16323
17142
|
responses: {
|
|
16324
17143
|
/** @description Default Response */
|
|
16325
17144
|
200: {
|
|
@@ -17037,7 +17856,7 @@ export interface operations {
|
|
|
17037
17856
|
/** @description Full-text search over item titles/content */
|
|
17038
17857
|
search?: string;
|
|
17039
17858
|
/** @description Filter to a specific external data source (e.g. website, confluence, notion) */
|
|
17040
|
-
data_source?: "confluence" | "notion" | "zendesk_support" | "shopify" | "gitbook" | "intercom" | "front" | "freshdesk" | "hubspot_kb" | "ai_instructions" | "custom_training" | "website" | "workflow";
|
|
17859
|
+
data_source?: "confluence" | "notion" | "zendesk_support" | "shopify" | "gitbook" | "intercom" | "front" | "freshdesk" | "hubspot_kb" | "ai_instructions" | "custom_training" | "website" | "workflow" | "help_center";
|
|
17041
17860
|
visibility?: "internal" | "public";
|
|
17042
17861
|
page?: number;
|
|
17043
17862
|
limit?: number;
|
|
@@ -19176,9 +19995,9 @@ export interface operations {
|
|
|
19176
19995
|
getImpactReport: {
|
|
19177
19996
|
parameters: {
|
|
19178
19997
|
query?: {
|
|
19179
|
-
/** @description Start date in ISO 8601 format (defaults to 30 days
|
|
19998
|
+
/** @description Start date in ISO 8601 format; a date-only value starts at 00:00 UTC (defaults to 30 days before the end) */
|
|
19180
19999
|
start_date?: string;
|
|
19181
|
-
/** @description End date in ISO 8601 format (defaults to now) */
|
|
20000
|
+
/** @description End date in ISO 8601 format; a date-only value covers the whole UTC day (defaults to now) */
|
|
19182
20001
|
end_date?: string;
|
|
19183
20002
|
};
|
|
19184
20003
|
header?: never;
|
|
@@ -19216,7 +20035,7 @@ export interface operations {
|
|
|
19216
20035
|
custom_data_key?: string;
|
|
19217
20036
|
/** @description Start date in ISO 8601 format (defaults to 30 days ago) */
|
|
19218
20037
|
start_date?: string;
|
|
19219
|
-
/** @description End date in ISO 8601 format (defaults to now) */
|
|
20038
|
+
/** @description End date in ISO 8601 format; a date-only value covers the whole UTC day (defaults to now) */
|
|
19220
20039
|
end_date?: string;
|
|
19221
20040
|
};
|
|
19222
20041
|
header?: never;
|
|
@@ -19256,7 +20075,7 @@ export interface operations {
|
|
|
19256
20075
|
custom_data_key?: string;
|
|
19257
20076
|
/** @description Start date in ISO 8601 format (defaults to 30 days ago) */
|
|
19258
20077
|
start_date?: string;
|
|
19259
|
-
/** @description End date in ISO 8601 format (defaults to now) */
|
|
20078
|
+
/** @description End date in ISO 8601 format; a date-only value covers the whole UTC day (defaults to now) */
|
|
19260
20079
|
end_date?: string;
|
|
19261
20080
|
limit?: number;
|
|
19262
20081
|
offset?: number;
|
|
@@ -21076,6 +21895,58 @@ export interface operations {
|
|
|
21076
21895
|
};
|
|
21077
21896
|
};
|
|
21078
21897
|
};
|
|
21898
|
+
listPhoneAgentKnowledgeSourceItems: {
|
|
21899
|
+
parameters: {
|
|
21900
|
+
query: {
|
|
21901
|
+
folderKey: string;
|
|
21902
|
+
page?: number;
|
|
21903
|
+
limit?: number;
|
|
21904
|
+
};
|
|
21905
|
+
header?: never;
|
|
21906
|
+
path: {
|
|
21907
|
+
phone_agent_id: string;
|
|
21908
|
+
};
|
|
21909
|
+
cookie?: never;
|
|
21910
|
+
};
|
|
21911
|
+
requestBody?: never;
|
|
21912
|
+
responses: {
|
|
21913
|
+
/** @description Default Response */
|
|
21914
|
+
200: {
|
|
21915
|
+
headers: {
|
|
21916
|
+
[name: string]: unknown;
|
|
21917
|
+
};
|
|
21918
|
+
content: {
|
|
21919
|
+
"application/json": {
|
|
21920
|
+
items: {
|
|
21921
|
+
id: string;
|
|
21922
|
+
title: string;
|
|
21923
|
+
sourceUrl: string | null;
|
|
21924
|
+
selected: boolean;
|
|
21925
|
+
/** @description Whether this source can be selected for a voice agent */
|
|
21926
|
+
selectable: boolean;
|
|
21927
|
+
/** @description User-facing explanation when the source cannot be selected */
|
|
21928
|
+
unavailableReason: string | null;
|
|
21929
|
+
}[];
|
|
21930
|
+
pagination: {
|
|
21931
|
+
page: number;
|
|
21932
|
+
limit: number;
|
|
21933
|
+
total: number;
|
|
21934
|
+
hasNextPage: boolean;
|
|
21935
|
+
};
|
|
21936
|
+
};
|
|
21937
|
+
};
|
|
21938
|
+
};
|
|
21939
|
+
/** @description Internal Server Error */
|
|
21940
|
+
500: {
|
|
21941
|
+
headers: {
|
|
21942
|
+
[name: string]: unknown;
|
|
21943
|
+
};
|
|
21944
|
+
content: {
|
|
21945
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
21946
|
+
};
|
|
21947
|
+
};
|
|
21948
|
+
};
|
|
21949
|
+
};
|
|
21079
21950
|
setPhoneAgentCallerNumber: {
|
|
21080
21951
|
parameters: {
|
|
21081
21952
|
query?: never;
|
|
@@ -24344,6 +25215,67 @@ export interface operations {
|
|
|
24344
25215
|
};
|
|
24345
25216
|
};
|
|
24346
25217
|
};
|
|
25218
|
+
listRoles: {
|
|
25219
|
+
parameters: {
|
|
25220
|
+
query?: never;
|
|
25221
|
+
header?: never;
|
|
25222
|
+
path?: never;
|
|
25223
|
+
cookie?: never;
|
|
25224
|
+
};
|
|
25225
|
+
requestBody?: never;
|
|
25226
|
+
responses: {
|
|
25227
|
+
/** @description Default Response */
|
|
25228
|
+
200: {
|
|
25229
|
+
headers: {
|
|
25230
|
+
[name: string]: unknown;
|
|
25231
|
+
};
|
|
25232
|
+
content: {
|
|
25233
|
+
"application/json": components["schemas"]["RolePublicDto"][];
|
|
25234
|
+
};
|
|
25235
|
+
};
|
|
25236
|
+
/** @description Internal Server Error */
|
|
25237
|
+
500: {
|
|
25238
|
+
headers: {
|
|
25239
|
+
[name: string]: unknown;
|
|
25240
|
+
};
|
|
25241
|
+
content: {
|
|
25242
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
25243
|
+
};
|
|
25244
|
+
};
|
|
25245
|
+
};
|
|
25246
|
+
};
|
|
25247
|
+
getRole: {
|
|
25248
|
+
parameters: {
|
|
25249
|
+
query?: never;
|
|
25250
|
+
header?: never;
|
|
25251
|
+
path: {
|
|
25252
|
+
/** @description Role ID */
|
|
25253
|
+
role_id: string;
|
|
25254
|
+
};
|
|
25255
|
+
cookie?: never;
|
|
25256
|
+
};
|
|
25257
|
+
requestBody?: never;
|
|
25258
|
+
responses: {
|
|
25259
|
+
/** @description Default Response */
|
|
25260
|
+
200: {
|
|
25261
|
+
headers: {
|
|
25262
|
+
[name: string]: unknown;
|
|
25263
|
+
};
|
|
25264
|
+
content: {
|
|
25265
|
+
"application/json": components["schemas"]["RolePublicDto"];
|
|
25266
|
+
};
|
|
25267
|
+
};
|
|
25268
|
+
/** @description Internal Server Error */
|
|
25269
|
+
500: {
|
|
25270
|
+
headers: {
|
|
25271
|
+
[name: string]: unknown;
|
|
25272
|
+
};
|
|
25273
|
+
content: {
|
|
25274
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
25275
|
+
};
|
|
25276
|
+
};
|
|
25277
|
+
};
|
|
25278
|
+
};
|
|
24347
25279
|
getVocInsights: {
|
|
24348
25280
|
parameters: {
|
|
24349
25281
|
query?: never;
|
|
@@ -24918,6 +25850,121 @@ export interface operations {
|
|
|
24918
25850
|
};
|
|
24919
25851
|
};
|
|
24920
25852
|
};
|
|
25853
|
+
getWidgetConnectionAccessToken: {
|
|
25854
|
+
parameters: {
|
|
25855
|
+
query?: never;
|
|
25856
|
+
header?: never;
|
|
25857
|
+
path: {
|
|
25858
|
+
connectionId: string;
|
|
25859
|
+
};
|
|
25860
|
+
cookie?: never;
|
|
25861
|
+
};
|
|
25862
|
+
requestBody: {
|
|
25863
|
+
content: {
|
|
25864
|
+
"application/json": {
|
|
25865
|
+
contact_id: string;
|
|
25866
|
+
account_id?: string;
|
|
25867
|
+
};
|
|
25868
|
+
};
|
|
25869
|
+
};
|
|
25870
|
+
responses: {
|
|
25871
|
+
/** @description Default Response */
|
|
25872
|
+
201: {
|
|
25873
|
+
headers: {
|
|
25874
|
+
[name: string]: unknown;
|
|
25875
|
+
};
|
|
25876
|
+
content: {
|
|
25877
|
+
"application/json": {
|
|
25878
|
+
/** Format: uuid */
|
|
25879
|
+
connection_id: string;
|
|
25880
|
+
resource: string;
|
|
25881
|
+
access_token: string;
|
|
25882
|
+
/** @enum {string} */
|
|
25883
|
+
token_type: "Bearer";
|
|
25884
|
+
expires_at: string | null;
|
|
25885
|
+
scope: string | null;
|
|
25886
|
+
};
|
|
25887
|
+
};
|
|
25888
|
+
};
|
|
25889
|
+
/** @description Default Response */
|
|
25890
|
+
409: {
|
|
25891
|
+
headers: {
|
|
25892
|
+
[name: string]: unknown;
|
|
25893
|
+
};
|
|
25894
|
+
content: {
|
|
25895
|
+
"application/json": {
|
|
25896
|
+
/** @enum {string} */
|
|
25897
|
+
code: "connection_required";
|
|
25898
|
+
};
|
|
25899
|
+
};
|
|
25900
|
+
};
|
|
25901
|
+
/** @description Internal Server Error */
|
|
25902
|
+
500: {
|
|
25903
|
+
headers: {
|
|
25904
|
+
[name: string]: unknown;
|
|
25905
|
+
};
|
|
25906
|
+
content: {
|
|
25907
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
25908
|
+
};
|
|
25909
|
+
};
|
|
25910
|
+
};
|
|
25911
|
+
};
|
|
25912
|
+
callWidgetConnectionTool: {
|
|
25913
|
+
parameters: {
|
|
25914
|
+
query?: never;
|
|
25915
|
+
header?: never;
|
|
25916
|
+
path: {
|
|
25917
|
+
serverId: string;
|
|
25918
|
+
};
|
|
25919
|
+
cookie?: never;
|
|
25920
|
+
};
|
|
25921
|
+
requestBody: {
|
|
25922
|
+
content: {
|
|
25923
|
+
"application/json": {
|
|
25924
|
+
contact_id: string;
|
|
25925
|
+
account_id?: string;
|
|
25926
|
+
tool: string;
|
|
25927
|
+
arguments: {
|
|
25928
|
+
[key: string]: unknown;
|
|
25929
|
+
};
|
|
25930
|
+
};
|
|
25931
|
+
};
|
|
25932
|
+
};
|
|
25933
|
+
responses: {
|
|
25934
|
+
/** @description Default Response */
|
|
25935
|
+
201: {
|
|
25936
|
+
headers: {
|
|
25937
|
+
[name: string]: unknown;
|
|
25938
|
+
};
|
|
25939
|
+
content: {
|
|
25940
|
+
"application/json": string | number | boolean | null | unknown[] | {
|
|
25941
|
+
[key: string]: unknown;
|
|
25942
|
+
};
|
|
25943
|
+
};
|
|
25944
|
+
};
|
|
25945
|
+
/** @description Default Response */
|
|
25946
|
+
409: {
|
|
25947
|
+
headers: {
|
|
25948
|
+
[name: string]: unknown;
|
|
25949
|
+
};
|
|
25950
|
+
content: {
|
|
25951
|
+
"application/json": {
|
|
25952
|
+
/** @enum {string} */
|
|
25953
|
+
code: "connection_required" | "provider_connection_required";
|
|
25954
|
+
};
|
|
25955
|
+
};
|
|
25956
|
+
};
|
|
25957
|
+
/** @description Internal Server Error */
|
|
25958
|
+
500: {
|
|
25959
|
+
headers: {
|
|
25960
|
+
[name: string]: unknown;
|
|
25961
|
+
};
|
|
25962
|
+
content: {
|
|
25963
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
25964
|
+
};
|
|
25965
|
+
};
|
|
25966
|
+
};
|
|
25967
|
+
};
|
|
24921
25968
|
authenticateWidgetUser: {
|
|
24922
25969
|
parameters: {
|
|
24923
25970
|
query?: never;
|