Skip to main content
POST
Create outbound call conversation

Authorizations

Authorization
string
header
default:App
required

This is the most secure authorization type and the one with the most flexibility.

API 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 be 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. Finally, the loss of an API key is easily manageable.

You can manage your API keys from GUI, or programmatically with dedicated API.

API key Authorization header example:

Body

application/json
from
string
required

DID number that is used to originate the call. DID numbers can be configured through the portal, or using the 'Purchase a number' endpoint.

to
string
required

Destination number.

agentId
string
required

Id of the agent originating the call.

voiceClientType
enum<string>
default:PSTN

Voice client type of the destination number.

Available options:
PSTN,
WEBRTC,
WHATSAPP,
VIBER,
LIVE_CHAT

Response

OK

from
string
required

DID number that is used to originate the call. DID numbers can be configured through the portal, or using the 'Purchase a number' endpoint.

to
string
required

Destination number.

agentId
string
required

Id of the agent originating the call.

conversationId
string
read-only

Id of the created conversation