Call Forwarding Services with Voice Mail Support¶

Display user’s call forwarding always with voice mail¶

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

The API is implemented using UserCallForwardingAlwaysGetRequest and UserVoiceMessagingUserGetVoiceManagementRequest.

The following logic is applied when analyzing the answer from Broadsoft to build the final answer:

if CFA is active, the mode has value “number” and the active is True
else if VM is active and alwaysRedirectToVoiceMail is True then mode has value “voiceMail” and the active is True
else if VM the mode has value “number” and the active is False

Update a user’s call forwarding always with voice mail¶

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

The API is implemented using UserCallForwardingAlwaysModifyRequest and UserVoiceMessagingUserModifyVoiceManagementRequest

The following logic is applied to build the requests towards Broadsoft:

if the mode has value “voiceMail” and active is True then the CFA is deactivated, the VM is activated and the VM option alwaysRedirectToVoiceMail is activated
else if the mode has value “voiceMail” and active is False then the CFA is deactivated, the VM is status is untouched (because it could be needed for other features) and the VM option alwaysRedirectToVoiceMail is deactivated
else if the mode has value “number” and active is True then the CFA is activated, the VM is status is untouched (because it could be needed for other features) and the VM option alwaysRedirectToVoiceMail is deactivated
else if the mode has value “number” and active is False then the CFA is deactivated, the VM is status is untouched (because it could be needed for other features) and the VM option alwaysRedirectToVoiceMail is deactivated

In case of mode = voiceMail and active is True, will auto-population the voice messaging credentials using UserVoiceMessagingUserModifyAdvancedVoiceManagementRequest.

Display user’s call forwarding busy with voice mail¶

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

The API is implemented using UserCallForwardingBusyGetRequest and UserVoiceMessagingUserGetVoiceManagementRequest.

The following logic is applied when analyzing the answer from Broadsoft to build the final answer:

if CFB is active, the mode has value “number” and the active is True
else if VM is active and busyRedirectToVoiceMail is True then mode has value “voiceMail” and the active is True
else if VM the mode has value “number” and the active is False

Update a user’s call forwarding busy with voice mail¶

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

The API is implemented using UserCallForwardingBusyModifyRequest and UserVoiceMessagingUserModifyVoiceManagementReques

The following logic is applied to build the requests towards Broadsoft:

if the mode has value “voiceMail” and active is True then the CFA is deactivated, the VM is activated and the VM option busyRedirectToVoiceMail is activated
else if the mode has value “voiceMail” and active is False then the CFA is deactivated, the VM is status is untouched (because it could be needed for other features) and the VM option busyRedirectToVoiceMail is deactivated
else if the mode has value “number” and active is True then the CFA is activated, the VM is status is untouched (because it could be needed for other features) and the VM option busyRedirectToVoiceMail is deactivated
else if the mode has value “number” and active is False then the CFA is deactivated, the VM is status is untouched (because it could be needed for other features) and the VM option busyRedirectToVoiceMail is deactivated

In case of mode = voiceMail and active is True, will auto-population the voice messaging credentials using UserVoiceMessagingUserModifyAdvancedVoiceManagementRequest.

Display user’s call forwarding no answer with voice mail¶

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

The API is implemented using UserCallForwardingNoAnswerGetRequest and UserVoiceMessagingUserGetVoiceManagementRequest.

The following logic is applied when analyzing the answer from Broadsoft to build the final answer:

if CFNA is active, the mode has value “number” and the active is True
else if VM is active and noAnswerRedirectToVoiceMail is True then mode has value “voiceMail” and the active is True
else if VM the mode has value “number” and the active is False
The numberOfRings is read for the the CFNA

Additional informations

Response JSON Object:

numberOfRings (integer) – Value in range 0, 2 - 20.

Update a user’s call forwarding no answer with voice mail¶

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

The API is implemented using UserCallForwardingNoAnswerModifyRequest and UserVoiceMessagingUserModifyVoiceManagementReques

The following logic is applied to build the requests towards Broadsoft:

if the mode has value “voiceMail” and active is True then the CFNA is deactivated, the VM is activated and the VM option noAnswerRedirectToVoiceMail is activated
else if the mode has value “voiceMail” and active is False then the CFNA is deactivated, the VM is status is untouched (because it could be needed for other features) and the VM option noAnswerRedirectToVoiceMail is deactivated
else if the mode has value “number” and active is True then the CFNA is activated, the VM is status is untouched (because it could be needed for other features) and the VM option noAnswerRedirectToVoiceMail is deactivated
else if the mode has value “number” and active is False then the CFNA is deactivated, the VM is status is untouched (because it could be needed for other features) and the VM option noAnswerRedirectToVoiceMail is deactivated
The numberOfRings is updated in the CFNA service.

In case of mode = voiceMail and active is True, will auto-population the voice messaging credentials using UserVoiceMessagingUserModifyAdvancedVoiceManagementRequest.

Additional restrictions

Response JSON Object:

numberOfRings (integer) – Value in range 0, 2 - 20.