Make Preview Call
URL
https://<subdomain>.ryng.in/rest-api/v1/preview/call
Replace
<subdomain>with your account subdomain.
Method
POST
Headers
x-access-token
The access token is provisioned for you by Ryng. If you do not have this already, please reach out to your Ryng project champion. Alternatively, you can raise a request on our support portal.
Params
For this API, params are either added by query params or can be given inside the request body
Type: query params/body
agentID
int
Agent to be assigned for the call
Yes
campaignID
int
The campaign to which the campaign is added
Yes
customerName
text
Name of the customer to be called
No
terminalCallbackUrl
string
Optional URL endpoint to receive callbacks on the terminal state of each call (i.e., each row of customer data) in this request. One callback will be sent per call. The callback will contain all metadata and disposition details for that particular call and will be sent as a POST request to this endpoint. The format of the callback is given below. The API expects to receive a 200 OK response from the callback URL endpoint upon successful receipt of the callback. On any non-200 response, Ryng will retry the callback at 1-minute intervals up to two more times.
No
connectCallbackUrl
string
Optional URL endpoint to receive callbacks on the terminal state of each call (i.e., each row of customer data) in this request. One callback will be sent per call. The callback will contain all metadata and disposition details for that particular call and will be sent as a POST request to this endpoint. The format of the callback is given below. The API expects to receive a 200 OK response from the callback URL endpoint upon successful receipt of the callback. On any non-200 response, Ryng will retry the callback at 1-minute intervals up to two more times.
No
Example Body
{
"agentID": 7,
"campaignID": 595,
"customerNumber": "+91XXXXXXXX85",
"customerName": "Joe"
}API Responses
Append Campaign API
POST https://tenant.ryng.in/rest-api/v1/preview/call
Headers
x-access-token*
Provided by Ryng Team
Connect Callback Body Example
Terminal Callback Body Example
Last updated