@opencx/mcp 1.15.74 → 1.15.76

package/dist/schema.d.ts

@@ -3166,6 +3166,30 @@ export interface paths {
         patch: operations["updateOrg"];
         trace?: never;
     };
+    "/session-sidebar": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get the session sidebar layout
+         * @description The workspace-wide arrangement of the cards and widgets in the session sidebar (the right side of an open session).
+         */
+        get: operations["getSessionSidebar"];
+        /**
+         * Update the session sidebar layout
+         * @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.
+         */
+        put: operations["updateSessionSidebar"];
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/phone/voices": {
         parameters: {
             query?: never;
@@ -3652,6 +3676,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/sequences/voice-trunks": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List the SIP trunks a sequence's Human voice step can call through
+         * @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.
+         */
+        get: operations["listVoiceTrunks"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/sequences/email-senders": {
         parameters: {
             query?: never;
@@ -3733,6 +3777,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/sequences/{sequenceId}/call-attempts": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List a sequence's team calls
+         * @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.
+         */
+        get: operations["listSequenceCallAttempts"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/sequences/{sequenceId}/stats": {
         parameters: {
             query?: never;
@@ -7556,6 +7620,10 @@ export interface components {
             telephony_distribution?: "fewest_answered_today" | "longest_available";
             /** @description SLA policy whose phone answer-time target grades calls waiting in this team. Null uses the organization default. */
             phone_sla_policy_id?: string | null;
+            /** @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. */
+            call_recording_enabled?: boolean;
+            /** @description Languages spoken on calls this team answers (language codes). Live transcripts of those calls stay in these languages; empty uses the organization default. */
+            call_languages?: string[];
             /** @description Seconds between automatic assignments to the same agent under the least-busy strategy: 0 turns pacing off, otherwise 15 to 3600. */
             auto_assign_interval_seconds?: number;
         };
@@ -7902,6 +7970,22 @@ export interface components {
                             type?: "string" | "number" | "boolean" | "date" | "string[]" | "number[]";
                         };
                     };
+                    /**
+                     * @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.
+                     * @enum {string}
+                     */
+                    handled_by?: "ai" | "human";
+                    /** @description Human steps: the team whose free agents take the calls. Required when handled_by is "human". */
+                    team_id?: string;
+                    /**
+                     * Format: uuid
+                     * @description Human steps: the org's own SIP trunk the calls go out through (see list voice trunks). Required when handled_by is "human".
+                     */
+                    trunk_id?: string;
+                    /** @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. */
+                    caller_id?: string;
+                    /** @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. */
+                    numbers_per_free_agent?: number;
                 };
                 delay_minutes: number;
             } | {
@@ -8059,6 +8143,22 @@ export interface components {
                             type?: "string" | "number" | "boolean" | "date" | "string[]" | "number[]";
                         };
                     };
+                    /**
+                     * @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.
+                     * @enum {string}
+                     */
+                    handled_by?: "ai" | "human";
+                    /** @description Human steps: the team whose free agents take the calls. Required when handled_by is "human". */
+                    team_id?: string;
+                    /**
+                     * Format: uuid
+                     * @description Human steps: the org's own SIP trunk the calls go out through (see list voice trunks). Required when handled_by is "human".
+                     */
+                    trunk_id?: string;
+                    /** @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. */
+                    caller_id?: string;
+                    /** @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. */
+                    numbers_per_free_agent?: number;
                 };
                 delay_minutes: number;
             } | {
@@ -8139,6 +8239,22 @@ export interface components {
                             type?: "string" | "number" | "boolean" | "date" | "string[]" | "number[]";
                         };
                     };
+                    /**
+                     * @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.
+                     * @enum {string}
+                     */
+                    handled_by?: "ai" | "human";
+                    /** @description Human steps: the team whose free agents take the calls. Required when handled_by is "human". */
+                    team_id?: string;
+                    /**
+                     * Format: uuid
+                     * @description Human steps: the org's own SIP trunk the calls go out through (see list voice trunks). Required when handled_by is "human".
+                     */
+                    trunk_id?: string;
+                    /** @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. */
+                    caller_id?: string;
+                    /** @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. */
+                    numbers_per_free_agent?: number;
                 } | {
                     /** @constant */
                     type: "email";
@@ -8219,6 +8335,22 @@ export interface components {
                                 type?: "string" | "number" | "boolean" | "date" | "string[]" | "number[]";
                             };
                         };
+                        /**
+                         * @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.
+                         * @enum {string}
+                         */
+                        handled_by?: "ai" | "human";
+                        /** @description Human steps: the team whose free agents take the calls. Required when handled_by is "human". */
+                        team_id?: string;
+                        /**
+                         * Format: uuid
+                         * @description Human steps: the org's own SIP trunk the calls go out through (see list voice trunks). Required when handled_by is "human".
+                         */
+                        trunk_id?: string;
+                        /** @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. */
+                        caller_id?: string;
+                        /** @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. */
+                        numbers_per_free_agent?: number;
                     };
                     delay_minutes: number;
                 } | {
@@ -9426,6 +9558,12 @@ export interface components {
             /** @description The name of the organization. */
             name?: string;
         };
+        UpdateSessionSidebarDto: {
+            /** @description The new order, replacing the stored one. Entries are unique built-in card keys and `app:<mini app id>` entries. */
+            card_order?: string[];
+            /** @description The built-in card keys to hide, replacing the stored list. */
+            hidden_cards?: string[];
+        };
         HandBackCallInput: {
             /**
              * Format: uuid
@@ -9567,6 +9705,10 @@ export interface components {
             telephony_distribution?: "fewest_answered_today" | "longest_available";
             /** @description SLA policy whose phone answer-time target grades calls waiting in this team. Null uses the organization default. */
             phone_sla_policy_id?: string | null;
+            /** @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. */
+            call_recording_enabled?: boolean;
+            /** @description Languages spoken on calls this team answers (language codes). Live transcripts of those calls stay in these languages; empty uses the organization default. */
+            call_languages?: string[];
             /** @description Seconds between automatic assignments to the same agent under the least-busy strategy: 0 turns pacing off, otherwise 15 to 3600. */
             auto_assign_interval_seconds?: number;
         };
@@ -10597,6 +10739,8 @@ export interface components {
                     kind: "prompt" | "keypad" | "result";
                     key?: string;
                     accepted?: boolean;
+                    /** @enum {string} */
+                    actor?: "caller" | "agent";
                 };
             } | null;
             extra_params?: {
@@ -10911,6 +11055,7 @@ export interface components {
         CompanyAgentOwner: {
             /** @description The teammate’s OpenCX user id */
             id: number;
+            /** @description The teammate’s name in this organization, as set on their profile */
             name: string;
             /** Format: email */
             email: string;
@@ -11240,6 +11385,8 @@ export interface components {
             /** @enum {string} */
             telephony_distribution: "fewest_answered_today" | "longest_available";
             phone_sla_policy_id: string | null;
+            call_recording_enabled: boolean;
+            call_languages: string[];
             auto_assign_interval_seconds: number;
             zendesk_group_id: string | null;
             zendesk_group_channels: components["schemas"]["SessionChannel"][] | null;
@@ -12295,6 +12442,8 @@ export interface components {
             name: string;
             /** @enum {string} */
             status: "draft" | "active" | "paused";
+            /** @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. */
+            paused_reason: ("trunk_missing" | "caller_id_missing" | "team_missing" | "telephony_off" | "calls_failing") | null;
             steps: ({
                 /** @constant */
                 channel: "whatsapp";
@@ -12349,6 +12498,22 @@ export interface components {
                             type?: "string" | "number" | "boolean" | "date" | "string[]" | "number[]";
                         };
                     };
+                    /**
+                     * @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.
+                     * @enum {string}
+                     */
+                    handled_by?: "ai" | "human";
+                    /** @description Human steps: the team whose free agents take the calls. Required when handled_by is "human". */
+                    team_id?: string;
+                    /**
+                     * Format: uuid
+                     * @description Human steps: the org's own SIP trunk the calls go out through (see list voice trunks). Required when handled_by is "human".
+                     */
+                    trunk_id?: string;
+                    /** @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. */
+                    caller_id?: string;
+                    /** @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. */
+                    numbers_per_free_agent?: number;
                 };
                 delay_minutes: number;
             } | {
@@ -12422,6 +12587,8 @@ export interface components {
             name: string;
             /** @enum {string} */
             status: "draft" | "active" | "paused";
+            /** @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. */
+            paused_reason: ("trunk_missing" | "caller_id_missing" | "team_missing" | "telephony_off" | "calls_failing") | null;
             steps: ({
                 /** @constant */
                 channel: "whatsapp";
@@ -12476,6 +12643,22 @@ export interface components {
                             type?: "string" | "number" | "boolean" | "date" | "string[]" | "number[]";
                         };
                     };
+                    /**
+                     * @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.
+                     * @enum {string}
+                     */
+                    handled_by?: "ai" | "human";
+                    /** @description Human steps: the team whose free agents take the calls. Required when handled_by is "human". */
+                    team_id?: string;
+                    /**
+                     * Format: uuid
+                     * @description Human steps: the org's own SIP trunk the calls go out through (see list voice trunks). Required when handled_by is "human".
+                     */
+                    trunk_id?: string;
+                    /** @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. */
+                    caller_id?: string;
+                    /** @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. */
+                    numbers_per_free_agent?: number;
                 };
                 delay_minutes: number;
             } | {
@@ -12748,6 +12931,8 @@ export interface components {
             name: string;
             /** @enum {string} */
             status: "draft" | "active" | "paused";
+            /** @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. */
+            paused_reason: ("trunk_missing" | "caller_id_missing" | "team_missing" | "telephony_off" | "calls_failing") | null;
             steps: ({
                 /** @constant */
                 channel: "whatsapp";
@@ -12802,6 +12987,22 @@ export interface components {
                             type?: "string" | "number" | "boolean" | "date" | "string[]" | "number[]";
                         };
                     };
+                    /**
+                     * @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.
+                     * @enum {string}
+                     */
+                    handled_by?: "ai" | "human";
+                    /** @description Human steps: the team whose free agents take the calls. Required when handled_by is "human". */
+                    team_id?: string;
+                    /**
+                     * Format: uuid
+                     * @description Human steps: the org's own SIP trunk the calls go out through (see list voice trunks). Required when handled_by is "human".
+                     */
+                    trunk_id?: string;
+                    /** @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. */
+                    caller_id?: string;
+                    /** @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. */
+                    numbers_per_free_agent?: number;
                 };
                 delay_minutes: number;
             } | {
@@ -12960,6 +13161,48 @@ export interface components {
                 noop: number;
             };
         };
+        SequenceVoiceTrunksDto: {
+            /** @description The org's own SIP trunks — the only trunks a Human voice step can call through. */
+            trunks: {
+                /**
+                 * Format: uuid
+                 * @description Pass as `trunk_id` on a Human voice step.
+                 */
+                id: string;
+                name: string;
+            }[];
+        };
+        SequenceCallAttemptsDto: {
+            attempts: {
+                /** Format: uuid */
+                id: string;
+                /**
+                 * Format: uuid
+                 * @description The person in the sequence (their contact id).
+                 */
+                contact_id: string;
+                step_index: number;
+                team_id: string;
+                /**
+                 * @description "dialing" while the call is live, then "done".
+                 * @enum {string}
+                 */
+                status: "dialing" | "done";
+                /** @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. */
+                result: ("answered" | "no_answer" | "busy" | "failed" | "missed" | "voicemail" | "wrong_number") | null;
+                /** @description The agent (user id) who took the call. */
+                answered_by: number | null;
+                /** @description The agent who took the call changed its result. */
+                corrected: boolean;
+                /** @description The call's inbox session. */
+                session_id: string | null;
+                /** Format: date-time */
+                dialed_at: string;
+                completed_at: string | null;
+            }[];
+            /** @description Opaque cursor: pass as `before` for the next (older) page; null on the last page. */
+            next_before: string | null;
+        };
         EmailFleetSuggestionDto: {
             domain: string;
             available: boolean;
@@ -15499,7 +15742,7 @@ export interface components {
             channel: string | null;
             /** @description Why the address was blocked. */
             reason: string;
-            /** @description Where the entry came from. "api" is one you added. Anything else was recorded when the person opted out themselves, and is not removable by default. */
+            /** @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. */
             source: string | null;
             /** Format: date-time */
             created_at: string;
@@ -15959,6 +16202,12 @@ export interface components {
             /** @description When the organization was last updated. */
             updated_at: string | null;
         };
+        SessionSidebarDto: {
+            /** @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. */
+            card_order: string[];
+            /** @description Built-in card keys hidden from the sidebar. */
+            hidden_cards: string[];
+        };
         WebCallSuccessDto: {
             success: boolean;
         };
@@ -24130,6 +24379,68 @@ export interface operations {
             };
         };
     };
+    getSessionSidebar: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Default Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SessionSidebarDto"];
+                };
+            };
+            /** @description Internal Server Error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorDto"];
+                };
+            };
+        };
+    };
+    updateSessionSidebar: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["UpdateSessionSidebarDto"];
+            };
+        };
+        responses: {
+            /** @description Default Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SessionSidebarDto"];
+                };
+            };
+            /** @description Internal Server Error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorDto"];
+                };
+            };
+        };
+    };
     listVoices: {
         parameters: {
             query?: {
@@ -25196,6 +25507,35 @@ export interface operations {
             };
         };
     };
+    listVoiceTrunks: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Default Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SequenceVoiceTrunksDto"];
+                };
+            };
+            /** @description Internal Server Error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorDto"];
+                };
+            };
+        };
+    };
     listEmailSenders: {
         parameters: {
             query?: never;
@@ -25367,6 +25707,44 @@ export interface operations {
             };
         };
     };
+    listSequenceCallAttempts: {
+        parameters: {
+            query?: {
+                step_index?: number;
+                result?: "answered" | "no_answer" | "busy" | "failed" | "missed" | "voicemail" | "wrong_number";
+                limit?: number;
+                /** @description Page cursor: the `next_before` of the previous page, passed back as is. */
+                before?: string;
+            };
+            header?: never;
+            path: {
+                /** @description The unique identifier of the sequence */
+                sequenceId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Default Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SequenceCallAttemptsDto"];
+                };
+            };
+            /** @description Internal Server Error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorDto"];
+                };
+            };
+        };
+    };
     getSequenceStats: {
         parameters: {
             query?: never;