Receive Node

The receive node allows you to wait for a response from the user. The response can be a message, a voice call, or an event like a button click (for example, Accept button in an interactive push notification) or a selection from a list (for example, choosing an option from a List Picker on Apple Messages for Business).

You can also use the receive node to wait for external events to occur before resuming the flow. For example, a web application can resume the flow by invoking a custom event API when a user visits a website and fills an inquiry form.

87

Receive Node

Node Configuration

Double-click the node to configure it. Select the desired channel to wait for a message or a custom event to wait for an event. You can configure multiple channels/custom events on a single receive node.

Specify the duration (in seconds), in the Max Timeout field, for which the node waits to receive a message on the selected channel(s). If there is no incoming message/event within the specified time period, the flow exits the node from ontimeout edge.

1192

Receive Node Configuration

Channels and Events

The configuration window lists all the channels that the receiving node supports. The following table lists and explains all the required configurations for each of the channels:

Channel - Property/EventDescription
SMS An inbound message (through SMS) from the user resumes the flow
NumberThe number on which the user sends the message. This is the number you own on the platform.
KeywordA unique string received from the user to trigger the flow
From NumberThe number from which the user sends the message
Voice An inbound voice call from the user resumes the flow
Voice NumberThe number used to make outbound voice calls to the users. This is the number you own on the platform.
FromThe number from which the user makes a voice call
MMSAn inbound message (through MMS) from the user resumes the flow
NumberThe number on which the user sends the message. This is the number you own on the platform.
From NumberThe number from which the user sends the message
Messenger Message/EventAn inbound message (through Messenger) from the user resumes the flow
From PSIDThe PSID from which the user sends a message
Event Name:

Incoming Message

Postback
Incoming Message event is triggered when a message has been sent to your Page.

Postback occur when a postback button, Get Started button, or persistent menu item is tapped
Google Business Messages An inbound message (through Google Business Message) from the user resumes the flow.
From Conversation IDThe Conversation ID from which the user sends a message.
Event Name:

IncomingMessage

UserStatus

SuggestionResponse
This event occurs every time a user sends a text message with or without attachments to your Google Business Messages account.

This event is triggered when the user either starts typing while composing a message or requests for a live agent in the conversation with your Google Business Messages account.

This event occurs every time a user selects one of the suggested responses.
Instagram Message An inbound message (through Instagram) from the user resumes the flow.
From IGSIDThe IGSID from which the user sends a message.
Event Name:

Incoming Message

Postback

Delete Message
Incoming Message - This event occurs every time a user sends a text message with or without attachments to your Instagram account.

Postback - This event is triggered when user clicks postback type button.

Message Deleted - This event occurs every time a user sends a delete message to your Instagram account.
WhatsApp MessageAn inbound WhatsApp from the user resumes the flow.
From WhatsAppIDThe number from which the user sends a WhatsApp message
Sender NameThe username from which the message is sent
Event Name:

Incoming Message

Postback

List Message

Reply Buttons message
The event triggered by the user's response
If a user taps a quick reply button, postback event is be used to process the event
This event occurs every time a user selects one of the List Message options
This event occurs every time a user selects one of the Reply Buttons options
Custom Event The selected custom event resumes the flow along with post data from the event available as 'session data'
Custom EventThe trigger of the specified custom event resumes the flow
Resume KeyA unique key (per session) passed along with the custom event that resumes the flow
ValueA value for the resume key
Add Another Resume Key-ValueA button that lets you add another resume key-value pair
Live Chat / In-App MessagingAn inbound message within the app that resumes the flow
From (ThreadID)A variable that contains thread id of the incoming message on the app
From (UserID)The user id from which the app user sends the message
Event Name:

Incoming Message

Postback

Form Response
The event triggered by the user's response

When a user taps on a quick reply button, or a button of type postback within a template message, then the response is received back on the platform as a Postback event.

Note: If you are configuring the receive node to wait on multiple live chat / in-app message response types at once, configure the 'Form Response' message type as the first to be able to configure the Form Response Content Type and Form Template details. Due to a bug, you won't be able to configure these if you don't configure Form Response as the first response event.
Content Type:

Static

Dynamic
If Static is selected as Content Type, select the Form template to receive the Form Response

If Dynamic is selected as Content Type, the output variable corresponding to the form will hold the entire payload which is received as the Form Response
Form TemplateSelect the required template when the Content Type is Static
Email An inbound email from the user resumes the flow
From (EmailID)The email id from which the users sends the message​​​.
The platform will not trigger or resume a flow, nor trigger a rule or an outbound webhook notification for incoming emails where Sender Email ID is same as the Recipient Email ID. However, details of such incoming emails will be available within Export Logs.

For email sent via SMTP channel, we do not support delivery tracking.
Apple Messages for Business Message/EventAn inbound Apple Messages for Business message from the user resumes the flow
From (Apple Messages for Business ID)The id from which the user sends a message on Apple Messages for Business
Event Name:

Incoming Message

InteractiveMessageResponse: QuickReply

InteractiveMessageResponse: ListPicker

InteractiveMessageResponse: TimePicker

InteractiveMessageResponse: FormMessage

InteractiveMessageResponse: Payment

InteractiveMessageResponse: ClassicalAuthentication

InteractiveMessageResponse: NewAuthentication

InteractiveMessageResponse: iMessageApp
The event triggered by the user's response
RCS Message/Event An inbound RCS message/event from the user resumes the flow
From MSISDNThe mobile number from which the user sends a message an RCS message
Event Name:

Incoming Message

Postback Response

Incoming Attachment

Location Response
The event triggered by the user's response

Input Variables

You can see a list of all the flow variables available for use within this node under the Input Variables pane. You can also search for a variable using the Search field.

You can see the list of variables that you explicitly create and configure for this node under the Custom Variables pane. You can also add a custom variable to the flow using the Add New Custom Variable button. For more information, see Custom Variables.

1276

Input and Custom Variables

📘

Note

All the numbers in the To field are represented using the "E+164" format. This format displays the number with a "+" followed by the country code and the phone number. This is not applicable to the numbers in the From field.

Output Variables

The node-level variables are auto-generated by each node and can be referenced in other nodes later in the flow. The auto-generated output variables contain the data that a node produces when the flow execution passes through that node. These variables are prefixed with the node id allowing unique access to each of these variables. For example, the customer response that a receive node captures is stored in the nodeid.receive.message output variable.

📘

Note

The tables below provide a standard list of Receive Node and Start Node output variables.

The receive node has a set of output variables based on the channel.

👍

PCI and Malware Scanning related Output Variables

Please note that PCI and Malware scanning related Output Variables documented below are applicable and available only when Webex CC or CCE integration is enabled for your Webex Connect tenant.

For more information, see the following tables:

SMS Node Output Variables

Incoming EventOutput VariablesDescriptionExample
Mobile Originated - MOsms.keywordContains the keyword, if the incoming message has a keyword configured.Key
sms.serviceNumberThe user's number the customer is sending the message to.
Prefix the inbound number with the correct country code.
4.47521E+11
sms.messageIncoming text message from end-customer.Flow
sms.timestampRecord of the time when the request is received on Webex Connect platform. For e.g. 1582627917.2020-02-25T07:10:45.051Z
sms.transIdUnique identifier corresponding to the transaction.234190eb-df62-45c8-9281-c4b6f5b09c20
sms.senderNumberNumber of the customer's handset from where the incoming message is originating.9.19676E+11
On Link Clicksms.linkStatusActive
sms.timestampRecord of the time when the request is received on Webex Connect platform.2020-02-21T09:41:37.517Z
sms.transIdUnique identifier corresponding to the transaction.8f02482e-060c-4d07-8256-66791830e71c_85218130063343228
sms.senderNumberNumber of the customer's handset from where the incoming message is originating.9.19676E+11

🚧

Note

It is mandatory to use the exact country code (for example, +44, +1) as the prefix to the numbers. Numbers without country code may lead to error in the receive node. "0" is not accepted as a valid country code.

Voice Node Output Variables

Incoming EventOutput VariablesDescriptionExample
Missed Callvoice.timestampRecord of the time when the request is received on Webex Connect platform.1582627917
voice.transIdUnique identifier corresponding to the transaction.
voice.serviceNumberNumber on Webex Connect to which the call was placed.
voice.msisdnCustomer's number from which the call was placed.
voice.offeredOnTimestamp of the when the call was initiated.
voice.releasedOnTimestamp of end of the call.
voice.callTypeType of the call - Missed Call, IBD and OBD where IBD being inbound call and OBD being outbound call.

Messenger Node Output Variables

Incoming EventOutput VariablesDescriptionExample
Incoming messagemessenger.messageIncoming text message from end-customer.Text
messenger.psIdPage-scoped Identifier of a messenger, user used to reply back to end-customer. It gets generated on first incoming message from end-customer.Image, Video, GIFs
messenger.attachmentUrlURL of the first attachment in case of multiple attachments.https://scontent.xx.fbcdn.net/v/t1.15752-9/72730271_417889542250561_2125819214483685376_n.jpg?_nc_cat=103&_nc_ohc=V7t4vOxTCQYAX8iKoJA&_nc_ad=z-m&_nc_cid=0&_nc_zor=9&_nc_ht=scontent.xx&oh=3823f14c0eea111080f58d3ee4d8245c&oe=5EF6C203
messenger.attachments*The full attachment object available such as attachment type and media URL sent by the app user as part of the incoming message. May contain caption in case of Image.{"payload":{"url":"https://scontent.xx.fbcdn.net/v/t1.15752-9/72730271_417889542250561_2125819214483685376_n.jpg?_nc_cat=103&_nc_ohc=V7t4vOxTCQYAX8iKoJA&_nc_ad=z-m&_nc_cid=0&_nc_zor=9&_nc_ht=scontent.xx&oh=3823f14c0eea111080f58d3ee4d8245c&oe=5EF6C203"},"type":"image"},{"payload":{"url":"https://scontent.xx.fbcdn.net/v/t1.15752-9/49442028_304527510181624_4550358914847211520_n.png?_nc_cat=103&_nc_ohc=aftIRUGfVdsAX8iQbkB&_nc_ad=z-m&_nc_cid=0&_nc_zor=9&_nc_ht=scontent.xx&oh=65561f3e90e1570f7feaf27af7400cda&oe=5EC19C85"},"type":"image"}
messenger.locationUrlURL for the website where the user downloaded the location information.Location
messenger.locationLatitudeLattitude of the location shared by the customer.17.437008131462.
messenger.locationLongitudeLongitude of the location shared by the customer.78.39840389618.
messenger.locationTitleLocation Title.Daspalla D-Convention Hall, Road no: 37, Jubilee Hills, Hyderabad.
messenger.nameName of the messenger.Jack Suraj
messenger.profilePictureURL of the first attachment in case of multiple attachments.https://platform-lookaside.fbsbx.com/platform/profilepic/?psid=2534050010034596&width=1024&ext=1585393423&hash=AeSzgFDboc2HqIAm
messenger.appIdUnique identifier of the app from which the app user has sent the request.a_637183089024870000
messenger.timestampRecord of the time when the request is received on Webex Connect platform.1.5828E+12
messenger.transIdUnique identifier corresponding to the transaction.6bbe6cb4-73b6-4c26-a8b6-fe39c13fdf26_0
Postbackmessenger.postbackPayloadPostback payload identifies customer's response to a quick reply, button or a persistent menu tap.
messenger.psIdPage-scoped Identifier of a messenger, user used to reply back to end-customer. It gets generated on first incoming message from end-customer.
messenger.profilePictureURL of the first attachment in case of multiple attachments.
messenger.appIdUnique identifier of the app from which the app user has sent the request.
messenger.timestampRecord of the time when the request is received on Webex Connect platform.
messenger.transIdUnique identifier corresponding to the transaction.

MMS Node Output Variables

Incoming EventOutput Variables DescriptionExample
Mobile Originated - MOmms.serviceNumberThe user's number the customer is sending the message to. Prefix the inbound number with the correct country code.44 7111345232
mms.timestampRecord of the time when the request is received on Webex Connect platform. For e.g. 1582627917.

2020-02-25T07:10:45.051Z
mms.transIdUnique identifier corresponding to the transaction.234190eb-df62-45c8-9281-c4b6f5b09c20
mms.senderNumberNumber of the customer's handset from where the incoming message is originating.19052342345
receive.message Incoming text message from end-customer.Ducati
receive.channelIdentifies the channel from where the message has been received i.e. MMS.MMS
receive.payloadAny required value that is not included in any other output variable comes under payload.
receive.attachment

Instagram Node Output Variables

Incoming EventOutput VariablesDescriptionExample
Incoming Message, Postback, Message Deletedinstagram.messageIdIdentifier for messages sent from the end customer to the business account"messageId": "aWdfZAG1faXRlbToxOklHTWVzc2FnZAUlEOjE3ODQxNDU1NTM5NjA0NzQ4OjM0MDI4MjM2Njg0MTcxMDMwMDk0OTEyODE4NzA2OTgxOTg2OTI4NDozMDY4Nzg2MzU1NzM1OTI1MDY4MTA0OTUxMTc5NDU3MzMxMgZDZD"
Incoming Eventsinstagram.messageIncoming text message from end-customer.Text Message: "Hi"
Postbackinstagram.payloadPostback payload that identifies customer's response to a quick reply, template button."quickReplyPayload": "{"payload":"Add to cart","title":"Add to card"}",
Postbackinstagram.titleTitle of the Instagram account holder.
Postback, Incoming Message, Message Deletedinstagram.igsid Page-scoped Identifier of an Instagram user used to reply back to end-customer. It gets generated on first incoming message from end-customer.
Identifier for messages sent from the end customer to the business account
* Identified for messages deleted from the business account.
"igsid": "5275638769194520"
Postback, Incoming Message, Message Deletedinstagram.igid Page-scoped Identifier of an Instagram Business account used to reply to end-customer. It gets generated on first incoming message from end-customer.
Page-scoped Identifier of an Instagram Business account used to reply to end-customer. It gets generated on first incoming message from end-customer.
* Page-scoped identifier of an Instagram Business account used to delete a message from the customer.
“igid”: “17841454028327633“
Postback, Incoming Message, Message Deletedinstagram.timestamp Record of the time when the request is received on Webex Connect platform.
Record of the time when the request is sent from the Webex Connect platform.
* Record of the time when the message is deleted from the Webex Connect platform.
"timestamp": "1663597769637"
Postback, Incoming Message, Message Deletedinstagram.event* To identify the event type - postback, incoming, or message deleted."event": "MO" ,
"event": "OnPostback",
"event": "OnMessageDeleted",
Postback, Incoming Message, Message Deletedinstagram.userIdThe unique identifier of the app user."userId": "",
Postback, Incoming Message, Message Deletedinstagram.appIdUnique identifier of the app from which the app user has sent the request."appId": "a_637989151073720000",
Postbackinstagram.quickReplyPayloadPayload that identifies the business account's response to the customer's quick reply."quickReplyPayload": "{"payload":"Order status"}"
Incoming Messageinstagram.attachmentThe full attachment object available such as images, videos, locations, files etc. sent by the app user as part of the incoming message."attachment": "`{"payload":{"url":"https://lookaside.fbsbx.com/ig_messaging_cdn/?asset_id=1671821199864696&signature=AbzzQo9GUu0Ca9prExszWgmwdrEXjvxRgW74CwYj53axqORubYJNapprzYMzZ2J4iW65I0VVYyTC-ayR9LGtmQchQsljxhLaNF8jnyLNgE-4F5O0CVU2eCYesdXJV_cXPZJYQnFIHE43uOW9ehdipjggYglEUmG2PgJG5_QMmphrdOycd8c1mAzvjmfKBNHMV5QRI37Q-gtXbotihRyvi-iY-xCJSqg"},"type":"image"}]",
Postback, Incoming Message, Message Deletedinstagram.messageIdContains the message Id for the message."messageId": "aWdfZAG1faXRlbToxOklHTWVzc2FnZAUlEOjE3ODQxNDU0MDI4MzI3NjMzOjM0MDI4MjM2Njg0MTcxMDMwMDk0OTEyODMwNjQwMjE1NjYyMzExMDozMDY4Nzk2OTMwMjU3ODk3OTU1MzAwNjU2NDU5ODA4NzY4MAZDZD",
Incoming Messageinstagram.attachmentTypeType of attachment i.e. image, gif, quick reply, and video."attachmentType": "image",

"attachmentType": "audio",

"attachmentType": "video",
Incoming Messageinstagram.attachmentUrlURL of the first attachment in case of multiple attachments."attachmentUrl": "https://lookaside.fbsbx.com/ig_messaging_cdn/?asset_id=17964232888925487&signature=AbzxYfPgbyrbgqvQ4zWLayyMJo4fAM7JjR5atpeCLOQdFX5d3hObq1fw-kPBLDkyHiyYyTPbaOnzhVCPBrG9preKkdHA2W8sl0lCs7g8fWk2uaZ-lSu8MSnabAFfH91vWelUJl-8x_NN9ZEBOVTzThpbouP21CJA-IcOh_ODV79wAHaaLfB8v63XqgXv71fnXxKoA-gXneNwYxm3Y9r2nnWg6Na2gK8W",
Incoming Messageinstagram.storyReplyUrlURL of the posted story’s reply from the end customer."storyReplyUrl": "https://lookaside.fbsbx.com/ig_messaging_cdn/?asset_id=17950801241174150&signature=AbzpNim0D-dMzZRWWmeGvcLBXGX8LjdfMHiS6_I6h_uXw8DslIq_INYv5HK2-dSGmANs3NaT2mraLIvKSVZoFAMl8Te-O9ahYqnmGlpaHDHxZInTCAjjBR6Ecao82ajuDF4c8Vuz9YjLemhC1Ct1L0ucQUPrCPH99xjWkTTA67PxHskgvuy95vS_MgPk1kNQF5Veqcb0Od-s6Jo8kspWRsNs16IXFflt"
Incoming Messageinstagram.repliedMessageIdUnique identifier of the reply received from the end customer."repliedMessageId": "aWdfZAG1faXRlbToxOklHTWVzc2FnZAUlEOjE3ODQxNDU0MDI4MzI3NjMzOjM0MDI4MjM2Njg0MTcxMDMwMDk0OTEyODMwNjQwMjE1NjYyMzExMDozMDY4Nzk3NjU3MjczMjk5Njk4MTMyNDM0MjA1MTczMzUwNAZDZD",
Incoming Messageinstagram.reactionUnique identifier of the emoticon reply received from the end customer."reaction": "{"reaction":"love","emoji":"❤️","action":"react"}",

Google Business Messages Node Output Variables

Incoming EventOutput VariablesDescriptionExample
MO
Image
Suggestion Response
User Status
gbm.responseType“event”: MO
“event”: attachment
“event”:SuggestionResponse
“event”: UserStatus
MO
Image
Suggestion Response
User Status
gbm.displayNameThe name of the user who sent the message. If the user opts out of identity sharing, this field is empty.“displayName”: webex connect
MO
Image
Suggestion Response
User Status
gbm.resolvedLocaleThe best computed match of the user's locale (reported in userDeviceLocale) and the agent's supported locales (determined by specified conversational settings). See Localization and Begin the conversation.
The locale value is a well-formed IETF BCP 47 language tag.
“resolvedLocale":en
MO
Image
Suggestion Response
User Status
gbm.entryPointThe messaging surface the user began the conversation from, as defined by EntryPoint."entryPoint": MAPS
"entryPoint":SHOPPING
"entryPoint":URL
MO
Image
Suggestion Response
User Status
gbm.deflectedPhoneNumberThe phone number that Business Messages deflected the user from calling when the conversation started.
MO
Image
Suggestion Response
User Status
gbm.customContextContext data specified by the partner.
MO
Image
Suggestion Response
User Status
gbm.timestamp (sendTime) Record of the time when the request is received on Webex Connect platform.
Record of the time when the request is sent from the Webex Connect platform.
* Record of the time when the message is deleted from the Webex Connect platform.
"timestamp": "1663597769637"
MO
Image
Suggestion Response
User Status
gbm.placeIdA unique identifier from the Google Places database for the location that the user messaged. It only appears in messages from location-specific entry points.“placeId":ChIJn79NMNQEdkgRwFGArS-EXd4
MO
Image
Suggestion Response
User Status
gbm.nearPlaceIdA unique identifier from the Google Places database for the first location in a Local Pack. Confirm the locations that users want to chat with when you receive nearPlaceId values.
MO
Image
Suggestion Response
User Status
gbm.appIdUnique identifier of the app from which the app user has sent the request."appId": "a_637989151073720000",
MO
Image
Suggestion Response
User Status
gbm.widgetUrlThe URL of the website where the conversational surface launched.
MO
Image
Suggestion Response
User Status
gbm.widgetContextThe data-bm-widget-context attribute value of the widget used to start the conversation.
MO
Image
Suggestion Response
User Status
gbm.transIdThe unique identifier of the transaction"tid": "b466b657-3685-4c81-aa50-d9747c709cd8"
MO
Image
Suggestion Response
User Status
gbm.conversationIdThe unique identifier of the conversation"conversationId": "013e05a7-a3df-4fb0-aea2-73e78bfda115"
MO
Image
Suggestion Response
User Status
gbm.requestId"messageId": "73c8a5e6-cea1-4026-a02a-5db01275acdd-1678177067839"
MO
Image
Suggestion Response
User Status
gbm.agentIdThe unique identified of the agent"agentId": "0982a814-0651-4d2c-8982-a6b8b5de38f3"
MO
Image
Suggestion Response
User Status
gbm.customAgentIdimimobile-demo
MO
Image
Suggestion Response
User Status
service.serviceKey54251909-59b9-11ed-9c39-02a06e0e48bf
MO
Image
Suggestion Response
User Status
gbm.suggestionType“type":REPLY
“type":ACTION
MO
Image
Suggestion Response
User Status
gbm.requestedLiveAgent“requestedLiveAgent":true
MO
Image
Suggestion Response
User Status
gbm.postbackData“postbackData”: “url opened successfully”
User Statusgbm.isTyping“isTyping": true
MOgbm.text“message" : “Hello”

WhatsApp Node Output Variables

Incoming EventOutput VariablesDescriptionExample
Incoming Messagewhatsapp.messageIncoming text message from end-customer.Hello
whatsapp.waIdThe WhatsApp number of the end-customer.9.19964E+11
whatsapp.attachmentTypePublic url of the uploaded attachment.Image, audio, video, document, and contact
whatsapp.locationAddressFull address of the location.IMI Mobile, Plot No 770, Rd Number 44, Hyderabad, Telangana 500033
whatsapp.locationLatitudeLocation Latitude.17.434715270996
whatsapp.locationLongitudeLocation Longitude.78.3984832763671
whatsapp.locationNameURL for the website where the user downloaded the location information.IMI Mobile
whatsapp.locationUrlURL for the website where the user downloaded the location information.
whatsapp.imageUrlURL of the image.
whatsapp.mimeTypeMime type of the attachment.
whatsapp.captionCaption, if present along with image and video.
whatsapp.documentUrlDirect URL of the attachment ending with file type.
whatsapp.voiceUrlDirect URL of the attachment ending with file type.
whatsapp.audioUrlDirect URL of the attachment ending with file type.
whatsapp.attachments*The full attachment object available such as attachment type and media URL etc. sent by the app user as part of the incoming message.. May contain caption in case of image.
whatsapp.appIdUnique identifier of the app from which the app user has sent the request.
whatsapp.timestampRecord of the time when the request is received on Webex Connect platform.
whatsapp.contextIdRemoved
whatsapp.systemBodyRemoved
whatsapp.transIdUnique identifier corresponding to the transaction.
whatsapp.videoUrlDirect URL of the attachment ending with file type.
whatsapp.contactsFull contact object containing addresses, phone numbers, emails etc.Addresses: Array
Birthday: YYYY-MM-DD formatted string
Contact_image: Base64-encoded image
Emails: Array
IMS: Array
Name: Array
Org: Array
Phones: Array
URLs: Array
whatsapp.usernameThe username of the sender.
Postbackwhatsapp.waIdThe WhatsApp number of the end-customer+919876543210
whatsapp.buttonPayloadDeveloper-defined payload that will be returned when the button is clicked in addition to the display text on the button
whatsapp.buttonTextThe button text that you have used while creating the template
whatsapp.contextId
whatsapp.appIdUnique identifier of the app from which the app user has sent the request
whatsapp.timestampRecord of the time when the request is received on Webex Connect platform.
whatsapp.transIdUnique identifier corresponding to the transaction.
List Messagewhatsapp.waIdThe WhatsApp number of the end-customer.
whatsapp.listRowTitle
whatsapp.listRowIdentifier
whatsapp.listDescription
whatsapp.usernameThe username of the sender.
whatsapp.contextId
whatsapp.type
whatsapp.appIdUnique identifier of the app from which the app user has sent the request.
whatsapp.timestampRecord of the time when the request is received on Webex Connect platform.
whatsapp.transIdUnique identifier corresponding to the transaction.
Reply Buttons whatsapp.waIdThe WhatsApp number of the end-customer
whatsapp.replyButtonIdentifier
whatsapp.replyButtonTitle
whatsapp.usernameThe username of the sender.
whatsapp.contextId
whatsapp.type
whatsapp.appIdUnique identifier of the app from which the app user has sent the request.
whatsapp.timestampRecord of the time when the request is received on Webex Connect platform.
whatsapp.transIdUnique identifier corresponding to the transaction.

📘

Note

WhatsApp.caption is only supported for image attachment

In-app Messaging Node Output Variables

Incoming EventOutput VariablesDescriptionExample
Custom Eventinappmessaging.userIdThe unique identifier of the app user.
inappmessaging.payloadAny required value that is not included in any other output variable comes under payload.
inappmessaging.appIdUnique identifier of the app from which the app user has sent the request.
inappmessaging.timestampRecord of the time when the request is received on imiconnect platform.
inappmessaging.extrasContains additional information received in the message
inappmessaging.transIdUnique identifier corresponding to the transaction, which is the custom event in this case.
inappmessaging.formResponseCaptures the response received on the pre-chat form
inappmessaging.formFields.IssueThe issue/reason stated on the pre-chat form
inappmessaging.formFields.DateThe date on which the pre-chat form was submitted
Geo Enterinappmessaging.userIdThe unique identifier of the app user.
inappmessaging.geofenceIdUnique identifier corresponding to a geofence.
inappmessaging.appIdUnique identifier of the app from which the app user has sent the request.
inappmessaging.timestampRecord of the time when the request is received on Webex Connect platform.
inappmessaging.transIdUnique identifier corresponding to the transaction, which is the event when an app user enters a specific geofence.
Geo Leaveinappmessaging.userIdThe unique identifier of the app user.
inappmessaging.geofenceIdUnique identifier corresponding to a geofence.
inappmessaging.appIdUnique identifier of the app from which the app user has sent the request.
inappmessaging.timestampRecord of the time when the request is received on Webex Connect platform.
inappmessaging.transIdUnique identifier corresponding to the transaction, which is the event when an app user leaves a specific geofence.
Incoming Messageinappmessaging.timestampRecord of the time when the request is received on Webex Connect platform.
inappmessaging.userIdThe unique identifier of the app user.
inappmessaging.threadIdThe unique identifier corresponding to a thread.
inappmessaging.completedOn
inappmessaging.threadTitleThe name set as the title of a thread.
inappmessaging.threadStatusThe status of the thread converying whether the thread is in open state or closed.
inappmessaging.messageIncoming message by the end-customer.
inappmessaging.attachmentThe full attachment object available such as images, videos, locations, files etc. sent by the app user as part of the incoming message.
inappmessaging.version
inappmessaging.deviceIdUnique identifier correspnding to the device from which the app user has sent the message.
inappmessaging.origin
inappmessaging.appIdUnique identifier of the app from which the app user has sent the request.
inappmessaging.transIdUnique identifier corresponding to the transaction, which is the custom event in this case.
Interactive Message Responseinappmessaging.timestampRecord of the time when the request is received on Webex Connect platform.
inappmessaging.userIdThe unique identifier of the app user.
inappmessaging.pushIdThe token generated by FCM or APNS at the time of user registration.
inappmessaging.pushTypeThe type of push notification, conveying whether it's a silent or normal push notification.
inappmessaging.interactivePushResponseThe response or the button tapped on by the user within the interactive notification.
inappmessaging.appIdUnique identifier of the app from which the app user has sent the request.
inappmessaging.transIdUnique identifier corresponding to the transaction, which is the custom event in this case.
Location Changeinappmessaging.timestampRecord of the time when the request is received on Webex Connect platform.
inappmessaging.userIdThe unique identifier of the app user.
inappmessaging.completedOn
inappmessaging.deviceIdUnique identifier correspnding to the device from which the app user has sent the message.
inappmessaging.origin
inappmessaging.version
onLinkClick
On Network Changeinappmessaging.completedOn
inappmessaging.version
inappmessaging.timestampRecord of the time when the request is received on Webex Connect platform.
inappmessaging.deviceIdUnique identifier correspnding to the device from which the app user has sent the message.
inappmessaging.origin
inappmessaging.userIdThe unique identifier of the app user.
Node outcomesThis is not an output variable.
On Web Push Clickinappmessaging.timestampRecord of the time when the request is received on Webex Connect platform.
inappmessaging.userIdThe unique identifier of the app user.
inappmessaging.pushIdThe token generated by FCM or APNS at the time of user registration.
inappmessaging.pushTypeThe type of push notification, conveying whether it's a silent or normal push notification.
inappmessaging.appIdUnique identifier of the app from which the app user has sent the request.
inappmessaging.transIdUnique identifier corresponding to the transaction, which is the custom event in this case.
On Connectinappmessaging.userIdThe unique identifier of the app user.
inappmessaging.timestampRecord of the time when the request is received on Webex Connect platform.
inappmessaging.appIdUnique identifier of the app from which the app user has sent the request.
inappmessaging.transIdUnique identifier corresponding to the transaction, which is the event when connection between the app on Webex Connect is established.
On Disconnectinappmessaging.userIdThe unique identifier of the app user.
inappmessaging.timestampRecord of the time when the request is received on Webex Connect platform.
inappmessaging.appIdUnique identifier of the app from which the app user has sent the request.
inappmessaging.transIdUnique identifier corresponding to the transaction, which is the event when connection between the app on Webex Connect is closed.
Profile Creationinappmessaging.profile.makeThe manufacturer of the device from which the app user has registerd.
inappmessaging.profile.osThe operating system of the device from which the app user has registered.
inappmessaging.profile.osVersionThe version of the operating system of the device.
inappmessaging.profile.sdkVersionThe Webex Connect SDK version of the app.
inappmessaging.profile.modelThe model name of the device.
inappmessaging.userIdThe unique identifier of the app user.
inappmessaging.timestampRecord of the time when the request is received on Webex Connect platform.
inappmessaging.appIdUnique identifier of the app from which the app user has sent the request.
inappmessaging.transIdUnique identifier corresponding to the transaction, which is the custom event in this case.
Profile Updateinappmessaging.profile.makeThe manufacturer of the device from which the app user has registerd.
inappmessaging.profile.osThe operating system of the device from which the app user has registered.
inappmessaging.profile.osVersionThe version of the operating system of the device.
inappmessaging.profile.sdkVersionThe Webex Connect SDK version of the app.
inappmessaging.profile.modelThe model name of the device.
inappmessaging.userIdThe unique identifier of the app user.
inappmessaging.timestampRecord of the time when the request is received on Webex Connect platform.
inappmessaging.appIdUnique identifier of the app from which the app user has sent the request.
inappmessaging.transIdUnique identifier corresponding to the transaction, which is the custom event in this case.
Roaming Change
Subscribeinappmessaging.topicName of the topic which the user has subsribed to.
inappmessaging.userIdThe unique identifier of the app user.
inappmessaging.timestampRecord of the time when the request is received on Webex Connect platform.
inappmessaging.appIdUnique identifier of the app from which the app user has sent the request.
inappmessaging.transIdUnique identifier corresponding to the transaction, which is the custom event in this case.
unSubscribeinappmessaging.topicName of the topic which the user has subsribed to.
inappmessaging.userIdThe unique identifier of the app user.
inappmessaging.timestampRecord of the time when the request is received on Webex Connect platform.
inappmessaging.appIdUnique identifier of the app from which the app user has sent the request.
inappmessaging.transIdUnique identifier corresponding to the transaction, which is the custom event in this case.
Timezone Change

Email Node Output Variables

Incoming EventOutput VariablesDescriptionExample
Incoming Messageemail.subjectContains the subject of the incoming email.Email MO Start 1/2/3
email.messageContains the body of the incoming email.Email MO Start 2\r\n
email.emailIdContains the email ID of the sender.[email protected]
email.transIdUnique identifier corresponding to the transaction.2c25f71d-d014-4798-8e83-6d884b2931fa
email.timestampRecord of the time when the request is received on Webex Connect platform.2020-03-04T06:03:32.184Z
email.attachmentsThe full attachment object available such as images, videos, locations, files etc. sent by the app user as part of the incoming message.
email.appIdUnique identifier of the app from which the app user has sent the request.a_637172790998330000
email.senderNameContains the name of the sender
email.toAddressesContains the recipient's email addresses
email.ccRecipentsContains the email address for one or more cc recipients list
email.bccRecipentsContains the email address for one or more bcc recipients list
email.htmlMessageContains the HTML message for the email
email.inReplyToContains the inReplyTo value of which this email is a part of
email.messageIdContains the message Id for the email
email.headersContains the email header
email.assetTypeContains the asset type as email or image.
email.strippedTextContains the value of stripped HTML as provided by SMTP server
email.strippedHTMLContains the value of stripped HTML as provided by SMTP server
email.PCIInfo.isPCIComplianceIs True when the data is PCI compliant
email.PCIInfo.isPCIValidationDoneIs True when the PCI validation done
email.PCIInfo.nonPCIComplianceReasonContains the reason for which the data is dropped or masked.
email.PCIInfo.droppedAttachmentCountContains the number of dropped attachments
email.PCIInfo.isAttachmentEnabledContains if the message is enabled for the attachments
Subscribe/Unsubscribeemail.messageContains the body of the incoming email.N/A
email.emailIdContains the email ID of the sender.[email protected]
email.transIdUnique identifier corresponding to the transaction.1459722c-246c-4625-9ad6-7f4f8a4b1642
email.timestampRecord of the time when the request is received on Webex Connect platform.2020-03-04T15:27:27.409+05:30
email.attachmentsThe full attachment object available such as images, videos, locations, files etc. sent by the app user as part of the incoming message.N/A
email.appIdUnique identifier of the app from which the app user has sent the request.a_637172790998330000

Apple Messages for Business(AMB) Node Output Variables

Incoming EventOutput VariablesDescriptionExample
Form Messages
abc.abcUserIdUnique user ID of the customer with the corresponding business that never changes even if the customer changes their device.urn:mbid:AQAAYw0Y67QGE2NeYq9uX3t+UeD3B07eJDj86A/uU/XrcUiI6MNNF0VFr0iEsBjZGZLFY8sxy3Ia4FgBwguB7rja8tFvvYIJuvDzbFwDl3TIERGzlpN1sxk3rgbPSVyyzgODUIWc924JOO6WSDiFkzz8WHHoxwg=
abc.appIdUnique identifier of the app from which the app user has sent the request.a_636893638318070000
abc.typeType of the message. It’s “interactive” for Form Messages.
abc.timestampRecord of the time when the request is received on the Webex Connect platform. For e.g. 1582627917.2020-02-28T04:44:15.077Z
abc.localeLanguage locale of the customer's device.en_US
abc.requestIdentifierRequest identifier of the form message that was sent to the customer is returned in this variable.
abc.transId (only for Start Node)Unique identifier corresponding to the transaction.
service.serviceKey (only for Start Node)Contains the service key used for authenticating while sending the message.
abc.selectionsForm response payload that captures the user’s responses across various pages of the form
abc.selectionsCountTotal number of pages in the form
abc.capabilityListHelps you find out if the device that you are using has the capability to support the Form Messages message feature. It is applicable for other message types too.
abc.replyMessageAlternateTitleTitle of the reply bubble as defined in the sent message.Mar 20, 2020 at 12:00 PM
abc.accountIdUnique account ID of the business as defined by Apple.3364d419-4b4a-4f59-a767-ac7e60214baa
abc.deviceAgentContains the information of the type of device the customer is messaging from.iPhone OS
abc.interactivePayloadAvailable only in Start Node. The corresponding variable on the Receive Node is 'receive.payload'.Sample Payload
{
"replyMessage": {
"imageIdentifier": "551a9527-e8c1-4395-9431-885c7e8615f2",
"subtitle": "This is Subtitle",
"style": "small",
"alternateTitle": "Tap to view your response.",
"title": "Tap to view your response."
},
"formMessage": {
"template": "messageForms",
"private": false,
"selections": [
{
"pageIdentifier": "1",
"subtitle": "Was the merchandise you received defective or not as the merchant described?",
"title": "Item Condition",
"items": [
{
"identifier": "101",
"type": "select",
"title": "Defective",
"value": "defective"
}
]
},
{
"pageIdentifier": "2",
"subtitle": "Do you have any supporting documents that demonstrate that the product quality was not sufficient?",
"title": "Supporting Documents",
"items": [
{
"identifier": "202",
"type": "select",
"title": "No",
"value": "no"
}
]
}
],
"version": "1.1"
}
}
abc.pciInfo.isPCICompliance
abc.pciInfo.isPCIValidationDone
abc.pciInfo.nonPCIComplianceReason
abc.pciInfo.isAttachmentEnabled
abc.pciInfo.droppedAttachmentCount
New Auth Response
abc.abcUserIdUnique user ID of the customer with the corresponding business that never changes even if the customer changes their device.urn:mbid:AQAAYw0Y67QGE2NeYq9uX3t+UeD3B07eJDj86A/uU/XrcUiI6MNNF0VFr0iEsBjZGZLFY8sxy3Ia4FgBwguB7rja8tFvvYIJuvDzbFwDl3TIERGzlpN1sxk3rgbPSVyyzgODUIWc924JOO6WSDiFkzz8WHHoxwg=
abc.authTokenAuth token returned by the authenticating system.Authtoken: AQUxx-v6A7qc4dh-N9ZgCDc38LHKFzFM1zMxiiN1z9hgCo1b17NblPWDih3JSARgcv7cvBzNwSY3f9bgqWoYsmIJByG57UExQ4gw1fT0uCMUFbbPdJUx03rObWhUX47SPj_fI4v_T7ec1Jd3H5AQkzX-rTfJnawVIlC7fd8e-jm4GMxPqlkTjC3zWmmTZOYggdiQWBoj6g7EN0yBV-s0zwVdxE2ix7plbOfCkVo6qDVu6HLk0K3lPAQF5viXNcz9LXc8KHyj7zfjOV2bfUB2H6STkymRggKlC03O8F2RN3iDzK8kQq4-NlLvj_5OuvdKpReOXHFMMN-UCYhjngJ1lwmCKRmPbQ
abc.authStatusStatus of the user authentication e.g., authenticated.Authenticated
abc.authReplyMessageTitleTitle of the reply bubble as defined in the sent message.Reply message
abc.authReplyMessageAlternateTitleAlternate Title of the reply bubble as defined in the sent message.Reply message
abc.transIdUnique identifier corresponding to the transaction.
abc.accountIdUnique account ID of the business as defined by Apple.
abc.appIdUnique identifier of the app from which the app user has sent the request.a_636893638318070000
abc.timestampRecord of the time when the request is received on Webex Connect platform. For e.g. 1582627917.2020-02-28T04:44:15.077Z
abc.requestIdentifierRequest identifier of the new auth response message that was sent to the customer is returned in this variable.
service.serviceKey (only for Start Node)Contains the service key used for authenticating while sending the message.54251909-59b9-11ed-9c39-02a06e0e48bf
abc.capabilityListHelps you find out if the device that you are using has the capability of supporting the New Auth message feature. It is applicable for other message types as well.
abc.expiryTimeExpiry time of the access token expressed in seconds.
abc.typeType of the Message.)
iMessage App Response
abc.abcUserIdUnique user ID of the customer with the corresponding business that never changes even if the customer changes their device.urn:mbid:AQAAYw0Y67QGE2NeYq9uX3t+UeD3B07eJDj86A/uU/XrcUiI6MNNF0VFr0iEsBjZGZLFY8sxy3Ia4FgBwguB7rja8tFvvYIJuvDzbFwDl3TIERGzlpN1sxk3rgbPSVyyzgODUIWc924JOO6WSDiFkzz8WHHoxwg=
abc.appIdUnique identifier of the app from which the app user has sent the request.a_636893638318070000
abc.bid
abc.timestampRecord of the time when the request is received on Webex Connect platform. For e.g. 1582627917.2020-02-28T04:44:15.077Z
abc.localeLanguage locale of the customer's device.en_US
abc.requestIdentifierRequest identifier of the new auth response message that was sent to the customer is returned in this variable.formmessage123
abc.transId (only for Start Node)Unique identifier corresponding to the transaction.
abc.url
service.serviceKey (only for Start Node)Contains the service key used for authenticating while sending the message.54251909-59b9-11ed-9c39-02a06e0e48bf
abc.attachmentsThe full attachment object available such as images, videos, locations, files etc. sent by the app user as part of the incoming message.[{"size":"146021","name":"IMG_0869.jpeg","mimeType":"image/jpeg","type":"image","url":"https://s3.amazonaws.com/appleattachment/366ffe58-0e96-4f67-953d-478f8bdc29d5.jpeg"},{"size":"845196","name":"IMG_0990.mov","mimeType":"video/quicktime","type":"video","url":"https://s3.amazonaws.com/appleattachment/f23aa2cc-13e6-44b4-9e37-57368d3b38ee.quicktime"}]
abc.capabilityListThis parameter helps you find out if the device that you are using has the capability of supporting the new auth response message feature. It is applicable for other message types as well.
abc.replyMessageAlternateTitleTitle of the reply bubble as defined in the sent message.Mar 20, 2020 at 12:00 PM
abc.accountIdUnique account ID of the business as defined by Apple.3364d419-4b4a-4f59-a767-ac7e60214baa
abc.deviceAgentContains the information of the type of device the customer is messaging from.iPhone OS
abc.typeType of the message.
abc.pciInfo.isPCICompliance
abc.pciInfo.isPCIValidationDone
abc.pciInfo.nonPCIComplianceReason
abc.pciInfo.isAttachmentEnabled
abc.pciInfo.droppedAtt
abc.abcUserIdachmentCount
Incoming Message
abc.messageContains the body of the incoming message.Incomingmessage
abc.abcUserIdUnique user Id of the customer with the corresponding business that never changes even if the customer changes their device.urn:mbid:AQAAYw0Y67QGE2NeYq9uX3t+UeD3B07eJDj86A/uU/XrcUiI6MNNF0VFr0iEsBjZGZLFY8sxy3Ia4FgBwguB7rja8tFvvYIJuvDzbFwDl3TIERGzlpN1sxk3rgbPSVyyzgODUIWc924JOO6WSDiFkzz8WHHoxwg=
abc.attachmentCountCount of total number of attachments.2
abc.attachmentUrlURL of the first attachment in case of multiple attachments.https://s3.amazonaws.com/appleattachment/366ffe58-0e96-4f67-953d-478f8bdc29d5.jpeg
abc.attachmentTypeType of attachment i.e. image, gif and video.image/jpeg (Only first Url mimetype coming)
abc.attachmentsThe full attachment object available such as images, videos, locations, files etc. sent by the app user as part of the incoming message.{"size":"146021","name":"IMG_0869.jpeg","mimeType":"image/jpeg","type":"image","url":"https://s3.amazonaws.com/appleattachment/366ffe58-0e96-4f67-953d-478f8bdc29d5.jpeg"},{"size":"845196","name":"IMG_0990.mov","mimeType":"video/quicktime","type":"video","url":"https://s3.amazonaws.com/appleattachment/f23aa2cc-13e6-44b4-9e37-57368d3b38ee.quicktime"}
abc.localeLanguage locale of the customer's device.en_US
abc.accountIdUnique account Id of the business as defined by Apple.3364d419-4b4a-4f59-a767-ac7e60214baa
abc.appIdUnique identifier of the app from which the app user has sent the request.a_636893638318070000
abc.timestampRecord of the time when the request is received on Webex Connect platform. For e.g. 1582627917.2020-02-28T04:44:15.077Z
abc.transIdUnique identifier corresponding to the transaction.c330c225-a541-c501-bdfe-971ada4cf168
abc.intentIdIntent Id as configured in the entrypoint.
abc.groupIdGroup Id as configured in the entry point.
abc.deviceAgentContains the information of the type of device the customer is messaging from.iPhone OS
abc.capabilitiesContains the information of the features capabilities of the customer device such as auth, pay etc.AUTH,1.00
Date Picker
abc.messageContains the body of the incoming message.N/A
abc.abcUserIdUnique userId of the customer with the corresponding business that never changes even if the customer changes their device.urn:mbid:AQAAYw0Y67QGE2NeYq9uX3t+UeD3B07eJDj86A/uU/XrcUiI6MNNF0VFr0iEsBjZGZLFY8sxy3Ia4FgBwguB7rja8tFvvYIJuvDzbFwDl3TIERGzlpN1sxk3rgbPSVyyzgODUIWc924JOO6WSDiFkzz8WHHoxwg=
abc.datePickerTimeSlotsArray that contains the time slot selected by the customer e.g., [{"duration":"1800","identifier":"c020521e-cc3c-41fa-876e-a445237a6f83","startTime":"2020-03-20T06:30+0000"}].{"duration":"1800","identifier":"c020521e-cc3c-41fa-876e-a445237a6f83","startTime":"2020-03-20T06:30+0000"}
abc.datePickerTimeSlotsDurationDuration of the time slot selected by the customer.1800
abc.datePickerTimeSlotsIdentifierIdentifier of the time slot selected by the customer.c020521e-cc3c-41fa-876e-a445237a6f83
abc.datePickerTimeSlotsStartTimeStart time of the time slot selected by the customer.2020-03-20T06:30+0000
abc.requestIdentifierRequest identifier of the timepicker message that was sent to the customer is returned in this variable.datepicker123
abc.replyMessageAlternateTitleTitle of the reply bubble as defined in the sent message.Mar 20, 2020 at 12:00 PM
abc.localeLanguage locale of the customer's device.
abc.accountIdUnique account Id of the business as defined by Apple.3364d419-4b4a-4f59-a767-ac7e60214baa
abc.appIdUnique identifier of the app from which the app user has sent the request.a_636893638318070000
abc.timestampRecord of the time when the request is received on Webex Connect platform. For e.g. 1582627917.2020-03-04T12:11:48.480Z
abc.transIdUnique identifier corresponding to the transaction.2a1d1f03-ead9-a6ca-011c-7a47def5f850
abc.deviceAgentContains the information of the type of device the customer is messaging from.iPhone OS
abc.capabilitiesContains the information of the features capabilities of the customer device such as auth, pay etc.AUTH,1.00
abc.listPickeritemsArray that contains the list picker item(s) selected by the customer.
abc.listPickerOtherItemsArray that contains the list picker item(s) not selected by the customer.
service.serviceKeyContains the service key used for authenticating while sending the message.
abc.capabilityListThis parameter helps you find out if the device that you are using has the capability of supporting the Date Picker message feature. It is applicable for other message types as well.
abc.typeType of the message. It’s “interactive” for Date Picker
abc.interactivePayloadSample Payload:
{
"replyMessage": {
"style": "small",
"alternateTitle": "Dec 28, 2023 at 12:00 PM",
"title": "Dec 28, 2023 at 12:00 PM"
},
"datePicker": {
"identifier": "Date",
"timezoneOffset": "330",
"location": {},
"title": "BookAppointment",
"timeslots": [
{
"duration": "1800",
"identifier": "653",
"startTime": "2023-12-28T06:30+0000"
}
]
}
}
List Picker
abc.messageContains the body of the incoming message.NA
abc.abcUserIdUnique userId of the customer with the corresponding business that never changes even if the customer changes their device.urn:mbid:AQAAYw0Y67QGE2NeYq9uX3t+UeD3B07eJDj86A/uU/XrcUiI6MNNF0VFr0iEsBjZGZLFY8sxy3Ia4FgBwguB7rja8tFvvYIJuvDzbFwDl3TIERGzlpN1sxk3rgbPSVyyzgODUIWc924JOO6WSDiFkzz8WHHoxwg=
abc.listPickerItemsArray that contains the list picker item(s) selected by the customer.{"identifier":"a2323","style":"default","title":"I1title","url":"https://s3.amazonaws.com/appleattachment/4d7483af-0eb8-4e1e-8ac5-e8b3f7e5d110.jpeg","order":"0"}
abc.listPickerOtherItemsArray that contains the list picker item(s) not selected by the customer.{"identifier":"S1Item1Identifier@123","style":"default","title":"I1title","url":"https://s3.amazonaws.com/appleattachment/0b2f916d-e8cf-4807-98f8-f001838eec2b.jpeg","order":"0"},{"identifier":"S2Item2Identifier@123","style":"default","title":"I2title","url":"https://s3.amazonaws.com/appleattachment/b75c7f8b-2112-4c97-a232-494cc5b5f9be.jpeg","order":"1"}
abc.requestIdentifierRequest identifier of the timepicker message that was sent to the customer is returned in this variable.listpicker123
abc.replyMessageAlternateTitleTitle of the reply bubble as defined in the sent message.I1title and I2title
abc.localeLanguage locale of the customer's device.Value not getting. Need to raise bug
abc.accountIdUnique account Id of the business as defined by Apple.3364d419-4b4a-4f59-a767-ac7e60214baa
abc.appIdUnique identifier of the app from which the app user has sent the request.a_636893638318070000
abc.timestampRecord of the time when the request is received on Webex Connect platform. For e.g. 1582627917.2020-03-04T11:16:48.987Z
abc.transIdUnique identifier corresponding to the transaction.7fdc3a1f-b461-f5b8-bfcc-047d1898e86a
abc.deviceAgentContains the information of the type of device the customer is messaging from.iPhone OS
abc.capabilitiesContains the information of the features capabilities of the customer device such as auth, pay etc.AUTH,1.00
abc.listPickeritemsArray that contains the list picker item(s) selected by the customer.
abc.listPickerOtherItemsArray that contains the list picker item(s) not selected by the customer.
service.serviceKeyContains the service key used for authenticating while sending the message.
abc.capabilityListThis parameter helps you find out if the device that you are using has the capability of supporting the List Picker message feature. It is applicable for other message types as well.
abc.typeType of the message. It’s “interactive” for List Picker
abc.interactivePayloadSample Payload
{
"replyMessage": {
"imageIdentifier": "9190df46-3054-20e0-f227-1f8f4dd4a2b2",
"style": "large",
"alternateTitle": "I6 alone",
"title": "I6 alone"
},
"listPicker": {
"otherItemCount": 3,
"selectedItemCount": 1,
"otherItems": [
{
"identifier": "a232323",
"style": "default",
"title": "I1",
"url": "https://s3.amazonaws.com/stagingappleattachment/36e9cb72-15df-486b-8dff-b860fb9fa39d.jpeg",
"order": "0"
},
{
"identifier": "231231",
"style": "default",
"title": "I3",
"url": "https://s3.amazonaws.com/stagingappleattachment/f6da952f-b346-4e82-a6cc-5020df300f87.jpeg",
"order": "1"
},
{
"identifier": "21312",
"style": "default",
"title": "I4",
"order": "2"
}
],
"selectedItems": [
{
"identifier": "32423423423",
"style": "default",
"title": "I6",
"order": "1"
}
]
}
}
Apple Pay
abc.abcUserIdUnique userId of the customer with the corresponding business that never changes even if the customer changes their device.urn:mbid:AQAAY0aPiHTsDEzUfCKpalC9GpjVmP8/qnC2h7QD1ZmACRkPGQAEt/1DlNkhZQ6wkMFdmTJZ2OPls6gckV7VboJj39NMCYERacHhmgJ57VO814j0lGUyYJap3sBD26hmleqIC07leuHV2fJcwC3FQQdvVg/RAVY=
abc.paymentStatusPayment status of the payment request sent to the customer e.g. paid.Paid
abc.paymentReplyMessageTitleTitle of the reply bubble as defined in the sent message.Reply title
abc.paymentReplyMessageSubtitleSubtitle of the reply bubble as defined in the sent message.Paid CN¥100.10 with Pay
abc.transIdUnique identifier corresponding to the transaction.
abc.accountIdUnique account Id of the business as defined by Apple.
abc.appIdUnique identifier of the app from which the app user has sent the request.
abc.requestIdentifierRequest identifier of the timepicker message that was sent to the customer is returned in this variable.
abc.typeType of the message.
Classical Authentication(Deprecated)
abc.authTokenAuth token returned by the authenticating system.Authtoken: AQUxx-v6A7qc4dh-N9ZgCDc38LHKFzFM1zMxiiN1z9hgCo1b17NblPWDih3JSARgcv7cvBzNwSY3f9bgqWoYsmIJByG57UExQ4gw1fT0uCMUFbbPdJUx03rObWhUX47SPj_fI4v_T7ec1Jd3H5AQkzX-rTfJnawVIlC7fd8e-jm4GMxPqlkTjC3zWmmTZOYggdiQWBoj6g7EN0yBV-s0zwVdxE2ix7plbOfCkVo6qDVu6HLk0K3lPAQF5viXNcz9LXc8KHyj7zfjOV2bfUB2H6STkymRggKlC03O8F2RN3iDzK8kQq4-NlLvj_5OuvdKpReOXHFMMN-UCYhjngJ1lwmCKRmPbQ
abc.authStatusStatus of the user authentication e.g., authenticated.Authenticated
abc.capabilitiesContains the information of the features capabilities of the customer device such as auth, pay etc.AUTH,1.00
abc.authReplyMessageTitleTitle of the reply bubble as defined in the sent message.Reply message
abc.authReplyMessageSubtitleSubtitle of the reply bubble as defined in the sent message.Reply message
abc.abcUserIdUnique userId of the customer with the corresponding business that never changes even if the customer changes their device.urn:mbid:AQAAYw0Y67QGE2NeYq9uX3t+UeD3B07eJDj86A/uU/XrcUiI6MNNF0VFr0iEsBjZGZLFY8sxy3Ia4FgBwguB7rja8tFvvYIJuvDzbFwDl3TIERGzlpN1sxk3rgbPSVyyzgODUIWc924JOO6WSDiFkzz8WHHoxwg=
abc.transIdUnique identifier corresponding to the transaction.
abc.accountIdUnique account Id of the business as defined by Apple.
abc.appIdUnique identifier of the app from which the app user has sent the request.
abc.requestIdentifierRequest identifier of the timepicker message that was sent to the customer is returned in this variable.
abc.timestampRecord of the time when the request is received on Webex Connect platform. For e.g. 1582627917.
service.serviceKeyContains the service key used for authenticating while sending the message.
abc.capabilityListThis parameter helps you find out if the device that you are using has the capability of supporting the OAuth feature. It is applicable for other message types as well.
abc.typeType of the Message
Quick Reply
abc.abcUserIdUnique userId of the customer with the corresponding business that never changes even if the customer changes their device.
abc.appIdUnique identifier of the app from which the app user has sent the request.
abc.typeType of the message. It’s “interactive” for Quick Replies.Type of the message. It’s “interactive” for Quick Replies.
abc.localeLanguage locale of the customer's device.
abc.requestIdentifierRequest identifier of the timepicker message that was sent to the customer is returned in this variable.
abc.timestampRecord of the time when the request is received on imiconnect platform. For e.g. 1582627917.
abc.selectedIdentifierThe selected identifier of the item .
abc.selectedIndexThe selected item number from top order.
abc.quickReplyItemsThe full array of section items that were available for selection.
service.serviceKeyContains the service key used for authenticating while sending the message.
abc.capabilityListThis parameter helps you find out if the device that you are using has the capability of supporting the Quick Reply message feature. It is applicable for other message types as well.
abc.interactivePayloadSample Payload
{
"quickReply": {
"selectedIdentifier": "OptionA",
"items": [
{
"identifier": "OptionA",
/ "title": "Confirm"
},
{
"identifier": "OptionB",
"title": "Cancel"
}
],
"selectedIndex": 0
}
}
abc.accountidUnique account Id of the business as defined by Apple.abc.listPickeritemsArray that contains the list picker item(s) selected by the customer.
Conversation closed
abc.abcUserIdUnique user ID of the customer with the corresponding business that never changes even if the customer changes their device.
service.serviceKeyContains the service key used for authenticating while sending the message.
abc.capabilityListThis parameter helps you find out if the device that you are using has the capability of supporting the new auth response message feature. It is applicable for other message types as well.
abc.appIdUnique identifier of the app from which the app user has sent the request.
abc.accountIdUnique account Id of the business as defined by Apple.
abc.typeType of the Message.

RCS Node Output Variables

Incoming EventOutput VariablesDescriptionExample
Incoming Messagercs.textIncoming text message from end-customer.rcsflow
rcs.numberNumber of the customer's handset where the incoming message is originating from.9.16304E+11
rcs.timestampRecord of the time when the request is received on Webex Connect platform.1584602304
rcs.appIdUnique identifier of the app from which the app user has sent the request.a_157017189286805250
rcs.transIdUnique identifier corresponding to the transaction.4bd0eed2-b14f-9b27-c192-0b5f757b68e2
Incoming Attachmentrcs.fileUrlURL containing the attachment sent by the customer.https://rcs-user-content-us.storage.googleapis.com/2fa59f37-3aa6-4110-b472-1ac570249892/c28d0e7f8ad803d7a3c507b8c289bf8b5efc422e3c1954e6a478a72cade6
rcs.fileNameName of the attachment sent by the customer.IMG_20200318_093646_01.jpg
rcs.fileSizeSize of attachment sent by the customer in kb.145984
rcs.mimeTypeFile type of the customer sent by the customer e.g., img/png.Image/jpeg
rcs.textIncoming text message from end-customer.
rcs.numberNumber of the customer's handset where the incoming message is originating from.9.16304E+11
rcs.timestampRecord of the time when the request is received on Webex Connect platform.1584608632
rcs.appIdUnique identifier of the app from which the app user has sent the request.a_157017189286805250
rcs.transIdUnique identifier corresponding to the transaction.798d8999-8d3a-90c7-49bb-560e8930aeeb
Postback Responsercs.postbackDataContains the postback data configured for the suggestion clicked by customer.Simple reply
rcs.numberNumber of the customer's handset where the incoming message is originating from.9.16304E+11
rcs.timestampRecord of the time when the request is received on Webex Connect platform. For e.g. 1582627917.1584604585
rcs.appIdUnique identifier of the app from which the app user has sent the request.a_157017189286805250
rcs.transIdUnique identifier corresponding to the transaction.432f0042-9ded-b747-10ba-89bb1b15aba6
Location Responsercs.lattitudeLattitude of the location shared by the customer.17.4347002
rcs.longitudeLongitude of the location shared by the customer.78.3985753
rcs.numberNumber of the customer's handset where the incoming message is originating from.9.16304E+11
rcs.timestampRecord of the time when the request is received on Webex Connect platform.1584616556
rcs.appIdUnique identifier of the app from which the app user has sent the request.a_157017189286805250
rcs.transIdUnique identifier corresponding to the transaction.74ece05e-ff79-9318-2de7-966b680696e9

Node Outcomes

You can see the list of possible node outcomes for this node under this pane. You can customize the node labels using the Edit (pencil) icon. The node exits through one of the node edges corresponding to the outcome of the node.

Node EdgeNode Event/Outcome
Success (green)


Note: You can see this node edge only when you complete the node configuration.
* onSuccess - the flow exits through this node when it is a success. This node is replaced by a channel-specific node for every channel that you configure. For example, if you configure SMS, the onSuccess node event is replaced by sms.mo and for WhatsApp, the node event is whatsapp.mo.
Timeout (yellow/amber)* onTimeout - the flow exits through this node outcome when no message was received within the specified timeout duration
Error (red)* onError - the flow exits through this node outcome when there is an error

See the example for configuration details.

382

Node Outcomes

Transition Actions

Use this tab to configure the transition actions for On-enter/On-leave events. However, configuring transition actions is optional. For detailed instructions about configuring the transition actions, see Node Transition Actions.

1158

Transition Actions

Example

A healthcare app sends reminders to its users about their upcoming medical appointments. In this use case, the receiving node waits for users' response (through SMS) to either confirm or cancel their appointment.

The node waits for the specified duration (Max Timeout) to receive a message sent From Number on the specified Number with any Keyword. See the following screenshot to understand the configuration.

848

Configuration to receive an SMS