Contains the payloads and descriptions for Inbound, Outbound, and Delivery Receipts for In-App.
In-App - Inbound Message
The following are the In-App inbound message payloads.
{
"x-wx-gtrid": "06XXXXf8-6XXd-4XX1-8XX2-24XXXXXXXX50",
"datetime": "2024-04-02T10:03:35.105+05:30",
"attachments": "",
"appId": "NEXXXXXX34",
"channel": "Rtm",
"replyTo": "",
"dataIntegration": {
"context": {
"check": "Data Stream Start Node",
"serviceId": "12345",
"serviceName": "My New Service",
"flowId": "54321",
"flowName": "Sample Flow",
"messagingAPI": "false"
},
"appContext": {
}
},
"event": "MO",
"message": "DS",
"userId": "2580",
"tid": "f5XXXX5a-aXX1-4XX0-8XX8-8dXXXXXXXXb7",
"ts": "2024-04-02T10:03:35.105+05:30"
}
{
"x-wx-gtrid": "a3XXXXce-3XX5-4XX4-9XX1-f3XXXXXXXXd4",
"datetime": "2024-04-02T11:08:57.380+05:30",
"attachments": "[{\"file\":\"https://stagingrtmedia.s3.amazonaws.com/ne05064134/97407654974538.doc\",\"size\":98304,\"id\":\"97407654974538\",\"contentType\":\"file\"}]",
"appId": "NEXXXXXX34",
"channel": "Rtm",
"replyTo": "",
"dataIntegration": {
"context": {
"check": "Data Stream Start Node",
"serviceId": "12345",
"serviceName": "Inapp_Frist",
"flowId": "54321",
"flowName": "DSFlow",
"messagingAPI": "false"
},
"appContext": {
}
},
"event": "MO",
"message": "",
"userId": "2580",
"tid": "a2XXXXf0-0XX0-4XXa-bXX6-d7XXXXXXXXXcd",
"ts": "2024-04-02T11:08:57.380+05:30"
}
{
"attachments": "",
"channel": "Rtm",
"interactiveData": "",
"dataIntegration": {
"context": {
"check": "post back start node",
"serviceId": "35378",
"serviceName": "Inapp_First",
"flowId": "36500",
"flowName": "DS2",
"messagingAPI": "false"
},
"appContext": {
}
},
"message": "Bookmark Item",
"userId": "2580",
"tid": "59XXXXf7-2XX1-4XXd-9XXe-80XXXXXXXX21",
"x-wx-gtrid": "95XXXX0f-2XX2-4XX0-9XX7-5fXXXXXXXX2b6",
"datetime": "2024-04-02T12:53:30.903+05:30",
"appId": "NE05064134",
"replyTo": "",
"event": "OnPostback",
"ts": "2024-04-02T12:53:30.903+05:30"
}
{
"connect_message_id": "fcXXXX48-9XXf-4XX7-8XXe-27XXXXXXXXf8",
"data": "",
"origin": "gateway",
"channel": "Rtm",
"dataIntegration": {
"context": {
"Team ": "Test"
},
"appContext": {
"tenant_identifier": "CampaignTopic",
"AuthURL": "https://login.microsoftonline.com/organizations/oauth2/v2.0/authorize",
"Topic": "dummy_data",
"webhookurl": "dummy_data",
"Name": ""
}
},
"clentId": "POXXXX3801/3XX2/v2_fc50XXXXXXXXXX5",
"userId": "",
"deviceId": "fc5XXXXXXXXX25a",
"version": "2",
"tid": "e3XXXX37-0XXe-4XX0-8XX1-ffXXXXXXXX8f_2",
"pciInfo": "",
"datetime": "2022-04-29T09:16:25.739Z",
"appId": "PO11153801",
"event": "OnGeoEnter",
"tenant": "1",
"ts": "2022-04-29T09:16:25.739Z"
}
{
"connect_message_id": "fcXXXX48-9XXf-4XX7-8XXe-27XXXXXXXXf8",
"data": "",
"origin": "gateway",
"channel": "Rtm",
"dataIntegration": {
"context": {
"Geoleave": "StartNode"
},
"appContext": {
"tenant_identifier": "CampaignTopic",
"AuthURL": "https://login.microsoftonline.com/organizations/oauth2/v2.0/authorize",
"Topic": "",
"webhookurl": "https://integrations.imiconnect.site/v1/integration/abcd12",
"Name": ""
}
},
"clentId": "POXXXX3801/3XX2/v2_fc50XXXXXXXXXX5a",
"userId": "",
"deviceId": "fc5XXXXXXXXX25a",
"version": "2",
"tid": "e3XXXX37-0XXe-4XX0-8XX1-ffXXXXXXXX8f_2",
"pciInfo": "",
"datetime": "2022-04-29T10:00:55.652Z",
"appId": "POXXXXXX01",
"event": "OnGeoLeave",
"tenant": "1",
"ts": "2022-04-29T10:00:55.652Z"
}
{
"origin": "gateway",
"channel": "Rtm",
"dataIntegration": {
"context": {
"check": "Start Node On thread closed",
"serviceId": "35378",
"serviceName": "Inapp_First",
"flowId": "36518",
"flowName": "DS3",
"messagingAPI": "false"
},
"appContext": {
}
},
"type": "Conversation",
"title": "DSS",
"userId": "2580",
"tid": "66XXXXfd-9XX5-4XX3-bXX2-49XXXXXXXXa8",
"threadId": "bfXXXX54-0XXb-4XX7-9XXd-cdXXXXXXXX2d",
"x-wx-gtrid": "c2XXXX9f-dXX8-4XXa-aXX6-ffXXXXXXX45",
"datetime": "2024-04-02T15:07:44.967+05:30",
"appId": "NEXXXX34",
"event": "OnThreadClosed",
"status": "Closed",
"ts": "2024-04-02T15:07:44.967+05:30"
}
{
"connect_message_id": "a8XXXXfd-cXX6-4XXe-aXXf-a5XXXXXXXXd5",
"data": "{\"sale\":true,\"city\":\"Hyderabad\",\"company\":\"IMImobile\",\"employees\":[{\"city\":\"Hyd\",\"name\":\"John\",\"age\":30}],\"age\":30}",
"origin": "gateway",
"channel": "Rtm",
"dataIntegration": {
"context": {
"check": "Start Node Custom Event",
"serviceId": "35378",
"serviceName": "InappR660Regression",
"flowId": "36548",
"flowName": "DS4",
"messagingAPI": "false"
},
"appContext": {
}
},
"clentId": "SDXXXXXX29/9XX9/v2_f9XXXXXXXXXXXX66",
"userId": "9XX9",
"deviceId": "f9XXXXXXXXXXXX66",
"version": "2",
"tid": "7bXXXX72-bXXf-4XX8-bXXe-87XXXXXXXXe7",
"x-wx-gtrid": "a3XXXX8d-7XXc-4XX6-9XXc-98XXXXXXXX53",
"datetime": "2024-04-02T17:45:12.636+05:30",
"appId": "SD31113129",
"event": "CUSTOM",
"tenant": "41012799",
"ts": "2024-04-02T17:45:12.636+05:30"
}
In-App - Inbound Message Descriptions
The following table contains the parameter descriptions of inbound messages.
| Field Name | Descriptions | Example | Event Type |
|---|---|---|---|
| x-wx-gtrid | Contains the global transaction ID between cross-products for a given request. | d7XXXX76-3XXa-4XXe-9XX3-d6XXXXXXXXf9 | Message and Attachments |
| datetime | Data and Time on which the message is received. | 2020-02-25T12:40:45.051+05:30 | Postback, Geo Enter, Geo Leave, OnThread Closed, and Custom Event |
| attachments | In-App attachment details | [{"file":"https://stagingrtmedia.s3.amazonaws.com/ne05064134/97407654974538.doc","size":98304,"id":"97407654974538","contentType":"file"}] | |
| Channel | This is “rt” in case of Live Chat and In-App Messaging. | RTM | Common parameter for all inbound event types. |
| appId | Contains the application ID. | a_63XXXXXXXXXXXXX000 | Common parameter for all inbound event types. |
| replyTo | Contains the details of the user to whom the message is being sent. | User1 | Message, Attachments and Postback |
| dataIntegration | The object contains key-value pairs which are added either by Data Stream admin or in flow and also app context object. | "dataIntegration": { "context": { "key1": "value1", "key2": "value2", "key3": "value3" }, “appContext”: { } } | Common parameter for all inbound event types. |
| context | The object contains key-value pairs which are added either by Data Stream admin or in flow. | "context": { "key1": "value1", "key2": "value2", "key3": "value3" } | Common parameter for all inbound event types. |
| serviceId | Contains the unique reference id of the service. | 12345 | Common parameter for all inbound event types. |
| serviceName | Contains the name of the service. | My New Service | Common parameter for all inbound event types. |
| flowId | Contains the unique ID for the flow. | 54321 | Common parameter for all inbound event types. |
| flowName | Contains the name of the flow. | Sample Flow | Common parameter for all inbound event types. |
| messagingAPI | Indicates whether the request is sent through messaging API. | true/false | Common parameter for all inbound event types. |
| appContext | The object is added as key-value pair either by Data Stream admin or in flow. | “appContext“: { “key1”: “value1“, “key2”: “value2“ } | Common parameter for all inbound event types. |
| event | Contains the incoming event type. | Incoming Message OnPostback OnGeoEnter OnGeoLeave OnThreadClosed Custom | |
| message | Contains the text message sent by the user. | Hi this is a LiveChat message | |
| userId | Unique identification number of the user. | 12345 | Common parameter for all inbound event types. |
| tid | Contains the transaction id. | cfXXXX81-2XXe-4XX5-9XXd-36XXXXXXXX3a | Common parameter for all inbound event types. |
| ts | Timestamp when MO received to Webex Connect. | 2022-01-17T10:59:51.945Z | Common parameter for all inbound event types. |
| clentId | Unique identification number of the client. | POXXXX3801/3XX2/v2_fc50XXXXXXXXXX5a | |
| pciInfo | Contains the PCI information of the user. | droppedAttachmentCount | Geo Enter and Geo Leave |
| deviceId | Unique identification number of the device. | fc5XXXXXXXXX25a | Geo Enter and Geo Leave |
| version | Version of the In-App REST API used for sending messages. | 1 | Geo Enter and Geo Leave |
| Name | Contains the name of the user. | Tom | Geo Enter and Geo Leave |
| status | Contains the status of the flow. | Closed | |
| title | Contains the title name | Buy Now |
In-App - Delivery Receipt
The following are the In-App delivery receipts payloads.
{
"deliveryInfoNotification": {
"deliveryInfo": {
"timeStamp": "2022-01-17T16:08:10.787+05:30",
"pushId": "dummy_data",
"Description": "Submitted",
"code": "7501",
"deliveryChannel": "rt",
"destination": "dummy_data",
"destinationType": "customerid",
"deviceid": "",
"deliveryStatus": "Submitted"
},
"subtid": "dummy_data",
"transid": "dummy_data",
"callbackData": "",
"correlationid": ""
},
"dataIntegration": {
"context": {
"Key": "Value",
"Key2": "Value2"
},
"appContext": {
"adminKey": "",
"tenant_identifier": "dummyTenant"
}
}
}
}
{
"deliveryInfoNotification": {
"deliveryInfo": {
"timeStamp": "2022-01-17T16:08:10.896+05:30",
"pushId": "",
"Description": "Delivered",
"code": "7500",
"deliveryChannel": "rt",
"destination": "dummy_data",
"destinationType": "customerid",
"deviceid": "dummy_data",
"deliveryStatus": "Delivered"
},
"subtid": "dummy_data",
"transid": "dummy_data",
"callbackData": "",
"correlationid": ""
},
"dataIntegration": {
"dataIntegration": {
"context": {
"Key": "Value",
"Key2": "Value2"
},
"appContext": {
"adminKey": "",
"tenant_identifier": "dummyTenant"
}
}
}
}
{
"deliveryInfoNotification": {
"deliveryInfo": {
"timeStamp": "2022-01-17T16:08:10.927+05:30",
"pushId": "",
"Description": "Read",
"code": "7502",
"deliveryChannel": "rt",
"destination": "dummy_data",
"destinationType": "customerid",
"deviceid": "dummy_data",
"deliveryStatus": "Read"
},
"subtid": "dummy_data",
"transid": "dummy_data",
"callbackData": "",
"correlationid": ""
},
"dataIntegration": {
"dataIntegration": {
"context": {
"Key": "Value",
"Key2": "Value2"
},
"appContext": {
"adminKey": "",
"tenant_identifier": "dummyTenant"
}
}
}
}
In-App - Delivery Receipt Descriptions
The following table contains the parameter descriptions of delivery receipts.
| Field Name | Description | Example | Message Type |
|---|---|---|---|
| x-wx-gtrid | Contains the global transaction ID between cross-products for a given request. | d7XXXX76-3XXa-4XXe-9XX3-d6XXXXXXXXf9 | Common parameter for all delivery receipts. |
| deliveryInfoNotification | System variable | N/A | Common parameter for all delivery receipts. |
| deliveryInfo | System variable | N/A | Common parameter for all delivery receipts. |
| timeStamp | Timestamp of the event | 2024-03-04T16:08:52.860+05:30 | Common parameter for all delivery receipts. |
| Description | Detailed description of the delivery status. | Message length exceeded | Common parameter for all delivery receipts. |
| code | Status code as mentioned in the documentation | 7107 | Common parameter for all delivery receipts. |
| deliveryChannel | Channel to be used to send message | In-App | Common parameter for all delivery receipts. |
| additionalinfo | Additional info such as details about the browser used to open a link in case of Click events. | Common parameter for all delivery receipts. | |
| destination | The mobile number to which message will be sent. | 174XXXX6048 | Common parameter for all delivery receipts. |
| destinationType | This is always msisdn for In-App. | customerid | Common parameter for all delivery receipts. |
| deliveryStatus | Status of messages once sent | Submitted | Common parameter for all delivery receipts. |
| subtid | A unique transaction id will be generated as subtid for the flow level transactions(or node tid). | 27XXXX95-dXXb-4XXc-8XXc-61XXXXXXX8fa | Common parameter for all delivery receipts. |
| transid | Unique transaction reference id of the request. | 93XXXX0b-0XX0-4XXb-aXXd-37fXXXXXXX4d | Common parameter for all delivery receipts. |
| callbackData | Data that you have configured to receive on the notify Url. This is configured as a part of the request | CallBackdata | Common parameter for all delivery receipts. |
| correlationid | The CorrelationID is a unique identifier that you can attach to every request as a reference a particular transaction or event. This is configured as a part of the request. | InAppMTusingmsisdn | Common parameter for all delivery receipts. |
| dataIntegration | The object contains key-value pairs which are added either by Data Stream admin or in flow and also app context object. | "dataIntegration": { "context": { "key1": "value1", "key2": "value2", "key3": "value3" }, “appContext”: { } } | Common parameter for all delivery receipts. |
| context | The object contains key-value pairs which are added either by Data Stream admin or in flow. | "context": { "key1": "value1", "key2": "value2", "key3": "value3" } | Common parameter for all delivery receipts. |
| serviceId | Contains the unique reference id of the service. | 12345 | Common parameter for all delivery receipts. |
| serviceName | Contains the name of the service. | My New Service | Common parameter for all delivery receipts. |
| flowId | Contains the unique ID for the flow. | 54321 | Common parameter for all delivery receipts. |
| flowName | Contains the name of the flow. | Sample Flow | Common parameter for all delivery receipts. |
| messagingAPI | Indicates whether the request is sent through messaging API | true/false | Common parameter for all delivery receipts. |
| appContext | The object is added as key-value pair either by Data Stream admin or in flow. | “appContext“: { “key1”: “value1“, “key2”: “value2“ } | Common parameter for all delivery receipts. |
In-App - Outbound Message
The following are the In-App outbound message payloads.
{
"transid": "1cXXXXcd-7XX0-4XX2-9XX7-24XXXXXXXXa4",
"channel": "RT",
"extras": {
},
"validateDestination": false,
"dataIntegration": {
"context": {
"check": "Data Stream Send Node",
"serviceId": "12345",
"serviceName": "My New Service",
"flowId": "54321",
"flowName": "Sample Flow",
"messagingAPI": "false"
},
"appContext": {
}
},
"priority": 5,
"message": "Send Node flow executed 01-04-2024",
"userId": "2XX0",
"tid": "1cXXXXcd-7XX0-4XX2-9XX7-249XXXXXXXXa4",
"threadid": "b5XXXX01-c2ee-4XXc-aXX0-01XXXXXXXX0b",
"clientUUID": "0aXXXX00-98ef-4XX5-bXX9-5eXXXXXXXX83",
"x-wx-gtrid": "7aXXXXa6-bXX5-6XX0-aXX8-bcXXXXXXXX6f",
"appId": "NEXXXXXX34",
"x_msg_seq": 0,
"serviceKey": "27XXXX75-eXX3-1XXe-aXX0-02XXXXXXXXd5"
}
{
"channel": "RT",
"extras": {
},
"validateDestination": false,
"dataIntegration": {
"context": {
"check": "Send Node with file",
"serviceId": "12345",
"serviceName": "Inapp_First",
"flowId": "54321",
"flowName": "DS2",
"messagingAPI": "false"
},
"appContext": {
}
},
"priority": 5,
"message": "Send Node with file",
"userId": "2XX0",
"tid": "1cXXXXcd-7XX0-4XX2-9XX7-249XXXXXXXXa4",
"threadid": "b5XXXX01-c2ee-4XXc-aXX0-01XXXXXXXX0b",
"clientUUID": "0aXXXX00-98ef-4XX5-bXX9-5eXXXXXXXX83",
"x-wx-gtrid": "7aXXXXa6-bXX5-6XX0-aXX8-bcXXXXXXXX6f",
"attachment": [
{
"preview": "https://sample-videos.com/img/Sample-jpg-image-50kb.jpg",
"file": "https://sample-videos.com/img/Sample-jpg-image-50kb.jpg",
"contentType": "image/jpg"
}
],
"appId": "NEXXXXXX34",
"x_msg_seq": 0,
"serviceKey": "27XXXX75-eXX3-1XXe-aXX0-02XXXXXXXXd5"
}
{
"transid": "a3XXXX3c-5XX0-4XXe-aXXd-edXXXXXXXX12",
"channel": "RT",
"extras": {
},
"validateDestination": false,
"dataIntegration": {
"context": {
"Check": "Post Back Send Node",
"serviceId": "12345",
"serviceName": "InappR_First",
"flowId": "54321",
"flowName": "DS3",
"messagingAPI": "false"
},
"appContext": {
}
},
"priority": 5,
"message": "Generic template",
"userId": "2XX0",
"tid": "1cXXXXcd-7XX0-4XX2-9XX7-249XXXXXXXXa4",
"threadid": "b5XXXX01-c2ee-4XXc-aXX0-01XXXXXXXX0b",
"clientUUID": "0aXXXX00-98ef-4XX5-bXX9-5eXXXXXXXX83",
"x-wx-gtrid": "7aXXXXa6-bXX5-6XX0-aXX8-bcXXXXXXXX6f",
"attachment": [
{
"templateType": "generic",
"payload": {
"reference": "Consent",
"elements": [
{
"buttons": [
{
"identifier": "12124",
"payload": "",
"type": "templatePostback",
"title": "Buy Now",
"url": ""
}
],
"subtitle": "Subtitle",
"imageUrls": [
"https://www.fnordware.com/superpng/pnggrad16rgb.png"
],
"title": "product"
}
]
},
"contentType": "template"
}
],
"appId": "NEXXXXXX34",
"x_msg_seq": 0,
"serviceKey": "27XXXX75-eXX3-1XXe-aXX0-02XXXXXXXXd5"
}
{
"quickReplies": {
"reference": "Consent",
"options": [
{
"identifier": "12321",
"payload": "",
"imageUrl": "https://www.fnordware.com/superpng/pnggrad16rgb.png",
"type": "quickReplyPostback",
"title": "Yes"
}
]
},
"transid": "2eXXXX09-1XX1-4XX9-9XX7-93XXXXXXXX25",
"channel": "RT",
"extras": {
},
"validateDestination": false,
"dataIntegration": {
"context": {
"check": "Send Node Quick Reply",
"serviceId": "12345",
"serviceName": "Inapp_First",
"flowId": "54321",
"flowName": "DS3",
"messagingAPI": "false"
},
"appContext": {
}
},
"priority": 5,
"message": "Quick reply Post back",
"userId": "2XX0",
"tid": "1cXXXXcd-7XX0-4XX2-9XX7-249XXXXXXXXa4",
"threadid": "b5XXXX01-c2ee-4XXc-aXX0-01XXXXXXXX0b",
"clientUUID": "0aXXXX00-98ef-4XX5-bXX9-5eXXXXXXXX83",
"x-wx-gtrid": "7aXXXXa6-bXX5-6XX0-aXX8-bcXXXXXXXX6f",
"appId": "NEXXXXXX34",
"x_msg_seq": 0,
"serviceKey": "27XXXX75-eXX3-1XXe-aXX0-02XXXXXXXXd5"
}
{
"transid": "2eXXXX09-1XX1-4XX9-9XX7-93XXXXXXXX25",
"channel": "RT",
"extras": {
},
"validateDestination": false,
"dataIntegration": {
"context": {
"check": "DS send node form",
"serviceId": "12345",
"serviceName": "Inapp_First",
"flowId": "54321",
"flowName": "DSFlow",
"messagingAPI": "false"
},
"appContext": {
}
},
"priority": 1,
"userId": "2XX0",
"tid": "1cXXXXcd-7XX0-4XX2-9XX7-249XXXXXXXXa4",
"threadid": "b5XXXX01-c2ee-4XXc-aXX0-01XXXXXXXX0b",
"clientUUID": "0aXXXX00-98ef-4XX5-bXX9-5eXXXXXXXX83",
"x-wx-gtrid": "7aXXXXa6-bXX5-6XX0-aXX8-bcXXXXXXXX6f",
"attachment": [
{
"templateType": "form",
"payload": {
"fields": [
{
"name": "Name",
"description": "enter name",
"label": "Name",
"type": "text",
"mandatory": false
},
{
"name": "Email",
"description": "email",
"label": "Email",
"type": "email",
"mandatory": false
},
{
"name": "Gender",
"options": [
"Male",
"Female"
],
"description": "",
"label": "Gender",
"type": "dropdown",
"mandatory": false
}
],
"title": "Student Form"
},
"templateId": "0W1XPWN2ND",
"contentType": "template"
}
],
"appId": "NEXXXXXX34",
"x_msg_seq": 0,
"serviceKey": "27XXXX75-eXX3-1XXe-aXX0-02XXXXXXXXd5"
In-App - Outbound Message Descriptions
The following table contains the parameter descriptions of outbound messages.
| Field Name | Descriptions | Example | Event Type |
|---|---|---|---|
| transid | Unique transaction reference id of the request. | 93XXXX0b-0XX0-4XXb-aXXd-37fXXXXXXX4d | Text, File, Postback, and Form Response |
| channel | This is “rt” in case of Live Chat and In-App Messaging. | RTM | Common parameter for all outbound message types. |
| extras | Contains the additional information like some user-specific property, or any custom parameter that is required to display the message in a certain fashion within the app | { "key1": "value1", "key2": "value2", "key3": "value3" } | Common parameter for all outbound message types. |
| validateDestination | System Variable | true/false | Common parameter for all outbound message types. |
| dataIntegration | The object contains key-value pairs which are added either by Data Stream admin or in flow and also app context object. | "dataIntegration": { "context": { "key1": "value1", "key2": "value2", "key3": "value3" }, “appContext”: { } } | Common parameter for all outbound message types. |
| context | The object contains key-value pairs which are added either by Data Stream admin or in flow. | "context": { "key1": "value1", "key2": "value2", "key3": "value3" } | Common parameter for all outbound message types. |
| serviceId | Contains the unique reference id of the service. | 12345 | Common parameter for all outbound message types. |
| serviceName | Contains the name of the service. | My New Service | Common parameter for all outbound message types. |
| flowId | Contains the unique ID for the flow. | 54321 | Common parameter for all outbound message types. |
| flowName | Contains the name of the flow. | Sample Flow | Common parameter for all outbound message types. |
| messagingAPI | Indicates whether the request is sent through messaging API. | true/false | Common parameter for all outbound message types. |
| appContext | The object is added as key-value pair either by Data Stream admin or in flow. | “appContext“: { “key1”: “value1“, “key2”: “value2“ } | Common parameter for all outbound message types. |
| priority | This parameter is used to specify the message priority. | 1 | Common parameter for all outbound message types. |
| message | Contains the text message sent by the user. | Hi this is a LiveChat message | Common parameter for all outbound message types. |
| userId | Unique identification number of the user. | 2480 | Common parameter for all outbound message types. |
| tid | Transaction ID | 234XXXXX-dXXX-4XXX-9XXX-c4bXXXXXXX20 | Common parameter for all outbound message types. |
| threadid | Unique identification number of the thread. | 12eXXXX26-9XX1-4XX7-bXXa-d9XXXXXXXX13 | Common parameter for all outbound message types. |
| clientUUID | Contains the clients unique identification number. | 9eXXXX26-9XX1-4XX7-bXXa-d9XXXXXXXXbd | Common parameter for all outbound message types. |
| x-wx-gtrid | Contains the global transaction ID between cross-products for a given request. | d7XXXX76-3XXa-4XXe-9XX3-d6XXXXXXXXf9 | Common parameter for all outbound message types. |
| appId | Contains the application ID | a_63XXXXXXXXXXXXX000 | Common parameter for all outbound message types. |
| x_msg_seq | This parameter represents whether the request should process sequence or not. | 0 | Common parameter for all outbound message types. |
| serviceKey | Unique identification number for the service. | 02XXXXd0-5XX7-1XXd-bXX8-12XXXXXXXX6d | Common parameter for all outbound message types. |
| templateType | Contains the information about the template type. Generic or Form | "templateType": "form", "templateType": "generic", | |
| payload | Contains the information about the payload. | payload": { "reference": "T-shirt options", "elements": [ //Maximum of 8 elements can be added. { "title": "Classic White T-Shirt", "subtitle": "Clothing", "imageUrls": [ //Maximum of 5 images can be added. "https://e7.pngegg.com/pngimages/464/597/png-clipart-logo-cisco-systems-router-network-switch-packet-tracer-logo-hmi-emblem-text-thumbnail.png" ], "buttons": [ //Maximum of 3 buttons can be added. { "type": "webUrl", "identifier": "21221-323232-231212", "url": "https://upload.wikimedia.org/wikipedia/commons/6/6a/PNG_Test.png", "title": "View Item", "payload": {} } | |
| type | Defines the type of the button. In case of a quick reply, it should be quickReplyPostback. | quickReplyPostback | Quick Reply |
| title | Specifies the bubble title. | Student Form | Form Response |