Avaya Infinity™Avaya Experience Platform™
API Reference

List Agents

post
{protocol}://{server}{basePath}/accounts//journeys:listAgents

Lists the Agents to have participated on a Customer's Journey for the required Channel within a timeframe. By default this is limited to the last 30 days unless a "startDate" for the search is provided.

The Agents are listed in descending order based on the "leftAt" timefield, this can be changed to ascending with the optional "orderBy" parameter.

This does not include any Agents that are currently active on the Customer's Journey that have yet to leave.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 6 and 6
^[a-zA-Z]{6}$

The unique 6 character internal id that represents the customer account.

Query Params
int32
1 to 10
Defaults to 1

The maximum number of results per page

string
length between 3 and 4
Defaults to desc

Ordering is performed on the "leftAt" field, the default order is descending.

To specify ascending order, "asc" should be used.

Body Params

Search criteria.

The list Agents search criteria.

identifiers
object
required

Unique identifiers for identifying the customer during an Engagement such as phoneNumbers or emailAddresses.

date-time | null

The start date in ISO 8601 format, for example 2018-11-13T20:20:39+00:00. The returned results will be inclusive of this datetime. If omitted, defaults to the last 30 days.

string
required
length between 3 and 50

The unique identifier for the Agent's channel.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 7 months ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Choose an example:
application/json
application/problem+json

Updated 7 months ago

Did this page help you?