Search
Close this search box.

< / >

Agent APIs

DTMF Dialing

URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/agentbox.php?agent_id={{agent_id}}&api=dtmf&tones={{dtmf_tones}}

Description:

This API allows you to send DTMF tones to the agent application phone in a simple and effective way.

Benefit:

By using this API, you get dialing automation, agent productivity optimization, and a smoother experience.

How does it work?

  • The consumption of this API is done through the POST method.
  • Replace {{wolkvox_server}} in the URL with the nomenclature of your operation on the server.
  • You must replace {{agent_id}} with the extension number of the agent assigned in the wolkvox system.
  • You must replace {{dtmf_tones}} with the number you want to send to the agent application phone.
  • You must use “wolkvox-token: {{token}}” in the HEADER and replace {{token}} with the authorization token generated in your wolkvox operation.
  • Please note that the same token cannot be consumed simultaneously, so you can program the next API to be consumed when the result of the previous one is successful.
  • The agent APIs v2 require an authentication token for access; however, the use of this token does not affect the assigned consumption. It is important to note that all other restrictions and limits set for API consumption remain applicable when using the agent v2 APIs.
  • Limit of records that can be downloaded per consumption: 60,000 records.
  • Limit of records that can be uploaded per consumption: 10,000 records.
  • Limit of days queried in dates: 31 days.
  • Limit of result weight: 256 MB.
  • API consumption time limit: 60 seconds.
  • Concurrent consumption limit of a token: 2 simultaneous requests.
  • Daily limit of tokens: Number of licenses multiplied by 1000 daily tokens.
  • Note: This API is compatible with both wolkvox Desktop Agent and web version.
REQUEST
NAMEDESCRIPTIONTYPE
tokenAuthorization token generated in the wolkvox Manager application.INT
wolkvox_serverServer nomenclature in which your operation is located. This code is provided by support staff.INT
agent_idAgent extension number assigned in the wolkvox system.INT
dtmf_tonesNumbers you want to send to the wolkvox Agent application phone.INT
RESPONSE
NAMEDESCRIPTIONTYPE
codeIndicate the status code of the response.String
errorProvides detailed information about any error that may occur during the execution of the API. The value “null” indicates that no errors occurred and that the execution of the API was successful.String
msgIt is an informative message that describes the response.String
dataIt contains the data or set of data obtained when consuming the API. In other words, it stores the specific information related to the operation carried out through the API.JSON Object
Possible response codes
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/agentbox.php?agent_id={{agent_id}}&api=dtmf&tones={{dtmf_tones}}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_HTTPHEADER => array(
    'wolkvox_server: {{wolkvox_server}}',
    'wolkvox-token: {{wolkvox-token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
			

RESPONSE

				
					{
    "code": "200",
    "error": null,
    "msg": "default",
    "data": "tones agentbox has been added "
}
				
			
We use cookies, if you continue browsing we will assume that you agree. You can read more about the use of cookies in our privacy policies and treatment of personal data