Получение статуса доставки сообщения (imOutMessageId)

Метод, описанный в этой статье, предназначен только для SME.

В результате выполнения запроса будет получен статус доставки сообщения с заданным идентификатором. В случае успешного выполнения запроса вернется ответ от сервера, содержащий JSON с данными о текущeм статусе сообщения.

URL-адрес подключения

Для отправки сообщения выполняется GET-запрос на URL-адрес: https://im.edna.ru/api/imOutMessage/{imOutMessageId}

Формат запроса

Запрос имеет один обязательный параметр imOutMessageId, который передается как часть URL. Это идентификатор отправленного ранее сообщения, например: https://im.edna.ru/api/imOutMessage/d290f1ee-6c54-4b01-90e6-d701748f0851

Формат ответа

В ответ на запрос возвращается JSON-объект, содержащий Id отправленного сообщения и статус его обработки.

{
    "imOutMessageId":"test-001",
    "dlvStatus":"read",
    "dlvStatusAt":"2021-01-29T13:15:07.000+0000",
    "code":"ok"
}

Если сообщение не было доставлено, то будет указана причина:

{
    "imOutMessageId": "test-001",
    "dlvStatus": "undelivered",
    "dlvStatusAt": "2021-01-15T11:41:20.000+0000",
    "dlvError": "not-whatsapp-user",
    "code": "ok"
}

Параметры ответа

ПараметрТип данныхОписание
imOutMessageIdstringИдентификатор сообщения
dlvStatusstringСтатус сообщения. Возможные значения
dlvStatusAtstringДата и время получения статуса сообщения. Указывается в следующем формате, например, 2020-01-29T19:03:52.355+0300.
dlvErrorstring (optional)Ошибка, возникшая при доставке сообщения. Возможные значения
codestringКод обработки статуса сообщения
Отправка сообщений (imOutMessage)
Cледующая статья Отправка HSM сообщения (imOutHSM)