Рассмотрим варианты использования API через наш сервис. В данный момент доступны два варианта: с заменой хуков Telegram или с использованием сервисов API для отправки и сохранения данных на стороне WorkHard.Chat.
Во ВКонтакте необходимости в этом нет, поскольку эта платформа позволяет добавлять несколько серверов получателей.
Замена хука и использование callback url
При добавлении канала НЕ ставьте галочку. Когда канал будет добавлен, хук заменится на наш WorkHard.Chat, а все данные, которые отправляет Telegram, будут приходить к нам на серверы.
Чтобы отправить какие-либо данные в ваш сервис (например, «новое сообщение», «новая подписка», «контакт отписался»), добавьте callback url.
В списке каналов нажмите на три точки, выберите «Добавить callback url» и в поле напишите куда нужно отправлять данные (https://вашурл.com).
После добавления callback url, на указанный адрес будут отправляться POST данные, внутри будет массив с параметрами:
- type_id — 1 — Новое сообщение; 2 — Новый подписчик; 3 — Контакт отписался;
- message_id — id сообщения на стороне WorkHard.Chat;
- contact_id — id контакта на платформе (Telegram, VK);
- chat_contact_id — id контакта в сервисе WorkHard.Chat;
- text — тело сообщения.
Если требуются какие-либо дополнительные параметры, напишите нам, по возможности добавим все, что необходимо.
Использование сервисов WorkHard.Chat без замены хука
При добавлении канала поставьте галочку. Когда канал будет добавлен, хук НЕ заменится на наш, все данные, которые отправляет Telegram, будут приходить к вам на серверы, после чего нужно будет отправлять их к нам.
В профиле на WorkHard.Chat есть API TOKEN. Используйте его для авторизации, все запросы должны приходить с Bearer авторизацией.
При отправке в хедер добавьте Autorization: Bearer ВАШ_ТОКЕН
Сервисы:
- POST https://api.workhard.chat/v2/customer/outer/ID/send-message
- GET https://api.workhard.chat/v2/customer/outer/ID/get-contacts
- POST https://api.workhard.chat/v2/customer/outer/ID/add-contact
- POST https://api.workhard.chat/v2/customer/outer/ID/delete-contact
- POST https://api.workhard.chat/v2/customer/outer/ID/delete-message
Отправка сообщения
Отправьте POST запрос на https://api.workhard.chat/v2/customer/outer/ID/send-message с параметрами
- id — (int) id канала (можно увидеться в списке каналов);
- message — (string) сообщение для отправки;
- contact_id — (int) id контакта на в сервисе (Telegram, vk).
В ответ поступит массив с message (сообщение) и id_contact — id контакта на WorkHard.Chat.
Получить контакты
Отправляем GET запрос на https://api.workhard.chat/v2/customer/outer/ID/get-contacts с параметрами
- id — (int) id канала (можно увидеться в списке каналов)
В ответ поступит массив с параметрами:
- id — id контакта на WorkHard.Chat;
- contact_id — id контакта на платформе (Telegram, VK);
- is_deleted — удаленный контакт;
- block — заблокированный контакт.
Добавление контакта
Отправьте POST запрос на https://api.workhard.chat/v2/customer/outer/ID/add-contact с параметрами:
- id — (int) id канала (можно увидеться в списке каналов);
- contact_id — (int) id контакта на платформе (Telegram, VK).
В ответ поступит id контакта с WorkHard.Chat.
Удаление контакта
Отправьте POST запрос на https://api.workhard.chat/v2/customer/outer/ID/delete-contact с параметрами:
- id — (int) id канала (можно увидеться в списке каналов);
- contact_id — (int) id контакта на платформе (Telegram, VK).
В ответ поступит id контакта с WorkHard.Chat.
Удаление сообщения
Отправьте POST запрос на https://api.workhard.chat/v2/customer/outer/ID/delete-message с параметрами:
- id — (int) id канала (можно увидеться в списке каналов);
- contact_id — (int) id контакта с WorkHard.Chat;
- message_id — (int) id сообщения с WorkHard.Chat (приходит при отправке через наш сервис).
Остались вопросы? Задайте их в нашем Телеграм-чате.
