delete
https://api.talkdeskapp.com/schedule-callbacks/
Importing the time off balance.
Scope
schedule-callbacks:write
- Schedule a callback or reschedule a callback
Response Example
{
{
"callback_id": "2da8a248-4b77-463e-9a36-d724f5792971",
"account_id": "6142f79f738eb0e4a44b18c4",
"interaction_id": "03e5c6f0-53c5-4b76-86ef-8d89ac67cdc6",
"caller_id": "+155598754214",
"scheduled_time_to_call": "2021-03-24T11:48:40.500Z",
"timezone": "Europe/Lisbon",
"preferred_start_time": "2000-01-01T12:00:00.000Z",
"preferred_end_time": "2000-01-01T18:00:00.000Z",
"processed_time": "2021-03-24T11:48:40.500Z",
"created_at": "2021-03-24T11:40:40.500Z",
"created_by": "Chandler",
"contact_id": "4028814076d8250c0176d826d90f0000",
"root_interaction_id": "13e5c6f0-53c5-4b76-86ef-8d89ac67cdc2",
"teams": [
{
"team_id": "5b34eb0cdcba1b000bdbd321"
}
],
"assign_type": "MYSELF_ONLY",
"from_call_type": "PROACTIVE_OUTBOUND",
"dialing_model": "PREDICTIVE",
"ring_groups": [
{
"ring_group": "61935f5904147e334756017d"
}
],
"agents": [
{
"agent_id": "5252g4504147e334756017d"
}
],
"campaign_id": "8c86a8f4-da30-41ac-a09d-148e7690c330",
"record_id": "2b56abbb-1bb2-40de-9b88-243a4773b518",
"record_list_id": "c9798bc0-4f5d-474f-afb7-88bf6e543c94",
"phone_number": "+351910000000",
"record_first_name": "Chandler",
"record_last_name": "Bing",
"next_time_to_call": "2023-03-24T11:48:40Z",
"status": "UNATTEMPTED",
"record_extra_data": {
"job": "statistical analysis and data reconfiguration.",
"address": "Apartment #19 in Greenwich Village, Manhattan"
},
"_links": {
"self": {
"href": "https://api.talkdeskapp.com/callbacks/2da8a248-4b77-463e-9a36-d724f5792971"
}
}
}
204 (no content)
The request was successful, and there is no representation to return (i.e., the callback was successfully canceled).
401 (unauthorized)
| Parameter | Type | Description | Required |
|---|---|---|---|
| code | string | Internal error reference code. | yes |
| message | string | Summary of the error. | yes |
| description | string | Detailed error explanation regarding invalid or missing credentials. | no |
| fields | array[object] | "fields" subdivides into: "name" (string) "description" (string) | yes (name and description) |
403 (forbidden)
| Parameter | Type | Description | Required |
|---|---|---|---|
| code | string | Internal error reference code. | yes |
| message | string | Summary of the error. | yes |
| description | string | Detailed error explanation indicating missing scopes or permissions. | no |
| fields | array[object] | "fields" subdivides into: "name" (string) "description" (string) | yes (name and description) |
404 (not found)
| Parameter | Type | Description | Required |
|---|---|---|---|
| code | string | Internal error reference code. | yes |
| message | string | Summary of the error (e.g., Callback not found). | yes |
| description | string | Detailed error explanation stating the resource does not exist. | no |
| fields | array[object] | "fields" subdivides into: "name" (string) "description" (string) | yes (name and description) |
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.