Call Policies

Display the call policies of the User

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

Authorization rights: minimum End User.

Example request:

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

Example response:

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

{
  "redirectedCallsCOLPPrivacy": "Privacy For External Calls",
  "callBeingForwardedResponseCallType": "Internal Calls",
  "callingLineIdentityForRedirectedCalls": "Redirecting User Identity For All Redirections"
}
Response JSON Object:

  • redirectedCallsCOLPPrivacy (string) – the type of privacy applied on redirected calls.

  • callBeingForwardedResponseCallType (string) – the policy for generating 181 SIP responses for redirected calls.

  • callingLineIdentityForRedirectedCalls (string) – the calling line identity for redirected calls.

Status Codes:

Update the call policies of the User

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

Authorization rights: minimum End User.

Example request:

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

{
  "redirectedCallsCOLPPrivacy": "Privacy For External Calls",
  "callBeingForwardedResponseCallType": "Internal Calls",
  "callingLineIdentityForRedirectedCalls": "Redirecting User Identity For All Redirections"
}
Request JSON Object:

  • redirectedCallsCOLPPrivacy (string) – the type of privacy applied on redirected calls. Value comes from list: “No Privacy”, “Privacy For External Calls”, “Privacy For All Calls”

  • callBeingForwardedResponseCallType (string) – the policy for generating 181 SIP responses for redirected calls. Value comes from list: “Never”, “Internal Calls”, “All Calls”

  • callingLineIdentityForRedirectedCalls (string) – the calling line identity for redirected calls. Value comes from list: “Originating Identity”, “Redirecting User Identity For External Redirections”, “Redirecting User Identity For All Redirections”

Example response:

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

{
  "redirectedCallsCOLPPrivacy": "Privacy For External Calls",
  "callBeingForwardedResponseCallType": "Internal Calls",
  "callingLineIdentityForRedirectedCalls": "Redirecting User Identity For All Redirections"
}
Status Codes: