Fetch Single User

Sample Request

curl --request GET \
     --url https://api-account-uk.acefone.com/v1/user/id \
     --header 'accept: application/json'

📘 Important!

Before we begin, note that the * sign denotes the mandatory variables in each table.

Request Variables (Path Params)

The following parameter is required to fetch single user details.

Sample Response

{
    "data": {
        "id": "288256",
        "name": "xyz",
        "number": "+91999999999",
        "team_member": {
            "designation": null,
            "email": "[email protected]",
            "login_id": "png4747",
            "status": 1,
            "role": {
                "name": "Admin New",
                "id": 54742
            },
            "is_login_based_calling": true,
            "is_web_login_block": false,
            "users_for_cdr": {
                "type": "all",
                "value": null
            }
        },
        "agent": {
            "id": "0502842370002",
            "intercom": 1002,
            "number": "+919999999999",
            "agent_status": 0,
            "extension": {
                "username": "0602842370077",
                "outbound_block": false
            },
            "sticky_Agent": null,
            "time_group": {
                "id": 23743,
                "name": "TEster OCT NOV"
            },
            "failover_destination": {
                "id": "50757",
                "name": "OFF hours OB",
                "type": "auto_attendant"
            },
            "is_international_outbound_enabled": false
        }
    }
}

Response Variables

The response returned is as following:

  <th>
    **Description**
  </th>

  <th>
    **Data Type**
  </th>
</tr>

  <td>
    Id of the user.
  </td>

  <td>
    integer
  </td>
</tr>

<tr>
  <td>
    data[i].name
  </td>

  <td>
    Name of the user.
  </td>

  <td>
    String
  </td>
</tr>

<tr>
  <td>
    data[i].number
  </td>

  <td>
    Phone number of the user.
  </td>

  <td>
    String
  </td>
</tr>

<tr>
  <td>
    data[i].team\_member.designation
  </td>

  <td>
    Designation of the team member/user.
  </td>

  <td>
    String
  </td>
</tr>

<tr>
  <td>
    data[i].team\_member.email
  </td>

  <td>
    Email of the team member/user.
  </td>

  <td>
    String
  </td>
</tr>

<tr>
  <td>
    data[i].team\_member.login\_id
  </td>

  <td>
    Login ID of the team member.
  </td>

  <td>
    String
  </td>
</tr>

<tr>
  <td>
    data[i].team\_member.status
  </td>

  <td>
    Status of the team member. For example: *BLOCK* = 0  <br>*UNBLOCK* = 1
  </td>

  <td>
    integer
  </td>
</tr>

<tr>
  <td>
    data[i].team\_member.role.id
  </td>

  <td>
    Id of the permission role defined for the user.
  </td>

  <td>
    integer
  </td>
</tr>

<tr>
  <td>
    data[i].team\_member.role.name
  </td>

  <td>
    Name of the permission role defined for the user.
  </td>

  <td>
    String
  </td>
</tr>

<tr>
  <td>
    data[i].agent.id
  </td>

  <td>
    Id of the agent.
  </td>

  <td>
    integer
  </td>
</tr>

<tr>
  <td>
    data[i].agent.intercom
  </td>

  <td>
    Intercom of the agent/user.
  </td>

  <td>
    integer
  </td>
</tr>

<tr>
  <td>
    data[i].agent.number
  </td>

  <td>
    Number of the agent/user.
  </td>

  <td>
    String
  </td>
</tr>

<tr>
  <td>
    data[i].agent.agent\_status
  </td>

  <td>
    Status of the agent. For example: *Enabled* = 0  <br>*Blocked* = 1  <br>*Disabled* = 2  <br>*Busy* = 3  <br>*Offline* = 4
  </td>

  <td>
    integer
  </td>
</tr>

<tr>
  <td>
    data[i].agent.extension.username
  </td>

  <td>
    Username of the extension for the agent/user.
  </td>

  <td>
    String
  </td>
</tr>

<tr>
  <td>
    data[i].agent.extension.outbound\_block
  </td>

  <td>
    Whether outbound calling is blocked for the user extension or not. For example: true or false.
  </td>

  <td>
    Boolean
  </td>
</tr>

<tr>
  <td>
    data[i].sticky\_Agent.timeout
  </td>

  <td>
    The call timeout duration for the sticky agent. **Note:** Value is in seconds.
  </td>

  <td>
    integer
  </td>
</tr>

<tr>
  <td>
    data[i].sticky\_Agent.ring\_strategy
  </td>

  <td>
    The ring strategy name of the department.<br><br>For example, Order By.
  </td>

  <td>
    String
  </td>
</tr>

<tr>
  <td>
    data[i].sticky\_Agent.alternate\_numbers
  </td>

  <td>
    The alternate numbers of the agent. For example, 9123234000.
  </td>

  <td>
    String
  </td>
</tr>

<tr>
  <td>
    data[i].time\_group.id
  </td>

  <td>
    The unique ID of the time group assigned. For example, 12345.
  </td>

  <td>
    integer
  </td>
</tr>

<tr>
  <td>
    data[i].time\_group.name
  </td>

  <td>
    Name of the time group assigned.
  </td>

  <td>
    String
  </td>
</tr>

<tr>
  <td>
    data[i].failover\_destination.id
  </td>

  <td>
    ID of the failover destination where the call will land in case the agent doesn't pick up the call.
  </td>

  <td>
    String
  </td>
</tr>

<tr>
  <td>
    data[i].failover\_destination.name
  </td>

  <td>
    Name of the failover destination
  </td>

  <td>
    String
  </td>
</tr>

<tr>
  <td>
    data[i].failover\_destination.type
  </td>

  <td>
    Type of the failover destination module. For example: agent, department, etc.
  </td>

  <td>
    String
  </td>
</tr>

<tr>
  <td>
    data[i].users\_for\_cdr.type
  </td>

  <td>
    Type of users selected for cdr view. For example: all, none, user
  </td>

  <td>
    String
  </td>
</tr>

<tr>
  <td>
    data[i].users\_for\_cdr.value
  </td>

  <td>
    Value of users selected for cdr view.
  </td>

  <td>
    String
  </td>
</tr>

<tr>
  <td>
    data[i].is\_web\_login\_block
  </td>

  <td>
    Whether web login is blocked on the user or not. For example: true or false.
  </td>

  <td>
    Boolean
  </td>
</tr>

<tr>
  <td>
    data[i].is\_login\_based\_calling
  </td>

  <td>
    Whether login-based calling is enabled on the user or not. For example: true or false.
  </td>

  <td>
    Boolean
  </td>
</tr>

<tr>
  <td>
    data[i].is\_international\_outbound\_enabled
  </td>

  <td>
    Whether internation outbound is enabled on the user or not. For example: true or false.
  </td>

  <td>
    Boolean
  </td>
</tr>