POST
/
call
cURL
curl --request POST \
  --url https://api.altur.io/api/v1.0/call \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "agent_id": "<string>",
  "phone_number_to": "<string>",
  "end_user_display_name": "<string>",
  "end_user_context": "<string>",
  "initial_message": "<string>"
}'
{
  "id": "<string>",
  "thread": {
    "id": "<string>",
    "agent": {
      "id": "<string>",
      "name": "<string>"
    },
    "end_user": {
      "id": "<string>",
      "display_name": "<string>",
      "integration_type": "api",
      "info": "<string>"
    },
    "integration": {
      "id": "<string>",
      "type": "api"
    },
    "updated_at": "2023-11-07T05:31:56Z",
    "active": true,
    "blocked": true,
    "tags": [
      {
        "id": "<string>",
        "name": "<string>",
        "color": "blue"
      }
    ],
    "assigned_to": [
      {
        "id": "<string>",
        "email": "<string>",
        "first_name": "<string>",
        "last_name": "<string>"
      }
    ]
  },
  "type": "inbound",
  "status": "created",
  "answered_by": "human",
  "created_at": "2023-11-07T05:31:56Z",
  "started_at": "2023-11-07T05:31:56Z",
  "ended_at": "2023-11-07T05:31:56Z",
  "duration": 123,
  "billable_duration": 123
}

Authorizations

Authorization
string
header
required

Add api-key YOUR_API_SECRET_KEY as the value of the Authorization header.

Body

application/json
agent_id
string<uuid4>
required

Unique identifier of the Agent that will participate in the Call (formerly Chatbot or Assistant)

phone_number_to
string<e164>
required

E.164 formatted phone number of the EndUser to call

end_user_display_name
string

Display name of the EndUser to call

end_user_context

Context of the EndUser to call

initial_message
string

Initial message the Agent will say upon the call being answered

Response

Call response

id
string

Unique identifier for the Call

thread
object
type
enum<string>

Type of the Call

Available options:
inbound,
outbound
status
enum<string>

Status of the Call

Available options:
created,
queued,
ringing,
in-progress,
forwarding,
ended,
busy,
no-answer,
failed
answered_by
enum<string>

Who or what answered the Call

Available options:
human,
machine,
unknown
created_at
string<date-time>

Datetime from when the Call was created

started_at
string<date-time>

Datetime from when the Call was started

ended_at
string<date-time>

Datetime from when the Call was ended

duration
integer

Duration of the Call in seconds

billable_duration
integer

Billable duration of the Call in seconds