База знаний

Отправка одиночных сообщений по API

POST /sms/v1/message/sendOne

Обязательные поля
channel - тип сообщения (sms | viber | viber_sms)
sms_text - текст sms сообщения, по умолчанию пустая строка
viber_text - текст viber сообщения, по умолчанию пустая строка
sms_sender - имя sms отправитель, по умолчанию значение SmsGold
viber_sender - имя viber отправитель, по умолчанию пустая строка
phone - номер получателя, в формате +7/7
hookUrl - URL на который прийдет статус сообщения (POST запрос, не обязательный параметр)

В случае, если указан канал viber_sms, то тогда 
в сообщении обязательно заполняется все 4 поля с данными sms_text sms_sender viber_text viber_sender

ответ

{
msgId - идентификатор сообщения
}

Пакетная отправка сообщений

POST /sms/v1/message/sendBatch для песочницы

Обязательные поля
channel - тип сообщения (sms | viber | viber_sms)
sms_text - текст sms сообщения, по умолчанию пустая строка
viber_text - текст viber сообщения, по умолчанию пустая строка
sms_sender - имя sms отправитель, по умолчанию значение SmsGold
viber_sender - имя viber отправитель, по умолчанию пустая строка
phones - список номеров, в виде массива в формате +7/7 ( ["79991110000", "+79991110000"] ), лимит списка 1000 номеров
hookUrl - URL на который прийдет статус сообщения (POST запрос, не обязательный параметр)
groups - список ID групп контактов, из которых нужно дополнить список (поле phones)


при отправке данных, в случае отсутствия данных в полях `phones` или `groups`, указывается пустой массив



формат данных поля groups

// одна группа
[{"id": "5ba8bf4afd6ab6082aecc2bd", "gender": 0}]

// несколько групп
[{"id": "5ba8bf4afd6ab6082aecc2bd", "gender": 0}, 
{"id": "5ba8bf4afd6ab6082aecc2bd", "gender": 0}]

id - Идентифркатор группы
gender - Пол контакта, не обязательное поле (0 - Мужчины / 1 - Женщины / 2 - Все)



для viber есть дополнительные параметры (не обязательные)
button_text - текст кнопки, по умолчанию пустая строка
button_link - ссылка, по умолчанию пустая строка
imageViber - изображение, передается идентификатор изображения в формате UUID, по умолчанию пустая строка


для вайбер доступны следующие варианты отправки
  • Текст
  • Текст + кнопка + ссылка
  • Текст + картинка + кнопка + ссылка

ответ

{
 "idList": [ // список идентификаторов сообщений
  "5de5e55669a44f2daf60c200",
  "5de5e55669a44f2daf60c201",
  "5de5e55669a44f2daf60c202",
  "5de5e55669a44f2daf60c203",
  "5de5e55669a44f2daf60c204"
  ]
}

в случае, если в рассылке суммарно (общее кол-во номеров из массивов phones и groups) будет превышать 10000 номеров, то ответ будет таким

{
"dispatchID":
"05cda110-1584-11ea-acec-4b67393726be-9339381-lza9eHQZxXk-CI9cAvsWIBIRLC8EfSNb8",
"requestId":
"09560790-b9c2-4d84-b85a-93b3b1e94410"
}

где
dispatchID - идентификатор рассылки
requestId - идентификатор запроса

Идентификаторы сообщений будут приходить небольшими массивами на URL указанный в параметре hookForIds, в дополнении к обязательным параметрам
На хук будет приходить POST запрос с данными вида

{
"dispatchID":
"05cda110-1584-11ea-acec-4b67393726be-9339381-lza9eHQZxXk-CI9cAvsWIBIRLC8EfSNb8",
"requestId":
"09560790-b9c2-4d84-b85a-93b3b1e94410",
"idList": [
  "5de5e55669a44f2daf60c200",
  "5de5e55669a44f2daf60c201",
  "5de5e55669a44f2daf60c202",
  "5de5e55669a44f2daf60c203",
  "5de5e55669a44f2daf60c204"
  ]
}



Распределение затрат между юр. лицами

для того чтобы указать, за каким пользователем будет закреплена рассылка, в данных, при отправке сообщений, необходимо указать дополнительный параметр cfoKey, который представляет из себя hash, например VmTE1T0LVHm.

Список ключей имеющихся у пользователя, уточняется через тех. поддержку.


Варианты ошибок при отправке

Дополнительная информация об ошибке, передается в поле code

статус ответа 400
10000 - превышет лимит списка номеров в запросе
10001 - не указан список номеров
10002 - некорректный формат номера(ов) телефона(ов)
10003 - неверный формат групп контактов
10004 - не найден список номеров или групп
10005 - не указан список номеров или список групп контактов

статус ответа 402
10006 - недостаточно средств, необходимо пополнить баланс

статус ответа 403
1000 - запрет рассылки сообщений
1001 - запрет изменения баз(групп контактов)


статус ответа 500
Ошибка системы


Возврат к списку