Search Live Conversations

Use the live conversations request to search for live conversations happening in realtime, you can use the request body to create complex filters for your search.

Endpoint

Method: POST

URL: /conversation/live

Request Parameter

Parameter Name	Data Type	Description	Required/Optional
`pageSize`	Number	How many live (active) calls to display per page.	Required
`pageToken`	String	The token for which page of the response to see, if you want the first page of a search use `null`, if applicable the response will provide a `nextPageToken` that can be used to get the next page in a subsequent request.	Optional
`groupFilter`	Array	Filter your search, the criteria to determine which conversations should be considered a match and be displayed in the response. See Filters for a detailed explanation on how filters work - how to use them in API requests and therefore how to understand them in API responses.	Optional

Parameter Name

Data Type

Description

Required/Optional

pageSize

Number

How many live (active) calls to display per page.

Required

pageToken

String

The token for which page of the response to see, if you want the first page of a search use null, if applicable the response will provide a nextPageToken that can be used to get the next page in a subsequent request.

Optional

groupFilter

Array

Filter your search, the criteria to determine which conversations should be considered a match and be displayed in the response.

See Filters for a detailed explanation on how filters work - how to use them in API requests and therefore how to understand them in API responses.

Optional

For an example request, see Sample Request.

Response and Error Code

Response Code	Condition
200	OK

Response Parameters

Parameter Name	Data Type	Description
`liveCalls`	Array	A list of currently active calls followed by a list of agents and their live monitor status. When a call is live the following sub-parameters will be displayed, `conversationID`, `tenantID`, `agentID`, `agentName`, `agentEmail`, `liveMonitorStatus`, `phoneNumber`, `callStart`, and `callDurationSeconds`. When an agent is not in a live call only the following sub-parameters will be displayed, `agentId`, `agentName`, `agentEmail`, and `liveMonitorStatus`.
`conversationID`	String	The ID of the live conversation, this ID is used to identify the call throughout the system, in realtime and after the call has ended (post call).
`tenantID`	String	The ID of your tenant.
`agentID`	String	The ID of the agent.
`agentName`	String	The full name of the agent.
`agentEmail`	String	The email address of the agent.
`liveMonitorStatus`	String	Whether the agent is in a live call or not, potential values include `LIVE_MONITORING_STATUS_ACTIVE` (in a call) or `LIVE_MONITORING_STATUS_IDLE` (not in a call).
`phoneNumber`	String	The Phone number of the agent.
`callStart`	Date Time	The date and time that the conversation started, in the format `YYYY-MM-DDT00:00:00.000Z`.
`callDurationSeconds`	Integer	How long the call has been live for, in seconds.
`nextPageTokens`	String	The token for the next page of live conversations, use this token as the `pageToken` parameter value in a subsequent request to get the next page.
`totalCount`	Integer	The total count of agents in your system, idle agents are listed each page of the response.

For an example response, see Sample Response.

Sample Request

{
    "pageSize": 1,
    "pageToken": null,
    "groupFilter": null
}

Sample Response

{
    "liveCalls": [
        {
            "conversationId": "735e0c4f-7ffd-4553-b82e-13e968bfc2cb",
            "tenantId": "67hg8362-g3d2-7g92-9273-d9h02kr83736",
            "agentId": "auth0|735ujf53h235bn09835d984h",
            "agentName": "John Doe",
            "agentEmail": "johndoe@domain.com",
            "liveMonitorStatus": "LIVE_MONITORING_STATUS_ACTIVE",
            "phoneNumber": "00000000",
            "callStart": "2024-08-13T11:00:17.861Z",
            "callDurationSeconds": 15
        },
        {
            "agentId": "auth0|737ghf53h235bn09835d466l",
            "agentName": "Amy Lee",
            "agentEmail": "amylee@domain.com",
            "liveMonitorStatus": "LIVE_MONITORING_STATUS_IDLE"
        }
    ],
    "nextPageToken": "eyJwYWdlX3NpemUiOjIsImNoZWNrX3N1bSI6WzEwMCwxNjEsODUsNzAsNCwwLDE5MywxNTQsOTAsMjA1LDQyLDE3OCwxNzcsMTI5LDEwNyw1N10sInRlbmFudF9pZCI6IjY2ZGQ4NDE4LWIxZDEtNGQ0Ny05MjE4LWMwZTI5YmYxMzE3MCIsImNvbnZlcnNhdGlvbl9pZCI6ImU1MmI3ZjE3LTM4ZGUtNDExZC05NjBmLWQ3ZjIyMzYyYzkyNCIsInRvdGFsX2NvdW50IjozLCJmaWx0ZXJfdmFsdWVzIjp7fX0=",
    "totalCount": "3"
}

In this section:

Uniphore Customer Portal