Description:
With this API, you will be able to obtain the report of the status of each record added to your WhatsApp campaign.
Benefit:
Perform a detailed monitoring of WhatsApp campaigns.
How it works:
- The consumption of this API is done via 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 header to utilize the authorization token.
- Please note that the same token cannot be consumed simultaneously, so you can schedule the next API consumption after the successful completion of the previous one.
- In terms of timing, for operational tracking, 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 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 |
campaign_id | Numeric identification of the campaign. It can receive the value “all” to obtain the report of all campaigns of the operation. | String |
date_ini | Start date (YYYYmmddHHiiss). | String |
date_end | End date (YYYYmmddHHiiss). | String |
Response
NAME | DESCRIPTION | TYPE |
---|---|---|
campaign_id | Campaign identification number. | String |
telephone | Customer’s phone number. | String |
status | Record status. It can yield the values “accepted,” “delivered,” “submitted,” and “failed” | String |
errors | Errors encountered when trying to contact the record. | String |
date | Date and time when the record was contacted. | String |
last_update | Last date the record was contacted. | String |