Call Pickup¶

Defining call pickup groups allows users part of the pickup group to take ringing calls from other members of the pickup group.

Retrieve list available users¶

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

Retrieve the list of the available users for assignement.

Example request:

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

Request JSON Object:

includeHiddenUsers (boolean) – See includeHiddenUsers from Search criteria.

Example response:

HTTP/1.1 200 OK

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

Response JSON Object:

available_users (array) – The list of the available users for assignement. See Available User List Item.

Status Codes:

200 OK –

Create instance¶

POST /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/call_pickups/¶

Create a new call pickup group in a group.

Example request:

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

{
   "name": "APIO Test Call Pickup",
   "assigned_users": [
      "ApioUserTest1@sip.netaxis.be",
      "ApioUserTest2@sip.netaxis.be"
   ]
}

Request JSON Object:

name (string) – See name from Call Pickup Instance.
userIds (array) – See userIds from Call Pickup Instance.

Example response:

Response:

Similar to GET instance method response.

Status Codes:

201 Created – instance created

Retrieve instance¶

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/call_pickups/(string: call_pickup_name)/¶

Retrieve a call pickup group.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/services/call_pickups/APIO%20Test%20Call%20Pickup@sip.netaxis.be/ HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK

{
   "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:

assigned_users (array) – See assigned_users from Call Pickup Instance.

Status Codes:

200 OK –

Retrieve list instances¶

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

Retrieve the list of call pickup groups.

Example request:

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

Example response:

HTTP/1.1 200 OK

{
   "call_pickups": ["APIO Test Call Pickup"]
}

Response JSON Object:

call_pickups (array) – The list of call pickup groups. See Call Pickup List Instances

Status Codes:

200 OK –

Update instance¶

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/call_pickups/(string: call_pickup_name)/¶

Update a call pickup group.

Example request:

PUT /api/v1/tenants/foo/groups/foogroup/services/call_pickups/APIO%20Test%20Call%20Pickup@sip.netaxis.be/ HTTP/1.1
Host: example.com

{
   "name": "APIO Test Call Pickup New",
   "assigned_users": [
      "ApioDummyUserTest@sip.netaxis.be",
      "ApioUserTest2@sip.netaxis.be",
      "ApioDummyUserTest1@sip.netaxis.be",
      "ApioUserTest1@sip.netaxis.be"
   ]
}

Request JSON Object:

name (string) – See name from Call Pickup Instance.
userIds (array) – See userIds from Call Pickup Instance.

Example response:

Response:

Similar to GET instance method response.

Status Codes:

200 OK – instance updated

Delete instance¶

DELETE /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/call_pickups/(string: call_pickup_name)/¶

Delete a call pickup group.

Example request:

DELETE /api/v1/tenants/foo/groups/foogroup/services/call_pickups/APIO%20Test%20Call%20Pickup%20New@sip.netaxis.be/ HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK

Status Codes:

200 OK – instance delete

Call Pickup Instance¶

Name	Type	Methods			Description
Name	Type	GET	POST	PUT	Description
name	String	N	R	R	Uniquely identifies a user. For PUT the value is an URL parameter.
assigned_users	Array	A	O	O	List of assigned users in the call pickup group. See Available User List Item.

Call Pickup List Instances¶

Name	Type	Methods			Description
Name	Type	GET	POST	PUT	Description
call_pickups	Array	A	F	F	List of call pickup names in the group.