Security
Manage your security options.
List allowed region or country codes.
OK
A collection of allowed region or country codes.
Error
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.
A collection of allowed region or country codes.
OK
No content
Error
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.
Use the filter query parameter to retrieve just a subset of a collection.
Use the search query parameter to restrict the results of a request to match a search criterion.
Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.
Use the skip query parameter to set the number of items to skip at the start of a collection.
0Use the top query parameter to specify the page size of the result set.
100OK
Total number of resource.
100Error
GET /api/disallowed_codes HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"count": 1,
"items": [
{
"id": null,
"number_prefix": null,
"description": null
}
]
}Create a block code.
The number prefix of blocked code.
An alphanumeric sequence beginning with an optional plus sign.
The description of blocked code.
Created
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwError
POST /api/disallowed_codes HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 41
{
"number_prefix": null,
"description": null
}{
"id": "xxxxxxxx"
}Retrieve details of blocked code by it's unique ID.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwOK
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe number prefix of blocked code.
An alphanumeric sequence beginning with an optional plus sign.
The description of blocked code.
Error
GET /api/disallowed_codes/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": null,
"number_prefix": null,
"description": null
}Update a blocked code by it's ID.
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwThe number prefix of blocked code.
An alphanumeric sequence beginning with an optional plus sign.
The description of blocked code.
OK
No content
Error
POST /api/disallowed_codes/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 41
{
"number_prefix": null,
"description": null
}No content
Destroy disallowed codes
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwNo Content
Invalid entry ID supplied
No content
User not found
POST /api/disallowed_codes/{id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Export a collection of disallowed codes to file.
OK
Error
GET /api/disallowed_codes/export HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
binaryUse the filter query parameter to retrieve just a subset of a collection.
Use the search query parameter to restrict the results of a request to match a search criterion.
Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.
Use the skip query parameter to set the number of items to skip at the start of a collection.
0Use the top query parameter to specify the page size of the result set.
100OK
Total number of resource.
100Error
GET /api/blacklisted_numbers HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"count": 1,
"items": [
{
"id": null,
"number": null,
"expire_at": null,
"created_at": null,
"updated_at": null,
"description": null
}
]
}An alphanumeric sequence beginning with an optional plus sign.
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
2017-07-21T17:32:28ZRemarks for the blacklisted number.
Created
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwError
POST /api/blacklisted_numbers HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 51
{
"number": null,
"expire_at": null,
"description": null
}{
"id": "xxxxxxxx"
}The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwOK
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwAn alphanumeric sequence beginning with an optional plus sign.
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
2017-07-21T17:32:28ZThe 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
2017-07-21T17:32:28ZThe 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
2017-07-21T17:32:28ZRemarks for the blacklisted number.
Error
GET /api/blacklisted_numbers/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": null,
"number": null,
"expire_at": null,
"created_at": null,
"updated_at": null,
"description": null
}The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwAn alphanumeric sequence beginning with an optional plus sign.
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
2017-07-21T17:32:28ZRemarks for the blacklisted number.
OK
No content
Error
POST /api/blacklisted_numbers/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 51
{
"number": null,
"expire_at": null,
"description": null
}No content
Destroy blacklisted number
The unique ID of the resource.
NzAwNTUxOTA5NzczMTQ4MTYwNo Content
Invalid entry ID supplied
No content
POST /api/blacklisted_numbers/{id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Export a collection of number blacklists to file.
OK
Error
GET /api/blacklisted_numbers/export HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
binaryLast updated
Was this helpful?