Skip to content

ื”ื•ื“ืขืช ื˜ืงืกื˜ ื™ื•ืฆืืช ืื• ื”ื•ื“ืขื” ืขื URL#

ื—ืœืง ื–ื” ืžืชืืจ ืืช ืคื•ืจืžื˜ ืื•ื‘ื™ื™ืงื˜ ื”-messageData ืฉืœ ื”-webhook ื”ื ื›ื ืก ืขื‘ื•ืจ ื”ื•ื“ืขืช ื˜ืงืกื˜ ื™ื•ืฆืืช ืขื URL. ืœืชื™ืื•ืจ ื”ืคื•ืจืžื˜ ื”ื›ืœืœื™ ืฉืœ ื”-webhooks ื”ื ื›ื ืกื™ื, ืขื™ื™ื ื• ื‘ื—ืœืง ื”ื•ื“ืขื•ืช ื™ื•ืฆืื•ืช.

ื›ื“ื™ ืœืงื‘ืœ webhooks ื ื›ื ืกื™ื ืžืกื•ื’ ื–ื”, ืฉื ื™ ื”ืชื ืื™ื ื”ื‘ืื™ื ื—ื™ื™ื‘ื™ื ืœื”ืชืงื™ื™ื:

typeWebhook = outgoingMessageReceived || outgoingAPIMessageReceived

messageData.typeMessage = extendedTextMessage

ื”ื’ื“ืจืช ืžื•ืคืข (instance)

ื›ื“ื™ ืœืงื‘ืœ ื”ืชืจืื•ืช ื ื›ื ืกื•ืช ืขืœ ื”ื•ื“ืขื•ืช ื˜ืงืกื˜ ืžื•ืจื—ื‘ื•ืช, ื™ืฉ ืœื”ืคืขื™ืœ ืืช ื”ื”ื’ื“ืจื•ืช ื‘ืืžืฆืขื•ืช ืื—ืช ืžื”ืืคืฉืจื•ื™ื•ืช ื”ื‘ืื•ืช:

  1. ื‘ืืžืฆืขื•ืช ื”ืงื•ื ืกื•ืœื” ื”ืคืขื™ืœื• ืืช ื”ื”ื’ื“ืจื•ืช Receive notifications about messages sent from API, Receive notifications about messages sent from the phone ื•-Receive notifications about edited messages.

  2. ื‘ืืžืฆืขื•ืช ืฉื™ื˜ืช SetSettings ื”ืคืขื™ืœื• ืืช ื”ื”ื’ื“ืจื•ืช outgoingAPIMessageWebhook, outgoingMessageWebhook ื•-editedMessageWebhook.

Webhook#

ืคืจืžื˜ืจื™ Webhook#

ืคืจืžื˜ืจื™ ืื•ื‘ื™ื™ืงื˜ messageData

Parameter Type Description
typeMessage string ืกื•ื’ ื”-webhook ื”ื™ื•ืฆื. ืขื‘ื•ืจ ื”ื•ื“ืขื•ืช ืžืกื•ื’ ื–ื”, ื”ืคืจืžื˜ืจ ืžืงื‘ืœ ืืช ื”ืขืจืš extendedTextMessage
extendedTextMessageData object ืื•ื‘ื™ื™ืงื˜ ืžื™ื“ืข ืขืœ ื”ืงื™ืฉื•ืจ ื”ื ื›ื ืก ืขื ืžื˜ื-ื“ืื˜ื”
quotedMessage object ืื•ื‘ื™ื™ืงื˜ ืžื™ื“ืข ืขืœ ื”ื”ื•ื“ืขื” ื”ืžืฆื•ื˜ื˜ืช. ืงื™ื™ื ืจืง ืื ื”ื”ื•ื“ืขื” ืขืฆืžื” ื”ื™ื ืฆื™ื˜ื•ื˜

ืคืจืžื˜ืจื™ ืื•ื‘ื™ื™ืงื˜ extendedTextMessageData

Parameter Type Description
text string ื˜ืงืกื˜ ื”ืงื™ืฉื•ืจ ืื• ื˜ืงืกื˜ ืจื’ื™ืœ
description string ืชื™ืื•ืจ ื”ืงื™ืฉื•ืจ, ื™ื›ื•ืœ ืœื”ื™ื•ืช ืจื™ืง
title string ื›ื•ืชืจืช ื”ืงื™ืฉื•ืจ, ื™ื›ื•ืœื” ืœื”ื™ื•ืช ืจื™ืงื”
containsAutoReply boolean ื”ืื ื”ื”ื•ื“ืขื” ืžื›ื™ืœื” ืชืฉื•ื‘ื” ืื•ื˜ื•ืžื˜ื™ืช (ืจืง ืœื”ื•ื“ืขื•ืช ืคืจืกื•ืžืช)
mediaType string ืกื•ื’ ื”ืžื“ื™ื” ืฉืœ ื”ื”ื•ื“ืขื”, ืœื“ื•ื’ืžื” "IMAGE" (ืจืง ืœื”ื•ื“ืขื•ืช ืคืจืกื•ืžืช)
showAdAttribution boolean ื”ืื ื™ืฉ ืœื”ืฆื™ื’ ืืช ืคืจื˜ื™ ื”ืคืจืกื•ืžืช (ืจืง ืœื”ื•ื“ืขื•ืช ืคืจืกื•ืžืช)
sourceId string ืžื–ื”ื” ื”ืคืจืกื•ืžืช (ืจืง ืœื”ื•ื“ืขื•ืช ืคืจืกื•ืžืช)
sourceType string ืกื•ื’ ื”ืžืงื•ืจ, ืœื“ื•ื’ืžื” "ad" (ืจืง ืœื”ื•ื“ืขื•ืช ืคืจืกื•ืžืช)
sourceUrl string ื›ืชื•ื‘ืช ื”-URL ืฉืœ ื”ืคืจืกื•ืžืช (ืจืง ืœื”ื•ื“ืขื•ืช ืคืจืกื•ืžืช)
conversionSource string ืœื•ืงืœื™ื–ืฆื™ื™ืช ื”ื”ื•ื“ืขื” (ืจืง ืœื”ื•ื“ืขื•ืช ืคืจืกื•ืžืช)
entryPointConversionApp string ืžืงื•ืจ ื”ื”ื•ื“ืขื” (ืจืง ืœื”ื•ื“ืขื•ืช ืคืจืกื•ืžืช)
jpegThumbnail string ืชืฆื•ื’ื” ืžืงื“ื™ืžื” ืฉืœ ืชืžื•ื ื” ื‘ืงื™ื“ื•ื“ base64, ื™ื›ื•ืœื” ืœื”ื™ื•ืช ื—ืกืจื”
thumbnailUrl string ื›ืชื•ื‘ืช ื”-URL ืฉืœ ืชืฆื•ื’ื” ืžืงื“ื™ืžื” ืฉืœ ืชืžื•ื ื” (ืจืง ืœื”ื•ื“ืขื•ืช ืคืจืกื•ืžืช)
isForwarded boolean ื”ืื ื”ื”ื•ื“ืขื” ื”ื•ืขื‘ืจื”, ืžืงื‘ืœ ืืช ื”ืขืจื›ื™ื true/false
forwardingScore integer ืžืกืคืจ ื”ื”ืขื‘ืจื•ืช ืฉืœ ื”ื”ื•ื“ืขื”
previewType string ืกื•ื’ ื”ืชืฆื•ื’ื” ื”ืžืงื“ื™ืžื” (ืจืง ืœื”ื•ื“ืขื•ืช ืคืจืกื•ืžืช) ื”ืขืจืš previewType:None ื”ื•ืฆื ืžืฉื™ืžื•ืฉ
ctwaClid string ืžื–ื”ื” ื”ืžืจื” ืฉืœ "ืœื—ื™ืฆื” ืœื•ื•ืื˜ืกืืค" ืžืคืจืกื•ืžืช. ืžืฉืžืฉ ืœืงื™ืฉื•ืจ ื”ืฉื™ื—ื” ืœืงืžืคื™ื™ืŸ ื”ืคืจืกื•ืžืช (ืจืง ืœื”ื•ื“ืขื•ืช ืคืจืกื•ืžืช)
automatedGreetingMessageShown boolean ืžืฆื™ื™ืŸ ืื ืœืžืฉืชืžืฉ ื”ื•ืฆื’ื” ื”ื•ื“ืขืช ื‘ืจื›ื” ืื•ื˜ื•ืžื˜ื™ืช (ืจืง ืœื”ื•ื“ืขื•ืช ืคืจืกื•ืžืช)
sourceApp string ื”ืืคืœื™ืงืฆื™ื” ืฉืžืžื ื” ื™ื–ืžื• ืืช ื”ืื™ื ื˜ืจืืงืฆื™ื” ืขื ื•ื•ืื˜ืกืืค: ืœื“ื•ื’ืžื”, Facebook, Instagram, ืื• ืืคืœื™ืงืฆื™ื™ืช Meta ืื—ืจืช. (ืจืง ืœื”ื•ื“ืขื•ืช ืคืจืกื•ืžืช)
originalImageUrl string ื”ืงื™ืฉื•ืจ ื”ืžืงื•ืจื™ ืœืชืžื•ื ื” ื”ืžืฉื•ื™ื›ืช ืœืคืจืกื•ืžืช. (ืจืง ืœื”ื•ื“ืขื•ืช ืคืจืกื•ืžืช)

ืคืจืžื˜ืจื™ ืื•ื‘ื™ื™ืงื˜ quotedMessage

Parameter Type Description
stanzaId string ืžื–ื”ื” ื”ื”ื•ื“ืขื” ื”ืžืฆื•ื˜ื˜ืช
participant string ืžื–ื”ื” ื”ืฉื•ืœื— ืฉืœ ื”ื”ื•ื“ืขื” ื”ืžืฆื•ื˜ื˜ืช
typeMessage string ืกื•ื’ ื”ื”ื•ื“ืขื” ื”ืžืฆื•ื˜ื˜ืช

ืฉืืจ ื”ืฉื“ื•ืช ืžืชืžืœืื™ื ื‘ื”ืชืื ืœืกื•ื’ ื”ื”ื•ื“ืขื” ื”ืžืฆื•ื˜ื˜ืช ื•ื–ื”ื™ื ืœืฉื“ื•ืช ืฉืœ ื”ื”ื•ื“ืขื•ืช ื”ื ื›ื ืกื•ืช ื”ืžืชื•ืืจื™ื ื‘ื—ืœืง ื”ื•ื“ืขื•ืช ื™ื•ืฆืื•ืช

Webhook body example#

Advertising outgoing message of target ad webhook body example#

{
        "typeWebhook": "outgoingMessageReceived",
        "idMessage": "3AC3BB68475D6EC5BBD1",
        "instanceData": {
            "idInstance": 1101000001,
            "wid": "79876543210@c.us",
            "typeInstance": "whatsapp"
        },
        "timestamp": 1785992892,
        "senderData": {
            "chatId": "71234567890@c.us",
            "sender": "79876543210@c.us",
            "senderName": "John",
            "senderContactName": "John Doe",
            "chatName": "Jane"
        },
        "messageData": {
            "typeMessage": "extendedTextMessage",
            "extendedTextMessageData": {
                "text": "Hello! I would like to place an order.",
                "description": ":thinking_face:Thinking about what to choose today?\n\Chat with clients in the best messenger on Earth.\nSales managers are ready to answer you.\n:mailto: support@green-api.com",
                "title": "Write to us",
                "previewType": "None",
                "jpegThumbnail": "",
                "forwardingScore": 0,
                "isForwarded": false,
                "containsAutoReply": false,
                "ctwaClid": "Afh6oztQClFhp ... bjQ",
                "greetingMessageBody": "Hello! We are happy to help you!",
                "mediaType": "VIDEO",
                "showAdAttribution": true,
                "automatedGreetingMessageShown": true,
                "sourceId": "120252186701100169",
                "sourceType": "ad",
                "sourceApp": "instagram",
                "sourceUrl": "https://www.instagram.com/p/187 ... xWK/",
                "originalImageUrl": "https://instagram.ftse3-2.fna.fbcdn.net/ ... =6A79CE3D",
                "entryPointConversionApp": "instagram",
                "thumbnailUrl": "https://instagram.ftse3-2.fna.fbcdn.net/ ... =6A79CE3D"
            }
        }
}