Skip to main content
POST
/
v1
/
schedule-call
Schedule Call
curl --request POST \
  --url https://api.telli.com/v1/schedule-call \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agent_id": "<string>",
  "max_retry_days": 123,
  "override_from_number": "<string>",
  "schedule": {
    "at": "2024-01-01T10:00:00.000Z",
    "ignore_dialing_window": false
  }
}
'
{
  "status": "success",
  "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "loop_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
Authorization
string
header
required

API key must be provided as: Bearer <api_key>

Body

application/json
​
contact_id
string<uuid>
required

telli contact ID of the contact to schedule a call with

​
agent_id
string
required

Agent ID to use for the call

​
max_retry_days
number

Optional number of days to retry the call. Defaults to the account's max retry days

​
override_from_number
string

Optional phone number to use as the caller ID. Must be a valid E.164 number that belongs to the account

​
schedule
object

Optional schedule configuration. Use to schedule a call at a specific time, and optionally to bypass dialing window restrictions. Setting a schedule will override any existing schedule for the contact and agent.

Response

Call scheduled successfully

​
status
string
Example:

"success"

​
contact_id
string<uuid>
​
loop_id
string<uuid>