Executive¶

Display Executive available assistants¶

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/executive/available_assistants/¶

Retrieve the list of available assistant users for this executive user.

Authorization rights: minimum End User.

Example request:

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

Request JSON Object:

sameGroupOnly (boolean) – to filter the list to the same Group only. Default True. Only suitable for enterprises.

Example response:

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

{
  "users": [
    {
      "userId": "test_user@netaxis.be",
      "firstName": "Test",
      "lastName": "User",
      "phoneNumber": "+3269441552",
      "extension": "1552",
      "department": {
        "tenantId": "test_tenant",
        "groupId": "test_group",
        "departmentName": "Test department",
        "fullPathName": "Test department (test_group)"
      },
      "emailAddress": "test.user@netaxis.be"
    }
  ]
}

Example request with sameGroupOnly:

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

{
   "sameGroupOnly": false
}

Example response:

HTTP/1.1 200 OK

{
  "users": [
  {
      "userId": "ApioEntUserTestGrp2",
      "firstName": "User",
      "lastName": "ApioEnt",
      "phoneNumber": "",
      "extension": "",
      "emailAddress": "",
  },
  {
      "userId": "ApioEntUserTest2@sip.netaxis.be",
      "firstName": "User2",
      "lastName": "ApioEnt",
      "phoneNumber": "",
      "extension": "4001",
      "emailAddress": "",
  },
  ]
}

Status Codes:

200 OK – OK
200 OK – no error
404 Not Found – the service is not assigned to the user

Response JSON Object:

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

Display Executive’s assigned assistants¶

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/executive/assistants/¶

Retrieve the list of assigned assistants users to answer calls on behalf of the executive user.

Authorization rights: minimum End User.

Example request:

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

Example response:

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

{
  "allowOptInOut": false,
  "assistantUsers": [
    {
      "userId": "test_user@netaxis.be",
      "firstName": "Test",
      "lastName": "User",
      "phoneNumber": "+3269441552",
      "extension": "1552",
      "department": {
        "tenantId": "test_tenant",
        "groupId": "test_group",
        "departmentName": "Test department",
        "fullPathName": "Test department (test_group)"
      },
      "emailAddress": "test.user@netaxis.be"
    }
  ]
}

Response JSON Object:

allowOptInOut (boolean) – allow / disallow assistants to opt-in or opt-out of the pool.
assistantUsers (array) – a list of assistant users assigned to this executive as defined as User summary attributes.

Status Codes:

200 OK – no error
404 Not Found – the service is not assigned to the user

Update Executive’s assigned assistants¶

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/executive/assistants/¶

Update the list of assigned assistants users to answer calls on behalf of the executive user.

Authorization rights: minimum End User.

Example request:

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

{
  "allowOptInOut": true,
  "assistantUserIds": ["test_user@netaxis.be", "another_user@netaxis.be"]
}

Request JSON Object:

allowOptInOut (boolean) – allow / disallow assistants to opt-in or opt-out of the pool.
assistantUserIds (array) – a list of assistants users to be assigned to this executive.

Example response:

Response:

Similar to GET instance method response.

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 Executive’s filtering options¶

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/executive/filtering/¶

Retrieve call filtering options for the executive user. This allows to specify which incoming calls should be routed to executive’s assistants, based on filtering criteria.

Authorization rights: minimum End User.

Example request:

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

Example response:

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

{
  "enabled": false,
  "mode": "Simple",
  "type": "All Calls",
  "criteria": [
    {
      "name": "Test Criteria 1",
      "active": true,
      "filter": true,
      "timeSchedule": {
        "level": "User",
        "name": "My Office Hours",
        "type": "Time"
      },
      "fromDnCriteria": {
        "selection": "Specified Only",
        "includeAnonymousCallers": true,
        "includeUnavailableCallers": true,
        "phoneNumbers": [
          "+3223661285",
          "+3267219021"
        ]
      },
      "holidaySchedule": {
        "level": "Tenant",
        "name": "Group Holiday Schedule",
        "type": "Holiday"
      }
    }
  ]
}

Response JSON Object:

enabled (boolean) – used to turn call filtering on an off.
mode (string) – call Filtering Mode.
type (string) – pre-defined criteria to use for the Simple mode.
criteria (array) – a list of criteria objects used for Advanced mode as defined as Criteria attributes.

Status Codes:

200 OK – no error
404 Not Found – the service is not assigned to the user

Update Executive’s filtering options¶

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/executive/filtering/¶

Update call filtering options for the executive user.

Authorization rights: minimum End User.

Example request:

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

{
  "enabled": false,
  "mode": "Advanced",
  "type": "All Calls",
  "criteria": [
    {
      "name": "Test Criteria 1",
      "active": false
    }
  ]
}

Request JSON Object:

enabled (boolean) – used to turn call filtering on an off.
mode (string) – call Filtering Mode, allowed values are Simple or Advanced.
type (string) – pre-defined criteria to use for the Simple mode. Allowed values are All Calls, All Internal Calls or All External Calls.
criteria (array) – a list of criteria objects used for Advanced mode as defined as Criteria attributes.

Example response:

Response:

Similar to GET instance method response.

Status Codes:

200 OK – no error
404 Not Found – the service is not assigned to the user
400 Bad Request – error during the update

Note:

The current version of this service only allows the user to update the active flag of an existing criteria.

Display Executive’s screening options¶

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/executive/screening/¶

Retrieve call screening options for the executive user.

Authorization rights: minimum End User.

Example request:

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

Example response:

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

{
  "enabled": false,
  "alertType": "Silent",
  "alertMobilityLocation": false,
  "alertAnywhereLocations": false,
  "alertSharedCallAppearanceLocations": false
}

Response JSON Object:

enable (boolean) – used to turn call screening on an off.
alertType (string) – thee alerting type, allowed values are Silent or Ring Splash.
alertMobilityLocation (boolean) – enable / disable Mobility as a location to alert.
alertAnywhereLocations (boolean) – enable / disable Anywhere as a location to alert
alertSharedCallAppearanceLocations (boolean) – enable / disable Shared call Appearance as a location to alert

Status Codes:

200 OK – no error
404 Not Found – the service is not assigned to the user

Update Executive’s screening options¶

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/executive/screening/¶

Update call screening options for the executive user.

Authorization rights: minimum End User.

Example request:

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

{
  "enabled": true,
  "alertType": "Ring Splash",
  "alertMobilityLocation": true,
  "alertAnywhereLocations": false,
  "alertSharedCallAppearanceLocations": true
}

Request JSON Object:

enable (boolean) – used to turn call screening on an off.
alertType (string) – thee alerting type, allowed values are Silent or Ring Splash.
alertMobilityLocation (boolean) – enable / disable Mobility as a location to alert.
alertAnywhereLocations (boolean) – enable / disable Anywhere as a location to alert
alertSharedCallAppearanceLocations (boolean) – enable / disable Shared call Appearance as a location to alert

Example response:

Response:

Similar to GET instance method response.

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 Executive’s alerting options¶

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/executive/alerting/¶

Retrieve call alerting options for the executive user.

Authorization rights: minimum End User.

Example request:

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

Example response:

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

{
  "mode": "Sequential",
  "cliNameMode": "Custom",
  "cliCustomName": "Test User",
  "cliCustomNameUnicode": "Test User Unicode",
  "cliPhoneNumberMode": "Custom",
  "cliCustomPhoneNumber": "+32495575607",
  "callPushRecallAfter": 4,
  "nextAssistantAfter": 5,
  "rolloverEnabled": true,
  "rolloverWaitTime": 30,
  "rolloverAction": "Forward",
  "rolloverForwardTo": "+3223661285",
}

Response JSON Object:

mode (string) – the alerting mode, allowed values are Simultaneous or Sequential
cliNameMode (string) – the alerting calling line ID name mode, allowed values are Executive, Executive-Originator, Originator-Executive, Originator or Custom
cliCustomName (string) – the alerting calling line ID name in case the calling line ID name mode is set to Custom
cliCustomNameUnicode (string) – an optional alerting unicode calling line ID name in case the calling line ID name mode is set to Custom
cliPhoneNumberMode (string) – the alerting calling line ID number mode, allowed values are Executive, Originator or Custom
cliCustomPhoneNumber (string) – the alerting calling line ID number in case the calling line ID phone number mode is set to Custom
callPushRecallAfter (integer) – the number of rings for the call push recall
nextAssistantAfter (integer) – the number of rings before alerting the next assistant, if mode is set to Sequential
rolloverEnabled (boolean) – enable / disable rollover
rolloverWaitTime (integer) – the rollover time-out in seconds
rolloverAction (string) – the rollover action, allowed values are Voice Messaging, Forward or No Answer Processing
rolloverForwardTo (string) – the number to forward the call to if rollover action has been set to Forward

Status Codes:

200 OK – no error
404 Not Found – the service is not assigned to the user

Update Executive’s alerting options¶

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/executive/alerting/¶

Update call alerting options for the executive user.

Authorization rights: minimum End User.

Example request:

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

{
  "mode": "Sequential",
  "cliNameMode": "Custom",
  "cliCustomName": "Test User",
  "cliCustomNameUnicode": "Test User Unicode",
  "cliPhoneNumberMode": "Custom",
  "cliCustomPhoneNumber": "+32495575607",
  "callPushRecallAfter": 4,
  "nextAssistantAfter": 5,
  "rolloverEnabled": true,
  "rolloverWaitTime": 30,
  "rolloverAction": "Forward",
  "rolloverForwardTo": "+3223661285",
}

Request JSON Object:

mode (string) – the alerting mode, allowed values are Simultaneous or Sequential
cliNameMode (string) – the alerting calling line ID name mode, allowed values are Executive, Executive-Originator, Originator-Executive, Originator or Custom
cliCustomName (string) – the alerting calling line ID name in case the calling line ID name mode is set to Custom
cliCustomNameUnicode (string) – an optional alerting unicode calling line ID name in case the calling line ID name mode is set to Custom
cliPhoneNumberMode (string) – the alerting calling line ID number mode, allowed values are Executive, Originator or Custom
cliCustomPhoneNumber (string) – the alerting calling line ID number in case the calling line ID phone number mode is set to Custom
callPushRecallAfter (integer) – the number of rings for the call push recall
nextAssistantAfter (integer) – the number of rings before alerting the next assistant, if mode is set to Sequential
rolloverEnabled (boolean) – enable / disable rollover
rolloverWaitTime (integer) – the rollover time-out in seconds
rolloverAction (string) – the rollover action, allowed values are Voice Messaging, Forward or No Answer Processing
rolloverForwardTo (string) – the number to forward the call to if rollover action has been set to Forward

Example response:

Response:

Similar to GET instance method response.

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 user’s executive filter criteria¶

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/executive/criteria/(string: instance_name)/¶

Retrieve the settings of the specified executive filter criteria.

Authorization rights: minimum End User.

Example request:

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

Example response:

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

{
  "name": "Test Criteria 1",
  "timeSchedule": {
    "level": "User",
    "name": "My Office Hours",
    "type": "Time"
  },
  "holidaySchedule": {
    "level": "Tenant",
    "name": "Group Holiday Schedule",
    "type": "Holiday"
  },
  "filter": false,
  "fromDnCriteria": {
    "selection": "Specified Only",
    "includeAnonymousCallers": true,
    "includeUnavailableCallers": true,
    "phoneNumbers": [
      "+3223661285",
      "+3267219021"
    ]
  },
  "active": true,
}

Response JSON Object:

name (string) – see name from Criteria attributes for Executive and Executive Assistant.
active (boolean) – see active from Criteria attributes for Executive and Executive Assistant.
timeSchedule (object) – see timeSchedule from Criteria attributes for Executive and Executive Assistant.
holidaySchedule (object) – see holidaySchedule from Criteria attributes for Executive and Executive Assistant.
fromDnCriteria (object) – a criteria from DN object as defined as Criteria attributes for Executive and Executive Assistant.
filter (boolean) – see filter from Criteria attributes for Executive and Executive Assistant.

Status Codes:

200 OK – no error
404 Not Found – the service is not assigned to the user

Create a user’s executive filter criteria¶

POST /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/executive/criteria/¶

Create a new criteria for the executive filter feature.

Authorization rights: minimum End User.

Example request:

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

{
  "name": "Test Criteria 1",
  "timeSchedule": {
    "level": "User",
    "name": "My Office Hours",
    "type": "Time"
  },
  "holidaySchedule": {
    "level": "Tenant",
    "name": "Group Holiday Schedule",
    "type": "Holiday"
  },
  "filter": false,
  "fromDnCriteria": {
    "selection": "Specified Only",
    "includeAnonymousCallers": true,
    "includeUnavailableCallers": true,
    "phoneNumbers": [
      "+3223661285",
      "+3267219021"
    ]
  },
  "active": true,
}

Request JSON Object:

name (string) – see name from Criteria attributes for Executive and Executive Assistant (required).
active (boolean) – see active from Criteria attributes for Executive and Executive Assistant.
timeSchedule (object) – see timeSchedule from Criteria attributes for Executive and Executive Assistant.
holidaySchedule (object) – see holidaySchedule from Criteria attributes for Executive and Executive Assistant.
fromDnCriteria (object) – a criteria from DN object as defined as Criteria attributes for Executive and Executive Assistant.
filter (boolean) – see filter from Criteria attributes for Executive and Executive Assistant.

Example response:

Response:

Similar to GET instance method response.

Status Codes:

200 OK – no error
404 Not Found – the service is not assigned to the user
400 Bad Request – error during the update

Update a user’s executive filter criteria¶

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/executive/criteria/(string: instance_name)/¶

Update the specified executive filter criteria.

Authorization rights: minimum End User.

Example request:

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

{
  "name": "Test Criteria 1",
  "timeSchedule": {
    "level": "User",
    "name": "My Office Hours",
    "type": "Time"
  },
  "holidaySchedule": {
    "level": "Tenant",
    "name": "Group Holiday Schedule",
    "type": "Holiday"
  },
  "filter": false,
  "fromDnCriteria": {
    "selection": "Specified Only",
    "includeAnonymousCallers": true,
    "includeUnavailableCallers": true,
    "phoneNumbers": [
      "+3223661285",
      "+3267219021"
    ]
  },
  "active": true,
}

Request JSON Object:

name (string) – see name from Criteria attributes for Executive and Executive Assistant. Only required if you want to change the current name of the criteria.
active (boolean) – see active from Criteria attributes for Executive and Executive Assistant.
timeSchedule (object) – see timeSchedule from Criteria attributes for Executive and Executive Assistant.
holidaySchedule (object) – see holidaySchedule from Criteria attributes for Executive and Executive Assistant.
fromDnCriteria (object) – a criteria from DN object as defined as Criteria attributes for Executive and Executive Assistant.
filter (boolean) – see filter from Criteria attributes for Executive and Executive Assistant.

Example response:

Response:

Similar to GET instance method response.

Status Codes:

200 OK – no error
404 Not Found – the service is not assigned to the user
400 Bad Request – error during the update

Delete a user’s executive criteria¶

DELETE /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/executive/criteria/(string: instance_name)/¶

Delete the specified executive filter criteria.

Authorization rights: minimum End User.

Example request:

DELETE /api/v1/tenants/foo/groups/foogroup/users/foouser/services/executive/criteria/foocriteria/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

Example response:

HTTP/1.1 200 OK

Response JSON Object:

name (string) – see name from Criteria attributes for Custom Ring Back.

Status Codes:

200 OK – no error
404 Not Found – the service is not assigned to the user
400 Bad Request – error during the deletion