Saltar al contenido principal
POST
/
v1
/
call
Make Call
import requests

url = "http://localhost:3000/v1/call/"

payload = {
    "from_number": "<string>",
    "to_number": "<string>",
    "dynamic_variables": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "dialing",
  "type": "inbound",
  "contact": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_date": "2023-11-07T05:31:56Z",
    "identifier": "<string>",
    "contact_type": "call"
  },
  "phone_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_date": "2023-11-07T05:31:56Z",
  "recording_url": "<string>",
  "start_time": "2023-11-07T05:31:56Z",
  "end_time": "2023-11-07T05:31:56Z",
  "duration": 123,
  "end_reason": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
from_number
string
required

The phone number of the caller. You can use one of your phone numbers in E.164 format or the unique identifier of the phone number.

​
to_number
string
required

The phone number of the called party in E.164 format.

​
dynamic_variables
Dynamic Variables · object

A dictionary of dynamic variables to be substitute the variables in the prompt

Response

Successful Response

​
id
string<uuid>
required

The unique identifier for the call

​
agent_id
string<uuid> | null
required

The unique identifier for the agent that handled the call

​
status
enum<string>
required

The current status of the call

Opciones disponibles:
dialing,
in_progress,
completed,
failed,
transferred,
no_answer
​
type
enum<string>
required

The direction of the phone call

Opciones disponibles:
inbound,
outbound
​
contact
Contact · object
required

Details of the contact that initiated or received the call

​
phone_id
string<uuid> | null
required

The ID of the phone that was used to make or receive the call

​
created_date
string<date-time>
required

The date and time when the call was created

​
recording_url
string | null

The call recording URL.

​
start_time
string<date-time> | null

The start time of the call

​
end_time
string<date-time> | null

The end time of the call, if ended

​
duration
integer | null

The call duration in seconds. null if the call has not ended

​
end_reason
string | null

The reason for call termination, if the call has ended