8. Real-time chat report - Wolkvox

< / >

APIs

8. Real-time chat report

URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/real_time.php?api=chats

Description:

This report provides complete and real-time information of all chats that are active in your operation at the time of the query.

Benefit:

It allows administrators to monitor and manage interactions in real time, ensuring that agents are responding promptly and effectively, which improves operational efficiency and customer satisfaction.

How does it work?

This API is consumed using the GET method.
To consume this API, you must replace {{wolkvox_server}} in the URL with the server nomenclature of the operation.
You must use the wolkvox-token: {{token}} header to use the authorization token.
Please note that the same token cannot be consumed simultaneously, so you can program the next API to be consumed when the result of the previous one is successful.
In terms of time, to track your operation, you can consume the information every 5 minutes.
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 consulted in dates: 31 days.
Limit of result weight: 256 MB.
Limit of API consumption time: 60 seconds.
Limit of simultaneous consumption of a token: 2 simultaneous requests.
Daily token limit: Number of licenses multiplied by 1000 tokens per day.

Request

NAME	DESCRIPTION	TYPE
api	Type of report required.	String

Response

NAME	DESCRIPTION	TYPE
agent_id	Agent extension number.	String
active_chats	Agent’s active chats.	String
conn_id	Chat identification number.	String
channel	Type of channel where the chat is happening.	String
connector_id	WhatsApp connector identification number.	String
customer_phone	Customer’s phone number.	String
conversation	Dataset about a message sent in the conversation.	String
from	Indicate who sent the message.	String
msg	Message sent by the sender.	String
date	Date the message was sent.	String

Possible response codes

				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/real_time.php?api=chats',
  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;

				
					curl --location --globoff 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/real_time.php?api=chats' \
--header 'wolkvox-token: {{wolkvox-token}}'

				
					OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("https://wv{{wolkvox_server}}.wolkvox.com/api/v2/real_time.php?api=chats")
  .method("GET", body)
  .addHeader("wolkvox-token", "{{wolkvox-token}}")
  .build();
Response response = client.newCall(request).execute();

				
					import requests

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

payload = {}
headers = {
  'wolkvox-token': '{{wolkvox-token}}'
}

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

print(response.text)

RESPONSE

				
					{
    "code": "200",
    "error": null,
    "msg": "x records were found",
    "data": [
        {
            "agent_id": "",
            "active_chats": [
                {
                    "conn_id": "",
                    "channel": "",
                    "connector_id": "",
                    "customer_phone": "",
                    "conversation": [
                        {
                            "from": "",
                            "msg": "",
                            "date": ""
                        }
                    ]
                },
                {
                    "conn_id": "",
                    "channel": "",
                    "connector_id": "",
                    "customer_phone": "",
                    "conversation": [
                        {
                            "from": "",
                            "msg": "",
                            "date": ""
                        }
                    ]
                }
            ]
        },
        {
            "agent_id": "",
            "active_chats": [
                {
                    "conn_id": "",
                    "channel": "",
                    "connector_id": "",
                    "customer_phone": "",
                    "conversation": [
                        {
                            "from": "",
                            "msg": "",
                            "date": ""
                        }
                    ]
                }
            ]
        }
    ]
}

wolkvox
worldwide

UNITED STATES

Atlanta, GA +1 (470) 447-2610
Miami, FL +1 (470) 447-2610

ARGENTINA

Buenos Aires +54 (11) 5217 5933

BRAZIL

Sao Paulo +55 (11) 521 75 933

CHILE

Santiago de Chile +56 (2) 240 533 89

SPAIN

Madrid +34 (910) 601 691

COLOMBIA

Medellín +57 (604) 322 98 80

GUATEMALA

Ciudad de Guatemala +502 (2) 3141344

MEXICO

Ciudad de México +52 (55) 8526 36 34

DOMINICAN REPUBLIC

Santo Domingo +1 (829) 249 69 68

PERU

Lima +51 (1) 644 91 39

|

Information security policy

|

|

Information Transfer Policies

Copyright © 2023 MICROSYSLABS. 1820 N Corporate Lakes Blvd, unit 205. Weston, FL 33326

Nosotros

OMNICHANNEL PLATFORM

CHATBOTS AND VOICEBOTS

wolkvox worldwide

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

Information security policy

Information Transfer Policies

Copyright © 2023 MICROSYSLABS S.A.S.
Cra 30 # 4A – 45 Of. 205 Ed. FOREVER W&L, Medellín, Colombia