Полное описание запроса при входящем сообщении

POSThttps://kazinfoteh.orh/wasender/sendwamsg

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

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

:::check
"typeRequest": "inboxmsg"
:::

Request

Header Params

X-API-KEY

string

required

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

Example:

123

typeRequest

string

required

inboxmsg - Входящее сообщение (не статус сообщения)

Default:

inboxmsg

Example:

inboxmsg

string

required

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

Example:

01912729-09f5-79dc-b7c2-890036482836

receivedAt

string

required

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

Example:

2024-08-06 15:13:10

channel

string

required

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

Example:

77770229831

receiver

string

required

Номер телефона абонента

Example:

77771234567

msgType

enum<string>

required

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

Allowed values:

textimagestickervideoaudiodocumentlocationinteractivecontacts

Example:

image

uiUserName

string

required

UserName абонента в системе WhatsApp

Example:

Abai77kz

uiFirstName

string

required

FirstName абонента в системе WhatsApp

Example:

Абай

uiLastName

string

required

LastName абонента в системе WhatsApp

Example:

Дусенов

msgText

string

required

Текст сообщения

Example:

Привет, это мое сообщение

msgCaption

string

required

Текстовая подпись для изображения, видео или документа, только для msgType=
image
video
document

Example:

Моя картинка

msgAttachmentUrl

string

required

URL ссылка на контент. Только для типов msgType=
image
sticker
video
document
audio

*Ссылка действительна 7 суток

Example:

https://kazinfoteh.kz/upl/09CC4398-236C-4E42-88BE-E166258AB90D.jpeg

msgAttachmentName

string

required

Название файла, только для msgType=
document

Example:

Schet ot 2024-07.pdf

msgLocLongitude

string

required

Долгота, только для msgType=location

Example:

76.8147456

msgLocLatitude

string

required

Широта, только для msgType=location

Example:

43.2078848

msgLocAddress

string

required

Текстовый адрес (если есть на картах). Только для msgType=location

Example:

Алматы 40а

contactFirstName

string

required

FirstName контакта. Только для msgType=contacts

Example:

Алексей

contactLastName

string

required

LastName контакта. Только для msgType=contacts

Example:

Петров

contactFirstPhoneNumber

string

required

Основной номер телефона. Формат зависит от операционной системы и аппарата абонента. Только для msgType=contacts

Examples:

+7 701 123 4561+7 (702) 1234567

contactFirstWabaPhoneNumber

string

required

Если на номере телефона есть аккаут WhatsApp. Только для msgType=contacts

Example:

77011234567

contactFirstPhoneNumberType

string

required

Тип номера телефона. Значения зависят от операционной системы и аппарата абонента. Только для msgType=contacts

Examples:

CELLМобильныйДомашнийРабочий

contactSecondPhoneNumber

string

required

Второй номер телефона. Формат зависит от операционной системы и аппарата абонента. Только для msgType=contacts

Examples:

+7 701 123 4567+7 (701) 1234567

contactSecondWabaPhoneNumber

string

required

Если на втором номере телефона есть аккаут WhatsApp. Только для msgType=contacts

Example:

77771234567

contactSecondPhoneNumberType

string

required

Тип номера телефона. Значения зависят от операционной системы и аппарата абонента. Только для msgType=contacts

Examples:

CELLмобильныйдомашний

contactEmail

string

required

Email. Только для msgType=contacts

contactEmailType

string

required

Тип email адреса. Значения зависят от операционной системы и аппарата абонента. Только для msgType=contacts

Examples:

рабочийличный

itemsType

enum<string>

required

Тип нажатой кнопку
button_reply
list_reply
Только для msgType=interactive

Allowed values:

button_replylist_reply

Example:

button_reply

itemsIdentifier

string

required

Ваш индификатор элемента списка или кнопки, которую вы задали при отправке "Сообщение с кнопками ответа" или "Сообщение с списками" и на которую нажал абонент. Только для msgType=interactive

Example:

1YT1

itemsTitle

string

required

Название списка или кнопки, которую вы задали при отправке "Сообщение с кнопками ответа" или "Сообщение с списками" и на которую нажал абонент. Только для msgType=interactive

Example:

Подробнее

itemsSubtitle

string

required

Описание элемента списка, которую вы задали при отправке "Сообщение с списками" и на которую нажал абонент. Только для msgType=interactive и itemsType=list_reply

Example:

Шорты, размер XL

{
  "typeRequest": "inboxmsg",
  "id": "01912729-09f5-79dc-b7c2-890036482836",
  "receivedAt": "2024-08-06 15:13:10",
  "channel": "77770229831",
  "receiver": "77776662222",
  "msgType": "image",
  "uiUserName": "Abai",
  "uiFirstName": "",
  "uiLastName": "",
  "msgText": "",
  "msgCaption": "",
  "msgAttachmentUrl": "https://kazinfoteh.kz/upl/09CC4398-236C-4E42-88BE-E166258AB90D.jpeg",
  "msgAttachmentName": "",
  "msgLocLongitude": "",
  "msgLocLatitude": "",
  "msgLocAddress": "",
  "contactFirstName": "",
  "contactLastName": "",
  "contactFirstPhoneNumber": "",
  "contactFirstWabaPhoneNumber": "",
  "contactFirstPhoneNumberType": "",
  "contactSecondPhoneNumber": "",
  "contactSecondWabaPhoneNumber": "",
  "contactSecondPhoneNumberType": "",
  "contactEmail": "",
  "contactEmailType": "",
  "itemsType": "",
  "itemsIdentifier": "",
  "itemsTitle": "",
  "itemsSubtitle": ""
}

Request samples

Responses

Record Not Found(404)

HTTP Code: 404

Content Type : HTMLtext/html

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

Last modified: 4 months ago