Как получать SMS через API и вебхуки

Включите доступ к API в профиле, сгенерируйте токен и обращайтесь к API с ним. Чтобы входящие SMS приходили на ваш сервер сами, добавьте URL вебхука на той же вкладке.

Обновлено 2 мин чтения

Читать сообщения и управлять номерами можно из собственного кода. Новые SMS получают двумя способами: запрашивать их у API или принимать вебхуком, который присылает каждое сообщение на ваш сервер, как только оно пришло.

Как получить токен API

  1. Шаг 1. Откройте вкладку API

    Зайдите в Профиль и откройте вкладку API.

    Откройте вкладку API. Зайдите в Профиль и откройте вкладку API.
  2. Шаг 2. Включите доступ к API

    Переведите Доступ к API в состояние Включено. Этим же переключателем доступ к API отключается целиком, если понадобится.

  3. Шаг 3. Сгенерируйте токен

    Нажмите Сгенерировать токен в блоке Персональный токен доступа. Токен показывается один раз, поэтому скопируйте его и сохраните. Перевыпустить токен создаёт новый и отзывает прежний.

  4. Шаг 4. Обращайтесь к API

    Передавайте токен как Bearer в заголовке Authorization. Базовый URL и готовый пример curl есть на той же вкладке.

Все методы, параметры и ответы описаны в документации API.

Как принимать SMS вебхуком

При вебхуке мы сами отправляем POST-запрос на ваш сервер, когда что-то происходит, так что опрашивать API не нужно. После включения доступа к API на той же вкладке ниже появляется блок Вебхуки.

  1. Шаг 1. Укажите URL

    Заполните URL вебхука: это адрес на вашем сервере, который отвечает статусом 2xx в течение 10 секунд. Лучше https: по обычному http текст SMS и коды идут без шифрования.

    Укажите URL. Заполните URL вебхука: это адрес на вашем сервере, который отвечает статусом 2xx в течение 10 секунд. Лучше https: по обычному http текст SMS и коды идут без шифрования.
  2. Шаг 2. Выберите события

    Доступны Пришла новая SMS, Номер в сети после пробуждения, Аренда продлена, Аренда не продлена: не хватило баланса и Аренда завершилась.

  3. Шаг 3. Создайте и проверьте

    Нажмите Создать вебхук, убедитесь, что включено Отправлять события, затем нажмите Отправить тест. Результат и последние доставки видны на странице.

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

Вопросы по теме

В Профиле, на вкладке API. После генерации токен показывается один раз. Если потеряли, нажмите «Перевыпустить токен».

Нет. Можно опрашивать API сами. Вебхуки просто избавляют от опроса.

Если ваш сервер долго не отвечает, отправка отключается. Исправьте адрес, включите «Отправлять события» и сохраните.

Нет. API читает сообщения и управляет номерами, отправки там нет.

Читайте также

Не нашли ответа?

Напишите в поддержку в Telegram. Пришлите номер и скриншот того, что видите, так разберёмся быстрее.

Новости Поддержка