ARGENTINA
Buenos Aires +54 (11) 5217 5933
BRAZIL
Sao Paulo +55 (11) 521 75 933
CHILE
Santiago de Chile +56 (2) 240 533 89
URL:
https://wv{{wolkvox_server}}.wolkvox.com/api/v2/reports_manager.php?api=agent_13_1&date_ini={{date_ini}}&date_end={{date_end}}
Description:
This API allows retrieving a complete detail of all phone interactions that have been transferred within the wolkvox system. It tracks all calls that have gone through multiple transfers or conferences, displaying their history and the different stages of communication.
It includes key information such as the transfer identifier, source and destination agent, call duration, and interaction type (incoming call, outgoing call, transfer, internal, etc.).
Benefits:
✅ Greater call traceability: Allows identifying all transfers and conferences of a call, making it easier to analyze complex interactions.
✅ Process optimization: Helps detect improvement points in the management of transferred calls, preventing unnecessary reprocessing.
✅ Monitoring and control: Facilitates tracking calls between agents and departments, ensuring better service management.
✅ Pattern identification: Enables analysis of transfer behaviors and their impact on the customer experience.
How it works?
The consumption of this API is done via the GET method.
To use this API, replace {{wolkvox_server}} in the URL with the appropriate server designation for the operation.
The request must include the wolkvox-token: {{token}} header to use the authorization token.
Please note that the same token cannot be consumed simultaneously. It is recommended to program the next API request only after the previous one has been successfully processed.
For operational tracking, the API can be queried every 5 minutes.
API Consumption Limits:
Code examples:
In our Postman workspace (click here to access), you have access to code examples that simplify integration with our APIs in various programming languages, such as cURL, Python, JavaScript, and more.
This feature is ideal for quick integrations and allows you to adapt API requests based on your system’s programming language.
How to use the code examples:
| NAME | DESCRIPTION | TYPE |
|---|---|---|
| api | required report type. | String |
| date_ini |
Start date and time of the query in YYYYMMDDHHMMSS format.
|
String |
| date_end |
End date and time of the query in YYYYMMDDHHMMSS format.
|
String |
| NAME | DESCRIPTION | TYPE |
|---|---|---|
| code |
Response status code. “200” indicates that the request was successful.
|
String |
| error |
If an error occurs in the query, the error message will be displayed here. If there are no errors, its value will be null.
|
String |
| msg |
Response message. Indicates how many records were found in the query.
|
String |
| data |
Contains the list of records obtained based on the date filter. If no data is available, this array will be empty ([]).
|
String |
| conn_id_transfer |
Unique identifier of the transferred call or conference.
|
String |
| skill_id |
Identifier of the skill associated with the call. It may be “-” if not applicable.
|
String |
| date |
Call date and time in YYYY-MM-DD HH:MM:SS format.
|
String |
| ani |
Origin phone number of the call.
|
String |
| origin_agent_id |
Identifier of the agent who made the transfer or conference.
|
String |
| origin_agent_name |
Name of the originating agent of the transfer or conference.
|
String |
| destiny_agent_id |
Identifier of the destination agent. If there is no destination agent, it will display “-“.
|
String |
| destiny_agent_name |
Name of the agent who received the transferred or conference call. It may be empty if there was no destination.
|
String |
| dnis |
Phone number to which the call was directed.
|
String |
| time |
Call duration in HH:MM:SS format.
|
String |
| type_call |
Type of phone interaction. The `”type_call”` field indicates the type of interaction performed and can take various values depending on its origin: `conference`: When the call involves multiple agents or users.
`inbound`: When it is an incoming call received from an external customer. `internal call`: When communication is between agents within the platform. `internal call_inb`: When the internal call is inbound, initiated from another extension or agent. `internal call_que`: When the call originates from a queue. `out_pre`: If the outbound call was generated through a predictive campaign. `outbound_ma`: If the call was manually made by an agent. `transfer`: If the call was transferred to another agent or destination within the platform. |
String |
| id_call_origin |
Identifier of the original call before being transferred or placed in a conference.
|
String |
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/reports_manager.php?api=agent_13_1&date_ini={{date_ini}}&date_end={{date_end}}',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => array(
'wolkvox-token: {{wolkvox-token}}'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
{
"code": "200",
"error": null,
"msg": "X records were found",
"data": [
{
"conn_id_transfer": "",
"skill_id": "",
"date": "",
"ani": "",
"origin_agent_id": "",
"origin_agent_name": "",
"destiny_agent_id": "",
"destiny_agent_name": "",
"dnis": "",
"time": "",
"type_call": "",
"id_call_origin": ""
},
{
"conn_id_transfer": "",
"skill_id": "",
"date": "",
"ani": "",
"origin_agent_id": "",
"origin_agent_name": "",
"destiny_agent_id": "",
"destiny_agent_name": "",
"dnis": "",
"time": "",
"type_call": "",
"id_call_origin": ""
}
]
}
Sao Paulo +55 (11) 521 75 933
Santiago de Chile +56 (2) 240 533 89
Medellín +57 (604) 322 98 80
Ciudad de Guatemala +502 (2) 3141344
Ciudad de México +52 (55) 8526 36 34
Copyright © 2023 MICROSYSLABS. 1820 N Corporate Lakes Blvd, unit 205. Weston, FL 33326
Copyright © 2023 MICROSYSLABS S.A.S.
Cra 30 # 4A – 45 Of. 205 Ed. FOREVER W&L, Medellín, Colombia