Agent Team API

You can associate a set of agents to a team with a specific supervisor. The supervisor can run reports on that team and receive Supervisor Assist requests from its members.

You can use the Agent Team API to list the agent teams currently defined in the database, define new agent teams, and view, edit, and delete existing agent teams.

URL

https://<server>/unifiedconfig/config/agentteam

Operations

Parameters

Search and sort values

The following table shows the parameters that are searched and the parameters that are sortable.

Search parameters Sort parameters
  • name
  • description
  • name (default)
  • description

See Search and Sort.

Example get response

<agentTeam>
    <refURL>http://***.***.***.***/unifiedconfig/config/agentteam/(id)</refURL>
    <name>team1</name>
    <dialedNumber>
       <refURL>[https://***.***.***.***/unifiedconfig/config/dialednumber/(id)]</refURL>
       <dialedNumberString>8885551212</dialedNumberString>
    </dialedNumber>
    <description>test agent team1</description>
    <agents>
       <agent>
          <refURL>[https://***.***.***.***/unifiedconfig/config/agent/(id_1)]</refURL>
          <firstName>John</firstName>
          <lastName>Smith</lastName>
          <userName>username</userName>
          <agentId>8006</agentId>
       </agent>
       <agent>
          <refURL>[https://***.***.***.***/unifiedconfig/config/agent/(id_2)]</refURL>
          <firstName>Jane</firstName>
          <lastName>Doe</lastName>
          <userName>username</userName>
          <agentId>8007</agentId>
       </agent>
    </agents>

    <supervisor>
       <supervisor>
          <refURL>[https://***.***.***.***/unifiedconfig/config/agent/(id_3)]</refURL>
          <firstName>Mary</firstName>
          <lastName>Hart</lastName>
          <userName>username</userName>
          <agentId>8008</agentId>
       </supervisor>
       <supervisor>
          <refURL>[https://***.***.***.***/unifiedconfig/config/agent/(id_4)]</refURL>
          <firstName>Jack</firstName>
          <lastName>Jones</lastName>
          <userName>username</userName>
          <agentId>8009</agentId>
       </supervisor>
    </supervisors>
    <changeStamp>0</changeStamp>
 </agentTeam>