Call Processing Policies

Display the call processing policies at System level

GET /api/v1/system/call_processing_policy/

Example request:

GET /api/v1/system/call_processing_policy/ HTTP/1.1
Host: example.com

Example response:

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

{
  "useMaxSimultaneousCalls": true,
  "maxSimultaneousCalls": 5,
  "useMaxSimultaneousVideoCalls": true,
  "maxSimultaneousVideoCalls": 5,
  "useMaxCallTimeForAnsweredCalls": true,
  "maxCallTimeForAnsweredCallsMinutes": 1440,
  "useMaxCallTimeForUnansweredCalls": false,
  "maxCallTimeForUnansweredCallsMinutes": 2,
  "mediaPolicySelection": "No Restrictions",
  "networkUsageSelection": "Do Not Force Enterprise and Group Calls",
  "enforceGroupCallingLineIdentityRestriction": false,
  "enforceEnterpriseCallingLineIdentityRestriction": false,
  "allowEnterpriseGroupCallTypingForPrivateDialingPlan": false,
  "allowEnterpriseGroupCallTypingForPublicDialingPlan": false,
  "overrideCLIDRestrictionForPrivateCallCategory": false,
  "useEnterpriseCLIDForPrivateCallCategory": false,
  "enableEnterpriseExtensionDialing": true,
  "maxConferenceParties": 6,
  "useMaxConcurrentRedirectedCalls": true,
  "maxConcurrentRedirectedCalls": 5,
  "useMaxFindMeFollowMeDepth": true,
  "maxFindMeFollowMeDepth": 2,
  "maxRedirectionDepth": 5,
  "useMaxConcurrentFindMeFollowMeInvocations": true,
  "maxConcurrentFindMeFollowMeInvocations": 2,
  "clidPolicy": "Use DN",
  "emergencyClidPolicy": "Use DN",
  "allowAlternateNumbersForRedirectingIdentity": true,
  "blockCallingNameForExternalCalls": false,
  "enableDialableCallerID": false,
  "allowConfigurableCLIDForRedirectingIdentity": true,
  "enterpriseCallsCLIDPolicy": "Use Location Code plus Extension",
  "enterpriseGroupCallsCLIDPolicy": "Use Extension",
  "serviceProviderGroupCallsCLIDPolicy": "Use Extension",
  "enablePhoneListLookup": false
}
Response JSON Object:

  • clidPolicy (string) – the calling line ID policy for external calls

  • enterpriseCallsCLIDPolicy (string) – the calling line ID policy for Enterprise Calls, for a tenant of type enterprise.

  • groupCallsCLIDPolicy (string) – the calling line ID policy for Group Calls.

  • serviceProviderGroupCallsCLIDPolicy (string) – Service Provider Group Calls CLID Policy

  • emergencyClidPolicy (string) – the calling line ID policy for Emergency Calls.

  • allowAlternateNumbersForRedirectingIdentity (boolean) – If the user was called on his alternate identity then the alternate number is used as the redirecting identity

  • allowConfigurableCLIDForRedirectingIdentity (boolean) – Preset the configurable CLID of the user in redirected calls.

  • blockCallingNameForExternalCalls (boolean) – Prevent the system from sending the user’s calling name when the user makes an external call.

  • useMaxSimultaneousCalls (boolean) – the maximum number of concurrent calls check is enabled.

  • maxSimultaneousCalls (integer) – the maximum number of concurrent calls if enabled.

  • useMaxSimultaneousVideoCalls (boolean) – the maximum number of concurrent video calls check is enabled.

  • maxSimultaneousVideoCalls (integer) – the maximum number of concurrent video calls if enabled.

  • useMaxCallTimeForAnsweredCalls (boolean) – the maximum duration for answered calls check is enabled.

  • maxCallTimeForAnsweredCallsMinutes (integer) – the maximum duration for answered calls if enabled.

  • useMaxCallTimeForUnansweredCalls (boolean) – the maximum duration for unanswered calls check is enabled.

  • maxCallTimeForUnansweredCallsMinutes (integer) – the maximum duration for unanswered calls if enabled.

  • useMaxConcurrentFindMeFollowMeInvocations (boolean) – the maximum number of concurrent Find Me/Follow Me invocations check is enabled.

  • maxConcurrentFindMeFollowMeInvocations (integer) – the maximum number of concurrent Find Me/Follow Me invocations if enabled.

  • useMaxConcurrentRedirectedCalls (boolean) – to enable the maximum number for concurrent redirected calls check is enabled.

  • maxConcurrentRedirectedCalls (integer) – the maximum number for concurrent redirected calls if enabled.

  • useMaxFindMeFollowMeDepth (boolean) – the maximum number for the Find Me/Follow me depth check is enabled.

  • maxFindMeFollowMeDepth (integer) – the maximum number for the Find Me/Follow me depth if enabled.

  • maxRedirectionDepth (integer) – the maximum redirection depth.

  • maxConferenceParties" (integer) – max number of partecipants to conference

  • mediaPolicySelection (string) – the Media policy configured.

  • supportedMediaSetName (string) – the particular supported media in case this mode is enabled.

  • networkUsageSelection (string) – Network Usage types.

  • enforceGroupCallingLineIdentityRestriction (boolean) – Forces the group’s calling line ID restrictions for incoming calls.

  • enforceEnterpriseCallingLineIdentityRestriction (boolean) – Forces the tenant’s calling line ID restrictions for incoming calls.

  • allowEnterpriseGroupCallTypingForPrivateDialingPlan (boolean) – this feature allows group calls to be routed internally within the Application Server if the destination is hosted on the same Application Server, and if the Network Server used a Private Dialing Plan routing policy.

  • allowEnterpriseGroupCallTypingForPublicDialingPlan (boolean) – this feature allows group calls to be routed internally within the Application Server if the destination is hosted on the same Application Server, and if the Network Server used a Public Dialing Plan routing policy.

  • overrideCLIDRestrictionForPrivateCallCategory (boolean) – this feature allows you to override the Calling Line Identity restrictions when the Network Server returns a contact via its private dialing plan whether the destination is part of the same enterprise as the caller or not.

  • useEnterpriseCLIDForPrivateCallCategory (boolean) – to use the policy that you are currently defining for the the tenant.

  • enableEnterpriseExtensionDialing (boolean) – when enabled the calls inside a Tenant of type Enterprise remains local.

  • enableDialableCallerID" (boolean) – enable Dialable Caller ID

  • enablePhoneListLookup (boolean) – enable the Phone List Lookup.

Request JSON Object:

  • conferenceURI (string) – Conference URI

Status Codes:

Update the call processing policies at Tenant level

PUT /api/v1/tenants/(string: tenant_id)/services/call_processing_policies/

Update the configuration of the call processing policy at Tenant level.

Example request:

PUT /api/v1/tenants/foo/services/call_processing_policies/ HTTP/1.1
Host: example.com

Content-Type: "application/json"

{
  "supportedMediaSetName": "",
  "conferenceURI": 'test@netaxis.be',
  "enablePhoneListLookup": false
}
Response JSON Object:

  • clidPolicy (string) – (Optional) the calling line ID policy for external calls. value comes from list: “Use DN”, “Use Configurable CLID”

  • emergencyClidPolicy (string) – (Optional) the calling line ID policy for Emergency Calls. value comes from list: “Use DN”, “Use Configurable CLID”

  • enterpriseCallsCLIDPolicy (string) – (Optional) the calling line ID policy for Enterprise Calls, for a tenant of type enterprise. value comes from list: “Use Extension”, “Use Location Code plus Extension”, “Use External Calls Policy”

  • enterpriseGroupCallsCLIDPolicy (string) – (Optional) the Group calling line ID policy for Enterprise Calls, for a tenant of type enterprise. value comes from list: “Use Extension”, “Use Location Code plus Extension”, “Use External Calls Policy”

  • serviceProviderGroupCallsCLIDPolicy (string) – (Optional) Service Provider Group Calls CLID Policy

  • allowConfigurableCLIDForRedirectingIdentity (boolean) – (Optional) Preset the configurable CLID of the user in redirected calls.

  • allowAlternateNumbersForRedirectingIdentity (boolean) – (Optional) If the user was called on his alternate identity then the alternate number is used as the redirecting identity

  • blockCallingNameForExternalCalls (boolean) – (Optional) Prevent the system from sending the user’s calling name when the user makes an external call.

  • useMaxSimultaneousCalls (boolean) – (Optional) the maximum number of concurrent calls check is enabled.

  • maxSimultaneousCalls (integer) – (Optional) the maximum number of concurrent calls if enabled. Value from range 1 - 999999.

  • useMaxSimultaneousVideoCalls (boolean) – (Optional) the maximum number of concurrent video calls check is enabled.

  • maxSimultaneousVideoCalls (integer) – (Optional) the maximum number of concurrent video calls if enabled. Value from range 1 - 999999.

  • useMaxCallTimeForAnsweredCalls (boolean) – (Optional) the maximum duration for answered calls check is enabled.

  • maxCallTimeForAnsweredCallsMinutes (integer) – (Optional) the maximum duration for answered calls if enabled. Value from range 3 - 2880.

  • useMaxCallTimeForUnansweredCalls (boolean) – (Optional) the maximum duration for unanswered calls check is enabled.

  • maxCallTimeForUnansweredCallsMinutes (integer) – (Optional) the maximum duration for unanswered calls if enabled. Value from range 1 - 2880.

  • useMaxConcurrentRedirectedCalls (boolean) – (Optional) to enable the maximum number for concurrent redirected calls check is enabled. Value from range 1 - 999999.

  • maxConcurrentRedirectedCalls (integer) – (Optional) the maximum number for concurrent redirected calls if enabled. Value from range 1 - 999999.

  • useMaxConcurrentFindMeFollowMeInvocations (boolean) – (Optional) the maximum number of concurrent Find Me/Follow Me invocations check is enabled.

  • maxConcurrentFindMeFollowMeInvocations (integer) – (Optional) the maximum number of concurrent Find Me/Follow Me invocations if enabled. Value from range 1 - 999999.

  • useMaxFindMeFollowMeDepth (boolean) – (Optional) the maximum number for the Find Me/Follow me depth check is enabled.

  • maxFindMeFollowMeDepth (integer) – (Optional) the maximum number for the Find Me/Follow me depth if enabled. Value from range 1 - 100.

  • maxRedirectionDepth (integer) – (Optional) the maximum redirection depth. Value from range 1 - 100.

  • maxConferenceParties" (integer) – (Optional) max number of partecipants to conference. Value from range 4 - 15.

  • mediaPolicySelection (string) – (Optional) the Media policy configured. value comes from list: “Use Uncompressed Codec”, “Use Supported Media Set”, “No Restrictions”.

  • supportedMediaSetName (string) – (Optional) the particular supported media in case this mode is enabled.

  • networkUsageSelection (string) – (Optional) Network Usage types. Value comes from list: “Force All Calls”, “Force All Except Extension and Location Calls”, “Do Not Force Enterprise and Group Calls”

  • enforceGroupCallingLineIdentityRestriction (boolean) – (Optional) Forces the group’s calling line ID restrictions for incoming calls.

  • enforceEnterpriseCallingLineIdentityRestriction (boolean) – (Optional) Forces the tenant’s calling line ID restrictions for incoming calls.

  • allowEnterpriseGroupCallTypingForPrivateDialingPlan (boolean) – (Optional) this feature allows group calls to be routed internally within the Application Server if the destination is hosted on the same Application Server, and if the Network Server used a Private Dialing Plan routing policy.

  • allowEnterpriseGroupCallTypingForPublicDialingPlan (boolean) – (Optional) this feature allows group calls to be routed internally within the Application Server if the destination is hosted on the same Application Server, and if the Network Server used a Public Dialing Plan routing policy.

  • overrideCLIDRestrictionForPrivateCallCategory (boolean) – (Optional) this feature allows you to override the Calling Line Identity restrictions when the Network Server returns a contact via its private dialing plan whether the destination is part of the same enterprise as the caller or not.

  • useEnterpriseCLIDForPrivateCallCategory (boolean) – (Optional) to use the policy that you are currently defining for the the tenant.

  • enableEnterpriseExtensionDialing (boolean) – (Optional) when enabled the calls inside a Tenant of type Enterprise remains local.

  • conferenceURI (string) – (Optional) Conference URI

  • enableDialableCallerID (boolean) – (Optional) enable Dialable CallerID

  • enablePhoneListLookup (boolean) – (Optional) enable the Phone List Lookup.

Status Codes:

Example response:

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

{}
Status Codes: