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

В данной статье мы подробно рассмотрим процесс отправки, редактирования и удаления сообщений через API Wazzup.

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

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

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

В теле запроса нужно передавать

• ключ API в заголовке — он нужен для авторизации,
• параметры сообщения.

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

Роут не идемпотентен! Повторные запросы с одним и тем же содержимым приведут к отправке нескольких одинаковых сообщений.

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

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

Обычное сообщение

fetch("https://api.wazzup24.com/v3/message", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer {apiKey|sidecarApiKey}",
  },
  body: {
    channelId: "e0629e11-0f67-4567-92a9-2237e91ec1b9",
    refMessageId: "61e5a375-1760-452f-ad73-5318844ffc4f",
    crmUserId: "string-user-id",
    crmMessageId: "string-crm-message-id",
    chatId: "string-chat-id",
    chatType: "whatsapp",
    text: "message text"
  },
});

Шаблон WABA

Запрос на отправку шаблона WABA с 3 кнопками. У каждой есть полезная нагрузка.

fetch("https://api.wazzup24.com/v3/message", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer {apiKey|sidecarApiKey}",
  },
  body: {
    channelId: "24197d5f-06de-421f-8576-9f6e6cb67f28",
    chatType: "whatsapp",
    chatId: "79994621848",
    templateId: "6201005a-9a6f-486f-bdd5-e6cb86c76ddb",
    templateValues: ["value"]
    buttonsObject: {
     buttons: [
         { payload: "button_payload 1" },
         { payload: "button_payload 2" },
         { payload: "button_payload 3" }
     ]
    }
  },
});

В запросе для шаблонов WABA с кнопками не нужно прописывать текст кнопок. Они проходят модерацию вместе с основным текстом шаблона, поэтому кнопки нельзя менять.

buttonsObject пригодится, только если для кнопок нужно указать полезную нагрузку в поле payload. 

Интерактивное сообщение WABA

В этом запросе отправляем интерактивное сообщение с 3 кнопками: «Да», «Нет» и «возможно». У кнопок нет полезной нагрузки.

fetch("https://api.wazzup24.com/v3/message", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer {apiKey|sidecarApiKey}",
  },
  body: {
    channelId: "e0629e11-0f67-4567-92a9-2237e91ec1b9",
    refMessageId: "61e5a375-1760-452f-ad73-5318844ffc4f",
    crmUserId: "string-user-id",
    crmMessageId: "string-crm-message-id",
    chatId: "string-chat-id",
    chatType: "whatsapp",
    text: "message text",
    buttonsObject: {
     buttons: [
         {text: "Да", type: "text"},
         {text: "Нет", type: "text"},
         {text: "возможно", type: "text"}
     ]
    }
  },
});

Ответ

Если отправляете через API шаблон без полезной нагрузки, в вебхуке об ответном сообщении отправим текст соответствующей кнопки. Если отправляете интерактивное сообщение без полезной нагрузки — отправим порядковый номер кнопки, начиная с 0.

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

HTTP/1.1 201 OK 
{ 
    "messageId": "f66c53a6-957a-46b2-b41b-5a2ef4844bcb", 
    "chatId": "79999999999" 
}

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

Если запрос содержит некорректные данные или параметры, система вернет одну из следующих ошибок:

1. Некорректные значения параметров

Если переданное значение параметра не соответствует требованиям (например, channelId не в формате UUID, chatId не является строкой или chatType не соответствует допустимым значениям), API вернет ошибку:

{
    "status": 400,
    "requestId": "7ca68797d127735e72b066b0080e2cc0",
    "error": "INVALID_MESSAGE_DATA",
    "description": "Message data is invalid",
    "data": {
        "fields": [
            "channelId"
        ]
    }
}

Решение: Проверьте правильность значений передаваемых параметров. В data.fields будет указан параметр, в котором найдена ошибка.

2. Несоответствие типа транспорта и канала

Если в запросе указан channelId с одним транспортом, а chatType принадлежит другому транспорту, API вернет следующую ошибку:

{
    "status": 400,
    "requestId": "21a9be7692d378b0270e7fc1d993381a",
    "error": "WRONG_TRANSPORT",
    "description": "You can't send message to vk chat from whatsapp transport",
    "data": {
        "channelId": "dffa1c7b-6db8-4b8f-b559-91166aba879e",
        "transport": "whatsapp",
        "chatType": "vk"
    }
}

Решение: Убедитесь, что chatType соответствует транспорту, указанному в channelId.

3. Повторное использование crmMessageId

Если в запросе указан crmMessageId, который уже использовался в течение последних 60 секунд, API вернет следующую ошибку:

{
    "status": 400,
    "requestId": "c1005276e8a2b5aa23fcc94407d39f49",
    "error": "REPEATED_CRM_MESSAGE_ID",
    "description": "You have already sent message with same crmMessageId",
    "data": {
        "crmMessageId": "1"
    }
}

Решение: Используйте уникальные crmMessageId для каждого сообщения. Проверка на повтор длится 60 секунд.

Управление отправленными сообщениями

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

Редактирование сообщений

Wazzup поддерживает редактирование отправленных сообщений. Можно изменить текст или вложение, но не одновременно.

PATCH https://api.wazzup24.com/v3/message/:messageId

В заголовке запроса необходимо передавать API-ключ:

"Authorization": "Bearer {apiKey|sidecarApiKey}"

Как редактировать сообщение:

• В поле text укажите новый текст сообщения.
• Если нужно заменить вложение, используйте contentUri.
• Одновременно изменять текст и вложение нельзя.

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

curl 
--location 
--request PATCH 'https://api.wazzup24.com/v3/message/6f1b3c67-3008-488b-9abc-12fcac6de134' \
--header 'Authorization: Bearer {apiKey|sidecarApiKey}' \
--header 'Content-Type: application/json' \
--data '{
"text": "Обновленный текст сообщения",
"crmUserId": "2e0df379-0e3c-470f-9b36-06b9e34c3bdb"
}'

Пример использования для сообщений с вложением:

curl
--location 
--request PATCH 'https://api.wazzup24.com/v3/message/6f1b3c67-3008-488b-9abc-12fcac6de134' \
--header 'Authorization: Bearer {apiKey|sidecarApiKey}' \
--header 'Content-Type: application/json' \
--data '{
"contentUri": "https://example.com/image.png",
"crmUserId": "2e0df379-0e3c-470f-9b36-06b9e34c3bdb"
}'

Удаление сообщений

Чтобы удалить сообщение, используйте метод:

DELETE https://api.wazzup24.com/v3/message/:messageId

В заголовке запроса необходимо передавать API-ключ:

"Authorization": "Bearer {apiKey|sidecarApiKey}"

Пример удаления сообщения:

curl 
--location
--request DELETE 'https://api.wazzup24.com/v3/message/6f1b3c67-3008-488b-9abc-12fcac6de134' \
--header 'Authorization: Bearer {apiKey|sidecarApiKey}'