Example: Including Null Values in a Response

This example demonstrates how to use a GET request to retrieve interactions and include parameters with null values in the response.

Request

Sample Request

The request below returns interactions and includes parameters with null responses:

curl GET https://api.cxengage.net/v1/tenants/0e73a980-6557-11e6-b1b9-ca81484488df/interactions?green=false

Request Parameters

The table below lists the parameters you can include in a request:

Parameter Required?

Type

 

 Description

tenantId

 yes UUID The tenant's unique identifier.

Response

Sample Response

The request returns JSON structured like the example below:

{
    "tenantId": "0e73a980-6557-11e6-b1b9-ca81484488df",
    "customerAbandonTime": null,
    "monitors": [],
    "ivrAbandoned": null,
    "thirdPartyTime": null,
    "hooks": [],
    "campaignId": null,
    "flagged": null,
    "customerHoldTime": null,
    "endTimestamp": "2017-12-07T19:27:48.405Z",
    "flowId": "f3207a30-1a2a-11e7-9873-1b92cd79a0c3",
    "customerTransfers": null,
    "leadId": null,
    "customerConversationTime": 22.72,
    "customerTalkTime": 22.72,
    "interactionTime": 46.578,
    "segments": [
        {
            "segmentConsultTime": null,
            "segmentNumber": 0,
            "segmentCancelled": null,
            "interactionSegmentId": "99a96130-db84-11e7-b86d-6aa612aefe9d",
            "agentId": null,
            "interactionAgentId": null,
            "transfer": null,
            "segmentStartType": "interaction",
            "addParticipantTime": null,
            "addParticipant": null,
            "segmentToAgentId": "0383c270-6b93-11e6-83b4-ca81484488df",
            "endTimestamp": "2017-12-07T19:27:34.792Z",
            "segmentEndType": "success",
            "transferTime": null,
            "segmentExtensionValue": null,
            "segmentCancelTime": null,
            "segmentExtensionType": null,
            "addParticipantHandedOff": null,
            "startTimestamp": "2017-12-07T19:27:01.827Z",
            "segmentTime": 32.965,
            "segmentThirdParty": null
        }
    ],
    "interactionId": "9998bf60-db84-11e7-9709-c2b07aa3bee9",
    "contactPoint": "+15065551234",
    "customerResponseTimes": [],
    "customer": "+15065551235",
    "customerSatisfactionScore": 10,
    "customerHolds": 0,
    "campaignVersion": null,
    "campaignRunId": null,
    "details": {
        "endTimestamp": "2017-12-07T19:27:48.405Z",
        "interactionId": "9998bf60-db84-11e7-9709-c2b07aa3bee9",
        "contactPoint": "+15065551234",
        "customer": "+15062618924",
        "csat": 10,
        "startTimestamp": "2017-12-07T19:27:01.827Z",
        "agents": [
            {
                "conversationStartTimestamp": "2017-12-07T19:27:10.779Z",
                "conversationEndTimestamp": "2017-12-07T19:27:34.144Z",
                "agentId": "0383c270-6b93-11e6-83b4-ca81484488df",
                "agentName": "Betty Agent",
                "dispositionId": "89c2d1d0-332d-11e6-8dd4-c88eee4d9f61",
                "dispositionName": "Issue resolved",
                "noteTitle": null
            }
        ],
        "direction": "inbound",
        "contactId": null,
        "channelType": "voice"
    },
    "customerHoldAbandoned": null,
    "messagingTranscript": null,
    "notes": [],
    "startTimestamp": "2017-12-07T19:27:01.827Z",
    "ivrAbandonTime": null,
    "ivrTime": 0.216,
    "audioRecording": null,
    "dispositionName": "Issue resolved",
    "noEnqueuement": null,
    "dispositionId": "89c2d1d0-332d-11e6-8dd4-c88eee4d9f61",
    "agents": [
        {
            "responseTimes": [],
            "platformAgentId": 71,
            "agentWorkAccepted": true,
            "agentName": "Betty Agent",
            "agentWorkOfferTime": 7.023,
            "agentWrapUpTime": null,
            "sessionId": "6f145920-db84-11e7-80f5-bb59d9e3b1bd",
            "interactionSegmentId": "99a96130-db84-11e7-b86d-6aa612aefe9d",
            "agentId": "0383c270-6b93-11e6-83b4-ca81484488df",
            "interactionAgentId": "9a9ebdb0-db84-11e7-816a-c7c1ef97bf27",
            "agentReplyTime": null,
            "agentWorkRejectedTime": null,
            "endTimestamp": "2017-12-07T19:27:34.792Z",
            "agentHandleTime": 23.365,
            "agentWorkCancelTime": null,
            "agentInitiatedHoldTime": null,
            "agentNoReply": null,
            "agentHolds": null,
            "agentHoldTime": null,
            "agentFocusTime": null,
            "startTimestamp": "2017-12-07T19:27:03.435Z",
            "dispositionName": "Issue resolved",
            "tenantAgentId": 419,
            "agentConversationTime": 23.365,
            "dispositionId": "89c2d1d0-332d-11e6-8dd4-c88eee4d9f61",
            "agentInReplyTime": null,
            "agentReadTime": null,
            "agentInitiatedHolds": null,
            "queueId": "da75d1d0-686c-11e6-bab5-2a8ecd302b89",
            "agentTalkTime": 23.365,
            "agentWorkAcceptedTime": 7.023,
            "agentCustomerHoldAbandon": null
        }
    ],
    "flowName": "Voice Flow with Script",
    "queues": [
        {
            "queueCallbackRequested": null,
            "queueEntryLength": 1,
            "interactionSegmentId": "99a96130-db84-11e7-b86d-6aa612aefe9d",
            "agentId": "0383c270-6b93-11e6-83b4-ca81484488df",
            "queueCallbackAnswered": null,
            "queueAbandonTime": null,
            "platformQueueId": 40,
            "queueAbandoned": null,
            "endTimestamp": "2017-12-07T19:27:10.779Z",
            "slaAbandoned": null,
            "queueCallbackUnanswered": null,
            "queueCancelTime": null,
            "queueExitType": "success",
            "queueCallbackTime": null,
            "queueEntryType": "ivr",
            "interactionQueueId": "99c96c50-db84-11e7-95f3-204e8fcfa723",
            "queueType": "queue",
            "startTimestamp": "2017-12-07T19:27:02.043Z",
            "queueExitLength": null,
            "queueName": "Sales",
            "queueTime": 8.736,
            "slaTime": 8.736,
            "queueId": "da75d1d0-686c-11e6-bab5-2a8ecd302b89",
            "timeToAnswer": 8.736
        }
    ],
    "direction": "inbound",
    "contactId": null,
    "channelType": "voice"
}

Response Parameters

Your response may include statistics that are not described in this reference. For more information about the statistics that are returned, see the Data Dictionary.

The table below lists and describes the parameters that can be returned in the response.

Parameter Description
page The page number for the page of results returned in the request.
limit The number of interactions to return per page. The default is 10. The maximum is 1000.
offset The offset, if specified, from the request. For example, the request might show interactions from page 10.
tenantId The tenant’s unique identifier.
total The number of interactions on the tenant.
tenantTimeZone The human readable name of the time zone for the tenant.
results

For each interaction, the following parameters might be returned:

Parameter Description
tenantID The unique identifier of the tenant.
flagged Flagged interactions may have missing data associated with them. Valid values are true or null.
endTimestamp The date and time, in UTC, that the interaction ended.
flowId The unique identifier of the flow.
interactionId The unique identifier of the interaction..
contactPoint The phone number or email address that the customer contacted.
customer The phone number or email address of the customer.
messagingTranscript The transcript of the SMS conversation.
notes The note that the agent wrote for the interaction.
startTimestamp The date and time, in UTC, that the interaction started.
audioRecording A link to the audio recording if recording was enabled for the flow that received the interaction.
dispositionName The human-readable description of the disposition assigned to the interaction.
dispositionId The unique identifier of the disposition assigned to the interaction.
flowName The human-readable name of the flow.
direction The direction of the interaction, either inbound or outbound.
contactId The contact's unique identifier.
channelType The channel of the interaction such as voice, email, or SMS.
hooks

If the interaction is linked with a record from a third-party Customer Relationship Manager (CRM) or ticketing system, the following attributes are returned:

  • interactionHookId—The unique identifier of hook instance.
  • hookSubType—The type of record linked to the interaction. For example, this could be user or ticket.
  • agentId—The unique identifier of the CxEngage agent.
  • hookType—The third-party application, for example, zendesk.
  • hookName—The title associated with the third-party record linked to the interaction. For example, this could be a contact name or a ticket number.
  • hookedBy—The unique identifier for the third-party system user. For example, the Zendesk user identification for the user that linked the record to the CxEngage interaction.
  • hookId—The unique identifier of the record from the third party system that that is linked to the interaction. For example, a ticket number for Zendesk or a case number for Salesforce. This attribute is part of a three-way key that also includes hookType and hookSubtype.
  • timestamp—The date and time, in UTC, of when this interaction was linked to a third-party record.
segments

Each entry in this object provides data about the segments of the customer interaction.

The following attributes are returned for each segment:

  • segmentAgentId—Displays the ID of the agent responsible for creating this segment. For example the agent that initiated the add-participant or transfer event, or makes an outbound interaction.
  • segmentToAgentId—Displays the ID of the agent that accepted the work, either through a transfer or add participant action, for this segment.
  • interactionSegmentId—A unique identifier for the segment.
  • segmentNumber—Segments are enumerated as follows:
    • Segment 0 is always the result of an interaction-start event. The segment ends when either the agent is deallocated from the interaction or the customer abandons.
    • Segment 1 (and subsequent segments) are created as the result of a transfer-start or add-participant-start event.
  • startTimestamp—The date and time, in UTC, that the segment started.
  • segmentStartType—Displays the type of action that initiated the segment, either:
    • interaction—Indicates that the segment was initiated by an interaction-start event.
    • transfer—Indicates that a transfer event initiated the segment.
    • addParticant—Indicates that an add-participant event initiated the segment.
  • endTimestamp— The date and time, in UTC, that the segment ended.
  • segmentEndType—Displays the type of action that ended the segment.
    • interaction-end—The interaction is complete.
    • customer-disconnect—The customer abandons the interaction.
    • cancelled—The agent cancels the Add Participant or Transfer action.
    • success—An agent accepts the transfer, causing the agent that initiated the transfer to be deallocated from the interaction.
  • segmentCancelled—Displays true if the transfer was canceled or abandoned.
  • segmentCancelTime—The amount of time, in seconds, from the interaction start until the segment is cancelled, either by a customer-disconnect or cancelled event.
  • segmentTime—The amount of time, in seconds, from the interaction start until the segment is complete, either by a success or interaction-end event.
agents

Each entry in this object includes agent-related data. Each entry provides data from when an agent is allocated until the agent is deallocated in the interaction.

The following attributes are returned for each agent:

  • platformAgentId—The unique identifier of the platform user.
  • agentName—The first and last name of the agent.
  • sessionId—The unique identifier for the agent's session. A session begins when an agent logs in to Agent Toolbar or any of the Skylight products and ends when the agent logs out.
  • interactionSegmentId—A unique identifier for the segment. If an interaction enters the same queue twice in an interaction, each queue entry is given a unique identifier.
  • agentId—The unique identifier of the CxEngage agent.
  • interactionAgentId—Each agent is involved in an interaction is given a unique identifier. For each time that an agent is allocated, a unique interactionAgentId attribute is created.
  • endTimestamp—The date and time, in UTC, that the agent was deallocated from the interaction.
  • startTimestamp—The date and time, in UTC, that the agent was allocated to the interaction.
  • tenantAgentId—The unique identifier of the tenant user.
  • queueId—The unique identifier of the queue that the work offer is accepted from.
queues

Each entry in this object provides queue-related data when a customer enters a queue until an agent accepts the interaction.

The following attributes are returned for each queue:

  • interactionSegmentId—A unique identifier for the segment that this enqueuement belongs to.
  • agentId—The unique identifier of the agent who accepts the interaction from the queue.
  • platformQueueId—An integer value that third-party Workforce Management (WFM) systems can use to associate with the CxEngage queue. In CxEngage, queues are identfied by a UUID, so a second identification number is required for third-party systems that don't use UUIDs.
  • endTimestamp—The date and time, in UTC, that the interaction exited the queue.
  • queueExitType—The action that caused the interaction to leave the queue. Valid options are timeout, success, callback, abandon, add-participant-cancel, and interaction-end.
  • queueEntryType—The actions that put the interaction in the queue. Valid options are transfer, add participant, callback, ivr, or timeout.
  • interactionQueueId—A unique identifier for each time that an interaction enters a queue. For each queue entry in an interaction, a new interactionQueueId attribute is created.
  • queueType—The type of queue, either queue or resource.
  • startTimestamp—The date and time, in UTC, that the interaction entered the queue.
  • queueName—The human-readable name of the queue.
  • queueId—The unique identifier of the queue that the work offer is accepted from.