@opencx/mcp 1.15.75 → 1.15.76
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/campaign-tools.spec.js +32 -0
- package/dist/campaign-tools.spec.js.map +1 -1
- package/dist/schema.d.ts +379 -99
- package/dist/schema.d.ts.map +1 -1
- package/dist/tools/campaign-channel.d.ts.map +1 -1
- package/dist/tools/campaign-channel.js +55 -0
- package/dist/tools/campaign-channel.js.map +1 -1
- package/dist/tools/campaign-spine.d.ts.map +1 -1
- package/dist/tools/campaign-spine.js +34 -0
- package/dist/tools/campaign-spine.js.map +1 -1
- package/dist/tools/team-settings.d.ts +2 -0
- package/dist/tools/team-settings.d.ts.map +1 -1
- package/dist/tools/team-settings.js +8 -0
- package/dist/tools/team-settings.js.map +1 -1
- package/package.json +1 -1
package/dist/schema.d.ts
CHANGED
|
@@ -2155,30 +2155,6 @@ export interface paths {
|
|
|
2155
2155
|
patch?: never;
|
|
2156
2156
|
trace?: never;
|
|
2157
2157
|
};
|
|
2158
|
-
"/session-sidebar": {
|
|
2159
|
-
parameters: {
|
|
2160
|
-
query?: never;
|
|
2161
|
-
header?: never;
|
|
2162
|
-
path?: never;
|
|
2163
|
-
cookie?: never;
|
|
2164
|
-
};
|
|
2165
|
-
/**
|
|
2166
|
-
* Get the session sidebar layout
|
|
2167
|
-
* @description The workspace-wide arrangement of the cards and widgets in the session sidebar (the right side of an open session).
|
|
2168
|
-
*/
|
|
2169
|
-
get: operations["getSessionSidebar"];
|
|
2170
|
-
/**
|
|
2171
|
-
* Update the session sidebar layout
|
|
2172
|
-
* @description Reorder, hide or show cards and widgets in the session sidebar for the whole workspace. Partial update: omit a field to leave it unchanged. Returns the new layout.
|
|
2173
|
-
*/
|
|
2174
|
-
put: operations["updateSessionSidebar"];
|
|
2175
|
-
post?: never;
|
|
2176
|
-
delete?: never;
|
|
2177
|
-
options?: never;
|
|
2178
|
-
head?: never;
|
|
2179
|
-
patch?: never;
|
|
2180
|
-
trace?: never;
|
|
2181
|
-
};
|
|
2182
2158
|
"/macros/settings": {
|
|
2183
2159
|
parameters: {
|
|
2184
2160
|
query?: never;
|
|
@@ -3190,6 +3166,30 @@ export interface paths {
|
|
|
3190
3166
|
patch: operations["updateOrg"];
|
|
3191
3167
|
trace?: never;
|
|
3192
3168
|
};
|
|
3169
|
+
"/session-sidebar": {
|
|
3170
|
+
parameters: {
|
|
3171
|
+
query?: never;
|
|
3172
|
+
header?: never;
|
|
3173
|
+
path?: never;
|
|
3174
|
+
cookie?: never;
|
|
3175
|
+
};
|
|
3176
|
+
/**
|
|
3177
|
+
* Get the session sidebar layout
|
|
3178
|
+
* @description The workspace-wide arrangement of the cards and widgets in the session sidebar (the right side of an open session).
|
|
3179
|
+
*/
|
|
3180
|
+
get: operations["getSessionSidebar"];
|
|
3181
|
+
/**
|
|
3182
|
+
* Update the session sidebar layout
|
|
3183
|
+
* @description Reorder, hide or show cards and widgets in the session sidebar for the whole workspace. Partial update: omit a field to leave it unchanged. Returns the new layout.
|
|
3184
|
+
*/
|
|
3185
|
+
put: operations["updateSessionSidebar"];
|
|
3186
|
+
post?: never;
|
|
3187
|
+
delete?: never;
|
|
3188
|
+
options?: never;
|
|
3189
|
+
head?: never;
|
|
3190
|
+
patch?: never;
|
|
3191
|
+
trace?: never;
|
|
3192
|
+
};
|
|
3193
3193
|
"/phone/voices": {
|
|
3194
3194
|
parameters: {
|
|
3195
3195
|
query?: never;
|
|
@@ -3676,6 +3676,26 @@ export interface paths {
|
|
|
3676
3676
|
patch?: never;
|
|
3677
3677
|
trace?: never;
|
|
3678
3678
|
};
|
|
3679
|
+
"/sequences/voice-trunks": {
|
|
3680
|
+
parameters: {
|
|
3681
|
+
query?: never;
|
|
3682
|
+
header?: never;
|
|
3683
|
+
path?: never;
|
|
3684
|
+
cookie?: never;
|
|
3685
|
+
};
|
|
3686
|
+
/**
|
|
3687
|
+
* List the SIP trunks a sequence's Human voice step can call through
|
|
3688
|
+
* @description The organization's own SIP trunks. A voice step with `handled_by: "human"` is called by a team of agents instead of an AI phone agent, and its calls go out through one of these (`trunk_id`). A trunk the platform hosts is never listed: team calls only ride your own trunk. Empty when the organization has none — connect one under Settings → SIP first.
|
|
3689
|
+
*/
|
|
3690
|
+
get: operations["listVoiceTrunks"];
|
|
3691
|
+
put?: never;
|
|
3692
|
+
post?: never;
|
|
3693
|
+
delete?: never;
|
|
3694
|
+
options?: never;
|
|
3695
|
+
head?: never;
|
|
3696
|
+
patch?: never;
|
|
3697
|
+
trace?: never;
|
|
3698
|
+
};
|
|
3679
3699
|
"/sequences/email-senders": {
|
|
3680
3700
|
parameters: {
|
|
3681
3701
|
query?: never;
|
|
@@ -3757,6 +3777,26 @@ export interface paths {
|
|
|
3757
3777
|
patch?: never;
|
|
3758
3778
|
trace?: never;
|
|
3759
3779
|
};
|
|
3780
|
+
"/sequences/{sequenceId}/call-attempts": {
|
|
3781
|
+
parameters: {
|
|
3782
|
+
query?: never;
|
|
3783
|
+
header?: never;
|
|
3784
|
+
path?: never;
|
|
3785
|
+
cookie?: never;
|
|
3786
|
+
};
|
|
3787
|
+
/**
|
|
3788
|
+
* List a sequence's team calls
|
|
3789
|
+
* @description Every call a Human voice step placed for a team, newest first: who was called, whether the call is still live, how it ended, which agent took it, and whether that agent corrected the result. Filter by step or result; page with `before`. AI voice steps are not listed here — their outcomes are on the contact events.
|
|
3790
|
+
*/
|
|
3791
|
+
get: operations["listSequenceCallAttempts"];
|
|
3792
|
+
put?: never;
|
|
3793
|
+
post?: never;
|
|
3794
|
+
delete?: never;
|
|
3795
|
+
options?: never;
|
|
3796
|
+
head?: never;
|
|
3797
|
+
patch?: never;
|
|
3798
|
+
trace?: never;
|
|
3799
|
+
};
|
|
3760
3800
|
"/sequences/{sequenceId}/stats": {
|
|
3761
3801
|
parameters: {
|
|
3762
3802
|
query?: never;
|
|
@@ -7580,6 +7620,10 @@ export interface components {
|
|
|
7580
7620
|
telephony_distribution?: "fewest_answered_today" | "longest_available";
|
|
7581
7621
|
/** @description SLA policy whose phone answer-time target grades calls waiting in this team. Null uses the organization default. */
|
|
7582
7622
|
phone_sla_policy_id?: string | null;
|
|
7623
|
+
/** @description Record calls answered by this team. When off, answering does not start a recording; one the phone agent or call flow already started keeps running. */
|
|
7624
|
+
call_recording_enabled?: boolean;
|
|
7625
|
+
/** @description Languages spoken on calls this team answers (language codes). Live transcripts of those calls stay in these languages; empty uses the organization default. */
|
|
7626
|
+
call_languages?: string[];
|
|
7583
7627
|
/** @description Seconds between automatic assignments to the same agent under the least-busy strategy: 0 turns pacing off, otherwise 15 to 3600. */
|
|
7584
7628
|
auto_assign_interval_seconds?: number;
|
|
7585
7629
|
};
|
|
@@ -7926,6 +7970,22 @@ export interface components {
|
|
|
7926
7970
|
type?: "string" | "number" | "boolean" | "date" | "string[]" | "number[]";
|
|
7927
7971
|
};
|
|
7928
7972
|
};
|
|
7973
|
+
/**
|
|
7974
|
+
* @description Who takes the call: "ai" (default) — the sequence's AI phone agent; "human" — a team of agents, dialed for them through the org's own SIP trunk. Omitted = "ai", except on an update of a human step, which must say "ai" to switch it.
|
|
7975
|
+
* @enum {string}
|
|
7976
|
+
*/
|
|
7977
|
+
handled_by?: "ai" | "human";
|
|
7978
|
+
/** @description Human steps: the team whose free agents take the calls. Required when handled_by is "human". */
|
|
7979
|
+
team_id?: string;
|
|
7980
|
+
/**
|
|
7981
|
+
* Format: uuid
|
|
7982
|
+
* @description Human steps: the org's own SIP trunk the calls go out through (see list voice trunks). Required when handled_by is "human".
|
|
7983
|
+
*/
|
|
7984
|
+
trunk_id?: string;
|
|
7985
|
+
/** @description Human steps: the number shown to the person, in E.164 (+ and digits), one of the workspace's verified numbers. Omitted = the trunk's default. */
|
|
7986
|
+
caller_id?: string;
|
|
7987
|
+
/** @description Human steps: how many numbers ring at once for each free agent (1–5, default 1). Above 1, a person who picks up while every agent is busy is missed and gets the next step. */
|
|
7988
|
+
numbers_per_free_agent?: number;
|
|
7929
7989
|
};
|
|
7930
7990
|
delay_minutes: number;
|
|
7931
7991
|
} | {
|
|
@@ -8083,6 +8143,22 @@ export interface components {
|
|
|
8083
8143
|
type?: "string" | "number" | "boolean" | "date" | "string[]" | "number[]";
|
|
8084
8144
|
};
|
|
8085
8145
|
};
|
|
8146
|
+
/**
|
|
8147
|
+
* @description Who takes the call: "ai" (default) — the sequence's AI phone agent; "human" — a team of agents, dialed for them through the org's own SIP trunk. Omitted = "ai", except on an update of a human step, which must say "ai" to switch it.
|
|
8148
|
+
* @enum {string}
|
|
8149
|
+
*/
|
|
8150
|
+
handled_by?: "ai" | "human";
|
|
8151
|
+
/** @description Human steps: the team whose free agents take the calls. Required when handled_by is "human". */
|
|
8152
|
+
team_id?: string;
|
|
8153
|
+
/**
|
|
8154
|
+
* Format: uuid
|
|
8155
|
+
* @description Human steps: the org's own SIP trunk the calls go out through (see list voice trunks). Required when handled_by is "human".
|
|
8156
|
+
*/
|
|
8157
|
+
trunk_id?: string;
|
|
8158
|
+
/** @description Human steps: the number shown to the person, in E.164 (+ and digits), one of the workspace's verified numbers. Omitted = the trunk's default. */
|
|
8159
|
+
caller_id?: string;
|
|
8160
|
+
/** @description Human steps: how many numbers ring at once for each free agent (1–5, default 1). Above 1, a person who picks up while every agent is busy is missed and gets the next step. */
|
|
8161
|
+
numbers_per_free_agent?: number;
|
|
8086
8162
|
};
|
|
8087
8163
|
delay_minutes: number;
|
|
8088
8164
|
} | {
|
|
@@ -8163,6 +8239,22 @@ export interface components {
|
|
|
8163
8239
|
type?: "string" | "number" | "boolean" | "date" | "string[]" | "number[]";
|
|
8164
8240
|
};
|
|
8165
8241
|
};
|
|
8242
|
+
/**
|
|
8243
|
+
* @description Who takes the call: "ai" (default) — the sequence's AI phone agent; "human" — a team of agents, dialed for them through the org's own SIP trunk. Omitted = "ai", except on an update of a human step, which must say "ai" to switch it.
|
|
8244
|
+
* @enum {string}
|
|
8245
|
+
*/
|
|
8246
|
+
handled_by?: "ai" | "human";
|
|
8247
|
+
/** @description Human steps: the team whose free agents take the calls. Required when handled_by is "human". */
|
|
8248
|
+
team_id?: string;
|
|
8249
|
+
/**
|
|
8250
|
+
* Format: uuid
|
|
8251
|
+
* @description Human steps: the org's own SIP trunk the calls go out through (see list voice trunks). Required when handled_by is "human".
|
|
8252
|
+
*/
|
|
8253
|
+
trunk_id?: string;
|
|
8254
|
+
/** @description Human steps: the number shown to the person, in E.164 (+ and digits), one of the workspace's verified numbers. Omitted = the trunk's default. */
|
|
8255
|
+
caller_id?: string;
|
|
8256
|
+
/** @description Human steps: how many numbers ring at once for each free agent (1–5, default 1). Above 1, a person who picks up while every agent is busy is missed and gets the next step. */
|
|
8257
|
+
numbers_per_free_agent?: number;
|
|
8166
8258
|
} | {
|
|
8167
8259
|
/** @constant */
|
|
8168
8260
|
type: "email";
|
|
@@ -8243,6 +8335,22 @@ export interface components {
|
|
|
8243
8335
|
type?: "string" | "number" | "boolean" | "date" | "string[]" | "number[]";
|
|
8244
8336
|
};
|
|
8245
8337
|
};
|
|
8338
|
+
/**
|
|
8339
|
+
* @description Who takes the call: "ai" (default) — the sequence's AI phone agent; "human" — a team of agents, dialed for them through the org's own SIP trunk. Omitted = "ai", except on an update of a human step, which must say "ai" to switch it.
|
|
8340
|
+
* @enum {string}
|
|
8341
|
+
*/
|
|
8342
|
+
handled_by?: "ai" | "human";
|
|
8343
|
+
/** @description Human steps: the team whose free agents take the calls. Required when handled_by is "human". */
|
|
8344
|
+
team_id?: string;
|
|
8345
|
+
/**
|
|
8346
|
+
* Format: uuid
|
|
8347
|
+
* @description Human steps: the org's own SIP trunk the calls go out through (see list voice trunks). Required when handled_by is "human".
|
|
8348
|
+
*/
|
|
8349
|
+
trunk_id?: string;
|
|
8350
|
+
/** @description Human steps: the number shown to the person, in E.164 (+ and digits), one of the workspace's verified numbers. Omitted = the trunk's default. */
|
|
8351
|
+
caller_id?: string;
|
|
8352
|
+
/** @description Human steps: how many numbers ring at once for each free agent (1–5, default 1). Above 1, a person who picks up while every agent is busy is missed and gets the next step. */
|
|
8353
|
+
numbers_per_free_agent?: number;
|
|
8246
8354
|
};
|
|
8247
8355
|
delay_minutes: number;
|
|
8248
8356
|
} | {
|
|
@@ -9138,12 +9246,6 @@ export interface components {
|
|
|
9138
9246
|
*/
|
|
9139
9247
|
region?: "eu-west-1" | "us-east-1";
|
|
9140
9248
|
};
|
|
9141
|
-
UpdateSessionSidebarDto: {
|
|
9142
|
-
/** @description The new order, replacing the stored one. Entries are unique built-in card keys and `app:<mini app id>` entries. */
|
|
9143
|
-
card_order?: string[];
|
|
9144
|
-
/** @description The built-in card keys to hide, replacing the stored list. */
|
|
9145
|
-
hidden_cards?: string[];
|
|
9146
|
-
};
|
|
9147
9249
|
UpdateMacroSettingsDto: {
|
|
9148
9250
|
/** @description The full list of language codes (lower-case, such as `es`; at most 10, each from `supported_translation_languages`, no repeats) to translate every org-wide macro into. It replaces the current list, so send every language you want to keep. `[]` turns macro translation off. */
|
|
9149
9251
|
translation_languages: string[];
|
|
@@ -9456,6 +9558,12 @@ export interface components {
|
|
|
9456
9558
|
/** @description The name of the organization. */
|
|
9457
9559
|
name?: string;
|
|
9458
9560
|
};
|
|
9561
|
+
UpdateSessionSidebarDto: {
|
|
9562
|
+
/** @description The new order, replacing the stored one. Entries are unique built-in card keys and `app:<mini app id>` entries. */
|
|
9563
|
+
card_order?: string[];
|
|
9564
|
+
/** @description The built-in card keys to hide, replacing the stored list. */
|
|
9565
|
+
hidden_cards?: string[];
|
|
9566
|
+
};
|
|
9459
9567
|
HandBackCallInput: {
|
|
9460
9568
|
/**
|
|
9461
9569
|
* Format: uuid
|
|
@@ -9597,6 +9705,10 @@ export interface components {
|
|
|
9597
9705
|
telephony_distribution?: "fewest_answered_today" | "longest_available";
|
|
9598
9706
|
/** @description SLA policy whose phone answer-time target grades calls waiting in this team. Null uses the organization default. */
|
|
9599
9707
|
phone_sla_policy_id?: string | null;
|
|
9708
|
+
/** @description Record calls answered by this team. When off, answering does not start a recording; one the phone agent or call flow already started keeps running. */
|
|
9709
|
+
call_recording_enabled?: boolean;
|
|
9710
|
+
/** @description Languages spoken on calls this team answers (language codes). Live transcripts of those calls stay in these languages; empty uses the organization default. */
|
|
9711
|
+
call_languages?: string[];
|
|
9600
9712
|
/** @description Seconds between automatic assignments to the same agent under the least-busy strategy: 0 turns pacing off, otherwise 15 to 3600. */
|
|
9601
9713
|
auto_assign_interval_seconds?: number;
|
|
9602
9714
|
};
|
|
@@ -10627,6 +10739,8 @@ export interface components {
|
|
|
10627
10739
|
kind: "prompt" | "keypad" | "result";
|
|
10628
10740
|
key?: string;
|
|
10629
10741
|
accepted?: boolean;
|
|
10742
|
+
/** @enum {string} */
|
|
10743
|
+
actor?: "caller" | "agent";
|
|
10630
10744
|
};
|
|
10631
10745
|
} | null;
|
|
10632
10746
|
extra_params?: {
|
|
@@ -10941,6 +11055,7 @@ export interface components {
|
|
|
10941
11055
|
CompanyAgentOwner: {
|
|
10942
11056
|
/** @description The teammate’s OpenCX user id */
|
|
10943
11057
|
id: number;
|
|
11058
|
+
/** @description The teammate’s name in this organization, as set on their profile */
|
|
10944
11059
|
name: string;
|
|
10945
11060
|
/** Format: email */
|
|
10946
11061
|
email: string;
|
|
@@ -11270,6 +11385,8 @@ export interface components {
|
|
|
11270
11385
|
/** @enum {string} */
|
|
11271
11386
|
telephony_distribution: "fewest_answered_today" | "longest_available";
|
|
11272
11387
|
phone_sla_policy_id: string | null;
|
|
11388
|
+
call_recording_enabled: boolean;
|
|
11389
|
+
call_languages: string[];
|
|
11273
11390
|
auto_assign_interval_seconds: number;
|
|
11274
11391
|
zendesk_group_id: string | null;
|
|
11275
11392
|
zendesk_group_channels: components["schemas"]["SessionChannel"][] | null;
|
|
@@ -12325,6 +12442,8 @@ export interface components {
|
|
|
12325
12442
|
name: string;
|
|
12326
12443
|
/** @enum {string} */
|
|
12327
12444
|
status: "draft" | "active" | "paused";
|
|
12445
|
+
/** @description Set when the sequence paused itself: "trunk_missing" (a Human voice step's SIP trunk was deleted), "caller_id_missing" (its caller ID is no longer one of the workspace's verified numbers), "team_missing" (its team was deleted), "telephony_off" (telephony was turned off for the workspace) or "calls_failing" (most of its latest team calls failed). null when a person paused it or it is not paused. Resuming clears it. */
|
|
12446
|
+
paused_reason: ("trunk_missing" | "caller_id_missing" | "team_missing" | "telephony_off" | "calls_failing") | null;
|
|
12328
12447
|
steps: ({
|
|
12329
12448
|
/** @constant */
|
|
12330
12449
|
channel: "whatsapp";
|
|
@@ -12379,6 +12498,22 @@ export interface components {
|
|
|
12379
12498
|
type?: "string" | "number" | "boolean" | "date" | "string[]" | "number[]";
|
|
12380
12499
|
};
|
|
12381
12500
|
};
|
|
12501
|
+
/**
|
|
12502
|
+
* @description Who takes the call: "ai" (default) — the sequence's AI phone agent; "human" — a team of agents, dialed for them through the org's own SIP trunk. Omitted = "ai", except on an update of a human step, which must say "ai" to switch it.
|
|
12503
|
+
* @enum {string}
|
|
12504
|
+
*/
|
|
12505
|
+
handled_by?: "ai" | "human";
|
|
12506
|
+
/** @description Human steps: the team whose free agents take the calls. Required when handled_by is "human". */
|
|
12507
|
+
team_id?: string;
|
|
12508
|
+
/**
|
|
12509
|
+
* Format: uuid
|
|
12510
|
+
* @description Human steps: the org's own SIP trunk the calls go out through (see list voice trunks). Required when handled_by is "human".
|
|
12511
|
+
*/
|
|
12512
|
+
trunk_id?: string;
|
|
12513
|
+
/** @description Human steps: the number shown to the person, in E.164 (+ and digits), one of the workspace's verified numbers. Omitted = the trunk's default. */
|
|
12514
|
+
caller_id?: string;
|
|
12515
|
+
/** @description Human steps: how many numbers ring at once for each free agent (1–5, default 1). Above 1, a person who picks up while every agent is busy is missed and gets the next step. */
|
|
12516
|
+
numbers_per_free_agent?: number;
|
|
12382
12517
|
};
|
|
12383
12518
|
delay_minutes: number;
|
|
12384
12519
|
} | {
|
|
@@ -12452,6 +12587,8 @@ export interface components {
|
|
|
12452
12587
|
name: string;
|
|
12453
12588
|
/** @enum {string} */
|
|
12454
12589
|
status: "draft" | "active" | "paused";
|
|
12590
|
+
/** @description Set when the sequence paused itself: "trunk_missing" (a Human voice step's SIP trunk was deleted), "caller_id_missing" (its caller ID is no longer one of the workspace's verified numbers), "team_missing" (its team was deleted), "telephony_off" (telephony was turned off for the workspace) or "calls_failing" (most of its latest team calls failed). null when a person paused it or it is not paused. Resuming clears it. */
|
|
12591
|
+
paused_reason: ("trunk_missing" | "caller_id_missing" | "team_missing" | "telephony_off" | "calls_failing") | null;
|
|
12455
12592
|
steps: ({
|
|
12456
12593
|
/** @constant */
|
|
12457
12594
|
channel: "whatsapp";
|
|
@@ -12506,6 +12643,22 @@ export interface components {
|
|
|
12506
12643
|
type?: "string" | "number" | "boolean" | "date" | "string[]" | "number[]";
|
|
12507
12644
|
};
|
|
12508
12645
|
};
|
|
12646
|
+
/**
|
|
12647
|
+
* @description Who takes the call: "ai" (default) — the sequence's AI phone agent; "human" — a team of agents, dialed for them through the org's own SIP trunk. Omitted = "ai", except on an update of a human step, which must say "ai" to switch it.
|
|
12648
|
+
* @enum {string}
|
|
12649
|
+
*/
|
|
12650
|
+
handled_by?: "ai" | "human";
|
|
12651
|
+
/** @description Human steps: the team whose free agents take the calls. Required when handled_by is "human". */
|
|
12652
|
+
team_id?: string;
|
|
12653
|
+
/**
|
|
12654
|
+
* Format: uuid
|
|
12655
|
+
* @description Human steps: the org's own SIP trunk the calls go out through (see list voice trunks). Required when handled_by is "human".
|
|
12656
|
+
*/
|
|
12657
|
+
trunk_id?: string;
|
|
12658
|
+
/** @description Human steps: the number shown to the person, in E.164 (+ and digits), one of the workspace's verified numbers. Omitted = the trunk's default. */
|
|
12659
|
+
caller_id?: string;
|
|
12660
|
+
/** @description Human steps: how many numbers ring at once for each free agent (1–5, default 1). Above 1, a person who picks up while every agent is busy is missed and gets the next step. */
|
|
12661
|
+
numbers_per_free_agent?: number;
|
|
12509
12662
|
};
|
|
12510
12663
|
delay_minutes: number;
|
|
12511
12664
|
} | {
|
|
@@ -12778,6 +12931,8 @@ export interface components {
|
|
|
12778
12931
|
name: string;
|
|
12779
12932
|
/** @enum {string} */
|
|
12780
12933
|
status: "draft" | "active" | "paused";
|
|
12934
|
+
/** @description Set when the sequence paused itself: "trunk_missing" (a Human voice step's SIP trunk was deleted), "caller_id_missing" (its caller ID is no longer one of the workspace's verified numbers), "team_missing" (its team was deleted), "telephony_off" (telephony was turned off for the workspace) or "calls_failing" (most of its latest team calls failed). null when a person paused it or it is not paused. Resuming clears it. */
|
|
12935
|
+
paused_reason: ("trunk_missing" | "caller_id_missing" | "team_missing" | "telephony_off" | "calls_failing") | null;
|
|
12781
12936
|
steps: ({
|
|
12782
12937
|
/** @constant */
|
|
12783
12938
|
channel: "whatsapp";
|
|
@@ -12832,6 +12987,22 @@ export interface components {
|
|
|
12832
12987
|
type?: "string" | "number" | "boolean" | "date" | "string[]" | "number[]";
|
|
12833
12988
|
};
|
|
12834
12989
|
};
|
|
12990
|
+
/**
|
|
12991
|
+
* @description Who takes the call: "ai" (default) — the sequence's AI phone agent; "human" — a team of agents, dialed for them through the org's own SIP trunk. Omitted = "ai", except on an update of a human step, which must say "ai" to switch it.
|
|
12992
|
+
* @enum {string}
|
|
12993
|
+
*/
|
|
12994
|
+
handled_by?: "ai" | "human";
|
|
12995
|
+
/** @description Human steps: the team whose free agents take the calls. Required when handled_by is "human". */
|
|
12996
|
+
team_id?: string;
|
|
12997
|
+
/**
|
|
12998
|
+
* Format: uuid
|
|
12999
|
+
* @description Human steps: the org's own SIP trunk the calls go out through (see list voice trunks). Required when handled_by is "human".
|
|
13000
|
+
*/
|
|
13001
|
+
trunk_id?: string;
|
|
13002
|
+
/** @description Human steps: the number shown to the person, in E.164 (+ and digits), one of the workspace's verified numbers. Omitted = the trunk's default. */
|
|
13003
|
+
caller_id?: string;
|
|
13004
|
+
/** @description Human steps: how many numbers ring at once for each free agent (1–5, default 1). Above 1, a person who picks up while every agent is busy is missed and gets the next step. */
|
|
13005
|
+
numbers_per_free_agent?: number;
|
|
12835
13006
|
};
|
|
12836
13007
|
delay_minutes: number;
|
|
12837
13008
|
} | {
|
|
@@ -12990,6 +13161,48 @@ export interface components {
|
|
|
12990
13161
|
noop: number;
|
|
12991
13162
|
};
|
|
12992
13163
|
};
|
|
13164
|
+
SequenceVoiceTrunksDto: {
|
|
13165
|
+
/** @description The org's own SIP trunks — the only trunks a Human voice step can call through. */
|
|
13166
|
+
trunks: {
|
|
13167
|
+
/**
|
|
13168
|
+
* Format: uuid
|
|
13169
|
+
* @description Pass as `trunk_id` on a Human voice step.
|
|
13170
|
+
*/
|
|
13171
|
+
id: string;
|
|
13172
|
+
name: string;
|
|
13173
|
+
}[];
|
|
13174
|
+
};
|
|
13175
|
+
SequenceCallAttemptsDto: {
|
|
13176
|
+
attempts: {
|
|
13177
|
+
/** Format: uuid */
|
|
13178
|
+
id: string;
|
|
13179
|
+
/**
|
|
13180
|
+
* Format: uuid
|
|
13181
|
+
* @description The person in the sequence (their contact id).
|
|
13182
|
+
*/
|
|
13183
|
+
contact_id: string;
|
|
13184
|
+
step_index: number;
|
|
13185
|
+
team_id: string;
|
|
13186
|
+
/**
|
|
13187
|
+
* @description "dialing" while the call is live, then "done".
|
|
13188
|
+
* @enum {string}
|
|
13189
|
+
*/
|
|
13190
|
+
status: "dialing" | "done";
|
|
13191
|
+
/** @description How the call ended: answered (an agent took it), no_answer, busy, failed, missed (picked up, but no agent was free), voicemail, wrong_number. null while live. */
|
|
13192
|
+
result: ("answered" | "no_answer" | "busy" | "failed" | "missed" | "voicemail" | "wrong_number") | null;
|
|
13193
|
+
/** @description The agent (user id) who took the call. */
|
|
13194
|
+
answered_by: number | null;
|
|
13195
|
+
/** @description The agent who took the call changed its result. */
|
|
13196
|
+
corrected: boolean;
|
|
13197
|
+
/** @description The call's inbox session. */
|
|
13198
|
+
session_id: string | null;
|
|
13199
|
+
/** Format: date-time */
|
|
13200
|
+
dialed_at: string;
|
|
13201
|
+
completed_at: string | null;
|
|
13202
|
+
}[];
|
|
13203
|
+
/** @description Opaque cursor: pass as `before` for the next (older) page; null on the last page. */
|
|
13204
|
+
next_before: string | null;
|
|
13205
|
+
};
|
|
12993
13206
|
EmailFleetSuggestionDto: {
|
|
12994
13207
|
domain: string;
|
|
12995
13208
|
available: boolean;
|
|
@@ -15529,7 +15742,7 @@ export interface components {
|
|
|
15529
15742
|
channel: string | null;
|
|
15530
15743
|
/** @description Why the address was blocked. */
|
|
15531
15744
|
reason: string;
|
|
15532
|
-
/** @description Where the entry came from. "api" is one you added. Anything else was recorded when the person opted out themselves
|
|
15745
|
+
/** @description Where the entry came from. "api" is one you added. "agent_correction" is one a teammate added by marking a sequence call as a wrong number. Anything else was recorded when the person opted out themselves. Only "api" entries are removable by default. */
|
|
15533
15746
|
source: string | null;
|
|
15534
15747
|
/** Format: date-time */
|
|
15535
15748
|
created_at: string;
|
|
@@ -15540,12 +15753,6 @@ export interface components {
|
|
|
15540
15753
|
domainRecords: unknown | null;
|
|
15541
15754
|
domainStatus: string | null;
|
|
15542
15755
|
};
|
|
15543
|
-
SessionSidebarDto: {
|
|
15544
|
-
/** @description Cards and widgets in the order the session sidebar shows them: built-in card keys and `app:<mini app id>` entries, one per mini-app widget. Empty means the default arrangement. */
|
|
15545
|
-
card_order: string[];
|
|
15546
|
-
/** @description Built-in card keys hidden from the sidebar. */
|
|
15547
|
-
hidden_cards: string[];
|
|
15548
|
-
};
|
|
15549
15756
|
MacroSettingsDto: {
|
|
15550
15757
|
/** @description Language codes (lower-case, such as `es`) every org-wide macro is translated into, in the order they were chosen. Empty means macro translation is off. */
|
|
15551
15758
|
translation_languages: string[];
|
|
@@ -15995,6 +16202,12 @@ export interface components {
|
|
|
15995
16202
|
/** @description When the organization was last updated. */
|
|
15996
16203
|
updated_at: string | null;
|
|
15997
16204
|
};
|
|
16205
|
+
SessionSidebarDto: {
|
|
16206
|
+
/** @description Cards and widgets in the order the session sidebar shows them: built-in card keys and `app:<mini app id>` entries, one per mini-app widget. Empty means the default arrangement. */
|
|
16207
|
+
card_order: string[];
|
|
16208
|
+
/** @description Built-in card keys hidden from the sidebar. */
|
|
16209
|
+
hidden_cards: string[];
|
|
16210
|
+
};
|
|
15998
16211
|
WebCallSuccessDto: {
|
|
15999
16212
|
success: boolean;
|
|
16000
16213
|
};
|
|
@@ -21808,68 +22021,6 @@ export interface operations {
|
|
|
21808
22021
|
};
|
|
21809
22022
|
};
|
|
21810
22023
|
};
|
|
21811
|
-
getSessionSidebar: {
|
|
21812
|
-
parameters: {
|
|
21813
|
-
query?: never;
|
|
21814
|
-
header?: never;
|
|
21815
|
-
path?: never;
|
|
21816
|
-
cookie?: never;
|
|
21817
|
-
};
|
|
21818
|
-
requestBody?: never;
|
|
21819
|
-
responses: {
|
|
21820
|
-
/** @description Default Response */
|
|
21821
|
-
200: {
|
|
21822
|
-
headers: {
|
|
21823
|
-
[name: string]: unknown;
|
|
21824
|
-
};
|
|
21825
|
-
content: {
|
|
21826
|
-
"application/json": components["schemas"]["SessionSidebarDto"];
|
|
21827
|
-
};
|
|
21828
|
-
};
|
|
21829
|
-
/** @description Internal Server Error */
|
|
21830
|
-
500: {
|
|
21831
|
-
headers: {
|
|
21832
|
-
[name: string]: unknown;
|
|
21833
|
-
};
|
|
21834
|
-
content: {
|
|
21835
|
-
"application/json": components["schemas"]["ErrorDto"];
|
|
21836
|
-
};
|
|
21837
|
-
};
|
|
21838
|
-
};
|
|
21839
|
-
};
|
|
21840
|
-
updateSessionSidebar: {
|
|
21841
|
-
parameters: {
|
|
21842
|
-
query?: never;
|
|
21843
|
-
header?: never;
|
|
21844
|
-
path?: never;
|
|
21845
|
-
cookie?: never;
|
|
21846
|
-
};
|
|
21847
|
-
requestBody: {
|
|
21848
|
-
content: {
|
|
21849
|
-
"application/json": components["schemas"]["UpdateSessionSidebarDto"];
|
|
21850
|
-
};
|
|
21851
|
-
};
|
|
21852
|
-
responses: {
|
|
21853
|
-
/** @description Default Response */
|
|
21854
|
-
200: {
|
|
21855
|
-
headers: {
|
|
21856
|
-
[name: string]: unknown;
|
|
21857
|
-
};
|
|
21858
|
-
content: {
|
|
21859
|
-
"application/json": components["schemas"]["SessionSidebarDto"];
|
|
21860
|
-
};
|
|
21861
|
-
};
|
|
21862
|
-
/** @description Internal Server Error */
|
|
21863
|
-
500: {
|
|
21864
|
-
headers: {
|
|
21865
|
-
[name: string]: unknown;
|
|
21866
|
-
};
|
|
21867
|
-
content: {
|
|
21868
|
-
"application/json": components["schemas"]["ErrorDto"];
|
|
21869
|
-
};
|
|
21870
|
-
};
|
|
21871
|
-
};
|
|
21872
|
-
};
|
|
21873
22024
|
getMacroSettings: {
|
|
21874
22025
|
parameters: {
|
|
21875
22026
|
query?: never;
|
|
@@ -24228,6 +24379,68 @@ export interface operations {
|
|
|
24228
24379
|
};
|
|
24229
24380
|
};
|
|
24230
24381
|
};
|
|
24382
|
+
getSessionSidebar: {
|
|
24383
|
+
parameters: {
|
|
24384
|
+
query?: never;
|
|
24385
|
+
header?: never;
|
|
24386
|
+
path?: never;
|
|
24387
|
+
cookie?: never;
|
|
24388
|
+
};
|
|
24389
|
+
requestBody?: never;
|
|
24390
|
+
responses: {
|
|
24391
|
+
/** @description Default Response */
|
|
24392
|
+
200: {
|
|
24393
|
+
headers: {
|
|
24394
|
+
[name: string]: unknown;
|
|
24395
|
+
};
|
|
24396
|
+
content: {
|
|
24397
|
+
"application/json": components["schemas"]["SessionSidebarDto"];
|
|
24398
|
+
};
|
|
24399
|
+
};
|
|
24400
|
+
/** @description Internal Server Error */
|
|
24401
|
+
500: {
|
|
24402
|
+
headers: {
|
|
24403
|
+
[name: string]: unknown;
|
|
24404
|
+
};
|
|
24405
|
+
content: {
|
|
24406
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
24407
|
+
};
|
|
24408
|
+
};
|
|
24409
|
+
};
|
|
24410
|
+
};
|
|
24411
|
+
updateSessionSidebar: {
|
|
24412
|
+
parameters: {
|
|
24413
|
+
query?: never;
|
|
24414
|
+
header?: never;
|
|
24415
|
+
path?: never;
|
|
24416
|
+
cookie?: never;
|
|
24417
|
+
};
|
|
24418
|
+
requestBody: {
|
|
24419
|
+
content: {
|
|
24420
|
+
"application/json": components["schemas"]["UpdateSessionSidebarDto"];
|
|
24421
|
+
};
|
|
24422
|
+
};
|
|
24423
|
+
responses: {
|
|
24424
|
+
/** @description Default Response */
|
|
24425
|
+
200: {
|
|
24426
|
+
headers: {
|
|
24427
|
+
[name: string]: unknown;
|
|
24428
|
+
};
|
|
24429
|
+
content: {
|
|
24430
|
+
"application/json": components["schemas"]["SessionSidebarDto"];
|
|
24431
|
+
};
|
|
24432
|
+
};
|
|
24433
|
+
/** @description Internal Server Error */
|
|
24434
|
+
500: {
|
|
24435
|
+
headers: {
|
|
24436
|
+
[name: string]: unknown;
|
|
24437
|
+
};
|
|
24438
|
+
content: {
|
|
24439
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
24440
|
+
};
|
|
24441
|
+
};
|
|
24442
|
+
};
|
|
24443
|
+
};
|
|
24231
24444
|
listVoices: {
|
|
24232
24445
|
parameters: {
|
|
24233
24446
|
query?: {
|
|
@@ -25294,6 +25507,35 @@ export interface operations {
|
|
|
25294
25507
|
};
|
|
25295
25508
|
};
|
|
25296
25509
|
};
|
|
25510
|
+
listVoiceTrunks: {
|
|
25511
|
+
parameters: {
|
|
25512
|
+
query?: never;
|
|
25513
|
+
header?: never;
|
|
25514
|
+
path?: never;
|
|
25515
|
+
cookie?: never;
|
|
25516
|
+
};
|
|
25517
|
+
requestBody?: never;
|
|
25518
|
+
responses: {
|
|
25519
|
+
/** @description Default Response */
|
|
25520
|
+
200: {
|
|
25521
|
+
headers: {
|
|
25522
|
+
[name: string]: unknown;
|
|
25523
|
+
};
|
|
25524
|
+
content: {
|
|
25525
|
+
"application/json": components["schemas"]["SequenceVoiceTrunksDto"];
|
|
25526
|
+
};
|
|
25527
|
+
};
|
|
25528
|
+
/** @description Internal Server Error */
|
|
25529
|
+
500: {
|
|
25530
|
+
headers: {
|
|
25531
|
+
[name: string]: unknown;
|
|
25532
|
+
};
|
|
25533
|
+
content: {
|
|
25534
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
25535
|
+
};
|
|
25536
|
+
};
|
|
25537
|
+
};
|
|
25538
|
+
};
|
|
25297
25539
|
listEmailSenders: {
|
|
25298
25540
|
parameters: {
|
|
25299
25541
|
query?: never;
|
|
@@ -25465,6 +25707,44 @@ export interface operations {
|
|
|
25465
25707
|
};
|
|
25466
25708
|
};
|
|
25467
25709
|
};
|
|
25710
|
+
listSequenceCallAttempts: {
|
|
25711
|
+
parameters: {
|
|
25712
|
+
query?: {
|
|
25713
|
+
step_index?: number;
|
|
25714
|
+
result?: "answered" | "no_answer" | "busy" | "failed" | "missed" | "voicemail" | "wrong_number";
|
|
25715
|
+
limit?: number;
|
|
25716
|
+
/** @description Page cursor: the `next_before` of the previous page, passed back as is. */
|
|
25717
|
+
before?: string;
|
|
25718
|
+
};
|
|
25719
|
+
header?: never;
|
|
25720
|
+
path: {
|
|
25721
|
+
/** @description The unique identifier of the sequence */
|
|
25722
|
+
sequenceId: string;
|
|
25723
|
+
};
|
|
25724
|
+
cookie?: never;
|
|
25725
|
+
};
|
|
25726
|
+
requestBody?: never;
|
|
25727
|
+
responses: {
|
|
25728
|
+
/** @description Default Response */
|
|
25729
|
+
200: {
|
|
25730
|
+
headers: {
|
|
25731
|
+
[name: string]: unknown;
|
|
25732
|
+
};
|
|
25733
|
+
content: {
|
|
25734
|
+
"application/json": components["schemas"]["SequenceCallAttemptsDto"];
|
|
25735
|
+
};
|
|
25736
|
+
};
|
|
25737
|
+
/** @description Internal Server Error */
|
|
25738
|
+
500: {
|
|
25739
|
+
headers: {
|
|
25740
|
+
[name: string]: unknown;
|
|
25741
|
+
};
|
|
25742
|
+
content: {
|
|
25743
|
+
"application/json": components["schemas"]["ErrorDto"];
|
|
25744
|
+
};
|
|
25745
|
+
};
|
|
25746
|
+
};
|
|
25747
|
+
};
|
|
25468
25748
|
getSequenceStats: {
|
|
25469
25749
|
parameters: {
|
|
25470
25750
|
query?: never;
|