WAZZUP Help

Как перейти со старого API на новый

Здесь перечислены только отличия. Если в этом документе чего-то нет, значит это осталось без изменений.

Авторизация

Для авторизации во всех запросах нужно добавить заголовок “Authorization”.

Меняется формат данных в заголовке “Authorization”:

Было Стало
Authorization: “34e6679dfe3e41e49bf7e5150eaedd72” Authorization: “Basic 32a817cbc1594bd5885574d8f0290cd3”

Чтобы получить ключ, перейдите в настройки интеграции в личном кабинете Wazzup → «Добавить интеграцию» → «Интеграция по API».

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

Измените адрес для отправки сообщений:

Было Стало
https://{subdomain}.wazzup24.com/api/v1.1/send_message https://api.wazzup24.com/v2/send_message

Параметры запроса

Измените параметры запроса:

Было Стало
transport chatType
from Больше не используется
channelId — channelid канала (uuidv4), через который нужно отправить сообщение
to chatId
refId refMessageId

Вместо параметра from c номером телефона канала отправки нужно отправлять параметр channelId с id канала (uuidv4), через который нужно отправить сообщение. Информацию о каналах, в том числе их channelId можно получить запросом на GET https://api.wazzup24.com/v2/channels.

Подробнее об этом читайте в разделе «Получение списка каналов».

Результат запроса

Измените имя параметра с идентификатором созданного сообщения:

Было Стало
guid messageId

Коды ошибок

Измените коды некоторых ошибок:

Было Стало
MESSAGE_INCORRECT_PHONE CHAT_INCORRECT_CHAT_ID — некорректный аккаунт адресата (кроме номера WhatsApp): должен содержать от 1 до 200 символов
CHAT_INCORRECT_CHAT_ID_WHATSAPP — некорректный номер телефона для WhatsApp: должен содержать от 9 до 16 цифр
MESSAGE_CHANNEL_DISABLED MESSAGE_CHANNEL_BLOCKED
MESSAGE_WRONG_TRANSPORT Больше не используется
CHAT_WRONG_CHAT_TYPE — Некорректный тип чата
MESSAGE_CHANNEL_TARIFF_IS_NOT_ENOUGH MESSAGES_NOT_TEXT_FIRST

Вебхуки

URL для веб-хуков теперь устанавливается не в личном кабинете при добавлении интеграции, а запросом PUT https://api.wazzup24.com/v2/webhooks. Для изменения URL или отключения вебхуков переустанавливать интеграцию не нужно.

Подробнее об этом читайте в разделе «Подключение веб-хуков и получение текущего значения».

Новые сообщения (messages)

Измените поля и их значения в объектах:

Было Стало
guid messageId
channel Больше не используется
channelId — channelId канала
phone chatId
senderType authorType
refId refMessageId
username authorName
chatType — тип чата (мессенджера), “whatsapp” или “instagram”

Изменения состояния каналов (channels)

Измените поля и их значения в объектах:

Было Стало
channel plainId
channelId — channelId канала
transport — тип канала (мессенджер), “whatsapp” или “instagram”
senderType authorType
refId refMessageId
username authorName
chatType — тип чата (мессенджера), “whatsapp” или “instagram”

Прочее

Добавлены новые возможности:

  • Окно с чатом Wazzup;
  • Счетчик неотвеченных;
  • Получение списка доступных каналов для отправки сообщений;
  • Подключение вебхуков и получение текущего значения url;
  • Новые типы вебхуков:
    • Изменение списка каналов в интеграции;
    • Запрос на создание сделки пользователем;
  • Работа со списком пользователей;
  • Работа со списком сущностей в CRM.

Подробнее о всех функциях читайте в документации по новому API.