Channel Zones API

Channel Zones API

Get list of channel zones

List of channel zones with their countries

SecuritybearerAuth
Request
query Parameters
page[number]
integer >= 1
Default: 1

The page number to load

page[size]
integer [ 1 .. 250 ]
Default: 20

The size of the page

Responses
200

A list of channel zones

Response Schema: application/json
Array of objects (Channel zone object)
object (PaginationMeta)
get/channel_zones
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "channels": 7,
      • "countries": [
        • "BE",
        • "EL",
        • "LT",
        • "PT",
        • "BG",
        • "ES",
        • "LU",
        • "RO",
        • "CZ",
        • "FR",
        • "HU",
        • "SI",
        • "DK",
        • "HR",
        • "MT",
        • "SK",
        • "DE",
        • "IT",
        • "NL",
        • "FI",
        • "EE",
        • "CY",
        • "AT",
        • "SE",
        • "IE",
        • "LV",
        • "PL"
        ],
      • "created_at": "2019-01-23T18:10:02.574Z",
      • "id": "1653e6a1-4bfd-4857-97c6-6a51e1c34477",
      • "name": "Euro channel zone",
      • "record_type": "channel_zone",
      • "updated_at": "2019-01-23T18:10:02.574Z"
      }
    ],
  • "meta": {
    • "page_number": 2,
    • "page_size": 25,
    • "total_pages": 3,
    • "total_results": 55
    }
}
Get a specific channel zone
Get a specific channel zone


SecuritybearerAuth 
Request 
path Parameters
channel_zone_id
required
string
Channel zone identifier


 
Responses 
200
Requested channel zone


Response Schema: application/json
channels
required
integer <int64> 
 
countries
required
Array of strings
List of countries (in ISO 3166-2, capitalized) members of the billing channel zone


 
created_at
string
ISO 8601 formatted date of when the channel zone was created


 
id
required
string
 
name
required
string
 
record_type
required
string
 Value: "channel_zone"  
updated_at
string
ISO 8601 formatted date of when the channel zone was updated


 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
get/channel_zones/{channel_zone_id}
Request samples 
Response samples 
application/json
{
  • "channels": 7,
  • "countries": [
    • "BE",
    • "EL",
    • "LT",
    • "PT",
    • "BG",
    • "ES",
    • "LU",
    • "RO",
    • "CZ",
    • "FR",
    • "HU",
    • "SI",
    • "DK",
    • "HR",
    • "MT",
    • "SK",
    • "DE",
    • "IT",
    • "NL",
    • "FI",
    • "EE",
    • "CY",
    • "AT",
    • "SE",
    • "IE",
    • "LV",
    • "PL"
    ],
  • "created_at": "2019-01-23T18:10:02.574Z",
  • "id": "1653e6a1-4bfd-4857-97c6-6a51e1c34477",
  • "name": "Euro channel zone",
  • "record_type": "channel_zone",
  • "updated_at": "2019-01-23T18:10:02.574Z"
}
Patch a channel zone
Change the amount of reserved channels at a given channel zone


SecuritybearerAuth 
Request 
path Parameters
channel_zone_id
required
string
Channel zone identifier


 
Request Body schema: application/json
required
Quantity of reserved channels


channels
integer <int64> 
 
Responses 
200
Successfuly patched channel zone


Response Schema: application/json
channels
required
integer <int64> 
 
countries
required
Array of strings
List of countries (in ISO 3166-2, capitalized) members of the billing channel zone


 
created_at
string
ISO 8601 formatted date of when the channel zone was created


 
id
required
string
 
name
required
string
 
record_type
required
string
 Value: "channel_zone"  
updated_at
string
ISO 8601 formatted date of when the channel zone was updated


 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
patch/channel_zones/{channel_zone_id}
Request samples 
application/json
{
  • "channels": 0
}
Response samples 
application/json
{
  • "channels": 7,
  • "countries": [
    • "BE",
    • "EL",
    • "LT",
    • "PT",
    • "BG",
    • "ES",
    • "LU",
    • "RO",
    • "CZ",
    • "FR",
    • "HU",
    • "SI",
    • "DK",
    • "HR",
    • "MT",
    • "SK",
    • "DE",
    • "IT",
    • "NL",
    • "FI",
    • "EE",
    • "CY",
    • "AT",
    • "SE",
    • "IE",
    • "LV",
    • "PL"
    ],
  • "created_at": "2019-01-23T18:10:02.574Z",
  • "id": "1653e6a1-4bfd-4857-97c6-6a51e1c34477",
  • "name": "Euro channel zone",
  • "record_type": "channel_zone",
  • "updated_at": "2019-01-23T18:10:02.574Z"
}
Get the list of phone numbers assigned to a channel zone
Retrieve the assigned phone numbers in a channel zone. Phone numbers assigned to a channel zone can receive concurrent calls up to the quantity reserved in that channel zone. Additional concurrent calls are rejected with a busy signal.


SecuritybearerAuth 
Request 
path Parameters
channel_zone_id
required
string
Channel zone identifier


 
query Parameters
page[number]
integer  >= 1 
 Default:  1
The page number to load


 
page[size]
integer  [ 1 .. 250 ] 
 Default:  20
The size of the page


 
Responses 
200
A list of phone numbers


Response Schema: application/json
Array of objects (Phone Number object) 
 
object (PaginationMeta) 
 
get/channel_zones/{channel_zone_id}/channel_zone_phone_numbers
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "channel_zone_id": "1653e6a1-4bfd-4857-97c6-6a51e1c34477",
      • "created_at": "2019-01-23T18:10:02.574Z",
      • "id": "3da3c749-bb7d-4ad6-acae-ca0d415ae08b",
      • "phone_number": "+15554441234",
      • "record_type": "channel_zone_phone_number"
      }
    ],
  • "meta": {
    • "page_number": 2,
    • "page_size": 25,
    • "total_pages": 3,
    • "total_results": 55
    }
}
Assign a phone number to a channel zone
You should own the phone number being assigned to the channel zone. Remember that you should reserve channels in this channel zone, otherwise you won't be able to receive incoming calls.


SecuritybearerAuth 
Request 
path Parameters
channel_zone_id
required
string
Channel zone identifier


 
Request Body schema: application/json
required
Phone number to assign to the channel zone. The phone number should be in E.164 format.


phone_number
required
string <+E.164> 
 
Responses 
200
A new inserted phone number


Response Schema: application/json
channel_zone_id
required
string
 
created_at
string
ISO 8601 formatted date of when the phone number was created


 
id
string
 
phone_number
required
string <+E.164> 
 
record_type
required
string
 Value: "channel_zone_phone_number"  
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
post/channel_zones/{channel_zone_id}/channel_zone_phone_numbers
Request samples 
application/json
{
  • "phone_number": "+15554441234"
}
Response samples 
application/json
{
  • "channel_zone_id": "1653e6a1-4bfd-4857-97c6-6a51e1c34477",
  • "created_at": "2019-01-23T18:10:02.574Z",
  • "id": "3da3c749-bb7d-4ad6-acae-ca0d415ae08b",
  • "phone_number": "+15554441234",
  • "record_type": "channel_zone_phone_number"
}
Unassign a phone number from a channel zone
SecuritybearerAuth 
Request 
path Parameters
channel_zone_id
required
string
Channel zone identifier


 
phone_number
required
string <+E.164> 
The phone number to be looked up


 
 Example:  +15554441234
Responses 
200
The phone number is successfully deleted


default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
delete/channel_zones/{channel_zone_id}/channel_zone_phone_numbers/{phone_number}
Request samples 
Response samples 
application/json
{
  • "errors": [
    • {
      • "code": "string",
      • "detail": "string",
      • "meta": { },
      • "source": {
        • "parameter": "string",
        • "pointer": "/json/pointer"
        },
      • "title": "string"
      }
    ]
}