Authenticated web messaging attributes

Authenticated web messaging allows only authenticated users to initiate a web messaging session with your agents. These authenticated users must log in to your website before they can send a web message.

After you configure authenticated web messaging, you can access these existing built-in variables in Architect inbound message flows, which store some authenticated user attributes defined as standard Claims by OpenId Connect Reference:

Name Type Collection? Read Only? Description
Message.ACDSkill Skill Yes Yes The ACD skills that apply to the message.
Message.Campaign Campaign No Yes The campaign for the flow.
Message.ContactID String No Yes The ID of the contact that connects to this flow.
Message.ContactList ContactList No Yes The contact list for this flow.
Message.ConversationID String No Yes The conversation identifier for the active message.
Message.CurrentQueue Queue No Yes The current queue for the active message.
Message.EstimatedWaitTime Duration No Yes The current queue’s estimated wait time for the message.
Message.ExternalTag String No Yes

The external tag for the active call.

Message.IsAuthenticated Boolean No Yes Returns a value that indicates whether the message is authenticated. True if the authentication was requested for the message when it enters the queue; otherwise, false.
Message.IsNewConversation Boolean No Yes Indicates whether the message is in a new conversation.
Message.JourneyContext Journey context No Yes The journey context associated with this message. If no journey context is available, NOT_SET is returned.
Message.Language String No Yes The IETF language tag lowercase string value set on the current interaction.
Message.LanguageSkill Language skill Yes Yes The language skill for the current interaction.
Message.Message ShortMessage No Yes The message associated with the inbound message flow. You can access properties from this variable to get information about the message.
Message.Message.attachments Collection Yes Yes The collection of attachments on this message.
Message.Message.Body String No Yes The body content of the message.
Message.Message.bodyType String No Yes The message body type. For example, text, HTML, or RTF.
Message.Message.dateTimeUtc DateTime No Yes The UTC datetime for the message.
Message.Message.id String No Yes A unique identifier for the message.
Message.Message.senderAddress Object No Yes The address of the message sender.
Message.Message.senderAddressInfo Object No Yes The message sender’s address information.
Message.Message.senderAddressInfo.addressDisplayable String No Yes A displayable version of the contact address.
Example: (317) 555-1212
Message.Message.senderAddressInfo.addressNormalized String No Yes The contact address after internal processing completes.
Example: +13175551212
Message.Message.senderAddressInfo.addressRaw String No Yes The contact address as supplied directly by the underlying message system.
Example: 5551212
Message.Message.senderAddressInfo.email String No Yes The email address of the message sender. This email address is supplied by the specific messaging provider. If an email address is not available, the system returns NOT_SET.
Message.Message.senderAddressInfo.name String No A contact name as supported by the underlying messaging system; for example, a Twitter handle or a Facebook name.
Message.Message.targetAddresses Collection Yes Yes The collection of addresses for the message targets.
Message.Message.type String No Yes The message type. For example, SMS, Facebook, Twitter, and Line.
Message.PositionInQueue Integer No Yes The current position in queue for the current message.
Message.Priority Integer No Yes The current priority of the conversation. The priority value is greater than or equal to -25,000,000. If the system cannot determine the priority or it is not applicable for the current flow, then the system returns a NOT_SET integer.