Information on available roles for a specific agent
GET {{httptype}}://{{IP}}/mot/{{miralixAccount}}/agents/{{identificationType}}/{{TypeID}}/roles
Returns information on all available roles for a specific agent in to OfficeTeam. Information Information includes the queues assigned to the role.
HTTP GET: /agents/{identificationType}/{identification}/roles
| Parameter | Value | Description |
|---|---|---|
| identificationType | sipUri, id, email, syncId | Different identification types, that can be used to identify an agent |
| identification | String | The identification value must match the selected identification type. So, if identificationType is set to email, then the identification value must match an agent's email |
Example
https://192.168.1.10/mot/greenbox/agents/id/8/roles - Information on all available roles for the agent with ID 8
https://192.168.1.10/mot/greenbox/agents/email/lucas.p@company.local/roles - Information on all available roles for the agent with email address of lucas.p@company.local
https://192.168.1.10/mot/greenbox/agents/sipUri/sip:lp1@company.local/roles - Information on all available roles for the agent with sip URI sip:lp1@company.local
https://192.168.1.10/mot/greenbox/agents/syncId/f4fd9e5f-017d-4350-adf8-8dd811bc1a2e/roles - Information on all available roles for the agent with syncId f4fd9e5f-017d-4350-adf8-8dd811bc1a2e
Result
Information on all available roles for a specific agent that is in to Miralix OfficeTeam.
- 200 OK - Information on all available roles for the specific agent
- 400 Bad Request - One or more parameters are not valid
- 403 Forbidden - Missing required License to access this request
- 404 Not Found - The agent is not does not exist
- 500 Internal Server Error - Internal processing error
JSON result
| Parameter | Value | Description |
|---|---|---|
| Id | {Integer} | ID of the role in the database |
| Name | {String} | Name of the role |
| Queues | {Array} | For each queue assigned to this role, the following information is available |
| ↳ Id | {Integer} | Queue's ID in the database |
| ↳ Name | {String} | Name of the queue |
| ↳ Skill | {Integer} | Skill assigned to the Agent for this queue |
| ↳ Spectator | true | This is only shown if the Agent is Spectator of this queue |
RESPONSES
status: OK
[{"Id":823,"Name":"Task Rolle","Queues":[{"Id":2078,"Name":"Miralix Task Queue 1","Skill":9},{"Id":116,"Name":"Miralix Task Queue 2","Skill":8},{"Id":211,"Name":"Minor Task Queue 1","Skill":8}]},{"Id":0,"Name":"Default","Queues":[{"Id":2094,"Name":"PickUp Queue","Skill":9},{"Id":19,"Name":"Miralix Queue 1","Skill":9},{"Id":1030,"Name":"Retur calls","Skill":9,"Spectator":true}]}]