Developer Docs
OVERVIEW
RCS
SMS / 2Way SMS API
Number Intelligence
Balance
Contacts
Senders
Lists
Stoplists
Statistics
Request to download statistics
To download statistics, make a request to this URL:
| GET https://api.bsg.world/rest/stat/create |
Request body
1. One of the following mandatory parameters is passed:
- message_id – set to “message_id”. If this value is set, all subsequent fields are ignored, even if data is specified there. Array. 300 values in an array maximum. If an empty array is specified, or if there is a parameter, but the key is not an array, then the parameter is ignored.
OR a time span:
- time_in_from — date and time when messages were received on the platform.
- time_in_to — date and time when messages were received on the platform.
2. Optional parameters are passed:
| Parameter | Type | Description |
|---|---|---|
| msisdn | An array of values to specify numbers. If an empty array is specified, or if there is a parameter, but the key is not an array, then the parameter is ignored. | |
| originator | string | Sender name. |
| source_type | string | The message source from where the message came to the platform. Can take one of the following values: api, web, smpp, xml, http, json. |
| message_type | string | Message type. Can take the following values: sms, hlr, viber. |
| time_sent_from | Time of sending messages from the platform “from”. | |
| time_sent_to | The time when messages were sent from the platform “until”. | |
| country_name | string | The name of the country to search. |
| operator_id | Indication of the country operator, if the Country_name field is present. If an operator without a country is specified, it is ignored | |
| status | string | The status of the messages to display. Can take the following values: Delivered, Rejected, Scheduled, Moderation, Accepted, Sending, Sent, Expired, Failed, Undelivered, Unknown, Read, not-viber-user. |
| sl_clicks | It is necessary to consider the number of clicks or not. The field is available only to clients who have connected short links. | |
| sl_clicks_comp | Comparison operator with the number of clicks value. Can take values: “<”, “>”, “=”. The field is available only to clients who have connected short links. | |
| sl_clicks_count | The value to compare. The upper character limit is 999999. The field is available only to clients who have connected short links. |
if the request is successful, you will receive a response:
{
"error":0,
"key": {}
}
Interested in a special offer?
Ready to reach further?
Let’s talk
Submit