telnyx 7.30.0 → 7.31.0
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/CHANGELOG.md +7 -0
- package/client.d.mts +22 -4
- package/client.d.mts.map +1 -1
- package/client.d.ts +22 -4
- package/client.d.ts.map +1 -1
- package/client.js +18 -0
- package/client.js.map +1 -1
- package/client.mjs +18 -0
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/agent-gateways/agent-gateways.d.mts +360 -0
- package/resources/agent-gateways/agent-gateways.d.mts.map +1 -0
- package/resources/agent-gateways/agent-gateways.d.ts +360 -0
- package/resources/agent-gateways/agent-gateways.d.ts.map +1 -0
- package/resources/agent-gateways/agent-gateways.js +140 -0
- package/resources/agent-gateways/agent-gateways.js.map +1 -0
- package/resources/agent-gateways/agent-gateways.mjs +135 -0
- package/resources/agent-gateways/agent-gateways.mjs.map +1 -0
- package/resources/agent-gateways/apis.d.mts +300 -0
- package/resources/agent-gateways/apis.d.mts.map +1 -0
- package/resources/agent-gateways/apis.d.ts +300 -0
- package/resources/agent-gateways/apis.d.ts.map +1 -0
- package/resources/agent-gateways/apis.js +89 -0
- package/resources/agent-gateways/apis.js.map +1 -0
- package/resources/agent-gateways/apis.mjs +85 -0
- package/resources/agent-gateways/apis.mjs.map +1 -0
- package/resources/agent-gateways/guardrails.d.mts +210 -0
- package/resources/agent-gateways/guardrails.d.mts.map +1 -0
- package/resources/agent-gateways/guardrails.d.ts +210 -0
- package/resources/agent-gateways/guardrails.d.ts.map +1 -0
- package/resources/agent-gateways/guardrails.js +96 -0
- package/resources/agent-gateways/guardrails.js.map +1 -0
- package/resources/agent-gateways/guardrails.mjs +92 -0
- package/resources/agent-gateways/guardrails.mjs.map +1 -0
- package/resources/agent-gateways/index.d.mts +9 -0
- package/resources/agent-gateways/index.d.mts.map +1 -0
- package/resources/agent-gateways/index.d.ts +9 -0
- package/resources/agent-gateways/index.d.ts.map +1 -0
- package/resources/agent-gateways/index.js +21 -0
- package/resources/agent-gateways/index.js.map +1 -0
- package/resources/agent-gateways/index.mjs +10 -0
- package/resources/agent-gateways/index.mjs.map +1 -0
- package/resources/agent-gateways/keys/index.d.mts +3 -0
- package/resources/agent-gateways/keys/index.d.mts.map +1 -0
- package/resources/agent-gateways/keys/index.d.ts +3 -0
- package/resources/agent-gateways/keys/index.d.ts.map +1 -0
- package/resources/agent-gateways/keys/index.js +9 -0
- package/resources/agent-gateways/keys/index.js.map +1 -0
- package/resources/agent-gateways/keys/index.mjs +4 -0
- package/resources/agent-gateways/keys/index.mjs.map +1 -0
- package/resources/agent-gateways/keys/keys.d.mts +329 -0
- package/resources/agent-gateways/keys/keys.d.mts.map +1 -0
- package/resources/agent-gateways/keys/keys.d.ts +329 -0
- package/resources/agent-gateways/keys/keys.d.ts.map +1 -0
- package/resources/agent-gateways/keys/keys.js +99 -0
- package/resources/agent-gateways/keys/keys.js.map +1 -0
- package/resources/agent-gateways/keys/keys.mjs +94 -0
- package/resources/agent-gateways/keys/keys.mjs.map +1 -0
- package/resources/agent-gateways/keys/tool-permissions.d.mts +103 -0
- package/resources/agent-gateways/keys/tool-permissions.d.mts.map +1 -0
- package/resources/agent-gateways/keys/tool-permissions.d.ts +103 -0
- package/resources/agent-gateways/keys/tool-permissions.d.ts.map +1 -0
- package/resources/agent-gateways/keys/tool-permissions.js +62 -0
- package/resources/agent-gateways/keys/tool-permissions.js.map +1 -0
- package/resources/agent-gateways/keys/tool-permissions.mjs +58 -0
- package/resources/agent-gateways/keys/tool-permissions.mjs.map +1 -0
- package/resources/agent-gateways/keys.d.mts +2 -0
- package/resources/agent-gateways/keys.d.mts.map +1 -0
- package/resources/agent-gateways/keys.d.ts +2 -0
- package/resources/agent-gateways/keys.d.ts.map +1 -0
- package/resources/agent-gateways/keys.js +6 -0
- package/resources/agent-gateways/keys.js.map +1 -0
- package/resources/agent-gateways/keys.mjs +3 -0
- package/resources/agent-gateways/keys.mjs.map +1 -0
- package/resources/agent-gateways/mcp-servers.d.mts +246 -0
- package/resources/agent-gateways/mcp-servers.d.mts.map +1 -0
- package/resources/agent-gateways/mcp-servers.d.ts +246 -0
- package/resources/agent-gateways/mcp-servers.d.ts.map +1 -0
- package/resources/agent-gateways/mcp-servers.js +97 -0
- package/resources/agent-gateways/mcp-servers.js.map +1 -0
- package/resources/agent-gateways/mcp-servers.mjs +93 -0
- package/resources/agent-gateways/mcp-servers.mjs.map +1 -0
- package/resources/agent-gateways/policies.d.mts +266 -0
- package/resources/agent-gateways/policies.d.mts.map +1 -0
- package/resources/agent-gateways/policies.d.ts +266 -0
- package/resources/agent-gateways/policies.d.ts.map +1 -0
- package/resources/agent-gateways/policies.js +97 -0
- package/resources/agent-gateways/policies.js.map +1 -0
- package/resources/agent-gateways/policies.mjs +93 -0
- package/resources/agent-gateways/policies.mjs.map +1 -0
- package/resources/agent-gateways/policy-attachments.d.mts +123 -0
- package/resources/agent-gateways/policy-attachments.d.mts.map +1 -0
- package/resources/agent-gateways/policy-attachments.d.ts +123 -0
- package/resources/agent-gateways/policy-attachments.d.ts.map +1 -0
- package/resources/agent-gateways/policy-attachments.js +63 -0
- package/resources/agent-gateways/policy-attachments.js.map +1 -0
- package/resources/agent-gateways/policy-attachments.mjs +59 -0
- package/resources/agent-gateways/policy-attachments.mjs.map +1 -0
- package/resources/agent-gateways/teams/index.d.mts +3 -0
- package/resources/agent-gateways/teams/index.d.mts.map +1 -0
- package/resources/agent-gateways/teams/index.d.ts +3 -0
- package/resources/agent-gateways/teams/index.d.ts.map +1 -0
- package/resources/agent-gateways/teams/index.js +9 -0
- package/resources/agent-gateways/teams/index.js.map +1 -0
- package/resources/agent-gateways/teams/index.mjs +4 -0
- package/resources/agent-gateways/teams/index.mjs.map +1 -0
- package/resources/agent-gateways/teams/teams.d.mts +210 -0
- package/resources/agent-gateways/teams/teams.d.mts.map +1 -0
- package/resources/agent-gateways/teams/teams.d.ts +210 -0
- package/resources/agent-gateways/teams/teams.d.ts.map +1 -0
- package/resources/agent-gateways/teams/teams.js +98 -0
- package/resources/agent-gateways/teams/teams.js.map +1 -0
- package/resources/agent-gateways/teams/teams.mjs +93 -0
- package/resources/agent-gateways/teams/teams.mjs.map +1 -0
- package/resources/agent-gateways/teams/tool-permissions.d.mts +82 -0
- package/resources/agent-gateways/teams/tool-permissions.d.mts.map +1 -0
- package/resources/agent-gateways/teams/tool-permissions.d.ts +82 -0
- package/resources/agent-gateways/teams/tool-permissions.d.ts.map +1 -0
- package/resources/agent-gateways/teams/tool-permissions.js +62 -0
- package/resources/agent-gateways/teams/tool-permissions.js.map +1 -0
- package/resources/agent-gateways/teams/tool-permissions.mjs +58 -0
- package/resources/agent-gateways/teams/tool-permissions.mjs.map +1 -0
- package/resources/agent-gateways/teams.d.mts +2 -0
- package/resources/agent-gateways/teams.d.mts.map +1 -0
- package/resources/agent-gateways/teams.d.ts +2 -0
- package/resources/agent-gateways/teams.d.ts.map +1 -0
- package/resources/agent-gateways/teams.js +6 -0
- package/resources/agent-gateways/teams.js.map +1 -0
- package/resources/agent-gateways/teams.mjs +3 -0
- package/resources/agent-gateways/teams.mjs.map +1 -0
- package/resources/agent-gateways.d.mts +2 -0
- package/resources/agent-gateways.d.mts.map +1 -0
- package/resources/agent-gateways.d.ts +2 -0
- package/resources/agent-gateways.d.ts.map +1 -0
- package/resources/agent-gateways.js +6 -0
- package/resources/agent-gateways.js.map +1 -0
- package/resources/agent-gateways.mjs +3 -0
- package/resources/agent-gateways.mjs.map +1 -0
- package/resources/ai/assistants/assistants.d.mts +23 -9
- package/resources/ai/assistants/assistants.d.mts.map +1 -1
- package/resources/ai/assistants/assistants.d.ts +23 -9
- package/resources/ai/assistants/assistants.d.ts.map +1 -1
- package/resources/ai/assistants/assistants.js.map +1 -1
- package/resources/ai/assistants/assistants.mjs.map +1 -1
- package/resources/ai/memory/namespaces/index.d.mts +1 -1
- package/resources/ai/memory/namespaces/index.d.mts.map +1 -1
- package/resources/ai/memory/namespaces/index.d.ts +1 -1
- package/resources/ai/memory/namespaces/index.d.ts.map +1 -1
- package/resources/ai/memory/namespaces/index.js.map +1 -1
- package/resources/ai/memory/namespaces/index.mjs.map +1 -1
- package/resources/ai/memory/namespaces/namespaces.d.mts +2 -2
- package/resources/ai/memory/namespaces/namespaces.d.mts.map +1 -1
- package/resources/ai/memory/namespaces/namespaces.d.ts +2 -2
- package/resources/ai/memory/namespaces/namespaces.d.ts.map +1 -1
- package/resources/ai/memory/namespaces/namespaces.js.map +1 -1
- package/resources/ai/memory/namespaces/namespaces.mjs.map +1 -1
- package/resources/ai/memory/namespaces/profiles/index.d.mts +1 -1
- package/resources/ai/memory/namespaces/profiles/index.d.mts.map +1 -1
- package/resources/ai/memory/namespaces/profiles/index.d.ts +1 -1
- package/resources/ai/memory/namespaces/profiles/index.d.ts.map +1 -1
- package/resources/ai/memory/namespaces/profiles/index.js.map +1 -1
- package/resources/ai/memory/namespaces/profiles/index.mjs.map +1 -1
- package/resources/ai/memory/namespaces/profiles/profiles.d.mts +20 -2
- package/resources/ai/memory/namespaces/profiles/profiles.d.mts.map +1 -1
- package/resources/ai/memory/namespaces/profiles/profiles.d.ts +20 -2
- package/resources/ai/memory/namespaces/profiles/profiles.d.ts.map +1 -1
- package/resources/ai/memory/namespaces/profiles/profiles.js.map +1 -1
- package/resources/ai/memory/namespaces/profiles/profiles.mjs.map +1 -1
- package/resources/calendar-connections/calendar-connections.d.mts +380 -0
- package/resources/calendar-connections/calendar-connections.d.mts.map +1 -0
- package/resources/calendar-connections/calendar-connections.d.ts +380 -0
- package/resources/calendar-connections/calendar-connections.d.ts.map +1 -0
- package/resources/calendar-connections/calendar-connections.js +102 -0
- package/resources/calendar-connections/calendar-connections.js.map +1 -0
- package/resources/calendar-connections/calendar-connections.mjs +97 -0
- package/resources/calendar-connections/calendar-connections.mjs.map +1 -0
- package/resources/calendar-connections/index.d.mts +3 -0
- package/resources/calendar-connections/index.d.mts.map +1 -0
- package/resources/calendar-connections/index.d.ts +3 -0
- package/resources/calendar-connections/index.d.ts.map +1 -0
- package/resources/calendar-connections/index.js +9 -0
- package/resources/calendar-connections/index.js.map +1 -0
- package/resources/calendar-connections/index.mjs +4 -0
- package/resources/calendar-connections/index.mjs.map +1 -0
- package/resources/calendar-connections/meetings.d.mts +149 -0
- package/resources/calendar-connections/meetings.d.mts.map +1 -0
- package/resources/calendar-connections/meetings.d.ts +149 -0
- package/resources/calendar-connections/meetings.d.ts.map +1 -0
- package/resources/calendar-connections/meetings.js +47 -0
- package/resources/calendar-connections/meetings.js.map +1 -0
- package/resources/calendar-connections/meetings.mjs +43 -0
- package/resources/calendar-connections/meetings.mjs.map +1 -0
- package/resources/calendar-connections.d.mts +2 -0
- package/resources/calendar-connections.d.mts.map +1 -0
- package/resources/calendar-connections.d.ts +2 -0
- package/resources/calendar-connections.d.ts.map +1 -0
- package/resources/calendar-connections.js +6 -0
- package/resources/calendar-connections.js.map +1 -0
- package/resources/calendar-connections.mjs +3 -0
- package/resources/calendar-connections.mjs.map +1 -0
- package/resources/calls/actions.d.mts +11 -5
- package/resources/calls/actions.d.mts.map +1 -1
- package/resources/calls/actions.d.ts +11 -5
- package/resources/calls/actions.d.ts.map +1 -1
- package/resources/calls/calls.d.mts +4 -4
- package/resources/calls/calls.d.mts.map +1 -1
- package/resources/calls/calls.d.ts +4 -4
- package/resources/calls/calls.d.ts.map +1 -1
- package/resources/calls/calls.js.map +1 -1
- package/resources/calls/calls.mjs.map +1 -1
- package/resources/calls/index.d.mts +1 -1
- package/resources/calls/index.d.mts.map +1 -1
- package/resources/calls/index.d.ts +1 -1
- package/resources/calls/index.d.ts.map +1 -1
- package/resources/calls/index.js.map +1 -1
- package/resources/calls/index.mjs.map +1 -1
- package/resources/conferences/actions.d.mts +1 -1
- package/resources/conferences/actions.d.mts.map +1 -1
- package/resources/conferences/actions.d.ts +1 -1
- package/resources/conferences/actions.d.ts.map +1 -1
- package/resources/index.d.mts +6 -2
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +6 -2
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +13 -4
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +4 -0
- package/resources/index.mjs.map +1 -1
- package/resources/meeting-bot/calendar.d.mts +34 -0
- package/resources/meeting-bot/calendar.d.mts.map +1 -0
- package/resources/meeting-bot/calendar.d.ts +34 -0
- package/resources/meeting-bot/calendar.d.ts.map +1 -0
- package/resources/meeting-bot/calendar.js +26 -0
- package/resources/meeting-bot/calendar.js.map +1 -0
- package/resources/meeting-bot/calendar.mjs +22 -0
- package/resources/meeting-bot/calendar.mjs.map +1 -0
- package/resources/meeting-bot/index.d.mts +3 -0
- package/resources/meeting-bot/index.d.mts.map +1 -0
- package/resources/meeting-bot/index.d.ts +3 -0
- package/resources/meeting-bot/index.d.ts.map +1 -0
- package/resources/meeting-bot/index.js +9 -0
- package/resources/meeting-bot/index.js.map +1 -0
- package/resources/meeting-bot/index.mjs +4 -0
- package/resources/meeting-bot/index.mjs.map +1 -0
- package/resources/meeting-bot/meeting-bot.d.mts +10 -0
- package/resources/meeting-bot/meeting-bot.d.mts.map +1 -0
- package/resources/meeting-bot/meeting-bot.d.ts +10 -0
- package/resources/meeting-bot/meeting-bot.d.ts.map +1 -0
- package/resources/meeting-bot/meeting-bot.js +17 -0
- package/resources/meeting-bot/meeting-bot.js.map +1 -0
- package/resources/meeting-bot/meeting-bot.mjs +12 -0
- package/resources/meeting-bot/meeting-bot.mjs.map +1 -0
- package/resources/meeting-bot.d.mts +2 -0
- package/resources/meeting-bot.d.mts.map +1 -0
- package/resources/meeting-bot.d.ts +2 -0
- package/resources/meeting-bot.d.ts.map +1 -0
- package/resources/meeting-bot.js +6 -0
- package/resources/meeting-bot.js.map +1 -0
- package/resources/meeting-bot.mjs +3 -0
- package/resources/meeting-bot.mjs.map +1 -0
- package/resources/meeting-sessions/actions.d.mts +17 -11
- package/resources/meeting-sessions/actions.d.mts.map +1 -1
- package/resources/meeting-sessions/actions.d.ts +17 -11
- package/resources/meeting-sessions/actions.d.ts.map +1 -1
- package/resources/meeting-sessions/actions.js +14 -10
- package/resources/meeting-sessions/actions.js.map +1 -1
- package/resources/meeting-sessions/actions.mjs +14 -10
- package/resources/meeting-sessions/actions.mjs.map +1 -1
- package/resources/meeting-sessions/artifacts.d.mts +8 -7
- package/resources/meeting-sessions/artifacts.d.mts.map +1 -1
- package/resources/meeting-sessions/artifacts.d.ts +8 -7
- package/resources/meeting-sessions/artifacts.d.ts.map +1 -1
- package/resources/meeting-sessions/artifacts.js +8 -7
- package/resources/meeting-sessions/artifacts.js.map +1 -1
- package/resources/meeting-sessions/artifacts.mjs +8 -7
- package/resources/meeting-sessions/artifacts.mjs.map +1 -1
- package/resources/meeting-sessions/index.d.mts +1 -1
- package/resources/meeting-sessions/index.d.mts.map +1 -1
- package/resources/meeting-sessions/index.d.ts +1 -1
- package/resources/meeting-sessions/index.d.ts.map +1 -1
- package/resources/meeting-sessions/index.js.map +1 -1
- package/resources/meeting-sessions/index.mjs.map +1 -1
- package/resources/meeting-sessions/meeting-sessions.d.mts +281 -103
- package/resources/meeting-sessions/meeting-sessions.d.mts.map +1 -1
- package/resources/meeting-sessions/meeting-sessions.d.ts +281 -103
- package/resources/meeting-sessions/meeting-sessions.d.ts.map +1 -1
- package/resources/meeting-sessions/meeting-sessions.js +53 -21
- package/resources/meeting-sessions/meeting-sessions.js.map +1 -1
- package/resources/meeting-sessions/meeting-sessions.mjs +53 -21
- package/resources/meeting-sessions/meeting-sessions.mjs.map +1 -1
- package/resources/text-to-speech/text-to-speech.d.mts +45 -5
- package/resources/text-to-speech/text-to-speech.d.mts.map +1 -1
- package/resources/text-to-speech/text-to-speech.d.ts +45 -5
- package/resources/text-to-speech/text-to-speech.d.ts.map +1 -1
- package/resources/text-to-speech/text-to-speech.js +8 -2
- package/resources/text-to-speech/text-to-speech.js.map +1 -1
- package/resources/text-to-speech/text-to-speech.mjs +8 -2
- package/resources/text-to-speech/text-to-speech.mjs.map +1 -1
- package/resources/user-profile.d.mts +284 -0
- package/resources/user-profile.d.mts.map +1 -0
- package/resources/user-profile.d.ts +284 -0
- package/resources/user-profile.d.ts.map +1 -0
- package/resources/user-profile.js +42 -0
- package/resources/user-profile.js.map +1 -0
- package/resources/user-profile.mjs +38 -0
- package/resources/user-profile.mjs.map +1 -0
- package/resources/webhooks.d.mts +129 -3
- package/resources/webhooks.d.mts.map +1 -1
- package/resources/webhooks.d.ts +129 -3
- package/resources/webhooks.d.ts.map +1 -1
- package/src/client.ts +90 -0
- package/src/resources/agent-gateways/agent-gateways.ts +605 -0
- package/src/resources/agent-gateways/apis.ts +388 -0
- package/src/resources/agent-gateways/guardrails.ts +304 -0
- package/src/resources/agent-gateways/index.ts +87 -0
- package/src/resources/agent-gateways/keys/index.ts +20 -0
- package/src/resources/agent-gateways/keys/keys.ts +437 -0
- package/src/resources/agent-gateways/keys/tool-permissions.ts +139 -0
- package/src/resources/agent-gateways/keys.ts +3 -0
- package/src/resources/agent-gateways/mcp-servers.ts +328 -0
- package/src/resources/agent-gateways/policies.ts +348 -0
- package/src/resources/agent-gateways/policy-attachments.ts +167 -0
- package/src/resources/agent-gateways/teams/index.ts +16 -0
- package/src/resources/agent-gateways/teams/teams.ts +282 -0
- package/src/resources/agent-gateways/teams/tool-permissions.ts +112 -0
- package/src/resources/agent-gateways/teams.ts +3 -0
- package/src/resources/agent-gateways.ts +3 -0
- package/src/resources/ai/assistants/assistants.ts +24 -9
- package/src/resources/ai/memory/namespaces/index.ts +1 -0
- package/src/resources/ai/memory/namespaces/namespaces.ts +2 -0
- package/src/resources/ai/memory/namespaces/profiles/index.ts +1 -0
- package/src/resources/ai/memory/namespaces/profiles/profiles.ts +24 -1
- package/src/resources/calendar-connections/calendar-connections.ts +486 -0
- package/src/resources/calendar-connections/index.ts +21 -0
- package/src/resources/calendar-connections/meetings.ts +205 -0
- package/src/resources/calendar-connections.ts +3 -0
- package/src/resources/calls/actions.ts +16 -4
- package/src/resources/calls/calls.ts +6 -2
- package/src/resources/calls/index.ts +1 -0
- package/src/resources/conferences/actions.ts +2 -1
- package/src/resources/index.ts +36 -0
- package/src/resources/meeting-bot/calendar.ts +54 -0
- package/src/resources/meeting-bot/index.ts +8 -0
- package/src/resources/meeting-bot/meeting-bot.ts +23 -0
- package/src/resources/meeting-bot.ts +3 -0
- package/src/resources/meeting-sessions/actions.ts +17 -11
- package/src/resources/meeting-sessions/artifacts.ts +8 -7
- package/src/resources/meeting-sessions/index.ts +4 -0
- package/src/resources/meeting-sessions/meeting-sessions.ts +321 -102
- package/src/resources/text-to-speech/text-to-speech.ts +81 -5
- package/src/resources/user-profile.ts +357 -0
- package/src/resources/webhooks.ts +216 -0
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -1,4 +1,6 @@
|
|
|
1
1
|
import { APIResource } from "../../core/resource.mjs";
|
|
2
|
+
import * as MeetingSessionsAPI from "./meeting-sessions.mjs";
|
|
3
|
+
import * as CalendarConnectionsAPI from "../calendar-connections/calendar-connections.mjs";
|
|
2
4
|
import * as ActionsAPI from "./actions.mjs";
|
|
3
5
|
import { ActionAcceptedResponse, ActionSendChatParams, ActionSpeakParams, Actions } from "./actions.mjs";
|
|
4
6
|
import * as ArtifactsAPI from "./artifacts.mjs";
|
|
@@ -9,7 +11,9 @@ export declare class MeetingSessions extends APIResource {
|
|
|
9
11
|
actions: ActionsAPI.Actions;
|
|
10
12
|
artifacts: ArtifactsAPI.Artifacts;
|
|
11
13
|
/**
|
|
12
|
-
* Returns a list of meeting sessions, optionally filtered by status.
|
|
14
|
+
* Returns a list of meeting sessions, optionally filtered by status. List items
|
|
15
|
+
* omit assistant.dynamic_variables and recording_export. Some items include
|
|
16
|
+
* remote_state_observed_at; retrieve the individual session for current state.
|
|
13
17
|
*
|
|
14
18
|
* @example
|
|
15
19
|
* ```ts
|
|
@@ -18,19 +22,18 @@ export declare class MeetingSessions extends APIResource {
|
|
|
18
22
|
*/
|
|
19
23
|
list(query?: MeetingSessionListParams | null | undefined, options?: RequestOptions): APIPromise<MeetingSessionListResponse>;
|
|
20
24
|
/**
|
|
21
|
-
* Creates a
|
|
22
|
-
*
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
* 400 `invalid_request` (message prefix `assistant_avatar_not_configured:`), an
|
|
25
|
+
* Creates a meeting session and returns 201, or 200 for a replay. Use a unique
|
|
26
|
+
* `idempotency_key` per intended join and reuse the same key and request on
|
|
27
|
+
* retries. Reusing a key with a different join configuration or meeting URL can
|
|
28
|
+
* return 409 invalid_state. Always retry with the original request. The session
|
|
29
|
+
* can pass through joining and waiting_for_admission before active. Optional
|
|
30
|
+
* `camera_image` input is write-only and applies when no assistant avatar takes
|
|
31
|
+
* precedence. An ignored URL is not fetched. An effective URL source is resolved
|
|
32
|
+
* before bot creation; the source URL and image bytes are not returned in the
|
|
33
|
+
* session response. Treat signed URLs as credentials. With
|
|
34
|
+
* `assistant.avatar: true`, the assistant is read before the bot is created: an
|
|
35
|
+
* assistant without a Telnyx avatar configured is rejected with 400
|
|
36
|
+
* `invalid_request` (message prefix `assistant_avatar_not_configured:`), an
|
|
34
37
|
* unknown assistant with 400 `invalid_request` (prefix `assistant_not_found:`),
|
|
35
38
|
* and a failed lookup with 503 `assistant_lookup_unavailable`; no bot is created
|
|
36
39
|
* in any of these cases.
|
|
@@ -47,7 +50,9 @@ export declare class MeetingSessions extends APIResource {
|
|
|
47
50
|
/**
|
|
48
51
|
* Stops a meeting session without deleting its persisted record. Scheduled bots
|
|
49
52
|
* are cancelled, while bots that are joining or active are asked to leave. The
|
|
50
|
-
* persisted meeting session record remains available.
|
|
53
|
+
* persisted meeting session record remains available. A successful response can
|
|
54
|
+
* report leaving while departure is pending. Poll until ended, failed, or
|
|
55
|
+
* admission_denied. Exported Storage objects are unaffected.
|
|
51
56
|
*
|
|
52
57
|
* @example
|
|
53
58
|
* ```ts
|
|
@@ -75,7 +80,10 @@ export declare class MeetingSessions extends APIResource {
|
|
|
75
80
|
* Updates mutable properties of a meeting session. Only sessions in the scheduled
|
|
76
81
|
* state can be updated; any other state returns 409 with the invalid_state error
|
|
77
82
|
* code. All request fields are optional, and an empty object is a valid no-op
|
|
78
|
-
* update.
|
|
83
|
+
* update. Calendar-controlled Google Meet and Teams sessions return 409
|
|
84
|
+
* calendar_managed; change the event instead. A conflicting pending edit returns
|
|
85
|
+
* 409 edit_in_progress. On a timeout or 503, read the session and retry the same
|
|
86
|
+
* changes.
|
|
79
87
|
*
|
|
80
88
|
* @example
|
|
81
89
|
* ```ts
|
|
@@ -108,7 +116,10 @@ export declare class MeetingSessions extends APIResource {
|
|
|
108
116
|
* events, artifacts, and usage records. It is separate from
|
|
109
117
|
* `DELETE /meeting_sessions/{id}`, which stops or cancels participation without
|
|
110
118
|
* deleting the persisted session. A missing/foreign session returns 404; a
|
|
111
|
-
* deletion request whose outcome is unknown returns 502.
|
|
119
|
+
* deletion request whose outcome is unknown returns 502. Customer Storage exports
|
|
120
|
+
* do not support this operation (422 unsupported_capability); delete the exported
|
|
121
|
+
* object through Storage instead. Stopping a session does not delete an exported
|
|
122
|
+
* object.
|
|
112
123
|
*
|
|
113
124
|
* @example
|
|
114
125
|
* ```ts
|
|
@@ -120,10 +131,11 @@ export declare class MeetingSessions extends APIResource {
|
|
|
120
131
|
*/
|
|
121
132
|
deleteRecordingMedia(id: string, options?: RequestOptions): APIPromise<MeetingSessionDeleteRecordingMediaResponse>;
|
|
122
133
|
/**
|
|
123
|
-
* Returns transcript segments ordered by ascending
|
|
124
|
-
*
|
|
125
|
-
*
|
|
126
|
-
* supplied
|
|
134
|
+
* Returns transcript segments ordered by ascending seq. Default limit is 100,
|
|
135
|
+
* maximum 1000. Continue with after=meta.next_after. On an empty page,
|
|
136
|
+
* meta.next_after preserves a positive supplied after cursor, or is null when no
|
|
137
|
+
* positive cursor was supplied. wait_seconds holds an empty read for up to 25
|
|
138
|
+
* seconds; a timeout still returns 200.
|
|
127
139
|
*
|
|
128
140
|
* @example
|
|
129
141
|
* ```ts
|
|
@@ -134,11 +146,31 @@ export declare class MeetingSessions extends APIResource {
|
|
|
134
146
|
* ```
|
|
135
147
|
*/
|
|
136
148
|
retrieveTranscript(id: string, query?: MeetingSessionRetrieveTranscriptParams | null | undefined, options?: RequestOptions): APIPromise<MeetingSessionRetrieveTranscriptResponse>;
|
|
149
|
+
/**
|
|
150
|
+
* Retrieve recording export status. Customer Storage exports include
|
|
151
|
+
* recording_export with the bucket, region, key and pending/exported/failed
|
|
152
|
+
* status, or null when no reference is available. The data array is empty for
|
|
153
|
+
* these exports. Download or share the object using the Storage API once its
|
|
154
|
+
* status is exported. Zoom recordings and existing Google Meet or Teams recordings
|
|
155
|
+
* held by the Meeting service continue returning temporary download links in data
|
|
156
|
+
* through this same endpoint and session ID. Those recordings do not require
|
|
157
|
+
* Storage setup or migration. Refresh this endpoint when a link expires. Select
|
|
158
|
+
* the download method from the returned fields, not the platform alone.
|
|
159
|
+
*
|
|
160
|
+
* @example
|
|
161
|
+
* ```ts
|
|
162
|
+
* const response =
|
|
163
|
+
* await client.meetingSessions.retrieveRecordings(
|
|
164
|
+
* 'mtgsess_a1b2c3d4-e5f6-7890-abcd-ef1234567890',
|
|
165
|
+
* );
|
|
166
|
+
* ```
|
|
167
|
+
*/
|
|
168
|
+
retrieveRecordings(id: string, options?: RequestOptions): APIPromise<MeetingSessionRetrieveRecordingsResponse>;
|
|
137
169
|
}
|
|
138
170
|
/**
|
|
139
|
-
* Represents a meeting session.
|
|
140
|
-
*
|
|
141
|
-
* routing, key, or internal fields are exposed.
|
|
171
|
+
* Represents a meeting session. Core serializer fields are required;
|
|
172
|
+
* platform-specific fields are optional. Nullable fields use null when absent. No
|
|
173
|
+
* actor, provider-bot, idempotency, routing, key, or internal fields are exposed.
|
|
142
174
|
*/
|
|
143
175
|
export interface MeetingSession {
|
|
144
176
|
/**
|
|
@@ -152,7 +184,7 @@ export interface MeetingSession {
|
|
|
152
184
|
/**
|
|
153
185
|
* Assistant configuration if an assistant is attached, otherwise null.
|
|
154
186
|
*/
|
|
155
|
-
assistant:
|
|
187
|
+
assistant: CalendarConnectionsAPI.MeetingSessionAssistant | null;
|
|
156
188
|
/**
|
|
157
189
|
* Current state of the assistant, or null if no assistant is attached.
|
|
158
190
|
*/
|
|
@@ -191,7 +223,14 @@ export interface MeetingSession {
|
|
|
191
223
|
*/
|
|
192
224
|
ended_at: string | null;
|
|
193
225
|
/**
|
|
194
|
-
*
|
|
226
|
+
* A machine-readable lifecycle reason, or null. Values include left_on_request,
|
|
227
|
+
* meeting_ended, everyone_left, no_one_joined, silence_timeout,
|
|
228
|
+
* max_duration_reached, admission_timeout, admission_denied, removed_from_meeting,
|
|
229
|
+
* recording_permission_denied, meeting_not_found, meeting_not_started,
|
|
230
|
+
* meeting_access_denied, meeting_full, cancelled, cancelled_calendar_disconnected,
|
|
231
|
+
* cancelled_calendar_event_deleted, cancelled_calendar_superseded,
|
|
232
|
+
* cancelled_policy, internal_error, and other. Treat this vocabulary as
|
|
233
|
+
* extensible.
|
|
195
234
|
*/
|
|
196
235
|
failure_reason: string | null;
|
|
197
236
|
/**
|
|
@@ -218,9 +257,9 @@ export interface MeetingSession {
|
|
|
218
257
|
*/
|
|
219
258
|
platform: 'zoom' | 'google_meet' | 'teams' | 'webex' | 'unknown';
|
|
220
259
|
/**
|
|
221
|
-
*
|
|
260
|
+
* Always telnyx.
|
|
222
261
|
*/
|
|
223
|
-
provider:
|
|
262
|
+
provider: 'telnyx';
|
|
224
263
|
/**
|
|
225
264
|
* Whether the session is being recorded.
|
|
226
265
|
*/
|
|
@@ -235,7 +274,14 @@ export interface MeetingSession {
|
|
|
235
274
|
*/
|
|
236
275
|
status: 'scheduled' | 'joining' | 'waiting_for_admission' | 'active' | 'leaving' | 'ended' | 'failed' | 'admission_denied';
|
|
237
276
|
/**
|
|
238
|
-
*
|
|
277
|
+
* A machine-readable lifecycle reason, or null. Values include left_on_request,
|
|
278
|
+
* meeting_ended, everyone_left, no_one_joined, silence_timeout,
|
|
279
|
+
* max_duration_reached, admission_timeout, admission_denied, removed_from_meeting,
|
|
280
|
+
* recording_permission_denied, meeting_not_found, meeting_not_started,
|
|
281
|
+
* meeting_access_denied, meeting_full, cancelled, cancelled_calendar_disconnected,
|
|
282
|
+
* cancelled_calendar_event_deleted, cancelled_calendar_superseded,
|
|
283
|
+
* cancelled_policy, internal_error, and other. Treat this vocabulary as
|
|
284
|
+
* extensible.
|
|
239
285
|
*/
|
|
240
286
|
status_detail: string | null;
|
|
241
287
|
/**
|
|
@@ -246,32 +292,19 @@ export interface MeetingSession {
|
|
|
246
292
|
* Webhook endpoint for session lifecycle callbacks, or null if not configured.
|
|
247
293
|
*/
|
|
248
294
|
webhook_url: string | null;
|
|
249
|
-
}
|
|
250
|
-
export declare namespace MeetingSession {
|
|
251
295
|
/**
|
|
252
|
-
*
|
|
296
|
+
* Customer Storage recording reference. Pending is not downloadable; exported
|
|
297
|
+
* means upload was verified; failed is terminal. Download with ordinary Storage
|
|
298
|
+
* authorization. No presigned URL is returned.
|
|
253
299
|
*/
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
audio_gate: 'half_duplex' | 'full_duplex';
|
|
263
|
-
/**
|
|
264
|
-
* The dynamic variables in force for this session, or null when none were
|
|
265
|
-
* supplied.
|
|
266
|
-
*/
|
|
267
|
-
dynamic_variables: {
|
|
268
|
-
[key: string]: string;
|
|
269
|
-
} | null;
|
|
270
|
-
/**
|
|
271
|
-
* Whether the bot leaves when the Assistant's conversation ends or fails.
|
|
272
|
-
*/
|
|
273
|
-
leave_on_end: boolean;
|
|
274
|
-
}
|
|
300
|
+
recording_export?: MeetingSessionRecordingExport | null;
|
|
301
|
+
/**
|
|
302
|
+
* Optional observation time on session list items. Retrieve the individual session
|
|
303
|
+
* when current state is required.
|
|
304
|
+
*/
|
|
305
|
+
remote_state_observed_at?: string;
|
|
306
|
+
}
|
|
307
|
+
export declare namespace MeetingSession {
|
|
275
308
|
/**
|
|
276
309
|
* The assistant's avatar, captured from its `avatar_settings` when the session was
|
|
277
310
|
* created. For display only; later changes to the assistant do not update it.
|
|
@@ -305,6 +338,10 @@ export declare namespace MeetingSession {
|
|
|
305
338
|
* The message posted to chat on join, or null when unset.
|
|
306
339
|
*/
|
|
307
340
|
chat_on_enter: string | null;
|
|
341
|
+
/**
|
|
342
|
+
* Detection settings. Enabling audio or video detection is currently unsupported.
|
|
343
|
+
*/
|
|
344
|
+
deepfake_detection: Config.DeepfakeDetection;
|
|
308
345
|
/**
|
|
309
346
|
* Text spoken on meeting entry, or null if not set.
|
|
310
347
|
*/
|
|
@@ -317,13 +354,107 @@ export declare namespace MeetingSession {
|
|
|
317
354
|
* Configured voice identifier, or null if not set.
|
|
318
355
|
*/
|
|
319
356
|
voice: string | null;
|
|
357
|
+
/**
|
|
358
|
+
* Automatic departure settings for Google Meet and Teams. Omitted fields use the
|
|
359
|
+
* default behavior. Set at creation; cannot be changed later. Zoom ignores this
|
|
360
|
+
* policy.
|
|
361
|
+
*/
|
|
362
|
+
leave_policy?: MeetingSessionsAPI.MeetingSessionLeavePolicy;
|
|
363
|
+
/**
|
|
364
|
+
* Recording intent set at creation for Google Meet and Teams. Distinct from the
|
|
365
|
+
* top-level recording field, which reports current activity.
|
|
366
|
+
*/
|
|
367
|
+
recording?: boolean;
|
|
368
|
+
/**
|
|
369
|
+
* Non-default recording layout. Omitted for the default speaker_view layout.
|
|
370
|
+
*/
|
|
371
|
+
recording_view?: 'gallery_view' | 'speaker_view_no_sidebar';
|
|
372
|
+
}
|
|
373
|
+
namespace Config {
|
|
374
|
+
/**
|
|
375
|
+
* Detection settings. Enabling audio or video detection is currently unsupported.
|
|
376
|
+
*/
|
|
377
|
+
interface DeepfakeDetection {
|
|
378
|
+
audio: boolean;
|
|
379
|
+
video: boolean;
|
|
380
|
+
}
|
|
320
381
|
}
|
|
321
382
|
}
|
|
383
|
+
/**
|
|
384
|
+
* Automatic departure settings for Google Meet and Teams. Omitted fields use the
|
|
385
|
+
* default behavior. Set at creation; cannot be changed later. Zoom ignores this
|
|
386
|
+
* policy.
|
|
387
|
+
*/
|
|
388
|
+
export interface MeetingSessionLeavePolicy {
|
|
389
|
+
/**
|
|
390
|
+
* Seconds alone after another participant has attended and left. Does not start
|
|
391
|
+
* just because the bot arrives first.
|
|
392
|
+
*/
|
|
393
|
+
alone_seconds?: number;
|
|
394
|
+
/**
|
|
395
|
+
* Case-insensitive names or phrases identifying other bots to exclude when
|
|
396
|
+
* deciding whether this bot is alone. Matching splits names on spaces, hyphens and
|
|
397
|
+
* underscores. Null or an empty array disables filtering.
|
|
398
|
+
*/
|
|
399
|
+
bot_name_keywords?: Array<string> | null;
|
|
400
|
+
/**
|
|
401
|
+
* Seconds to wait for the host to start the meeting.
|
|
402
|
+
*/
|
|
403
|
+
host_wait_seconds?: number;
|
|
404
|
+
/**
|
|
405
|
+
* Seconds to wait for lobby admission.
|
|
406
|
+
*/
|
|
407
|
+
lobby_wait_seconds?: number;
|
|
408
|
+
/**
|
|
409
|
+
* Maximum seconds after joining. Null means no per-join duration limit; service
|
|
410
|
+
* safety limits still apply.
|
|
411
|
+
*/
|
|
412
|
+
max_duration_seconds?: number | null;
|
|
413
|
+
/**
|
|
414
|
+
* Seconds after joining before silence detection starts a fresh inactivity timer.
|
|
415
|
+
*/
|
|
416
|
+
silence_grace_seconds?: number;
|
|
417
|
+
/**
|
|
418
|
+
* Continuous audio inactivity before departure after the silence grace period.
|
|
419
|
+
*/
|
|
420
|
+
silence_seconds?: number;
|
|
421
|
+
}
|
|
422
|
+
/**
|
|
423
|
+
* Customer-owned Telnyx Storage destination for recording exports. Uses the
|
|
424
|
+
* authenticated organization and user; do not supply credentials, region,
|
|
425
|
+
* organization ID or object key.
|
|
426
|
+
*/
|
|
427
|
+
export interface MeetingSessionRecordingDestination {
|
|
428
|
+
/**
|
|
429
|
+
* Existing accessible bucket. Consecutive dots and IPv4-address names are
|
|
430
|
+
* rejected.
|
|
431
|
+
*/
|
|
432
|
+
bucket: string;
|
|
433
|
+
/**
|
|
434
|
+
* Optional object-key prefix. One trailing slash is normalized. Empty path
|
|
435
|
+
* segments, . and .. segments are rejected.
|
|
436
|
+
*/
|
|
437
|
+
prefix?: string;
|
|
438
|
+
}
|
|
439
|
+
/**
|
|
440
|
+
* Customer Storage recording reference. Pending is not downloadable; exported
|
|
441
|
+
* means upload was verified; failed is terminal. Download with ordinary Storage
|
|
442
|
+
* authorization. No presigned URL is returned.
|
|
443
|
+
*/
|
|
444
|
+
export interface MeetingSessionRecordingExport {
|
|
445
|
+
bucket: string;
|
|
446
|
+
bytes: number | null;
|
|
447
|
+
exported_at: string | null;
|
|
448
|
+
key: string;
|
|
449
|
+
region: string;
|
|
450
|
+
status: 'pending' | 'exported' | 'failed';
|
|
451
|
+
type: 'video';
|
|
452
|
+
}
|
|
322
453
|
export interface MeetingSessionResponse {
|
|
323
454
|
/**
|
|
324
|
-
* Represents a meeting session.
|
|
325
|
-
*
|
|
326
|
-
* routing, key, or internal fields are exposed.
|
|
455
|
+
* Represents a meeting session. Core serializer fields are required;
|
|
456
|
+
* platform-specific fields are optional. Nullable fields use null when absent. No
|
|
457
|
+
* actor, provider-bot, idempotency, routing, key, or internal fields are exposed.
|
|
327
458
|
*/
|
|
328
459
|
data: MeetingSession;
|
|
329
460
|
}
|
|
@@ -357,6 +488,28 @@ export declare namespace MeetingSessionRetrieveEventsResponse {
|
|
|
357
488
|
type: string;
|
|
358
489
|
}
|
|
359
490
|
}
|
|
491
|
+
export interface MeetingSessionRetrieveRecordingsResponse {
|
|
492
|
+
/**
|
|
493
|
+
* Temporary download URLs for recordings held by the Meeting service, including
|
|
494
|
+
* Zoom and existing Google Meet and Teams recordings. Empty for customer Storage
|
|
495
|
+
* exports; use recording_export instead. Choose the download method from these
|
|
496
|
+
* fields rather than the platform alone.
|
|
497
|
+
*/
|
|
498
|
+
data: Array<MeetingSessionRetrieveRecordingsResponse.Data>;
|
|
499
|
+
/**
|
|
500
|
+
* Customer Storage recording reference. Pending is not downloadable; exported
|
|
501
|
+
* means upload was verified; failed is terminal. Download with ordinary Storage
|
|
502
|
+
* authorization. No presigned URL is returned.
|
|
503
|
+
*/
|
|
504
|
+
recording_export?: MeetingSessionRecordingExport | null;
|
|
505
|
+
}
|
|
506
|
+
export declare namespace MeetingSessionRetrieveRecordingsResponse {
|
|
507
|
+
interface Data {
|
|
508
|
+
expires_at: string | null;
|
|
509
|
+
type: string;
|
|
510
|
+
url: string;
|
|
511
|
+
}
|
|
512
|
+
}
|
|
360
513
|
export interface MeetingSessionRetrieveTranscriptResponse {
|
|
361
514
|
data: Array<MeetingSessionRetrieveTranscriptResponse.Data>;
|
|
362
515
|
meta: MeetingSessionRetrieveTranscriptResponse.Meta;
|
|
@@ -366,7 +519,16 @@ export declare namespace MeetingSessionRetrieveTranscriptResponse {
|
|
|
366
519
|
confidence: number | null;
|
|
367
520
|
occurred_at: string;
|
|
368
521
|
relative_ts: number | null;
|
|
522
|
+
/**
|
|
523
|
+
* Monotonic transcript append cursor. This is separate from the event-history
|
|
524
|
+
* cursor and does not establish conversational turn order.
|
|
525
|
+
*/
|
|
369
526
|
seq: number;
|
|
527
|
+
/**
|
|
528
|
+
* Recorded participant or bot label, or null when unavailable. Labels are
|
|
529
|
+
* attribution, not verified identity. Segments from concurrent speakers can
|
|
530
|
+
* finalize in a different order from the conversation.
|
|
531
|
+
*/
|
|
370
532
|
speaker_label: string | null;
|
|
371
533
|
text: string;
|
|
372
534
|
}
|
|
@@ -390,10 +552,8 @@ export interface MeetingSessionCreateParams {
|
|
|
390
552
|
*/
|
|
391
553
|
meeting_url: string;
|
|
392
554
|
/**
|
|
393
|
-
* Attach a Telnyx AI Assistant
|
|
394
|
-
*
|
|
395
|
-
* connection, caller ID and loopback SIP URI previously required here have been
|
|
396
|
-
* removed and are now rejected as unknown fields.
|
|
555
|
+
* Attach a Telnyx AI Assistant owned by the authenticated account. Supply its ID
|
|
556
|
+
* and optional conversation settings. Unknown fields are rejected.
|
|
397
557
|
*/
|
|
398
558
|
assistant?: MeetingSessionCreateParams.Assistant;
|
|
399
559
|
/**
|
|
@@ -407,12 +567,13 @@ export interface MeetingSessionCreateParams {
|
|
|
407
567
|
*/
|
|
408
568
|
bot_name?: string;
|
|
409
569
|
/**
|
|
410
|
-
*
|
|
570
|
+
* Not supported for Google Meet and Teams joins (422 unsupported_capability).
|
|
571
|
+
* Write-only static camera-tile image for this session, not an account or
|
|
411
572
|
* participant profile photo. Supply exactly one JPEG source. When effective, the
|
|
412
573
|
* image is used as the bot's static camera/video output; presentation varies by
|
|
413
574
|
* meeting platform and recording configuration and is not guaranteed in
|
|
414
|
-
* recordings. An
|
|
415
|
-
*
|
|
575
|
+
* recordings. An attached assistant or avatar takes precedence, so this input is
|
|
576
|
+
* ignored and a URL source is not fetched.
|
|
416
577
|
*/
|
|
417
578
|
camera_image?: MeetingSessionCreateParams.MeetingSessionCameraImageBase64Source | MeetingSessionCreateParams.MeetingSessionCameraImageURLSource;
|
|
418
579
|
/**
|
|
@@ -420,20 +581,30 @@ export interface MeetingSessionCreateParams {
|
|
|
420
581
|
* typically a recording disclosure. Delivered at most once. Independent of
|
|
421
582
|
* `speak_on_enter`: both may be set, and the chat message posts first because it
|
|
422
583
|
* does not wait for text-to-speech or avatar startup. Rejected with 422
|
|
423
|
-
* `unsupported_capability` on platforms without meeting chat.
|
|
584
|
+
* `unsupported_capability` on platforms without meeting chat. For Google Meet and
|
|
585
|
+
* Teams, text must be nonblank, at most 4096 UTF-8 bytes, with no control
|
|
586
|
+
* characters except tabs and line breaks. Counts toward the 1000-chat-request
|
|
587
|
+
* session limit.
|
|
424
588
|
*/
|
|
425
589
|
chat_on_enter?: string;
|
|
426
590
|
/**
|
|
427
|
-
*
|
|
428
|
-
*
|
|
429
|
-
*
|
|
591
|
+
* Use a unique key per intended join and reuse the same key and request on
|
|
592
|
+
* retries. Reusing a key with a different join configuration or meeting URL can
|
|
593
|
+
* return 409 invalid_state. Always retry with the original request.
|
|
430
594
|
*/
|
|
431
595
|
idempotency_key?: string;
|
|
432
596
|
/**
|
|
433
|
-
* ISO-8601 timestamp
|
|
434
|
-
*
|
|
597
|
+
* Future ISO-8601 join timestamp including timezone. Google Meet and Teams accept
|
|
598
|
+
* dates at most three years ahead. Omit for an immediate join. Assistant sessions
|
|
599
|
+
* created through this endpoint must join immediately.
|
|
435
600
|
*/
|
|
436
601
|
join_at?: string;
|
|
602
|
+
/**
|
|
603
|
+
* Automatic departure settings for Google Meet and Teams. Omitted fields use the
|
|
604
|
+
* default behavior. Set at creation; cannot be changed later. Zoom ignores this
|
|
605
|
+
* policy.
|
|
606
|
+
*/
|
|
607
|
+
leave_policy?: MeetingSessionLeavePolicy;
|
|
437
608
|
/**
|
|
438
609
|
* Arbitrary key-value metadata attached to the session. The serialized JSON
|
|
439
610
|
* representation must not exceed 16384 characters at runtime.
|
|
@@ -442,11 +613,28 @@ export interface MeetingSessionCreateParams {
|
|
|
442
613
|
[key: string]: unknown;
|
|
443
614
|
};
|
|
444
615
|
/**
|
|
445
|
-
*
|
|
446
|
-
*
|
|
447
|
-
*
|
|
448
|
-
*
|
|
449
|
-
*
|
|
616
|
+
* Google Meet and Teams only. Defaults to true when recording_export is supplied
|
|
617
|
+
* and false otherwise. True requires recording_export.bucket; false cannot be
|
|
618
|
+
* combined with recording_export. Fixed at creation, with no pause/resume action.
|
|
619
|
+
* Zoom rejects recording, recording_view, and recording_export with 422
|
|
620
|
+
* unsupported_capability; omit these fields for Zoom.
|
|
621
|
+
*/
|
|
622
|
+
recording?: boolean;
|
|
623
|
+
/**
|
|
624
|
+
* Customer-owned Telnyx Storage destination for recording exports. Uses the
|
|
625
|
+
* authenticated organization and user; do not supply credentials, region,
|
|
626
|
+
* organization ID or object key.
|
|
627
|
+
*/
|
|
628
|
+
recording_export?: MeetingSessionRecordingDestination;
|
|
629
|
+
/**
|
|
630
|
+
* Recording layout for Google Meet and Teams. Defaults to speaker_view. Accepted
|
|
631
|
+
* at creation only; does not enable recording by itself.
|
|
632
|
+
*/
|
|
633
|
+
recording_view?: 'speaker_view' | 'gallery_view' | 'speaker_view_no_sidebar';
|
|
634
|
+
/**
|
|
635
|
+
* Text the bot speaks after joining. Available for sessions without a digital
|
|
636
|
+
* avatar. With an AI Assistant, the greeting waits until the assistant is
|
|
637
|
+
* connected. Rejected with 400 invalid_request when assistant.avatar is true.
|
|
450
638
|
*/
|
|
451
639
|
speak_on_enter?: string;
|
|
452
640
|
/**
|
|
@@ -456,7 +644,8 @@ export interface MeetingSessionCreateParams {
|
|
|
456
644
|
/**
|
|
457
645
|
* Session-default voice identifier used for `speak_on_enter` and ordinary speak
|
|
458
646
|
* actions. A voice supplied on an individual speak action overrides this default
|
|
459
|
-
* for that utterance.
|
|
647
|
+
* for that utterance. With an assistant attached, its conversational voice remains
|
|
648
|
+
* configured on the assistant.
|
|
460
649
|
*/
|
|
461
650
|
voice?: string;
|
|
462
651
|
/**
|
|
@@ -468,10 +657,8 @@ export interface MeetingSessionCreateParams {
|
|
|
468
657
|
}
|
|
469
658
|
export declare namespace MeetingSessionCreateParams {
|
|
470
659
|
/**
|
|
471
|
-
* Attach a Telnyx AI Assistant
|
|
472
|
-
*
|
|
473
|
-
* connection, caller ID and loopback SIP URI previously required here have been
|
|
474
|
-
* removed and are now rejected as unknown fields.
|
|
660
|
+
* Attach a Telnyx AI Assistant owned by the authenticated account. Supply its ID
|
|
661
|
+
* and optional conversation settings. Unknown fields are rejected.
|
|
475
662
|
*/
|
|
476
663
|
interface Assistant {
|
|
477
664
|
/**
|
|
@@ -479,12 +666,9 @@ export declare namespace MeetingSessionCreateParams {
|
|
|
479
666
|
*/
|
|
480
667
|
id: string;
|
|
481
668
|
/**
|
|
482
|
-
*
|
|
483
|
-
*
|
|
484
|
-
*
|
|
485
|
-
* `full_duplex` sends a separate stream per participant, which allows barge-in and
|
|
486
|
-
* removes self-hearing, and COSTS SIGNIFICANTLY MORE: per-participant streams
|
|
487
|
-
* multiply the per-minute cost by the number of participants.
|
|
669
|
+
* Use half_duplex (default) to pause listening while the assistant speaks, or
|
|
670
|
+
* full_duplex to allow participants to interrupt. Full-duplex pricing depends on
|
|
671
|
+
* participant audio usage; see the Meeting pricing guide.
|
|
488
672
|
*/
|
|
489
673
|
audio_gate?: 'half_duplex' | 'full_duplex';
|
|
490
674
|
/**
|
|
@@ -492,12 +676,11 @@ export declare namespace MeetingSessionCreateParams {
|
|
|
492
676
|
* [AI Assistant avatars](/docs/inference/ai-assistants/avatars)) as the bot's
|
|
493
677
|
* camera, lip-synced to the assistant's own speech. The request carries no avatar
|
|
494
678
|
* ID or key: the assistant is read at creation and the request is rejected with
|
|
495
|
-
* 400 `invalid_request` if it has no Telnyx avatar configured.
|
|
496
|
-
* Meet, Zoom,
|
|
497
|
-
* `
|
|
498
|
-
*
|
|
499
|
-
*
|
|
500
|
-
* `degraded`.
|
|
679
|
+
* 400 `invalid_request` if it has no Telnyx avatar configured. Available for
|
|
680
|
+
* Google Meet, Zoom, and Teams sessions. REST-only. Not echoed back on
|
|
681
|
+
* `assistant`; the session's top-level `avatar` and `avatar_state` fields report
|
|
682
|
+
* it instead. If the avatar fails, the session continues voice-only and
|
|
683
|
+
* `avatar_state` becomes `degraded`.
|
|
501
684
|
*/
|
|
502
685
|
avatar?: boolean;
|
|
503
686
|
/**
|
|
@@ -508,19 +691,14 @@ export declare namespace MeetingSessionCreateParams {
|
|
|
508
691
|
* conversation. At most 63 entries; keys 1-128 characters; values must be strings.
|
|
509
692
|
* The map is budgeted in aggregate at 1,047,552 bytes (1023 KiB) rather than
|
|
510
693
|
* capped per value. `streaming_audio`, `ai_assistant_streaming_audio` and
|
|
511
|
-
* `meeting_session_id` are reserved and rejected with `400 invalid_request
|
|
512
|
-
* they toggle provider infrastructure or are set by the service rather than fill a
|
|
513
|
-
* prompt template.
|
|
694
|
+
* `meeting_session_id` are reserved and rejected with `400 invalid_request`.
|
|
514
695
|
*/
|
|
515
696
|
dynamic_variables?: {
|
|
516
697
|
[key: string]: string;
|
|
517
698
|
};
|
|
518
699
|
/**
|
|
519
|
-
* Leave
|
|
520
|
-
*
|
|
521
|
-
* after the Assistant stops. Fires once: a second terminal transition does not
|
|
522
|
-
* leave twice, and a leave the provider refuses is logged without changing how the
|
|
523
|
-
* session settles.
|
|
700
|
+
* Leave when the assistant conversation ends or fails. Defaults to false. Other
|
|
701
|
+
* leave-policy rules and explicit leave requests still apply.
|
|
524
702
|
*/
|
|
525
703
|
leave_on_end?: boolean;
|
|
526
704
|
}
|
|
@@ -530,7 +708,7 @@ export declare namespace MeetingSessionCreateParams {
|
|
|
530
708
|
* and the URL-safe alphabet are rejected. The encoded value is limited to
|
|
531
709
|
* 1,835,008 characters and the decoded JPEG to 1,363,148 bytes. The JPEG is
|
|
532
710
|
* limited to 4,096 pixels per dimension, 4 megapixels, and 128 MB of decoder
|
|
533
|
-
* memory. The image bytes are not
|
|
711
|
+
* memory. The image bytes are not returned in the session response.
|
|
534
712
|
*/
|
|
535
713
|
base64_data: string;
|
|
536
714
|
/**
|
|
@@ -550,8 +728,8 @@ export declare namespace MeetingSessionCreateParams {
|
|
|
550
728
|
* Fetching is limited to public network destinations, a five-second timeout, no
|
|
551
729
|
* redirects, a 2xx image/jpeg response with identity or no content encoding, and a
|
|
552
730
|
* 1,363,148-byte limit enforced against both declared and streamed content. The
|
|
553
|
-
* service resolves the URL before bot creation and does not
|
|
554
|
-
*
|
|
731
|
+
* service resolves the URL before bot creation and does not return the URL or
|
|
732
|
+
* image bytes in the session response.
|
|
555
733
|
*/
|
|
556
734
|
url: string;
|
|
557
735
|
}
|
|
@@ -593,7 +771,7 @@ export interface MeetingSessionRetrieveTranscriptParams {
|
|
|
593
771
|
wait_seconds?: number;
|
|
594
772
|
}
|
|
595
773
|
export declare namespace MeetingSessions {
|
|
596
|
-
export { type MeetingSession as MeetingSession, type MeetingSessionResponse as MeetingSessionResponse, type MeetingSessionListResponse as MeetingSessionListResponse, type MeetingSessionDeleteRecordingMediaResponse as MeetingSessionDeleteRecordingMediaResponse, type MeetingSessionRetrieveEventsResponse as MeetingSessionRetrieveEventsResponse, type MeetingSessionRetrieveTranscriptResponse as MeetingSessionRetrieveTranscriptResponse, type MeetingSessionListParams as MeetingSessionListParams, type MeetingSessionCreateParams as MeetingSessionCreateParams, type MeetingSessionUpdateParams as MeetingSessionUpdateParams, type MeetingSessionRetrieveEventsParams as MeetingSessionRetrieveEventsParams, type MeetingSessionRetrieveTranscriptParams as MeetingSessionRetrieveTranscriptParams, };
|
|
774
|
+
export { type MeetingSession as MeetingSession, type MeetingSessionLeavePolicy as MeetingSessionLeavePolicy, type MeetingSessionRecordingDestination as MeetingSessionRecordingDestination, type MeetingSessionRecordingExport as MeetingSessionRecordingExport, type MeetingSessionResponse as MeetingSessionResponse, type MeetingSessionListResponse as MeetingSessionListResponse, type MeetingSessionDeleteRecordingMediaResponse as MeetingSessionDeleteRecordingMediaResponse, type MeetingSessionRetrieveEventsResponse as MeetingSessionRetrieveEventsResponse, type MeetingSessionRetrieveRecordingsResponse as MeetingSessionRetrieveRecordingsResponse, type MeetingSessionRetrieveTranscriptResponse as MeetingSessionRetrieveTranscriptResponse, type MeetingSessionListParams as MeetingSessionListParams, type MeetingSessionCreateParams as MeetingSessionCreateParams, type MeetingSessionUpdateParams as MeetingSessionUpdateParams, type MeetingSessionRetrieveEventsParams as MeetingSessionRetrieveEventsParams, type MeetingSessionRetrieveTranscriptParams as MeetingSessionRetrieveTranscriptParams, };
|
|
597
775
|
export { Actions as Actions, type ActionAcceptedResponse as ActionAcceptedResponse, type ActionSendChatParams as ActionSendChatParams, type ActionSpeakParams as ActionSpeakParams, };
|
|
598
776
|
export { Artifacts as Artifacts, type MeetingSessionArtifact as MeetingSessionArtifact, type MeetingSessionArtifactResponse as MeetingSessionArtifactResponse, type ArtifactListResponse as ArtifactListResponse, type ArtifactCreateParams as ArtifactCreateParams, type ArtifactRetrieveParams as ArtifactRetrieveParams, };
|
|
599
777
|
}
|