Call Pickup

Call pickup allows users being part of a pickup group to take ringing calls from other members of the same pickup group.

Retrieve User Call Pickup Group

Retrieve the details of the Call Pickup group a user belongs to.

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/call_pickups/

Retrieve user’s call pickup group.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/users/foouser/services/call_pickups/ HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK

{
   "name": "APIO Test Call Pickup",
   "assigned_users": [
      {
         "userId": "ApioUserTest1@sip.netaxis.be",
         "lastName": "Test1",
         "firstName": "Test1",
         "extension": "5001",
         "department": {
              "tenantId": "ApioSpTest",
              "groupId": "ApioGrpTest",
              "departmentName": "test_department_initial",
              "fullPathName": "test_department_parent_1 \\ test_department_initial"
         },
         "phoneNumber": "+3225126777",
         "emailAddress": ""
      },
      {
         "userId": "ApioUserTest2@sip.netaxis.be",
         "lastName": "Test2",
         "firstName": "Test2",
         "extension": "5002",
         "department": "",
         "phoneNumber": "",
         "emailAddress": ""
      }
   ]
}

Response JSON Object:

• name (string) – See name from User Call Pickup Group.

• assigned_users (array) – See assigned_users from User Call Pickup Group.

Status Codes:

• 200 OK –

User Call Pickup Group

Name	Type	Methods	Description
		GET
name	String	C	Uniquely identifies a call pickup group.
assigned_users	Array	A	List of assigned users in the call pickup group. See Available User List Item.