Security

Manage your security options.

List allowed region or country codes

get

List allowed region or country codes.

Authorizations
Responses
200
OK
application/json
get
GET /api/allowed_country_codes HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    "text"
  ]
}

Update allowed region or country codes.

post

Update allowed region or country codes.

Authorizations
Body
itemsstring[]Optional

A collection of allowed region or country codes.

Responses
200
OK
post
POST /api/allowed_country_codes HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "items": [
    "text"
  ]
}
No content

List block codes

get

List block codes.

Authorizations
Query parameters
filterstringOptional

Use the filter query parameter to retrieve just a subset of a collection.

searchstringOptional

Use the search query parameter to restrict the results of a request to match a search criterion.

orderbystringOptional

Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.

skipinteger · int32Optional

Use the skip query parameter to set the number of items to skip at the start of a collection.

Default: 0
topinteger · int32 · min: 1 · max: 100Optional

Use the top query parameter to specify the page size of the result set.

Default: 100
Responses
200
OK
application/json
get
GET /api/disallowed_codes HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 100,
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "number_prefix": "text",
      "description": "text"
    }
  ]
}

Create a block code

post

Create a block code.

Authorizations
Body
number_prefixstring · min: 1 · max: 16Optional

The number prefix of blocked code.
An alphanumeric sequence beginning with an optional plus sign.

descriptionstring · max: 1024Optional

The description of blocked code.

Responses
201
Created
application/json
post
POST /api/disallowed_codes HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "number_prefix": "text",
  "description": "text"
}
{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Retrieve blocked code

get

Retrieve details of blocked code by it's unique ID.

Authorizations
Path parameters
idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200
OK
application/json
get
GET /api/disallowed_codes/{id} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "number_prefix": "text",
  "description": "text"
}

Update a blocked code

post

Update a blocked code by it's ID.

Authorizations
Path parameters
idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Body
idall ofOptional

The unique ID of blocked code.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
number_prefixstring · min: 1 · max: 16Optional

The number prefix of blocked code.
An alphanumeric sequence beginning with an optional plus sign.

descriptionstring · max: 1024Optional

The description of blocked code.

Responses
200
OK
post
POST /api/disallowed_codes/{id} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "number_prefix": "text",
  "description": "text"
}
No content

Destroy disallowed codes

post

Destroy disallowed codes

Authorizations
Path parameters
idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
204
No Content
post
POST /api/disallowed_codes/{id}/destroy HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Export disallowed codes

get

Export a collection of disallowed codes to file.

Authorizations
Responses
200
OK
application/octet-stream
Responsestring · binary
get
GET /api/disallowed_codes/export HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary

List blacklisted numbers

get
Authorizations
Query parameters
filterstringOptional

Use the filter query parameter to retrieve just a subset of a collection.

searchstringOptional

Use the search query parameter to restrict the results of a request to match a search criterion.

orderbystringOptional

Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.

skipinteger · int32Optional

Use the skip query parameter to set the number of items to skip at the start of a collection.

Default: 0
topinteger · int32 · min: 1 · max: 100Optional

Use the top query parameter to specify the page size of the result set.

Default: 100
Responses
200
OK
application/json
get
GET /api/blacklisted_numbers HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 100,
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "number": "text",
      "expire_at": "2017-07-21T17:32:28Z",
      "created_at": "2017-07-21T17:32:28Z",
      "updated_at": "2017-07-21T17:32:28Z",
      "description": "text"
    }
  ]
}

Create new blacklisted number

post
Authorizations
Body
numberstring · min: 1 · max: 64Required

An alphanumeric sequence beginning with an optional plus sign.

expire_atall ofOptional

Blacklisted number's expire time.

string · date_timeOptional

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Example: 2017-07-21T17:32:28Z
descriptionstring · max: 255Optional

Remarks for the blacklisted number.

Responses
201
Created
application/json
post
POST /api/blacklisted_numbers HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "number": "text",
  "expire_at": "2017-07-21T17:32:28Z",
  "description": "text"
}
{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Show blacklisted number

get
Authorizations
Path parameters
idall ofRequired

The unique ID of this blacklisted number.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200
OK
application/json
get
GET /api/blacklisted_numbers/{id} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "number": "text",
  "expire_at": "2017-07-21T17:32:28Z",
  "created_at": "2017-07-21T17:32:28Z",
  "updated_at": "2017-07-21T17:32:28Z",
  "description": "text"
}

Update blacklisted number

post
Authorizations
Path parameters
idall ofRequired

The unique ID of this blacklisted number.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Body
numberstring · min: 1 · max: 64Optional

An alphanumeric sequence beginning with an optional plus sign.

expire_atall ofOptional

Blacklisted number's expire time.

string · date_timeOptional

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Example: 2017-07-21T17:32:28Z
descriptionstring · max: 255Optional

Remarks for the blacklisted number.

Responses
200
OK
post
POST /api/blacklisted_numbers/{id} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "number": "text",
  "expire_at": "2017-07-21T17:32:28Z",
  "description": "text"
}
No content

Destroy blacklisted number

post

Destroy blacklisted number

Authorizations
Path parameters
idall ofRequired

The unique ID of this blacklisted number.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
204
No Content
post
POST /api/blacklisted_numbers/{id}/destroy HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Export number blacklists

get

Export a collection of number blacklists to file.

Authorizations
Responses
200
OK
application/octet-stream
Responsestring · binary
get
GET /api/blacklisted_numbers/export HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary
PreviousShared VoicemailsNextFeature Access Codes