In this article, we will thoroughly examine the process of sending, editing, and deleting messages via the Wazzup API.

How to send messages

To send messages it is necessary to call:

POST https://api.wazzup24.com/v3/message
├── channelId *
├── chatType *
├── chatId
├── text
├── contentUri
├── refMessageId
├── crmUserId
├── crmMessageId
├── username
├── phone
├── clearUnanswered
├── templateId
├── templateValues[]
└── buttonsObject
    ├── buttons[]
    │   ├── text
    │   ├── type
    │   ├── url
    │   └── callbackData
    ├── replyMarkup
    ├── removeKeyboard
    └── oneTimeKeyboard

In the message body you should pass the parameters of the message with the authorization data in the header.

buttonsObject (object)

buttons (object)

If it was sent, then if another request with the same crmMessageId is received, the message will not be sent, the error 400 Bad Request, { error: 'repeatedCrmMessageId', description: 'You have already sent message with the same crmMessageId' } will be returned.

Important: In order to send WABA templates in the "text" field you must pass the "template code", which you can obtain from support. If there are variables in the template, you should replace them with the necessary values at the moment of sending. You can read more about how to add a template and examples of how to use it in the article.

Regular message request example

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 template request example

Request to submit a WABA template with 3 buttons. Each has a payload.

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 interactive message request example

In this request we send an interactive message with 3 buttons: "Yes", "No" and "Maybe". The buttons have no payload.

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: "Yes", type: "text"},
          {text: "No", type: "text"},
          {text: "Maybe", type: "text"}
      ]
    }
  },
});

Telegram Bot inline keyboard message

Each inline keyboard button must include either a callback_data or url parameter.

Button layout is defined in an array, which determines their arrangement both in rows and within each row.

Example:

This request body contains an inline keyboard with three buttons: "ONE", "TWO", and "THREE".

• The "ONE" button includes a url parameter.
• The "TWO" and "THREE" buttons include callback_data parameters.

The button layout consists of two rows:

• First row: "ONE" button;
• Second row: "TWO" and "THREE" buttons.

{
   "channelId": "3dbcc57d-de7d-43d9-8414-0f8b86aa2cf2",
   "chatType": "telegram",
   "chatId": "779064031",
   "text": "INLINE TEXT",
   "buttonsObject": {
       "replyMarkup": "inline",
       "buttons": [
           [
               {
                   "text": "ONE",
                   "url": "https://www.youtube.com"
               }
           ],
           [
               {
                   "text": "TWO",
                   "callbackData": "TWO"
               },
               {
                   "text": "THREE",
                   "callbackData": "THREE"
               }
           ]
       ]
   }
}

Messages with a custom Telegram Bot keyboard

Custom keyboard buttons only transmit text. Additional parameters are not transmitted.

The button layout is defined in an array, which specifies the order of placement both by row and within each row.

Example

This request body transmits a custom keyboard with three buttons: "ONE", "TWO", and "THREE". The oneTimeKeyboard parameter is also transmitted. The button layout consists of two rows:

• The first row contains the "ONE" button.
• The second row contains the "TWO" and "THREE" buttons.

{
   "channelId": "3dbcc57d-de7d-43d9-8414-0f8b86aa2cf2",
   "chatType": "telegram",
   "chatId": "779064031",
   "text": "INLINE TEXT",
   "buttonsObject": {
       "replyMarkup": "reply",
       "oneTimeKeyboard": true,
       "buttons": [
           [
               {
                   "text": "ONE"
               }
           ],
           [
               {
                   "text": "TWO"
               },
               {
                   "text": "THREE"
               }
           ]
       ]
   }
}

Message includes the parameter, which removes the current custom keyboard

This message includes the remove_keyboard parameter, which removes the current custom keyboard.

{
   "channelId": "3dbcc57d-de7d-43d9-8414-0f8b86aa2cf2",
   "chatType": "telegram",
   "chatId": "779064031",
   "text": "INLINE delete",
   "buttonsObject": {
       "replyMarkup": "reply",
       "removeKeyboard": true
   }
}

Response

If you send a template without a payload via the API, we will send the text of the corresponding button in the response message webhook. If you send an interactive message without a payload, we will send the button's serial number, starting from 0.

Response example

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

Errors when sending messages

If the request contains incorrect data or parameters, the system will return one of the following errors:

1. Invalid Parameter Values

If a parameter value does not meet the requirements (for example, channelId is not in UUID format, chatId is not a string, or chatType does not match the allowed values), the API will return the following error:

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

Solution: Check the validity of the parameter values being passed. The data.fields array will indicate the parameter that contains the error.

2. Mismatch Between Transport Type and Channel

If the request specifies a channelId with one transport type, but the chatType belongs to another transport, the API will return the following error:

{
    "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"
    }
}

Solution: Ensure that chatType matches the transport type specified in channelId.

3. Reusing crmMessageId

If the request includes a crmMessageId that was already used within the last 60 seconds, the API will return the following error:

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

Solution: Use unique crmMessageId values for each message. The system checks for duplicates within a 60-second window.

Editing Messages

Wazzup supports editing sent messages. You can change either the text or the attachment, but not both at the same time.

PATCH https://api.wazzup24.com/v3/message/:messageId
├── crmUserId
├── text
└── contentUri

Include the API key in the request header:

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

How to edit a message:

• Specify the new message text in the text field.
• If you need to replace the attachment, use contentUri.
• You cannot change both the text and the attachment simultaneously.

Example usage for text messages:

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": "Updated message text",
"crmUserId": "2e0df379-0e3c-470f-9b36-06b9e34c3bdb"
}'

Example usage for messages with attachments:

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"
}'

Deleting Messages

To delete a message, use the following method:

Include the API key in the request header:

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

Example of message deletion:

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