WHY WOLKVOX? OMNICHANNEL PLATFORM WOLKVOX CRM CHATBOTS AND VOICEBOTS MANUALS

COLOMBIA Medellín +57 (4) 322 98 80 Bogotá +57 (1) 381 90 40 Cali +57 (2) 891 28 46 Barranquilla +57 (5) 316 10 34 ARGENTINA Buenos Aires +54 (11) 5217 5933 SPAIN Madrid +34 (910) 601 691 MEXICO Ciudad de México +52 (55) 8526 36 34 BRASIL Brasilia +55 (61) 9836 4127 São Paulo +55 (12) 9811 155 83 UNITED STATES New York +1 (914) 373 71 36 DOMINICAN REPUBLIC Santo Domingo +1 (829) 249 69 68 CHILE Santiago de Chile +56 (2) 240 533 89 GUATEMALA Ciudad de Guatemala +502 (2) 314 1344 PERU Lima +51 (1) 644 91 39

2. Create agent

< / >

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_dni}}",
    "agent_name": "{{agent_name}}",
    "agent_sso": "{{agent_sso}}",
    "agent_pass": "{{agent_pass}}"
}',
  CURLOPT_HTTPHEADER => array(
    'wolkvox_server: {{wolkvox_server}}',
    'wolkvox-token: {{wolkvox-token}}',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
					curl --location --globoff 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/configuration.php?api=create_agent' \
--header 'wolkvox_server: {{wolkvox_server}}' \
--header 'wolkvox-token: {{wolkvox-token}}' \
--header 'Content-Type: application/json' \
--data '{
    "agent_dni": "{{agent_dni}}",
    "agent_name": "{{agent_name}}",
    "agent_sso": "{{agent_sso}}",
    "agent_pass": "{{agent_pass}}"
}'

				
					OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\r\n    \"agent_dni\": \"{{agent_dni}}\",\r\n    \"agent_name\": \"{{agent_name}}\",\r\n    \"agent_sso\": \"{{agent_sso}}\",\r\n    \"agent_pass\": \"{{agent_pass}}\"\r\n}");
Request request = new Request.Builder()
  .url("https://wv{{wolkvox_server}}.wolkvox.com/api/v2/configuration.php?api=create_agent")
  .method("POST", body)
  .addHeader("wolkvox_server", "{{wolkvox_server}}")
  .addHeader("wolkvox-token", "{{wolkvox-token}}")
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();

				
					import requests
import json

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

payload = json.dumps({
  "agent_dni": "{{agent_dni}}",
  "agent_name": "{{agent_name}}",
  "agent_sso": "{{agent_sso}}",
  "agent_pass": "{{agent_pass}}"
})
headers = {
  'wolkvox_server': '{{wolkvox_server}}',
  'wolkvox-token': '{{wolkvox-token}}',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

RESPONSE

				
					{
    "code": 201,
    "error": null,
    "msg": "Agent has been created",
    "data": [
        {
            "agent_id": "",
            "password": ""
        }
    ]
}

APPLICATIONS

MULTICHANNEL DIALER

WOLKVOX STUDIO

ARTIFICIAL INTELLIGENCE

VOICE OF THE CUSTOMER

QUALITY AND PRODUCTIVITY

ANALYTICS

TELEPHONY

INTEGRATIONS

BY INDUSTRY

BY COMPANY TYPE

SMART TEAMS

AUTOMATION AND ARTIFICIAL INTELLIGENCE

DIGITAL TRANSFORMATION

APPLICATIONS

MULTICHANNEL DIALER

WOLKVOX STUDIO

ARTIFICIAL INTELLIGENCE

VOICE OF THE CUSTOMER

QUALITY AND PRODUCTIVITY

ANALYTICS

TELEPHONY

INTEGRATIONS

BY INDUSTRY

BY COMPANY TYPE

SMART TEAMS

AUTOMATION AND ARTIFICIAL INTELLIGENCE

DIGITAL TRANSFORMATION

< / >

APIs Reports Manager

2. Create agent

Request

Response

RESPONSE

UNITED STATES

ARGENTINA

BRAZIL

CHILE

SPAIN

COLOMBIA

GUATEMALA

MEXICO

DOMINICAN REPUBLIC

PERU

AUTOMATION AND
ARTIFICIAL INTELLIGENCE

AUTOMATION AND
ARTIFICIAL INTELLIGENCE