Search
Close this search box.

< / >

Agent APIs

Transfer call

URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/agentbox.php?api=transfer&agent_id={{agent_id}}&customer_phone={{customer_phone}}

Description:

This API allows transferring the current call from the agent to a phone number or another agent.

Benefit:

By using this API, you gain flexibility in transfer, resource optimization, improved customer experience, and increased agent control.

How it works?

  • 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 from whom you want to transfer the call.
  • You must replace {{customer_phone}} with the phone number or extension of the agent to whom you want to transfer the call. In other words, you can transfer the call to another agent or to a phone number of your choice.
  • Use ‘wolkvox-token: {{token}}’ in the HEADER and replace {{token}} with the authorization token generated in your wolkvox operation.
  • Note that the same token cannot be consumed simultaneously, so you can schedule 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
NAME DESCRIPTION TYPE
token Token code generated in the Wolkvox Manager application. INT
wolkvox_server Server nomenclature where your operation is located. This code is provided by support personnel. INT
agent_id Agent extension number assigned in the wolkvox system from which you want to transfer the call. INT
customer_phone It is the phone number or extension of the agent to whom you want to transfer the call. INT
RESPONSE
NAME DESCRIPTION TYPE
code Indicates the status code of the response. String
error Provides detailed information about any errors that may occur during the execution of the API. The value ‘null’ indicates that no errors occurred, and the API execution was successful. String
msg Is an informative message that describes the response. String
data Contains the data or dataset obtained when consuming the API. In other words, it stores specific information related to the operation performed through the API. JSON Object
conn_id Call identification code. String
Possible response codes
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/agentbox.php?api=transfer&agent_id={{agent_id}}&customer_phone={{customer_phone}}',
  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": "Call has been transfer to X number",
    "data": {
     "conn_id": ""
    }
}
				
			
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