Call Capacity Management¶

Create instance¶

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

Create a new instance for the call capacity service.

Authorization Right:minimum Group Admin.

Example request:

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

{
   "name": "test_call_capa",
   "isDefault": true,
   "maxCalls": 7,
   "maxOutgoingCalls": 5,
   "userIds" : [
      "user_1@sip.netaxis.be",
      "user_9@sip.netaxis.be"
   ]
}

Request JSON Object:

name (string) – (Required) See name from Call Capacity Instance.
isDefault (boolean) – (Required) See isDefault from Call Capacity Instance.
maxCalls (integer) – (Required) See maxCalls from Call Capacity Instance.
maxIncomingCalls (integer) – (Optional) See maxIncomingCalls from Call Capacity Instance. If not present there is no limitation.
maxOutgoingCalls (integer) – (Optional) See maxOutgoingCalls from Call Capacity Instance. If not present there is no limitation.
userIds (array) – (Optional) See userIds from Call Capacity Instance.

Example response:

Response:

Similar to GET instance method response.

Status Codes:

201 Created – instance created

Retrieve list instances¶

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

Retrieve the list of instances of the call capacity service.

Authorization Right:minimum Group Admin.

Example request:

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

Example response:

HTTP/1.1 200 OK

{
   "call_capacities" : [
      {
         "name": "test_call_capa",
         "isDefault": true,
         "maxCalls": 7,
         "maxOutgoingCalls": 5
      }
   ]
}

Response JSON Object:

call_capacities (object) – A list of call capacities. See Call Capacity Instance

Status Codes:

200 OK – no errors

Retrieve instance¶

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

Retrieve an instance of the call capacity service.

Authorization Right:minimum Group Admin.

Example request:

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

Example response:

HTTP/1.1 200 OK

{
   "isDefault": true,
   "maxCalls": 7,
   "maxOutgoingCalls": 5
   "users": [
      {
         "extension": "5001",
         "firstName": "Test1",
         "lastName": "Test1",
         "userId": "ApioUserTest1@sip.netaxis.be",
         "emailAddress": "",
         "department": "",
         "phoneNumber": "+3225126777"
      }
   ]
}

Response JSON Object:

name (string) – (Always) See name from Call Capacity Instance.
isDefault (boolean) – (Always) See isDefault from Call Capacity Instance.
maxCalls (integer) – (Always) See maxCalls from Call Capacity Instance.
maxIncomingCalls (integer) – (Optional) See maxIncomingCalls from Call Capacity Instance. If not present there is no limitation.
maxOutgoingCalls (integer) – (Optional) See maxOutgoingCalls from Call Capacity Instance. If not present there is no limitation.
users (array) – (Optional) See users from Call Capacity Instance.

Status Codes:

200 OK – no errors

Modify instance¶

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/call_capacities/(string: call_capacity_name)/¶

Update an instance of the call capacity service.

Authorization Right:minimum Group Admin.

Example request:

PUT /api/v1/tenants/foo/groups/foogroup/services/call_capacities/test_call_capa/ HTTP/1.1
Host: example.com

{
   "isDefault": true,
   "maxCalls": 5,
   "maxIncomingCalls": null,
   "maxOutgoingCalls": 3,
   "userIds" : [
      "user_1"
   ]
}

Request JSON Object:

name (integer) – (Optional) See name from Call Capacity Instance.
isDefault (boolean) – (Optional) See isDefault from Call Capacity Instance.
maxCalls (integer) – (Optional) See maxCalls from Call Capacity Instance.
maxIncomingCalls (integer) – (Optional) See maxIncomingCalls from Call Capacity Instance. Special case: use null to remove the limit, as 0 means no call.
maxOutgoingCalls (integer) – (Optional) See maxOutgoingCalls from Call Capacity Instance. Special case: use null to remove the limit, as 0 means no call.
userIds (array) – (Optional) See userIds from Call Capacity Instance.

Example response:

Response:

Similar to GET instance method response.

Status Codes:

200 OK – instance updated
400 Bad Request – some errors occurred

Delete instance¶

DELETE /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/call_capacities/(string: call_capacity_name)/¶

Delete an instance of the call capacity service.

Authorization Right:minimum Group Admin.

Example request:

DELETE /api/v1/tenants/foo/groups/foogroup/services/call_capacities/test_call_capa/ HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK

Status Codes:

200 OK – instance delete

Retrieve available users¶

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

Retrieve the list of users who could be assigned to a Call Capacity instance.

Authorization Right:minimum Group Admin.

Example request:

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

Example response:

HTTP/1.1 200 OK

{
   "users": [
      {"userId": "user1", "firstName": "tom", "lastName": "smith", "extension": "1234", "emailAddress": "", "phoneNumber": "+3225126777"},
      {"userId": "user2", "firstName": "john", "lastName": "doe", "extension": "4321", "emailAddress": "", "department": {"tenantId": "ApioSpTest", "groupId": "ApioGrpTest", "departmentName": "test_department_initial", "fullPathName": "test_department_parent_1 \\ test_department_initial"}, "phoneNumber": "+3225125757"}
   ]
}

Response JSON Object:

users (array) – a list of user objects as defined below

Status Codes:

200 OK – no errors

Users for Call Capacity attributes¶

Name	Type	Methods	Description
Name	Type	GET	Description
userId	String	A	The unique user Id.
firstName	String	A	The user first name. (See First / Last name).
lastName	String	A	The user last name. (See First / Last name).
department	Object	C	The department the user belongs to. (See Group department key attributes).
extension	String	A	The user extension. (See Extension).
phoneNumber	String	A	The user phone number (See Phone Number).
emailAddress	String	A	The user email address.