SMS

Query SMS history (paginated). Filter by recipient (`to`) and `createdAt` date range via queryOptionsRequest; page with pagedListRequest { nextId, pageSize }. Returns { data, total, nextId, currentTotal }.

post/api/v1/sms/query

Request

  • Base URL: https://api.voicelogica.ai
  • URL: https://api.voicelogica.ai/api/v1/sms/query
  • Auth: API key in header x-api-key

Headers

x-api-keystring required

Your API key for authentication. Required for all endpoints.

x-company-idstring

Optional company ID for resellers. When provided, the API request will operate on behalf of the specified subsidiary company. The API key must have access to the specified company.

Request body

Example request

{
  "pagedListRequest": {
    "nextId": null,
    "pageSize": 20
  },
  "queryOptionsRequest": {
    "filtersRequest": [
      {
        "field": "to",
        "matchMode": 8,
        "operator": 1,
        "value": "+3069",
        "values": null,
        "rangeValues": null,
        "ignoreCase": true
      },
      {
        "field": "createdAt",
        "matchMode": 10,
        "operator": 1,
        "value": null,
        "values": null,
        "rangeValues": {
          "start": "2026-06-01T00:00:00.000Z",
          "end": "2026-06-30T23:59:59.999Z"
        },
        "ignoreCase": null
      }
    ]
  }
}

Response

Paginated SMS history

totalinteger required

Total number of records

nextIdstring nullable

ID of the next page, if available

currentTotalinteger required

Number of records in the current response

Example response

{
  "data": [
    {}
  ],
  "total": 1,
  "nextId": null,
  "currentTotal": 1
}

Changes

No recorded changes to this operation across all 2 revisions of this API.