API reference
ScheduledCall
The ScheduledCall object.
| Field | Type | Description |
|---|---|---|
agent_id |
string (uuid) | |
agent_version |
integer or null | The published version it will be answered with, when the request pinned one. |
call_window |
CallWindow or null | |
conversation_id |
string (uuid) or null | The conversation, once it is placed. |
created_at |
string (date-time) | |
dial_at |
string (date-time) | When it will be placed — already moved into its window, if it has one. |
error |
string or null | |
error_code |
string or null | Why it was refused at its time — the code POST /v1/calls would answer. |
external_id |
string or null | |
finished_at |
string (date-time) or null | |
from_number_id |
string (uuid) or null | |
id |
string (uuid) | |
language |
string or null | |
livemode |
boolean | |
metadata |
object | |
object |
scheduled_call |
|
project_id |
string (uuid) | |
status |
string | scheduled until its time; placed once it became a conversation; cancelled if you called it off; failed if it was refused at its time. One of: scheduled, placed, cancelled, failed. New words may be added. |
to_number |
string | |
variables |
object |