Request a CallBack Now

Introduction

Description: This API allows requesting the CX platform to initiate an outbound call to a specific destination. When answered by the destination, it will be treated as a regular Inbound Queue Call, waiting in the Queue to be assigned to an agent.

Notes:

  • This API does not behave as the CallBack functionality available for callers when waiting on a Queue.

  • In-queue CallBack functionality is not available to outbound calls queued using the CallBack Now API.

scope: cx.queue-calls

API Request

curl -XPOST --location 'https://cpaas.sangoma.com/cx/api/v1/queues/call/' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --header 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \ --data '{ "queue_name": "queue_test", "destination": "9001", "tenant_domain": "acme.cx.sangoma.com" }'

Note: Replace <YOUR_ACCESS_TOKEN> with your Access Token obtained from the Requesting Access Token authentication step detailed in API Authentication .

This API call will enable the specified Queue (queue_name) within the tenant_domain to make calls to the provided destination.

Return to Documentation Home I Return to Sangoma Support