Skip to main content
POST
Create Call

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

Input data for creating a new interaction

agentId
string
required

Your agents UUID

Example:

"123e4567-e89b-12d3-a456-426614174000"

channel
enum<string>
required

The interaction channel, you can send your agent to call, sms, whatsapp or webchat

Available options:
call,
sms,
whatsapp,
email,
webchat
Example:

"call"

skillId
string
required

Your skill UUID

Example:

"123e4567-e89b-12d3-a456-426614174000"

customerOverride
object
required

Your agent override settings

Example:
agentOverride
object

Your agent override settings

Example:
customerName
string

The customer's name to create a new customer

Example:

"John Does"

customerPhone
string

The customer's phone number to create a new customer

Example:

"+1234567890"

customerEmail
string

The customer's email to create a new customer

Example:

"customer@email.com"

Response

Initiate call

id
string
required

Interaction ID

Example:

"123e4567-e89b-12d3-a456-426614174000"

status
string
required

Interaction status

Example:

"in-progress"

agentPhone
string
required

Agent phone number

Example:

"+1234567890"

agentEmail
string
required

Agent Email

Example:

"+1234567890"

customerPhone
string
required

Customer phone number

Example:

"+1234567890"

customerEmail
string
required

Customer email

Example:

"+1234567890"

agentId
string
required

Agent ID

Example:

"123e4567-e89b-12d3-a456-426614174000"

customerId
string
required

Customer ID

Example:

"123e4567-e89b-12d3-a456-426614174000"

skillId
string
required

Skill ID

Example:

"123e4567-e89b-12d3-a456-426614174000"

customerName
string
required

Customer name

Example:

"John Doe"

transcription
string
required

Transcription

Example:

"Hello, how can I help you?"

recordingUrl
string
required

Recording URL

Example:

"https://example.com/recording.wav"

messages
string[]
required

conversation messages

Example:
duration
number
required

Session duration in seconds

Example:

"7200"