Security

Manage your security options.

List allowed region or country codes

get

List allowed region or country codes.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

application/json

itemsstring[]Optional

A collection of allowed region or country codes.

4XX

Error

get/allowed_country_codes

GET /api/allowed_country_codes HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    "xxx",
    "yyy"
  ]
}

Update allowed region or country codes.

post

Update allowed region or country codes.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

itemsstring[]Optional

A collection of allowed region or country codes.

Responses

200

No content

4XX

Error

post/allowed_country_codes

POST /api/allowed_country_codes HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "items": [
    "xxx",
    "yyy"
  ]
}

No content

List block codes

get

List block codes.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

application/json

countinteger · int64Optional

Total number of resource.

Example: 100

4XX

Error

get/disallowed_codes

GET /api/disallowed_codes HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 1,
  "items": [
    {
      "id": "xxxxxx",
      "number_prefix": "example",
      "description": ""
    }
  ]
}

Create a block code

post

Create a block code.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

idstringOptionalExample: NzAwNTUxOTA5NzczMTQ4MTYw

4XX

Error

post/disallowed_codes

POST /api/disallowed_codes HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "number_prefix": "example",
  "description": ""
}

{
  "id": "xxxxxxxx"
}

Retrieve blocked code

get

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The unique ID of the blocked code.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

application/json

idstringOptionalExample: 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.

4XX

Error

get/disallowed_codes/{id}

GET /api/disallowed_codes/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "xxxxxx",
  "number_prefix": "example",
  "description": ""
}

Update a blocked code

post

Update a blocked code by it's ID.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The unique ID of the code.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

idstringOptionalExample: 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

No content

4XX

Error

post/disallowed_codes/{id}

POST /api/disallowed_codes/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "number_prefix": "example",
  "description": ""
}

No content

Destroy disallowed codes

post

Destroy disallowed codes

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The unique ID of the code.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

No content

400

Invalid entry ID supplied

404

User not found

post/disallowed_codes/{id}/destroy

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

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

application/octet-stream

Responsestring · binary

4XX

Error

get/disallowed_codes/export

GET /api/disallowed_codes/export HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary

List blacklisted numbers

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

application/json

countinteger · int64Optional

Total number of resource.

Example: 100

4XX

Error

get/blacklisted_numbers

GET /api/blacklisted_numbers HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 1,
  "items": [
    {
      "id": "xxxxxx",
      "number": "000000",
      "expire_at": "2020-01-01T00:00:00Z",
      "created_at": "2020-01-01T00:00:00Z",
      "updated_at": "2020-01-01T00:00:00Z",
      "description": ""
    }
  ]
}

Create new blacklisted number

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

numberstring · min: 1 · max: 64Required

An alphanumeric sequence beginning with an optional plus sign.

expire_atstring · 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

idstringOptionalExample: NzAwNTUxOTA5NzczMTQ4MTYw

4XX

Error

post/blacklisted_numbers

POST /api/blacklisted_numbers HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 71

{
  "number": "000000",
  "expire_at": "2020-01-01T00:00:00Z",
  "description": ""
}

{
  "id": "xxxxxxxx"
}

Show blacklisted number

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

application/json

idstringOptionalExample: NzAwNTUxOTA5NzczMTQ4MTYw

numberstring · min: 1 · max: 64Optional

An alphanumeric sequence beginning with an optional plus sign.

expire_atstring · 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

created_atstring · 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

updated_atstring · 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.

4XX

Error

get/blacklisted_numbers/{id}

GET /api/blacklisted_numbers/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "xxxxxx",
  "number": "000000",
  "expire_at": "2020-01-01T00:00:00Z",
  "created_at": "2020-01-01T00:00:00Z",
  "updated_at": "2020-01-01T00:00:00Z",
  "description": ""
}

Update blacklisted number

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw

Body

numberstring · min: 1 · max: 64Optional

An alphanumeric sequence beginning with an optional plus sign.

expire_atstring · 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

No content

4XX

Error

post/blacklisted_numbers/{id}

POST /api/blacklisted_numbers/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 71

{
  "number": "000000",
  "expire_at": "2020-01-01T00:00:00Z",
  "description": ""
}

No content

Destroy blacklisted number

post

Destroy blacklisted number

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

No content

400

Invalid entry ID supplied

post/blacklisted_numbers/{id}/destroy

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

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

application/octet-stream

Responsestring · binary

4XX

Error

get/blacklisted_numbers/export

GET /api/blacklisted_numbers/export HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary

PreviousShared Voicemails NextFeature Access Codes

Last updated 20 days ago

Was this helpful?