Call Interception

Get configuration

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/intercept/

Get the details about the call interception of a group.

Example request:

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

Example response:

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

{
   "active": false,
   "inboundAnnouncementSelection": "Default",
   "audioFile": {
      "name": "Test audio file"
   },
   "inboudPlayNewPhoneNumber": false,
   "inboudTransferOnZeroToPhoneNumber": false,
   "inboundInterceptionMode": "Intercept All",
   "inboundAlternateBlockingAnnouncement": false,
   "inboundRouteToVoiceMail": false,
   "outboundRerouteCalls": false,
   "outboundAllowLocalCalls": false
}
Response JSON Object:

  • active (boolean) – Indicate if the service is active or not

  • inboundAnnouncementSelection (string) – Define the type announcement played to incoming intercepted calls.

  • audioFile (object) – (Optional) An object as defined as Audio File attributes.

  • inboudPlayNewPhoneNumber (boolean) – If true, play new phone number for inbound intercepted calls feature.

  • inboudNewPhoneNumber (string) – (Optional) The new phone number to be played when playNewPhoneNumber is true.

  • inboudTransferOnZeroToPhoneNumber (boolean) – If true, the transfer to other phone number when pressing “0” feature is active.

  • inboudTransferPhoneNumber (boolean) – (Optional) Transfer to this phone number if transferOnZeroToPhoneNumber is active.

  • inboundInterceptionMode (string) – The type of inbound calls to Intercept or allow.

  • inboundAlternateBlockingAnnouncement (boolean) – Play an alternate announcement for inbound calls when “Allow All” is selected.

  • inboundRouteToVoiceMail (boolean) – Define the phone number for the outbound rerouting.

  • inboundExemptMobilityCalls (boolean) – Inbound calls fot mobile number are never blocked if enable.

  • inboundDisableParallelRingingToNetworkLocations (boolean) – This option disables parallel ringing to the intercepted user’s alternate network locations on allowed inbound calls.

  • outboundRerouteCalls (boolean) – Reroute outbound calls to a phone number.

  • outboundReroutePhoneNumber (string) – (Optional) Define the phone number for the outbound rerouting.

  • outboundAllowLocalCalls (boolean) – Allow outbound calls to local numbers. Mutually exclusive with allowOutboundEntAndGroupCalls, if both are False then all outbound calls are rejected.

  • allowOutboundEntAndGroupCalls (string) – Allow outbound calls to Group and Tenant (If Enterprise) numbers. Mutually exclusive with outboundAllowLocalCalls, if both are False then all outbound calls are rejected.

  • outboundExemptMobilityCalls (boolean) – Outgoing calls fot mobile number are never blocked if enable.

Status Codes:

Update configuration

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/services/intercept/

Update the details about the call interception of a group. It is also possible to apply a provisioning template to update the Intercept configuration. The provisioning template is of category group_intercept with default_values (for further informations, see Create Provisioning Template).

It is not allowed to update the Intercept configuration when the Group is in a suspended status. In this case, only a System admin can force the update.

Example request:

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

{
   "active": true,
   "inboundInterceptionMode": "Intercept All",
   "inboundAnnouncementSelection": "Personal",
   "inboundAudioFile": {
       "description": "Test audio file",
       "content": CONTENT_AUDIO_FILE
   },
   "inboundAlternateBlockingAnnouncement": true,
   "inboundRouteToVoiceMail": true,
   "inboundPlayNewPhoneNumber": true,
   "inboundNewPhoneNumber": "+3271123456",
   "inboundTransferOnZeroToPhoneNumber": true,
   "inboundTransferPhoneNumber": "+3271654321"
}
Request JSON Object:

  • active (boolean) – (Optional) Indicate if the service is active or not

  • inboundInterceptionMode (string) – (Optional) Define the type of interception for incoming calls.

  • inboundAnnouncementSelection (string) – (Optional) Define the type announcement played to incoming intercepted calls.

  • inboundAudioFile (object) – (Optional) Define the Personal announcement, see Audio File Upload.

  • inboundAlternateBlockingAnnouncement (boolean) – (Optional) Play an alternate announcement for inbound calls when “Allow All” is selected.

  • inboundRouteToVoiceMail (boolean) – (Optional) Route inbound intercepted calls to the VM of the user instead of playing the announcement.

  • inboundPlayNewPhoneNumber (boolean) – (Optional) Activate the play new phone number for inbound intercepted calls feature.

  • inboundNewPhoneNumber (string) – (Optional) The new phone number to be played when inboudPlayNewPhoneNumber is true.

  • inboundTransferOnZeroToPhoneNumber (boolean) – (Optional) Activate the transfer to other phone number when pressing “0” feature.

  • inboundTransferPhoneNumber (string) – (Optional) The new phone number to be played when inboundTransferOnZeroToPhoneNumber is true.

  • inboundExemptMobilityCalls (boolean) – (Optional) Inbound calls fot mobile number are never blocked if enable.

  • inboundDisableParallelRingingToNetworkLocations (boolean) – (Optional) This option disables parallel ringing to the intercepted user’s alternate network locations on allowed inbound calls.

  • outboundAllowLocalCalls (string) – (Optional) Allow outbound calls to local numbers. Mutually exclusive with inboundTransferOnZeroToPhoneNumber, if both are False then all outbound calls are rejected.

  • allowOutboundEntAndGroupCalls (string) – (Optional) Allow outbound calls to Group and Tenant (If Enterprise) numbers. Mutually exclusive with outboundAllowLocalCalls, if both are False then all outbound calls are rejected.

  • outboundRerouteCalls (string) – (Optional) Reroute outbound blocked calls to a phone number.

  • outboundReroutePhoneNumber (string) – (Optional) Define the phone number for the outbound rerouting.

  • outboundExemptMobilityCalls (boolean) – (Optional) Outgoing calls fot mobile number are never blocked if enable.

  • templateName (string) – (Optional) As defined as Template Name.

Example response:

Response:

Similar to GET instance method response.

Status Codes: