REST API для работы с WhatsApp

Мы добавили в OLChat REST API для работы с WhatsApp! Теперь вы можете сформировать вебхук и использовать его для вызовов методов REST в своих сценариях автоматизации и при интеграции различных сервисов.

Получение вебхука

Создать вебхук можно зайдя в приложение OLChat — «•••» (меню вызова настроек коннектора) — Настройки коннектора — Вебхук — Сгенерировать новый:

После создания, вебхук можно скопировать в буфер, нажав на кнопку «Скопировать вебхук». При необходимости вебхук можно изменить, нажав на кнопку «Сгенерировать новый»:

Описание методов

Для простоты использования, большая часть API допускает использование GET-запросов.

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

Для корректного срабатывания запросов в параметр "Номер телефона" необходимо вписывать значение через " 7 " в начале номера.

Отправка сообщения

GET https://olchat.infocom.io/rest/webhook/wa/{{token}}/sendText

Позволяет отправить текстовое сообщение на указанный номер телефона в WhatsApp.

Ограничение: 5 запросов в 3 секунды

Path Parameters

Name	Type	Description
phone_number*	str	Номер телефона
body*	text	Тело сообщения
send_to_imol*	Y|N	Отправка в чат Открытой Линии. Может принимать значение Y|N

200: OK

Отправка файла

GET https://olchat.infocom.io/rest/webhook/wa/{{token}}/sendFile

Позволяет отправить файл на указанный номер телефона в WhatsApp. В качестве файла указывается прямая ссылка на файл. Подробнее в статье Создание прямой ссылки на файл.

Ограничение: 5 запросов в 3 секунды

Path Parameters

Name	Type	Description
phone_number*	str	Номер телефона
body*	url	Прямая ссылка на файл
send_to_imol*	Y|N	Отправка в чат Открытой Линии. Может принимать значение Y|N
caption	str	Текст подписи под картинкой

200: OK

Проверка WA на номере

GET https://olchat.infocom.io/rest/webhook/wa/{{token}}/checkPhone

Позволяет проверить наличие на номере аккаунта WhatsApp.

Ограничение: 3 запроса в 1 секунду

ВАЖНО! Не злоупотребляйте этим методом, т.к. высока вероятность блокировки вашего аккаунта со стороны WhatsApp

Path Parameters

Name	Type	Description
phone_number*	str	Номер телефона

200: OK

Проверка статуса линии

GET https://olchat.infocom.io/rest/webhook/wa/{{token}}/checkStatus

Позволяет проверить статус текущей линии.

Ограничение: 5 запросов в 3 секунды

Проверка статуса сообщения

GET https://olchat.infocom.io/rest/webhook/wa/{{token}}/checkMessageStatus

Ограничение: 5 запросов в 3 секунды

Path Parameters

Name	Type	Description
phone_number*	str	Номер телефона
message_id*	str	ID сообщения

200: OK

Где можно использовать REST API

Предположим, что у вас есть сайт или интернет-магазин который не интегрирован с Битрикс24, но, присутствует необходимость уведомить клиента заполнившего форму на WhatsApp о том, что его заявка принята в работу или заказ оформлен.

Вы можете привязаться к событию заполнения формы и отправить запрос, содержащий метод отправки сообщения: https://olchat.infocom.io/rest/webhook/wa/{{token}}/sendText

• В качестве phone_number передайте в запрос номер телефона из формы

• В качестве body – ваш текст сообщения, например: «Мы получили вашу заявку, номер вашего заказа №00001»

• В send_to_imol передайте Y или N

Другие примеры использования REST API:

1. Уведомление о записи на приём из сторонней системы (например, запись на приём у стоматолога);

2. Отправка уведомления из 1С;

3. Сообщение с номера телефона для интегратора.