Executive Assistant

Display Executive Assistant’s assigned executives

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

Retrieve the list of executives the user is assigned to as an assistant. An assistant can be assigned to more than one executive

Authorization rights: minimum End User.

Example request:

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

Example response:

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

{
  "enableDivert": true,
  "divertTo": "+3223661285",
  "executiveUsers": [
    {
      "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)"
      },
      "optInStatus": true,
      "optInAllowed": true
    }
  ]
}
Response JSON Object:

  • enableDivert (boolean) – allow / disallow diverting of executive calls.

  • divertTo (string) – a phone number to sent the call to if diverting is activated

  • executiveUsers (array) – a list of executive users assigned to this assistant as defined as User summary attributes. This list is extended with the two next fields.

  • optInStatus (boolean) – opt-in / opt-out of the executive pool. Modifying this flag is only allowed if executive allowed opt-in /opt-out option.

  • optInAllowed (boolean) – allow / disallow the assistant to opt-in / opt-out executive pool. This flag is read-only and cannot be changed by the assistant.

Status Codes:

Update Executive Assistant’s assigned executives

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

Update the list of assigned executive users assigned to the assistant.

Authorization rights: minimum End User.

Example request:

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

{
  "enableDivert": true,
  "divertTo": "+3223661285",
  "executiveUsers": [
    {
      "userId": "test_user@netaxis.be",
      "optInStatus": true
    }
  ]
}
Request JSON Object:

  • enableDivert (boolean) – allow / disallow diverting of executive calls.

  • divertTo (string) – a phone number to sent the call to if diverting is activated

  • executiveUsers (array) – a list of executive users assigned to this assistant together with their opt-in status.

  • optInStatus (boolean) – opt-in / opt-out of the executive pool. Modifying this flag is only allowed if executive allowed opt-in /opt-out option.

Example response:

Response:

Similar to GET instance method response.

Status Codes:

Display Executive Assistant’s filtering options

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/executive_assistant/executives/(string: instance_name)/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. This API is similar to the one of the executive. The assistant may only use it if he/she is in executive’s list of assigned assistants.

Authorization rights: minimum End User.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/users/foouser/services/executive_assistant/executives/baruser/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:

Update Executive Assistant’s filtering options

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/executive_assistant/executives/(string: instance_name)/filtering/

Update call filtering options for the executive user. This API is similar to the one of the executive. The assistant may only use it if he/she is in executive’s list of assigned assistants.

Authorization rights: minimum End User.

Example request:

PUT /api/v1/tenants/foo/groups/foogroup/users/foouser/services/executive_assistant/executives/baruser/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:

  • allowOptInOut (boolean) – see name from Criteria attributes.

  • assistantUserIds (array) – a list of assistants users to be assigned to this executive.

Example response:

Response:

Similar to GET instance method response.

Response 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.

Note:

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

Display Executive Assistant’s screening options

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/executive_assistant/executives/(string: instance_name)/screening/

Retrieve call screening options for the executive user. This API is similar to the one of the executive. The assistant may only use it if he/she is in executive’s list of assigned assistants.

Authorization rights: minimum End User.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/users/foouser/services/executive_assistant/executives/baruser/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:

Update Executive Assistant’s screening options

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/executive_assistant/executives/(string: instance_name)/screening/

Update call screening options for the executive user. This API is similar to the one of the executive. The assistant may only use it if he/she is in executive’s list of assigned assistants.

Authorization rights: minimum End User.

Example request:

PUT /api/v1/tenants/foo/groups/foogroup/users/foouser/services/executive_assistant/executives/baruser/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:

Display Executive Assistant’s alerting options

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/executive_assistant/executives/(string: instance_name)/alerting/

Retrieve call alerting options for the executive user. This API is similar to the one of the executive. The assistant may only use it if he/she is in executive’s list of assigned assistants.

Authorization rights: minimum End User.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/users/foouser/services/executive_assistant/executives/baruser/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:

Update Executive Assistant’s alerting options

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/executive_assistant/executives/(string: instance_name)/alerting/

Update call alerting options for the executive user. This API is similar to the one of the executive. The assistant may only use it if he/she is in executive’s list of assigned assistants.

Authorization rights: minimum End User.

Example request:

PUT /api/v1/tenants/foo/groups/foogroup/users/foouser/services/executive_assistant/executives/baruser/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:

Display user’s executive filter criteria

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/executive_assistant/executives/(string: instance_name)/criteria/(string: sub_instance_name)/

Retrieve the settings of the specified executive filter criteria. This API is similar to the one of the executive. The assistant may only use it if he/she is in executive’s list of assigned assistants.

Authorization rights: minimum End User.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/users/foouser/services/executive_assistant/executives/baruser/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:
Status Codes:

Create a user’s executive filter criteria

POST /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/executive_assistant/executives/(string: instance_name)/criteria/

Create a new criteria for the executive filter feature. This API is similar to the one of the executive. The assistant may only use it if he/she is in executive’s list of assigned assistants.

Authorization rights: minimum End User.

Example request:

POST /api/v1/tenants/foo/groups/foogroup/users/foouser/services/executive_assistant/executives/baruser/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:

Example response:

Response:

Similar to GET instance method response.

Status Codes:

Update a user’s executive filter criteria

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/executive_assistant/executives/(string: instance_name)/criteria/(string: sub_instance_name)/

Update the specified executive filter criteria. This API is similar to the one of the executive. The assistant may only use it if he/she is in executive’s list of assigned assistants.

Authorization rights: minimum End User.

Example request:

PUT /api/v1/tenants/foo/groups/foogroup/users/foouser/services/executive_assistant/executives/baruser/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:

Example response:

Response:

Similar to GET instance method response.

Status Codes:

Delete a user’s executive criteria

DELETE /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/executive_assistant/executives/(string: instance_name)/criteria/(string: sub_instance_name)/

Delete the specified executive filter criteria. This API is similar to the one of the executive. The assistant may only use it if he/she is in executive’s list of assigned assistants.

Authorization rights: minimum End User.

Example request:

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

Example response:

HTTP/1.1 200 OK
Response JSON Object:
Status Codes: