CPaaS Guide
CPaaS Guide
BlogLogin

Incoming Message Webhooks

Suggest Edits

Overview

These webhooks notify you when users respond through RCS—via clicks, text, media, files, contact cards, GIFs, or location sharing. Each event helps you capture user intent and continue the conversation. Supported Incoming Message Types are as below:

  • Suggestion button clicks
  • Text replies
  • Images
  • Videos
  • GIFs
  • Emojis
  • File uploads (VCF, others)
  • Location messages
  • Contact messages
URL suggestion button Click

{
  "incoming_message": [
    {
      "message_id": "Mxh8CX9e0WShe4JN-Hfinjhg",
      "from": "fG2uBk2yZaj3TkwN",
      "from_name": "abhishekmaurya_h9mcvAK3",
      "received_at": 1724739569843,
      "message_type": "click",
      "message_details": {
        "suggestionResponse": {
          "metadata": "{\"msgId\":\"api-337-919999999999-7d5506d8e1266f2aa7d7df34524bd749-1724677147\",\"a2pMsgDate\":\"2024-08-26T12:59:08.315\",\"templateCode\":\"temp_new_promo_12345\",\"templateType\":\"rich_card\",\"suggestionType\":\"url_action\",\"suggestionIndex\":0}",
          "postbackData": "Visit Now",
          "text": "Visit Now",
          "type": "ACTION"
        }
      },
      "to": "+919999999999",
      "nc_bot_id": "682"
    }
  ]
}

Dialer suggestion button Click

{
    "incoming_message": [
        {
            "from": "fG2uBk2yZaj3TkwN",
            "from_name": "abhishekmaurya_h9mcvAK3",
            "message_details": {
                "suggestionResponse": {
                    "metadata": "{\"msgId\":\"api-337-919999999999-7d5506d8e1266f2aa7d7df34524bd749-1724677147\",\"a2pMsgDate\":\"2024-08-26T12:59:08.315\",\"templateCode\":\"temp_new_promo_12345\",\"templateType\":\"rich_card\",\"suggestionType\":\"dialer_action\",\"suggestionIndex\":1}",
                    "postbackData": "Call Now",
                    "text": "Call Now",
                    "type": "ACTION"
                }
            },
            "message_id": "MxAyx=HIMWTRiRpjPwExDJYg",
            "message_type": "click",
            "received_at": 1724741398880,
            "to": "+919999999999",
            "nc_bot_id": "682"
        }
    ]
}

Reply suggestion button Click 

{
    "incoming_message": [
        {
            "from": "fG2uBk2yZaj3TkwN",
            "from_name": "abhishekmaurya_h9mcvAK3",
            "message_details": {
                "suggestionResponse": {
                    "metadata": "{\"msgId\":\"api-337-919999999999-7d5506d8e1266f2aa7d7df34524bd749-1724677147\",\"a2pMsgDate\":\"2024-08-26T12:59:08.315\",\"templateCode\":\"temp_new_promo_12345\",\"templateType\":\"rich_card\",\"suggestionType\":\"reply\",\"suggestionIndex\":2}",
                    "postbackData": "Click here to know more",
                    "text": "Click here to know more",
                    "type": "REPLY"
                }
            },
            "message_id": "MxZ15GoCiGTKqtm0O-0wPa9g",
            "message_type": "click",
            "received_at": 1724741521856,
            "to": "+919999999999",
            "nc_bot_id": "682"
        }
    ]
}


Text Message reply

{
    "incoming_message": [
        {
            "from": "fG2uBk2yZaj3TkwN",
            "from_name": "abhishekmaurya_h9mcvAK3",
            "message_details": {
                "text": "Hello"
            },
            "message_id": "Mx20OT9Mr0SfK3fJzPyU7FJg",
            "message_type": "text",
            "received_at": 1724741900534,
            "to": "+919999999999",
            "nc_bot_id": "682"
        }
    ]
}


Image file Upload by user

{
    "incoming_message": [
        {
            "from": "fG2uBk2yZaj3TkwN",
            "from_name": "abhishekmaurya_h9mcvAK3",
            "message_details": {
                "userFile": {
                    "payload": {
                        "fileName": "1000201703.jpg",
                        "fileSizeBytes": 83814,
                        "fileUri": "https://rcs-copper-ap.googleapis.com/b3a3ee36-f1ee-4455-9ed1-b26d8ef10c6d/273c760067ea3f185479f96b9707bee3fac3a07f838f70fec15f0aa84c8c",
                        "mimeType": "image/jpeg"
                    },
                    "thumbnail": {
                        "fileSizeBytes": 10099,
                        "fileUri": "https://rcs-copper-ap.googleapis.com/5aa0605a-a588-4fb6-b136-562a59044b0e/94633b8da4e63c2cfa3906ef0f5cfd283cef3cef9c1632180db151585fa2",
                        "mimeType": "image/jpeg"
                    }
                }
            },
            "message_id": "Mx5PXnDSegQxOnxZInZvGV0g",
            "message_type": "image",
            "received_at": 1724742093988,
            "to": "+919999999999",
            "nc_bot_id": "682"
        }
    ]
}


Video file Upload by user

{
    "incoming_message": [
        {
            "from": "fG2uBk2yZaj3TkwN",
            "from_name": "abhishekmaurya_h9mcvAK3",
            "message_details": {
                "userFile": {
                    "payload": {
                        "fileName": "1000176758.mp4",
                        "fileSizeBytes": 1203711,
                        "fileUri": "https://rcs-copper-ap.googleapis.com/395fdb36-00e2-45a9-baf6-3b4f765f825f/2cba9561295c6dd9a645be07d58588aa757e11540693d942ebb2d048216e",
                        "mimeType": "video/mp4"
                    },
                    "thumbnail": {
                        "fileSizeBytes": 10108,
                        "fileUri": "https://rcs-copper-ap.googleapis.com/e13db6d4-10d1-4467-b88e-92e84cb8f2ef/4670146055b45722c673c0c53e5e73598ad09289e7b81eb03451b762c635",
                        "mimeType": "image/jpeg"
                    }
                }
            },
            "message_id": "MxqxQRzgJOSWG3hC9eitzr3A",
            "message_type": "video",
            "received_at": 1724742280787,
            "to": "+919999999999",
            "nc_bot_id": "682"
        }
    ]
}

Emojis reply by user

{
    "incoming_message": [
        {
            "from": "fG2uBk2yZaj3TkwN",
            "from_name": "abhishekmaurya_h9mcvAK3",
            "message_details": {
                "text": "😃😁😃😃😃😁😁🤐"
            },
            "message_id": "MxkkkrE4ZATM2NK5W0GfLCFA",
            "message_type": "text",
            "received_at": 1724744176823,
            "to": "+919999999999",
            "nc_bot_id": "682"
        }
    ]
}



GIF reply by user

{
    "incoming_message": [
        {
            "from": "fG2uBk2yZaj3TkwN",
            "from_name": "abhishekmaurya_h9mcvAK3",
            "message_details": {
                "userFile": {
                    "payload": {
                        "fileName": "7181220953077861750.gif",
                        "fileSizeBytes": 1144897,
                        "fileUri": "https://rcs-copper-ap.googleapis.com/9ba73bbe-057d-417d-b2e3-f62f6067ba12/aea4d614c97df3f0cda792cf53a7f0a39c63d88e12149d9adb8615333823",
                        "mimeType": "image/gif"
                    }
                }
            },
            "message_id": "Mxk0WNHO6NRD-aEK42dSah8A",
            "message_type": "image",
            "received_at": 1724744510113,
            "to": "+919999999999",
            "nc_bot_id": "682"
        }
    ]
}

Location reply by user

{
    "incoming_message": [
        {
            "from": "fG2uBk2yZaj3TkwN",
            "from_name": "abhishekmaurya_h9mcvAK3",
            "message_details": {
                "location": {
                    "latitude": 19.19576758977053,
                    "longitude": 72.94772274792194
                }
            },
            "message_id": "MxwaW47jVBRFeMDNa48HYiHA",
            "message_type": "location",
            "received_at": 1724746081309,
            "to": "+919999999999",
            "nc_bot_id": "682"
        }
    ]
}

Contact as file type reply by user

{
    "incoming_message": [
        {
            "from": "fG2uBk2yZaj3TkwN",
            "from_name": "abhishekmaurya_h9mcvAK3",
            "message_details": {
                "userFile": {
                    "payload": {
                        "fileName": "3936477288186474789.vcf",
                        "fileSizeBytes": 77,
                        "fileUri": "https://rcs-copper-ap.googleapis.com/09e88240-a7eb-4e5e-b15e-577f10ec2ff3/646dbc78427c8a40fc66a510ebae4df561c35b1b8525d6e915a29c5b4a7f",
                        "mimeType": "text/x-vcard"
                    }
                }
            },
            "message_id": "Mx9vCK=Y7JRxiomKjpZoZHHA",
            "message_type": "text",
            "received_at": 1724746197898,
            "to": "+919999999999",
            "nc_bot_id": "682"
        }
    ]
}

Contact as text type reply by user

{
    "incoming_message": [
        {
            "from": "fG2uBk2yZaj3TkwN",
            "from_name": "abhishekmaurya_h9mcvAK3",
            "message_details": {
                "text": "Akash\n[Mobile] +919999999999"
            },
            "message_id": "MxD0kd3MteTLSKYngw5VhY0g",
            "message_type": "text",
            "received_at": 1724746552590,
            "to": "+919999999999",
            "nc_bot_id": "682"
        }
    ]
}

Updated 1 day ago