Отправленное сообщение через API#

Формат сообщения, отправленного с API, идентичен формату входящего сообщения, при этом тип входящего уведомления принимает значение outgoingAPIMessageReceived.

Настройка инстанса

Чтобы получать входящие уведомления об отправленных через API сообщениях, необходимо включить настройки одним из представленных вариантов:

Через личный кабинет включить настройку Получать уведомления о сообщениях, отправленных через API (дополнительно Получать уведомления о статусах отправки/доставки/прочтении исходящих сообщений для получения уведомлений о статусах отправленного сообщения)
Через метод SetSettings включить настройку outgoingAPIMessageWebhook (дополнительно outgoingWebhook для получения уведомлений о статусах отправленного сообщения)

Пример тела уведомления#

Пример тела уведомления сообщения отправленного через API в личный чат#

{
  "typeWebhook": "outgoingAPIMessageReceived",
  "instanceData": {
    "idInstance": 4100000000,
    "wid": "79876543210@c.us",
    "typeInstance": "tgm"
  },
  "timestamp": 1763115112,
  "idMessage": "1763115112345",
  "senderData": {
    "chatId": "10000000",
    "sender": "10000000",
    "chatName": "Василиса Премудрая",
    "senderName": "Василиса Премудрая",
    "senderContactName": "Василиса Премудрая",
      "senderPhoneNumber": 79876543210
  },
    "messageData":{
       // В зависимости от typeMessage = textMessage || imageMessage || videoMessage || documentMessage || audioMessage  
       ...
       ...
       ...
    }
}

Пример тела уведомления сообщения отправленного через API в групповой чат#

{
  "typeWebhook": "outgoingAPIMessageReceived",
  "instanceData": {
    "idInstance": 4100000000,
    "wid": "79876543210@c.us",
    "typeInstance": "tgm"
  },
  "timestamp": 1763115112,
  "idMessage": "1763468266381",
  "senderData": {
      "chatId": "-10000000000000",
      "sender": "10000000",
      "chatName": "Тридесятое царство",
      "senderName": "Василиса",
      "senderContactName": "",
      "senderPhoneNumber": 0
  },
    "messageData":{
       // В зависимости от typeMessage = textMessage || imageMessage || videoMessage || documentMessage || audioMessage  
       ...
       ...
       ...
    }
}