Получение сообщения по id

Содержание

Получение сообщения по id#

Получение сообщения по uuid#

GET https://direct.i-dgtl.ru/api/v1/message/{message_uuid}

Метод позволяет получить сообщение по messageUuid

Path Parameters#

Name

Type

Description

message_uuid*

string

Идентификатор сообщения

Можно использовать как внутренний messageUuid, так и externalMessageId, если бы передан при отправке

Headers#

Name	Type	Description
Authorization*	string	`Basic {TOKEN_1}`

200

В ответе возвращается объект запрашиваемого сообщения.

{
  "createdTime": "2020-01-01T08:00:00Z",
  "channelType": "SMS",
  "sendingMethog": "UI",
  "trafficType": "SERVICE",
  "templateId": 120,
  "dispatchId": 123,
  "messageUuid": "9d213ffc-c388-46f5-b42b-01d589d1a815",
  "externalMessageId": "id123",
  "trafficCenterId": 1,
  "senderName": "testSender",
  "destination": "79818282828",
  "brand": "Мобильные ТелеСистемы ПАО",
  "country": "Россия",
  "region": "Республика Калмыкия",
  "content": "текст сообщения",
  "tags": [
    "tag1",
    "tag2"
  ],
  "ttl": 86400,
  "hours": [
    10,
    11,
    12
  ],
  "days": [
    5,
    6
  ],
  "localSendTime": "2021-02-02 15:00:00",
  "localCompletionTime": "2021-02-10 15:00:00",
  "useLocalTime": true,
  "callbackEvents": [
    "sent",
    "delivered"
  ],
  "callbackUrl": "https://url-for-callbacks",
  "totalParts": 1,
  "price": {
    "totalPrice": 2.5,
    "currency": "RUB",
    "invoicedParts": 1,
    "final": false
  },
  "sentTime": "2020-01-01T09:00:00Z",
  "statusTime": "2020-01-01T10:00:00Z",
  "status": "undelivered",
  "cascadeMessageUuid": "9d213ffc-c388-46f5-b42b-01d589d1a814",
  "cascadeStep": 1,
  "errorCode": 7060
}

401

Использование невалидного токена.

{
    "error": {
        "code": 4012,
        "msg": "Bad credentials"
    }
}

403

Использование неподходящего токена.

{
    "error": {
        "code": 4030,
        "msg": "Access Denied"
    }
}

404

Not Found. Сообщение не найдено.

{
  "error": {
    "code": 404,
    "msg": "Msg not found"
  }
} 

{% hint style=»warning» %} При запросе сообщения по message_uuid непосредственно после отправки в течение 10 секунд может возвращаться ошибка 404. {% endhint %}

Описание объекта сообщения #

Параметр	Тип	Описание
createdTime	string	Время создания сообщения (в UTC)
channelType	string	Канал трафика
sendingMethod	string	Способ отправки сообщения
trafficType	string	Тип трафика
templateId	integer	Идентификатор шаблона (возможен для сервисных и транзакционных сообщений)
dispatchId	integer	Идентификатор рассылки (-1 для одиночных сообщений)
messageUuid	string	Идентификатор сообщения
externalMessageId	string	Внутренний идентификатор сообщения в вашей системе (возвращается если был передан при отправке)
trafficCenterId	integer	Идентификатор ЦРТ
senderName	string	Имя отправителя
destination	string	Номер абонента
direction	string	Направление сообщения Параметр может отсутствовать для исходящих сообщений
brand	string	Оператор абонента
country	string	Страна абонента
region	string	Регион абонента
content	string	Текст сообщения
tags	array	Массив тегов (при наличии)
ttl	integer	Время жизни сообщения в секундах
hours	array (integer)	Допустимые часы отправки
days	array (integer)	Допустимые дни отправки
localSendTime	string	Нижняя граница допустимого времени отправки сообщения
localCompletionTime	string	Верхняя граница допустимого времени отправки сообщения
useLocalTime	boolean	Учет местного времени абонента для localSendTime, localCompletionTime, hours, days
callbackEvents	string	События для отправки callback
callbackUrl	string	Адрес для отправки callback
totalParts	integer	Количество частей в сообщении
price.totalPrice	number	Стоимость сообщения
price.currency	string	Валюта сообщения
price.invoicedParts	integer	Количество тарифицированных частей
price.final	boolean	Цена является окончательной (true) / предварительной (false)
sentTime	string	Время отправки сообщения (в UTC)
status	string	Статус сообщения
statusTime	string	Время получения статуса (в UTC), статус появляется после финализации сообщения
readStatus	string	Статус прочтения
readStatusTime	string	Время получения статуса прочтения (в UTC)
specialContent	object	Содержимое сообщения
specialContent.contentType	string	Тип содержимого сообщения
specialContent.text	string	Текст сообщения
specialContent.caption	string	Текст кнопки
specialContent.action	string	Действие кнопки
specialContent.imageUrl	string	Ссылка на изображение
errorCode	integer	Код ошибки сообщения
flashcallConversion	string	Результат отправки FlashCall
cascadeMessageUuid	string	Идентификатор корневого сообщения каскада
cascadeStep	integer	Номер шага в каскаде