Difference between revisions of "PEC-OU/Current/CXContact/smsnx"

From Genesys Documentation
Jump to: navigation, search
(Published)
 
(4 intermediate revisions by 3 users not shown)
Line 8: Line 8:
 
|Section={{Section
 
|Section={{Section
 
|alignment=Vertical
 
|alignment=Vertical
−
|structuredtext=The SMS/email Conversations Dashboard contains data about SMS/email conversation events.  
+
|structuredtext=The SMS/email Conversations Dashboard contains data about SMS/email conversation events. As long as the conversations continue, new records are added to the dashboard, and all the messages from the conversations are displayed.
  
 
{{NoteFormat|Although mentioned throughout this article, email conversations are currently reserved for future use.|}}
 
{{NoteFormat|Although mentioned throughout this article, email conversations are currently reserved for future use.|}}
  
 
SMS/email conversations can contain data associated with one or more of the following fields:
 
SMS/email conversations can contain data associated with one or more of the following fields:
−
 
 
{{{!}}  
 
{{{!}}  
 
! width="200px"{{!}}'''Field'''
 
! width="200px"{{!}}'''Field'''
Line 19: Line 18:
 
! width="200px"{{!}}'''Description'''
 
! width="200px"{{!}}'''Description'''
 
{{!}}-
 
{{!}}-
−
{{!}}direction (outbound|inbound)
+
{{!}}_index
 +
{{!}}keyword
 +
{{!}}The index name.
 +
{{!}}-
 +
{{!}}_type
 +
{{!}}keyword
 +
{{!}}The index type.
 +
{{!}}-
 +
{{!}}_id
 +
{{!}}keyword
 +
{{!}}The entry ID.
 +
{{!}}-
 +
{{!}}@timestamp
 +
{{!}}date
 +
{{!}}The timestamp (default timezone from settings) indicating when the Elasticsearch index was submitted for the event. Please note that this is not the time when the actual event occurred.
 +
{{!}}-
 +
{{!}}batchID
 +
{{!}}keyword
 +
{{!}}The Batch ID in the message that was received from OCS.
 +
{{!}}-
 +
{{!}}calluuid
 
{{!}}keyword
 
{{!}}keyword
−
{{!}}The direction of the SMS/email communication.
+
{{!}}The call attempt GUID.
 
{{!}}-
 
{{!}}-
 +
{{!}}campaignGroupName
 
{{!}}keyword
 
{{!}}keyword
 +
{{!}}The Campaign group name.
 +
{{!}}-
 +
{{!}}campaignName
 
{{!}}keyword
 
{{!}}keyword
−
{{!}}The keyword value identified in the inbound SMS/email. For example, STOP or HELP. (This field reserved for future use.)
+
{{!}}The Campaign name.
 
{{!}}-
 
{{!}}-
−
{{!}}timestamp
+
{{!}}campaignTemplateName
−
{{!}}integer
+
{{!}}keyword
−
{{!}}The timestamp of the last time the index was updated.
+
{{!}}The Campaign template name.
 
{{!}}-
 
{{!}}-
 
{{!}}ccid
 
{{!}}ccid
Line 35: Line 58:
 
{{!}}The Contact Center ID.
 
{{!}}The Contact Center ID.
 
{{!}}-
 
{{!}}-
−
{{!}}mediaType
+
{{!}}contact_info
 
{{!}}keyword
 
{{!}}keyword
−
{{!}}The Media type (SMS/email).
+
{{!}}The device's phone number or email address.
 
{{!}}-
 
{{!}}-
−
{{!}}batchID
+
{{!}}clientId
 
{{!}}keyword
 
{{!}}keyword
−
{{!}}The Batch ID in the message that was received from OCS.
+
{{!}}The Client ID in the Input file.
 +
{{!}}-
 +
{{!}}content
 +
{{!}}text
 +
{{!}}The content of an SMS/email message after personalization was applied.
 
{{!}}-
 
{{!}}-
−
{{!}}messageID
+
{{!}}direction
 
{{!}}keyword
 
{{!}}keyword
−
{{!}}The unique Message ID. For example, ccid.calluuid.
+
{{!}}The direction of the SMS/email communication. (Inbound / Outbound)
 +
{{!}}-
 +
{{!}}errorCode
 +
{{!}}integer
 +
{{!}}The error code.
 
{{!}}-
 
{{!}}-
−
{{!}}calluuid
+
{{!}}errorMessage
 
{{!}}keyword
 
{{!}}keyword
−
{{!}}The call attempt GUID.
+
{{!}}The error message.
 
{{!}}-
 
{{!}}-
−
{{!}}sessionuuid
+
{{!}}disposition
 
{{!}}keyword
 
{{!}}keyword
−
{{!}}The session GUID for the currently active/running Campaign group.
+
{{!}}Dispositon Code
 
{{!}}-
 
{{!}}-
−
{{!}}campaignName
+
{{!}}from
 
{{!}}keyword
 
{{!}}keyword
−
{{!}}The Campaign name.
+
{{!}}The sender's phone number or email address.
 
{{!}}-
 
{{!}}-
 
{{!}}groupName
 
{{!}}groupName
Line 63: Line 94:
 
{{!}}The Group name.
 
{{!}}The Group name.
 
{{!}}-
 
{{!}}-
−
{{!}}campaignGroupName
+
{{!}}id
 
{{!}}keyword
 
{{!}}keyword
−
{{!}}The Campaign group name.
+
{{!}}The index ID.
 +
{{!}}-
 +
{{!}}isTest
 +
{{!}}boolean
 +
{{!}}Indicates if a message has been sent as a result of the Send Test SMS or Send Test Email actions.
 
{{!}}-
 
{{!}}-
−
{{!}}campaignTemplateName
 
 
{{!}}keyword
 
{{!}}keyword
−
{{!}}The Campaign template name.
+
{{!}}keyword
 +
{{!}}The sender's phone number or email address.
 
{{!}}-
 
{{!}}-
 
{{!}}listName
 
{{!}}listName
Line 75: Line 110:
 
{{!}}The calling list name.
 
{{!}}The calling list name.
 
{{!}}-
 
{{!}}-
−
{{!}}contact_info
+
{{!}}mediaType
 +
{{!}}keyword
 +
{{!}}The media type (SMS/email).
 +
{{!}}-
 +
{{!}}messageID
 +
{{!}}keyword
 +
{{!}}The unique Message ID. For example, ccid.calluuid.
 +
{{!}}-
 +
{{!}}providerUpdate
 
{{!}}keyword
 
{{!}}keyword
−
{{!}}The device's phone number or email address.
+
{{!}}Provider Update
 +
{{!}}-
 +
{{!}}timestamp
 +
{{!}}date
 +
{{!}}The timestamp of the last time the index was updated.
 
{{!}}-
 
{{!}}-
−
{{!}}from
+
{{!}}optin
 
{{!}}keyword
 
{{!}}keyword
−
{{!}}The sender's phone number or email address.
+
{{!}}Indicates if the user sent START (for SMS) or has subscribed (for email).
 +
{{!}}-
 +
{{!}}optout
 +
{{!}}boolean
 +
{{!}}Indicates if the user sent STOP (for SMS) or unsubscribed (for email).
 
{{!}}-
 
{{!}}-
−
{{!}}subject
+
{{!}}partition
 
{{!}}keyword
 
{{!}}keyword
−
{{!}}The subject of the message.
+
{{!}}The name of the partition/division responsible for the SMS/email communication.
 
{{!}}-
 
{{!}}-
−
{{!}}clientId
+
{{!}}sessionuuid
 
{{!}}keyword
 
{{!}}keyword
−
{{!}}The Client ID in the Input file that was provided from the specification file.
+
{{!}}The session GUID for the currently active/running Campaign group.
 
{{!}}-
 
{{!}}-
 
{{!}}status
 
{{!}}status
Line 95: Line 146:
 
{{!}}The message status. For example, ['receivedFromOCS', 'queuedInternally', 'submittedToNexus', 'respondedFromNexus', 'notifiedOCS'].
 
{{!}}The message status. For example, ['receivedFromOCS', 'queuedInternally', 'submittedToNexus', 'respondedFromNexus', 'notifiedOCS'].
 
{{!}}-
 
{{!}}-
−
{{!}}errorCode
+
{{!}}subject
−
{{!}}integer
+
{{!}}subject
−
{{!}}The error code.
+
{{!}}The subject of the message.
 
{{!}}-
 
{{!}}-
−
{{!}}errorMessage
+
{{!}}triggerEventID
 
{{!}}keyword
 
{{!}}keyword
−
{{!}}The error message.
+
{{!}}The ID of the trigger event.
 
{{!}}-
 
{{!}}-
−
{{!}}content
+
{{!}}triggerRuleName
−
{{!}}text
 
−
{{!}}The content of an SMS/email message after personalization was applied.
 
−
{{!}}-
 
−
{{!}}partition
 
 
{{!}}keyword
 
{{!}}keyword
−
{{!}}The name of the partition/division responsible for the SMS/email communication.
+
{{!}}The name of the trigger rule that sent the message.
 
{{!}}}
 
{{!}}}
 
|Status=No
 
|Status=No

Latest revision as of 14:01, September 28, 2022

This topic is part of the manual Outbound (CX Contact) CX Contact Help for version Current of Outbound (CX Contact).

Learn about the SMS/Email Conversations Dashboard.

The SMS/email Conversations Dashboard contains data about SMS/email conversation events. As long as the conversations continue, new records are added to the dashboard, and all the messages from the conversations are displayed.

Important
Although mentioned throughout this article, email conversations are currently reserved for future use.

SMS/email conversations can contain data associated with one or more of the following fields:

Field Type Description
_index keyword The index name.
_type keyword The index type.
_id keyword The entry ID.
@timestamp date The timestamp (default timezone from settings) indicating when the Elasticsearch index was submitted for the event. Please note that this is not the time when the actual event occurred.
batchID keyword The Batch ID in the message that was received from OCS.
calluuid keyword The call attempt GUID.
campaignGroupName keyword The Campaign group name.
campaignName keyword The Campaign name.
campaignTemplateName keyword The Campaign template name.
ccid keyword The Contact Center ID.
contact_info keyword The device's phone number or email address.
clientId keyword The Client ID in the Input file.
content text The content of an SMS/email message after personalization was applied.
direction keyword The direction of the SMS/email communication. (Inbound / Outbound)
errorCode integer The error code.
errorMessage keyword The error message.
disposition keyword Dispositon Code
from keyword The sender's phone number or email address.
groupName keyword The Group name.
id keyword The index ID.
isTest boolean Indicates if a message has been sent as a result of the Send Test SMS or Send Test Email actions.
keyword keyword The sender's phone number or email address.
listName keyword The calling list name.
mediaType keyword The media type (SMS/email).
messageID keyword The unique Message ID. For example, ccid.calluuid.
providerUpdate keyword Provider Update
timestamp date The timestamp of the last time the index was updated.
optin keyword Indicates if the user sent START (for SMS) or has subscribed (for email).
optout boolean Indicates if the user sent STOP (for SMS) or unsubscribed (for email).
partition keyword The name of the partition/division responsible for the SMS/email communication.
sessionuuid keyword The session GUID for the currently active/running Campaign group.
status keyword The message status. For example, ['receivedFromOCS', 'queuedInternally', 'submittedToNexus', 'respondedFromNexus', 'notifiedOCS'].
subject subject The subject of the message.
triggerEventID keyword The ID of the trigger event.
triggerRuleName keyword The name of the trigger rule that sent the message.

Related topics

Retrieved from "https://all.docs.genesys.com/PEC-OU/Current/CXContact/smsnx (2025-08-28 18:16:43)"
Comments or questions about this documentation? Contact us for support!