Wazzup База знаний по сервису

wz-help-logo-part

База знаний

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

Для отправки сообщений необходимо вызвать

 POST https://api.wazzup24.com/v3/message

В теле следует передавать параметры сообщения с указанием данных авторизации в заголовке.

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

Параметр Тип Описание
channelId String Id канала (uuidv4), через который нужно отправить сообщение
chatType String Тип канала. Доступные значения:

INSTAGRAM: ‘instagram’,

TELEGRAM: ‘telegram’,

Групповой чат в Telegram: ‘telegroup’,

WHATSAPP: ‘whatsapp’,

Групповой чат WhatsApp: ‘whatsgroup’

chatId String Id чата (аккаунт контакта в мессенджере):

  1. для whatsapp — только цифры, без пробелов и спец. символов в формате 79011112233
  2. для instagram — аккаунт без «@» вначале
  3. для группового чата WhatsApp (‘whatsgroup’) — приходит в вебхуках входящих сообщений
text String Текст сообщения. Обязателен, если не указан contentUri.
Для WhatsApp до 10 000 символов,
Для Instagram до 1000 символов
contentUri String Ссылка на файл для отправки. Обязателен, если не указан text. Контент должен скачиваться по ссылке без редиректов. Попытка скачать контент будет производиться сразу же после получения запроса, то есть можно делать короткоживущие ссылки. По типу и размеру контента могут быть ограничения, специфические для каждого мессенджера.
refMessageId String Id сообщения для цитирования. Необязательный параметр
crmUserId string id юзера СРМ, указанный с помощью CRUD users. Не обязательное.
Если указано, и если такой юзер уже существует, мы сохраним его id и имя, как при отправке через iframe
crmMessageId string идентификатор сообщения на стороне CRM. Нужен для придания роуту идемпотентности. Не обязателен.

Роут не идемпотентен! Повторные запросы с одним и тем же содержимым приведут к отправке нескольких одинаковых сообщений. Для защиты от возможного дублирования сообщений можно добавлять уникальное для сообщения свойство crmMessageId. Если оно было отправлено, то при поступлении другого запроса с этим же crmMessageId, сообщение не отправится, вернётся ошибка 400 Bad Request, { error: ‘repeatedCrmMessageId’, description: ‘You have already sent message with same crmMessageId’ }.

Важно! Для отправки шаблонов WABA в поле “text” необходимо передавать “код шаблона”, который можно получить в поддержке. Если в шаблоне есть переменные, то в момент отправки следует заменять их нужными значениями. Подробней о том, как добавить шаблон и о примерах использования, можно прочитать в статье.

Пример запроса

 curl --location --request POST 'https://api.wazzup24.com/v3/message' \
--header 'Authorization: Bearer c8cf90444023482f909520d454368d27' \
--header 'Content-Type: application/json' \
--data-raw '{
"channelId": "3376e1c3-26a6-478b-b964-72bf01cc22cb",
"chatType": "whatsapp",
"chatId": "79998887766",
"content": "https://example.com/images/img_01.png"
}
'

Ответ

Параметр
Тип Описание
messageId String Идентификатор сообщения

Указывается только при code=OK

Пример ответа

HTTP/1.1 201 OK

 HTTP/1.1 200 OK
{
"messageId": "e0629e11-0f67-4567-92a9-2237e91ec1b9"
}

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

Код ошибки Описание
MESSAGE_WRONG_CONTENT_TYPE Неверный тип контента. Возникает, если не удалось определить тип контента или он не поддерживается.
MESSAGE_ONLY_TEXT_OR_CONTENT В сообщении может быть текст или контент. Отправлять одновременно текст и контент в WhatsApp и Instagram нельзя.
MESSAGE_NOTHING_TO_SEND Текст сообщения не найден.
MESSAGE_TEXT_TOO_LONG Длина текстового сообщения превышает 10 000 символов.
MESSAGE_CONTENT_CAN_NOT_BE_BLANK Файл с контентом не может быть пустым.

Возникает при отправке нетекстового сообщения, к которому не приложили контент.

MESSAGE_CONTENT_SIZE_EXCEEDED Контент превышает допустимый размер 10 MB.
MESSAGE_TEXT_CAN_NOT_BE_BLANK Текстовое сообщение не может быть пустым.
CHANNEL_NOT_FOUND Канал, через который отправляется сообщение, не найден в интеграции.
CHANNEL_BLOCKED Канал, через который отправляется сообщение, выключен.
MESSAGE_DOWNLOAD_CONTENT_ERROR Не удалось скачать контент по указанной ссылке.
MESSAGES_NOT_TEXT_FIRST На тарифе «Старт» нельзя написать первым.
MESSAGES_IS_SPAM Wazzup оценил это сообщение, как спам.
CHAT_WRONG_CHAT_TYPE Неверный тип чата.

Возникает в случае, если вы отправляете исходящее сообщение в мессенджер, не входящий в список [INSTAGRAM, WHATSAPP, VK, TELEGRAM].

CHAT_MISSING_CHAT_TYPE chatType не передан.

Выберете тип чата из списка [INSTAGRAM, WHATSAPP, VK, TELEGRAM].

CHAT_INCORRECT_CHAT_ID_WHATSAPP Некорректный номер WhatsApp.

Номер телефона должен быть в международном формате: содержать от 9 до 16 цифр, для российских номеров начинаться с 7.

CHAT_MISSING_CHAT_ID chatId не передан.
VALIDATION_ERROR Валидационная ошибка параметра, переданного в запрос.
ACCOUNT_NOT_FOUND Аккаунт не найден в интеграции.
CONTACT_NOT_FOUND Контакт не найден среди контактов аккаунта — чат с таким номером телефона отсутствует.
CHANNEL_NO_MONEY Канал не оплачен и имеет статус «Не оплачен».
MESSAGE_CHANNEL_UNAVAILABLE Канал, с которого отправляется сообщение, недоступен.

У канала статус «Телефон недоступен» или «Подождите минутку».

CONTACT_DETAIL_NOT_FOUND Информация о контакте отсутствует.
MESSAGES_ABNORMAL_SEND Тип чата не соответствует источнику контакта.

Например, такая ошибка может возникнуть, если вы пытаетесь отправить сообщение с канала WhatsApp на канал Instagram.

MESSAGES_INVALID_CONTACT_TYPE Тип чата не соответствует источнику контакта Instagram.

Например, такая ошибка может возникнуть, если вы пытаетесь отправить сообщение с канала Instagram на канал WhatsApp.

MESSAGES_CAN_NOT_ADD Сообщение не было отправлено. Возникла непредвиденная серверная ошибка.
REFERENCE_MESSAGE_NOT_FOUND Ошибка возникает при цитировании, если не удалось найти сообщение, к которому прикрепляется цитата.

Проверьте, что в качестве refId передан идентификатор сообщения, полученный от Wazzup.

UNKNOWN_ERROR Неизвестная ошибка.

Обратитесь в поддержку.