v1

latestOpenAPI 3.1.02026-07-24700259.3 KB

SMS

SMS Summary

Retrieve a summary of SMS messages within a certain time range.

post/sms/summary

Request body

start_datestring date

ISO-8601 formatted datetime which defaults to current date at midnight. The range will be inclusive of start_date and exclusive of end_date. Timezone is UTC.

end_datestring date

ISO-8601 formatted datetime which defaults to now. Timezone is UTC.

subaccount_idstring

If you wish to make this API call on behalf of a subaccount then include its unique ID here.

Response

Summary of SMS activity

request_idstring required

Example response

{
  "data": {
    "total_messages": 123,
    "total_units": 156,
    "total_cost": 10.456
  },
  "request_id": "4b661d88-6b2d-11eb-8bb3-f23c92bb31d2"
}