Search
Close this search box.
Search
Close this search box.

< / >

APIs Reports Manager

2. Create agent

URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/configuration.php?api=create_agent

Description:

This API allows the creation of new agents from external solutions, parameterizing the name, identification and network user, information required for logging.

Benefit:

Optimize processes and time by creating external solution agents in an agile and simple way.

How it works:

  • The consumption of this API is done by POST method.
  • In the json the parameters are added according to the operation or process to be performed.
  • To consume this API you must replace in the url {{{wolkvox_server}} by the nomenclature of the server of the operation.
  • You should use the header “wolkvox-token: {{token}}” to make use of the authorization token.
  • Please note that the same token cannot be consumed simultaneously. Therefore, you can schedule the next API to be consumed when the result of the previous one is successful.
  • The field “agent_sso” is optional and allows users to log in to the system using their existing authentication credentials, without the need to provide separate login information for our call and contact center software.
  • The field to assign a password “agent_pass”: “” can remain empty, and the system will assign a random password.
  • The password must contain at least one uppercase letter, one lowercase letter, one number, and one special character (!#%&*@).
  • 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.

Request

NAME DESCRIPTION TYPE
agent_dni Agent’s personal identification number String
agent_name Agent name String
agent_sso Network user for single sign on function String
agent_pass Password you want to assign to the agent String

Response

NAME DESCRIPTION TYPE
agent_id Refers to the agent’s numeric ID String
password Agent password String
Posibles códigos de respuesta
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/configuration.php?api=create_agent',
  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_POSTFIELDS =>'{
    "agent_dni": "",
    "agent_name": "",
    "agent_sso": "",
    "agent_pass": ""
}',
  CURLOPT_HTTPHEADER => array(
    'wolkvox-token: {{token}}',
    'Content-Type: text/plain'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
			

RESPONSE

				
					{
    "code": 201,
    "error": null,
    "msg": "Agent has been created",
    "data": [
        {
            "agent_id": "",
            "password": ""
        }
    ]
}
				
			
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