Push to Talk Services

Display push to talk selected users

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

Retrieve the settings of the Push to Talk service of the user.

Example request:

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

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{
  "selectedUsers": [
    {
      "userId": "ApioDummyUserTest@sip.netaxis.be",
      "firstName": "Test",
      "lastName": "Dummy",
      "extension": "",
      "phoneNumber": "",
      "department": {
        "tenantId": "ApioSpTest",
        "groupId": "ApioGrpTest",
        "departmentName": "test_department_initial",
        "fullPathName": "test_department_initial (ApioGrpTest)"
      },
      "emailAddress": "",
      "impId": ""
    }
  ],
  "allowAutoAnswer": false,
  "outgoingConnectionSelection": "Two Way",
  "accessListSelection": "Allow Calls From Everyone Except Selected Users"
}

Response JSON Object:

• selectedUsers (list) – a list of selected users as defined as User summary attributes.

• allowAutoAnswer (boolean) – enables or disables automatic answering of Push to Talk calls

• outgoingConnectionSelection (string) – establishes a one-way or two-way path. Allowed values are One way or Two way

• accessListSelection (string) – the way Push to Talk calls are filtered. Allowed values are Allow Calls From Selected Users or Allow Calls From Everyone Except Selected Users

Status Codes:

• 200 OK – no error

• 404 Not Found – the service is not assigned to the user

Update push to talk selected users

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/push_to_talk/

Update the settings of the Push to Talk service of the user.

Example request:

PUT /api/v1/tenants/foo/groups/foogroup/users/foouser/services/push_to_talk/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
    "selectedUserIds": [
        "ApioDummyUserTest@sip.netaxis.be",
        "ApioUserTest1@sip.netaxis.be",
    ],
    "allowAutoAnswer": false,
    "outgoingConnectionSelection": "Two Way",
    "accessListSelection": "Allow Calls From Everyone Except Selected Users"
}

Example response:

HTTP/1.1 200 OK

Request JSON Object:

• selectedUserIds (array) – the list of selected user IDs - empty list to delete

• allowAutoAnswer (boolean) – enables or disables automatic answering of Push to Talk calls

• outgoingConnectionSelection (string) – establishes a one-way or two-way path. Allowed values are One way or Two way

• accessListSelection (string) – the way Push to Talk calls are filtered. Allowed values are Allow Calls From Selected Users or Allow Calls From Everyone Except Selected Users

Status Codes:

• 200 OK – no error

• 404 Not Found – the service is not assigned to the user

• 400 Bad Request – error during the update

Display push to talk available users

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

Retrieve the list of available users to be used for the Push to Talk service of the user.

Example request:

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

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{
  "users": [
    {
      "userId": "ApioDummyUserTest@sip.netaxis.be",
      "firstName": "Test",
      "lastName": "Dummy",
      "extension": "",
      "phoneNumber": "",
      "department": {
        "tenantId": "ApioSpTest",
        "groupId": "ApioGrpTest",
        "departmentName": "test_department_initial",
        "fullPathName": "test_department_initial (ApioGrpTest)"
      },
      "emailAddress": "",
      "impId": ""
    }
  ]
}

Response JSON Object:

• users (array) – a list of users as defined as User summary attributes.

Status Codes:

• 200 OK – no error

• 404 Not Found – the service is not assigned to the user

User summary attributes

Name	Type	Method	Description
		GET
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	String	A	The department the user belongs to, an object as defined as Group department key attributes.
phoneNumber	String	A	The user’s phone number (if configured, empty or absent otherwise) (see Phone Number)
extension	String	A	The user extension. (see Extension)
emailAddress	String	A	The user email address
impId	String	A	TODO