Requesting Agent and Skill Lists

Prior to configuring an API request, you'll need a service user and accompanying bearer token to authorize the request.

Learn how to build a user and obtain a key here.

Requesting the Agent List and Phone Types

Make the following GET request:

https://< your tenant name >.xima.cloud/rest/api/v1/agents

For example:

https:// acme-ns.xima.cloud/rest/api/v1/agents

Include the authentication header:

Authorization: Bearer =

If the GET request was properly authenticated, you'll receive the agent and type list. Here is a shortened example result:

{
    "agents": [
        {
            "agent": "John Spector(104)",
            "type": "UC"
        },
        {
            "agent": "Alan Jones(271)",
            "type": "XIMA"
        },
        {
            "agent": "Bertha Hopkins(113)",
            "type": "XIMA"
        },
        {
            "agent": "Jane Pierson(242)",
            "type": "UC"
        }
    ]
}

"agent" returns the name of the agent exactly as programmed in the UC or within Xima if a non-uc agent. This could include partial names (i.e. tjohnson or terrancej). The name is followed by the agent's extension number

"type" returns the source of the agent's creation and type of phone they are using

• "UC" is returned for agents who were created in the UC system and rely on UC provided hard or softphones
• "Xima" is returned for agents who were configured inside of Xima CCaaS and only have phone access through the Xima softphone (webRTC)

Requesting the Skill List

Make the following GET request:

https://< your tenant name >.xima.cloud/rest/api/v1/skills

For example:

https:// acme-ns.xima.cloud/rest/api/v1/skills

Include the authentication header:

Authorization: Bearer =

If the GET request was properly authenticated, you'll receive the skill list. Here is an example result:

 "skills": [
        {
            "name": "Warranty Team"
        },
   {
            "name": "Customer Support"
        },
        {
            "name": "Sales"
        },
        {
            "name": "Accounts Receivable"
        }
    ]
}