POST
/
api
/
v1
/
calls
curl --request POST \
  --url https://cx-staging-three.fly.dev/api/v1/calls \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "agentId": "123e4567-e89b-12d3-a456-426614174000",
  "channel": "call",
  "skillId": "123e4567-e89b-12d3-a456-426614174000",
  "customerName": "John Does",
  "customerPhone": "+1234567890"
}'
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "in-progress",
  "agentPhone": "+1234567890",
  "customerPhone": "+1234567890",
  "agentId": "123e4567-e89b-12d3-a456-426614174000",
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "skillId": "123e4567-e89b-12d3-a456-426614174000",
  "customerName": "John Doe",
  "transcription": "Hello, how can I help you?",
  "recordingUrl": "https://example.com/recording.wav"
}

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,
webchat
Example:

"call"

​
skillId
string
required

Your skill UUID

Example:

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

​
customerName
string
required

The customers name you're trying to reach

Example:

"John Does"

​
customerPhone
string
required

The customers phone number you're trying to reach

Example:

"+1234567890"

Response

200
application/json
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"

​
customerPhone
string
required

Customer phone number

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"