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

From Genesys Documentation
Jump to: navigation, search
(Published)
 
(5 intermediate revisions by 4 users not shown)
Line 8: Line 8:
 
|Section={{Section
 
|Section={{Section
 
|alignment=Vertical
 
|alignment=Vertical
−
|structuredtext=The SMS/EMAIL Record Dashboard [[File: Analytics-sms.png|link=]] contains data about SMS/EMAIL events.  
+
|structuredtext=The SMS/EMAIL Record Dashboard [[File: Analytics-sms.png|link=]] contains data about SMS/email events. The data on this dashboard is continuously updated and displays only the current state of an event.
  
−
SMS/EMAIL records can contain data associated with one or more of the following fields:
+
SMS/email records can contain data associated with one or more of the following fields:
  
 
{{{!}}  
 
{{{!}}  
Line 16: Line 16:
 
! width="200px"{{!}}'''Type'''
 
! width="200px"{{!}}'''Type'''
 
! width="200px"{{!}}'''Description'''
 
! width="200px"{{!}}'''Description'''
−
{{!}}-
 
−
{{!}}id
 
−
{{!}}keyword
 
−
{{!}}The Index ID.
 
 
{{!}}-
 
{{!}}-
 
{{!}}@timestamp
 
{{!}}@timestamp
 
{{!}}date
 
{{!}}date
−
{{!}}The ISO index timestamp.
+
{{!}}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.
−
{{!}}-
 
−
{{!}}timestamp
 
−
{{!}}integer
 
−
{{!}}The timestamp of the last time the index was updated.
 
−
{{!}}-
 
−
{{!}}ccid
 
−
{{!}}keyword
 
−
{{!}}The Contact Center ID.
 
−
{{!}}-
 
−
{{!}}mediaType
 
−
{{!}}keyword
 
−
{{!}}The Media type (sms, email).
 
 
{{!}}-
 
{{!}}-
 
{{!}}batchID
 
{{!}}batchID
Line 41: Line 25:
 
{{!}}The Batch ID in the message that was received from OCS.
 
{{!}}The Batch ID in the message that was received from OCS.
 
{{!}}-
 
{{!}}-
−
{{!}}messageID
+
{{!}}callResult
 
{{!}}keyword
 
{{!}}keyword
−
{{!}}The unique Message ID. For example, ccid.calluuid.
+
{{!}}The call result.
 
{{!}}-
 
{{!}}-
 
{{!}}calluuid
 
{{!}}calluuid
Line 49: Line 33:
 
{{!}}The call attempt GUID.
 
{{!}}The call attempt GUID.
 
{{!}}-
 
{{!}}-
−
{{!}}sessionuuid
+
{{!}}campaignGroupName
 
{{!}}keyword
 
{{!}}keyword
−
{{!}}The session GUID for the currently active/running Campaign group.
+
{{!}}The Campaign group name.
 
{{!}}-
 
{{!}}-
 
{{!}}campaignName
 
{{!}}campaignName
Line 57: Line 41:
 
{{!}}The Campaign name.
 
{{!}}The Campaign name.
 
{{!}}-
 
{{!}}-
−
{{!}}groupName
+
{{!}}campaignTemplateName
−
{{!}}keyword
+
{{!}}Keyword
−
{{!}}The Group name.
+
{{!}}The Camaign template name
 
{{!}}-
 
{{!}}-
−
{{!}}campaignGroupName
+
{{!}}ccid
−
{{!}}keyword
 
−
{{!}}The Campaign group name.
 
−
{{!}}-
 
−
{{!}}listName
 
 
{{!}}keyword
 
{{!}}keyword
−
{{!}}The calling list name.
+
{{!}}The Contact center ID.
 
{{!}}-
 
{{!}}-
 
{{!}}chainId
 
{{!}}chainId
 
{{!}}integer
 
{{!}}integer
−
{{!}}Indicates the Contact ID in the database table.
+
{{!}}Indicates the contact ID in the database table.
 
{{!}}-
 
{{!}}-
 
{{!}}chainN
 
{{!}}chainN
 
{{!}}integer
 
{{!}}integer
 
{{!}}The number of the device in the contact/chain.
 
{{!}}The number of the device in the contact/chain.
 +
{{!}}-
 +
{{!}}clientId
 +
{{!}}keyword
 +
{{!}}The Client ID in the input file that was provided from the specification file.
 
{{!}}-
 
{{!}}-
 
{{!}}contact_info
 
{{!}}contact_info
 
{{!}}keyword
 
{{!}}keyword
 
{{!}}The device's phone number or email address.
 
{{!}}The device's phone number or email address.
 +
{{!}}-
 +
{{!}}content
 +
{{!}}text
 +
{{!}}The content of an SMS message after personalization was applied.
 +
{{!}}-
 +
{{!}}deliveryReceipt
 +
{{!}}keyword
 +
{{!}}The Nexus delivery result code.
 +
{{!}}-
 +
{{!}}disposition
 +
{{!}}keyword
 +
{{!}}The Disposition code. For example, <Nexus Delivery Result>:<Nexus extended state>
 +
{{!}}-
 +
{{!}}Error Msg
 +
{{!}}Keyword
 +
{{!}}The error message.
 +
{{!}}-
 +
{{!}}errorMessage
 +
{{!}}Keyword
 +
{{!}}The error message.
 
{{!}}-
 
{{!}}-
 
{{!}}from
 
{{!}}from
Line 85: Line 89:
 
{{!}}The sender's phone number or email address.
 
{{!}}The sender's phone number or email address.
 
{{!}}-
 
{{!}}-
−
{{!}}subject
+
{{!}}groupName
 
{{!}}keyword
 
{{!}}keyword
−
{{!}}The subject of the message.
+
{{!}}The Group name.
 
{{!}}-
 
{{!}}-
−
{{!}}clientId
+
{{!}}id
 
{{!}}keyword
 
{{!}}keyword
−
{{!}}The Client ID in the Input file that was provided from the specification file.
+
{{!}}The Index ID.
 
{{!}}-
 
{{!}}-
−
{{!}}timeReceivedFromOCS
+
{{!}}isTest
−
{{!}}date
+
{{!}}boolean
−
{{!}}The timestamp of when the message was received from OCS.
+
{{!}}Indicates if a message has been sent as a result of the Send Test SMS or Send Test Email actions.
 
{{!}}-
 
{{!}}-
−
{{!}}timeSubmittedToNexus
+
{{!}}listName
−
{{!}}date
+
{{!}}keyword
−
{{!}}The timestamp of when the message was submitted to Nexus.
+
{{!}}The calling list name.
 
{{!}}-
 
{{!}}-
−
{{!}}timeResponseReceived
+
{{!}}mediaType
−
{{!}}date
+
{{!}}keyword
−
{{!}}The timestamp of when the message was received from Nexus.
+
{{!}}The media type (sms, email).
 
{{!}}-
 
{{!}}-
−
{{!}}timeOCSNotified
+
{{!}}messageID
−
{{!}}date
+
{{!}}keyword
−
{{!}}The timestamp of when OCS provided a result.
+
{{!}}The unique Message ID. For example, ccid.calluuid.
 
{{!}}-
 
{{!}}-
−
{{!}}timeConsumerResponded
+
{{!}}optout
−
{{!}}date
+
{{!}}boolean
−
{{!}}The timestamp of when the user response (STOP) was received from Nexus.
+
{{!}}Indicates if the user sent STOP (for SMS) or unsubscribed (for email).
 
{{!}}-
 
{{!}}-
−
{{!}}deliveryReceipt
+
{{!}}partition
−
{{!}}keyword
+
{{!}}Keyword
−
{{!}}The Nexus delivery result code.
+
{{!}}The associated partition.
 
{{!}}-
 
{{!}}-
−
{{!}}{{Link-SomewhereInThisVersion|manual=CXContact|topic=callresult|anchor=StndrdCllRslts|display text=callResult}}
+
{{!}}providerReceipt
 
{{!}}keyword
 
{{!}}keyword
−
{{!}}The call result.
+
{{!}}The final SMS delivery state received from the SMS Aggregator.
 
{{!}}-
 
{{!}}-
−
{{!}}disposition
+
{{!}}sessionuuid
 
{{!}}keyword
 
{{!}}keyword
−
{{!}}The Disposition code. For example, <Nexus Delivery Result>:<Nexus extended state>
+
{{!}}The session GUID for the currently active/running Campaign group.
 
{{!}}-
 
{{!}}-
 
{{!}}status
 
{{!}}status
Line 129: Line 133:
 
{{!}}The message status. For example, ['receivedFromOCS', 'queuedInternally', 'submittedToNexus', 'respondedFromNexus', 'notifiedOCS'].
 
{{!}}The message status. For example, ['receivedFromOCS', 'queuedInternally', 'submittedToNexus', 'respondedFromNexus', 'notifiedOCS'].
 
{{!}}-
 
{{!}}-
−
{{!}}optout
+
{{!}}subject
−
{{!}}boolean
+
{{!}}keyword
−
{{!}}Indicate if the user sent STOP (for SMS) or unsubscribed (for Email).
+
{{!}}The subject of the message.
 +
{{!}}-
 +
{{!}}timeConsumerResponded
 +
{{!}}date
 +
{{!}}The timestamp of when the user response (STOP) was received from Nexus.
 +
{{!}}-
 +
{{!}}timeOCSNotified
 +
{{!}}date
 +
{{!}}The timestamp of when OCS provided a result.
 +
{{!}}-
 +
{{!}}timeReceivedFromOCS
 +
{{!}}date
 +
{{!}}The timestamp of when the message was received from OCS.
 +
{{!}}-
 +
{{!}}timeResponseReceived
 +
{{!}}date
 +
{{!}}The timestamp of when the message was received from Nexus.
 
{{!}}-
 
{{!}}-
−
{{!}}errorCode
+
{{!}}timestamp
 
{{!}}integer
 
{{!}}integer
−
{{!}}The error code.
+
{{!}}The timestamp of the last time the index was updated.
 +
{{!}}-
 +
{{!}}timeSubmittedToNexus
 +
{{!}}date
 +
{{!}}The timestamp of when the message was submitted to Nexus.
 +
{{!}}-
 +
{{!}}timeSubmittedToPortico
 +
{{!}}date
 +
{{!}}The timestamp of when the message was submitted to Portico.
 
{{!}}-
 
{{!}}-
−
{{!}}errorMessage
+
{{!}}triggerEventID
 
{{!}}keyword
 
{{!}}keyword
−
{{!}}The error message.
+
{{!}}The ID of the trigger event.
−
{{!}}-
 
−
{{!}}content
 
−
{{!}}text
 
−
{{!}}The content of an SMS message after personalization was applied.
 
 
{{!}}-
 
{{!}}-
−
{{!}}providerReceipt
+
{{!}}triggerRuleName
 
{{!}}keyword
 
{{!}}keyword
−
{{!}}The final SMS delivery state received from the SMS Aggregator.
+
{{!}}The name of the trigger rule that sent the message.
 
{{!}}-
 
{{!}}-
 
{{!}}userData
 
{{!}}userData
−
{{!}}object
+
{{!}}keyword
−
{{!}}The user related data that was received from OCS and used for filling in templates.
+
{{!}}User Attached Data
 
{{!}}}
 
{{!}}}
 
|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 Record Dashboard.

The SMS/EMAIL Record Dashboard Analytics-sms.png contains data about SMS/email events. The data on this dashboard is continuously updated and displays only the current state of an event.

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

Field Type Description
@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.
callResult keyword The call result.
calluuid keyword The call attempt GUID.
campaignGroupName keyword The Campaign group name.
campaignName keyword The Campaign name.
campaignTemplateName Keyword The Camaign template name
ccid keyword The Contact center ID.
chainId integer Indicates the contact ID in the database table.
chainN integer The number of the device in the contact/chain.
clientId keyword The Client ID in the input file that was provided from the specification file.
contact_info keyword The device's phone number or email address.
content text The content of an SMS message after personalization was applied.
deliveryReceipt keyword The Nexus delivery result code.
disposition keyword The Disposition code. For example, <Nexus Delivery Result>:<Nexus extended state>
Error Msg Keyword The error message.
errorMessage Keyword The error message.
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.
listName keyword The calling list name.
mediaType keyword The media type (sms, email).
messageID keyword The unique Message ID. For example, ccid.calluuid.
optout boolean Indicates if the user sent STOP (for SMS) or unsubscribed (for email).
partition Keyword The associated partition.
providerReceipt keyword The final SMS delivery state received from the SMS Aggregator.
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 keyword The subject of the message.
timeConsumerResponded date The timestamp of when the user response (STOP) was received from Nexus.
timeOCSNotified date The timestamp of when OCS provided a result.
timeReceivedFromOCS date The timestamp of when the message was received from OCS.
timeResponseReceived date The timestamp of when the message was received from Nexus.
timestamp integer The timestamp of the last time the index was updated.
timeSubmittedToNexus date The timestamp of when the message was submitted to Nexus.
timeSubmittedToPortico date The timestamp of when the message was submitted to Portico.
triggerEventID keyword The ID of the trigger event.
triggerRuleName keyword The name of the trigger rule that sent the message.
userData keyword User Attached Data

Related Topics

Retrieved from "https://all.docs.genesys.com/PEC-OU/Current/CXContact/smsemail (2025-08-27 01:05:14)"
Comments or questions about this documentation? Contact us for support!