Customer Experience Essentials API - Get List of available agents for Customer Experience Essentials

Get List of available agents for Customer Experience Essentials

Retrieve the list of available agents with Customer Experience Essentials license in a location.

This operation requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

GET/v1/telephony/config/locations/{locationId}/cxEssentials/agents/availableAgents

URI Parameters

locationId

stringrequired

Retrieve the list of avaiilable agents in this location.

Query Parameters

orgId

string

The organization ID of the customer or partner's organization.

hasCxEssentials

boolean

Returns only the list of available agents with Customer Experience Essentials license when true, otherwise returns the list of available agents with Customer Experience Basic license.

Response Properties

agents

array[GetAvailableAgentsCallQueueObject]

List of avaiilable agents in the given location.

string

Unique agent identifier.

lastName

string

Last name of the agent assigned to the particular location.

firstName

string

First name of the agent assigned to the particular location. Defaults to ".".

displayName

string

(string, optional) - Display name of the agent.

type

UserType

Type of the person, workspace or virtual line.

PEOPLE

string

Associated type is a person.

PLACE

string

Associated type is a workspace.

VIRTUAL_LINE

string

Associated type is a virtual line.

string

Email of the agent.

hasCxEssentials

boolean

Denotes whether the agent has Customer Experience Essentials license.

phoneNumbers

object

Phone number and extension of the agent.

external

string

External phoneNumber of the agent.

extension

string

Extension of the agent.

Response Codes

The list below describes the common success and error responses you should expect from the API.

Code	Status	Description
200	OK	Successful request with body content.
201	Created	The request has succeeded and has led to the creation of a resource.
202	Accepted	The request has been accepted for processing.
204	No Content	Successful request without body content.
400	Bad Request	The request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401	Unauthorized	Authentication credentials were missing or incorrect.
403	Forbidden	The request is understood, but it has been refused or access is not allowed.
404	Not Found	The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.
405	Method Not Allowed	The request was made to a resource using an HTTP request method that is not supported.
409	Conflict	The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.
410	Gone	The requested resource is no longer available.
415	Unsupported Media Type	The request was made to a resource without specifying a media type or used a media type that is not supported.
423	Locked	The requested resource is temporarily unavailable. A `Retry-After` header may be present that specifies how many seconds you need to wait before attempting the request again.
428	Precondition Required	File(s) cannot be scanned for malware and need to be force downloaded.
429	Too Many Requests	Too many requests have been sent in a given amount of time and the request has been rate limited. A `Retry-After` header should be present that specifies how many seconds you need to wait before a successful request can be made.
500	Internal Server Error	Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502	Bad Gateway	The server received an invalid response from an upstream server while processing the request. Try again later.
503	Service Unavailable	Server is overloaded with requests. Try again later.
504	Gateway Timeout	An upstream server failed to respond on time. If your query uses `max` parameter, please try to reduce it.

GET

/v1/telephony/config/locations//cxEssentials/agents/availableAgents{?orgId,hasCxEssentials}

Header

Authorization
Use personal access token
Bearer
This limited-duration personal access token is hidden for your security.

Query Parameters

orgId
string
The organization ID of the customer or partner's organization.
hasCxEssentials
boolean
Returns only the list of available agents with Customer Experience Essentials license when `true`, otherwise returns the list of available agents with Customer Experience Basic license.

https://webexapis.com/v1/telephony/config/locations/Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx/cxEssentials/agents/availableAgents?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE&hasCxEssentials=true

200 / OK

{
    "agents": [
        {
            "id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS80YzFjOWE2YS1jYjZiLTRjYjItOWJkYi02YjkyZTA1ZTI4ZmY",
            "lastName": "Smith",
            "firstName": "John",
            "displayName": "John_Smith",
            "type": "PEOPLE",
            "email": "JohnSmith@gmail.com",
            "hasCxEssentials": true,
            "phoneNumber": [
                {
                    "external": "+12165553518",
                    "extension": "5024"
                }
            ]
        },
        {
            "id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNGZkMGJkZS03MmM5LTRkMTktYmUxNS03YTdjMTM0YzExZmQ",
            "lastName": "Will",
            "firstName": "David",
            "displayName": "David Will",
            "type": "PEOPLE",
            "email": "davidWill@test.com",
            "hasCxEssentials": true,
            "phoneNumber": [
                {
                    "external": "+19458880340",
                    "extension": "5024"
                }
            ]
        }

    ]
}