SMS API

Отправка SMS-сообщений

Запрос:

Параметры передаются в заголовке запроса:

POST/GET https://api.unibell.ru/sms_new?X-Authorization=AccessKey d8ac9959r12b43545XXXXX&destAddr=7XXXXXXXXXX&sourceAddr=MySender&shortMessage=Текст сообщения

ПараметрТипОписание
destAddrstringНомер телефона, на который отправляется SMS-сообщение в формате e.164 для Российской Федерации
7XXXXXXXXXX
sourceAddrstringИмя отправителя (только латиница или номер телефона)
Поле не должно содержать кириллицы
shortMessagestringТекст сообщения

Ответ:

{
   "reference": "5b922bba6be053cd6a2ecebb1a31438a",
   "status": "ok",
}

При ошибке в sourceAddr:

{
    "status": "invalidDataError",
    "error": "Field sourceAddr must not contain Cyrillic"
}
ПараметрТипОписание
statusstringСтатус запроса
referencestringУникальный идентификатор сообщения
errorstringПоле sourceAddr не должно содержать кириллицы

Для получения результатов выполнения запроса может быть настроен callback (обратный вызов) по протоколу HTTP/HTTPS с помощью метода POST. Передаются параметры Content-Type: application/x-www-form-urlencoded (подробнее см. Callback).

ПараметрТипОписание
referencestringУникальный идентификатор сообщения
sourceAddrstringИмя отправителя
Поле не должно содержать кириллицы
destAddrstringНомер телефона, на который отправляется SMS-сообщение в формате e.164 для Российской Федерации
7XXXXXXXXXX
statusstringСтатус SMS-сообщения
DELIVERED — доставлено
UNDELIVERABLE — не доставлено (уточнение в
коде сетевой ошибки)
REJECTED — отклонено с ошибкой (уточнение в
коде сетевой ошибки)
networkErrCodestringОшибки SS7, смотрите ниже
imsistringIMSI абонента
vlrstringVLR абонента
createdDateTimestringДата/время создания
statusDateTimestringДата/время получения статуса

Массовая отправка SMS-сообщений

Запрос:

POST https://api.unibell.ru/sms_bulk?X-Authorization=AccessKey d8ac9959r12b43545XXXXX

или

POST api.unibell.ru/sms_bulk?X-Authorization=AccessKey d8ac9959r12b43545XXXXX

Тело запроса:

{
    "destAddrs": [
        "7XXXXXXXXXX",
        "32123",
        "один два три"
    ],
    "sourceAddr": "7XXXXXXXXXX",
    "shortMessage": "Текст сообщения"
}
ПараметрТипОписание
destAddrsstringСписок телефонных номеров, на которые отправляются SMS-сообщения в формате e.164 для Российской Федерации
7XXXXXXXXXX
sourceAddrstringИмя отправителя
Поле не должно содержать кириллицы
shortMessagestringТекст сообщения

Тело ответа:

{
    "status": "ok",
    "results": [
        {
            "status": "ok",
            "reference": "741bae0ce4f936d90ede02694881b69f",
            "destAddr": "7XXXXXXXXXX"
        },
        {
            "status": "error",
            "error": "Not valid destAddr",
            "destAddr": "32123"
        },
        {
            "status": "error",
            "error": "Not valid destAddr",
            "destAddr": "один два три"
        }
    ]
}
ПараметрТипОписание
statusstringСтатус запроса
resultsstringРезультаты по каждому получателю
errorstringОписание ошибки
referencestringУникальный идентификатор сообщения
destAddrstringНомер телефона, на который отправляется SMS-сообщение в формате e.164 для Российской Федерации
7XXXXXXXXXX

При ошибке в sourceAddr:

{
    "status": "invalidDataError",
    "error": "Field sourceAddr must not contain Cyrillic"
}
ПараметрТипОписание
statusstringСтатус запроса
errorstringПоле sourceAddr не должно содержать кириллицы

Коды ошибок в статусе

Возможные коды ошибок в статусе SMS (значения networkErrCode).

Все неуказанные коды считаются зависящими от поставщика и не обрабатываются отдельно.

КодНазваниеОписание
0Нет ошибкиАбонент существует и доступен
1Абонент не существуетУказанный номер телефона не существует
6Абонент не в сетиТелефон абонента отключен или находится вне зоны действия сети
11Нет услуги SMSОзначает, что абонент не может принять SMS-сообщение. Например, услуга не подключена, или абонент находится в роуминге, где не активирован прием сообщений, или у оператора абонента не налажен обмен SMS с текущим роуминговым оператором. Также это может быть городской номер без приема сообщений
12Ошибка в телефоне абонентаНе удается доставить сообщение абоненту из-за ошибки в телефонном аппарате или SIM-карте
13Абонент заблокированВозникает, например, если на счету абонента нулевой или отрицательный баланс, и он находится в роуминге, или заблокирован оператором за продолжительную неуплату либо добровольно самим абонентом. Также данная ошибка может возвращаться при повреждении SIM-карты либо неправильном вводе PIN и PUK-кодов SIM-карты
21Нет поддержки сервисаНет поддержки сервиса
На этой странице