{
"openapi":"3.1.0",
"info":{
"title":"Infobip OpenAPI Specification",
"description":"OpenAPI Specification that contains all public endpoints and webhooks.",
"contact":{
"name":"Infobip support",
"email":"support@infobip.com"
},
"version":"3.210.0",
"x-generatedAt":"2026-07-23T15:23:47.459971396Z"
},
"tags":[
{
"name":"channels",
"description":"Create a perfect customer experience by using the channels your customer already use and love.\n",
"x-type":"category",
"x-displayName":"Channels"
},
{
"name":"voice",
"description":"Infobip Voice API allows you to engage into voice communication with your customer using the Voice API features.\n\nWith Calls API, you can use our granular APIs to create any inbound or outbound voice and video scenario you require. Alternatively, you can use our high level APIs such as:\n\n* Voice Message, to send your customers Text-To-Speech or Pre-recorded message\n* Interactive Voice Response, to create and execute inbound or outbound IVR scenarios enabling interactive communication with your customers\n* Click-to-Call or Number Masking solutions, to establish live conversation between two parties and where you can also protect your customer's identity by using anonymization.\n\nHuge benefit of Voice channel is also that you can reach your customers not only on their mobile but also on their landline phones.\n\nAll Voice calls can be recorded.\n\nTo enable recording feature on Voice calls, please check each Channels Voice API.\n\nYou may fetch recorded audio files using [Recording page](https://portal.infobip.com/channels-and-numbers/channels/voice-and-webrtc/recording) section of the portal.\n\n[Learn more about Voice channel and use cases](https://www.infobip.com/products/voice)\n",
"x-type":"product",
"x-displayName":"Voice"
},
{
"name":"calls",
"description":"With Calls API, you can use our granular APIs to create any inbound or outbound voice and video scenario you require.\n\nEvery inbound connection to, or outbound connection from the Infobip platform is designated as a call leg, or simply put, a call. All API methods under the [**Call Legs**](#channels/voice/calls/call-legs) section allow your application to create, answer and perform actions on individual calls.\n\nApplications can connect multiple calls together, no matter if these calls are inbound or outbound, and no matter the type of the endpoint for each of these calls. When your application needs to connect only two calls together, it is not necessary to explicitly manage conference objects and use conferencing APIs – the *connect* API method on calls will manage these conferencing objects on your behalf. When your application needs to put together 3 or more calls together, you need to use the conference methods and their related actions under the [**Conference Calls**](#channels/voice/calls/conference-calls) section.\n\nA [**Calls Configuration**](https://www.infobip.com/docs/api/channels/voice/calls/calls-configurations) is a logical entity that represents a voice or video application you are implementing and hosting in your own environment, whether on premise or at your cloud hosting services. This logical entity includes only ID and Name, and is a placeholder for linking other configurations with your application.\n\nOne mandatory link to set up is linking you Calls Configuration with Subscriptions. Calls API is event-driven platform, and you need to define webhook to receive those events, as a pre-requisite for executing your business logic. Event subscriptions are defined on [**Subscriptions API**](https://www.infobip.com/docs/api/platform/subscriptions-api). One of available parameters, when defining subscription criteria, is `callsConfigurationId`, which allows you to define webhooks for Calls Configurations you create.\n\nAnother mandatory link to Calls Configurations is actual traffic. The reference of the Calls Configuration (`callsConfigurationId`) must be specified in API calls your application will make towards Infobip to create or manipulate calls, conferences and dialogs, ensuring that corresponding events are routed to the right webhooks. All methods to create and manage Calls Configurations are under the **Configurations** section.\n",
"x-type":"module",
"x-displayName":"Calls"
},
{
"name":"calls-configurations",
"description":"Creating Calls Configuration is precondition for using Calls API. You will find APIs for managing your configurations in this section.",
"x-type":"submodule",
"x-displayName":"Configurations"
},
{
"name":"calls-configuration",
"description":"",
"x-type":"section",
"x-displayName":"Calls configuration"
},
{
"name":"call-legs",
"description":"Every inbound connection to, or outbound connection from the Infobip platform is designated as a call leg, or simply put, a call. All API methods in this section allow your application to create, answer and perform actions on individual calls.",
"x-type":"submodule",
"x-displayName":"Call Legs"
},
{
"name":"calls-management",
"description":"",
"x-type":"section",
"x-displayName":"Calls Management"
},
{
"name":"calls-operations",
"description":"",
"x-type":"section",
"x-displayName":"Calls Operations"
},
{
"name":"application-transfer-management",
"description":"",
"x-type":"section",
"x-displayName":"Application Transfer"
},
{
"name":"conference-calls",
"description":"Applications can connect multiple calls together, no matter if these calls are inbound or outbound, and no matter the type of the endpoint for each of these calls. \n\nWhen your application needs to connect only two calls together, it is not necessary to explicitly manage conference objects and use conferencing APIs – the *connect* API method on calls will manage these conferencing objects on your behalf.\n\nWhen your application needs to put together 3 or more calls together, you need to use the conference methods and their related actions.\n",
"x-type":"submodule",
"x-displayName":"Conference Calls"
},
{
"name":"conference-management",
"description":"",
"x-type":"section",
"x-displayName":"Conference Management"
},
{
"name":"conference-operations",
"description":"",
"x-type":"section",
"x-displayName":"Conference Operations"
},
{
"name":"dialog-calls",
"description":"A Dialog offers another way to connect two calls together without relying on the implicit or explicit creation of a conference. \n\nTwo calls connected over a Dialog cannot be joined by additional participants and the overall connection flow will result in less events than when using other methods, such as `conference` or `connect`.\n\nAnother difference between Dialog and Connect/Conference APIs is that, unlike the latter, Dialog allows for early media propagation & media bypass. \n\nWhen creating a Dialog on an unanswered inbound call, the inbound call will be automatically answered once the destination party answers the call.\n",
"x-type":"submodule",
"x-displayName":"Dialog Calls"
},
{
"name":"dialog-management",
"description":"",
"x-type":"section",
"x-displayName":"Dialog Management"
},
{
"name":"dialog-operations",
"description":"",
"x-type":"section",
"x-displayName":"Dialog Operations"
},
{
"name":"sip-trunks",
"description":"Calls API allows your application to handle both inbound and outbound SIP calls. \n\nBefore your application can process an inbound SIP call or create an outbound one, you need to create at least one new SIP trunk with methods listed below.\n",
"x-type":"submodule",
"x-displayName":"SIP Trunks"
},
{
"name":"sip-trunk-management",
"description":"",
"x-type":"section",
"x-displayName":"SIP Trunk Management"
},
{
"name":"sip-trunk-status-management",
"description":"",
"x-type":"section",
"x-displayName":"SIP Trunk Status Management"
},
{
"name":"sip-trunk-service-address-management",
"description":"",
"x-type":"section",
"x-displayName":"SIP Trunk Service Address Management"
},
{
"name":"files-and-recordings",
"description":"Files operations allow the upload, list and delete audio files. These audio files can be played back in calls and conferences.\n\nRecordings methods allow to list, retrieve and delete audio and video recordings performed on calls and conferences.\n",
"x-type":"submodule",
"x-displayName":"Files And Recordings"
},
{
"name":"file-operations",
"description":"",
"x-type":"section",
"x-displayName":"File Operations"
},
{
"name":"recording-operations",
"description":"",
"x-type":"section",
"x-displayName":"Recording Operations"
},
{
"name":"media-stream",
"description":"Calls API allows your application to stream outbound call media to an arbitrary host. Before initiating the stream, you will need to create at least one new media-stream configuration. After creating the configuration, use the configuration ID within a call to start/stop streaming media. Media is streamed as a series of raw bytes. Currently only audio is supported.",
"x-type":"submodule",
"x-displayName":"Media streaming"
},
{
"name":"media-stream-configuration",
"description":"",
"x-type":"section",
"x-displayName":"Media stream configuration"
},
{
"name":"calls-applications",
"description":"Most actions performed on calls, conferences and dialogs using the Calls API will trigger one or several events to confirm the completion of the action’s execution, to update on call status or to raise an error. Events are sent to your exposed application webhooks using Subscriptions. \n\nFor more information about Calls application and subscriptions, read the following [documentation](https://www.infobip.com/docs/voice-and-video/calls#applications-concepts). Subscriptions can be managed via [API](https://www.infobip.com/docs/api/platform/subscriptions-api) or on the [Portal](https://portal.infobip.com/dev/subscriptions). The objective of this documentation is to list and document the content of all possible Calls API events you can configure via subscriptions.\n",
"x-type":"submodule",
"x-displayName":"Calls Events"
},
{
"name":"application-webhooks",
"description":"",
"x-type":"section",
"x-displayName":"Webhooks"
},
{
"name":"bulks",
"description":"The bulks API methods allow you to create multiple calls with a single request and managed the scheduled bulks. Calls that will be generated with the bulk methods support the same options as when creating singular calls, such as automated machine detection, recording and support of multiple endpoint types (phone, webRTC, SIP or Viber). Bulk calls do support additional parameters such as:\n\n* scheduling: when to start the call generation, and which are calling time windows for these calls to be generated\n* validity period: how long should Infobip try to generate these calls. This is a particularly interesting parameter to consider when defining calling time windows\n* call rate: the number of calls you should start during the specified time unit (such as 15 calls per minute or 60 calls per hour)\n\nMultiple bulks, each targeting multiple destinations with their own schedule and validity, can be bundled in a single request.\n\nBulks can be paused, resumed, canceled or rescheduled. Each new call within a bulk will result in the same stream of event status update as individually created calls (call_started, call_pre_established, call_ringing,…), giving your application full visibility and control about how each individual call needs to be handled.\n",
"x-type":"submodule",
"x-displayName":"Bulks"
},
{
"name":"bulk-call-management",
"description":"",
"x-type":"section",
"x-displayName":"Bulk Calls Management"
},
{
"name":"bulk-call-operations",
"description":"",
"x-type":"section",
"x-displayName":"Bulk Calls Operations"
},
{
"name":"calls-markup-language",
"description":"Calls Markup Language (CML) is a simple JSON-based language that enables you to define the flow of your voice application in a human readable format.",
"x-type":"module",
"x-displayName":"Calls Markup Language"
},
{
"name":"calls-markup-language-create",
"description":"",
"x-type":"section",
"x-displayName":"Calls Markup Language"
},
{
"name":"markup-language-instructions",
"description":"",
"x-type":"section",
"x-displayName":"Calls Markup Language Webhook"
},
{
"name":"markup-language-instructions-async",
"description":"",
"x-type":"section",
"x-displayName":"Calls Markup Language Webhook Async"
},
{
"name":"calls-markup-language-configuration",
"description":"",
"x-type":"section",
"x-displayName":"Calls Markup Language Configuration"
},
{
"name":"voice-message",
"description":"The Voice Message API initiate outbound calls to one or more destination numbers (landline or mobile). When the call has been answered, pre-recorded or text-to-speech converted audio file will be played to the recipient. Three flavors of voice messaging are available:\n\n* Single voice message: call one target number at a time, and play an audio file or text to speech\n* Multiple voice message: same as simple, but allows to define an array of messages, each with their own multiple target numbers\n* Advanced voice message: same as multiple, but\n * Can use Automated Machine Detection\n * Can define schedule for sending calls\n * Can define acceptable time windows for sending\n * Can capture 1 DTMF input from the callee(s), and report it via webhook, or or use DTMF input to forward the call to defined destination\n",
"x-type":"module",
"x-displayName":"Voice Message"
},
{
"name":"voice-message-sending-operations",
"description":"",
"x-type":"section",
"x-displayName":"Voice Message Sending Operations"
},
{
"name":"voice-message-scheduling-operations",
"description":"",
"x-type":"section",
"x-displayName":"Voice Message Scheduling Operations"
},
{
"name":"interactive-voice-response",
"description":"The IVR API enables the creation of inbound and outbound interactive call scenarios. For inbound calls, once your scenario is created you will need to link this scenario to the phone number you are renting on the Infobip platform using the [voice setup on number](#platform-connectivity/numbers/create-voice-setup-on-number) method.\n\nIVR scenarios can use the Record action to record a portion of the call. These recordings can be retrieved using the *Search Voice IVR Recorded Files* and *Download Voice IVR Recorded File*. Alternatively, IVR recorded audio can also be found using the [Search Recording](#channels/voice/search-recordings) method.\n",
"x-type":"module",
"x-displayName":"Interactive Voice Response"
},
{
"name":"manage-ivr-scenarios",
"description":"",
"x-type":"section",
"x-displayName":"Manage IVR Scenarios"
},
{
"name":"retrieve-recorded-files",
"description":"",
"x-type":"section",
"x-displayName":"Retrieve Recorded Files"
},
{
"name":"ivr-uploaded-files",
"description":"",
"x-type":"section",
"x-displayName":"Manage uploaded files"
},
{
"name":"click-to-call",
"description":"Click To Call",
"x-type":"module",
"x-displayName":"Click To Call"
},
{
"name":"voice-reports-and-logs",
"description":"Voice Reports And Logs",
"x-type":"module",
"x-displayName":"Voice Reports And Logs"
},
{
"name":"number-masking",
"description":"The Number Masking service enables two parties to engage in a conversation over the phone without exposing their phone numbers to each other. This service is ideal for businesses that share customer information with third parties. Have in mind that the Number masking mapping has to be implemented on your side in order to define to which phone number the incoming call should be forwarded to. Number masking mapping depends on your business logic.\n\nAll Number Masking calls can be recorded. To enable recording feature on Number masking calls, please check [Voice recording feature](#platform-connectivity/numbers/create-recording-configuration) documentation section. Recording on Number masking calls could be enabled using [Apps section](https://portal.infobip.com/apps/voice) of the portal.\n\nTo fetch recorded audio files please check [Voice recording audio page](#channels/voice/search-recordings). You may also fetch recorded audio files using [Recording page](https://portal.infobip.com/analyze/recordings) section of the portal.\n\n[Read more](https://www.infobip.com/docs/voice-and-video/number-masking#setup-using-api-setup)\n",
"x-type":"module",
"x-displayName":"Number Masking"
},
{
"name":"number-masking-configurations",
"description":"",
"x-type":"section",
"x-displayName":"Number Masking Configurations"
},
{
"name":"number-masking-events",
"description":"",
"x-type":"section",
"x-displayName":"Number Masking Events"
},
{
"name":"number-masking-credentials",
"description":"",
"x-type":"section",
"x-displayName":"Number Masking Credentials"
},
{
"name":"routing",
"description":"This API offers advanced calls routing features. You can use it to set up destinations of different types and routing logic between them.\n",
"x-type":"module",
"x-displayName":"Call Routing application"
},
{
"name":"call-routing-configurations",
"description":"",
"x-type":"section",
"x-displayName":"Call Routing Configuration"
},
{
"name":"call-routing-recordings",
"description":"",
"x-type":"section",
"x-displayName":"Call Routing Recordings"
},
{
"name":"call-routing-events",
"description":"",
"x-type":"section",
"x-displayName":"Call Routing Events"
},
{
"name":"call-routing-status-management",
"description":"",
"x-type":"section",
"x-displayName":"Call Routing Status Management"
},
{
"name":"call-routing-simulator",
"description":"",
"x-type":"section",
"x-displayName":"Call Routing Simulator"
}
],
"paths":{
"/calls/1/configurations":{
"get":{
"tags":[
"channels",
"voice",
"calls",
"calls-configurations",
"calls-configuration"
],
"summary":"Get calls configurations",
"description":"Get calls configurations.",
"operationId":"get-calls-configurations",
"parameters":[
{
"name":"page",
"in":"query",
"description":"Results page to retrieve (0..N).",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":0,
"minimum":0
}
},
{
"name":"size",
"in":"query",
"description":"Number of records per page.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":20,
"maximum":100,
"minimum":1
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.CallsConfigurationPage"
},
"examples":{
"List of calls configurations":{
"summary":"List of calls configurations",
"value":{
"results":[
{
"id":"63467c6e2885a5389ba11d80",
"name":"Calls configuration"
}
],
"paging":{
"page":0,
"size":1,
"totalPages":1,
"totalResults":1
}
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:configuration:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
},
"post":{
"tags":[
"channels",
"voice",
"calls",
"calls-configurations",
"calls-configuration"
],
"summary":"Create calls configuration",
"description":"Create calls configuration.",
"operationId":"create-calls-configuration",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/87fdb606ad2c440ed89e04f515deb90150ccd79b7e43f8b50549f5895d6c3429.CallsConfigurationCreateRequest"
},
"examples":{
"Request example":{
"summary":"Request example",
"value":{
"id":"63467c6e2885a5389ba11d80",
"name":"Calls configuration"
}
}
}
}
},
"required":true
},
"responses":{
"201":{
"description":"Calls configuration created.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/87fdb606ad2c440ed89e04f515deb90150ccd79b7e43f8b50549f5895d6c3429.CallsConfigurationResponse"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":{
"id":"63467c6e2885a5389ba11d80",
"name":"Calls configuration"
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:configuration:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"m"
}
]
}
},
"/calls/1/configurations/{callsConfigurationId}":{
"get":{
"tags":[
"channels",
"voice",
"calls",
"calls-configurations",
"calls-configuration"
],
"summary":"Get calls configuration",
"description":"Get a single calls configuration.",
"operationId":"get-calls-configuration",
"parameters":[
{
"name":"callsConfigurationId",
"in":"path",
"description":"Calls configuration ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/87fdb606ad2c440ed89e04f515deb90150ccd79b7e43f8b50549f5895d6c3429.CallsConfigurationResponse"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":{
"id":"63467c6e2885a5389ba11d80",
"name":"Calls configuration"
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:configuration:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
},
"put":{
"tags":[
"channels",
"voice",
"calls",
"calls-configurations",
"calls-configuration"
],
"summary":"Update calls configuration",
"description":"Update calls configuration.",
"operationId":"update-calls-configuration",
"parameters":[
{
"name":"callsConfigurationId",
"in":"path",
"description":"Calls configuration ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/87fdb606ad2c440ed89e04f515deb90150ccd79b7e43f8b50549f5895d6c3429.CallsConfigurationUpdateRequest"
},
"examples":{
"Update request example":{
"summary":"Update request example",
"value":{
"name":"Calls configuration"
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/87fdb606ad2c440ed89e04f515deb90150ccd79b7e43f8b50549f5895d6c3429.CallsConfigurationResponse"
},
"examples":{
"Update response example":{
"summary":"Update response example",
"value":{
"id":"63467c6e2885a5389ba11d80",
"name":"Calls configuration"
}
}
}
}
}
},
"400":{
"$ref":"#/components/responses/ApiException400"
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:configuration:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
},
"delete":{
"tags":[
"channels",
"voice",
"calls",
"calls-configurations",
"calls-configuration"
],
"summary":"Delete calls configuration",
"description":"Delete calls configuration.",
"operationId":"delete-calls-configuration",
"parameters":[
{
"name":"callsConfigurationId",
"in":"path",
"description":"Calls configuration ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/87fdb606ad2c440ed89e04f515deb90150ccd79b7e43f8b50549f5895d6c3429.CallsConfigurationResponse"
},
"examples":{
"Delete response example":{
"summary":"Delete response example",
"value":{
"id":"63467c6e2885a5389ba11d80",
"name":"Calls configuration"
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:configuration:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/calls":{
"get":{
"tags":[
"channels",
"voice",
"calls",
"call-legs",
"calls-management"
],
"summary":"Get calls",
"description":"Get calls with pagination.",
"operationId":"get-calls",
"parameters":[
{
"name":"type",
"in":"query",
"description":"Call endpoint type.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallEndpointType"
},
"example":"PHONE"
},
{
"name":"callsConfigurationId",
"in":"query",
"description":"Calls Configuration ID.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"dc5942707c704551a00cd2ea"
},
{
"name":"applicationId",
"in":"query",
"description":"Application ID.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"61c060db2675060027d8c7a6"
},
{
"name":"from",
"in":"query",
"description":"Caller identifier.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":44790123456
},
{
"name":"to",
"in":"query",
"description":"Callee identifier.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":44790987654
},
{
"name":"direction",
"in":"query",
"description":"Call direction.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallDirection"
},
"example":"OUTBOUND"
},
{
"name":"status",
"in":"query",
"description":"Call state.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallState"
},
"example":"FINISHED"
},
{
"name":"startTimeAfter",
"in":"query",
"description":"Date and time for when the call has been created. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ`.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"format":"date-time"
},
"example":"2022-05-01T14:25:45.125+0000"
},
{
"name":"conferenceId",
"in":"query",
"description":"Conference ID.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"066675c6-0db6-0db9-b032-031964d09af4"
},
{
"name":"dialogId",
"in":"query",
"description":"Dialog ID.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"6c73cbdc-c956-4bf5-a026-318236559167"
},
{
"name":"bulkId",
"in":"query",
"description":"Bulk ID.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"bde6deaa-23af-4340-aac7-f3fa063c4215"
},
{
"name":"page",
"in":"query",
"description":"Results page to retrieve (0..N).",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":0,
"minimum":0
}
},
{
"name":"size",
"in":"query",
"description":"Number of records per page.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":20,
"maximum":100,
"minimum":1
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallPage"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:logs:read"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
},
"post":{
"tags":[
"channels",
"voice",
"calls",
"call-legs",
"calls-management"
],
"summary":"Create call",
"description":"Create an outbound call to a given endpoint.",
"operationId":"create-call",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.CallRequest"
},
"examples":{
"Basic call request":{
"summary":"Basic call request",
"value":{
"endpoint":{
"type":"PHONE",
"phoneNumber":"41792036727"
},
"from":"41793026834",
"connectTimeout":30,
"maxDuration":300,
"callsConfigurationId":"dc5942707c704551a00cd2ea"
}
},
"Call request to WEBRTC endpoint":{
"summary":"Call request to WEBRTC endpoint",
"value":{
"endpoint":{
"type":"WEBRTC",
"identity":"Bob",
"displayName":"Bob"
},
"from":"41793026834",
"connectTimeout":30,
"maxDuration":300,
"callsConfigurationId":"dc5942707c704551a00cd2ea"
}
},
"Call request to SIP endpoint":{
"summary":"Call request to SIP endpoint",
"value":{
"endpoint":{
"type":"SIP",
"username":"username"
},
"from":"41793026834",
"connectTimeout":30,
"maxDuration":300,
"callsConfigurationId":"dc5942707c704551a00cd2ea"
}
},
"Call request to WEBSOCKET endpoint":{
"summary":"Call request to WEBSOCKET endpoint",
"value":{
"endpoint":{
"type":"WEBSOCKET",
"websocketEndpointConfigId":"websocket-config-id",
"identifier":"identifier"
},
"from":"41793026834",
"connectTimeout":30,
"maxDuration":300,
"callsConfigurationId":"dc5942707c704551a00cd2ea"
}
},
"Call request to VIBER endpoint":{
"summary":"Call request to VIBER endpoint",
"value":{
"endpoint":{
"type":"VIBER",
"phoneNumber":"41792036727"
},
"from":"41793026834",
"connectTimeout":30,
"maxDuration":300,
"callsConfigurationId":"dc5942707c704551a00cd2ea"
}
},
"Advanced Call request":{
"summary":"Advanced Call request",
"value":{
"endpoint":{
"type":"VIBER",
"phoneNumber":"41792036727"
},
"from":"41793026834",
"connectTimeout":30,
"recording":{
"recordingType":"AUDIO"
},
"maxDuration":300,
"callsConfigurationId":"dc5942707c704551a00cd2ea",
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
}
}
},
"Call request with machine detection":{
"summary":"Call request with machine detection",
"value":{
"endpoint":{
"type":"VIBER",
"phoneNumber":"41792036727"
},
"from":"41793026834",
"connectTimeout":30,
"recording":{
"recordingType":"AUDIO"
},
"machineDetection":{
"enabled":true
},
"maxDuration":300,
"callsConfigurationId":"dc5942707c704551a00cd2ea",
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
}
}
}
}
}
},
"required":true
},
"responses":{
"201":{
"description":"Call created.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/431fb79b0e816230968e14ba1e1c6fadb75cfde9cb3c381f4217b2777f48153f.Call"
},
"examples":{
"PHONE call response":{
"summary":"PHONE call response",
"value":{
"id":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"endpoint":{
"type":"PHONE",
"phoneNumber":"41792036727"
},
"from":"41793026834",
"to":"41792036727",
"direction":"OUTBOUND",
"state":"ESTABLISHED",
"startTime":"2026-01-15T11:59:30.000+0000",
"answerTime":"2026-01-15T11:59:35.000+0000",
"endTime":"2026-01-15T12:00:00.000+0000",
"callsConfigurationId":"dc5942707c704551a00cd2ea",
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
},
"customData":{
"key1":"value1",
"key2":"value2"
}
}
},
"WEBRTC call response":{
"summary":"WEBRTC call response",
"value":{
"id":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"endpoint":{
"type":"WEBRTC",
"identity":"Bob",
"displayName":"Bob"
},
"from":"41793026834",
"to":"41792036727",
"direction":"OUTBOUND",
"state":"ESTABLISHED",
"startTime":"2026-01-15T11:59:30.000+0000",
"answerTime":"2026-01-15T11:59:35.000+0000",
"endTime":"2026-01-15T12:00:00.000+0000",
"callsConfigurationId":"dc5942707c704551a00cd2ea",
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
},
"customData":{
"key1":"value1",
"key2":"value2"
}
}
},
"SIP call response":{
"summary":"SIP call response",
"value":{
"id":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"endpoint":{
"type":"SIP",
"username":"username"
},
"from":"41793026834",
"to":"41792036727",
"direction":"OUTBOUND",
"state":"ESTABLISHED",
"startTime":"2026-01-15T11:59:30.000+0000",
"answerTime":"2026-01-15T11:59:35.000+0000",
"endTime":"2026-01-15T12:00:00.000+0000",
"callsConfigurationId":"dc5942707c704551a00cd2ea",
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
},
"customData":{
"key1":"value1",
"key2":"value2"
}
}
},
"VIBER call response":{
"summary":"VIBER call response",
"value":{
"id":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"endpoint":{
"type":"VIBER",
"phoneNumber":"41792036727"
},
"from":"41793026834",
"to":"41792036727",
"direction":"OUTBOUND",
"state":"ESTABLISHED",
"startTime":"2026-01-15T11:59:30.000+0000",
"answerTime":"2026-01-15T11:59:35.000+0000",
"endTime":"2026-01-15T12:00:00.000+0000",
"callsConfigurationId":"dc5942707c704551a00cd2ea",
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
},
"customData":{
"key1":"value1",
"key2":"value2"
}
}
},
"WHATSAPP call response":{
"summary":"WHATSAPP call response",
"value":{
"id":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"endpoint":{
"type":"WHATSAPP",
"phoneNumber":"41792036727"
},
"from":"41793026834",
"to":"41792036727",
"direction":"OUTBOUND",
"state":"ESTABLISHED",
"startTime":"2026-01-15T11:59:30.000+0000",
"answerTime":"2026-01-15T11:59:35.000+0000",
"endTime":"2026-01-15T12:00:00.000+0000",
"callsConfigurationId":"dc5942707c704551a00cd2ea",
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
},
"customData":{
"key1":"value1",
"key2":"value2"
}
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Application not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:traffic:send"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":6,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/calls/{callId}":{
"get":{
"tags":[
"channels",
"voice",
"calls",
"call-legs",
"calls-management"
],
"summary":"Get call",
"description":"Get a single call.",
"operationId":"get-call",
"parameters":[
{
"name":"callId",
"in":"path",
"description":"Call ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/431fb79b0e816230968e14ba1e1c6fadb75cfde9cb3c381f4217b2777f48153f.Call"
},
"examples":{
"PHONE call response":{
"summary":"PHONE call response",
"value":{
"id":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"endpoint":{
"type":"PHONE",
"phoneNumber":"41792036727"
},
"from":"41793026834",
"to":"41792036727",
"direction":"OUTBOUND",
"state":"ESTABLISHED",
"startTime":"2026-01-15T11:59:30.000+0000",
"answerTime":"2026-01-15T11:59:35.000+0000",
"endTime":"2026-01-15T12:00:00.000+0000",
"callsConfigurationId":"dc5942707c704551a00cd2ea",
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
},
"customData":{
"key1":"value1",
"key2":"value2"
}
}
},
"WEBRTC call response":{
"summary":"WEBRTC call response",
"value":{
"id":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"endpoint":{
"type":"WEBRTC",
"identity":"Bob",
"displayName":"Bob"
},
"from":"41793026834",
"to":"41792036727",
"direction":"OUTBOUND",
"state":"ESTABLISHED",
"startTime":"2026-01-15T11:59:30.000+0000",
"answerTime":"2026-01-15T11:59:35.000+0000",
"endTime":"2026-01-15T12:00:00.000+0000",
"callsConfigurationId":"dc5942707c704551a00cd2ea",
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
},
"customData":{
"key1":"value1",
"key2":"value2"
}
}
},
"SIP call response":{
"summary":"SIP call response",
"value":{
"id":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"endpoint":{
"type":"SIP",
"username":"username"
},
"from":"41793026834",
"to":"41792036727",
"direction":"OUTBOUND",
"state":"ESTABLISHED",
"startTime":"2026-01-15T11:59:30.000+0000",
"answerTime":"2026-01-15T11:59:35.000+0000",
"endTime":"2026-01-15T12:00:00.000+0000",
"callsConfigurationId":"dc5942707c704551a00cd2ea",
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
},
"customData":{
"key1":"value1",
"key2":"value2"
}
}
},
"VIBER call response":{
"summary":"VIBER call response",
"value":{
"id":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"endpoint":{
"type":"VIBER",
"phoneNumber":"41792036727"
},
"from":"41793026834",
"to":"41792036727",
"direction":"OUTBOUND",
"state":"ESTABLISHED",
"startTime":"2026-01-15T11:59:30.000+0000",
"answerTime":"2026-01-15T11:59:35.000+0000",
"endTime":"2026-01-15T12:00:00.000+0000",
"callsConfigurationId":"dc5942707c704551a00cd2ea",
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
},
"customData":{
"key1":"value1",
"key2":"value2"
}
}
},
"WHATSAPP call response":{
"summary":"WHATSAPP call response",
"value":{
"id":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"endpoint":{
"type":"WHATSAPP",
"phoneNumber":"41792036727"
},
"from":"41793026834",
"to":"41792036727",
"direction":"OUTBOUND",
"state":"ESTABLISHED",
"startTime":"2026-01-15T11:59:30.000+0000",
"answerTime":"2026-01-15T11:59:35.000+0000",
"endTime":"2026-01-15T12:00:00.000+0000",
"callsConfigurationId":"dc5942707c704551a00cd2ea",
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
},
"customData":{
"key1":"value1",
"key2":"value2"
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:logs:read"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/calls/history":{
"get":{
"tags":[
"channels",
"voice",
"calls",
"call-legs",
"calls-management"
],
"summary":"Get calls history",
"description":"Get calls history with pagination. Calls history retention period is 5 days.",
"operationId":"get-calls-history",
"parameters":[
{
"name":"type",
"in":"query",
"description":"Call endpoint type.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallEndpointType"
},
"example":"PHONE"
},
{
"name":"callsConfigurationId",
"in":"query",
"description":"Calls Configuration ID.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"dc5942707c704551a00cd2ea"
},
{
"name":"applicationId",
"in":"query",
"description":"Application ID.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"61c060db2675060027d8c7a6"
},
{
"name":"from",
"in":"query",
"description":"Caller identifier.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":44790123456
},
{
"name":"to",
"in":"query",
"description":"Callee identifier.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":44790987654
},
{
"name":"direction",
"in":"query",
"description":"Call direction.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallDirection"
},
"example":"OUTBOUND"
},
{
"name":"status",
"in":"query",
"description":"Call state.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallState"
},
"example":"FINISHED"
},
{
"name":"startTimeAfter",
"in":"query",
"description":"Date and time for when the call has been created. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ`.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"format":"date-time"
},
"example":"2022-05-01T14:25:45.125+0000"
},
{
"name":"conferenceId",
"in":"query",
"description":"Conference ID.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"066675c6-0db6-0db9-b032-031964d09af4"
},
{
"name":"dialogId",
"in":"query",
"description":"Dialog ID.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"6c73cbdc-c956-4bf5-a026-318236559167"
},
{
"name":"bulkId",
"in":"query",
"description":"Bulk ID.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"bde6deaa-23af-4340-aac7-f3fa063c4215"
},
{
"name":"page",
"in":"query",
"description":"Results page to retrieve (0..N).",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":0,
"minimum":0
}
},
{
"name":"size",
"in":"query",
"description":"Number of records per page.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":20,
"maximum":100,
"minimum":1
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallLogPage"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:logs:read"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/calls/{callId}/history":{
"get":{
"tags":[
"channels",
"voice",
"calls",
"call-legs",
"calls-management"
],
"summary":"Get call history",
"description":"Get a single call history. Call history retention period is 5 days.",
"operationId":"get-call-history",
"parameters":[
{
"name":"callId",
"in":"path",
"description":"Call ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/431fb79b0e816230968e14ba1e1c6fadb75cfde9cb3c381f4217b2777f48153f.CallLog"
},
"examples":{
"PHONE call response":{
"summary":"PHONE call response",
"value":{
"callId":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"endpoint":{
"type":"PHONE",
"phoneNumber":"41792036727"
},
"from":"41793026834",
"to":"41792036727",
"direction":"OUTBOUND",
"state":"FINISHED",
"startTime":"2026-01-15T11:59:30.000+0000",
"answerTime":"2026-01-15T11:59:35.000+0000",
"endTime":"2026-01-15T12:00:00.000+0000",
"ringDuration":5,
"callsConfigurationIds":[
"dc5942707c704551a00cd2ea"
],
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
},
"conferenceIds":[
"e8a7c0f5-0f0b-4ccf-84a4-1b7e5f699001"
],
"duration":25,
"customData":{
"key1":"value1",
"key2":"value2"
},
"dialogId":"034e622a-cc7e-456d-8a10-0ba43b11aa5e"
}
},
"WEBRTC call response":{
"summary":"WEBRTC call response",
"value":{
"callId":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"endpoint":{
"type":"WEBRTC",
"identity":"Bob",
"displayName":"Bob"
},
"from":"41793026834",
"to":"41792036727",
"direction":"OUTBOUND",
"state":"FINISHED",
"startTime":"2026-01-15T11:59:30.000+0000",
"answerTime":"2026-01-15T11:59:35.000+0000",
"endTime":"2026-01-15T12:00:00.000+0000",
"ringDuration":5,
"callsConfigurationIds":[
"dc5942707c704551a00cd2ea"
],
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
},
"conferenceIds":[
"e8a7c0f5-0f0b-4ccf-84a4-1b7e5f699001"
],
"duration":25,
"customData":{
"key1":"value1",
"key2":"value2"
},
"dialogId":"034e622a-cc7e-456d-8a10-0ba43b11aa5e"
}
},
"SIP call response":{
"summary":"SIP call response",
"value":{
"callId":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"endpoint":{
"type":"SIP",
"username":"username"
},
"from":"41793026834",
"to":"41792036727",
"direction":"OUTBOUND",
"state":"FINISHED",
"startTime":"2026-01-15T11:59:30.000+0000",
"answerTime":"2026-01-15T11:59:35.000+0000",
"endTime":"2026-01-15T12:00:00.000+0000",
"ringDuration":5,
"callsConfigurationIds":[
"dc5942707c704551a00cd2ea"
],
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
},
"conferenceIds":[
"e8a7c0f5-0f0b-4ccf-84a4-1b7e5f699001"
],
"duration":25,
"customData":{
"key1":"value1",
"key2":"value2"
},
"dialogId":"034e622a-cc7e-456d-8a10-0ba43b11aa5e"
}
},
"VIBER call response":{
"summary":"VIBER call response",
"value":{
"callId":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"endpoint":{
"type":"VIBER",
"phoneNumber":"41792036727"
},
"from":"41793026834",
"to":"41792036727",
"direction":"OUTBOUND",
"state":"FINISHED",
"startTime":"2026-01-15T11:59:30.000+0000",
"answerTime":"2026-01-15T11:59:35.000+0000",
"endTime":"2026-01-15T12:00:00.000+0000",
"ringDuration":5,
"callsConfigurationIds":[
"dc5942707c704551a00cd2ea"
],
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
},
"conferenceIds":[
"e8a7c0f5-0f0b-4ccf-84a4-1b7e5f699001"
],
"duration":25,
"customData":{
"key1":"value1",
"key2":"value2"
},
"dialogId":"034e622a-cc7e-456d-8a10-0ba43b11aa5e"
}
},
"WHATSAPP call response":{
"summary":"WHATSAPP call response",
"value":{
"callId":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"endpoint":{
"type":"WHATSAPP",
"phoneNumber":"41792036727"
},
"from":"41793026834",
"to":"41792036727",
"direction":"OUTBOUND",
"state":"FINISHED",
"startTime":"2026-01-15T11:59:30.000+0000",
"answerTime":"2026-01-15T11:59:35.000+0000",
"endTime":"2026-01-15T12:00:00.000+0000",
"ringDuration":5,
"callsConfigurationIds":[
"dc5942707c704551a00cd2ea"
],
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
},
"conferenceIds":[
"e8a7c0f5-0f0b-4ccf-84a4-1b7e5f699001"
],
"duration":25,
"customData":{
"key1":"value1",
"key2":"value2"
},
"dialogId":"034e622a-cc7e-456d-8a10-0ba43b11aa5e"
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:logs:read"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/connect":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"call-legs",
"calls-management"
],
"summary":"Connect calls",
"description":"Connect calls in a conference.",
"operationId":"connect-calls",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/707907921d4508c2925eddc2449f10db322ecc083be424f87c50fe97ccd8be40.ConnectRequest"
},
"examples":{
"Connect request":{
"summary":"Connect request",
"value":{
"callIds":[
"d8d84155-3831-43fb-91c9-bb897149a79d",
"6539fcb4-4b2a-4ac9-a43a-d60807af29b0",
"d6d6058c-5077-49f9-a030-2fc40e8ca195"
]
}
},
"Connect request with conference":{
"summary":"Connect request with conference",
"value":{
"callIds":[
"d8d84155-3831-43fb-91c9-bb897149a79d",
"6539fcb4-4b2a-4ac9-a43a-d60807af29b0",
"d6d6058c-5077-49f9-a030-2fc40e8ca195"
],
"conferenceRequest":{
"name":"Example conference",
"recording":{
"recordingType":"AUDIO",
"conferenceComposition":{
"enabled":true
}
},
"callsConfigurationId":"dc5942707c704551a00cd2ea",
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
}
}
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Calls connected.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/c18e27d419b307552daa9403b0085ee796da1a5e57e2a4e6fb73f406471574fc.Conference"
},
"examples":{
"Conference response":{
"summary":"Conference response",
"value":{
"id":"e8a7c0f5-0f0b-4ccf-84a4-1b7e5f699001",
"name":"Example conference",
"participants":[],
"callsConfigurationId":"dc5942707c704551a00cd2ea",
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
}
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"One or more calls not found.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:traffic:send"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/calls/{callId}/connect":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"call-legs",
"calls-management"
],
"summary":"Connect with new call",
"description":"Connect an existing call with a new call in a conference.",
"operationId":"connect-with-new-call",
"parameters":[
{
"name":"callId",
"in":"path",
"description":"Call ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.ConnectWithNewCallRequest"
},
"examples":{
"Connect with new call request":{
"summary":"Connect with new call request",
"value":{
"callRequest":{
"endpoint":{
"type":"PHONE",
"phoneNumber":"41792036727"
},
"from":"41793026834"
},
"connectOnEarlyMedia":false
}
},
"Connect with new call and conference request":{
"summary":"Connect with new call and conference request",
"value":{
"callRequest":{
"endpoint":{
"type":"PHONE",
"phoneNumber":"41792036727"
},
"from":"41793026834",
"maxDuration":300
},
"connectOnEarlyMedia":false,
"conferenceRequest":{
"name":"Example conference",
"recording":{
"recordingType":"AUDIO",
"conferenceComposition":{
"enabled":true
}
},
"callsConfigurationId":"dc5942707c704551a00cd2ea",
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
}
}
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Calls connected in the conference.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/c18e27d419b307552daa9403b0085ee796da1a5e57e2a4e6fb73f406471574fc.ConferenceAndCall"
},
"examples":{
"Conference with new outbound call":{
"summary":"Conference with new outbound call",
"value":{
"conference":{
"id":"e8a7c0f5-0f0b-4ccf-84a4-1b7e5f699001",
"name":"Example conference",
"participants":[],
"callsConfigurationId":"dc5942707c704551a00cd2ea",
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
}
},
"call":{
"id":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"endpoint":{
"type":"PHONE",
"phoneNumber":"41792036727"
},
"from":"41793026834",
"to":"41792036727",
"direction":"OUTBOUND",
"state":"ESTABLISHED",
"startTime":"2026-01-15T11:59:30.000+0000",
"answerTime":"2026-01-15T11:59:35.000+0000",
"endTime":"2026-01-15T12:00:00.000+0000",
"callsConfigurationId":"dc5942707c704551a00cd2ea",
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
},
"customData":{
"key1":"value1",
"key2":"value2"
}
}
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Call or application not found.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:traffic:send"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":6,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/calls/{callId}/send-ringing":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"call-legs",
"calls-operations"
],
"summary":"Send ringing",
"description":"Send SIP ringtone to an unanswered inbound call.",
"operationId":"send-ringing",
"parameters":[
{
"name":"callId",
"in":"path",
"description":"Call ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse"
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:traffic:receive"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/calls/{callId}/pre-answer":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"call-legs",
"calls-operations"
],
"summary":"Pre-answer",
"description":"Pre-answer a call to handle early media.",
"operationId":"pre-answer-call",
"parameters":[
{
"name":"callId",
"in":"path",
"description":"Call ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/6665694460cb56ab854a173ada36805c85c7ec55584901d2f06225baf9b586cb.PublicPreAnswerRequest"
}
}
}
},
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse"
}
}
}
},
"400":{
"$ref":"#/components/responses/ApiException400"
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:traffic:receive"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/calls/{callId}/answer":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"call-legs",
"calls-operations"
],
"summary":"Answer",
"description":"Answer a call.",
"operationId":"answer-call",
"parameters":[
{
"name":"callId",
"in":"path",
"description":"Call ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AnswerRequest"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:traffic:receive"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/calls/{callId}/hangup":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"call-legs",
"calls-operations"
],
"summary":"Hangup",
"description":"Hang up a call.",
"operationId":"hangup-call",
"parameters":[
{
"name":"callId",
"in":"path",
"description":"Call ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/74d8b21d2b740d37eba3fa2f7296b180343b1bcffffec58c82756c7c83775e15.PublicHangupRequest"
},
"examples":{
"Basic hangup request example.":{
"summary":"Basic hangup request example.",
"value":{}
},
"Basic hangup request example with error code.":{
"summary":"Basic hangup request example with error code.",
"value":{
"errorCode":"NORMAL_HANGUP"
}
}
}
}
}
},
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/431fb79b0e816230968e14ba1e1c6fadb75cfde9cb3c381f4217b2777f48153f.Call"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:traffic:send"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/calls/{callId}/play":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"call-legs",
"calls-operations"
],
"summary":"Play file",
"description":"Play an audio file on a call.",
"operationId":"call-play-file",
"parameters":[
{
"name":"callId",
"in":"path",
"description":"Call ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/6665694460cb56ab854a173ada36805c85c7ec55584901d2f06225baf9b586cb.PublicPlayRequest"
},
"examples":{
"Play audio from file":{
"summary":"Play audio from file",
"value":{
"content":{
"fileId":"65f0b3d7c8b6a00001a2b3c4",
"type":"FILE"
}
}
},
"Play audio from URL":{
"summary":"Play audio from URL",
"value":{
"content":{
"fileUrl":"https://example.com/example-audio.wav",
"type":"URL"
}
}
},
"Play audio from TEXT":{
"summary":"Play audio from TEXT",
"value":{
"content":{
"text":"This is an example of text to speech",
"language":"en",
"type":"TEXT"
}
}
},
"Play TTY audio from TEXT":{
"summary":"Play TTY audio from TEXT",
"value":{
"content":{
"text":"This is a TTY example",
"type":"TTY"
}
}
},
"Play audio in loop":{
"summary":"Play audio in loop",
"value":{
"loopCount":3,
"content":{
"fileUrl":"https://example.com/example-audio.wav",
"type":"URL"
}
}
},
"Play audio with offset and timeout":{
"summary":"Play audio with offset and timeout",
"value":{
"timeout":30000,
"offset":5000,
"content":{
"fileId":"65f0b3d7c8b6a00001a2b3c4",
"type":"FILE"
}
}
},
"Play audio with stop on DTMF option":{
"summary":"Play audio with stop on DTMF option",
"value":{
"content":{
"fileId":"65f0b3d7c8b6a00001a2b3c4",
"type":"FILE"
},
"stopOn":{
"terminator":"5",
"type":"DTMF"
}
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:traffic:send"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/calls/{callId}/stop-play":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"call-legs",
"calls-operations"
],
"summary":"Stop playing file",
"description":"Stop playing an audio file on a call.",
"operationId":"call-stop-playing-file",
"parameters":[
{
"name":"callId",
"in":"path",
"description":"Call ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/6665694460cb56ab854a173ada36805c85c7ec55584901d2f06225baf9b586cb.PublicStopPlayRequest"
}
}
}
},
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse"
}
}
}
},
"400":{
"$ref":"#/components/responses/ApiException400"
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:traffic:send"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/calls/{callId}/say":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"call-legs",
"calls-operations"
],
"summary":"Say text",
"description":"Say text on a call.",
"operationId":"call-say-text",
"parameters":[
{
"name":"callId",
"in":"path",
"description":"Call ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.PublicSayRequest"
},
"examples":{
"Basic say request example":{
"summary":"Basic say request example",
"value":{
"text":"This is an example of text to speech",
"language":"en"
}
},
"Advanced say request example":{
"summary":"Advanced say request example",
"value":{
"text":"This is an advanced example of text to speech",
"language":"en",
"speechRate":1.5,
"loopCount":2,
"preferences":{
"voiceGender":"MALE"
},
"stopOn":{
"terminator":"#",
"type":"DTMF"
}
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:traffic:send"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/calls/{callId}/send-dtmf":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"call-legs",
"calls-operations"
],
"summary":"Send DTMF",
"description":"Send a DTMF on a call.",
"operationId":"call-send-dtmf",
"parameters":[
{
"name":"callId",
"in":"path",
"description":"Call ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/94dad8b938c4159f751dc1ff0b70e7beab7409955ce0b31399dbe9488973d3a6.DtmfSendRequest"
},
"examples":{
"Send DTMF with single digit":{
"summary":"Send DTMF with single digit",
"value":{
"dtmf":"3"
}
},
"Send DTMF with multiple digits":{
"summary":"Send DTMF with multiple digits",
"value":{
"dtmf":"341#"
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:traffic:send"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/calls/{callId}/capture/dtmf":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"call-legs",
"calls-operations"
],
"summary":"Capture DTMF",
"description":"Capture a DTMF on a call.",
"operationId":"call-capture-dtmf",
"parameters":[
{
"name":"callId",
"in":"path",
"description":"Call ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.DtmfCaptureRequest"
},
"examples":{
"Capture DTMF request example":{
"summary":"Capture DTMF request example",
"value":{
"maxLength":4,
"timeout":5000,
"terminator":"#",
"digitTimeout":3000
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:traffic:record"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/calls/{callId}/capture/speech":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"call-legs",
"calls-operations"
],
"summary":"Capture Speech",
"description":"Capture speech on a call.",
"operationId":"call-capture-speech",
"parameters":[
{
"name":"callId",
"in":"path",
"description":"Call ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.SpeechCaptureRequest"
},
"examples":{
"Start speech capture request":{
"summary":"Start speech capture request",
"value":{
"language":"en-GB",
"timeout":30,
"maxSilence":3,
"keyPhrases":[
"word",
"phrase"
],
"customDictionary":[
"custom",
"word"
],
"advancedFormatting":true
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:traffic:record"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/calls/{callId}/start-transcription":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"call-legs",
"calls-operations"
],
"summary":"Start transcription",
"description":"Start call transcription.",
"operationId":"call-start-transcription",
"parameters":[
{
"name":"callId",
"in":"path",
"description":"Call ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.PublicStartTranscriptionRequest"
},
"examples":{
"Start transcription request":{
"summary":"Start transcription request",
"value":{
"transcription":{
"language":"en-GB",
"sendInterimResults":true,
"customDictionary":[
"custom",
"word"
],
"advancedFormatting":true
}
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse"
}
}
}
},
"400":{
"$ref":"#/components/responses/ApiException400"
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:traffic:record"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/calls/{callId}/stop-transcription":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"call-legs",
"calls-operations"
],
"summary":"Stop transcription",
"description":"Stop call transcription.",
"operationId":"call-stop-transcription",
"parameters":[
{
"name":"callId",
"in":"path",
"description":"Call ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse"
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:traffic:record"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/calls/{callId}/start-recording":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"call-legs",
"calls-operations"
],
"summary":"Start recording",
"description":"Start a recording on a call.",
"operationId":"call-start-recording",
"parameters":[
{
"name":"callId",
"in":"path",
"description":"Call ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.RecordingStartRequest"
},
"examples":{
"Start audio recording":{
"summary":"Start audio recording",
"value":{
"recording":{
"recordingType":"AUDIO"
}
}
},
"Start audio recording with additional options":{
"summary":"Start audio recording with additional options",
"value":{
"recording":{
"recordingType":"AUDIO",
"maxSilence":5,
"beep":true,
"maxDuration":20,
"customData":{
"key1":"value1",
"key2":"value2"
},
"filePrefix":"customFilename"
}
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:traffic:record"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/calls/{callId}/stop-recording":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"call-legs",
"calls-operations"
],
"summary":"Stop recording",
"description":"Stop a recording on a call.",
"operationId":"call-stop-recording",
"parameters":[
{
"name":"callId",
"in":"path",
"description":"Call ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:traffic:record"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/calls/{callId}/start-media-stream":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"call-legs",
"calls-operations"
],
"summary":"Start streaming media",
"description":"Start streaming media.",
"operationId":"start-media-stream",
"parameters":[
{
"name":"callId",
"in":"path",
"description":"Call ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.StartMediaStreamRequest"
},
"examples":{
"Start media stream request example":{
"summary":"Start media stream request example",
"value":{
"mediaStream":{
"audioProperties":{
"mediaStreamConfigId":"63467c6e2885a5389ba11d80",
"replaceMedia":false,
"multiChannel":{
"enabled":false
}
}
}
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:traffic:record"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/calls/{callId}/stop-media-stream":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"call-legs",
"calls-operations"
],
"summary":"Stop streaming media",
"description":"Stop streaming media.",
"operationId":"stop-media-stream",
"parameters":[
{
"name":"callId",
"in":"path",
"description":"Call ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:traffic:record"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/calls/{callId}/send-message":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"call-legs",
"calls-operations"
],
"summary":"Send message",
"description":"Send a message to a specific WebRTC call leg.",
"operationId":"call-send-message",
"parameters":[
{
"name":"callId",
"in":"path",
"description":"Call ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/6665694460cb56ab854a173ada36805c85c7ec55584901d2f06225baf9b586cb.CallSendMessageRequest"
},
"examples":{
"Send message to WebRTC endpoint":{
"summary":"Send message to WebRTC endpoint",
"value":{
"message":"This meeting will end in 5 minutes."
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:traffic:send"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/calls/{callId}/application-transfer":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"call-legs",
"application-transfer-management"
],
"summary":"Request application transfer",
"description":"Request application transfer.",
"operationId":"application-transfer",
"parameters":[
{
"name":"callId",
"in":"path",
"description":"Call ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/be917819c3f3f7072f44fe3d7909e7b833fe4857710e7f5ab585df108ef1ed5b.ApplicationTransferRequest"
},
"examples":{
"Application transfer request":{
"summary":"Application transfer request",
"value":{
"destinationCallsConfigurationId":"dc5942707c704551a00cd2ea",
"timeout":20
}
},
"Application transfer request with platform":{
"summary":"Application transfer request with platform",
"value":{
"destinationCallsConfigurationId":"dc5942707c704551a00cd2ea",
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
},
"timeout":20
}
},
"Application transfer request with propagation options":{
"summary":"Application transfer request with propagation options",
"value":{
"destinationCallsConfigurationId":"dc5942707c704551a00cd2ea",
"timeout":20,
"propagationOptions":{
"recordingTransferOptions":{
"continueCallRecording":true
}
}
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:traffic:send"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/calls/{callId}/application-transfer/{transferId}/accept":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"call-legs",
"application-transfer-management"
],
"summary":"Accept application transfer",
"description":"Accept application transfer.",
"operationId":"application-transfer-accept",
"parameters":[
{
"name":"callId",
"in":"path",
"description":"Call ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
},
{
"name":"transferId",
"in":"path",
"description":"The unique identifier of a transfer, sent to the receiving application in an `ApplicationTransferRequestedEvent`.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:traffic:receive"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/calls/{callId}/application-transfer/{transferId}/reject":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"call-legs",
"application-transfer-management"
],
"summary":"Reject application transfer",
"description":"Reject application transfer.",
"operationId":"application-transfer-reject",
"parameters":[
{
"name":"callId",
"in":"path",
"description":"Call ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
},
{
"name":"transferId",
"in":"path",
"description":"The unique identifier of a transfer, sent to the receiving application in an `ApplicationTransferRequestedEvent`.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:traffic:receive"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/conferences":{
"get":{
"tags":[
"channels",
"voice",
"calls",
"conference-calls",
"conference-management"
],
"summary":"Get conferences",
"description":"Get conferences with pagination.",
"operationId":"get-conferences",
"parameters":[
{
"name":"name",
"in":"query",
"description":"Conference name.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"Conference"
},
{
"name":"callId",
"in":"query",
"description":"Call ID.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"066675c6-0db6-0db9-b032-031964d09af4"
},
{
"name":"callsConfigurationId",
"in":"query",
"description":"Calls Configuration ID.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"dc5942707c704551a00cd2ea"
},
{
"name":"applicationId",
"in":"query",
"description":"Application ID.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"61c060db2675060027d8c7a6"
},
{
"name":"startTimeAfter",
"in":"query",
"description":"Date and time for when the conference has been created. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ`.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"format":"date-time"
},
"example":"2022-05-01T14:25:45.125+0000"
},
{
"name":"page",
"in":"query",
"description":"Results page to retrieve (0..N).",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":0,
"minimum":0
}
},
{
"name":"size",
"in":"query",
"description":"Number of records per page.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":20,
"maximum":100,
"minimum":1
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.ConferencePage"
},
"examples":{
"Conference page response.":{
"summary":"Conference page response.",
"value":{
"results":[
{
"id":"e8a7c0f5-0f0b-4ccf-84a4-1b7e5f699001",
"name":"Example conference",
"participants":[],
"callsConfigurationId":"dc5942707c704551a00cd2ea",
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
}
}
],
"paging":{
"page":0,
"size":1,
"totalPages":1,
"totalResults":1
}
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:logs:read"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
},
"post":{
"tags":[
"channels",
"voice",
"calls",
"conference-calls",
"conference-management"
],
"summary":"Create conference",
"description":"Create a conference.",
"operationId":"create-conference",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/707907921d4508c2925eddc2449f10db322ecc083be424f87c50fe97ccd8be40.ConferenceRequest"
},
"examples":{
"Conference request":{
"summary":"Conference request",
"value":{
"name":"Example conference",
"callsConfigurationId":"dc5942707c704551a00cd2ea",
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
}
}
},
"Conference request with recording":{
"summary":"Conference request with recording",
"value":{
"name":"Example conference",
"recording":{
"recordingType":"AUDIO",
"conferenceComposition":{
"enabled":true
}
},
"callsConfigurationId":"dc5942707c704551a00cd2ea",
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
}
}
}
}
}
},
"required":true
},
"responses":{
"201":{
"description":"Conference created.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/c18e27d419b307552daa9403b0085ee796da1a5e57e2a4e6fb73f406471574fc.Conference"
},
"examples":{
"Conference response":{
"summary":"Conference response",
"value":{
"id":"e8a7c0f5-0f0b-4ccf-84a4-1b7e5f699001",
"name":"Example conference",
"participants":[],
"callsConfigurationId":"dc5942707c704551a00cd2ea",
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
}
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Application not found.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:traffic:send"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":20,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/conferences/{conferenceId}":{
"get":{
"tags":[
"channels",
"voice",
"calls",
"conference-calls",
"conference-management"
],
"summary":"Get conference",
"description":"Get a single conference.",
"operationId":"get-conference",
"parameters":[
{
"name":"conferenceId",
"in":"path",
"description":"Conference ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/c18e27d419b307552daa9403b0085ee796da1a5e57e2a4e6fb73f406471574fc.Conference"
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:logs:read"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
},
"patch":{
"tags":[
"channels",
"voice",
"calls",
"conference-calls",
"conference-management"
],
"summary":"Update all calls",
"description":"Update all calls in a conference.",
"operationId":"update-conference",
"parameters":[
{
"name":"conferenceId",
"in":"path",
"description":"Conference ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/02ec6d748bd9b366e5aeae1eaf03d6007ae57830d7d55344122f68a2478c9f84.UpdateRequest"
},
"examples":{
"Mute all conference calls":{
"summary":"Mute all conference calls",
"value":{
"muted":true
}
},
"Deaf all conference calls":{
"summary":"Deaf all conference calls",
"value":{
"deaf":true
}
},
"Blind all conference calls":{
"summary":"Blind all conference calls",
"value":{
"blind":true
}
},
"Unmute and deaf all conference calls":{
"summary":"Unmute and deaf all conference calls",
"value":{
"muted":false,
"deaf":true
}
},
"Deaf and blind all conference calls (blinding applies only to WebRTC endpoints)":{
"summary":"Deaf and blind all conference calls (blinding applies only to WebRTC endpoints)",
"value":{
"deaf":true,
"blind":true
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:traffic:send"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/conferences/history":{
"get":{
"tags":[
"channels",
"voice",
"calls",
"conference-calls",
"conference-management"
],
"summary":"Get conferences history",
"description":"Get conferences history with pagination. Conferences history retention period is 5 days.",
"operationId":"get-conferences-history",
"parameters":[
{
"name":"name",
"in":"query",
"description":"Conference name.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"Conference"
},
{
"name":"callId",
"in":"query",
"description":"Call ID.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"066675c6-0db6-0db9-b032-031964d09af4"
},
{
"name":"callsConfigurationId",
"in":"query",
"description":"Calls Configuration ID.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"dc5942707c704551a00cd2ea"
},
{
"name":"applicationId",
"in":"query",
"description":"Application ID.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"61c060db2675060027d8c7a6"
},
{
"name":"startTimeAfter",
"in":"query",
"description":"Date and time for when the conference has been created. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ`.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"format":"date-time"
},
"example":"2022-05-01T14:25:45.125+0000"
},
{
"name":"endTimeBefore",
"in":"query",
"description":"Date and time for when the conference has been finished. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ`.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"format":"date-time"
},
"example":"2022-05-01T14:26:45.125+0000"
},
{
"name":"page",
"in":"query",
"description":"Results page to retrieve (0..N).",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":0,
"minimum":0
}
},
{
"name":"size",
"in":"query",
"description":"Number of records per page.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":20,
"maximum":100,
"minimum":1
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.ConferenceLogPage"
},
"examples":{
"Conference log page response.":{
"summary":"Conference log page response.",
"value":{
"results":[
{
"conferenceId":"e8a7c0f5-0f0b-4ccf-84a4-1b7e5f699001",
"name":"Example conference",
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
},
"startTime":"2026-01-15T11:57:30.000+0000",
"endTime":"2026-01-15T11:59:20.000+0000",
"duration":110,
"sessions":[
{
"callId":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"joinTime":"2026-01-15T11:58:00.000+0000",
"leaveTime":"2026-01-15T11:59:00.000+0000"
},
{
"callId":"ae024ad1-52e7-45d5-a5d2-cd7c809e03f8",
"joinTime":"2026-01-15T11:57:30.000+0000",
"leaveTime":"2026-01-15T11:59:20.000+0000"
}
],
"recording":{
"composedFiles":[
{
"id":"65f0b3d7c8b6a00001a2b3d5",
"name":"example-recording.wav",
"fileFormat":"WAV",
"size":67564,
"creationTime":"2026-01-15T12:00:00.000+0000",
"duration":10,
"startTime":"2026-01-15T11:57:30.000+0000",
"endTime":"2026-01-15T11:59:20.000+0000",
"location":"HOSTED"
}
],
"callRecordings":[
{
"callId":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"endpoint":{
"type":"PHONE",
"phoneNumber":"41793026834"
},
"direction":"INBOUND",
"files":[
{
"id":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"name":"d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav",
"fileFormat":"WAV",
"size":67564,
"creationTime":"2026-01-15T12:00:00.150+0000",
"duration":10,
"startTime":"2026-01-15T11:59:50.000+0000",
"endTime":"2026-01-15T12:00:00.000+0000",
"location":"HOSTED",
"customData":{
"key1":"value1",
"key2":"value2"
}
}
],
"status":"SUCCESSFUL"
},
{
"callId":"ae024ad1-52e7-45d5-a5d2-cd7c809e03f8",
"endpoint":{
"type":"PHONE",
"phoneNumber":"41793026834"
},
"direction":"INBOUND",
"files":[
{
"id":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"name":"d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav",
"fileFormat":"WAV",
"size":67564,
"creationTime":"2026-01-15T12:00:00.150+0000",
"duration":10,
"startTime":"2026-01-15T11:59:50.000+0000",
"endTime":"2026-01-15T12:00:00.000+0000",
"location":"HOSTED",
"customData":{
"key1":"value1",
"key2":"value2"
}
}
],
"status":"SUCCESSFUL"
}
]
},
"errorCode":{
"id":10000,
"name":"NORMAL_HANGUP",
"description":"The call has ended with hangup initiated by caller, callee or API"
}
}
],
"paging":{
"page":0,
"size":1,
"totalPages":1,
"totalResults":1
}
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:logs:read"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/conferences/{conferenceId}/history":{
"get":{
"tags":[
"channels",
"voice",
"calls",
"conference-calls",
"conference-management"
],
"summary":"Get conference history",
"description":"Get a single conference history. Conference history retention period is 5 days.",
"operationId":"get-conference-history",
"parameters":[
{
"name":"conferenceId",
"in":"path",
"description":"Conference ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/707907921d4508c2925eddc2449f10db322ecc083be424f87c50fe97ccd8be40.ConferenceLogResponse"
},
"examples":{
"Conference history log":{
"summary":"Conference history log",
"value":{
"conferenceId":"e8a7c0f5-0f0b-4ccf-84a4-1b7e5f699001",
"name":"Example conference",
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
},
"startTime":"2026-01-15T11:57:30.000+0000",
"endTime":"2026-01-15T11:59:20.000+0000",
"duration":110,
"sessions":[
{
"callId":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"joinTime":"2026-01-15T11:58:00.000+0000",
"leaveTime":"2026-01-15T11:59:00.000+0000"
},
{
"callId":"ae024ad1-52e7-45d5-a5d2-cd7c809e03f8",
"joinTime":"2026-01-15T11:57:30.000+0000",
"leaveTime":"2026-01-15T11:59:20.000+0000"
}
],
"recording":{
"composedFiles":[
{
"id":"65f0b3d7c8b6a00001a2b3d5",
"name":"example-recording.wav",
"fileFormat":"WAV",
"size":67564,
"creationTime":"2026-01-15T12:00:00.000+0000",
"duration":10,
"startTime":"2026-01-15T11:57:30.000+0000",
"endTime":"2026-01-15T11:59:20.000+0000",
"location":"HOSTED"
}
],
"callRecordings":[
{
"callId":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"endpoint":{
"type":"PHONE",
"phoneNumber":"41793026834"
},
"direction":"INBOUND",
"files":[
{
"id":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"name":"d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav",
"fileFormat":"WAV",
"size":67564,
"creationTime":"2026-01-15T12:00:00.150+0000",
"duration":10,
"startTime":"2026-01-15T11:59:50.000+0000",
"endTime":"2026-01-15T12:00:00.000+0000",
"location":"HOSTED",
"customData":{
"key1":"value1",
"key2":"value2"
}
}
],
"status":"SUCCESSFUL"
},
{
"callId":"ae024ad1-52e7-45d5-a5d2-cd7c809e03f8",
"endpoint":{
"type":"PHONE",
"phoneNumber":"41793026834"
},
"direction":"INBOUND",
"files":[
{
"id":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"name":"d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav",
"fileFormat":"WAV",
"size":67564,
"creationTime":"2026-01-15T12:00:00.150+0000",
"duration":10,
"startTime":"2026-01-15T11:59:50.000+0000",
"endTime":"2026-01-15T12:00:00.000+0000",
"location":"HOSTED",
"customData":{
"key1":"value1",
"key2":"value2"
}
}
],
"status":"SUCCESSFUL"
}
]
},
"errorCode":{
"id":10000,
"name":"NORMAL_HANGUP",
"description":"The call has ended with hangup initiated by caller, callee or API"
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:logs:read"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/conferences/{conferenceId}/call":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"conference-calls",
"conference-management"
],
"summary":"Add new call",
"description":"Create a new outbound call and add it to a conference.",
"operationId":"add-new-conference-call",
"parameters":[
{
"name":"conferenceId",
"in":"path",
"description":"Conference ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/707907921d4508c2925eddc2449f10db322ecc083be424f87c50fe97ccd8be40.AddNewCallRequest"
},
"examples":{
"Add new call":{
"summary":"Add new call",
"value":{
"callRequest":{
"endpoint":{
"type":"PHONE",
"phoneNumber":"41792036727"
},
"from":"41793026834"
},
"connectOnEarlyMedia":false
}
},
"Add new call and connect on early media":{
"summary":"Add new call and connect on early media",
"value":{
"callRequest":{
"endpoint":{
"type":"PHONE",
"phoneNumber":"41792036727"
},
"from":"41793026834"
},
"connectOnEarlyMedia":true
}
},
"Add new call with a specific role":{
"summary":"Add new call with a specific role",
"value":{
"callRequest":{
"endpoint":{
"type":"PHONE",
"phoneNumber":"41792036727"
},
"from":"41793026834"
},
"connectOnEarlyMedia":false,
"role":{
"type":"MONITOR"
}
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Call added.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/c18e27d419b307552daa9403b0085ee796da1a5e57e2a4e6fb73f406471574fc.ConferenceAndCall"
},
"examples":{
"Add new call response example":{
"summary":"Add new call response example",
"value":{
"conference":{
"id":"e8a7c0f5-0f0b-4ccf-84a4-1b7e5f699001",
"name":"Example conference",
"participants":[],
"callsConfigurationId":"dc5942707c704551a00cd2ea",
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
}
},
"call":{
"id":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"endpoint":{
"type":"PHONE",
"phoneNumber":"41792036727"
},
"from":"41793026834",
"to":"41792036727",
"direction":"OUTBOUND",
"state":"ESTABLISHED",
"startTime":"2026-01-15T11:59:30.000+0000",
"answerTime":"2026-01-15T11:59:35.000+0000",
"endTime":"2026-01-15T12:00:00.000+0000",
"callsConfigurationId":"dc5942707c704551a00cd2ea",
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
},
"customData":{
"key1":"value1",
"key2":"value2"
}
}
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Conference or application not found.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"description":"Too many requests",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"TOO_MANY_REQUESTS",
"text":"Too many requests."
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:traffic:send"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":6,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/conferences/{conferenceId}/call/{callId}":{
"put":{
"tags":[
"channels",
"voice",
"calls",
"conference-calls",
"conference-management"
],
"summary":"Add existing call",
"description":"Add an existing call to a conference.",
"operationId":"add-existing-conference-call",
"parameters":[
{
"name":"conferenceId",
"in":"path",
"description":"Conference ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
},
{
"name":"callId",
"in":"path",
"description":"Call ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/707907921d4508c2925eddc2449f10db322ecc083be424f87c50fe97ccd8be40.AddExistingCallRequest"
},
"examples":{
"Add existing call":{
"summary":"Add existing call",
"value":{
"connectOnEarlyMedia":false
}
},
"Add existing call and connect on early media":{
"summary":"Add existing call and connect on early media",
"value":{
"connectOnEarlyMedia":true
}
},
"Add existing call with a specific role":{
"summary":"Add existing call with a specific role",
"value":{
"connectOnEarlyMedia":false,
"role":{
"type":"MONITOR"
}
}
}
}
}
}
},
"responses":{
"200":{
"description":"Call added.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/c18e27d419b307552daa9403b0085ee796da1a5e57e2a4e6fb73f406471574fc.Conference"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Conference or call not found.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:traffic:send"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
},
"delete":{
"tags":[
"channels",
"voice",
"calls",
"conference-calls",
"conference-management"
],
"summary":"Remove call",
"description":"Remove a call from a conference. The call stays active after this action.",
"operationId":"remove-conference-call",
"parameters":[
{
"name":"conferenceId",
"in":"path",
"description":"Conference ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
},
{
"name":"callId",
"in":"path",
"description":"Call ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse"
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Conference or call not found.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:traffic:send"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
},
"patch":{
"tags":[
"channels",
"voice",
"calls",
"conference-calls",
"conference-management"
],
"summary":"Update call",
"description":"Update a call in a conference.",
"operationId":"update-conference-call",
"parameters":[
{
"name":"conferenceId",
"in":"path",
"description":"Conference ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
},
{
"name":"callId",
"in":"path",
"description":"Call ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/02ec6d748bd9b366e5aeae1eaf03d6007ae57830d7d55344122f68a2478c9f84.UpdateCallRequest"
},
"examples":{
"Mute single conference call":{
"summary":"Mute single conference call",
"value":{
"muted":true
}
},
"Deaf single conference call":{
"summary":"Deaf single conference call",
"value":{
"deaf":true
}
},
"Unmute and deaf single conference call":{
"summary":"Unmute and deaf single conference call",
"value":{
"muted":false,
"deaf":true
}
},
"Blind single conference call":{
"summary":"Blind single conference call",
"value":{
"blind":true
}
},
"Change role inside the conference":{
"summary":"Change role inside the conference",
"value":{
"role":{
"type":"MONITOR"
}
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Conference or call not found.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:traffic:send"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/conferences/{conferenceId}/hangup":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"conference-calls",
"conference-operations"
],
"summary":"Hangup conference",
"description":"Hang up a conference. This action also hangs up all calls in the conference.",
"operationId":"hangup-conference",
"parameters":[
{
"name":"conferenceId",
"in":"path",
"description":"Conference ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/c18e27d419b307552daa9403b0085ee796da1a5e57e2a4e6fb73f406471574fc.Conference"
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:traffic:send"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/conferences/{conferenceId}/play":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"conference-calls",
"conference-operations"
],
"summary":"Play file",
"description":"Play an audio file on a conference.",
"operationId":"conference-play-file",
"parameters":[
{
"name":"conferenceId",
"in":"path",
"description":"Conference ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4811a3a9108d5f90b8934012403f954f20270c436bdecbc318a80214cf54fc02.ConferencePlayRequest"
},
"examples":{
"Play audio from file":{
"summary":"Play audio from file",
"value":{
"content":{
"fileId":"218eceba-c044-430d-9f26-8f1a7f0g2d03",
"type":"FILE"
}
}
},
"Play audio from URL":{
"summary":"Play audio from URL",
"value":{
"content":{
"fileUrl":"https://www.example.com/file.wav",
"type":"URL"
}
}
},
"Play audio in loop":{
"summary":"Play audio in loop",
"value":{
"loopCount":3,
"content":{
"fileUrl":"https://www.example.com/file.wav",
"type":"URL"
}
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:traffic:send"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/conferences/{conferenceId}/stop-play":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"conference-calls",
"conference-operations"
],
"summary":"Stop playing file",
"description":"Stop playing an audio file on a conference.",
"operationId":"conference-stop-playing-file",
"parameters":[
{
"name":"conferenceId",
"in":"path",
"description":"Conference ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse"
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:traffic:send"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/conferences/{conferenceId}/say":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"conference-calls",
"conference-operations"
],
"summary":"Say text",
"description":"Say text on a conference.",
"operationId":"conference-say-text",
"parameters":[
{
"name":"conferenceId",
"in":"path",
"description":"Conference ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4811a3a9108d5f90b8934012403f954f20270c436bdecbc318a80214cf54fc02.ConferenceSayRequest"
},
"examples":{
"Say request":{
"summary":"Say request",
"value":{
"text":"Hello world",
"language":"en"
}
},
"Say request with additional options":{
"summary":"Say request with additional options",
"value":{
"text":"Hello world",
"language":"en",
"speechRate":1.2,
"loopCount":3,
"preferences":{
"voiceGender":"FEMALE",
"voiceName":"Joanna"
}
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:traffic:send"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/conferences/{conferenceId}/start-recording":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"conference-calls",
"conference-operations"
],
"summary":"Start recording",
"description":"Start recording a conference.",
"operationId":"conference-start-recording",
"parameters":[
{
"name":"conferenceId",
"in":"path",
"description":"Conference ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4811a3a9108d5f90b8934012403f954f20270c436bdecbc318a80214cf54fc02.ConferenceRecordingRequest"
},
"examples":{
"Start recording request":{
"summary":"Start recording request",
"value":{
"recordingType":"AUDIO_AND_VIDEO"
}
},
"Start recording request with composition":{
"summary":"Start recording request with composition",
"value":{
"recordingType":"AUDIO",
"conferenceComposition":{
"enabled":true
}
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:traffic:record"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/conferences/{conferenceId}/stop-recording":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"conference-calls",
"conference-operations"
],
"summary":"Stop recording",
"description":"Stop recording a conference.",
"operationId":"conference-stop-recording",
"parameters":[
{
"name":"conferenceId",
"in":"path",
"description":"Conference ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:traffic:record"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/conferences/{conferenceId}/broadcast-webrtc-text":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"conference-calls",
"conference-operations"
],
"summary":"Broadcast text",
"description":"Broadcasts a text message to conference WebRTC participants with open data channel.",
"operationId":"conference-broadcast-webrtc-text",
"parameters":[
{
"name":"conferenceId",
"in":"path",
"description":"Conference ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4811a3a9108d5f90b8934012403f954f20270c436bdecbc318a80214cf54fc02.ConferenceBroadcastWebrtcTextRequest"
},
"examples":{
"Conference broadcast WebRTC text request":{
"summary":"Conference broadcast WebRTC text request",
"value":{
"text":"This meeting will end in 5 minutes."
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"deprecated":true,
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:traffic:send"
],
"x-deprecationInformation":{
"deprecation":"2025-11-06T12:00:00.000+0000",
"sunset":"2026-01-11T12:00:00.000+0000",
"successorOperationId":"conference-send-message"
},
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/conferences/{conferenceId}/send-message":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"conference-calls",
"conference-operations"
],
"summary":"Send message",
"description":"Send a message to all WebRTC participants in a conference.",
"operationId":"conference-send-message",
"parameters":[
{
"name":"conferenceId",
"in":"path",
"description":"Conference ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4811a3a9108d5f90b8934012403f954f20270c436bdecbc318a80214cf54fc02.ConferenceSendMessageRequest"
},
"examples":{
"Send a message to all WebRTC participants in a conference":{
"summary":"Send a message to all WebRTC participants in a conference",
"value":{
"message":"This meeting will end in 5 minutes."
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:traffic:send"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/dialogs":{
"get":{
"tags":[
"channels",
"voice",
"calls",
"dialog-calls",
"dialog-management"
],
"summary":"Get dialogs",
"description":"Get dialogs with pagination.",
"operationId":"get-dialogs",
"parameters":[
{
"name":"callsConfigurationId",
"in":"query",
"description":"Calls Configuration ID.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"dc5942707c704551a00cd2ea"
},
{
"name":"applicationId",
"in":"query",
"description":"Application ID.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"61c060db2675060027d8c7a6"
},
{
"name":"state",
"in":"query",
"description":"Dialog state.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicDialogState"
},
"example":"ESTABLISHED"
},
{
"name":"parentCallId",
"in":"query",
"description":"Parent call ID.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"066675c6-0db6-0db9-b032-031964d09af4"
},
{
"name":"childCallId",
"in":"query",
"description":"Child call ID.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"072675c6-3db6-0fb9-b632-031264d09ck2"
},
{
"name":"startTimeAfter",
"in":"query",
"description":"Date and time for when the dialog has been created. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ`.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"format":"date-time"
},
"example":"2022-05-01T14:25:45.125+0000"
},
{
"name":"page",
"in":"query",
"description":"Results page to retrieve (0..N).",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":0,
"minimum":0
}
},
{
"name":"size",
"in":"query",
"description":"Number of records per page.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":20,
"maximum":100,
"minimum":1
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.DialogPage"
},
"examples":{
"Dialog page response.":{
"summary":"Dialog page response.",
"value":{
"results":[
{
"id":"034e622a-cc7e-456d-8a10-0ba43b11aa5e",
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
},
"state":"ESTABLISHED",
"startTime":"2026-01-15T12:00:00.000+0000",
"establishTime":"2026-01-15T12:00:02.000+0000",
"endTime":"2026-01-15T12:01:00.000+0000",
"parentCall":{
"id":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"endpoint":{
"type":"PHONE",
"phoneNumber":"41793026834"
},
"direction":"INBOUND",
"state":"ESTABLISHED",
"media":{
"audio":{
"muted":false,
"deaf":false
},
"video":{
"camera":false,
"screenShare":false,
"blind":false
}
},
"startTime":"2026-01-15T12:00:00.000+0000",
"answerTime":"2026-01-15T12:00:02.000+0000",
"endTime":"2026-01-15T12:01:00.000+0000",
"ringDuration":2,
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
},
"dialogId":"034e622a-cc7e-456d-8a10-0ba43b11aa5e"
},
"childCall":{
"id":"ae024ad1-52e7-45d5-a5d2-cd7c809e03f8",
"endpoint":{
"type":"PHONE",
"phoneNumber":"41792036727"
},
"direction":"OUTBOUND",
"state":"ESTABLISHED",
"media":{
"audio":{
"muted":false,
"deaf":false
},
"video":{
"camera":false,
"screenShare":false,
"blind":false
}
},
"startTime":"2026-01-15T12:00:00.000+0000",
"answerTime":"2026-01-15T12:00:02.000+0000",
"endTime":"2026-01-15T12:01:00.000+0000",
"ringDuration":2,
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
},
"dialogId":"034e622a-cc7e-456d-8a10-0ba43b11aa5e"
}
}
],
"paging":{
"page":0,
"size":1,
"totalPages":1,
"totalResults":1
}
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:logs:read"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
},
"post":{
"tags":[
"channels",
"voice",
"calls",
"dialog-calls",
"dialog-management"
],
"summary":"Create dialog",
"description":"Create a dialog.",
"operationId":"create-dialog",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/5fc49137a7b003ca1d8c4957601417b8ed884356b7fbc49afe416dd5c098a0bd.DialogRequest"
},
"examples":{
"Dialog request":{
"summary":"Dialog request",
"value":{
"parentCallId":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"childCallRequest":{
"endpoint":{
"type":"PHONE",
"phoneNumber":"41792036727"
},
"from":"41793026834",
"connectTimeout":60,
"machineDetection":{
"enabled":true
},
"customData":{
"key1":"value1",
"key2":"value2"
}
},
"recording":{
"recordingType":"AUDIO",
"dialogComposition":{
"enabled":false
}
},
"maxDuration":3600,
"propagationOptions":{
"childCallHangup":false
}
}
}
}
}
},
"required":true
},
"responses":{
"201":{
"description":"Dialog created.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/5fc49137a7b003ca1d8c4957601417b8ed884356b7fbc49afe416dd5c098a0bd.DialogResponse"
},
"examples":{
"Created dialog response":{
"summary":"Created dialog response",
"value":{
"id":"034e622a-cc7e-456d-8a10-0ba43b11aa5e",
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
},
"state":"ESTABLISHED",
"startTime":"2026-01-15T12:00:00.000+0000",
"establishTime":"2026-01-15T12:00:02.000+0000",
"endTime":"2026-01-15T12:01:00.000+0000",
"parentCall":{
"id":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"endpoint":{
"type":"PHONE",
"phoneNumber":"41793026834"
},
"direction":"INBOUND",
"state":"ESTABLISHED",
"media":{
"audio":{
"muted":false,
"deaf":false
},
"video":{
"camera":false,
"screenShare":false,
"blind":false
}
},
"startTime":"2026-01-15T12:00:00.000+0000",
"answerTime":"2026-01-15T12:00:02.000+0000",
"endTime":"2026-01-15T12:01:00.000+0000",
"ringDuration":2,
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
},
"dialogId":"034e622a-cc7e-456d-8a10-0ba43b11aa5e"
},
"childCall":{
"id":"ae024ad1-52e7-45d5-a5d2-cd7c809e03f8",
"endpoint":{
"type":"PHONE",
"phoneNumber":"41792036727"
},
"direction":"OUTBOUND",
"state":"ESTABLISHED",
"media":{
"audio":{
"muted":false,
"deaf":false
},
"video":{
"camera":false,
"screenShare":false,
"blind":false
}
},
"startTime":"2026-01-15T12:00:00.000+0000",
"answerTime":"2026-01-15T12:00:02.000+0000",
"endTime":"2026-01-15T12:01:00.000+0000",
"ringDuration":2,
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
},
"dialogId":"034e622a-cc7e-456d-8a10-0ba43b11aa5e"
}
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Application not found.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:traffic:send"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":20,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/dialogs/parent-call/{parentCallId}/child-call/{childCallId}":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"dialog-calls",
"dialog-management"
],
"summary":"Create dialog with existing calls",
"description":"Create a dialog with existing calls.",
"operationId":"create-dialog-with-existing-calls",
"parameters":[
{
"name":"parentCallId",
"in":"path",
"description":"Call ID of the parent call to be connected in a dialog.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"126f327b-dd4e-456d-8a10-1cb78a23bc8a"
},
{
"name":"childCallId",
"in":"path",
"description":"Call ID of the child call to be connected in a dialog. Needs to have been created using [create method](#create-call) with `parentCallId` parameter equal to the parent call ID above.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"034e622a-cc7e-456d-8a10-0ba43b11aa5e"
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/5fc49137a7b003ca1d8c4957601417b8ed884356b7fbc49afe416dd5c098a0bd.DialogWithExistingCallsRequest"
},
"examples":{
"Dialog with existing call request":{
"summary":"Dialog with existing call request",
"value":{
"recording":{
"recordingType":"AUDIO",
"dialogComposition":{
"enabled":false
},
"customData":{
"property1":"value1",
"string":"string"
}
},
"maxDuration":28800,
"propagationOptions":{
"childCallHangup":true,
"childCallRinging":false,
"ringbackGeneration":{
"enabled":false
}
}
}
}
}
}
},
"required":true
},
"responses":{
"201":{
"description":"Dialog created.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/5fc49137a7b003ca1d8c4957601417b8ed884356b7fbc49afe416dd5c098a0bd.DialogResponse"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Application not found.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:traffic:send"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":20,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/dialogs/{dialogId}":{
"get":{
"tags":[
"channels",
"voice",
"calls",
"dialog-calls",
"dialog-management"
],
"summary":"Get dialog",
"description":"Get a single dialog.",
"operationId":"get-dialog",
"parameters":[
{
"name":"dialogId",
"in":"path",
"description":"Dialog ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"034e622a-cc7e-456d-8a10-0ba43b11aa5e"
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/5fc49137a7b003ca1d8c4957601417b8ed884356b7fbc49afe416dd5c098a0bd.DialogResponse"
},
"examples":{
"Dialog response":{
"summary":"Dialog response",
"value":{
"id":"034e622a-cc7e-456d-8a10-0ba43b11aa5e",
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
},
"state":"ESTABLISHED",
"startTime":"2026-01-15T12:00:00.000+0000",
"establishTime":"2026-01-15T12:00:02.000+0000",
"endTime":"2026-01-15T12:01:00.000+0000",
"parentCall":{
"id":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"endpoint":{
"type":"PHONE",
"phoneNumber":"41793026834"
},
"direction":"INBOUND",
"state":"ESTABLISHED",
"media":{
"audio":{
"muted":false,
"deaf":false
},
"video":{
"camera":false,
"screenShare":false,
"blind":false
}
},
"startTime":"2026-01-15T12:00:00.000+0000",
"answerTime":"2026-01-15T12:00:02.000+0000",
"endTime":"2026-01-15T12:01:00.000+0000",
"ringDuration":2,
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
},
"dialogId":"034e622a-cc7e-456d-8a10-0ba43b11aa5e"
},
"childCall":{
"id":"ae024ad1-52e7-45d5-a5d2-cd7c809e03f8",
"endpoint":{
"type":"PHONE",
"phoneNumber":"41792036727"
},
"direction":"OUTBOUND",
"state":"ESTABLISHED",
"media":{
"audio":{
"muted":false,
"deaf":false
},
"video":{
"camera":false,
"screenShare":false,
"blind":false
}
},
"startTime":"2026-01-15T12:00:00.000+0000",
"answerTime":"2026-01-15T12:00:02.000+0000",
"endTime":"2026-01-15T12:01:00.000+0000",
"ringDuration":2,
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
},
"dialogId":"034e622a-cc7e-456d-8a10-0ba43b11aa5e"
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:logs:read"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/dialogs/history":{
"get":{
"tags":[
"channels",
"voice",
"calls",
"dialog-calls",
"dialog-management"
],
"summary":"Get dialogs history",
"description":"Get dialogs history with pagination. Dialogs history retention period is 5 days.",
"operationId":"get-dialogs-history",
"parameters":[
{
"name":"callsConfigurationId",
"in":"query",
"description":"Calls Configuration ID.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"dc5942707c704551a00cd2ea"
},
{
"name":"applicationId",
"in":"query",
"description":"Application ID.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"61c060db2675060027d8c7a6"
},
{
"name":"state",
"in":"query",
"description":"Dialog state.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicDialogState"
},
"example":"ESTABLISHED"
},
{
"name":"parentCallId",
"in":"query",
"description":"Parent call ID.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"066675c6-0db6-0db9-b032-031964d09af4"
},
{
"name":"childCallId",
"in":"query",
"description":"Child call ID.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"072675c6-3db6-0fb9-b632-031264d09ck2"
},
{
"name":"startTimeAfter",
"in":"query",
"description":"Date and time for when the dialog has been created. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ`.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"format":"date-time"
},
"example":"2022-05-01T14:25:45.125+0000"
},
{
"name":"endTimeBefore",
"in":"query",
"description":"Date and time for when the dialog has been finished. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSS+ZZZZ`.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"format":"date-time"
},
"example":"2022-05-01T14:26:45.125+0000"
},
{
"name":"page",
"in":"query",
"description":"Results page to retrieve (0..N).",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":0,
"minimum":0
}
},
{
"name":"size",
"in":"query",
"description":"Number of records per page.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":20,
"maximum":100,
"minimum":1
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.DialogLogPage"
},
"examples":{
"Dialog log page response.":{
"summary":"Dialog log page response.",
"value":{
"results":[
{
"dialogId":"034e622a-cc7e-456d-8a10-0ba43b11aa5e",
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
},
"state":"ESTABLISHED",
"startTime":"2026-01-15T12:00:00.000+0000",
"establishTime":"2026-01-15T12:00:02.000+0000",
"endTime":"2026-01-15T12:01:00.000+0000",
"parentCallId":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"childCallId":"ae024ad1-52e7-45d5-a5d2-cd7c809e03f8",
"duration":60,
"recording":{
"composedFiles":[
{
"id":"65f0b3d7c8b6a00001a2b3d5",
"name":"example-recording.wav",
"fileFormat":"WAV",
"size":67564,
"creationTime":"2026-01-15T12:00:00.000+0000",
"duration":10,
"startTime":"2026-01-15T11:57:30.000+0000",
"endTime":"2026-01-15T11:59:20.000+0000",
"location":"SFTP",
"sftpUploadStatus":"UPLOADED"
}
],
"callRecordings":[
{
"callId":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"endpoint":{
"type":"PHONE",
"phoneNumber":"41793026834"
},
"direction":"INBOUND",
"files":[
{
"id":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"name":"d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav",
"fileFormat":"WAV",
"size":67564,
"creationTime":"2026-01-15T12:00:00.150+0000",
"duration":10,
"startTime":"2026-01-15T11:59:50.000+0000",
"endTime":"2026-01-15T12:00:00.000+0000",
"location":"HOSTED",
"customData":{
"key1":"value1",
"key2":"value2"
}
}
],
"status":"SUCCESSFUL"
},
{
"callId":"ae024ad1-52e7-45d5-a5d2-cd7c809e03f8",
"endpoint":{
"type":"PHONE",
"phoneNumber":"41793026834"
},
"direction":"INBOUND",
"files":[
{
"id":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"name":"d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav",
"fileFormat":"WAV",
"size":67564,
"creationTime":"2026-01-15T12:00:00.150+0000",
"duration":10,
"startTime":"2026-01-15T11:59:50.000+0000",
"endTime":"2026-01-15T12:00:00.000+0000",
"location":"HOSTED",
"customData":{
"key1":"value1",
"key2":"value2"
}
}
],
"status":"SUCCESSFUL"
}
]
},
"errorCode":{
"id":10000,
"name":"NORMAL_HANGUP",
"description":"The call has ended with hangup initiated by caller, callee or API"
},
"hangupSource":"CHILD_ENDPOINT"
}
],
"paging":{
"page":0,
"size":1,
"totalPages":1,
"totalResults":1
}
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:logs:read"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/dialogs/{dialogId}/history":{
"get":{
"tags":[
"channels",
"voice",
"calls",
"dialog-calls",
"dialog-management"
],
"summary":"Get dialog history",
"description":"Get a single dialog history. Dialog history retention period is 5 days.",
"operationId":"get-dialog-history",
"parameters":[
{
"name":"dialogId",
"in":"path",
"description":"Dialog ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"034e622a-cc7e-456d-8a10-0ba43b11aa5e"
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/5fc49137a7b003ca1d8c4957601417b8ed884356b7fbc49afe416dd5c098a0bd.DialogLogResponse"
},
"examples":{
"Dialog log response":{
"summary":"Dialog log response",
"value":{
"dialogId":"034e622a-cc7e-456d-8a10-0ba43b11aa5e",
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
},
"state":"ESTABLISHED",
"startTime":"2026-01-15T12:00:00.000+0000",
"establishTime":"2026-01-15T12:00:02.000+0000",
"endTime":"2026-01-15T12:01:00.000+0000",
"parentCallId":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"childCallId":"ae024ad1-52e7-45d5-a5d2-cd7c809e03f8",
"duration":60,
"recording":{
"composedFiles":[
{
"id":"65f0b3d7c8b6a00001a2b3d5",
"name":"example-recording.wav",
"fileFormat":"WAV",
"size":67564,
"creationTime":"2026-01-15T12:00:00.000+0000",
"duration":10,
"startTime":"2026-01-15T11:57:30.000+0000",
"endTime":"2026-01-15T11:59:20.000+0000",
"location":"SFTP",
"sftpUploadStatus":"UPLOADED"
}
],
"callRecordings":[
{
"callId":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"endpoint":{
"type":"PHONE",
"phoneNumber":"41793026834"
},
"direction":"INBOUND",
"files":[
{
"id":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"name":"d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav",
"fileFormat":"WAV",
"size":67564,
"creationTime":"2026-01-15T12:00:00.150+0000",
"duration":10,
"startTime":"2026-01-15T11:59:50.000+0000",
"endTime":"2026-01-15T12:00:00.000+0000",
"location":"HOSTED",
"customData":{
"key1":"value1",
"key2":"value2"
}
}
],
"status":"SUCCESSFUL"
},
{
"callId":"ae024ad1-52e7-45d5-a5d2-cd7c809e03f8",
"endpoint":{
"type":"PHONE",
"phoneNumber":"41793026834"
},
"direction":"INBOUND",
"files":[
{
"id":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"name":"d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav",
"fileFormat":"WAV",
"size":67564,
"creationTime":"2026-01-15T12:00:00.150+0000",
"duration":10,
"startTime":"2026-01-15T11:59:50.000+0000",
"endTime":"2026-01-15T12:00:00.000+0000",
"location":"HOSTED",
"customData":{
"key1":"value1",
"key2":"value2"
}
}
],
"status":"SUCCESSFUL"
}
]
},
"errorCode":{
"id":10000,
"name":"NORMAL_HANGUP",
"description":"The call has ended with hangup initiated by caller, callee or API"
},
"hangupSource":"CHILD_ENDPOINT"
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:logs:read"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/dialogs/{dialogId}/hangup":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"dialog-calls",
"dialog-operations"
],
"summary":"Hangup dialog",
"description":"Hang up a dialog. This action also hangs up all calls in the dialog.",
"operationId":"hangup-dialog",
"parameters":[
{
"name":"dialogId",
"in":"path",
"description":"Dialog ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/5fc49137a7b003ca1d8c4957601417b8ed884356b7fbc49afe416dd5c098a0bd.DialogResponse"
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:traffic:send"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/dialogs/{dialogId}/play":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"dialog-calls",
"dialog-operations"
],
"summary":"Play file",
"description":"Play an audio file on a dialog.",
"operationId":"dialog-play-file",
"parameters":[
{
"name":"dialogId",
"in":"path",
"description":"Dialog ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/14b5f31f4f292db4a32c4e61928f9a47f8ff4c0a1c06a38af2c29ef9ca05095d.DialogPlayRequest"
},
"examples":{
"Play audio from file":{
"summary":"Play audio from file",
"value":{
"content":{
"fileId":"65f0b3d7c8b6a00001a2b3c4",
"type":"FILE"
}
}
},
"Play audio from URL":{
"summary":"Play audio from URL",
"value":{
"content":{
"fileUrl":"https://example.com/example-audio.wav",
"type":"URL"
}
}
},
"Play audio in loop":{
"summary":"Play audio in loop",
"value":{
"loopCount":3,
"content":{
"fileUrl":"https://example.com/example-audio.wav",
"type":"URL"
}
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:traffic:send"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/dialogs/{dialogId}/say":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"dialog-calls",
"dialog-operations"
],
"summary":"Say text",
"description":"Say text on a dialog.",
"operationId":"dialog-say-text",
"parameters":[
{
"name":"dialogId",
"in":"path",
"description":"Dialog ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/14b5f31f4f292db4a32c4e61928f9a47f8ff4c0a1c06a38af2c29ef9ca05095d.DialogSayRequest"
},
"examples":{
"Simple say request":{
"summary":"Simple say request",
"value":{
"text":"Hello world",
"language":"en"
}
},
"Say request with additional options":{
"summary":"Say request with additional options",
"value":{
"text":"Hello world",
"language":"en",
"speechRate":1.2,
"loopCount":3,
"preferences":{
"voiceGender":"FEMALE",
"voiceName":"Joanna"
}
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:traffic:send"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/dialogs/{dialogId}/stop-play":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"dialog-calls",
"dialog-operations"
],
"summary":"Stop playing file",
"description":"Stop playing an audio file on a dialog.",
"operationId":"dialog-stop-playing-file",
"parameters":[
{
"name":"dialogId",
"in":"path",
"description":"Dialog ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse"
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:traffic:send"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/dialogs/{dialogId}/start-recording":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"dialog-calls",
"dialog-operations"
],
"summary":"Start recording",
"description":"Start recording a dialog.",
"operationId":"dialog-start-recording",
"parameters":[
{
"name":"dialogId",
"in":"path",
"description":"Dialog ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/14b5f31f4f292db4a32c4e61928f9a47f8ff4c0a1c06a38af2c29ef9ca05095d.DialogRecordingRequest"
},
"examples":{
"Request dialog recording.":{
"summary":"Request dialog recording.",
"value":{
"recordingType":"AUDIO_AND_VIDEO",
"dialogComposition":{
"enabled":true
},
"customData":{
"key":"value"
},
"filePrefix":"customFilename"
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:traffic:record"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/dialogs/{dialogId}/stop-recording":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"dialog-calls",
"dialog-operations"
],
"summary":"Stop recording",
"description":"Stop recording a dialog.",
"operationId":"dialog-stop-recording",
"parameters":[
{
"name":"dialogId",
"in":"path",
"description":"Dialog ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:traffic:record"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/dialogs/{dialogId}/broadcast-webrtc-text":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"dialog-calls",
"dialog-operations"
],
"summary":"Broadcast text",
"description":"Broadcasts a text message to dialog WebRTC call legs with open data channel.",
"operationId":"dialog-broadcast-webrtc-text",
"parameters":[
{
"name":"dialogId",
"in":"path",
"description":"Dialog ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/14b5f31f4f292db4a32c4e61928f9a47f8ff4c0a1c06a38af2c29ef9ca05095d.DialogBroadcastWebrtcTextRequest"
},
"examples":{
"Broadcast text to dialog WebRTC call legs with open data channel.":{
"summary":"Broadcast text to dialog WebRTC call legs with open data channel.",
"value":{
"text":"This dialog will end in 5 minutes."
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"deprecated":true,
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:traffic:send"
],
"x-deprecationInformation":{
"deprecation":"2025-11-06T12:00:00.000+0000",
"sunset":"2026-01-11T12:00:00.000+0000",
"successorOperationId":"dialog-send-message"
},
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/dialogs/{dialogId}/send-message":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"dialog-calls",
"dialog-operations"
],
"summary":"Send message",
"description":"Send a message to all WebRTC call legs in a dialog.",
"operationId":"dialog-send-message",
"parameters":[
{
"name":"dialogId",
"in":"path",
"description":"Dialog ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/14b5f31f4f292db4a32c4e61928f9a47f8ff4c0a1c06a38af2c29ef9ca05095d.DialogSendMessageRequest"
},
"examples":{
"Send a message to all WebRTC call legs in a dialog":{
"summary":"Send a message to all WebRTC call legs in a dialog",
"value":{
"message":"This meeting will end in 5 minutes."
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:traffic:send"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/dialogs/{dialogId}/transfer/accept":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"dialog-calls",
"dialog-operations"
],
"summary":"Dialog transfer accept",
"description":"Accepts a dialog transfer request.",
"operationId":"dialog-transfer-accept",
"parameters":[
{
"name":"dialogId",
"in":"path",
"description":"Dialog ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/14b5f31f4f292db4a32c4e61928f9a47f8ff4c0a1c06a38af2c29ef9ca05095d.DialogAcceptTransferRequest"
},
"examples":{
"Accept transfer request":{
"summary":"Accept transfer request",
"value":{
"targetCallRequest":{
"endpoint":{
"type":"PHONE",
"phoneNumber":"41792036727"
},
"from":"41793026834"
}
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/5fc49137a7b003ca1d8c4957601417b8ed884356b7fbc49afe416dd5c098a0bd.DialogResponse"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:traffic:send"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":6,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/dialogs/{dialogId}/transfer/reject":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"dialog-calls",
"dialog-operations"
],
"summary":"Dialog transfer reject",
"description":"Rejects a dialog transfer request.",
"operationId":"dialog-transfer-reject",
"parameters":[
{
"name":"dialogId",
"in":"path",
"description":"Dialog ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:traffic:receive"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/sip-trunks":{
"get":{
"tags":[
"channels",
"voice",
"calls",
"sip-trunks",
"sip-trunk-management"
],
"summary":"Get SIP trunks",
"description":"Get SIP trunks with pagination.",
"operationId":"get-sip-trunks",
"parameters":[
{
"name":"name",
"in":"query",
"description":"SIP trunk name.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"My SIP trunk"
},
{
"name":"page",
"in":"query",
"description":"Results page to retrieve (0..N).",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":0,
"minimum":0
}
},
{
"name":"size",
"in":"query",
"description":"Number of records per page.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":20,
"maximum":100,
"minimum":1
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.SipTrunkPage"
},
"examples":{
"SIP trunk page response.":{
"summary":"SIP trunk page response.",
"value":{
"results":[
{
"id":"62eb6ff07b18cc6cdf5cf001",
"type":"STATIC",
"name":"Static SIP Trunk",
"location":"NEW_YORK",
"tls":false,
"codecs":[
"PCMU",
"PCMA"
],
"dtmf":"INBAND",
"fax":"T38",
"numberFormat":"US_NATIONAL",
"internationalCallsAllowed":false,
"channelLimit":10,
"anonymization":"REMOTE_PARTY_ID",
"billingPackage":{
"packageType":"UNLIMITED",
"countryCode":"USA",
"addressId":"562949953421333"
},
"sbcHosts":{
"primary":[
"111.111.111.111:5060"
],
"backup":[
"222.222.222.222:5060"
],
"subnets":[
"11.22.33.44/24"
]
},
"sipOptions":{
"enabled":false
},
"sourceHosts":[
"10.10.10.10"
],
"destinationHosts":[
"100.100.100.100:5060",
"my.destination.com",
"my.destination.com:5060"
],
"strategy":"ROUND_ROBIN"
},
{
"id":"62eb6ff07b18cc6cdf5cf001",
"type":"REGISTERED",
"name":"Registered SIP Trunk",
"location":"SAO_PAULO",
"tls":true,
"codecs":[
"G729"
],
"dtmf":"RFC2833",
"fax":"NONE",
"numberFormat":"E164",
"internationalCallsAllowed":true,
"channelLimit":999,
"anonymization":"PREFERRED_IDENTITY",
"billingPackage":{
"packageType":"METERED"
},
"sbcHosts":{
"primary":[
"111.111.111.111:5061"
],
"backup":[
"222.222.222.222:5061"
],
"subnets":[
"11.22.33.44/24"
]
},
"username":"426c8402-691c-11ee-8c99-0242ac120002",
"inviteAuthentication":true
}
],
"paging":{
"page":0,
"size":2,
"totalPages":1,
"totalResults":2
}
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:configuration:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
},
"post":{
"tags":[
"channels",
"voice",
"calls",
"sip-trunks",
"sip-trunk-management"
],
"summary":"Create SIP trunk",
"description":"Create a SIP trunk. Fields not sent in request body will take default values. This operation is asynchronous. The SIP trunk will be created in the background.",
"operationId":"create-sip-trunk",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/6423f137d264daaaab4ca521d6dfeb19cab29b6b25c3d2da0c1c3fb475a5e829.SipTrunkRequest"
},
"examples":{
"Static SIP trunk":{
"summary":"Static SIP trunk",
"value":{
"type":"STATIC",
"name":"Static SIP trunk",
"location":"NEW_YORK",
"internationalCallsAllowed":false,
"channelLimit":10,
"billingPackage":{
"packageType":"UNLIMITED",
"countryCode":"USA",
"addressId":"562949953421333"
},
"tls":false,
"codecs":[
"PCMU",
"PCMA"
],
"dtmf":"INBAND",
"fax":"T38",
"numberFormat":"US_NATIONAL",
"anonymization":"REMOTE_PARTY_ID",
"sourceHosts":[
"10.10.10.10"
],
"destinationHosts":[
"100.100.100.101:5060",
"my.destination.com",
"my.destination.com:5060"
],
"strategy":"ROUND_ROBIN",
"sipOptions":{
"enabled":false
}
}
},
"Registered SIP trunk":{
"summary":"Registered SIP trunk",
"value":{
"type":"REGISTERED",
"name":"Registered SIP trunk",
"location":"SAO_PAULO",
"internationalCallsAllowed":true,
"channelLimit":999,
"billingPackage":{
"packageType":"METERED"
},
"tls":true,
"codecs":[
"G729"
],
"dtmf":"RFC2833",
"fax":"NONE",
"numberFormat":"E164",
"anonymization":"PREFERRED_IDENTITY",
"inviteAuthentication":true
}
},
"Freshworks Provider SIP trunk":{
"summary":"Freshworks Provider SIP trunk",
"value":{
"type":"PROVIDER",
"name":"Freshworks Provider SIP trunk",
"location":"SAO_PAULO",
"internationalCallsAllowed":true,
"channelLimit":10,
"billingPackage":{
"packageType":"METERED"
},
"provider":{
"accountSid":"223344",
"sipDomain":"123456-sip.domain.com",
"type":"FRESHWORKS"
}
}
},
"Genesys Cloud Provider SIP trunk":{
"summary":"Genesys Cloud Provider SIP trunk",
"value":{
"type":"PROVIDER",
"name":"Genesys Provider SIP trunk",
"internationalCallsAllowed":true,
"channelLimit":10,
"billingPackage":{
"packageType":"METERED"
},
"tls":true,
"provider":{
"region":"NA_US_EAST_1",
"type":"GENESYS_CLOUD"
}
}
},
"Cisco Webex Provider SIP trunk":{
"summary":"Cisco Webex Provider SIP trunk",
"value":{
"type":"PROVIDER",
"name":"Cisco Webex SIP trunk",
"location":"NEW_YORK",
"internationalCallsAllowed":true,
"channelLimit":10,
"billingPackage":{
"packageType":"METERED"
},
"provider":{
"ciscoUUID":"b48b3fdd-d0e4-4da6-b350-58600ec1ffec",
"type":"CISCO_WEBEX"
}
}
},
"OpenAI Realtime Provider SIP trunk":{
"summary":"OpenAI Realtime Provider SIP trunk",
"value":{
"type":"PROVIDER",
"name":"OpenAI Realtime SIP trunk",
"location":"FRANKFURT",
"internationalCallsAllowed":true,
"channelLimit":10,
"billingPackage":{
"packageType":"METERED"
},
"provider":{
"projectId":"proj_123456",
"type":"OPENAI_REALTIME"
}
}
}
}
}
},
"required":true
},
"responses":{
"202":{
"description":"Create SIP trunk request accepted.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.CreateSipTrunkResponse"
},
"examples":{
"Static SIP trunk":{
"summary":"Static SIP trunk",
"value":{
"id":"62eb6ff07b18cc6cdf5cf001",
"type":"STATIC",
"name":"Static SIP Trunk",
"location":"NEW_YORK",
"internationalCallsAllowed":false,
"channelLimit":10,
"billingPackage":{
"packageType":"UNLIMITED",
"countryCode":"USA",
"addressId":"562949953421333"
},
"sbcHosts":{
"primary":[
"111.111.111.111:5060"
],
"backup":[
"222.222.222.222:5060"
],
"subnets":[
"11.22.33.44/24"
]
},
"tls":false,
"codecs":[
"PCMU",
"PCMA"
],
"dtmf":"INBAND",
"fax":"T38",
"numberFormat":"US_NATIONAL",
"anonymization":"REMOTE_PARTY_ID",
"sourceHosts":[
"10.10.10.10"
],
"destinationHosts":[
"100.100.100.100:5060",
"my.destination.com",
"my.destination.com:5060"
],
"strategy":"ROUND_ROBIN",
"sipOptions":{
"enabled":false
}
}
},
"Registered SIP trunk":{
"summary":"Registered SIP trunk",
"value":{
"id":"62eb6ff07b18cc6cdf5cf001",
"type":"REGISTERED",
"name":"Registered SIP Trunk",
"location":"SAO_PAULO",
"internationalCallsAllowed":true,
"channelLimit":999,
"billingPackage":{
"packageType":"METERED"
},
"sbcHosts":{
"primary":[
"111.111.111.111:5061"
],
"backup":[
"222.222.222.222:5061"
],
"subnets":[
"11.22.33.44/24"
]
},
"tls":true,
"codecs":[
"G729"
],
"dtmf":"RFC2833",
"fax":"NONE",
"numberFormat":"E164",
"anonymization":"PREFERRED_IDENTITY",
"username":"426c8402-691c-11ee-8c99-0242ac120002",
"password":"fkZ1921tM87",
"inviteAuthentication":true
}
},
"Freshworks Provider SIP trunk":{
"summary":"Freshworks Provider SIP trunk",
"value":{
"id":"62eb6ff07b18cc6cdf5cf001",
"type":"PROVIDER",
"name":"Freshworks Provider SIP trunk",
"location":"FRANKFURT",
"internationalCallsAllowed":true,
"channelLimit":10,
"billingPackage":{
"packageType":"METERED"
},
"sbcHosts":{
"primary":[
"111.111.111.111:5061"
],
"backup":[
"222.222.222.222:5061"
],
"subnets":[
"11.22.33.44/24"
]
},
"provider":{
"accountSid":"223344",
"sipDomain":"123456-sip.domain.com",
"type":"FRESHWORKS"
}
}
},
"Genesys Cloud Provider SIP trunk":{
"summary":"Genesys Cloud Provider SIP trunk",
"value":{
"id":"62eb6ff07b18cc6cdf5cf001",
"type":"PROVIDER",
"name":"Genesys Provider SIP trunk",
"location":"NEW_YORK",
"internationalCallsAllowed":true,
"channelLimit":10,
"billingPackage":{
"packageType":"METERED"
},
"sbcHosts":{
"primary":[
"111.111.111.111:5061"
],
"backup":[
"222.222.222.222:5061"
]
},
"provider":{
"region":"NA_US_EAST_1",
"outboundTerminationFQDN":"b48b3fdd-d0e4-4da6-b350-58600ec1ffec",
"inboundTerminationIdentifier":"b48b3fdd-d0e4-4da6-b350-58600ec1ffec",
"type":"GENESYS_CLOUD"
}
}
},
"Cisco Webex Provider SIP trunk":{
"summary":"Cisco Webex Provider SIP trunk",
"value":{
"id":"62eb6ff07b18cc6cdf5cf001",
"type":"PROVIDER",
"name":"Cisco Webex SIP trunk",
"location":"NEW_YORK",
"internationalCallsAllowed":true,
"channelLimit":10,
"billingPackage":{
"packageType":"METERED"
},
"provider":{
"ciscoUUID":"b48b3fdd-d0e4-4da6-b350-58600ec1ffec",
"type":"CISCO_WEBEX"
}
}
},
"OpenAI Realtime Provider SIP trunk":{
"summary":"OpenAI Realtime Provider SIP trunk",
"value":{
"id":"62eb6ff07b18cc6cdf5cf001",
"type":"PROVIDER",
"name":"OpenAI Realtime SIP trunk",
"location":"FRANKFURT",
"internationalCallsAllowed":true,
"channelLimit":10,
"billingPackage":{
"packageType":"METERED"
},
"provider":{
"projectId":"proj_123456",
"type":"OPENAI_REALTIME"
}
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:configuration:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"m"
}
]
}
},
"/calls/1/sip-trunks/{sipTrunkId}":{
"get":{
"tags":[
"channels",
"voice",
"calls",
"sip-trunks",
"sip-trunk-management"
],
"summary":"Get SIP trunk",
"description":"Get a single SIP trunk.",
"operationId":"get-sip-trunk",
"parameters":[
{
"name":"sipTrunkId",
"in":"path",
"description":"SIP trunk ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.SipTrunkResponse"
},
"examples":{
"Static SIP trunk":{
"summary":"Static SIP trunk",
"value":{
"id":"62eb6ff07b18cc6cdf5cf001",
"type":"STATIC",
"name":"Static SIP Trunk",
"location":"NEW_YORK",
"tls":false,
"codecs":[
"PCMU",
"PCMA"
],
"dtmf":"INBAND",
"fax":"T38",
"numberFormat":"US_NATIONAL",
"internationalCallsAllowed":false,
"channelLimit":10,
"anonymization":"REMOTE_PARTY_ID",
"billingPackage":{
"packageType":"UNLIMITED",
"countryCode":"USA",
"addressId":"562949953421333"
},
"sbcHosts":{
"primary":[
"111.111.111.111:5060"
],
"backup":[
"222.222.222.222:5060"
],
"subnets":[
"11.22.33.44/24"
]
},
"sipOptions":{
"enabled":false
},
"sourceHosts":[
"10.10.10.10"
],
"destinationHosts":[
"100.100.100.100:5060",
"my.destination.com",
"my.destination.com:5060"
],
"strategy":"ROUND_ROBIN"
}
},
"Registered SIP trunk":{
"summary":"Registered SIP trunk",
"value":{
"id":"62eb6ff07b18cc6cdf5cf001",
"type":"REGISTERED",
"name":"Registered SIP Trunk",
"location":"SAO_PAULO",
"tls":true,
"codecs":[
"G729"
],
"dtmf":"RFC2833",
"fax":"NONE",
"numberFormat":"E164",
"internationalCallsAllowed":true,
"channelLimit":999,
"anonymization":"PREFERRED_IDENTITY",
"billingPackage":{
"packageType":"METERED"
},
"sbcHosts":{
"primary":[
"111.111.111.111:5061"
],
"backup":[
"222.222.222.222:5061"
],
"subnets":[
"11.22.33.44/24"
]
},
"username":"426c8402-691c-11ee-8c99-0242ac120002",
"inviteAuthentication":true
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:configuration:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
},
"put":{
"tags":[
"channels",
"voice",
"calls",
"sip-trunks",
"sip-trunk-management"
],
"summary":"Update SIP trunk",
"description":"Update a SIP trunk. Fields not sent in request body will take default values and overwrite the existing ones. This operation is asynchronous. The SIP trunk will be updated in the background.",
"operationId":"update-sip-trunk",
"parameters":[
{
"name":"sipTrunkId",
"in":"path",
"description":"Sip Trunk ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/6423f137d264daaaab4ca521d6dfeb19cab29b6b25c3d2da0c1c3fb475a5e829.SipTrunkUpdateRequest"
},
"examples":{
"Static SIP trunk":{
"summary":"Static SIP trunk",
"value":{
"type":"STATIC",
"name":"Static SIP trunk",
"internationalCallsAllowed":false,
"channelLimit":10,
"sourceHosts":[
"10.10.10.10"
],
"destinationHosts":[
"100.100.100.101:5060",
"my.destination.com",
"my.destination.com:5060"
],
"codecs":[
"PCMA",
"PCMU"
],
"dtmf":"INBAND",
"fax":"T38",
"anonymization":"REMOTE_PARTY_ID",
"numberFormat":"US_NATIONAL",
"sipOptions":{
"enabled":false
}
}
},
"Registered SIP trunk":{
"summary":"Registered SIP trunk",
"value":{
"type":"REGISTERED",
"name":"Registered SIP trunk",
"internationalCallsAllowed":true,
"channelLimit":999,
"inviteAuthentication":true,
"codecs":[
"G729"
],
"dtmf":"RFC2833",
"fax":"NONE",
"anonymization":"PREFERRED_IDENTITY",
"numberFormat":"E164"
}
}
}
}
},
"required":true
},
"responses":{
"202":{
"description":"Update SIP trunk request accepted.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.SipTrunkResponse"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:configuration:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"m"
}
]
},
"delete":{
"tags":[
"channels",
"voice",
"calls",
"sip-trunks",
"sip-trunk-management"
],
"summary":"Delete SIP trunk",
"description":"Delete a SIP trunk. This operation is asynchronous. The SIP trunk will be deleted in the background.",
"operationId":"delete-sip-trunk",
"parameters":[
{
"name":"sipTrunkId",
"in":"path",
"description":"SIP trunk ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"202":{
"description":"Delete SIP trunk request accepted.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.SipTrunkResponse"
},
"examples":{
"Static SIP trunk":{
"summary":"Static SIP trunk",
"value":{
"id":"62eb6ff07b18cc6cdf5cf001",
"type":"STATIC",
"name":"Static SIP Trunk",
"location":"NEW_YORK",
"tls":false,
"codecs":[
"PCMU",
"PCMA"
],
"dtmf":"INBAND",
"fax":"T38",
"numberFormat":"US_NATIONAL",
"internationalCallsAllowed":false,
"channelLimit":10,
"anonymization":"REMOTE_PARTY_ID",
"billingPackage":{
"packageType":"UNLIMITED",
"countryCode":"USA",
"addressId":"562949953421333"
},
"sbcHosts":{
"primary":[
"111.111.111.111:5060"
],
"backup":[
"222.222.222.222:5060"
],
"subnets":[
"11.22.33.44/24"
]
},
"sipOptions":{
"enabled":false
},
"sourceHosts":[
"10.10.10.10"
],
"destinationHosts":[
"100.100.100.100:5060",
"my.destination.com",
"my.destination.com:5060"
],
"strategy":"ROUND_ROBIN"
}
},
"Registered SIP trunk":{
"summary":"Registered SIP trunk",
"value":{
"id":"62eb6ff07b18cc6cdf5cf001",
"type":"REGISTERED",
"name":"Registered SIP Trunk",
"location":"SAO_PAULO",
"tls":true,
"codecs":[
"G729"
],
"dtmf":"RFC2833",
"fax":"NONE",
"numberFormat":"E164",
"internationalCallsAllowed":true,
"channelLimit":999,
"anonymization":"PREFERRED_IDENTITY",
"billingPackage":{
"packageType":"METERED"
},
"sbcHosts":{
"primary":[
"111.111.111.111:5061"
],
"backup":[
"222.222.222.222:5061"
],
"subnets":[
"11.22.33.44/24"
]
},
"username":"426c8402-691c-11ee-8c99-0242ac120002",
"inviteAuthentication":true
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:configuration:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/sip-trunks/{sipTrunkId}/reset-password":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"sip-trunks",
"sip-trunk-management"
],
"summary":"Reset SIP trunk credentials",
"description":"Reset credentials. For `REGISTERED` SIP trunks, resets the registration password. For `AUTHENTICATED` SIP trunks, resets the authentication secrets (header value and digest credentials).",
"operationId":"reset-sip-trunk-password",
"parameters":[
{
"name":"sipTrunkId",
"in":"path",
"description":"SIP trunk ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"Successfully reset credentials.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.SipTrunkResetPasswordResponse"
},
"examples":{
"Registered SIP trunk credentials":{
"summary":"Registered SIP trunk credentials",
"value":{
"username":"426c8402-691c-11ee-8c99-0242ac120002",
"password":"fkZ1921tM87",
"type":"REGISTERED"
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:configuration:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/sip-trunks/{sipTrunkId}/status":{
"get":{
"tags":[
"channels",
"voice",
"calls",
"sip-trunks",
"sip-trunk-status-management"
],
"summary":"Get SIP trunk status",
"description":"Get a SIP trunk status. Successfully deleted SIP trunk does not have status.",
"operationId":"get-sip-trunk-status",
"parameters":[
{
"name":"sipTrunkId",
"in":"path",
"description":"Sip Trunk ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"SIP trunk status.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.ExtendedSipTrunkStatusResponse"
},
"examples":{
"Response example 1":{
"summary":"Response example 1",
"value":{
"adminStatus":"ENABLED",
"actionStatus":{
"status":"SUCCESS"
},
"activeCalls":100
}
},
"Response example 2":{
"summary":"Response example 2",
"value":{
"adminStatus":"DISABLED",
"actionStatus":{
"status":"FAILED",
"reason":"Invalid source IP."
},
"activeCalls":0
}
},
"Response example 3":{
"summary":"Response example 3",
"value":{
"adminStatus":"DISABLED",
"actionStatus":{
"status":"RESET",
"reason":"Not enough credits."
},
"registrationStatus":"UNREGISTERED",
"activeCalls":0
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:configuration:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"m"
}
]
},
"post":{
"tags":[
"channels",
"voice",
"calls",
"sip-trunks",
"sip-trunk-status-management"
],
"summary":"Set SIP trunk status",
"description":"Set a SIP trunk's status.",
"operationId":"set-sip-trunk-status",
"parameters":[
{
"name":"sipTrunkId",
"in":"path",
"description":"Sip Trunk ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/6423f137d264daaaab4ca521d6dfeb19cab29b6b25c3d2da0c1c3fb475a5e829.SipTrunkStatusRequest"
},
"examples":{
"Request example 1":{
"summary":"Request example 1",
"value":{
"adminStatus":"ENABLED"
}
},
"Request example 2":{
"summary":"Request example 2",
"value":{
"adminStatus":"DISABLED"
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"SIP trunk status set.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.SipTrunkStatusResponse"
},
"examples":{
"Response example 1":{
"summary":"Response example 1",
"value":{
"adminStatus":"ENABLED"
}
},
"Response example 2":{
"summary":"Response example 2",
"value":{
"adminStatus":"DISABLED"
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:configuration:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"m"
}
]
}
},
"/calls/1/sip-trunks/service-addresses":{
"get":{
"tags":[
"channels",
"voice",
"calls",
"sip-trunks",
"sip-trunk-service-address-management"
],
"summary":"Get SIP trunk service addresses",
"description":"Get SIP trunk service addresses.",
"operationId":"get-sip-trunk-service-addresses",
"parameters":[
{
"name":"page",
"in":"query",
"description":"Results page to retrieve (0..N).",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":0,
"minimum":0
}
},
{
"name":"size",
"in":"query",
"description":"Number of records per page.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":20,
"maximum":100,
"minimum":1
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.SipTrunkServiceAddressPage"
},
"examples":{
"SIP trunk service address page response.":{
"summary":"SIP trunk service address page response.",
"value":{
"results":[
{
"id":"abc-def-ghi",
"name":"Location address name",
"street":"Location address street",
"city":"My city",
"postCode":"71000",
"suite":"1030",
"country":{
"name":"Croatia",
"code":"HRV"
},
"region":{
"name":"Zagreb County",
"code":"HR-01"
}
}
],
"paging":{
"page":0,
"size":20,
"totalPages":1,
"totalResults":1
}
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:configuration:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
},
"post":{
"tags":[
"channels",
"voice",
"calls",
"sip-trunks",
"sip-trunk-service-address-management"
],
"summary":"Create SIP trunk service address",
"description":"Create a SIP trunk service address.",
"operationId":"create-sip-trunk-service-address",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/5cec81334b90b810e64e8923d2a0d906614be46012f19935bf49fd13e921d8b2.PublicSipTrunkServiceAddressRequest"
},
"examples":{
"SIP trunk service address request":{
"summary":"SIP trunk service address request",
"value":{
"name":"Location address name",
"street":"Location address street",
"city":"My city",
"postCode":"71000",
"suite":"1030",
"countryCode":"HRV",
"countryRegionCode":"HR-01"
}
}
}
}
},
"required":true
},
"responses":{
"201":{
"description":"SIP trunk service address created.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/5cec81334b90b810e64e8923d2a0d906614be46012f19935bf49fd13e921d8b2.PublicSipTrunkServiceAddress"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":{
"id":"abc-def-ghi",
"name":"Location address name",
"street":"Location address street",
"city":"My city",
"postCode":"71000",
"suite":"1030",
"country":{
"name":"Croatia",
"code":"HRV"
},
"region":{
"name":"Zagreb County",
"code":"HR-01"
}
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:configuration:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"m"
}
]
}
},
"/calls/1/sip-trunks/service-addresses/{sipTrunkServiceAddressId}":{
"get":{
"tags":[
"channels",
"voice",
"calls",
"sip-trunks",
"sip-trunk-service-address-management"
],
"summary":"Get SIP trunk service address",
"description":"Get SIP trunk service address.",
"operationId":"get-sip-trunk-service-address",
"parameters":[
{
"name":"sipTrunkServiceAddressId",
"in":"path",
"description":"SIP trunk service address ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/5cec81334b90b810e64e8923d2a0d906614be46012f19935bf49fd13e921d8b2.PublicSipTrunkServiceAddress"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":{
"id":"abc-def-ghi",
"name":"Location address name",
"street":"Location address street",
"city":"My city",
"postCode":"71000",
"suite":"1030",
"country":{
"name":"Croatia",
"code":"HRV"
},
"region":{
"name":"Zagreb County",
"code":"HR-01"
}
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:configuration:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"m"
}
]
},
"put":{
"tags":[
"channels",
"voice",
"calls",
"sip-trunks",
"sip-trunk-service-address-management"
],
"summary":"Update SIP trunk service address",
"description":"Update SIP trunk service address.",
"operationId":"update-sip-trunk-service-address",
"parameters":[
{
"name":"sipTrunkServiceAddressId",
"in":"path",
"description":"SIP trunk service address ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/5cec81334b90b810e64e8923d2a0d906614be46012f19935bf49fd13e921d8b2.PublicSipTrunkServiceAddressRequest"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/5cec81334b90b810e64e8923d2a0d906614be46012f19935bf49fd13e921d8b2.PublicSipTrunkServiceAddress"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":{
"id":"abc-def-ghi",
"name":"Location address name",
"street":"Location address street",
"city":"My city",
"postCode":"71000",
"suite":"1030",
"country":{
"name":"Croatia",
"code":"HRV"
},
"region":{
"name":"Zagreb County",
"code":"HR-01"
}
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:configuration:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"m"
}
]
},
"delete":{
"tags":[
"channels",
"voice",
"calls",
"sip-trunks",
"sip-trunk-service-address-management"
],
"summary":"Delete SIP trunk service address",
"description":"Delete SIP trunk service address.",
"operationId":"delete-sip-trunk-service-address",
"parameters":[
{
"name":"sipTrunkServiceAddressId",
"in":"path",
"description":"SIP trunk service address ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/5cec81334b90b810e64e8923d2a0d906614be46012f19935bf49fd13e921d8b2.PublicSipTrunkServiceAddress"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":{
"id":"abc-def-ghi",
"name":"Location address name",
"street":"Location address street",
"city":"My city",
"postCode":"71000",
"suite":"1030",
"country":{
"name":"Croatia",
"code":"HRV"
},
"region":{
"name":"Zagreb County",
"code":"HR-01"
}
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:configuration:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"m"
}
]
}
},
"/calls/1/sip-trunks/service-addresses/countries":{
"get":{
"tags":[
"channels",
"voice",
"calls",
"sip-trunks",
"sip-trunk-service-address-management"
],
"summary":"Get countries",
"description":"Get countries with shortcodes you'd need for a SIP trunk address.",
"operationId":"get-countries",
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/5cec81334b90b810e64e8923d2a0d906614be46012f19935bf49fd13e921d8b2.PublicCountry"
}
},
"examples":{
"Response example":{
"summary":"Response example",
"value":[
{
"name":"New Zealand",
"code":"NZL"
},
{
"name":"Fiji",
"code":"FJI"
},
{
"name":"Guadeloupe",
"code":"GLP"
}
]
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:configuration:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/sip-trunks/service-addresses/countries/regions":{
"get":{
"tags":[
"channels",
"voice",
"calls",
"sip-trunks",
"sip-trunk-service-address-management"
],
"summary":"Get regions",
"description":"Get regions with shortcodes you'd need for a SIP trunk address.",
"operationId":"get-regions",
"parameters":[
{
"name":"countryCode",
"in":"query",
"description":"Country code.",
"required":true,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"HRV"
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/5cec81334b90b810e64e8923d2a0d906614be46012f19935bf49fd13e921d8b2.PublicRegion"
}
},
"examples":{
"Response example":{
"summary":"Response example",
"value":[
{
"name":"Dubrovnik-Neretva County",
"code":"HR-19",
"countryCode":"HRV"
},
{
"name":"Međimurje County",
"code":"HR-20",
"countryCode":"HRV"
},
{
"name":"City of Zagreb",
"code":"HR-21",
"countryCode":"HRV"
}
]
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:configuration:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/files":{
"get":{
"tags":[
"channels",
"voice",
"calls",
"files-and-recordings",
"file-operations"
],
"summary":"Get files",
"description":"Get files with pagination. Maximum number of pages is 100.",
"operationId":"get-calls-files",
"parameters":[
{
"name":"page",
"in":"query",
"description":"Results page to retrieve (0..N).",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":0,
"minimum":0
}
},
{
"name":"size",
"in":"query",
"description":"Number of records per page.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":20,
"maximum":100,
"minimum":1
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.FilePage"
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:media:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
},
"post":{
"tags":[
"channels",
"voice",
"calls",
"files-and-recordings",
"file-operations"
],
"summary":"Upload audio file",
"description":"Upload an audio file. Uploaded files can be played on calls, dialogs or conferences. The file will be removed if it is not used for 90 days.",
"operationId":"upload-calls-audio-file",
"requestBody":{
"description":"Audio file to be uploaded.",
"content":{
"multipart/form-data":{
"schema":{
"type":"object",
"properties":{
"file":{
"type":"string",
"format":"binary"
}
},
"required":[
"file"
]
}
}
}
},
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.File"
}
}
}
},
"400":{
"$ref":"#/components/responses/ApiException400"
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:media:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"m"
}
]
}
},
"/calls/1/files/{fileId}":{
"get":{
"tags":[
"channels",
"voice",
"calls",
"files-and-recordings",
"file-operations"
],
"summary":"Get file",
"description":"Get a single file.",
"operationId":"get-calls-file",
"parameters":[
{
"name":"fileId",
"in":"path",
"description":"File ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.File"
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:media:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
},
"delete":{
"tags":[
"channels",
"voice",
"calls",
"files-and-recordings",
"file-operations"
],
"summary":"Delete file",
"description":"Delete a file.",
"operationId":"delete-calls-file",
"parameters":[
{
"name":"fileId",
"in":"path",
"description":"File ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.File"
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:media:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/recordings/calls":{
"get":{
"tags":[
"channels",
"voice",
"calls",
"files-and-recordings",
"recording-operations"
],
"summary":"Get calls recordings",
"description":"Get the recordings of calls with pagination.",
"operationId":"get-calls-recordings",
"parameters":[
{
"name":"callId",
"in":"query",
"description":"Call ID.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"64d214c5-70b7-4ea6-b2a6-8334d1f34fb4"
},
{
"name":"callsConfigurationId",
"in":"query",
"description":"Calls Configuration ID.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"dc5942707c704551a00cd2ea"
},
{
"name":"applicationId",
"in":"query",
"description":"Application ID.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"61c060db2675060027d8c7a6"
},
{
"name":"entityId",
"in":"query",
"description":"Entity ID.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"64d214c5-70b7-4ea6-b2a6-8334d1f34fb4"
},
{
"name":"endpointIdentifier",
"in":"query",
"description":"Endpoint identifier.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":44790123456
},
{
"name":"startTimeAfter",
"in":"query",
"description":"Date and time when the (first) call recording started.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"format":"date-time"
},
"example":"2022-05-01T14:25:45.134+0000"
},
{
"name":"endTimeBefore",
"in":"query",
"description":"Date and time when the (last) call recording ended.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"format":"date-time"
},
"example":"2022-05-01T14:35:45.154+0000"
},
{
"name":"direction",
"in":"query",
"description":"Call direction.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallDirection"
},
"example":"OUTBOUND"
},
{
"name":"endpointType",
"in":"query",
"description":"Endpoint type.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallEndpointType"
},
"example":"WEBRTC"
},
{
"name":"location",
"in":"query",
"description":"Recording location.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingLocation"
},
"example":"FRANKFURT"
},
{
"name":"page",
"in":"query",
"description":"Results page to retrieve (0..N).",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":0,
"minimum":0
}
},
{
"name":"size",
"in":"query",
"description":"Number of records per page.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":20,
"maximum":100,
"minimum":1
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.CallRecordingPage"
},
"examples":{
"Call recording page response.":{
"summary":"Call recording page response.",
"value":{
"results":[
{
"callId":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"endpoint":{
"type":"PHONE",
"phoneNumber":"41793026834"
},
"direction":"INBOUND",
"files":[
{
"id":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"name":"d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav",
"fileFormat":"WAV",
"size":67564,
"creationTime":"2026-01-15T12:00:00.150+0000",
"duration":10,
"startTime":"2026-01-15T11:59:50.000+0000",
"endTime":"2026-01-15T12:00:00.000+0000",
"location":"HOSTED",
"customData":{
"key1":"value1",
"key2":"value2"
}
}
],
"status":"SUCCESSFUL"
},
{
"callId":"ae024ad1-52e7-45d5-a5d2-cd7c809e03f8",
"endpoint":{
"type":"PHONE",
"phoneNumber":"41793026834"
},
"direction":"INBOUND",
"files":[
{
"id":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"name":"d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav",
"fileFormat":"WAV",
"size":67564,
"creationTime":"2026-01-15T12:00:00.150+0000",
"duration":10,
"startTime":"2026-01-15T11:59:50.000+0000",
"endTime":"2026-01-15T12:00:00.000+0000",
"location":"HOSTED",
"customData":{
"key1":"value1",
"key2":"value2"
}
}
],
"status":"PARTIALLY_FAILED",
"reason":"Recording postprocessing failed"
}
],
"paging":{
"page":0,
"size":2,
"totalPages":1,
"totalResults":2
}
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:recording:read"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/recordings/calls/{callId}":{
"get":{
"tags":[
"channels",
"voice",
"calls",
"files-and-recordings",
"recording-operations"
],
"summary":"Get call recordings",
"description":"Get the recordings for a single call.",
"operationId":"get-call-recordings",
"parameters":[
{
"name":"callId",
"in":"path",
"description":"Call ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
},
{
"name":"location",
"in":"query",
"description":"Recording location.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingLocation"
},
"example":"FRANKFURT"
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/a8c993b4bcabd2960dfaf3986394e0fe85cd1c09dc98b0a81b51403a00c8f97c.PublicCallRecording"
},
"examples":{
"Call recording":{
"summary":"Call recording",
"value":{
"callId":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"endpoint":{
"type":"PHONE",
"phoneNumber":"41793026834"
},
"direction":"INBOUND",
"files":[
{
"id":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"name":"d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav",
"fileFormat":"WAV",
"size":67564,
"creationTime":"2026-01-15T12:00:00.150+0000",
"duration":10,
"startTime":"2026-01-15T11:59:50.000+0000",
"endTime":"2026-01-15T12:00:00.000+0000",
"location":"HOSTED",
"customData":{
"key1":"value1",
"key2":"value2"
}
}
],
"status":"SUCCESSFUL"
}
},
"Failed call recording":{
"summary":"Failed call recording",
"value":{
"callId":"ae024ad1-52e7-45d5-a5d2-cd7c809e03f8",
"endpoint":{
"type":"PHONE",
"phoneNumber":"41793026834"
},
"direction":"INBOUND",
"files":[
{
"id":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"name":"d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav",
"fileFormat":"WAV",
"size":67564,
"creationTime":"2026-01-15T12:00:00.150+0000",
"duration":10,
"startTime":"2026-01-15T11:59:50.000+0000",
"endTime":"2026-01-15T12:00:00.000+0000",
"location":"HOSTED",
"customData":{
"key1":"value1",
"key2":"value2"
}
}
],
"status":"PARTIALLY_FAILED",
"reason":"Recording postprocessing failed"
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:recording:read"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
},
"delete":{
"tags":[
"channels",
"voice",
"calls",
"files-and-recordings",
"recording-operations"
],
"summary":"Delete call recordings",
"description":"Delete the recordings for a single call.",
"operationId":"delete-call-recordings",
"parameters":[
{
"name":"callId",
"in":"path",
"description":"Call ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
},
{
"name":"location",
"in":"query",
"description":"Recording location.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingLocation"
},
"example":"FRANKFURT"
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/a8c993b4bcabd2960dfaf3986394e0fe85cd1c09dc98b0a81b51403a00c8f97c.PublicCallRecording"
},
"examples":{
"Call recording":{
"summary":"Call recording",
"value":{
"callId":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"endpoint":{
"type":"PHONE",
"phoneNumber":"41793026834"
},
"direction":"INBOUND",
"files":[
{
"id":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"name":"d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav",
"fileFormat":"WAV",
"size":67564,
"creationTime":"2026-01-15T12:00:00.150+0000",
"duration":10,
"startTime":"2026-01-15T11:59:50.000+0000",
"endTime":"2026-01-15T12:00:00.000+0000",
"location":"HOSTED",
"customData":{
"key1":"value1",
"key2":"value2"
}
}
],
"status":"SUCCESSFUL"
}
},
"Failed call recording":{
"summary":"Failed call recording",
"value":{
"callId":"ae024ad1-52e7-45d5-a5d2-cd7c809e03f8",
"endpoint":{
"type":"PHONE",
"phoneNumber":"41793026834"
},
"direction":"INBOUND",
"files":[
{
"id":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"name":"d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav",
"fileFormat":"WAV",
"size":67564,
"creationTime":"2026-01-15T12:00:00.150+0000",
"duration":10,
"startTime":"2026-01-15T11:59:50.000+0000",
"endTime":"2026-01-15T12:00:00.000+0000",
"location":"HOSTED",
"customData":{
"key1":"value1",
"key2":"value2"
}
}
],
"status":"PARTIALLY_FAILED",
"reason":"Recording postprocessing failed"
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:recording:delete"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/recordings/conferences":{
"get":{
"tags":[
"channels",
"voice",
"calls",
"files-and-recordings",
"recording-operations"
],
"summary":"Get conferences recordings",
"description":"Get the recordings of conferences with pagination.",
"operationId":"get-conferences-recordings",
"parameters":[
{
"name":"conferenceId",
"in":"query",
"description":"Conference ID.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"64d214c5-70b7-4ea6-b2a6-8334d1f34fb4"
},
{
"name":"callsConfigurationId",
"in":"query",
"description":"Calls Configuration ID.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"dc5942707c704551a00cd2ea"
},
{
"name":"applicationId",
"in":"query",
"description":"Application ID.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"61c060db2675060027d8c7a6"
},
{
"name":"entityId",
"in":"query",
"description":"Entity ID.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"64d214c5-70b7-4ea6-b2a6-8334d1f34fb4"
},
{
"name":"conferenceName",
"in":"query",
"description":"Conference name.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"Conference"
},
{
"name":"callId",
"in":"query",
"description":"Filter all conference recordings where call ID was included in the recording.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"64d214c5-70b7-4ea6-b2a6-8334d1f34fb4"
},
{
"name":"callEndpointType",
"in":"query",
"description":"Filter all conference recordings where calls with endpoint type were included in the recording.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallEndpointType"
},
"example":"WEBRTC"
},
{
"name":"callEndpointIdentifier",
"in":"query",
"description":"Filter all conference recordings where calls with endpoint identifier were included in the recording.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":44790123456
},
{
"name":"startTimeAfter",
"in":"query",
"description":"Date and time when the (first) conference recording started.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"format":"date-time"
},
"example":"2022-05-01T14:25:45.134+0000"
},
{
"name":"endTimeBefore",
"in":"query",
"description":"Date and time when the (last) conference recording ended.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"format":"date-time"
},
"example":"2022-05-01T14:35:45.154+0000"
},
{
"name":"composition",
"in":"query",
"description":"Flag indicating whether auto-compose feature was turned on for the recording.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"boolean"
},
"example":true
},
{
"name":"location",
"in":"query",
"description":"Recording location.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingLocation"
},
"example":"FRANKFURT"
},
{
"name":"page",
"in":"query",
"description":"Results page to retrieve (0..N).",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":0,
"minimum":0
}
},
{
"name":"size",
"in":"query",
"description":"Number of records per page.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":20,
"maximum":100,
"minimum":1
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.ConferenceRecordingPage"
},
"examples":{
"Conference recording page response.":{
"summary":"Conference recording page response.",
"value":{
"results":[
{
"conferenceId":"e8a7c0f5-0f0b-4ccf-84a4-1b7e5f699001",
"conferenceName":"Example conference",
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
},
"composedFiles":[
{
"id":"65f0b3d7c8b6a00001a2b3d5",
"name":"example-recording.wav",
"fileFormat":"WAV",
"size":67564,
"creationTime":"2026-01-15T12:00:00.150+0000",
"duration":10,
"startTime":"2026-01-15T11:59:50.000+0000",
"endTime":"2026-01-15T12:00:00.000+0000",
"location":"SFTP",
"sftpUploadStatus":"UPLOADED",
"customData":{
"key1":"value1",
"key2":"value2"
}
}
],
"callRecordings":[
{
"callId":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"endpoint":{
"type":"PHONE",
"phoneNumber":"41793026834"
},
"direction":"INBOUND",
"files":[
{
"id":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"name":"d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav",
"fileFormat":"WAV",
"size":67564,
"creationTime":"2026-01-15T12:00:00.150+0000",
"duration":10,
"startTime":"2026-01-15T11:59:50.000+0000",
"endTime":"2026-01-15T12:00:00.000+0000",
"location":"HOSTED",
"customData":{
"key1":"value1",
"key2":"value2"
}
}
],
"status":"SUCCESSFUL"
},
{
"callId":"ae024ad1-52e7-45d5-a5d2-cd7c809e03f8",
"endpoint":{
"type":"PHONE",
"phoneNumber":"41793026834"
},
"direction":"INBOUND",
"files":[
{
"id":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"name":"d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav",
"fileFormat":"WAV",
"size":67564,
"creationTime":"2026-01-15T12:00:00.150+0000",
"duration":10,
"startTime":"2026-01-15T11:59:50.000+0000",
"endTime":"2026-01-15T12:00:00.000+0000",
"location":"HOSTED",
"customData":{
"key1":"value1",
"key2":"value2"
}
}
],
"status":"SUCCESSFUL"
}
]
}
],
"paging":{
"page":0,
"size":1,
"totalPages":1,
"totalResults":1
}
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:recording:read"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/recordings/conferences/{conferenceId}":{
"get":{
"tags":[
"channels",
"voice",
"calls",
"files-and-recordings",
"recording-operations"
],
"summary":"Get conference recordings",
"description":"Get the recordings for a single conference.",
"operationId":"get-conference-recordings",
"parameters":[
{
"name":"conferenceId",
"in":"path",
"description":"Conference ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
},
{
"name":"location",
"in":"query",
"description":"Recording location.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingLocation"
},
"example":"FRANKFURT"
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/a8c993b4bcabd2960dfaf3986394e0fe85cd1c09dc98b0a81b51403a00c8f97c.PublicConferenceRecording"
},
"examples":{
"Conference recording response":{
"summary":"Conference recording response",
"value":{
"conferenceId":"e8a7c0f5-0f0b-4ccf-84a4-1b7e5f699001",
"conferenceName":"Example conference",
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
},
"composedFiles":[
{
"id":"65f0b3d7c8b6a00001a2b3d5",
"name":"example-recording.wav",
"fileFormat":"WAV",
"size":67564,
"creationTime":"2026-01-15T12:00:00.150+0000",
"duration":10,
"startTime":"2026-01-15T11:59:50.000+0000",
"endTime":"2026-01-15T12:00:00.000+0000",
"location":"SFTP",
"sftpUploadStatus":"UPLOADED",
"customData":{
"key1":"value1",
"key2":"value2"
}
}
],
"callRecordings":[
{
"callId":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"endpoint":{
"type":"PHONE",
"phoneNumber":"41793026834"
},
"direction":"INBOUND",
"files":[
{
"id":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"name":"d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav",
"fileFormat":"WAV",
"size":67564,
"creationTime":"2026-01-15T12:00:00.150+0000",
"duration":10,
"startTime":"2026-01-15T11:59:50.000+0000",
"endTime":"2026-01-15T12:00:00.000+0000",
"location":"HOSTED",
"customData":{
"key1":"value1",
"key2":"value2"
}
}
],
"status":"SUCCESSFUL"
},
{
"callId":"ae024ad1-52e7-45d5-a5d2-cd7c809e03f8",
"endpoint":{
"type":"PHONE",
"phoneNumber":"41793026834"
},
"direction":"INBOUND",
"files":[
{
"id":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"name":"d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav",
"fileFormat":"WAV",
"size":67564,
"creationTime":"2026-01-15T12:00:00.150+0000",
"duration":10,
"startTime":"2026-01-15T11:59:50.000+0000",
"endTime":"2026-01-15T12:00:00.000+0000",
"location":"HOSTED",
"customData":{
"key1":"value1",
"key2":"value2"
}
}
],
"status":"SUCCESSFUL"
}
]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:recording:read"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
},
"delete":{
"tags":[
"channels",
"voice",
"calls",
"files-and-recordings",
"recording-operations"
],
"summary":"Delete conference recordings",
"description":"Delete the recordings for a single conference.",
"operationId":"delete-conference-recordings",
"parameters":[
{
"name":"conferenceId",
"in":"path",
"description":"Conference ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
},
{
"name":"location",
"in":"query",
"description":"Recording location.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingLocation"
},
"example":"FRANKFURT"
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/a8c993b4bcabd2960dfaf3986394e0fe85cd1c09dc98b0a81b51403a00c8f97c.PublicConferenceRecording"
},
"examples":{
"Conference recording response":{
"summary":"Conference recording response",
"value":{
"conferenceId":"e8a7c0f5-0f0b-4ccf-84a4-1b7e5f699001",
"conferenceName":"Example conference",
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
},
"composedFiles":[
{
"id":"65f0b3d7c8b6a00001a2b3d5",
"name":"example-recording.wav",
"fileFormat":"WAV",
"size":67564,
"creationTime":"2026-01-15T12:00:00.150+0000",
"duration":10,
"startTime":"2026-01-15T11:59:50.000+0000",
"endTime":"2026-01-15T12:00:00.000+0000",
"location":"SFTP",
"sftpUploadStatus":"UPLOADED",
"customData":{
"key1":"value1",
"key2":"value2"
}
}
],
"callRecordings":[
{
"callId":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"endpoint":{
"type":"PHONE",
"phoneNumber":"41793026834"
},
"direction":"INBOUND",
"files":[
{
"id":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"name":"d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav",
"fileFormat":"WAV",
"size":67564,
"creationTime":"2026-01-15T12:00:00.150+0000",
"duration":10,
"startTime":"2026-01-15T11:59:50.000+0000",
"endTime":"2026-01-15T12:00:00.000+0000",
"location":"HOSTED",
"customData":{
"key1":"value1",
"key2":"value2"
}
}
],
"status":"SUCCESSFUL"
},
{
"callId":"ae024ad1-52e7-45d5-a5d2-cd7c809e03f8",
"endpoint":{
"type":"PHONE",
"phoneNumber":"41793026834"
},
"direction":"INBOUND",
"files":[
{
"id":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"name":"d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav",
"fileFormat":"WAV",
"size":67564,
"creationTime":"2026-01-15T12:00:00.150+0000",
"duration":10,
"startTime":"2026-01-15T11:59:50.000+0000",
"endTime":"2026-01-15T12:00:00.000+0000",
"location":"HOSTED",
"customData":{
"key1":"value1",
"key2":"value2"
}
}
],
"status":"SUCCESSFUL"
}
]
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":"Bad request"
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:recording:delete"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/recordings/conferences/{conferenceId}/compose":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"files-and-recordings",
"recording-operations"
],
"summary":"Compose conference recording on calls",
"description":"Compose conference recording on calls. All calls will be merged into a single audio or video file.",
"operationId":"compose-conference-recording",
"parameters":[
{
"name":"conferenceId",
"in":"path",
"description":"Conference ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
},
{
"name":"location",
"in":"query",
"description":"Recording location.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingLocation"
},
"example":"FRANKFURT"
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.OnDemandComposition"
}
}
}
},
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse"
}
}
}
},
"400":{
"$ref":"#/components/responses/ApiException400"
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:recording:read"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/recordings/dialogs":{
"get":{
"tags":[
"channels",
"voice",
"calls",
"files-and-recordings",
"recording-operations"
],
"summary":"Get dialogs recordings",
"description":"Get the recordings of dialogs with pagination.",
"operationId":"get-dialogs-recordings",
"parameters":[
{
"name":"dialogId",
"in":"query",
"description":"Dialog ID.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"64d214c5-70b7-4ea6-b2a6-8334d1f34fb4"
},
{
"name":"callsConfigurationId",
"in":"query",
"description":"Calls Configuration ID.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"dc5942707c704551a00cd2ea"
},
{
"name":"applicationId",
"in":"query",
"description":"Application ID.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"61c060db2675060027d8c7a6"
},
{
"name":"entityId",
"in":"query",
"description":"Entity ID.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"64d214c5-70b7-4ea6-b2a6-8334d1f34fb4"
},
{
"name":"callId",
"in":"query",
"description":"Filter all dialog recordings where call ID was included in the recording.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"64d214c5-70b7-4ea6-b2a6-8334d1f34fb4"
},
{
"name":"callEndpointType",
"in":"query",
"description":"Filter all dialog recordings where calls with endpoint type were included in the recording.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallEndpointType"
},
"example":"WEBRTC"
},
{
"name":"callEndpointIdentifier",
"in":"query",
"description":"Filter all dialog recordings where calls with endpoint identifier were included in the recording.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":44790123456
},
{
"name":"startTimeAfter",
"in":"query",
"description":"Date and time when the (first) dialog recording started.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"format":"date-time"
},
"example":"2022-05-01T14:25:45.134+0000"
},
{
"name":"endTimeBefore",
"in":"query",
"description":"Date and time when the (last) dialog recording ended.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"format":"date-time"
},
"example":"2022-05-01T14:35:45.154+0000"
},
{
"name":"composition",
"in":"query",
"description":"Flag indicating whether auto-compose feature was turned on for the recording.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"boolean"
},
"example":true
},
{
"name":"location",
"in":"query",
"description":"Recording location.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingLocation"
},
"example":"FRANKFURT"
},
{
"name":"page",
"in":"query",
"description":"Results page to retrieve (0..N).",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":0,
"minimum":0
}
},
{
"name":"size",
"in":"query",
"description":"Number of records per page.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":20,
"maximum":100,
"minimum":1
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.DialogRecordingPage"
},
"examples":{
"Dialog recording page response.":{
"summary":"Dialog recording page response.",
"value":{
"results":[
{
"dialogId":"034e622a-cc7e-456d-8a10-0ba43b11aa5e",
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
},
"composedFiles":[
{
"id":"65f0b3d7c8b6a00001a2b3d5",
"name":"example-recording.wav",
"fileFormat":"WAV",
"size":67564,
"creationTime":"2026-01-15T12:00:00.150+0000",
"duration":10,
"startTime":"2026-01-15T11:59:50.000+0000",
"endTime":"2026-01-15T12:00:00.000+0000",
"location":"HOSTED",
"customData":{
"key1":"value1",
"key2":"value2"
}
}
],
"callRecordings":[
{
"callId":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"endpoint":{
"type":"PHONE",
"phoneNumber":"41793026834"
},
"direction":"INBOUND",
"files":[
{
"id":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"name":"d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav",
"fileFormat":"WAV",
"size":67564,
"creationTime":"2026-01-15T12:00:00.150+0000",
"duration":10,
"startTime":"2026-01-15T11:59:50.000+0000",
"endTime":"2026-01-15T12:00:00.000+0000",
"location":"HOSTED",
"customData":{
"key1":"value1",
"key2":"value2"
}
}
],
"status":"SUCCESSFUL"
},
{
"callId":"ae024ad1-52e7-45d5-a5d2-cd7c809e03f8",
"endpoint":{
"type":"PHONE",
"phoneNumber":"41793026834"
},
"direction":"INBOUND",
"files":[
{
"id":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"name":"d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav",
"fileFormat":"WAV",
"size":67564,
"creationTime":"2026-01-15T12:00:00.150+0000",
"duration":10,
"startTime":"2026-01-15T11:59:50.000+0000",
"endTime":"2026-01-15T12:00:00.000+0000",
"location":"HOSTED",
"customData":{
"key1":"value1",
"key2":"value2"
}
}
],
"status":"SUCCESSFUL"
}
]
}
],
"paging":{
"page":0,
"size":1,
"totalPages":1,
"totalResults":1
}
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:recording:read"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/recordings/dialogs/{dialogId}":{
"get":{
"tags":[
"channels",
"voice",
"calls",
"files-and-recordings",
"recording-operations"
],
"summary":"Get dialog recordings",
"description":"Get the recordings for a single dialog.",
"operationId":"get-dialog-recordings",
"parameters":[
{
"name":"dialogId",
"in":"path",
"description":"Dialog ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
},
{
"name":"location",
"in":"query",
"description":"Recording location.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingLocation"
},
"example":"FRANKFURT"
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/a8c993b4bcabd2960dfaf3986394e0fe85cd1c09dc98b0a81b51403a00c8f97c.PublicDialogRecording"
},
"examples":{
"Dialog recording response":{
"summary":"Dialog recording response",
"value":{
"dialogId":"034e622a-cc7e-456d-8a10-0ba43b11aa5e",
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
},
"composedFiles":[
{
"id":"65f0b3d7c8b6a00001a2b3d5",
"name":"example-recording.wav",
"fileFormat":"WAV",
"size":67564,
"creationTime":"2026-01-15T12:00:00.150+0000",
"duration":10,
"startTime":"2026-01-15T11:59:50.000+0000",
"endTime":"2026-01-15T12:00:00.000+0000",
"location":"HOSTED",
"customData":{
"key1":"value1",
"key2":"value2"
}
}
],
"callRecordings":[
{
"callId":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"endpoint":{
"type":"PHONE",
"phoneNumber":"41793026834"
},
"direction":"INBOUND",
"files":[
{
"id":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"name":"d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav",
"fileFormat":"WAV",
"size":67564,
"creationTime":"2026-01-15T12:00:00.150+0000",
"duration":10,
"startTime":"2026-01-15T11:59:50.000+0000",
"endTime":"2026-01-15T12:00:00.000+0000",
"location":"HOSTED",
"customData":{
"key1":"value1",
"key2":"value2"
}
}
],
"status":"SUCCESSFUL"
},
{
"callId":"ae024ad1-52e7-45d5-a5d2-cd7c809e03f8",
"endpoint":{
"type":"PHONE",
"phoneNumber":"41793026834"
},
"direction":"INBOUND",
"files":[
{
"id":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"name":"d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav",
"fileFormat":"WAV",
"size":67564,
"creationTime":"2026-01-15T12:00:00.150+0000",
"duration":10,
"startTime":"2026-01-15T11:59:50.000+0000",
"endTime":"2026-01-15T12:00:00.000+0000",
"location":"HOSTED",
"customData":{
"key1":"value1",
"key2":"value2"
}
}
],
"status":"SUCCESSFUL"
}
]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:recording:read"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
},
"delete":{
"tags":[
"channels",
"voice",
"calls",
"files-and-recordings",
"recording-operations"
],
"summary":"Delete dialog recordings",
"description":"Delete the recordings for a single dialog.",
"operationId":"delete-dialog-recordings",
"parameters":[
{
"name":"dialogId",
"in":"path",
"description":"Dialog ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
},
{
"name":"location",
"in":"query",
"description":"Recording location.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingLocation"
},
"example":"FRANKFURT"
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/a8c993b4bcabd2960dfaf3986394e0fe85cd1c09dc98b0a81b51403a00c8f97c.PublicDialogRecording"
},
"examples":{
"Dialog recording response":{
"summary":"Dialog recording response",
"value":{
"dialogId":"034e622a-cc7e-456d-8a10-0ba43b11aa5e",
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
},
"composedFiles":[
{
"id":"65f0b3d7c8b6a00001a2b3d5",
"name":"example-recording.wav",
"fileFormat":"WAV",
"size":67564,
"creationTime":"2026-01-15T12:00:00.150+0000",
"duration":10,
"startTime":"2026-01-15T11:59:50.000+0000",
"endTime":"2026-01-15T12:00:00.000+0000",
"location":"HOSTED",
"customData":{
"key1":"value1",
"key2":"value2"
}
}
],
"callRecordings":[
{
"callId":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"endpoint":{
"type":"PHONE",
"phoneNumber":"41793026834"
},
"direction":"INBOUND",
"files":[
{
"id":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"name":"d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav",
"fileFormat":"WAV",
"size":67564,
"creationTime":"2026-01-15T12:00:00.150+0000",
"duration":10,
"startTime":"2026-01-15T11:59:50.000+0000",
"endTime":"2026-01-15T12:00:00.000+0000",
"location":"HOSTED",
"customData":{
"key1":"value1",
"key2":"value2"
}
}
],
"status":"SUCCESSFUL"
},
{
"callId":"ae024ad1-52e7-45d5-a5d2-cd7c809e03f8",
"endpoint":{
"type":"PHONE",
"phoneNumber":"41793026834"
},
"direction":"INBOUND",
"files":[
{
"id":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"name":"d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav",
"fileFormat":"WAV",
"size":67564,
"creationTime":"2026-01-15T12:00:00.150+0000",
"duration":10,
"startTime":"2026-01-15T11:59:50.000+0000",
"endTime":"2026-01-15T12:00:00.000+0000",
"location":"HOSTED",
"customData":{
"key1":"value1",
"key2":"value2"
}
}
],
"status":"SUCCESSFUL"
}
]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:recording:delete"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/recordings/dialogs/{dialogId}/compose":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"files-and-recordings",
"recording-operations"
],
"summary":"Compose dialog recording on calls",
"description":"Compose dialog recording on calls. Both calls will be merged into a single audio or video file.",
"operationId":"compose-dialog-recording",
"parameters":[
{
"name":"dialogId",
"in":"path",
"description":"Dialog ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
},
{
"name":"location",
"in":"query",
"description":"Recording location.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingLocation"
},
"example":"FRANKFURT"
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.OnDemandComposition"
}
}
}
},
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse"
}
}
}
},
"400":{
"$ref":"#/components/responses/ApiException400"
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:recording:read"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/recordings/files/{fileId}":{
"get":{
"tags":[
"channels",
"voice",
"calls",
"files-and-recordings",
"recording-operations"
],
"summary":"Download recording file",
"description":"Download a recording file.",
"operationId":"download-recording-file",
"parameters":[
{
"name":"fileId",
"in":"path",
"description":"File ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
},
{
"name":"location",
"in":"query",
"description":"Recording location.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingLocation"
},
"example":"FRANKFURT"
},
{
"name":"Range",
"in":"header",
"description":"Range header specifies range of bytes to be returned by the response. If range header is not specified, response will return a complete file.",
"required":false,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"bytes=0-1023"
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/octet-stream":{
"schema":{
"type":"string",
"format":"binary",
"description":"File binary stream response"
}
}
}
},
"206":{
"description":"Partial content",
"content":{
"application/octet-stream":{
"schema":{
"type":"string",
"format":"binary",
"description":"Partial file binary stream response"
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"416":{
"description":"Requested range not satisfiable",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"REQUESTED_RANGE_NOT_SATISFIABLE",
"text":"Requested range is invalid."
}
}
}
}
}
}
}
},
"429":{
"description":"Too many requests",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"TOO_MANY_REQUESTS",
"text":"Too many requests."
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:recording:read"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"m"
}
]
},
"delete":{
"tags":[
"channels",
"voice",
"calls",
"files-and-recordings",
"recording-operations"
],
"summary":"Delete recording file",
"description":"Delete a single file from a call or conference recording. The call or conference recording metadata will still exist after deleting the file, but the file will not show up anymore in the file list of that call or conference recording.",
"operationId":"delete-recording-file",
"parameters":[
{
"name":"fileId",
"in":"path",
"description":"File ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
},
{
"name":"location",
"in":"query",
"description":"Recording location.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingLocation"
},
"example":"FRANKFURT"
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/a8c993b4bcabd2960dfaf3986394e0fe85cd1c09dc98b0a81b51403a00c8f97c.PublicRecordingFile"
},
"examples":{
"Recording file response":{
"summary":"Recording file response",
"value":{
"id":"65f0b3d7c8b6a00001a2b3d5",
"name":"65f0b3d7c8b6a00001a2b3d5_1652725357412.wav",
"fileFormat":"WAV",
"size":67564,
"creationTime":"2026-01-15T12:00:00.150+0000",
"duration":10,
"startTime":"2026-01-15T11:59:50.000+0000",
"endTime":"2026-01-15T12:00:00.000+0000",
"location":"HOSTED",
"customData":{
"key1":"value1",
"key2":"value2"
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"description":"Too many requests",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"TOO_MANY_REQUESTS",
"text":"Too many requests."
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:recording:delete"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"m"
}
]
}
},
"/calls/1/media-stream-configs":{
"get":{
"tags":[
"channels",
"voice",
"calls",
"media-stream",
"media-stream-configuration"
],
"summary":"Get media-stream configs",
"description":"Get media-stream configs.",
"operationId":"get-media-stream-configs",
"parameters":[
{
"name":"page",
"in":"query",
"description":"Results page to retrieve (0..N).",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":0,
"minimum":0
}
},
{
"name":"size",
"in":"query",
"description":"Number of records per page.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":20,
"maximum":100,
"minimum":1
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.MediaStreamConfigPage"
},
"examples":{
"Media stream config page response.":{
"summary":"Media stream config page response.",
"value":{
"results":[
{
"id":"63467c6e2885a5389ba11d80",
"type":"MEDIA_STREAMING",
"name":"Media-stream config",
"url":"ws://example-web-socket.com:3001",
"audioEncoding":"RAW"
},
{
"id":"63467c6e2885a5389ba11d81",
"type":"WEBSOCKET_ENDPOINT",
"name":"Media-stream config",
"url":"ws://example-web-socket.com:3001",
"sampleRate":"8000"
}
],
"paging":{
"page":0,
"size":2,
"totalPages":1,
"totalResults":2
}
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:configuration:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
},
"post":{
"tags":[
"channels",
"voice",
"calls",
"media-stream",
"media-stream-configuration"
],
"summary":"Create a media-stream configuration",
"description":"Create a media-stream configuration. For more details, see [documentation](https://www.infobip.com/docs/voice-and-video/calls#media-streaming-understanding-calls-api).",
"operationId":"create-media-stream-config",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/58f57942de1c194257c321b1824e5d3941d9e9f538a9f08ddcb73e6025439f43.MediaStreamConfigRequest"
},
"examples":{
"Media streaming config request":{
"summary":"Media streaming config request",
"value":{
"type":"MEDIA_STREAMING",
"name":"Media-stream config",
"url":"ws://example-web-socket.com:3001",
"securityConfig":{
"username":"my-username",
"password":"my-password",
"type":"BASIC"
},
"audioEncoding":"RAW"
}
},
"WebSocket endpoint config request":{
"summary":"WebSocket endpoint config request",
"value":{
"type":"WEBSOCKET_ENDPOINT",
"name":"Media-stream config",
"url":"ws://example-web-socket.com:3001",
"sampleRate":"8000"
}
}
}
}
},
"required":true
},
"responses":{
"201":{
"description":"Media stream config created.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/655eaf80f7479f4a18447865649b33bdb754aaa97779726ffb72592cb1ac3ce5.MediaStreamConfigResponse"
},
"examples":{
"Media streaming config response":{
"summary":"Media streaming config response",
"value":{
"id":"63467c6e2885a5389ba11d80",
"type":"MEDIA_STREAMING",
"name":"Media-stream config",
"url":"ws://example-web-socket.com:3001",
"audioEncoding":"RAW"
}
},
"WebSocket endpoint config response":{
"summary":"WebSocket endpoint config response",
"value":{
"id":"63467c6e2885a5389ba11d81",
"type":"WEBSOCKET_ENDPOINT",
"name":"Media-stream config",
"url":"ws://example-web-socket.com:3001",
"sampleRate":"8000"
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:configuration:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"m"
}
]
}
},
"/calls/1/media-stream-configs/{mediaStreamConfigId}":{
"get":{
"tags":[
"channels",
"voice",
"calls",
"media-stream",
"media-stream-configuration"
],
"summary":"Get media-stream configuration",
"description":"Get a single media-stream configuration.",
"operationId":"get-media-stream-config",
"parameters":[
{
"name":"mediaStreamConfigId",
"in":"path",
"description":"Media-stream configuration ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/655eaf80f7479f4a18447865649b33bdb754aaa97779726ffb72592cb1ac3ce5.MediaStreamConfigResponse"
},
"examples":{
"Media streaming config response":{
"summary":"Media streaming config response",
"value":{
"id":"63467c6e2885a5389ba11d80",
"type":"MEDIA_STREAMING",
"name":"Media-stream config",
"url":"ws://example-web-socket.com:3001",
"audioEncoding":"RAW"
}
},
"WebSocket endpoint config response":{
"summary":"WebSocket endpoint config response",
"value":{
"id":"63467c6e2885a5389ba11d81",
"type":"WEBSOCKET_ENDPOINT",
"name":"Media-stream config",
"url":"ws://example-web-socket.com:3001",
"sampleRate":"8000"
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:configuration:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
},
"put":{
"tags":[
"channels",
"voice",
"calls",
"media-stream",
"media-stream-configuration"
],
"summary":"Update a media-stream configuration",
"description":"Update a media-stream configuration.",
"operationId":"update-media-stream-config",
"parameters":[
{
"name":"mediaStreamConfigId",
"in":"path",
"description":"Media-stream configuration ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/58f57942de1c194257c321b1824e5d3941d9e9f538a9f08ddcb73e6025439f43.MediaStreamConfigRequest"
},
"examples":{
"Media streaming config request":{
"summary":"Media streaming config request",
"value":{
"type":"MEDIA_STREAMING",
"name":"Media-stream config",
"url":"ws://example-web-socket.com:3001",
"securityConfig":{
"username":"my-username",
"password":"my-password",
"type":"BASIC"
},
"audioEncoding":"RAW"
}
},
"WebSocket endpoint config request":{
"summary":"WebSocket endpoint config request",
"value":{
"type":"WEBSOCKET_ENDPOINT",
"name":"Media-stream config",
"url":"ws://example-web-socket.com:3001",
"sampleRate":"8000"
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/655eaf80f7479f4a18447865649b33bdb754aaa97779726ffb72592cb1ac3ce5.MediaStreamConfigResponse"
},
"examples":{
"Media streaming config response":{
"summary":"Media streaming config response",
"value":{
"id":"63467c6e2885a5389ba11d80",
"type":"MEDIA_STREAMING",
"name":"Media-stream config",
"url":"ws://example-web-socket.com:3001",
"audioEncoding":"RAW"
}
},
"WebSocket endpoint config response":{
"summary":"WebSocket endpoint config response",
"value":{
"id":"63467c6e2885a5389ba11d81",
"type":"WEBSOCKET_ENDPOINT",
"name":"Media-stream config",
"url":"ws://example-web-socket.com:3001",
"sampleRate":"8000"
}
}
}
}
}
},
"400":{
"$ref":"#/components/responses/ApiException400"
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:configuration:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
},
"delete":{
"tags":[
"channels",
"voice",
"calls",
"media-stream",
"media-stream-configuration"
],
"summary":"Delete a media-stream configuration",
"description":"Delete a media-stream configuration.",
"operationId":"delete-media-stream-config",
"parameters":[
{
"name":"mediaStreamConfigId",
"in":"path",
"description":"Media-stream configuration ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/655eaf80f7479f4a18447865649b33bdb754aaa97779726ffb72592cb1ac3ce5.MediaStreamConfigResponse"
},
"examples":{
"Media streaming config response":{
"summary":"Media streaming config response",
"value":{
"id":"63467c6e2885a5389ba11d80",
"type":"MEDIA_STREAMING",
"name":"Media-stream config",
"url":"ws://example-web-socket.com:3001",
"audioEncoding":"RAW"
}
},
"WebSocket endpoint config response":{
"summary":"WebSocket endpoint config response",
"value":{
"id":"63467c6e2885a5389ba11d81",
"type":"WEBSOCKET_ENDPOINT",
"name":"Media-stream config",
"url":"ws://example-web-socket.com:3001",
"sampleRate":"8000"
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:configuration:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/bulks":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"bulks",
"bulk-call-management"
],
"summary":"Create bulk of calls",
"description":"Create a bulk of outbound calls. Currently, only `PHONE` endpoints are supported.\nWhen retry options are specified, bulk calls are retried if they meet internal or client retry criteria.\nClient retry criteria are met when call reaches the end device and fails. Internal retry criteria are met when call fails before reaching the end device.",
"operationId":"create-bulk",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/2f1f086f3fbc952749e03dadc7759cfc932ca2898a0c5e5b77a8bc2d84bd5c48.BulkRequest"
},
"examples":{
"Basic bulk request":{
"summary":"Basic bulk request",
"value":{
"callsConfigurationId":"dc5942707c704551a00cd2ea",
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
},
"items":[
{
"from":"41793026834",
"callRequests":[
{
"endpoint":{
"phoneNumber":"41792036727",
"type":"PHONE"
}
},
{
"endpoint":{
"phoneNumber":"41792036728",
"type":"PHONE"
}
},
{
"endpoint":{
"phoneNumber":"41792036729",
"type":"PHONE"
}
}
]
}
]
}
},
"Advanced bulk request":{
"summary":"Advanced bulk request",
"value":{
"bulkId":"46ab0413-448f-4153-ada9-b68b14242dc3",
"callsConfigurationId":"dc5942707c704551a00cd2ea",
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
},
"items":[
{
"from":"41793026834",
"callRequests":[
{
"externalId":"your-external-id-1",
"endpoint":{
"phoneNumber":"41792036727",
"type":"PHONE"
}
},
{
"externalId":"your-external-id-2",
"endpoint":{
"phoneNumber":"41792036728",
"type":"PHONE"
}
},
{
"externalId":"your-external-id-3",
"endpoint":{
"phoneNumber":"41792036729",
"type":"PHONE"
}
}
],
"recording":{
"recordingType":"AUDIO"
},
"machineDetection":{
"enabled":true
},
"maxDuration":28000,
"connectTimeout":30,
"callRate":{
"maxCalls":10,
"timeUnit":"MINUTES"
},
"validityPeriod":60,
"retryOptions":{
"minWaitPeriod":5,
"maxWaitPeriod":10,
"maxAttempts":5
},
"schedulingOptions":{
"startTime":"2026-01-15T12:00:00.000+0000",
"callingTimeWindow":{
"from":{
"hour":9,
"minute":0
},
"to":{
"hour":17,
"minute":0
},
"days":[
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY"
]
}
},
"customData":{
"key1":"value1",
"key2":"value2"
}
}
]
}
}
}
}
},
"required":true
},
"responses":{
"201":{
"description":"Bulk created.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/2f1f086f3fbc952749e03dadc7759cfc932ca2898a0c5e5b77a8bc2d84bd5c48.BulkResponse"
},
"examples":{
"Basic bulk request":{
"summary":"Basic bulk request",
"value":{
"bulkId":"46ab0413-448f-4153-ada9-b68b14242dc3",
"calls":[
{
"callsConfigurationId":"dc5942707c704551a00cd2ea",
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
},
"callId":"266f8375-33d3-482f-a258-51e86b5ae9ac",
"externalId":"your-external-id-1",
"from":"41793026834",
"endpoint":{
"phoneNumber":"41792036727",
"type":"PHONE"
},
"status":"PENDING"
},
{
"callsConfigurationId":"dc5942707c704551a00cd2ea",
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
},
"callId":"366f8375-33d3-482f-a258-51e86b5ae9ad",
"externalId":"your-external-id-2",
"from":"41793026834",
"endpoint":{
"phoneNumber":"41792036728",
"type":"PHONE"
},
"status":"PENDING"
},
{
"callsConfigurationId":"dc5942707c704551a00cd2ea",
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
},
"callId":"466f8375-33d3-482f-a258-51e86b5ae9ae",
"externalId":"your-external-id-3",
"from":"41793026834",
"endpoint":{
"phoneNumber":"41792036729",
"type":"PHONE"
},
"status":"PENDING"
}
]
}
},
"Bulk Response":{
"summary":"Bulk Response",
"value":{
"bulkId":"46ab0413-448f-4153-ada9-b68b14242dc3",
"calls":[
{
"callsConfigurationId":"dc5942707c704551a00cd2ea",
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
},
"callId":"266f8375-33d3-482f-a258-51e86b5ae9ac",
"externalId":"your-external-id-1",
"from":"41793026834",
"endpoint":{
"phoneNumber":"41792036727",
"type":"PHONE"
},
"status":"PENDING"
},
{
"callsConfigurationId":"dc5942707c704551a00cd2ea",
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
},
"callId":"366f8375-33d3-482f-a258-51e86b5ae9ad",
"externalId":"your-external-id-2",
"from":"41793026834",
"endpoint":{
"phoneNumber":"41792036728",
"type":"PHONE"
},
"status":"PENDING"
},
{
"callsConfigurationId":"dc5942707c704551a00cd2ea",
"platform":{
"applicationId":"61c060db2675060027d8c7a6"
},
"callId":"466f8375-33d3-482f-a258-51e86b5ae9ae",
"externalId":"your-external-id-3",
"from":"41793026834",
"endpoint":{
"phoneNumber":"41792036729",
"type":"PHONE"
},
"status":"PENDING"
}
]
}
}
}
}
}
},
"400":{
"description":"Bad request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Request is invalid."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Application not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:traffic:send"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":2000,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/bulks/{bulkId}":{
"get":{
"tags":[
"channels",
"voice",
"calls",
"bulks",
"bulk-call-management"
],
"summary":"Get bulk status",
"description":"Get a single bulk status. Bulk has a status if it was created with scheduling options.",
"operationId":"get-bulk-status",
"parameters":[
{
"name":"bulkId",
"in":"path",
"description":"Bulk ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BulkStatus"
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:logs:read"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/bulks/{bulkId}/reschedule":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"bulks",
"bulk-call-operations"
],
"summary":"Reschedule",
"description":"Reschedule a bulk. Rescheduling is possible only if the bulk was created with scheduling options and has not started yet.",
"operationId":"reschedule-bulk",
"parameters":[
{
"name":"bulkId",
"in":"path",
"description":"Bulk ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RescheduleRequest"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BulkStatus"
}
}
}
},
"400":{
"$ref":"#/components/responses/ApiException400"
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:bulk:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/bulks/{bulkId}/pause":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"bulks",
"bulk-call-operations"
],
"summary":"Pause",
"description":"Pause a bulk. Bulk can be paused if it is in progress and was created with scheduling options.",
"operationId":"pause-bulk",
"parameters":[
{
"name":"bulkId",
"in":"path",
"description":"Bulk ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BulkStatus"
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:bulk:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/bulks/{bulkId}/resume":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"bulks",
"bulk-call-operations"
],
"summary":"Resume",
"description":"Resume a bulk. Bulk can be resumed if it is paused and was created with scheduling options.",
"operationId":"resume-bulk",
"parameters":[
{
"name":"bulkId",
"in":"path",
"description":"Bulk ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BulkStatus"
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:bulk:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/calls/1/bulks/{bulkId}/cancel":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"bulks",
"bulk-call-operations"
],
"summary":"Cancel",
"description":"Cancel a bulk. Bulk can be cancelled if it was created with scheduling options and has not finished yet.",
"operationId":"cancel-bulk",
"parameters":[
{
"name":"bulkId",
"in":"path",
"description":"Bulk ID.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BulkStatus"
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Resource was not found."
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"calls:manage",
"calls:bulk:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/markuplanguage/1/create":{
"post":{
"tags":[
"channels",
"voice",
"calls-markup-language",
"calls-markup-language-create"
],
"summary":"Create markup language call.",
"description":"Create a new markup language call which will be processed according to provided markup instructions.",
"operationId":"create-markup-language-call",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/eaaf11bb9830fc826a8597df01bea6f2a14ef6d1ed129a4f6623981d52827778.MarkupRequest"
},
"examples":{
"Minimal markup call":{
"summary":"Minimal markup call",
"value":{
"callback":{
"url":"https://example.com/cml/markup",
"errorUrl":"https://example.com/cml/error",
"method":"POST"
},
"endpoint":{
"phoneNumber":"41793026835",
"type":"PHONE"
},
"from":"41793026834"
}
},
"Markup call with notify URL and external ID":{
"summary":"Markup call with notify URL and external ID",
"value":{
"callback":{
"url":"https://example.com/cml/markup",
"errorUrl":"https://example.com/cml/error",
"method":"POST"
},
"endpoint":{
"phoneNumber":"41793026835",
"type":"PHONE"
},
"from":"41793026834",
"externalId":"call-external-id-123",
"notifyUrl":"https://example.com/cml/notify"
}
},
"Markup call with synchronous machine detection":{
"summary":"Markup call with synchronous machine detection",
"value":{
"callback":{
"url":"https://example.com/cml/markup",
"errorUrl":"https://example.com/cml/error",
"method":"POST"
},
"endpoint":{
"phoneNumber":"41793026835",
"type":"PHONE"
},
"from":"41793026834",
"machineDetection":{
"detectionTime":3.0,
"mode":{
"type":"SYNC"
}
}
}
},
"Markup call with asynchronous machine detection and message detection":{
"summary":"Markup call with asynchronous machine detection and message detection",
"value":{
"callback":{
"url":"https://example.com/cml/markup",
"errorUrl":"https://example.com/cml/error",
"method":"POST"
},
"endpoint":{
"phoneNumber":"41793026835",
"type":"PHONE"
},
"from":"41793026834",
"machineDetection":{
"detectionTime":3.0,
"mode":{
"asyncUrl":"https://example.com/cml/amd",
"asyncUrlMethod":"POST",
"type":"ASYNC"
},
"messageDetection":{
"timeout":30
}
}
}
}
}
}
},
"required":true
},
"responses":{
"201":{
"description":"Markup Language Call Successfully Created",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/eaaf11bb9830fc826a8597df01bea6f2a14ef6d1ed129a4f6623981d52827778.MarkupResponse"
},
"examples":{
"Minimal markup call response":{
"summary":"Minimal markup call response",
"value":{
"callback":{
"url":"https://example.com/cml/markup",
"errorUrl":"https://example.com/cml/error",
"method":"POST"
},
"endpoint":{
"phoneNumber":"41793026835",
"type":"PHONE"
},
"from":"41793026834"
}
},
"Markup call response with duration and external ID":{
"summary":"Markup call response with duration and external ID",
"value":{
"callback":{
"url":"https://example.com/cml/markup",
"errorUrl":"https://example.com/cml/error",
"method":"POST"
},
"endpoint":{
"phoneNumber":"41793026835",
"type":"PHONE"
},
"from":"41793026834",
"externalId":"call-external-id-123"
}
}
}
}
}
},
"400":{
"$ref":"#/components/responses/ApiException400"
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"markuplanguage:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":50,
"numberOfTimeUnits":0,
"timeUnit":"m"
}
]
}
},
"/markuplanguage/1/config":{
"get":{
"tags":[
"channels",
"voice",
"calls-markup-language",
"calls-markup-language-configuration"
],
"summary":"Get markup language configurations",
"description":"Get existing markup language configurations with pagination.",
"operationId":"get-markup-language-config-list",
"parameters":[
{
"name":"page",
"in":"query",
"description":"Results page to retrieve (0..N).",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":0,
"minimum":0
}
},
{
"name":"size",
"in":"query",
"description":"Number of records per page.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":20,
"maximum":100,
"minimum":1
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/526c8fd5dbec2ed6659284b76850ff4085b7915f78d3266fedb5e0b5300d882a.MarkupLanguageConfigResponsePage"
},
"examples":{
"Markup language configuration response page example":{
"summary":"Markup language configuration response page example",
"description":"Example of a page of markup language configuration responses with different HTTP methods and URL setups.",
"value":{
"results":[
{
"id":123,
"name":"BasicMarkupConfiguration",
"markupUrl":"https://example.com/cml/markup",
"httpMethod":"POST",
"createTime":"2024-01-15T10:30:00",
"updateTime":"2024-01-15T10:30:00"
},
{
"id":124,
"name":"FullMarkupConfiguration",
"markupUrl":"https://example.com/cml/markup",
"notifyUrl":"https://example.com/cml/notify",
"errorUrl":"https://example.com/cml/error",
"httpMethod":"POST",
"createTime":"2024-02-10T09:00:00",
"updateTime":"2024-06-20T14:00:00"
},
{
"id":125,
"name":"GetMethodMarkupConfiguration",
"markupUrl":"https://example.com/cml/markup",
"httpMethod":"GET",
"createTime":"2024-03-05T12:00:00",
"updateTime":"2024-03-05T12:00:00"
}
],
"paging":{
"page":0,
"size":20,
"totalPages":1,
"totalResults":3
}
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.ApiError"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request",
"validationErrors":{
"field":[
"field must not be null"
]
}
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"property.path",
"violation":"Violation message."
}
],
"resources":[]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"markuplanguage:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":50,
"numberOfTimeUnits":0,
"timeUnit":"m"
}
]
},
"post":{
"tags":[
"channels",
"voice",
"calls-markup-language",
"calls-markup-language-configuration"
],
"summary":"Create a markup language configuration",
"description":"Create a new markup language configuration.",
"operationId":"create-markup-language-config",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/eaaf11bb9830fc826a8597df01bea6f2a14ef6d1ed129a4f6623981d52827778.MarkupLanguageConfigRequest"
},
"examples":{
"Basic markup language configuration":{
"summary":"Basic markup language configuration",
"value":{
"name":"UniqueMarkupConfiguration",
"markupUrl":"https://example.com/cml/markup",
"httpMethod":"POST"
}
},
"Full markup language configuration with notify and error URLs":{
"summary":"Full markup language configuration with notify and error URLs",
"value":{
"name":"UniqueMarkupConfiguration",
"markupUrl":"https://example.com/cml/markup",
"notifyUrl":"https://example.com/cml/notify",
"errorUrl":"https://example.com/cml/error",
"httpMethod":"POST"
}
},
"Markup language configuration using GET HTTP method":{
"summary":"Markup language configuration using GET HTTP method",
"value":{
"name":"UniqueMarkupConfiguration",
"markupUrl":"https://example.com/cml/markup",
"httpMethod":"GET"
}
}
}
}
},
"required":true
},
"responses":{
"201":{
"description":"Markup Language Configuration Successfully Created",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/eaaf11bb9830fc826a8597df01bea6f2a14ef6d1ed129a4f6623981d52827778.MarkupLanguageConfigResponse"
},
"examples":{
"Basic markup language configuration response":{
"summary":"Basic markup language configuration response",
"value":{
"id":123,
"name":"UniqueMarkupConfiguration",
"markupUrl":"https://example.com/cml/markup",
"httpMethod":"POST",
"createTime":"2024-01-15T10:30:00",
"updateTime":"2024-01-15T10:30:00"
}
},
"Full markup language configuration response with notify and error URLs":{
"summary":"Full markup language configuration response with notify and error URLs",
"value":{
"id":123,
"name":"UniqueMarkupConfiguration",
"markupUrl":"https://example.com/cml/markup",
"notifyUrl":"https://example.com/cml/notify",
"errorUrl":"https://example.com/cml/error",
"httpMethod":"POST",
"createTime":"2024-01-15T10:30:00",
"updateTime":"2024-06-20T14:00:00"
}
},
"Markup language configuration response using GET HTTP method":{
"summary":"Markup language configuration response using GET HTTP method",
"value":{
"id":123,
"name":"UniqueMarkupConfiguration",
"markupUrl":"https://example.com/cml/markup",
"httpMethod":"GET",
"createTime":"2024-01-15T10:30:00",
"updateTime":"2024-01-15T10:30:00"
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.ApiError"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request",
"validationErrors":{
"field":[
"field must not be null"
]
}
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"property.path",
"violation":"Violation message."
}
],
"resources":[]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"markuplanguage:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":50,
"numberOfTimeUnits":0,
"timeUnit":"m"
}
]
}
},
"/markuplanguage/1/config/{configId}":{
"get":{
"tags":[
"channels",
"voice",
"calls-markup-language",
"calls-markup-language-configuration"
],
"summary":"Get a markup language configuration",
"description":"Get an existing markup language configuration.",
"operationId":"get-markup-language-config",
"parameters":[
{
"name":"configId",
"in":"path",
"description":"Configuration identifier",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":123
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/eaaf11bb9830fc826a8597df01bea6f2a14ef6d1ed129a4f6623981d52827778.MarkupLanguageConfigResponse"
},
"examples":{
"Basic markup language configuration response":{
"summary":"Basic markup language configuration response",
"value":{
"id":123,
"name":"UniqueMarkupConfiguration",
"markupUrl":"https://example.com/cml/markup",
"httpMethod":"POST",
"createTime":"2024-01-15T10:30:00",
"updateTime":"2024-01-15T10:30:00"
}
},
"Full markup language configuration response with notify and error URLs":{
"summary":"Full markup language configuration response with notify and error URLs",
"value":{
"id":123,
"name":"UniqueMarkupConfiguration",
"markupUrl":"https://example.com/cml/markup",
"notifyUrl":"https://example.com/cml/notify",
"errorUrl":"https://example.com/cml/error",
"httpMethod":"POST",
"createTime":"2024-01-15T10:30:00",
"updateTime":"2024-06-20T14:00:00"
}
},
"Markup language configuration response using GET HTTP method":{
"summary":"Markup language configuration response using GET HTTP method",
"value":{
"id":123,
"name":"UniqueMarkupConfiguration",
"markupUrl":"https://example.com/cml/markup",
"httpMethod":"GET",
"createTime":"2024-01-15T10:30:00",
"updateTime":"2024-01-15T10:30:00"
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.ApiError"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Not found"
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"markuplanguage:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":50,
"numberOfTimeUnits":0,
"timeUnit":"m"
}
]
},
"put":{
"tags":[
"channels",
"voice",
"calls-markup-language",
"calls-markup-language-configuration"
],
"summary":"Update a markup language configuration",
"description":"Update an already existing markup language configuration. Fields that are not sent in the request body will take default values and overwrite existing ones.",
"operationId":"update-markup-language-config",
"parameters":[
{
"name":"configId",
"in":"path",
"description":"Configuration identifier",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":123
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/eaaf11bb9830fc826a8597df01bea6f2a14ef6d1ed129a4f6623981d52827778.MarkupLanguageConfigRequest"
},
"examples":{
"Basic markup language configuration":{
"summary":"Basic markup language configuration",
"value":{
"name":"UniqueMarkupConfiguration",
"markupUrl":"https://example.com/cml/markup",
"httpMethod":"POST"
}
},
"Full markup language configuration with notify and error URLs":{
"summary":"Full markup language configuration with notify and error URLs",
"value":{
"name":"UniqueMarkupConfiguration",
"markupUrl":"https://example.com/cml/markup",
"notifyUrl":"https://example.com/cml/notify",
"errorUrl":"https://example.com/cml/error",
"httpMethod":"POST"
}
},
"Markup language configuration using GET HTTP method":{
"summary":"Markup language configuration using GET HTTP method",
"value":{
"name":"UniqueMarkupConfiguration",
"markupUrl":"https://example.com/cml/markup",
"httpMethod":"GET"
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/eaaf11bb9830fc826a8597df01bea6f2a14ef6d1ed129a4f6623981d52827778.MarkupLanguageConfigResponse"
},
"examples":{
"Basic markup language configuration response":{
"summary":"Basic markup language configuration response",
"value":{
"id":123,
"name":"UniqueMarkupConfiguration",
"markupUrl":"https://example.com/cml/markup",
"httpMethod":"POST",
"createTime":"2024-01-15T10:30:00",
"updateTime":"2024-01-15T10:30:00"
}
},
"Full markup language configuration response with notify and error URLs":{
"summary":"Full markup language configuration response with notify and error URLs",
"value":{
"id":123,
"name":"UniqueMarkupConfiguration",
"markupUrl":"https://example.com/cml/markup",
"notifyUrl":"https://example.com/cml/notify",
"errorUrl":"https://example.com/cml/error",
"httpMethod":"POST",
"createTime":"2024-01-15T10:30:00",
"updateTime":"2024-06-20T14:00:00"
}
},
"Markup language configuration response using GET HTTP method":{
"summary":"Markup language configuration response using GET HTTP method",
"value":{
"id":123,
"name":"UniqueMarkupConfiguration",
"markupUrl":"https://example.com/cml/markup",
"httpMethod":"GET",
"createTime":"2024-01-15T10:30:00",
"updateTime":"2024-01-15T10:30:00"
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.ApiError"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request",
"validationErrors":{
"field":[
"field must not be null"
]
}
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"property.path",
"violation":"Violation message."
}
],
"resources":[]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.ApiError"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Not found"
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"markuplanguage:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":50,
"numberOfTimeUnits":0,
"timeUnit":"m"
}
]
},
"delete":{
"tags":[
"channels",
"voice",
"calls-markup-language",
"calls-markup-language-configuration"
],
"summary":"Delete a markup language configuration",
"description":"Delete an existing markup language configuration.",
"operationId":"delete-markup-language-config",
"parameters":[
{
"name":"configId",
"in":"path",
"description":"Configuration identifier",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":123
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/eaaf11bb9830fc826a8597df01bea6f2a14ef6d1ed129a4f6623981d52827778.MarkupLanguageConfigResponse"
},
"examples":{
"Basic markup language configuration response":{
"summary":"Basic markup language configuration response",
"value":{
"id":123,
"name":"UniqueMarkupConfiguration",
"markupUrl":"https://example.com/cml/markup",
"httpMethod":"POST",
"createTime":"2024-01-15T10:30:00",
"updateTime":"2024-01-15T10:30:00"
}
},
"Full markup language configuration response with notify and error URLs":{
"summary":"Full markup language configuration response with notify and error URLs",
"value":{
"id":123,
"name":"UniqueMarkupConfiguration",
"markupUrl":"https://example.com/cml/markup",
"notifyUrl":"https://example.com/cml/notify",
"errorUrl":"https://example.com/cml/error",
"httpMethod":"POST",
"createTime":"2024-01-15T10:30:00",
"updateTime":"2024-06-20T14:00:00"
}
},
"Markup language configuration response using GET HTTP method":{
"summary":"Markup language configuration response using GET HTTP method",
"value":{
"id":123,
"name":"UniqueMarkupConfiguration",
"markupUrl":"https://example.com/cml/markup",
"httpMethod":"GET",
"createTime":"2024-01-15T10:30:00",
"updateTime":"2024-01-15T10:30:00"
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.ApiError"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Not found"
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"markuplanguage:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":50,
"numberOfTimeUnits":0,
"timeUnit":"m"
}
]
}
},
"/tts/3/single":{
"post":{
"tags":[
"channels",
"voice",
"voice-message",
"voice-message-sending-operations"
],
"summary":"Send single voice message",
"description":"This method allows you to send single voice message to one or more destination addresses.",
"externalDocs":{
"description":"Learn more about voice messages",
"url":"https://www.infobip.com/docs/voice-and-video/voice-messages"
},
"operationId":"send-single-voice-tts",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4171c7b532e904c90fa2d755f583a0120bed3adbb383ab2309fddb57ee41f476.SingleTtsApiRequest"
},
"examples":{
"Single voice message with text":{
"summary":"Single voice message with text",
"description":"Single voice message with text",
"value":{
"text":"Test Voice message.",
"language":"en",
"voice":{
"gender":"female",
"name":"Joanna"
},
"from":"41793026700",
"to":"41793026727"
}
},
"Single voice message with audio file":{
"summary":"Single voice message with audio file",
"description":"Single voice message with audio file",
"value":{
"audioFileUrl":"https://www.example.com/audio/greeting.mp3",
"from":"41793026700",
"to":"41793026727"
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/4171c7b532e904c90fa2d755f583a0120bed3adbb383ab2309fddb57ee41f476.SingleTtsApiRequest"
},
"examples":{
"Single voice message with text":{
"summary":"Single voice message with text",
"description":"Single voice message with text",
"value":"\n \n Test Voice message.\n \n en\n \n \n \n female\n \n Joanna\n \n \n \n 41793026700\n \n 41793026727\n \n\n"
},
"Single voice message with audio file":{
"summary":"Single voice message with audio file",
"description":"Single voice message with audio file",
"value":"\n \n https://www.example.com/audio/greeting.mp3\n \n 41793026700\n \n 41793026727\n \n\n"
}
}
},
"application/x-www-form-urlencoded":{
"schema":{
"$ref":"#/components/schemas/4171c7b532e904c90fa2d755f583a0120bed3adbb383ab2309fddb57ee41f476.SingleTtsApiRequest"
},
"examples":{
"Single voice message with text":{
"summary":"Single voice message with text",
"description":"Single voice message with text",
"value":"curl -L -g 'https://{baseUrl}/tts/3/single' \\\n-H 'Authorization: {authorization}' \\\n-H 'Content-Type: application/x-www-form-urlencoded' \\\n--data-urlencode 'from=442032864231' \\\n--data-urlencode 'to=41793026727' \\\n--data-urlencode 'language=en' \\\n--data-urlencode 'text=Test Voice message' \\\n--data-urlencode 'voice.gender=female' \\\n--data-urlencode 'voice.name=Joanna'\n"
},
"Single voice message with audio file":{
"summary":"Single voice message with audio file",
"description":"Single voice message with audio file",
"value":"curl -L -g 'https://{baseUrl}/tts/3/single' \\\n-H 'Authorization: {authorization}' \\\n-H 'Content-Type: application/x-www-form-urlencoded' \\\n--data-urlencode 'from=442032864231' \\\n--data-urlencode 'to=41793026727' \\\n--data-urlencode 'audioFileUrl=https://www.example.com/audio/greeting.mp3'\n"
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/97cb4ba23432eb0e600ef0617ae1982d499839ef41226973c71dfb335b3071b8.StandardVoiceResponse"
},
"examples":{
"Successful response example":{
"summary":"Successful response example",
"value":{
"bulkId":"4fda521a-c680-470d-b134-83d468f7ac80",
"messages":[
{
"to":"41793026727",
"status":{
"groupId":1,
"groupName":"PENDING",
"id":26,
"name":"PENDING_ACCEPTED",
"description":"Message accepted, pending for delivery."
},
"messageId":"2250be2d4219-3af1-78856-aabe-1362af1edfd2"
}
]
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/97cb4ba23432eb0e600ef0617ae1982d499839ef41226973c71dfb335b3071b8.StandardVoiceResponse"
},
"examples":{
"Successful response example":{
"summary":"Successful response example",
"value":"\n 4fda521a-c680-470d-b134-83d468f7ac80\n \n \n 41793026727\n \n 1\n PENDING\n 26\n PENDING_ACCEPTED\n Message accepted, pending for delivery.\n \n 2250be2d4219-3af1-78856-aabe-1362af1edfd2\n \n \n\n"
}
}
}
}
},
"400":{
"$ref":"#/components/responses/ApiException400"
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"message:send",
"voice-message:message:send",
"voice-message:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":2000,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/tts/3/multi":{
"post":{
"tags":[
"channels",
"voice",
"voice-message",
"voice-message-sending-operations"
],
"summary":"Send multiple voice messages",
"description":"This method allows you to send multiple voice messages to one or more destination addresses.",
"externalDocs":{
"description":"Learn more about voice messages",
"url":"https://www.infobip.com/docs/voice-and-video/voice-messages"
},
"operationId":"send-multiple-voice-tts",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/faa1195a85d1a730663c8d9058f7685a3760136466d26134605b0efcc286bec7.MultiTtsApiRequest"
},
"examples":{
"Multiple voice messages with text":{
"summary":"Multiple voice messages with text",
"value":{
"messages":[
{
"text":"Test Voice message.",
"language":"en",
"voice":{
"gender":"female",
"name":"Joanna"
},
"from":"41793026700",
"to":[
"41793026727",
"41793026731"
]
}
]
}
},
"Multiple voice messages with audio file":{
"summary":"Multiple voice messages with audio file",
"value":{
"messages":[
{
"audioFileUrl":"https://www.example.com/audio/greeting.mp3",
"from":"41793026700",
"to":[
"41793026727",
"41793026731"
]
}
]
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/faa1195a85d1a730663c8d9058f7685a3760136466d26134605b0efcc286bec7.MultiTtsApiRequest"
},
"examples":{
"Multiple voice messages with text":{
"summary":"Multiple voice messages with text",
"value":"\n \n \n Test Voice message.\n en\n \n female\n Joanna\n \n 41793026700\n \n 41793026727\n 41793026731\n \n \n \n\n"
},
"Multiple voice messages with audio file":{
"summary":"Multiple voice messages with audio file",
"value":"\n \n \n https://www.example.com/audio/greeting.mp3\n 41793026700\n \n 41793026727\n 41793026731\n \n \n \n\n"
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/97cb4ba23432eb0e600ef0617ae1982d499839ef41226973c71dfb335b3071b8.StandardVoiceResponse"
},
"examples":{
"Successful response example":{
"summary":"Successful response example",
"value":{
"bulkId":"4fda521a-c680-470d-b134-83d468f7ac80",
"messages":[
{
"to":"41793026727",
"status":{
"groupId":1,
"groupName":"PENDING",
"id":26,
"name":"PENDING_ACCEPTED",
"description":"Message accepted, pending for delivery."
},
"messageId":"2250be2d4219-3af1-78856-aabe-1362af1edfd2"
}
]
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/97cb4ba23432eb0e600ef0617ae1982d499839ef41226973c71dfb335b3071b8.StandardVoiceResponse"
},
"examples":{
"Successful response example":{
"summary":"Successful response example",
"value":"\n 4fda521a-c680-470d-b134-83d468f7ac80\n \n \n 41793026727\n \n 1\n PENDING\n 26\n PENDING_ACCEPTED\n Message accepted, pending for delivery.\n \n 2250be2d4219-3af1-78856-aabe-1362af1edfd2\n \n \n\n"
}
}
}
}
},
"400":{
"$ref":"#/components/responses/ApiException400"
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"message:send",
"voice-message:message:send",
"voice-message:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":2000,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/tts/3/advanced":{
"post":{
"tags":[
"channels",
"voice",
"voice-message",
"voice-message-sending-operations"
],
"summary":"Send advanced voice message",
"description":"This method allows you to send advanced voice messages to one or more destination addresses.",
"externalDocs":{
"description":"Learn more about voice messages",
"url":"https://www.infobip.com/docs/voice-and-video/voice-messages"
},
"operationId":"send-advanced-voice-tts",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/329f726ae6e36d1a92786c502bebf028e5aa08cc32a3a8e9f0bed0d82dbc7157.AdvancedTtsApiRequest"
},
"examples":{
"Advanced voice message request example":{
"summary":"Advanced voice message request example",
"value":{
"bulkId":"BULK-ID-123-xyz",
"messages":[
{
"from":"41793026700",
"destinations":[
{
"to":"41793026727",
"messageId":"MESSAGE-ID-123-xyz"
},
{
"to":"41793026731"
}
],
"text":"Test Voice message.",
"language":"en",
"voice":{
"gender":"female",
"name":"Joanna"
},
"speechRate":1.0,
"notifyUrl":"https://www.example.com/voice/notify",
"notifyContentType":"application/json",
"callbackData":"DLR callback data",
"validityPeriod":720,
"sendAt":"2023-08-10T07:36:42.005+0000",
"repeatDtmf":"123",
"maxDtmf":1,
"ringTimeout":45,
"dtmfTimeout":10,
"callTimeout":130,
"callTransfers":[
{
"callTransferMaxDuration":45,
"equals":"2",
"transferTo":"41793026700",
"if":"DTMF"
},
{
"callTransferMaxDuration":45,
"transferTo":"41793026701",
"if":"anyDtmf"
}
],
"pause":3,
"retry":{
"minPeriod":1,
"maxPeriod":5,
"maxCount":5
},
"sendingSpeed":{
"speed":5,
"timeUnit":"minute"
},
"machineDetection":"continue",
"deliveryTimeWindow":{
"days":[
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
"SUNDAY"
],
"from":{
"hour":6,
"minute":0
},
"to":{
"hour":15,
"minute":30
}
}
}
]
}
},
"OTP message example":{
"summary":"OTP message example",
"value":{
"bulkId":"BULK-ID-123-xyz",
"messages":[
{
"from":"41793026700",
"destinations":[
{
"to":"41793026727"
}
],
"text":"Hello, your code is,, 5,, 8,, 4,, 2",
"language":"en",
"voice":{
"gender":"female",
"name":"Joanna"
}
}
]
}
},
"Audio file message":{
"summary":"Audio file message",
"value":{
"messages":[
{
"from":"41793026700",
"destinations":[
{
"to":"41793026727"
}
],
"audioFileUrl":"https://www.example.com/audio/greeting.mp3"
}
]
}
},
"Machine detection with hangup":{
"summary":"Machine detection with hangup",
"value":{
"messages":[
{
"from":"41793026700",
"destinations":[
{
"to":"41793026727"
}
],
"text":"Test Voice message.",
"language":"en",
"voice":{
"gender":"female",
"name":"Joanna"
},
"machineDetection":"hangup"
}
]
}
},
"DTMF input collection with call transfer":{
"summary":"DTMF input collection with call transfer",
"value":{
"messages":[
{
"from":"41793026700",
"destinations":[
{
"to":"41793026727"
}
],
"text":"Test Voice message.",
"language":"en",
"voice":{
"gender":"female",
"name":"Joanna"
},
"repeatDtmf":"123",
"maxDtmf":3,
"ringTimeout":30,
"dtmfTimeout":10,
"callTimeout":120,
"callTransfers":[
{
"callTransferMaxDuration":60,
"equals":"1",
"transferTo":"41793026700",
"if":"DTMF"
},
{
"callTransferMaxDuration":60,
"transferTo":"41793026701",
"if":"anyDtmf"
}
]
}
]
}
},
"Campaign broadcast with sending speed limit":{
"summary":"Campaign broadcast with sending speed limit",
"value":{
"bulkId":"BULK-ID-CAMPAIGN-001",
"messages":[
{
"from":"41793026700",
"destinations":[
{
"to":"41793026727"
}
],
"text":"Hello! You have an incoming call from our support team. Please hold while we connect you.",
"language":"en",
"voice":{
"gender":"female",
"name":"Joanna"
},
"notifyUrl":"https://www.example.com/delivery-report",
"notifyContentType":"application/json",
"sendingSpeed":{
"speed":50,
"timeUnit":"minute"
}
}
]
}
},
"Retry on failed delivery with scheduled time window":{
"summary":"Retry on failed delivery with scheduled time window",
"value":{
"bulkId":"BULK-ID-123-xyz",
"messages":[
{
"from":"41793026700",
"destinations":[
{
"to":"41793026727"
}
],
"text":"Test Voice message.",
"language":"en",
"voice":{
"gender":"female",
"name":"Joanna"
},
"notifyUrl":"https://www.example.com/delivery-report",
"notifyContentType":"application/json",
"retry":{
"minPeriod":5,
"maxPeriod":30,
"maxCount":3
},
"deliveryTimeWindow":{
"days":[
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY"
],
"from":{
"hour":8,
"minute":0
},
"to":{
"hour":20,
"minute":0
}
}
}
]
}
},
"Callback data with delivery report":{
"summary":"Callback data with delivery report",
"value":{
"messages":[
{
"from":"41793026700",
"destinations":[
{
"to":"41793026727"
}
],
"text":"Test Voice message.",
"language":"en",
"voice":{
"gender":"female",
"name":"Joanna"
},
"notifyUrl":"https://www.example.com/delivery-report",
"notifyContentType":"application/json",
"callbackData":"DLR callback data"
}
]
}
},
"Bulk request with multiple messages":{
"summary":"Bulk request with multiple messages",
"value":{
"bulkId":"BULK-ID-123-xyz",
"messages":[
{
"from":"41793026700",
"destinations":[
{
"to":"41793026727",
"messageId":"MSG-001"
}
],
"text":"Connecting your first call.",
"language":"en"
},
{
"from":"41793026700",
"destinations":[
{
"to":"41793026731",
"messageId":"MSG-002"
}
],
"text":"Connecting your second call.",
"language":"en"
}
]
}
},
"German language with male voice":{
"summary":"German language with male voice",
"value":{
"messages":[
{
"from":"41793026700",
"destinations":[
{
"to":"41793026727"
}
],
"text":"Hallo! Sie werden jetzt mit unserem Support-Team verbunden. Bitte warten Sie.",
"language":"de",
"voice":{
"gender":"male",
"name":"Hans"
}
}
]
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/329f726ae6e36d1a92786c502bebf028e5aa08cc32a3a8e9f0bed0d82dbc7157.AdvancedTtsApiRequest"
},
"examples":{
"Advanced voice message request example":{
"summary":"Advanced voice message request example",
"value":"\n BULK-ID-123-xyz\n \n \n 41793026700\n \n \n 41793026727\n MESSAGE-ID-123-xyz\n \n \n 41793026731\n \n \n Test Voice message.\n en\n \n female\n Joanna\n \n 1.0\n https://www.example.com/voice/notify\n application/json\n DLR callback data\n 720\n 2023-08-10T07:36:42.005+0000\n 123\n 1\n 45\n 10\n 130\n \n \n 45\n 2\n 41793026700\n DTMF\n \n \n 45\n 41793026701\n anyDtmf\n \n \n 3\n \n 1\n 5\n 5\n \n \n 5\n minute\n \n continue\n \n \n MONDAY\n TUESDAY\n WEDNESDAY\n THURSDAY\n FRIDAY\n SATURDAY\n SUNDAY\n \n \n 6\n 0\n \n \n 15\n 30\n \n \n \n \n\n"
},
"OTP message example":{
"summary":"OTP message example",
"value":"\n BULK-ID-123-xyz\n \n \n 41793026700\n \n \n 41793026727\n \n \n Hello, your code is,, 5,, 8,, 4,, 2\n en\n \n female\n Joanna\n \n \n \n\n"
},
"Audio file message":{
"summary":"Audio file message",
"value":"\n \n \n 41793026700\n \n \n 41793026727\n \n \n https://www.example.com/audio/greeting.mp3\n \n \n\n"
},
"Machine detection with hangup":{
"summary":"Machine detection with hangup",
"value":"\n \n \n 41793026700\n \n \n 41793026727\n \n \n Test Voice message.\n en\n \n female\n Joanna\n \n hangup\n \n \n\n"
},
"DTMF input collection with call transfer":{
"summary":"DTMF input collection with call transfer",
"value":"\n \n \n 41793026700\n \n \n 41793026727\n \n \n Test Voice message.\n en\n \n female\n Joanna\n \n 123\n 3\n 30\n 10\n 120\n \n \n 60\n 1\n 41793026700\n DTMF\n \n \n 60\n 41793026701\n anyDtmf\n \n \n \n \n\n"
},
"Campaign broadcast with sending speed limit":{
"summary":"Campaign broadcast with sending speed limit",
"value":"\n BULK-ID-CAMPAIGN-001\n \n \n 41793026700\n \n \n 41793026727\n \n \n Hello! You have an incoming call from our support team. Please hold while we connect you.\n en\n \n female\n Joanna\n \n https://www.example.com/delivery-report\n application/json\n \n 50\n minute\n \n \n \n\n"
},
"Retry on failed delivery with scheduled time window":{
"summary":"Retry on failed delivery with scheduled time window",
"value":"\n BULK-ID-123-xyz\n \n \n 41793026700\n \n \n 41793026727\n \n \n Test Voice message.\n en\n \n female\n Joanna\n \n https://www.example.com/delivery-report\n application/json\n \n 5\n 30\n 3\n \n \n \n MONDAY\n TUESDAY\n WEDNESDAY\n THURSDAY\n FRIDAY\n \n \n 8\n 0\n \n \n 20\n 0\n \n \n \n \n\n"
},
"Callback data with delivery report":{
"summary":"Callback data with delivery report",
"value":"\n \n \n 41793026700\n \n \n 41793026727\n \n \n Test Voice message.\n en\n \n female\n Joanna\n \n https://www.example.com/delivery-report\n application/json\n DLR callback data\n \n \n\n"
},
"Bulk request with multiple messages":{
"summary":"Bulk request with multiple messages",
"value":"\n BULK-ID-123-xyz\n \n \n 41793026700\n \n \n 41793026727\n MSG-001\n \n \n Connecting your first call.\n en\n \n \n 41793026700\n \n \n 41793026731\n MSG-002\n \n \n Connecting your second call.\n en\n \n \n\n"
},
"German language with male voice":{
"summary":"German language with male voice",
"value":"\n \n \n 41793026700\n \n \n 41793026727\n \n \n Hallo! Sie werden jetzt mit unserem Support-Team verbunden. Bitte warten Sie.\n de\n \n male\n Hans\n \n \n \n\n"
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/97cb4ba23432eb0e600ef0617ae1982d499839ef41226973c71dfb335b3071b8.StandardVoiceResponse"
},
"examples":{
"Successful response example":{
"summary":"Successful response example",
"value":{
"bulkId":"4fda521a-c680-470d-b134-83d468f7ac80",
"messages":[
{
"to":"41793026727",
"status":{
"groupId":1,
"groupName":"PENDING",
"id":26,
"name":"PENDING_ACCEPTED",
"description":"Message accepted, pending for delivery."
},
"messageId":"2250be2d4219-3af1-78856-aabe-1362af1edfd2"
}
]
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/97cb4ba23432eb0e600ef0617ae1982d499839ef41226973c71dfb335b3071b8.StandardVoiceResponse"
},
"examples":{
"Successful response example":{
"summary":"Successful response example",
"value":"\n 4fda521a-c680-470d-b134-83d468f7ac80\n \n \n 41793026727\n \n 1\n PENDING\n 26\n PENDING_ACCEPTED\n Message accepted, pending for delivery.\n \n 2250be2d4219-3af1-78856-aabe-1362af1edfd2\n \n \n\n"
}
}
}
}
},
"400":{
"$ref":"#/components/responses/ApiException400"
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"message:send",
"voice-message:message:send",
"voice-message:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":2000,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/tts/3/voices/{language}":{
"get":{
"tags":[
"channels",
"voice",
"voice-message",
"voice-message-sending-operations"
],
"summary":"Get Voices",
"description":"This method allows you to retrieve all voices for the given language",
"operationId":"get-voices",
"parameters":[
{
"name":"language",
"in":"path",
"description":"Represents the language abbreviation. (e.g. `en`). You can find the list of supported languages in corresponding section for sending voice message.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
},
{
"name":"includeNeural",
"in":"query",
"description":"Indicates whether neural voices should be included in the response.\nIf set to `false` or omitted, only standard voices will be included in the response.\nIf set to `true`, both standard and neural voices will be included in the response.\n",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"boolean",
"default":false
}
}
],
"responses":{
"200":{
"description":"successful response",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.GetVoicesResponse"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":{
"voices":[
{
"name":"Benjamin",
"gender":"male",
"supplier":"Microsoft",
"ssmlSupported":false,
"isDefault":false,
"isNeural":false
},
{
"name":"Ivy",
"gender":"female",
"supplier":"Amazon",
"ssmlSupported":true,
"isDefault":false,
"isNeural":false
},
{
"name":"Joanna",
"gender":"female",
"supplier":"Amazon",
"ssmlSupported":true,
"isDefault":true,
"isNeural":false
},
{
"name":"Joey",
"gender":"male",
"supplier":"Amazon",
"ssmlSupported":true,
"isDefault":false,
"isNeural":false
}
]
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.GetVoicesResponse"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":"\n \n \n \n \n \n Benjamin\n \n male\n \n Microsoft\n \n false\n \n false\n \n false\n \n \n \n \n \n Ivy\n \n female\n \n Amazon\n \n true\n \n false\n \n false\n \n \n \n \n \n Joanna\n \n female\n \n Amazon\n \n true\n \n true\n \n false\n \n \n \n \n \n Joey\n \n male\n \n Amazon\n \n true\n \n false\n \n false\n \n \n \n \n \n\n"
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"4XX":{
"description":"Error responses",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/31756dca18d13ab491063defb0eba5e91f72bccd700f710f44794c6f1df9c9ea.ApiException"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":{
"requestError":{
"serviceException":{
"messageId":"string",
"text":"string"
}
}
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/31756dca18d13ab491063defb0eba5e91f72bccd700f710f44794c6f1df9c9ea.ApiException"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":"\n \n \n \n \n \n String\n \n String\n \n \n \n \n \n\n"
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
},
"5XX":{
"description":"Error responses",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/31756dca18d13ab491063defb0eba5e91f72bccd700f710f44794c6f1df9c9ea.ApiException"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":{
"requestError":{
"serviceException":{
"messageId":"string",
"text":"string"
}
}
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/31756dca18d13ab491063defb0eba5e91f72bccd700f710f44794c6f1df9c9ea.ApiException"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":"\n \n \n \n \n \n String\n \n String\n \n \n \n \n \n\n"
}
}
}
}
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"voice-message:manage",
"voice-message:message:send",
"message:send"
]
}
},
"/tts/3/bulks":{
"get":{
"tags":[
"channels",
"voice",
"voice-message",
"voice-message-scheduling-operations"
],
"summary":"Get sent bulks",
"description":"This method will return information about the scheduled time for a unique bulk message. Canceling and rescheduling are supported only when the voice message request contains at least one message and the message bulkId is unique.",
"operationId":"get-sent-bulks",
"parameters":[
{
"name":"bulkId",
"in":"query",
"description":"Unique ID of the bulk.",
"required":true,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/a15a35d4e9d79ecb7047887a88973e9a539c66701b3c993c3c3be69782dd8aba.BulkResponse"
},
"examples":{
"Bulk response":{
"summary":"Bulk response",
"value":{
"bulkId":"5028e2d42f19-42f1-4656-351e-a42c191e5fd2",
"sendAt":"2023-09-26T14:07:35.000+0000"
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/a15a35d4e9d79ecb7047887a88973e9a539c66701b3c993c3c3be69782dd8aba.BulkResponse"
},
"examples":{
"Bulk response":{
"summary":"Bulk response",
"value":"\n 5028e2d42f19-42f1-4656-351e-a42c191e5fd2\n 2023-09-26T14:07:35.000+0000\n\n"
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/1a32a5811401e5289f9edb3a3b051fee21e1ffff7ad179f3aead79d4a871821d.ApiException"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/1a32a5811401e5289f9edb3a3b051fee21e1ffff7ad179f3aead79d4a871821d.ApiException"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":"\n \n \n BAD_REQUEST\n Bad request\n \n \n\n"
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"description":"Too Many Requests",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/1a32a5811401e5289f9edb3a3b051fee21e1ffff7ad179f3aead79d4a871821d.ApiException"
},
"examples":{
"Too many requests response":{
"summary":"Too many requests response",
"value":{
"requestError":{
"serviceException":{
"messageId":"TOO_MANY_REQUESTS",
"text":"Too many requests"
}
}
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/1a32a5811401e5289f9edb3a3b051fee21e1ffff7ad179f3aead79d4a871821d.ApiException"
},
"examples":{
"Too many requests response":{
"summary":"Too many requests response",
"value":"\n \n \n TOO_MANY_REQUESTS\n Too many requests\n \n \n\n"
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"message:send",
"voice-message:message:send",
"voice-message:manage"
]
},
"put":{
"tags":[
"channels",
"voice",
"voice-message",
"voice-message-scheduling-operations"
],
"summary":"Reschedule sent bulk",
"description":"This method allows you to reschedule scheduled TTS bulk. Messages scheduled with the sendAt or Sending speed parameter can be paused, resumed or canceled by changing the message status, or rescheduled using the bulkId parameter as an identifier. Rescheduling is only possible if the bulk status is PAUSED.",
"operationId":"reschedule-sent-bulk",
"parameters":[
{
"name":"bulkId",
"in":"query",
"description":"Unique ID of the bulk.",
"required":true,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/a15a35d4e9d79ecb7047887a88973e9a539c66701b3c993c3c3be69782dd8aba.BulkRequest"
},
"examples":{
"Reschedule bulk status request":{
"summary":"Reschedule bulk status request",
"value":{
"sendAt":"2023-09-26T14:07:35.000+0000"
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/a15a35d4e9d79ecb7047887a88973e9a539c66701b3c993c3c3be69782dd8aba.BulkRequest"
},
"examples":{
"Reschedule bulk status request":{
"summary":"Reschedule bulk status request",
"value":"\n 2023-09-26T14:07:35.000+0000\n\n"
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/a15a35d4e9d79ecb7047887a88973e9a539c66701b3c993c3c3be69782dd8aba.BulkResponse"
},
"examples":{
"Bulk response":{
"summary":"Bulk response",
"value":{
"bulkId":"5028e2d42f19-42f1-4656-351e-a42c191e5fd2",
"sendAt":"2023-09-26T14:07:35.000+0000"
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/a15a35d4e9d79ecb7047887a88973e9a539c66701b3c993c3c3be69782dd8aba.BulkResponse"
},
"examples":{
"Bulk response":{
"summary":"Bulk response",
"value":"\n 5028e2d42f19-42f1-4656-351e-a42c191e5fd2\n 2023-09-26T14:07:35.000+0000\n\n"
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/1a32a5811401e5289f9edb3a3b051fee21e1ffff7ad179f3aead79d4a871821d.ApiException"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/1a32a5811401e5289f9edb3a3b051fee21e1ffff7ad179f3aead79d4a871821d.ApiException"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":"\n \n \n BAD_REQUEST\n Bad request\n \n \n\n"
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"description":"Too Many Requests",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/1a32a5811401e5289f9edb3a3b051fee21e1ffff7ad179f3aead79d4a871821d.ApiException"
},
"examples":{
"Too many requests response":{
"summary":"Too many requests response",
"value":{
"requestError":{
"serviceException":{
"messageId":"TOO_MANY_REQUESTS",
"text":"Too many requests"
}
}
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/1a32a5811401e5289f9edb3a3b051fee21e1ffff7ad179f3aead79d4a871821d.ApiException"
},
"examples":{
"Too many requests response":{
"summary":"Too many requests response",
"value":"\n \n \n TOO_MANY_REQUESTS\n Too many requests\n \n \n\n"
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"message:send",
"voice-message:message:send",
"voice-message:manage"
]
}
},
"/tts/3/bulks/status":{
"get":{
"tags":[
"channels",
"voice",
"voice-message",
"voice-message-scheduling-operations"
],
"summary":"Get sent bulk's status",
"description":"This method allows you to get status of scheduled TTS bulk.",
"operationId":"get-sent-bulks-status",
"parameters":[
{
"name":"bulkId",
"in":"query",
"description":"Unique ID of the bulk.",
"required":true,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/a15a35d4e9d79ecb7047887a88973e9a539c66701b3c993c3c3be69782dd8aba.BulkStatusResponse"
},
"examples":{
"Bulk status response":{
"summary":"Bulk status response",
"value":{
"bulkId":"5028e2d42f19-42f1-4656-351e-a42c191e5fd2",
"status":"PENDING"
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/a15a35d4e9d79ecb7047887a88973e9a539c66701b3c993c3c3be69782dd8aba.BulkStatusResponse"
},
"examples":{
"Bulk status response":{
"summary":"Bulk status response",
"value":"\n 5028e2d42f19-42f1-4656-351e-a42c191e5fd2\n PENDING\n\n"
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/1a32a5811401e5289f9edb3a3b051fee21e1ffff7ad179f3aead79d4a871821d.ApiException"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/1a32a5811401e5289f9edb3a3b051fee21e1ffff7ad179f3aead79d4a871821d.ApiException"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":"\n \n \n BAD_REQUEST\n Bad request\n \n \n\n"
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"description":"Too Many Requests",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/1a32a5811401e5289f9edb3a3b051fee21e1ffff7ad179f3aead79d4a871821d.ApiException"
},
"examples":{
"Too many requests response":{
"summary":"Too many requests response",
"value":{
"requestError":{
"serviceException":{
"messageId":"TOO_MANY_REQUESTS",
"text":"Too many requests"
}
}
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/1a32a5811401e5289f9edb3a3b051fee21e1ffff7ad179f3aead79d4a871821d.ApiException"
},
"examples":{
"Too many requests response":{
"summary":"Too many requests response",
"value":"\n \n \n TOO_MANY_REQUESTS\n Too many requests\n \n \n\n"
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"message:send",
"voice-message:message:send",
"voice-message:manage"
]
},
"put":{
"tags":[
"channels",
"voice",
"voice-message",
"voice-message-scheduling-operations"
],
"summary":"Manage sent bulk's status",
"description":"This method allows you to manage statuses of scheduled TTS bulk. Messages scheduled with the sendAt or sending speed parameter can be paused, resumed or canceled by changing the message status, or rescheduled using the bulkId parameter as an identifier. Only voice messages that were not already sent can be canceled.",
"operationId":"manage-sent-bulks-status",
"parameters":[
{
"name":"bulkId",
"in":"query",
"description":"Unique ID of the bulk.",
"required":true,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/a15a35d4e9d79ecb7047887a88973e9a539c66701b3c993c3c3be69782dd8aba.BulkStatusRequest"
},
"examples":{
"Bulk status request":{
"summary":"Bulk status request",
"value":{
"status":"PENDING"
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/a15a35d4e9d79ecb7047887a88973e9a539c66701b3c993c3c3be69782dd8aba.BulkStatusRequest"
},
"examples":{
"Bulk status request":{
"summary":"Bulk status request",
"value":"\n PENDING\n\n"
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/a15a35d4e9d79ecb7047887a88973e9a539c66701b3c993c3c3be69782dd8aba.BulkStatusResponse"
},
"examples":{
"Bulk status response":{
"summary":"Bulk status response",
"value":{
"bulkId":"5028e2d42f19-42f1-4656-351e-a42c191e5fd2",
"status":"PENDING"
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/a15a35d4e9d79ecb7047887a88973e9a539c66701b3c993c3c3be69782dd8aba.BulkStatusResponse"
},
"examples":{
"Bulk status response":{
"summary":"Bulk status response",
"value":"\n 5028e2d42f19-42f1-4656-351e-a42c191e5fd2\n PENDING\n\n"
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/1a32a5811401e5289f9edb3a3b051fee21e1ffff7ad179f3aead79d4a871821d.ApiException"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/1a32a5811401e5289f9edb3a3b051fee21e1ffff7ad179f3aead79d4a871821d.ApiException"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":"\n \n \n BAD_REQUEST\n Bad request\n \n \n\n"
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"description":"Too Many Requests",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/1a32a5811401e5289f9edb3a3b051fee21e1ffff7ad179f3aead79d4a871821d.ApiException"
},
"examples":{
"Too many requests response":{
"summary":"Too many requests response",
"value":{
"requestError":{
"serviceException":{
"messageId":"TOO_MANY_REQUESTS",
"text":"Too many requests"
}
}
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/1a32a5811401e5289f9edb3a3b051fee21e1ffff7ad179f3aead79d4a871821d.ApiException"
},
"examples":{
"Too many requests response":{
"summary":"Too many requests response",
"value":"\n \n \n TOO_MANY_REQUESTS\n Too many requests\n \n \n\n"
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"message:send",
"voice-message:message:send",
"voice-message:manage"
]
}
},
"/voice/ivr/1/scenarios":{
"get":{
"tags":[
"channels",
"voice",
"interactive-voice-response",
"manage-ivr-scenarios"
],
"summary":"Search Voice IVR Scenarios",
"description":"This method allows you to search Voice IVR Scenarios by name. To get a list of all IVR Scenarios, make a request without any parameters.",
"operationId":"search-voice-ivr-scenarios",
"parameters":[
{
"name":"page",
"in":"query",
"description":"Page number you want to see. Default is 1.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"minimum":1
}
},
{
"name":"pageSize",
"in":"query",
"description":"Size of the page you want to see. Default is 50.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"maximum":50,
"minimum":1
}
},
{
"name":"name",
"in":"query",
"description":"The name to search by.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"label",
"in":"query",
"description":"The label of scenario to search by.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"lastUsageDateSince",
"in":"query",
"description":"Lower limit of last usage date in `yyyy-MM-dd` format. Note: For scenarios where `lastUsageDate` is `null`, filtering matches `createTime`.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"format":"date"
}
},
{
"name":"lastUsageDateUntil",
"in":"query",
"description":"Upper limit of last usage date in `yyyy-MM-dd` format. Note: For scenarios where `lastUsageDate` is `null`, filtering matches `createTime`.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"format":"date"
}
}
],
"responses":{
"200":{
"description":"successful response",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SearchResponse"
}
},
"examples":{
"Response example":{
"summary":"Response example",
"value":[
{
"id":"E83E787CF2613450157ADA3476171E3F",
"name":"My Scenario",
"description":"Scenario to send a message",
"createTime":"2023-09-14T15:13:36.735+0000",
"updateTime":"2023-09-14T16:20:32.432+0000",
"lastUsageDate":"2023-09-14",
"script":[
{
"sendSms":{
"text":"Hello",
"to":"${to}"
}
}
]
}
]
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"ivr:manage",
"ivr:configuration:manage",
"message:send"
]
},
"post":{
"tags":[
"channels",
"voice",
"interactive-voice-response",
"manage-ivr-scenarios"
],
"summary":"Create Voice IVR Scenarios",
"description":"This method allows you to create a Voice IVR Scenario. The IVR scenario will be removed if not used for more than 1 year.",
"operationId":"create-a-voice-ivr-scenario",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.UpdateScenarioRequest"
},
"examples":{
"Call API":{
"summary":"Call API",
"description":"Call API",
"value":{
"name":"Call API",
"description":"Perform a POST request to provided URL with headers and payload.",
"script":[
{
"request":"https://example.com/api/12345",
"options":{
"method":"POST",
"headers":{
"content-type":"application/json"
},
"body":{
"payload":"${to} finished the IVR."
}
}
}
]
}
},
"Call Api to send collected DTMFs":{
"summary":"Call Api to send collected DTMFs",
"description":"Call Api to send collected DTMFs",
"value":{
"name":"Call Api",
"description":"Collect users input and submits it with a POST request to a url.",
"script":[
{
"say":"Hello, please press 1 if you wish to subscribe to our newsletter."
},
{
"collectInto":"myCollectedVariable",
"options":{
"maxInputLength":1,
"timeout":5
}
},
{
"request":"https://example.com/subscription",
"options":{
"method":"POST",
"headers":{
"custom-header":"header-value"
},
"body":{
"shouldSubscribe":"${myCollectedVariable}"
}
}
},
{
"if":"${myCollectedVariable == 1}",
"then":[
{
"say":"You subscribed successfully."
}
]
}
]
}
},
"Call Api with response":{
"summary":"Call Api with response",
"description":"Call Api with response",
"value":{
"name":"Call Api with collected response",
"description":"Collect users input and submit it with a POST request to a url, and play the response back to the user. Let's assume the response is a simple JSON object that has only one field with a key called 'responseText' and value defined by the clients API.",
"script":[
{
"say":"Hello, please press 1 if you wish to subscribe to our newsletter."
},
{
"collectInto":"myCollectedVariable",
"options":{
"maxInputLength":1,
"timeout":5
}
},
{
"request":"https://example.com/subscription",
"options":{
"method":"POST",
"headers":{
"custom-header":"header-value"
},
"body":{
"shouldSubscribe":"${myCollectedVariable}"
},
"collectResponse":true
}
},
{
"say":"${responseText}"
}
]
}
},
"Capture":{
"summary":"Capture",
"description":"Capture",
"value":{
"name":"Capture speech",
"description":"Capture users speech and branch the call based on the spoken words.",
"script":[
{
"say":"Say yes or no"
},
{
"capture":"myVar",
"timeout":3,
"speechOptions":{
"language":"en-US",
"maxSilence":2,
"keyPhrases":[
"yes",
"no"
]
}
},
{
"if":"${myVar == 'yes'}",
"then":[
{
"say":"Ok. I will send you more details"
}
],
"else":[]
},
{
"if":"${myVar == 'no'}",
"then":[
{
"say":"Thank you for listening."
}
],
"else":[]
},
{
"if":"${myVar == ''}",
"then":[
{
"say":"I did not understand"
}
],
"else":[]
},
"hangup"
]
}
},
"Capture speech or digit":{
"summary":"Capture speech or digit",
"description":"Capture speech or digit",
"value":{
"name":"Capture speech or digit",
"description":"Capture speech or digit",
"script":[
{
"say":"Say discount or press 1 to get discount. Say exit or press 0 to exit."
},
{
"capture":"myVar",
"timeout":5,
"speechOptions":{
"language":"en-US",
"maxSilence":2,
"keyPhrases":[
"discount",
"exit"
]
},
"dtmfOptions":{
"maxInputLength":1
}
},
{
"if":"${myVar == 'discount' || myVar == '1'}",
"then":[
{
"say":"You will get discount"
}
],
"else":[
{
"if":"${myVar == 'exit' || myVar == '0'}",
"then":[
{
"say":"Goodbye"
}
],
"else":[
{
"say":"I did not understand"
}
]
}
]
},
"hangup"
]
}
},
"Collect dtmf and branch call execution based on input":{
"summary":"Collect dtmf and branch call execution based on input",
"description":"Collect dtmf and branch call execution based on input",
"value":{
"name":"Capture speech or digit",
"description":"Capture speech or digit",
"script":[
{
"say":"Say discount or press 1 to get discount. Say exit or press 0 to exit."
},
{
"capture":"myVar",
"timeout":5,
"speechOptions":{
"language":"en-US",
"maxSilence":2,
"keyPhrases":[
"discount",
"exit"
]
},
"dtmfOptions":{
"maxInputLength":1
}
},
{
"if":"${myVar == 'discount' || myVar == '1'}",
"then":[
{
"say":"You will get discount"
}
],
"else":[
{
"if":"${myVar == 'exit' || myVar == '0'}",
"then":[
{
"say":"Goodbye"
}
],
"else":[
{
"say":"I did not understand"
}
]
}
]
},
"hangup"
]
}
},
"Collect dtmf with default branch":{
"summary":"Collect dtmf with default branch",
"description":"Collect dtmf with default branch",
"value":{
"name":"Collect dtmf with default branch",
"description":"Based on the collected input, the execution is branched into 2 branches. If wrong digit is pressed or nothing is pressed, execute default branch.",
"script":[
{
"say":"Hello. Press 1 or 2. Or press any other digit or do not press anything for default message to be played."
},
{
"collectInto":"myVariable",
"options":{
"maxInputLength":1,
"timeout":5,
"sendToReports":"ALWAYS",
"mappedValues":{
"1":"pressed one",
"2":"pressed two"
}
}
},
{
"case":{
"1":[
{
"say":"You have pressed 1."
}
],
"2":[
{
"say":"You have pressed 2."
}
],
"__default":[
{
"say":"You pressed some other key or didn't press anything"
}
]
},
"switch":"myVariable"
}
]
}
},
"Dial":{
"summary":"Dial",
"description":"Dial",
"value":{
"name":"Dial to a destination",
"description":"Dial to a provided destination to bridge original call with the dialed call.",
"script":[
{
"dial":"41793026731",
"options":{
"senderId":"123456789",
"maxCallDuration":10
}
}
]
}
},
"Dial from a variable":{
"summary":"Dial from a variable",
"description":"Dial from a variable",
"value":{
"name":"Dial to a number resolved from a variable",
"description":"Dial to a number resolved from a variable",
"script":[
{
"dial":"${numberToDial}",
"options":{
"senderId":"123456789",
"maxCallDuration":10
}
}
]
}
},
"Dial to Many - parallel":{
"summary":"Dial to Many - parallel",
"description":"Dial to Many - parallel",
"value":{
"name":"Dial to Many - parallel",
"description":"Dial multiple destinations in parallel. This means that all destinations will receive the call at the same time, but only the first who answers is connected.",
"script":[
{
"dialToMany":[
{
"number":"41793026741"
},
{
"number":"41793026801"
},
{
"number":"41793026653"
},
{
"number":"41793026142"
}
],
"options":{
"parallel":true,
"senderId":"4179302614112",
"maxCallDuration":60
}
}
]
}
},
"Dial to Many - sequential":{
"summary":"Dial to Many - sequential",
"description":"Dial to Many - sequential",
"value":{
"name":"Dial to Many - example",
"description":"Dial multiple destinations in sequential. This means that the provided destinations will be called one by one as defined in the action below. First who answers will be connected, and the next ones will not be called.",
"script":[
{
"dialToMany":[
{
"number":"41793026741"
},
{
"number":"41793026801"
},
{
"number":"41793026653"
},
{
"number":"41793026142"
}
],
"options":{
"parallel":false,
"senderId":"4179302614112",
"maxCallDuration":60
}
}
]
}
},
"Dial to Conversations":{
"summary":"Dial to Conversations",
"description":"Dial to Conversations",
"value":{
"name":"Dial to Conversations",
"description":"Dial to Conversations.",
"script":[
{
"dialToConversations":{
"options":{
"tags":[
"tag name 1",
"tag name 2"
]
}
}
}
]
}
},
"Dial to Conversations with tagIdentifierType":{
"summary":"Dial to Conversations with tagIdentifierType",
"description":"Dial to Conversations with tagIdentifierType",
"value":{
"name":"Dial to Conversations with tagIdentifierType",
"description":"Dial to Conversations with tagIdentifierType.",
"script":[
{
"dialToConversations":{
"options":{
"tagIdentifierType":"ID",
"tags":[
"aaaaaaaa-bbbb-cccc-1111-222222222222",
"bbbbbbbb-cccc-eeee-2222-333333333333"
]
}
}
}
]
}
},
"For-Each":{
"summary":"For-Each",
"description":"For-Each",
"value":{
"name":"For-Each",
"description":"Use For-each to perform any action for each of provided values.",
"script":[
{
"for-each":"city",
"in":"New York,Los Angeles,Boston",
"do":[
{
"say":"Hello from ${city}"
}
]
}
]
}
},
"Goto to repeat a message":{
"summary":"Goto to repeat a message",
"description":"Goto to repeat a message",
"value":{
"name":"Goto to repeat say action n times",
"description":"Repeat a message n times and then hang up",
"script":[
{
"actionId":1,
"say":"Your password is 1, 2, 3, 4"
},
{
"if":"${countVar == 3}",
"then":[
{
"say":"I will hangup now"
}
]
},
{
"goTo":1,
"options":{
"gotoLimit":3,
"countVariable":"countVar"
}
},
"hangup"
]
}
},
"Goto limit reached":{
"summary":"Goto limit reached",
"description":"Goto limit reached",
"value":{
"name":"Goto limit reached",
"description":"Goto limit reached",
"script":[
{
"say":"Hello world",
"actionId":1
},
{
"if":"${count_var == 3}",
"then":[
{
"say":"I will hangup now"
}
]
},
{
"goTo":1,
"options":{
"gotoLimit":3,
"countVariable":"count_var"
}
},
"hangup"
]
}
},
"If-Then-Else":{
"summary":"If-Then-Else",
"description":"If-Then-Else",
"value":{
"name":"If-Then-Else",
"description":"If-Then-Else",
"script":[
{
"if":"${number > 0}",
"then":[
{
"say":"Number ${number} is a positive number."
}
],
"else":[
{
"say":"Number ${number} is a non-positive number."
}
]
}
]
}
},
"Machine detection with advanced options":{
"summary":"Machine detection with advanced options",
"description":"Machine detection with advanced options",
"value":{
"description":"Advanced machine detection",
"name":"Advanced machine detection",
"script":[
{
"answeringMachineDetection":true,
"options":{
"waitEndOfMessageDetection":"ALWAYS",
"endOfMessageDetectionTimeout":30
},
"onDetecting":[
{
"say":"Thank you for using our services. We’re excited to reward your loyalty with free concert tickets."
}
],
"onMachineDetected":[
{
"say":"It seems we've reached your voicemail. Please visit our website to learn more about the free tickets."
},
"hangup"
],
"onTimeout":[
"hangup"
]
},
{
"say":"Please enter your preferred concert date. For example, to enter March 1st, press 0 1 0 3. Thank you!"
},
{
"collectInto":"concertDate",
"options":{
"maxInputLength":8
}
},
"hangup"
]
}
},
"Machine detection with if-then-else":{
"summary":"Machine detection with if-then-else",
"description":"Machine detection with if-then-else",
"value":{
"name":"Machine detection if-then-else",
"description":"This example uses machine detection with if-else to detect if answering machine has answered the call, and based on that information branches the execution of the IVR scenario.",
"script":[
"machineDetection",
{
"if":"${machineAnswered == true}",
"then":[
"hangup"
],
"else":[
{
"say":"Hello human."
}
]
}
]
}
},
"Machine detection with switch-case":{
"summary":"Machine detection with switch-case",
"description":"Machine detection with switch-case",
"value":{
"name":"Machine detection with switch-case",
"description":"This example uses machine detection with switch-case to detect if answering machine has answered the call, and based on that information branches the execution of the IVR scenario.",
"script":[
"machineDetection",
{
"case":{
"true":[
"hangup"
],
"__default":[
{
"say":"Hello. Human has answered the call."
}
]
},
"switch":"machineAnswered"
}
]
}
},
"Pause":{
"summary":"Pause",
"description":"Pause",
"value":{
"name":"Pause",
"description":"Create a pause of 2 seconds, for example between 2 say actions.",
"script":[
{
"say":"Hello, saying something before I make a pause of 2 seconds."
},
{
"pause":2
},
{
"say":"Phew, that felt like forever."
}
]
}
},
"Play from url":{
"summary":"Play from url",
"description":"Play from url",
"value":{
"name":"Play from url",
"description":"Play from url",
"script":[
{
"playFromUrl":"https://www.example.com/voice/sound.mp3"
}
]
}
},
"Play from Recording where recording was in a previous call":{
"summary":"Play from Recording where recording was in a previous call",
"description":"Play from Recording where recording was in a previous call",
"value":{
"name":"Play From Recording where recording was in a previous call",
"description":"Play the recording of a previous call. All you have to do is to provide the recording id.",
"script":[
{
"playFromRecording":"recordingId"
}
]
}
},
"Play from uploaded file":{
"summary":"Play from uploaded file",
"description":"Play from uploaded file",
"value":{
"name":"Play from uploaded file",
"description":"Play the file uploaded through IVR upload API.",
"script":[
{
"playFromUpload":"f75ff9ca-20ce-47b7-ab0c-8adcb9725bb0",
"options":{
"loopCount":3
}
}
]
}
},
"Play TTY":{
"summary":"Play TTY",
"description":"Play TTY",
"value":{
"name":"Play TTY test",
"description":"TTY text output using Baudot tones",
"script":[
{
"playTty":"Welcome to TTY system"
},
"hangup"
]
}
},
"Play TTY with collect":{
"summary":"Play TTY with collect",
"description":"Play TTY with collect",
"value":{
"name":"Play TTY with collect",
"description":"Play TTY action combined with Collect to gather user input",
"script":[
{
"playTty":"Enter your PIN"
},
{
"collectInto":"pin",
"options":{
"maxInputLength":4
}
},
"hangup"
]
}
},
"Record":{
"summary":"Record",
"description":"Record",
"value":{
"name":"Record",
"description":"Record users call",
"script":[
{
"record":10,
"options":{
"escapeDigits":"123*",
"beep":true,
"maxSilence":3,
"identifier":"${varName}"
}
}
]
}
},
"Record & play from recording":{
"summary":"Record & play from recording",
"description":"Record & play from recording",
"value":{
"name":"Record & play from recording",
"description":"Record a voice mail and play the recording back to the user.",
"script":[
{
"say":"After this message, we will record you for 10 seconds and play back the recording to you. Please speak after the beep sound."
},
{
"record":10,
"options":{
"beep":true,
"identifier":"recordVariable",
"escapeDigits":"1",
"maxSilence":3
}
},
{
"playFromRecording":"recordVariable"
}
]
}
},
"Repeat-While":{
"summary":"Repeat-While",
"description":"Repeat-While",
"value":{
"name":"Repeat-While",
"description":"Repeat-While",
"script":[
{
"setVariable":"i",
"value":"1"
},
{
"repeat":[
{
"setVariable":"i",
"value":"${i + 1}"
},
{
"playFromUrl":"http://www.example.com/file.wav"
}
],
"while":"${i < 4}"
},
"hangup"
]
}
},
"Say":{
"summary":"Say",
"description":"Say",
"value":{
"name":"Say",
"description":"Say",
"script":[
{
"say":"Hello. You have successfully used a Say Action in IVR."
}
]
}
},
"Say with custom voice options":{
"summary":"Say with custom voice options",
"description":"Say with custom voice options",
"value":{
"name":"Say with custom voice options",
"description":"Say with custom voice options",
"script":[
{
"say":"Hello. You have successfully used a Say Action in IVR with custom voice options.",
"options":{
"speechRate":2,
"language":"en",
"voice":{
"name":"Joanna",
"gender":"FEMALE"
}
}
}
]
}
},
"Say with variables":{
"summary":"Say with variables",
"description":"Say with variables",
"value":{
"name":"Say with variables",
"description":"Say example with variables",
"script":[
{
"say":"Hello ${userNameVariable}. You have successfully used a Say Action in IVR with a variable."
}
]
}
},
"Say with a pause in between words":{
"summary":"Say with a pause in between words",
"description":"Say with a pause in between words",
"value":{
"name":"Say with a pause in between words",
"description":"Say with a pause in between words",
"script":[
{
"say":"Hello ,, You have successfully used a Say Action in IVR with a pause."
}
]
}
},
"Set Variable":{
"summary":"Set Variable",
"description":"Set Variable",
"value":{
"name":"Set Variable",
"description":"Set Variable",
"script":[
{
"say":"DTMFs will be collected now"
},
{
"collectInto":"dtmf"
},
{
"switch":"dtmf",
"case":{
"1":[
{
"say":"You pressed 1"
}
],
"2":[
{
"say":"You pressed 2"
}
],
"__default":[
{
"setVariable":"dtmf",
"value":"1"
},
{
"say":"You did not press 1 nor 2. Setting DTMF variable to 1."
}
]
}
},
"hangup"
]
}
},
"Send SMS":{
"summary":"Send SMS",
"description":"Send SMS",
"value":{
"name":"Send SMS",
"description":"Send SMS",
"script":[
{
"sendSms":{
"text":"Hello",
"from":"InfoSMS",
"to":"${to}"
}
}
]
}
},
"Switch-Case":{
"summary":"Switch-Case",
"description":"Switch-Case",
"value":{
"name":"Switch-Case",
"description":"Switch-Case",
"script":[
{
"switch":"myVariable",
"case":{
"1":[
{
"dial":"41793026731"
}
],
"2":[
{
"playFromUrl":"https://www.example.com/voice/advanced"
}
],
"3":[
{
"request":"https://example.com/api/12345",
"options":{
"method":"POST",
"headers":{
"content-type":"application/json"
},
"body":{
"payload":"${to} finished the IVR."
}
}
}
],
"4":[
{
"request":"https://example.com/api/12345",
"options":{
"method":"GET",
"collectResponse":true
}
}
],
"5":[
{
"request":"https://example.com/api/12345",
"options":{
"method":"PUT",
"headers":{
"content-type":"application/xml",
"accept":"application/xml"
},
"body":"${to} finished the IVR.",
"collectResponse":true
}
}
],
"__default":[
{
"say":"Dear Customer, you pressed wrong number. Please, try again."
},
{
"collectInto":"myVariable",
"options":{
"maxInputLength":1
}
}
]
}
}
]
}
},
"Use case: Checking order":{
"summary":"Use case: Checking order",
"description":"Use case: Checking order",
"value":{
"name":"Use case: Checking order",
"description":"Checking order",
"script":[
{
"say":"Welcome to Acme Co Delivery. To track your package, please enter your 5 digit your tracking number."
},
{
"collectInto":"code",
"options":{
"maxInputLength":5
}
},
{
"request":"https://example.com/api/12345",
"options":{
"method":"POST",
"headers":{
"content-type":"application/json"
},
"body":{
"code":"${code}"
},
"collectResponse":true
}
},
{
"say":"responseMessage"
},
{
"say":"If you have any questions or need to reschedule the delivery, press 1 to speak with an agent."
},
{
"collectInto":"satisfiedAnswer"
},
{
"switch":"satisfiedAnswer",
"case":{
"1":[
{
"dial":"41793026731"
}
]
}
},
"hangup"
]
}
},
"Use case: Scheduling appointment":{
"summary":"Use case: Scheduling appointment",
"description":"Use case: Scheduling appointment",
"value":{
"name":"Use case: Scheduling appointment",
"description":"Scheduling appointment",
"script":[
{
"say":"Dear client, we would like to schedule an appointment on 14.10. Available time is 10:00 am, 11 am and 2:00 pm. Please press 1 for 10 am, 2 for 11 or 3 for a 2 pm meeting. If non of the above suits you, we will send new message suggesting different time frame."
},
{
"collectInto":"scheduleTime"
},
{
"switch":"scheduleTime",
"case":{
"1":[
{
"say":"Thank you. Your appointment is scheduled for 10 am."
}
],
"2":[
{
"say":"Thank you. Your appointment is scheduled for 11 am."
}
],
"3":[
{
"say":"Thank you. Your appointment is scheduled for 2 pm."
}
],
"__default":[
{
"say":"Thank you We will suggest another time slot once it’s available."
},
"hangup"
]
}
},
{
"say":"Thank you. Your appointment is scheduled."
},
"hangup"
]
}
},
"While-Do":{
"summary":"While-Do",
"description":"While-Do",
"value":{
"name":"While-Do",
"description":"While-Do",
"script":[
{
"setVariable":"i",
"value":"1"
},
{
"while":"${i < 4}",
"do":[
{
"playFromUrl":"http://www.example.com/file${i}.wav"
},
{
"setVariable":"i",
"value":"${i + 1}"
}
]
},
"hangup"
]
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"successful response",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.UpdateScenarioResponse"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":{
"id":"E83E787CF2613450157ADA3476171E3F",
"name":"My Scenario",
"description":"Scenario to send a message",
"createTime":"2023-09-14T15:13:36.735+0000",
"script":[
{
"sendSms":{
"text":"Hello",
"to":"${to}"
}
}
]
}
}
}
}
}
},
"400":{
"$ref":"#/components/responses/ApiException400"
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"ivr:manage",
"ivr:configuration:manage",
"message:send"
]
}
},
"/voice/ivr/1/scenarios/{id}":{
"get":{
"tags":[
"channels",
"voice",
"interactive-voice-response",
"manage-ivr-scenarios"
],
"summary":"Get a Voice IVR Scenario",
"description":"This method allows you to get a Voice IVR Scenario.",
"operationId":"get-a-voice-ivr-scenario",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Scenario identifier.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"successful response",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.UpdateScenarioResponse"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":{
"id":"E83E787CF2613450157ADA3476171E3F",
"name":"My Scenario",
"description":"Scenario to send a message",
"createTime":"2023-09-14T15:13:36.735+0000",
"updateTime":"2023-09-14T16:20:32.432+0000",
"lastUsageDate":"2023-09-14",
"script":[
{
"sendSms":{
"text":"Hello",
"to":"${to}"
}
}
]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"ivr:manage",
"ivr:configuration:manage",
"message:send"
]
},
"put":{
"tags":[
"channels",
"voice",
"interactive-voice-response",
"manage-ivr-scenarios"
],
"summary":"Update Voice IVR Scenarios",
"description":"This method allows you to update a Voice IVR Scenario. Changes may take up to 10 minutes to apply.",
"operationId":"update-voice-ivr-scenario",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Scenario identifier.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.UpdateScenarioRequest"
},
"examples":{
"Call API":{
"summary":"Call API",
"description":"Call API",
"value":{
"name":"Call API",
"description":"Perform a POST request to provided URL with headers and payload.",
"script":[
{
"request":"https://example.com/api/12345",
"options":{
"method":"POST",
"headers":{
"content-type":"application/json"
},
"body":{
"payload":"${to} finished the IVR."
}
}
}
]
}
},
"Call Api to send collected DTMFs":{
"summary":"Call Api to send collected DTMFs",
"description":"Call Api to send collected DTMFs",
"value":{
"name":"Call Api",
"description":"Collect users input and submits it with a POST request to a url.",
"script":[
{
"say":"Hello, please press 1 if you wish to subscribe to our newsletter."
},
{
"collectInto":"myCollectedVariable",
"options":{
"maxInputLength":1,
"timeout":5
}
},
{
"request":"https://example.com/subscription",
"options":{
"method":"POST",
"headers":{
"custom-header":"header-value"
},
"body":{
"shouldSubscribe":"${myCollectedVariable}"
}
}
},
{
"if":"${myCollectedVariable == 1}",
"then":[
{
"say":"You subscribed successfully."
}
]
}
]
}
},
"Call Api with response":{
"summary":"Call Api with response",
"description":"Call Api with response",
"value":{
"name":"Call Api with collected response",
"description":"Collect users input and submit it with a POST request to a url, and play the response back to the user. Let's assume the response is a simple JSON object that has only one field with a key called 'responseText' and value defined by the clients API.",
"script":[
{
"say":"Hello, please press 1 if you wish to subscribe to our newsletter."
},
{
"collectInto":"myCollectedVariable",
"options":{
"maxInputLength":1,
"timeout":5
}
},
{
"request":"https://example.com/subscription",
"options":{
"method":"POST",
"headers":{
"custom-header":"header-value"
},
"body":{
"shouldSubscribe":"${myCollectedVariable}"
},
"collectResponse":true
}
},
{
"say":"${responseText}"
}
]
}
},
"Capture":{
"summary":"Capture",
"description":"Capture",
"value":{
"name":"Capture speech",
"description":"Capture users speech and branch the call based on the spoken words.",
"script":[
{
"say":"Say yes or no"
},
{
"capture":"myVar",
"timeout":3,
"speechOptions":{
"language":"en-US",
"maxSilence":2,
"keyPhrases":[
"yes",
"no"
]
}
},
{
"if":"${myVar == 'yes'}",
"then":[
{
"say":"Ok. I will send you more details"
}
],
"else":[]
},
{
"if":"${myVar == 'no'}",
"then":[
{
"say":"Thank you for listening."
}
],
"else":[]
},
{
"if":"${myVar == ''}",
"then":[
{
"say":"I did not understand"
}
],
"else":[]
},
"hangup"
]
}
},
"Capture speech or digit":{
"summary":"Capture speech or digit",
"description":"Capture speech or digit",
"value":{
"name":"Capture speech or digit",
"description":"Capture speech or digit",
"script":[
{
"say":"Say discount or press 1 to get discount. Say exit or press 0 to exit."
},
{
"capture":"myVar",
"timeout":5,
"speechOptions":{
"language":"en-US",
"maxSilence":2,
"keyPhrases":[
"discount",
"exit"
]
},
"dtmfOptions":{
"maxInputLength":1
}
},
{
"if":"${myVar == 'discount' || myVar == '1'}",
"then":[
{
"say":"You will get discount"
}
],
"else":[
{
"if":"${myVar == 'exit' || myVar == '0'}",
"then":[
{
"say":"Goodbye"
}
],
"else":[
{
"say":"I did not understand"
}
]
}
]
},
"hangup"
]
}
},
"Collect dtmf and branch call execution based on input":{
"summary":"Collect dtmf and branch call execution based on input",
"description":"Collect dtmf and branch call execution based on input",
"value":{
"name":"Capture speech or digit",
"description":"Capture speech or digit",
"script":[
{
"say":"Say discount or press 1 to get discount. Say exit or press 0 to exit."
},
{
"capture":"myVar",
"timeout":5,
"speechOptions":{
"language":"en-US",
"maxSilence":2,
"keyPhrases":[
"discount",
"exit"
]
},
"dtmfOptions":{
"maxInputLength":1
}
},
{
"if":"${myVar == 'discount' || myVar == '1'}",
"then":[
{
"say":"You will get discount"
}
],
"else":[
{
"if":"${myVar == 'exit' || myVar == '0'}",
"then":[
{
"say":"Goodbye"
}
],
"else":[
{
"say":"I did not understand"
}
]
}
]
},
"hangup"
]
}
},
"Collect dtmf with default branch":{
"summary":"Collect dtmf with default branch",
"description":"Collect dtmf with default branch",
"value":{
"name":"Collect dtmf with default branch",
"description":"Based on the collected input, the execution is branched into 2 branches. If wrong digit is pressed or nothing is pressed, execute default branch.",
"script":[
{
"say":"Hello. Press 1 or 2. Or press any other digit or do not press anything for default message to be played."
},
{
"collectInto":"myVariable",
"options":{
"maxInputLength":1,
"timeout":5,
"sendToReports":"ALWAYS",
"mappedValues":{
"1":"pressed one",
"2":"pressed two"
}
}
},
{
"case":{
"1":[
{
"say":"You have pressed 1."
}
],
"2":[
{
"say":"You have pressed 2."
}
],
"__default":[
{
"say":"You pressed some other key or didn't press anything"
}
]
},
"switch":"myVariable"
}
]
}
},
"Dial":{
"summary":"Dial",
"description":"Dial",
"value":{
"name":"Dial to a destination",
"description":"Dial to a provided destination to bridge original call with the dialed call.",
"script":[
{
"dial":"41793026731",
"options":{
"senderId":"123456789",
"maxCallDuration":10
}
}
]
}
},
"Dial from a variable":{
"summary":"Dial from a variable",
"description":"Dial from a variable",
"value":{
"name":"Dial to a number resolved from a variable",
"description":"Dial to a number resolved from a variable",
"script":[
{
"dial":"${numberToDial}",
"options":{
"senderId":"123456789",
"maxCallDuration":10
}
}
]
}
},
"Dial to Many - parallel":{
"summary":"Dial to Many - parallel",
"description":"Dial to Many - parallel",
"value":{
"name":"Dial to Many - parallel",
"description":"Dial multiple destinations in parallel. This means that all destinations will receive the call at the same time, but only the first who answers is connected.",
"script":[
{
"dialToMany":[
{
"number":"41793026741"
},
{
"number":"41793026801"
},
{
"number":"41793026653"
},
{
"number":"41793026142"
}
],
"options":{
"parallel":true,
"senderId":"4179302614112",
"maxCallDuration":60
}
}
]
}
},
"Dial to Many - sequential":{
"summary":"Dial to Many - sequential",
"description":"Dial to Many - sequential",
"value":{
"name":"Dial to Many - example",
"description":"Dial multiple destinations in sequential. This means that the provided destinations will be called one by one as defined in the action below. First who answers will be connected, and the next ones will not be called.",
"script":[
{
"dialToMany":[
{
"number":"41793026741"
},
{
"number":"41793026801"
},
{
"number":"41793026653"
},
{
"number":"41793026142"
}
],
"options":{
"parallel":false,
"senderId":"4179302614112",
"maxCallDuration":60
}
}
]
}
},
"Dial to Conversations":{
"summary":"Dial to Conversations",
"description":"Dial to Conversations",
"value":{
"name":"Dial to Conversations",
"description":"Dial to Conversations.",
"script":[
{
"dialToConversations":{
"options":{
"tags":[
"tag name 1",
"tag name 2"
]
}
}
}
]
}
},
"Dial to Conversations with tagIdentifierType":{
"summary":"Dial to Conversations with tagIdentifierType",
"description":"Dial to Conversations with tagIdentifierType",
"value":{
"name":"Dial to Conversations with tagIdentifierType",
"description":"Dial to Conversations with tagIdentifierType.",
"script":[
{
"dialToConversations":{
"options":{
"tagIdentifierType":"ID",
"tags":[
"aaaaaaaa-bbbb-cccc-1111-222222222222",
"bbbbbbbb-cccc-eeee-2222-333333333333"
]
}
}
}
]
}
},
"For-Each":{
"summary":"For-Each",
"description":"For-Each",
"value":{
"name":"For-Each",
"description":"Use For-each to perform any action for each of provided values.",
"script":[
{
"for-each":"city",
"in":"New York,Los Angeles,Boston",
"do":[
{
"say":"Hello from ${city}"
}
]
}
]
}
},
"Goto to repeat a message":{
"summary":"Goto to repeat a message",
"description":"Goto to repeat a message",
"value":{
"name":"Goto to repeat say action n times",
"description":"Repeat a message n times and then hang up",
"script":[
{
"actionId":1,
"say":"Your password is 1, 2, 3, 4"
},
{
"if":"${countVar == 3}",
"then":[
{
"say":"I will hangup now"
}
]
},
{
"goTo":1,
"options":{
"gotoLimit":3,
"countVariable":"countVar"
}
},
"hangup"
]
}
},
"Goto limit reached":{
"summary":"Goto limit reached",
"description":"Goto limit reached",
"value":{
"name":"Goto limit reached",
"description":"Goto limit reached",
"script":[
{
"say":"Hello world",
"actionId":1
},
{
"if":"${count_var == 3}",
"then":[
{
"say":"I will hangup now"
}
]
},
{
"goTo":1,
"options":{
"gotoLimit":3,
"countVariable":"count_var"
}
},
"hangup"
]
}
},
"If-Then-Else":{
"summary":"If-Then-Else",
"description":"If-Then-Else",
"value":{
"name":"If-Then-Else",
"description":"If-Then-Else",
"script":[
{
"if":"${number > 0}",
"then":[
{
"say":"Number ${number} is a positive number."
}
],
"else":[
{
"say":"Number ${number} is a non-positive number."
}
]
}
]
}
},
"Machine detection with advanced options":{
"summary":"Machine detection with advanced options",
"description":"Machine detection with advanced options",
"value":{
"description":"Advanced machine detection",
"name":"Advanced machine detection",
"script":[
{
"answeringMachineDetection":true,
"options":{
"waitEndOfMessageDetection":"ALWAYS",
"endOfMessageDetectionTimeout":30
},
"onDetecting":[
{
"say":"Thank you for using our services. We’re excited to reward your loyalty with free concert tickets."
}
],
"onMachineDetected":[
{
"say":"It seems we've reached your voicemail. Please visit our website to learn more about the free tickets."
},
"hangup"
],
"onTimeout":[
"hangup"
]
},
{
"say":"Please enter your preferred concert date. For example, to enter March 1st, press 0 1 0 3. Thank you!"
},
{
"collectInto":"concertDate",
"options":{
"maxInputLength":8
}
},
"hangup"
]
}
},
"Machine detection with if-then-else":{
"summary":"Machine detection with if-then-else",
"description":"Machine detection with if-then-else",
"value":{
"name":"Machine detection if-then-else",
"description":"This example uses machine detection with if-else to detect if answering machine has answered the call, and based on that information branches the execution of the IVR scenario.",
"script":[
"machineDetection",
{
"if":"${machineAnswered == true}",
"then":[
"hangup"
],
"else":[
{
"say":"Hello human."
}
]
}
]
}
},
"Machine detection with switch-case":{
"summary":"Machine detection with switch-case",
"description":"Machine detection with switch-case",
"value":{
"name":"Machine detection with switch-case",
"description":"This example uses machine detection with switch-case to detect if answering machine has answered the call, and based on that information branches the execution of the IVR scenario.",
"script":[
"machineDetection",
{
"case":{
"true":[
"hangup"
],
"__default":[
{
"say":"Hello. Human has answered the call."
}
]
},
"switch":"machineAnswered"
}
]
}
},
"Pause":{
"summary":"Pause",
"description":"Pause",
"value":{
"name":"Pause",
"description":"Create a pause of 2 seconds, for example between 2 say actions.",
"script":[
{
"say":"Hello, saying something before I make a pause of 2 seconds."
},
{
"pause":2
},
{
"say":"Phew, that felt like forever."
}
]
}
},
"Play from url":{
"summary":"Play from url",
"description":"Play from url",
"value":{
"name":"Play from url",
"description":"Play from url",
"script":[
{
"playFromUrl":"https://www.example.com/voice/sound.mp3"
}
]
}
},
"Play from Recording where recording was in a previous call":{
"summary":"Play from Recording where recording was in a previous call",
"description":"Play from Recording where recording was in a previous call",
"value":{
"name":"Play From Recording where recording was in a previous call",
"description":"Play the recording of a previous call. All you have to do is to provide the recording id.",
"script":[
{
"playFromRecording":"recordingId"
}
]
}
},
"Play from uploaded file":{
"summary":"Play from uploaded file",
"description":"Play from uploaded file",
"value":{
"name":"Play from uploaded file",
"description":"Play the file uploaded through IVR upload API.",
"script":[
{
"playFromUpload":"f75ff9ca-20ce-47b7-ab0c-8adcb9725bb0",
"options":{
"loopCount":3
}
}
]
}
},
"Play TTY":{
"summary":"Play TTY",
"description":"Play TTY",
"value":{
"name":"Play TTY test",
"description":"TTY text output using Baudot tones",
"script":[
{
"playTty":"Welcome to TTY system"
},
"hangup"
]
}
},
"Play TTY with collect":{
"summary":"Play TTY with collect",
"description":"Play TTY with collect",
"value":{
"name":"Play TTY with collect",
"description":"Play TTY action combined with Collect to gather user input",
"script":[
{
"playTty":"Enter your PIN"
},
{
"collectInto":"pin",
"options":{
"maxInputLength":4
}
},
"hangup"
]
}
},
"Record":{
"summary":"Record",
"description":"Record",
"value":{
"name":"Record",
"description":"Record users call",
"script":[
{
"record":10,
"options":{
"escapeDigits":"123*",
"beep":true,
"maxSilence":3,
"identifier":"${varName}"
}
}
]
}
},
"Record & play from recording":{
"summary":"Record & play from recording",
"description":"Record & play from recording",
"value":{
"name":"Record & play from recording",
"description":"Record a voice mail and play the recording back to the user.",
"script":[
{
"say":"After this message, we will record you for 10 seconds and play back the recording to you. Please speak after the beep sound."
},
{
"record":10,
"options":{
"beep":true,
"identifier":"recordVariable",
"escapeDigits":"1",
"maxSilence":3
}
},
{
"playFromRecording":"recordVariable"
}
]
}
},
"Repeat-While":{
"summary":"Repeat-While",
"description":"Repeat-While",
"value":{
"name":"Repeat-While",
"description":"Repeat-While",
"script":[
{
"setVariable":"i",
"value":"1"
},
{
"repeat":[
{
"setVariable":"i",
"value":"${i + 1}"
},
{
"playFromUrl":"http://www.example.com/file.wav"
}
],
"while":"${i < 4}"
},
"hangup"
]
}
},
"Say":{
"summary":"Say",
"description":"Say",
"value":{
"name":"Say",
"description":"Say",
"script":[
{
"say":"Hello. You have successfully used a Say Action in IVR."
}
]
}
},
"Say with custom voice options":{
"summary":"Say with custom voice options",
"description":"Say with custom voice options",
"value":{
"name":"Say with custom voice options",
"description":"Say with custom voice options",
"script":[
{
"say":"Hello. You have successfully used a Say Action in IVR with custom voice options.",
"options":{
"speechRate":2,
"language":"en",
"voice":{
"name":"Joanna",
"gender":"FEMALE"
}
}
}
]
}
},
"Say with variables":{
"summary":"Say with variables",
"description":"Say with variables",
"value":{
"name":"Say with variables",
"description":"Say example with variables",
"script":[
{
"say":"Hello ${userNameVariable}. You have successfully used a Say Action in IVR with a variable."
}
]
}
},
"Say with a pause in between words":{
"summary":"Say with a pause in between words",
"description":"Say with a pause in between words",
"value":{
"name":"Say with a pause in between words",
"description":"Say with a pause in between words",
"script":[
{
"say":"Hello ,, You have successfully used a Say Action in IVR with a pause."
}
]
}
},
"Set Variable":{
"summary":"Set Variable",
"description":"Set Variable",
"value":{
"name":"Set Variable",
"description":"Set Variable",
"script":[
{
"say":"DTMFs will be collected now"
},
{
"collectInto":"dtmf"
},
{
"switch":"dtmf",
"case":{
"1":[
{
"say":"You pressed 1"
}
],
"2":[
{
"say":"You pressed 2"
}
],
"__default":[
{
"setVariable":"dtmf",
"value":"1"
},
{
"say":"You did not press 1 nor 2. Setting DTMF variable to 1."
}
]
}
},
"hangup"
]
}
},
"Send SMS":{
"summary":"Send SMS",
"description":"Send SMS",
"value":{
"name":"Send SMS",
"description":"Send SMS",
"script":[
{
"sendSms":{
"text":"Hello",
"from":"InfoSMS",
"to":"${to}"
}
}
]
}
},
"Switch-Case":{
"summary":"Switch-Case",
"description":"Switch-Case",
"value":{
"name":"Switch-Case",
"description":"Switch-Case",
"script":[
{
"switch":"myVariable",
"case":{
"1":[
{
"dial":"41793026731"
}
],
"2":[
{
"playFromUrl":"https://www.example.com/voice/advanced"
}
],
"3":[
{
"request":"https://example.com/api/12345",
"options":{
"method":"POST",
"headers":{
"content-type":"application/json"
},
"body":{
"payload":"${to} finished the IVR."
}
}
}
],
"4":[
{
"request":"https://example.com/api/12345",
"options":{
"method":"GET",
"collectResponse":true
}
}
],
"5":[
{
"request":"https://example.com/api/12345",
"options":{
"method":"PUT",
"headers":{
"content-type":"application/xml",
"accept":"application/xml"
},
"body":"${to} finished the IVR.",
"collectResponse":true
}
}
],
"__default":[
{
"say":"Dear Customer, you pressed wrong number. Please, try again."
},
{
"collectInto":"myVariable",
"options":{
"maxInputLength":1
}
}
]
}
}
]
}
},
"Use case: Checking order":{
"summary":"Use case: Checking order",
"description":"Use case: Checking order",
"value":{
"name":"Use case: Checking order",
"description":"Checking order",
"script":[
{
"say":"Welcome to Acme Co Delivery. To track your package, please enter your 5 digit your tracking number."
},
{
"collectInto":"code",
"options":{
"maxInputLength":5
}
},
{
"request":"https://example.com/api/12345",
"options":{
"method":"POST",
"headers":{
"content-type":"application/json"
},
"body":{
"code":"${code}"
},
"collectResponse":true
}
},
{
"say":"responseMessage"
},
{
"say":"If you have any questions or need to reschedule the delivery, press 1 to speak with an agent."
},
{
"collectInto":"satisfiedAnswer"
},
{
"switch":"satisfiedAnswer",
"case":{
"1":[
{
"dial":"41793026731"
}
]
}
},
"hangup"
]
}
},
"Use case: Scheduling appointment":{
"summary":"Use case: Scheduling appointment",
"description":"Use case: Scheduling appointment",
"value":{
"name":"Use case: Scheduling appointment",
"description":"Scheduling appointment",
"script":[
{
"say":"Dear client, we would like to schedule an appointment on 14.10. Available time is 10:00 am, 11 am and 2:00 pm. Please press 1 for 10 am, 2 for 11 or 3 for a 2 pm meeting. If non of the above suits you, we will send new message suggesting different time frame."
},
{
"collectInto":"scheduleTime"
},
{
"switch":"scheduleTime",
"case":{
"1":[
{
"say":"Thank you. Your appointment is scheduled for 10 am."
}
],
"2":[
{
"say":"Thank you. Your appointment is scheduled for 11 am."
}
],
"3":[
{
"say":"Thank you. Your appointment is scheduled for 2 pm."
}
],
"__default":[
{
"say":"Thank you We will suggest another time slot once it’s available."
},
"hangup"
]
}
},
{
"say":"Thank you. Your appointment is scheduled."
},
"hangup"
]
}
},
"While-Do":{
"summary":"While-Do",
"description":"While-Do",
"value":{
"name":"While-Do",
"description":"While-Do",
"script":[
{
"setVariable":"i",
"value":"1"
},
{
"while":"${i < 4}",
"do":[
{
"playFromUrl":"http://www.example.com/file${i}.wav"
},
{
"setVariable":"i",
"value":"${i + 1}"
}
]
},
"hangup"
]
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"successful response",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.UpdateScenarioResponse"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":[
{
"id":"E83E787CF2613450157ADA3476171E3F",
"name":"My Scenario",
"description":"Scenario to send a message",
"createTime":"2023-09-14T15:13:36.735+0000",
"updateTime":"2023-09-14T16:20:32.432+0000",
"lastUsageDate":"2023-09-14",
"script":[
{
"sendSms":{
"text":"Hello",
"to":"${to}"
}
}
]
}
]
}
}
}
}
},
"400":{
"$ref":"#/components/responses/ApiException400"
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"ivr:manage",
"ivr:configuration:manage",
"message:send"
]
},
"delete":{
"tags":[
"channels",
"voice",
"interactive-voice-response",
"manage-ivr-scenarios"
],
"summary":"Delete Voice IVR Scenarios",
"description":"This method allows you to delete a Voice IVR Scenario.",
"operationId":"delete-a-voice-ivr-scenario",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Scenario identifier (for example E83E787CF2613450157ADA3476171E3F).",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"successful response"
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"ivr:manage",
"ivr:configuration:manage",
"message:send"
]
}
},
"/voice/ivr/1/messages":{
"post":{
"tags":[
"channels",
"voice",
"interactive-voice-response",
"manage-ivr-scenarios"
],
"summary":"Launch IVR Scenario",
"description":"This method allows you to start an outbound IVR toward a multiple destinations.",
"operationId":"send-voice-messages-with-an-ivr-scenario",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.LaunchScenarioRequest"
},
"examples":{
"Request example":{
"summary":"Request example",
"value":{
"bulkId":"BULK-ID-123-xyz",
"messages":[
{
"scenarioId":"6298AA7707903A4ED680B436929681AD",
"from":"41793026700",
"destinations":[
{
"to":"41793026727"
},
{
"to":"41793026731"
}
],
"notifyUrl":"https://www.example.com/voice/advanced",
"notifyContentType":"application/json",
"callbackData":"DLR callback data",
"validityPeriod":720,
"sendAt":"2023-10-03T12:21:00.632+0000",
"retry":{
"minPeriod":1,
"maxPeriod":5,
"maxCount":5
},
"record":false,
"deliveryTimeWindow":{
"from":{
"hour":6,
"minute":0
},
"to":{
"hour":15,
"minute":30
},
"days":[
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
"SUNDAY"
]
}
}
]
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.LaunchScenarioRequest"
},
"examples":{
"Request example":{
"summary":"Request example",
"value":"\n \n BULK-ID-123-xyz\n \n \n \n \n \n 6298AA7707903A4ED680B436929681AD\n \n 41793026700\n \n \n \n \n \n 41793026727\n \n \n \n \n \n 41793026731\n \n \n \n \n \n https://www.example.com/voice/advanced\n \n application/json\n \n DLR callback data\n \n 720\n \n 2023-10-03T12:21:00.632+0000\n \n \n \n 1\n \n 5\n \n 5\n \n \n \n false\n \n \n \n \n \n 6\n \n 0\n \n \n \n \n \n 15\n \n 30\n \n \n \n \n \n MONDAY\n \n TUESDAY\n \n WEDNESDAY\n \n THURSDAY\n \n FRIDAY\n \n SATURDAY\n \n SUNDAY\n \n \n \n \n \n \n \n \n \n\n"
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"successful response",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.StandardVoiceResponse"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":{
"bulkId":"5028e2d42f19-42f1-4656-351e-a42c191e5fd2",
"messages":[
{
"to":"41793026727",
"status":{
"groupId":1,
"groupName":"PENDING",
"id":26,
"name":"PENDING_ACCEPTED",
"description":"Message accepted, pending for delivery."
},
"messageId":"4242f196ba50-a356-2f91-831c4aa55f351ed2"
},
{
"to":"41793026731",
"status":{
"groupId":1,
"groupName":"PENDING",
"id":26,
"name":"PENDING_ACCEPTED",
"description":"Message accepted, pending for delivery."
},
"messageId":"5f35f896ba50-a356-43a4-91cd81b85f8c689"
}
]
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.StandardVoiceResponse"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":"\n \n 5028e2d42f19-42f1-4656-351e-a42c191e5fd2\n \n \n \n \n \n 41793026727\n \n \n \n 1\n \n PENDING\n \n 26\n \n PENDING_ACCEPTED\n \n Message accepted, pending for delivery.\n \n \n \n 4242f196ba50-a356-2f91-831c4aa55f351ed2\n \n \n \n \n \n 41793026731\n \n \n \n 1\n \n PENDING\n \n 26\n \n PENDING_ACCEPTED\n \n Message accepted, pending for delivery.\n \n \n \n 5f35f896ba50-a356-43a4-91cd81b85f8c689\n \n \n \n \n \n\n"
}
}
}
}
},
"400":{
"$ref":"#/components/responses/ApiException400"
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"ivr:manage",
"ivr:message:send",
"message:send"
]
}
},
"/voice/ivr/1/files":{
"get":{
"tags":[
"channels",
"voice",
"interactive-voice-response",
"retrieve-recorded-files"
],
"summary":"Search Voice IVR Recorded Files",
"description":"This method allows you to search Voice IVR Recorded Audio Files.",
"operationId":"search-voice-ivr-recorded-files",
"parameters":[
{
"name":"page",
"in":"query",
"description":"Page number you want to see.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32"
}
},
{
"name":"pageSize",
"in":"query",
"description":"Size of the page you want to see.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32"
}
},
{
"name":"messageId",
"in":"query",
"description":"The message ID to search by.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"number",
"in":"query",
"description":"The called phone number to search by.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"successful response",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.RecordedAudioFilesResponse"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":{
"files":[
{
"messageId":"453e161a-fe4f-4f3c-80c0-ab520de9a969",
"from":"442032864231",
"to":"38712345678",
"scenarioId":"C9CE33CF130511D8E333C1260BABA309",
"groupId":"#/script/1",
"url":"/voice/ivr/1/files/3C67336FA555A606C85FA9637906A6AB98436B7AFC65D857A416F6521D39F8F0E1D3D2469FF580D8968D3DD89A2DB561",
"recordedAt":"2023-10-25T12:36:37.234+0000"
},
{
"messageId":"05b2859d-85c6-4068-9347-2e563b5c9cf4",
"from":"442032864231",
"to":"38712345678",
"scenarioId":"4A6177C9B92039306F1F091708851A2E",
"groupId":"#/script/1",
"url":"/voice/ivr/1/files/305DE72BA11D81D1BAED75BFC46706761580BDEC2218C22628447FD3814E7913D3058E4ECBFD6F55C80E976235EEB111",
"recordedAt":"2023-10-25T12:36:37.240+0000"
}
]
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.RecordedAudioFilesResponse"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":"\n \n \n \n \n \n 453e161a-fe4f-4f3c-80c0-ab520de9a969\n \n 442032864231\n \n 38712345678\n \n C9CE33CF130511D8E333C1260BABA309\n \n #/script/1\n \n /voice/ivr/1/files/3C67336FA555A606C85FA9637906A6AB98436B7AFC65D857A416F6521D39F8F0E1D3D2469FF580D8968D3DD89A2DB561\n \n 2023-10-25T12:36:37.234+0000\n \n \n \n \n \n 05b2859d-85c6-4068-9347-2e563b5c9cf4\n \n 442032864231\n \n 38712345678\n \n 4A6177C9B92039306F1F091708851A2E\n \n #/script/1\n \n /voice/ivr/1/files/305DE72BA11D81D1BAED75BFC46706761580BDEC2218C22628447FD3814E7913D3058E4ECBFD6F55C80E976235EEB111\n \n 2023-10-25T12:36:37.240+0000\n \n \n \n \n \n\n"
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"ivr:manage",
"ivr:configuration:manage",
"message:send"
]
}
},
"/voice/ivr/1/files/{id}":{
"get":{
"tags":[
"channels",
"voice",
"interactive-voice-response",
"retrieve-recorded-files"
],
"summary":"Download Voice IVR Recorded File.",
"description":"This method allows you to download Voice IVR Recorded Audio File. The returned audio data is encoded as PCM 16bit 8kHz WAVE audio. The files are available on Infobip servers for 2 months.",
"operationId":"search-voice-ivr-recorded-file",
"parameters":[
{
"name":"id",
"in":"path",
"description":"File ID to download.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"successful response",
"content":{
"audio/vnd.wave":{
"schema":{
"type":"string",
"format":"binary"
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"$ref":"#/components/responses/ApiException404"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"ivr:manage",
"ivr:configuration:manage",
"message:send"
]
}
},
"/voice/ivr/1/uploads":{
"get":{
"tags":[
"channels",
"voice",
"interactive-voice-response",
"ivr-uploaded-files"
],
"summary":"Get files",
"description":"Get files with pagination. Maximum number of pages is 100.",
"operationId":"ivr-upload-get-files",
"parameters":[
{
"name":"page",
"in":"query",
"description":"Results page to retrieve (0..N).",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":0,
"minimum":0
}
},
{
"name":"size",
"in":"query",
"description":"Number of records per page.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":20,
"maximum":100,
"minimum":1
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/5cb8669321a9b28a95445a23a292423b19c28f831eda62032aef9c6b53da7813.RouteResponsePage"
},
"examples":{
"Route response page example":{
"summary":"Route response page example",
"description":"Example of a page of route responses that includes route with Phone destination and Route with SIP destination.",
"value":{
"results":[
{
"id":"f8fc8aca-786d-4943-9af2-e7ec01b5e80d",
"name":"SIP endpoint route",
"destinations":[
{
"value":{
"username":"41793026834",
"sipTrunkId":"string",
"customHeaders":{
"string":"string"
},
"type":"SIP"
},
"connectTimeout":30,
"recording":{
"recordingType":"AUDIO",
"recordingComposition":{
"enabled":true
},
"customData":{
"string":"string"
},
"filePrefix":"string"
},
"type":"ENDPOINT"
}
],
"transferOnly":false
},
{
"id":"f8fc8aca-786d-4943-9af2-e7ec01b5e80d",
"name":"Phone endpoint route",
"destinations":[
{
"value":{
"phoneNumber":"41793026834",
"type":"PHONE"
},
"connectTimeout":30,
"recording":{
"recordingType":"AUDIO",
"recordingComposition":{
"enabled":true
},
"customData":{
"string":"string"
},
"filePrefix":"string"
},
"type":"ENDPOINT"
}
],
"transferOnly":false
}
],
"paging":{
"page":0,
"size":20,
"totalPages":1,
"totalResults":2
}
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.ApiError"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request",
"validationErrors":{
"field":[
"field must not be null"
]
}
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"property.path",
"violation":"Violation message."
}
],
"resources":[]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"ivr:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
},
"post":{
"tags":[
"channels",
"voice",
"interactive-voice-response",
"ivr-uploaded-files"
],
"summary":"Upload file",
"description":"Upload an audio file to be played in IVR calls. The file will be removed if it is not used for 90 days. Supported formats: `.wav` and `.mp3`.",
"operationId":"ivr-upload-audio-file",
"requestBody":{
"description":"Audio file to be uploaded.",
"content":{
"multipart/form-data":{
"schema":{
"type":"object",
"properties":{
"file":{
"type":"string",
"format":"binary"
}
},
"required":[
"file"
]
}
}
}
},
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.File"
}
}
}
},
"400":{
"$ref":"#/components/responses/ApiException400"
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"ivr:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":100,
"numberOfTimeUnits":0,
"timeUnit":"m"
}
]
}
},
"/voice/ctc/1/send":{
"post":{
"tags":[
"channels",
"voice",
"click-to-call"
],
"summary":"Send click-to-call message",
"description":"This method allows you to send click-to-call voice messages.",
"externalDocs":{
"description":"Learn more about click-to-call",
"url":"https://www.infobip.com/docs/voice-and-video/click-to-call"
},
"operationId":"send-click-to-call-message",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/977e3573b6848c404863a30ecae06e08186a75a9070af48acc4b4f99a371a9b7.ClickToCallApiRequest"
},
"examples":{
"Click-to-call request example":{
"summary":"Click-to-call request example",
"value":{
"bulkId":"BULK-ID-123-xyz",
"messages":[
{
"from":"41793026700",
"fromB":"41793026701",
"destinationA":"41793026727",
"destinationB":"41793026731",
"messageId":"MESSAGE-ID-123-xyz",
"text":"Test Voice message.",
"language":"en",
"voice":{
"gender":"female",
"name":"Joanna"
},
"anonymization":false,
"notifyUrl":"https://www.example.com/voice/notify",
"notifyContentType":"application/json",
"maxDuration":60,
"warningTime":5,
"retry":{
"minPeriod":1,
"maxPeriod":5,
"maxCount":5
},
"machineDetection":"hangup",
"deliveryTimeWindow":{
"days":[
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
"SUNDAY"
],
"from":{
"hour":6,
"minute":0
},
"to":{
"hour":15,
"minute":30
}
}
}
]
}
},
"Message with default language and voice":{
"summary":"Message with default language and voice",
"value":{
"messages":[
{
"from":"41793026700",
"destinationA":"41793026727",
"destinationB":"41793026731",
"text":"Hello! You are being connected to our support team. Please hold."
}
]
}
},
"Message with voice selection":{
"summary":"Message with voice selection",
"value":{
"messages":[
{
"from":"41793026700",
"destinationA":"41793026727",
"destinationB":"41793026731",
"text":"Hello! You are being connected to our support team. Please hold.",
"language":"en",
"voice":{
"gender":"female",
"name":"Joanna"
}
}
]
}
},
"German language with male voice":{
"summary":"German language with male voice",
"value":{
"messages":[
{
"from":"41793026700",
"destinationA":"41793026727",
"destinationB":"41793026731",
"text":"Hallo! Sie werden jetzt mit unserem Support-Team verbunden. Bitte warten Sie.",
"language":"de",
"voice":{
"gender":"male",
"name":"Hans"
}
}
]
}
},
"Spanish language without voice selection":{
"summary":"Spanish language without voice selection",
"value":{
"messages":[
{
"from":"41793026700",
"destinationA":"41793026727",
"destinationB":"41793026731",
"text":"Hola! Está siendo conectado con nuestro equipo de soporte. Por favor, espere.",
"language":"es"
}
]
}
},
"Audio file played before transfer":{
"summary":"Audio file played before transfer",
"value":{
"messages":[
{
"from":"41793026700",
"destinationA":"41793026727",
"destinationB":"41793026731",
"audioFileUrl":"https://www.example.com/audio/greeting.mp3"
}
]
}
},
"Anonymized call":{
"summary":"Anonymized call",
"value":{
"messages":[
{
"from":"41793026700",
"destinationA":"41793026727",
"destinationB":"41793026731",
"text":"Test Voice message.",
"anonymization":true
}
]
}
},
"Separate caller IDs for each party":{
"summary":"Separate caller IDs for each party",
"value":{
"messages":[
{
"from":"41793026700",
"fromB":"41793026701",
"destinationA":"41793026727",
"destinationB":"41793026731",
"text":"Test Voice message."
}
]
}
},
"Machine detection with hangup":{
"summary":"Machine detection with hangup",
"value":{
"messages":[
{
"from":"41793026700",
"destinationA":"41793026727",
"destinationB":"41793026731",
"text":"Connecting you now.",
"language":"en",
"machineDetection":"hangup"
}
]
}
},
"Call duration limit with warning beep":{
"summary":"Call duration limit with warning beep",
"value":{
"messages":[
{
"from":"41793026700",
"destinationA":"41793026727",
"destinationB":"41793026731",
"text":"Test Voice message.",
"maxDuration":120,
"warningTime":10
}
]
}
},
"Retry on failed delivery":{
"summary":"Retry on failed delivery",
"value":{
"messages":[
{
"from":"41793026700",
"destinationA":"41793026727",
"destinationB":"41793026731",
"text":"Test Voice message.",
"retry":{
"minPeriod":1,
"maxPeriod":10,
"maxCount":3
}
}
]
}
},
"Delivery time window restricted to business hours":{
"summary":"Delivery time window restricted to business hours",
"value":{
"messages":[
{
"from":"41793026700",
"destinationA":"41793026727",
"destinationB":"41793026731",
"text":"Test Voice message.",
"deliveryTimeWindow":{
"days":[
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY"
],
"from":{
"hour":9,
"minute":0
},
"to":{
"hour":17,
"minute":0
}
}
}
]
}
},
"Delivery report with notify URL":{
"summary":"Delivery report with notify URL",
"value":{
"messages":[
{
"from":"41793026700",
"destinationA":"41793026727",
"destinationB":"41793026731",
"text":"Test Voice message.",
"notifyUrl":"https://www.example.com/delivery-report",
"notifyContentType":"application/json"
}
]
}
},
"Bulk request with multiple messages":{
"summary":"Bulk request with multiple messages",
"value":{
"bulkId":"BULK-ID-123-xyz",
"messages":[
{
"from":"41793026700",
"destinationA":"41793026727",
"destinationB":"41793026731",
"messageId":"MSG-001",
"text":"Connecting your first call.",
"language":"en"
},
{
"from":"41793026700",
"destinationA":"41793026728",
"destinationB":"41793026732",
"messageId":"MSG-002",
"text":"Connecting your second call.",
"language":"en"
}
]
}
},
"Retry with schedule and delivery report":{
"summary":"Retry with schedule and delivery report",
"value":{
"bulkId":"BULK-ID-123-xyz",
"messages":[
{
"from":"41793026700",
"destinationA":"41793026727",
"destinationB":"41793026731",
"text":"Test Voice message.",
"notifyUrl":"https://www.example.com/delivery-report",
"notifyContentType":"application/json",
"retry":{
"minPeriod":5,
"maxPeriod":30,
"maxCount":4
},
"deliveryTimeWindow":{
"days":[
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY"
],
"from":{
"hour":8,
"minute":0
},
"to":{
"hour":20,
"minute":0
}
}
}
]
}
},
"Outbound campaign: Announcement with machine detection and retry":{
"summary":"Outbound campaign: Announcement with machine detection and retry",
"value":{
"bulkId":"BULK-ID-CAMPAIGN-001",
"messages":[
{
"from":"41793026700",
"destinationA":"41793026727",
"destinationB":"41793026731",
"messageId":"MSG-CAMPAIGN-001",
"text":"Hello! You have an incoming call from our support team. Please hold while we connect you.",
"language":"en",
"voice":{
"gender":"female",
"name":"Joanna"
},
"notifyUrl":"https://www.example.com/delivery-report",
"notifyContentType":"application/json",
"retry":{
"minPeriod":2,
"maxPeriod":20,
"maxCount":3
},
"machineDetection":"hangup"
}
]
}
},
"Timed support connection: audio greeting with duration limit and delivery report":{
"summary":"Timed support connection: audio greeting with duration limit and delivery report",
"value":{
"messages":[
{
"from":"41793026700",
"destinationA":"41793026727",
"destinationB":"41793026731",
"audioFileUrl":"https://www.example.com/audio/greeting.mp3",
"notifyUrl":"https://www.example.com/delivery-report",
"notifyContentType":"application/json",
"maxDuration":180,
"warningTime":15
}
]
}
},
"Privacy-first scheduled call: anonymized with business hours and retry":{
"summary":"Privacy-first scheduled call: anonymized with business hours and retry",
"value":{
"messages":[
{
"from":"41793026700",
"destinationA":"41793026727",
"destinationB":"41793026731",
"text":"Test Voice message.",
"anonymization":true,
"retry":{
"minPeriod":10,
"maxPeriod":60,
"maxCount":2
},
"deliveryTimeWindow":{
"days":[
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY"
],
"from":{
"hour":9,
"minute":0
},
"to":{
"hour":18,
"minute":0
}
}
}
]
}
},
"Full outbound agent connect: separate caller IDs, voice message, machine detection, and duration limit":{
"summary":"Full outbound agent connect: separate caller IDs, voice message, machine detection, and duration limit",
"value":{
"messages":[
{
"from":"41793026700",
"fromB":"41793026701",
"destinationA":"41793026727",
"destinationB":"41793026731",
"text":"Please hold, an agent will be with you shortly.",
"language":"en",
"voice":{
"gender":"female",
"name":"Joanna"
},
"notifyUrl":"https://www.example.com/delivery-report",
"notifyContentType":"application/json",
"maxDuration":300,
"warningTime":20,
"machineDetection":"hangup"
}
]
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/977e3573b6848c404863a30ecae06e08186a75a9070af48acc4b4f99a371a9b7.ClickToCallApiRequest"
},
"examples":{
"Click-to-call request example":{
"summary":"Click-to-call request example",
"value":"\n BULK-ID-123-xyz\n \n \n 41793026700\n 41793026701\n 41793026727\n 41793026731\n MESSAGE-ID-123-xyz\n Test Voice message.\n en\n \n female\n Joanna\n \n false\n https://www.example.com/voice/notify\n application/json\n 60\n 5\n \n 1\n 5\n 5\n \n hangup\n \n \n MONDAY\n TUESDAY\n WEDNESDAY\n THURSDAY\n FRIDAY\n SATURDAY\n SUNDAY\n \n \n 6\n 0\n \n \n 15\n 30\n \n \n \n \n\n"
},
"Message with default language and voice":{
"summary":"Message with default language and voice",
"value":"\n \n \n 41793026700\n 41793026727\n 41793026731\n Hello! You are being connected to our support team. Please hold.\n \n \n\n"
},
"Message with voice selection":{
"summary":"Message with voice selection",
"value":"\n \n \n 41793026700\n 41793026727\n 41793026731\n Hello! You are being connected to our support team. Please hold.\n en\n \n female\n Joanna\n \n \n \n\n"
},
"German language with male voice":{
"summary":"German language with male voice",
"value":"\n \n \n 41793026700\n 41793026727\n 41793026731\n Hallo! Sie werden jetzt mit unserem Support-Team verbunden. Bitte warten Sie.\n de\n \n male\n Hans\n \n \n \n\n"
},
"Spanish language without voice selection":{
"summary":"Spanish language without voice selection",
"value":"\n \n \n 41793026700\n 41793026727\n 41793026731\n Hola! Está siendo conectado con nuestro equipo de soporte. Por favor, espere.\n es\n \n \n\n"
},
"Audio file played before transfer":{
"summary":"Audio file played before transfer",
"value":"\n \n \n 41793026700\n 41793026727\n 41793026731\n https://www.example.com/audio/greeting.mp3\n \n \n\n"
},
"Anonymized call":{
"summary":"Anonymized call",
"value":"\n \n \n 41793026700\n 41793026727\n 41793026731\n Test Voice message.\n true\n \n \n\n"
},
"Separate caller IDs for each party":{
"summary":"Separate caller IDs for each party",
"value":"\n \n \n 41793026700\n 41793026701\n 41793026727\n 41793026731\n Test Voice message.\n \n \n\n"
},
"Machine detection with hangup":{
"summary":"Machine detection with hangup",
"value":"\n \n \n 41793026700\n 41793026727\n 41793026731\n Connecting you now.\n en\n hangup\n \n \n\n"
},
"Call duration limit with warning beep":{
"summary":"Call duration limit with warning beep",
"value":"\n \n \n 41793026700\n 41793026727\n 41793026731\n Test Voice message.\n 120\n 10\n \n \n\n"
},
"Retry on failed delivery":{
"summary":"Retry on failed delivery",
"value":"\n \n \n 41793026700\n 41793026727\n 41793026731\n Test Voice message.\n \n 1\n 10\n 3\n \n \n \n\n"
},
"Delivery time window restricted to business hours":{
"summary":"Delivery time window restricted to business hours",
"value":"\n \n \n 41793026700\n 41793026727\n 41793026731\n Test Voice message.\n \n \n MONDAY\n TUESDAY\n WEDNESDAY\n THURSDAY\n FRIDAY\n \n \n 9\n 0\n \n \n 17\n 0\n \n \n \n \n\n"
},
"Delivery report with notify URL":{
"summary":"Delivery report with notify URL",
"value":"\n \n \n 41793026700\n 41793026727\n 41793026731\n Test Voice message.\n https://www.example.com/delivery-report\n application/json\n \n \n\n"
},
"Bulk request with multiple messages":{
"summary":"Bulk request with multiple messages",
"value":"\n BULK-ID-123-xyz\n \n \n 41793026700\n 41793026727\n 41793026731\n MSG-001\n Connecting your first call.\n en\n \n \n 41793026700\n 41793026728\n 41793026732\n MSG-002\n Connecting your second call.\n en\n \n \n\n"
},
"Retry with schedule and delivery report":{
"summary":"Retry with schedule and delivery report",
"value":"\n BULK-ID-123-xyz\n \n \n 41793026700\n 41793026727\n 41793026731\n Test Voice message.\n https://www.example.com/delivery-report\n application/json\n \n 5\n 30\n 4\n \n \n \n MONDAY\n TUESDAY\n WEDNESDAY\n THURSDAY\n FRIDAY\n \n \n 8\n 0\n \n \n 20\n 0\n \n \n \n \n\n"
},
"Outbound campaign: Announcement with machine detection and retry":{
"summary":"Outbound campaign: Announcement with machine detection and retry",
"value":"\n BULK-ID-CAMPAIGN-001\n \n \n 41793026700\n 41793026727\n 41793026731\n MSG-CAMPAIGN-001\n Hello! You have an incoming call from our support team. Please hold while we connect you.\n en\n \n female\n Joanna\n \n https://www.example.com/delivery-report\n application/json\n \n 2\n 20\n 3\n \n hangup\n \n \n\n"
},
"Timed support connection: audio greeting with duration limit and delivery report":{
"summary":"Timed support connection: audio greeting with duration limit and delivery report",
"value":"\n \n \n 41793026700\n 41793026727\n 41793026731\n https://www.example.com/audio/greeting.mp3\n https://www.example.com/delivery-report\n application/json\n 180\n 15\n \n \n\n"
},
"Privacy-first scheduled call: anonymized with business hours and retry":{
"summary":"Privacy-first scheduled call: anonymized with business hours and retry",
"value":"\n \n \n 41793026700\n 41793026727\n 41793026731\n Test Voice message.\n true\n \n 10\n 60\n 2\n \n \n \n MONDAY\n TUESDAY\n WEDNESDAY\n THURSDAY\n FRIDAY\n \n \n 9\n 0\n \n \n 18\n 0\n \n \n \n \n\n"
},
"Full outbound agent connect: separate caller IDs, voice message, machine detection, and duration limit":{
"summary":"Full outbound agent connect: separate caller IDs, voice message, machine detection, and duration limit",
"value":"\n \n \n 41793026700\n 41793026701\n 41793026727\n 41793026731\n Please hold, an agent will be with you shortly.\n en\n \n female\n Joanna\n \n https://www.example.com/delivery-report\n application/json\n 300\n 20\n hangup\n \n \n\n"
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/97cb4ba23432eb0e600ef0617ae1982d499839ef41226973c71dfb335b3071b8.StandardVoiceResponse"
},
"examples":{
"Successful response example":{
"summary":"Successful response example",
"value":{
"bulkId":"4fda521a-c680-470d-b134-83d468f7ac80",
"messages":[
{
"to":"41793026727",
"status":{
"groupId":1,
"groupName":"PENDING",
"id":26,
"name":"PENDING_ACCEPTED",
"description":"Message accepted, pending for delivery."
},
"messageId":"2250be2d4219-3af1-78856-aabe-1362af1edfd2"
}
]
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/97cb4ba23432eb0e600ef0617ae1982d499839ef41226973c71dfb335b3071b8.StandardVoiceResponse"
},
"examples":{
"Successful response example":{
"summary":"Successful response example",
"value":"\n 4fda521a-c680-470d-b134-83d468f7ac80\n \n \n 41793026727\n \n 1\n PENDING\n 26\n PENDING_ACCEPTED\n Message accepted, pending for delivery.\n \n 2250be2d4219-3af1-78856-aabe-1362af1edfd2\n \n \n\n"
}
}
}
}
},
"400":{
"$ref":"#/components/responses/ApiException400"
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"message:send",
"clicktocall:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":2000,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/voice/1/reports":{
"get":{
"tags":[
"channels",
"voice",
"voice-reports-and-logs"
],
"summary":"Get Voice Delivery Reports",
"description":"This method allows you to get delivery reports for sent Voice messages, outbound IVR or Click-to-call (without notifyUrl request parameter). Delivery reports are returned only once. Additional delivery report request will return an empty collection.",
"operationId":"get-voice-delivery-reports",
"parameters":[
{
"name":"bulkId",
"in":"query",
"description":"The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination addresses.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"messageId",
"in":"query",
"description":"The ID that uniquely identifies the message sent.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"limit",
"in":"query",
"description":"The maximum number of returned delivery reports. Default value is 50.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer"
}
}
],
"responses":{
"200":{
"description":"successful response",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.ReportResponse"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":{
"results":[
{
"bulkId":"8c20f086-d82b-48cc-b2b3-3ca5f7aca9fb",
"messageId":"ff4804ef-6ab6-4abd-984d-ab3b1387e852",
"from":"385333444",
"to":"385981178",
"sentAt":"2018-06-25T13:38:14.730+0000",
"mccMnc":"21901",
"callbackData":"DLR callback data",
"voiceCall":{
"feature":"Voice-message",
"startTime":"2018-06-25T13:38:15.000+0000",
"answerTime":"2018-06-25T13:38:25.000+0000",
"endTime":"2018-06-25T13:38:28.316+0000",
"duration":10,
"chargedDuration":30,
"fileDuration":19.3,
"dtmfCodes":"3, 9",
"ivr":{
"scenarioId":"333",
"scenarioName":"Scenario name",
"collectedDtmfs":"{\"myFirstVar\":\"3\",\"mySecondVar\":\"9\"}",
"collectedMappedDtmfs":null,
"spokenInput":null,
"matchedSpokenInput":null
}
},
"price":{
"pricePerSecond":0.01,
"currency":"EUR"
},
"status":{
"groupId":3,
"groupName":"DELIVERED",
"id":5,
"name":"DELIVERED_TO_HANDSET",
"description":"Message delivered to handset"
},
"error":{
"groupId":0,
"groupName":"OK",
"id":5000,
"name":"VOICE_ANSWERED",
"description":"Call answered by human",
"permanent":true
}
}
]
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.ReportResponse"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":"\n \n \n \n \n \n 8c20f086-d82b-48cc-b2b3-3ca5f7aca9fb\n \n ff4804ef-6ab6-4abd-984d-ab3b1387e852\n \n 385333444\n \n 385981178\n \n 2018-06-25T13:38:14.730+0000\n \n 21901\n \n DLR callback data\n \n \n \n Voice-message\n \n 2018-06-25T13:38:15.000+0000\n \n 2018-06-25T13:38:25.000+0000\n \n 2018-06-25T13:38:28.316+0000\n \n 10\n \n 30\n \n 19.3\n \n 3, 9\n \n \n \n 333\n \n Scenario name\n \n {\"myFirstVar\":\"3\",\"mySecondVar\":\"9\"}\n \n \n \n \n \n \n \n \n \n \n \n \n \n 0.01\n \n EUR\n \n \n \n \n \n 3\n \n DELIVERED\n \n 5\n \n DELIVERED_TO_HANDSET\n \n Message delivered to handset\n \n \n \n \n \n 0\n \n OK\n \n 5000\n \n VOICE_ANSWERED\n \n Call answered by human\n \n true\n \n \n \n \n \n \n \n\n"
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"4XX":{
"description":"Error responses",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/31756dca18d13ab491063defb0eba5e91f72bccd700f710f44794c6f1df9c9ea.ApiException"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":{
"requestError":{
"serviceException":{
"messageId":"string",
"text":"string"
}
}
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/31756dca18d13ab491063defb0eba5e91f72bccd700f710f44794c6f1df9c9ea.ApiException"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":"\n \n \n \n \n \n String\n \n String\n \n \n \n \n \n\n"
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
},
"5XX":{
"description":"Error responses",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/31756dca18d13ab491063defb0eba5e91f72bccd700f710f44794c6f1df9c9ea.ApiException"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":{
"requestError":{
"serviceException":{
"messageId":"string",
"text":"string"
}
}
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/31756dca18d13ab491063defb0eba5e91f72bccd700f710f44794c6f1df9c9ea.ApiException"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":"\n \n \n \n \n \n String\n \n String\n \n \n \n \n \n\n"
}
}
}
}
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"voice-reports:read",
"voice:logs:read",
"message:send"
]
}
},
"/tts/3/reports":{
"get":{
"tags":[
"channels",
"voice",
"voice-reports-and-logs"
],
"summary":"Get Voice Delivery Reports",
"description":"This version is deprecated as of July 1st 2020, meaning no fixes/updates will be provided and no new parameters will be added.\n\n\n\"We strongly advise you to update to new [delivery report method](https://www.infobip.com/docs/api/channels/voice/voice-reports-and-logs/get-voice-delivery-reports).\n",
"operationId":"get-voice-delivery-reports-deprecated",
"parameters":[
{
"name":"bulkId",
"in":"query",
"description":"The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination addresses.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"messageId",
"in":"query",
"description":"The ID that uniquely identifies the message sent.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"limit",
"in":"query",
"description":"The maximum number of returned delivery reports. Default value is 50.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer"
}
}
],
"responses":{
"200":{
"description":"successful response",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.VoiceReportResponse"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":{
"results":[
{
"bulkId":"8c20f086-d82b-48cc-b2b3-3ca5f7aca9fb",
"messageId":"ff4804ef-6ab6-4abd-984d-ab3b1387e852",
"to":"385981178",
"sentAt":"2018-06-25T13:38:14.730+0000",
"doneAt":"2018-06-25T13:38:28.318+0000",
"startTime":"2018-06-25T13:38:15.000+0000",
"endTime":"2018-06-25T13:38:28.316+0000",
"answerTime":"2018-06-25T13:38:25.000+0000",
"duration":10,
"fileDuration":19.3,
"mccMnc":"21901",
"callbackData":"DLR callback data",
"dtmfCodes":"1",
"recordedAudioFileUrl":"/tts/3/files/ff4804ef-6ab6-4abd-984d-ab3b1387e852/385981178",
"price":{
"pricePerSecond":0.01,
"currency":"EUR"
},
"status":{
"groupId":3,
"groupName":"DELIVERED",
"id":5,
"name":"DELIVERED_TO_HANDSET",
"description":"Message delivered to handset"
},
"error":{
"groupId":0,
"groupName":"OK",
"id":5000,
"name":"VOICE_ANSWERED",
"description":"Call answered by human",
"permanent":true
}
}
]
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.VoiceReportResponse"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":"\n \n \n \n \n \n 8c20f086-d82b-48cc-b2b3-3ca5f7aca9fb\n \n ff4804ef-6ab6-4abd-984d-ab3b1387e852\n \n 385981178\n \n 2018-06-25T13:38:14.730+0000\n \n 2018-06-25T13:38:28.318+0000\n \n 2018-06-25T13:38:15.000+0000\n \n 2018-06-25T13:38:28.316+0000\n \n 2018-06-25T13:38:25.000+0000\n \n 10\n \n 19.3\n \n 21901\n \n DLR callback data\n \n 1\n \n /tts/3/files/ff4804ef-6ab6-4abd-984d-ab3b1387e852/385981178\n \n \n \n 0.01\n \n EUR\n \n \n \n \n \n 3\n \n DELIVERED\n \n 5\n \n DELIVERED_TO_HANDSET\n \n Message delivered to handset\n \n \n \n \n \n 0\n \n OK\n \n 5000\n \n VOICE_ANSWERED\n \n Call answered by human\n \n true\n \n \n \n \n \n \n \n\n"
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"4XX":{
"description":"Error responses",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/31756dca18d13ab491063defb0eba5e91f72bccd700f710f44794c6f1df9c9ea.ApiException"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":{
"requestError":{
"serviceException":{
"messageId":"string",
"text":"string"
}
}
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/31756dca18d13ab491063defb0eba5e91f72bccd700f710f44794c6f1df9c9ea.ApiException"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":"\n \n \n \n \n \n String\n \n String\n \n \n \n \n \n\n"
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
},
"5XX":{
"description":"Error responses",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/31756dca18d13ab491063defb0eba5e91f72bccd700f710f44794c6f1df9c9ea.ApiException"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":{
"requestError":{
"serviceException":{
"messageId":"string",
"text":"string"
}
}
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/31756dca18d13ab491063defb0eba5e91f72bccd700f710f44794c6f1df9c9ea.ApiException"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":"\n \n \n \n \n \n String\n \n String\n \n \n \n \n \n\n"
}
}
}
}
}
},
"deprecated":true,
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"voice-message:manage",
"voice-message:logs:read",
"message:send"
],
"x-deprecationInformation":{
"deprecation":"2020-07-01T00:00:00Z",
"successorOperationId":"get-voice-delivery-reports"
}
}
},
"/tts/3/logs":{
"get":{
"tags":[
"channels",
"voice",
"voice-reports-and-logs"
],
"summary":"Get sent Voice logs",
"description":"This method allows you to get logs of sent Voice messages. Voice logs are available for the last 48 hours!",
"operationId":"get-sent-voice-logs",
"parameters":[
{
"name":"from",
"in":"query",
"description":"The sender ID which can be alphanumeric or numeric.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"to",
"in":"query",
"description":"Destination address of the voice message.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"bulkId",
"in":"query",
"description":"The ID which uniquely identifies the request.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"array",
"items":{
"type":"string"
}
}
},
{
"name":"messageId",
"in":"query",
"description":"The ID that uniquely identifies the message sent.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"array",
"items":{
"type":"string"
}
}
},
{
"name":"generalStatus",
"in":"query",
"description":"Sent voice message status group. Indicates whether the message has been successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.IpCoreGeneralStatus"
}
},
{
"name":"sentSince",
"in":"query",
"description":"Lower limit on date and time of sending a Voice message. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"format":"date-time"
}
},
{
"name":"sentUntil",
"in":"query",
"description":"Upper limit on date and time of sending a Voice message. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"format":"date-time"
}
},
{
"name":"limit",
"in":"query",
"description":"Maximal number of messages in the returned logs. Default value is 50.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32"
}
},
{
"name":"mcc",
"in":"query",
"description":"Mobile country code.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"mnc",
"in":"query",
"description":"Mobile network code.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"successful response",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.LogsResponse"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":{
"results":[
{
"bulkId":"06479ba3-5977-47f6-9346-fee0369bc76b",
"messageId":"1f21d8d7-f306-4f53-9f6e-eddfce9849ea",
"to":"41793026727",
"from":"41793026700",
"text":"Test voice message.",
"sentAt":"2023-08-10T07:36:42.187+0000",
"doneAt":"2023-08-10T07:36:43.194+0000",
"duration":10,
"mccMnc":"22801",
"price":{
"pricePerSecond":0.01,
"currency":"EUR"
},
"status":{
"groupId":3,
"groupName":"DELIVERED",
"id":5,
"name":"DELIVERED_TO_HANDSET",
"description":"Message delivered to handset"
},
"error":{
"groupId":0,
"groupName":"OK",
"id":5003,
"name":"EC_VOICE_NO_ANSWER",
"description":"User was notified, but did not answer call",
"permanent":true
}
}
]
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.LogsResponse"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":"\n \n \n \n \n \n 06479ba3-5977-47f6-9346-fee0369bc76b\n \n 1f21d8d7-f306-4f53-9f6e-eddfce9849ea\n \n 41793026727\n \n 41793026700\n \n Test voice message.\n \n 2023-08-10T07:36:42.187+0000\n \n 2023-08-10T07:36:43.194+0000\n \n 10\n \n 22801\n \n \n \n 0.01\n \n EUR\n \n \n \n \n \n 3\n \n DELIVERED\n \n 5\n \n DELIVERED_TO_HANDSET\n \n Message delivered to handset\n \n \n \n \n \n 0\n \n OK\n \n 5003\n \n EC_VOICE_NO_ANSWER\n \n User was notified, but did not answer call\n \n true\n \n \n \n \n \n \n \n\n"
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"4XX":{
"description":"Error responses",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/31756dca18d13ab491063defb0eba5e91f72bccd700f710f44794c6f1df9c9ea.ApiException"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":{
"requestError":{
"serviceException":{
"messageId":"string",
"text":"string"
}
}
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/31756dca18d13ab491063defb0eba5e91f72bccd700f710f44794c6f1df9c9ea.ApiException"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":"\n \n \n \n \n \n String\n \n String\n \n \n \n \n \n\n"
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
},
"5XX":{
"description":"Error responses",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/31756dca18d13ab491063defb0eba5e91f72bccd700f710f44794c6f1df9c9ea.ApiException"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":{
"requestError":{
"serviceException":{
"messageId":"string",
"text":"string"
}
}
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/31756dca18d13ab491063defb0eba5e91f72bccd700f710f44794c6f1df9c9ea.ApiException"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":"\n \n \n \n \n \n String\n \n String\n \n \n \n \n \n\n"
}
}
}
}
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"voice-message:manage",
"voice-message:logs:read",
"message:send"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":120,
"numberOfTimeUnits":0,
"timeUnit":"m"
}
]
}
},
"/voice/masking/2/config":{
"get":{
"tags":[
"channels",
"voice",
"number-masking",
"number-masking-configurations"
],
"summary":"Get number masking configurations",
"description":"This method allows you to get all voice number masking configurations.",
"operationId":"get-number-masking-configurations",
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/2f772c02a4c3391667bfa54680f8db54477fb2b9100309bf0d515e4ee848facc.SetupResponse"
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ac429fcfd24f9a7e1a25e07a88be90c98df1692e2811a989e35dc3301ebb4715.ApiException"
},
"examples":{
"Configurations not found":{
"summary":"Configurations not found",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Masking configurations not found."
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"numbermasking:manage"
]
},
"post":{
"tags":[
"channels",
"voice",
"number-masking",
"number-masking-configurations"
],
"summary":"Create number masking configuration",
"description":"This method allows you to create masking configuration.",
"operationId":"create-number-masking-configuration",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/2f772c02a4c3391667bfa54680f8db54477fb2b9100309bf0d515e4ee848facc.SetupBody"
},
"examples":{
"Request example":{
"summary":"Request example",
"value":{
"name":"UniqueConfigurationName",
"callbackUrl":"https://example.com/1/callback",
"statusUrl":"https://example.com/1/status"
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/2f772c02a4c3391667bfa54680f8db54477fb2b9100309bf0d515e4ee848facc.SetupResponse"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":{
"key":"3FC0C9CB4AFAEAC67E8FC6BA3B1E044A",
"name":"UniqueConfigurationName",
"callbackUrl":"https://example.com/1/callback",
"statusUrl":"https://example.com/1/status",
"insertDateTime":"2019-08-16T09:11:36.573",
"updateDateTime":"2019-08-16T09:11:36.573"
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ac429fcfd24f9a7e1a25e07a88be90c98df1692e2811a989e35dc3301ebb4715.ApiException"
},
"examples":{
"Invalid setup body":{
"summary":"Invalid setup body",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request",
"validationErrors":{
"name":[
"Setup name is required."
]
}
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"numbermasking:manage"
]
}
},
"/voice/masking/2/config/{key}":{
"get":{
"tags":[
"channels",
"voice",
"number-masking",
"number-masking-configurations"
],
"summary":"Get number masking configuration",
"description":"This method allows you to get a Voice number masking configuration.",
"operationId":"get-number-masking-configuration",
"parameters":[
{
"name":"key",
"in":"path",
"description":"Masking configuration identifier.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/2f772c02a4c3391667bfa54680f8db54477fb2b9100309bf0d515e4ee848facc.SetupResponse"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":{
"key":"3FC0C9CB4AFAEAC67E8FC6BA3B1E044A",
"name":"UniqueConfigurationName",
"callbackUrl":"https://example.com/1/callback",
"statusUrl":"https://example.com/1/status",
"insertDateTime":"2019-08-16T09:11:36.573",
"updateDateTime":"2019-08-16T09:11:36.573"
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ac429fcfd24f9a7e1a25e07a88be90c98df1692e2811a989e35dc3301ebb4715.ApiException"
},
"examples":{
"Invalid key":{
"summary":"Invalid key",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Make sure you provided a valid key parameter."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ac429fcfd24f9a7e1a25e07a88be90c98df1692e2811a989e35dc3301ebb4715.ApiException"
},
"examples":{
"Configuration not found":{
"summary":"Configuration not found",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Masking configuration not found."
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"numbermasking:manage"
]
},
"put":{
"tags":[
"channels",
"voice",
"number-masking",
"number-masking-configurations"
],
"summary":"Update number masking configuration",
"description":"This method allows you to update a Voice number masking configuration.",
"operationId":"update-number-masking-configuration",
"parameters":[
{
"name":"key",
"in":"path",
"description":"Masking configuration identifier.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/2f772c02a4c3391667bfa54680f8db54477fb2b9100309bf0d515e4ee848facc.SetupBody"
},
"examples":{
"Request example":{
"summary":"Request example",
"value":{
"name":"UniqueConfigurationName",
"callbackUrl":"https://example.com/1/callback",
"statusUrl":"https://example.com/1/status"
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/2f772c02a4c3391667bfa54680f8db54477fb2b9100309bf0d515e4ee848facc.SetupResponse"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":{
"key":"3FC0C9CB4AFAEAC67E8FC6BA3B1E044A",
"name":"UniqueConfigurationName",
"callbackUrl":"https://example.com/1/callback",
"statusUrl":"https://example.com/1/status",
"insertDateTime":"2019-08-16T09:11:36.573",
"updateDateTime":"2019-08-16T09:11:36.573"
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ac429fcfd24f9a7e1a25e07a88be90c98df1692e2811a989e35dc3301ebb4715.ApiException"
},
"examples":{
"Invalid setup body":{
"summary":"Invalid setup body",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request",
"validationErrors":{
"name":[
"Setup name is required."
]
}
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ac429fcfd24f9a7e1a25e07a88be90c98df1692e2811a989e35dc3301ebb4715.ApiException"
},
"examples":{
"Configuration not found":{
"summary":"Configuration not found",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Masking configuration not found."
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"numbermasking:manage"
]
},
"delete":{
"tags":[
"channels",
"voice",
"number-masking",
"number-masking-configurations"
],
"summary":"Delete number masking configuration",
"description":"This method allows you to delete a Voice number masking configuration.",
"operationId":"delete-number-masking-configuration",
"parameters":[
{
"name":"key",
"in":"path",
"description":"Masking configuration identifier.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK"
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ac429fcfd24f9a7e1a25e07a88be90c98df1692e2811a989e35dc3301ebb4715.ApiException"
},
"examples":{
"Invalid key":{
"summary":"Invalid key",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Make sure you provided a valid key parameter."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ac429fcfd24f9a7e1a25e07a88be90c98df1692e2811a989e35dc3301ebb4715.ApiException"
},
"examples":{
"Configuration not found":{
"summary":"Configuration not found",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Masking configuration not found."
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"numbermasking:manage"
]
}
},
"/voice/masking/1/upload":{
"post":{
"tags":[
"channels",
"voice",
"number-masking",
"number-masking-configurations"
],
"summary":"Upload audio files",
"description":"This method allows uploading audio files that can be used on Infobip Voice platform. The method accepts either a URL or an uploaded audio file in the request body. Using both or neither will cause the request to be rejected.",
"operationId":"upload-audio-files",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9ecece8e0bfcbe5cd4fc1dd17fb7c9f9ae92bd39a74bbe56daee9e0629666e59.UploadBody"
},
"examples":{
"Using URL to audio file":{
"summary":"Using URL to audio file",
"value":{
"url":"https://example.com/audio.mp3"
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9ecece8e0bfcbe5cd4fc1dd17fb7c9f9ae92bd39a74bbe56daee9e0629666e59.UploadResponse"
},
"examples":{
"Upload file response":{
"summary":"Upload file response",
"value":{
"fileId":"cb702ae4-f356-4efd-b2dd-7a667b570af5"
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ac429fcfd24f9a7e1a25e07a88be90c98df1692e2811a989e35dc3301ebb4715.ApiException"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"numbermasking:manage"
]
}
},
"/voice/masking/2/credentials":{
"get":{
"tags":[
"channels",
"voice",
"number-masking",
"number-masking-credentials"
],
"summary":"Get number masking credentials",
"description":"This method allows you to get Voice number masking credentials.",
"operationId":"get-number-masking-credentials",
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/56fc13d85fd8c7d40ac0157103bb5ccebc0bb2862850603cc2c5a808276f4742.CredentialsResponse"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":{
"apiId":"55ddccad2df62a4b615b7e3c472b2ab6",
"key":"5da086b6a8e4424993646b8699c333ca"
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ac429fcfd24f9a7e1a25e07a88be90c98df1692e2811a989e35dc3301ebb4715.ApiException"
},
"examples":{
"Credentials not found":{
"summary":"Credentials not found",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Credentials not found."
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"numbermasking:manage"
]
},
"put":{
"tags":[
"channels",
"voice",
"number-masking",
"number-masking-credentials"
],
"summary":"Update number masking credentials",
"description":"This method allows you to update Voice number masking credentials.",
"operationId":"update-number-masking-credentials",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/56fc13d85fd8c7d40ac0157103bb5ccebc0bb2862850603cc2c5a808276f4742.CredentialsBody"
},
"examples":{
"Request example":{
"summary":"Request example",
"value":{
"apiId":"55ddccad2df62a4b615b7e3c472b2ab6",
"key":"5da086b6a8e4424993646b8699c333ca"
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/56fc13d85fd8c7d40ac0157103bb5ccebc0bb2862850603cc2c5a808276f4742.CredentialsResponse"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":{
"apiId":"55ddccad2df62a4b615b7e3c472b2ab6",
"key":"5da086b6a8e4424993646b8699c333ca"
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ac429fcfd24f9a7e1a25e07a88be90c98df1692e2811a989e35dc3301ebb4715.ApiException"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"numbermasking:manage"
]
},
"post":{
"tags":[
"channels",
"voice",
"number-masking",
"number-masking-credentials"
],
"summary":"Create number masking credentials",
"description":"This method allows you to create Voice number masking credentials.",
"operationId":"create-number-masking-credentials",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/56fc13d85fd8c7d40ac0157103bb5ccebc0bb2862850603cc2c5a808276f4742.CredentialsBody"
},
"examples":{
"Request example":{
"summary":"Request example",
"value":{
"apiId":"55ddccad2df62a4b615b7e3c472b2ab6",
"key":"5da086b6a8e4424993646b8699c333ca"
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/56fc13d85fd8c7d40ac0157103bb5ccebc0bb2862850603cc2c5a808276f4742.CredentialsResponse"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":{
"apiId":"55ddccad2df62a4b615b7e3c472b2ab6",
"key":"5da086b6a8e4424993646b8699c333ca"
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ac429fcfd24f9a7e1a25e07a88be90c98df1692e2811a989e35dc3301ebb4715.ApiException"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"409":{
"description":"Conflict",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ac429fcfd24f9a7e1a25e07a88be90c98df1692e2811a989e35dc3301ebb4715.ApiException"
},
"examples":{
"Credentials already exist":{
"summary":"Credentials already exist",
"value":{
"requestError":{
"serviceException":{
"messageId":"FORBIDDEN",
"text":"Credentials already exist."
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"numbermasking:manage"
]
},
"delete":{
"tags":[
"channels",
"voice",
"number-masking",
"number-masking-credentials"
],
"summary":"Delete number masking credentials",
"description":"This method allows you to delete Voice number masking credentials.",
"operationId":"delete-number-masking-credentials",
"responses":{
"204":{
"description":"No Content"
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ac429fcfd24f9a7e1a25e07a88be90c98df1692e2811a989e35dc3301ebb4715.ApiException"
},
"examples":{
"Credentials not found":{
"summary":"Credentials not found",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Credentials not found."
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"numbermasking:manage"
]
}
},
"/callrouting/1/routes":{
"get":{
"tags":[
"channels",
"voice",
"routing",
"call-routing-configurations"
],
"summary":"Get call routes",
"description":"Get existing call routes with pagination.",
"operationId":"get-call-routes",
"parameters":[
{
"name":"nameContains",
"in":"query",
"description":"String contained in the name of the route, case-insensitive.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"maxLength":255
}
},
{
"name":"page",
"in":"query",
"description":"Results page to retrieve (0..N).",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":0,
"minimum":0
}
},
{
"name":"size",
"in":"query",
"description":"Number of records per page.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":20,
"maximum":100,
"minimum":1
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/5cb8669321a9b28a95445a23a292423b19c28f831eda62032aef9c6b53da7813.RouteResponsePage"
},
"examples":{
"Route response page example":{
"summary":"Route response page example",
"description":"Example of a page of route responses that includes route with Phone destination and Route with SIP destination.",
"value":{
"results":[
{
"id":"f8fc8aca-786d-4943-9af2-e7ec01b5e80d",
"name":"SIP endpoint route",
"destinations":[
{
"value":{
"username":"41793026834",
"sipTrunkId":"string",
"customHeaders":{
"string":"string"
},
"type":"SIP"
},
"connectTimeout":30,
"recording":{
"recordingType":"AUDIO",
"recordingComposition":{
"enabled":true
},
"customData":{
"string":"string"
},
"filePrefix":"string"
},
"type":"ENDPOINT"
}
],
"transferOnly":false
},
{
"id":"f8fc8aca-786d-4943-9af2-e7ec01b5e80d",
"name":"Phone endpoint route",
"destinations":[
{
"value":{
"phoneNumber":"41793026834",
"type":"PHONE"
},
"connectTimeout":30,
"recording":{
"recordingType":"AUDIO",
"recordingComposition":{
"enabled":true
},
"customData":{
"string":"string"
},
"filePrefix":"string"
},
"type":"ENDPOINT"
}
],
"transferOnly":false
}
],
"paging":{
"page":0,
"size":20,
"totalPages":1,
"totalResults":2
}
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.ApiError"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request",
"validationErrors":{
"field":[
"field must not be null"
]
}
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"property.path",
"violation":"Violation message."
}
],
"resources":[]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"callrouting:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":50,
"numberOfTimeUnits":0,
"timeUnit":"m"
}
]
},
"post":{
"tags":[
"channels",
"voice",
"routing",
"call-routing-configurations"
],
"summary":"Create a call route",
"description":"Create a new call route.",
"operationId":"create-call-route",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/1e938b22275568ebc747d21724b50c9be18ff5770eb33c37b76fda4633c14bde.RouteRequest"
},
"examples":{
"Route with a SIP endpoint destination":{
"summary":"Route with a SIP endpoint destination",
"value":{
"name":"Route with a SIP endpoint destination",
"destinations":[
{
"value":{
"username":"41793026834",
"sipTrunkId":"60d345fd3a799ec",
"customHeaders":{
"Header-Name":"header value"
},
"type":"SIP"
},
"connectTimeout":30,
"recording":{
"recordingType":"AUDIO",
"recordingComposition":{
"enabled":true
},
"customData":{
"key1":"value1"
},
"filePrefix":"rec"
},
"type":"ENDPOINT"
}
],
"transferOnly":false
}
},
"Route with a phone endpoint destination":{
"summary":"Route with a phone endpoint destination",
"value":{
"name":"Route with a phone endpoint destination",
"destinations":[
{
"value":{
"phoneNumber":"41793026834",
"type":"PHONE"
},
"connectTimeout":30,
"recording":{
"recordingType":"AUDIO",
"recordingComposition":{
"enabled":true
},
"customData":{
"key1":"value1"
},
"filePrefix":"rec"
},
"type":"ENDPOINT"
}
],
"transferOnly":false
}
},
"Route with a SIP endpoint destination with failover to a phone endpoint destination":{
"summary":"Route with a SIP endpoint destination with failover to a phone endpoint destination",
"value":{
"name":"Route with a SIP endpoint destination with failover to a phone endpoint destination",
"destinations":[
{
"value":{
"username":"41793026834",
"sipTrunkId":"60d345fd3a799ec",
"customHeaders":{
"Header-Name":"header value"
},
"type":"SIP"
},
"connectTimeout":30,
"recording":{
"recordingType":"AUDIO",
"recordingComposition":{
"enabled":true
},
"customData":{
"key1":"value1"
},
"filePrefix":"rec"
},
"type":"ENDPOINT"
},
{
"value":{
"phoneNumber":"41793026834",
"type":"PHONE"
},
"connectTimeout":30,
"recording":{
"recordingType":"AUDIO",
"recordingComposition":{
"enabled":true
},
"customData":{
"key1":"value1"
},
"filePrefix":"rec"
},
"type":"ENDPOINT"
}
],
"transferOnly":false
}
},
"Route with an URL endpoint destination":{
"summary":"Route with an URL endpoint destination",
"value":{
"name":"Route with an URL endpoint destination",
"destinations":[
{
"url":"https://www.example.com",
"securityConfig":{
"username":"user",
"type":"BASIC"
},
"type":"URL"
}
],
"transferOnly":false
}
},
"Route with two SIP endpoints destinations in round-robin configuration":{
"summary":"Route with two SIP endpoints destinations in round-robin configuration",
"value":{
"name":"Route with two SIP endpoints destinations in round-robin configuration",
"destinations":[
{
"value":{
"username":"41793026834",
"sipTrunkId":"60d345fd3a799ec",
"customHeaders":{
"Header-Name":"header value"
},
"type":"SIP"
},
"priority":1,
"weight":50,
"type":"ENDPOINT"
},
{
"value":{
"username":"41793026834",
"sipTrunkId":"92d871fj8i802ip",
"customHeaders":{
"key1":"value1"
},
"type":"SIP"
},
"priority":1,
"weight":50,
"type":"ENDPOINT"
}
],
"transferOnly":false
}
},
"Route with a PHONE search criteria":{
"summary":"Route with a PHONE search criteria",
"value":{
"name":"Route with a PHONE search criteria",
"criteria":[
{
"to":"41793(.+)",
"value":{
"from":"41793(.+)",
"type":"PHONE"
}
}
],
"destinations":[
{
"value":{
"username":"41793026834",
"sipTrunkId":"60d345fd3a799ec",
"customHeaders":{
"Header-Name":"header value"
},
"type":"SIP"
},
"connectTimeout":30,
"recording":{
"recordingType":"AUDIO",
"recordingComposition":{
"enabled":true
},
"customData":{
"key1":"value1"
},
"filePrefix":"rec"
},
"type":"ENDPOINT"
}
],
"transferOnly":false
}
},
"Route with a SIP search criteria":{
"summary":"Route with a SIP search criteria",
"value":{
"name":"Route with a SIP search criteria",
"criteria":[
{
"to":"41793(.+)",
"value":{
"sipTrunkId":"60d345fd3a799ec",
"username":"41793(.+)",
"headers":[
{
"headerName":"X-Header-Name",
"headerValue":"41793(.+)"
}
],
"type":"SIP"
}
}
],
"destinations":[
{
"value":{
"username":"41793026834",
"sipTrunkId":"60d345fd3a799ec",
"customHeaders":{
"X-Identity":"john.doe"
},
"type":"SIP"
},
"connectTimeout":30,
"recording":{
"recordingType":"AUDIO",
"recordingComposition":{
"enabled":true
},
"customData":{
"key1":"value1"
},
"filePrefix":"rec"
},
"type":"ENDPOINT"
}
],
"transferOnly":false
}
},
"Route with a WebRTC search criteria":{
"summary":"Route with a WebRTC search criteria",
"value":{
"name":"Route with a WebRTC search criteria",
"criteria":[
{
"value":{
"type":"WEBRTC"
}
}
],
"destinations":[
{
"value":{
"username":"41793026834",
"sipTrunkId":"60d345fd3a799ec",
"customHeaders":{
"Header-Name":"header value"
},
"type":"SIP"
},
"connectTimeout":30,
"recording":{
"recordingType":"AUDIO",
"recordingComposition":{
"enabled":true
},
"customData":{
"key1":"value1"
},
"filePrefix":"rec"
},
"type":"ENDPOINT"
}
],
"transferOnly":false
}
}
}
}
},
"required":true
},
"responses":{
"201":{
"description":"Route Successfully Created",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/1e938b22275568ebc747d21724b50c9be18ff5770eb33c37b76fda4633c14bde.RouteResponse"
},
"examples":{
"Route with a SIP endpoint destination":{
"summary":"Route with a SIP endpoint destination",
"value":{
"id":"f8fc8aca-786d-4943-9af2-e7ec01b5e80d",
"name":"Sample Route Name",
"destinations":[
{
"value":{
"username":"41793026834",
"sipTrunkId":"string",
"customHeaders":{
"X-Header-Name":"header value"
},
"type":"SIP"
},
"connectTimeout":30,
"recording":{
"recordingType":"AUDIO",
"recordingComposition":{
"enabled":true
},
"customData":{
"key1":"value1"
},
"filePrefix":"recording"
},
"type":"ENDPOINT"
}
],
"status":"ENABLED",
"order":1,
"transferOnly":false
}
},
"Route with a phone endpoint destination":{
"summary":"Route with a phone endpoint destination",
"value":{
"id":"f8fc8aca-786d-4943-9af2-e7ec01b5e80d",
"name":"Sample Route Name",
"destinations":[
{
"value":{
"phoneNumber":"41793026834",
"type":"PHONE"
},
"connectTimeout":30,
"recording":{
"recordingType":"AUDIO",
"recordingComposition":{
"enabled":true
},
"customData":{
"key1":"value1"
},
"filePrefix":"recording"
},
"type":"ENDPOINT"
}
],
"status":"ENABLED",
"order":1,
"transferOnly":false
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.ApiError"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"create.route.destinations[0].value.sipTrunkId must not be blank"
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"property.path",
"violation":"Violation message."
}
],
"resources":[]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"callrouting:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":50,
"numberOfTimeUnits":0,
"timeUnit":"m"
}
]
}
},
"/callrouting/1/routes/{routeId}":{
"get":{
"tags":[
"channels",
"voice",
"routing",
"call-routing-configurations"
],
"summary":"Get a call route",
"description":"Get an existing call route.",
"operationId":"get-call-route",
"parameters":[
{
"name":"routeId",
"in":"path",
"description":"Route identifier",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"56b3e3ea-e91f-44ed-9d57-c7f05cd358ba"
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/1e938b22275568ebc747d21724b50c9be18ff5770eb33c37b76fda4633c14bde.RouteResponse"
},
"examples":{
"Route with a SIP endpoint destination":{
"summary":"Route with a SIP endpoint destination",
"value":{
"id":"f8fc8aca-786d-4943-9af2-e7ec01b5e80d",
"name":"Sample Route Name",
"destinations":[
{
"value":{
"username":"41793026834",
"sipTrunkId":"string",
"customHeaders":{
"X-Header-Name":"header value"
},
"type":"SIP"
},
"connectTimeout":30,
"recording":{
"recordingType":"AUDIO",
"recordingComposition":{
"enabled":true
},
"customData":{
"key1":"value1"
},
"filePrefix":"recording"
},
"type":"ENDPOINT"
}
],
"status":"ENABLED",
"order":1,
"transferOnly":false
}
},
"Route with a phone endpoint destination":{
"summary":"Route with a phone endpoint destination",
"value":{
"id":"f8fc8aca-786d-4943-9af2-e7ec01b5e80d",
"name":"Sample Route Name",
"destinations":[
{
"value":{
"phoneNumber":"41793026834",
"type":"PHONE"
},
"connectTimeout":30,
"recording":{
"recordingType":"AUDIO",
"recordingComposition":{
"enabled":true
},
"customData":{
"key1":"value1"
},
"filePrefix":"recording"
},
"type":"ENDPOINT"
}
],
"status":"ENABLED",
"order":1,
"transferOnly":false
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.ApiError"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Not found"
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"callrouting:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":50,
"numberOfTimeUnits":0,
"timeUnit":"m"
}
]
},
"put":{
"tags":[
"channels",
"voice",
"routing",
"call-routing-configurations"
],
"summary":"Update a call route",
"description":"Update an already existing call route. Fields that are not sent in the request body will take default values and overwrite existing ones.",
"operationId":"update-call-route",
"parameters":[
{
"name":"routeId",
"in":"path",
"description":"Route identifier",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"56b3e3ea-e91f-44ed-9d57-c7f05cd358ba"
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/1e938b22275568ebc747d21724b50c9be18ff5770eb33c37b76fda4633c14bde.RouteRequest"
},
"examples":{
"Route with a SIP endpoint destination":{
"summary":"Route with a SIP endpoint destination",
"value":{
"name":"Route with a SIP endpoint destination",
"destinations":[
{
"value":{
"username":"41793026834",
"sipTrunkId":"60d345fd3a799ec",
"customHeaders":{
"Header-Name":"header value"
},
"type":"SIP"
},
"connectTimeout":30,
"recording":{
"recordingType":"AUDIO",
"recordingComposition":{
"enabled":true
},
"customData":{
"key1":"value1"
},
"filePrefix":"rec"
},
"type":"ENDPOINT"
}
],
"transferOnly":false
}
},
"Route with a phone endpoint destination":{
"summary":"Route with a phone endpoint destination",
"value":{
"name":"Route with a phone endpoint destination",
"destinations":[
{
"value":{
"phoneNumber":"41793026834",
"type":"PHONE"
},
"connectTimeout":30,
"recording":{
"recordingType":"AUDIO",
"recordingComposition":{
"enabled":true
},
"customData":{
"key1":"value1"
},
"filePrefix":"rec"
},
"type":"ENDPOINT"
}
],
"transferOnly":false
}
},
"Route with a SIP endpoint destination with failover to a phone endpoint destination":{
"summary":"Route with a SIP endpoint destination with failover to a phone endpoint destination",
"value":{
"name":"Route with a SIP endpoint destination with failover to a phone endpoint destination",
"destinations":[
{
"value":{
"username":"41793026834",
"sipTrunkId":"60d345fd3a799ec",
"customHeaders":{
"Header-Name":"header value"
},
"type":"SIP"
},
"connectTimeout":30,
"recording":{
"recordingType":"AUDIO",
"recordingComposition":{
"enabled":true
},
"customData":{
"key1":"value1"
},
"filePrefix":"rec"
},
"type":"ENDPOINT"
},
{
"value":{
"phoneNumber":"41793026834",
"type":"PHONE"
},
"connectTimeout":30,
"recording":{
"recordingType":"AUDIO",
"recordingComposition":{
"enabled":true
},
"customData":{
"key1":"value1"
},
"filePrefix":"rec"
},
"type":"ENDPOINT"
}
],
"transferOnly":false
}
},
"Route with an URL endpoint destination":{
"summary":"Route with an URL endpoint destination",
"value":{
"name":"Route with an URL endpoint destination",
"destinations":[
{
"url":"https://www.example.com",
"securityConfig":{
"username":"user",
"type":"BASIC"
},
"type":"URL"
}
],
"transferOnly":false
}
},
"Route with two SIP endpoints destinations in round-robin configuration":{
"summary":"Route with two SIP endpoints destinations in round-robin configuration",
"value":{
"name":"Route with two SIP endpoints destinations in round-robin configuration",
"destinations":[
{
"value":{
"username":"41793026834",
"sipTrunkId":"60d345fd3a799ec",
"customHeaders":{
"Header-Name":"header value"
},
"type":"SIP"
},
"priority":1,
"weight":50,
"type":"ENDPOINT"
},
{
"value":{
"username":"41793026834",
"sipTrunkId":"92d871fj8i802ip",
"customHeaders":{
"key1":"value1"
},
"type":"SIP"
},
"priority":1,
"weight":50,
"type":"ENDPOINT"
}
],
"transferOnly":false
}
},
"Route with a PHONE search criteria":{
"summary":"Route with a PHONE search criteria",
"value":{
"name":"Route with a PHONE search criteria",
"criteria":[
{
"to":"41793(.+)",
"value":{
"from":"41793(.+)",
"type":"PHONE"
}
}
],
"destinations":[
{
"value":{
"username":"41793026834",
"sipTrunkId":"60d345fd3a799ec",
"customHeaders":{
"Header-Name":"header value"
},
"type":"SIP"
},
"connectTimeout":30,
"recording":{
"recordingType":"AUDIO",
"recordingComposition":{
"enabled":true
},
"customData":{
"key1":"value1"
},
"filePrefix":"rec"
},
"type":"ENDPOINT"
}
],
"transferOnly":false
}
},
"Route with a SIP search criteria":{
"summary":"Route with a SIP search criteria",
"value":{
"name":"Route with a SIP search criteria",
"criteria":[
{
"to":"41793(.+)",
"value":{
"sipTrunkId":"60d345fd3a799ec",
"username":"41793(.+)",
"headers":[
{
"headerName":"X-Header-Name",
"headerValue":"41793(.+)"
}
],
"type":"SIP"
}
}
],
"destinations":[
{
"value":{
"username":"41793026834",
"sipTrunkId":"60d345fd3a799ec",
"customHeaders":{
"X-Identity":"john.doe"
},
"type":"SIP"
},
"connectTimeout":30,
"recording":{
"recordingType":"AUDIO",
"recordingComposition":{
"enabled":true
},
"customData":{
"key1":"value1"
},
"filePrefix":"rec"
},
"type":"ENDPOINT"
}
],
"transferOnly":false
}
},
"Route with a WebRTC search criteria":{
"summary":"Route with a WebRTC search criteria",
"value":{
"name":"Route with a WebRTC search criteria",
"criteria":[
{
"value":{
"type":"WEBRTC"
}
}
],
"destinations":[
{
"value":{
"username":"41793026834",
"sipTrunkId":"60d345fd3a799ec",
"customHeaders":{
"Header-Name":"header value"
},
"type":"SIP"
},
"connectTimeout":30,
"recording":{
"recordingType":"AUDIO",
"recordingComposition":{
"enabled":true
},
"customData":{
"key1":"value1"
},
"filePrefix":"rec"
},
"type":"ENDPOINT"
}
],
"transferOnly":false
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/1e938b22275568ebc747d21724b50c9be18ff5770eb33c37b76fda4633c14bde.RouteResponse"
},
"examples":{
"Route with a SIP endpoint destination":{
"summary":"Route with a SIP endpoint destination",
"value":{
"id":"f8fc8aca-786d-4943-9af2-e7ec01b5e80d",
"name":"Sample Route Name",
"destinations":[
{
"value":{
"username":"41793026834",
"sipTrunkId":"string",
"customHeaders":{
"X-Header-Name":"header value"
},
"type":"SIP"
},
"connectTimeout":30,
"recording":{
"recordingType":"AUDIO",
"recordingComposition":{
"enabled":true
},
"customData":{
"key1":"value1"
},
"filePrefix":"recording"
},
"type":"ENDPOINT"
}
],
"status":"ENABLED",
"order":1,
"transferOnly":false
}
},
"Route with a phone endpoint destination":{
"summary":"Route with a phone endpoint destination",
"value":{
"id":"f8fc8aca-786d-4943-9af2-e7ec01b5e80d",
"name":"Sample Route Name",
"destinations":[
{
"value":{
"phoneNumber":"41793026834",
"type":"PHONE"
},
"connectTimeout":30,
"recording":{
"recordingType":"AUDIO",
"recordingComposition":{
"enabled":true
},
"customData":{
"key1":"value1"
},
"filePrefix":"recording"
},
"type":"ENDPOINT"
}
],
"status":"ENABLED",
"order":1,
"transferOnly":false
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.ApiError"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request",
"validationErrors":{
"field":[
"field must not be null"
]
}
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"property.path",
"violation":"Violation message."
}
],
"resources":[]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.ApiError"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Not found"
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"callrouting:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":50,
"numberOfTimeUnits":0,
"timeUnit":"m"
}
]
},
"delete":{
"tags":[
"channels",
"voice",
"routing",
"call-routing-configurations"
],
"summary":"Delete a call route",
"description":"Delete an existing call route.",
"operationId":"delete-call-route",
"parameters":[
{
"name":"routeId",
"in":"path",
"description":"Route identifier",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"56b3e3ea-e91f-44ed-9d57-c7f05cd358ba"
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/1e938b22275568ebc747d21724b50c9be18ff5770eb33c37b76fda4633c14bde.RouteResponse"
},
"examples":{
"Route with a SIP endpoint destination":{
"summary":"Route with a SIP endpoint destination",
"value":{
"id":"f8fc8aca-786d-4943-9af2-e7ec01b5e80d",
"name":"Sample Route Name",
"destinations":[
{
"value":{
"username":"41793026834",
"sipTrunkId":"string",
"customHeaders":{
"X-Header-Name":"header value"
},
"type":"SIP"
},
"connectTimeout":30,
"recording":{
"recordingType":"AUDIO",
"recordingComposition":{
"enabled":true
},
"customData":{
"key1":"value1"
},
"filePrefix":"recording"
},
"type":"ENDPOINT"
}
],
"status":"ENABLED",
"order":1,
"transferOnly":false
}
},
"Route with a phone endpoint destination":{
"summary":"Route with a phone endpoint destination",
"value":{
"id":"f8fc8aca-786d-4943-9af2-e7ec01b5e80d",
"name":"Sample Route Name",
"destinations":[
{
"value":{
"phoneNumber":"41793026834",
"type":"PHONE"
},
"connectTimeout":30,
"recording":{
"recordingType":"AUDIO",
"recordingComposition":{
"enabled":true
},
"customData":{
"key1":"value1"
},
"filePrefix":"recording"
},
"type":"ENDPOINT"
}
],
"status":"ENABLED",
"order":1,
"transferOnly":false
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.ApiError"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Not found"
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"callrouting:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":50,
"numberOfTimeUnits":0,
"timeUnit":"m"
}
]
},
"patch":{
"tags":[
"channels",
"voice",
"routing",
"call-routing-configurations"
],
"summary":"Set order on call route",
"description":"Set order on existing call route.",
"operationId":"set-order-call-route",
"parameters":[
{
"name":"routeId",
"in":"path",
"description":"Route identifier",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"56b3e3ea-e91f-44ed-9d57-c7f05cd358ba"
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/1e938b22275568ebc747d21724b50c9be18ff5770eb33c37b76fda4633c14bde.RouteOrderRequest"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/1e938b22275568ebc747d21724b50c9be18ff5770eb33c37b76fda4633c14bde.RouteResponse"
},
"examples":{
"Route with a SIP endpoint destination":{
"summary":"Route with a SIP endpoint destination",
"value":{
"id":"f8fc8aca-786d-4943-9af2-e7ec01b5e80d",
"name":"Sample Route Name",
"destinations":[
{
"value":{
"username":"41793026834",
"sipTrunkId":"string",
"customHeaders":{
"X-Header-Name":"header value"
},
"type":"SIP"
},
"connectTimeout":30,
"recording":{
"recordingType":"AUDIO",
"recordingComposition":{
"enabled":true
},
"customData":{
"key1":"value1"
},
"filePrefix":"recording"
},
"type":"ENDPOINT"
}
],
"status":"ENABLED",
"order":1,
"transferOnly":false
}
},
"Route with a phone endpoint destination":{
"summary":"Route with a phone endpoint destination",
"value":{
"id":"f8fc8aca-786d-4943-9af2-e7ec01b5e80d",
"name":"Sample Route Name",
"destinations":[
{
"value":{
"phoneNumber":"41793026834",
"type":"PHONE"
},
"connectTimeout":30,
"recording":{
"recordingType":"AUDIO",
"recordingComposition":{
"enabled":true
},
"customData":{
"key1":"value1"
},
"filePrefix":"recording"
},
"type":"ENDPOINT"
}
],
"status":"ENABLED",
"order":1,
"transferOnly":false
}
}
}
}
}
},
"400":{
"$ref":"#/components/responses/ApiException400"
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.ApiError"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Not found"
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"callrouting:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":50,
"numberOfTimeUnits":0,
"timeUnit":"m"
}
]
}
},
"/callrouting/1/recordings":{
"get":{
"tags":[
"channels",
"voice",
"routing",
"call-routing-recordings"
],
"summary":"Get recordings",
"description":"This method allows searching and filtering based on various recording data properties.",
"operationId":"search-call-routing-recording",
"parameters":[
{
"name":"sortBy",
"in":"query",
"description":"Field that will be used for sorting.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RecordingSortColumn"
},
"example":"START_TIME"
},
{
"name":"sortDirection",
"in":"query",
"description":"Order in which files will be sorted based on sortBy field.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SortDirection"
},
"example":"DESC"
},
{
"name":"endpointType",
"in":"query",
"description":"Endpoint type of at least one participant in the recorded call.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"PHONE"
},
{
"name":"phoneNumber",
"in":"query",
"description":"Phone number that was participant of the recorded call.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":41792036727
},
{
"name":"sipTrunkId",
"in":"query",
"description":"SIP Trunk ID that was participant of the recorded call.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"60d345fd3a799ec"
},
{
"name":"sipUsername",
"in":"query",
"description":"Username on the SIP trunk that was participant of the recorded call.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":41793026834
},
{
"name":"webrtcIdentity",
"in":"query",
"description":"WebRTC Identity that was participant of the recorded call.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"WebRTC_user"
},
{
"name":"routeId",
"in":"query",
"description":"Route ID that was used to establish the recorded call.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"f8fc8aca-786d-4943-9af2-e7ec01b5e80d"
},
{
"name":"routeName",
"in":"query",
"description":"Route name to be used to match recordings. Name will be matched comparing it to all route names.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"Sample Route Name"
},
{
"name":"correlationId",
"in":"query",
"description":"Correlation ID to match.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"d8d84155-3831-43fb-91c9-bb897149a79d"
},
{
"name":"startTimeAfter",
"in":"query",
"description":"Date and time when the (first) call recording started.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"format":"date-time"
},
"example":"2024-05-01T14:25:45.125+0000"
},
{
"name":"startTimeBefore",
"in":"query",
"description":"Date and time when the (last) call recording started.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"format":"date-time"
},
"example":"2024-05-01T14:26:45.125+0000"
},
{
"name":"location",
"in":"query",
"description":"Recording location.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RecordingLocation"
},
"example":"FRANKFURT"
},
{
"name":"page",
"in":"query",
"description":"Results page to retrieve (0..N).",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":0,
"minimum":0
}
},
{
"name":"size",
"in":"query",
"description":"Number of records per page.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":20,
"maximum":100,
"minimum":1
}
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/aa157138bc28697f89db8325cc3d3ce20c0f3c72c30b6831a5435f3f2d211cfe.CallRoutingRecordingPage"
},
"examples":{
"Successfully fetching results":{
"summary":"Successfully fetching results",
"description":"Fetching recorded calls.",
"value":{
"results":[
{
"application":{
"routeId":"edef623d-0e1a-4a83-91e5-73c75ed31473",
"routeName":"Route with disabled recording composition",
"correlationId":"8fdbf7d9-9889-4c2e-8f16-246d5fe066de",
"startTime":"2025-04-04T09:25:50.060+0000",
"endTime":"2025-04-04T09:25:57.780+0000",
"type":"CALL_ROUTING"
},
"recording":{
"composedFiles":[],
"callRecordings":[
{
"callId":"q9lo60o6ihb23q06epc23n46ihd0nilcibb8nihd5jpu6n5d3boqip1e1bqs667ofk00",
"endpoint":{
"phoneNumber":"38761111222",
"type":"PHONE"
},
"direction":"INBOUND",
"status":"SUCCESSFUL",
"files":[
{
"id":"b83f049e-6b2a-4111-bbeb-32426fe0a737",
"name":"b83f049e-6b2a-4111-bbeb-32426fe0a737.wav",
"fileFormat":"WAV",
"size":123392,
"startTime":"2025-04-04T09:25:50.059+0000",
"endTime":"2025-04-04T09:25:57.739+0000",
"creationTime":"2025-04-04T09:25:57.829+0000",
"duration":7,
"location":"HOSTED",
"customData":{
"routeId":"edef623d-0e1a-4a83-91e5-73c75ed31473"
}
}
]
},
{
"callId":"cb64100e-371c-4928-8cbd-1256752e4de4",
"endpoint":{
"phoneNumber":"38762222333",
"type":"PHONE"
},
"direction":"OUTBOUND",
"status":"SUCCESSFUL",
"files":[
{
"id":"d411529b-cc99-4144-8e4d-53214a1f1660",
"name":"d411529b-cc99-4144-8e4d-53214a1f1660.wav",
"fileFormat":"WAV",
"size":123682,
"startTime":"2025-04-04T09:25:50.079+0000",
"endTime":"2025-04-04T09:25:57.779+0000",
"creationTime":"2025-04-04T09:25:57.825+0000",
"duration":7,
"location":"HOSTED",
"customData":{
"routeId":"edef623d-0e1a-4a83-91e5-73c75ed31473"
}
}
]
}
]
}
},
{
"application":{
"routeId":"3a1fcde8-df41-4209-b9a5-895db5d42e3d",
"routeName":"Route with enabled recording composition",
"correlationId":"fc840e38-29dc-47d5-9947-17371c939a17",
"startTime":"2025-04-04T11:38:01.723+0000",
"endTime":"2025-04-04T11:38:12.763+0000",
"type":"CALL_ROUTING"
},
"recording":{
"composedFiles":[
{
"id":"294cdf1b-70ae-4249-b384-6f267b5cf345",
"name":"294cdf1b-70ae-4249-b384-6f267b5cf345.wav",
"fileFormat":"WAV",
"size":177152,
"startTime":"2025-04-04T11:38:01.724+0000",
"endTime":"2025-04-04T11:38:12.764+0000",
"creationTime":"2025-04-04T11:38:12.829+0000",
"duration":11,
"location":"HOSTED",
"customData":{
"routeId":"3a1fcde8-df41-4209-b9a5-895db5d42e3d"
}
}
],
"callRecordings":[
{
"callId":"m1to60o6ihb23q06epc23n46ihd0nilcibb8nihd5jpu6n5d3boqip1e1bqs6lfdgk00",
"endpoint":{
"phoneNumber":"38761111222",
"type":"PHONE"
},
"direction":"INBOUND",
"files":[]
},
{
"callId":"81a815ee-4fc2-45e3-a3eb-50277359a089",
"endpoint":{
"phoneNumber":"38761111333",
"type":"PHONE"
},
"direction":"OUTBOUND",
"files":[]
}
]
}
}
],
"paging":{
"page":0,
"size":20,
"totalPages":1,
"totalResults":2
}
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.ApiError"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Invalid sort column."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"property.path",
"violation":"Violation message."
}
],
"resources":[]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"callrouting:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":10,
"numberOfTimeUnits":0,
"timeUnit":"m"
}
]
},
"delete":{
"tags":[
"channels",
"voice",
"routing",
"call-routing-recordings"
],
"summary":"Delete by correlation ID",
"description":"This method allows deleting call recordings based on correlation ID.",
"operationId":"delete-by-correlation-id",
"parameters":[
{
"name":"correlationId",
"in":"query",
"description":"Correlation ID to match.",
"required":true,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"d8d84155-3831-43fb-91c9-bb897149a79d"
},
{
"name":"location",
"in":"query",
"description":"Recording location.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RecordingLocation"
},
"example":"FRANKFURT"
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/6ee61eb40f9e4619d309dfe8df9b479488b43bcde7df95f6a044b2e14abf591e.RecordingApiResponse"
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.ApiError"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Invalid sort column."
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"property.path",
"violation":"Violation message."
}
],
"resources":[]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RecordingNotFoundException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Not found"
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"callrouting:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":10,
"numberOfTimeUnits":0,
"timeUnit":"m"
}
]
}
},
"/callrouting/1/recordings/files/{fileId}":{
"get":{
"tags":[
"channels",
"voice",
"routing",
"call-routing-recordings"
],
"summary":"Download recording file",
"description":"Download a recording file.",
"operationId":"recording-file-download",
"parameters":[
{
"name":"fileId",
"in":"path",
"description":"File ID to match.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
}
},
{
"name":"location",
"in":"query",
"description":"Recording location.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RecordingLocation"
},
"example":"FRANKFURT"
},
{
"name":"Range",
"in":"header",
"description":"Range header specifies range of bytes to be returned by the response. If range header is not specified, response will return a complete file.",
"required":false,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"bytes=0-1023"
}
],
"responses":{
"200":{
"description":"Success",
"content":{
"application/octet-stream":{
"schema":{
"type":"string",
"format":"binary",
"description":"File binary stream response"
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RecordingServiceException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request."
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RecordingNotFoundException"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Not found"
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"callrouting:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":10,
"numberOfTimeUnits":0,
"timeUnit":"m"
}
]
}
},
"/callrouting/1/routes/{routeId}/status":{
"post":{
"tags":[
"channels",
"voice",
"routing",
"call-routing-status-management"
],
"summary":"Update route status",
"description":"Update status of existing call route. ",
"operationId":"update-call-route-status",
"parameters":[
{
"name":"routeId",
"in":"path",
"description":"Route identifier",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"56b3e3ea-e91f-44ed-9d57-c7f05cd358ba"
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/1e938b22275568ebc747d21724b50c9be18ff5770eb33c37b76fda4633c14bde.RouteStatusRequest"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/1e938b22275568ebc747d21724b50c9be18ff5770eb33c37b76fda4633c14bde.RouteResponse"
},
"examples":{
"Route with a SIP endpoint destination":{
"summary":"Route with a SIP endpoint destination",
"value":{
"id":"f8fc8aca-786d-4943-9af2-e7ec01b5e80d",
"name":"Sample Route Name",
"destinations":[
{
"value":{
"username":"41793026834",
"sipTrunkId":"string",
"customHeaders":{
"X-Header-Name":"header value"
},
"type":"SIP"
},
"connectTimeout":30,
"recording":{
"recordingType":"AUDIO",
"recordingComposition":{
"enabled":true
},
"customData":{
"key1":"value1"
},
"filePrefix":"recording"
},
"type":"ENDPOINT"
}
],
"status":"ENABLED",
"order":1,
"transferOnly":false
}
},
"Route with a phone endpoint destination":{
"summary":"Route with a phone endpoint destination",
"value":{
"id":"f8fc8aca-786d-4943-9af2-e7ec01b5e80d",
"name":"Sample Route Name",
"destinations":[
{
"value":{
"phoneNumber":"41793026834",
"type":"PHONE"
},
"connectTimeout":30,
"recording":{
"recordingType":"AUDIO",
"recordingComposition":{
"enabled":true
},
"customData":{
"key1":"value1"
},
"filePrefix":"recording"
},
"type":"ENDPOINT"
}
],
"status":"ENABLED",
"order":1,
"transferOnly":false
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.ApiError"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request",
"validationErrors":{
"field":[
"field must not be null"
]
}
}
}
}
},
"Bad request":{
"summary":"Bad request",
"value":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"property.path",
"violation":"Violation message."
}
],
"resources":[]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.ApiError"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Not found"
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"callrouting:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":50,
"numberOfTimeUnits":0,
"timeUnit":"m"
}
]
}
},
"/callrouting/1/routes/simulate":{
"post":{
"tags":[
"channels",
"voice",
"routing",
"call-routing-simulator"
],
"summary":"Simulate route selection",
"description":"Simulates which route will be selected upon predefined request.",
"operationId":"simulate-route-selection",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/c5d63eb36983d8ea1e54e74166c0e08ea636cff38a55aa9570bd7ba615a520a0.RouteSimulatorRequest"
},
"examples":{
"Phone simulator request example":{
"summary":"Example of a phone simulator request",
"value":{
"to":"41793012345",
"useDisabledRoutes":false,
"endpoint":{
"from":"41793026234",
"type":"PHONE"
}
}
},
"SIP simulator request example":{
"summary":"Example of a SIP simulator request",
"value":{
"to":"41793012345",
"useDisabledRoutes":false,
"endpoint":{
"from":"41793026234",
"sipTrunkId":"test-sip-trunk-id",
"headers":{
"X-Header-Name":"Value"
},
"type":"SIP"
}
}
},
"WebRTC simulator request example":{
"summary":"Example of a WebRTC simulator request",
"value":{
"to":"41793012345",
"useDisabledRoutes":false,
"endpoint":{
"from":"dUser",
"type":"WEBRTC"
}
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/1e938b22275568ebc747d21724b50c9be18ff5770eb33c37b76fda4633c14bde.RouteResponse"
},
"examples":{
"Route with a SIP endpoint destination":{
"summary":"Route with a SIP endpoint destination",
"value":{
"id":"f8fc8aca-786d-4943-9af2-e7ec01b5e80d",
"name":"Sample Route Name",
"destinations":[
{
"value":{
"username":"41793026834",
"sipTrunkId":"string",
"customHeaders":{
"X-Header-Name":"header value"
},
"type":"SIP"
},
"connectTimeout":30,
"recording":{
"recordingType":"AUDIO",
"recordingComposition":{
"enabled":true
},
"customData":{
"key1":"value1"
},
"filePrefix":"recording"
},
"type":"ENDPOINT"
}
],
"status":"ENABLED",
"order":1,
"transferOnly":false
}
},
"Route with a phone endpoint destination":{
"summary":"Route with a phone endpoint destination",
"value":{
"id":"f8fc8aca-786d-4943-9af2-e7ec01b5e80d",
"name":"Sample Route Name",
"destinations":[
{
"value":{
"phoneNumber":"41793026834",
"type":"PHONE"
},
"connectTimeout":30,
"recording":{
"recordingType":"AUDIO",
"recordingComposition":{
"enabled":true
},
"customData":{
"key1":"value1"
},
"filePrefix":"recording"
},
"type":"ENDPOINT"
}
],
"status":"ENABLED",
"order":1,
"transferOnly":false
}
}
}
}
}
},
"400":{
"$ref":"#/components/responses/ApiException400"
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.ApiError"
},
"examples":{
"Error responses":{
"summary":"Error responses",
"description":"Error responses",
"value":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Not found"
}
}
}
}
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"callrouting:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":5,
"numberOfTimeUnits":0,
"timeUnit":"m"
}
]
}
}
},
"components":{
"schemas":{
"00a1f95ecbb89787a99eae13916106d1d4d9cc2934634cfbf0d16daa73fd2cf0.TextPlayContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicPlayContent"
},
{
"type":"object",
"properties":{
"text":{
"type":"string",
"description":"Text to read. Use the Speech Synthesis Markup Language (SSML) in a request to fine-tune your output."
},
"language":{
"type":"string",
"description":"Text language. Must be defined for correct pronunciation. More info about available languages and voices can be found [here](https://www.infobip.com/docs/voice-and-video/getting-started#text-to-speech-add-ons-and-options).",
"enum":[
"ar",
"ar-ma",
"ar_xa",
"bg",
"bn",
"bn-in",
"ca",
"cmn-cn",
"cs",
"da",
"de",
"de-at",
"de-ch",
"el",
"en",
"en-au",
"en-ca",
"en-gb",
"en-gb-wls",
"en-ie",
"en-in",
"en-ph",
"es",
"es-419",
"es-ar",
"es-co",
"es-mx",
"es-us",
"et-ee",
"fi",
"fil-ph",
"fr",
"fr-ca",
"fr-ch",
"gu",
"he",
"hi",
"hr",
"hu",
"id",
"is",
"it",
"ja",
"kk-kz",
"kn",
"ko",
"lt",
"lv",
"ml",
"mr-in",
"ms",
"nb-no",
"nl",
"nl-be",
"no",
"pa-in",
"pl",
"pt-br",
"pt-pt",
"ro",
"ru",
"sk",
"sl",
"sr-rs",
"sv",
"sw-ke",
"sw-tz",
"ta",
"te",
"th",
"tr",
"uk",
"ur-in",
"ur-pk",
"uz-uz",
"vi",
"wls",
"yue-hk",
"zh-cn",
"zh-tw"
]
},
"speechRate":{
"type":"number",
"format":"double",
"description":"Speech rate. Must be within `[0.5 - 2.0]` range, default value is `1`."
},
"preferences":{
"$ref":"#/components/schemas/08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.PublicVoicePreferences"
}
}
}
],
"required":[
"language",
"text"
],
"title":"TextPlayContent"
},
"02ec6d748bd9b366e5aeae1eaf03d6007ae57830d7d55344122f68a2478c9f84.UpdateCallRequest":{
"type":"object",
"properties":{
"muted":{
"type":"boolean",
"description":"Indicates whether to mute or unmute the end user. This action prevents the user from talking."
},
"deaf":{
"type":"boolean",
"description":"Indicates whether to deaf or undeaf the end user. This action prevents the user from hearing the call."
},
"blind":{
"type":"boolean",
"description":"Indicates whether to blind or unblind the end user. This action prevents the user from seeing any remote video in the call. Only applicable for WebRTC endpoints."
},
"role":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Role"
}
},
"title":"UpdateCallRequest"
},
"02ec6d748bd9b366e5aeae1eaf03d6007ae57830d7d55344122f68a2478c9f84.UpdateRequest":{
"type":"object",
"properties":{
"muted":{
"type":"boolean",
"description":"Indicates whether to mute or unmute the end user. This action prevents the user from talking."
},
"deaf":{
"type":"boolean",
"description":"Indicates whether to deaf or undeaf the end user. This action prevents the user from hearing the call."
},
"blind":{
"type":"boolean",
"description":"Indicates whether to blind or unblind the end user. This action prevents the user from seeing any remote video in the call. Only applicable for WebRTC endpoints."
}
},
"title":"UpdateRequest"
},
"08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.ActionCallRequest":{
"type":"object",
"properties":{
"endpoint":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallEndpoint"
},
"from":{
"type":"string",
"description":"Caller identifier. Must be a number in the [E.164](https://en.wikipedia.org/wiki/E.164) format for calls to `PHONE`, a string for calls to `WEBRTC` or `SIP`, and a Viber Voice number for calls to `VIBER`. Field is mandatory for `VIBER` endpoint and calls to emergency numbers."
},
"fromDisplayName":{
"type":"string",
"description":"Display name to show when placing calls towards WEBRTC endpoints. Can be any alphanumeric string."
},
"connectTimeout":{
"type":"integer",
"format":"int32",
"description":"Time to wait, in seconds, before the called party answers the call.",
"maximum":60
},
"recording":{
"$ref":"#/components/schemas/6665694460cb56ab854a173ada36805c85c7ec55584901d2f06225baf9b586cb.CallRecordingRequest"
},
"machineDetection":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MachineDetectionRequest"
},
"maxDuration":{
"type":"integer",
"format":"int32",
"default":28800,
"description":"Max duration in seconds."
},
"customData":{
"type":"object",
"additionalProperties":{
"type":"string"
},
"description":"Custom data."
}
},
"required":[
"endpoint"
],
"title":"ActionCallRequest"
},
"08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.CallRequest":{
"type":"object",
"description":"Outbound call request.",
"properties":{
"endpoint":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallEndpoint"
},
"from":{
"type":"string",
"description":"Caller identifier. Must be a number in the [E.164](https://en.wikipedia.org/wiki/E.164) format for calls to `PHONE`, a string for calls to `WEBRTC` or `SIP`, and a Viber Voice number for calls to `VIBER`. Field is mandatory for `VIBER` endpoint and calls to emergency numbers."
},
"fromDisplayName":{
"type":"string",
"description":"Display name to show when placing calls towards WEBRTC endpoints. Can be any alphanumeric string."
},
"connectTimeout":{
"type":"integer",
"format":"int32",
"description":"Time to wait, in seconds, before the called party answers the call.",
"maximum":60
},
"recording":{
"$ref":"#/components/schemas/6665694460cb56ab854a173ada36805c85c7ec55584901d2f06225baf9b586cb.CallRecordingRequest"
},
"machineDetection":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MachineDetectionRequest"
},
"maxDuration":{
"type":"integer",
"format":"int32",
"default":28800,
"description":"Max duration in seconds."
},
"customData":{
"type":"object",
"additionalProperties":{
"type":"string"
},
"description":"Custom data."
},
"callsConfigurationId":{
"type":"string",
"description":"Calls Configuration ID."
},
"platform":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Platform"
},
"parentCallId":{
"type":"string",
"description":"ID of an existing call that initiated this leg. Required for [creating a dialog with an existing call.](#create-dialog-with-existing-calls)",
"maxLength":128
},
"externalId":{
"type":"string",
"description":"Custom ID assigned by the client."
}
},
"required":[
"callsConfigurationId",
"endpoint"
],
"title":"CallRequest"
},
"08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.ConnectWithNewCallRequest":{
"type":"object",
"properties":{
"callRequest":{
"$ref":"#/components/schemas/08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.ActionCallRequest"
},
"connectOnEarlyMedia":{
"type":"boolean",
"default":false,
"description":"Indicates whether to connect calls on early media. Otherwise, the calls are connected after being established. Cannot be `true` when `ringbackGeneration` is enabled."
},
"ringbackGeneration":{
"$ref":"#/components/schemas/2dac378b25c8dcf450b0618ee8c5fb6fb461154cc6b53aedfd327a01e576875e.RingbackGeneration"
},
"conferenceRequest":{
"$ref":"#/components/schemas/707907921d4508c2925eddc2449f10db322ecc083be424f87c50fe97ccd8be40.ActionConferenceRequest"
}
},
"required":[
"callRequest"
],
"title":"ConnectWithNewCallRequest"
},
"08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.DtmfCaptureRequest":{
"type":"object",
"properties":{
"maxLength":{
"type":"integer",
"format":"int32",
"description":"Maximum number of digits to capture."
},
"timeout":{
"type":"integer",
"format":"int32",
"description":"The duration, in milliseconds, to wait for the first DTMF digit response."
},
"terminator":{
"type":"string",
"description":"Digit used to end input if less than `maxLength` digits have been pressed."
},
"digitTimeout":{
"type":"integer",
"format":"int32",
"description":"Duration, in milliseconds, to wait for a DTMF digit in-between individual digit inputs. If not set, `digitTimeout` will use the same duration as `timeout`."
},
"playContent":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicPlayContent"
},
"customData":{
"type":"object",
"additionalProperties":{
"type":"string"
},
"description":"Optional parameter to update a call's custom data."
}
},
"required":[
"maxLength",
"timeout"
],
"title":"DtmfCaptureRequest"
},
"08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.PublicSayRequest":{
"type":"object",
"description":"Call say request.",
"properties":{
"text":{
"type":"string",
"description":"Text to read. Use the Speech Synthesis Markup Language (SSML) in a request to fine-tune your output."
},
"language":{
"type":"string",
"description":"Text language. Must be defined for correct pronunciation. More info about available languages and voices can be found [here](https://www.infobip.com/docs/voice-and-video/getting-started#text-to-speech).",
"enum":[
"ar",
"ar-ma",
"ar_xa",
"bg",
"bn",
"bn-in",
"ca",
"cmn-cn",
"cs",
"da",
"de",
"de-at",
"de-ch",
"el",
"en",
"en-au",
"en-ca",
"en-gb",
"en-gb-wls",
"en-ie",
"en-in",
"en-ph",
"es",
"es-419",
"es-ar",
"es-co",
"es-mx",
"es-us",
"et-ee",
"fi",
"fil-ph",
"fr",
"fr-ca",
"fr-ch",
"gu",
"he",
"hi",
"hr",
"hu",
"id",
"is",
"it",
"ja",
"kk-kz",
"kn",
"ko",
"lt",
"lv",
"ml",
"mr-in",
"ms",
"nb-no",
"nl",
"nl-be",
"no",
"pa-in",
"pl",
"pt-br",
"pt-pt",
"ro",
"ru",
"sk",
"sl",
"sr-rs",
"sv",
"sw-ke",
"sw-tz",
"ta",
"te",
"th",
"tr",
"uk",
"ur-in",
"ur-pk",
"uz-uz",
"vi",
"wls",
"yue-hk",
"zh-cn",
"zh-tw"
]
},
"speechRate":{
"type":"number",
"format":"double",
"description":"Speech rate. Must be within `[0.5 - 2.0]` range, default value is `1`."
},
"loopCount":{
"type":"integer",
"format":"int32",
"description":"Number of times to read the text."
},
"preferences":{
"$ref":"#/components/schemas/08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.PublicVoicePreferences"
},
"stopOn":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicTermination"
},
"customData":{
"type":"object",
"additionalProperties":{
"type":"string"
},
"description":"Optional parameter to update a call's custom data."
}
},
"required":[
"language",
"text"
],
"title":"PublicSayRequest"
},
"08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.PublicStartTranscriptionRequest":{
"type":"object",
"properties":{
"transcription":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Transcription"
}
},
"title":"PublicStartTranscriptionRequest"
},
"08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.PublicVoicePreferences":{
"type":"object",
"description":"Voice preferences.",
"properties":{
"voiceGender":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Gender"
},
"voiceName":{
"type":"string",
"description":"Voice name in which text would be synthesized. More info about available languages and voices can be found [here](https://www.infobip.com/docs/voice-and-video/getting-started#text-to-speech-add-ons-and-options).",
"enum":[
"Aadita",
"Aarohi (neural)",
"Aarushi (beta)",
"Aarya",
"Abbi (neural)",
"Abigail",
"Abrielle (beta)",
"Abril (neural)",
"Achara (neural)",
"Achernar ar-XA (generative)",
"Achernar bg (generative)",
"Achernar bn-IN (generative)",
"Achernar cmn-CN (generative)",
"Achernar cs (generative)",
"Achernar da-DK (generative)",
"Achernar el-GR (generative)",
"Achernar en-IN (generative)",
"Achernar en-US (generative)",
"Achernar es-US (generative)",
"Achernar et-EE (generative)",
"Achernar fi-FI (generative)",
"Achernar fr-CA (generative)",
"Achernar gu-IN (generative)",
"Achernar he-IL (generative)",
"Achernar hi-IN (generative)",
"Achernar hr-HR (generative)",
"Achernar hu-HU (generative)",
"Achernar id-ID (generative)",
"Achernar kn-IN (generative)",
"Achernar ko-KR (generative)",
"Achernar lt-LT (generative)",
"Achernar lv-LV (generative)",
"Achernar ml-IN (generative)",
"Achernar mr-IN (generative)",
"Achernar nb-NO (generative)",
"Achernar nl-BE (generative)",
"Achernar pa-IN (generative)",
"Achernar pl-PL (generative)",
"Achernar pt-BR (generative)",
"Achernar ro-RO (generative)",
"Achernar ru-RU (generative)",
"Achernar sk-SK (generative)",
"Achernar sl-SI (generative)",
"Achernar sr-RS (generative)",
"Achernar sv-SE (generative)",
"Achernar sw-KE (generative)",
"Achernar ta-IN (generative)",
"Achernar te-IN (generative)",
"Achernar th-TH (generative)",
"Achernar tr-TR (generative)",
"Achernar uk-UA (generative)",
"Achernar ur-IN (generative)",
"Achernar vi-VN (generative)",
"Achernar yue-HK (generative)",
"Achird ar-XA (generative)",
"Achird bg (generative)",
"Achird bn-IN (generative)",
"Achird cmn-CN (generative)",
"Achird cs (generative)",
"Achird da-DK (generative)",
"Achird el-GR (generative)",
"Achird en-IN (generative)",
"Achird en-US (generative)",
"Achird es-US (generative)",
"Achird et-EE (generative)",
"Achird fi-FI (generative)",
"Achird fr-CA (generative)",
"Achird gu-IN (generative)",
"Achird he-IL (generative)",
"Achird hi-IN (generative)",
"Achird hr-HR (generative)",
"Achird hu-HU (generative)",
"Achird id-ID (generative)",
"Achird kn-IN (generative)",
"Achird ko-KR (generative)",
"Achird lt-LT (generative)",
"Achird lv-LV (generative)",
"Achird ml-IN (generative)",
"Achird mr-IN (generative)",
"Achird nb-NO (generative)",
"Achird nl-BE (generative)",
"Achird pa-IN (generative)",
"Achird pl-PL (generative)",
"Achird pt-BR (generative)",
"Achird ro-RO (generative)",
"Achird ru-RU (generative)",
"Achird sk-SK (generative)",
"Achird sl-SI (generative)",
"Achird sr-RS (generative)",
"Achird sv-SE (generative)",
"Achird sw-KE (generative)",
"Achird ta-IN (generative)",
"Achird te-IN (generative)",
"Achird th-TH (generative)",
"Achird tr-TR (generative)",
"Achird uk-UA (generative)",
"Achird ur-IN (generative)",
"Achird vi-VN (generative)",
"Achird yue-HK (generative)",
"Aditi",
"Agathe (generative)",
"Agnieszka (neural)",
"Agota",
"Agustina (generative)",
"Ahmet (neural)",
"Aigul (neural)",
"Aisha (beta)",
"Akash (beta)",
"Akemi (beta)",
"Alain (neural)",
"Alba (neural)",
"Aled (neural)",
"Alfie (neural)",
"Alina (neural)",
"Alnilam ar-XA (generative)",
"Alnilam bg (generative)",
"Alnilam bn-IN (generative)",
"Alnilam cmn-CN (generative)",
"Alnilam cs (generative)",
"Alnilam da-DK (generative)",
"Alnilam el-GR (generative)",
"Alnilam en-IN (generative)",
"Alnilam en-US (generative)",
"Alnilam es-US (generative)",
"Alnilam et-EE (generative)",
"Alnilam fi-FI (generative)",
"Alnilam fr-CA (generative)",
"Alnilam gu-IN (generative)",
"Alnilam he-IL (generative)",
"Alnilam hi-IN (generative)",
"Alnilam hr-HR (generative)",
"Alnilam hu-HU (generative)",
"Alnilam id-ID (generative)",
"Alnilam kn-IN (generative)",
"Alnilam ko-KR (generative)",
"Alnilam lt-LT (generative)",
"Alnilam lv-LV (generative)",
"Alnilam ml-IN (generative)",
"Alnilam mr-IN (generative)",
"Alnilam nb-NO (generative)",
"Alnilam nl-BE (generative)",
"Alnilam pa-IN (generative)",
"Alnilam pl-PL (generative)",
"Alnilam pt-BR (generative)",
"Alnilam ro-RO (generative)",
"Alnilam ru-RU (generative)",
"Alnilam sk-SK (generative)",
"Alnilam sl-SI (generative)",
"Alnilam sr-RS (generative)",
"Alnilam sv-SE (generative)",
"Alnilam sw-KE (generative)",
"Alnilam ta-IN (generative)",
"Alnilam te-IN (generative)",
"Alnilam th-TH (generative)",
"Alnilam tr-TR (generative)",
"Alnilam uk-UA (generative)",
"Alnilam ur-IN (generative)",
"Alnilam vi-VN (generative)",
"Alnilam yue-HK (generative)",
"Alonso (neural)",
"Alvaro (generative)",
"Alvaro (neural)",
"Ama (generative)",
"Amal (beta)",
"Amala (neural)",
"Amalthea (generative)",
"Amber (neural)",
"Ameera",
"Amy",
"Andrew (neural)",
"Andromeda (generative)",
"Aneta",
"Angelo (neural)",
"Annette (neural)",
"Antoine (neural)",
"Antonia (generative)",
"Antonin (neural)",
"Antonio (neural)",
"Aoede ar-XA (generative)",
"Aoede bg (generative)",
"Aoede bn-IN (generative)",
"Aoede cmn-CN (generative)",
"Aoede cs (generative)",
"Aoede da-DK (generative)",
"Aoede el-GR (generative)",
"Aoede en-IN (generative)",
"Aoede en-US (generative)",
"Aoede es-US (generative)",
"Aoede et-EE (generative)",
"Aoede fi-FI (generative)",
"Aoede fr-CA (generative)",
"Aoede gu-IN (generative)",
"Aoede he-IL (generative)",
"Aoede hi-IN (generative)",
"Aoede hr-HR (generative)",
"Aoede hu-HU (generative)",
"Aoede id-ID (generative)",
"Aoede kn-IN (generative)",
"Aoede ko-KR (generative)",
"Aoede lt-LT (generative)",
"Aoede lv-LV (generative)",
"Aoede ml-IN (generative)",
"Aoede mr-IN (generative)",
"Aoede nb-NO (generative)",
"Aoede nl-BE (generative)",
"Aoede pa-IN (generative)",
"Aoede pl-PL (generative)",
"Aoede pt-BR (generative)",
"Aoede ro-RO (generative)",
"Aoede ru-RU (generative)",
"Aoede sk-SK (generative)",
"Aoede sl-SI (generative)",
"Aoede sr-RS (generative)",
"Aoede sv-SE (generative)",
"Aoede sw-KE (generative)",
"Aoede ta-IN (generative)",
"Aoede te-IN (generative)",
"Aoede th-TH (generative)",
"Aoede tr-TR (generative)",
"Aoede uk-UA (generative)",
"Aoede ur-IN (generative)",
"Aoede vi-VN (generative)",
"Aoede yue-HK (generative)",
"Aoi (neural)",
"Apollo (generative)",
"Aquila (generative)",
"Arcas (generative)",
"Ardi (neural)",
"Aria (neural)",
"Ariane (neural)",
"Aries (generative)",
"Arif (beta)",
"Arjun",
"Arnau (neural)",
"Asad (neural)",
"Ashley (neural)",
"Asteria (generative)",
"Astrid",
"Athena (generative)",
"Athina (neural)",
"Atlas (generative)",
"Aurelia (generative)",
"Aurora (generative)",
"Ava (neural)",
"Avri (neural)",
"Bashkar (neural)",
"Beatrix (generative)",
"Beatriz (neural)",
"Bella (neural)",
"Benigno (neural)",
"Bernd (neural)",
"Bianca",
"Blessica (neural)",
"BongJin (neural)",
"Borislav (neural)",
"Brandon (neural)",
"Brenda (neural)",
"Brian",
"Brian (neural)",
"Brigitte (neural)",
"Calimero (neural)",
"Callirrhoe ar-XA (generative)",
"Callirrhoe bg (generative)",
"Callirrhoe bn-IN (generative)",
"Callirrhoe cmn-CN (generative)",
"Callirrhoe cs (generative)",
"Callirrhoe da-DK (generative)",
"Callirrhoe el-GR (generative)",
"Callirrhoe en-IN (generative)",
"Callirrhoe en-US (generative)",
"Callirrhoe es-US (generative)",
"Callirrhoe et-EE (generative)",
"Callirrhoe fi-FI (generative)",
"Callirrhoe fr-CA (generative)",
"Callirrhoe gu-IN (generative)",
"Callirrhoe he-IL (generative)",
"Callirrhoe hi-IN (generative)",
"Callirrhoe hr-HR (generative)",
"Callirrhoe hu-HU (generative)",
"Callirrhoe id-ID (generative)",
"Callirrhoe kn-IN (generative)",
"Callirrhoe ko-KR (generative)",
"Callirrhoe lt-LT (generative)",
"Callirrhoe lv-LV (generative)",
"Callirrhoe ml-IN (generative)",
"Callirrhoe mr-IN (generative)",
"Callirrhoe nb-NO (generative)",
"Callirrhoe nl-BE (generative)",
"Callirrhoe pa-IN (generative)",
"Callirrhoe pl-PL (generative)",
"Callirrhoe pt-BR (generative)",
"Callirrhoe ro-RO (generative)",
"Callirrhoe ru-RU (generative)",
"Callirrhoe sk-SK (generative)",
"Callirrhoe sl-SI (generative)",
"Callirrhoe sr-RS (generative)",
"Callirrhoe sv-SE (generative)",
"Callirrhoe sw-KE (generative)",
"Callirrhoe ta-IN (generative)",
"Callirrhoe te-IN (generative)",
"Callirrhoe th-TH (generative)",
"Callirrhoe tr-TR (generative)",
"Callirrhoe uk-UA (generative)",
"Callirrhoe ur-IN (generative)",
"Callirrhoe vi-VN (generative)",
"Callirrhoe yue-HK (generative)",
"Callista (generative)",
"Camila",
"Candela (neural)",
"Carina (generative)",
"Carla",
"Carlota (neural)",
"Carly (neural)",
"Carmen",
"Cataldo (neural)",
"Cecilio (neural)",
"Celeste (generative)",
"Celeste (neural)",
"Celine",
"Cesare (generative)",
"Chantal",
"Chao",
"Charon",
"Chen (beta)",
"Christel (neural)",
"Christoph (neural)",
"Christopher (neural)",
"Cinzia (generative)",
"Clara (neural)",
"Claude (neural)",
"Colette (neural)",
"Conchita",
"Connor (neural)",
"Conrad (neural)",
"Cora (generative)",
"Cora (neural)",
"Coralie (neural)",
"Cordelia (generative)",
"Cornelia (generative)",
"Cristiano",
"Daichi (neural)",
"Dalia (neural)",
"Daman (beta)",
"Daphne (generative)",
"Darina",
"Dario (neural)",
"Dariya (neural)",
"Darren (neural)",
"Daudi (neural)",
"Daulet (neural)",
"David",
"Davis (neural)",
"Delia (generative)",
"Demetra (generative)",
"Denise (neural)",
"Despina",
"Dhwani (neural)",
"Diana (generative)",
"Diego (neural)",
"Dinesh (beta)",
"Dionisio (generative)",
"Divya (beta)",
"Dmitry (neural)",
"Donato (neural)",
"Dora",
"Draco (generative)",
"Duarte (neural)",
"Duncan (neural)",
"Ebisu (generative)",
"Elara (generative)",
"Electra (generative)",
"Elena (neural)",
"Elias (neural)",
"Elio (generative)",
"Elizabeth (neural)",
"Elke (neural)",
"Elliot (neural)",
"Elsa (neural)",
"Elsie (neural)",
"Elvira (neural)",
"Elza (neural)",
"Emel (neural)",
"Emil (neural)",
"Emily (neural)",
"Emma",
"Emma (neural)",
"Enric (neural)",
"Enrique",
"Eric (neural)",
"Estrella (generative)",
"Estrella (neural)",
"Ethan (neural)",
"Evelin (beta)",
"Ewa",
"Fabian (generative)",
"Fabio (neural)",
"Fabiola (neural)",
"Fabrice (neural)",
"Fang",
"Farooq (beta)",
"Fenna (neural)",
"Fenrir ar-XA (generative)",
"Fenrir bg (generative)",
"Fenrir bn-IN (generative)",
"Fenrir cmn-CN (generative)",
"Fenrir cs (generative)",
"Fenrir da-DK (generative)",
"Fenrir el-GR (generative)",
"Fenrir en-IN (generative)",
"Fenrir en-US (generative)",
"Fenrir es-US (generative)",
"Fenrir et-EE (generative)",
"Fenrir fi-FI (generative)",
"Fenrir fr-CA (generative)",
"Fenrir gu-IN (generative)",
"Fenrir he-IL (generative)",
"Fenrir hi-IN (generative)",
"Fenrir hr-HR (generative)",
"Fenrir hu-HU (generative)",
"Fenrir id-ID (generative)",
"Fenrir kn-IN (generative)",
"Fenrir ko-KR (generative)",
"Fenrir lt-LT (generative)",
"Fenrir lv-LV (generative)",
"Fenrir ml-IN (generative)",
"Fenrir mr-IN (generative)",
"Fenrir nb-NO (generative)",
"Fenrir nl-BE (generative)",
"Fenrir pa-IN (generative)",
"Fenrir pl-PL (generative)",
"Fenrir pt-BR (generative)",
"Fenrir ro-RO (generative)",
"Fenrir ru-RU (generative)",
"Fenrir sk-SK (generative)",
"Fenrir sl-SI (generative)",
"Fenrir sr-RS (generative)",
"Fenrir sv-SE (generative)",
"Fenrir sw-KE (generative)",
"Fenrir ta-IN (generative)",
"Fenrir te-IN (generative)",
"Fenrir th-TH (generative)",
"Fenrir tr-TR (generative)",
"Fenrir uk-UA (generative)",
"Fenrir ur-IN (generative)",
"Fenrir vi-VN (generative)",
"Fenrir yue-HK (generative)",
"Fernanda (neural)",
"Fiamma (neural)",
"Filiz",
"Finn (neural)",
"Flavio (generative)",
"Francisca (neural)",
"Freya (neural)",
"Fuaad",
"Fujin (generative)",
"Gabriela (beta)",
"Gabrijela (neural)",
"Gadis (neural)",
"Gagan (neural)",
"Ganesh (beta)",
"Geraint",
"Gerardo (neural)",
"Gianna (beta)",
"Gianni (neural)",
"Giorgio",
"Giovanna (neural)",
"Giuseppe (neural)",
"Gloria (generative)",
"GookMin (neural)",
"Gudrun (neural)",
"Gunnar (neural)",
"Guy (neural)",
"Gwyneth",
"Hamed (neural)",
"Hans",
"Harmonia (generative)",
"Harri (neural)",
"Hector (generative)",
"Helena (generative)",
"Henri (neural)",
"Henriques (beta)",
"Hera (generative)",
"Hermes (generative)",
"Hestia (generative)",
"Hila (neural)",
"Hillevi (neural)",
"Himchan (beta)",
"HiuGaai (neural)",
"HiuMaan (neural)",
"HoaiMy (neural)",
"Hollie (neural)",
"HsiaoChen (neural)",
"HsiaoYu (neural)",
"Huang (beta)",
"Humberto (neural)",
"Hussein (beta)",
"Hyperion (generative)",
"Hyunsu (neural)",
"Idan",
"Imelda (neural)",
"InJoon (neural)",
"Indah (beta)",
"Ines",
"Ingrid (neural)",
"Irene (neural)",
"Iris (generative)",
"Irma (neural)",
"Isabella (neural)",
"Iselin (neural)",
"Ivy",
"Izanami (generative)",
"Jacek",
"Jacinda (beta)",
"Jacob (neural)",
"Jacqueline (neural)",
"Jamal (neural)",
"Jan",
"Jan (neural)",
"Jane (neural)",
"Janus (generative)",
"Jason (neural)",
"Javier (generative)",
"Jean (neural)",
"Jennifer",
"Jenny (neural)",
"Jeppe (neural)",
"Jeraldo (beta)",
"Jerome (neural)",
"JiMin (neural)",
"Jina (beta)",
"Joana (neural)",
"Joanna",
"Joanne (neural)",
"Joey",
"Jonas (neural)",
"Jorge (neural)",
"Josephine (neural)",
"Julio (neural)",
"Julius (generative)",
"Juno (generative)",
"Jupiter (generative)",
"Justin",
"Kalina (neural)",
"Kara (generative)",
"Karl",
"Kasper (neural)",
"Katja (neural)",
"Keita (neural)",
"Ken (neural)",
"Kendra",
"Killian (neural)",
"Kim (neural)",
"Kimberly",
"Kirti (beta)",
"Klarissa (neural)",
"Klaus (neural)",
"Kore ar-XA (generative)",
"Kore bg (generative)",
"Kore bn-IN (generative)",
"Kore cmn-CN (generative)",
"Kore cs (generative)",
"Kore da-DK (generative)",
"Kore el-GR (generative)",
"Kore en-IN (generative)",
"Kore en-US (generative)",
"Kore es-US (generative)",
"Kore et-EE (generative)",
"Kore fi-FI (generative)",
"Kore fr-CA (generative)",
"Kore gu-IN (generative)",
"Kore he-IL (generative)",
"Kore hi-IN (generative)",
"Kore hr-HR (generative)",
"Kore hu-HU (generative)",
"Kore id-ID (generative)",
"Kore kn-IN (generative)",
"Kore ko-KR (generative)",
"Kore lt-LT (generative)",
"Kore lv-LV (generative)",
"Kore ml-IN (generative)",
"Kore mr-IN (generative)",
"Kore nb-NO (generative)",
"Kore nl-BE (generative)",
"Kore pa-IN (generative)",
"Kore pl-PL (generative)",
"Kore pt-BR (generative)",
"Kore ro-RO (generative)",
"Kore ru-RU (generative)",
"Kore sk-SK (generative)",
"Kore sl-SI (generative)",
"Kore sr-RS (generative)",
"Kore sv-SE (generative)",
"Kore sw-KE (generative)",
"Kore ta-IN (generative)",
"Kore te-IN (generative)",
"Kore th-TH (generative)",
"Kore tr-TR (generative)",
"Kore uk-UA (generative)",
"Kore ur-IN (generative)",
"Kore vi-VN (generative)",
"Kore yue-HK (generative)",
"Laia (neural)",
"Lara (generative)",
"Larissa (neural)",
"Lars (generative)",
"Lea",
"Leda (generative)",
"Leda ar-XA (generative)",
"Leda bg (generative)",
"Leda bn-IN (generative)",
"Leda cmn-CN (generative)",
"Leda cs (generative)",
"Leda da-DK (generative)",
"Leda el-GR (generative)",
"Leda en-IN (generative)",
"Leda en-US (generative)",
"Leda es-US (generative)",
"Leda et-EE (generative)",
"Leda fi-FI (generative)",
"Leda fr-CA (generative)",
"Leda gu-IN (generative)",
"Leda he-IL (generative)",
"Leda hi-IN (generative)",
"Leda hr-HR (generative)",
"Leda hu-HU (generative)",
"Leda id-ID (generative)",
"Leda kn-IN (generative)",
"Leda ko-KR (generative)",
"Leda lt-LT (generative)",
"Leda lv-LV (generative)",
"Leda ml-IN (generative)",
"Leda mr-IN (generative)",
"Leda nb-NO (generative)",
"Leda nl-BE (generative)",
"Leda pa-IN (generative)",
"Leda pl-PL (generative)",
"Leda pt-BR (generative)",
"Leda ro-RO (generative)",
"Leda ru-RU (generative)",
"Leda sk-SK (generative)",
"Leda sl-SI (generative)",
"Leda sr-RS (generative)",
"Leda sv-SE (generative)",
"Leda sw-KE (generative)",
"Leda ta-IN (generative)",
"Leda te-IN (generative)",
"Leda th-TH (generative)",
"Leda tr-TR (generative)",
"Leda uk-UA (generative)",
"Leda ur-IN (generative)",
"Leda vi-VN (generative)",
"Leda yue-HK (generative)",
"Leela (beta)",
"Leila (neural)",
"Leni (neural)",
"Leticia (neural)",
"Lia (neural)",
"Liam (neural)",
"Libby (neural)",
"Liberto (neural)",
"Lien (beta)",
"Lin (beta)",
"Linda",
"Lisandro (neural)",
"Liu (beta)",
"Liv",
"Livia (generative)",
"Lotte",
"Louisa (neural)",
"Luciano (generative)",
"Luciano (neural)",
"Lukas (neural)",
"Luna (generative)",
"Lupe",
"Maarten (neural)",
"Madhur (neural)",
"Madina (neural)",
"Mads",
"Mai (beta)",
"Maia (generative)",
"Maja",
"Maja (neural)",
"Manohar (neural)",
"Manuela (neural)",
"Marek (neural)",
"Marina (neural)",
"Marlene",
"Mars (generative)",
"Mathieu",
"Matthew",
"Mattias (neural)",
"Maurice (neural)",
"Maxim",
"Mayu (neural)",
"Meira",
"Melia (generative)",
"Mia",
"Michelle (neural)",
"Midhun (neural)",
"Miguel",
"Minerva (generative)",
"Ming",
"Minho (beta)",
"Mizuki",
"Mohan (neural)",
"Monica (neural)",
"Mouna (neural)",
"Naja",
"NamMinh (neural)",
"Namratha (beta)",
"Nanami (neural)",
"Nancy (neural)",
"Naoki (neural)",
"Natalia",
"Natasha (neural)",
"Natchaya (beta)",
"Neerja (neural)",
"Neil (neural)",
"Neptune (generative)",
"Nestor (generative)",
"Nestoras (neural)",
"Nia (neural)",
"Nicolau (neural)",
"Nicole",
"Nijat",
"Nil (neural)",
"Niranjan (neural)",
"Niwat (neural)",
"Noah (neural)",
"Noemi (neural)",
"Noora (neural)",
"Nuria (neural)",
"Nurin",
"Nurul (beta)",
"Odysseus (generative)",
"Oliver (neural)",
"Olivia (generative)",
"Olivia (neural)",
"Ophelia (generative)",
"Orion (generative)",
"Orpheus (generative)",
"Orus ar-XA (generative)",
"Orus bg (generative)",
"Orus bn-IN (generative)",
"Orus cmn-CN (generative)",
"Orus cs (generative)",
"Orus da-DK (generative)",
"Orus el-GR (generative)",
"Orus en-IN (generative)",
"Orus en-US (generative)",
"Orus es-US (generative)",
"Orus et-EE (generative)",
"Orus fi-FI (generative)",
"Orus fr-CA (generative)",
"Orus gu-IN (generative)",
"Orus he-IL (generative)",
"Orus hi-IN (generative)",
"Orus hr-HR (generative)",
"Orus hu-HU (generative)",
"Orus id-ID (generative)",
"Orus kn-IN (generative)",
"Orus ko-KR (generative)",
"Orus lt-LT (generative)",
"Orus lv-LV (generative)",
"Orus ml-IN (generative)",
"Orus mr-IN (generative)",
"Orus nb-NO (generative)",
"Orus nl-BE (generative)",
"Orus pa-IN (generative)",
"Orus pl-PL (generative)",
"Orus pt-BR (generative)",
"Orus ro-RO (generative)",
"Orus ru-RU (generative)",
"Orus sk-SK (generative)",
"Orus sl-SI (generative)",
"Orus sr-RS (generative)",
"Orus sv-SE (generative)",
"Orus sw-KE (generative)",
"Orus ta-IN (generative)",
"Orus te-IN (generative)",
"Orus th-TH (generative)",
"Orus tr-TR (generative)",
"Orus uk-UA (generative)",
"Orus ur-IN (generative)",
"Orus vi-VN (generative)",
"Orus yue-HK (generative)",
"Osman (neural)",
"Ostap (neural)",
"Pallavi (neural)",
"Palmira (neural)",
"Paloma (neural)",
"Pandora (generative)",
"Pelayo (neural)",
"Penelope",
"Pernille (neural)",
"Perseo (generative)",
"Petra (neural)",
"Phoebe (generative)",
"Pierina (neural)",
"Pluto (generative)",
"Polina (neural)",
"Prabhat (neural)",
"Premwadee (neural)",
"Quan (beta)",
"Rafiki (neural)",
"Ralf (neural)",
"Raquel (neural)",
"Raveena",
"Rehema (neural)",
"Renata (neural)",
"Revati",
"Reza (beta)",
"Rhea (generative)",
"Ricardo",
"Rinaldo (neural)",
"Roger (neural)",
"Rok (neural)",
"Roman (generative)",
"Ruben",
"Russell",
"Ryan (neural)",
"Sadaltager ar-XA (generative)",
"Sadaltager bg (generative)",
"Sadaltager bn-IN (generative)",
"Sadaltager cmn-CN (generative)",
"Sadaltager cs (generative)",
"Sadaltager da-DK (generative)",
"Sadaltager el-GR (generative)",
"Sadaltager en-IN (generative)",
"Sadaltager en-US (generative)",
"Sadaltager es-US (generative)",
"Sadaltager et-EE (generative)",
"Sadaltager fi-FI (generative)",
"Sadaltager fr-CA (generative)",
"Sadaltager gu-IN (generative)",
"Sadaltager he-IL (generative)",
"Sadaltager hi-IN (generative)",
"Sadaltager hr-HR (generative)",
"Sadaltager hu-HU (generative)",
"Sadaltager id-ID (generative)",
"Sadaltager kn-IN (generative)",
"Sadaltager ko-KR (generative)",
"Sadaltager lt-LT (generative)",
"Sadaltager lv-LV (generative)",
"Sadaltager ml-IN (generative)",
"Sadaltager mr-IN (generative)",
"Sadaltager nb-NO (generative)",
"Sadaltager nl-BE (generative)",
"Sadaltager pa-IN (generative)",
"Sadaltager pl-PL (generative)",
"Sadaltager pt-BR (generative)",
"Sadaltager ro-RO (generative)",
"Sadaltager ru-RU (generative)",
"Sadaltager sk-SK (generative)",
"Sadaltager sl-SI (generative)",
"Sadaltager sr-RS (generative)",
"Sadaltager sv-SE (generative)",
"Sadaltager sw-KE (generative)",
"Sadaltager ta-IN (generative)",
"Sadaltager te-IN (generative)",
"Sadaltager th-TH (generative)",
"Sadaltager tr-TR (generative)",
"Sadaltager uk-UA (generative)",
"Sadaltager ur-IN (generative)",
"Sadaltager vi-VN (generative)",
"Sadaltager yue-HK (generative)",
"Salli",
"Salma (neural)",
"Samantha (beta)",
"Sander (generative)",
"Sapna (neural)",
"Sara (neural)",
"Sardor (neural)",
"Saturn (generative)",
"Saul (neural)",
"Sayan (beta)",
"Selena (generative)",
"Selene (generative)",
"Selma (neural)",
"SeoHyeon (neural)",
"Seoyeon",
"Seraphina (neural)",
"Shakir (neural)",
"Shashank (beta)",
"Shiori (neural)",
"Shruti (beta)",
"Shruti (neural)",
"Silvia (generative)",
"Sirio (generative)",
"Sobhana (neural)",
"Sofie (neural)",
"Sonia (neural)",
"SoonBok (neural)",
"Sophia (beta)",
"Srecko (neural)",
"Steffan (neural)",
"Sumi (beta)",
"SunHi (neural)",
"Sushmita (beta)",
"Svetlana (neural)",
"Swara (neural)",
"Sylvie (neural)",
"Takumi",
"Tamas (neural)",
"Tanishaa (neural)",
"Tanja (neural)",
"Tatyana",
"Teo (neural)",
"Thalia (generative)",
"Thalita (neural)",
"Theia (generative)",
"Thierry (neural)",
"Thomas (neural)",
"Tim (neural)",
"Tina (neural)",
"Tomas (neural)",
"Tony (neural)",
"Triana (neural)",
"Tuan (beta)",
"Ulyana",
"Uzma (neural)",
"Uzume (generative)",
"Valerio (generative)",
"Valerio (neural)",
"Valluvar (neural)",
"Vera (neural)",
"Vesta (generative)",
"Vicki",
"Vijay (beta)",
"Viktoria (generative)",
"Viktoria (neural)",
"Vishnu (beta)",
"Vitoria",
"Vivienne (neural)",
"Vlasta (neural)",
"WanLung (neural)",
"Wang (beta)",
"William (neural)",
"Xiaochen (neural)",
"Xiaohan (neural)",
"Xiaomeng (neural)",
"Xiaomo (neural)",
"Xiaoqiu (neural)",
"Xiaorou (neural)",
"Xiaorui (neural)",
"Xiaoxiao (neural)",
"Xiaoyan (neural)",
"Xiaoyi (neural)",
"Xiaozhen (neural)",
"Ximena (neural)",
"Yago (neural)",
"Yara (neural)",
"Yasmin (neural)",
"Yosef",
"YuJin (neural)",
"YunJhe (neural)",
"Yunfeng (neural)",
"Yunhao (neural)",
"Yunjian (neural)",
"Yunjie (neural)",
"Yunxi (neural)",
"Yunxia (neural)",
"Yunyang (neural)",
"Yunye (neural)",
"Yunze (neural)",
"Yves (neural)",
"Yvette (neural)",
"Zariyah (neural)",
"Zeina",
"Zeus (generative)",
"Zhang (beta)",
"Zhiyu",
"Zofia (neural)",
"Zuri (neural)"
]
}
},
"title":"PublicVoicePreferences"
},
"08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.RecordingStartRequest":{
"type":"object",
"properties":{
"recording":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingRequest"
}
},
"title":"RecordingStartRequest"
},
"08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.SpeechCaptureRequest":{
"type":"object",
"properties":{
"language":{
"$ref":"#/components/schemas/61f95109c33ad36c729390593c474a655f9ca0e00403d6dbc107cf0f6c5cf04b.Language"
},
"timeout":{
"type":"integer",
"format":"int32",
"description":"The maximum duration of speech capture.",
"maximum":30,
"minimum":1
},
"maxSilence":{
"type":"integer",
"format":"int32",
"description":"The silence duration before terminating the speech capture after speech has been detected.",
"maximum":5,
"minimum":1
},
"keyPhrases":{
"type":"array",
"description":"Array of key-phrases used for matching capturing speech.",
"items":{
"type":"string",
"description":"Array of key-phrases used for matching capturing speech."
},
"uniqueItems":true
},
"terminateOnKeyPhrase":{
"type":"boolean",
"default":true,
"description":"Indicates whether speech capture should terminate immediately upon detecting a key phrase. Defaults to `true`. When `false`, capture proceeds until completion and retains only the first matched key phrase, if any."
},
"customDictionary":{
"type":"array",
"description":"Array of custom words (typically, industry-specific terms) used for improved speech capture.",
"items":{
"type":"string",
"description":"Array of custom words (typically, industry-specific terms) used for improved speech capture."
}
},
"advancedFormatting":{
"type":"boolean",
"default":false,
"description":"Toggles enhanced text formatting features like punctuation, proper casing, numeral normalization, and disfluency filtering. Defaults to `false`."
}
},
"required":[
"language",
"timeout"
],
"title":"SpeechCaptureRequest"
},
"08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.StartMediaStreamRequest":{
"type":"object",
"properties":{
"mediaStream":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MediaStream"
}
},
"required":[
"mediaStream"
],
"title":"StartMediaStreamRequest"
},
"0ea963ede06ee99578911cc0068f7474598729635091b55d2985483fad214d7b.AnnouncementCallee":{
"type":"object",
"description":"Announcement to be played to a callee before connecting them to a caller.",
"properties":{
"fileId":{
"type":"string",
"description":"ID of an audio file played to a callee. Required if `fileUrl` is not provided."
},
"fileUrl":{
"type":"string",
"description":"URL of an audio file played to a callee. Required if `fileId` is not provided."
}
},
"title":"AnnouncementCallee"
},
"0ea963ede06ee99578911cc0068f7474598729635091b55d2985483fad214d7b.AnnouncementCaller":{
"type":"object",
"description":"Announcement to be played to a caller before they dial in to the callee.",
"properties":{
"fileId":{
"type":"string",
"description":"ID of an audio file to be played to a caller. Required if `fileUrl` is not provided."
},
"fileUrl":{
"type":"string",
"description":"URL of a file played to a caller. Required if `fileId` is not provided."
}
},
"title":"AnnouncementCaller"
},
"0ea963ede06ee99578911cc0068f7474598729635091b55d2985483fad214d7b.Announcements":{
"type":"object",
"description":"Announcements to be played when a call is answered.",
"properties":{
"caller":{
"$ref":"#/components/schemas/0ea963ede06ee99578911cc0068f7474598729635091b55d2985483fad214d7b.AnnouncementCaller"
},
"callee":{
"$ref":"#/components/schemas/0ea963ede06ee99578911cc0068f7474598729635091b55d2985483fad214d7b.AnnouncementCallee"
}
},
"title":"Announcements"
},
"0ea963ede06ee99578911cc0068f7474598729635091b55d2985483fad214d7b.AudioCallbackResponse":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/0ea963ede06ee99578911cc0068f7474598729635091b55d2985483fad214d7b.CallbackResponse"
},
{
"type":"object",
"properties":{
"fileUrl":{
"type":"string",
"description":"Url of the audio file to be played to the caller. Required if `fileId` is not provided."
},
"fileId":{
"type":"string",
"description":"Identification of the audio file to be played to the caller. Required if `fileUrl` is not provided."
}
}
}
],
"title":"AudioCallbackResponse"
},
"0ea963ede06ee99578911cc0068f7474598729635091b55d2985483fad214d7b.CallbackResponse":{
"type":"object",
"discriminator":{
"propertyName":"command",
"mapping":{
"audio":"#/components/schemas/0ea963ede06ee99578911cc0068f7474598729635091b55d2985483fad214d7b.AudioCallbackResponse",
"captureDtmf":"#/components/schemas/0ea963ede06ee99578911cc0068f7474598729635091b55d2985483fad214d7b.CaptureDtmfCallbackResponse",
"dial":"#/components/schemas/0ea963ede06ee99578911cc0068f7474598729635091b55d2985483fad214d7b.DialCallbackResponse"
}
},
"properties":{
"command":{
"type":"string"
}
},
"required":[
"command"
],
"title":"CallbackResponse"
},
"0ea963ede06ee99578911cc0068f7474598729635091b55d2985483fad214d7b.CaptureDtmfCallbackResponse":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/0ea963ede06ee99578911cc0068f7474598729635091b55d2985483fad214d7b.CallbackResponse"
},
{
"type":"object",
"properties":{
"fileId":{
"type":"string",
"description":"ID of an audio file to play. Required if `fileUrl` is not provided."
},
"fileUrl":{
"type":"string",
"description":"URL of an audio file to play. Required if `fileId` is not provided."
},
"maxLength":{
"type":"integer",
"format":"int32",
"default":15,
"description":"Maximum number of digits to capture."
},
"timeout":{
"type":"integer",
"format":"int32",
"description":"The duration, in milliseconds, to wait for the first DTMF digit response."
},
"digitTimeout":{
"type":"integer",
"format":"int32",
"description":"Duration, in milliseconds, to wait for a DTMF digit in-between individual digit inputs. If not set, `digitTimeout` will use the same duration as `timeout`."
},
"terminator":{
"type":"string",
"default":"#",
"description":"Digit used to end input if less than `maxLength` digits have been pressed."
},
"addCountryCode":{
"type":"boolean",
"default":false,
"description":"Whether to convert the collected number into international format or not."
}
}
}
],
"required":[
"maxLength",
"timeout"
],
"title":"CaptureDtmfCallbackResponse"
},
"0ea963ede06ee99578911cc0068f7474598729635091b55d2985483fad214d7b.DialCallbackResponse":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/0ea963ede06ee99578911cc0068f7474598729635091b55d2985483fad214d7b.CallbackResponse"
},
{
"type":"object",
"properties":{
"phoneNumber":{
"type":"string",
"description":"Destination phone number to call."
},
"callerId":{
"type":"string",
"description":"Caller ID displayed to a called party."
},
"announcements":{
"$ref":"#/components/schemas/0ea963ede06ee99578911cc0068f7474598729635091b55d2985483fad214d7b.Announcements"
},
"recording":{
"$ref":"#/components/schemas/0ea963ede06ee99578911cc0068f7474598729635091b55d2985483fad214d7b.Recording"
},
"machineDetection":{
"$ref":"#/components/schemas/0ea963ede06ee99578911cc0068f7474598729635091b55d2985483fad214d7b.MachineDetection"
},
"clientReferenceId":{
"type":"string",
"description":"A user-defined reference ID for associating with a number masking session. This ID will appear in subsequent status requests and, if the session is recorded and our SFTP facility is used, will name the recording file. **Note:** In the case of recording, please limit this field to `200` characters as generated file name uses this field, call ID and extension, and if total file name is bigger than 256 characters, saving of the recording file will fail."
}
}
}
],
"required":[
"callerId",
"phoneNumber"
],
"title":"DialCallbackResponse"
},
"0ea963ede06ee99578911cc0068f7474598729635091b55d2985483fad214d7b.ExecutionMode":{
"type":"string",
"default":"SYNC",
"description":"Indicates whether detection is performed before (`SYNC`) or after (`ASYNC`) bridging the call. `ASYNC` only applies if there is no announcement playing to the callee side, otherwise it behaves like `SYNC`.",
"enum":[
"SYNC",
"ASYNC"
],
"title":"ExecutionMode"
},
"0ea963ede06ee99578911cc0068f7474598729635091b55d2985483fad214d7b.MachineDetection":{
"type":"object",
"description":"Answering machine detection configuration of a Number Masking call. Detection will be performed only on the callee side of the call.",
"properties":{
"enabled":{
"type":"boolean",
"description":"Indicates whether machine detection is enabled from the callee perspective."
},
"executionMode":{
"$ref":"#/components/schemas/0ea963ede06ee99578911cc0068f7474598729635091b55d2985483fad214d7b.ExecutionMode"
},
"detectionTime":{
"type":"number",
"format":"double",
"default":3.74,
"description":"Duration of machine detection. Higher values will increase the accuracy of machine detection, but will also increase the time it takes to detect a machine."
},
"hangupOnMachineDetection":{
"type":"boolean",
"default":true,
"description":"Indicates whether the callee side will hangup upon machine detection."
}
},
"title":"MachineDetection"
},
"0ea963ede06ee99578911cc0068f7474598729635091b55d2985483fad214d7b.MachineDetectionResult":{
"type":"string",
"description":"Result of Answering Machine Detection. Possible values are `HUMAN` and `MACHINE`.",
"enum":[
"HUMAN",
"MACHINE"
],
"title":"MachineDetectionResult"
},
"0ea963ede06ee99578911cc0068f7474598729635091b55d2985483fad214d7b.Recording":{
"type":"object",
"description":"Recording configuration of a Number Masking call.",
"properties":{
"enabled":{
"type":"boolean",
"description":"Indicates whether call recording is enabled from the callee perspective."
},
"recordCalleeAnnouncement":{
"type":"boolean",
"default":true,
"description":"Flag that indicates will callee announcement be included in recording file. If not set, it will be `true`."
}
},
"title":"Recording"
},
"0ea963ede06ee99578911cc0068f7474598729635091b55d2985483fad214d7b.RecordingStatus":{
"type":"string",
"description":"Recording status provided if recording was attempted.",
"enum":[
"HOSTED",
"SFTP",
"FAILED"
],
"title":"RecordingStatus"
},
"0ea963ede06ee99578911cc0068f7474598729635091b55d2985483fad214d7b.StatusResponse":{
"type":"object",
"title":"StatusResponse"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.AnsweringMachineDetection":{
"type":"object",
"description":"This action detects answering machines at the beginning of a call. It allows for detailed configuration of actions to be executed at various stages of the detection process.",
"properties":{
"answeringMachineDetection":{
"type":"boolean",
"description":"Indicates whether machine detection should be performed."
},
"options":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.AnsweringMachineDetectionOptions"
},
"onDetecting":{
"type":"array",
"description":"Array of actions to execute while detection is in progress. A maximum of two actions of specific types (`Play`, `Say`, `Collect`) can be defined.",
"items":{
"type":"object",
"description":"Array of actions to execute while detection is in progress. A maximum of two actions of specific types (`Play`, `Say`, `Collect`) can be defined."
}
},
"onMachineDetected":{
"type":"array",
"description":"Array of actions to execute when a machine is detected, or when the end of the message is reached if `endOfMessageDetectionTimeout` is set. Actions defined in `onDetecting` are interrupted before these actions begin. If you do not intend to continue the scenario after `onMachineDetected`, include a `Hangup` action at the end of this section to terminate the call.",
"items":{
"type":"object",
"description":"Array of actions to execute when a machine is detected, or when the end of the message is reached if `endOfMessageDetectionTimeout` is set. Actions defined in `onDetecting` are interrupted before these actions begin. If you do not intend to continue the scenario after `onMachineDetected`, include a `Hangup` action at the end of this section to terminate the call."
}
},
"onTimeout":{
"type":"array",
"description":"Array of actions to execute when a machine is detected and the `endOfMessageDetectionTimeout` is reached. If you do not intend to continue the scenario after `onTimeout`, include a `Hangup` action at the end of this section to terminate the call.",
"items":{
"type":"object",
"description":"Array of actions to execute when a machine is detected and the `endOfMessageDetectionTimeout` is reached. If you do not intend to continue the scenario after `onTimeout`, include a `Hangup` action at the end of this section to terminate the call."
}
},
"onHumanDetected":{
"type":"array",
"description":"Array of actions to execute when a human is detected. Actions defined in `onDetecting` are interrupted before these actions begin. To avoid this interruption, omit this section and define the remaining scenario after this action. If you do not intend to continue the scenario after `onHumanDetected`, include a `Hangup` action at the end of this section to terminate the call.",
"items":{
"type":"object",
"description":"Array of actions to execute when a human is detected. Actions defined in `onDetecting` are interrupted before these actions begin. To avoid this interruption, omit this section and define the remaining scenario after this action. If you do not intend to continue the scenario after `onHumanDetected`, include a `Hangup` action at the end of this section to terminate the call."
}
}
},
"required":[
"answeringMachineDetection",
"onMachineDetected"
],
"title":"Machine Detection (Advanced)"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.AnsweringMachineDetectionOptions":{
"type":"object",
"properties":{
"waitEndOfMessageDetection":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.WaitForEom"
},
"endOfMessageDetectionTimeout":{
"type":"integer",
"format":"int32",
"description":"Specifies the timeout (in seconds) to wait for the end of the message after a machine is detected. If set, actions defined in `onMachineDetected` will be executed only after the end of the message is detected or the timeout is reached. If not set, `onMachineDetected` actions will be triggered immediately after machine detection. If the timeout is reached before the end of the message, actions defined in `onTimeout` will be executed instead.",
"maximum":60,
"minimum":1
}
},
"title":"AnsweringMachineDetectionOptions"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.AudioContent":{
"type":"object",
"discriminator":{
"propertyName":"type",
"mapping":{
"URL":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.UrlAudioContent",
"FILE":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.FileAudioContent"
}
},
"properties":{
"type":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.AudioContentType"
}
},
"required":[
"type"
],
"title":"AudioContent"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.AudioContentType":{
"type":"string",
"description":"Type of audio content",
"enum":[
"FILE",
"URL"
],
"title":"AudioContentType"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.CallApi":{
"type":"object",
"description":"Call API Action performs an HTTP request to a client’s endpoint, and (if told to) processes the response data. If collectResponse is set, the system will attempt to parse the response from the server. Our platform needs to be able to make HTTP requests to the specified endpoint.",
"properties":{
"request":{
"type":"string",
"description":"The URL to target. The parameter can be constructed using variables."
},
"options":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.CallApiOptions"
},
"actionId":{
"type":"integer",
"format":"int32",
"description":"User-defined ID of an action that can be used with go-to action."
}
},
"required":[
"options",
"request"
],
"title":"Call API"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.CallApiOptions":{
"type":"object",
"properties":{
"method":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.HttpMethod"
},
"headers":{
"type":"object",
"additionalProperties":{
"type":"string",
"description":"HTTP headers"
},
"description":"HTTP headers"
},
"body":{
"type":"string",
"description":"HTTP body. The parameter can be constructed using variables."
},
"collectResponse":{
"type":"boolean",
"description":"If this field is set, the system will parse the response and save all its fields as variables inside scenario. Note: Parser ignores non-primitive fields and does not go deeper than the first level. For example, if the response is {\"letters\": \"abcd\", \"numbers\": 12345}, the system will store variables letters and numbers, with values abcd and 12345 respectively. The response cannot contain duplicate keys or predefined words. Check the example Call Api with response. Response that is parsed can only be in JSON or XML. Predefined words: from, to, startTime, answerTime and machineAnswered."
}
},
"required":[
"body",
"method"
],
"title":"CallApiOptions"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.CallDirection":{
"type":"string",
"description":"Call direction.",
"enum":[
"INBOUND",
"OUTBOUND"
],
"title":"CallDirection"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Capture":{
"type":"object",
"description":"Capture action performs speech recognition of a specified duration. The recognized text can be used in other actions of the scenario. Speech capture will start after the beep tone.",
"properties":{
"capture":{
"type":"string",
"description":"Variable name. If speech recognition matches one of the specified keyPhrases, a variable with this name will be set to match the keyphrase. Otherwise, this variable will be an empty string. Together with this variable, an implicit variable that contains the full text of the captured speech will be created. The name of this variable is constructed by adding _Full suffix to the variable name."
},
"timeout":{
"type":"integer",
"format":"int32",
"description":"Number of seconds used for capturing speech or digits failover. Minimum value is 1 and maximum value is 30. Can be overriden with speechOptions.maxSilence.",
"maximum":30,
"minimum":1
},
"beep":{
"type":"boolean",
"default":true,
"description":"Flag indicating whether a beep sound should play at the start of capture."
},
"speechOptions":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SpeechOptions"
},
"dtmfOptions":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DtmfOptions"
},
"sendToReports":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SendToReports"
},
"actionId":{
"type":"integer",
"format":"int32",
"description":"User-defined ID of an action that can be used with go-to action."
}
},
"required":[
"capture",
"speechOptions",
"timeout"
],
"title":"Capture"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.CaseObject":{
"type":"object",
"properties":{
"__default":{
"type":"array",
"description":"Array of actions to execute if none of the conditions above are met.",
"items":{
"type":"object",
"description":"Array of actions to execute if none of the conditions above are met."
}
}
},
"title":"CaseObject"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Collect":{
"type":"object",
"description":"Collect action reads the DTMF input from the user’s phone and saves it into a variable. Saved variable can be used within the IVR in any other action that allows variable usage. (e.g. switch/case)",
"properties":{
"collectInto":{
"type":"string",
"description":"The name of the variable to set."
},
"options":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.CollectOptions"
},
"actionId":{
"type":"integer",
"format":"int32",
"description":"User-defined ID of an action that can be used with go-to action."
}
},
"required":[
"collectInto"
],
"title":"Collect"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.CollectOptions":{
"type":"object",
"properties":{
"maxInputLength":{
"type":"integer",
"format":"int32",
"description":"Maximum acceptable number of digits. Stops reading after maxdigits have been entered (without requiring the user to press '#' key).",
"maximum":64,
"minimum":1
},
"timeout":{
"type":"integer",
"format":"int32",
"description":"Timeout in seconds for user to press both first DTMF and all other inter-digit DTMFs. Default value is 5. Max value is 30. The parameter can be constructed using variables.",
"maximum":30
},
"sendToReports":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SendToReports"
},
"mappedValues":{
"type":"object",
"additionalProperties":{
"type":"string",
"description":"Map of expected collected DTMF values with some real meaning. (Example: if you have multilingual IVR, and option for users to press 1 to enter \"English\" menu, you can define {\"1\":\"English\"}, so the reporting and analysis will be easier). When this option is defined additional variable is present in the scenario. If you set your collect action variable name to myVar, then you will get additional variable myVar_Meaning containing the mapped value for a collected DTMF. Mapped values can contain only numbers and multiple asterisk (*) symbols."
},
"description":"Map of expected collected DTMF values with some real meaning. (Example: if you have multilingual IVR, and option for users to press 1 to enter \"English\" menu, you can define {\"1\":\"English\"}, so the reporting and analysis will be easier). When this option is defined additional variable is present in the scenario. If you set your collect action variable name to myVar, then you will get additional variable myVar_Meaning containing the mapped value for a collected DTMF. Mapped values can contain only numbers and multiple asterisk (*) symbols."
}
},
"title":"CollectOptions"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.CustomRingback":{
"type":"object",
"description":"Custom ringback tones configuration. Allows specifying different audio files to play during ringing and when the call fails.",
"properties":{
"ringingAudio":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.AudioContent"
},
"failedAudio":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.AudioContent"
}
},
"required":[
"ringingAudio"
],
"title":"CustomRingback"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DeliveryDay":{
"type":"string",
"enum":[
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
"SUNDAY"
],
"title":"DeliveryDay"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DeliveryTime":{
"type":"object",
"properties":{
"hour":{
"type":"integer",
"format":"int32"
},
"minute":{
"type":"integer",
"format":"int32"
}
},
"title":"DeliveryTime"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DeliveryTimeWindow":{
"type":"object",
"description":"Scheduling object that allows setting up detailed time windows in which the message can be sent. Consists of from, to and days properties. Days property is mandatory. From and to properties should be either both included, to allow finer time window granulation or both omitted, to include whole days in the delivery time window. Note: delivery time window is set in UTC timezone.",
"properties":{
"days":{
"type":"array",
"items":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DeliveryDay"
},
"uniqueItems":true
},
"from":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DeliveryTime"
},
"to":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DeliveryTime"
}
},
"required":[
"from",
"to"
],
"title":"DeliveryTimeWindow"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Destination":{
"type":"object",
"description":"Array of message destination addresses. Maximum number of destination addresses is 20k.",
"properties":{
"messageId":{
"type":"string",
"description":"The ID that uniquely identifies the message sent."
},
"to":{
"type":"string",
"description":"Message destination addresses. Destination address must be in the E.164 standard format (Example: `41793026727`)."
}
},
"required":[
"to"
],
"title":"Destination"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Dial":{
"type":"object",
"description":"Dial action performs a call redirection, joining the user's call with another destination. Dial must be the last action.",
"properties":{
"dial":{
"type":"string",
"description":"must be a valid E164 MSISDN; the parameter can be constructed using variables"
},
"options":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DialOptions"
},
"actionId":{
"type":"integer",
"format":"int32",
"description":"User-defined ID of an action that can be used with go-to action."
}
},
"required":[
"dial"
],
"title":"Dial"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DialOptions":{
"type":"object",
"properties":{
"senderId":{
"type":"string",
"description":"must be a valid E164 MSISDN; the parameter can be constructed using variables"
},
"maxCallDuration":{
"type":"integer",
"format":"int32",
"description":"If set, call transfer will be limited by maxCallDuration seconds, must be a positive number, no upper bound.",
"minimum":1
},
"customRingback":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.CustomRingback"
}
},
"title":"DialOptions"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DialToConversations":{
"type":"object",
"description":"Dial to Conversations action performs a call redirection to the [Infobip Conversations platform](https://www.infobip.com/docs/conversations), joining the user’s call with an agent. Dial to Conversations must be the last action.",
"properties":{
"dialToConversations":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DialToConversationsData"
}
},
"required":[
"dialToConversations"
],
"title":"Dial To Conversations"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DialToConversationsData":{
"type":"object",
"properties":{
"options":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DialToConversationsOptions"
}
},
"required":[
"options"
],
"title":"DialToConversationsData"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DialToConversationsOptions":{
"type":"object",
"properties":{
"tagIdentifierType":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.TagIdentifierType"
},
"tags":{
"type":"array",
"description":"An array of [conversation tag](https://www.infobip.com/docs/conversations/get-to-know-conversations#tags-templates-and-tags) names or ids that are assigned to this conversation for better categorization of the topics or customer intent. Value can be an array of tag names/ids, empty array, or null value.",
"items":{
"type":"string",
"description":"An array of [conversation tag](https://www.infobip.com/docs/conversations/get-to-know-conversations#tags-templates-and-tags) names or ids that are assigned to this conversation for better categorization of the topics or customer intent. Value can be an array of tag names/ids, empty array, or null value."
}
}
},
"required":[
"tags"
],
"title":"DialToConversationsOptions"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DialToMany":{
"type":"object",
"description":"Dial to Many action performs a call redirection to multiple destinations, joining the user’s call only with the destination that answered the call first. After Dial to Many action the following actions are forbidden: Say, Collect, Dial, Dial to Many, Dial to Conversations, Play, Record and Play from Recording.",
"properties":{
"dialToMany":{
"type":"array",
"items":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Numbers"
}
},
"options":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DialToManyOptions"
},
"actionId":{
"type":"integer",
"format":"int32",
"description":"User-defined ID of an action that can be used with go-to action."
}
},
"required":[
"dialToMany",
"options"
],
"title":"Dial To Many"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DialToManyOptions":{
"type":"object",
"properties":{
"parallel":{
"type":"boolean",
"default":false,
"description":"Flag indicating that parallel (`true`), or sequential (`false`) Dial to Many will be executed."
},
"senderId":{
"type":"string",
"description":"Must be a valid [E.164](https://en.wikipedia.org/wiki/E.164) number; the parameter can be constructed using variables"
},
"maxCallDuration":{
"type":"integer",
"format":"int32",
"description":"If set, call transfer will be limited by `maxCallDuration` seconds; must be a positive number, no upper bound.",
"minimum":1
}
},
"title":"DialToManyOptions"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DtmfOptions":{
"type":"object",
"properties":{
"maxInputLength":{
"type":"integer",
"format":"int32",
"description":"Maximum acceptable number of digits. Capturing is stopped after this number of digits has been entered. If not set, maximum value will be used.",
"maximum":64,
"minimum":1
},
"mappedValues":{
"type":"object",
"additionalProperties":{
"type":"string",
"description":"Map of expected collected DTMF values with some real meaning. (Example: if you have multilingual IVR, and option for users to press 1 to enter \"English\" menu, you can define {\"1\":\"English\"}, so the reporting and analysis will be easier). When this option is defined additional variable is present in the scenario. If you set your capture action variable name to myVar, then you will get additional variable myVar_Meaning containing the mapped value for a collected DTMF. Keys can contain only digits and asterisks."
},
"description":"Map of expected collected DTMF values with some real meaning. (Example: if you have multilingual IVR, and option for users to press 1 to enter \"English\" menu, you can define {\"1\":\"English\"}, so the reporting and analysis will be easier). When this option is defined additional variable is present in the scenario. If you set your capture action variable name to myVar, then you will get additional variable myVar_Meaning containing the mapped value for a collected DTMF. Keys can contain only digits and asterisks."
}
},
"required":[
"maxInputLength"
],
"title":"DtmfOptions"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.FileAudioContent":{
"type":"object",
"description":"Audio content from an uploaded file. Use this when the audio file has been uploaded to Infobip.",
"properties":{
"fileId":{
"type":"string",
"description":"ID of uploaded file."
},
"type":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.AudioContentType"
}
},
"required":[
"fileId",
"type"
],
"title":"FileAudioContent"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.ForEach":{
"type":"object",
"description":"For-each action is a control statement that executes a block of code for each of the values within the supplied list. The Supplied list of values can be static or dynamic (defined as user variable).",
"properties":{
"for-each":{
"type":"string",
"description":"Variable name that will be used inside the loop to represent single value from supplied list of values."
},
"in":{
"type":"string",
"description":"List of values that will be iterated over. Must be delimited with specified `delimiter`."
},
"delimiter":{
"type":"string",
"default":",",
"description":"Delimiter for separating values in the list of values."
},
"do":{
"type":"array",
"description":"Array of actions to execute.",
"items":{
"type":"object",
"description":"Array of actions to execute."
}
}
},
"required":[
"do",
"for-each",
"in"
],
"title":"For Each"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.GetVoicesResponse":{
"type":"object",
"properties":{
"voices":{
"type":"array",
"description":"Array of voices belonging to the specified language.",
"items":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SynthesisVoiceResponse"
}
}
},
"title":"GetVoicesResponse"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.GoTo":{
"type":"object",
"description":"Go-To action is used to go back to some specified action that was already executed in the scenario and continue the execution from that point.",
"properties":{
"goTo":{
"type":"integer",
"format":"int32",
"description":"The actionId of an action to which to jump"
},
"options":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.GoToOptions"
}
},
"required":[
"goTo"
],
"title":"Go To"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.GoToOptions":{
"type":"object",
"properties":{
"goToLimit":{
"type":"integer",
"format":"int32",
"description":"Maximum number of times goto can jump to specified action. Valid values are from 1 to 100.",
"maximum":100,
"minimum":1
},
"countVariable":{
"type":"string",
"description":"Name of the variable which counts passes through goto action"
}
},
"title":"GoToOptions"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Hangup":{
"type":"string",
"description":"Hangup action marks the end of the IVR flow execution, leading to the call actually being hung up.",
"enum":[
"hangup"
],
"required":[
"hangup"
],
"title":"Hang-up"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.HttpMethod":{
"type":"string",
"description":"Http method",
"enum":[
"GET",
"POST",
"PUT",
"DELETE",
"PATCH"
],
"title":"HttpMethod"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.IfThenElse":{
"type":"object",
"description":"If-Then-Else action provides simple branching based on a condition. If the condition evaluates to true, the then block is executed, otherwise the else block is executed. Only one of the blocks is required to be non-empty.",
"properties":{
"if":{
"type":"string",
"description":"The expression to evaluate"
},
"then":{
"type":"array",
"description":"The actions to execute if condition is evaluated to true.",
"items":{
"type":"object",
"description":"The actions to execute if condition is evaluated to true."
}
},
"else":{
"type":"array",
"description":"The actions to execute if condition is evaluated to false.",
"items":{
"type":"object",
"description":"The actions to execute if condition is evaluated to false."
}
},
"actionId":{
"type":"integer",
"format":"int32",
"description":"User-defined ID of an action that can be used with go-to action."
}
},
"required":[
"if"
],
"title":"If Then Else"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.IpCoreGeneralStatus":{
"type":"string",
"enum":[
"ACCEPTED",
"PENDING",
"UNDELIVERABLE",
"DELIVERED",
"EXPIRED",
"REJECTED"
],
"title":"IpCoreGeneralStatus"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.IvrData":{
"type":"object",
"description":"Fields representing details about IVR, if outbound IVR is being used. If the call was not IVR, the field will be null.",
"properties":{
"scenarioId":{
"type":"string",
"description":"The ID that uniquely identifies the IVR scenario."
},
"scenarioName":{
"type":"string",
"description":"Name of IVR scenario."
},
"collectedDtmfs":{
"type":"string",
"description":"JSON object showing the result of every CollectAction in IVR scenario in the form of key/value pairs, where the key is CollectAction variable and pair is collected DTMF."
},
"collectedMappedDtmfs":{
"type":"string",
"description":"JSON object showing the result of every CollectAction in IVR scenario with the mapped, meaningful, values you defined in CollectAction `mappedValues` option."
},
"spokenInput":{
"type":"string",
"description":"JSON object showing the result of every CaptureSpeech action with full text spoken by the user."
},
"matchedSpokenInput":{
"type":"string",
"description":"JSON object showing the result of every CaptureSpeech action with only the key phrases that matched user spoken input."
}
},
"title":"IvrData"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.IvrMessage":{
"type":"object",
"description":"Array of IVR messages to be sent, one object per every message.",
"properties":{
"scenarioId":{
"type":"string",
"description":"Scenario key."
},
"from":{
"type":"string",
"description":"Numeric sender ID length should be between 3 and 14 characters."
},
"destinations":{
"type":"array",
"description":"Array of message destination addresses. Maximum number of destination addresses is 20k.",
"items":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Destination"
}
},
"notifyUrl":{
"type":"string",
"description":"The URL on your callback server on which the Delivery report will be sent."
},
"notifyContentType":{
"type":"string",
"description":"Preferred Delivery report content type. Can be `application/json` or `application/xml`."
},
"notifyContentVersion":{
"type":"integer",
"format":"int32",
"description":"Specifies the version of the report model to be sent. Can be `1` ([deprecated version 1](#programmable-communications/voice/receive-voice-delivery-reports-deprecated)) or `2` ([current version 2](#programmable-communications/voice/receive-voice-delivery-reports)). The default is version 2."
},
"callbackData":{
"type":"string",
"description":"Additional client's data that will be sent on the notifyUrl. The maximum value is 200 characters."
},
"validityPeriod":{
"type":"integer",
"format":"int32",
"description":"The message validity period shown in minutes. When the period expires, it will not be allowed for the message to be sent. A validity period longer than 48h is not supported (in this case, it will be automatically set to 48h)."
},
"sendAt":{
"type":"string",
"format":"date-time",
"description":"Used for scheduled Voice messages (message not to be sent immediately, but at scheduled time)."
},
"retry":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Retry"
},
"ringTimeout":{
"type":"integer",
"format":"int32",
"description":"Ringing duration, unless there are no operator limitations. Default value is `45`. Note: There are no limitations on the Voice platform regarding this value, however, most of the operators have their own ring timeout limitations and it is advisable to keep the ringTimeout value up to `45` seconds."
},
"sendingSpeed":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SendingSpeed"
},
"parameters":{
"type":"object",
"additionalProperties":{
"type":"string"
},
"description":"The parameters that should be passed to the scenario on execution."
},
"pause":{
"type":"integer",
"format":"int32",
"description":"Indicating period of time in seconds between end user answering the call and message starting to be played. Minimal value is `0` and maximum value is `10` seconds. Default value is `0`."
},
"deliveryTimeWindow":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DeliveryTimeWindow"
},
"callTimeout":{
"type":"integer",
"format":"int32",
"description":"Maximum possible duration of the call to be set, shown in seconds."
}
},
"required":[
"destinations",
"scenarioId"
],
"title":"IvrMessage"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.LaunchScenarioRequest":{
"type":"object",
"properties":{
"bulkId":{
"type":"string",
"description":"The ID which uniquely identifies the request."
},
"messages":{
"type":"array",
"description":"Array of IVR messages to be sent, one object per every message.",
"items":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.IvrMessage"
}
}
},
"required":[
"messages"
],
"title":"LaunchScenarioRequest"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.LogsReport":{
"type":"object",
"description":"Array of voice message logs, one object per each message.",
"properties":{
"bulkId":{
"type":"string",
"description":"The ID that uniquely identifies the bulk of messages."
},
"messageId":{
"type":"string",
"description":"The ID that uniquely identifies the message sent."
},
"to":{
"type":"string",
"description":"Destination address of the voice message."
},
"from":{
"type":"string",
"description":"The sender ID which can be alphanumeric or numeric."
},
"text":{
"type":"string",
"description":"Content of the voice message that was sent."
},
"sentAt":{
"type":"string",
"format":"date-time",
"description":"Date and time when the voice message was initiated. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ."
},
"doneAt":{
"type":"string",
"format":"date-time",
"description":"Date and time when the Infobip services finished processing the voice message (i.e. delivered to the destination, delivered to the destination network, etc.)."
},
"duration":{
"type":"integer",
"format":"int32",
"description":"Voice message duration in seconds."
},
"mccMnc":{
"type":"string",
"description":"Mobile country and network codes."
},
"price":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Price"
},
"status":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SingleMessageStatus"
},
"error":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.VoiceError"
}
},
"title":"LogsReport"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.LogsResponse":{
"type":"object",
"properties":{
"results":{
"type":"array",
"description":"Array of voice message logs, one object per each message.",
"items":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.LogsReport"
}
}
},
"title":"LogsResponse"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.MachineDetection":{
"type":"string",
"description":"Machine Detection action detects answering machines at the beginning of the call. This action sets `machineAnswered` variable upon completion to `true` or `false`. Machine Detection introduces a delay of approximately 4s. This is the minimum time needed for machine detection. Machine Detection action has to be followed by a condition action that uses the value of `machineAnswered` for branching into the 'human answered' block and the 'answering machine answered' block. The 'answering machine' block can have a Say/Play/PlayFromRecording action or a Hangup action.",
"enum":[
"machineDetection"
],
"required":[
"machineDetection"
],
"title":"Machine Detection (Simple)"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Numbers":{
"type":"object",
"properties":{
"number":{
"type":"string",
"description":"Must be a valid [E.164](https://en.wikipedia.org/wiki/E.164) number; the parameter can be constructed using variables"
}
},
"required":[
"number"
],
"title":"Numbers"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Pause":{
"type":"object",
"description":"Pause action pauses execution of the IVR scenario for the provided duration.",
"properties":{
"pause":{
"type":"number",
"format":"double",
"description":"the amount to wait in seconds, from 0 (exclusive) to 5 (inclusive)",
"exclusiveMinimum":0,
"maximum":5,
"minimum":0
},
"actionId":{
"type":"integer",
"format":"int32",
"description":"User-defined ID of an action that can be used with go-to action."
}
},
"required":[
"pause"
],
"title":"Pause"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Play":{
"type":"object",
"description":"Play action performs playback of audio provided by the client’s URL. Supported formats of the provided file are aac, aiff, m4a, mp2, mp3, mp4 (audio only), ogg, wav and wma. Our platform needs to have permission to make GET and HEAD HTTP requests on the provided URL. Standard http ports (like 80, 8080, etc.) are advised.",
"properties":{
"playFromUrl":{
"type":"string",
"description":"Audio file URL. The parameter can be constructed using variables."
},
"actionId":{
"type":"integer",
"format":"int32",
"description":"User-defined ID of an action that can be used with go-to action."
},
"options":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.PlayOptions"
}
},
"required":[
"playFromUrl"
],
"title":"Play"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.PlayFromRecording":{
"type":"object",
"description":"Play from Recording Action plays audio recorded from the current or some other call.",
"properties":{
"playFromRecording":{
"type":"string",
"description":"Identifier of the recorded file. The parameter can be constructed using variables."
},
"actionId":{
"type":"integer",
"format":"int32",
"description":"User-defined ID of an action that can be used with go-to action."
}
},
"required":[
"playFromRecording"
],
"title":"Play From Recording"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.PlayFromUpload":{
"type":"object",
"description":"Play From Upload action performs playback of uploaded audio file. Not available in inbound IVR at the moment.",
"properties":{
"playFromUpload":{
"type":"string",
"description":"ID of uploaded file. The parameter can be constructed using variables."
},
"options":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.PlayFromUploadOptions"
},
"actionId":{
"type":"integer",
"format":"int32",
"description":"User-defined ID of an action that can be used with go-to action."
}
},
"required":[
"playFromUpload"
],
"title":"Play From Upload"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.PlayFromUploadOptions":{
"type":"object",
"properties":{
"loopCount":{
"type":"integer",
"format":"int32",
"description":"Number of times the file will be played. Valid values are from 1 to 10.",
"maximum":10,
"minimum":1
}
},
"title":"PlayFromUploadOptions"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.PlayOptions":{
"type":"object",
"properties":{
"loopCount":{
"type":"integer",
"format":"int32",
"description":"Number of times the file will be played.",
"maximum":10,
"minimum":1
}
},
"title":"PlayOptions"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.PlayTty":{
"type":"object",
"description":"Play TTY action converts the provided text into Baudot tones and plays the generated audio, enabling the message to be displayed on a connected TTY device. This action is designed to support IVR scenarios adapted for users with hearing impairments.",
"properties":{
"playTty":{
"type":"string",
"description":"Text that will be played in Baudot tones. The parameter can be constructed using variables."
},
"options":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.PlayTtyOptions"
},
"actionId":{
"type":"integer",
"format":"int32",
"description":"User-defined ID of an action that can be used with go-to action."
}
},
"required":[
"playTty"
],
"title":"Play TTY"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.PlayTtyOptions":{
"type":"object",
"properties":{
"loopCount":{
"type":"integer",
"format":"int32",
"description":"Number of times the message will be played.",
"maximum":10,
"minimum":1
}
},
"title":"PlayTtyOptions"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Price":{
"type":"object",
"description":"Sent voice message price.",
"properties":{
"pricePerSecond":{
"type":"number",
"description":"Price per one second of the voice message."
},
"currency":{
"type":"string",
"description":"The currency in which the price is expressed."
}
},
"title":"Price"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Record":{
"type":"object",
"description":"Record action records a portion of the call. The recording starts at the moment where the Record action is added in the IVR.",
"properties":{
"record":{
"type":"integer",
"format":"int32",
"description":"The duration to record for in seconds; null for unlimited."
},
"options":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.RecordOptions"
},
"actionId":{
"type":"integer",
"format":"int32",
"description":"User-defined ID of an action that can be used with go-to action."
}
},
"required":[
"record"
],
"title":"Record"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.RecordOptions":{
"type":"object",
"properties":{
"escapeDigits":{
"type":"string",
"description":"DTMF codes which should stop recording when input by the user."
},
"beep":{
"type":"boolean",
"description":"Flag indicating a beep sound should be played at the start of the recording."
},
"maxSilence":{
"type":"integer",
"format":"int32",
"description":"The amount of silence to wait for before stopping the recording."
},
"identifier":{
"type":"string",
"description":"The identifier for the recording. Identified recordings can be reused in Play from Recording. The parameter can be constructed using variables."
}
},
"title":"RecordOptions"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.RecordedAudioFilesResponse":{
"type":"object",
"properties":{
"files":{
"type":"array",
"description":"Array of recorded files metadata, one for each recorded file.",
"items":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.RecordedIvrFile"
}
}
},
"title":"RecordedAudioFilesResponse"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.RecordedIvrFile":{
"type":"object",
"description":"Array of recorded files metadata, one for each recorded file.",
"properties":{
"messageId":{
"type":"string",
"description":"The ID that uniquely identifies the sent message."
},
"from":{
"type":"string",
"description":"Numeric sender ID."
},
"to":{
"type":"string",
"description":"Destination address."
},
"scenarioId":{
"type":"string",
"description":"Scenario key."
},
"groupId":{
"type":"string",
"description":"Differentiates recordings made by separate Record actions."
},
"url":{
"type":"string",
"description":"Relative URL path to the recorded file. To download the audio, just perform a GET request using the relative URL of a specific file. The returned audio data is encoded as PCM 16bit 8kHz WAVE audio. The files are available on Infobip servers for 2 months."
},
"recordedAt":{
"type":"string",
"format":"date-time",
"description":"The time the recording took place."
}
},
"title":"RecordedIvrFile"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.RepeatWhile":{
"type":"object",
"description":"Repeat-While action is a control flow statement that repeatedly executes a block of code, as long as the boolean condition in the while field is true. Comparison is done using equal (==) or not equal (!=) operators. Make sure not to provide a condition that causes an infinite loop.",
"properties":{
"repeat":{
"type":"array",
"description":"Array of actions to execute.",
"items":{
"type":"object",
"description":"Array of actions to execute."
}
},
"while":{
"type":"string",
"description":"The expression to evaluate."
}
},
"required":[
"repeat",
"while"
],
"title":"Repeat While"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Report":{
"type":"object",
"description":"Arrays of delivery reports, one object for every message.",
"properties":{
"bulkId":{
"type":"string",
"description":"The ID that uniquely identifies the bulk of messages."
},
"messageId":{
"type":"string",
"description":"The ID that uniquely identifies the message sent."
},
"from":{
"type":"string",
"description":"The sender ID which can be alphanumeric or numeric."
},
"to":{
"type":"string",
"description":"Destination address of the voice message."
},
"sentAt":{
"type":"string",
"description":"Date and time when the voice message was initiated. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`."
},
"mccMnc":{
"type":"string",
"description":"Mobile country and network codes."
},
"callbackData":{
"type":"string",
"description":"Custom data sent over to the notifyUrl."
},
"voiceCall":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.VoiceData"
},
"price":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Price"
},
"status":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SingleMessageStatus"
},
"error":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.VoiceError"
}
},
"title":"Report"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.ReportResponse":{
"type":"object",
"properties":{
"results":{
"type":"array",
"description":"Arrays of delivery reports, one object for every message.",
"items":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Report"
}
}
},
"title":"ReportResponse"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Retry":{
"type":"object",
"description":"Used to define if the delivery of the Voice messages should be retried in case the first try doesn't succeed. Additional retries will be made according to the schedule defined by _minPeriod_ and _maxPeriod_ parameters and platform's internal retry logic. If the _minPeriod_ differs _maxPeriod_, delivery will be retried in the following manner: after 1 min, 2 min, 5 min, 10 min, 20 min, 30 min, 1 hour, 2 hours, 4 hours, 8 hours, 16 hours, 24 hours or until maxPeriod is reached. If the retry attempt for the _maxPeriod_ is reached, the _maxPeriod_ will be used for all subsequent retries. If the _minPeriod_ and the _maxPeriod_ are defined as equal values, the period of time between retries will be equal to this value. Message delivery will be retried until the successful delivery or message validity or _maxCount_ value is reached.",
"properties":{
"maxCount":{
"type":"integer",
"format":"int32",
"description":"Specify the maximum number of retry attempts. Maximum value of the maxCount is `4`. If the value is higher than `4`, it will be set to `4`."
},
"maxPeriod":{
"type":"integer",
"format":"int32",
"description":"Defines the maximum waiting time (in minutes) after the previous failed attempt to try to deliver the message again. Supported values are 1 min, 2 min, 5 min, 10 min, 20 min, 30 min, 1 hour, 2 hours, 4 hours, 8 hours, 16 hours, 24 hours. If entered a value that isn't from the previous list but that's smaller than 24 hours, it is used the next bigger value from the list. If entered value that is bigger than 24 hours than it is used 24 hours."
},
"minPeriod":{
"type":"integer",
"format":"int32",
"description":"Defines the minimal waiting time (in minutes) after the previous failed attempt to try to deliver the message again. Supported values are 1 min, 2 min, 5 min, 10 min, 20 min, 30 min, 1 hour, 2 hours, 4 hours, 8 hours, 16 hours, 24 hours. If entered a value that isn't from the previous list but that's smaller than 24 hours, it is used the next bigger value from the list. If entered value that is bigger than 24 hours than it is used 24 hours."
}
},
"required":[
"maxCount",
"maxPeriod",
"minPeriod"
],
"title":"Retry"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Say":{
"type":"object",
"description":"Say action converts provided text into an audio file which is played during the call based on the provided parameters. Message text can be up to 1400 characters long.",
"properties":{
"say":{
"type":"string",
"description":"Message text. SSML (_Speech Synthesis Markup Language_) is supported and can be used to fully customize pronunciation of the provided text. The parameter can be constructed using variables.",
"externalDocs":{
"description":"SSML support",
"url":"https://www.infobip.com/docs/voice-and-video/reference#ssml-support-text-to-speech-languages"
}
},
"options":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SayOptions"
},
"actionId":{
"type":"integer",
"format":"int32",
"description":"User-defined ID of an action that can be used with go-to action."
}
},
"required":[
"say"
],
"title":"Say"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SayOptions":{
"type":"object",
"properties":{
"language":{
"type":"string",
"description":"Must be defined for correct pronunciation. The parameter can be constructed using variables."
},
"voice":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.VoiceOptions"
},
"speechRate":{
"type":"number",
"format":"double",
"description":"Must be within [0.5 - 2.0] range, default value is 1.",
"maximum":2,
"minimum":0.5
}
},
"title":"SayOptions"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Script":{
"type":"array",
"description":"Array of IVR actions defining scenario. NOTE: Answering Machine Detection, Call Recording and Speech Recognition (used for Capture action) are add-on features. To enable these add-ons, please contact our [sales](https://www.infobip.com/contact) organisation.",
"items":{
"oneOf":[
{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.CallApi"
},
{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Capture"
},
{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Collect"
},
{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Dial"
},
{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DialToMany"
},
{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DialToConversations"
},
{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.ForEach"
},
{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.GoTo"
},
{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Hangup"
},
{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.IfThenElse"
},
{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.MachineDetection"
},
{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.AnsweringMachineDetection"
},
{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Pause"
},
{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Play"
},
{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.PlayFromRecording"
},
{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.PlayFromUpload"
},
{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.PlayTty"
},
{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Record"
},
{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.RepeatWhile"
},
{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Say"
},
{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SendSms"
},
{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SetVariable"
},
{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SwitchCase"
},
{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.WhileDo"
}
]
},
"title":"Script"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SearchResponse":{
"type":"object",
"properties":{
"createTime":{
"type":"string",
"format":"date-time",
"description":"Creation timestamp."
},
"description":{
"type":"string",
"description":"Scenario description."
},
"id":{
"type":"string",
"description":"Scenario key. It is used for launching IVR scenario."
},
"name":{
"type":"string",
"description":"Scenario name."
},
"notifyUrl":{
"type":"string",
"description":"The URL on the client's callback server on which the Delivery report will be sent."
},
"notifyContentType":{
"type":"string",
"description":"Preferred Delivery report content type. Can be `application/json` or `application/xml`."
},
"record":{
"type":"boolean",
"description":"Indicates if all calls using the scenario should be recorded."
},
"script":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Script"
},
"updateTime":{
"type":"string",
"format":"date-time",
"description":"Update timestamp"
},
"lastUsageDate":{
"type":"string",
"format":"date",
"description":"Last usage date. `null` for scenarios that are used last time before `2024-01-01`."
}
},
"title":"SearchResponse"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SendSms":{
"type":"object",
"description":"Send SMS action creates and sends a text message from the scenario.",
"properties":{
"sendSms":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SendSmsData"
},
"actionId":{
"type":"integer",
"format":"int32",
"description":"User-defined ID of an action that can be used with go-to action."
}
},
"required":[
"sendSms"
],
"title":"Send SMS"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SendSmsData":{
"type":"object",
"properties":{
"text":{
"type":"string",
"description":"The text of the message that will be sent."
},
"from":{
"type":"string",
"description":"Represents sender ID and it can be alphanumeric or numeric; alphanumeric sender ID length should be between 3 and 11 characters; numeric sender ID length should be between 3 and 14 characters; the parameter can be constructed using variables"
},
"to":{
"type":"string",
"description":"Must be a valid E164 MSISDN; the parameter can be constructed using variables"
}
},
"required":[
"from",
"text",
"to"
],
"title":"SendSmsData"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SendToReports":{
"type":"string",
"description":"Choose if you want to show DTMF inputs in Voice reports and logs. Options are: ALWAYS (always send - default value), MASKED (send masked - xxxx will be shown in reports and logs), NEVER (don't send - DTMF inputs will not be shown in reports and logs).",
"enum":[
"ALWAYS",
"MASKED",
"NEVER"
],
"title":"SendToReports"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SendingSpeed":{
"type":"object",
"description":"Sending rate defined in number of messages sent per second, minute, hour or day. You may wish to use this to allow your systems or agents to handle large amounts of incoming traffic. Not setting a send speed limit can overwhelm your resources with incoming traffic. If this parameter is defined, _validityPeriod_ is ignored.",
"properties":{
"speed":{
"type":"integer",
"format":"int32",
"description":"Defines the number of messages that will be sent per specified time unit."
},
"timeUnit":{
"type":"string",
"description":"Defines time unit used for calculating sending speed. Possible values: `second`, `minute`, `hour` and `day`."
}
},
"title":"SendingSpeed"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SetVariable":{
"type":"object",
"description":"Set variable action makes it possible to set a variable defined inside the IVR scenario to a specified value.",
"properties":{
"setVariable":{
"type":"string",
"description":"Name of a variable."
},
"value":{
"type":"string",
"description":"Value to which the variable should be set. The parameter can be constructed using variables."
}
},
"required":[
"setVariable",
"value"
],
"title":"Set Variable"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SingleMessageStatus":{
"type":"object",
"description":"Indicates whether the message is successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status.",
"externalDocs":{
"description":"Response status and error codes",
"url":"https://www.infobip.com/docs/essentials/api-essentials/response-status-and-error-codes"
},
"properties":{
"groupId":{
"type":"integer",
"format":"int32",
"description":"Status group ID."
},
"groupName":{
"type":"string",
"description":"Status group name that describes which category the status code belongs to, e.g. PENDING, UNDELIVERABLE, DELIVERED, EXPIRED, REJECTED."
},
"id":{
"type":"integer",
"format":"int32",
"description":"Status ID."
},
"name":{
"type":"string",
"description":"Status name."
},
"description":{
"type":"string",
"description":"Human-readable description of the status."
}
},
"title":"SingleMessageStatus"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SpeechOptions":{
"type":"object",
"properties":{
"language":{
"type":"string",
"description":"Language used in speech that needs to be captured. For full list of supported languages see [Supported languages](https://www.infobip.com/docs/voice-and-video/interactive-voice-response-ivr#speech-recognition-supported-languages-ivr-over-api)."
},
"keyPhrases":{
"type":"array",
"description":"Array of keyphrases used for matching capturing speech. If full captured text contains one of the specified phrases, that phrase will be set in variable specified in capture parameter. If keyphrases are not set or no matching is done, variable will be set to empty string. Every keyphrase can contain up to 5 words and number of keyphrases is not limited.",
"items":{
"type":"string",
"description":"Array of keyphrases used for matching capturing speech. If full captured text contains one of the specified phrases, that phrase will be set in variable specified in capture parameter. If keyphrases are not set or no matching is done, variable will be set to empty string. Every keyphrase can contain up to 5 words and number of keyphrases is not limited."
}
},
"maxSilence":{
"type":"integer",
"format":"int32",
"description":"If used, this parameter defines the number of seconds of silence that will stop capturing. For example value of 3 defines that capturing stops as soon as 3 seconds of silence is detected or when timeout expires, whichever happens first. Minimum value is 1 and maximum value is 5. The value must be lower than the timeout value.",
"maximum":5,
"minimum":1
}
},
"required":[
"language",
"maxSilence"
],
"title":"SpeechOptions"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.StandardVoiceResponse":{
"type":"object",
"properties":{
"bulkId":{
"type":"string",
"description":"The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address."
},
"messages":{
"type":"array",
"description":"Array of sent messages, one object per every message.",
"items":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.VoiceResponseDetails"
}
}
},
"title":"StandardVoiceResponse"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SwitchCase":{
"type":"object",
"description":"Switch-Case action takes a saved variable (obtained via either a Collect, Call API action or scenario parameters) and performs flow control based on it. It works similarly to the switch case block, using case-sensitive comparison.",
"properties":{
"switch":{
"type":"string",
"description":"Name of the variable whose value to inspect."
},
"case":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.CaseObject"
},
"actionId":{
"type":"integer",
"format":"int32",
"description":"User-defined ID of an action that can be used with go-to action."
}
},
"required":[
"case",
"switch"
],
"title":"Switch Case"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SynthesisVoiceResponse":{
"type":"object",
"description":"Array of voices belonging to the specified language.",
"properties":{
"name":{
"type":"string",
"description":"Name of the voice. Example: `Joanna`"
},
"gender":{
"type":"string",
"description":"Gender of the voice. Can be `male` or `female`."
},
"supplier":{
"type":"string",
"description":"Name of the supplier for text to speech synthesis."
},
"ssmlSupported":{
"type":"boolean",
"description":"Indicates if SSML is supported."
},
"default":{
"type":"boolean"
},
"neural":{
"type":"boolean"
},
"isDefault":{
"type":"boolean",
"description":"Indicates whether voice is default voice for a given language. If voice is not chosen for the language, then default voice will be used."
},
"isNeural":{
"type":"boolean",
"description":"Indicates whether voice is neural. Using neural voice will generate additional cost."
}
},
"title":"SynthesisVoiceResponse"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.TagIdentifierType":{
"type":"string",
"description":"Defines which identifier will be provided in the tags field. Possible values are ID and NAME. If not provided, default value of NAME is used.",
"enum":[
"ID",
"NAME"
],
"title":"TagIdentifierType"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.UpdateScenarioRequest":{
"type":"object",
"properties":{
"name":{
"type":"string",
"description":"The name of IVR scenario."
},
"description":{
"type":"string",
"description":"Description of IVR scenario."
},
"notifyUrl":{
"type":"string",
"description":"The URL on your callback server on which the Delivery report will be sent."
},
"notifyContentType":{
"type":"string",
"description":"Preferred Delivery report content type. Can be `application/json` or `application/xml`."
},
"record":{
"type":"boolean",
"description":"Indicates if all calls using the scenario should be recorded."
},
"script":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Script"
}
},
"required":[
"name",
"script"
],
"title":"UpdateScenarioRequest"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.UpdateScenarioResponse":{
"type":"object",
"properties":{
"createTime":{
"type":"string",
"format":"date-time",
"description":"Creation timestamp."
},
"description":{
"type":"string",
"description":"Scenario description."
},
"id":{
"type":"string",
"description":"Scenario key. It is used for launching IVR scenario."
},
"name":{
"type":"string",
"description":"Scenario name."
},
"notifyUrl":{
"type":"string",
"description":"The URL on the client's callback server on which the Delivery report will be sent."
},
"notifyContentType":{
"type":"string",
"description":"Preferred Delivery report content type. Can be `application/json` or `application/xml`."
},
"record":{
"type":"boolean",
"description":"Indicates if all calls using the scenario should be recorded."
},
"script":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Script"
},
"updateTime":{
"type":"string",
"format":"date-time",
"description":"Update timestamp."
},
"lastUsageDate":{
"type":"string",
"format":"date",
"description":"Last usage date. `null` for scenarios that are used last time before `2024-01-01`."
}
},
"title":"UpdateScenarioResponse"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.UrlAudioContent":{
"type":"object",
"description":"Audio content from a URL. Use this when the audio file is hosted at an external URL.",
"properties":{
"fileUrl":{
"type":"string",
"description":"Audio file URL."
},
"type":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.AudioContentType"
}
},
"required":[
"fileUrl",
"type"
],
"title":"UrlAudioContent"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.VoiceData":{
"type":"object",
"description":"Fields representing details specific for voice messages.",
"properties":{
"feature":{
"type":"string",
"description":"Name of the Infobip Voice service or feature."
},
"startTime":{
"type":"string",
"description":"Date and time when the voice message was established and started ringing. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ."
},
"answerTime":{
"type":"string",
"description":"Date and time when the voice message was answered. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ."
},
"endTime":{
"type":"string",
"description":"Date and time when the voice message was ended. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ."
},
"duration":{
"type":"integer",
"format":"int32",
"description":"Duration of the voice message, in seconds."
},
"chargedDuration":{
"type":"integer",
"format":"int32",
"description":"Charged duration of the voice message, in seconds."
},
"fileDuration":{
"type":"number",
"format":"double",
"description":"Duration of the voice message audio file, in seconds."
},
"direction":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.CallDirection"
},
"dtmfCodes":{
"type":"string",
"description":"DTMF code entered by user. Can be empty string, if user did not press anything, or `null` in case of IVR if user did not participate in Collect action."
},
"answeredBy":{
"type":"string",
"description":"If machine detection is used, contains the result of the machine detection (`HUMAN` or `MACHINE`)."
},
"callRecordingFileId":{
"type":"string",
"description":"Call recording file identification, if the call was recorded. Currently, populated only if the call was IVR."
},
"ivr":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.IvrData"
}
},
"title":"VoiceData"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.VoiceError":{
"type":"object",
"description":"Indicates whether the error occurred during the query execution.",
"externalDocs":{
"description":"Response status and error codes",
"url":"https://www.infobip.com/docs/essentials/api-essentials/response-status-and-error-codes"
},
"properties":{
"groupId":{
"type":"integer",
"format":"int32",
"description":"Error group ID."
},
"groupName":{
"type":"string",
"description":"Error group name."
},
"id":{
"type":"integer",
"format":"int32",
"description":"Error ID."
},
"name":{
"type":"string",
"description":"Error name."
},
"description":{
"type":"string",
"description":"Human-readable description of the error."
},
"permanent":{
"type":"boolean",
"description":"Tells if the error is permanent."
}
},
"title":"VoiceError"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.VoiceOptions":{
"type":"object",
"properties":{
"name":{
"type":"string",
"description":"Name of the voice in which the text would be synthesized. The parameter can be constructed using variables."
},
"gender":{
"type":"string",
"description":"Gender in which the text would be synthesized. The parameter can be constructed using variables."
}
},
"title":"VoiceOptions"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.VoiceReport":{
"type":"object",
"description":"Arrays of delivery reports, one object for every message.",
"properties":{
"bulkId":{
"type":"string",
"description":"The ID that uniquely identifies the bulk of messages."
},
"messageId":{
"type":"string",
"description":"The ID that uniquely identifies the message sent."
},
"to":{
"type":"string",
"description":"Destination address of the voice message."
},
"sentAt":{
"type":"string",
"description":"Date and time when the voice message was initiated. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ."
},
"doneAt":{
"type":"string",
"description":"Date and time when the Infobip services finished processing the voice message (i.e. delivered to the destination, delivered to the destination network, etc.). Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ."
},
"startTime":{
"type":"string",
"description":"Date and time when the voice message was established and started ringing. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ."
},
"endTime":{
"type":"string",
"description":"Date and time when the voice message was ended. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ."
},
"answerTime":{
"type":"string",
"description":"Date and time when the voice message was answered. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ."
},
"duration":{
"type":"integer",
"format":"int32",
"description":"Duration of the voice message, in seconds."
},
"fileDuration":{
"type":"number",
"format":"double",
"description":"Duration of the voice message audio file, in seconds."
},
"mccMnc":{
"type":"string",
"description":"Mobile country and network codes."
},
"callbackData":{
"type":"string",
"description":"Custom data sent over to the notifyUrl."
},
"dtmfCodes":{
"type":"string",
"description":"DTMF code entered by user. Can be empty string, if user did not press anything, or `null` in case of IVR if user did not participate in Collect action."
},
"recordedAudioFileUrl":{
"type":"string",
"description":"Url to retrieve recorded calls that were made by voice messages with the record feature activated. Using that URL with GET method will initiate the download of the recorded file. If using a REST testing client, make sure to save the downloaded data instead of displaying it in the client’s response area. Recordings are encoded as PCM WAVE signed little-endian 16bit 8kHz audio files."
},
"scenarioId":{
"type":"string",
"description":"The ID that uniquely identifies the IVR scenario."
},
"scenarioName":{
"type":"string",
"description":"Name of IVR scenario."
},
"price":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Price"
},
"status":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SingleMessageStatus"
},
"error":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.VoiceError"
}
},
"title":"VoiceReport"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.VoiceReportResponse":{
"type":"object",
"properties":{
"results":{
"type":"array",
"description":"Arrays of delivery reports, one object for every message.",
"items":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.VoiceReport"
}
}
},
"title":"VoiceReportResponse"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.VoiceResponseDetails":{
"type":"object",
"description":"Array of sent messages, one object per every message.",
"properties":{
"to":{
"type":"string",
"description":"The message destination address."
},
"status":{
"$ref":"#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SingleMessageStatus"
},
"messageId":{
"type":"string",
"description":"The ID that uniquely identifies the message sent."
}
},
"title":"VoiceResponseDetails"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.WaitForEom":{
"type":"string",
"description":"Indicates whether end of the message detection is enabled for the call. `ALWAYS` specifies that after detection of `MACHINE` the script will always wait for the end of the message before executing actions defined in `onMachineDetected`. `NEVER` specifies that after detection of `MACHINE` actions defined in `onMachineDetected` will be executed immediately. `ON_DETECTING` specifies that end of the message will be respected as long as actions in `onDetecting` are in progress, once these actions finish the script jumps to `onMachineDetected` section immediately.",
"enum":[
"ALWAYS",
"NEVER",
"ON_DETECTING"
],
"title":"WaitForEom"
},
"13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.WhileDo":{
"type":"object",
"description":"While-Do action executes the do field block of code as long as a specified condition is true in the while field. As with Repeat-While, comparison is done using equal (==) or not equal (! =) operators. Make sure not to provide a condition that causes an infinite loop.",
"properties":{
"while":{
"type":"string",
"description":"The expression to evaluate."
},
"do":{
"type":"array",
"description":"Array of actions to execute if none of the conditions above are met.",
"items":{
"type":"object",
"description":"Array of actions to execute if none of the conditions above are met."
}
}
},
"required":[
"do",
"while"
],
"title":"While Do"
},
"14b5f31f4f292db4a32c4e61928f9a47f8ff4c0a1c06a38af2c29ef9ca05095d.DialogAcceptTransferRequest":{
"type":"object",
"properties":{
"targetCallRequest":{
"$ref":"#/components/schemas/5fc49137a7b003ca1d8c4957601417b8ed884356b7fbc49afe416dd5c098a0bd.DialogCallRequest"
}
},
"required":[
"targetCallRequest"
],
"title":"DialogAcceptTransferRequest"
},
"14b5f31f4f292db4a32c4e61928f9a47f8ff4c0a1c06a38af2c29ef9ca05095d.DialogBroadcastWebrtcTextRequest":{
"type":"object",
"properties":{
"text":{
"type":"string",
"description":"Text to broadcast."
}
},
"title":"DialogBroadcastWebrtcTextRequest"
},
"14b5f31f4f292db4a32c4e61928f9a47f8ff4c0a1c06a38af2c29ef9ca05095d.DialogPlayRequest":{
"type":"object",
"properties":{
"loopCount":{
"type":"integer",
"format":"int32",
"description":"Number of times the file will be played."
},
"content":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicPlayContent"
}
},
"required":[
"content"
],
"title":"DialogPlayRequest"
},
"14b5f31f4f292db4a32c4e61928f9a47f8ff4c0a1c06a38af2c29ef9ca05095d.DialogRecordingRequest":{
"type":"object",
"properties":{
"recordingType":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingType"
},
"dialogComposition":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogRecordingComposition"
},
"customData":{
"type":"object",
"additionalProperties":{
"type":"string"
},
"description":"Custom data."
},
"filePrefix":{
"type":"string",
"description":"Custom name for the recording's zip file. Applicable only when SFTP server is enabled on [Voice settings page](https://portal.infobip.com/apps/voice/recording/settings).\nUsing the same filePrefix will override the files on the SFTP server.\nFor recordings without composition, `callId` and `fileId` will be appended to the `filePrefix` value."
}
},
"required":[
"recordingType"
],
"title":"DialogRecordingRequest"
},
"14b5f31f4f292db4a32c4e61928f9a47f8ff4c0a1c06a38af2c29ef9ca05095d.DialogSayRequest":{
"type":"object",
"properties":{
"text":{
"type":"string",
"description":"Text to read."
},
"language":{
"type":"string",
"description":"Text language. Must be defined for correct pronunciation. For more details on available languages and voices, see our [documentation](https://www.infobip.com/docs/voice-and-video/outbound-calls#text-to-speech-voice-over-broadcast).",
"enum":[
"ar",
"ar-ma",
"ar_xa",
"bg",
"bn",
"bn-in",
"ca",
"cmn-cn",
"cs",
"da",
"de",
"de-at",
"de-ch",
"el",
"en",
"en-au",
"en-ca",
"en-gb",
"en-gb-wls",
"en-ie",
"en-in",
"en-ph",
"es",
"es-419",
"es-ar",
"es-co",
"es-mx",
"es-us",
"et-ee",
"fi",
"fil-ph",
"fr",
"fr-ca",
"fr-ch",
"gu",
"he",
"hi",
"hr",
"hu",
"id",
"is",
"it",
"ja",
"kk-kz",
"kn",
"ko",
"lt",
"lv",
"ml",
"mr-in",
"ms",
"nb-no",
"nl",
"nl-be",
"no",
"pa-in",
"pl",
"pt-br",
"pt-pt",
"ro",
"ru",
"sk",
"sl",
"sr-rs",
"sv",
"sw-ke",
"sw-tz",
"ta",
"te",
"th",
"tr",
"uk",
"ur-in",
"ur-pk",
"uz-uz",
"vi",
"wls",
"yue-hk",
"zh-cn",
"zh-tw"
]
},
"speechRate":{
"type":"number",
"format":"double",
"description":"Speech rate. Must be within `[0.5 - 2.0]` range, default value is `1`."
},
"loopCount":{
"type":"integer",
"format":"int32",
"description":"Number of times to read the text."
},
"preferences":{
"$ref":"#/components/schemas/08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.PublicVoicePreferences"
}
},
"required":[
"language",
"text"
],
"title":"DialogSayRequest"
},
"14b5f31f4f292db4a32c4e61928f9a47f8ff4c0a1c06a38af2c29ef9ca05095d.DialogSendMessageRequest":{
"type":"object",
"properties":{
"message":{
"type":"string",
"description":"Message to send."
}
},
"required":[
"message"
],
"title":"DialogSendMessageRequest"
},
"1a32a5811401e5289f9edb3a3b051fee21e1ffff7ad179f3aead79d4a871821d.ApiException":{
"type":"object",
"properties":{
"requestError":{
"$ref":"#/components/schemas/ApiRequestError"
}
},
"title":"ApiException"
},
"1e938b22275568ebc747d21724b50c9be18ff5770eb33c37b76fda4633c14bde.RouteOrderRequest":{
"type":"object",
"description":"Route request object.",
"properties":{
"order":{
"type":"integer",
"format":"int32",
"description":"Route order.",
"minimum":1
}
},
"required":[
"order"
],
"title":"RouteOrderRequest"
},
"1e938b22275568ebc747d21724b50c9be18ff5770eb33c37b76fda4633c14bde.RouteRequest":{
"type":"object",
"description":"Route request object.",
"properties":{
"name":{
"type":"string",
"description":"Route name."
},
"criteria":{
"type":"array",
"description":"List of criteria used to match a route. For a route to match, any criterion should be met.",
"items":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SearchCriteria"
}
},
"destinations":{
"type":"array",
"description":"List of destinations. First destination in the list is the first one to be executed. Subsequent destinations are executed only if the previous one fails.",
"items":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Destination"
},
"maxItems":10,
"minItems":1
},
"transferOnly":{
"type":"boolean",
"default":false,
"description":"Indicates whether this route should be used exclusively for call transfers initiated via the REFER SIP message. The `to` number value will be taken from the `Refer-To` header."
}
},
"required":[
"destinations",
"name"
],
"title":"RouteRequest"
},
"1e938b22275568ebc747d21724b50c9be18ff5770eb33c37b76fda4633c14bde.RouteResponse":{
"type":"object",
"description":"Route response object.",
"properties":{
"id":{
"type":"string",
"description":"Unique identifier of a route."
},
"name":{
"type":"string",
"description":"Route name."
},
"criteria":{
"type":"array",
"description":"List of criteria that should match route. For a route to match, any criterion should be met.",
"items":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SearchCriteria"
}
},
"destinations":{
"type":"array",
"description":"List of destinations. First destination in the list is the first one to be executed. Subsequent destinations are executed only if the previous one fails.",
"items":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Destination"
},
"maxItems":10,
"minItems":1
},
"status":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RouteStatus"
},
"order":{
"type":"integer",
"format":"int32",
"description":"Indicates priority index of the route. Routes with lower priority index are executed first. "
},
"transferOnly":{
"type":"boolean",
"description":"Indicates whether this route should be used exclusively for call transfers initiated via the REFER SIP message. The `to` number value will be taken from the `Refer-To` header."
}
},
"required":[
"destinations",
"id",
"name",
"status"
],
"title":"RouteResponse"
},
"1e938b22275568ebc747d21724b50c9be18ff5770eb33c37b76fda4633c14bde.RouteStatusRequest":{
"type":"object",
"description":"Route status request object.",
"properties":{
"routeStatus":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RouteStatus"
}
},
"required":[
"routeStatus"
],
"title":"RouteStatusRequest"
},
"27eaa09c2aeef6932f3271ca5bde4158d33d6ab404b64c38db12c844a2084089.RingbackGeneration":{
"type":"object",
"description":"Option to generate a consistent local ringback tone, overriding remote ringing tones. If enabled, the ringback will be generated for existing conference participants, provided they are present before the remote ringback of the new participant starts.",
"properties":{
"enabled":{
"type":"boolean",
"default":false,
"description":"Flag indicating whether ringback generation is enabled. Cannot be `true` when `connectOnEarlyMedia` is `true`."
}
},
"title":"RingbackGeneration"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.AdvancedTtsApiMessage":{
"type":"object",
"description":"Array of messages to be sent, one object per every message",
"properties":{
"from":{
"type":"string",
"description":"Numeric sender ID in E.164 standard format (Example: 41793026727). This is caller ID that will be presented to the end user where applicable."
},
"destinations":{
"type":"array",
"description":"Array of message destination addresses. Maximum number of destination addresses is 20k.",
"items":{
"$ref":"#/components/schemas/97cb4ba23432eb0e600ef0617ae1982d499839ef41226973c71dfb335b3071b8.Destination"
}
},
"audioFileUrl":{
"type":"string",
"description":"An audio file can be delivered as a voice message to the recipients. An audio file must be uploaded online, so that the existing URL can be available for file download. Size of the audio file must be below 4 MB. Supported formats of the provided file are aac, aiff, m4a, mp2, mp3, mp4 (audio only), ogg, wav and wma. Our platform needs to have permission to make GET and HEAD HTTP requests on the provided URL. Standard http ports (like 80, 8080, etc.) are advised."
},
"text":{
"type":"string",
"description":"Text of the message that will be sent. Message text can be up to 1400 characters long and cannot contain only punctuation. Adding _pauses_ between the words and extending the duration of the voice message is possible by using the comma character `“,”`. For example, if you want to have a 3 second pause after each word, then the text parameter should look like this `“one,,,,,,two,,,,,,three,,,,,,”`. Each comma creates a pause of 0.5 seconds. SSML (_Speech Synthesis Markup Language_) is supported and can be used to fully customize pronunciation of the provided text.",
"externalDocs":{
"description":"SSML support",
"url":"https://www.infobip.com/docs/voice-and-video/reference#ssml-support-text-to-speech-languages"
}
},
"language":{
"type":"string",
"description":"If the message is in text format, the language in which the message is written must be defined for correct pronunciation. More about Text-to-speech functionality and supported TTS languages can be found [here](https://www.infobip.com/docs/voice-and-video/outbound-calls#text-to-speech-voice-over-broadcast). If not set, default language is `English [en]`. If voice is not set, then default voice for that specific language is used. In the case of English language, the voice is `[Joanna]`.",
"externalDocs":{
"description":"Voice Text-To-Speech Languages",
"url":"https://www.infobip.com/docs/voice-and-video/reference#text-to-speech-languages"
}
},
"voice":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Voice"
},
"speechRate":{
"type":"number",
"format":"double",
"description":"The reproduction speed of speech in the resulting message. Effective only when using text. Supported range is from `0.5` (slow down speech) to `2` (speed up speech). Values less than `0.5` will be replaced with `0.5`, and values higher than `2` will be replaced with `2`. Default value is `1`."
},
"notifyUrl":{
"type":"string",
"description":"The URL on your callback server on which the Delivery report will be sent."
},
"notifyContentType":{
"type":"string",
"description":"Preferred Delivery report content type. Can be `application/json` or `application/xml`. [Read more](https://www.infobip.com/docs/api#channels/voice/get-voice-delivery-reports)."
},
"notifyContentVersion":{
"type":"integer",
"format":"int32",
"description":"Specifies the version of the Delivery report to be sent. Can be `1` ([deprecated version 1](#programmable-communications/voice/receive-voice-delivery-reports-deprecated)) or `2` ([current version 2](#programmable-communications/voice/receive-voice-delivery-reports)). The default is version 2. [Read more](https://www.infobip.com/docs/api#channels/voice/get-voice-delivery-reports)."
},
"callbackData":{
"type":"string",
"description":"Additional client's data that will be sent on the notifyUrl. The maximum value is 700 characters. Example: `Text containing some additional data needed in Delivery Report`.",
"maxLength":700,
"minLength":0
},
"validityPeriod":{
"type":"integer",
"format":"int32",
"description":"The message validity period shown in minutes. When the period expires, it will not be allowed for the message to be sent. A validity period longer than 48h is not supported (in this case, it will be automatically set to 48h).",
"minimum":1
},
"sendAt":{
"type":"string",
"format":"date-time",
"description":"Used for scheduled Voice messages (message not to be sent immediately, but at scheduled time)."
},
"repeatDtmf":{
"type":"string",
"description":"Specify DTMF code that is used as an indicator to repeat the voice message to the end user. The # key cannot be collected, as it is reserved for user input termination. Message can be repeated up to 5 times."
},
"maxDtmf":{
"type":"integer",
"format":"int32",
"description":"Defines the maximum number of DTMF codes entered by end user that would be collected."
},
"ringTimeout":{
"type":"integer",
"format":"int32",
"description":"Ringing duration, unless there are no operator limitations. Default value is `45`. Note: There are no limitations on the Voice platform regarding this value, however, most of the operators have their own ring timeout limitations and it is advisable to keep the ringTimeout value up to `45` seconds."
},
"dtmfTimeout":{
"type":"integer",
"format":"int32",
"description":"The waiting period for end user to enter DTMF digits. Default value is `10` seconds."
},
"callTimeout":{
"type":"integer",
"format":"int32",
"description":"Maximum possible duration of the call to be set, shown in seconds."
},
"callTransfers":{
"type":"array",
"description":"Call transfers object enables transferring the ongoing call to another recipient(s) and establish a communication between your original recipient and additional one.",
"items":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallTransfer"
}
},
"pause":{
"type":"integer",
"format":"int32",
"description":"Period of time in seconds between end user answering the call and message starting to be played. Minimal value is `0` and maximum value is 10 seconds. Default value is `0`.",
"maximum":10,
"minimum":0
},
"retry":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Retry"
},
"sendingSpeed":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SendingSpeed"
},
"machineDetection":{
"type":"string",
"description":"Used for enabling detection of answering machine after the call has been answered. It can be set to `hangup` or `continue`. When set to `hangup`, if a machine is detected call will hang up. When set to `continue`, if a machine is detected, then voice message starts playing into voice mail after the answering message is finished with its greeting. If machineDetection is used, there is a minimum of 4 seconds detection time, which can result in delay of playing the message. Answering machine detection is additionally charged. For more information please contact your account manager and check documentation on Answering Machine Detection.",
"externalDocs":{
"description":"Answering Machine Detection",
"url":"https://www.infobip.com/docs/voice-and-video/getting-started#answering-machine-detection-add-ons-and-options"
}
},
"deliveryTimeWindow":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.DeliveryTimeWindow"
}
},
"required":[
"destinations"
],
"title":"AdvancedTtsApiMessage"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.AllowedDay":{
"type":"string",
"description":"Allowed day.",
"enum":[
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
"SUNDAY"
],
"title":"AllowedDay"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.AllowedTimeFrom":{
"type":"object",
"description":"The exact time of day to enable call forwarding. Time is expressed in the `UTC` time zone. If not set, defaults to `00:00:00`.",
"properties":{
"hour":{
"type":"integer",
"format":"int32",
"description":"Hour when the time window opens.",
"maximum":23,
"minimum":0
},
"minute":{
"type":"integer",
"format":"int32",
"description":"Minute when the time window opens.",
"maximum":59,
"minimum":0
}
},
"required":[
"hour",
"minute"
],
"title":"AllowedTimeFrom"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.AllowedTimeTo":{
"type":"object",
"description":"The exact time of day to end call forwarding. Time is expressed in the `UTC` time zone. If not set, defaults to `23:59:59`.",
"properties":{
"hour":{
"type":"integer",
"format":"int32",
"description":"Hour when the time window closes.",
"maximum":23,
"minimum":0
},
"minute":{
"type":"integer",
"format":"int32",
"description":"Minute when the time window closes.",
"maximum":59,
"minimum":0
}
},
"required":[
"hour",
"minute"
],
"title":"AllowedTimeTo"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.AllowedTimeWindow":{
"type":"object",
"description":"Sets specific delivery windows outside of which calls won't be forwarded to the destination. If defined, call forwarding is allowed only if any time window in array is satisfied. ",
"properties":{
"from":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.AllowedTimeFrom"
},
"to":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.AllowedTimeTo"
},
"days":{
"type":"array",
"description":"Days for which to apply the `from` and `to` properties. If not set, defaults to all days.",
"items":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.AllowedDay"
}
}
},
"title":"AllowedTimeWindow"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.AmdStatus":{
"type":"string",
"description":"The result of the machine detection process.",
"enum":[
"HUMAN",
"MACHINE",
"MACHINE_EOM_BEEP",
"MACHINE_EOM_SILENCE",
"MACHINE_EOM_TIMEOUT"
],
"example":"HUMAN",
"title":"AmdStatus"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.ApiError":{
"type":"object",
"properties":{
"errorCode":{
"type":"string",
"description":"An error code uniquely identifying the error case."
},
"description":{
"type":"string",
"description":"A detailed description of an error."
},
"action":{
"type":"string",
"description":"An action that should be taken to recover from the error."
},
"violations":{
"type":"array",
"description":"List of violations that caused the error.",
"items":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.ApiErrorViolation"
}
},
"resources":{
"type":"array",
"description":"List of available resources to recover from the error.",
"items":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.ApiErrorResource"
}
}
},
"required":[
"action",
"description",
"errorCode",
"resources",
"violations"
],
"title":"ApiError"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.ApiErrorResource":{
"type":"object",
"description":"List of available resources to recover from the error.",
"properties":{
"name":{
"type":"string",
"description":"Resource name."
},
"url":{
"type":"string",
"description":"Resource URL."
}
},
"title":"ApiErrorResource"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.ApiErrorViolation":{
"type":"object",
"description":"List of violations that caused the error.",
"properties":{
"property":{
"type":"string",
"description":"Request property that caused the error."
},
"violation":{
"type":"string",
"description":"Detailed violation description."
}
},
"title":"ApiErrorViolation"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Application":{
"type":"object",
"description":"Destination application of a route.",
"discriminator":{
"propertyName":"type",
"mapping":{
"INFOBIP_APPLICATION":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.InfobipApplication",
"CALLS_APPLICATION":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallsApplication"
}
},
"properties":{
"type":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.ApplicationType"
},
"customData":{
"type":"object",
"additionalProperties":{
"type":"string"
}
}
},
"required":[
"type"
],
"title":"Application"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.ApplicationCriteria":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Criteria"
},
{
"type":"object",
"properties":{
"callsConfigurationId":{
"type":"string"
}
}
}
],
"required":[
"type"
],
"title":"ApplicationCriteria"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.ApplicationDestination":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Destination"
},
{
"type":"object",
"properties":{
"value":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Application"
},
"priority":{
"type":"integer",
"format":"int32",
"description":"Priority of the destination within a route. Destinations with lower value have higher priority. Either all or no destination need to have this value defined.",
"maximum":100,
"minimum":1
},
"weight":{
"type":"integer",
"format":"int32",
"description":"Weight of the destination within a route. It specifies how much traffic is handled by destination relative to other destinations within the same priority level. Values are evaluated relative to each other and they don't need to add up to 100. Either all or no destination need to have this value defined.",
"maximum":100,
"minimum":1
},
"allowedTimeWindows":{
"type":"array",
"description":"Sets specific delivery windows outside of which calls won't be forwarded to the destination. If defined, call forwarding is allowed only if any time window in array is satisfied. ",
"items":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.AllowedTimeWindow"
}
}
}
}
],
"required":[
"type",
"value"
],
"title":"ApplicationDestination"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.ApplicationType":{
"type":"string",
"enum":[
"CALL_ROUTING"
],
"title":"ApplicationType"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.AsyncMachineDetectionMode":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.MachineDetectionMode"
},
{
"type":"object",
"properties":{
"asyncUrl":{
"type":"string",
"description":"Callback URL for ASYNC mode"
},
"asyncUrlMethod":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.MarkupHttpMethod"
}
}
}
],
"required":[
"asyncUrl",
"asyncUrlMethod"
],
"title":"AsyncMachineDetectionMode"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.BasicUrlSecurityConfig":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.UrlSecurityConfig"
},
{
"type":"object",
"properties":{
"username":{
"type":"string",
"description":"Username."
},
"password":{
"type":"string",
"description":"Password.",
"writeOnly":true
}
}
}
],
"required":[
"password",
"type",
"username"
],
"title":"BasicUrlSecurityConfig"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.BulkStatus":{
"type":"string",
"description":"New status of the bulk.",
"enum":[
"PENDING",
"PAUSED",
"PROCESSING",
"CANCELED",
"FINISHED",
"FAILED"
],
"title":"BulkStatus"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallDirection":{
"type":"string",
"description":"The direction of the call. Possible values are: INBOUND, OUTBOUND.",
"enum":[
"INBOUND",
"OUTBOUND"
],
"example":"INBOUND",
"title":"CallDirection"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallEndpoint":{
"type":"object",
"description":"Call endpoint. Represents a caller for the inbound calls and a callee for the outbound calls.",
"discriminator":{
"propertyName":"type",
"mapping":{
"PHONE":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.PhoneEndpoint",
"SIP":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SipEndpoint",
"WEBRTC":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.WebRtcEndpoint",
"VIBER":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.ViberEndpoint",
"WHATSAPP":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.WhatsAppEndpoint",
"WEBSOCKET":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.WebsocketEndpoint"
}
},
"example":{
"phoneNumber":"41792030000",
"type":"PHONE"
},
"properties":{
"type":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallEndpointType"
}
},
"title":"CallEndpoint"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallEndpointType":{
"type":"string",
"enum":[
"PHONE",
"SIP",
"WEBRTC",
"VIBER",
"WHATSAPP",
"WEBSOCKET"
],
"title":"CallEndpointType"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallRoutingApplication":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/6ee61eb40f9e4619d309dfe8df9b479488b43bcde7df95f6a044b2e14abf591e.RecordingApplication"
},
{
"type":"object",
"properties":{
"routeId":{
"type":"string",
"description":"Route identifier."
},
"routeName":{
"type":"string",
"description":"Route name."
},
"correlationId":{
"type":"string",
"description":"Unique identifier for a call routing recording call."
},
"startTime":{
"type":"string",
"format":"date-time",
"description":"Start time of the call."
},
"endTime":{
"type":"string",
"format":"date-time",
"description":"End time of the call."
}
}
}
],
"required":[
"correlationId",
"type"
],
"title":"CallRoutingApplication"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallTransfer":{
"type":"object",
"description":"Call transfers object enables transferring the ongoing call to another recipient(s) and establish a communication between your original recipient and additional one.",
"properties":{
"callTransferMaxDuration":{
"type":"integer",
"format":"int32",
"description":"Maximum duration of the transferred call, specified in seconds."
},
"equals":{
"type":"string",
"description":"Criteria for establishing call transfer, if `dtmf` is evaluated."
},
"transferTo":{
"type":"string",
"description":"Phone number of the recipient that will receive transferred call. Must be written in E.164 standard (Example: 41793026727)."
},
"if":{
"type":"string",
"description":"Specifies what to evaluate. Can be `dtmf` or `anyDtmf`."
}
},
"required":[
"if",
"transferTo"
],
"title":"CallTransfer"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Callback":{
"type":"object",
"description":"Clients callback where markup language is hosted.",
"properties":{
"url":{
"type":"string",
"description":"URL where markup language is hosted"
},
"errorUrl":{
"type":"string",
"description":"URL where errors will be sent"
},
"method":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.MarkupHttpMethod"
}
},
"required":[
"errorUrl",
"method",
"url"
],
"title":"Callback"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackEndpoint":{
"type":"object",
"description":"Endpoint involved in the call delivered to the Markup Language callback.",
"discriminator":{
"propertyName":"type",
"mapping":{
"PHONE":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackPhoneEndpoint",
"SIP":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackSipEndpoint",
"WEBRTC":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackWebRtcEndpoint",
"VIBER":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackViberEndpoint",
"WHATSAPP":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackWhatsAppEndpoint",
"WEBSOCKET":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackWebsocketEndpoint"
}
},
"example":{
"type":"PHONE",
"phoneNumber":"41793026834"
},
"properties":{
"type":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackEndpointType"
}
},
"required":[
"type"
],
"title":"CallbackEndpoint"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackEndpointType":{
"type":"string",
"enum":[
"PHONE",
"SIP",
"WEBRTC",
"VIBER",
"WHATSAPP",
"WEBSOCKET"
],
"title":"CallbackEndpointType"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackPhoneEndpoint":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackEndpoint"
},
{
"type":"object",
"properties":{
"phoneNumber":{
"type":"string",
"description":"Phone number in the [E.164](https://en.wikipedia.org/wiki/E.164) format.",
"example":"41793026834"
}
}
}
],
"required":[
"phoneNumber",
"type"
],
"title":"CallbackPhoneEndpoint"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackSipEndpoint":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackEndpoint"
},
{
"type":"object",
"properties":{
"username":{
"type":"string",
"description":"SIP endpoint username.",
"example":"alice"
},
"sipTrunkId":{
"type":"string",
"description":"SIP trunk ID.",
"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"customHeaders":{
"type":"object",
"additionalProperties":{
"type":"string",
"example":"{\"X-Client-Session\":\"abc123\"}"
},
"description":"Custom headers. Only headers starting with `X-Client-` prefix will be propagated.",
"example":{
"X-Client-Session":"abc123"
}
}
}
}
],
"required":[
"sipTrunkId",
"type",
"username"
],
"title":"CallbackSipEndpoint"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackUrl":{
"type":"object",
"description":"Callback URL configuration.",
"properties":{
"url":{
"type":"string",
"description":"Callback URL."
},
"method":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.MarkupHttpMethod"
}
},
"required":[
"url"
],
"title":"CallbackUrl"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackViberEndpoint":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackEndpoint"
},
{
"type":"object",
"properties":{
"phoneNumber":{
"type":"string",
"description":"Phone number in the [E.164](https://en.wikipedia.org/wiki/E.164) format.",
"example":"41793026834"
}
}
}
],
"required":[
"phoneNumber",
"type"
],
"title":"CallbackViberEndpoint"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackWebRtcEndpoint":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackEndpoint"
},
{
"type":"object",
"properties":{
"identity":{
"type":"string",
"description":"The identity used to present a user on the Infobip WebRTC platform. Must be unique.",
"example":"alice.smith"
},
"displayName":{
"type":"string",
"description":"A human-readable name for a given identity.",
"example":"Alice Smith"
}
}
}
],
"required":[
"identity",
"type"
],
"title":"CallbackWebRtcEndpoint"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackWebsocketEndpoint":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackEndpoint"
},
{
"type":"object",
"properties":{
"websocketEndpointConfigId":{
"type":"string",
"description":"Websocket endpoint configuration ID.",
"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"identifier":{
"type":"string",
"description":"Optional identifier for websocket calls.",
"example":"call-session-123"
}
}
}
],
"required":[
"type",
"websocketEndpointConfigId"
],
"title":"CallbackWebsocketEndpoint"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackWhatsAppEndpoint":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackEndpoint"
},
{
"type":"object",
"properties":{
"phoneNumber":{
"type":"string",
"description":"Phone number in the [E.164](https://en.wikipedia.org/wiki/E.164) format.",
"example":"41793026834"
}
}
}
],
"required":[
"phoneNumber",
"type"
],
"title":"CallbackWhatsAppEndpoint"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallsApplication":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Application"
},
{
"type":"object",
"properties":{
"applicationId":{
"type":"string",
"description":"ID of an application to which a call is to be transferred."
},
"customData":{
"type":"object",
"additionalProperties":{
"type":"string"
},
"description":"Client defined data passed to the calls application."
},
"timeout":{
"type":"integer",
"format":"int32",
"description":"Time to wait, in seconds, for a receiving application to accept the transfer."
}
}
}
],
"required":[
"applicationId",
"type"
],
"title":"CallsApplication"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CaptureDtmf":{
"type":"object",
"description":"CaptureDtmf action collects DTMF input from the caller.",
"properties":{
"action":{
"type":"string",
"description":"Action discriminator.",
"enum":[
"captureDtmf"
]
},
"callback":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CaptureDtmfCallbackUrl"
},
"maxLength":{
"type":"integer",
"format":"int32",
"default":1,
"description":"Maximum number of digits to capture.",
"maximum":30
},
"timeout":{
"type":"integer",
"format":"int32",
"default":5,
"description":"Timeout in seconds waiting for input.",
"maximum":30,
"minimum":1
},
"terminator":{
"type":"string",
"default":"#",
"description":"DTMF digit that terminates input."
},
"play":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CapturePlayInstruction"
},
"say":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CaptureSayInstruction"
}
},
"required":[
"action",
"callback"
],
"title":"CaptureDtmf"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CaptureDtmfCallbackUrl":{
"type":"object",
"description":"Callback URL configuration for captureDtmf action.",
"properties":{
"url":{
"type":"string",
"description":"Callback URL."
},
"method":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.MarkupHttpMethod"
},
"callOnEmpty":{
"type":"boolean",
"default":false,
"description":"Whether to invoke the callback URL when no DTMF digits were collected."
}
},
"required":[
"url"
],
"title":"CaptureDtmfCallbackUrl"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CapturePlayInstruction":{
"type":"object",
"description":"Audio content to play before capturing DTMF input.",
"properties":{
"content":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.PlayContent"
}
},
"required":[
"content"
],
"title":"CapturePlayInstruction"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CaptureSayInstruction":{
"type":"object",
"description":"Text-to-speech content to say before capturing DTMF input.",
"properties":{
"text":{
"type":"string",
"description":"Text to be spoken."
},
"language":{
"type":"string",
"description":"Text language. Must be defined for correct pronunciation. More info about available languages and voices can be found [here](https://www.infobip.com/docs/voice-and-video/reference#text-to-speech-languages). Use value from Abbreviation column in the table.",
"example":"en"
},
"speechRate":{
"type":"number",
"format":"double",
"default":1,
"description":"Speech rate (0.5 to 2.0).",
"maximum":2,
"minimum":0.5
},
"voicePreferences":{
"$ref":"#/components/schemas/49f1996e051117ce119ddfc3e07857856b24a0d3f7351242fd9c4615508a2845.VoicePreferences"
}
},
"required":[
"text"
],
"title":"CaptureSayInstruction"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.ClickToCallApiMessage":{
"type":"object",
"description":"Array of click to call messages to be sent.",
"properties":{
"from":{
"type":"string",
"description":"Numeric sender ID. Will be shown to _destinationA_."
},
"fromB":{
"type":"string",
"description":"Numeric sender ID in E.164 format. If set, it will be shown to _destinationB_. If not set, _from_ or _destinationA_ will be shown to _destinationB_, depending on the value of _anonymization_."
},
"destinationA":{
"type":"string",
"description":"Original destination address. Address must be in the international format (Example: `41793026727`)."
},
"destinationB":{
"type":"string",
"description":"Destination address to which the call will be transferred after successful answering. Address must be in the international format (Example: `41793026727`)."
},
"messageId":{
"type":"string",
"description":"The ID that uniquely identifies the message sent. It can be defined by you or Infobip will generate unique message ID for this specific call. The field is not mandatory."
},
"audioFileUrl":{
"type":"string",
"description":"An audio file can be delivered as a voice message to the recipients. An audio file must be uploaded online, so that the existing URL can be available for file download. Size of the audio file must be below 4 MB. Supported formats of the provided file are aac, aiff, m4a, mp2, mp3, mp4 (audio only), ogg, wav and wma. Our platform needs to have permission to make GET and HEAD HTTP requests on the provided URL. Standard http ports (like 80, 8080, etc.) are advised."
},
"text":{
"type":"string",
"description":"Text of the message that will be played before call transfer. SSML (Speech Synthesis Markup Language) is supported and can be used to fully customize pronunciation of the provided text."
},
"language":{
"type":"string",
"description":"If the message is in text format, language in which the message is written must be defined for correct pronunciation. In the Languages section, you can find the list of languages that we support. If not set, default language is `English [en].`",
"externalDocs":{
"description":"Voice Text-To-Speech Languages",
"url":"https://www.infobip.com/docs/voice-and-video/reference#text-to-speech-languages"
}
},
"voice":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Voice"
},
"anonymization":{
"type":"boolean",
"description":"If set, same numeric sender (defined in _from_) is used for both calls (towards _destinationA_ and _destinationB_). If not set, _destinationA_ will be shown to _destinationB_. If _fromB_ is set up, _anonymization_ will not be applied; _from_ will be shown to _destinationA_ and _fromB_ will be shown to _destinationB_. Default value is `false`. "
},
"notifyUrl":{
"type":"string",
"description":"The URL on your callback server on which the Delivery report will be sent."
},
"notifyContentType":{
"type":"string",
"description":"Preferred Delivery report content type. Can be `application/json` or `application/xml`."
},
"notifyContentVersion":{
"type":"integer",
"format":"int32",
"description":"Specifies the version of the report model to be sent. Can be `1` ([deprecated version 1](#programmable-communications/voice/receive-voice-delivery-reports-deprecated)) or `2` ([current version 2](#programmable-communications/voice/receive-voice-delivery-reports)). The default is version 2."
},
"maxDuration":{
"type":"integer",
"format":"int32",
"description":"Maximum duration of transferred call in seconds. If set, when _maxDuration_ is reached call will be terminated."
},
"warningTime":{
"type":"integer",
"format":"int32",
"description":"Time before the end of the transferred call, in seconds, when warning beep sound will be played. For example, if _maxDuration_ is set to `60` and warningTime is set to `5`, this means that warning beep will be played on `55.` second of the transferred call, or `5` seconds before it's end."
},
"retry":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Retry"
},
"machineDetection":{
"type":"string",
"description":"Used for enabling detection of answering machine after the call has been answered on `destinationA`. It can be set to `hangup` which means if a machine is detected, the call is hung up. If `machineDetection` is used, there is a minimum of 4 seconds detection time, which can result in delay of playing the message. Answering machine detection is additionally charged. For more information please contact your account manager.",
"externalDocs":{
"description":"Answering Machine Detection",
"url":"https://www.infobip.com/docs/voice-and-video/getting-started#answering-machine-detection-add-ons-and-options"
}
},
"deliveryTimeWindow":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.DeliveryTimeWindow"
}
},
"required":[
"destinationA",
"destinationB",
"from"
],
"title":"ClickToCallApiMessage"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CmlScript":{
"type":"array",
"description":"Array of markup language instructions defining the call flow.",
"items":{
"oneOf":[
{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Play"
},
{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Say"
},
{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Fetch"
},
{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Pause"
},
{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Hangup"
},
{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Record"
},
{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CaptureDtmf"
},
{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.StartRecording"
},
{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.StopRecording"
},
{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Dial"
}
]
},
"title":"CmlScript"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Criteria":{
"type":"object",
"description":"Criteria type.",
"discriminator":{
"propertyName":"type",
"mapping":{
"PHONE":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.PhoneCriteria",
"SIP":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SipCriteria",
"WEBRTC":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.WebRTCCriteria",
"APPLICATION":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.ApplicationCriteria",
"WHATSAPP":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.WhatsAppCriteria"
}
},
"properties":{
"type":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CriteriaType"
}
},
"required":[
"type"
],
"title":"Criteria"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CriteriaType":{
"type":"string",
"enum":[
"PHONE",
"SIP",
"WEBRTC",
"APPLICATION",
"WHATSAPP"
],
"title":"CriteriaType"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CustomDataEntry":{
"type":"object",
"description":"WhatsApp custom data. To meet the criteria, all of the provided custom data pairs must match.",
"properties":{
"key":{
"type":"string",
"description":"Custom data key. Example: `key1`."
},
"value":{
"type":"string",
"description":"Custom data value or regular expression pattern representing the value. Examples: `value1`, `value(.+)`."
}
},
"required":[
"key"
],
"title":"CustomDataEntry"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.DeliveryDay":{
"type":"string",
"enum":[
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
"SUNDAY"
],
"title":"DeliveryDay"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.DeliveryTime":{
"type":"object",
"properties":{
"hour":{
"type":"integer",
"format":"int32",
"maximum":23,
"minimum":0
},
"minute":{
"type":"integer",
"format":"int32",
"maximum":59,
"minimum":0
}
},
"required":[
"hour",
"minute"
],
"title":"DeliveryTime"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.DeliveryTimeWindow":{
"type":"object",
"description":"Scheduling object that allows setting up detailed time windows in which the message can be sent. Consists of from, to and days properties. Days in the week are written as their full names: Monday-Sunday. Days parameter must be populated as a list, between two square brackets. `Example: ['MONDAY', 'TUESDAY', 'WEDNESDAY']`. From and to properties should be either both included, to allow finer time window granulation or both omitted, to include whole days in the delivery time window. From and to parameters are objects, that consist of hour and minute fields that hold integer values. For example, ` from: [ hour: 15, minute:45 ]`. For complete json, please check out our example. Note: delivery time window is set in UTC timezone.",
"properties":{
"days":{
"type":"array",
"items":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.DeliveryDay"
},
"uniqueItems":true
},
"from":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.DeliveryTime"
},
"to":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.DeliveryTime"
}
},
"required":[
"days",
"from",
"to"
],
"title":"DeliveryTimeWindow"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Destination":{
"type":"object",
"description":"List of destinations. First destination in the list is the first one to be executed. Subsequent destinations are executed only if the previous one fails.",
"discriminator":{
"propertyName":"type",
"mapping":{
"APPLICATION":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.ApplicationDestination",
"ENDPOINT":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.EndpointDestination",
"URL":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.UrlDestination"
}
},
"properties":{
"priority":{
"type":"integer",
"format":"int32"
},
"type":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.DestinationType"
},
"weight":{
"type":"integer",
"format":"int32"
}
},
"required":[
"type"
],
"title":"Destination"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.DestinationType":{
"type":"string",
"enum":[
"APPLICATION",
"ENDPOINT",
"URL"
],
"title":"DestinationType"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Dial":{
"type":"object",
"description":"Dial action connects the call to one or more endpoints.",
"properties":{
"action":{
"type":"string",
"description":"Action discriminator.",
"enum":[
"dial"
]
},
"callback":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackUrl"
},
"endpointCallback":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackUrl"
},
"from":{
"type":"string",
"description":"Caller ID to use when dialing."
},
"connectTimeout":{
"type":"integer",
"format":"int32",
"description":"Connection timeout in seconds (1 to 30).",
"maximum":30,
"minimum":1
},
"hangupOn":{
"type":"string",
"description":"Digit to press to hang up the call.",
"maxLength":1,
"minLength":0
},
"answerBeforeConnecting":{
"type":"boolean",
"default":false,
"description":"Whether to answer the call before connecting to endpoints."
},
"recording":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.DialRecording"
},
"maxDuration":{
"type":"integer",
"format":"int32",
"description":"Maximum call duration in seconds."
},
"ringTone":{
"type":"string",
"description":"Ring tone to play while connecting."
},
"endpoints":{
"type":"array",
"description":"List of endpoints to dial (1 to 10).",
"items":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallEndpoint"
},
"maxItems":10,
"minItems":1
},
"machineDetection":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.MachineDetection"
}
},
"required":[
"action",
"endpoints"
],
"title":"Dial"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.DialData":{
"type":"object",
"description":"The data related to the dial instruction.",
"properties":{
"callId":{
"type":"string",
"description":"The unique identifier of the call that was dialed.",
"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"errorCodeId":{
"type":"integer",
"format":"int32",
"description":"The status of the dialed call.",
"example":0
},
"errorCodeName":{
"type":"string",
"description":"The name of the error code associated with the dialed call.",
"example":"NORMAL_HANGUP"
},
"duration":{
"type":"integer",
"format":"int64",
"description":"The duration of the dialed call in milliseconds.",
"example":12500
}
},
"title":"DialData"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.DialRecording":{
"type":"object",
"description":"Recording configuration for dial actions.",
"properties":{
"filePrefix":{
"type":"string",
"description":"Prefix for recorded file names."
},
"recordingStatusCallbackUrl":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackUrl"
},
"recordingStatusCallbackEvents":{
"type":"array",
"description":"Set of recording status events that trigger the recording status callback.",
"items":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RecordingStatusEvent"
},
"uniqueItems":true
},
"customData":{
"type":"object",
"additionalProperties":{
"type":"string",
"description":"Custom data to attach to recordings."
},
"description":"Custom data to attach to recordings."
}
},
"title":"DialRecording"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Endpoint":{
"type":"object",
"description":"Endpoint for a given destination.",
"discriminator":{
"propertyName":"type",
"mapping":{
"PHONE":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.PhoneEndpoint",
"SIP":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SipEndpoint",
"VIBER":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.ViberEndpoint",
"WHATSAPP":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.WhatsAppEndpoint",
"WEBSOCKET":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.WebSocketEndpoint",
"WEBRTC":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.WebRTCEndpoint"
}
},
"properties":{
"type":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.EndpointType"
}
},
"required":[
"type"
],
"title":"Endpoint"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.EndpointDestination":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Destination"
},
{
"type":"object",
"properties":{
"value":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Endpoint"
},
"priority":{
"type":"integer",
"format":"int32",
"description":"Priority of the destination within a route. Destinations with lower value have higher priority. Either all or no destination need to have this value defined.",
"maximum":100,
"minimum":1
},
"weight":{
"type":"integer",
"format":"int32",
"description":"Weight of the destination within a route. It specifies how much traffic is handled by destination relative to other destinations within the same priority level. Values are evaluated relative to each other and they don't need to add up to 100. Either all or no destination need to have this value defined.",
"maximum":100,
"minimum":1
},
"connectTimeout":{
"type":"integer",
"format":"int32",
"description":"Time to wait, in seconds, to establish a call toward the destination endpoint. The call will be terminated if it is not answered within the specified time."
},
"recording":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Recording"
},
"allowedTimeWindows":{
"type":"array",
"description":"Sets specific delivery windows outside of which calls won't be forwarded to the destination. If defined, call forwarding is allowed only if any time window in array is satisfied. ",
"items":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.AllowedTimeWindow"
}
}
}
}
],
"required":[
"type",
"value"
],
"title":"EndpointDestination"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.EndpointDestinationResponse":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.UrlDestinationResponse"
},
{
"type":"object",
"properties":{
"value":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Endpoint"
},
"connectTimeout":{
"type":"integer",
"format":"int32",
"description":"Time to wait, in seconds, to establish a call toward the destination endpoint. The call will be terminated if it is not answered within the specified time."
},
"recording":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Recording"
}
}
}
],
"required":[
"type",
"value"
],
"title":"EndpointDestinationResponse"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.EndpointType":{
"type":"string",
"enum":[
"PHONE",
"SIP",
"WEBRTC",
"VIBER",
"WEBSOCKET"
],
"title":"EndpointType"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Fetch":{
"type":"object",
"description":"Fetch action retrieves markup instructions from a URL at runtime.",
"properties":{
"action":{
"type":"string",
"description":"Action discriminator.",
"enum":[
"fetch"
]
},
"url":{
"type":"string",
"description":"URL to fetch markup instructions from."
},
"method":{
"type":"string",
"default":"POST",
"description":"HTTP method for the fetch request (POST or GET)."
}
},
"required":[
"action",
"url"
],
"title":"Fetch"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.File":{
"type":"object",
"description":"The list of the results for this page.",
"properties":{
"id":{
"type":"string",
"description":"File ID.",
"example":"218eceba-c044-430d-9f26-8f1a7f0g2d03"
},
"name":{
"type":"string",
"description":"File name.",
"example":"Example file"
},
"fileFormat":{
"type":"string",
"description":"File format.",
"example":"WAV"
},
"size":{
"type":"integer",
"format":"int64",
"description":"File size in bytes.",
"example":292190
},
"creationTime":{
"type":"string",
"format":"date-time",
"description":"File creation time."
},
"expirationTime":{
"type":"string",
"format":"date-time",
"description":"File expiration time."
},
"duration":{
"type":"integer",
"format":"int64",
"description":"File duration in seconds.",
"example":3
}
},
"required":[
"fileFormat",
"name"
],
"title":"File"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.FilePlayContent":{
"type":"object",
"description":"Plays an audio file previously uploaded to Infobip storage.",
"properties":{
"type":{
"type":"string",
"description":"Content type discriminator.",
"enum":[
"FILE"
]
},
"fileId":{
"type":"string",
"description":"Identifier of the audio file stored in Infobip storage."
}
},
"required":[
"fileId",
"type"
],
"title":"FilePlayContent"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Gender":{
"type":"string",
"description":"Voice gender in which text would be synthesized.",
"enum":[
"FEMALE",
"MALE"
],
"title":"Gender"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Hangup":{
"type":"object",
"description":"Hangup action terminates the call.",
"properties":{
"action":{
"type":"string",
"description":"Action discriminator.",
"enum":[
"hangup"
]
},
"errorCode":{
"type":"string",
"default":"REJECTED",
"description":"Error code to return when hanging up."
}
},
"required":[
"action"
],
"title":"Hangup"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.HmacAlgorithm":{
"type":"string",
"description":"Hmac algorithm.",
"enum":[
"HMAC_MD5",
"HMAC_SHA_1",
"HMAC_SHA_224",
"HMAC_SHA_256",
"HMAC_SHA_384",
"HMAC_SHA_512"
],
"title":"HmacAlgorithm"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.HmacUrlSecurityConfig":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.UrlSecurityConfig"
},
{
"type":"object",
"properties":{
"secretKey":{
"type":"string",
"description":"Algorithm used for encryption.",
"writeOnly":true
},
"algorithm":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.HmacAlgorithm"
}
}
}
],
"required":[
"algorithm",
"secretKey",
"type"
],
"title":"HmacUrlSecurityConfig"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.InfobipApplication":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Application"
},
{
"type":"object",
"properties":{
"applicationId":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.InfobipApplicationId"
},
"customData":{
"type":"object",
"additionalProperties":{
"type":"string"
},
"description":"Client defined data passed to the Infobip application."
}
}
}
],
"required":[
"applicationId",
"type"
],
"title":"InfobipApplication"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.InfobipApplicationId":{
"type":"string",
"description":"ID of an Infobip application to which the call is to be transferred.",
"enum":[
"CONVERSATIONS"
],
"title":"InfobipApplicationId"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.MachineDetection":{
"type":"object",
"description":"Machine detection configuration for the dial.",
"properties":{
"detectionTime":{
"type":"number",
"format":"double",
"description":"Detection time in seconds",
"maximum":5,
"minimum":1
},
"mode":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.MachineDetectionMode"
},
"messageDetection":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.MessageDetection"
}
},
"title":"MachineDetection"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.MachineDetectionMode":{
"type":"object",
"description":"Machine detection mode configuration",
"discriminator":{
"propertyName":"type",
"mapping":{
"SYNC":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SyncMachineDetectionMode",
"ASYNC":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.AsyncMachineDetectionMode"
}
},
"properties":{
"type":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.MachineDetectionModeType"
}
},
"title":"MachineDetectionMode"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.MachineDetectionModeType":{
"type":"string",
"enum":[
"SYNC",
"ASYNC"
],
"title":"MachineDetectionModeType"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.MarkupHttpMethod":{
"type":"string",
"description":"Allowed markup HTTP method.",
"enum":[
"POST",
"GET"
],
"title":"MarkupHttpMethod"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.MessageDetection":{
"type":"object",
"description":"Message detection configuration",
"properties":{
"timeout":{
"type":"integer",
"format":"int32",
"description":"Timeout in seconds",
"maximum":60,
"minimum":1
}
},
"title":"MessageDetection"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.MultiTtsApiMessage":{
"type":"object",
"description":"Array of messages to be sent, one per every message.",
"properties":{
"audioFileUrl":{
"type":"string",
"description":"An audio file can be delivered as a voice message to the recipients. An audio file must be uploaded online, so that the existing URL can be available for file download. Size of the audio file must be below 4 MB. Supported formats of the provided file are aac, aiff, m4a, mp2, mp3, mp4 (audio only), ogg, wav and wma. Our platform needs to have permission to make GET and HEAD HTTP requests on the provided URL. Standard http ports (like 80, 8080, etc.) are advised."
},
"text":{
"type":"string",
"description":"Text of the message that will be sent. Message text can be up to 1400 characters long and cannot contain only punctuation. SSML (_Speech Synthesis Markup Language_) is supported and can be used to fully customize pronunciation of the provided text.",
"externalDocs":{
"description":"SSML support",
"url":"https://www.infobip.com/docs/voice-and-video/reference#ssml-support-text-to-speech-languages"
}
},
"language":{
"type":"string",
"description":"If the message is in text format, the language in which the message is written must be defined for correct pronunciation. More about Text-to-speech functionality and supported TTS languages can be found [here](https://www.infobip.com/docs/voice-and-video/outbound-calls#text-to-speech-voice-over-broadcast). If not set, default language is `English [en]`. If voice is not set, then default voice for that specific language is used. In the case of English language, the voice is `[Joanna]`.",
"externalDocs":{
"description":"Voice Text-To-Speech Languages",
"url":"https://www.infobip.com/docs/voice-and-video/reference#text-to-speech-languages"
}
},
"voice":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Voice"
},
"from":{
"type":"string",
"description":"Numeric sender ID in E.164 standard format (Example: 41793026727). This is caller ID that will be presented to the end user where applicable."
},
"to":{
"type":"array",
"description":"Phone number of the recipient. Phone number must be written in E.164 standard format (Example: 41793026727). Maximum number of phone numbers listed is 20k.",
"items":{
"type":"string",
"description":"Phone number of the recipient. Phone number must be written in E.164 standard format (Example: 41793026727). Maximum number of phone numbers listed is 20k."
}
}
},
"required":[
"to"
],
"title":"MultiTtsApiMessage"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.PageInfo":{
"type":"object",
"description":"Contains information about the page.",
"properties":{
"page":{
"type":"integer",
"format":"int32",
"description":"Requested page number.",
"minimum":0
},
"size":{
"type":"integer",
"format":"int32",
"description":"Requested page size.",
"minimum":1
},
"totalPages":{
"type":"integer",
"format":"int32",
"description":"The total number of pages of the results matching the requested parameters.",
"minimum":0
},
"totalResults":{
"type":"integer",
"format":"int64",
"description":"The total number of the results matching the requested parameters.",
"minimum":0
}
},
"required":[
"page",
"size",
"totalPages",
"totalResults"
],
"title":"PageInfo"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Pause":{
"type":"object",
"description":"Pause action waits for a specified duration before executing the next instruction.",
"properties":{
"action":{
"type":"string",
"description":"Action discriminator.",
"enum":[
"pause"
]
},
"duration":{
"type":"number",
"format":"double",
"description":"Duration of the pause in seconds (1 to 5).",
"maximum":5,
"minimum":1
}
},
"required":[
"action",
"duration"
],
"title":"Pause"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.PhoneCriteria":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Criteria"
},
{
"type":"object",
"properties":{
"from":{
"type":"string",
"description":"Phone number or regular expression pattern representing the phone number. Examples: `41793026727`, `41793(.+)`."
}
}
}
],
"required":[
"type"
],
"title":"PhoneCriteria"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.PhoneEndpoint":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Endpoint"
},
{
"type":"object",
"properties":{
"from":{
"type":"string",
"description":"Phone number in the [E.164](https://en.wikipedia.org/wiki/E.164) format. Defaults to `from` value used in inbound call."
},
"phoneNumber":{
"type":"string",
"description":"Phone number in the [E.164] format. Defaults to `to` value used in inbound call."
},
"ringbackGeneration":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RingbackGeneration"
}
}
}
],
"required":[
"type"
],
"title":"PhoneEndpoint"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Play":{
"type":"object",
"description":"Play action plays an audio file or stream to the caller.",
"properties":{
"action":{
"type":"string",
"description":"Action discriminator.",
"enum":[
"play"
]
},
"content":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.PlayContent"
},
"loopCount":{
"type":"integer",
"format":"int32",
"description":"Number of times to loop the content."
}
},
"required":[
"action",
"content"
],
"title":"Play"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.PlayContent":{
"description":"Polymorphic content played to the caller.",
"oneOf":[
{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.FilePlayContent"
},
{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.UrlPlayContent"
},
{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RecordingPlayContent"
}
],
"title":"PlayContent"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Record":{
"type":"object",
"description":"Record action records audio from the call.",
"properties":{
"action":{
"type":"string",
"description":"Action discriminator.",
"enum":[
"record"
]
},
"callback":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackUrl"
},
"recordingStatusCallbackUrl":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackUrl"
},
"recordingStatusCallbackEvents":{
"type":"array",
"description":"Set of recording status events that trigger the recording status callback.",
"items":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RecordingStatusEvent"
},
"uniqueItems":true
},
"timeout":{
"type":"integer",
"format":"int32",
"description":"Maximum recording duration in seconds."
},
"maxSilence":{
"type":"integer",
"format":"int32",
"description":"Maximum silence duration in seconds before stopping recording."
},
"escapeDtmf":{
"type":"string",
"description":"DTMF digit to escape recording."
},
"playBeep":{
"type":"boolean",
"default":true,
"description":"Whether to play a beep before recording starts."
}
},
"required":[
"action",
"callback"
],
"title":"Record"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Recording":{
"type":"object",
"description":"If set, captures the call session from an established call to a given destination.",
"properties":{
"recordingType":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RecordingType"
},
"recordingComposition":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RecordingComposition"
},
"customData":{
"type":"object",
"additionalProperties":{
"type":"string"
},
"description":"Client-defined data visible when a recording is downloaded."
},
"filePrefix":{
"type":"string",
"description":"Custom name for the recording's zip file. Applicable only when SFTP server is enabled on [Voice settings page](https://portal.infobip.com/apps/voice/recording/settings). For recordings without composition, `callId` and `fileId` will be appended to the `filePrefix` value. For recordings with composition, `fileId` will be appended to the `filePrefix` value.",
"maxLength":100,
"minLength":1,
"pattern":"^[a-zA-Z0-9_\\-]*$"
}
},
"required":[
"recordingType"
],
"title":"Recording"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RecordingComposition":{
"type":"object",
"description":"Sets recording composition options.",
"properties":{
"enabled":{
"type":"boolean",
"description":"Indicates whether to create a single recording of both participants. If set to `true`, both participants are merged into a single audio or video file. Otherwise, both participants will have their own individual audio or video file."
}
},
"required":[
"enabled"
],
"title":"RecordingComposition"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RecordingLocation":{
"type":"string",
"enum":[
"SAO_PAULO",
"BOGOTA",
"FRANKFURT",
"JOHANNESBURG",
"JOHANNESBURG_1",
"NEW_YORK",
"PORTLAND",
"MOSCOW",
"SINGAPORE",
"ISTANBUL",
"KUALA_LUMPUR",
"JAKARTA",
"MUMBAI",
"HONG_KONG_1",
"HONG_KONG",
"RIYADH",
"CHENNAI"
],
"title":"RecordingLocation"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RecordingNotFoundException":{
"type":"object",
"properties":{
"message":{
"type":"string"
},
"cause":{
"type":"object",
"properties":{
"stackTrace":{
"type":"array",
"items":{
"type":"object",
"properties":{
"classLoaderName":{
"type":"string"
},
"moduleName":{
"type":"string"
},
"moduleVersion":{
"type":"string"
},
"methodName":{
"type":"string"
},
"fileName":{
"type":"string"
},
"lineNumber":{
"type":"integer",
"format":"int32"
},
"className":{
"type":"string"
},
"nativeMethod":{
"type":"boolean"
}
}
}
},
"message":{
"type":"string"
},
"localizedMessage":{
"type":"string"
}
}
},
"stackTrace":{
"type":"array",
"items":{
"type":"object",
"properties":{
"classLoaderName":{
"type":"string"
},
"moduleName":{
"type":"string"
},
"moduleVersion":{
"type":"string"
},
"methodName":{
"type":"string"
},
"fileName":{
"type":"string"
},
"lineNumber":{
"type":"integer",
"format":"int32"
},
"className":{
"type":"string"
},
"nativeMethod":{
"type":"boolean"
}
}
}
},
"suppressed":{
"type":"array",
"items":{
"type":"object",
"properties":{
"stackTrace":{
"type":"array",
"items":{
"type":"object",
"properties":{
"classLoaderName":{
"type":"string"
},
"moduleName":{
"type":"string"
},
"moduleVersion":{
"type":"string"
},
"methodName":{
"type":"string"
},
"fileName":{
"type":"string"
},
"lineNumber":{
"type":"integer",
"format":"int32"
},
"className":{
"type":"string"
},
"nativeMethod":{
"type":"boolean"
}
}
}
},
"message":{
"type":"string"
},
"localizedMessage":{
"type":"string"
}
}
}
},
"localizedMessage":{
"type":"string"
}
},
"title":"RecordingNotFoundException"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RecordingPlayContent":{
"type":"object",
"description":"Plays a previously recorded call file.",
"properties":{
"type":{
"type":"string",
"description":"Content type discriminator.",
"enum":[
"RECORDING"
]
},
"fileId":{
"type":"string",
"description":"Identifier of the recording to play."
}
},
"required":[
"fileId",
"type"
],
"title":"RecordingPlayContent"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RecordingServiceException":{
"type":"object",
"properties":{
"cause":{
"type":"object",
"properties":{
"stackTrace":{
"type":"array",
"items":{
"type":"object",
"properties":{
"classLoaderName":{
"type":"string"
},
"moduleName":{
"type":"string"
},
"moduleVersion":{
"type":"string"
},
"methodName":{
"type":"string"
},
"fileName":{
"type":"string"
},
"lineNumber":{
"type":"integer",
"format":"int32"
},
"className":{
"type":"string"
},
"nativeMethod":{
"type":"boolean"
}
}
}
},
"message":{
"type":"string"
},
"localizedMessage":{
"type":"string"
}
}
},
"stackTrace":{
"type":"array",
"items":{
"type":"object",
"properties":{
"classLoaderName":{
"type":"string"
},
"moduleName":{
"type":"string"
},
"moduleVersion":{
"type":"string"
},
"methodName":{
"type":"string"
},
"fileName":{
"type":"string"
},
"lineNumber":{
"type":"integer",
"format":"int32"
},
"className":{
"type":"string"
},
"nativeMethod":{
"type":"boolean"
}
}
}
},
"message":{
"type":"string"
},
"suppressed":{
"type":"array",
"items":{
"type":"object",
"properties":{
"stackTrace":{
"type":"array",
"items":{
"type":"object",
"properties":{
"classLoaderName":{
"type":"string"
},
"moduleName":{
"type":"string"
},
"moduleVersion":{
"type":"string"
},
"methodName":{
"type":"string"
},
"fileName":{
"type":"string"
},
"lineNumber":{
"type":"integer",
"format":"int32"
},
"className":{
"type":"string"
},
"nativeMethod":{
"type":"boolean"
}
}
}
},
"message":{
"type":"string"
},
"localizedMessage":{
"type":"string"
}
}
}
},
"localizedMessage":{
"type":"string"
}
},
"title":"RecordingServiceException"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RecordingSortColumn":{
"type":"string",
"enum":[
"ENDPOINT_TYPE",
"ROUTE_ID",
"CORRELATION_ID",
"START_TIME",
"END_TIME"
],
"title":"RecordingSortColumn"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RecordingStatusEvent":{
"type":"string",
"description":"Recording status delivered with the record callback.",
"enum":[
"in-progress",
"completed"
],
"example":"in-progress",
"title":"RecordingStatusEvent"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RecordingType":{
"type":"string",
"description":"Recording type.",
"enum":[
"AUDIO",
"AUDIO_AND_VIDEO"
],
"title":"RecordingType"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.ResponseDetails":{
"type":"object",
"description":"Array of sent messages, one object per every message.",
"properties":{
"to":{
"type":"string",
"description":"The message destination address."
},
"status":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SingleMessageStatus"
},
"messageId":{
"type":"string",
"description":"The ID that uniquely identifies the message sent."
}
},
"title":"ResponseDetails"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Retry":{
"type":"object",
"description":"Used to define if the delivery of the Voice messages should be retried in case the first try doesn't succeed. Additional retries will be made according to the schedule defined by _minPeriod_ and _maxPeriod_ parameters and platform's internal retry logic. If the _minPeriod_ differs _maxPeriod_, delivery will be retried in the following manner: after 1 min, 2 min, 5 min, 10 min, 20 min, 30 min, 1 hour, 2 hours, 4 hours, 8 hours, 16 hours, 24 hours or until maxPeriod is reached. If the retry attempt for the _maxPeriod_ is reached, the _maxPeriod_ will be used for all subsequent retries. If the _minPeriod_ and the _maxPeriod_ are defined as equal values, the period of time between retries will be equal to this value. Message delivery will be retried until the successful delivery or message validity or _maxCount_ value is reached.",
"properties":{
"minPeriod":{
"type":"integer",
"format":"int32",
"description":"Defines the minimal waiting time (in minutes) after the previous failed attempt to try to deliver the message again. Supported values are 1 min, 2 min, 5 min, 10 min, 20 min, 30 min, 1 hour, 2 hours, 4 hours, 8 hours, 16 hours, 24 hours. If entered a value that isn't from the previous list but that's smaller than 24 hours, it is used the next bigger value from the list. If entered value that is bigger than 24 hours than it is used 24 hours."
},
"maxPeriod":{
"type":"integer",
"format":"int32",
"description":"Defines the maximum waiting time (in minutes) after the previous failed attempt to try to deliver the message again. Supported values are 1 min, 2 min, 5 min, 10 min, 20 min, 30 min, 1 hour, 2 hours, 4 hours, 8 hours, 16 hours, 24 hours. If entered a value that isn't from the previous list but that's smaller than 24 hours, it is used the next bigger value from the list. If entered value that is bigger than 24 hours than it is used 24 hours."
},
"maxCount":{
"type":"integer",
"format":"int32",
"description":"Specify the maximum number of retry attempts. Maximum value of the maxCount is `4`. If the value is higher than `4`, it will be set to `4`."
}
},
"required":[
"maxCount",
"maxPeriod",
"minPeriod"
],
"title":"Retry"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RingbackGeneration":{
"type":"object",
"description":"Option to generate a consistent local ringback tone, overriding remote ringing tones. It applies only to `INBOUND` parent calls in the `CALLING` state; otherwise, it is ignored.",
"properties":{
"enabled":{
"type":"boolean"
}
},
"required":[
"enabled"
],
"title":"RingbackGeneration"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RouteStatus":{
"type":"string",
"description":"Indicates whether the route is enabled or not.",
"enum":[
"ENABLED",
"DISABLED"
],
"title":"RouteStatus"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Say":{
"type":"object",
"description":"Say action converts text to speech and plays it to the caller.",
"properties":{
"action":{
"type":"string",
"description":"Action discriminator.",
"enum":[
"say"
]
},
"text":{
"type":"string",
"description":"Text to be spoken."
},
"language":{
"type":"string",
"description":"Text language. Must be defined for correct pronunciation. More info about available languages and voices can be found [here](https://www.infobip.com/docs/voice-and-video/reference#text-to-speech-languages). Use value from abbreviation column in the table.",
"example":"en"
},
"speechRate":{
"type":"number",
"format":"double",
"default":1,
"description":"Speech rate (0.5 to 2.0).",
"maximum":2,
"minimum":0.5
},
"loopCount":{
"type":"integer",
"format":"int32",
"description":"Number of times to repeat the speech.",
"minimum":1
},
"voicePreferences":{
"$ref":"#/components/schemas/49f1996e051117ce119ddfc3e07857856b24a0d3f7351242fd9c4615508a2845.VoicePreferences"
}
},
"required":[
"action",
"text"
],
"title":"Say"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SearchCriteria":{
"type":"object",
"description":"List of criteria that should match route. For a route to match, any criterion should be met.",
"properties":{
"to":{
"type":"string",
"description":"Phone number or regular expression pattern representing the phone number. Applies to all search criteria types except `WEBRTC`. Examples: `41793026727`, `41793(.+)`."
},
"value":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Criteria"
}
},
"title":"SearchCriteria"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SendingSpeed":{
"type":"object",
"description":"Sending rate defined in number of messages sent per second, minute, hour or day. You may wish to use this to allow your systems or agents to handle large amounts of incoming traffic. Not setting a send speed limit can overwhelm your resources with incoming traffic. If this parameter is defined, _validityPeriod_ is ignored.",
"properties":{
"speed":{
"type":"integer",
"format":"int32",
"description":"Defines the number of messages that will be sent per specified time unit."
},
"timeUnit":{
"type":"string",
"description":"Defines time unit used for calculating sending speed. Possible values: `second`, `minute`, `hour` and `day`."
}
},
"title":"SendingSpeed"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SimulatorCallEndpoint":{
"type":"object",
"description":"Simulator endpoint to be used for the simulation. ",
"discriminator":{
"propertyName":"type",
"mapping":{
"SIP":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SimulatorSipEndpoint",
"PHONE":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SimulatorPhoneEndpoint",
"WEBRTC":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SimulatorWebRTCEndpoint",
"WHATSAPP":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SimulatorWhatsAppEndpoint"
}
},
"properties":{
"type":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SimulatorCallEndpointType"
}
},
"title":"SimulatorCallEndpoint"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SimulatorCallEndpointType":{
"type":"string",
"enum":[
"SIP",
"PHONE",
"WEBRTC",
"WHATSAPP"
],
"title":"SimulatorCallEndpointType"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SimulatorPhoneEndpoint":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SimulatorCallEndpoint"
},
{
"type":"object",
"properties":{
"from":{
"type":"string",
"description":"Phone number in the [E.164](https://en.wikipedia.org/wiki/E.164) format."
}
}
}
],
"required":[
"from"
],
"title":"SimulatorPhoneEndpoint"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SimulatorSipEndpoint":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SimulatorCallEndpoint"
},
{
"type":"object",
"properties":{
"from":{
"type":"string",
"description":"Username sent to a selected SIP trunk."
},
"sipTrunkId":{
"type":"string",
"description":"Unique identifier of a SIP trunk."
},
"headers":{
"type":"object",
"additionalProperties":{
"type":"string"
},
"description":"Custom headers."
}
}
}
],
"required":[
"from",
"sipTrunkId"
],
"title":"SimulatorSipEndpoint"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SimulatorWebRTCEndpoint":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SimulatorCallEndpoint"
},
{
"type":"object",
"properties":{
"from":{
"type":"string",
"description":"The unique from identity used to present a user on the Infobip WebRTC platform."
},
"customData":{
"type":"object",
"additionalProperties":{
"type":"string"
},
"description":"WebRTC custom data."
}
}
}
],
"required":[
"from"
],
"title":"SimulatorWebRTCEndpoint"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SimulatorWhatsAppEndpoint":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SimulatorCallEndpoint"
},
{
"type":"object",
"properties":{
"from":{
"type":"string",
"description":"Phone number in the [E.164](https://en.wikipedia.org/wiki/E.164) format."
},
"customData":{
"type":"object",
"additionalProperties":{
"type":"string"
},
"description":"WhatsApp custom data."
}
}
}
],
"required":[
"from"
],
"title":"SimulatorWhatsAppEndpoint"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SingleMessageStatus":{
"type":"object",
"description":"Indicates whether the message has been successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status.",
"properties":{
"groupId":{
"type":"integer",
"format":"int32",
"description":"Status group ID."
},
"groupName":{
"type":"string",
"description":"Status group name that describes which category the status code belongs to, e.g. PENDING, UNDELIVERABLE, DELIVERED, EXPIRED, REJECTED."
},
"id":{
"type":"integer",
"format":"int32",
"description":"Status ID."
},
"name":{
"type":"string",
"description":"Status name."
},
"description":{
"type":"string",
"description":"Human-readable description of the status."
}
},
"title":"SingleMessageStatus"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SipCriteria":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Criteria"
},
{
"type":"object",
"properties":{
"sipTrunkId":{
"type":"string",
"description":"ID of the SIP trunk. Example: `60d345fd3a799ec`"
},
"username":{
"type":"string",
"description":"SIP trunk username or regular expression pattern representing username. Examples: `41793026727`, `41793(.+)`."
},
"headers":{
"type":"array",
"description":"SIP headers. To meet the criteria, all of the provided headers must match.",
"items":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SipHeader"
}
}
}
}
],
"required":[
"type"
],
"title":"SipCriteria"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SipEndpoint":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Endpoint"
},
{
"type":"object",
"properties":{
"from":{
"type":"string",
"description":"Caller ID that will be used. Defaults to `from` value used in inbound call."
},
"username":{
"type":"string",
"description":"Username sent to a selected SIP trunk. When not defined, Infobip DID number is used instead."
},
"sipTrunkId":{
"type":"string",
"description":"Unique identifier of a SIP trunk."
},
"customHeaders":{
"type":"object",
"additionalProperties":{
"type":"string"
},
"description":"Custom headers. Only headers starting with `X-` prefix will be propagated. Supports using variables `${from}` and `${to}`."
},
"ringbackGeneration":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RingbackGeneration"
}
}
}
],
"required":[
"sipTrunkId",
"type"
],
"title":"SipEndpoint"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SipHeader":{
"type":"object",
"description":"SIP headers. To meet the criteria, all of the provided headers must match.",
"properties":{
"headerName":{
"type":"string",
"description":"SIP header name starting with `X-`. Example: `X-Identity`.",
"pattern":"^X-.*$"
},
"headerValue":{
"type":"string",
"description":"SIP header value or regular expression pattern representing the value. Examples: `john.doe`, `john(.+)`."
}
},
"required":[
"headerName"
],
"title":"SipHeader"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SortDirection":{
"type":"string",
"enum":[
"ASC",
"DESC"
],
"title":"SortDirection"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.StartRecording":{
"type":"object",
"description":"StartRecording action starts recording the call.",
"properties":{
"action":{
"type":"string",
"description":"Action discriminator.",
"enum":[
"startRecording"
]
},
"recordingStatusCallbackUrl":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackUrl"
},
"recordingStatusCallbackEvents":{
"type":"array",
"description":"Set of recording status events that trigger the recording status callback.",
"items":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RecordingStatusEvent"
},
"uniqueItems":true
},
"playBeep":{
"type":"boolean",
"default":true,
"description":"Whether to play a beep when recording starts."
}
},
"required":[
"action"
],
"title":"StartRecording"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.StopRecording":{
"type":"object",
"description":"StopRecording action stops an ongoing recording.",
"properties":{
"action":{
"type":"string",
"description":"Action discriminator.",
"enum":[
"stopRecording"
]
},
"callback":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackUrl"
}
},
"required":[
"action",
"callback"
],
"title":"StopRecording"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SyncMachineDetectionMode":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.MachineDetectionMode"
}
],
"title":"SyncMachineDetectionMode"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.UrlDestination":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Destination"
},
{
"type":"object",
"properties":{
"priority":{
"type":"integer",
"format":"int32",
"description":"Priority of the destination within a route. Destinations with lower value have higher priority. Either all or no destination need to have this value defined.",
"maximum":100,
"minimum":1
},
"weight":{
"type":"integer",
"format":"int32",
"description":"Weight of the destination within a route. It specifies how much traffic is handled by destination relative to other destinations within the same priority level. Values are evaluated relative to each other and they don't need to add up to 100. Either all or no destination need to have this value defined.",
"maximum":100,
"minimum":1
},
"url":{
"type":"string",
"description":"URL endpoint which provides next destination to be tried in a route as a response to `POST` HTTP request sent by the Infobip Platform. Returned destination must be of `ENDPOINT_DESTINATION` type."
},
"securityConfig":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.UrlSecurityConfig"
}
}
}
],
"required":[
"type",
"url"
],
"title":"UrlDestination"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.UrlDestinationHttpRequest":{
"type":"object",
"properties":{
"applicationId":{
"type":"string",
"default":"CALL_ROUTING",
"description":"Identifier of the application that originated the call."
},
"routeId":{
"type":"string",
"description":"Identifier of the route that is used to process the call.",
"example":"f8fc8aca-786d-4943-9af2-e7ec01b5e80d"
},
"callId":{
"type":"string",
"description":"Identifier of the call that is being processed.",
"example":"d8d84155-3831-43fb-91c9-bb897149a79d"
},
"from":{
"type":"string",
"description":"Phone number from which the call originated from.",
"example":"44790123456"
},
"to":{
"type":"string",
"description":"Destination phone number of the call.",
"example":"44790123456"
},
"startTime":{
"type":"string",
"format":"date-time",
"description":"Timestamp representing start time of the call.",
"example":"2024-01-01T10:00:00Z"
}
},
"title":"UrlDestinationHttpRequest"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.UrlDestinationResponse":{
"type":"object",
"discriminator":{
"propertyName":"type",
"mapping":{
"ENDPOINT":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.EndpointDestinationResponse"
}
},
"properties":{
"type":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.DestinationType"
}
},
"required":[
"type"
],
"title":"UrlDestinationResponse"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.UrlPlayContent":{
"type":"object",
"description":"Plays an audio file fetched from a remote URL.",
"properties":{
"type":{
"type":"string",
"description":"Content type discriminator.",
"enum":[
"URL"
]
},
"fileUrl":{
"type":"string",
"description":"URL of the remote audio file to play."
},
"cacheDuration":{
"type":"integer",
"format":"int32",
"description":"How long, in seconds, the fetched file may be cached (1 to 86400).",
"maximum":86400
}
},
"required":[
"fileUrl",
"type"
],
"title":"UrlPlayContent"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.UrlSecurityConfig":{
"type":"object",
"description":"URL endpoint security configuration.",
"discriminator":{
"propertyName":"type",
"mapping":{
"BASIC":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.BasicUrlSecurityConfig",
"HMAC":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.HmacUrlSecurityConfig"
}
},
"properties":{
"type":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.UrlSecurityConfigType"
}
},
"required":[
"type"
],
"title":"UrlSecurityConfig"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.UrlSecurityConfigType":{
"type":"string",
"enum":[
"BASIC",
"HMAC"
],
"title":"UrlSecurityConfigType"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.ViberEndpoint":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Endpoint"
},
{
"type":"object",
"properties":{
"from":{
"type":"string",
"description":"Viber registered phone number. Defaults to `from` value used in inbound call."
},
"phoneNumber":{
"type":"string",
"description":"Phone number in the [E.164](https://en.wikipedia.org/wiki/E.164) format. Defaults to `to` value used in inbound call."
}
}
}
],
"required":[
"type"
],
"title":"ViberEndpoint"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Voice":{
"type":"object",
"description":"Used to define voice in which text would be synthesized. It has two parameters: _name_ and _gender_. When only _name_ is provided, then that exact voice with that name will be used to synthesize text. If only _gender_ is provided, then text is synthesized with first voice in given gender. If voice is not set, then default voice for that specific language is used.",
"properties":{
"gender":{
"type":"string",
"description":"Gender of the voice. Can be `male` or `female`."
},
"name":{
"type":"string",
"description":"Name of the voice. Example: `Joanna`"
}
},
"title":"Voice"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.WebRTCCriteria":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Criteria"
},
{
"type":"object",
"properties":{
"identity":{
"type":"string",
"description":"WebRTC identity or regular expression pattern representing identity. Examples: `WebRTC_user`, `WebRTC_(.+)`."
},
"customData":{
"type":"array",
"description":"WebRTC custom data. To meet the criteria, all of the provided custom data pairs must match.",
"items":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CustomDataEntry"
}
}
}
}
],
"required":[
"type"
],
"title":"WebRTCCriteria"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.WebRTCEndpoint":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Endpoint"
},
{
"type":"object",
"properties":{
"identity":{
"type":"string",
"description":"The unique identity used to present a user on the Infobip WebRTC platform. Defaults to `to` value used in inbound call."
}
}
}
],
"required":[
"type"
],
"title":"WebRTCEndpoint"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.WebRtcEndpoint":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallEndpoint"
},
{
"type":"object",
"properties":{
"identity":{
"type":"string",
"description":"The identity used to present a user on the Infobip WebRTC platform. Must be unique."
},
"displayName":{
"type":"string",
"description":"A human-readable name for a given identity."
}
}
}
],
"required":[
"identity"
],
"title":"WebRtcEndpoint"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.WebSocketEndpoint":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Endpoint"
},
{
"type":"object",
"properties":{
"websocketEndpointConfigId":{
"type":"string",
"description":"Websocket endpoint configuration ID."
},
"identifier":{
"type":"string",
"description":"Optional identifier for websocket calls."
},
"customData":{
"type":"object",
"additionalProperties":{
"type":"string"
},
"description":"Custom data associated with the websocket endpoint. Supports using variables `${from}` and `${to}`."
}
}
}
],
"required":[
"type",
"websocketEndpointConfigId"
],
"title":"WebSocketEndpoint"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.WebsocketEndpoint":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallEndpoint"
},
{
"type":"object",
"properties":{
"websocketEndpointConfigId":{
"type":"string",
"description":"Websocket endpoint configuration ID."
},
"identifier":{
"type":"string",
"description":"Optional identifier for websocket calls."
}
}
}
],
"required":[
"websocketEndpointConfigId"
],
"title":"WebsocketEndpoint"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.WhatsAppCriteria":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Criteria"
},
{
"type":"object",
"properties":{
"from":{
"type":"string",
"description":"Phone number or regular expression pattern representing the phone number. Examples: `41793026727`, `41793(.+)`."
},
"customData":{
"type":"array",
"description":"WhatsApp custom data. To meet the criteria, all of the provided custom data pairs must match.",
"items":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CustomDataEntry"
}
}
}
}
],
"required":[
"type"
],
"title":"WhatsAppCriteria"
},
"287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.WhatsAppEndpoint":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Endpoint"
},
{
"type":"object",
"properties":{
"from":{
"type":"string",
"description":"WhatsApp registered phone number. Defaults to `from` value used in inbound call."
},
"phoneNumber":{
"type":"string",
"description":"Phone number in the [E.164](https://en.wikipedia.org/wiki/E.164) format. Defaults to `to` value used in inbound call."
}
}
}
],
"required":[
"type"
],
"title":"WhatsAppEndpoint"
},
"2dac378b25c8dcf450b0618ee8c5fb6fb461154cc6b53aedfd327a01e576875e.RingbackGeneration":{
"type":"object",
"description":"Option to generate a consistent local ringback tone, overriding remote ringing tones. If enabled, the ringback will be generated for the existing call, provided it joins the conference before the remote ringback of the new call starts.",
"properties":{
"enabled":{
"type":"boolean",
"default":false,
"description":"Flag indicating whether ringback generation is enabled. Cannot be `true` when `connectOnEarlyMedia` is `true`."
}
},
"title":"RingbackGeneration"
},
"2f1f086f3fbc952749e03dadc7759cfc932ca2898a0c5e5b77a8bc2d84bd5c48.BulkRequest":{
"type":"object",
"properties":{
"bulkId":{
"type":"string",
"description":"Unique ID of the bulk request. If it's not set, a unique ID will be assigned to the bulk request."
},
"callsConfigurationId":{
"type":"string",
"description":"Calls Configuration ID."
},
"platform":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Platform"
},
"items":{
"type":"array",
"description":"Bulk item list.",
"items":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BulkItem"
},
"minLength":1
}
},
"required":[
"callsConfigurationId",
"items"
],
"title":"BulkRequest"
},
"2f1f086f3fbc952749e03dadc7759cfc932ca2898a0c5e5b77a8bc2d84bd5c48.BulkResponse":{
"type":"object",
"properties":{
"bulkId":{
"type":"string",
"description":"Unique ID of the bulk request."
},
"calls":{
"type":"array",
"description":"Bulk call list.",
"items":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BulkCall"
}
}
},
"title":"BulkResponse"
},
"2f772c02a4c3391667bfa54680f8db54477fb2b9100309bf0d515e4ee848facc.SetupBody":{
"type":"object",
"properties":{
"name":{
"type":"string",
"description":"Unique configuration name. Alphanumeric, max length 100.",
"pattern":"[a-zA-Z0-9 ]+"
},
"callbackUrl":{
"type":"string",
"description":"Client's URL that will be called on each inbound call to related Number masking Voice number in order to get instructions of how to handle incoming calls. Instructions are a result of mapping logic implemented on your side according to your business case."
},
"statusUrl":{
"type":"string",
"description":"Client's URL for status report delivery after the call is finished."
},
"backupCallbackUrl":{
"type":"string",
"description":"If callbackUrl is unavailable this one will be called instead."
},
"backupStatusUrl":{
"type":"string",
"description":"If statusUrl is unavailable this one will be called instead."
},
"description":{
"type":"string",
"description":"Masking configuration description.",
"pattern":"[a-zA-Z0-9 ]*"
}
},
"required":[
"callbackUrl",
"name"
],
"title":"SetupBody"
},
"2f772c02a4c3391667bfa54680f8db54477fb2b9100309bf0d515e4ee848facc.SetupResponse":{
"type":"object",
"properties":{
"key":{
"type":"string",
"description":"Use to connect masking configuration with Voice-enabled number."
},
"name":{
"type":"string",
"description":"Unique configuration name. Alphanumeric, max length 100."
},
"callbackUrl":{
"type":"string",
"description":"Client's URL that will be called on each inbound call to related Number masking Voice number in order to get instructions of how to handle incoming calls. Instructions are a result of mapping logic implemented on your side according to your business case."
},
"statusUrl":{
"type":"string",
"description":"Client's URL for status report delivery after the call is finished."
},
"backupCallbackUrl":{
"type":"string",
"description":"If callbackUrl is unavailable this one will be called instead."
},
"backupStatusUrl":{
"type":"string",
"description":"If statusUrl is unavailable this one will be called instead."
},
"description":{
"type":"string",
"description":"Masking configuration description"
},
"insertDateTime":{
"type":"string",
"format":"date-time",
"description":"Date and time (UTC timezone) when masking configuration is created."
},
"updateDateTime":{
"type":"string",
"format":"date-time",
"description":"Date and time (UTC timezone) when masking configuration was last modified."
}
},
"title":"SetupResponse"
},
"31756dca18d13ab491063defb0eba5e91f72bccd700f710f44794c6f1df9c9ea.ApiException":{
"type":"object",
"properties":{
"requestError":{
"$ref":"#/components/schemas/ApiRequestError"
}
},
"title":"ApiException"
},
"329f726ae6e36d1a92786c502bebf028e5aa08cc32a3a8e9f0bed0d82dbc7157.AdvancedTtsApiRequest":{
"type":"object",
"description":"Advanced voice message request object.",
"properties":{
"bulkId":{
"type":"string",
"description":"The ID which uniquely identifies the request."
},
"messages":{
"type":"array",
"description":"Array of messages to be sent, one object per every message",
"items":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.AdvancedTtsApiMessage"
}
}
},
"required":[
"messages"
],
"title":"AdvancedTtsApiRequest"
},
"4171c7b532e904c90fa2d755f583a0120bed3adbb383ab2309fddb57ee41f476.SingleTtsApiRequest":{
"type":"object",
"description":"Single voice message request object.",
"properties":{
"audioFileUrl":{
"type":"string",
"description":"An audio file can be delivered as a voice message to the recipients. An audio file must be uploaded online, so that the existing URL can be available for file download. Size of the audio file must be below 4 MB. Supported formats of the provided file are mp3 and wav. Our platform needs to have permission to make GET and HEAD HTTP requests on the provided URL. Standard http ports (like 80, 8080, etc.) are advised."
},
"text":{
"type":"string",
"description":"Message to be converted to speech and played to subscribers. Message text can be up to 1400 characters long and cannot contain only punctuation. SSML (_Speech Synthesis Markup Language_) is supported and can be used to fully customize pronunciation of the provided text.",
"externalDocs":{
"description":"SSML support",
"url":"https://www.infobip.com/docs/voice-and-video/reference#ssml-support-text-to-speech-languages"
}
},
"language":{
"type":"string",
"description":"If the message is in text format, the language in which the message is written must be defined for correct pronunciation. More about Text-to-speech functionality and supported TTS languages can be found [here](https://www.infobip.com/docs/voice-and-video/outbound-calls#text-to-speech-voice-over-broadcast). If not set, default language is `English [en]`. If voice is not set, then default voice for that specific language is used. In the case of English language, the voice is `[Joanna]`.",
"externalDocs":{
"description":"Voice Text-To-Speech Languages",
"url":"https://www.infobip.com/docs/voice-and-video/reference#text-to-speech-languages"
}
},
"voice":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Voice"
},
"from":{
"type":"string",
"description":"Numeric sender ID in E.164 standard format (Example: 41793026727). This is caller ID that will be presented to the end user where applicable."
},
"to":{
"type":"string",
"description":"Phone number of the recipient. Phone number must be written in E.164 standard format (Example: 41793026727)."
}
},
"required":[
"from",
"to"
],
"title":"SingleTtsApiRequest"
},
"42b3068683a04f02f0303cd880adeb4415571c6aad33d9a3c6850123c94c9889.VoiceReport":{
"type":"object",
"properties":{
"bulkId":{
"type":"string",
"description":"The ID that uniquely identifies the bulk of messages.",
"readOnly":false,
"writeOnly":false
},
"messageId":{
"type":"string",
"description":"The ID that uniquely identifies the message sent.",
"readOnly":false,
"writeOnly":false
},
"to":{
"type":"string",
"description":"Destination address of the voice message.",
"readOnly":false,
"writeOnly":false
},
"sentAt":{
"type":"string",
"description":"Date and time when the voice message was initiated. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.",
"readOnly":false,
"writeOnly":false
},
"doneAt":{
"type":"string",
"description":"Date and time when the Infobip services finished processing the voice message (i.e. delivered to the destination, delivered to the destination network, etc.). Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.",
"readOnly":false,
"writeOnly":false
},
"startTime":{
"type":"string",
"description":"Date and time when the voice message was established and started ringing. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.",
"readOnly":false,
"writeOnly":false
},
"answerTime":{
"type":"string",
"description":"Date and time when the voice message was answered. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.",
"readOnly":false,
"writeOnly":false
},
"endTime":{
"type":"string",
"description":"Date and time when the voice message was ended. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.",
"readOnly":false,
"writeOnly":false
},
"duration":{
"type":"integer",
"format":"int32",
"description":"Duration of the voice message call, in seconds.",
"readOnly":false,
"writeOnly":false
},
"fileDuration":{
"type":"number",
"format":"double",
"description":"Duration of the voice message audio file, in seconds.",
"readOnly":false,
"writeOnly":false
},
"mccMnc":{
"type":"string",
"description":"Mobile country and network codes.",
"readOnly":false,
"writeOnly":false
},
"callbackData":{
"type":"string",
"description":"Custom data sent over to the notifyUrl.",
"readOnly":false,
"writeOnly":false
},
"dtmfCodes":{
"type":"string",
"description":"DTMF code entered by user. Can be empty string, if user did not press anything, or `null` in case of IVR if user did not participate in Collect action.",
"readOnly":false,
"writeOnly":false
},
"dtmfCodesAsJson":{
"type":"string",
"description":"DTMF code entered by user, but in JSON form - including DTMF variable names.",
"readOnly":false,
"writeOnly":false
},
"transcribedAudioFileUrl":{
"type":"string",
"description":"Url to retrieve call transcription that were made by voice messages with the transcribe feature activated.",
"readOnly":false,
"writeOnly":false
},
"scenarioId":{
"type":"string",
"description":"The ID that uniquely identifies the IVR scenario.",
"readOnly":false,
"writeOnly":false
},
"scenarioName":{
"type":"string",
"description":"Name of IVR scenario.",
"readOnly":false,
"writeOnly":false
},
"price":{
"allOf":[
{
"$ref":"#/components/schemas/a22294a21e0a6f95f3711ca1f29de62bd2ce6d8bf890b9e41dadab263638faaf.Price"
}
],
"description":"Sent voice message price.",
"readOnly":false,
"writeOnly":false
},
"status":{
"allOf":[
{
"$ref":"#/components/schemas/a22294a21e0a6f95f3711ca1f29de62bd2ce6d8bf890b9e41dadab263638faaf.Status"
}
],
"description":"Indicates whether the message is successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status.",
"externalDocs":{
"description":"Response status and error codes",
"url":"https://www.infobip.com/docs/essentials/api-essentials/response-status-and-error-codes#status-object-example"
},
"readOnly":false,
"writeOnly":false
},
"error":{
"allOf":[
{
"$ref":"#/components/schemas/a22294a21e0a6f95f3711ca1f29de62bd2ce6d8bf890b9e41dadab263638faaf.Error"
}
],
"description":"Indicates whether the error occurred during the query execution.",
"externalDocs":{
"description":"Response status and error codes",
"url":"https://www.infobip.com/docs/essentials/api-essentials/response-status-and-error-codes#error-object-example"
},
"readOnly":false,
"writeOnly":false
}
},
"title":"VoiceReport"
},
"42b3068683a04f02f0303cd880adeb4415571c6aad33d9a3c6850123c94c9889.VoiceReportsResponse":{
"type":"object",
"properties":{
"results":{
"type":"array",
"description":"Arrays of delivery reports, one object for every message.",
"items":{
"$ref":"#/components/schemas/42b3068683a04f02f0303cd880adeb4415571c6aad33d9a3c6850123c94c9889.VoiceReport"
},
"readOnly":false,
"writeOnly":false
}
},
"title":"VoiceReportsResponse"
},
"431fb79b0e816230968e14ba1e1c6fadb75cfde9cb3c381f4217b2777f48153f.Call":{
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"Unique call ID.",
"example":"d8d84155-3831-43fb-91c9-bb897149a79d",
"maxLength":128
},
"endpoint":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallEndpoint"
},
"from":{
"type":"string",
"description":"Caller ID.",
"example":"44790123456"
},
"to":{
"type":"string",
"description":"Callee ID.",
"example":"44790987654"
},
"direction":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallDirection"
},
"state":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallState"
},
"media":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MediaProperties"
},
"startTime":{
"type":"string",
"format":"date-time",
"description":"Date and time for when the call has been created."
},
"answerTime":{
"type":"string",
"format":"date-time",
"description":"Date and time for when the call has been answered."
},
"endTime":{
"type":"string",
"format":"date-time",
"description":"Date and time for when the call has been finished."
},
"parentCallId":{
"type":"string",
"description":"Parent call ID.",
"example":"3ad8805e-d401-424e-9b03-e02a2016a5e2",
"maxLength":128
},
"machineDetection":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MachineDetectionProperties"
},
"ringDuration":{
"type":"integer",
"format":"int32",
"description":"Ringing duration in seconds.",
"example":3
},
"callsConfigurationId":{
"type":"string",
"description":"Current calls configuration ID.",
"example":"dc5942707c704551a00cd2ea"
},
"platform":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Platform"
},
"conferenceId":{
"type":"string",
"description":"Current conference ID.",
"example":"034e622a-cc7e-456d-8a10-0ba43b11aa5e",
"maxLength":128
},
"customData":{
"type":"object",
"additionalProperties":{
"type":"string",
"example":"{\"key1\":\"value1\",\"key2\":\"value2\"}"
},
"description":"Custom data.",
"example":{
"key1":"value1",
"key2":"value2"
}
},
"dialogId":{
"type":"string",
"description":"Dialog ID.",
"example":"5aee53f4-72f8-484b-bfcc-10c5f5476f70",
"maxLength":128
},
"externalId":{
"type":"string",
"description":"Client defined call ID."
}
},
"required":[
"endpoint"
],
"title":"Call"
},
"431fb79b0e816230968e14ba1e1c6fadb75cfde9cb3c381f4217b2777f48153f.CallLog":{
"type":"object",
"properties":{
"callId":{
"type":"string",
"description":"Unique call ID.",
"example":"d8d84155-3831-43fb-91c9-bb897149a79d",
"maxLength":128
},
"endpoint":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallEndpoint"
},
"from":{
"type":"string",
"description":"Caller ID.",
"example":"44790123456"
},
"to":{
"type":"string",
"description":"Callee ID.",
"example":"44790987654"
},
"direction":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallDirection"
},
"state":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallState"
},
"startTime":{
"type":"string",
"format":"date-time",
"description":"Date and time for when the call has been created."
},
"answerTime":{
"type":"string",
"format":"date-time",
"description":"Date and time for when the call has been answered."
},
"endTime":{
"type":"string",
"format":"date-time",
"description":"Date and time for when the call has been finished."
},
"parentCallId":{
"type":"string",
"description":"Parent call ID.",
"example":"3ad8805e-d401-424e-9b03-e02a2016a5e2",
"maxLength":128
},
"machineDetection":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MachineDetectionProperties"
},
"ringDuration":{
"type":"integer",
"format":"int64",
"description":"Ringing duration in seconds.",
"example":3
},
"callsConfigurationIds":{
"type":"array",
"description":"IDs of the calls configurations used during the call.",
"example":[
"a1b06592152e08646b08c057"
],
"items":{
"type":"string",
"description":"IDs of the calls configurations used during the call.",
"example":"[\"a1b06592152e08646b08c057\"]"
}
},
"platform":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Platform"
},
"conferenceIds":{
"type":"array",
"description":"IDs of the conferences where the call was a participant.",
"example":[
"066675c6-0db6-0db9-b032-031964d09af4"
],
"items":{
"type":"string",
"description":"IDs of the conferences where the call was a participant.",
"example":"[\"066675c6-0db6-0db9-b032-031964d09af4\"]"
}
},
"duration":{
"type":"integer",
"format":"int64",
"description":"Call duration in seconds.",
"example":5
},
"hasCameraVideo":{
"type":"boolean",
"description":"Indicates if camera was enabled during the call.",
"example":false
},
"hasScreenshareVideo":{
"type":"boolean",
"description":"Indicates if screen sharing was enabled during the call.",
"example":false
},
"errorCode":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ErrorCodeInfo"
},
"customData":{
"type":"object",
"additionalProperties":{
"type":"string",
"example":"{\"key1\":\"value1\",\"key2\":\"value2\"}"
},
"description":"Custom data.",
"example":{
"key1":"value1",
"key2":"value2"
}
},
"dialogId":{
"type":"string",
"description":"Dialog ID.",
"maxLength":128
},
"sender":{
"type":"string",
"description":"Sender."
},
"hangupSource":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.HangupSource"
},
"externalId":{
"type":"string",
"description":"Client defined call ID."
}
},
"required":[
"endpoint"
],
"title":"CallLog"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse":{
"type":"object",
"properties":{
"status":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionStatus"
}
},
"title":"ActionResponse"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionStatus":{
"type":"string",
"description":"Action status.",
"enum":[
"PENDING",
"IN_PROGRESS",
"COMPLETED",
"FAILED"
],
"title":"ActionStatus"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionType":{
"type":"string",
"description":"Action type related to error code.",
"enum":[
"SEND_RINGING",
"PLAY",
"SAY",
"SEND_DTMF",
"CAPTURE_DTMF",
"CAPTURE_SPEECH",
"CALL_TRANSCRIPTION",
"CREATE_BULK"
],
"title":"ActionType"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AdvisorRole":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Role"
},
{
"type":"object",
"properties":{
"advise":{
"type":"array",
"description":"List of call IDs that can hear (and see) this advisor.",
"items":{
"type":"string",
"description":"List of call IDs that can hear (and see) this advisor."
}
}
}
}
],
"required":[
"advise"
],
"title":"AdvisorRole"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AnonymizationType":{
"type":"string",
"default":"NONE",
"description":"Preferred presentation of anonymized calls.",
"enum":[
"NONE",
"REMOTE_PARTY_ID",
"ASSERTED_IDENTITY",
"PREFERRED_IDENTITY"
],
"title":"AnonymizationType"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AnswerRequest":{
"type":"object",
"properties":{
"customData":{
"type":"object",
"additionalProperties":{
"type":"string"
},
"description":"Optional parameter to update a call's custom data."
},
"recording":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallRecordingRequest"
}
},
"title":"AnswerRequest"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ApplicationTransferFailedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ApplicationTransferFailedProperties"
}
}
}
],
"title":"ApplicationTransferFailedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ApplicationTransferFailedProperties":{
"type":"object",
"properties":{
"sourceCallsConfigurationId":{
"type":"string"
},
"destinationCallsConfigurationId":{
"type":"string"
},
"sourceApplicationId":{
"type":"string"
},
"destinationApplicationId":{
"type":"string"
},
"transferId":{
"type":"string"
}
},
"required":[
"destinationApplicationId",
"sourceApplicationId",
"transferId"
],
"title":"ApplicationTransferFailedProperties"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ApplicationTransferFinishedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ApplicationTransferFinishedProperties"
}
}
}
],
"title":"ApplicationTransferFinishedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ApplicationTransferFinishedProperties":{
"type":"object",
"properties":{
"sourceCallsConfigurationId":{
"type":"string"
},
"destinationCallsConfigurationId":{
"type":"string"
},
"sourceApplicationId":{
"type":"string"
},
"destinationApplicationId":{
"type":"string"
},
"transferId":{
"type":"string"
},
"call":{
"$ref":"#/components/schemas/431fb79b0e816230968e14ba1e1c6fadb75cfde9cb3c381f4217b2777f48153f.Call"
},
"locationId":{
"type":"integer",
"format":"int32"
}
},
"required":[
"call",
"destinationApplicationId",
"sourceApplicationId",
"transferId"
],
"title":"ApplicationTransferFinishedProperties"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ApplicationTransferRequestedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ApplicationTransferRequestedProperties"
}
}
}
],
"title":"ApplicationTransferRequestedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ApplicationTransferRequestedProperties":{
"type":"object",
"properties":{
"sourceCallsConfigurationId":{
"type":"string"
},
"sourceApplicationId":{
"type":"string"
},
"transferId":{
"type":"string"
},
"call":{
"$ref":"#/components/schemas/431fb79b0e816230968e14ba1e1c6fadb75cfde9cb3c381f4217b2777f48153f.Call"
},
"locationId":{
"type":"integer",
"format":"int32"
}
},
"required":[
"call",
"sourceApplicationId",
"transferId"
],
"title":"ApplicationTransferRequestedProperties"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AudioCodec":{
"type":"string",
"description":"Audio codec.",
"enum":[
"PCMU",
"PCMA",
"G729"
],
"title":"AudioCodec"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AudioEncoding":{
"type":"string",
"description":"Audio encoding format for the media stream.",
"enum":[
"RAW",
"BASE64"
],
"title":"AudioEncoding"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AudioMediaProperties":{
"type":"object",
"description":"Audio media properties.",
"properties":{
"muted":{
"type":"boolean",
"description":"Indicates whether the end user can speak."
},
"userMuted":{
"type":"boolean",
"description":"Indicates whether the end user muted himself."
},
"deaf":{
"type":"boolean",
"description":"Indicates whether the end user can hear."
}
},
"title":"AudioMediaProperties"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AuditorRole":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Role"
}
],
"title":"AuditorRole"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AuthenticatedSipTrunkRequest":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/6423f137d264daaaab4ca521d6dfeb19cab29b6b25c3d2da0c1c3fb475a5e829.SipTrunkRequest"
},
{
"type":"object",
"properties":{
"authentication":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkAuthenticationRequest"
},
"codecs":{
"type":"array",
"description":"List of audio codecs supported by a SIP trunk.",
"items":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AudioCodec"
}
},
"dtmf":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DtmfType"
},
"fax":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.FaxType"
},
"numberFormat":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.NumberPresentationFormat"
},
"anonymization":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AnonymizationType"
}
}
}
],
"required":[
"billingPackage",
"channelLimit",
"name",
"type"
],
"title":"AuthenticatedSipTrunkRequest"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AuthenticatedSipTrunkUpdateRequest":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/6423f137d264daaaab4ca521d6dfeb19cab29b6b25c3d2da0c1c3fb475a5e829.SipTrunkUpdateRequest"
},
{
"type":"object",
"properties":{
"authentication":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkAuthentication"
},
"codecs":{
"type":"array",
"description":"List of audio codecs supported by a SIP trunk.",
"items":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AudioCodec"
}
},
"dtmf":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DtmfType"
},
"fax":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.FaxType"
},
"numberFormat":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.NumberPresentationFormat"
},
"anonymization":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AnonymizationType"
}
}
}
],
"required":[
"name",
"type"
],
"title":"AuthenticatedSipTrunkUpdateRequest"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BasicUrlSecurityConfig":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.UrlSecurityConfig"
},
{
"type":"object",
"properties":{
"username":{
"type":"string",
"description":"Username."
},
"password":{
"type":"string",
"description":"Password."
}
}
}
],
"required":[
"password",
"username"
],
"title":"BasicUrlSecurityConfig"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BillingPackage":{
"type":"object",
"description":"Billing package.",
"properties":{
"packageType":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BillingPackageType"
},
"countryCode":{
"type":"string",
"description":"Country code. Currently, only `USA` is supported and required for the `UNLIMITED` package type.",
"example":"USA"
},
"addressId":{
"type":"string",
"description":"ID of SIP trunk address."
}
},
"required":[
"packageType"
],
"title":"BillingPackage"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BillingPackageType":{
"type":"string",
"description":"Billing package type.",
"enum":[
"METERED",
"UNLIMITED"
],
"example":"METERED",
"title":"BillingPackageType"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BulkCall":{
"type":"object",
"description":"Bulk call list.",
"properties":{
"callsConfigurationId":{
"type":"string",
"description":"Calls Configuration ID."
},
"platform":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Platform"
},
"callId":{
"type":"string",
"description":"Unique call ID.",
"maxLength":128
},
"externalId":{
"type":"string",
"description":"Client-defined call ID."
},
"from":{
"type":"string",
"description":"Caller identifier."
},
"endpoint":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BulkEndpoint"
},
"status":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionStatus"
},
"reason":{
"type":"string",
"description":"Failure reason in human-readable format."
}
},
"title":"BulkCall"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BulkCallRequest":{
"type":"object",
"description":"Call request list.",
"minLength":1,
"properties":{
"externalId":{
"type":"string",
"description":"Custom ID assigned by the client."
},
"endpoint":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BulkEndpoint"
}
},
"required":[
"endpoint"
],
"title":"BulkCallRequest"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BulkCallStatusEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallLogProperties"
}
}
}
],
"title":"BulkCallStatusEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BulkEndpoint":{
"type":"object",
"description":"Call endpoint. Represents the callee for a call.",
"discriminator":{
"propertyName":"type",
"mapping":{
"PHONE":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BulkPhoneEndpoint"
}
},
"example":{
"phoneNumber":"41792030000",
"type":"PHONE"
},
"properties":{
"type":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BulkEndpointType"
}
},
"title":"CallEndpoint"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BulkEndpointType":{
"type":"string",
"enum":[
"PHONE"
],
"title":"BulkEndpointType"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BulkItem":{
"type":"object",
"description":"Bulk item list.",
"minLength":1,
"properties":{
"from":{
"type":"string",
"description":"Caller identifier. Must be a number in the [E.164](https://en.wikipedia.org/wiki/E.164) format."
},
"callRequests":{
"type":"array",
"description":"Call request list.",
"items":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BulkCallRequest"
},
"minLength":1
},
"recording":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallRecordingRequest"
},
"machineDetection":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MachineDetectionRequest"
},
"maxDuration":{
"type":"integer",
"format":"int32",
"default":28800,
"description":"Maximum call duration in seconds. Once exceeded, the call terminates automatically."
},
"connectTimeout":{
"type":"integer",
"format":"int32",
"description":"Time to wait, in seconds, before the called party answers the call. Once exceeded, the call terminates automatically.",
"maximum":60
},
"callRate":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallRate"
},
"validityPeriod":{
"type":"integer",
"format":"int32",
"description":"The call validity period in minutes. Once expired, the call is not established."
},
"retryOptions":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RetryOptions"
},
"schedulingOptions":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SchedulingOptions"
},
"customData":{
"type":"object",
"additionalProperties":{
"type":"string"
},
"description":"Client-defined, bulk-level custom data."
}
},
"required":[
"callRequests"
],
"title":"BulkItem"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BulkPhoneEndpoint":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BulkEndpoint"
},
{
"type":"object",
"properties":{
"phoneNumber":{
"type":"string",
"description":"Phone number in the [E.164](https://en.wikipedia.org/wiki/E.164) format."
}
}
}
],
"required":[
"phoneNumber"
],
"title":"BulkPhoneEndpoint"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BulkStatus":{
"type":"object",
"properties":{
"bulkId":{
"type":"string",
"description":"Unique ID of the bulk request.",
"example":"46ab0413-448f-4153-ada9-b68b14242dc3"
},
"startTime":{
"type":"string",
"format":"date-time",
"description":"Bulk request handling start time."
},
"status":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Status"
}
},
"title":"BulkStatus"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallDirection":{
"type":"string",
"description":"Call direction.",
"enum":[
"INBOUND",
"OUTBOUND"
],
"title":"CallDirection"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallDisconnectedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallProperties"
}
}
}
],
"title":"CallDisconnectedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallEndpoint":{
"type":"object",
"description":"Call endpoint. Represents a caller for the inbound calls and a callee for the outbound calls.",
"discriminator":{
"propertyName":"type",
"mapping":{
"PHONE":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PhoneEndpoint",
"SIP":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipEndpoint",
"WEBRTC":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.WebRtcEndpoint",
"VIBER":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ViberEndpoint",
"WHATSAPP":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.WhatsAppEndpoint",
"WEBSOCKET":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.WebsocketEndpoint"
}
},
"example":{
"phoneNumber":"41792030000",
"type":"PHONE"
},
"properties":{
"type":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallEndpointType"
}
},
"title":"CallEndpoint"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallEndpointType":{
"type":"string",
"enum":[
"PHONE",
"SIP",
"WEBRTC",
"VIBER",
"WHATSAPP",
"WEBSOCKET"
],
"title":"CallEndpointType"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallEstablishedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallProperties"
}
}
}
],
"title":"CallEstablishedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallFailedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallWithErrorCodeProperties"
}
}
}
],
"title":"CallFailedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallFinishedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallWithErrorCodeProperties"
}
}
}
],
"title":"CallFinishedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallLogPage":{
"type":"object",
"properties":{
"results":{
"type":"array",
"description":"The list of the results for this page.",
"items":{
"$ref":"#/components/schemas/431fb79b0e816230968e14ba1e1c6fadb75cfde9cb3c381f4217b2777f48153f.CallLog"
}
},
"paging":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PageInfo"
}
},
"title":"CallLogPage"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallLogProperties":{
"type":"object",
"description":"Properties of the events that provide `CallLog` object.",
"properties":{
"callLog":{
"$ref":"#/components/schemas/431fb79b0e816230968e14ba1e1c6fadb75cfde9cb3c381f4217b2777f48153f.CallLog"
}
},
"title":"CallLogProperties"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallMediaChangedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MediaProperties"
}
}
}
],
"title":"CallMediaChangedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallPage":{
"type":"object",
"properties":{
"results":{
"type":"array",
"description":"The list of the results for this page.",
"items":{
"$ref":"#/components/schemas/431fb79b0e816230968e14ba1e1c6fadb75cfde9cb3c381f4217b2777f48153f.Call"
}
},
"paging":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PageInfo"
}
},
"title":"CallPage"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallPreEstablishedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallProperties"
}
}
}
],
"title":"CallPreEstablishedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallProperties":{
"type":"object",
"description":"Properties of the events that provide `Call` object.",
"properties":{
"call":{
"$ref":"#/components/schemas/431fb79b0e816230968e14ba1e1c6fadb75cfde9cb3c381f4217b2777f48153f.Call"
},
"apiBaseUrl":{
"type":"string",
"description":"Base URL of the API which you should invoke for all actions related to the call."
},
"sender":{
"type":"string"
},
"resolvedCnam":{
"type":"string",
"description":"The caller's display name as received with the inbound call. When the called number has CNAM delivery enabled, this field contains the resolved Caller ID Name (CNAM) associated with the calling party's phone number.",
"example":"John Doe"
},
"forwardedFrom":{
"type":"array",
"description":"Call diversion history. Contains information about the original destination and reason if the call was forwarded before reaching the final recipient.",
"example":"forwardedFrom=[ForwardingInfo(number=41793026727, reason=unconditional)]",
"items":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ForwardingInfo"
}
}
},
"title":"CallProperties"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallRate":{
"type":"object",
"description":"Call rate defined in number of calls created per second, minute, hour, or day.",
"properties":{
"maxCalls":{
"type":"integer",
"format":"int32",
"description":"Defines the number of calls scheduled per specified time unit."
},
"timeUnit":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.TimeUnit"
}
},
"title":"CallRate"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallReceivedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallProperties"
}
}
}
],
"title":"CallReceivedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallReconnectedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallProperties"
}
}
}
],
"title":"CallReconnectedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallRecordingDeletedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
}
],
"title":"CallRecordingDeletedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallRecordingFailedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallRecordingFailedProperties"
}
}
}
],
"title":"CallRecordingFailedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallRecordingFailedProperties":{
"type":"object",
"properties":{
"reason":{
"type":"string",
"description":"Recording failure reason."
},
"recordingCustomData":{
"type":"object",
"additionalProperties":{
"type":"string",
"example":"{\"key1\":\"value1\",\"key2\":\"value2\"}"
},
"description":"Recording custom data.",
"example":{
"key1":"value1",
"key2":"value2"
}
},
"fileId":{
"type":"string",
"description":"Recording file identifier.",
"example":"218eceba-c044-430d-9f26-8f1a7f0g2d03"
}
},
"title":"CallRecordingFailedProperties"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallRecordingReadyEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallRecordingReadyProperties"
}
}
}
],
"title":"CallRecordingReadyEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallRecordingReadyProperties":{
"type":"object",
"description":"Call recording information available when recording is ready.",
"properties":{
"recording":{
"$ref":"#/components/schemas/7b57a3f63e8903c91849b16f49588058258cfa7d794a974c87de13a6bfe457e6.CallRecording"
}
},
"title":"CallRecordingReadyProperties"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallRecordingRequest":{
"type":"object",
"properties":{
"recordingType":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingType"
},
"customData":{
"type":"object",
"additionalProperties":{
"type":"string"
}
},
"filePrefix":{
"type":"string",
"maxLength":214,
"minLength":1,
"pattern":"^[a-zA-Z0-9_\\-]*$"
},
"channels":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingChannels"
}
},
"required":[
"recordingType"
],
"title":"CallRecordingRequest"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallRecordingStartedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallRecordingStartedProperties"
}
}
}
],
"title":"CallRecordingStartedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallRecordingStartedProperties":{
"type":"object",
"description":"Call recording information available when recording is started.",
"properties":{
"recordingType":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingType"
},
"fileId":{
"type":"string",
"description":"Recording file identifier.",
"example":"218eceba-c044-430d-9f26-8f1a7f0g2d03"
},
"maxDuration":{
"type":"integer",
"format":"int32",
"description":"Maximum recording duration in seconds."
},
"maxSilence":{
"type":"integer",
"format":"int32",
"description":"Silence duration, in seconds, before the recording stops."
},
"beep":{
"type":"boolean",
"description":"Flag indicating if a beep sound should be played before recording."
},
"filePrefix":{
"type":"string",
"description":"Custom name for the recording's zip file."
},
"customData":{
"type":"object",
"additionalProperties":{
"type":"string"
},
"description":"Custom data."
}
},
"title":"CallRecordingStartedProperties"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallRecordingStoppedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallRecordingStoppedProperties"
}
}
}
],
"title":"CallRecordingStoppedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallRecordingStoppedProperties":{
"type":"object",
"description":"Description of the recording stopped event.",
"properties":{
"startTime":{
"type":"string",
"format":"date-time",
"description":"Date and time for when the call recording has started."
},
"endTime":{
"type":"string",
"format":"date-time",
"description":"Date and time for when the call recording has stopped."
},
"fileId":{
"type":"string",
"description":"Recording file identifier.",
"example":"218eceba-c044-430d-9f26-8f1a7f0g2d03"
}
},
"title":"CallRecordingStoppedProperties"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallRingingEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallProperties"
}
}
}
],
"title":"CallRingingEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallStartedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallProperties"
},
"retryProperties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RetryProperties"
}
}
}
],
"title":"CallStartedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallState":{
"type":"string",
"description":"Call state.",
"enum":[
"CALLING",
"RINGING",
"PRE_ESTABLISHED",
"ESTABLISHED",
"FINISHED",
"FAILED",
"CANCELLED",
"NO_ANSWER",
"BUSY"
],
"title":"CallState"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallWithErrorCodeProperties":{
"type":"object",
"description":"Properties of the events that provide `CallLog` object.",
"properties":{
"callLog":{
"$ref":"#/components/schemas/431fb79b0e816230968e14ba1e1c6fadb75cfde9cb3c381f4217b2777f48153f.CallLog"
}
},
"title":"CallWithErrorCodeProperties"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CiscoWebexProvider":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PegasusProvider"
},
{
"type":"object",
"properties":{
"ciscoUUID":{
"type":"string",
"description":"Cisco organization ID."
}
}
}
],
"required":[
"ciscoUUID"
],
"title":"CiscoWebexProvider"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ConferenceComposition":{
"type":"object",
"properties":{
"enabled":{
"type":"boolean",
"default":false,
"description":"Indicates whether to create a single recording of all participants. If set to `True`, all\nparticipants are merged into a single audio or video file. Otherwise, all participants will have their\nown individual audio or video file."
}
},
"title":"ConferenceComposition"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ConferenceCompositionFailedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ConferenceCompositionFailedProperties"
}
}
}
],
"title":"ConferenceCompositionFailedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ConferenceCompositionFailedProperties":{
"type":"object",
"description":"Detailed failure description.",
"properties":{
"reason":{
"type":"string",
"description":"Failure reason in human-readable format."
}
},
"title":"ConferenceCompositionFailedProperties"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ConferenceCompositionFinishedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ConferenceCompositionFinishedProperties"
}
}
}
],
"title":"ConferenceCompositionFinishedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ConferenceCompositionFinishedProperties":{
"type":"object",
"description":"Conference recording information available upon finished composition.",
"properties":{
"recording":{
"$ref":"#/components/schemas/7b57a3f63e8903c91849b16f49588058258cfa7d794a974c87de13a6bfe457e6.ConferenceRecording"
}
},
"title":"ConferenceCompositionFinishedProperties"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ConferenceCreatedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ConferenceProperties"
}
}
}
],
"title":"ConferenceCreatedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ConferenceFinishedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ConferenceWithErrorCodeProperties"
}
}
}
],
"title":"ConferenceFinishedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ConferenceProperties":{
"type":"object",
"description":"Properties of the events that provide `Conference` object.",
"properties":{
"conference":{
"$ref":"#/components/schemas/c18e27d419b307552daa9403b0085ee796da1a5e57e2a4e6fb73f406471574fc.Conference"
},
"apiBaseUrl":{
"type":"string",
"description":"Base URL of API which you should invoke for all actions related to the conference."
}
},
"title":"ConferenceProperties"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ConferenceRecordingDeletedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
}
],
"title":"ConferenceRecordingDeletedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ConferenceRecordingFailedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingFailedProperties"
}
}
}
],
"title":"ConferenceRecordingFailedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ConferenceRecordingLog":{
"type":"object",
"description":"Conference recordings.",
"properties":{
"composedFiles":{
"type":"array",
"description":"File(s) with a recording of all conference participants.",
"items":{
"$ref":"#/components/schemas/a8c993b4bcabd2960dfaf3986394e0fe85cd1c09dc98b0a81b51403a00c8f97c.PublicRecordingFile"
}
},
"callRecordings":{
"type":"array",
"description":"File(s) with a recording of one conference participant.",
"items":{
"$ref":"#/components/schemas/a8c993b4bcabd2960dfaf3986394e0fe85cd1c09dc98b0a81b51403a00c8f97c.PublicCallRecording"
}
}
},
"title":"ConferenceRecordingLog"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ConferenceRecordingReadyEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ConferenceRecordingReadyProperties"
}
}
}
],
"title":"ConferenceRecordingReadyEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ConferenceRecordingReadyProperties":{
"type":"object",
"description":"Conference recording information available when recording is ready.",
"properties":{
"recording":{
"$ref":"#/components/schemas/7b57a3f63e8903c91849b16f49588058258cfa7d794a974c87de13a6bfe457e6.ConferenceRecording"
}
},
"title":"ConferenceRecordingReadyProperties"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ConferenceRecordingStartedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingStartedProperties"
}
}
}
],
"title":"ConferenceRecordingStartedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ConferenceRecordingStoppedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ConferenceRecordingStoppedProperties"
}
}
}
],
"title":"ConferenceRecordingStoppedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ConferenceRecordingStoppedProperties":{
"type":"object",
"description":"Description of the recording stopped event.",
"properties":{
"startTime":{
"type":"string",
"format":"date-time",
"description":"Date and time for when the conference recording has started."
},
"endTime":{
"type":"string",
"format":"date-time",
"description":"Date and time for when the conference recording has stopped."
}
},
"title":"ConferenceRecordingStoppedProperties"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ConferenceWithErrorCodeProperties":{
"type":"object",
"description":"Properties of the events that provide `Conference` object together with `ErrorCode`.",
"properties":{
"conference":{
"$ref":"#/components/schemas/c18e27d419b307552daa9403b0085ee796da1a5e57e2a4e6fb73f406471574fc.Conference"
},
"errorCode":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ErrorCodeInfo"
}
},
"title":"ConferenceWithErrorCodeProperties"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DayOfWeek":{
"type":"string",
"description":"Days when scheduling call establishment will be attempted.",
"enum":[
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
"SUNDAY"
],
"title":"DayOfWeek"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DefaultRole":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Role"
}
],
"title":"DefaultRole"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DetectionResult":{
"type":"string",
"description":"Detected class during analysis of the call. Always returns either HUMAN or MACHINE. Use confidenceRating for a finer grained analysis result",
"enum":[
"HUMAN",
"MACHINE"
],
"example":"HUMAN",
"title":"DetectionResult"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Dialog":{
"type":"object",
"properties":{
"id":{
"type":"string"
},
"callsConfigurationId":{
"type":"string"
},
"applicationId":{
"type":"string"
},
"entityId":{
"type":"string"
},
"state":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogState"
},
"startTime":{
"type":"string",
"format":"date-time"
},
"establishTime":{
"type":"string",
"format":"date-time"
},
"endTime":{
"type":"string",
"format":"date-time"
},
"parentCall":{
"$ref":"#/components/schemas/431fb79b0e816230968e14ba1e1c6fadb75cfde9cb3c381f4217b2777f48153f.Call"
},
"childCall":{
"$ref":"#/components/schemas/431fb79b0e816230968e14ba1e1c6fadb75cfde9cb3c381f4217b2777f48153f.Call"
}
},
"title":"Dialog"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogCompositionFailedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogCompositionFailedProperties"
}
}
}
],
"title":"DialogCompositionFailedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogCompositionFailedProperties":{
"type":"object",
"description":"Detailed failure description.",
"properties":{
"reason":{
"type":"string",
"description":"Failure reason in human-readable format."
}
},
"title":"DialogCompositionFailedProperties"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogCompositionFinishedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogCompositionFinishedProperties"
}
}
}
],
"title":"DialogCompositionFinishedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogCompositionFinishedProperties":{
"type":"object",
"description":"Dialog recording information available upon finished composition.",
"properties":{
"recording":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogRecording"
}
},
"title":"DialogCompositionFinishedProperties"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogCreatedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogCreatedProperties"
}
}
}
],
"title":"DialogCreatedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogCreatedProperties":{
"type":"object",
"description":"Properties of the event that provide created `Dialog` object.",
"properties":{
"dialog":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Dialog"
},
"apiBaseUrl":{
"type":"string",
"description":"Base URL of API which you should invoke for all actions related to the dialog."
}
},
"title":"DialogCreatedProperties"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogEstablishedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogProperties"
}
}
}
],
"title":"DialogEstablishedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogFailedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogWithErrorCodeProperties"
}
}
}
],
"title":"DialogFailedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogFinishedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogWithErrorCodeProperties"
}
}
}
],
"title":"DialogFinishedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogHangupSource":{
"type":"string",
"enum":[
"API",
"PARENT_ENDPOINT",
"CHILD_ENDPOINT",
"PLATFORM"
],
"title":"DialogHangupSource"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogProperties":{
"type":"object",
"description":"Properties of the events that provide `Dialog` object.",
"properties":{
"dialog":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Dialog"
}
},
"title":"DialogProperties"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogRecording":{
"type":"object",
"properties":{
"dialogId":{
"type":"string"
},
"callsConfigurationId":{
"type":"string"
},
"applicationId":{
"type":"string"
},
"entityId":{
"type":"string"
},
"composedFiles":{
"type":"array",
"items":{
"$ref":"#/components/schemas/7b57a3f63e8903c91849b16f49588058258cfa7d794a974c87de13a6bfe457e6.RecordingFile"
}
},
"callRecordings":{
"type":"array",
"items":{
"$ref":"#/components/schemas/7b57a3f63e8903c91849b16f49588058258cfa7d794a974c87de13a6bfe457e6.CallRecording"
}
},
"startTime":{
"type":"string",
"format":"date-time"
},
"endTime":{
"type":"string",
"format":"date-time"
}
},
"title":"DialogRecording"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogRecordingComposition":{
"type":"object",
"properties":{
"enabled":{
"type":"boolean",
"default":false,
"description":"Indicates whether to create a single recording of both participants. If set to `true`, both participants are merged into a single audio or video file. Otherwise, both participants will have their own individual audio or video file."
}
},
"title":"DialogRecordingComposition"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogRecordingDeletedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
}
],
"title":"DialogRecordingDeletedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogRecordingFailedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingFailedProperties"
}
}
}
],
"title":"DialogRecordingFailedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogRecordingLog":{
"type":"object",
"description":"Dialog recordings.",
"properties":{
"composedFiles":{
"type":"array",
"description":"File(s) with a recording of both dialog calls.",
"items":{
"$ref":"#/components/schemas/a8c993b4bcabd2960dfaf3986394e0fe85cd1c09dc98b0a81b51403a00c8f97c.PublicRecordingFile"
}
},
"callRecordings":{
"type":"array",
"description":"File(s) with a recording of individual dialog calls.",
"items":{
"$ref":"#/components/schemas/a8c993b4bcabd2960dfaf3986394e0fe85cd1c09dc98b0a81b51403a00c8f97c.PublicCallRecording"
}
}
},
"title":"DialogRecordingLog"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogRecordingReadyEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogRecordingReadyProperties"
}
}
}
],
"title":"DialogRecordingReadyEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogRecordingReadyProperties":{
"type":"object",
"description":"Dialog recording information available when recording is ready.",
"properties":{
"recording":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogRecording"
}
},
"title":"DialogRecordingReadyProperties"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogRecordingStartedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingStartedProperties"
}
}
}
],
"title":"DialogRecordingStartedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogRecordingStoppedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogRecordingStoppedProperties"
}
}
}
],
"title":"DialogRecordingStoppedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogRecordingStoppedProperties":{
"type":"object",
"description":"Description of the recording stopped event.",
"properties":{
"startTime":{
"type":"string",
"format":"date-time",
"description":"Date and time for when the dialog recording has started."
},
"endTime":{
"type":"string",
"format":"date-time",
"description":"Date and time for when the dialog recording has stopped."
}
},
"title":"DialogRecordingStoppedProperties"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogState":{
"type":"string",
"enum":[
"CREATED",
"PRE_ESTABLISHED",
"ESTABLISHED",
"FINISHED",
"FAILED",
"TRANSFERRING"
],
"title":"DialogState"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogTransferFailedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
}
],
"title":"DialogTransferFailedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogTransferFinishedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
}
],
"title":"DialogTransferFinishedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogTransferRequestedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogTransferRequestedProperties"
}
}
}
],
"title":"DialogTransferRequestedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogTransferRequestedProperties":{
"type":"object",
"properties":{
"transferorCall":{
"$ref":"#/components/schemas/431fb79b0e816230968e14ba1e1c6fadb75cfde9cb3c381f4217b2777f48153f.Call"
},
"referTo":{
"type":"string",
"description":"Transfer destination."
}
},
"title":"DialogTransferRequestedProperties"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogWithErrorCodeProperties":{
"type":"object",
"description":"Properties of the events that provide `Dialog` object together with `ErrorCode`.",
"properties":{
"dialog":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Dialog"
},
"errorCode":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ErrorCodeInfo"
},
"hangupSource":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogHangupSource"
}
},
"title":"DialogWithErrorCodeProperties"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DtmfCapturedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DtmfProperties"
}
}
}
],
"title":"DtmfCapturedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DtmfProperties":{
"type":"object",
"description":"Properties of the events that provide DTMF capturing result.",
"properties":{
"dtmf":{
"type":"string",
"description":"Collected DTMF input."
},
"timeout":{
"type":"boolean",
"description":"Whether collection was terminated by the timeout."
},
"customData":{
"type":"object",
"additionalProperties":{
"type":"string"
},
"description":"Custom data."
},
"playedContentProperties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PlayedContentProperties"
}
},
"title":"DtmfProperties"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DtmfTermination":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicTermination"
},
{
"type":"object",
"properties":{
"terminator":{
"type":"string",
"description":"Digits used to end the audio playback. If no digits are set, any DTMF digit will end the audio playback. After first DTMF digit is pressed, playback will stop and pressed digit will be present in `PLAY_FINISHED` or `SAY_FINISHED` event. \nIf terminator is set to `123`, pressing either `1`, `2` or `3` will terminate the playback."
}
}
}
],
"title":"DtmfTermination"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DtmfType":{
"type":"string",
"default":"RFC2833",
"description":"DTMF type.",
"enum":[
"RFC2833",
"INBAND"
],
"title":"DtmfType"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ErrorCodeInfo":{
"type":"object",
"description":"Reason why the call has finished.",
"properties":{
"id":{
"type":"integer",
"format":"int32",
"description":"Unique ErrorCode ID.",
"example":10000
},
"name":{
"type":"string",
"description":"Unique ErrorCode name in machine-readable format.",
"example":"NORMAL_HANGUP"
},
"description":{
"type":"string",
"description":"ErrorCode description in human-readable format.",
"example":"The call has ended with hangup initiated by caller, callee or API"
}
},
"title":"ErrorCodeInfo"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ErrorEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ErrorProperties"
}
}
}
],
"title":"ErrorEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ErrorProperties":{
"type":"object",
"description":"Detailed error description.",
"properties":{
"actionType":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionType"
},
"errorCode":{
"type":"string",
"description":"Unique error code in machine-readable format."
},
"errorDetails":{
"type":"string",
"description":"Error details in human-readable format."
}
},
"title":"ErrorProperties"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event":{
"type":"object",
"discriminator":{
"propertyName":"type",
"mapping":{
"DTMF_CAPTURED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DtmfCapturedEvent",
"CALL_ESTABLISHED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallEstablishedEvent",
"CALL_FINISHED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallFinishedEvent",
"CALL_FAILED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallFailedEvent",
"CALL_PRE_ESTABLISHED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallPreEstablishedEvent",
"CALL_RECEIVED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallReceivedEvent",
"CALL_STARTED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallStartedEvent",
"CALL_RINGING":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallRingingEvent",
"CALL_MEDIA_CHANGED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallMediaChangedEvent",
"CALL_RECORDING_STARTED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallRecordingStartedEvent",
"CALL_RECORDING_FAILED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallRecordingFailedEvent",
"CALL_RECORDING_READY":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallRecordingReadyEvent",
"CALL_RECORDING_STOPPED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallRecordingStoppedEvent",
"CONFERENCE_RECORDING_STARTED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ConferenceRecordingStartedEvent",
"CONFERENCE_RECORDING_FAILED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ConferenceRecordingFailedEvent",
"CONFERENCE_RECORDING_READY":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ConferenceRecordingReadyEvent",
"CONFERENCE_RECORDING_STOPPED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ConferenceRecordingStoppedEvent",
"CONFERENCE_CREATED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ConferenceCreatedEvent",
"CONFERENCE_FINISHED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ConferenceFinishedEvent",
"ERROR":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ErrorEvent",
"PARTICIPANT_MEDIA_CHANGED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ParticipantMediaChangedEvent",
"PARTICIPANT_JOIN_FAILED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ParticipantJoinFailedEvent",
"PARTICIPANT_JOINED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ParticipantJoinedEvent",
"PARTICIPANT_JOINING":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ParticipantJoiningEvent",
"PARTICIPANT_REMOVED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ParticipantRemovedEvent",
"PARTICIPANT_RECORDING_FAILED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ParticipantRecordingFailedEvent",
"PARTICIPANT_STARTED_TALKING":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ParticipantStartedTalkingEvent",
"PARTICIPANT_STOPPED_TALKING":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ParticipantStoppedTalkingEvent",
"PARTICIPANT_ROLE_CHANGED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ParticipantRoleChangedEvent",
"PARTICIPANT_ROLE_CHANGE_FAILED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ParticipantRoleChangeFailedEvent",
"PLAY_FINISHED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PlayFinishedEvent",
"CONFERENCE_COMPOSITION_FAILED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ConferenceCompositionFailedEvent",
"CONFERENCE_COMPOSITION_FINISHED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ConferenceCompositionFinishedEvent",
"SAY_FINISHED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SayFinishedEvent",
"MACHINE_DETECTION_FINISHED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MachineDetectionFinishedEvent",
"MACHINE_DETECTION_FAILED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MachineDetectionFailedEvent",
"MACHINE_MESSAGE_DETECTION_FINISHED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MachineMessageDetectionFinishedEvent",
"MACHINE_MESSAGE_DETECTION_FAILED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MachineMessageDetectionFailedEvent",
"MEDIA_STREAM_STARTED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MediaStreamStartedEvent",
"MEDIA_STREAM_FINISHED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MediaStreamFinishedEvent",
"MEDIA_STREAM_FAILED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MediaStreamFailedEvent",
"APPLICATION_TRANSFER_REQUESTED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ApplicationTransferRequestedEvent",
"APPLICATION_TRANSFER_FAILED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ApplicationTransferFailedEvent",
"APPLICATION_TRANSFER_FINISHED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ApplicationTransferFinishedEvent",
"DIALOG_CREATED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogCreatedEvent",
"DIALOG_ESTABLISHED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogEstablishedEvent",
"DIALOG_FAILED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogFailedEvent",
"DIALOG_FINISHED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogFinishedEvent",
"DIALOG_RECORDING_STARTED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogRecordingStartedEvent",
"DIALOG_RECORDING_FAILED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogRecordingFailedEvent",
"DIALOG_RECORDING_READY":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogRecordingReadyEvent",
"DIALOG_RECORDING_STOPPED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogRecordingStoppedEvent",
"DIALOG_COMPOSITION_FAILED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogCompositionFailedEvent",
"DIALOG_COMPOSITION_FINISHED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogCompositionFinishedEvent",
"TRANSCRIPTION":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.TranscriptionEvent",
"SPEECH_CAPTURED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SpeechCapturedEvent",
"BULK_CALL_STATUS":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BulkCallStatusEvent",
"CALL_RECORDING_DELETED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallRecordingDeletedEvent",
"CONFERENCE_RECORDING_DELETED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ConferenceRecordingDeletedEvent",
"DIALOG_RECORDING_DELETED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogRecordingDeletedEvent",
"CALL_DISCONNECTED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallDisconnectedEvent",
"CALL_RECONNECTED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallReconnectedEvent",
"DIALOG_TRANSFER_REQUESTED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogTransferRequestedEvent",
"DIALOG_TRANSFER_FAILED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogTransferFailedEvent",
"DIALOG_TRANSFER_FINISHED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogTransferFinishedEvent"
}
},
"properties":{
"conferenceId":{
"type":"string",
"description":"Unique ID of the conference, if the event is related to a conference.",
"maxLength":128
},
"callId":{
"type":"string",
"description":"Unique ID of the call, if the event is related to a call.",
"maxLength":128
},
"timestamp":{
"type":"string",
"format":"date-time",
"description":"Date and time for when the event has occurred."
},
"callsConfigurationId":{
"type":"string",
"description":"Unique ID of the calls configuration, if the event is related to a calls configuration."
},
"platform":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Platform"
},
"bulkId":{
"type":"string",
"description":"Unique ID of the bulk action, if the event is related to a bulk action."
},
"dialogId":{
"type":"string",
"description":"Unique ID of the dialog that event is related to.",
"maxLength":128
},
"type":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.EventType"
}
},
"title":"Event"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.EventType":{
"type":"string",
"description":"Type determining content of received event.",
"enum":[
"DTMF_CAPTURED",
"CALL_ESTABLISHED",
"CALL_PRE_ESTABLISHED",
"CALL_MEDIA_CHANGED",
"CALL_FINISHED",
"CALL_FAILED",
"CALL_RECEIVED",
"CALL_STARTED",
"CALL_RECORDING_STARTED",
"CALL_RECORDING_FAILED",
"CALL_RECORDING_READY",
"CALL_RECORDING_STOPPED",
"CONFERENCE_RECORDING_STARTED",
"CONFERENCE_RECORDING_FAILED",
"CONFERENCE_RECORDING_READY",
"CONFERENCE_RECORDING_STOPPED",
"CALL_RINGING",
"CONFERENCE_CREATED",
"CONFERENCE_FINISHED",
"ERROR",
"PARTICIPANT_MEDIA_CHANGED",
"PARTICIPANT_JOIN_FAILED",
"PARTICIPANT_JOINED",
"PARTICIPANT_JOINING",
"PARTICIPANT_RECORDING_FAILED",
"PARTICIPANT_REMOVED",
"PARTICIPANT_STARTED_TALKING",
"PARTICIPANT_STOPPED_TALKING",
"PARTICIPANT_ROLE_CHANGED",
"PARTICIPANT_ROLE_CHANGE_FAILED",
"PLAY_FINISHED",
"CONFERENCE_COMPOSITION_FAILED",
"CONFERENCE_COMPOSITION_FINISHED",
"SAY_FINISHED",
"MACHINE_DETECTION_FINISHED",
"MACHINE_DETECTION_FAILED",
"MACHINE_MESSAGE_DETECTION_FINISHED",
"MACHINE_MESSAGE_DETECTION_FAILED",
"MEDIA_STREAM_STARTED",
"MEDIA_STREAM_FAILED",
"MEDIA_STREAM_FINISHED",
"APPLICATION_TRANSFER_REQUESTED",
"APPLICATION_TRANSFER_FAILED",
"APPLICATION_TRANSFER_FINISHED",
"DIALOG_CREATED",
"DIALOG_ESTABLISHED",
"DIALOG_FAILED",
"DIALOG_FINISHED",
"DIALOG_RECORDING_STARTED",
"DIALOG_RECORDING_FAILED",
"DIALOG_RECORDING_READY",
"DIALOG_RECORDING_STOPPED",
"DIALOG_COMPOSITION_FAILED",
"DIALOG_COMPOSITION_FINISHED",
"TRANSCRIPTION",
"SPEECH_CAPTURED",
"BULK_CALL_STATUS",
"CONFERENCE_RECORDING_DELETED",
"DIALOG_RECORDING_DELETED",
"CALL_RECORDING_DELETED",
"CALL_DISCONNECTED",
"CALL_RECONNECTED",
"DIALOG_TRANSFER_REQUESTED",
"DIALOG_TRANSFER_FAILED",
"DIALOG_TRANSFER_FINISHED"
],
"title":"EventType"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.FaxType":{
"type":"string",
"default":"NONE",
"description":"Fax type.",
"enum":[
"NONE",
"INBAND",
"T38"
],
"title":"FaxType"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.File":{
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"File ID.",
"example":"218eceba-c044-430d-9f26-8f1a7f0g2d03"
},
"name":{
"type":"string",
"description":"File name.",
"example":"Example file"
},
"fileFormat":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.FileFormat"
},
"size":{
"type":"integer",
"format":"int64",
"description":"File size in bytes.",
"example":292190
},
"creationTime":{
"type":"string",
"format":"date-time",
"description":"File creation time."
},
"expirationTime":{
"type":"string",
"format":"date-time",
"description":"File expiration time."
},
"duration":{
"type":"integer",
"format":"int64",
"description":"File duration in seconds.",
"example":3
}
},
"required":[
"fileFormat",
"name"
],
"title":"File"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.FileFormat":{
"type":"string",
"description":"File format.",
"enum":[
"MP3",
"WAV",
"MP4"
],
"example":"WAV",
"title":"FileFormat"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.FilePage":{
"type":"object",
"properties":{
"results":{
"type":"array",
"description":"The list of the results for this page.",
"items":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.File"
}
},
"paging":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PageInfo"
}
},
"title":"FilePage"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.FilePlayContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicPlayContent"
},
{
"type":"object",
"properties":{
"fileId":{
"type":"string",
"description":"ID of the previously uploaded audio file."
}
}
}
],
"required":[
"fileId"
],
"title":"FilePlayContent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ForwardingInfo":{
"type":"object",
"description":"Information about a call diversion/forwarding hop, containing the original destination and the reason for forwarding.",
"example":"forwardedFrom=[ForwardingInfo(number=41793026727, reason=unconditional)]",
"properties":{
"number":{
"type":"string",
"description":"The phone number from which the call was forwarded.",
"example":"41793026727"
},
"reason":{
"type":"string",
"description":"The reason why the call was forwarded.",
"example":"unconditional"
}
},
"title":"ForwardingInfo"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.FreshworksProvider":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PegasusProvider"
},
{
"type":"object",
"properties":{
"accountSid":{
"type":"string",
"description":"Twilio account sid of the trunk."
},
"sipDomain":{
"type":"string",
"description":"Sip domain related to the trunk."
}
}
}
],
"required":[
"accountSid",
"sipDomain"
],
"title":"FreshworksProvider"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Gender":{
"type":"string",
"description":"Voice gender in which text would be synthesized.",
"enum":[
"FEMALE",
"MALE"
],
"title":"Gender"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.GenesysCloudProvider":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PegasusProvider"
},
{
"type":"object",
"properties":{
"region":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.GenesysCloudRegion"
},
"outboundTerminationFQDN":{
"type":"string",
"description":"Outbound termination FQDN.",
"readOnly":true
},
"inboundTerminationIdentifier":{
"type":"string",
"description":"Inbound termination identifier.",
"readOnly":true
}
}
}
],
"required":[
"region"
],
"title":"GenesysCloudProvider"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.GenesysCloudRegion":{
"type":"string",
"description":"Genesys cloud region.",
"enum":[
"NA_US_EAST_1",
"NA_US_EAST_2",
"NA_US_WEST_2",
"CA_CENTRAL_1",
"SA_EAST_1",
"EU_CENTRAL_1",
"EU_CENTRAL_2",
"EU_WEST_1",
"EU_WEST_2",
"ME_CENTRAL_1",
"AP_SOUTH_1",
"AP_NORTHEAST_3",
"AP_NORTHEAST_2",
"AP_SOUTHEAST_2",
"AP_SOUTHEAST_1",
"AP_NORTHEAST_1"
],
"title":"GenesysCloudRegion"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.HangupSource":{
"type":"string",
"description":"Hangup source.",
"enum":[
"ENDPOINT",
"API",
"PLATFORM"
],
"title":"HangupSource"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.HmacAlgorithm":{
"type":"string",
"description":"HMAC algorithm.",
"enum":[
"HMAC_MD5",
"HMAC_SHA_1",
"HMAC_SHA_224",
"HMAC_SHA_256",
"HMAC_SHA_384",
"HMAC_SHA_512"
],
"title":"HmacAlgorithm"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.HmacUrlSecurityConfig":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.UrlSecurityConfig"
},
{
"type":"object",
"properties":{
"secretKey":{
"type":"string",
"description":"Secret key."
},
"algorithm":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.HmacAlgorithm"
}
}
}
],
"required":[
"algorithm",
"secretKey"
],
"title":"HmacUrlSecurityConfig"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ListenerRole":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Role"
}
],
"title":"ListenerRole"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MachineDetectionFailedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MachineDetectionFailedProperties"
}
}
}
],
"title":"MachineDetectionFailedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MachineDetectionFailedProperties":{
"type":"object",
"description":"Properties of the machine detection failed event.",
"properties":{
"reason":{
"type":"string",
"description":"Reason behind the machine detection failure."
},
"customData":{
"type":"object",
"additionalProperties":{
"type":"string"
},
"description":"Custom data."
}
},
"title":"MachineDetectionFailedProperties"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MachineDetectionFinishedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MachineDetectionProperties"
}
}
}
],
"title":"MachineDetectionFinishedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MachineDetectionProperties":{
"type":"object",
"description":"Properties of the events that provide Answering Machine Detection result.",
"properties":{
"detectionResult":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DetectionResult"
},
"confidenceRating":{
"type":"object",
"additionalProperties":{
"type":"number",
"format":"double"
},
"description":"A map representing the confidence rating for each detection class. The key is a tag indicating the detection class, and the value is a float between `0.0` and `1.0` representing the confidence rating. Possible classes are: `HUMAN`, `MACHINE`, `MUSIC`, `RINGING`, `NOISE`, `SILENCE` and `OTHER`. Each class confidence rating is independent from the other, thereby the sum of all confidence values may not equal 1.0.",
"example":{
"HUMAN":0.95,
"MACHINE":0.0,
"MUSIC":0.0,
"RINGING":0.0,
"NOISE":0.05,
"SILENCE":0.01,
"OTHER":0.02
}
},
"customData":{
"type":"object",
"additionalProperties":{
"type":"string"
},
"description":"Custom data."
}
},
"title":"MachineDetectionProperties"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MachineDetectionRequest":{
"type":"object",
"properties":{
"enabled":{
"type":"boolean",
"description":"Indicates whether to enable answering machine detection. If set to true, answering machine detection will generate an event indicating if the call was answered by a human or a machine."
},
"messageDetectionTimeout":{
"type":"integer",
"format":"int32",
"description":"Indicates maximum duration for detecting the end of the message when a answering machine is detected. If set to 0, no end of message detection will be done. Expressed in seconds.",
"maximum":60
},
"detectionTime":{
"type":"number",
"format":"double",
"default":3.7,
"description":"Indicates time in seconds during which answering machine detection will analyse the call before making a decision. Shorter detection time may come at the expense of accuracy. Must be lower than `messageDetectionTimeout` if `messageDetectionTimeout` is specified.",
"maximum":5,
"minimum":1
}
},
"required":[
"enabled"
],
"title":"MachineDetectionRequest"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MachineMessageDetectionFailedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MachineMessageDetectionFailedProperties"
}
}
}
],
"title":"MachineMessageDetectionFailedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MachineMessageDetectionFailedProperties":{
"type":"object",
"description":"Properties of the machine message detection failed event.",
"properties":{
"reason":{
"type":"string",
"description":"Reason behind the machine message detection failure."
},
"customData":{
"type":"object",
"additionalProperties":{
"type":"string"
},
"description":"Custom data."
}
},
"title":"MachineMessageDetectionFailedProperties"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MachineMessageDetectionFinishedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MachineMessageDetectionFinishedProperties"
}
}
}
],
"title":"MachineMessageDetectionFinishedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MachineMessageDetectionFinishedProperties":{
"type":"object",
"description":"Properties of the machine message detection finished event.",
"properties":{
"detectionResult":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MachineMessageDetectionResult"
},
"customData":{
"type":"object",
"additionalProperties":{
"type":"string"
},
"description":"Custom data."
}
},
"title":"MachineMessageDetectionFinishedProperties"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MachineMessageDetectionResult":{
"type":"string",
"description":"Result of end of machine message detection.",
"enum":[
"BEEP",
"SILENCE",
"TIMEOUT"
],
"title":"MachineMessageDetectionResult"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MediaProperties":{
"type":"object",
"properties":{
"audio":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AudioMediaProperties"
},
"video":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.VideoMediaProperties"
}
},
"title":"MediaProperties"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MediaStream":{
"type":"object",
"properties":{
"audioProperties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MediaStreamAudioProperties"
}
},
"title":"MediaStream"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MediaStreamAudioProperties":{
"type":"object",
"properties":{
"mediaStreamConfigId":{
"type":"string",
"description":"Media stream configuration ID."
},
"replaceMedia":{
"type":"boolean",
"description":"Indicates whether outbound media should be replaced. The replacement media is received from the url defined in the media stream configuration."
},
"multiChannel":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MediaStreamMultiChannel"
}
},
"required":[
"mediaStreamConfigId"
],
"title":"MediaStreamAudioProperties"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MediaStreamFailedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MediaStreamFailedProperties"
}
}
}
],
"title":"MediaStreamFailedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MediaStreamFailedProperties":{
"type":"object",
"description":"Properties of the media stream failed event.",
"properties":{
"configId":{
"type":"string",
"description":"Media-stream configuration ID."
},
"streamId":{
"type":"string",
"description":"Unique stream identifier."
},
"reason":{
"type":"string",
"description":"Reason why media streaming failed."
}
},
"title":"MediaStreamFailedProperties"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MediaStreamFinishedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MediaStreamFinishedProperties"
}
}
}
],
"title":"MediaStreamFinishedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MediaStreamFinishedProperties":{
"type":"object",
"description":"Properties of the media stream finished event.",
"properties":{
"configId":{
"type":"string",
"description":"Media-stream configuration ID."
},
"streamId":{
"type":"string",
"description":"Unique stream identifier."
},
"reason":{
"type":"string",
"description":"Media stream connection closed: additional info."
}
},
"title":"MediaStreamFinishedProperties"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MediaStreamMultiChannel":{
"type":"object",
"description":"Multi-channel streaming configuration. When enabled, streams both directions as interleaved stereo (left=caller's voice, right=what caller hears). Disabled by default.",
"properties":{
"enabled":{
"type":"boolean"
}
},
"required":[
"enabled"
],
"title":"MediaStreamMultiChannel"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MediaStreamStartedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MediaStreamStartedProperties"
}
}
}
],
"title":"MediaStreamStartedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MediaStreamStartedProperties":{
"type":"object",
"description":"Properties of the media stream started event.",
"properties":{
"configId":{
"type":"string",
"description":"Media-stream configuration ID."
},
"streamId":{
"type":"string",
"description":"Unique stream identifier."
}
},
"title":"MediaStreamStartedProperties"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MediaStreamingConfigRequest":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/58f57942de1c194257c321b1824e5d3941d9e9f538a9f08ddcb73e6025439f43.MediaStreamConfigRequest"
},
{
"type":"object",
"properties":{
"securityConfig":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.UrlSecurityConfig"
}
}
}
],
"required":[
"name",
"type",
"url"
],
"title":"MediaStreamingConfigRequest"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MediaStreamingConfigResponse":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/655eaf80f7479f4a18447865649b33bdb754aaa97779726ffb72592cb1ac3ce5.MediaStreamConfigResponse"
},
{
"type":"object",
"properties":{
"audioEncoding":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AudioEncoding"
}
}
}
],
"title":"MediaStreamingConfigResponse"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MonitorRole":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Role"
}
],
"title":"MonitorRole"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MultiChannel":{
"type":"object",
"description":"Multi-channel configuration. If enabled, audio of each participant will be in a separate channel in the composed file. Otherwise, audio of all participants will be mixed into a single channel in the composed file.",
"properties":{
"enabled":{
"type":"boolean"
}
},
"required":[
"enabled"
],
"title":"MultiChannel"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.NumberPresentationFormat":{
"type":"string",
"description":"Format in which numbers are sent to a SIP trunk.",
"enum":[
"E164",
"INTERNATIONAL",
"US_NATIONAL"
],
"title":"NumberPresentationFormat"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.OnDemandComposition":{
"type":"object",
"description":"Composition request.",
"properties":{
"deleteCallRecordings":{
"type":"boolean",
"default":true,
"description":"Indicates whether to delete individual files for the call recordings after composition. If set to 'true' then files from the call recordings will be deleted after composition. Otherwise, files from the call recordings will be available, alongside with composed file."
},
"multiChannel":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MultiChannel"
}
},
"title":"OnDemandComposition"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.OpenAiProvider":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PegasusProvider"
},
{
"type":"object",
"properties":{
"projectId":{
"type":"string",
"description":"OpenAI Realtime projectId"
}
}
}
],
"required":[
"projectId"
],
"title":"OpenAiProvider"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PageInfo":{
"type":"object",
"description":"Contains information about the page.",
"properties":{
"page":{
"type":"integer",
"format":"int32",
"description":"Requested page number.",
"minimum":0
},
"size":{
"type":"integer",
"format":"int32",
"description":"Requested page size.",
"minimum":1
},
"totalPages":{
"type":"integer",
"format":"int32",
"description":"The total number of pages of the results matching the requested parameters.",
"minimum":0
},
"totalResults":{
"type":"integer",
"format":"int64",
"description":"The total number of the results matching the requested parameters.",
"minimum":0
}
},
"required":[
"page",
"size",
"totalPages",
"totalResults"
],
"title":"PageInfo"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ParticipantJoinFailedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ParticipantWithReasonProperties"
}
}
}
],
"title":"ParticipantJoinFailedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ParticipantJoinedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4b6d991c2661465a70fbabb20a534b0a2c34b3dc4776665474af60f3d1cc5273.ParticipantProperties"
}
}
}
],
"title":"ParticipantJoinedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ParticipantJoiningEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4b6d991c2661465a70fbabb20a534b0a2c34b3dc4776665474af60f3d1cc5273.ParticipantProperties"
}
}
}
],
"title":"ParticipantJoiningEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ParticipantMediaChangedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MediaProperties"
}
}
}
],
"title":"ParticipantMediaChangedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ParticipantRecordingFailedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingFailedProperties"
}
}
}
],
"title":"ParticipantRecordingFailedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ParticipantRemovedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ParticipantWithReasonProperties"
}
}
}
],
"title":"ParticipantRemovedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ParticipantRoleChangeFailedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ParticipantWithReasonProperties"
}
}
}
],
"title":"ParticipantRoleChangeFailedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ParticipantRoleChangedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4b6d991c2661465a70fbabb20a534b0a2c34b3dc4776665474af60f3d1cc5273.ParticipantProperties"
}
}
}
],
"title":"ParticipantRoleChangedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ParticipantSession":{
"type":"object",
"description":"List of participant sessions.",
"properties":{
"callId":{
"type":"string",
"description":"Unique call ID.",
"maxLength":128
},
"joinTime":{
"type":"string",
"format":"date-time",
"description":"Date and time for when the participant joined the conference."
},
"leaveTime":{
"type":"string",
"format":"date-time",
"description":"Date and time for when the participant left the conference."
}
},
"title":"ParticipantSession"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ParticipantStartedTalkingEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
}
],
"title":"ParticipantStartedTalkingEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ParticipantState":{
"type":"string",
"description":"Participant state.",
"enum":[
"JOINING",
"JOINED",
"LEFT"
],
"title":"ParticipantState"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ParticipantStoppedTalkingEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
}
],
"title":"ParticipantStoppedTalkingEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ParticipantWithReasonProperties":{
"type":"object",
"description":"Properties of the events that provide `Participant` object and reason.",
"properties":{
"participant":{
"$ref":"#/components/schemas/c18e27d419b307552daa9403b0085ee796da1a5e57e2a4e6fb73f406471574fc.Participant"
},
"reason":{
"type":"string"
}
},
"title":"ParticipantWithReasonProperties"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PegasusProvider":{
"type":"object",
"discriminator":{
"propertyName":"type",
"mapping":{
"FRESHWORKS":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.FreshworksProvider",
"GENESYS_CLOUD":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.GenesysCloudProvider",
"CISCO_WEBEX":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CiscoWebexProvider",
"OPENAI_REALTIME":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.OpenAiProvider"
}
},
"properties":{
"type":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PegasusProviderTrunkType"
}
},
"title":"PegasusProvider"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PegasusProviderTrunkType":{
"type":"string",
"description":"Provider type.",
"enum":[
"FRESHWORKS",
"GENESYS_CLOUD",
"CISCO_WEBEX",
"OPENAI_REALTIME"
],
"title":"PegasusProviderTrunkType"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PegasusSipTrunkType":{
"type":"string",
"description":"SIP trunk type.",
"enum":[
"STATIC",
"REGISTERED",
"PROVIDER",
"AUTHENTICATED"
],
"title":"PegasusSipTrunkType"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PhoneEndpoint":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallEndpoint"
},
{
"type":"object",
"properties":{
"phoneNumber":{
"type":"string",
"description":"Phone number in the [E.164](https://en.wikipedia.org/wiki/E.164) format."
}
}
}
],
"required":[
"phoneNumber"
],
"title":"PhoneEndpoint"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Platform":{
"type":"object",
"description":"Platform options. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"properties":{
"entityId":{
"type":"string",
"description":"Required to use entity in a send request for outbound traffic. Returned in notification events. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"applicationId":{
"type":"string",
"description":"Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
}
},
"title":"Platform"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PlayFinishedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PlayProperties"
}
}
}
],
"title":"PlayFinishedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PlayProperties":{
"type":"object",
"description":"Properties of the events that provide playback results.",
"properties":{
"duration":{
"type":"integer",
"format":"int64",
"description":"How long, in milliseconds, file was played before the playback was stopped."
},
"playedCompletely":{
"type":"boolean",
"description":"Whether the file was played completely, in its full duration."
},
"capturedDtmf":{
"type":"string",
"description":"Collected DTMF input that stopped the file playback."
},
"customData":{
"type":"object",
"additionalProperties":{
"type":"string"
},
"description":"Custom data."
}
},
"title":"PlayProperties"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PlayedContentProperties":{
"type":"object",
"description":"Properties about content played before collecting DTMF input.",
"properties":{
"duration":{
"type":"integer",
"format":"int64",
"description":"How long, in milliseconds, content was played before DTMF collection started."
},
"playedCompletely":{
"type":"boolean",
"description":"Whether the content was played completely, in it's full duration."
}
},
"title":"PlayedContentProperties"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Provider":{
"type":"string",
"default":"AZURE",
"description":"Speech-to-text provider to use. Defaults to `AZURE`.",
"enum":[
"GOOGLE",
"AZURE",
"DEEPGRAM"
],
"title":"Provider"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ProviderSipTrunkRequest":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/6423f137d264daaaab4ca521d6dfeb19cab29b6b25c3d2da0c1c3fb475a5e829.SipTrunkRequest"
},
{
"type":"object",
"properties":{
"tls":{
"type":"boolean",
"default":false,
"description":"Indicates whether communication is secured by the TLS protocol."
},
"provider":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PegasusProvider"
}
}
}
],
"required":[
"billingPackage",
"channelLimit",
"name",
"provider",
"type"
],
"title":"ProviderSipTrunkRequest"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ProviderSipTrunkUpdateRequest":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/6423f137d264daaaab4ca521d6dfeb19cab29b6b25c3d2da0c1c3fb475a5e829.SipTrunkUpdateRequest"
}
],
"required":[
"name"
],
"title":"ProviderSipTrunkUpdateRequest"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicDialogState":{
"type":"string",
"description":"Dialog state.",
"enum":[
"CREATED",
"PRE_ESTABLISHED",
"ESTABLISHED",
"FINISHED",
"FAILED",
"TRANSFERRING"
],
"title":"PublicDialogState"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicErrorCode":{
"type":"string",
"description":"Error code to hang up with. There are rules for using error codes.\n\n`NORMAL_HANGUP` - Call needs to be established.\n\n`MACHINE_DETECTED` - Call needs to be established and must be `OUTBOUND`.\n\n`NO_ANSWER` - Call cannot be established.\n\n`BUSY` - Call cannot be established.\n\n`CANCELLED` - Call cannot be established.\n\n`REJECTED` - Call cannot be established.\n\n`FORBIDDEN` - Call cannot be established.\n\n`DESTINATION_NOT_FOUND` - Call cannot be established.\n\n`DESTINATION_UNAVAILABLE` - Call cannot be established.\n\n`INVALID_DESTINATION` - Call cannot be established.\n\n`SERVICE_UNAVAILABLE` - Call cannot be established.",
"enum":[
"NORMAL_HANGUP",
"MACHINE_DETECTED",
"NO_ANSWER",
"BUSY",
"CANCELLED",
"REJECTED",
"FORBIDDEN",
"DESTINATION_NOT_FOUND",
"DESTINATION_UNAVAILABLE",
"INVALID_DESTINATION",
"INVALID_REQUEST",
"REQUEST_TIMEOUT",
"SERVICE_UNAVAILABLE"
],
"title":"PublicErrorCode"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicPlayContent":{
"type":"object",
"description":"Audio content to play. It can either be previously uploaded file or a file from a URL.",
"discriminator":{
"propertyName":"type",
"mapping":{
"FILE":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.FilePlayContent",
"URL":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.UrlPlayContent",
"RECORDING":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingPlayContent",
"TEXT":"#/components/schemas/00a1f95ecbb89787a99eae13916106d1d4d9cc2934634cfbf0d16daa73fd2cf0.TextPlayContent",
"TTY":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.TtyPlayContent"
}
},
"properties":{
"type":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicPlayContentType"
}
},
"title":"PlayContent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicPlayContentType":{
"type":"string",
"enum":[
"FILE",
"URL",
"RECORDING",
"TEXT",
"TTY"
],
"title":"PublicPlayContentType"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicTermination":{
"type":"object",
"description":"Indicates when to stop the action. The action can be interrupted at any time by the end user when they press any DTMF key.",
"discriminator":{
"propertyName":"type",
"mapping":{
"DTMF":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DtmfTermination"
}
},
"properties":{
"type":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicTerminationType"
}
},
"title":"PublicTermination"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicTerminationType":{
"type":"string",
"enum":[
"DTMF"
],
"title":"PublicTerminationType"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingChannels":{
"type":"string",
"default":"MONO",
"description":"Audio channel mode. If set to `STEREO`, incoming audio from the endpoint is recorded on the left channel and outgoing audio on the right channel.",
"enum":[
"MONO",
"STEREO"
],
"title":"RecordingChannels"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingFailedProperties":{
"type":"object",
"properties":{
"reason":{
"type":"string",
"description":"Recording failure reason."
},
"recordingCustomData":{
"type":"object",
"additionalProperties":{
"type":"string",
"example":"{\"key1\":\"value1\",\"key2\":\"value2\"}"
},
"description":"Recording custom data.",
"example":{
"key1":"value1",
"key2":"value2"
}
}
},
"title":"RecordingFailedProperties"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingFileLocation":{
"type":"string",
"description":"Location of recording file after processing.",
"enum":[
"SFTP",
"HOSTED"
],
"title":"RecordingFileLocation"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingLocation":{
"type":"string",
"enum":[
"SAO_PAULO",
"BOGOTA",
"FRANKFURT",
"JOHANNESBURG",
"NEW_YORK",
"PORTLAND",
"MOSCOW",
"SINGAPORE",
"ISTANBUL",
"KUALA_LUMPUR",
"JAKARTA",
"MUMBAI",
"HONG_KONG",
"RIYADH",
"CHENNAI"
],
"title":"RecordingLocation"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingPlayContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicPlayContent"
},
{
"type":"object",
"properties":{
"fileId":{
"type":"string",
"description":"ID of the file to be played."
}
}
}
],
"required":[
"fileId"
],
"title":"RecordingPlayContent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingRequest":{
"type":"object",
"properties":{
"recordingType":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingType"
},
"maxSilence":{
"type":"integer",
"format":"int32",
"description":"Silence duration, in seconds, before the recording stops. (If this field is set the recording can't be stopped by the [stop recording endpoint](#call-stop-recording).)"
},
"beep":{
"type":"boolean",
"default":false,
"description":"Flag indicating if a beep sound should be played before recording."
},
"maxDuration":{
"type":"integer",
"format":"int32",
"description":"Maximum recording duration in seconds. (If this field is set the recording can't be stopped by the [stop recording endpoint](#call-stop-recording).)"
},
"customData":{
"type":"object",
"additionalProperties":{
"type":"string"
},
"description":"Custom data."
},
"filePrefix":{
"type":"string",
"description":"Custom name for the recording's zip file. Applicable only when SFTP server is enabled on [Voice settings page](https://portal.infobip.com/apps/voice/recording/settings).\nUsing the same `filePrefix` will override the files on the SFTP server."
}
},
"required":[
"recordingType"
],
"title":"RecordingRequest"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingStartedProperties":{
"type":"object",
"description":"Recording information available when recording is started.",
"properties":{
"recordingType":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingType"
},
"composition":{
"type":"boolean",
"description":"Flag indicating whether auto-compose feature was turned on for the recording."
},
"filePrefix":{
"type":"string",
"description":"Custom name for the recording's zip file."
},
"customData":{
"type":"object",
"additionalProperties":{
"type":"string"
},
"description":"Custom data."
}
},
"title":"RecordingStartedProperties"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingStatus":{
"type":"string",
"description":"Status of call recording.",
"enum":[
"SUCCESSFUL",
"PARTIALLY_FAILED",
"FAILED"
],
"title":"RecordingStatus"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingType":{
"type":"string",
"description":"Recording type.",
"enum":[
"AUDIO",
"AUDIO_AND_VIDEO"
],
"title":"RecordingType"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RegisteredSipTrunkRequest":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/6423f137d264daaaab4ca521d6dfeb19cab29b6b25c3d2da0c1c3fb475a5e829.SipTrunkRequest"
},
{
"type":"object",
"properties":{
"tls":{
"type":"boolean",
"default":false,
"description":"Indicates whether communication is secured by the TLS protocol."
},
"codecs":{
"type":"array",
"description":"List of audio codecs supported by a SIP trunk.",
"items":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AudioCodec"
}
},
"dtmf":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DtmfType"
},
"fax":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.FaxType"
},
"numberFormat":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.NumberPresentationFormat"
},
"anonymization":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AnonymizationType"
},
"inviteAuthentication":{
"type":"boolean",
"default":false,
"description":"Enables an authentication challenge for each call."
}
}
}
],
"required":[
"billingPackage",
"channelLimit",
"name",
"type"
],
"title":"RegisteredSipTrunkRequest"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RegisteredSipTrunkUpdateRequest":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/6423f137d264daaaab4ca521d6dfeb19cab29b6b25c3d2da0c1c3fb475a5e829.SipTrunkUpdateRequest"
},
{
"type":"object",
"properties":{
"inviteAuthentication":{
"type":"boolean",
"description":"Enables an authentication challenge for each call."
},
"codecs":{
"type":"array",
"description":"List of audio codecs supported by a SIP trunk.",
"items":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AudioCodec"
}
},
"dtmf":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DtmfType"
},
"fax":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.FaxType"
},
"anonymization":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AnonymizationType"
},
"numberFormat":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.NumberPresentationFormat"
}
}
}
],
"required":[
"name",
"type"
],
"title":"RegisteredSipTrunkUpdateRequest"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RequestMediaStreamConfigType":{
"type":"string",
"description":"Media stream configuration type.",
"enum":[
"MEDIA_STREAMING",
"WEBSOCKET_ENDPOINT"
],
"title":"RequestMediaStreamConfigType"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RescheduleRequest":{
"type":"object",
"properties":{
"startTime":{
"type":"string",
"format":"date-time",
"description":"Rescheduled start time."
}
},
"required":[
"startTime"
],
"title":"RescheduleRequest"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ResponseMediaStreamConfigType":{
"type":"string",
"description":"Media stream configuration type.",
"enum":[
"MEDIA_STREAMING",
"WEBSOCKET_ENDPOINT"
],
"title":"ResponseMediaStreamConfigType"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ResultType":{
"type":"string",
"enum":[
"INTERIM",
"COMPLETE"
],
"title":"ResultType"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RetryOptions":{
"type":"object",
"description":"Used to determine whether to retry the delivery of a bulk call if the initial attempt fails. Additional retries will occur based on the schedule defined by the _minWaitPeriod_ and _maxWaitPeriod_ parameters, as well as the platform's internal retry logic. If _minWaitPeriod_ differs from _maxWaitPeriod_, the delivery will be retried according to the following schedule: after 1 minute, 2 minutes, 5 minutes, 10 minutes, 20 minutes, 30 minutes, 1 hour, 2 hours, 4 hours, 8 hours, 16 hours, and 24 hours, or until _maxWaitPeriod_ is reached. Once the retry attempt for _maxWaitPeriod_ is reached, _maxWaitPeriod_ will be used for all subsequent retries. If _minWaitPeriod_ and _maxWaitPeriod_ are defined as equal values, the period between retries will be equal to this value. Bulk call delivery will be retried until successful delivery, call validity expiration, or reaching the _maxAttempts_ value.",
"properties":{
"minWaitPeriod":{
"type":"integer",
"format":"int32",
"description":"Defines the minimum waiting time (in minutes) after the previous failed attempt before trying to establish the call again. Supported values are 1 minute, 2 minutes, 5 minutes, 10 minutes, 20 minutes, 30 minutes, 1 hour, 2 hours, 4 hours, 8 hours, 16 hours, and 24 hours. If entered a value that is not in the list but is smaller than 24 hours, the next bigger value from the list will be used. If a value larger than 24 hours is entered, 24 hours will be used."
},
"maxWaitPeriod":{
"type":"integer",
"format":"int32",
"description":"Defines the maximum waiting time (in minutes) after the previous failed attempt before trying to establish the call again. Supported values are 1 minute, 2 minutes, 5 minutes, 10 minutes, 20 minutes, 30 minutes, 1 hour, 2 hours, 4 hours, 8 hours, 16 hours, and 24 hours. If entered a value that is not in the list but is smaller than 24 hours, the next bigger value from the list will be used. If a value larger than 24 hours is entered, 24 hours will be used."
},
"maxAttempts":{
"type":"integer",
"format":"int32",
"description":"Defines the maximum number of retry attempts. The maximum value is `4`. If a value higher than `4` is entered, it will be set to `4`."
}
},
"title":"RetryOptions"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RetryProperties":{
"type":"object",
"description":"Properties indicating whether the event is related with a retried call.",
"properties":{
"retry":{
"type":"boolean"
}
},
"title":"RetryProperties"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Role":{
"type":"object",
"description":"Represents the role of the call inside the conference.",
"discriminator":{
"propertyName":"type",
"mapping":{
"DEFAULT":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DefaultRole",
"ADVISOR":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AdvisorRole",
"MONITOR":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MonitorRole",
"LISTENER":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ListenerRole",
"AUDITOR":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AuditorRole"
}
},
"properties":{
"type":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RoleType"
}
},
"title":"Role"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RoleType":{
"type":"string",
"enum":[
"DEFAULT",
"ADVISOR",
"MONITOR",
"LISTENER",
"AUDITOR"
],
"title":"RoleType"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SayFinishedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SayProperties"
}
}
}
],
"title":"SayFinishedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SayProperties":{
"type":"object",
"description":"Properties of the events that provide results of `say` action.",
"properties":{
"duration":{
"type":"integer",
"format":"int64",
"description":"How long, in milliseconds, synthesized text was played before the playback was stopped."
},
"playedCompletely":{
"type":"boolean",
"description":"Whether the synthesized text was played completely, in its full duration."
},
"capturedDtmf":{
"type":"string",
"description":"Collected DTMF input that stopped the synthesized text playback."
},
"customData":{
"type":"object",
"additionalProperties":{
"type":"string"
},
"description":"Custom data."
}
},
"title":"SayProperties"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SbcHosts":{
"type":"object",
"description":"Infobip SBC (Session Border Controller) hosts.",
"properties":{
"primary":{
"type":"array",
"items":{
"type":"string"
}
},
"backup":{
"type":"array",
"items":{
"type":"string"
}
},
"subnets":{
"type":"array",
"items":{
"type":"string"
}
}
},
"title":"SbcHosts"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SchedulingOptions":{
"type":"object",
"description":"Scheduling object that allows setting up detailed time windows within which calls can be established. Note that calling time window is set in UTC timezone.",
"properties":{
"startTime":{
"type":"string",
"format":"date-time",
"description":"Scheduling start date and time."
},
"callingTimeWindow":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.TimeWindow"
}
},
"title":"SchedulingOptions"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SelectionStrategy":{
"type":"string",
"default":"FAILOVER",
"description":"Strategy for SIP trunk host selection.",
"enum":[
"FAILOVER",
"ROUND_ROBIN"
],
"title":"SelectionStrategy"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SftpUploadStatus":{
"type":"string",
"description":"Indicates current status of the recording file being uploaded via SFTP.",
"enum":[
"UPLOADING",
"UPLOADED",
"FAILED"
],
"title":"SftpUploadStatus"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipEndpoint":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallEndpoint"
},
{
"type":"object",
"properties":{
"username":{
"type":"string",
"description":"SIP endpoint username."
},
"sipTrunkId":{
"type":"string",
"description":"SIP trunk ID."
},
"customHeaders":{
"type":"object",
"additionalProperties":{
"type":"string"
},
"description":"Custom headers. Only headers starting with `X-` prefix will be propagated."
}
}
}
],
"required":[
"sipTrunkId",
"username"
],
"title":"SipEndpoint"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipOptions":{
"type":"object",
"description":"SIP Options.",
"properties":{
"enabled":{
"type":"boolean",
"default":false,
"description":"Indicates whether Infobip Session Border Controller should send SIP Options."
}
},
"title":"SipOptions"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkActionStatus":{
"type":"string",
"description":"Status of the last action performed on the SIP trunk configuration.",
"enum":[
"CREATING",
"UPDATING",
"DELETING",
"FAILED",
"RESET",
"SUCCESS"
],
"title":"SipTrunkActionStatus"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkActionStatusResponse":{
"type":"object",
"description":"SIP trunk action status.",
"properties":{
"status":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkActionStatus"
},
"reason":{
"type":"string",
"description":"Description of the `FAILED` or `RESET` action."
}
},
"title":"SipTrunkActionStatusResponse"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkAdminStatus":{
"type":"string",
"description":"SIP trunk admin status.",
"enum":[
"ENABLED",
"DISABLED",
"SYSTEM_DISABLED"
],
"title":"SipTrunkAdminStatus"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkAuthentication":{
"type":"object",
"description":"Authentication configuration for inbound and outbound calls.",
"properties":{
"inbound":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkInboundAuthentication"
},
"outbound":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkOutboundAuthentication"
}
},
"title":"SipTrunkAuthentication"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkAuthenticationRequest":{
"type":"object",
"description":"Authentication configuration for inbound and outbound calls.",
"properties":{
"inbound":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkInboundAuthenticationRequest"
},
"outbound":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkOutboundAuthentication"
}
},
"title":"SipTrunkAuthenticationRequest"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkAuthenticationWithCredentials":{
"type":"object",
"description":"Generated authentication credentials for inbound and outbound calls.",
"properties":{
"inbound":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkInboundAuthenticationWithCredentials"
},
"outbound":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkOutboundAuthenticationWithCredentials"
}
},
"title":"SipTrunkAuthenticationWithCredentials"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkInboundAuthentication":{
"type":"object",
"description":"Inbound authentication configuration.",
"properties":{
"digestAuthenticationEnabled":{
"type":"boolean",
"default":false,
"description":"Enables digest authentication for inbound SIP calls."
}
},
"title":"SipTrunkInboundAuthentication"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkInboundAuthenticationRequest":{
"type":"object",
"description":"Inbound authentication configuration for create requests.",
"properties":{
"headerValue":{
"type":"string",
"description":"Value of the Authorization header for inbound SIP calls. If not provided, it will be auto-generated."
},
"digestAuthenticationEnabled":{
"type":"boolean",
"default":false,
"description":"Enables digest authentication for inbound SIP calls."
}
},
"title":"SipTrunkInboundAuthenticationRequest"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkInboundAuthenticationWithCredentials":{
"type":"object",
"description":"Generated inbound authentication credentials.",
"properties":{
"headerValue":{
"type":"string",
"description":"Authorization header value used for authenticating inbound SIP requests."
},
"digestAuthenticationEnabled":{
"type":"boolean",
"description":"Indicates whether digest authentication is enabled for inbound SIP calls."
},
"digestUsername":{
"type":"string",
"description":"Username used for digest authentication."
},
"digestPassword":{
"type":"string",
"description":"Password used for digest authentication."
}
},
"title":"SipTrunkInboundAuthenticationWithCredentials"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkLocation":{
"type":"string",
"description":"SIP trunk location.",
"enum":[
"SAO_PAULO",
"BOGOTA",
"FRANKFURT",
"SWEDEN",
"JOHANNESBURG",
"NEW_YORK",
"PORTLAND",
"MOSCOW",
"SINGAPORE",
"ISTANBUL",
"KUALA_LUMPUR"
],
"title":"SipTrunkLocation"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkOutboundAuthentication":{
"type":"object",
"description":"Outbound authentication configuration.",
"properties":{
"fqdn":{
"type":"string",
"description":"Fully qualified domain name of the remote SIP endpoint for outbound calls."
}
},
"title":"SipTrunkOutboundAuthentication"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkOutboundAuthenticationWithCredentials":{
"type":"object",
"description":"Generated outbound authentication credentials.",
"properties":{
"fqdn":{
"type":"string",
"description":"Fully qualified domain name of the remote SIP endpoint for outbound calls."
},
"digestUsername":{
"type":"string",
"description":"Username used for outbound digest authentication."
},
"digestPassword":{
"type":"string",
"description":"Password used for outbound digest authentication."
}
},
"title":"SipTrunkOutboundAuthenticationWithCredentials"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkRegistrationStatus":{
"type":"string",
"description":"SIP trunk registration status.",
"enum":[
"REGISTERED",
"UNREGISTERED"
],
"title":"SipTrunkRegistrationStatus"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SpeechCaptureProperties":{
"type":"object",
"properties":{
"fullText":{
"type":"string"
},
"matchedKeyPhrase":{
"type":"string"
},
"confidence":{
"type":"number",
"format":"double"
},
"terminationReason":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.TerminationReason"
}
},
"title":"SpeechCaptureProperties"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SpeechCapturedEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SpeechCaptureProperties"
}
}
}
],
"title":"SpeechCapturedEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.StaticSipTrunkRequest":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/6423f137d264daaaab4ca521d6dfeb19cab29b6b25c3d2da0c1c3fb475a5e829.SipTrunkRequest"
},
{
"type":"object",
"properties":{
"tls":{
"type":"boolean",
"default":false,
"description":"Indicates whether communication is secured by the TLS protocol."
},
"codecs":{
"type":"array",
"description":"List of audio codecs supported by a SIP trunk.",
"items":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AudioCodec"
}
},
"dtmf":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DtmfType"
},
"fax":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.FaxType"
},
"numberFormat":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.NumberPresentationFormat"
},
"anonymization":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AnonymizationType"
},
"sourceHosts":{
"type":"array",
"description":"List of SIP trunk source hosts. If empty, destination host list must not be empty. Source hosts can be sent in 2 formats: IP address without port or domain without port.",
"items":{
"type":"string",
"description":"List of SIP trunk source hosts. If empty, destination host list must not be empty. Source hosts can be sent in 2 formats: IP address without port or domain without port."
}
},
"destinationHosts":{
"type":"array",
"description":"List of SIP trunk destination hosts. If empty, source host list must not be empty. Destination hosts can be sent in 3 formats: IP address with port, domain name with port or domain name without port. The port must fall in the range 1025-65535 or be 0 for SRV lookup.",
"items":{
"type":"string",
"description":"List of SIP trunk destination hosts. If empty, source host list must not be empty. Destination hosts can be sent in 3 formats: IP address with port, domain name with port or domain name without port. The port must fall in the range 1025-65535 or be 0 for SRV lookup."
}
},
"strategy":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SelectionStrategy"
},
"sipOptions":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipOptions"
}
}
}
],
"required":[
"billingPackage",
"channelLimit",
"name",
"type"
],
"title":"StaticSipTrunkRequest"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.StaticSipTrunkUpdateRequest":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/6423f137d264daaaab4ca521d6dfeb19cab29b6b25c3d2da0c1c3fb475a5e829.SipTrunkUpdateRequest"
},
{
"type":"object",
"properties":{
"sourceHosts":{
"type":"array",
"description":"List of SIP trunk source hosts. If empty, destination host list must not be empty. Source hosts can be sent in 2 formats: IP address without port or domain without port.",
"items":{
"type":"string",
"description":"List of SIP trunk source hosts. If empty, destination host list must not be empty. Source hosts can be sent in 2 formats: IP address without port or domain without port."
}
},
"destinationHosts":{
"type":"array",
"description":"List of SIP trunk destination hosts. If empty, source host list must not be empty. Destination hosts can be sent in 3 formats: IP address with port, domain name with port or domain name without port. The port must fall in the range 1025-65535 or be 0 for SRV lookup.",
"items":{
"type":"string",
"description":"List of SIP trunk destination hosts. If empty, source host list must not be empty. Destination hosts can be sent in 3 formats: IP address with port, domain name with port or domain name without port. The port must fall in the range 1025-65535 or be 0 for SRV lookup."
}
},
"strategy":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SelectionStrategy"
},
"codecs":{
"type":"array",
"description":"List of audio codecs supported by a SIP trunk.",
"items":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AudioCodec"
}
},
"dtmf":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DtmfType"
},
"fax":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.FaxType"
},
"anonymization":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AnonymizationType"
},
"numberFormat":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.NumberPresentationFormat"
},
"sipOptions":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipOptions"
}
}
}
],
"required":[
"name",
"type"
],
"title":"StaticSipTrunkUpdateRequest"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Status":{
"type":"string",
"description":"Current bulk status.",
"enum":[
"PENDING",
"PAUSED",
"PROCESSING",
"CANCELED",
"FINISHED",
"FAILED"
],
"example":"PENDING",
"title":"Status"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.TerminationReason":{
"type":"string",
"enum":[
"KEY_PHRASE",
"SILENCE",
"TIMEOUT",
"HANGUP"
],
"title":"TerminationReason"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.TimeUnit":{
"type":"string",
"description":"Defines a time unit used for calculating call creation rate.",
"enum":[
"SECONDS",
"MINUTES",
"HOURS",
"DAYS"
],
"title":"TimeUnit"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.TimeWindow":{
"type":"object",
"description":"Defines a scheduling object that allows setting up a detailed time window in which calls can be established. Consists of from, to and days properties. Days property is mandatory.",
"properties":{
"from":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.TimeWindowPoint"
},
"to":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.TimeWindowPoint"
},
"days":{
"type":"array",
"description":"Days when scheduling call establishment will be attempted.",
"items":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DayOfWeek"
}
}
},
"required":[
"days"
],
"title":"TimeWindow"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.TimeWindowPoint":{
"type":"object",
"description":"Call establishment attempt end time.",
"properties":{
"hour":{
"type":"integer",
"format":"int32"
},
"minute":{
"type":"integer",
"format":"int32"
}
},
"title":"TimeWindowPoint"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Transcription":{
"type":"object",
"properties":{
"language":{
"$ref":"#/components/schemas/61f95109c33ad36c729390593c474a655f9ca0e00403d6dbc107cf0f6c5cf04b.Language"
},
"sendInterimResults":{
"type":"boolean",
"default":false,
"description":"Flag indicating whether interim transcription results should be sent."
},
"customDictionary":{
"type":"array",
"description":"Array of custom words used for more accurate transcription.",
"items":{
"type":"string",
"description":"Array of custom words used for more accurate transcription."
}
},
"advancedFormatting":{
"type":"boolean",
"default":false,
"description":"Toggles enhanced text formatting features like punctuation, proper casing, numeral normalization, and disfluency filtering. Defaults to `false`."
},
"provider":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Provider"
}
},
"required":[
"language"
],
"title":"Transcription"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.TranscriptionEvent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
},
{
"type":"object",
"properties":{
"properties":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.TranscriptionProperties"
}
}
}
],
"title":"TranscriptionEvent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.TranscriptionProperties":{
"type":"object",
"properties":{
"results":{
"type":"array",
"items":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.TranscriptionResult"
}
}
},
"title":"TranscriptionProperties"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.TranscriptionResult":{
"type":"object",
"properties":{
"type":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ResultType"
},
"startTime":{
"type":"string",
"format":"date-time"
},
"endTime":{
"type":"string",
"format":"date-time"
},
"text":{
"type":"string"
},
"confidence":{
"type":"number",
"format":"double"
}
},
"title":"TranscriptionResult"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.TtyPlayContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicPlayContent"
},
{
"type":"object",
"properties":{
"text":{
"type":"string",
"description":"Text that will be played in Baudot tones."
}
}
}
],
"required":[
"text"
],
"title":"TtyPlayContent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.UrlPlayContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicPlayContent"
},
{
"type":"object",
"properties":{
"fileUrl":{
"type":"string",
"description":"URL of the audio file. Only `wav` and `mp3` files are supported."
}
}
}
],
"required":[
"fileUrl"
],
"title":"UrlPlayContent"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.UrlSecurityConfig":{
"type":"object",
"description":"Webhook security config.",
"discriminator":{
"propertyName":"type",
"mapping":{
"BASIC":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BasicUrlSecurityConfig",
"HMAC":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.HmacUrlSecurityConfig"
}
},
"properties":{
"type":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.UrlSecurityConfigType"
}
},
"title":"UrlSecurityConfig"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.UrlSecurityConfigType":{
"type":"string",
"enum":[
"BASIC",
"HMAC"
],
"title":"UrlSecurityConfigType"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ViberEndpoint":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallEndpoint"
},
{
"type":"object",
"properties":{
"phoneNumber":{
"type":"string",
"description":"Phone number in the [E.164](https://en.wikipedia.org/wiki/E.164) format."
}
}
}
],
"required":[
"phoneNumber"
],
"title":"ViberEndpoint"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.VideoMediaProperties":{
"type":"object",
"description":"Video media properties.",
"properties":{
"camera":{
"type":"boolean",
"description":"Indicates whether there is a video feed."
},
"screenShare":{
"type":"boolean",
"description":"Indicates whether the end user is sharing their screen."
},
"blind":{
"type":"boolean",
"description":"Indicates whether the end user can receive remote videos."
}
},
"title":"VideoMediaProperties"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.WebRtcEndpoint":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallEndpoint"
},
{
"type":"object",
"properties":{
"identity":{
"type":"string",
"description":"The identity used to present a user on the Infobip WebRTC platform. Must be unique."
},
"displayName":{
"type":"string",
"description":"A human-readable name for a given identity."
}
}
}
],
"required":[
"identity"
],
"title":"WebRtcEndpoint"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.WebsocketEndpoint":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallEndpoint"
},
{
"type":"object",
"properties":{
"websocketEndpointConfigId":{
"type":"string",
"description":"Websocket endpoint configuration ID."
},
"identifier":{
"type":"string",
"description":"Optional identifier for websocket calls."
}
}
}
],
"required":[
"websocketEndpointConfigId"
],
"title":"WebsocketEndpoint"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.WebsocketEndpointConfigRequest":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/58f57942de1c194257c321b1824e5d3941d9e9f538a9f08ddcb73e6025439f43.MediaStreamConfigRequest"
},
{
"type":"object",
"properties":{
"sampleRate":{
"type":"string",
"default":"8000",
"description":"Audio sampling rate.",
"enum":[
"8000",
"16000",
"24000",
"32000"
]
}
}
}
],
"required":[
"name",
"type",
"url"
],
"title":"WebsocketEndpointConfigRequest"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.WebsocketEndpointConfigResponse":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/655eaf80f7479f4a18447865649b33bdb754aaa97779726ffb72592cb1ac3ce5.MediaStreamConfigResponse"
},
{
"type":"object",
"properties":{
"sampleRate":{
"type":"string",
"default":"8000",
"description":"Audio sampling rate."
}
}
}
],
"title":"WebsocketEndpointConfigResponse"
},
"4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.WhatsAppEndpoint":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallEndpoint"
},
{
"type":"object",
"properties":{
"phoneNumber":{
"type":"string",
"description":"Phone number in the [E.164](https://en.wikipedia.org/wiki/E.164) format."
}
}
}
],
"required":[
"phoneNumber"
],
"title":"WhatsAppEndpoint"
},
"4811a3a9108d5f90b8934012403f954f20270c436bdecbc318a80214cf54fc02.ConferenceBroadcastWebrtcTextRequest":{
"type":"object",
"properties":{
"text":{
"type":"string",
"description":"Text to broadcast."
}
},
"title":"ConferenceBroadcastWebrtcTextRequest"
},
"4811a3a9108d5f90b8934012403f954f20270c436bdecbc318a80214cf54fc02.ConferencePlayRequest":{
"type":"object",
"properties":{
"loopCount":{
"type":"integer",
"format":"int32",
"description":"Number of times the file will be played."
},
"content":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicPlayContent"
}
},
"required":[
"content"
],
"title":"ConferencePlayRequest"
},
"4811a3a9108d5f90b8934012403f954f20270c436bdecbc318a80214cf54fc02.ConferenceRecordingRequest":{
"type":"object",
"properties":{
"recordingType":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingType"
},
"conferenceComposition":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ConferenceComposition"
},
"customData":{
"type":"object",
"additionalProperties":{
"type":"string"
},
"description":"Custom data."
},
"filePrefix":{
"type":"string",
"description":"Custom name for the recording's zip file. Applicable only when SFTP server is enabled on [Voice settings page](https://portal.infobip.com/apps/voice/recording/settings).\nUsing the same `filePrefix` will override the files on the SFTP server.\nFor recording without composition, `callId` and `fileId` will be appended to the `filePrefix` value."
}
},
"required":[
"recordingType"
],
"title":"ConferenceRecordingRequest"
},
"4811a3a9108d5f90b8934012403f954f20270c436bdecbc318a80214cf54fc02.ConferenceSayRequest":{
"type":"object",
"properties":{
"text":{
"type":"string",
"description":"Text to read."
},
"language":{
"type":"string",
"description":"Text language. Must be defined for correct pronunciation. More info about available languages and voices can be found [here](https://www.infobip.com/docs/voice-and-video/getting-started#text-to-speech-add-ons-and-options).",
"enum":[
"ar",
"ar-ma",
"ar_xa",
"bg",
"bn",
"bn-in",
"ca",
"cmn-cn",
"cs",
"da",
"de",
"de-at",
"de-ch",
"el",
"en",
"en-au",
"en-ca",
"en-gb",
"en-gb-wls",
"en-ie",
"en-in",
"en-ph",
"es",
"es-419",
"es-ar",
"es-co",
"es-mx",
"es-us",
"et-ee",
"fi",
"fil-ph",
"fr",
"fr-ca",
"fr-ch",
"gu",
"he",
"hi",
"hr",
"hu",
"id",
"is",
"it",
"ja",
"kk-kz",
"kn",
"ko",
"lt",
"lv",
"ml",
"mr-in",
"ms",
"nb-no",
"nl",
"nl-be",
"no",
"pa-in",
"pl",
"pt-br",
"pt-pt",
"ro",
"ru",
"sk",
"sl",
"sr-rs",
"sv",
"sw-ke",
"sw-tz",
"ta",
"te",
"th",
"tr",
"uk",
"ur-in",
"ur-pk",
"uz-uz",
"vi",
"wls",
"yue-hk",
"zh-cn",
"zh-tw"
]
},
"speechRate":{
"type":"number",
"format":"double",
"description":"Speech rate. Must be within `[0.5 - 2.0]` range, default value is `1`.",
"maximum":2,
"minimum":0.5
},
"loopCount":{
"type":"integer",
"format":"int32",
"description":"Number of times to read the text."
},
"preferences":{
"$ref":"#/components/schemas/08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.PublicVoicePreferences"
}
},
"required":[
"language",
"text"
],
"title":"ConferenceSayRequest"
},
"4811a3a9108d5f90b8934012403f954f20270c436bdecbc318a80214cf54fc02.ConferenceSendMessageRequest":{
"type":"object",
"properties":{
"message":{
"type":"string",
"description":"Message to send."
}
},
"required":[
"message"
],
"title":"ConferenceSendMessageRequest"
},
"49f1996e051117ce119ddfc3e07857856b24a0d3f7351242fd9c4615508a2845.VoicePreferences":{
"type":"object",
"description":"Voice preferences for text-to-speech.",
"properties":{
"voiceGender":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Gender"
},
"voice":{
"type":"string",
"description":"Voice name in which text would be synthesized. More info about available languages and voices can be found [here](https://www.infobip.com/docs/voice-and-video/reference#available-voices-by-language). Use value from Name column in the table.",
"example":"Joanna"
}
},
"title":"VoicePreferences"
},
"4b6d991c2661465a70fbabb20a534b0a2c34b3dc4776665474af60f3d1cc5273.ParticipantProperties":{
"type":"object",
"description":"Properties of the events that provide `Participant` object.",
"properties":{
"participant":{
"$ref":"#/components/schemas/c18e27d419b307552daa9403b0085ee796da1a5e57e2a4e6fb73f406471574fc.Participant"
}
},
"title":"ParticipantProperties"
},
"526c8fd5dbec2ed6659284b76850ff4085b7915f78d3266fedb5e0b5300d882a.MarkupLanguageConfigResponsePage":{
"type":"object",
"description":"Markup language configurations response object.",
"properties":{
"results":{
"type":"array",
"description":"The list of the results for this page.",
"items":{
"$ref":"#/components/schemas/eaaf11bb9830fc826a8597df01bea6f2a14ef6d1ed129a4f6623981d52827778.MarkupLanguageConfigResponse"
}
},
"paging":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.PageInfo"
}
},
"title":"MarkupLanguageConfigResponsePage"
},
"56fc13d85fd8c7d40ac0157103bb5ccebc0bb2862850603cc2c5a808276f4742.CredentialsBody":{
"type":"object",
"properties":{
"apiId":{
"type":"string",
"description":"The first part of the generate Authorization header.",
"pattern":"[a-zA-Z0-9-]+"
},
"key":{
"type":"string",
"description":"Used to generate the second part of the Authorization header.",
"pattern":"[a-zA-Z0-9-]+"
}
},
"required":[
"apiId",
"key"
],
"title":"CredentialsBody"
},
"56fc13d85fd8c7d40ac0157103bb5ccebc0bb2862850603cc2c5a808276f4742.CredentialsResponse":{
"type":"object",
"properties":{
"apiId":{
"type":"string",
"description":"The first part of the generate Authorization header."
},
"key":{
"type":"string",
"description":"Used to generate the second part of the Authorization header."
}
},
"title":"CredentialsResponse"
},
"58f57942de1c194257c321b1824e5d3941d9e9f538a9f08ddcb73e6025439f43.MediaStreamConfigRequest":{
"type":"object",
"discriminator":{
"propertyName":"type",
"mapping":{
"MEDIA_STREAMING":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MediaStreamingConfigRequest",
"WEBSOCKET_ENDPOINT":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.WebsocketEndpointConfigRequest"
}
},
"properties":{
"type":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RequestMediaStreamConfigType"
},
"name":{
"type":"string",
"description":"Media-stream configuration name.",
"maxLength":128,
"minLength":0
},
"url":{
"type":"string",
"description":"Destination websocket or load balancer URL."
}
},
"required":[
"name",
"type",
"url"
],
"title":"MediaStreamConfigRequest"
},
"59ad711434aad6c39708ffc0bab084b409f8c1de0ab1fd0cfa66aa965f740ee4.CallbackRequest":{
"type":"object",
"description":"Callback request.",
"properties":{
"from":{
"type":"string",
"description":"Caller phone number."
},
"to":{
"type":"string",
"description":"Called phone number."
},
"correlationId":{
"type":"string",
"description":"Unique identifier of the call record, available for both Callback and Status requests."
},
"nmCorrelationId":{
"type":"string",
"description":"Unique identifier for correlation with inbound call, available in Callback and Status requests."
},
"dtmfCaptured":{
"type":"boolean",
"description":"Indicates that this callback request is initiated after the `captureDtmf` command is executed. Not present in the first callback request for the call."
}
},
"title":"CallbackRequest"
},
"5cb8669321a9b28a95445a23a292423b19c28f831eda62032aef9c6b53da7813.RouteResponsePage":{
"type":"object",
"description":"Routes response object.",
"properties":{
"results":{
"type":"array",
"description":"The list of the results for this page.",
"items":{
"$ref":"#/components/schemas/1e938b22275568ebc747d21724b50c9be18ff5770eb33c37b76fda4633c14bde.RouteResponse"
}
},
"paging":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.PageInfo"
}
},
"title":"RouteResponsePage"
},
"5cec81334b90b810e64e8923d2a0d906614be46012f19935bf49fd13e921d8b2.PublicCountry":{
"type":"object",
"description":"SIP trunk service address country.",
"properties":{
"name":{
"type":"string",
"description":"Name of the country where SIP trunk is located."
},
"code":{
"type":"string",
"description":"Code of the country where SIP trunk is located."
}
},
"title":"PublicCountry"
},
"5cec81334b90b810e64e8923d2a0d906614be46012f19935bf49fd13e921d8b2.PublicRegion":{
"type":"object",
"description":"SIP trunk service address region.",
"properties":{
"name":{
"type":"string",
"description":"Name of the region from the country where SIP trunk is located."
},
"code":{
"type":"string",
"description":"Code of the region from the country where SIP trunk is located."
},
"countryCode":{
"type":"string",
"description":"Code of the country where SIP trunk is located."
}
},
"title":"PublicRegion"
},
"5cec81334b90b810e64e8923d2a0d906614be46012f19935bf49fd13e921d8b2.PublicSipTrunkServiceAddress":{
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"SIP trunk service address ID."
},
"name":{
"type":"string",
"description":"SIP trunk service address name."
},
"street":{
"type":"string",
"description":"SIP trunk service address street."
},
"city":{
"type":"string",
"description":"SIP trunk service address city."
},
"postCode":{
"type":"string",
"description":"SIP trunk service address post code."
},
"suite":{
"type":"string",
"description":"SIP trunk service address suite."
},
"country":{
"$ref":"#/components/schemas/5cec81334b90b810e64e8923d2a0d906614be46012f19935bf49fd13e921d8b2.PublicCountry"
},
"region":{
"$ref":"#/components/schemas/5cec81334b90b810e64e8923d2a0d906614be46012f19935bf49fd13e921d8b2.PublicRegion"
}
},
"title":"PublicSipTrunkServiceAddress"
},
"5cec81334b90b810e64e8923d2a0d906614be46012f19935bf49fd13e921d8b2.PublicSipTrunkServiceAddressRequest":{
"type":"object",
"description":"SIP trunk service address request.",
"properties":{
"name":{
"type":"string",
"description":"SIP trunk service address name."
},
"street":{
"type":"string",
"description":"SIP trunk service address street."
},
"city":{
"type":"string",
"description":"SIP trunk service address city."
},
"postCode":{
"type":"string",
"description":"SIP trunk service address post code."
},
"suite":{
"type":"string",
"description":"SIP trunk service address suite."
},
"countryCode":{
"type":"string",
"description":"SIP trunk service address [country code](#get-countries)."
},
"countryRegionCode":{
"type":"string",
"description":"SIP trunk service address [country region code](#get-regions). Mandatory for countries that have defined regions."
}
},
"required":[
"city",
"countryCode",
"name",
"postCode",
"street"
],
"title":"PublicSipTrunkServiceAddressRequest"
},
"5fc49137a7b003ca1d8c4957601417b8ed884356b7fbc49afe416dd5c098a0bd.DialogCallRequest":{
"type":"object",
"properties":{
"endpoint":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallEndpoint"
},
"from":{
"type":"string",
"description":"Caller identifier. Must be a number in the [E.164](https://en.wikipedia.org/wiki/E.164) format for calls to `PHONE`, a string for calls to `WEBRTC` or `SIP`, and a Viber Voice number for calls to `VIBER`. Field is mandatory for `VIBER` endpoint and calls to emergency numbers."
},
"fromDisplayName":{
"type":"string",
"description":"Display name to show when placing calls towards WEBRTC endpoints. Can be any alphanumeric string."
},
"connectTimeout":{
"type":"integer",
"format":"int32",
"description":"Time to wait, in seconds, before the called party answers the call.",
"maximum":60
},
"machineDetection":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MachineDetectionRequest"
},
"customData":{
"type":"object",
"additionalProperties":{
"type":"string"
},
"description":"Custom data is used for storing call-specific data defined by the client."
}
},
"title":"DialogCallRequest"
},
"5fc49137a7b003ca1d8c4957601417b8ed884356b7fbc49afe416dd5c098a0bd.DialogLogResponse":{
"type":"object",
"properties":{
"dialogId":{
"type":"string",
"description":"Unique dialog ID.",
"example":"034e622a-cc7e-456d-8a10-0ba43b11aa5e",
"maxLength":128
},
"callsConfigurationId":{
"type":"string",
"description":"Calls Configuration ID.",
"example":"dc5942707c704551a00cd2ea"
},
"platform":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Platform"
},
"state":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicDialogState"
},
"startTime":{
"type":"string",
"format":"date-time",
"description":"Date and time for when the dialog has been created."
},
"establishTime":{
"type":"string",
"format":"date-time",
"description":"Date and time for when the dialog has been established."
},
"endTime":{
"type":"string",
"format":"date-time",
"description":"Date and time for when the dialog has been finished."
},
"parentCallId":{
"type":"string",
"description":"Unique parent call ID.",
"example":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"maxLength":128
},
"childCallId":{
"type":"string",
"description":"Unique child call ID.",
"example":"ae024ad1-52e7-45d5-a5d2-cd7c809e03f8",
"maxLength":128
},
"duration":{
"type":"integer",
"format":"int64",
"description":"Dialog duration in seconds.",
"example":5
},
"recording":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogRecordingLog"
},
"errorCode":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ErrorCodeInfo"
},
"hangupSource":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogHangupSource"
}
},
"title":"DialogLogResponse"
},
"5fc49137a7b003ca1d8c4957601417b8ed884356b7fbc49afe416dd5c098a0bd.DialogPropagationOptions":{
"type":"object",
"properties":{
"childCallHangup":{
"type":"boolean",
"default":true,
"description":"Flag indicating if the parent call should be terminated when the child call ends."
},
"childCallRinging":{
"type":"boolean",
"default":false,
"description":"Flag indicating if a child call's ringing should be propagated to the parent call. The parent call must be `INBOUND`. Cannot be `true` when `ringbackGeneration` is enabled."
},
"ringbackGeneration":{
"$ref":"#/components/schemas/f9f4d06aa76c139ea87428e14c99b11f79a0ab9b330e26afc80d0c5a5ff1acbb.RingbackGeneration"
}
},
"title":"DialogPropagationOptions"
},
"5fc49137a7b003ca1d8c4957601417b8ed884356b7fbc49afe416dd5c098a0bd.DialogRequest":{
"type":"object",
"properties":{
"parentCallId":{
"type":"string",
"description":"Unique parent call ID.",
"maxLength":128
},
"childCallRequest":{
"$ref":"#/components/schemas/5fc49137a7b003ca1d8c4957601417b8ed884356b7fbc49afe416dd5c098a0bd.DialogCallRequest"
},
"recording":{
"$ref":"#/components/schemas/14b5f31f4f292db4a32c4e61928f9a47f8ff4c0a1c06a38af2c29ef9ca05095d.DialogRecordingRequest"
},
"maxDuration":{
"type":"integer",
"format":"int32",
"default":28800,
"description":"Max duration in seconds."
},
"propagationOptions":{
"$ref":"#/components/schemas/5fc49137a7b003ca1d8c4957601417b8ed884356b7fbc49afe416dd5c098a0bd.DialogPropagationOptions"
}
},
"required":[
"parentCallId"
],
"title":"DialogRequest"
},
"5fc49137a7b003ca1d8c4957601417b8ed884356b7fbc49afe416dd5c098a0bd.DialogResponse":{
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"Unique dialog ID.",
"example":"034e622a-cc7e-456d-8a10-0ba43b11aa5e",
"maxLength":128
},
"callsConfigurationId":{
"type":"string",
"description":"Calls Configuration ID.",
"example":"dc5942707c704551a00cd2ea"
},
"platform":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Platform"
},
"state":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicDialogState"
},
"startTime":{
"type":"string",
"format":"date-time",
"description":"Date and time for when the dialog has been created."
},
"establishTime":{
"type":"string",
"format":"date-time",
"description":"Date and time for when the dialog has been established."
},
"endTime":{
"type":"string",
"format":"date-time",
"description":"Date and time for when the dialog has been finished."
},
"parentCall":{
"$ref":"#/components/schemas/431fb79b0e816230968e14ba1e1c6fadb75cfde9cb3c381f4217b2777f48153f.Call"
},
"childCall":{
"$ref":"#/components/schemas/431fb79b0e816230968e14ba1e1c6fadb75cfde9cb3c381f4217b2777f48153f.Call"
}
},
"title":"DialogResponse"
},
"5fc49137a7b003ca1d8c4957601417b8ed884356b7fbc49afe416dd5c098a0bd.DialogWithExistingCallsRequest":{
"type":"object",
"properties":{
"recording":{
"$ref":"#/components/schemas/14b5f31f4f292db4a32c4e61928f9a47f8ff4c0a1c06a38af2c29ef9ca05095d.DialogRecordingRequest"
},
"maxDuration":{
"type":"integer",
"format":"int32",
"default":28800,
"description":"Max duration in seconds."
},
"propagationOptions":{
"$ref":"#/components/schemas/5fc49137a7b003ca1d8c4957601417b8ed884356b7fbc49afe416dd5c098a0bd.DialogPropagationOptions"
}
},
"title":"DialogWithExistingCallsRequest"
},
"60d0e6d5cbcf8382b5a6bad1f38781f71991c7ea63dad2e6ec22ddc8893af51c.CaptureDtmfCallbackRequest":{
"type":"object",
"description":"Markup Language captureDtmf callback request object. Sent to the callback URL configured on the CaptureDtmf instruction after the caller has finished entering DTMF digits (or the timeout expired). Extends the instructions callback payload with the collected DTMF sequence.",
"properties":{
"callId":{
"type":"string",
"description":"Unique identifier of the call.",
"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"from":{
"type":"string",
"description":"The phone number of the caller in the [E.164](https://en.wikipedia.org/wiki/E.164) format.",
"example":"41793026834"
},
"to":{
"type":"string",
"description":"The phone number of the callee in the [E.164](https://en.wikipedia.org/wiki/E.164) format.",
"example":"41793026835"
},
"direction":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallDirection"
},
"endpoint":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackEndpoint"
},
"startTime":{
"type":"string",
"format":"date-time",
"description":"The timestamp when the call started, in ISO-8601 UTC format (yyyy-MM-dd'T'HH:mm:ss.SSSZ).",
"example":"2025-04-04T11:38:01.724Z"
},
"capturedDtmf":{
"type":"string",
"description":"DTMF digits collected from the caller. Empty when the timeout elapsed with no input and callOnEmpty is enabled.",
"example":"1234"
}
},
"title":"CaptureDtmfCallbackRequest"
},
"60d0e6d5cbcf8382b5a6bad1f38781f71991c7ea63dad2e6ec22ddc8893af51c.DialCallbackRequest":{
"type":"object",
"description":"Markup Language dial callback request object. Sent to the callback URL configured on the Dial instruction once the dial endpoint has been processed. Extends the instructions callback payload with the dial endpoint result.",
"properties":{
"callId":{
"type":"string",
"description":"Unique identifier of the call.",
"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"from":{
"type":"string",
"description":"The phone number of the caller in the [E.164](https://en.wikipedia.org/wiki/E.164) format.",
"example":"41793026834"
},
"to":{
"type":"string",
"description":"The phone number of the callee in the [E.164](https://en.wikipedia.org/wiki/E.164) format.",
"example":"41793026835"
},
"direction":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallDirection"
},
"endpoint":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackEndpoint"
},
"startTime":{
"type":"string",
"format":"date-time",
"description":"The timestamp when the call started, in ISO-8601 UTC format (yyyy-MM-dd'T'HH:mm:ss.SSSZ).",
"example":"2025-04-04T11:38:01.724Z"
},
"dialData":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.DialData"
}
},
"title":"DialCallbackRequest"
},
"60d0e6d5cbcf8382b5a6bad1f38781f71991c7ea63dad2e6ec22ddc8893af51c.ErrorCallbackRequest":{
"type":"object",
"description":"Markup Language error callback request object. Sent to the configured errorUrl when the platform fails to retrieve or execute a Markup Language script. Extends the instructions callback payload with the error code and details describing the failure.",
"properties":{
"callId":{
"type":"string",
"description":"Unique identifier of the call.",
"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"from":{
"type":"string",
"description":"The phone number of the caller in the [E.164](https://en.wikipedia.org/wiki/E.164) format.",
"example":"41793026834"
},
"to":{
"type":"string",
"description":"The phone number of the callee in the [E.164](https://en.wikipedia.org/wiki/E.164) format.",
"example":"41793026835"
},
"direction":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallDirection"
},
"endpoint":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackEndpoint"
},
"startTime":{
"type":"string",
"format":"date-time",
"description":"The timestamp when the call started, in ISO-8601 UTC format (yyyy-MM-dd'T'HH:mm:ss.SSSZ).",
"example":"2025-04-04T11:38:01.724Z"
},
"errorCode":{
"type":"string",
"description":"Error category code.",
"example":"HTTP_ERROR"
},
"errorDetails":{
"type":"string",
"description":"Detailed error message.",
"example":"Error while reaching https://{yourDomain}/your/webhook/path"
}
},
"title":"ErrorCallbackRequest"
},
"60d0e6d5cbcf8382b5a6bad1f38781f71991c7ea63dad2e6ec22ddc8893af51c.MachineDetectionCallbackRequest":{
"type":"object",
"description":"Markup Language machine detection callback request object. Sent to the callback URL configured on the Markup Language configuration (markupUrl) once machine detection has completed. Extends the instructions callback payload with the machine detection result and confidence ratings.",
"properties":{
"callId":{
"type":"string",
"description":"Unique identifier of the call.",
"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"from":{
"type":"string",
"description":"The phone number of the caller in the [E.164](https://en.wikipedia.org/wiki/E.164) format.",
"example":"41793026834"
},
"to":{
"type":"string",
"description":"The phone number of the callee in the [E.164](https://en.wikipedia.org/wiki/E.164) format.",
"example":"41793026835"
},
"direction":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallDirection"
},
"endpoint":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackEndpoint"
},
"startTime":{
"type":"string",
"format":"date-time",
"description":"The timestamp when the call started, in ISO-8601 UTC format (yyyy-MM-dd'T'HH:mm:ss.SSSZ).",
"example":"2025-04-04T11:38:01.724Z"
},
"machineDetectionResult":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.AmdStatus"
},
"confidenceRating":{
"type":"object",
"additionalProperties":{
"type":"number",
"format":"double"
},
"description":"Confidence rating for the machine detection result.",
"example":{
"HUMAN":0.92,
"MACHINE":0.08
}
}
},
"title":"MachineDetectionCallbackRequest"
},
"60d0e6d5cbcf8382b5a6bad1f38781f71991c7ea63dad2e6ec22ddc8893af51c.MachineMessageDetectionCallbackRequest":{
"type":"object",
"description":"Markup Language machine message detection callback request object. Sent to the callback URL configured on the Markup Language configuration (markupUrl) once machine message detection has completed. Extends the instructions callback payload with the machine detection result.",
"properties":{
"callId":{
"type":"string",
"description":"Unique identifier of the call.",
"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"from":{
"type":"string",
"description":"The phone number of the caller in the [E.164](https://en.wikipedia.org/wiki/E.164) format.",
"example":"41793026834"
},
"to":{
"type":"string",
"description":"The phone number of the callee in the [E.164](https://en.wikipedia.org/wiki/E.164) format.",
"example":"41793026835"
},
"direction":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallDirection"
},
"endpoint":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackEndpoint"
},
"startTime":{
"type":"string",
"format":"date-time",
"description":"The timestamp when the call started, in ISO-8601 UTC format (yyyy-MM-dd'T'HH:mm:ss.SSSZ).",
"example":"2025-04-04T11:38:01.724Z"
},
"machineDetectionResult":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.AmdStatus"
}
},
"title":"MachineMessageDetectionCallbackRequest"
},
"60d0e6d5cbcf8382b5a6bad1f38781f71991c7ea63dad2e6ec22ddc8893af51c.RecordCallbackRequest":{
"type":"object",
"description":"Markup Language record callback request object. Sent to the callback URL configured on the Record instruction when a recording is started, stopped, or fully processed. Extends the instructions callback payload with the recorded file identifier and the current recording status.",
"properties":{
"callId":{
"type":"string",
"description":"Unique identifier of the call.",
"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"from":{
"type":"string",
"description":"The phone number of the caller in the [E.164](https://en.wikipedia.org/wiki/E.164) format.",
"example":"41793026834"
},
"to":{
"type":"string",
"description":"The phone number of the callee in the [E.164](https://en.wikipedia.org/wiki/E.164) format.",
"example":"41793026835"
},
"direction":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallDirection"
},
"endpoint":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackEndpoint"
},
"startTime":{
"type":"string",
"format":"date-time",
"description":"The timestamp when the call started, in ISO-8601 UTC format (yyyy-MM-dd'T'HH:mm:ss.SSSZ).",
"example":"2025-04-04T11:38:01.724Z"
},
"recordingFileId":{
"type":"string",
"description":"Identifier of the recorded audio file.",
"example":"b83f049e-6b2a-4111-bbeb-32426fe0a737"
},
"recordingStatus":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RecordingStatusEvent"
}
},
"title":"RecordCallbackRequest"
},
"60d0e6d5cbcf8382b5a6bad1f38781f71991c7ea63dad2e6ec22ddc8893af51c.RecordingStatusCallbackRequest":{
"type":"object",
"description":"Markup Language recording status callback request object. Sent to the callback URL configured on the Record or StartRecording instruction once the recording has been fully processed. Extends the instructions callback payload with the recorded file identifier and the final recording status.",
"properties":{
"callId":{
"type":"string",
"description":"Unique identifier of the call.",
"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"from":{
"type":"string",
"description":"The phone number of the caller in the [E.164](https://en.wikipedia.org/wiki/E.164) format.",
"example":"41793026834"
},
"to":{
"type":"string",
"description":"The phone number of the callee in the [E.164](https://en.wikipedia.org/wiki/E.164) format.",
"example":"41793026835"
},
"direction":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallDirection"
},
"endpoint":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackEndpoint"
},
"startTime":{
"type":"string",
"format":"date-time",
"description":"The timestamp when the call started, in ISO-8601 UTC format (yyyy-MM-dd'T'HH:mm:ss.SSSZ).",
"example":"2025-04-04T11:38:01.724Z"
},
"recordingFileId":{
"type":"string",
"description":"The unique identifier of the recording file.",
"example":"b83f049e-6b2a-4111-bbeb-32426fe0a737"
},
"recordingStatus":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RecordingStatusEvent"
}
},
"title":"RecordingStatusCallbackRequest"
},
"60d0e6d5cbcf8382b5a6bad1f38781f71991c7ea63dad2e6ec22ddc8893af51c.WebhookCallbackRequest":{
"type":"object",
"description":"Markup language callback request object.",
"properties":{
"callId":{
"type":"string",
"description":"Unique identifier of the call.",
"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"from":{
"type":"string",
"description":"The phone number of the caller in the [E.164](https://en.wikipedia.org/wiki/E.164) format.",
"example":"41793026834"
},
"to":{
"type":"string",
"description":"The phone number of the callee in the [E.164](https://en.wikipedia.org/wiki/E.164) format.",
"example":"41793026835"
},
"direction":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallDirection"
},
"endpoint":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackEndpoint"
},
"startTime":{
"type":"string",
"format":"date-time",
"description":"The timestamp when the call started, in ISO-8601 UTC format (yyyy-MM-dd'T'HH:mm:ss.SSSZ).",
"example":"2025-04-04T11:38:01.724Z"
}
},
"title":"WebhookCallbackRequest"
},
"61f95109c33ad36c729390593c474a655f9ca0e00403d6dbc107cf0f6c5cf04b.Language":{
"type":"string",
"enum":[
"af-ZA",
"sq-AL",
"am-ET",
"ar-KW",
"ar-AE",
"ar-BH",
"ar-DZ",
"ar-EG",
"ar-IL",
"ar-IQ",
"ar-JO",
"ar-LB",
"ar-LY",
"ar-MA",
"ar-OM",
"ar-PS",
"ar-QA",
"ar-SA",
"ar-SY",
"ar-TN",
"ar-YE",
"hy-AM",
"az-AZ",
"eu-ES",
"bn-IN",
"bn-BD",
"bs-BA",
"bg-BG",
"my-MM",
"ca-ES",
"zh-CN",
"zh-HK",
"zh-TW",
"hr-HR",
"cs-CZ",
"da-DK",
"nl-NL",
"nl-BE",
"en-AU",
"en-CA",
"en-GB",
"en-GH",
"en-HK",
"en-IE",
"en-IN",
"en-KE",
"en-NG",
"en-NZ",
"en-PH",
"en-PK",
"en-SG",
"en-TZ",
"en-US",
"en-ZA",
"et-EE",
"fil-PH",
"fi-FI",
"fr-BE",
"fr-CA",
"fr-CH",
"fr-FR",
"gl-ES",
"ka-GE",
"de-AT",
"de-CH",
"de-DE",
"el-GR",
"gu-IN",
"he-IL",
"hi-IN",
"hu-HU",
"is-IS",
"id-ID",
"ga-IE",
"it-CH",
"it-IT",
"ja-JP",
"jv-ID",
"kn-IN",
"kk-KZ",
"km-KH",
"ko-KR",
"lo-LA",
"lv-LV",
"lt-LT",
"mk-MK",
"ms-MY",
"ml-IN",
"mt-MT",
"mr-IN",
"mn-MN",
"ne-NP",
"no-NO",
"fa-IR",
"pl-PL",
"pt-PT",
"pt-BR",
"pa-Guru-IN",
"ro-RO",
"ru-RU",
"sr-RS",
"si-LK",
"sk-SK",
"sl-SI",
"es-BO",
"es-AR",
"es-CL",
"es-CO",
"es-CR",
"es-CU",
"es-DO",
"es-EC",
"es-ES",
"es-GQ",
"es-GT",
"es-HN",
"es-MX",
"es-NI",
"es-PA",
"es-PE",
"es-PR",
"es-PY",
"es-SV",
"es-US",
"es-UY",
"es-VE",
"su-ID",
"sw-TZ",
"sw-KE",
"sv-SE",
"ta-IN",
"ta-LK",
"ta-MY",
"ta-SG",
"te-IN",
"th-TH",
"tr-TR",
"uk-UA",
"ur-IN",
"ur-PK",
"uz-UZ",
"vi-VN",
"zu-ZA"
],
"title":"Language"
},
"6423f137d264daaaab4ca521d6dfeb19cab29b6b25c3d2da0c1c3fb475a5e829.SipTrunkRequest":{
"type":"object",
"discriminator":{
"propertyName":"type",
"mapping":{
"STATIC":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.StaticSipTrunkRequest",
"REGISTERED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RegisteredSipTrunkRequest",
"PROVIDER":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ProviderSipTrunkRequest",
"AUTHENTICATED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AuthenticatedSipTrunkRequest"
}
},
"properties":{
"type":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PegasusSipTrunkType"
},
"name":{
"type":"string",
"description":"SIP trunk name.",
"maxLength":128,
"minLength":0
},
"location":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkLocation"
},
"internationalCallsAllowed":{
"type":"boolean",
"default":false,
"description":"Indicates whether international calls should be allowed. Calls between different countries are considered international."
},
"channelLimit":{
"type":"integer",
"format":"int32",
"description":"Maximum number of concurrent channels.",
"maximum":1000
},
"billingPackage":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BillingPackage"
}
},
"required":[
"billingPackage",
"channelLimit",
"name"
],
"title":"SipTrunkRequest"
},
"6423f137d264daaaab4ca521d6dfeb19cab29b6b25c3d2da0c1c3fb475a5e829.SipTrunkStatusRequest":{
"type":"object",
"description":"SIP trunk status request.",
"properties":{
"adminStatus":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkAdminStatus"
}
},
"required":[
"adminStatus"
],
"title":"SipTrunkStatusRequest"
},
"6423f137d264daaaab4ca521d6dfeb19cab29b6b25c3d2da0c1c3fb475a5e829.SipTrunkUpdateRequest":{
"type":"object",
"discriminator":{
"propertyName":"type",
"mapping":{
"STATIC":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.StaticSipTrunkUpdateRequest",
"REGISTERED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RegisteredSipTrunkUpdateRequest",
"PROVIDER":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ProviderSipTrunkUpdateRequest",
"AUTHENTICATED":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AuthenticatedSipTrunkUpdateRequest"
}
},
"properties":{
"type":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PegasusSipTrunkType"
},
"name":{
"type":"string",
"description":"SIP trunk name."
},
"internationalCallsAllowed":{
"type":"boolean",
"default":false,
"description":"Indicates whether international calls should be allowed. Calls between different countries are considered international."
},
"channelLimit":{
"type":"integer",
"format":"int32",
"description":"Maximum number of concurrent channels.",
"maximum":1000
}
},
"required":[
"name"
],
"title":"SipTrunkUpdateRequest"
},
"655eaf80f7479f4a18447865649b33bdb754aaa97779726ffb72592cb1ac3ce5.MediaStreamConfigResponse":{
"type":"object",
"discriminator":{
"propertyName":"type",
"mapping":{
"MEDIA_STREAMING":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MediaStreamingConfigResponse",
"WEBSOCKET_ENDPOINT":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.WebsocketEndpointConfigResponse"
}
},
"properties":{
"id":{
"type":"string",
"description":"Media-stream configuration ID."
},
"type":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ResponseMediaStreamConfigType"
},
"name":{
"type":"string",
"description":"Media-stream configuration name."
},
"url":{
"type":"string",
"description":"Destination websocket or load balancer URL."
}
},
"title":"MediaStreamConfigResponse"
},
"6665694460cb56ab854a173ada36805c85c7ec55584901d2f06225baf9b586cb.CallRecordingRequest":{
"type":"object",
"properties":{
"recordingType":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingType"
},
"customData":{
"type":"object",
"additionalProperties":{
"type":"string"
},
"description":"Custom data."
},
"filePrefix":{
"type":"string",
"description":"Custom name for the recording's zip file. Applicable only when SFTP server is enabled on [Voice settings page](https://portal.infobip.com/apps/voice/recording/settings).\nUsing the same `filePrefix` will override the files on the SFTP server."
},
"channels":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingChannels"
}
},
"required":[
"recordingType"
],
"title":"CallRecordingRequest"
},
"6665694460cb56ab854a173ada36805c85c7ec55584901d2f06225baf9b586cb.CallSendMessageRequest":{
"type":"object",
"properties":{
"message":{
"type":"string",
"description":"Message to send."
}
},
"required":[
"message"
],
"title":"CallSendMessageRequest"
},
"6665694460cb56ab854a173ada36805c85c7ec55584901d2f06225baf9b586cb.PublicPlayRequest":{
"type":"object",
"description":"Call play request.",
"properties":{
"loopCount":{
"type":"integer",
"format":"int32",
"description":"Number of times the file will be played."
},
"timeout":{
"type":"integer",
"format":"int64",
"description":"The duration, in milliseconds, of the file to be played. If timeout is not defined, the file will be played until it ends."
},
"offset":{
"type":"integer",
"format":"int64",
"description":"The starting point, in milliseconds, from which the file will be played. If offset is not defined, the file will be played from its beginning."
},
"content":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicPlayContent"
},
"stopOn":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicTermination"
},
"customData":{
"type":"object",
"additionalProperties":{
"type":"string"
},
"description":"Optional parameter to update a call's custom data."
}
},
"required":[
"content"
],
"title":"PublicPlayRequest"
},
"6665694460cb56ab854a173ada36805c85c7ec55584901d2f06225baf9b586cb.PublicPreAnswerRequest":{
"type":"object",
"properties":{
"ringing":{
"type":"boolean",
"default":false,
"description":"Indicates whether to play a ringing sound on the call after pre-answering it."
},
"customData":{
"type":"object",
"additionalProperties":{
"type":"string"
},
"description":"Optional parameter to update a call's custom data."
}
},
"title":"PublicPreAnswerRequest"
},
"6665694460cb56ab854a173ada36805c85c7ec55584901d2f06225baf9b586cb.PublicStopPlayRequest":{
"type":"object",
"properties":{
"customData":{
"type":"object",
"additionalProperties":{
"type":"string"
},
"description":"Optional parameter to update a call's custom data."
}
},
"title":"PublicStopPlayRequest"
},
"6ee61eb40f9e4619d309dfe8df9b479488b43bcde7df95f6a044b2e14abf591e.CallRecording":{
"type":"object",
"description":"Call recording metadata.",
"properties":{
"callId":{
"type":"string",
"description":"Call identifier."
},
"endpoint":{
"type":"string",
"description":"Call endpoint. Represents a caller for the inbound calls and a callee for the outbound calls."
},
"direction":{
"type":"string",
"description":"Call direction.",
"enum":[
"INBOUND",
"OUTBOUND"
]
},
"status":{
"type":"string",
"description":"Status of call recording."
},
"reason":{
"type":"string",
"description":"Reason for recording failure."
},
"files":{
"type":"array",
"description":"Recording files.",
"items":{
"$ref":"#/components/schemas/6ee61eb40f9e4619d309dfe8df9b479488b43bcde7df95f6a044b2e14abf591e.RecordedFile"
}
}
},
"title":"CallRecording"
},
"6ee61eb40f9e4619d309dfe8df9b479488b43bcde7df95f6a044b2e14abf591e.RecordedFile":{
"type":"object",
"description":"Recorded file.",
"properties":{
"id":{
"type":"string",
"description":"File ID."
},
"name":{
"type":"string",
"description":"File name."
},
"fileFormat":{
"type":"string",
"description":"File format.",
"enum":[
"MP3",
"WAV",
"MP4"
]
},
"size":{
"type":"integer",
"format":"int64",
"description":"File size in bytes."
},
"startTime":{
"type":"string",
"format":"date-time",
"description":"Date and time when the recording started."
},
"endTime":{
"type":"string",
"format":"date-time",
"description":"Date and time when the recording ended."
},
"creationTime":{
"type":"string",
"format":"date-time",
"description":"File creation time."
},
"duration":{
"type":"integer",
"format":"int64",
"description":"File duration in seconds."
},
"location":{
"type":"string",
"description":"Location of recording file after processing.",
"enum":[
"UPLOADING",
"UPLOADED",
"HOSTED"
]
},
"customData":{
"type":"object",
"additionalProperties":{
"type":"string"
},
"description":"Client-defined data."
}
},
"title":"RecordedFile"
},
"6ee61eb40f9e4619d309dfe8df9b479488b43bcde7df95f6a044b2e14abf591e.RecordingApiResponse":{
"type":"object",
"description":"Recording API response.",
"properties":{
"application":{
"$ref":"#/components/schemas/6ee61eb40f9e4619d309dfe8df9b479488b43bcde7df95f6a044b2e14abf591e.RecordingApplication"
},
"recording":{
"$ref":"#/components/schemas/6ee61eb40f9e4619d309dfe8df9b479488b43bcde7df95f6a044b2e14abf591e.RecordingMetadata"
}
},
"required":[
"application",
"recording"
],
"title":"RecordingApiResponse"
},
"6ee61eb40f9e4619d309dfe8df9b479488b43bcde7df95f6a044b2e14abf591e.RecordingApplication":{
"type":"object",
"description":"Recording application metadata",
"discriminator":{
"propertyName":"type",
"mapping":{
"CALL_ROUTING":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallRoutingApplication"
}
},
"properties":{
"type":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.ApplicationType"
}
},
"required":[
"type"
],
"title":"RecordingApplication"
},
"6ee61eb40f9e4619d309dfe8df9b479488b43bcde7df95f6a044b2e14abf591e.RecordingMetadata":{
"type":"object",
"description":"Recording metadata",
"properties":{
"composedFiles":{
"type":"array",
"description":"Composed recording files.",
"items":{
"$ref":"#/components/schemas/6ee61eb40f9e4619d309dfe8df9b479488b43bcde7df95f6a044b2e14abf591e.RecordedFile"
}
},
"callRecordings":{
"type":"array",
"description":"Call recording data.",
"items":{
"$ref":"#/components/schemas/6ee61eb40f9e4619d309dfe8df9b479488b43bcde7df95f6a044b2e14abf591e.CallRecording"
}
}
},
"title":"RecordingMetadata"
},
"707907921d4508c2925eddc2449f10db322ecc083be424f87c50fe97ccd8be40.ActionConferenceRequest":{
"type":"object",
"properties":{
"name":{
"type":"string",
"description":"Conference name, will be auto-generated if not provided."
},
"recording":{
"$ref":"#/components/schemas/4811a3a9108d5f90b8934012403f954f20270c436bdecbc318a80214cf54fc02.ConferenceRecordingRequest"
},
"maxDuration":{
"type":"integer",
"format":"int32",
"default":28800,
"description":"Max duration in seconds."
}
},
"title":"ActionConferenceRequest"
},
"707907921d4508c2925eddc2449f10db322ecc083be424f87c50fe97ccd8be40.AddExistingCallRequest":{
"type":"object",
"properties":{
"connectOnEarlyMedia":{
"type":"boolean",
"default":false,
"description":"Indicates whether to add an existing call on early media. Otherwise, the call will be added after being established. This field is applicable for `OUTBOUND` calls only. Cannot be `true` when `ringbackGeneration` is enabled."
},
"ringbackGeneration":{
"$ref":"#/components/schemas/efc1265916a727aef4eb46ff2e01c3e0ad0c1ad70cf38d568ed99c04a9a73fa0.RingbackGeneration"
},
"role":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Role"
},
"customData":{
"type":"object",
"additionalProperties":{
"type":"string"
},
"description":"Optional parameter to update a call's custom data."
}
},
"title":"AddExistingCallRequest"
},
"707907921d4508c2925eddc2449f10db322ecc083be424f87c50fe97ccd8be40.AddNewCallRequest":{
"type":"object",
"properties":{
"callRequest":{
"$ref":"#/components/schemas/08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.ActionCallRequest"
},
"connectOnEarlyMedia":{
"type":"boolean",
"default":false,
"description":"Indicates whether to connect a new call on early media. Otherwise, the call will be connected after being established. Cannot be `true` when `ringbackGeneration` is enabled."
},
"ringbackGeneration":{
"$ref":"#/components/schemas/27eaa09c2aeef6932f3271ca5bde4158d33d6ab404b64c38db12c844a2084089.RingbackGeneration"
},
"role":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Role"
}
},
"required":[
"callRequest"
],
"title":"AddNewCallRequest"
},
"707907921d4508c2925eddc2449f10db322ecc083be424f87c50fe97ccd8be40.ConferenceLogResponse":{
"type":"object",
"properties":{
"conferenceId":{
"type":"string",
"description":"Unique conference ID.",
"example":"e8a7c0f5-0f0b-4ccf-84a4-1b7e5f699001",
"maxLength":128
},
"name":{
"type":"string",
"description":"Conference name, requested or autogenerated on creation.",
"example":"Example conference"
},
"platform":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Platform"
},
"startTime":{
"type":"string",
"format":"date-time",
"description":"Date and time for when the conference has been created."
},
"endTime":{
"type":"string",
"format":"date-time",
"description":"Date and time for when the conference ended."
},
"duration":{
"type":"integer",
"format":"int64",
"description":"Conference duration in seconds.",
"example":55
},
"sessions":{
"type":"array",
"description":"List of participant sessions.",
"items":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ParticipantSession"
}
},
"recording":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ConferenceRecordingLog"
},
"errorCode":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ErrorCodeInfo"
}
},
"title":"ConferenceLogResponse"
},
"707907921d4508c2925eddc2449f10db322ecc083be424f87c50fe97ccd8be40.ConferenceRequest":{
"type":"object",
"properties":{
"name":{
"type":"string",
"description":"Conference name, will be auto-generated if not provided."
},
"recording":{
"$ref":"#/components/schemas/4811a3a9108d5f90b8934012403f954f20270c436bdecbc318a80214cf54fc02.ConferenceRecordingRequest"
},
"maxDuration":{
"type":"integer",
"format":"int32",
"default":28800,
"description":"Max duration in seconds."
},
"callsConfigurationId":{
"type":"string",
"description":"Calls Configuration ID."
},
"platform":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Platform"
}
},
"required":[
"callsConfigurationId"
],
"title":"ConferenceRequest"
},
"707907921d4508c2925eddc2449f10db322ecc083be424f87c50fe97ccd8be40.ConnectRequest":{
"type":"object",
"properties":{
"callIds":{
"type":"array",
"description":"IDs of the calls to connect.",
"items":{
"type":"string",
"description":"IDs of the calls to connect."
},
"uniqueItems":true
},
"conferenceRequest":{
"$ref":"#/components/schemas/707907921d4508c2925eddc2449f10db322ecc083be424f87c50fe97ccd8be40.ActionConferenceRequest"
}
},
"required":[
"callIds"
],
"title":"ConnectRequest"
},
"74d8b21d2b740d37eba3fa2f7296b180343b1bcffffec58c82756c7c83775e15.PublicHangupRequest":{
"type":"object",
"description":"Hangup request.",
"properties":{
"errorCode":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicErrorCode"
}
},
"title":"PublicHangupRequest"
},
"74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.AuthenticatedSipTrunkResponse":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.SipTrunkResponse"
},
{
"type":"object",
"properties":{
"authentication":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkAuthentication"
}
}
}
],
"title":"AuthenticatedSipTrunkResponse"
},
"74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.CreateAuthenticatedSipTrunkResponse":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.CreateSipTrunkResponse"
},
{
"type":"object",
"properties":{
"authentication":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkAuthenticationWithCredentials"
},
"tls":{
"type":"boolean",
"description":"Indicates whether TLS is enforced. Always enabled for authenticated SIP trunks."
},
"codecs":{
"type":"array",
"description":"List of audio codecs supported by a SIP trunk.",
"items":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AudioCodec"
}
},
"dtmf":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DtmfType"
},
"fax":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.FaxType"
},
"numberFormat":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.NumberPresentationFormat"
},
"anonymization":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AnonymizationType"
}
}
}
],
"title":"CreateAuthenticatedSipTrunkResponse"
},
"74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.CreateProviderSipTrunkResponse":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.CreateSipTrunkResponse"
},
{
"type":"object",
"properties":{
"provider":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PegasusProvider"
}
}
}
],
"title":"CreateProviderSipTrunkResponse"
},
"74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.CreateRegisteredSipTrunkResponse":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.CreateSipTrunkResponse"
},
{
"type":"object",
"properties":{
"tls":{
"type":"boolean",
"description":"Indicates whether communication is secured by the TLS protocol."
},
"codecs":{
"type":"array",
"description":"List of audio codecs supported by a SIP trunk.",
"items":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AudioCodec"
}
},
"dtmf":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DtmfType"
},
"fax":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.FaxType"
},
"numberFormat":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.NumberPresentationFormat"
},
"anonymization":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AnonymizationType"
},
"username":{
"type":"string",
"description":"Registration username."
},
"password":{
"type":"string",
"description":"Registration password."
},
"inviteAuthentication":{
"type":"boolean",
"description":"Enables an authentication challenge for each call."
}
}
}
],
"title":"CreateRegisteredSipTrunkResponse"
},
"74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.CreateSipTrunkResponse":{
"type":"object",
"discriminator":{
"propertyName":"type",
"mapping":{
"STATIC":"#/components/schemas/74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.CreateStaticSipTrunkResponse",
"REGISTERED":"#/components/schemas/74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.CreateRegisteredSipTrunkResponse",
"PROVIDER":"#/components/schemas/74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.CreateProviderSipTrunkResponse",
"AUTHENTICATED":"#/components/schemas/74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.CreateAuthenticatedSipTrunkResponse"
}
},
"properties":{
"id":{
"type":"string",
"description":"SIP trunk ID."
},
"type":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PegasusSipTrunkType"
},
"name":{
"type":"string",
"description":"SIP trunk name."
},
"location":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkLocation"
},
"internationalCallsAllowed":{
"type":"boolean",
"description":"Indicates whether international calls should be allowed. Calls between different countries are considered international."
},
"channelLimit":{
"type":"integer",
"format":"int32",
"description":"Maximum number of concurrent channels."
},
"billingPackage":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BillingPackage"
},
"sbcHosts":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SbcHosts"
}
},
"title":"CreateSipTrunkResponse"
},
"74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.CreateStaticSipTrunkResponse":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.CreateSipTrunkResponse"
},
{
"type":"object",
"properties":{
"tls":{
"type":"boolean",
"description":"Indicates whether communication is secured by the TLS protocol."
},
"codecs":{
"type":"array",
"description":"List of audio codecs supported by a SIP trunk.",
"items":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AudioCodec"
}
},
"dtmf":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DtmfType"
},
"fax":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.FaxType"
},
"numberFormat":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.NumberPresentationFormat"
},
"anonymization":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AnonymizationType"
},
"sourceHosts":{
"type":"array",
"description":"List of source hosts.",
"items":{
"type":"string",
"description":"List of source hosts."
}
},
"destinationHosts":{
"type":"array",
"description":"List of destination hosts.",
"items":{
"type":"string",
"description":"List of destination hosts."
}
},
"strategy":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SelectionStrategy"
},
"sipOptions":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipOptions"
}
}
}
],
"title":"CreateStaticSipTrunkResponse"
},
"74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.ExtendedSipTrunkStatusResponse":{
"type":"object",
"properties":{
"adminStatus":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkAdminStatus"
},
"actionStatus":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkActionStatusResponse"
},
"registrationStatus":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkRegistrationStatus"
},
"activeCalls":{
"type":"integer",
"format":"int32",
"description":"Number of active calls."
}
},
"title":"ExtendedSipTrunkStatusResponse"
},
"74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.ProviderSipTrunkResponse":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.SipTrunkResponse"
},
{
"type":"object",
"properties":{
"provider":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PegasusProvider"
}
}
}
],
"title":"ProviderSipTrunkResponse"
},
"74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.RegisteredSipTrunkResponse":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.SipTrunkResponse"
},
{
"type":"object",
"properties":{
"username":{
"type":"string",
"description":"Registration username."
},
"inviteAuthentication":{
"type":"boolean",
"description":"Enables an authentication challenge for each call."
}
}
}
],
"title":"RegisteredSipTrunkResponse"
},
"74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.SipTrunkAuthenticatedResetPasswordResponse":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.SipTrunkResetPasswordResponse"
},
{
"type":"object",
"properties":{
"authentication":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkAuthenticationWithCredentials"
}
}
}
],
"title":"SipTrunkAuthenticatedResetPasswordResponse"
},
"74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.SipTrunkRegisteredResetPasswordResponse":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.SipTrunkResetPasswordResponse"
},
{
"type":"object",
"properties":{
"username":{
"type":"string",
"description":"Registration username."
},
"password":{
"type":"string",
"description":"New registration password."
}
}
}
],
"title":"SipTrunkRegisteredResetPasswordResponse"
},
"74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.SipTrunkResetPasswordResponse":{
"type":"object",
"discriminator":{
"propertyName":"type",
"mapping":{
"REGISTERED":"#/components/schemas/74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.SipTrunkRegisteredResetPasswordResponse",
"AUTHENTICATED":"#/components/schemas/74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.SipTrunkAuthenticatedResetPasswordResponse"
}
},
"properties":{
"type":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PegasusSipTrunkType"
}
},
"title":"SipTrunkResetPasswordResponse"
},
"74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.SipTrunkResponse":{
"type":"object",
"discriminator":{
"propertyName":"type",
"mapping":{
"STATIC":"#/components/schemas/74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.StaticSipTrunkResponse",
"REGISTERED":"#/components/schemas/74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.RegisteredSipTrunkResponse",
"PROVIDER":"#/components/schemas/74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.ProviderSipTrunkResponse",
"AUTHENTICATED":"#/components/schemas/74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.AuthenticatedSipTrunkResponse"
}
},
"properties":{
"id":{
"type":"string",
"description":"SIP trunk ID."
},
"type":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PegasusSipTrunkType"
},
"name":{
"type":"string",
"description":"SIP trunk name."
},
"location":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkLocation"
},
"tls":{
"type":"boolean",
"description":"Indicates whether communication is secured by the TLS protocol."
},
"codecs":{
"type":"array",
"description":"List of audio codecs supported by a SIP trunk.",
"items":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AudioCodec"
}
},
"dtmf":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DtmfType"
},
"fax":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.FaxType"
},
"numberFormat":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.NumberPresentationFormat"
},
"internationalCallsAllowed":{
"type":"boolean",
"description":"Indicates whether international calls should be allowed. Calls between different countries are considered international."
},
"channelLimit":{
"type":"integer",
"format":"int32",
"description":"Maximum number of concurrent channels."
},
"anonymization":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AnonymizationType"
},
"billingPackage":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BillingPackage"
},
"sbcHosts":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SbcHosts"
},
"sipOptions":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipOptions"
}
},
"title":"SipTrunkResponse"
},
"74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.SipTrunkStatusResponse":{
"type":"object",
"properties":{
"adminStatus":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkAdminStatus"
}
},
"title":"SipTrunkStatusResponse"
},
"74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.StaticSipTrunkResponse":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.SipTrunkResponse"
},
{
"type":"object",
"properties":{
"sourceHosts":{
"type":"array",
"description":"List of source hosts.",
"items":{
"type":"string",
"description":"List of source hosts."
}
},
"destinationHosts":{
"type":"array",
"description":"List of destination hosts.",
"items":{
"type":"string",
"description":"List of destination hosts."
}
},
"strategy":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SelectionStrategy"
}
}
}
],
"title":"StaticSipTrunkResponse"
},
"7b57a3f63e8903c91849b16f49588058258cfa7d794a974c87de13a6bfe457e6.CallRecording":{
"type":"object",
"properties":{
"callId":{
"type":"string",
"description":"Call ID.",
"example":"d8d84155-3831-43fb-91c9-bb897149a79d",
"maxLength":128
},
"endpoint":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallEndpoint"
},
"direction":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallDirection"
},
"files":{
"type":"array",
"description":"Call recording files.",
"items":{
"$ref":"#/components/schemas/7b57a3f63e8903c91849b16f49588058258cfa7d794a974c87de13a6bfe457e6.RecordingFile"
}
},
"status":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingStatus"
},
"reason":{
"type":"string",
"description":"Reason for recording failure."
},
"callsConfigurationId":{
"type":"string",
"description":"Calls Configuration ID."
},
"applicationId":{
"type":"string",
"deprecated":true,
"description":"Application ID."
},
"startTime":{
"type":"string",
"format":"date-time",
"description":"Date and time when the (first) call recording started."
},
"endTime":{
"type":"string",
"format":"date-time",
"description":"Date and time when the (last) call recording ended."
}
},
"required":[
"endpoint"
],
"title":"CallRecording"
},
"7b57a3f63e8903c91849b16f49588058258cfa7d794a974c87de13a6bfe457e6.ConferenceRecording":{
"type":"object",
"properties":{
"conferenceId":{
"type":"string",
"description":"Conference ID.",
"maxLength":128
},
"conferenceName":{
"type":"string",
"description":"Conference name."
},
"callsConfigurationId":{
"type":"string",
"description":"Calls Configuration ID."
},
"applicationId":{
"type":"string",
"deprecated":true,
"description":"Application ID."
},
"composedFiles":{
"type":"array",
"description":"File(s) with a recording of all conference participants.",
"items":{
"$ref":"#/components/schemas/7b57a3f63e8903c91849b16f49588058258cfa7d794a974c87de13a6bfe457e6.RecordingFile"
}
},
"callRecordings":{
"type":"array",
"description":"File(s) with a recording of one conference participant.",
"items":{
"$ref":"#/components/schemas/7b57a3f63e8903c91849b16f49588058258cfa7d794a974c87de13a6bfe457e6.CallRecording"
}
},
"startTime":{
"type":"string",
"format":"date-time",
"description":"Date and time when the (first) recording started."
},
"endTime":{
"type":"string",
"format":"date-time",
"description":"Date and time when the (last) recording ended."
}
},
"title":"ConferenceRecording"
},
"7b57a3f63e8903c91849b16f49588058258cfa7d794a974c87de13a6bfe457e6.RecordingFile":{
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"File ID.",
"example":"218eceba-c044-430d-9f26-8f1a7f0g2d03"
},
"name":{
"type":"string",
"description":"File name.",
"example":"Example file"
},
"fileFormat":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.FileFormat"
},
"size":{
"type":"integer",
"format":"int64",
"description":"File size in bytes.",
"example":292190
},
"creationTime":{
"type":"string",
"format":"date-time",
"description":"File creation time."
},
"expirationTime":{
"type":"string",
"format":"date-time",
"description":"File expiration time."
},
"duration":{
"type":"integer",
"format":"int64",
"description":"File duration in seconds.",
"example":3
},
"startTime":{
"type":"string",
"format":"date-time",
"description":"Date and time when the recording started."
},
"endTime":{
"type":"string",
"format":"date-time",
"description":"Date and time when the recording ended."
},
"location":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingFileLocation"
},
"sftpUploadStatus":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SftpUploadStatus"
},
"multichannelMappingData":{
"type":"object",
"additionalProperties":{
"type":"string"
},
"description":"A map that associates audio channels with their respective call IDs for managing multichannel composed recordings."
}
},
"required":[
"fileFormat",
"name"
],
"title":"RecordingFile"
},
"87fdb606ad2c440ed89e04f515deb90150ccd79b7e43f8b50549f5895d6c3429.CallsConfigurationCreateRequest":{
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"Calls configuration ID. If not provided, system will generate random ID, which will be returned in response.",
"maxLength":128,
"minLength":1,
"pattern":"^[a-zA-Z0-9_-]*$"
},
"name":{
"type":"string",
"description":"Calls configuration name.",
"maxLength":128,
"minLength":1
}
},
"title":"CallsConfigurationCreateRequest"
},
"87fdb606ad2c440ed89e04f515deb90150ccd79b7e43f8b50549f5895d6c3429.CallsConfigurationResponse":{
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"Calls configuration ID."
},
"name":{
"type":"string",
"description":"Calls configuration name."
}
},
"title":"CallsConfigurationResponse"
},
"87fdb606ad2c440ed89e04f515deb90150ccd79b7e43f8b50549f5895d6c3429.CallsConfigurationUpdateRequest":{
"type":"object",
"properties":{
"name":{
"type":"string",
"description":"Calls configuration name.",
"maxLength":128,
"minLength":1
}
},
"title":"CallsConfigurationUpdateRequest"
},
"94dad8b938c4159f751dc1ff0b70e7beab7409955ce0b31399dbe9488973d3a6.DtmfSendRequest":{
"type":"object",
"properties":{
"customData":{
"type":"object",
"additionalProperties":{
"type":"string"
},
"description":"Optional parameter to update a call's custom data."
},
"dtmf":{
"type":"string",
"description":"DTMF digits to send."
}
},
"required":[
"dtmf"
],
"title":"DtmfSendRequest"
},
"977e3573b6848c404863a30ecae06e08186a75a9070af48acc4b4f99a371a9b7.ClickToCallApiRequest":{
"type":"object",
"description":"Click-to-call request object.",
"properties":{
"bulkId":{
"type":"string",
"description":"The ID which uniquely identifies the request."
},
"messages":{
"type":"array",
"description":"Array of click to call messages to be sent.",
"items":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.ClickToCallApiMessage"
}
}
},
"required":[
"messages"
],
"title":"ClickToCallApiRequest"
},
"97cb4ba23432eb0e600ef0617ae1982d499839ef41226973c71dfb335b3071b8.Destination":{
"type":"object",
"description":"Array of message destination addresses. Maximum number of destination addresses is 20k.",
"properties":{
"to":{
"type":"string",
"description":"Message destination addresses. Destination address must be in the E.164 standard format (Example: `41793026727`)."
},
"messageId":{
"type":"string",
"description":"The ID that uniquely identifies the message sent."
}
},
"required":[
"to"
],
"title":"Destination"
},
"97cb4ba23432eb0e600ef0617ae1982d499839ef41226973c71dfb335b3071b8.StandardVoiceResponse":{
"type":"object",
"description":"Voice response object",
"properties":{
"bulkId":{
"type":"string",
"description":"The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address."
},
"messages":{
"type":"array",
"description":"Array of sent messages, one object per every message.",
"items":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.ResponseDetails"
}
}
},
"title":"StandardVoiceResponse"
},
"9ddf5548c4806a579a37575477f73704a9d1f23ccda5d683f70483437522f25d.StatusRequest":{
"type":"object",
"description":"Status request.",
"properties":{
"action":{
"type":"string",
"description":"Requested action (dial, audio, captureDtmf)."
},
"from":{
"type":"string",
"description":"Caller phone number."
},
"to":{
"type":"string",
"description":"Called phone number."
},
"transferTo":{
"type":"string",
"description":"Called party phone number that the call is transferred to."
},
"duration":{
"type":"integer",
"format":"int32",
"description":"Duration of the outbound call shown in seconds"
},
"status":{
"type":"string",
"description":"Call status which can be: answered, busy, no answer, failed or congestion"
},
"nmCorrelationId":{
"type":"string",
"description":"Unique identifier for correlation with inbound call, available in Callback and Status requests."
},
"fileID":{
"type":"string",
"description":"Identifier of the file played to the caller."
},
"fileUrl":{
"type":"string",
"description":"The URL of the file played to the caller."
},
"ringingTime":{
"type":"string",
"description":"Date and time when ringing started."
},
"answeredTime":{
"type":"string",
"description":"Date and time when the call was answered."
},
"correlationId":{
"type":"string",
"description":"Unique identifier of the call record, available for both Callback and Status requests."
},
"inboundDuration":{
"type":"integer",
"format":"int32",
"description":"Duration of the inbound call shown in seconds."
},
"calculatedDuration":{
"type":"integer",
"format":"int32",
"description":"The duration of the outbound part of the number masking session, where the voice billing model (1/1, 15/15,...) has been applied to the calculatedDuration."
},
"pricePerSecond":{
"type":"number",
"format":"double",
"description":"This is the price per second for the outbound part of the number masking session, with the price being expressed in cents per second."
},
"currency":{
"type":"string",
"description":"The currency in which the price is expressed."
},
"recordingFileId":{
"type":"string",
"description":"ID of a recording file of a call."
},
"recordCalleeAnnouncement":{
"type":"boolean",
"description":"Flag that indicates if callee announcement is included in recording file."
},
"recordingStatus":{
"$ref":"#/components/schemas/0ea963ede06ee99578911cc0068f7474598729635091b55d2985483fad214d7b.RecordingStatus"
},
"machineDetectionResult":{
"$ref":"#/components/schemas/0ea963ede06ee99578911cc0068f7474598729635091b55d2985483fad214d7b.MachineDetectionResult"
},
"clientReferenceId":{
"type":"string",
"description":"Client-defined ID of a valid file name. Used to correlate a call with this reference. If recording is enabled and files are stored in the SFTP server, that ID will be used as a file name instead."
}
},
"title":"StatusRequest"
},
"9ecece8e0bfcbe5cd4fc1dd17fb7c9f9ae92bd39a74bbe56daee9e0629666e59.UploadBody":{
"type":"object",
"properties":{
"url":{
"type":"string",
"description":"URL of your voice file location. Max size of the file is 4MB. The acceptable file format is mp3."
},
"content":{
"type":"string",
"format":"byte",
"description":"Encoded (Base64) value of mp3 file can be included instead of the file location URL."
}
},
"title":"UploadBody"
},
"9ecece8e0bfcbe5cd4fc1dd17fb7c9f9ae92bd39a74bbe56daee9e0629666e59.UploadResponse":{
"type":"object",
"properties":{
"fileId":{
"type":"string",
"description":"Id of the uploaded audio file."
}
},
"title":"UploadResponse"
},
"ApiException":{
"type":"object",
"properties":{
"requestError":{
"$ref":"#/components/schemas/ApiRequestError"
}
},
"title":"ApiException"
},
"ApiRequestError":{
"type":"object",
"properties":{
"serviceException":{
"$ref":"#/components/schemas/ApiRequestErrorDetails"
}
},
"title":"ApiRequestError"
},
"ApiRequestErrorDetails":{
"type":"object",
"properties":{
"messageId":{
"type":"string",
"description":"Identifier of the error."
},
"text":{
"type":"string",
"description":"Detailed error description."
},
"validationErrors":{
"type":"object",
"additionalProperties":{
"type":"array",
"items":{
"type":"string",
"description":"Validation errors."
}
},
"description":"Validation errors."
}
},
"title":"ApiRequestErrorDetails"
},
"a15a35d4e9d79ecb7047887a88973e9a539c66701b3c993c3c3be69782dd8aba.BulkRequest":{
"type":"object",
"description":"Bulk request object.",
"properties":{
"sendAt":{
"type":"string",
"format":"date-time",
"description":"Rescheduled timestamp of the bulk."
}
},
"required":[
"sendAt"
],
"title":"BulkRequest"
},
"a15a35d4e9d79ecb7047887a88973e9a539c66701b3c993c3c3be69782dd8aba.BulkResponse":{
"type":"object",
"description":"Bulk response object.",
"properties":{
"bulkId":{
"type":"string",
"description":"Unique ID of the bulk."
},
"sendAt":{
"type":"string",
"format":"date-time",
"description":"Timestamp when bulk is scheduled."
}
},
"title":"BulkResponse"
},
"a15a35d4e9d79ecb7047887a88973e9a539c66701b3c993c3c3be69782dd8aba.BulkStatusRequest":{
"type":"object",
"description":"Bulk status request object.",
"properties":{
"status":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.BulkStatus"
}
},
"required":[
"status"
],
"title":"BulkStatusRequest"
},
"a15a35d4e9d79ecb7047887a88973e9a539c66701b3c993c3c3be69782dd8aba.BulkStatusResponse":{
"type":"object",
"description":"Bulk status response object.",
"properties":{
"bulkId":{
"type":"string",
"description":"Unique ID of the bulk."
},
"status":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.BulkStatus"
}
},
"required":[
"status"
],
"title":"BulkStatusResponse"
},
"a22294a21e0a6f95f3711ca1f29de62bd2ce6d8bf890b9e41dadab263638faaf.Error":{
"type":"object",
"properties":{
"groupId":{
"type":"integer",
"format":"int32",
"description":"Error group ID.",
"readOnly":false,
"writeOnly":false
},
"groupName":{
"type":"string",
"description":"Error group name.",
"readOnly":false,
"writeOnly":false
},
"id":{
"type":"integer",
"format":"int32",
"description":"Error ID.",
"readOnly":false,
"writeOnly":false
},
"name":{
"type":"string",
"description":"Error name.",
"readOnly":false,
"writeOnly":false
},
"description":{
"type":"string",
"description":"Human-readable description of the error.",
"readOnly":false,
"writeOnly":false
},
"permanent":{
"type":"boolean",
"description":"Tells if the error is permanent.",
"readOnly":false,
"writeOnly":false
}
},
"title":"Error"
},
"a22294a21e0a6f95f3711ca1f29de62bd2ce6d8bf890b9e41dadab263638faaf.Price":{
"type":"object",
"properties":{
"pricePerSecond":{
"type":"number",
"format":"double",
"description":"Price per one second of the Voice message.",
"readOnly":false,
"writeOnly":false
},
"currency":{
"type":"string",
"description":"The currency in which the price is expressed.",
"readOnly":false,
"writeOnly":false
}
},
"title":"Price"
},
"a22294a21e0a6f95f3711ca1f29de62bd2ce6d8bf890b9e41dadab263638faaf.Status":{
"type":"object",
"properties":{
"groupId":{
"type":"integer",
"format":"int32",
"description":"Status group ID.",
"readOnly":false,
"writeOnly":false
},
"groupName":{
"type":"string",
"description":"Status group name that describes which category the status code belongs to, e.g. PENDING, UNDELIVERABLE, DELIVERED, EXPIRED, REJECTED.",
"readOnly":false,
"writeOnly":false
},
"id":{
"type":"integer",
"format":"int32",
"description":"Status ID.",
"readOnly":false,
"writeOnly":false
},
"name":{
"type":"string",
"description":"Status name.",
"readOnly":false,
"writeOnly":false
},
"description":{
"type":"string",
"description":"Human-readable description of the status.",
"readOnly":false,
"writeOnly":false
}
},
"title":"Status"
},
"a8c993b4bcabd2960dfaf3986394e0fe85cd1c09dc98b0a81b51403a00c8f97c.PublicCallRecording":{
"type":"object",
"properties":{
"callId":{
"type":"string",
"description":"Call ID.",
"example":"d8d84155-3831-43fb-91c9-10b5a8d628a0",
"maxLength":128
},
"endpoint":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallEndpoint"
},
"direction":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallDirection"
},
"files":{
"type":"array",
"description":"Call recording files.",
"items":{
"$ref":"#/components/schemas/a8c993b4bcabd2960dfaf3986394e0fe85cd1c09dc98b0a81b51403a00c8f97c.PublicRecordingFile"
}
},
"status":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingStatus"
},
"reason":{
"type":"string",
"description":"Reason for recording failure."
},
"callsConfigurationId":{
"type":"string",
"description":"Calls Configuration ID."
},
"platform":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Platform"
},
"startTime":{
"type":"string",
"format":"date-time",
"description":"Date and time when the (first) call recording started."
},
"endTime":{
"type":"string",
"format":"date-time",
"description":"Date and time when the (last) call recording ended."
}
},
"required":[
"endpoint"
],
"title":"PublicCallRecording"
},
"a8c993b4bcabd2960dfaf3986394e0fe85cd1c09dc98b0a81b51403a00c8f97c.PublicConferenceRecording":{
"type":"object",
"properties":{
"conferenceId":{
"type":"string",
"description":"Conference ID.",
"maxLength":128
},
"conferenceName":{
"type":"string",
"description":"Conference name."
},
"callsConfigurationId":{
"type":"string",
"description":"Calls Configuration ID."
},
"platform":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Platform"
},
"composedFiles":{
"type":"array",
"description":"File(s) with a recording of all conference participants.",
"items":{
"$ref":"#/components/schemas/a8c993b4bcabd2960dfaf3986394e0fe85cd1c09dc98b0a81b51403a00c8f97c.PublicRecordingFile"
}
},
"callRecordings":{
"type":"array",
"description":"File(s) with a recording of one conference participant.",
"items":{
"$ref":"#/components/schemas/a8c993b4bcabd2960dfaf3986394e0fe85cd1c09dc98b0a81b51403a00c8f97c.PublicCallRecording"
}
},
"startTime":{
"type":"string",
"format":"date-time",
"description":"Date and time when the (first) recording started."
},
"endTime":{
"type":"string",
"format":"date-time",
"description":"Date and time when the (last) recording ended."
}
},
"title":"PublicConferenceRecording"
},
"a8c993b4bcabd2960dfaf3986394e0fe85cd1c09dc98b0a81b51403a00c8f97c.PublicDialogRecording":{
"type":"object",
"properties":{
"dialogId":{
"type":"string",
"description":"Unique dialog ID.",
"example":"034e622a-cc7e-456d-8a10-0ba43b11aa5e",
"maxLength":128
},
"callsConfigurationId":{
"type":"string",
"description":"Calls Configuration ID.",
"example":"dc5942707c704551a00cd2ea"
},
"platform":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Platform"
},
"composedFiles":{
"type":"array",
"description":"File(s) with a recording of both dialog participants.",
"items":{
"$ref":"#/components/schemas/a8c993b4bcabd2960dfaf3986394e0fe85cd1c09dc98b0a81b51403a00c8f97c.PublicRecordingFile"
}
},
"callRecordings":{
"type":"array",
"description":"File(s) with a recording of one dialog participant.",
"items":{
"$ref":"#/components/schemas/a8c993b4bcabd2960dfaf3986394e0fe85cd1c09dc98b0a81b51403a00c8f97c.PublicCallRecording"
}
},
"startTime":{
"type":"string",
"format":"date-time",
"description":"Date and time when the (first) recording started."
},
"endTime":{
"type":"string",
"format":"date-time",
"description":"Date and time when the (last) recording ended."
}
},
"title":"PublicDialogRecording"
},
"a8c993b4bcabd2960dfaf3986394e0fe85cd1c09dc98b0a81b51403a00c8f97c.PublicRecordingFile":{
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"File ID.",
"example":"65f0b3d7c8b6a00001a2b3c4"
},
"name":{
"type":"string",
"description":"File name.",
"example":"example-audio.wav"
},
"fileFormat":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.FileFormat"
},
"size":{
"type":"integer",
"format":"int64",
"description":"File size in bytes.",
"example":292190
},
"creationTime":{
"type":"string",
"format":"date-time",
"description":"File creation time."
},
"duration":{
"type":"integer",
"format":"int64",
"description":"File duration in seconds.",
"example":3
},
"startTime":{
"type":"string",
"format":"date-time",
"description":"Date and time when the recording started."
},
"endTime":{
"type":"string",
"format":"date-time",
"description":"Date and time when the recording ended."
},
"location":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingFileLocation"
},
"sftpUploadStatus":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SftpUploadStatus"
},
"customData":{
"type":"object",
"additionalProperties":{
"type":"string"
},
"description":"Custom data."
}
},
"required":[
"fileFormat",
"name"
],
"title":"PublicRecordingFile"
},
"aa157138bc28697f89db8325cc3d3ce20c0f3c72c30b6831a5435f3f2d211cfe.CallRoutingRecordingPage":{
"type":"object",
"properties":{
"results":{
"type":"array",
"description":"The list of the results for this page.",
"items":{
"$ref":"#/components/schemas/6ee61eb40f9e4619d309dfe8df9b479488b43bcde7df95f6a044b2e14abf591e.RecordingApiResponse"
}
},
"paging":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.PageInfo"
}
},
"title":"CallRoutingRecordingPage"
},
"ac429fcfd24f9a7e1a25e07a88be90c98df1692e2811a989e35dc3301ebb4715.ApiException":{
"type":"object",
"properties":{
"requestError":{
"$ref":"#/components/schemas/ApiRequestError"
}
},
"title":"ApiException"
},
"b5f674fb4d8d190ed269baf3b9aaf29827a4d03ec2de31bb6b608809be9a182b.IvrData":{
"type":"object",
"properties":{
"scenarioId":{
"type":"string",
"description":"The ID that uniquely identifies the IVR scenario.",
"readOnly":false,
"writeOnly":false
},
"scenarioName":{
"type":"string",
"description":"Name of IVR scenario.",
"readOnly":false,
"writeOnly":false
},
"collectedDtmfs":{
"type":"string",
"description":"JSON object showing the result of every CollectAction in IVR scenario in the form of key/value pairs, where the key is CollectAction variable and pair is collected DTMF.",
"readOnly":false,
"writeOnly":false
},
"collectedMappedDtmfs":{
"type":"string",
"description":"JSON object showing the result of every CollectAction in IVR scenario with the mapped, meaningful, values you defined in CollectAction `mappedValues` option.",
"readOnly":false,
"writeOnly":false
},
"spokenInput":{
"type":"string",
"description":"JSON object showing the result of every CaptureSpeech action with full text spoken by the user.",
"readOnly":false,
"writeOnly":false
},
"matchedSpokenInput":{
"type":"string",
"description":"JSON object showing the result of every CaptureSpeech action with only the key phrases that matched user spoken input.",
"readOnly":false,
"writeOnly":false
}
},
"title":"IvrData"
},
"b5f674fb4d8d190ed269baf3b9aaf29827a4d03ec2de31bb6b608809be9a182b.VoiceData":{
"type":"object",
"properties":{
"feature":{
"type":"string",
"description":"Name of the Infobip Voice service or feature.",
"readOnly":false,
"writeOnly":false
},
"startTime":{
"type":"string",
"description":"Date and time when the voice message was established and started ringing. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.",
"readOnly":false,
"writeOnly":false
},
"answerTime":{
"type":"string",
"description":"Date and time when the voice message was answered. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.",
"readOnly":false,
"writeOnly":false
},
"endTime":{
"type":"string",
"description":"Date and time when the voice message was ended. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.",
"readOnly":false,
"writeOnly":false
},
"duration":{
"type":"integer",
"format":"int32",
"description":"Duration of the voice message, in seconds.",
"readOnly":false,
"writeOnly":false
},
"chargedDuration":{
"type":"integer",
"format":"int32",
"description":"Charged duration of the voice message, in seconds.",
"readOnly":false,
"writeOnly":false
},
"fileDuration":{
"type":"number",
"format":"double",
"description":"Duration of the voice message audio file, in seconds.",
"readOnly":false,
"writeOnly":false
},
"dtmfCodes":{
"type":"string",
"description":"DTMF code entered by user. Can be empty string, if user did not press anything, or `null` in case of IVR if user did not participate in Collect action.",
"readOnly":false,
"writeOnly":false
},
"answeredBy":{
"type":"string",
"description":"If machine detection is used, contains the result of the machine detection (`HUMAN` or `MACHINE`). Currently, populated only if the call was IVR.",
"readOnly":false,
"writeOnly":false
},
"callRecordingFileId":{
"type":"string",
"description":"Call recording file identification, if the call was recorded. Currently, populated only if the call was IVR. The file can be downloaded using [calls api](https://www.infobip.com/docs/api/channels/voice/calls/files-and-recordings/download-recording-file).",
"readOnly":false,
"writeOnly":false
},
"direction":{
"type":"string",
"description":"Call direction.",
"readOnly":false,
"writeOnly":false
},
"ivr":{
"allOf":[
{
"$ref":"#/components/schemas/b5f674fb4d8d190ed269baf3b9aaf29827a4d03ec2de31bb6b608809be9a182b.IvrData"
}
],
"description":"Fields representing details about IVR, if outbound IVR is being used. If the call was not IVR, the field will be null.",
"readOnly":false,
"writeOnly":false
}
},
"title":"VoiceData"
},
"b5f674fb4d8d190ed269baf3b9aaf29827a4d03ec2de31bb6b608809be9a182b.VoiceReport":{
"type":"object",
"properties":{
"bulkId":{
"type":"string",
"description":"The ID that uniquely identifies the bulk of messages.",
"readOnly":false,
"writeOnly":false
},
"messageId":{
"type":"string",
"description":"The ID that uniquely identifies the message sent.",
"readOnly":false,
"writeOnly":false
},
"from":{
"type":"string",
"description":"The sender ID which can be alphanumeric or numeric.",
"readOnly":false,
"writeOnly":false
},
"to":{
"type":"string",
"description":"Destination address of the voice message.",
"readOnly":false,
"writeOnly":false
},
"sentAt":{
"type":"string",
"description":"Date and time when the voice message was initiated. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.",
"readOnly":false,
"writeOnly":false
},
"mccMnc":{
"type":"string",
"description":"Mobile country and network codes.",
"readOnly":false,
"writeOnly":false
},
"callbackData":{
"type":"string",
"description":"Custom data sent over to the notifyUrl.",
"readOnly":false,
"writeOnly":false
},
"voiceCall":{
"allOf":[
{
"$ref":"#/components/schemas/b5f674fb4d8d190ed269baf3b9aaf29827a4d03ec2de31bb6b608809be9a182b.VoiceData"
}
],
"description":"Fields representing details specific for voice messages.",
"readOnly":false,
"writeOnly":false
},
"price":{
"allOf":[
{
"$ref":"#/components/schemas/a22294a21e0a6f95f3711ca1f29de62bd2ce6d8bf890b9e41dadab263638faaf.Price"
}
],
"description":"Sent Voice message price.",
"readOnly":false,
"writeOnly":false
},
"status":{
"allOf":[
{
"$ref":"#/components/schemas/a22294a21e0a6f95f3711ca1f29de62bd2ce6d8bf890b9e41dadab263638faaf.Status"
}
],
"description":"Indicates whether the message is successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status.",
"externalDocs":{
"description":"Response status and error codes",
"url":"https://www.infobip.com/docs/essentials/api-essentials/response-status-and-error-codes#status-object-example"
},
"readOnly":false,
"writeOnly":false
},
"error":{
"allOf":[
{
"$ref":"#/components/schemas/a22294a21e0a6f95f3711ca1f29de62bd2ce6d8bf890b9e41dadab263638faaf.Error"
}
],
"description":"Indicates whether the error occurred during the query execution.",
"externalDocs":{
"description":"Response status and error codes",
"url":"https://www.infobip.com/docs/essentials/api-essentials/response-status-and-error-codes#error-object-example"
},
"readOnly":false,
"writeOnly":false
}
},
"title":"VoiceReport"
},
"b5f674fb4d8d190ed269baf3b9aaf29827a4d03ec2de31bb6b608809be9a182b.VoiceReportsResponse":{
"type":"object",
"properties":{
"results":{
"type":"array",
"description":"Arrays of delivery reports, one object for every message.",
"items":{
"$ref":"#/components/schemas/b5f674fb4d8d190ed269baf3b9aaf29827a4d03ec2de31bb6b608809be9a182b.VoiceReport"
},
"readOnly":false,
"writeOnly":false
}
},
"title":"VoiceReportsResponse"
},
"be917819c3f3f7072f44fe3d7909e7b833fe4857710e7f5ab585df108ef1ed5b.ApplicationTransferPropagationOptions":{
"type":"object",
"description":"Options that should be propagated while transferring the call.",
"properties":{
"recordingTransferOptions":{
"$ref":"#/components/schemas/be917819c3f3f7072f44fe3d7909e7b833fe4857710e7f5ab585df108ef1ed5b.RecordingTransferOptions"
}
},
"title":"ApplicationTransferPropagationOptions"
},
"be917819c3f3f7072f44fe3d7909e7b833fe4857710e7f5ab585df108ef1ed5b.ApplicationTransferRequest":{
"type":"object",
"properties":{
"destinationCallsConfigurationId":{
"type":"string",
"description":"ID of the calls configuration to which the call is to be transferred."
},
"platform":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Platform"
},
"timeout":{
"type":"integer",
"format":"int32",
"default":30,
"description":"Time to wait, in seconds, for the receiving application to accept the transfer."
},
"customData":{
"type":"object",
"additionalProperties":{
"type":"string"
},
"description":"Optional parameter to update a call's custom data."
},
"propagationOptions":{
"$ref":"#/components/schemas/be917819c3f3f7072f44fe3d7909e7b833fe4857710e7f5ab585df108ef1ed5b.ApplicationTransferPropagationOptions"
}
},
"required":[
"destinationCallsConfigurationId"
],
"title":"ApplicationTransferRequest"
},
"be917819c3f3f7072f44fe3d7909e7b833fe4857710e7f5ab585df108ef1ed5b.RecordingTransferOptions":{
"type":"object",
"description":"Options that control how call recording should behave after the application transfer.",
"properties":{
"continueCallRecording":{
"type":"boolean",
"default":false,
"description":"Continue recording on the transferred call."
}
},
"title":"RecordingTransferOptions"
},
"c18e27d419b307552daa9403b0085ee796da1a5e57e2a4e6fb73f406471574fc.Conference":{
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"Unique conference ID.",
"example":"034e622a-cc7e-456d-8a10-0ba43b11aa5e",
"maxLength":128
},
"name":{
"type":"string",
"description":"Conference name, requested or autogenerated on creation.",
"example":"Example conference"
},
"participants":{
"type":"array",
"description":"The list of conference participants.",
"items":{
"$ref":"#/components/schemas/c18e27d419b307552daa9403b0085ee796da1a5e57e2a4e6fb73f406471574fc.Participant"
}
},
"callsConfigurationId":{
"type":"string",
"description":"Calls Configuration ID.",
"example":"dc5942707c704551a00cd2ea"
},
"platform":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Platform"
}
},
"title":"Conference"
},
"c18e27d419b307552daa9403b0085ee796da1a5e57e2a4e6fb73f406471574fc.ConferenceAndCall":{
"type":"object",
"properties":{
"conference":{
"$ref":"#/components/schemas/c18e27d419b307552daa9403b0085ee796da1a5e57e2a4e6fb73f406471574fc.Conference"
},
"call":{
"$ref":"#/components/schemas/431fb79b0e816230968e14ba1e1c6fadb75cfde9cb3c381f4217b2777f48153f.Call"
}
},
"title":"ConferenceAndCall"
},
"c18e27d419b307552daa9403b0085ee796da1a5e57e2a4e6fb73f406471574fc.Participant":{
"type":"object",
"properties":{
"callId":{
"type":"string",
"description":"Participant call ID.",
"maxLength":128
},
"endpoint":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallEndpoint"
},
"state":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ParticipantState"
},
"joinTime":{
"type":"string",
"format":"date-time",
"description":"Date and time when the participant has joined."
},
"leaveTime":{
"type":"string",
"format":"date-time",
"description":"Date and time when the participant has left."
},
"media":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MediaProperties"
},
"role":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Role"
}
},
"required":[
"endpoint"
],
"title":"Participant"
},
"c5d63eb36983d8ea1e54e74166c0e08ea636cff38a55aa9570bd7ba615a520a0.RouteSimulatorRequest":{
"type":"object",
"description":"Route simulator request object.",
"properties":{
"to":{
"type":"string",
"description":"Phone number or regular expression pattern representing the phone number. Applies to all simulator endpoint types except `WEBRTC`. Examples: `41793026727`, `41793(.+)`."
},
"useDisabledRoutes":{
"type":"boolean",
"description":"If set to `true`, the simulator will use disabled routes for simulation. If set to `false`, only enabled routes will be used."
},
"endpoint":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SimulatorCallEndpoint"
}
},
"required":[
"endpoint",
"to"
],
"title":"RouteSimulatorRequest"
},
"e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException":{
"type":"object",
"properties":{
"requestError":{
"$ref":"#/components/schemas/ApiRequestError"
}
},
"title":"ApiException"
},
"eaaf11bb9830fc826a8597df01bea6f2a14ef6d1ed129a4f6623981d52827778.MarkupLanguageConfigRequest":{
"type":"object",
"description":"Markup language configuration request object.",
"properties":{
"name":{
"type":"string",
"description":"Configuration name."
},
"markupUrl":{
"type":"string",
"description":"URL where markup script is hosted."
},
"notifyUrl":{
"type":"string",
"description":"URL where notifications will be sent."
},
"errorUrl":{
"type":"string",
"description":"URL where error notifications will be sent."
},
"httpMethod":{
"type":"string",
"description":"HTTP method for callbacks (e.g., POST, GET).",
"maxLength":10,
"minLength":0
}
},
"required":[
"httpMethod",
"markupUrl",
"name"
],
"title":"MarkupLanguageConfigRequest"
},
"eaaf11bb9830fc826a8597df01bea6f2a14ef6d1ed129a4f6623981d52827778.MarkupLanguageConfigResponse":{
"type":"object",
"description":"Markup language configuration response object.",
"properties":{
"id":{
"type":"integer",
"format":"int64",
"description":"Unique identifier of the configuration."
},
"name":{
"type":"string",
"description":"Configuration name."
},
"markupUrl":{
"type":"string",
"description":"URL where markup script is hosted."
},
"notifyUrl":{
"type":"string",
"description":"URL where notifications will be sent."
},
"errorUrl":{
"type":"string",
"description":"URL where error notifications will be sent."
},
"httpMethod":{
"type":"string",
"description":"HTTP method for callbacks (e.g., POST, GET)."
},
"createTime":{
"type":"string",
"format":"date-time",
"description":"Timestamp when the configuration was created, in ISO-8601 UTC format (yyyy-MM-dd'T'HH:mm:ss.SSSZ).",
"example":"2025-04-04T11:38:01.724Z"
},
"updateTime":{
"type":"string",
"format":"date-time",
"description":"Timestamp when the configuration was last updated, in ISO-8601 UTC format (yyyy-MM-dd'T'HH:mm:ss.SSSZ).",
"example":"2025-04-04T11:38:01.724Z"
}
},
"required":[
"httpMethod",
"markupUrl",
"name"
],
"title":"MarkupLanguageConfigResponse"
},
"eaaf11bb9830fc826a8597df01bea6f2a14ef6d1ed129a4f6623981d52827778.MarkupRequest":{
"type":"object",
"description":"Markup language request object.",
"properties":{
"callback":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Callback"
},
"endpoint":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallEndpoint"
},
"from":{
"type":"string",
"description":"Phone number from which the call originated from.",
"example":"44790123456"
},
"externalId":{
"type":"string",
"description":"Unique identifier of the call."
},
"notifyUrl":{
"type":"string",
"description":"If set, the system will send a notification to this URL when the call ends."
},
"machineDetection":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.MachineDetection"
}
},
"required":[
"callback",
"endpoint",
"from"
],
"title":"MarkupRequest"
},
"eaaf11bb9830fc826a8597df01bea6f2a14ef6d1ed129a4f6623981d52827778.MarkupResponse":{
"type":"object",
"description":"Markup language response object.",
"properties":{
"callback":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Callback"
},
"endpoint":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallEndpoint"
},
"from":{
"type":"string",
"description":"Phone number from which the call originated from.",
"example":"44790123456"
},
"externalId":{
"type":"string",
"description":"Unique identifier of the call."
}
},
"title":"MarkupResponse"
},
"eaaf11bb9830fc826a8597df01bea6f2a14ef6d1ed129a4f6623981d52827778.WebhookCallbackResponse":{
"type":"object",
"description":"Response from the markup language callback containing instructions to execute.",
"properties":{
"script":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CmlScript"
}
},
"title":"WebhookCallbackResponse"
},
"efc1265916a727aef4eb46ff2e01c3e0ad0c1ad70cf38d568ed99c04a9a73fa0.RingbackGeneration":{
"type":"object",
"description":"Option to generate a consistent local ringback tone, overriding remote ringing tones. If enabled, the ringback will be generated for existing conference participants, if present, provided the new participant is added to the conference before its remote ringback starts. If the remote ringback has already started or finished, local ringback generation will not be applied.",
"properties":{
"enabled":{
"type":"boolean",
"default":false,
"description":"Flag indicating whether ringback generation is enabled. Cannot be `true` when `connectOnEarlyMedia` is `true`."
}
},
"title":"RingbackGeneration"
},
"f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.CallRecordingPage":{
"type":"object",
"properties":{
"results":{
"type":"array",
"description":"The list of the results for this page.",
"items":{
"$ref":"#/components/schemas/a8c993b4bcabd2960dfaf3986394e0fe85cd1c09dc98b0a81b51403a00c8f97c.PublicCallRecording"
}
},
"paging":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PageInfo"
}
},
"title":"CallRecordingPage"
},
"f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.CallsConfigurationPage":{
"type":"object",
"properties":{
"results":{
"type":"array",
"description":"The list of the results for this page.",
"items":{
"$ref":"#/components/schemas/87fdb606ad2c440ed89e04f515deb90150ccd79b7e43f8b50549f5895d6c3429.CallsConfigurationResponse"
}
},
"paging":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PageInfo"
}
},
"title":"CallsConfigurationPage"
},
"f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.ConferenceLogPage":{
"type":"object",
"properties":{
"results":{
"type":"array",
"description":"The list of the results for this page.",
"items":{
"$ref":"#/components/schemas/707907921d4508c2925eddc2449f10db322ecc083be424f87c50fe97ccd8be40.ConferenceLogResponse"
}
},
"paging":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PageInfo"
}
},
"title":"ConferenceLogPage"
},
"f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.ConferencePage":{
"type":"object",
"properties":{
"results":{
"type":"array",
"description":"The list of the results for this page.",
"items":{
"$ref":"#/components/schemas/c18e27d419b307552daa9403b0085ee796da1a5e57e2a4e6fb73f406471574fc.Conference"
}
},
"paging":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PageInfo"
}
},
"title":"ConferencePage"
},
"f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.ConferenceRecordingPage":{
"type":"object",
"properties":{
"results":{
"type":"array",
"description":"The list of the results for this page.",
"items":{
"$ref":"#/components/schemas/a8c993b4bcabd2960dfaf3986394e0fe85cd1c09dc98b0a81b51403a00c8f97c.PublicConferenceRecording"
}
},
"paging":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PageInfo"
}
},
"title":"ConferenceRecordingPage"
},
"f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.DialogLogPage":{
"type":"object",
"properties":{
"results":{
"type":"array",
"description":"The list of the results for this page.",
"items":{
"$ref":"#/components/schemas/5fc49137a7b003ca1d8c4957601417b8ed884356b7fbc49afe416dd5c098a0bd.DialogLogResponse"
}
},
"paging":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PageInfo"
}
},
"title":"DialogLogPage"
},
"f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.DialogPage":{
"type":"object",
"properties":{
"results":{
"type":"array",
"description":"The list of the results for this page.",
"items":{
"$ref":"#/components/schemas/5fc49137a7b003ca1d8c4957601417b8ed884356b7fbc49afe416dd5c098a0bd.DialogResponse"
}
},
"paging":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PageInfo"
}
},
"title":"DialogPage"
},
"f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.DialogRecordingPage":{
"type":"object",
"properties":{
"results":{
"type":"array",
"description":"The list of the results for this page.",
"items":{
"$ref":"#/components/schemas/a8c993b4bcabd2960dfaf3986394e0fe85cd1c09dc98b0a81b51403a00c8f97c.PublicDialogRecording"
}
},
"paging":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PageInfo"
}
},
"title":"DialogRecordingPage"
},
"f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.MediaStreamConfigPage":{
"type":"object",
"properties":{
"results":{
"type":"array",
"description":"The list of the results for this page.",
"items":{
"$ref":"#/components/schemas/655eaf80f7479f4a18447865649b33bdb754aaa97779726ffb72592cb1ac3ce5.MediaStreamConfigResponse"
}
},
"paging":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PageInfo"
}
},
"title":"MediaStreamConfigPage"
},
"f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.SipTrunkPage":{
"type":"object",
"properties":{
"results":{
"type":"array",
"description":"The list of the results for this page.",
"items":{
"$ref":"#/components/schemas/74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.SipTrunkResponse"
}
},
"paging":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PageInfo"
}
},
"title":"SipTrunkPage"
},
"f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.SipTrunkServiceAddressPage":{
"type":"object",
"properties":{
"results":{
"type":"array",
"description":"The list of the results for this page.",
"items":{
"$ref":"#/components/schemas/5cec81334b90b810e64e8923d2a0d906614be46012f19935bf49fd13e921d8b2.PublicSipTrunkServiceAddress"
}
},
"paging":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PageInfo"
}
},
"title":"SipTrunkServiceAddressPage"
},
"f9f4d06aa76c139ea87428e14c99b11f79a0ab9b330e26afc80d0c5a5ff1acbb.RingbackGeneration":{
"type":"object",
"description":"Option to generate a consistent local ringback tone, overriding remote ringing tones. It applies only to `INBOUND` parent calls in the `CALLING` state; otherwise, it is ignored.",
"properties":{
"enabled":{
"type":"boolean",
"default":false,
"description":"Flag indicating whether ringback generation is enabled. Cannot be `true` when `childCallRinging` is `true`."
}
},
"title":"RingbackGeneration"
},
"faa1195a85d1a730663c8d9058f7685a3760136466d26134605b0efcc286bec7.MultiTtsApiRequest":{
"type":"object",
"description":"Multiple voice messages request object.",
"properties":{
"messages":{
"type":"array",
"description":"Array of messages to be sent, one per every message.",
"items":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.MultiTtsApiMessage"
}
}
},
"required":[
"messages"
],
"title":"MultiTtsApiRequest"
}
},
"responses":{
"ApiException400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"example":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"example":"\n \n \n BAD_REQUEST\n Bad request\n \n \n\n"
}
}
},
"ApiException401":{
"description":"Unauthorized",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"example":{
"requestError":{
"serviceException":{
"messageId":"UNAUTHORIZED",
"text":"Unauthorized"
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"example":"\n \n \n UNAUTHORIZED\n Unauthorized\n \n \n\n"
}
}
},
"ApiException403":{
"description":"Forbidden",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"example":{
"requestError":{
"serviceException":{
"messageId":"FORBIDDEN",
"text":"Forbidden"
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"example":"\n \n \n FORBIDDEN\n Forbidden\n \n \n\n"
}
}
},
"ApiException404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"example":{
"requestError":{
"serviceException":{
"messageId":"NOT_FOUND",
"text":"Not found"
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"example":"\n \n \n NOT_FOUND\n Not found\n \n \n\n"
}
}
},
"ApiException429":{
"description":"Too Many Requests",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"example":{
"requestError":{
"serviceException":{
"messageId":"TOO_MANY_REQUESTS",
"text":"Too many requests"
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"example":"\n \n \n TOO_MANY_REQUESTS\n Too many requests\n \n \n\n"
}
}
},
"ApiException500":{
"description":"Internal Server Error",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"example":{
"requestError":{
"serviceException":{
"messageId":"GENERAL_ERROR",
"text":"Something went wrong. Please contact support."
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"example":"\n \n \n GENERAL_ERROR\n Something went wrong. Please contact support.\n \n \n\n"
}
}
}
},
"parameters":{},
"examples":{},
"requestBodies":{},
"headers":{},
"securitySchemes":{
"APIKeyHeader":{
"type":"apiKey",
"description":"This is the most secure authorization type and the one with the most flexibility.\n\nAPI keys can be generated by calling the dedicated API method. Furthermore, API keys can have a limited scope and cover only some API methods. Lastly, they can\nbe revoked at any time. This range of possibilities makes API keys well suited for separating the API access rights across multiple applications or use cases.\nFinally, the loss of an API key is easily manageable.\n\nYou can manage your API keys from [GUI](https://portal.infobip.com/settings/accounts/api-keys), or programmatically\nwith [dedicated API](#platform-&-connectivity/settings).\n\nAPI key Authorization header example:\n\n```shell\nAuthorization: App 003026bbc133714df1834b8638bb496e-8f4b3d9a-e931-478d-a994-28a725159ab9\n```\n",
"name":"Authorization",
"in":"header"
},
"Basic":{
"type":"http",
"description":"Basic authorization type can be used in situations when the API key is not available. For example, API methods for generating API keys should be authenticated\nwith the Basic type.\n\nIn this case, the credentials included in the Authorization header should be a Base64 encoded username and password combination. More formally, basic\nauthentication header can be constructed in three steps:\n\n* Username and password are concatenated using the colon `(:)` as a separator `username:password`.\n* The resulting string is encoded using the [RFC2045-MIME](https://www.ietf.org/rfc/rfc2045.txt) variant of Base64.\n* Encoded string is added as credentials after the `\"Basic \"` type.\n\nExample:\n\n```shell\nUsername: \"Aladdin\"\nPassword: \"openSesame\"\n\nConcatenated string: \"Aladdin:openSesame\"\n\nBase64 encoded string: \"QWxhZGRpbjpvcGVuU2VzYW1l\"\n\nAuthorization header: \"Basic QWxhZGRpbjpvcGVuU2VzYW1l\"\n```\n\n> **Implementation detail**: Base64 encoding is a standard and many available programming languages and frameworks provide convenient methods for encoding\n> strings.\n",
"scheme":"basic"
},
"IBSSOTokenHeader":{
"type":"apiKey",
"description":"This authorization type is suited for situations when you do not want to store Infobip credentials in your own app. Instead, your users will input their Infobip\ncredentials every time they access your application and the application will use those credentials to create a session. From then on, the session token can be\nused to authenticate subsequent API requests. Note that the session will expire automatically after a predefined period of inactivity, and can also be manually\nterminated by making an appropriate API call.\n\nYou can find more details on the creation and behavior of the session at\nthe [dedicated documentation page](#platform-connectivity/account-management/create-session).\n\nAfter obtaining the session token by calling the above-referenced API method you can include it in the Authorization header like this:\n\n```shell\nAuthorization: IBSSO 2f9b4d31-2d0d-49a8-85f0-9b862bdca394\n```\n",
"name":"Authorization",
"in":"header"
},
"OAuth2":{
"type":"oauth2",
"description":"Similarly to the IBSSO Token authentication you can use OAuth 2.0 bearer token with Infobip serving both as resource and authorization server. You can obtain\nthe access token using the client credentials grant from `auth/1/oauth2/token` endpoint. It will provide you with your access token, and its expiration period.\nYou can use the token to authorize your API calls until it expires. You can find out more about the process in\nthe [official specification](https://tools.ietf.org/html/rfc6749#section-4.4).\n\nYou can include your access token in the Authorization HTTP request header like this:\n\n```http\nAuthorization: Bearer \n```",
"flows":{
"clientCredentials":{
"tokenUrl":"https://api.infobip.com/auth/1/oauth2/token",
"scopes":{}
}
}
}
},
"links":{},
"callbacks":{}
},
"webhooks":{
"calls-event-webhook":{
"post":{
"tags":[
"channels",
"voice",
"calls",
"calls-applications",
"application-webhooks"
],
"summary":"Event Webhook",
"description":"Webhook triggered when there is any new event on platform that your application should handle.",
"operationId":"calls-event-webhook",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event"
}
}
}
},
"responses":{
"200":{
"description":"Your server returns this code if it accepts the callback."
}
}
}
},
"receive-markup-language-instructions":{
"post":{
"tags":[
"channels",
"voice",
"calls-markup-language",
"markup-language-instructions"
],
"summary":"Markup callback API",
"description":"Upon receiving a call to the Calls Markup Language, the Infobip platform generates a request to the **markupUrl** you set up \nin the Markup Language configuration. This request will contain Markup Language instructions which dictates call flow.",
"operationId":"markup-language-callback",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/60d0e6d5cbcf8382b5a6bad1f38781f71991c7ea63dad2e6ec22ddc8893af51c.WebhookCallbackRequest"
}
}
}
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/eaaf11bb9830fc826a8597df01bea6f2a14ef6d1ed129a4f6623981d52827778.WebhookCallbackResponse"
}
}
}
}
}
}
},
"receive-markup-language-error":{
"post":{
"tags":[
"channels",
"voice",
"calls-markup-language",
"markup-language-instructions"
],
"summary":"Error callback API",
"description":"When the Infobip platform fails to retrieve or execute Markup Language instructions, it generates a request to the \n**errorUrl** you set up in the Markup Language configuration. The request carries the call context together with the \nerror code and details that describe the failure.",
"operationId":"markup-language-error-callback",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/60d0e6d5cbcf8382b5a6bad1f38781f71991c7ea63dad2e6ec22ddc8893af51c.ErrorCallbackRequest"
}
}
}
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/eaaf11bb9830fc826a8597df01bea6f2a14ef6d1ed129a4f6623981d52827778.WebhookCallbackResponse"
}
}
}
}
}
}
},
"receive-markup-language-record":{
"post":{
"tags":[
"channels",
"voice",
"calls-markup-language",
"markup-language-instructions"
],
"summary":"Record callback API",
"description":"When the Infobip platform stops a call recording produced by a Record instruction, \nit generates a request to the callback URL configured on that Record instruction. The request carries the call context \ntogether with the recorded file identifier and the current recording status.",
"operationId":"markup-language-record-callback",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/60d0e6d5cbcf8382b5a6bad1f38781f71991c7ea63dad2e6ec22ddc8893af51c.RecordCallbackRequest"
}
}
}
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/eaaf11bb9830fc826a8597df01bea6f2a14ef6d1ed129a4f6623981d52827778.WebhookCallbackResponse"
}
}
}
}
}
}
},
"receive-markup-language-capture-dtmf":{
"post":{
"tags":[
"channels",
"voice",
"calls-markup-language",
"markup-language-instructions"
],
"summary":"Capture DTMF callback API",
"description":"When the Infobip platform finishes collecting DTMF input requested by a CaptureDtmf instruction, it generates a request \nto the callback URL configured on that CaptureDtmf instruction. The request carries the call context together with the \ncaptured DTMF sequence.",
"operationId":"markup-language-capture-dtmf-callback",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/60d0e6d5cbcf8382b5a6bad1f38781f71991c7ea63dad2e6ec22ddc8893af51c.CaptureDtmfCallbackRequest"
}
}
}
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/eaaf11bb9830fc826a8597df01bea6f2a14ef6d1ed129a4f6623981d52827778.WebhookCallbackResponse"
}
}
}
}
}
}
},
"fetch-markup-language":{
"post":{
"tags":[
"channels",
"voice",
"calls-markup-language",
"markup-language-instructions"
],
"summary":"Fetch callback API",
"description":"When the Infobip platform executes a Fetch instruction, it generates a request to the **url** you set up in the \nFetch instruction. The request carries the call context together with the fetch instruction details.",
"operationId":"markup-language-fetch-callback",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/60d0e6d5cbcf8382b5a6bad1f38781f71991c7ea63dad2e6ec22ddc8893af51c.WebhookCallbackRequest"
}
}
}
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/eaaf11bb9830fc826a8597df01bea6f2a14ef6d1ed129a4f6623981d52827778.WebhookCallbackResponse"
}
}
}
}
}
}
},
"send-machine-detection-callback":{
"post":{
"tags":[
"channels",
"voice",
"calls-markup-language",
"markup-language-instructions"
],
"summary":"Machine detection callback API",
"description":"When the Infobip platform finishes machine detection requested by a MachineDetection instruction, it generates a request \nto the callback URL configured on Markup Language configuration (markupUrl). The request carries the call context together with the \nmachine detection result.",
"operationId":"markup-language-machine-detection-callback",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/60d0e6d5cbcf8382b5a6bad1f38781f71991c7ea63dad2e6ec22ddc8893af51c.MachineDetectionCallbackRequest"
}
}
}
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/eaaf11bb9830fc826a8597df01bea6f2a14ef6d1ed129a4f6623981d52827778.WebhookCallbackResponse"
}
}
}
}
}
}
},
"dial-callback":{
"post":{
"tags":[
"channels",
"voice",
"calls-markup-language",
"markup-language-instructions"
],
"summary":"Dial callback API",
"description":"When the Infobip platform finishes processing a dial endpoint requested by a Dial instruction, it generates a request \nto the callback URL configured on that Dial instruction. The request carries the call context together with the \ndial endpoint result.",
"operationId":"markup-language-dial-callback",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/60d0e6d5cbcf8382b5a6bad1f38781f71991c7ea63dad2e6ec22ddc8893af51c.DialCallbackRequest"
}
}
}
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/eaaf11bb9830fc826a8597df01bea6f2a14ef6d1ed129a4f6623981d52827778.WebhookCallbackResponse"
}
}
}
}
}
}
},
"send-machine-detection-async-callback":{
"post":{
"tags":[
"channels",
"voice",
"calls-markup-language",
"markup-language-instructions-async"
],
"summary":"Machine detection async callback API",
"description":"When the Infobip platform finishes machine detection requested by a MachineDetection instruction, it generates a request \nto the callback URL configured on Markup Language configuration (markupUrl). The request carries the call context together with the \nmachine detection result.",
"operationId":"markup-language-machine-detection-async-callback",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/60d0e6d5cbcf8382b5a6bad1f38781f71991c7ea63dad2e6ec22ddc8893af51c.MachineDetectionCallbackRequest"
}
}
}
},
"responses":{
"200":{
"description":"Your server returns this code if it accepts the callback."
}
}
}
},
"send-machine-message-detection-async-callback":{
"post":{
"tags":[
"channels",
"voice",
"calls-markup-language",
"markup-language-instructions-async"
],
"summary":"Machine message detection callback API",
"description":"When the Infobip platform finishes machine message detection requested by a MachineMessageDetection instruction, it generates a request \nto the callback URL configured on Markup Language configuration (markupUrl) The request carries the call context together with the \nmachine message detection result.",
"operationId":"markup-language-machine-message-detection-callback",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/60d0e6d5cbcf8382b5a6bad1f38781f71991c7ea63dad2e6ec22ddc8893af51c.MachineMessageDetectionCallbackRequest"
}
}
}
},
"responses":{
"200":{
"description":"Your server returns this code if it accepts the callback."
}
}
}
},
"send-recording-status-callback":{
"post":{
"tags":[
"channels",
"voice",
"calls-markup-language",
"markup-language-instructions-async"
],
"summary":"Recording status callback API",
"description":"When the Infobip platform finishes processing a recording requested by a Record instruction, it generates a request \nto the callback URL configured on Record or StartRecording instruction. The request carries the call context together with the \nrecording status.",
"operationId":"markup-language-recording-status-callback",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/60d0e6d5cbcf8382b5a6bad1f38781f71991c7ea63dad2e6ec22ddc8893af51c.RecordingStatusCallbackRequest"
}
}
}
},
"responses":{
"200":{
"description":"Your server returns this code if it accepts the callback."
}
}
}
},
"receive-voice-delivery-reports":{
"post":{
"tags":[
"channels",
"voice",
"voice-reports-and-logs"
],
"summary":"Receive Voice Delivery Reports",
"description":"We can send you delivery reports for Voice messages, outbound IVR, Click-to-call or Markup Language in real time. All you need to do is specify notifyUrl in your endpoint when using some of these features and we will deliver a [status](https://www.infobip.com/docs/essentials/response-status-and-error-codes) report to your platform.",
"operationId":"receive-voice-delivery-reports",
"requestBody":{
"content":{
"text/plain":{
"schema":{
"allOf":[
{
"$ref":"#/components/schemas/b5f674fb4d8d190ed269baf3b9aaf29827a4d03ec2de31bb6b608809be9a182b.VoiceReportsResponse"
}
]
}
},
"application/json":{
"schema":{
"allOf":[
{
"$ref":"#/components/schemas/b5f674fb4d8d190ed269baf3b9aaf29827a4d03ec2de31bb6b608809be9a182b.VoiceReportsResponse"
}
]
},
"examples":{
"Report example":{
"summary":"Report example",
"value":{
"results":[
{
"bulkId":"8c20f086-d82b-48cc-b2b3-3ca5f7aca9fb",
"messageId":"ff4804ef-6ab6-4abd-984d-ab3b1387e852",
"from":"385333444",
"to":"385981178",
"sentAt":"2018-06-25T13:38:14.730+0000",
"mccMnc":"21901",
"callbackData":"DLR callback data",
"voiceCall":{
"feature":"Voice-message",
"startTime":"2018-06-25T13:38:15.000+0000",
"answerTime":"2018-06-25T13:38:25.000+0000",
"endTime":"2018-06-25T13:38:28.316+0000",
"duration":10,
"chargedDuration":30,
"fileDuration":19.3,
"dtmfCodes":"1",
"ivr":{
"scenarioId":"333",
"scenarioName":"Scenario name",
"collectedDtmfs":"{\"myFirstVar\":\"3\",\"mySecondVar\":\"8\"}"
}
},
"price":{
"pricePerSecond":0.01,
"currency":"EUR"
},
"status":{
"groupId":3,
"groupName":"DELIVERED",
"id":5,
"name":"DELIVERED_TO_HANDSET",
"description":"Message delivered to handset"
},
"error":{
"groupId":0,
"groupName":"OK",
"id":5000,
"name":"VOICE_ANSWERED",
"description":"Call answered by human",
"permanent":true
}
}
]
}
}
}
},
"application/xml":{
"schema":{
"allOf":[
{
"$ref":"#/components/schemas/b5f674fb4d8d190ed269baf3b9aaf29827a4d03ec2de31bb6b608809be9a182b.VoiceReportsResponse"
}
]
},
"examples":{
"Report example":{
"summary":"Report example",
"value":"\n \n \n 8c20f086-d82b-48cc-b2b3-3ca5f7aca9fb\n ff4804ef-6ab6-4abd-984d-ab3b1387e852\n 385333444\n 385981178\n 2018-06-25T13:38:14.730+0000\n 21901\n DLR callback data\n \n Voice-message\n 2018-06-25T13:38:15.000+0000\n 2018-06-25T13:38:25.000+0000\n 2018-06-25T13:38:28.316+0000\n 10\n 30\n 19.3\n 1\n \n 333\n Scenario name\n {\"myFirstVar\":\"3\",\"mySecondVar\":\"8\"}\n \n \n \n 0.01\n EUR\n \n \n 3\n DELIVERED\n 5\n DELIVERED_TO_HANDSET\n Message delivered to handset\n \n \n 0\n OK\n 5000\n VOICE_ANSWERED\n Call answered by human\n true\n \n \n \n\n"
}
}
},
"text/xml":{
"schema":{
"allOf":[
{
"$ref":"#/components/schemas/b5f674fb4d8d190ed269baf3b9aaf29827a4d03ec2de31bb6b608809be9a182b.VoiceReportsResponse"
}
]
}
},
"text/csv":{
"schema":{
"allOf":[
{
"$ref":"#/components/schemas/b5f674fb4d8d190ed269baf3b9aaf29827a4d03ec2de31bb6b608809be9a182b.VoiceReportsResponse"
}
]
}
},
"application/x-www-form-urlencoded":{
"schema":{
"allOf":[
{
"$ref":"#/components/schemas/b5f674fb4d8d190ed269baf3b9aaf29827a4d03ec2de31bb6b608809be9a182b.VoiceReportsResponse"
}
]
}
}
}
},
"responses":{
"200":{
"description":"Your server returns this code if it accepts the callback"
}
}
}
},
"deprecated-receive-voice-delivery-reports":{
"post":{
"tags":[
"channels",
"voice",
"voice-reports-and-logs"
],
"summary":"Receive Voice Delivery Reports",
"description":"This version is deprecated as of July 1st 2020, meaning no fixes/updates will be provided and no new parameters will be added.
We strongly advise you to update to new [delivery report method](#programmable-communications/voice/receive-voice-delivery-reports).",
"operationId":"receive-voice-delivery-reports-deprecated",
"requestBody":{
"content":{
"text/plain":{
"schema":{
"allOf":[
{
"$ref":"#/components/schemas/42b3068683a04f02f0303cd880adeb4415571c6aad33d9a3c6850123c94c9889.VoiceReportsResponse"
}
]
}
},
"application/json":{
"schema":{
"allOf":[
{
"$ref":"#/components/schemas/42b3068683a04f02f0303cd880adeb4415571c6aad33d9a3c6850123c94c9889.VoiceReportsResponse"
}
]
},
"examples":{
"Report example":{
"summary":"Report example",
"value":{
"results":[
{
"bulkId":"8c20f086-d82b-48cc-b2b3-3ca5f7aca9fb",
"messageId":"ff4804ef-6ab6-4abd-984d-ab3b1387e852",
"to":"385981178",
"sentAt":"2020-04-22T02:18:30.205+0000",
"doneAt":"2020-04-22T02:19:02.355+0000",
"startTime":1587521910000,
"endTime":1587521932224,
"answerTime":1587521917000,
"duration":14,
"fileDuration":19.3,
"mccMnc":"21901",
"callbackData":"DLR callback data",
"dtmfCodes":"1",
"dtmfCodesAsJson":"{\"myFirstVar\":\"3\",\"mySecondVar\":\"8\"}",
"transcribedAudioFileUrl":"/tts/3/transcriptions/message-id/38761333444",
"scenarioId":"333",
"scenarioName":"Scenario name",
"price":{
"pricePerSecond":0.01,
"currency":"EUR"
},
"status":{
"groupId":3,
"groupName":"DELIVERED",
"id":5,
"name":"DELIVERED_TO_HANDSET",
"description":"Message delivered to handset"
},
"error":{
"groupId":0,
"groupName":"OK",
"id":5000,
"name":"VOICE_ANSWERED",
"description":"Call answered by human",
"permanent":true
}
}
]
}
}
}
},
"application/xml":{
"schema":{
"allOf":[
{
"$ref":"#/components/schemas/42b3068683a04f02f0303cd880adeb4415571c6aad33d9a3c6850123c94c9889.VoiceReportsResponse"
}
]
},
"examples":{
"Report example":{
"summary":"Report example",
"value":"\n \n \n 8c20f086-d82b-48cc-b2b3-3ca5f7aca9fb\n ff4804ef-6ab6-4abd-984d-ab3b1387e852\n 385981178\n 2018-06-25T13:38:14.730+0000\n 2018-06-25T13:38:14.830+0000\n 2018-06-25T13:38:15.000+0000\n 2018-06-25T13:38:25.000+0000\n 2018-06-25T13:38:28.316+0000\n 10\n 19.3\n 21901\n DLRcallbackdata\n 1\n {\"myFirstVar\":\"3\",\"mySecondVar\":\"8\"}\n /tts/3/transcriptions/message-id/38761333444\n 333\n Scenarioname\n \n 0.01\n EUR\n \n \n 3\n DELIVERED\n 5\n DELIVERED_TO_HANDSET\n Messagedeliveredtohandset\n \n \n 0\n OK\n 5000\n VOICE_ANSWERED\n Callansweredbyhuman\n true\n \n \n \n\n"
}
}
},
"text/xml":{
"schema":{
"allOf":[
{
"$ref":"#/components/schemas/42b3068683a04f02f0303cd880adeb4415571c6aad33d9a3c6850123c94c9889.VoiceReportsResponse"
}
]
}
},
"text/csv":{
"schema":{
"allOf":[
{
"$ref":"#/components/schemas/42b3068683a04f02f0303cd880adeb4415571c6aad33d9a3c6850123c94c9889.VoiceReportsResponse"
}
]
}
},
"application/x-www-form-urlencoded":{
"schema":{
"allOf":[
{
"$ref":"#/components/schemas/42b3068683a04f02f0303cd880adeb4415571c6aad33d9a3c6850123c94c9889.VoiceReportsResponse"
}
]
}
}
}
},
"responses":{
"200":{
"description":"Your server returns this code, if it accepts the callback."
}
},
"deprecated":true
}
},
"receive-number-masking-target":{
"post":{
"tags":[
"channels",
"voice",
"number-masking",
"number-masking-events"
],
"summary":"Number Masking callback API",
"description":"Upon receiving a call to the Number Masking number, Infobip platform generates a request to the **callbackUrl** you set up \nin the NM configuration. This request will contain the callee number and the Voice number that's called. We also provide \n**correlationID** and **nmCorrelationID** to be used as identifiers for this call request.\n\nIn return from your platform, Infobip platform expects to receive the phone number needed to forward the call to and caller ID \nthat should be presented. Caller ID representation depends on the voice connection capabilities in a particular region. Instead of the number, \nyou could also send a parameter **audio** so we would play an audio file that was previously uploaded to our platform \n[(Audio file upload)](#customer-engagement/anonymize/upload-audio-files) or hosted on your server. Also, you can send a \nparameter **captureDtmf** to play audio file and start capturing DTMF input that will be sent as `from` field in the new callback request.\n",
"operationId":"provide-number-masking-target",
"parameters":[
{
"name":"Authorization",
"in":"header",
"description":"For more details check [Secure your communication](https://www.infobip.com/docs/voice-and-video/number-masking).",
"required":false,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"Authorization: "
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/59ad711434aad6c39708ffc0bab084b409f8c1de0ab1fd0cfa66aa965f740ee4.CallbackRequest"
},
"examples":{
"Callback request":{
"summary":"Callback request",
"value":{
"from":"41793026727",
"to":"41793026731",
"correlationId":"0f754338-1aff-4e09-a933-7d205ca7aed4",
"nmCorrelationId":"7cb72e4b-cf9f-40b6-9fc4-79588d18a666"
}
},
"Callback request after captureDtmf command":{
"summary":"Callback request after captureDtmf command",
"value":{
"from":"41228755825",
"to":"41793026731",
"correlationId":"0f754338-1aff-4e09-a933-7d205ca7aed4",
"nmCorrelationId":"7cb72e4b-cf9f-40b6-9fc4-79588d18a666",
"dtmfCaptured":true
}
}
}
}
}
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/0ea963ede06ee99578911cc0068f7474598729635091b55d2985483fad214d7b.CallbackResponse"
},
"examples":{
"Audio command response":{
"summary":"Audio command response",
"value":{
"fileUrl":"http://www.audioFileUrl.mp3"
}
},
"Dial command response":{
"summary":"Dial command response",
"value":{
"phoneNumber":"41792212112121",
"callerId":"41793026731",
"announcements":{
"caller":{
"fileUrl":"http://www.audioFileUrl.mp3"
},
"callee":{
"fileId":"f9850667-86c8-48d3-a9b2-9a6a372f5d00"
}
},
"recording":{
"enabled":true,
"recordCalleeAnnouncement":true
},
"machineDetection":{
"enabled":true,
"detectionTime":0.0,
"hangupOnMachineDetection":true
},
"clientReferenceId":"7e8d64c0-6c72-4922-aa96-48728753c660"
}
},
"Capture dtmf command response":{
"summary":"Capture dtmf command response",
"value":{
"fileUrl":"http://www.audioFileUrl.mp3",
"timeout":5000
}
}
}
}
}
}
}
}
},
"receive-masked-call-report":{
"post":{
"tags":[
"channels",
"voice",
"number-masking",
"number-masking-events"
],
"summary":"Number Masking status API",
"description":"After a received call to the Number Masking number has finished, Infobip platform generates a request to your **statusURL** \nset up in the NM configuration. This request contains report details of the call. We also provide the **correlationID** and \n**nmCorrelationID** to be used as identifiers for this call request.\n\nIn return from your platform, Infobip platform expects a confirmation that the request has been received successfully.\n",
"operationId":"receive-masked-call-report",
"parameters":[
{
"name":"Authorization",
"in":"header",
"description":"For more details check [Secure your communication](https://www.infobip.com/docs/voice-and-video/number-masking).",
"required":false,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"Authorization: "
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9ddf5548c4806a579a37575477f73704a9d1f23ccda5d683f70483437522f25d.StatusRequest"
},
"examples":{
"Status request":{
"summary":"Status request",
"value":{
"action":"dial",
"from":"41793026727",
"to":"41793026731",
"transferTo":"41793026785",
"duration":15,
"status":"answered",
"nmCorrelationId":"7cb72e4b-cf9f-40b6-9fc4-79588d18a666",
"ringingTime":"2018-01-01 12:00:00",
"answeredTime":"2018-01-01 12:00:10",
"correlationId":"0f754338-1aff-4e09-a933-7d205ca7aed4",
"inboundDuration":30,
"calculatedDuration":15,
"pricePerSecond":0.01,
"currency":"EUR",
"recordingFileId":"7e8d64c0-6c72-4922-aa96-48728753c660",
"recordCalleeAnnouncement":true,
"recordingStatus":"SFTP",
"machineDetectionResult":"HUMAN",
"clientReferenceId":"7e8d64c0-6c72-4922-aa96-48728753c660"
}
}
}
}
}
},
"responses":{
"200":{
"description":"A successful response is represented by an HTTP status code 200 OK from the Client’s platform.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/0ea963ede06ee99578911cc0068f7474598729635091b55d2985483fad214d7b.StatusResponse"
}
}
}
}
}
}
},
"receive-url-destination-request":{
"post":{
"tags":[
"channels",
"voice",
"routing",
"call-routing-events"
],
"summary":"URL destination webhook",
"description":"The client-defined API is triggered with information about the current call whenever the URL destination is reached in route resolution. The expected response is a valid endpoint destination.",
"operationId":"receive-url-destination-request",
"parameters":[
{
"name":"Authorization",
"in":"header",
"description":"Authentication generated based on route configuration. Basic and HMAC are supported.",
"required":false,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"Authorization: "
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.UrlDestinationHttpRequest"
}
}
}
},
"responses":{
"200":{
"description":"Success",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.UrlDestinationResponse"
},
"examples":{
"Phone destination response":{
"summary":"Phone destination response",
"value":{
"value":{
"phoneNumber":"41793026834",
"type":"PHONE"
},
"type":"ENDPOINT"
}
},
"SIP destination response":{
"summary":"SIP destination response",
"value":{
"value":{
"username":"41793026834",
"sipTrunkId":"60d345fd3a799ec",
"type":"SIP"
},
"connectTimeout":30,
"recording":{
"recordingType":"AUDIO"
},
"type":"ENDPOINT"
}
}
}
}
}
}
}
}
}
}
}