Медиа (изображение, аудио, видео, документ, стикер) - входящее сообщение

POST

https://ВашWebhook

На ваш URL приходит JSON запрос следующего формата.

CAUTION

Для получения статусов и входящих сообщений от абонента, Вам необходимо реализовать "приемщик" (webhook) на своей стороне, разместить на своем сервере и задать его методом SetWebhook

CHECK

"typeRequest": "inboxmsg"

типы

"type": "image" - Изображение
"type": "audio" - Аудио
"type": "video" - Видео
"type": "file" - Документ
"type": "sticker" - Стикер

INFO

Ссылка для скачивания медиа элемента доступна 7 суток

Request

Header Params

X-API-KEY

string

required

Ваш X-API-KEY, который вы задали через "Установить WebHook - setwebhook"

Example:

123

Body Params application/json

typeRequest

string

required

Тип запроса. Для входящих сообщений inboxmsg

Example:

inboxmsg

string

required

ID входящего сообщения

Example:

D6A10943-23F0-4CDB-ACFE-B11E0B8EE679

receivedAt

string

required

Дата и время сообщения

Example:

2024-12-20 12:38:36

channel

string

required

Номер канала на который отправлено сообщение

Example:

77009999999

payload

object

required

type

string

required

Тип входящего сообщения.

image - Для изображения
audio - Для аудио
video - Для видео
file - Для документов
sticker - Для стикеров

Example:

image

payload

object

required

sender

object

required

phone

string

required

Номер отправителя

Example:

77771234567

name

string

required

Никнейм в системе WhatsApp

Example:

Abai

context

object

required

Структура доступна если абонент процитировал ваше исходящее сообщение или переслал сообщение вам от другого абонента

string

required

ID вашего исходящего сообщения, которое цитирует абонент

Example:

POA10943-23F0-4CDB-ACFE-B11E0B8EE679

forwarded

string

required

true - абонент переслал вам это сообщение от другого абонента

Example:

false

frequently_forwarded

string

required

true - это часто пересылаемое сообщение

Example:

false

Example

{
  "typeRequest": "inboxmsg",
  "id": "D6A10943-23F0-4CDB-ACFE-B11E0B8EE679",
  "receivedAt": "2024-12-20 12:38:36",
  "channel": "77009999999",
  "payload": {
    "type": "image",
    "payload": {
      "text": "Вот моя картинка",
      "url": "https://filemanager.io/wa/d990d107-2071-4780-b1c7-ca3abfa58289/wa/media/942627793944084?download=false",
      "contentType": "image/jpeg"
    }
  },
  "sender": {
    "phone": "77771234567",
    "name": "Abai"
  },
  "context": {
    "id": "POA10943-23F0-4CDB-ACFE-B11E0B8EE679",
    "forwarded": "false",
    "frequently_forwarded": "false"
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://ВашWebhook' \
--header 'X-API-KEY: 123' \
--header 'Content-Type: application/json' \
--data-raw '{
    "typeRequest": "inboxmsg",
    "id": "D6A10943-23F0-4CDB-ACFE-B11E0B8EE679",
    "receivedAt": "2024-12-20 12:38:36",
    "channel": "77009999999",
    "payload": {
        "type": "image",
        "payload": {
            "text": "Вот моя картинка",
            "url": "https://filemanager.io/wa/d990d107-2071-4780-b1c7-ca3abfa58289/wa/media/942627793944084?download=false",
            "contentType": "image/jpeg"
        }
    },
    "sender": {
        "phone": "77771234567",
        "name": "Abai"
    },
    "context": {
        "id": "POA10943-23F0-4CDB-ACFE-B11E0B8EE679",
        "forwarded": "false",
        "frequently_forwarded": "false"
    }
}'

Responses

🟠404Record Not Found

text/html

Body

object {0}

Example

Сервис недоступен, попробуйте позднее

Modified at 2025-03-18 05:04:10

Текстовое входящее сообщение

Местоположение - входящее сообщение

Медиа (изображение, аудио, видео, документ, стикер) - входящее сообщение

На ваш URL приходит JSON запрос следующего формата.#

Request

Request samples

Responses

На ваш URL приходит JSON запрос следующего формата.