Search
Close this search box.

< / >

APIs Reports Manager

3. SMS – detail

URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/reports_manager.php?api=cdr_3&date_ini={{YYYYmmddHHiiss}}&date_end={{YYYYmmddHHiiss}}

Description:

This report provides detailed information on outbound messaging by SMS (text message) or WhatsApp indicating the channel used, telephone, destination, date of communication and message, as well as the numerical identification of the client and the agent.

Benefit:

This report allows to know the details of the communication by messaging (SMS – WhatsApp) including the text of the message sent.

How it works:

  • The consumption of this API is done by GET method.
  • 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.
  • In terms of time, to keep track of your operation you can make a consumption every 5 minutes of the information.
  • 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
api Type of report required String
date_ini Initial Date (YYYYmmddHHiiss) String
date_end Final Date (YYYYmmddHHiiss) String

Response

NAME DESCRIPTION TYPE
agent_id Refers to the numerical identification of the agent String
agent_name Agent’s name String
date Indicates the date with format year-month-day-time String
destiny Indicates the destination of the message String
telephone Indicates the phone number the message was sent to String
message It is the exact message that was sent by messaging (SMS – Apps). String
channel Channel used for message delivery. It can display the values “WhatsApp” (plus the type and identifier of the connector) for messages sent via WhatsApp and “SMS” if the text messaging tool was used. String
customer_id Corresponds to the customer’s identification number String
conn_id Corresponds to the call identification number String
Possible response codes

RESPONSE

				
					{
    "code": 200,
    "error": null,
    "msg": "1 records were found",
    "data": [
        {
            "agent_id": "",
            "agent_name": "",
            "date": "",
            "destiny": "",
            "telephone": "",
            "message": "",
            "channel": "",
            "customer_id": "",
            "conn_id": ""
        }
    ]
} 

				
			
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