Transactional API
Description
Transactional APIs are used when you want to push individual records to Ryng as they qualify within your system. Using transactional API ensures that each record is treated separately and you get a callback when the call-activity is complete on Ryng.
Typical use-cases:
Push a lead as they sign up via your landing page
Push a contact from CRM when they are moved to a particular stage
Push a contact from your support portal when ticket is raised
URL
https://<subdomain>.ryng.in/rest-api/v1/progressive/queue/<queueID>/transactional
Replace
<subdomain>with your account subdomain.Replace
queueIDwith your queue ID.
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.
Body
Type: json
agentMapping
String
Specify how agents should be assigned to queue calls • global - The agents to be assigned will be defined (by username) in the agents parameter • inline - Agents to be assigned for calls are fetched from the agentsAssigned parameter within jsonData • all-agents - (default) All agents are available to be assigned for queue calls
agents
Array of Strings
Specify one or more agent usernames amongst whom the leads/customers should be assigned in a round robin fashion
Yes - if agentMapping set to implicit
legDirection
String
Should we connect to the agent first, or the customer?
maxRetries
Number
Maximum number of retries to be made to customers who are unreachable or busyDefault setting fetched from queue if not specified
No
retryInterval
Number
Minimum interval (in minutes) between retries for unreachable customersDefault setting fetched from queue if not specified
No
maxDispose
Number
Time allotted (in seconds) for disposing a call before the next call is initiatedDefault setting fetched from queue if not specified
No
customerData
Object
Contains customer data to be uploaded to queue. Check CUSTOMER DATA EXAMPLES section for examples • 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. Format of the callback is given here. The API expects to receive a 200 OK response from the callback URL endpoint upon successful receipt of callback. On any non-200 response, Ryng will retry the callback at 1 minute intervals up to two more times. • connectCallbackUrl - (string) Optional URL endpoint to trigger a callback whenever an individual call (customer) is assigned to an agent. A single callback will be sent as a POST request to this endpoint each time a call is assigned to an agent. The callback will contain all metadata for that particular call in the body, the format of which is given below. The API expects to receive a 200 OK response from the callback URL endpoint. On any non-200 response, Ryng will retry the callback after a 1 minute interval one more time. • jsonData - (json) Call data is specified as an array of call objects Fields: → number - (Required) (String) Customer number to call for a given call → priority - (Number) Number based priority of the call. Bigger the number, higher the priority → agentsAssigned - (Array of Strings) Comma separated list of assignable agents to a specific call → customField{Number} - (ex. customField1) (String) Custom field values for a given
Example Body
API Responses
Transactional API
POST https://tenant.ryng.in/rest-api/v1/progressive/queue/:queueID/transactional
Headers
x-access-token*
String
Terminal Callback Body Example
Connect Callback Body Example
Last updated