Links

Отправка SMS

post
https://direct.i-dgtl.ru/api
/v1/message
Отправка SMS-сообщений
Метод позволяет отправлять массив одиночных сообщений (от 1 до 1000)
Parameters
Header
Authorization*
string
Basic {TOKEN_1}
Content-Type*
string
application/json
Body
channelType*
string
Канал отправки (SMS)
senderName*
string
Имя отправителя. Допускаются SMS-имена в статусе "Одобрено" с датой начала действия не позднее, чем время отправки запроса
destination*
string
Номер абонента
content*
string
Сообщение; строка в кодировке UTF-8 без Byte Order Mark
tags
array
Теги сообщения (массив строк). Каждый тег должен соответствовать выражению ^\w+$ (допускаются буквы в любом регистре, цифры и нижнее подчеркивание "_")
useLocalTime
boolean
Флаг, отвечающий за таймзону, в которой будет отправлено сообщение: true – отправка в таймзоне абонента false – отправка по МСК По умолчанию true
localSendTime
string
Нижняя граница допустимого времени отправки сообщения (с учетом значенияuseLocalTime) Дата в формате 'YYYY-MM-DD hh:mm:ss' в диапазоне от (текущее время в UTC - 12 часов) до (текущее время в UTC + 7 дней) По умолчанию сообщение будет отправлено сразу
localCompletionTime
string
Верхняя граница допустимого времени отправки сообщения (с учетом useLocalTime) в диапазоне от localSendTime до (текущее время в UTC + 70 дней)
ttl
integer
Время жизни сообщения в секундах. По истечении ttl сообщению устанавливается финальный статус. 60 ≤ ttl ≤ 86400
hours
array
Допустимые часы отправки (массив чисел). В массиве могут быть переданы целые числа от 0 до 23, каждое из которых соответствует разрешенному для отправки часовому интервалу с учетом useLocalTime; значения должны быть уникальны.
days
array
Допустимые дни отправки (массив чисел). В массиве могут быть переданы целые числа от 1 (пн) до 7 (вс), каждое из которых соответствует разрешенному для отправки дню недели; значения должны быть уникальны.
externalMessageId
string
Внутренний id сообщения в вашей системе. До 100 символов.
shortUrl
boolean
Флаг, отвечающий за сокращение ссылок в сообщении: true- ссылки в тексте сообщения будут сокращены По умолчанию false
callbackUrl
string
Адрес для отправки callback
callbackEvents
array
События, по которым будут отправлены callback (массив строк). При наличии callbackUrl и отсутствии callbackEvents в запросе, будет отправлен callback по событию delivered
Responses
200
В случае успешного запроса возвращается ответ, в котором перечислены идентификаторы сообщений (в том числе ваши, если были переданы) и коды результата. При значении errors = false гарантируется, что все переданные сообщения успешно созданы.
401
Использование невалидного токена / отсутствие заголовка авторизации
402
Недостаточно средств на балансе
403
Использование неподходящего токена
422
Невалидные параметры в теле запроса или превышение максимального количества объектов
503
Отсутствие возможности сокращения ссылок
Рекомендуемое время ожидания ответа: 70 секунд. Как правило, ответ на запрос возвращается не более чем за несколько секунд, но таймаут величиной в 70 секунд позволяет гарантированно получить ответ на запрос, в том числе в ситуациях повышенной нагрузки.
В качестве имени отправителя при отправке SMS-сообщений допускается использование имен в статусе "Одобрено" с датой начала действия не позднее текущей.
Имя отправителя можно создать как при помощи API, так и в личном кабинете на странице "Имена отправителей"
Для использования личного домена в сокращенных ссылках необходимо обратиться в поддержку
Возможные варианты перечислений:
Параметр
Варианты
callbackEvents

Тестирование

Для тестирования отправки SMS без регистрации имени отправителя вы можете использовать следующие данные:
  • senderName – i-dgtl.ru
  • destination – номер телефона, который принадлежит активному пользователю личного кабинета (можно найти на странице Пользователи)
  • прочие параметры – произвольные, в соответствии с описанием

Пример запроса

JSON
cURL
POST https://direct.i-dgtl.ru/api/v1/message
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Content-Type: application/json
[
{
"channelType": "SMS",
"senderName": "i-dgtl.ru",
"destination": "79818268484",
"content": "текст сообщения https://domain.com",
"localSendTime": "2020-01-01 18:00:00",
"localCompletionTime": "2020-01-02 18:00:00",
"useLocalTime": true,
"hours": [0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23],
"days": [1,2,3,4,5,6,7],
"shortUrl": true,
"externalMessageId": "10898",
"callbackUrl": "https://company.com/callback",
"callbackEvents": [
"delivered",
"click"
]
}
]
curl -X POST 'https://direct.i-dgtl.ru/api/v1/message' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==' \
-d '[{"channelType":"SMS","senderName":"i-dgtl.ru","destination":"79818268484","content":"текст сообщения https://domain.com","localSendTime":"2020-01-01 18:00:00","localCompletionTime":"2020-01-02 18:00:00","useLocalTime":true,"hours":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23],"days":[1,2,3,4,5,6,7],"shortUrl":true,"callbackUrl":"https://company.com/callback","callbackEvents":["delivered","click"]}]'