Mobile Number

Retrieve user’s mobile number settings

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

Update user’s mobile number.

Example request:

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

Example response:

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

{
   "active": false,
   "phonesToRing": "Fixed",
   "phoneNumber": "",
   "advanced_settings": {
      "alertClickToDialCalls": false,
      "alertGroupPagingCalls": false,
      "enableDiversionInhibitor": false,
      "requireAnswerConfirmation": false,
      "callControl": false,
      "useSettingLevel": "Group",
      "denyCallOriginations": false,
      "denyCallTerminations": false
   }
}
Response JSON Object:

  • active (boolean) – the active status.

  • phonesToRing (string) – the kind of phone to ring.

  • phoneNumber (string) – the phone number.

  • advanced_settings (object) – the advanced settings. See User Mobile Number Advanced Settings

Status Codes:

Update user’s mobile number settings

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

Update user’s mobile number.

Example request:

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

{
   "active": true,
   "phonesToRing": "Mobile",
   "phoneNumber": "+32-99996666",
   "advanced_settings": {
      "alertClickToDialCalls": true,
      "enableDiversionInhibitor": true,
   }
}
Request JSON Object:

  • active (boolean) – (Optional) the active status.

  • phonesToRing (string) – (Optional) the kind of phone to ring.

  • phoneNumber (string) – (Conditional) the phone number. Must be specified if active is set to True.

  • advanced_settings (object) – (Optional) the advanced settings. See User Mobile Number Advanced Settings

Example response:

Response:

Similar to GET instance method response.

Status Codes:

User Mobile Number Advanced Settings

Name

Type

Method

Description

GET

PUT

alertClickToDialCalls

Boolean

A

O

Ring the user’s mobile phone when the user makes a Click-to-Dial call.

alertGroupPagingCalls

Boolean

A

O

Ring the user’s mobile phone when the user receives a Group Paging call.

enableDiversionInhibitor

Boolean

A

O

Prevent redirection of unanswered incoming calls.

requireAnswerConfirmation

Boolean

A

O

Prompt the user to enter a confirmation digit before completing the mobile call leg answered by the user.

callControl

Boolean

A

O

Specify that call control is to be performed by Network Element and not by the mobile device.

useSettingLevel

String

A

O, C

WARNING: only for an admin. Value from “Group”, “User”. Use the mobility settings defined for the group or define it by setting the following fields.

denyCallOriginations

Boolean

A

O, C

WARNING: only for an admin. Block the user’s outgoing calls.

denyCallTerminations

Boolean

A

O, C

WARNING: only for an admin. Block the user’s incoming calls.

User Multiple Mobile Numbers

The Multiple Mobile Numbers service integrates the mobile network with the business services environment of the enterprise. This provides a seamless experience for the end user, allowing them to have a consistent business service on their mobile phone and desk phones. It also offers the flexibility of using multiple mobile devices and deciding when and how to use them for business and personal calls.

Retrieve a user’s multiple mobile numbers properties

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

Retrieve a user’s multiple mobile numbers properties.

Authorization rights: minimum End User.

Example request:

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

Example response:

HTTP/1.1 200 OK

{
      "active": false,
      "useMobileIdentityCallAnchoring": true,
      "preventCallsToOwnMobiles": false,
      "devicesToRing": {
          "mode": "Fixed",
          "includeSharedCallAppearance": true,
          "includeAnywhere": true,
          "includeExecutiveAssistant": true,
          "mobilesNumbers": [
              {
                  "mobileNumber": "+32471123599",
                  "countryCode": "32",
                  "nationalPrefix": "0"
              }
          ]
      }
}
Response JSON Object:

  • active (boolean) – Specifies whether the service is enabled or disabled.

  • useMobileIdentityCallAnchoring (boolean) – Specifies whether the user can configure call anchoring settings for your mobile devices.

  • preventCallsToOwnMobiles (boolean) – Specifies whether the user is allowed to make calls between his mobile devices.

  • devicesToRing (object) – The devices to ring when a call is received. An object as defined as Devices To Ring.

Status Codes:

Update a user’s multiple mobile numbers properties

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

Update a user’s multiple mobile numbers properties.

Authorization rights: minimum End User.

Restricted authorization rights: minimum Group Admin for these parameters:

  • active

  • useMobileIdentityCallAnchoring

  • preventCallsToOwnMobiles

Example request:

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

{
      "active": false,
      "useMobileIdentityCallAnchoring": true,
      "preventCallsToOwnMobiles": false,
      "devicesToRing": {
          "mode": "Fixed",
          "includeSharedCallAppearance": true,
          "includeAnywhere": true,
          "includeExecutiveAssistant": true,
          "mobilesNumbers": [
              {
                  "mobileNumber": "+32471123599"
              }
          ]
      }
}
Request JSON Object:

  • active (boolean) – Specifies whether the service is enabled or disabled.

  • useMobileIdentityCallAnchoring (boolean) – Specifies whether the user can configure call anchoring settings for your mobile devices.

  • preventCallsToOwnMobiles (boolean) – Specifies whether the user is allowed to make calls between his mobile devices.

  • devicesToRing (object) – The devices to ring when a call is received. An object as defined as Devices To Ring.

Example response:

Response:

Similar to GET instance method response.

Status Codes:

Retrieve a user’s multiple mobile numbers identities

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

Retrieve the list of mobile numbers identities of an end user.

Authorization rights: minimum End User.

Example request:

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

Example response:

HTTP/1.1 200 OK

{
      "mobileNumbers": [
          {
              "mobileNumber": "+32471123598",
              "description": "Test Description",
              "countryCode": "32",
              "nationalPrefix": "0",
              "primary": true,
              "enableAlerting": true
          }
      ]
}
Response JSON Object:
Status Codes:

Add a user’s multiple mobile numbers identity

POST /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/multiple_mobile_numbers/

Add a new mobile number identity to an end user.

Authorization rights: minimum End User.

Restricted authorization rights: minimum Group Admin for these parameters:

  • useSettingLevel

  • denyCallOriginations

  • denyCallTerminations

  • endpoint

  • outboundAlternateNumber

  • enableDirectRouting

  • markCDRAsEnterpriseGroupCalls

  • networkTranslationIndex

Example request:

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

{
      "mobileNumber": "+32471123598",
      "description": "Test Description",
      "primary": true,
      "enableAlerting": true,
      "alertAgentCalls": true,
      "alertClickToDialCalls": false,
      "alertGroupPagingCalls": false,
      "useMobilityCLI": false,
      "enableDiversionInhibitor": false,
      "requireAnswerConfirmation": false,
      "callControl": false,
      "useSettingLevel": "User",
      "denyCallOriginations": false,
      "denyCallTerminations": false,
      "devicesToRing": {
          "mode": "Mobile",
          "includeSharedCallAppearance": false,
          "includeAnywhere": false,
          "includeExecutiveAssistant": false,
          "mobilesNumbers": [
              {
                  "mobileNumber": "+32471123598"
              }
          ]
      },
      "enableDirectRouting": false,
      "markCDRAsEnterpriseGroupCalls": false,
      "endpoint": {
          "accessDevice": {
              "name": "APIO Test Device",
              "level": "Group"
          },
          "linePort": "test@sip.netaxis.be",
          "contacts": ["test_contact"]
      },
      "callAnchoring": {
          "enableCallAnchoring": true,
          "timeSchedule": {
              "level": "User",
              "name": "Every Friday"
          },
          "holidaySchedule": {
              "level": "User",
              "name": "Every Easter"
          }
      }
}
Request JSON Object:

  • mobileNumber (string) – The mobile number to add.

  • primary (boolean) – Specifies if it is the primary mobile number.

  • devicesToRing (object) – The devices to ring when this mobile number is called. An object as defined as Devices To Ring.

  • description (string) – (Optional) The description of the mobile number.

  • enableAlerting (boolean) – (Optional) Specifies if to enable the alerting.

  • alertAgentCalls (boolean) – (Optional) Make the user’s phone ring when a hunt group, call center, or route point for which the user is an agent distributes a call to the user.

  • alertClickToDialCalls (boolean) – (Optional) Make the user’s phone ring for Click To Dial calls.

  • alertGroupPagingCalls (boolean) – (Optional) Make the user’s phone ring when he receives a paging call.

  • useMobilityCLI (boolean) – (Optional) Specifies if to use the user’s mobile phone number as calling line identity when he makes a call from this mobile device.

  • enableDiversionInhibitor (boolean) – (Optional) Specifies if to enable Diversion Inhibitor: the unanswered incoming calls will not be redirected.

  • requireAnswerConfirmation (boolean) – (Optional) Specifies if an answer confirmation is required: a confirmation digit is prompted before the mobile call is answered by the user.

  • callControl (boolean) – (Optional) Specifies if call control has to be performed by BroadWorks and not by the mobile device.

  • useSettingLevel (string) – (Optional) A value from list: [‘Group’, ‘User’]. Select ‘Group’ to use the mobility settings defined for the Group. Select ‘User’ to use the mobility settings defined for the User.

  • denyCallOriginations (boolean) – (Optional) Specifies if to block outgoing calls from the mobile device.

  • denyCallTerminations (boolean) – (Optional) Specifies if to block incoming calls from the mobile device.

  • enableDirectRouting (boolean) – (Optional) Specifies whether direct routing is enabled for this mobile identity.

  • markCDRAsEnterpriseGroupCalls (boolean) – (Optional) Specifies whether calls made directly to the mobile identity from other users within the same enterprise or group shoud be recorded as intra-enterprise/group calls in the call detail record.

  • endpoint (object) – (Optional) An object as defined as Access Device Endpoint Hotline. Mutually exclusive with ‘outboundAlternateNumber’.

  • outboundAlternateNumber (string) – (Optional) An alternate outbound phone number or SIP-URI. Mutually exclusive with ‘endpoint’.

  • callAnchoring (object) – (Optional) An object as defined as Call Anchoring.

  • useMobilityConnectedIdentity (boolean) – (Optional) Specify if to use the mobility connected identity. Only available for Rel23.

  • networkTranslationIndex (boolean) – (Optional) the Network Translation Index (NTI) used to route calls from this device. Overrides the NTI configured at a higher level. The device has to have the Use Mobility Calling Line ID option enabled for the NTI to be used. Only available for Rel23.

Example response:

Response:

Similar to GET instance method response.

Status Codes:

  • 200 OK – no error

  • 400 Bad Request –

    invalid request due to invalid parameters, with possible sub-error codes:

    • 45 API_NOT_AVAILABLE_AT_NE, Some data cannot be modified or added because feature 16716 has not been activated.

    • 45 API_NOT_AVAILABLE_AT_NE, Some data cannot be modified or added because feature 16331 has not been activated.

    • 45 API_NOT_AVAILABLE_AT_NE, Some data cannot be modified or added because feature 20077 has not been activated.

Retrieve a user’s multiple mobile numbers identity

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

Retrieve a mobile number identity of an end user.

Authorization rights: minimum End User.

Example request:

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

Example response:

HTTP/1.1 200 OK

{
      "description": "Test Description",
      "primary": true,
      "enableAlerting": true,
      "alertAgentCalls": true,
      "alertClickToDialCalls": false,
      "alertGroupPagingCalls": false,
      "useMobilityCLI": false,
      "enableDiversionInhibitor": false,
      "requireAnswerConfirmation": false,
      "callControl": false,
      "useSettingLevel": "User",
      "denyCallOriginations": false,
      "denyCallTerminations": false,
      "devicesToRing": {
          "mode": "Mobile",
          "includeSharedCallAppearance": false,
          "includeAnywhere": false,
          "includeExecutiveAssistant": false,
          "mobilesNumbers": [
              {
                  "mobileNumber": "+32471123598",
                  "countryCode": "32",
                  "nationalPrefix": "0"
              }
          ]
      },
      "enableDirectRouting": false,
      "markCDRAsEnterpriseGroupCalls": false,
      "endpoint": {
          "accessDevice": {
              "name": "APIO Test Device",
              "level": "Group"
          },
          "linePort": "test@sip.netaxis.be",
          "contacts": ["test_contact"]
      },
      "callAnchoring": {
          "enableCallAnchoring": true,
          "timeSchedule": {
              "level": "User",
              "name": "Every Friday",
              "type": "Time"
          },
          "holidaySchedule": {
              "level": "User",
              "name": "Every Easter",
              "type": "Holiday"
          }
      }
}
Response JSON Object:

  • description (string) – The description of the mobile number.

  • primary (boolean) – Specifies if it is the primary mobile number.

  • enableAlerting (boolean) – Specifies if to enable the alerting.

  • alertAgentCalls (boolean) – Make the user’s phone ring when a hunt group, call center, or route point for which the user is an agent distributes a call to the user.

  • alertClickToDialCalls (boolean) – Make the user’s phone ring for Click To Dial calls.

  • alertGroupPagingCalls (boolean) – Make the user’s phone ring when he receives a paging call.

  • useMobilityCLI (boolean) – Specifies if to use the user’s mobile phone number as calling line identity when he makes a call from this mobile device.

  • enableDiversionInhibitor (boolean) – Specifies if to enable Diversion Inhibitor: the unanswered incoming calls will not be redirected.

  • requireAnswerConfirmation (boolean) – Specifies if an answer confirmation is required: a confirmation digit is prompted before the mobile call is answered by the user.

  • callControl (boolean) – Specifies if call control has to be performed by BroadWorks and not by the mobile device.

  • useSettingLevel (string) – A value from list: [‘Group’, ‘User’]. Select ‘Group’ to use the mobility settings defined for the Group. Select ‘User’ to use the mobility settings defined for the User.

  • denyCallOriginations (boolean) – Specifies if to block outgoing calls from the mobile device.

  • denyCallTerminations (boolean) – Specifies if to block incoming calls from the mobile device.

  • devicesToRing (object) – The devices to ring when this mobile number is called. An object as defined as Devices To Ring.

  • enableDirectRouting (boolean) – Specifies whether direct routing is enabled for this mobile identity.

  • markCDRAsEnterpriseGroupCalls (boolean) – Specifies whether calls made directly to the mobile identity from other users within the same enterprise or group shoud be recorded as intra-enterprise/group calls in the call detail record.

  • endpoint (object) – An object as defined as Access Device Endpoint Hotline.

  • outboundAlternateNumber (string) – An alternate outbound phone number or SIP-URI.

  • callAnchoring (object) – An object as defined as Call Anchoring.

  • useMobilityConnectedIdentity (boolean) – Specify if to use the mobility connected identity. Only available for Rel23.

  • networkTranslationIndex (boolean) – the Network Translation Index (NTI) used to route calls from this device. Overrides the NTI configured at a higher level. The device has to have the Use Mobility Calling Line ID option enabled for the NTI to be used. Only available for Rel23.

Status Codes:

Update a user’s multiple mobile numbers identity

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

Update a mobile number identity of an end user.

Authorization rights: minimum End User.

Restricted authorization rights: minimum Group Admin for these parameters:

  • useSettingLevel

  • denyCallOriginations

  • denyCallTerminations

  • endpoint

  • outboundAlternateNumber

  • enableDirectRouting

  • markCDRAsEnterpriseGroupCalls

  • networkTranslationIndex

Example request:

PUT /api/v1/tenants/foo/groups/foogroup/users/foouser/services/multiple_mobile_numbers/+32471123598/ HTTP/1.1
Host: example.com

{
      "description": "Test Description",
      "primary": true,
      "enableAlerting": true,
      "alertAgentCalls": true,
      "alertClickToDialCalls": false,
      "alertGroupPagingCalls": false,
      "useMobilityCLI": false,
      "enableDiversionInhibitor": false,
      "requireAnswerConfirmation": false,
      "callControl": false,
      "useSettingLevel": "User",
      "denyCallOriginations": false,
      "denyCallTerminations": false,
      "devicesToRing": {
          "mode": "Mobile",
          "includeSharedCallAppearance": false,
          "includeAnywhere": false,
          "includeExecutiveAssistant": false,
          "mobilesNumbers": [
              {
                  "mobileNumber": "+32471123598"
              }
          ]
      },
      "enableDirectRouting": false,
      "markCDRAsEnterpriseGroupCalls": false,
      "endpoint": {
          "accessDevice": {
              "name": "APIO Test Device",
              "level": "Group"
          },
          "linePort": "test@sip.netaxis.be",
          "contacts": ["test_contact"]
      },
      "callAnchoring": {
          "enableCallAnchoring": true,
          "timeSchedule": {
              "level": "User",
              "name": "Every Friday"
          },
          "holidaySchedule": {
              "level": "User",
              "name": "Every Easter"
          }
      }
}
Request JSON Object:

  • description (string) – (Optional) The description of the mobile number.

  • primary (boolean) – (Optional) Specifies if it is the primary mobile number.

  • enableAlerting (boolean) – (Optional) Specifies if to enable the alerting.

  • alertAgentCalls (boolean) – (Optional) Make the user’s phone ring when a hunt group, call center, or route point for which the user is an agent distributes a call to the user.

  • alertClickToDialCalls (boolean) – (Optional) Make the user’s phone ring for Click To Dial calls.

  • alertGroupPagingCalls (boolean) – (Optional) Make the user’s phone ring when he receives a paging call.

  • useMobilityCLI (boolean) – (Optional) Specifies if to use the user’s mobile phone number as calling line identity when he makes a call from this mobile device.

  • enableDiversionInhibitor (boolean) – (Optional) Specifies if to enable Diversion Inhibitor: the unanswered incoming calls will not be redirected.

  • requireAnswerConfirmation (boolean) – (Optional) Specifies if an answer confirmation is required: a confirmation digit is prompted before the mobile call is answered by the user.

  • callControl (boolean) – (Optional) Specifies if call control has to be performed by BroadWorks and not by the mobile device.

  • useSettingLevel (string) – (Optional) A value from list: [‘Group’, ‘User’]. Select ‘Group’ to use the mobility settings defined for the Group. Select ‘User’ to use the mobility settings defined for the User.

  • denyCallOriginations (boolean) – (Optional) Specifies if to block outgoing calls from the mobile device.

  • denyCallTerminations (boolean) – (Optional) Specifies if to block incoming calls from the mobile device.

  • devicesToRing (object) – (Optional) The devices to ring when this mobile number is called. An object as defined as Devices To Ring.

  • enableDirectRouting (boolean) – (Optional) Specifies whether direct routing is enabled for this mobile identity.

  • markCDRAsEnterpriseGroupCalls (boolean) – (Optional) Specifies whether calls made directly to the mobile identity from other users within the same enterprise or group shoud be recorded as intra-enterprise/group calls in the call detail record.

  • endpoint (object) – (Optional) An object as defined as Access Device Endpoint Hotline. Mutually exclusive with ‘outboundAlternateNumber’.

  • outboundAlternateNumber (string) – (Optional) An alternate outbound phone number or SIP-URI. Mutually exclusive with ‘endpoint’.

  • callAnchoring (object) – (Optional) An object as defined as Call Anchoring.

  • useMobilityConnectedIdentity (boolean) – (Optional) Specify if to use the mobility connected identity. Only available for Rel23.

  • networkTranslationIndex (boolean) – (Optional) The Network Translation Index (NTI) used to route calls from this device. Overrides the NTI configured at a higher level. The device has to have the Use Mobility Calling Line ID option enabled for the NTI to be used. Only available for Rel23.

Example response:

Response:

Similar to GET instance method response.

Status Codes:

  • 200 OK – no error

  • 400 Bad Request –

    invalid request due to invalid parameters, with possible sub-error codes:

    • 45 API_NOT_AVAILABLE_AT_NE, Some data cannot be modified or added because feature 16716 has not been activated.

    • 45 API_NOT_AVAILABLE_AT_NE, Some data cannot be modified or added because feature 16331 has not been activated.

    • 45 API_NOT_AVAILABLE_AT_NE, Some data cannot be modified or added because feature 20077 has not been activated.

Delete a user’s multiple mobile numbers identity

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

Delete a mobile number identity from an end user.

Authorization rights: minimum End User.

Example request:

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

{}

Example response:

HTTP/1.1 200 OK
Status Codes:

Configuration Information for Multiple Mobile Numbers

In the POST and the PUT APIs, the Application Server can allow to specify a specific endpoint by mobile number or not.

The following settings is to instruct the APIO how to manage this:

"IDENTITY_NETWORK_PROFILE_SUPPORT": true,
Settings description:

  • IDENTITY_NETWORK_PROFILE_SUPPORT: if false (default), the APIO will prevent the use of endpoint and outboundAlternateNumber in the POST and the PUT