Отправка VK

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

В связи со скорым запуском мессенджера МАХ, новые подключения по каналам VK/OK недоступны в i-digital direct. Следите за изменениями в нашем Telegram-канале.

POST https://direct.i-dgtl.ru/api/v1/message

Метод позволяет отправлять массив одиночных сообщений (от 1 до 1000)

Headers

Name	Type	Description
Authorization*	string	Basic {TOKEN_1}
Content-Type*	string	application/json

Request Body

Name	Type	Description
channelType*	string	Канал отправки (VK)
senderName*	string	Имя отправителя. Допускается любая непустая строка
destination*	string	Номер абонента
content*	string	Сообщение; строка в кодировке UTF-8 без Byte Order Mark От 1 до 2048 символов
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 (вс), каждое из которых соответствует разрешенному для отправки дню недели; значения должны быть уникальны.
shortUrl	boolean	Флаг, отвечающий за сокращение ссылок в сообщении: true - ссылки в тексте сообщения будут сокращены По умолчанию false
callbackUrl	string	Адрес для отправки callback
callbackEvents	string	События, по которым будут отправлены callback (массив строк). При наличии callbackUrl и отсутствии callbackEvents в запросе, будет отправлен callback по событию delivered.
externalMessageId	string	Внутренний id сообщения в вашей системе. До 100 символов.

200

В случае успешного запроса возвращается ответ, в котором перечислены идентификаторы сообщений и коды результата. При значении errors = false гарантируется, что все переданные сообщения успешно созданы.

{
  "errors": false,
  "items": [
    {
      "messageUuid": "063474ec-a34f-4558-90c5-984395000004",
      "code": 201
    },
    {
      "messageUuid": "063564ec-a34f-4558-90c5-984395000005",
      "code": 201
    }
  ]
}

401

403

422

402

Рекомендуемое время ожидания ответа: 70 секунд. Как правило, ответ на запрос возвращается не более чем за несколько секунд, но таймаут величиной в 70 секунд позволяет гарантированно получить ответ на запрос, в том числе в ситуациях повышенной нагрузки.

Для использования личного домена в сокращенных ссылках необходимо обратиться в поддержку

Возможные варианты перечислений:

Параметр	Варианты
callbackEvents	События для отправки callback

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

JSON

POST https://direct.i-dgtl.ru/api/v1/message
Authorization: Basic QWxhZGRpbjpvcG...
Content-Type: application/json
[
  {
    "channelType": "VK",
    "senderName": "VKSENDER",
    "destination": "79818268484",
    "content": "Текст VK-сообщения",
  }
]

cURL

В примере указан минимальный набор параметров, который позволяет моментально отправить VK (при наличии зарегистрированной VK-группы, информацию о которой нужно передать вашему менеджеру). Вы можете кастомизировать время отправки, настроить коллбэки и добавить теги, используя опциональные параметры, описанные в начале данной страницы.