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

Описание полей

Поле	Тип	Описание
uuid	string	Уникальный идентификатор сообщения
parent_uuid	string	UUID предыдущего сообщения в каскадной отправке. При отсутствии в значении будет пустая строка ""
child_uuid	string	UUID следующего сообщения в каскадной отправке. При отсутствии в значении будет пустая строка ""
type	enum	Один из возможных типов сообщения
status	enum	Один из возможных статусов сообщения
traffic_type	enum | null	Один из возможных типов тарификации сообщения
is_paid_name	boolean	Флаг платного имени отправителя
status_time	timestamp | null	Время получения статуса сообщения
start_time	timestamp | null	Запланированное время отправки сообщения
create_time	timestamp | null	Время создания сообщения
to	string	Номер телефона получателя в международном формате, например +79018027654
from	string	Имя отправителя
replacedFrom	string	Имя отправителя, отображаемое у получателя
text	string	Текст сообщения
country	string	ISO-код страны получателя
routes	enum[]	Массив, содержащий типы сообщения в последовательности каскадной отправки
operator	string | null	Короткое название оператора, зарегистрированного в системе
pool_operator_name	string | null	Полное название оператора получателя
operator_changed	boolean	Флаг, указывающий на то, что получатель сменил оператора
price	float	Стоимость сообщения в рублях
login	string	Логин пользователя, который создал сообщение
parts	integer	для SMS – количество частей сообщения; для Voice – количество прослушанных секунд, либо длина аудио дорожки в секундах, если сообщение еще не было доставлено.
ip	string	IP-адрес, с которого было отправлено сообщение для сообщений, отправленных из SMPP или API значением будет IP-адрес сервера; для сообщений из личного кабинета – IP-адрес пользователя личного кабинета.
source	enum	Один из возможных источников отправки сообщения
created	integer	Алиас для поля create_time
sended	timestamp | null	Время фактической отправки сообщения
provider_status	string | null	Статус сообщения, полученный от поставщика
regionId	integer | null	Идентификатор региона РФ получателя в системе не соответствует коду ФИАС
isInternationalName	boolean	Флаг, указывающий на то, что имя отправителя является международным
clientField	string | null	Произвольная строка, указанная при отправке сообщения
errCode	integer	Код ошибки, 0 – ошибка отсутствует

Перечисляемые значения

Типы сообщений

Значение	Описание
sms	SMS сообщение
viber	Сообщение в Viber
vk	Сообщение в VK
ok	Сообщение в OK
voice	Голосовое сообщение, звонок
fcall	Flash-call, авторизация по звонящему номеру телефона
hlr	HLR-запрос
ping	Ping-SMS
pushok	PushOk (SIM-Push)

Статусы сообщения

Все статусы, кроме created, progress и moderation являются конечными. Сообщение, имеющее конечный статус, не будет обновляться.

Исключением является статус delivered для сообщений в Viber или VK – он может быть изменен на read или reply после соответствующего действия получателя.

Значение	Описание
created	Сообщение создано и ожидает отправки
moderation	Сообщение проверяется модераторами
reject	Сообщение отклонено модератором
delivered	Сообщение доставлено до получателя
read	Сообщение прочитано получателем – только для сообщений Viber и VK
reply	Получатель ответил на сообщение – только для сообщений Viber
undelivered	Сообщение не доставлено
timeout	Просрочено – сообщение было отправлено, но время ожидания статуса истекло
progress	Сообщение в процессе отправки, либо в ожидании статуса после отправки
no_money	Недостаточно средств для отправки сообщения
doubled	Дублирование сообщения
limit_exceeded	Исчерпан один из лимитов на отправку сообщений, настраиваемых в личном кабинете
bad_number	Некорректный номер телефона получателя
stop_list	Номер телефона получателя находится в стоп-листе
route_closed	Направление закрыто для отправки; например, включены настройки ограничений по странам
error	Неизвестная ошибка

Типы тарификации

Значение	Описание
market	Рекламное сообщение – любое сообщение, не соответствующее шаблону
auth	Сообщение, текст которого соответствует зарегистрированному авторизационному шаблону
service	Сообщение, текст которого соответствует зарегистрированному сервисному шаблону
info	Сообщение, текст которого соответствует зарегистрированному информационному шаблону
market_template	Сообщение, текст которого соответствует зарегистрированному рекламному шаблону
transact	Сообщение, текст которого соответствует зарегистрированному транзакционному шаблону
fcall4	Flash-call сообщение с кодом из 4 цифр
fcall6	Flash-call сообщение с кодом из 6 цифр

Возможные комбинации значений типа и тарификации сообщения

	sms	viber	vk	ok	voice	fcall	hlr	ping	pushok
null	✅	✅	✅	✅	✅	✅	✅	✅	✅
market	✅
auth	✅
service	✅	✅
info	✅
market_template	✅
transact	✅
fcall4						✅
fcall6						✅

Источники отправки

Значение	Описание
api	Сообщение отправлено через HTTP API
lk	Сообщение отправлено из личного кабинета
smpp	Сообщение отправлено через SMPP
yclients	Сообщение отправлено из сервиса YClients