/irm/v1/agent

Agent phone, queues, and routing information

Parameters

  • TenantID - How your specific customer instance is identified, this will be a number. Find this in the app Help (?) icon > MotionCX Voice > Tenant:
  • AgentID - ID column in Administration > Users
  • It is recommended advanced filter object be done outside of the API document for best results.

Responses available:

  • 200
  • 401
  • 403

Example return:

{
  "routingProfile": {
    "id": 12,
    "name": "Automatic Pickup off",
    "description": null,
    "workstates": {
      "workstateSetId": 2,
      "defaultWorkstateId": 2
    },
    "queues": null,
    "agents": [],
    "chatChannelSettings": null,
    "caseRoutingChannelSettings": null,
    "phoneChannelSettings": {
      "metaData": {
        "allowPstn": true,
        "callParking": true
      },
      "automaticPickup": false,
      "screenRecording": false,
      "offeredTimeout": 30,
      "displayNewCasesInBackground": false
    }
  },
  "localUserName": null
}
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!