Callback API Parameters
Parameters are optional unless otherwise noted.
|
Parameter |
Description |
Notes |
|---|---|---|
|
title |
The name of the callback request. |
Required for POST and GET (create). |
|
name |
The person who generated the callback request. |
Required for POST and GET (create). The name is limited to a maximum of 100 characters. A newline (\n) is not allowed in the name. |
|
mediaAddress |
The phone number to call. |
Required for POST and GET (create). |
|
description |
An optional description to accompany the callback request. | |
|
tags |
One or more tags or keywords associated with the contact. |
To include tags when using GET to create a callback contact, use the parameter 'tags' in the query string. |
|
variables |
A set of custom name and value pairs. |
When using GET to create a callback, variables must be passed as query parameters and start with 'variable_'. |
|
status |
The status of a callback request. |
See "Contact State" in GET. |
|
estimatedWaitTime |
An estimate of the amount of time (in seconds) until an agent's phone will be available to place the call. | If CCE does not have enough data to calculate estimatedWaitTime, the API returns a value of -1. |