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

13. Edit agent

< / >

APIs

13. Edit agent

URL:

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

Description:

This API allows you to update or edit an agent’s information.

Benefit: Optimize processes and time by editing agent information from external solutions.

Type of request:

PUT

How it works:

The consumption of this API is done by PUT 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.
The wolkvox-token header must be used to make use of the authorization token.
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 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 software.
The field for assigning a password “agent_pass”: “” can remain empty, and the system will assign a random password.
The password must have 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_id	Refers to the numerical identification	String
agent_dni	Agent’s identification document number.	String
agent_name	Agent’s Name.	String
agent_sso	Single Sign-On (SSO) is an optional feature that allows users to log in to the system using their existing authentication credentials, without the need to provide separate login information for our software.	String
agent_pass	Password you want to assign to the agent.	String

Response

NAME	DESCRIPTION	TYPE
code	Response code	int
error	Error	String
msg	Description of the response	String

Possible response codes

				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/configuration.php?api=edit_agent&agent_id={{agent_id}}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'PUT',
  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 --request PUT 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/configuration.php?api=edit_agent&agent_id={{agent_id}}' \
--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=edit_agent&agent_id={{agent_id}}")
  .method("PUT", 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=edit_agent&agent_id={{agent_id}}"

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("PUT", url, headers=headers, data=payload)

print(response.text)

RESPONSE

				
					{
    "code": 202,
    "error": null,
    "msg": "agent has been updated"
}

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

13. Edit agent

Request

Response

RESPONSE

UNITED STATES

ARGENTINA

BRAZIL

CHILE

SPAIN

COLOMBIA

GUATEMALA

MEXICO

DOMINICAN REPUBLIC

PERU

AUTOMATION AND
ARTIFICIAL INTELLIGENCE

AUTOMATION AND
ARTIFICIAL INTELLIGENCE