Mobile Number

Retrieve user’s mobile number settings

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

The API is mapped to UserBroadWorksMobilityGetRequest

Additional informations

Response JSON Object:

Update user’s mobile number settings

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

The API is mapped to UserBroadWorksMobilityModifyRequest

Additional restrictions

Request JSON Object:

  • phonesToRing (string) – Values from “Fixed”, “Mobile”, “Both”.

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

  • advanced_settings (object) – Not supported by Broadsoft. See User Mobile Number Advanced Settings.

Note:

If the request modifies the phoneNumber and the new number does not belong to the appropriate Mobile Subscriber Directory Numbers pool, the request is rejected. For a service provider the number must belong to the group Mobile Subscriber Directory Numbers pool. For an enterprise user, the number must belong to the enterprise Mobile Subscriber Directory Numbers pool. If the request is executed by a user and modifies the phoneNumber, the request is rejected.

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.