Communication Barring Digit Pattern¶

Display tenant’s communication barring digit pattern criteria list¶

GET /api/v1/tenants/(string: tenant_id)/services/comm_barring/digit_patterns/¶

Display tenant’s communication barring digit patterns list.

Example request:

GET /api/v1/tenants/foo/services/comm_barring/digit_patterns/ HTTP/1.1
Host: example.com

Example response:

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

{
     "criteria": [
          {
              "name": "test digit pattern",
              "description": "criteria description"
          }
     ]
}

Response JSON Object:

criteria (array) – A list of criteria objects as defined in Digit pattern criteria in list attributes.

Status Codes:

200 OK – no error

Add a tenant’s communication barring digit pattern criteria¶

POST /api/v1/tenants/(string: tenant_id)/services/comm_barring/digit_patterns/¶

Add a tenant’s communication barring digit pattern criteria.

Example request:

POST /api/v1/tenants/foo/services/comm_barring/digit_patterns/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
  "name": "test pattern 2",
  "description": "test pattern 2 description",
  "digit_patterns": ["+123", "456?", "789$"]
}

Request JSON Object:

name (string) – See name from Digit pattern criteria attributes.
description (string) – See description from Digit pattern criteria attributes.
digit_patterns (array) – See digit_patterns from Digit pattern criteria attributes.

Example response:

HTTP/1.1 200 OK

Status Codes:

200 OK – no error
400 Bad Request – invalid data

Update a tenant’s communication barring digit pattern criteria¶

PUT /api/v1/tenants/(string: tenant_id)/services/comm_barring/digit_patterns/¶

Update a tenant’s communication barring digit pattern criteria.

Example request:

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

{
  "name": "test pattern 2",
  "description": "test pattern 2 description",
  "digit_patterns": ["+123", "456?", "789$"]
}

Request JSON Object:

name (string) – See name from Digit pattern criteria attributes.
description (string) – See description from Digit pattern criteria attributes.
digit_patterns (array) – See digit_patterns from Digit pattern criteria attributes. This is a replacement list.

Example response:

HTTP/1.1 200 OK

Status Codes:

200 OK – no error
400 Bad Request – invalid data

Display tenant’s communication barring digit pattern criteria¶

GET /api/v1/tenants/(string: tenant_id)/services/comm_barring/digit_patterns/(string: instance_name)/¶

Display tenant’s communication barring digit pattern instance.

Example request:

GET /api/v1/tenants/foo/services/comm_barring/digit_patterns/test_pattern/ HTTP/1.1
Host: example.com

Example response:

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

{
  "description": "test pattern description",
  "digit_patterns": ["+123", "456?", "789$"]
}

Response JSON Object:

description (string) – See description from Digit pattern criteria attributes.
digit_patterns (array) – See digit_patterns from Digit pattern criteria attributes.

Status Codes:

200 OK – no error

Remove a tenant’s communication barring digit pattern criteria¶

DELETE /api/v1/tenants/(string: tenant_id)/services/comm_barring/digit_patterns/(string: instance_name)/¶

Remove a tenant’s communication barring digit pattern criteria.

Authorization rights: minimum Tenant Admin.

Example request:

DELETE /api/v1/tenants/footenant/services/comm_barring/digit_patterns/test_pattern/ HTTP/1.1
Host: example.com

Example response:

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

{}

Status Codes:

200 OK – no error. Note that trying to delete an unexistent digit pattern criteria does not report an error.

Retrieve a list of profiles using a specified digit pattern criteria¶

GET /api/v1/tenants/(string: tenant_id)/services/comm_barring/digit_patterns/(string: instance_name)/usage/¶

Retrieve a list of profiles using a specified digit pattern criteria

Example request:

GET /api/v1/tenants/foo/services/comm_barring/digit_patterns/test_pattern/usage/ HTTP/1.1
Host: example.com

Example response:

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

{
   "profiles": [
      {
         "name": "test_profile",
         "description": "Foo description"
      }
   ]
}

Response JSON Object:

name (string) – The unique name of the profile.
description (string) – The profile description.

Status Codes:

200 OK – no error

Communication Barring Profile¶

Display tenant’s communication barring profile list¶

GET /api/v1/tenants/(string: tenant_id)/services/comm_barring/profiles/¶

Display tenant’s communication barring profiles list.

Example request:

GET /api/v1/tenants/foo/services/comm_barring/profiles/ HTTP/1.1
Host: example.com

Example response:

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

{
  "profiles": [
      {
          "default": true,
          "name": "Test profile 1",
          "description": "Test profile 1 description"
      }
  ]
}

Response JSON Object:

profiles (array) – A list of profiles objects as defined in Profile in list attributes.

Status Codes:

200 OK – no error

Add a tenant’s communication barring profile¶

POST /api/v1/tenants/(string: tenant_id)/services/comm_barring/profiles/¶

Add a tenant’s communication barring profile.

Example request:

POST /api/v1/tenants/foo/services/comm_barring/profiles/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
      "name": "Test valid profile",
      "description": "Test valid description",
      "originatingDefaultAction": "Allow",
      "originatingRules": [
          {
              "digitPatternCriteria": "test pattern 1",
              "action": "Treatment",
              "treatmentId": "test_treatment",
              "timeSchedule": "APIO Test Time Schedule",
              "holidaySchedule": "APIO Test Holiday Schedule"
          }
      ],
      "redirectingDefaultAction": "Allow",
      "redirectingRules": [],
      "callMeNowDefaultAction": "Allow",
      "callMeNowRules": [],
      "incomingDefaultAction": "Allow",
      "incomingRules": [],
      "default": true,
      "applyToAttendedCallTransfers": true
}

Request JSON Object:

name (string) – See name from Digit pattern criteria attributes.
description (string) – See description from Digit pattern criteria attributes.
originatingDefaultAction (string) – The default originating action. A value from list: “Allow”, “Allow Timed”, “Block”, “Authorization Code”, “Authorization Code Timed”, “Treatment”, “Transfer”.
originatingRules (array) – A list of objects as defined in Digit pattern rule attributes.
redirectingDefaultAction (string) – The default redirecting action. A value from list: “Allow”, “Allow Timed”, “Block”.
redirectingRules (array) – A list of objects as defined in Digit pattern rule attributes.
callMeNowDefaultAction (string) – The default call me now action. A value from list: “Allow”, “Allow Timed”, “Block”.
callMeNowRules (array) – A list of objects as defined in Digit pattern rule attributes.
incomingDefaultAction (string) – The default incoming action. A value from list: “Allow”, “Allow Timed”, “Block”.
incomingRules (array) – A list of objects as defined in Digit pattern rule attributes.
default (boolean) – Specifies if this profile is the default one.
applyToAttendedCallTransfers (boolean) – Specifies if to apply to attended call transfers.

Example response:

HTTP/1.1 200 OK

Status Codes:

200 OK – no error
400 Bad Request –
bad request, with possible sub-error codes:
- 2: INVALID_PARAMETERS, See restrictions for parameters within rules object: Digit pattern rule attributes

Update a tenant’s communication barring profile¶

PUT /api/v1/tenants/(string: tenant_id)/services/comm_barring/profiles/(string: instance_name)/¶

Update a tenant’s communication barring profile.

Example request:

PUT /api/v1/tenants/foo/services/comm_barring/profiles/test_profile/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
      "name": "Test valid profile",
      "description": "Test valid description",
      "originatingDefaultAction": "Allow",
      "originatingRules": [
          {
              "digitPatternCriteria": "test pattern 1",
              "action": "Treatment",
              "treatmentId": "test_treatment",
              "timeSchedule": "APIO Test Time Schedule",
              "holidaySchedule": "APIO Test Holiday Schedule"
          }
      ],
      "redirectingDefaultAction": "Allow",
      "redirectingRules": [],
      "callMeNowDefaultAction": "Allow",
      "callMeNowRules": [],
      "incomingDefaultAction": "Allow",
      "incomingRules": [],
      "default": true,
      "applyToAttendedCallTransfers": true
}

Request JSON Object:

name (string) – See name from Digit pattern criteria attributes.
description (string) – See description from Digit pattern criteria attributes.
originatingDefaultAction (string) – The default originating action. A value from list: “Allow”, “Allow Timed”, “Block”, “Authorization Code”, “Authorization Code Timed”, “Treatment”, “Transfer”.
originatingRules (array) – A list of objects as defined in Digit pattern rule attributes.
redirectingDefaultAction (string) – The default redirecting action. A value from list: “Allow”, “Allow Timed”, “Block”.
redirectingRules (array) – A list of objects as defined in Digit pattern rule attributes.
callMeNowDefaultAction (string) – The default call me now action. A value from list: “Allow”, “Allow Timed”, “Block”.
callMeNowRules (array) – A list of objects as defined in Digit pattern rule attributes.
incomingDefaultAction (string) – The default incoming action. A value from list: “Allow”, “Allow Timed”, “Block”.
incomingRules (array) – A list of objects as defined in Digit pattern rule attributes.
default (boolean) – Specifies if this profile is the default one.
applyToAttendedCallTransfers (boolean) – Specifies if to apply to attended call transfers.

Example response:

HTTP/1.1 200 OK

Status Codes:

200 OK – no error
400 Bad Request –
bad request, with possible sub-error codes:
- 2: INVALID_PARAMETERS, See restrictions for parameters within rules object: Digit pattern rule attributes

Display tenant’s communication barring profile¶

GET /api/v1/tenants/(string: tenant_id)/services/comm_barring/profiles/(string: instance_name)/¶

Display tenant’s communication barring profile.

Example request:

GET /api/v1/tenants/foo/services/comm_barring/profiles/test_profile/ HTTP/1.1
Host: example.com

Example response:

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


{
      "name": "Test valid profile",
      "description": "Test valid description",
      "originatingDefaultAction": "Allow",
      "originatingRules": [
          {
              "digitPatternCriteria": "test pattern 1",
              "action": "Treatment",
              "treatmentId": "test_treatment",
              "timeSchedule": "APIO Test Time Schedule",
              "holidaySchedule": "APIO Test Holiday Schedule"
          }
      ],
      "redirectingDefaultAction": "Allow",
      "redirectingRules": [
          {
              'digitPatternCriteria': 'test pattern 1',
              'action': 'Allow Timed',
              'callTimeoutSeconds': 3723,
              'timeSchedule': 'APIO Test Time Schedule',
              'holidaySchedule': 'APIO Test Holiday Schedule'
          }
      ],
      "callMeNowDefaultAction": "Allow",
      "callMeNowRules": [],
      "incomingDefaultAction": "Allow",
      "incomingRules": [],
      "default": true,
      "applyToAttendedCallTransfers": true
}

Response JSON Object:

name (string) – See name from Digit pattern criteria attributes.
description (string) – See description from Digit pattern criteria attributes.
originatingDefaultAction (string) – The default originating action. A value from list: “Allow”, “Allow Timed”, “Block”, “Authorization Code”, “Authorization Code Timed”, “Treatment”, “Transfer”.
originatingRules (array) – A list of objects as defined in Digit pattern rule attributes.
redirectingDefaultAction (string) – The default redirecting action. A value from list: “Allow”, “Allow Timed”, “Block”.
redirectingRules (array) – A list of objects as defined in Digit pattern rule attributes.
callMeNowDefaultAction (string) – The default call me now action. A value from list: “Allow”, “Allow Timed”, “Block”.
callMeNowRules (array) – A list of objects as defined in Digit pattern rule attributes.
incomingDefaultAction (string) – The default incoming action. A value from list: “Allow”, “Allow Timed”, “Block”.
incomingRules (array) – A list of objects as defined in Digit pattern rule attributes.
default (boolean) – Specifies if this profile is the default one.
applyToAttendedCallTransfers (boolean) – Specifies if to apply to attended call transfers.

Status Codes:

200 OK – no error

Remove a tenant’s communication barring profile¶

DELETE /api/v1/tenants/(string: tenant_id)/services/comm_barring/profiles/(string: instance_name)/¶

Remove a tenant’s communication barring profile.

Authorization rights: minimum Tenant Admin.

Example request:

DELETE /api/v1/tenants/footenant/services/comm_barring/profiles/test_profile/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
  "defaultProfile": "test pattern 2"
}

Request JSON Object:

defaultProfile (string) – (Optional) The name of the new default profile. If the default profile is deleted without specifying a new default profile, there will not be a default profile set.

Example response:

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

{}

Status Codes:

200 OK – no error. Note that trying to delete an unexistent profile does not report an error.

Retrieve a list of groups using a specified profile¶

GET /api/v1/tenants/(string: tenant_id)/services/comm_barring/profiles/(string: instance_name)/usage/¶

Retrieve a list of groups using a specified profile

Example request:

GET /api/v1/tenants/foo/services/comm_barring/profiles/test_profile/ HTTP/1.1
Host: example.com

{
   "sensitiveGroupNameContains": "Test"
}

Request JSON Object:

sensitiveGroupIdStarts (string) – (Optional) See sensitiveGroupIdStarts from Search criteria.
sensitiveGroupIdContains (string) – (Optional) See sensitiveGroupIdContains from Search criteria.
sensitiveGroupIdEquals (string) – (Optional) See sensitiveGroupIdEquals from Search criteria.
insensitiveGroupIdStarts (string) – (Optional) See insensitiveGroupIdStarts from Search criteria.
insensitiveGroupIdContains (string) – (Optional) See insensitiveGroupIdContains from Search criteria.
insensitiveGroupIdEquals (string) – (Optional) See insensitiveGroupIdEquals from Search criteria.
sensitiveGroupNameStarts (string) – (Optional) See sensitiveGroupNameStarts from Search criteria.
sensitiveGroupNameContains (string) – (Optional) See sensitiveGroupNameContains from Search criteria.
sensitiveGroupNameEquals (string) – (Optional) See sensitiveGroupNameEquals from Search criteria.
insensitiveGroupNameStarts (string) – (Optional) See insensitiveGroupNameStarts from Search criteria.
insensitiveGroupNameContains (string) – (Optional) See insensitiveGroupNameContains from Search criteria.
insensitiveGroupNameEquals (string) – (Optional) See insensitiveGroupNameEquals from Search criteria.
responseSizeLimit (integer) – (Optional) See responseSizeLimit from Search criteria.

Example response:

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

{
   "groups": [
      {
         "groupId": "foogroup",
         "groupName": "Foo Group"
      }
   ]
}

Response JSON Object:

groups (object) – a list of group object defined as Group basic attributes.

Status Codes:

200 OK – no error