Calls
Initiate call
POST
/
api
/
v1
/
calls
Authorizations
Authorization
string
headerrequiredBasic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Body
application/json
agentId
string
requiredYour agents UUID
channel
enum<string>
requiredThe interaction channel, you can send your agent to call, sms, whatsapp or webchat
Available options:
call
, sms
, whatsapp
, webchat
skillId
string
requiredYour skill UUID
customerName
string
requiredThe customers name you're trying to reach
customerPhone
string
requiredThe customers phone number you're trying to reach
Response
200 - application/json
id
string
requiredInteraction ID
status
string
requiredInteraction status
agentPhone
string
requiredAgent phone number
customerPhone
string
requiredCustomer phone number
agentId
string
requiredAgent ID
customerId
string
requiredCustomer ID
skillId
string
requiredSkill ID
customerName
string
requiredCustomer name
transcription
string
requiredTranscription
recordingUrl
string
requiredRecording URL