telnyx 7.25.0 → 7.27.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 +14 -0
- package/client.d.mts +25 -10
- package/client.d.mts.map +1 -1
- package/client.d.ts +25 -10
- package/client.d.ts.map +1 -1
- package/client.js +15 -0
- package/client.js.map +1 -1
- package/client.mjs +15 -0
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/addresses/addresses.d.mts +22 -2
- package/resources/addresses/addresses.d.mts.map +1 -1
- package/resources/addresses/addresses.d.ts +22 -2
- package/resources/addresses/addresses.d.ts.map +1 -1
- package/resources/addresses/addresses.js +12 -0
- package/resources/addresses/addresses.js.map +1 -1
- package/resources/addresses/addresses.mjs +12 -0
- package/resources/addresses/addresses.mjs.map +1 -1
- package/resources/ai/ai.d.mts +16 -7
- package/resources/ai/ai.d.mts.map +1 -1
- package/resources/ai/ai.d.ts +16 -7
- package/resources/ai/ai.d.ts.map +1 -1
- package/resources/ai/ai.js +4 -0
- package/resources/ai/ai.js.map +1 -1
- package/resources/ai/ai.mjs +4 -0
- package/resources/ai/ai.mjs.map +1 -1
- package/resources/ai/assistants/assistants.d.mts +383 -22
- package/resources/ai/assistants/assistants.d.mts.map +1 -1
- package/resources/ai/assistants/assistants.d.ts +383 -22
- package/resources/ai/assistants/assistants.d.ts.map +1 -1
- package/resources/ai/assistants/assistants.js +4 -1
- package/resources/ai/assistants/assistants.js.map +1 -1
- package/resources/ai/assistants/assistants.mjs +4 -1
- package/resources/ai/assistants/assistants.mjs.map +1 -1
- package/resources/ai/assistants/index.d.mts +1 -1
- package/resources/ai/assistants/index.d.mts.map +1 -1
- package/resources/ai/assistants/index.d.ts +1 -1
- package/resources/ai/assistants/index.d.ts.map +1 -1
- package/resources/ai/assistants/index.js.map +1 -1
- package/resources/ai/assistants/index.mjs.map +1 -1
- package/resources/ai/assistants/versions.d.mts +18 -1
- package/resources/ai/assistants/versions.d.mts.map +1 -1
- package/resources/ai/assistants/versions.d.ts +18 -1
- package/resources/ai/assistants/versions.d.ts.map +1 -1
- package/resources/ai/assistants/versions.js +4 -1
- package/resources/ai/assistants/versions.js.map +1 -1
- package/resources/ai/assistants/versions.mjs +4 -1
- package/resources/ai/assistants/versions.mjs.map +1 -1
- package/resources/ai/audio.d.mts +17 -5
- package/resources/ai/audio.d.mts.map +1 -1
- package/resources/ai/audio.d.ts +17 -5
- package/resources/ai/audio.d.ts.map +1 -1
- package/resources/ai/avatars.d.mts +200 -0
- package/resources/ai/avatars.d.mts.map +1 -0
- package/resources/ai/avatars.d.ts +200 -0
- package/resources/ai/avatars.d.ts.map +1 -0
- package/resources/ai/avatars.js +95 -0
- package/resources/ai/avatars.js.map +1 -0
- package/resources/ai/avatars.mjs +91 -0
- package/resources/ai/avatars.mjs.map +1 -0
- package/resources/ai/chat.d.mts +20 -6
- package/resources/ai/chat.d.mts.map +1 -1
- package/resources/ai/chat.d.ts +20 -6
- package/resources/ai/chat.d.ts.map +1 -1
- package/resources/ai/conversations/conversations.d.mts +8 -0
- package/resources/ai/conversations/conversations.d.mts.map +1 -1
- package/resources/ai/conversations/conversations.d.ts +8 -0
- package/resources/ai/conversations/conversations.d.ts.map +1 -1
- package/resources/ai/conversations/conversations.js.map +1 -1
- package/resources/ai/conversations/conversations.mjs.map +1 -1
- package/resources/ai/index.d.mts +3 -2
- package/resources/ai/index.d.mts.map +1 -1
- package/resources/ai/index.d.ts +3 -2
- package/resources/ai/index.d.ts.map +1 -1
- package/resources/ai/index.js +3 -1
- package/resources/ai/index.js.map +1 -1
- package/resources/ai/index.mjs +1 -0
- package/resources/ai/index.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 +54 -1
- package/resources/ai/memory/namespaces/profiles/profiles.d.mts.map +1 -1
- package/resources/ai/memory/namespaces/profiles/profiles.d.ts +54 -1
- package/resources/ai/memory/namespaces/profiles/profiles.d.ts.map +1 -1
- package/resources/ai/memory/namespaces/profiles/profiles.js +31 -0
- package/resources/ai/memory/namespaces/profiles/profiles.js.map +1 -1
- package/resources/ai/memory/namespaces/profiles/profiles.mjs +31 -0
- package/resources/ai/memory/namespaces/profiles/profiles.mjs.map +1 -1
- package/resources/ai/openai/chat.d.mts +20 -6
- package/resources/ai/openai/chat.d.mts.map +1 -1
- package/resources/ai/openai/chat.d.ts +20 -6
- package/resources/ai/openai/chat.d.ts.map +1 -1
- package/resources/ai/tools.d.mts +30 -2
- package/resources/ai/tools.d.mts.map +1 -1
- package/resources/ai/tools.d.ts +30 -2
- package/resources/ai/tools.d.ts.map +1 -1
- package/resources/calls/actions.d.mts +260 -25
- package/resources/calls/actions.d.mts.map +1 -1
- package/resources/calls/actions.d.ts +260 -25
- package/resources/calls/actions.d.ts.map +1 -1
- package/resources/calls/calls.d.mts +24 -14
- package/resources/calls/calls.d.mts.map +1 -1
- package/resources/calls/calls.d.ts +24 -14
- package/resources/calls/calls.d.ts.map +1 -1
- package/resources/calls/calls.js +8 -0
- package/resources/calls/calls.js.map +1 -1
- package/resources/calls/calls.mjs +8 -0
- 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/credential-connections/credential-connections.d.mts +38 -8
- package/resources/credential-connections/credential-connections.d.mts.map +1 -1
- package/resources/credential-connections/credential-connections.d.ts +38 -8
- package/resources/credential-connections/credential-connections.d.ts.map +1 -1
- package/resources/credential-connections/credential-connections.js.map +1 -1
- package/resources/credential-connections/credential-connections.mjs.map +1 -1
- package/resources/dial-metrics.d.mts +151 -0
- package/resources/dial-metrics.d.mts.map +1 -0
- package/resources/dial-metrics.d.ts +151 -0
- package/resources/dial-metrics.d.ts.map +1 -0
- package/resources/dial-metrics.js +44 -0
- package/resources/dial-metrics.js.map +1 -0
- package/resources/dial-metrics.mjs +40 -0
- package/resources/dial-metrics.mjs.map +1 -0
- package/resources/dir/dir.d.mts +11 -9
- package/resources/dir/dir.d.mts.map +1 -1
- package/resources/dir/dir.d.ts +11 -9
- package/resources/dir/dir.d.ts.map +1 -1
- package/resources/dir/dir.js +1 -2
- package/resources/dir/dir.js.map +1 -1
- package/resources/dir/dir.mjs +1 -2
- package/resources/dir/dir.mjs.map +1 -1
- package/resources/dir/phone-numbers.d.mts +0 -4
- package/resources/dir/phone-numbers.d.mts.map +1 -1
- package/resources/dir/phone-numbers.d.ts +0 -4
- package/resources/dir/phone-numbers.d.ts.map +1 -1
- package/resources/dir/references.d.mts +15 -9
- package/resources/dir/references.d.mts.map +1 -1
- package/resources/dir/references.d.ts +15 -9
- package/resources/dir/references.d.ts.map +1 -1
- package/resources/dir/references.js +15 -9
- package/resources/dir/references.js.map +1 -1
- package/resources/dir/references.mjs +15 -9
- package/resources/dir/references.mjs.map +1 -1
- package/resources/dir/verify-email.d.mts +17 -5
- package/resources/dir/verify-email.d.mts.map +1 -1
- package/resources/dir/verify-email.d.ts +17 -5
- package/resources/dir/verify-email.d.ts.map +1 -1
- package/resources/dir/verify-email.js +17 -5
- package/resources/dir/verify-email.js.map +1 -1
- package/resources/dir/verify-email.mjs +17 -5
- package/resources/dir/verify-email.mjs.map +1 -1
- package/resources/email-domains/email-domains.d.mts +1 -1
- package/resources/email-domains/email-domains.d.mts.map +1 -1
- package/resources/email-domains/email-domains.d.ts +1 -1
- package/resources/email-domains/email-domains.d.ts.map +1 -1
- package/resources/email-templates.d.mts +109 -18
- package/resources/email-templates.d.mts.map +1 -1
- package/resources/email-templates.d.ts +109 -18
- package/resources/email-templates.d.ts.map +1 -1
- package/resources/email-templates.js +5 -1
- package/resources/email-templates.js.map +1 -1
- package/resources/email-templates.mjs +5 -1
- package/resources/email-templates.mjs.map +1 -1
- package/resources/enterprises/dir.d.mts +8 -2
- package/resources/enterprises/dir.d.mts.map +1 -1
- package/resources/enterprises/dir.d.ts +8 -2
- package/resources/enterprises/dir.d.ts.map +1 -1
- package/resources/enterprises/dir.js +8 -2
- package/resources/enterprises/dir.js.map +1 -1
- package/resources/enterprises/dir.mjs +8 -2
- package/resources/enterprises/dir.mjs.map +1 -1
- package/resources/enterprises/enterprises.d.mts +7 -5
- package/resources/enterprises/enterprises.d.mts.map +1 -1
- package/resources/enterprises/enterprises.d.ts +7 -5
- package/resources/enterprises/enterprises.d.ts.map +1 -1
- package/resources/enterprises/enterprises.js +5 -3
- package/resources/enterprises/enterprises.js.map +1 -1
- package/resources/enterprises/enterprises.mjs +5 -3
- package/resources/enterprises/enterprises.mjs.map +1 -1
- package/resources/enterprises/index.d.mts +1 -1
- package/resources/enterprises/index.d.mts.map +1 -1
- package/resources/enterprises/index.d.ts +1 -1
- package/resources/enterprises/index.d.ts.map +1 -1
- package/resources/enterprises/index.js.map +1 -1
- package/resources/enterprises/index.mjs.map +1 -1
- package/resources/enterprises/reputation/external-verification.d.mts +94 -0
- package/resources/enterprises/reputation/external-verification.d.mts.map +1 -0
- package/resources/enterprises/reputation/external-verification.d.ts +94 -0
- package/resources/enterprises/reputation/external-verification.d.ts.map +1 -0
- package/resources/enterprises/reputation/external-verification.js +54 -0
- package/resources/enterprises/reputation/external-verification.js.map +1 -0
- package/resources/enterprises/reputation/external-verification.mjs +50 -0
- package/resources/enterprises/reputation/external-verification.mjs.map +1 -0
- package/resources/enterprises/reputation/index.d.mts +3 -2
- package/resources/enterprises/reputation/index.d.mts.map +1 -1
- package/resources/enterprises/reputation/index.d.ts +3 -2
- package/resources/enterprises/reputation/index.d.ts.map +1 -1
- package/resources/enterprises/reputation/index.js +3 -1
- package/resources/enterprises/reputation/index.js.map +1 -1
- package/resources/enterprises/reputation/index.mjs +1 -0
- package/resources/enterprises/reputation/index.mjs.map +1 -1
- package/resources/enterprises/reputation/loa.d.mts +3 -2
- package/resources/enterprises/reputation/loa.d.mts.map +1 -1
- package/resources/enterprises/reputation/loa.d.ts +3 -2
- package/resources/enterprises/reputation/loa.d.ts.map +1 -1
- package/resources/enterprises/reputation/numbers.d.mts +197 -4
- package/resources/enterprises/reputation/numbers.d.mts.map +1 -1
- package/resources/enterprises/reputation/numbers.d.ts +197 -4
- package/resources/enterprises/reputation/numbers.d.ts.map +1 -1
- package/resources/enterprises/reputation/numbers.js +58 -2
- package/resources/enterprises/reputation/numbers.js.map +1 -1
- package/resources/enterprises/reputation/numbers.mjs +58 -2
- package/resources/enterprises/reputation/numbers.mjs.map +1 -1
- package/resources/enterprises/reputation/remediation.d.mts +3 -2
- package/resources/enterprises/reputation/remediation.d.mts.map +1 -1
- package/resources/enterprises/reputation/remediation.d.ts +3 -2
- package/resources/enterprises/reputation/remediation.d.ts.map +1 -1
- package/resources/enterprises/reputation/reputation.d.mts +39 -3
- package/resources/enterprises/reputation/reputation.d.mts.map +1 -1
- package/resources/enterprises/reputation/reputation.d.ts +39 -3
- package/resources/enterprises/reputation/reputation.d.ts.map +1 -1
- package/resources/enterprises/reputation/reputation.js +22 -0
- package/resources/enterprises/reputation/reputation.js.map +1 -1
- package/resources/enterprises/reputation/reputation.mjs +22 -0
- package/resources/enterprises/reputation/reputation.mjs.map +1 -1
- package/resources/enterprises/verify-email.d.mts +1 -1
- package/resources/enterprises/verify-email.d.ts +1 -1
- package/resources/enterprises/verify-email.js +1 -1
- package/resources/enterprises/verify-email.mjs +1 -1
- package/resources/fqdn-connections/fqdn-connections.d.mts +38 -8
- package/resources/fqdn-connections/fqdn-connections.d.mts.map +1 -1
- package/resources/fqdn-connections/fqdn-connections.d.ts +38 -8
- package/resources/fqdn-connections/fqdn-connections.d.ts.map +1 -1
- package/resources/fqdn-connections/fqdn-connections.js.map +1 -1
- package/resources/fqdn-connections/fqdn-connections.mjs.map +1 -1
- package/resources/global-ip-assignment-health.d.mts +4 -4
- package/resources/global-ip-assignment-health.d.mts.map +1 -1
- package/resources/global-ip-assignment-health.d.ts +4 -4
- package/resources/global-ip-assignment-health.d.ts.map +1 -1
- package/resources/global-ip-assignments-usage.d.mts +4 -4
- package/resources/global-ip-assignments-usage.d.mts.map +1 -1
- package/resources/global-ip-assignments-usage.d.ts +4 -4
- package/resources/global-ip-assignments-usage.d.ts.map +1 -1
- package/resources/index.d.mts +8 -5
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +8 -5
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +10 -4
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +3 -0
- package/resources/index.mjs.map +1 -1
- package/resources/ip-connections.d.mts +36 -6
- package/resources/ip-connections.d.mts.map +1 -1
- package/resources/ip-connections.d.ts +36 -6
- package/resources/ip-connections.d.ts.map +1 -1
- package/resources/llm-token-gateway/index.d.mts +4 -1
- package/resources/llm-token-gateway/index.d.mts.map +1 -1
- package/resources/llm-token-gateway/index.d.ts +4 -1
- package/resources/llm-token-gateway/index.d.ts.map +1 -1
- package/resources/llm-token-gateway/index.js +7 -1
- package/resources/llm-token-gateway/index.js.map +1 -1
- package/resources/llm-token-gateway/index.mjs +4 -1
- package/resources/llm-token-gateway/index.mjs.map +1 -1
- package/resources/llm-token-gateway/llm-token-gateway.d.mts +14 -2
- package/resources/llm-token-gateway/llm-token-gateway.d.mts.map +1 -1
- package/resources/llm-token-gateway/llm-token-gateway.d.ts +14 -2
- package/resources/llm-token-gateway/llm-token-gateway.d.ts.map +1 -1
- package/resources/llm-token-gateway/llm-token-gateway.js +12 -0
- package/resources/llm-token-gateway/llm-token-gateway.js.map +1 -1
- package/resources/llm-token-gateway/llm-token-gateway.mjs +13 -1
- package/resources/llm-token-gateway/llm-token-gateway.mjs.map +1 -1
- package/resources/llm-token-gateway/spend.d.mts +223 -0
- package/resources/llm-token-gateway/spend.d.mts.map +1 -0
- package/resources/llm-token-gateway/spend.d.ts +223 -0
- package/resources/llm-token-gateway/spend.d.ts.map +1 -0
- package/resources/llm-token-gateway/spend.js +56 -0
- package/resources/llm-token-gateway/spend.js.map +1 -0
- package/resources/llm-token-gateway/spend.mjs +52 -0
- package/resources/llm-token-gateway/spend.mjs.map +1 -0
- package/resources/llm-token-gateway/token-groups.d.mts +577 -0
- package/resources/llm-token-gateway/token-groups.d.mts.map +1 -0
- package/resources/llm-token-gateway/token-groups.d.ts +577 -0
- package/resources/llm-token-gateway/token-groups.d.ts.map +1 -0
- package/resources/llm-token-gateway/token-groups.js +139 -0
- package/resources/llm-token-gateway/token-groups.js.map +1 -0
- package/resources/llm-token-gateway/token-groups.mjs +135 -0
- package/resources/llm-token-gateway/token-groups.mjs.map +1 -0
- package/resources/llm-token-gateway/token-keys.d.mts +318 -0
- package/resources/llm-token-gateway/token-keys.d.mts.map +1 -0
- package/resources/llm-token-gateway/token-keys.d.ts +318 -0
- package/resources/llm-token-gateway/token-keys.d.ts.map +1 -0
- package/resources/llm-token-gateway/token-keys.js +127 -0
- package/resources/llm-token-gateway/token-keys.js.map +1 -0
- package/resources/llm-token-gateway/token-keys.mjs +123 -0
- package/resources/llm-token-gateway/token-keys.mjs.map +1 -0
- package/resources/llm-token-gateway/usage.d.mts +205 -146
- package/resources/llm-token-gateway/usage.d.mts.map +1 -1
- package/resources/llm-token-gateway/usage.d.ts +205 -146
- package/resources/llm-token-gateway/usage.d.ts.map +1 -1
- package/resources/llm-token-gateway/usage.js +47 -15
- package/resources/llm-token-gateway/usage.js.map +1 -1
- package/resources/llm-token-gateway/usage.mjs +47 -15
- package/resources/llm-token-gateway/usage.mjs.map +1 -1
- package/resources/meeting-sessions/actions.d.mts +13 -7
- package/resources/meeting-sessions/actions.d.mts.map +1 -1
- package/resources/meeting-sessions/actions.d.ts +13 -7
- package/resources/meeting-sessions/actions.d.ts.map +1 -1
- package/resources/meeting-sessions/actions.js +13 -7
- package/resources/meeting-sessions/actions.js.map +1 -1
- package/resources/meeting-sessions/actions.mjs +13 -7
- package/resources/meeting-sessions/actions.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 +46 -65
- package/resources/meeting-sessions/meeting-sessions.d.mts.map +1 -1
- package/resources/meeting-sessions/meeting-sessions.d.ts +46 -65
- package/resources/meeting-sessions/meeting-sessions.d.ts.map +1 -1
- package/resources/meeting-sessions/meeting-sessions.js +14 -23
- package/resources/meeting-sessions/meeting-sessions.js.map +1 -1
- package/resources/meeting-sessions/meeting-sessions.mjs +14 -23
- package/resources/meeting-sessions/meeting-sessions.mjs.map +1 -1
- package/resources/messages/messages.d.mts +581 -118
- package/resources/messages/messages.d.mts.map +1 -1
- package/resources/messages/messages.d.ts +581 -118
- package/resources/messages/messages.d.ts.map +1 -1
- package/resources/messages/messages.js +71 -14
- package/resources/messages/messages.js.map +1 -1
- package/resources/messages/messages.mjs +71 -14
- package/resources/messages/messages.mjs.map +1 -1
- package/resources/messages/rcs.d.mts +26 -6
- package/resources/messages/rcs.d.mts.map +1 -1
- package/resources/messages/rcs.d.ts +26 -6
- package/resources/messages/rcs.d.ts.map +1 -1
- package/resources/messages/rcs.js +11 -2
- package/resources/messages/rcs.js.map +1 -1
- package/resources/messages/rcs.mjs +11 -2
- package/resources/messages/rcs.mjs.map +1 -1
- package/resources/phone-numbers/csv-downloads.d.mts +9 -0
- package/resources/phone-numbers/csv-downloads.d.mts.map +1 -1
- package/resources/phone-numbers/csv-downloads.d.ts +9 -0
- package/resources/phone-numbers/csv-downloads.d.ts.map +1 -1
- package/resources/phone-numbers/csv-downloads.js +5 -2
- package/resources/phone-numbers/csv-downloads.js.map +1 -1
- package/resources/phone-numbers/csv-downloads.mjs +5 -2
- package/resources/phone-numbers/csv-downloads.mjs.map +1 -1
- package/resources/phone-numbers/index.d.mts +2 -2
- package/resources/phone-numbers/index.d.mts.map +1 -1
- package/resources/phone-numbers/index.d.ts +2 -2
- package/resources/phone-numbers/index.d.ts.map +1 -1
- package/resources/phone-numbers/index.js.map +1 -1
- package/resources/phone-numbers/index.mjs.map +1 -1
- package/resources/phone-numbers/jobs.d.mts +277 -14
- package/resources/phone-numbers/jobs.d.mts.map +1 -1
- package/resources/phone-numbers/jobs.d.ts +277 -14
- package/resources/phone-numbers/jobs.d.ts.map +1 -1
- package/resources/phone-numbers/jobs.js +5 -4
- package/resources/phone-numbers/jobs.js.map +1 -1
- package/resources/phone-numbers/jobs.mjs +5 -4
- package/resources/phone-numbers/jobs.mjs.map +1 -1
- package/resources/phone-numbers/phone-numbers.d.mts +28 -3
- package/resources/phone-numbers/phone-numbers.d.mts.map +1 -1
- package/resources/phone-numbers/phone-numbers.d.ts +28 -3
- package/resources/phone-numbers/phone-numbers.d.ts.map +1 -1
- package/resources/phone-numbers/phone-numbers.js.map +1 -1
- package/resources/phone-numbers/phone-numbers.mjs.map +1 -1
- package/resources/porting-orders/phone-number-blocks.d.mts +1 -1
- package/resources/porting-orders/phone-number-blocks.d.mts.map +1 -1
- package/resources/porting-orders/phone-number-blocks.d.ts +1 -1
- package/resources/porting-orders/phone-number-blocks.d.ts.map +1 -1
- package/resources/porting-orders/porting-orders.d.mts +1 -1
- package/resources/porting-orders/porting-orders.d.mts.map +1 -1
- package/resources/porting-orders/porting-orders.d.ts +1 -1
- package/resources/porting-orders/porting-orders.d.ts.map +1 -1
- package/resources/porting-orders/porting-orders.js.map +1 -1
- package/resources/porting-orders/porting-orders.mjs.map +1 -1
- package/resources/porting-phone-numbers.d.mts +1 -1
- package/resources/porting-phone-numbers.d.mts.map +1 -1
- package/resources/porting-phone-numbers.d.ts +1 -1
- package/resources/porting-phone-numbers.d.ts.map +1 -1
- package/resources/reputation/numbers.d.mts +10 -0
- package/resources/reputation/numbers.d.mts.map +1 -1
- package/resources/reputation/numbers.d.ts +10 -0
- package/resources/reputation/numbers.d.ts.map +1 -1
- package/resources/shared.d.mts +4 -0
- package/resources/shared.d.mts.map +1 -1
- package/resources/shared.d.ts +4 -0
- package/resources/shared.d.ts.map +1 -1
- package/resources/sip-registration-status.d.mts +149 -0
- package/resources/sip-registration-status.d.mts.map +1 -0
- package/resources/sip-registration-status.d.ts +149 -0
- package/resources/sip-registration-status.d.ts.map +1 -0
- package/resources/sip-registration-status.js +32 -0
- package/resources/sip-registration-status.js.map +1 -0
- package/resources/sip-registration-status.mjs +28 -0
- package/resources/sip-registration-status.mjs.map +1 -0
- package/resources/speech-to-text/speech-to-text.d.mts +12 -5
- package/resources/speech-to-text/speech-to-text.d.mts.map +1 -1
- package/resources/speech-to-text/speech-to-text.d.ts +12 -5
- package/resources/speech-to-text/speech-to-text.d.ts.map +1 -1
- package/resources/telephony-credentials.d.mts +11 -2
- package/resources/telephony-credentials.d.mts.map +1 -1
- package/resources/telephony-credentials.d.ts +11 -2
- package/resources/telephony-credentials.d.ts.map +1 -1
- package/resources/telephony-credentials.js +9 -2
- package/resources/telephony-credentials.js.map +1 -1
- package/resources/telephony-credentials.mjs +9 -2
- package/resources/telephony-credentials.mjs.map +1 -1
- package/resources/texml/accounts/accounts.d.mts +2 -2
- package/resources/texml/accounts/accounts.d.ts +2 -2
- package/resources/texml/accounts/accounts.js +2 -2
- package/resources/texml/accounts/accounts.mjs +2 -2
- package/resources/texml/accounts/calls/calls.d.mts +49 -14
- package/resources/texml/accounts/calls/calls.d.mts.map +1 -1
- package/resources/texml/accounts/calls/calls.d.ts +49 -14
- package/resources/texml/accounts/calls/calls.d.ts.map +1 -1
- package/resources/texml/accounts/calls/calls.js +7 -7
- package/resources/texml/accounts/calls/calls.js.map +1 -1
- package/resources/texml/accounts/calls/calls.mjs +7 -7
- package/resources/texml/accounts/calls/calls.mjs.map +1 -1
- package/resources/texml/accounts/calls/recordings-json.d.mts +14 -4
- package/resources/texml/accounts/calls/recordings-json.d.mts.map +1 -1
- package/resources/texml/accounts/calls/recordings-json.d.ts +14 -4
- package/resources/texml/accounts/calls/recordings-json.d.ts.map +1 -1
- package/resources/texml/accounts/calls/recordings-json.js +2 -2
- package/resources/texml/accounts/calls/recordings-json.mjs +2 -2
- package/resources/texml/accounts/calls/recordings.d.mts +10 -2
- package/resources/texml/accounts/calls/recordings.d.mts.map +1 -1
- package/resources/texml/accounts/calls/recordings.d.ts +10 -2
- package/resources/texml/accounts/calls/recordings.d.ts.map +1 -1
- package/resources/texml/accounts/calls/recordings.js +4 -1
- package/resources/texml/accounts/calls/recordings.js.map +1 -1
- package/resources/texml/accounts/calls/recordings.mjs +4 -1
- package/resources/texml/accounts/calls/recordings.mjs.map +1 -1
- package/resources/texml/accounts/calls/siprec.d.mts +10 -2
- package/resources/texml/accounts/calls/siprec.d.mts.map +1 -1
- package/resources/texml/accounts/calls/siprec.d.ts +10 -2
- package/resources/texml/accounts/calls/siprec.d.ts.map +1 -1
- package/resources/texml/accounts/calls/siprec.js +4 -1
- package/resources/texml/accounts/calls/siprec.js.map +1 -1
- package/resources/texml/accounts/calls/siprec.mjs +4 -1
- package/resources/texml/accounts/calls/siprec.mjs.map +1 -1
- package/resources/texml/accounts/calls/streams.d.mts +10 -2
- package/resources/texml/accounts/calls/streams.d.mts.map +1 -1
- package/resources/texml/accounts/calls/streams.d.ts +10 -2
- package/resources/texml/accounts/calls/streams.d.ts.map +1 -1
- package/resources/texml/accounts/calls/streams.js +4 -1
- package/resources/texml/accounts/calls/streams.js.map +1 -1
- package/resources/texml/accounts/calls/streams.mjs +4 -1
- package/resources/texml/accounts/calls/streams.mjs.map +1 -1
- package/resources/texml/accounts/conferences/conferences.d.mts +29 -9
- package/resources/texml/accounts/conferences/conferences.d.mts.map +1 -1
- package/resources/texml/accounts/conferences/conferences.d.ts +29 -9
- package/resources/texml/accounts/conferences/conferences.d.ts.map +1 -1
- package/resources/texml/accounts/conferences/conferences.js +5 -5
- package/resources/texml/accounts/conferences/conferences.js.map +1 -1
- package/resources/texml/accounts/conferences/conferences.mjs +5 -5
- package/resources/texml/accounts/conferences/conferences.mjs.map +1 -1
- package/resources/texml/accounts/conferences/participants.d.mts +35 -10
- package/resources/texml/accounts/conferences/participants.d.mts.map +1 -1
- package/resources/texml/accounts/conferences/participants.d.ts +35 -10
- package/resources/texml/accounts/conferences/participants.d.ts.map +1 -1
- package/resources/texml/accounts/conferences/participants.js +5 -5
- package/resources/texml/accounts/conferences/participants.mjs +5 -5
- package/resources/texml/accounts/queues.d.mts +25 -8
- package/resources/texml/accounts/queues.d.mts.map +1 -1
- package/resources/texml/accounts/queues.d.ts +25 -8
- package/resources/texml/accounts/queues.d.ts.map +1 -1
- package/resources/texml/accounts/queues.js +7 -5
- package/resources/texml/accounts/queues.js.map +1 -1
- package/resources/texml/accounts/queues.mjs +7 -5
- package/resources/texml/accounts/queues.mjs.map +1 -1
- package/resources/texml/accounts/recordings/json.d.mts +14 -4
- package/resources/texml/accounts/recordings/json.d.mts.map +1 -1
- package/resources/texml/accounts/recordings/json.d.ts +14 -4
- package/resources/texml/accounts/recordings/json.d.ts.map +1 -1
- package/resources/texml/accounts/recordings/json.js +2 -2
- package/resources/texml/accounts/recordings/json.mjs +2 -2
- package/resources/texml/accounts/transcriptions/json.d.mts +14 -4
- package/resources/texml/accounts/transcriptions/json.d.mts.map +1 -1
- package/resources/texml/accounts/transcriptions/json.d.ts +14 -4
- package/resources/texml/accounts/transcriptions/json.d.ts.map +1 -1
- package/resources/texml/accounts/transcriptions/json.js +2 -2
- package/resources/texml/accounts/transcriptions/json.mjs +2 -2
- package/resources/texml/texml.d.mts +7 -3
- package/resources/texml/texml.d.mts.map +1 -1
- package/resources/texml/texml.d.ts +7 -3
- package/resources/texml/texml.d.ts.map +1 -1
- package/resources/texml/texml.js +4 -2
- package/resources/texml/texml.js.map +1 -1
- package/resources/texml/texml.mjs +4 -2
- package/resources/texml/texml.mjs.map +1 -1
- package/resources/text-to-speech/text-to-speech.d.mts +15 -6
- package/resources/text-to-speech/text-to-speech.d.mts.map +1 -1
- package/resources/text-to-speech/text-to-speech.d.ts +15 -6
- package/resources/text-to-speech/text-to-speech.d.ts.map +1 -1
- package/resources/tts-integrations/actions.d.mts +4 -0
- package/resources/tts-integrations/actions.d.mts.map +1 -0
- package/resources/tts-integrations/actions.d.ts +4 -0
- package/resources/tts-integrations/actions.d.ts.map +1 -0
- package/resources/tts-integrations/actions.js +9 -0
- package/resources/tts-integrations/actions.js.map +1 -0
- package/resources/tts-integrations/actions.mjs +5 -0
- package/resources/tts-integrations/actions.mjs.map +1 -0
- package/resources/tts-integrations/index.d.mts +3 -0
- package/resources/tts-integrations/index.d.mts.map +1 -0
- package/resources/tts-integrations/index.d.ts +3 -0
- package/resources/tts-integrations/index.d.ts.map +1 -0
- package/resources/tts-integrations/index.js +9 -0
- package/resources/tts-integrations/index.js.map +1 -0
- package/resources/tts-integrations/index.mjs +4 -0
- package/resources/tts-integrations/index.mjs.map +1 -0
- package/resources/tts-integrations/tts-integrations.d.mts +10 -0
- package/resources/tts-integrations/tts-integrations.d.mts.map +1 -0
- package/resources/tts-integrations/tts-integrations.d.ts +10 -0
- package/resources/tts-integrations/tts-integrations.d.ts.map +1 -0
- package/resources/tts-integrations/tts-integrations.js +17 -0
- package/resources/tts-integrations/tts-integrations.js.map +1 -0
- package/resources/tts-integrations/tts-integrations.mjs +12 -0
- package/resources/tts-integrations/tts-integrations.mjs.map +1 -0
- package/resources/tts-integrations.d.mts +2 -0
- package/resources/tts-integrations.d.mts.map +1 -0
- package/resources/tts-integrations.d.ts +2 -0
- package/resources/tts-integrations.d.ts.map +1 -0
- package/resources/tts-integrations.js +6 -0
- package/resources/tts-integrations.js.map +1 -0
- package/resources/tts-integrations.mjs +3 -0
- package/resources/tts-integrations.mjs.map +1 -0
- package/resources/uac-connections/uac-connections.d.mts +36 -6
- package/resources/uac-connections/uac-connections.d.mts.map +1 -1
- package/resources/uac-connections/uac-connections.d.ts +36 -6
- package/resources/uac-connections/uac-connections.d.ts.map +1 -1
- package/resources/uac-connections/uac-connections.js.map +1 -1
- package/resources/uac-connections/uac-connections.mjs.map +1 -1
- package/resources/voice-clones.d.mts +57 -10
- package/resources/voice-clones.d.mts.map +1 -1
- package/resources/voice-clones.d.ts +57 -10
- package/resources/voice-clones.d.ts.map +1 -1
- package/resources/voice-clones.js +6 -4
- package/resources/voice-clones.js.map +1 -1
- package/resources/voice-clones.mjs +6 -4
- package/resources/voice-clones.mjs.map +1 -1
- package/resources/webhooks.d.mts +986 -71
- package/resources/webhooks.d.mts.map +1 -1
- package/resources/webhooks.d.ts +986 -71
- package/resources/webhooks.d.ts.map +1 -1
- package/resources/webhooks.js.map +1 -1
- package/resources/webhooks.mjs.map +1 -1
- package/resources/whatsapp/hosted-signups.d.mts +165 -0
- package/resources/whatsapp/hosted-signups.d.mts.map +1 -0
- package/resources/whatsapp/hosted-signups.d.ts +165 -0
- package/resources/whatsapp/hosted-signups.d.ts.map +1 -0
- package/resources/whatsapp/hosted-signups.js +56 -0
- package/resources/whatsapp/hosted-signups.js.map +1 -0
- package/resources/whatsapp/hosted-signups.mjs +52 -0
- package/resources/whatsapp/hosted-signups.mjs.map +1 -0
- package/resources/whatsapp/index.d.mts +2 -0
- package/resources/whatsapp/index.d.mts.map +1 -1
- package/resources/whatsapp/index.d.ts +2 -0
- package/resources/whatsapp/index.d.ts.map +1 -1
- package/resources/whatsapp/index.js +5 -1
- package/resources/whatsapp/index.js.map +1 -1
- package/resources/whatsapp/index.mjs +2 -0
- package/resources/whatsapp/index.mjs.map +1 -1
- package/resources/whatsapp/phone-numbers/calling-routing.d.mts +6 -5
- package/resources/whatsapp/phone-numbers/calling-routing.d.mts.map +1 -1
- package/resources/whatsapp/phone-numbers/calling-routing.d.ts +6 -5
- package/resources/whatsapp/phone-numbers/calling-routing.d.ts.map +1 -1
- package/resources/whatsapp/phone-numbers/calling-routing.js +6 -5
- package/resources/whatsapp/phone-numbers/calling-routing.js.map +1 -1
- package/resources/whatsapp/phone-numbers/calling-routing.mjs +6 -5
- package/resources/whatsapp/phone-numbers/calling-routing.mjs.map +1 -1
- package/resources/whatsapp/signup.d.mts +128 -0
- package/resources/whatsapp/signup.d.mts.map +1 -0
- package/resources/whatsapp/signup.d.ts +128 -0
- package/resources/whatsapp/signup.d.ts.map +1 -0
- package/resources/whatsapp/signup.js +42 -0
- package/resources/whatsapp/signup.js.map +1 -0
- package/resources/whatsapp/signup.mjs +38 -0
- package/resources/whatsapp/signup.mjs.map +1 -0
- package/resources/whatsapp/whatsapp.d.mts +8 -0
- package/resources/whatsapp/whatsapp.d.mts.map +1 -1
- package/resources/whatsapp/whatsapp.d.ts +8 -0
- package/resources/whatsapp/whatsapp.d.ts.map +1 -1
- package/resources/whatsapp/whatsapp.js +8 -0
- package/resources/whatsapp/whatsapp.js.map +1 -1
- package/resources/whatsapp/whatsapp.mjs +8 -0
- package/resources/whatsapp/whatsapp.mjs.map +1 -1
- package/src/client.ts +57 -4
- package/src/resources/addresses/addresses.ts +22 -2
- package/src/resources/ai/ai.ts +40 -3
- package/src/resources/ai/assistants/assistants.ts +455 -20
- package/src/resources/ai/assistants/index.ts +2 -0
- package/src/resources/ai/assistants/versions.ts +20 -1
- package/src/resources/ai/audio.ts +18 -5
- package/src/resources/ai/avatars.ts +252 -0
- package/src/resources/ai/chat.ts +20 -6
- package/src/resources/ai/conversations/conversations.ts +9 -0
- package/src/resources/ai/index.ts +14 -0
- package/src/resources/ai/memory/namespaces/index.ts +2 -0
- package/src/resources/ai/memory/namespaces/namespaces.ts +4 -0
- package/src/resources/ai/memory/namespaces/profiles/index.ts +2 -0
- package/src/resources/ai/memory/namespaces/profiles/profiles.ts +71 -0
- package/src/resources/ai/openai/chat.ts +20 -6
- package/src/resources/ai/tools.ts +35 -1
- package/src/resources/calls/actions.ts +346 -20
- package/src/resources/calls/calls.ts +26 -8
- package/src/resources/calls/index.ts +2 -0
- package/src/resources/credential-connections/credential-connections.ts +41 -8
- package/src/resources/dial-metrics.ts +185 -0
- package/src/resources/dir/dir.ts +13 -8
- package/src/resources/dir/phone-numbers.ts +1 -6
- package/src/resources/dir/references.ts +15 -9
- package/src/resources/dir/verify-email.ts +17 -5
- package/src/resources/email-domains/email-domains.ts +1 -1
- package/src/resources/email-templates.ts +121 -19
- package/src/resources/enterprises/dir.ts +8 -2
- package/src/resources/enterprises/enterprises.ts +7 -3
- package/src/resources/enterprises/index.ts +1 -0
- package/src/resources/enterprises/reputation/external-verification.ts +125 -0
- package/src/resources/enterprises/reputation/index.ts +12 -0
- package/src/resources/enterprises/reputation/loa.ts +3 -2
- package/src/resources/enterprises/reputation/numbers.ts +256 -3
- package/src/resources/enterprises/reputation/remediation.ts +3 -2
- package/src/resources/enterprises/reputation/reputation.ts +70 -0
- package/src/resources/enterprises/verify-email.ts +1 -1
- package/src/resources/fqdn-connections/fqdn-connections.ts +41 -8
- package/src/resources/global-ip-assignment-health.ts +4 -4
- package/src/resources/global-ip-assignments-usage.ts +4 -4
- package/src/resources/index.ts +21 -2
- package/src/resources/ip-connections.ts +39 -6
- package/src/resources/llm-token-gateway/index.ts +38 -1
- package/src/resources/llm-token-gateway/llm-token-gateway.ts +83 -1
- package/src/resources/llm-token-gateway/spend.ts +309 -0
- package/src/resources/llm-token-gateway/token-groups.ts +724 -0
- package/src/resources/llm-token-gateway/token-keys.ts +422 -0
- package/src/resources/llm-token-gateway/usage.ts +273 -149
- package/src/resources/meeting-sessions/actions.ts +13 -7
- package/src/resources/meeting-sessions/index.ts +0 -1
- package/src/resources/meeting-sessions/meeting-sessions.ts +48 -79
- package/src/resources/messages/messages.ts +786 -125
- package/src/resources/messages/rcs.ts +37 -7
- package/src/resources/phone-numbers/csv-downloads.ts +15 -2
- package/src/resources/phone-numbers/index.ts +3 -1
- package/src/resources/phone-numbers/jobs.ts +332 -15
- package/src/resources/phone-numbers/phone-numbers.ts +38 -2
- package/src/resources/porting-orders/phone-number-blocks.ts +1 -0
- package/src/resources/porting-orders/porting-orders.ts +1 -0
- package/src/resources/porting-phone-numbers.ts +1 -0
- package/src/resources/reputation/numbers.ts +12 -0
- package/src/resources/shared.ts +5 -0
- package/src/resources/sip-registration-status.ts +188 -0
- package/src/resources/speech-to-text/speech-to-text.ts +12 -4
- package/src/resources/telephony-credentials.ts +24 -2
- package/src/resources/texml/accounts/accounts.ts +2 -2
- package/src/resources/texml/accounts/calls/calls.ts +49 -14
- package/src/resources/texml/accounts/calls/recordings-json.ts +14 -4
- package/src/resources/texml/accounts/calls/recordings.ts +10 -2
- package/src/resources/texml/accounts/calls/siprec.ts +10 -2
- package/src/resources/texml/accounts/calls/streams.ts +10 -2
- package/src/resources/texml/accounts/conferences/conferences.ts +29 -9
- package/src/resources/texml/accounts/conferences/participants.ts +35 -10
- package/src/resources/texml/accounts/queues.ts +25 -8
- package/src/resources/texml/accounts/recordings/json.ts +14 -4
- package/src/resources/texml/accounts/transcriptions/json.ts +14 -4
- package/src/resources/texml/texml.ts +7 -3
- package/src/resources/text-to-speech/text-to-speech.ts +15 -6
- package/src/resources/tts-integrations/actions.ts +5 -0
- package/src/resources/tts-integrations/index.ts +4 -0
- package/src/resources/tts-integrations/tts-integrations.ts +15 -0
- package/src/resources/tts-integrations.ts +3 -0
- package/src/resources/uac-connections/uac-connections.ts +39 -6
- package/src/resources/voice-clones.ts +65 -9
- package/src/resources/webhooks.ts +1257 -96
- package/src/resources/whatsapp/hosted-signups.ts +221 -0
- package/src/resources/whatsapp/index.ts +16 -0
- package/src/resources/whatsapp/phone-numbers/calling-routing.ts +6 -5
- package/src/resources/whatsapp/signup.ts +188 -0
- package/src/resources/whatsapp/whatsapp.ts +40 -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
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
import { APIResource } from '../../../core/resource';
|
|
4
4
|
import * as AssistantsAPI from './assistants';
|
|
5
5
|
import * as Shared from '../../shared';
|
|
6
|
+
import * as AvatarsAPI from '../avatars';
|
|
6
7
|
import * as ChatAPI from '../chat';
|
|
7
8
|
import * as ToolsAPI from '../tools';
|
|
8
9
|
import * as CanaryDeploysAPI from './canary-deploys';
|
|
@@ -209,7 +210,10 @@ export class Assistants extends APIResource {
|
|
|
209
210
|
/**
|
|
210
211
|
* Updates the specified AI assistant's attributes and returns the updated
|
|
211
212
|
* assistant. The request can also control how the change is promoted across
|
|
212
|
-
* assistant versions.
|
|
213
|
+
* assistant versions. Every update saves a new version, and an assistant keeps at
|
|
214
|
+
* most 10 versions: once it has more, the oldest versions are permanently deleted,
|
|
215
|
+
* except the main version and any version referenced by a traffic distribution
|
|
216
|
+
* rule.
|
|
213
217
|
*
|
|
214
218
|
* @example
|
|
215
219
|
* ```ts
|
|
@@ -647,6 +651,7 @@ export type AssistantTool =
|
|
|
647
651
|
| AssistantTool.SendDtmf
|
|
648
652
|
| AssistantTool.SendMessage
|
|
649
653
|
| AssistantTool.SkipTurn
|
|
654
|
+
| AssistantTool.Vision
|
|
650
655
|
| AssistantTool.Pay
|
|
651
656
|
| AssistantTool.UpdateDynamicVariables;
|
|
652
657
|
|
|
@@ -829,6 +834,14 @@ export namespace AssistantTool {
|
|
|
829
834
|
*/
|
|
830
835
|
targets: Array<Transfer.TargetsList> | string;
|
|
831
836
|
|
|
837
|
+
/**
|
|
838
|
+
* Plays a short beep once the transfer completes and the calls are bridged, so the
|
|
839
|
+
* transfer destination knows the caller is now on the line. The warm transfer
|
|
840
|
+
* message plays before the bridge; this marks the moment the caller actually
|
|
841
|
+
* joins. Works with and without `warm_transfer_acceptance`.
|
|
842
|
+
*/
|
|
843
|
+
bridge_beep?: Transfer.BridgeBeep;
|
|
844
|
+
|
|
832
845
|
/**
|
|
833
846
|
* Custom headers to be added to the SIP INVITE for the transfer command.
|
|
834
847
|
*/
|
|
@@ -931,6 +944,25 @@ export namespace AssistantTool {
|
|
|
931
944
|
sip_auth_username?: string;
|
|
932
945
|
}
|
|
933
946
|
|
|
947
|
+
/**
|
|
948
|
+
* Plays a short beep once the transfer completes and the calls are bridged, so the
|
|
949
|
+
* transfer destination knows the caller is now on the line. The warm transfer
|
|
950
|
+
* message plays before the bridge; this marks the moment the caller actually
|
|
951
|
+
* joins. Works with and without `warm_transfer_acceptance`.
|
|
952
|
+
*/
|
|
953
|
+
export interface BridgeBeep {
|
|
954
|
+
/**
|
|
955
|
+
* Whether to play the beep when the calls are bridged.
|
|
956
|
+
*/
|
|
957
|
+
enabled?: boolean;
|
|
958
|
+
|
|
959
|
+
/**
|
|
960
|
+
* Who hears the beep. `self` plays it to the transfer destination only; `both`
|
|
961
|
+
* plays it to the destination and the original caller.
|
|
962
|
+
*/
|
|
963
|
+
target_legs?: 'self' | 'both';
|
|
964
|
+
}
|
|
965
|
+
|
|
934
966
|
export interface CustomHeader {
|
|
935
967
|
name?: string;
|
|
936
968
|
|
|
@@ -1095,6 +1127,32 @@ export namespace AssistantTool {
|
|
|
1095
1127
|
* `shared` the exchange stays in the conversation like any other messages.
|
|
1096
1128
|
*/
|
|
1097
1129
|
end_user_target_context_mode?: 'private' | 'shared';
|
|
1130
|
+
|
|
1131
|
+
/**
|
|
1132
|
+
* Fail closed when the acceptance consult cannot run. Off by default: if the
|
|
1133
|
+
* consult cannot be set up for any reason — including where acceptance is
|
|
1134
|
+
* unavailable at all (`gather_using_ai`, Conversation Relay or web calls, a
|
|
1135
|
+
* conference, or additional invited participants) — the transfer degrades to a
|
|
1136
|
+
* plain warm transfer (the warm transfer message is played to the destination as
|
|
1137
|
+
* audio and the calls are bridged anyway). Set to true to treat those paths as a
|
|
1138
|
+
* decline instead: the destination is disconnected without being asked, the
|
|
1139
|
+
* assistant returns to the caller, and no bridge happens without an acceptance.
|
|
1140
|
+
* Only consult-setup failures are affected; the destination must still explicitly
|
|
1141
|
+
* accept on every consult that does run.
|
|
1142
|
+
*/
|
|
1143
|
+
require_acceptance?: boolean;
|
|
1144
|
+
|
|
1145
|
+
/**
|
|
1146
|
+
* How long, in seconds, the destination has to accept the transfer, counted from
|
|
1147
|
+
* when the private consult starts (right after the destination answers, or after
|
|
1148
|
+
* `warm_message_delay_ms`). The caller keeps hearing ringback the whole time. If
|
|
1149
|
+
* no acceptance arrives in time, the destination is hung up and the assistant
|
|
1150
|
+
* returns to the caller (the transfer fails as a timeout). Raise it for
|
|
1151
|
+
* destinations that answer before a human is on the line, such as a call-center
|
|
1152
|
+
* queue/ACD or an IVR playing hold audio; keep it as short as practical, since the
|
|
1153
|
+
* caller waits on ringback until it expires.
|
|
1154
|
+
*/
|
|
1155
|
+
timeout_secs?: number;
|
|
1098
1156
|
}
|
|
1099
1157
|
}
|
|
1100
1158
|
}
|
|
@@ -1368,6 +1426,30 @@ export namespace AssistantTool {
|
|
|
1368
1426
|
}
|
|
1369
1427
|
}
|
|
1370
1428
|
|
|
1429
|
+
/**
|
|
1430
|
+
* (BETA) Lets the assistant look at recent image frames the client sent into the
|
|
1431
|
+
* conversation (for example webcam or screen-share frames). Frames are sent with
|
|
1432
|
+
* `conversation.item.create` and `item.buffer: true`; they never trigger a
|
|
1433
|
+
* response on their own. The assistant decides when to look and which frames it
|
|
1434
|
+
* needs. Requires a model that supports image input.
|
|
1435
|
+
*/
|
|
1436
|
+
export interface Vision {
|
|
1437
|
+
type: 'vision';
|
|
1438
|
+
|
|
1439
|
+
/**
|
|
1440
|
+
* Whether this tool comes from the shared Tools Library. Responses merge shared
|
|
1441
|
+
* tools into `tools` with `shared: true`; inline tools carry `shared: false`.
|
|
1442
|
+
* Read-only: set by the server, not accepted in requests. When updating an
|
|
1443
|
+
* assistant, omit `shared: true` tools from the request `tools` array and manage
|
|
1444
|
+
* them through `tool_ids` instead — re-sending their definitions creates an inline
|
|
1445
|
+
* duplicate (rejected with error code 10015 when the type allows only one instance
|
|
1446
|
+
* per assistant).
|
|
1447
|
+
*/
|
|
1448
|
+
shared?: boolean;
|
|
1449
|
+
|
|
1450
|
+
vision?: ToolsAPI.VisionToolParams;
|
|
1451
|
+
}
|
|
1452
|
+
|
|
1371
1453
|
/**
|
|
1372
1454
|
* (BETA) The pay tool allows the assistant to collect card payments from the
|
|
1373
1455
|
* caller via DTMF during the conversation. Recording is automatically paused while
|
|
@@ -1440,6 +1522,35 @@ export interface AudioVisualizerConfig {
|
|
|
1440
1522
|
*/
|
|
1441
1523
|
export type AuthenticationMethod = 'token' | 'certificate';
|
|
1442
1524
|
|
|
1525
|
+
/**
|
|
1526
|
+
* **Beta:** Configuration for the Telnyx open-source avatar provider. Use a stock
|
|
1527
|
+
* avatar or an organization-owned custom avatar returned by the Avatars API.
|
|
1528
|
+
* Discover the available stock catalog with GET /v2/ai/avatars and
|
|
1529
|
+
* filter[avatar_type]=stock; follow meta.total_pages to load every page.
|
|
1530
|
+
*/
|
|
1531
|
+
export interface AvatarSettingsRequest {
|
|
1532
|
+
/**
|
|
1533
|
+
* The Telnyx stock avatar or organization-owned custom avatar to render.
|
|
1534
|
+
*/
|
|
1535
|
+
avatar_id: AvatarsAPI.AvatarID;
|
|
1536
|
+
|
|
1537
|
+
/**
|
|
1538
|
+
* The background to render.
|
|
1539
|
+
*/
|
|
1540
|
+
background_id: 'office' | 'studio' | 'reception' | 'illustrated_workspace';
|
|
1541
|
+
|
|
1542
|
+
/**
|
|
1543
|
+
* Required avatar model identifier, separate from `avatar_id`. The supported value
|
|
1544
|
+
* is `foxtrot-1`. Omission, null, and unsupported model identifiers are rejected.
|
|
1545
|
+
*/
|
|
1546
|
+
model: 'foxtrot-1';
|
|
1547
|
+
|
|
1548
|
+
/**
|
|
1549
|
+
* Selects the Telnyx open-source avatar provider.
|
|
1550
|
+
*/
|
|
1551
|
+
provider: 'telnyx';
|
|
1552
|
+
}
|
|
1553
|
+
|
|
1443
1554
|
/**
|
|
1444
1555
|
* Combine sub-expressions with a logical operator (`and` / `or` / `not`).
|
|
1445
1556
|
*
|
|
@@ -2112,7 +2223,11 @@ export interface FlowNodeReq {
|
|
|
2112
2223
|
|
|
2113
2224
|
/**
|
|
2114
2225
|
* Per-node transcription override (model/language/region). Unset fields cascade
|
|
2115
|
-
* from the assistant-level transcription.
|
|
2226
|
+
* from the assistant-level transcription. A node that sets `model`,
|
|
2227
|
+
* `fallback_models`, or `challenger` doesn't inherit the assistant's
|
|
2228
|
+
* `fallback_models` or `challenger`; it uses only the ones it sets. Otherwise it
|
|
2229
|
+
* inherits them, and they must fit the model and language the node runs; a change
|
|
2230
|
+
* they no longer fit is rejected.
|
|
2116
2231
|
*/
|
|
2117
2232
|
transcription?: TranscriptionSettings;
|
|
2118
2233
|
|
|
@@ -2189,6 +2304,14 @@ export interface InferenceEmbedding {
|
|
|
2189
2304
|
*/
|
|
2190
2305
|
a2a_agents?: Array<AssistantA2AAgent>;
|
|
2191
2306
|
|
|
2307
|
+
/**
|
|
2308
|
+
* **Beta:** Configuration for the Telnyx open-source avatar provider. Use a stock
|
|
2309
|
+
* avatar or an organization-owned custom avatar returned by the Avatars API.
|
|
2310
|
+
* Discover the available stock catalog with GET /v2/ai/avatars and
|
|
2311
|
+
* filter[avatar_type]=stock; follow meta.total_pages to load every page.
|
|
2312
|
+
*/
|
|
2313
|
+
avatar_settings?: TelnyxAvatarSettings | null;
|
|
2314
|
+
|
|
2192
2315
|
/**
|
|
2193
2316
|
* Conversation flow as returned by the API.
|
|
2194
2317
|
*/
|
|
@@ -2426,8 +2549,8 @@ export interface InferenceEmbeddingVoiceSettings {
|
|
|
2426
2549
|
* preview it before saving.
|
|
2427
2550
|
*/
|
|
2428
2551
|
background_audio?:
|
|
2429
|
-
| InferenceEmbeddingVoiceSettings.
|
|
2430
|
-
| InferenceEmbeddingVoiceSettings.
|
|
2552
|
+
| InferenceEmbeddingVoiceSettings.BackgroundAudioUnionMember0
|
|
2553
|
+
| InferenceEmbeddingVoiceSettings.BackgroundAudioUnionMember1
|
|
2431
2554
|
| InferenceEmbeddingVoiceSettings.UnionMember2;
|
|
2432
2555
|
|
|
2433
2556
|
/**
|
|
@@ -2512,6 +2635,17 @@ export interface InferenceEmbeddingVoiceSettings {
|
|
|
2512
2635
|
*/
|
|
2513
2636
|
temperature?: number;
|
|
2514
2637
|
|
|
2638
|
+
/**
|
|
2639
|
+
* Optional sound played to the caller while the assistant runs a tool (for example
|
|
2640
|
+
* a webhook or MCP tool). It replaces the background audio until the tool
|
|
2641
|
+
* responds, then the background audio resumes. Defaults to null, which plays no
|
|
2642
|
+
* sound; send `null` on update to clear it. Not played in conference calls.
|
|
2643
|
+
*/
|
|
2644
|
+
tool_call_audio?:
|
|
2645
|
+
| InferenceEmbeddingVoiceSettings.ToolCallAudioUnionMember0
|
|
2646
|
+
| InferenceEmbeddingVoiceSettings.ToolCallAudioUnionMember1
|
|
2647
|
+
| null;
|
|
2648
|
+
|
|
2515
2649
|
/**
|
|
2516
2650
|
* Amplifies similarity to the original speaker voice. Increases computational load
|
|
2517
2651
|
* and latency slightly. Only applicable when using ElevenLabs.
|
|
@@ -2528,7 +2662,7 @@ export interface InferenceEmbeddingVoiceSettings {
|
|
|
2528
2662
|
}
|
|
2529
2663
|
|
|
2530
2664
|
export namespace InferenceEmbeddingVoiceSettings {
|
|
2531
|
-
export interface
|
|
2665
|
+
export interface BackgroundAudioUnionMember0 {
|
|
2532
2666
|
/**
|
|
2533
2667
|
* Select from predefined media options.
|
|
2534
2668
|
*/
|
|
@@ -2546,7 +2680,7 @@ export namespace InferenceEmbeddingVoiceSettings {
|
|
|
2546
2680
|
volume?: number;
|
|
2547
2681
|
}
|
|
2548
2682
|
|
|
2549
|
-
export interface
|
|
2683
|
+
export interface BackgroundAudioUnionMember1 {
|
|
2550
2684
|
/**
|
|
2551
2685
|
* Provide a direct URL to an MP3 file. The audio will loop during the call.
|
|
2552
2686
|
*/
|
|
@@ -2571,6 +2705,36 @@ export namespace InferenceEmbeddingVoiceSettings {
|
|
|
2571
2705
|
*/
|
|
2572
2706
|
value: string;
|
|
2573
2707
|
}
|
|
2708
|
+
|
|
2709
|
+
export interface ToolCallAudioUnionMember0 {
|
|
2710
|
+
/**
|
|
2711
|
+
* Select from predefined media options.
|
|
2712
|
+
*/
|
|
2713
|
+
type: 'predefined_media';
|
|
2714
|
+
|
|
2715
|
+
/**
|
|
2716
|
+
* The predefined media to use. `typing` plays a keyboard typing sound.
|
|
2717
|
+
*/
|
|
2718
|
+
value: 'typing';
|
|
2719
|
+
|
|
2720
|
+
/**
|
|
2721
|
+
* Volume level for the predefined media. Supports values from 0.0 to 1.0 in 0.1
|
|
2722
|
+
* increments. `0.0` plays no sound.
|
|
2723
|
+
*/
|
|
2724
|
+
volume?: number;
|
|
2725
|
+
}
|
|
2726
|
+
|
|
2727
|
+
export interface ToolCallAudioUnionMember1 {
|
|
2728
|
+
/**
|
|
2729
|
+
* Provide a direct URL to an MP3 file. The audio loops while the tool runs.
|
|
2730
|
+
*/
|
|
2731
|
+
type: 'media_url';
|
|
2732
|
+
|
|
2733
|
+
/**
|
|
2734
|
+
* HTTPS URL to an MP3 file.
|
|
2735
|
+
*/
|
|
2736
|
+
value: string;
|
|
2737
|
+
}
|
|
2574
2738
|
}
|
|
2575
2739
|
|
|
2576
2740
|
export interface InferenceEmbeddingWebhookToolParams {
|
|
@@ -2995,6 +3159,34 @@ export interface PrivacySettings {
|
|
|
2995
3159
|
* border. Defaults to false.
|
|
2996
3160
|
*/
|
|
2997
3161
|
in_transit_data_locality?: boolean;
|
|
3162
|
+
|
|
3163
|
+
/**
|
|
3164
|
+
* Controls redaction of personally identifiable information (PII) from the
|
|
3165
|
+
* conversation history that is stored for this assistant. `disabled` (default)
|
|
3166
|
+
* stores content as-is. `redact` replaces detected PII with `<PII:type/>`
|
|
3167
|
+
* placeholders (e.g. `<PII:name/>`, `<PII:phone/>`) as the stored copies are
|
|
3168
|
+
* written: message content (user, assistant, and tool-result messages) and
|
|
3169
|
+
* tool-call arguments are redacted when written to conversation history, so the
|
|
3170
|
+
* stored transcript, its read-back via the history API, and any insights generated
|
|
3171
|
+
* from the stored messages contain the placeholders instead of the PII; response
|
|
3172
|
+
* bodies returned by webhook tools are redacted too, as stored in the webhook logs
|
|
3173
|
+
* — a per-conversation record separate from the transcript. In the Mission Control
|
|
3174
|
+
* Portal this field appears as a "PII Redaction" on/off toggle, where Enabled
|
|
3175
|
+
* corresponds to `redact`. Redaction runs when the stored copy is written, after
|
|
3176
|
+
* the LLM has generated its reply: the live conversation is not redacted, the
|
|
3177
|
+
* assistant's tools keep receiving the full (unredacted) values during the call,
|
|
3178
|
+
* and the LLM still sees full content in its context window. Call recordings
|
|
3179
|
+
* (including any recording layout configured under telephony settings) and the
|
|
3180
|
+
* payloads of messages/webhooks delivered during the call are never redacted by
|
|
3181
|
+
* this setting. The set of detected PII types (names, street addresses, phone
|
|
3182
|
+
* numbers, email addresses, government identifiers like SSN and driver's license
|
|
3183
|
+
* numbers, credit card and bank account numbers, IP addresses, dates of birth, and
|
|
3184
|
+
* other identifiers unique to a person) is fixed by Telnyx and cannot be
|
|
3185
|
+
* configured or extended per assistant. Assistants with `redact` cannot be used
|
|
3186
|
+
* for SMS/WhatsApp messaging (that combination is rejected with a 400 error);
|
|
3187
|
+
* voice and web chat are unaffected.
|
|
3188
|
+
*/
|
|
3189
|
+
pii_redaction?: 'disabled' | 'redact';
|
|
2998
3190
|
}
|
|
2999
3191
|
|
|
3000
3192
|
/**
|
|
@@ -3124,6 +3316,16 @@ export interface StartSpeakingPlan {
|
|
|
3124
3316
|
}
|
|
3125
3317
|
|
|
3126
3318
|
export interface TelephonySettings {
|
|
3319
|
+
/**
|
|
3320
|
+
* When enabled, the `messages` array of the `call.conversation.ended` webhook
|
|
3321
|
+
* contains the full conversation history in order: user and assistant turns,
|
|
3322
|
+
* assistant tool calls (`tool_calls`), tool results (`role: tool` with
|
|
3323
|
+
* `tool_call_id`), and informational `system` and `developer` entries. The
|
|
3324
|
+
* assistant's instructions are never included. When disabled, `messages` contains
|
|
3325
|
+
* only user and assistant text turns.
|
|
3326
|
+
*/
|
|
3327
|
+
conversation_ended_full_history?: boolean;
|
|
3328
|
+
|
|
3127
3329
|
/**
|
|
3128
3330
|
* Default Texml App used for voice calls with your assistant. This will be created
|
|
3129
3331
|
* automatically on assistant creation.
|
|
@@ -3189,9 +3391,16 @@ export interface TelephonySettings {
|
|
|
3189
3391
|
|
|
3190
3392
|
/**
|
|
3191
3393
|
* Maximum duration in seconds for the AI assistant to participate on the call.
|
|
3192
|
-
* When this limit is reached the assistant will be stopped.
|
|
3193
|
-
*
|
|
3194
|
-
*
|
|
3394
|
+
* When this limit is reached the assistant will be stopped. Stopping the assistant
|
|
3395
|
+
* does not itself hang up the call, and what happens next depends on how the
|
|
3396
|
+
* assistant is running. On Call Control (ai_assistant_start) the call leg stays
|
|
3397
|
+
* connected and continues to be billed until it is hung up (for example with the
|
|
3398
|
+
* Hangup call command) or until the call ends for another reason. On TeXML, the
|
|
3399
|
+
* assistant's `<Connect><AIAssistant>` instruction ends; in the default TeXML
|
|
3400
|
+
* setup for assistants no instructions follow it, so the call is hung up. Your
|
|
3401
|
+
* application receives a call.conversation.ended webhook when the assistant stops.
|
|
3402
|
+
* This limit does not apply to portions of a call without an active assistant (for
|
|
3403
|
+
* instance, a call transferred to a human representative).
|
|
3195
3404
|
*/
|
|
3196
3405
|
time_limit_secs?: number;
|
|
3197
3406
|
|
|
@@ -3204,9 +3413,16 @@ export interface TelephonySettings {
|
|
|
3204
3413
|
|
|
3205
3414
|
/**
|
|
3206
3415
|
* Maximum duration in seconds of end user silence on the call. When this limit is
|
|
3207
|
-
* reached the assistant will be stopped.
|
|
3208
|
-
*
|
|
3209
|
-
*
|
|
3416
|
+
* reached the assistant will be stopped. Stopping the assistant does not itself
|
|
3417
|
+
* hang up the call, and what happens next depends on how the assistant is running.
|
|
3418
|
+
* On Call Control (ai_assistant_start) the call leg stays connected and continues
|
|
3419
|
+
* to be billed until it is hung up (for example with the Hangup call command) or
|
|
3420
|
+
* until the call ends for another reason. On TeXML, the assistant's
|
|
3421
|
+
* `<Connect><AIAssistant>` instruction ends; in the default TeXML setup for
|
|
3422
|
+
* assistants no instructions follow it, so the call is hung up. Your application
|
|
3423
|
+
* receives a call.conversation.ended webhook when the assistant stops. This limit
|
|
3424
|
+
* does not apply to portions of a call without an active assistant (for instance,
|
|
3425
|
+
* a call transferred to a human representative).
|
|
3210
3426
|
*/
|
|
3211
3427
|
user_idle_timeout_secs?: number;
|
|
3212
3428
|
|
|
@@ -3349,6 +3565,35 @@ export namespace TelephonySettings {
|
|
|
3349
3565
|
}
|
|
3350
3566
|
}
|
|
3351
3567
|
|
|
3568
|
+
/**
|
|
3569
|
+
* **Beta:** Configuration for the Telnyx open-source avatar provider. Use a stock
|
|
3570
|
+
* avatar or an organization-owned custom avatar returned by the Avatars API.
|
|
3571
|
+
* Discover the available stock catalog with GET /v2/ai/avatars and
|
|
3572
|
+
* filter[avatar_type]=stock; follow meta.total_pages to load every page.
|
|
3573
|
+
*/
|
|
3574
|
+
export interface TelnyxAvatarSettings {
|
|
3575
|
+
/**
|
|
3576
|
+
* The Telnyx stock avatar or organization-owned custom avatar to render.
|
|
3577
|
+
*/
|
|
3578
|
+
avatar_id: AvatarsAPI.AvatarID;
|
|
3579
|
+
|
|
3580
|
+
/**
|
|
3581
|
+
* The background to render.
|
|
3582
|
+
*/
|
|
3583
|
+
background_id: 'office' | 'studio' | 'reception' | 'illustrated_workspace';
|
|
3584
|
+
|
|
3585
|
+
/**
|
|
3586
|
+
* Required avatar model identifier, separate from `avatar_id`. The supported value
|
|
3587
|
+
* is `foxtrot-1`. Omission, null, and unsupported model identifiers are rejected.
|
|
3588
|
+
*/
|
|
3589
|
+
model: 'foxtrot-1';
|
|
3590
|
+
|
|
3591
|
+
/**
|
|
3592
|
+
* Selects the Telnyx open-source avatar provider.
|
|
3593
|
+
*/
|
|
3594
|
+
provider: 'telnyx';
|
|
3595
|
+
}
|
|
3596
|
+
|
|
3352
3597
|
/**
|
|
3353
3598
|
* A standalone tool step in a conversation flow, as returned by the API.
|
|
3354
3599
|
*/
|
|
@@ -3489,6 +3734,24 @@ export interface TranscriptionSettings {
|
|
|
3489
3734
|
*/
|
|
3490
3735
|
api_key_ref?: string;
|
|
3491
3736
|
|
|
3737
|
+
/**
|
|
3738
|
+
* A second speech-to-text model that transcribes alongside `transcription.model`,
|
|
3739
|
+
* and the rule that decides which transcript the assistant uses.
|
|
3740
|
+
*/
|
|
3741
|
+
challenger?: TranscriptionSettings.Challenger | null;
|
|
3742
|
+
|
|
3743
|
+
/**
|
|
3744
|
+
* Up to 3 streaming models that take over transcription, in this order, when the
|
|
3745
|
+
* model in use fails, at the start of a call or mid-call. `model` must be a
|
|
3746
|
+
* streaming model too, and must support `language` alongside other models. On
|
|
3747
|
+
* update, a list replaces the stored one: omit the field to keep the stored list,
|
|
3748
|
+
* or send `null` or `[]` to remove it. When an update changes `model` or
|
|
3749
|
+
* `language`, stored fallbacks that no longer fit are removed without an error.
|
|
3750
|
+
* Can't be combined with `challenger`, the language booster; to replace a stored
|
|
3751
|
+
* language booster, send `challenger: null` in the same request.
|
|
3752
|
+
*/
|
|
3753
|
+
fallback_models?: Array<TranscriptionSettings.FallbackModel> | null;
|
|
3754
|
+
|
|
3492
3755
|
/**
|
|
3493
3756
|
* The language of the audio to be transcribed. If not set, or if set to `auto`,
|
|
3494
3757
|
* supported models will automatically detect the language. For `deepgram/flux`,
|
|
@@ -3506,7 +3769,12 @@ export interface TranscriptionSettings {
|
|
|
3506
3769
|
* `nl`, `en`, `fr`, `fy`, `de`, `it`, `pl`, `pt`, `es`, and `sv` to fix the
|
|
3507
3770
|
* transcription language. For `cohere/ar-stt`, supported values are `ar` and `en`;
|
|
3508
3771
|
* unlike other models, this model does not auto-detect and defaults to `ar` when
|
|
3509
|
-
* `language` is omitted.
|
|
3772
|
+
* `language` is omitted. For `speechmatics/linden-1`, there is no auto-detect; set
|
|
3773
|
+
* a code from Speechmatics' Realtime language list (67 language codes, including
|
|
3774
|
+
* `es-bilingual-en` for Spanish and English bilingual, and the spelling and script
|
|
3775
|
+
* variants `en-US`, `en-GB`, `en-AU`, `cmn-Hans`, and `cmn-Hant`; `en` alone uses
|
|
3776
|
+
* the default spelling); unset defaults to `en`, while an explicit `auto`,
|
|
3777
|
+
* `auto_beta`, or `multi` is rejected with a 400.
|
|
3510
3778
|
*/
|
|
3511
3779
|
language?: string;
|
|
3512
3780
|
|
|
@@ -3517,6 +3785,12 @@ export interface TranscriptionSettings {
|
|
|
3517
3785
|
* - `deepgram/flux` is optimized for turn-taking with multilingual language hints.
|
|
3518
3786
|
* - `deepgram/nova-3` is multilingual with automatic language detection.
|
|
3519
3787
|
* - `deepgram/nova-2` is Deepgram's previous-generation multilingual model.
|
|
3788
|
+
* - `speechmatics/standard` is a Speechmatics model self-hosted by Telnyx; it
|
|
3789
|
+
* supports a fixed set of language packs (including bilingual packs such as
|
|
3790
|
+
* `ar_en`) and defaults to `en`.
|
|
3791
|
+
* - `speechmatics/linden-1` (preview) is a vendor-hosted streaming model with no
|
|
3792
|
+
* auto-detect; set `language` from Speechmatics' Realtime language list
|
|
3793
|
+
* (defaults to `en`).
|
|
3520
3794
|
* - `azure/fast` is a multilingual Azure transcription model.
|
|
3521
3795
|
* - `assemblyai/universal-3-5-pro` is a multilingual streaming model with
|
|
3522
3796
|
* configurable turn detection. The legacy alias `assemblyai/universal-streaming`
|
|
@@ -3534,11 +3808,14 @@ export interface TranscriptionSettings {
|
|
|
3534
3808
|
* - `reson8/turns` is a turn-based streaming model covering 10 European languages
|
|
3535
3809
|
* with automatic language detection.
|
|
3536
3810
|
* - `cohere/ar-stt` is a non-streaming Arabic and English transcription model.
|
|
3811
|
+
* - `telnyx/basira` is a non-streaming Arabic transcription model.
|
|
3537
3812
|
*/
|
|
3538
3813
|
model?:
|
|
3539
3814
|
| 'deepgram/flux'
|
|
3540
3815
|
| 'deepgram/nova-3'
|
|
3541
3816
|
| 'deepgram/nova-2'
|
|
3817
|
+
| 'speechmatics/standard'
|
|
3818
|
+
| 'speechmatics/linden-1'
|
|
3542
3819
|
| 'azure/fast'
|
|
3543
3820
|
| 'assemblyai/universal-3-5-pro'
|
|
3544
3821
|
| 'assemblyai/universal-streaming'
|
|
@@ -3550,6 +3827,7 @@ export interface TranscriptionSettings {
|
|
|
3550
3827
|
| 'humain/realtime'
|
|
3551
3828
|
| 'reson8/turns'
|
|
3552
3829
|
| 'cohere/ar-stt'
|
|
3830
|
+
| 'telnyx/basira'
|
|
3553
3831
|
| 'distil-whisper/distil-large-v2'
|
|
3554
3832
|
| 'openai/whisper-large-v3-turbo';
|
|
3555
3833
|
|
|
@@ -3562,6 +3840,124 @@ export interface TranscriptionSettings {
|
|
|
3562
3840
|
settings?: TranscriptionSettingsConfig;
|
|
3563
3841
|
}
|
|
3564
3842
|
|
|
3843
|
+
export namespace TranscriptionSettings {
|
|
3844
|
+
/**
|
|
3845
|
+
* A second speech-to-text model that transcribes alongside `transcription.model`,
|
|
3846
|
+
* and the rule that decides which transcript the assistant uses.
|
|
3847
|
+
*/
|
|
3848
|
+
export interface Challenger {
|
|
3849
|
+
/**
|
|
3850
|
+
* The language booster's model. It must be the same kind of model as
|
|
3851
|
+
* `transcription.model`: both streaming (`deepgram/flux`, `deepgram/nova-3`,
|
|
3852
|
+
* `deepgram/nova-2`, `assemblyai/universal-3-5-pro` or its legacy alias
|
|
3853
|
+
* `assemblyai/universal-streaming`, `xai/grok-stt`, `soniox/stt-rt-v4`,
|
|
3854
|
+
* `soniox/stt-rt-v5`, `humain/realtime`, `reson8/turns`) or both non-streaming
|
|
3855
|
+
* (`azure/fast`, `nvidia/parakeet-v3`, `omi-health/omi-med-stt-v1`,
|
|
3856
|
+
* `cohere/ar-stt`, `distil-whisper/distil-large-v2`,
|
|
3857
|
+
* `openai/whisper-large-v3-turbo`, `telnyx/basira`). It can be the same model as
|
|
3858
|
+
* `transcription.model` on a different `language`.
|
|
3859
|
+
*/
|
|
3860
|
+
model:
|
|
3861
|
+
| 'deepgram/flux'
|
|
3862
|
+
| 'deepgram/nova-3'
|
|
3863
|
+
| 'deepgram/nova-2'
|
|
3864
|
+
| 'azure/fast'
|
|
3865
|
+
| 'assemblyai/universal-3-5-pro'
|
|
3866
|
+
| 'assemblyai/universal-streaming'
|
|
3867
|
+
| 'xai/grok-stt'
|
|
3868
|
+
| 'soniox/stt-rt-v4'
|
|
3869
|
+
| 'soniox/stt-rt-v5'
|
|
3870
|
+
| 'nvidia/parakeet-v3'
|
|
3871
|
+
| 'omi-health/omi-med-stt-v1'
|
|
3872
|
+
| 'humain/realtime'
|
|
3873
|
+
| 'reson8/turns'
|
|
3874
|
+
| 'cohere/ar-stt'
|
|
3875
|
+
| 'telnyx/basira'
|
|
3876
|
+
| 'distil-whisper/distil-large-v2'
|
|
3877
|
+
| 'openai/whisper-large-v3-turbo';
|
|
3878
|
+
|
|
3879
|
+
/**
|
|
3880
|
+
* The language this model transcribes. Omit it or set it to `null` to use the
|
|
3881
|
+
* language of `transcription.model`. The request is rejected when this model
|
|
3882
|
+
* doesn't support the language it would run. It is also rejected when it would run
|
|
3883
|
+
* the same model on the same language as `transcription.model`.
|
|
3884
|
+
*/
|
|
3885
|
+
language?: string | null;
|
|
3886
|
+
|
|
3887
|
+
/**
|
|
3888
|
+
* How the assistant picks the transcript it uses. The models are compared on how
|
|
3889
|
+
* complete and confident their transcripts are, not on language, so the rules work
|
|
3890
|
+
* best when both models understand the callers' language.
|
|
3891
|
+
*
|
|
3892
|
+
* - `best_turn` (default): both models transcribe the whole call. Each turn uses
|
|
3893
|
+
* the language booster's transcript only when it scores higher than the
|
|
3894
|
+
* transcript of `transcription.model` (clearly higher with non-streaming
|
|
3895
|
+
* models). With streaming models, `transcription.model` also decides when each
|
|
3896
|
+
* turn ends. Available for every pair.
|
|
3897
|
+
* - `best_engine`: both models transcribe the first turns, then the call continues
|
|
3898
|
+
* alone on the model whose transcripts scored higher. If neither clearly leads,
|
|
3899
|
+
* `transcription.model` continues. Streaming models only.
|
|
3900
|
+
* - `merge_words`: both models transcribe each utterance and their words are
|
|
3901
|
+
* merged, keeping Arabic and English spoken in the same sentence. Available only
|
|
3902
|
+
* for `telnyx/basira` with `cohere/ar-stt`, in either order. The pair runs on
|
|
3903
|
+
* the language that applies to `telnyx/basira` (its own, or that of
|
|
3904
|
+
* `transcription.model`), which must be Arabic (`ar` or an `ar-` locale),
|
|
3905
|
+
* `multi`, or `auto`.
|
|
3906
|
+
*/
|
|
3907
|
+
rule?: 'best_turn' | 'best_engine' | 'merge_words';
|
|
3908
|
+
|
|
3909
|
+
/**
|
|
3910
|
+
* Settings for the language booster, with the same fields and limits as
|
|
3911
|
+
* `transcription.settings`. Fields that don't apply to this model's provider are
|
|
3912
|
+
* dropped, and the provider's defaults fill in the rest. Omit it or set it to
|
|
3913
|
+
* `null` to use the settings of `transcription.model` where they apply to this
|
|
3914
|
+
* model.
|
|
3915
|
+
*/
|
|
3916
|
+
settings?: AssistantsAPI.TranscriptionSettingsConfig | null;
|
|
3917
|
+
}
|
|
3918
|
+
|
|
3919
|
+
/**
|
|
3920
|
+
* A streaming speech-to-text model that takes over transcription when the model in
|
|
3921
|
+
* use fails.
|
|
3922
|
+
*/
|
|
3923
|
+
export interface FallbackModel {
|
|
3924
|
+
/**
|
|
3925
|
+
* The fallback model. It must be a streaming model other than
|
|
3926
|
+
* `transcription.model` and the other fallbacks: `deepgram/flux`,
|
|
3927
|
+
* `deepgram/nova-3`, `deepgram/nova-2`, `assemblyai/universal-3-5-pro` (or its
|
|
3928
|
+
* legacy alias `assemblyai/universal-streaming`), `xai/grok-stt`,
|
|
3929
|
+
* `soniox/stt-rt-v4`, `soniox/stt-rt-v5`, `humain/realtime`, or `reson8/turns`.
|
|
3930
|
+
*/
|
|
3931
|
+
model:
|
|
3932
|
+
| 'deepgram/flux'
|
|
3933
|
+
| 'deepgram/nova-3'
|
|
3934
|
+
| 'deepgram/nova-2'
|
|
3935
|
+
| 'assemblyai/universal-3-5-pro'
|
|
3936
|
+
| 'assemblyai/universal-streaming'
|
|
3937
|
+
| 'xai/grok-stt'
|
|
3938
|
+
| 'soniox/stt-rt-v4'
|
|
3939
|
+
| 'soniox/stt-rt-v5'
|
|
3940
|
+
| 'humain/realtime'
|
|
3941
|
+
| 'reson8/turns';
|
|
3942
|
+
|
|
3943
|
+
/**
|
|
3944
|
+
* The language the fallback transcribes. Omit it or set it to `null` to use the
|
|
3945
|
+
* language of `transcription.model`. The request is rejected when the fallback
|
|
3946
|
+
* model doesn't support the language it would run.
|
|
3947
|
+
*/
|
|
3948
|
+
language?: string | null;
|
|
3949
|
+
|
|
3950
|
+
/**
|
|
3951
|
+
* Settings for the fallback, with the same fields and limits as
|
|
3952
|
+
* `transcription.settings`. Fields that don't apply to this model's provider are
|
|
3953
|
+
* dropped, and the provider's defaults fill in the rest. Omit it or set it to
|
|
3954
|
+
* `null` to use the settings of `transcription.model` where they apply to this
|
|
3955
|
+
* model.
|
|
3956
|
+
*/
|
|
3957
|
+
settings?: AssistantsAPI.TranscriptionSettingsConfig | null;
|
|
3958
|
+
}
|
|
3959
|
+
}
|
|
3960
|
+
|
|
3565
3961
|
export interface TranscriptionSettingsConfig {
|
|
3566
3962
|
/**
|
|
3567
3963
|
* Available only for soniox/stt-rt-v4 and soniox/stt-rt-v5. A comma-separated list
|
|
@@ -3589,9 +3985,9 @@ export interface TranscriptionSettingsConfig {
|
|
|
3589
3985
|
enable_endpoint_detection?: boolean;
|
|
3590
3986
|
|
|
3591
3987
|
/**
|
|
3592
|
-
*
|
|
3593
|
-
*
|
|
3594
|
-
*
|
|
3988
|
+
* @deprecated Deprecated and ignored. Accepted for backwards compatibility.
|
|
3989
|
+
* AssemblyAI turn detection is configured with min_turn_silence and
|
|
3990
|
+
* max_turn_silence.
|
|
3595
3991
|
*/
|
|
3596
3992
|
end_of_turn_confidence_threshold?: number;
|
|
3597
3993
|
|
|
@@ -3614,10 +4010,13 @@ export interface TranscriptionSettingsConfig {
|
|
|
3614
4010
|
interim_results?: boolean;
|
|
3615
4011
|
|
|
3616
4012
|
/**
|
|
3617
|
-
*
|
|
3618
|
-
*
|
|
3619
|
-
* for domain-specific terminology, proper nouns, or
|
|
3620
|
-
*
|
|
4013
|
+
* A comma-separated list of key terms to boost for recognition during
|
|
4014
|
+
* transcription, used by Deepgram, Reson8, Speechmatics Linden 1 and AssemblyAI
|
|
4015
|
+
* models. Helps improve accuracy for domain-specific terminology, proper nouns, or
|
|
4016
|
+
* uncommon words. At most 1000 characters in total. For
|
|
4017
|
+
* assemblyai/universal-3-5-pro (and its legacy alias
|
|
4018
|
+
* assemblyai/universal-streaming), also at most 100 terms of up to 50 characters
|
|
4019
|
+
* each. This field may be templated with
|
|
3621
4020
|
* [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
|
|
3622
4021
|
* using mustache syntax (e.g. `Telnyx,{{customer_name}},VoIP`). Variables are
|
|
3623
4022
|
* resolved at call time before the value is sent to the speech-to-text engine.
|
|
@@ -3654,6 +4053,24 @@ export interface TranscriptionSettingsConfig {
|
|
|
3654
4053
|
|
|
3655
4054
|
numerals?: boolean;
|
|
3656
4055
|
|
|
4056
|
+
/**
|
|
4057
|
+
* Available only for assemblyai/universal-3-5-pro (and its legacy alias
|
|
4058
|
+
* assemblyai/universal-streaming). Context about the conversation (domain, names,
|
|
4059
|
+
* terms) to improve transcription; describe the content, do not give instructions.
|
|
4060
|
+
* Leave empty unless needed. At most 1750 characters.
|
|
4061
|
+
*/
|
|
4062
|
+
prompt?: string;
|
|
4063
|
+
|
|
4064
|
+
/**
|
|
4065
|
+
* Available only for speechmatics/linden-1. When true, filler words such as "um"
|
|
4066
|
+
* and "uh" are removed from the transcript. Disfluency removal is supported only
|
|
4067
|
+
* for `ar`, `cmn`, `da`, `de`, `el`, `en`, `es`, `fr`, `he`, `hi`, `hu`, `it`,
|
|
4068
|
+
* `ja`, `nl`, `pl`, `pt`, and `ru`, determined by the base language (so `en-US`,
|
|
4069
|
+
* `en-GB`, `en-AU`, `cmn-Hans`, and `cmn-Hant` are supported); for other
|
|
4070
|
+
* languages, filler words remain in the transcript.
|
|
4071
|
+
*/
|
|
4072
|
+
remove_disfluencies?: boolean;
|
|
4073
|
+
|
|
3657
4074
|
smart_format?: boolean;
|
|
3658
4075
|
}
|
|
3659
4076
|
|
|
@@ -4162,6 +4579,14 @@ export interface AssistantCreateParams {
|
|
|
4162
4579
|
*/
|
|
4163
4580
|
a2a_agents?: Array<AssistantA2AAgent>;
|
|
4164
4581
|
|
|
4582
|
+
/**
|
|
4583
|
+
* Body param: **Beta:** Configuration for the Telnyx open-source avatar provider.
|
|
4584
|
+
* Use a stock avatar or an organization-owned custom avatar returned by the
|
|
4585
|
+
* Avatars API. Discover the available stock catalog with GET /v2/ai/avatars and
|
|
4586
|
+
* filter[avatar_type]=stock; follow meta.total_pages to load every page.
|
|
4587
|
+
*/
|
|
4588
|
+
avatar_settings?: AvatarSettingsRequest | null;
|
|
4589
|
+
|
|
4165
4590
|
/**
|
|
4166
4591
|
* Body param: Conversation flow as supplied by API clients (create / update).
|
|
4167
4592
|
*
|
|
@@ -4448,6 +4873,14 @@ export interface AssistantUpdateParams {
|
|
|
4448
4873
|
*/
|
|
4449
4874
|
a2a_agents?: Array<AssistantA2AAgent>;
|
|
4450
4875
|
|
|
4876
|
+
/**
|
|
4877
|
+
* **Beta:** Configuration for the Telnyx open-source avatar provider. Use a stock
|
|
4878
|
+
* avatar or an organization-owned custom avatar returned by the Avatars API.
|
|
4879
|
+
* Discover the available stock catalog with GET /v2/ai/avatars and
|
|
4880
|
+
* filter[avatar_type]=stock; follow meta.total_pages to load every page.
|
|
4881
|
+
*/
|
|
4882
|
+
avatar_settings?: AvatarSettingsRequest | null;
|
|
4883
|
+
|
|
4451
4884
|
/**
|
|
4452
4885
|
* Conversation flow as supplied by API clients (create / update).
|
|
4453
4886
|
*
|
|
@@ -4779,6 +5212,7 @@ export declare namespace Assistants {
|
|
|
4779
5212
|
type AssistantsList as AssistantsList,
|
|
4780
5213
|
type AudioVisualizerConfig as AudioVisualizerConfig,
|
|
4781
5214
|
type AuthenticationMethod as AuthenticationMethod,
|
|
5215
|
+
type AvatarSettingsRequest as AvatarSettingsRequest,
|
|
4782
5216
|
type BooleanOpExpression as BooleanOpExpression,
|
|
4783
5217
|
type ComparisonExpression as ComparisonExpression,
|
|
4784
5218
|
type ConversationFlow as ConversationFlow,
|
|
@@ -4815,6 +5249,7 @@ export declare namespace Assistants {
|
|
|
4815
5249
|
type SpeakNodeReq as SpeakNodeReq,
|
|
4816
5250
|
type StartSpeakingPlan as StartSpeakingPlan,
|
|
4817
5251
|
type TelephonySettings as TelephonySettings,
|
|
5252
|
+
type TelnyxAvatarSettings as TelnyxAvatarSettings,
|
|
4818
5253
|
type ToolNode as ToolNode,
|
|
4819
5254
|
type ToolNodeReq as ToolNodeReq,
|
|
4820
5255
|
type TranscriptionEndpointingPlan as TranscriptionEndpointingPlan,
|