Update a Callback

Scope

schedule-callbacks:write

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"
    }
  }
}

Body Response - Schema

200 OK

Parameter	Type	Description
callback_id	string	Id of the callback. Required.
account_id	string	Id of the account.
interaction_id	string	The interaction id of where the callback originates from.
caller_id	string	The number that will be shown as the caller.
scheduled_time_to_call	string	The time the callback is scheduled.
timezone	string	The timezone in which the callback is scheduled.
preferred_start_time	string	The started preferred time window on the preview screen.
preferred_end_time	string	The ended preferred time window on the preview screen.
processed_time	string	The time to process the callback.
created_at	string	The time to create the callback.
created_by	string	The user who created the callback.
contact_id	string	The contact id.
root_interaction_id	string	The root interaction id.
teams	array[object]	"teams" subdivides into: 1 - "team_id" (string) - Required.
assign_type	string	Allowed values: MYSELF_ONLY, SPECIFIC_AGENT, SPECIFIC_RING_GROUP, MYSELF_IF_AVAILABLE, ANY_ELIGIBLE_AGENT.
from_call_type	string	Allowed values: INBOUND, MANUAL_OUTBOUND, PROACTIVE_OUTBOUND.
dialing_model	string	Allowed values: PREDICTIVE, PREVIEW.
ring_groups	array[object]	"ring_groups" subdivides into: 1 - "ring_group" (string) - Required.
agents	array[object]	"agents" subdivides into: 1 - "agent_id" (string) - Required.
campaign_id	string	The campaign id of where the callback originates from.
record_id	string	The id of the record list where the record comes from.
record_list_id	string	The id of the record list that is scheduled to be called.
phone_number	string	The phone number that is scheduled to be called.
record_first_name	string	First name of the record.
record_last_name	string	Last name of the record.
record_extra_data	object	Extra Data from the record.
next_time_to_call	string	The next time the callback will be retried.
status	string	Allowed values: UNATTEMPTED, TO_BE_RETRIED, EXHAUSTED, SUCCESS, CANCELED, INVALID_NUMBER.
_links	object	"_links" subdivides into: 1 - "self" (object) - Link to the resource.

400 (bad request), 401 (unauthorized), 403 (forbidden), 404 (not found)

Parameter	Type	Description	Required
code	string	Internal error reference code.	yes
message	string	Summary of the error.	yes
description	string	Detailed error explanation.	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.

Scope

Response Example

Body Response - Schema

200 OK

400 (bad request), 401 (unauthorized), 403 (forbidden), 404 (not found)

🚧Troubleshooting

🚧
Troubleshooting