Get customer's SMS history
Fetch data about customer's sent SMS, filtrated by given parameters. Returns data with pagination.
For SMS, time period parameters filter by SMS created_at field.
Query Parameters
Optional field. Allows to filter out SMS by phone number. Filtration is done by a partial search.
Pagination parameters. Accepts page number. Pagination starts on page=1. If parameter is not provided, the default value of 1 will be set.
Pagination parameter. Accepts the size of page for pagination. Minimal page size is 1. If parameter is not provided, the default value of 10 will be set.
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.
Optional parameter that allows to search OTP SMS by sender, country, text and/or phone values. The search operation is partial.
Ordering parameter. Defines by which field the data will be sorted. If parameter is not provided, will be used entity's default ordering. To use entity's default sorting, pass _default as value.
Value in
- "_default"
- "created_at"
- "date"
- "country"
- "code"
- "phone"
- "number"
- "state"
- "status"
- "text"
- "mcc"
- "mnc"
- "price"
Ordering parameter. Defines the order of sorting (asc or desc). If parameter is not provided, will be used entity's default ordering.
Value in
- "asc"
- "desc"
Header Parameters
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/api/v1/sms/otp/history" \ -H "Authorization: string"{ "data": [ { "callback_payload": "string", "callback_response": "string", "callback_url": "string", "code": "string", "country": "string", "created_at": "string", "id": 0, "id_state": "string", "mcc": 0, "phone": "string", "price": 0, "sender": "string", "state": "PENDING", "text": "string" } ], "page": 0, "page_size": 0, "total": 0, "total_pages": 0}
