Skip to main content
POST
/
v1
/
calls
{
  "callId": "call-AuUKK371Spr5nHJS",
  "callType": "inbound",
  "phoneNumber": {
    "sipPhoneNumber": 14155552671,
    "provider": "twilio",
    "inboundAgentId": "D5D0p7TUs66TTAEAx",
    "outboundAgentId": "D5D0p7TUs66TTAEAx",
    "outboundPhoneNumber": 14155552671,
    "active": true,
    "terminationSipURI": "sip.telnyx.com",
    "friendlyName": "Support Line - US"
  },
  "campaign": {
    "campaignId": "camp-XiQEBcj9cc5TFRB4",
    "campaignName": "My Campaign",
    "campaignStatus": "live",
    "scheduledDate": "2023-11-07T05:31:56Z",
    "concurrentCalls": 5,
    "agent": {
      "name": "New AI Agent",
      "agentId": "D5D0p7TUs66TTAEAx",
      "status": "active"
    },
    "phoneNumber": {
      "sipPhoneNumber": 14155552671,
      "provider": "twilio",
      "inboundAgentId": "D5D0p7TUs66TTAEAx",
      "outboundAgentId": "D5D0p7TUs66TTAEAx",
      "outboundPhoneNumber": 14155552671,
      "active": true,
      "terminationSipURI": "sip.telnyx.com",
      "friendlyName": "Support Line - US"
    },
    "errors": [
      "<string>"
    ],
    "scheduled": true
  },
  "status": "ended",
  "startTime": "2021-04-20T10:00:00.000Z",
  "endTime": "2021-04-20T10:00:00.000Z",
  "duration": 120,
  "terminationReason": "inactivity",
  "createdAt": "2021-04-20T10:00:00.000Z",
  "updatedAt": "2021-04-20T10:00:00.000Z",
  "variables": {
    "customer_name": "Michael"
  },
  "recordingUrl": "https://livekitmedia.blob.core.windows.net/recording-container-prod/room-ST_b88xWeWhaCVw-_+91XXXXXXXXXX_7d752295/recording.mp3",
  "agent": {
    "name": "New AI Agent",
    "agentId": "D5D0p7TUs66TTAEAx",
    "status": "active"
  }
}

Authorizations

​
X-API-Key
string
header
required

API Key is required in header. You can find it in the settings

Body

application/json

The body is of type any.

Response

OK

​
callId
string

A unique identifier for any call, whether inbound, outbound, or web-based.

Example:

"call-AuUKK371Spr5nHJS"

​
callType
enum<string>

Specifies the direction or type of the call.

Available options:
inbound, outbound, web
Example:

"inbound"

​
phoneNumber
object
​
campaign
object
​
status
enum<string>

Status of the call

Available options:
scheduled, in-progress, ended, not-connected, error
Example:

"ended"

​
startTime
string<date-time>

Timestamp indicating when the call began.

Example:

"2021-04-20T10:00:00.000Z"

​
endTime
string<date-time>

Timestamp indicating when the call ended.

Example:

"2021-04-20T10:00:00.000Z"

​
duration
integer<int32>

Total duration of the call in seconds.

Example:

120

​
terminationReason
enum<string>

Reason for call termination

Available options:
customer_ended_call, agent_ended_call, inactivity, voicemail, busy, no-answer, failed
Example:

"inactivity"

​
createdAt
string<date-time>

The timestamp when the call record was created.

Example:

"2021-04-20T10:00:00.000Z"

​
updatedAt
string<date-time>

The timestamp when the call record was last updated.

Example:

"2021-04-20T10:00:00.000Z"

​
variables
object

A set of dynamic key-value pairs required by the selected Agent. These variables allow personalization of the call, such as passing the customer’s name or other contextual details.

Example:
{ "customer_name": "Michael" }
​
recordingUrl
string

Recording URL of the call

Example:

"https://livekitmedia.blob.core.windows.net/recording-container-prod/room-ST_b88xWeWhaCVw-_+91XXXXXXXXXX_7d752295/recording.mp3"

​
agent
object

Assigned agent for current campaign