API документация

Webhook

JSON API Получение уведомлений через Webhook Endpoint Общие сведения Технология Webhook позволяет получать пользовательские обратные вызовы по HTTP на ваш сервер. Для получения входящих уведомлений от девелопера требуется наличие публичного доступного IP-адреса (Endpoint). При создании вебхука применяется api_key авторизация. Авторизация Создание Получение конкретной записи Получение всех записей Изменение Удаление Доступные события

Idempotency of queries

JSON API Идемпотентность запросов Для некоторых интеграций требуется надежная защита от дублирования запросов, во избежание лишних отправок. Мы предоставляет такую защиту через механизм идемпотентных запросов. Для реализации механизма в доступных методах API, используется IDEMPOTENCY KEY, который можно получить в личном кабинете или в параметрах ответа при создании инстанса по API.   Во всех соответствующих запросах в …

Idempotency of queries Read More »

Bulk mailing

JSON API Массовая отправка сообщений Общие сведения Наш сервис использует механизм очереди при массовой отправке полученных по api сообщений. Очередь, в общем понятии — это пропускная способность каналов отправки. Принятые сообщения встают в очередь и отправляются приблизительно раз в 30 секунд. Для чего это нужно? Это, как и другие наши интеллектуальные инструменты, сводит к минимуму …

Bulk mailing Read More »

Telegram Authorization

JSON API WSS авторизация Telegram Tdlib Необходимо осуществить коннект к веб-сокету   wss://api.pushsms.ru/socket/websocket?token=токен_клиента&vsn=2.0.0 Обратите внимание, что адрес отличается от используемого при авторизации WhatsApp При удачном коннекте сервис возвращает сообщение: Connected to wss://api.pushsms.ru/socket/websocket?token=токен_клиента&vsn=2.0.0&vsn=2.0.0 Подключение к каналу Для подключения необходимо: * быть авторизованным, то есть первоначальный коннект с верным токеном ID клиента можно получить из JWT токена. …

Telegram Authorization Read More »

Service status list

JSON API Список статусов сервиса Ключ ID Значение Тип Описание telecommunication_company_error 0 Ошибка оператора финальный enroute 1 Передано оператору промежуточный delivered 2 Доставлено финальный expired 3 Просрочено финальный deleted 4 Удалено финальный undeliverable 5 Невозможно доставить финальный accepted 6 Принято промежуточный unknown 7 Неизвестная ошибка финальный rejected 8 Отклонено финальный Сервер не смог обработать запрос …

Service status list Read More »

Dispatch status

JSON API Статус отправки Общие сведения Механика, при которой сервер делает POST-запрос автоматически по указанному callback_url в запросе на доставку. Обращение сервера делается после обновлении статуса отправки до финального (доставлено, отказано в доставке итп). Обращение повторяется каждые 2 минуты 10 раз до момента, пока не получит в ответ HTTP-код 200. Параметры ответа Ключ Тип данных …

Dispatch status Read More »

Cascading

JSON API Каскадная отправка (WhatsApp, Telegram, VK/OK, SMS) Общие сведения Перед началом отправки с использованием WhatsApp, Telegram, VK и OK, вам нужно привязать их к аккаунту.  Далее вы можете указывать перечень каналов, по которым будет осуществляться попытка доставить сообщение. Переход к следующему каналу (попытке отправить через этот канал) происходит при получении статуса о невозможности доставить …

Cascading Read More »

Balance information

JSON API Информация о балансе Общие сведения Параметр Значение Авторизация Необходима HTTP – метод GET URL* https://api.pushsms.ru/api/v1/account Варианты ответа Успешный с http кодом 200 * v1 — скоуп присваивается каждой CRM и сервису индивидуально, запросите свое персональное значение v1 и используйте в коде его, отправляя запросы (https://api.pushsms.ru/api/имявашейcrm/account) Обратите внимание, если вы запрашиваете баланс мастер-аккаунта (аккаунт …

Balance information Read More »

Authorization token

JSON API Token-based авторизация В проекте применяется token-based авторизация. Необходимый access_token можно получить в разделе личного кабинета конкретного инстанса или в ответе при создании инстанса. Во всех соответствующих запросах в headers должно содержаться следующее: Ключ Значение Authorization Bearer {access_token} Content-Type application/json При отсутствии данных параметров или их не валидности во всех соответствующих ресурсах, ответ будет иметь: …

Authorization token Read More »

Send message

JSON API Отправка сообщений Общие сведения Параметр Значение Авторизация Необходима HTTP – метод POST URL https://api.pushsms.ru/api/v1/delivery Варианты ответа Успешный с http кодом 200, неуспешные с кодом 422 * v1 — скоуп присваивается каждой CRM и сервису индивидуально, запросите свое персональное значение v1 и используйте в коде его, отправляя запросы. Параметры Ключ Обязателен Тип данных Описание …

Send message Read More »

en_USEnglish