Запросы к API

Запросы к API осуществляются на адрес

https://whatsgate.ru/api/v1/<команда>

Перечень команд управления инстансом Whatsapp:

• send - отправка сообщений
• seen - делает последние сообщения в чате просмотренными для собеседника
• get-chats - запрос списка чатов
• get-media - запрос медиа-файла
• check - проверка зарегистрирован ли номер в Вотсап
• events-get - запрос входящих событий для получения входящих сообщений

Перечень команд управления сессиями:

• session-create - создание новой сессии Whatsapp
• session-delete - удаление сессии Whatsapp с выходом из авторизации
• sessions-get - получение списка сессий
• set-name - изменение имени сессии
• set-hook - установка webhook для получения входящих сообщений

Авторизация в API производится в заголовке запроса X-Api-Key Также, обязательно наличие заголовка Content-type: application/json

X-Api-Key: YOUR_API_KEY
Content-type: application/json

В теле запроса передается JSON - объект, обязательным параметром которого является WhatsappID

{
  "WhatsappID": "YOUR_WHATSAPP_ID",
  "number": "79999999999"
}

Если все прошло удачно, то в ответе на запрос будет указан код 200, в теле ответа будет находится JSON-объект. Поля JSON-объекта будут установлены в зависимости от переданной команды.

{
  "result": "OK",
  "data": true
}

При ошибке, кот ответа будет 500. Возвращаемый объект содержит следующие поля:

• name - Наименование ошибки
• message - Более подробная информация об ошибке
• code - Код ошибки

{
  "name": "Unauthorized",
  "message": "Your request was made with invalid credentials.",
  "code": 0
}