Skip to content

SmsGetMessage

GET sms/message/:id

Returns one message with everything that happened to it: attempts, the last provider response, the error, the price, and the delivery-report events received for it.

This is the page an operator opens after "the customer says the code never arrived" — the webhook events show whether the operator ever reported anything.

Access Control

Allowed roles: admin, leader, manager. A manager sees only their own messages; admin and leader are not restricted.

Request

GET request
GET https://{broker_domain}/sms/message/{id}
Authorization: <JWT_TOKEN>
{
  "command": "SmsGetMessage",
  "extID": "1",
  "data": {}
}
const res = await platform.SmsGetMessage({});

Path Parameters

Parameter Type Description
id int Message id

Response Data

{
  "id": 812,
  "phone": "380951234567",
  "message": "Your code is 4821",
  "status": "DELIVERED",
  "kind": "TRANSACTIONAL",
  "encoding": "GSM7",
  "parts": 1,
  "attempts": 1,
  "externalId": "prov-99213",
  "price": 0.0032,
  "currency": "EUR",
  "closedBy": "PROVIDER",
  "sentAt": "2026-08-24 13:32:41",
  "deliveredAt": "2026-08-24 13:32:47",
  "data": { "code": "4821" },
  "webhookEvents": [
    {
      "id": 5121,
      "providerEventId": "EV-99213-1",
      "result": "PROCESSED",
      "payload": { "MessageStatus": "delivered" },
      "createdAt": "2026-08-24 13:32:47"
    }
  ]
}

Errors

Code Error Description
403 PERMISSION_DENIED The message belongs to another manager
404 SMS_NOT_FOUND Message not found in the brand