Get

[POST] .../v1/sms/get

Returns information about single SMS messages. Use this method to retrieve single SMS history records for customer or partner communication audits and delivery troubleshooting. The request body is required and supports filters id, entity_type, entity_id and status, while selector fields; entity_id is applied only together with entity_type. The response returns paged SMS records with recipient entity, phone number, message text, status, creation timestamp, last_update, next_offset and total. The caller must have SMS read permission 584; missing body, denied permission, invalid filters and database errors are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
filters Array of Filter Optional Optional filters by fields available for this API method.
limit Int32 Optional Maximum number of records to return. The value is limited by server settings.
offset Int32 Optional Offset from the beginning of the result set.

Filterable Fields

Field Type Description
entity_id int SMS recipient ID.
entity_type string SMS recipient type. When Default is used, entity_id is ignored.
id int Single SMS message IDs.
status string SMS sending status filter. Default returns messages with any status.

Request Example

{
  "filters": [
    {
      "Field": "entity_type",
      "Operator": "Equal",
      "Value": "RetailCustomer"
    },
    {
      "Field": "entity_id",
      "Operator": "Equal",
      "Value": "25"
    },
    {
      "Field": "status",
      "Operator": "Equal",
      "Value": "New"
    }
  ],
  "limit": 50,
  "offset": 0
}

Response Parameters

Name Type Description
next_offset Int32 Offset for the next data page.
ok Boolean Indicates whether the request completed successfully.
result Array of SingleSms Result array.
total Int64 Total number of result items.

Response Example

{
  "ok": true,
  "result": [
    {
      "id": 1001,
      "entity_type": "RetailCustomer",
      "entity_id": 25,
      "date": 1712345678,
      "status": "New",
      "phone": "998909353214",
      "message": "Your order is ready",
      "last_update": 1712345678
    }
  ],
  "next_offset": 0,
  "total": 1
}