MessagingContactsReport
Query the Messaging Contacts Report via the Explore API. Provides detailed information about digital interactions at the conversation level. Up to a month of data per request.
Select
The MessagingContactsReport is a report view. The component processes the following pseudo-columns server-side; any other WHERE clause conditions are evaluated client-side.
- TimespanFrom supports the following operator: >=
- TimespanTo supports the following operator: <
- Timezone supports the following operator: =
If TimespanFrom and TimespanTo are omitted, the component defaults the time range to the last 31 days.
For example, the following query is processed server-side:
SELECT * FROM MessagingContactsReport WHERE TimespanFrom >= '2025-01-01' AND TimespanTo < '2025-02-01'
Columns
| Name | Type | References | Description |
| InteractionId [KEY] | String |
CallsReport.InteractionId | The unique identifier of the interaction. |
| ContactId [KEY] | String |
Contacts.Id | The unique identifier of the contact. |
| UserId | String |
Users.Id | The unique identifier of the agent who handled the interaction. |
| ChannelType | String | The type of messaging channel. Example values: SMS, EMAIL. | |
| ContactAssignedAt | Datetime | The date and time the contact was assigned to an agent. | |
| ContactDuration | Double | The duration of the contact. | |
| ContactFinishedAt | Datetime | The date and time the contact was finished. | |
| ContactFinishedReason | String | The reason the contact was finished. Example values: MANUALLY CLOSED. | |
| ContactHandleTime | String | The handle time of the contact in human-readable format. | |
| ContactPersonChannelIdentifier | String | The channel identifier of the contact person (phone number or email). | |
| ContactPersonId | String | The unique identifier of the contact person. | |
| ContactPersonName | String | The name of the contact person. | |
| ContactStartedAt | Datetime | The date and time the contact started. | |
| ConversationHistoryUrl | String | The URL to the conversation history. | |
| Conversation | String | A reference to the conversation associated with the messaging contact. | |
| DirectAssignmentUserId | String |
Users.Id | The user ID of the directly assigned agent, if applicable. |
| DirectAssignmentUser | String | The name of the directly assigned agent, if applicable. | |
| Direction | String | The direction of the interaction. Example values: Inbound, Outbound. | |
| DispositionName | String | The disposition name assigned to the interaction. | |
| FirstResponseTime | String | The first response time in human-readable format. | |
| HandlingQueues | String | The queues that handled the interaction. | |
| InteractionDuration | Double | The total duration of the interaction. | |
| InteractionFinishedAt | Datetime | The date and time the interaction was finished. | |
| InteractionHandleTime | String | The handle time of the interaction in human-readable format. | |
| InteractionStartedAt | Datetime | The date and time the interaction started. | |
| InteractionStatus | String | The status of the interaction. Example values: CLOSED. | |
| IsVirtualAgent | String | Whether a virtual agent handled the interaction. Values: YES, NO. | |
| Notes | String | Notes associated with the interaction. | |
| Queues | String | The queues associated with the interaction. | |
| TouchpointIdentifier | String | The identifier of the touchpoint (phone number or email). | |
| TouchpointName | String | The name of the touchpoint. | |
| TransferOut | String | Whether the interaction was transferred out. Values: Yes, No. | |
| UserName | String | The name of the agent who handled the interaction. | |
| VirtualAgentId | String |
Users.Id | The unique identifier of the virtual agent, if applicable. |
| VirtualAgentName | String | The name of the virtual agent, if applicable. | |
| WrapUpDuration | Double | The wrap-up duration after the contact. |
Pseudocolumns
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description | |
| TimespanFrom | Datetime | The start date for the report timespan. | |
| TimespanTo | Datetime | The end date for the report timespan. | |
| Timezone | String | The IANA timezone for the report timespan. |