Skip to main content
About the Resource Center

Interaction attributes in Genesys Cloud for Zendesk

Note: This article applies to Genesys Cloud for Zendesk.

By default, Genesys Cloud for Zendesk saves certain interaction attributes (known collectively as interaction logs) to comments on tickets. You can customize the interaction attributes that appear on these comments. For more information, see Configure interaction logging and Interaction logs.

You can also configure the integration to save interaction attributes to system or custom fields on tickets. For more information, see Configure interaction logging and Configure new tickets

Comments on tickets appear in the Conversations feed for individual tickets. Their content is not searchable. If you want to be able to search the content of comments, map the interaction attribute to a field.

Fields on tickets appear in the left navigation pane in Zendesk. Their content is searchable. 

Interaction attributes

You can map the following interaction attributes to fields or add them to comments.

Interaction attributeInteraction typeData typeDescription
Call.AniCall, callbackStringPhone number of the caller.
Call.CalledNumberCall, callbackStringPhone number dialed (DNIS or SIP addresses for queues).
Call.ConversationIdAll*StringInteraction ID.
Call.InternalCallBooleanIndicates whether the call is internal interaction.
Call.QueueNameAll*StringName of the queue that the interaction routes to or from.
Call.RemoteNameAll*String

Remote name for the active interaction.

Note: For SMS messages, this attribute returns the display address for the active interaction. For Genesys Cloud web messaging, this attribute returns Guest.

Call.StateAll*String

State of the interaction (for example, ALERTING, CONNECTED, DISCONNECTED, HELD).

Call.UUIDataCall, callback, outbound dialingString

Data received from inbound calls or sent with outbound calls. For more information, see About User to User Information (UUI) and the IETF UUI specification.

Email.SubjectEmailString

Subject line in the email. 

Interaction.ParticipantPurposeAll*String

Participant type of the interaction.

Interaction.StartTimeAll*String

Time when the first participant joined the conversation.

Date time is represented as an ISO-8601 string, for example: yyyy-MM-ddTHH:mm:ss.SSSZ.

Interaction.TotalAcdTimeAll*String

Total time in seconds that an interaction spends being routed to an agent. Does not include IVR time.

Example scenario: An interaction spends 30 seconds in an initial queue before a tier-one agent picks up the interaction. The agent transfers the interaction to a tier-two agent. The interaction spends 60 seconds in a queue before a tier-two agent picks up the interaction. TotalAcdTime: 90 seconds.

Interaction.TotalIvrTimeAll*String

Total time in seconds that an interaction spends in an IVR before being connected to an agent. Includes secure IVR time. Does not include ACD time.

Example scenario: An interaction spends 30 seconds in an initial IVR flow before a tier-one agent picks up the interaction. The agent transfers the interaction to a tier-two agent. The interaction spends 60 seconds in an IVR flow before a tier-two agent picks up the interaction. TotalIvrTime: 90 seconds.

Interaction.UrlAll*StringGenesys Cloud URL to information about the interaction.
Message.TypeMessageStringType of message interaction. Values: facebook, line, sms, twitter, whatsapp, or webmessaging.
Message.UsernameMessageStringUser name associated with Twitter Direct Message. Nothing returned for Facebook Messenger, LINE Messaging, SMS, WhatsApp, or Genesys Cloud web messaging messages.
Message.UseridMessageStringUser ID associated with Facebook Messenger, LINE Messaging, Twitter Direct Message, and Genesys Cloud web messaging messages. Phone number associated with WhatsApp messages. Nothing returned for SMS.
OutboundDialing.ContactIdOutbound dialingStringGenesys Cloud ID for a contact in a contact list associated with an outbound dialing campaign.
OutboundDialing.ContactListIdOutbound dialingStringGenesys Cloud ID for a contact list associated with an outbound dialing campaign.
OutboundDialing.CampaignIdOutbound dialingStringGenesys Cloud ID for an outbound dialing campaign.
Participant.{ColumnName}Outbound dialingStringColumn name in campaign management contact list. See Contact list view.
Participant.{CustomFieldName}Call, callback, email, message, ACD voicemailStringCustom field name that is assigned by using Set Participant Data in an Architect flow. See Set Participant Data action.
ChatStringCustom field name that is used in the chat widget.
Zendesk.AfterCallTimeAll*StringTotal time in seconds spent on wrap-up work, from the disconnection of the interaction to the completion of wrap-up work.
Zendesk.CallDurationAll*StringTotal duration in seconds that an agent spends on an interaction, including wrap-up work.
Zendesk.ConnectedTimeAll*StringTime when an agent was connected to an interaction.
Zendesk.DisconnectedTimeAll*StringTime when an agent was disconnected from an interaction.
Zendesk.DisplayAddressCall, callback, outbound dialing, , email, SMS and WhatsApp messagesStringRemote address of the active interaction (phone number for call, callback, outbound dialing, SMS and WhatsApp messages, and ACD voicemail interactions; email address for email interactions).

Note: Genesys recommends not using this attribute for call logs with callback interactions.

Zendesk.InteractionLogAll*StringLog for interactions. Includes everything that appears on a Zendesk ticket by default. See Interaction logs
Zendesk.InteractionLogNotesAll*String

Interaction log notes that agents add to the interaction. 

Note: The Interaction Log Notes attribute only appears if agents add interaction logs to the interaction in the client. 

Zendesk.NewTicketSubjectAll*StringInteraction type, remote address, date, and time for interaction. By default, written to subject field and comment. See Configure new tickets.  
Zendesk.ParticipantIdAll*StringUnique ID for each agent associated with a particular interaction. For example, an interaction that is transferred from one agent to another agent produces two participant IDs. One ID is for the original agent. A second ID is for the agent that received the transfer.
Zendesk.WrapUpCodeAll*StringWrap-up code for an interaction made from or to a queue.

* All refers to call, callback, outbound dialing, chat, email, message, and ACD voicemail interaction types. 

Interaction logs

This table includes a list of fields automatically captured as an interaction log for every interaction that an agent handles. By default, interaction logs appear as comments on tickets. You can customize the interaction logs that appear on Zendesk ticket comments. For more information, see Configure interaction logging

Field labelDescription
Interaction IDID associated with the interaction.
Remote Address

Phone number of the active call, SMS, or ACD voicemail; the email address of the active email.

Note: The Remote Address attribute does not appear on chat interactions or Facebook Messenger, LINE Messaging, Twitter Direct Message, WhatsApp, or Genesys Cloud web messaging message interactions. 

Remote Name

Name of the person who started the active interaction. 

Note: The Remote Name attribute appears on Genesys Cloud web messaging interactions as Guest but does not appear on any other message interaction type. 

Connected TimeTime when the agent answered the interaction.
Notes

Interaction Log Notes that agents add to the interaction in the client. 

Note: This attribute only appears if agents add content to the Interaction Logs Notes in the client.

For more information, see Interaction logs, Configure interaction logging, and Configure new tickets.

For more information about the integration, see About Genesys Cloud for Zendesk.