patch https://api.talkdeskapp.com/schedule-callbacks/
Body Parameters
The body parameters are part of an array.
Scope
schedule-callbacks:write
Body Schema - Response
Body Response - Example
[
{
"op": "replace",
"path": "/timeToCall",
"value": "2022-02-10T09:39:19Z"
},
{
"op": "replace",
"path": "/phoneNumber",
"value": "+8613036130259"
},
{
"op": "replace",
"path": "/timezone",
"value": "Asia/Shanghai"
},
{
"op": "replace",
"path": "/assignType",
"value": "SPECIFIC_AGENT"
},
{
"op": "replace",
"path": "/agents",
"value": [
"6af3b4f4-c962-4c37-80bd-bfec579bfd2c",
"0957ff2e-6e8b-42d3-9c4a-d7cf1b013aa7"
]
}
]
200 OK (return the updated callback)
| Parameter | Type | Description | Required |
|---|---|---|---|
| callback_id | string | ID of the callback | yes |
| interaction_id | string | the interaction ID of where the callback originates from | no |
| caller_id | string | the number that will be shown as the caller | no |
| scheduled_time_to_call | string | the time the callback is scheduled | no |
| timezone | string | the timezone in which the callback is scheduled | no |
| assign_type | string | Describes what assign type this is related to. The type of the assignee needs to be consistent with the callback assignment configuration. Default allowed values: MYSELF_ONLY, SPECIFIC_AGENT, SPECIFIC_RING_GROUP, MYSELF_IF_AVAILABLE, ANY_ELIGIBLE_AGENT | no |
| from_call_type | string | Describes what call type is this related to. Allowed values: INBOUND, MANUAL_OUTBOUND, PROACTIVE_OUTBOUND | no |
| dialing_model | string | Describes what dialing model is this related to. Allowed values: PREDICTIVE, PREVIEW | no |
| ring_groups | array[object] | Describes what ring group is this related to. Subdivides into: "ring_group" (string). Required. | no |
| agents | array[object] | Subdivides into: "agent_id" (string). Required. | no |
| campaign_id | string | the campaign ID of where the callback originates from | no |
| record_id | string | the ID of the record list where the record comes from | no |
| record_list_id | string | the ID of the record list that is scheduled to be called | no |
| phone_number | string | the phone number that is scheduled to be called | no |
| record_first_name | string | first name of the record that is scheduled to be called | no |
| record_last_name | string | last name of the record that is scheduled to be called | no |
| record_extra_data | object | extra data from the record that is scheduled to be called | yes |
| next_time_to_call | string | the next time the callback will be retried | no |
| status | string | The status of callback. Allowed values: UNATTEMPTED, TO_BE_RETRIED, EXHAUSTED, SUCCESS, CANCELED, INVALID_NUMBER | no |
| _links | object | "_links" subdivides into: 1 - "self" (object) - the link to the current page. Required. 1.1 - "href" (string). Required. | no |
400 (errors were found in the submitted data), 401 (unauthorized), 403 (forbidden), 404 (callback not found)
| Parameter | Type | Description | Required |
|---|---|---|---|
| code | string | n/a | yes |
| message | string | n/a | yes |
| description | string | n/a | no |
| fields | array[object] | "fields" subdivides into: "name" (string) "description" (string) | yes (name and description) |
API Availability
The Scheduled Callback Management API is only available for customers enrolled in Talkdesk's Early Access (EA) program.
To enter the EA program, contact a Customer Sucess Manager.
The Scheduled Callback Management API has been in GA since March 2022.
Troubleshooting
If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.