Create a Callback

post

https://api.talkdeskapp.com/schedule-callbacks

Creates a new scheduled callback and returns the created resource.
Use this endpoint to schedule a callback for a specific phone number with optional agent assignment and time scheduling.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Scope

schedule-callbacks:write

Body Params

Callback configuration parameters

interaction_id

string

required

length between 1 and 36

Id of the interaction

caller_id

string

required

length between 1 and 35

The number that will be shown as the caller

time_to_call

date-time

required

length between 1 and 35

The time the callback is scheduled

timezone

string

required

length between 1 and 100

The timezone in which the callback is scheduled

assign_type

string

enum

required

length between 1 and 50

Describes what assign type is this related to

Allowed:

from_call_type

string

enum

required

length between 1 and 50

Describes what call type is this related to

Allowed:

dialing_model

string

enum

required

length between 1 and 20

Describes what dialing model is this related to

Allowed:

queues

array of objects

Describes what queue is this related to

queues

agents

array of objects

agents

campaign_id

string

length between 1 and 36

The id of the campaign that originated this callback

record_id

string

length between 1 and 36

The id of the record that is scheduled to be called

record_list_id

string

length between 1 and 36

The id of the record list that is scheduled to be called

phone_number

string

required

length between 1 and 35

The phone number that is scheduled to be called

record_first_name

string

length between 1 and 200

First name of the record that is scheduled to be called

record_last_name

string

length between 1 and 200

Last name of the record that is scheduled to be called

record_extra_data

object

Extra Data from the record that is scheduled to be called

description

string

length between 1 and 2000

The callback note

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/hal+json

Scope

201Created a Callback

400Errors were found in the submitted data

401Unauthorized

403Forbidden