Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Query Parameters
Example:
{ "from": "2022-01-01", "to": "2022-01-31" }Example:
24
Available options:
failed, voicemail, ringing, answer, completed, busy, open, close, closed, resolved, no-answer, canceled, in-progress, ongoing, pending, stalled, expired, processing, queued Example:
"answer"
Available options:
call, sms, whatsapp, email, webchat Example:
"call"
Example:
"yes"
Response
Returns the call
Interaction ID
Example:
"123e4567-e89b-12d3-a456-426614174000"
Interaction status
Example:
"in-progress"
Agent phone number
Example:
"+1234567890"
Agent Email
Example:
"+1234567890"
Customer phone number
Example:
"+1234567890"
Customer email
Example:
"+1234567890"
Agent ID
Example:
"123e4567-e89b-12d3-a456-426614174000"
Customer ID
Example:
"123e4567-e89b-12d3-a456-426614174000"
Skill ID
Example:
"123e4567-e89b-12d3-a456-426614174000"
Customer name
Example:
"John Doe"
Transcription
Example:
"Hello, how can I help you?"
Recording URL
Example:
"https://example.com/recording.wav"
conversation messages
Example:
[
{
"sid": "SM1234567890abcdef",
"timestamp": "2025-03-17T14:30:00Z",
"sender": "agent",
"content": "Hello, how can I assist you today?",
"mediaUrl": "https://example.com/image.jpg",
"status": "delivered"
}
]Session duration in seconds
Example:
"7200"
