• REST
  • Java
Get SDK

Create Scheduled Callback

API Docs by APIMATIC
API EndpointsScheduled Callback

Create Scheduled Callback
#

Enables agents to create a scheduled callback from a third-party application, such as a CRM, via the API. Agents are identified by their email in the agent field.

POST /api/task/v1/scheduled_callbacks

API Code Playground

Endpoint Arguments
Parameters
Required
Required
String
Header

The Contact Center API key.

body
Required
Scheduled Callback
Body
Required
String

Contact phone number for callback

Required
String

Agent username(email) used for sign-in

String

Customer's IANA time zone. If not provided, Agent's time zone is set by default

Required
DateTime

Desired date and time, within 30 days, 08:00-22:00, 30-min intervals, 00 seconds in iso8601 format

String

Agent's context notes, with a maximum of 64 characters for adding relevant information

String

CID group label that will be applied to this callback. If not provided, the Default CID Group is set by default

UUID

The UUID of the call from which the callback was scheduled

String

Foreign Key to CRM record of contact

String

CRM name

Responses

  • 201
  • 401
  • 403
  • 422
  • 429

All parameters are valid and the Scheduled Callback was created

application/json

Type

Scheduled Callback Created

{
  "id": 1
}

Was this page helpful?

Thank you! Your feedback has been received.
  • REST
  • Java
  • Request
  • Response
curl -X POST \
  --url 'https://{cluster_id}.voiso.com/api/task/v1/scheduled_callbacks'  \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer token: Authorization: Bearer token6' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "contact_number": "1234567890",
  "agent": "agent@email.com",
  "time_zone": "Asia/Almaty",
  "scheduled_time": "2024-01-01T10:00:00Z",
  "context_notes": "Customer was busy, asked to callback later",
  "cid_group": "CID group for Abc region",
  "related_call_id": "046296f8-ac21-4c02-a85d-92a6578dd2ea",
  "external_contact_id": "2",
  "external_system_id": "Abc CRM"
}'