GET /api/message/{uuid}

Метод для получения информации об отправленном сообщении.

Параметры запроса

Полный URL запроса

https://cp.redsms.ru/api/message/{uuid}

Параметры пути

{uuid}

Обязательный параметр.

Уникальный идентификатор сообщения.

Параметры URL

fields

Параметр является необязательным, значение по умолчанию uuid,status,status_time.

Позволяет явно указать какие поля объекта сообщения необходимо вернуть в теле успешного ответа.

В значении необходимо указать необходимые поля, разделённые запятой ,. Примеры значений:

• ?fields=uuid,status – в ответе будут только поля UUID и статуса сообщения;
• ?fields=uuid,status,to,parts – в ответе будут поля UUID, статус, номер телефона получателя и количество частей.

Структура ответа

Пример тела успешного ответа:

{
  "item": {
    "uuid": "10eb3bbc-c353-11ee-8fa2-0242c0a86497",
    "status": "delivered",
    "status_time": 1707047226
  },
  "success": true
}

Поле item содержит объект сообщения с полями, указанными в параметре fields.

Пример тела ответа для запроса с параметром fields со значением uuid,status,status_time,traffic_type,from,to,text,price,clientField:

{
  "item": {
    "uuid": "10eb3bbc-c353-11ee-8fa2-0242c0a86496",
    "status": "delivered",
    "traffic_type": null,
    "status_time": 1707047226,
    "to": "+79018027654",
    "from": "Company",
    "text": "Ваш код для входа на сайт Company.ru - 8562",
    "price": 7,
    "clientField": null
  },
  "success": true
}

Возможные коды ответа

Код	Описание
200	Успешный ответ, всё хорошо
401	Недействительная авторизация – проверьте значения заголовков и наличие ограничений белого списка IP в личном кабинете
404	Сообщение не найдено, либо URL запроса некорректный – убедитесь, что путь запроса не заканчивается на /