Get customer's SMS statuses reports
Fetch SMS statuses reports based on customer's sent SMS. Statuses report represents the count of SMS sent during given time period and the difference in the counts compared to the previous such period.
Previous period is the time range of the same length, that ends right before the current time period starts. Current period is determined by time period parameters. For example, if current period is a week, the previous period is the previous week. If the current period is a month (30 days), the previous period is the last 30 days before that month begins.
For SMS statuses report, time period parameters filter by SMS created_at field. If no time filtration is provided in the request, by default report will be returned for the current month.
Query Parameters
Time period filter, determines the end of the period. Accepts string with time either as UNIX timestamp, or in format 2006-01-02T15:04:05Z07:00.
Time period filter, determines the start of the period. Accepts string with time either as UNIX timestamp, or in format 2006-01-02T15:04:05Z07:00.
Header Parameters
Your API token
Response Body
application/json
application/json
application/json
curl -X GET "https://dev-refactor-api-e.voipenv.uk/api/v1/sms/reports/statuses" \ -H "Authorization: string"{
"code": 0,
"data": {
"current_delivered_sms_count": 0,
"current_expired_sms_count": 0,
"current_pending_sms_count": 0,
"current_sent_to_delivery": 0,
"current_total_sms_count": 0,
"current_undelivered_sms_count": 0,
"delta_delivered_sms_count_percent": 0,
"delta_expired_sms_count_percent": 0,
"delta_pending_sms_count_percent": 0,
"delta_total_sms_count_percent": 0,
"delta_undelivered_sms_count_percent": 0,
"previous_sent_to_delivery": 0
},
"error_details": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"message": "string",
"request_id": "string",
"status": "ok"
}{
"code": 0,
"error_details": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"message": "string",
"request_id": "string",
"status": "error"
}{
"code": 0,
"error_details": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"message": "string",
"request_id": "string",
"status": "error"
}
