Callback Requests

Creates a request for a callback for the specified phone number. Instead of waiting on hold in the queue when all agents are busy, the caller's place is held in the queue and their call is automatically returned when an agent becomes available. For more information on callback requests, see Understanding the end-user experience in the Talk Help Center. Callbacks don't need to be enabled on the phone number to create a callback request with the API.

Create Callback Request

POST /api/v2/channels/voice/callback_requests.json

Available parameters
Name Type Mandatory Comments
phone_number_id integer yes Talk phone number ID
requester_phone_number string yes Callback phone number in E.164 international number format
group_ids array[integer] no IDs of groups to route the call to
Allowed For
  • Agents
Rate Limit

You can create 30 callback requests every 10 minutes using this endpoint.

Using curl
curl https://{subdomain} \
  -d '{"callback_request": {"phone_number_id": 1001, "requester_phone_number": "+1234567890"}}' \
  -H "Content-Type: application/json" -X POST \
  -v -u {email_address}:{password}
Example Response
Status: 201 Created