Storefronts
- Invoices
- Credit Notes
Customer Management
VoIP Bundle (Subscriptions)
- VoIP Subscription Bundle
SIP Account Management
Audio Management
- Sounds
- Playlists
Phone Numbers & Call Routing
Phone Calls & CDR Data
VoIP Phone Short Code
- Short Codes
eFax Management
- Fax Messages
- Fax Authorized Senders
Voicemails & Mailboxes
Caller ID
- Caller IDs
- Caller ID Requests
SIP Trunks
- Trunk Authentication
- VoIP Trunks
Wallboard Statistics
VoIP Phone Provisioning
- Devices
Call Queueing
Phone Books
- Phone Book
- Phone Book Contact
VoIP Phone Speed Dial
- Speed Dials
Text (SMS) Messaging
- Text Message Campaign

API Access

Build custom apps using our JSON API

Configure API

Phone Numbers

Phone Numbers for incoming calls and outgoing caller ID

Become a Reseller

Filter:

All
GET
POST
PUT
DELETE
Chargeable *

* You will be charged every time this command is run.

GET/voip/number

Gets all phone numbers on an account

Request Details

Response Details

Request Details

This command has no URL/Query String parameters

Response Details

200 Response

{
    "result" : [
        {
            "call_flow" : "b6493b1a-b70c-428f-ad55-f9197fec8e01",
            "can_invite_anonymously" : true,
            "country_code" : "44",
            "created_on" : "2023-06-07",
            "emergency_address" : "b6493b1a-b70c-428f-ad55-f9197fec8e01",
            "name" : "Pete's Direct Dial",
            "number" : "505505",
            "number_address" : "b6493b1a-b70c-428f-ad55-f9197fec8e01",
            "out_of_hours" : "026fc253-d2d2-4c66-8275-235610de2bf6",
            "price_category" : 1,
            "required_address_type" : 1,
            "trunk" : "aa432e40-6c55-4f19-8407-adf9ca66b652",
            "updated_on" : "2023-06-07",
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
        }
    ],
    "status_code" : 200,
    "status_message" : "OK"
}

GET/voip/number/pending

Gets all pending activation phone numbers on an account

Request Details

Response Details

Request Details

This command has no URL/Query String parameters

Response Details

200 Response

{
    "result" : [
        {
            "call_flow" : "b6493b1a-b70c-428f-ad55-f9197fec8e01",
            "can_invite_anonymously" : true,
            "country_code" : "44",
            "created_on" : "2023-06-07",
            "emergency_address" : "b6493b1a-b70c-428f-ad55-f9197fec8e01",
            "name" : "Pete's Direct Dial",
            "number" : "505505",
            "number_address" : "b6493b1a-b70c-428f-ad55-f9197fec8e01",
            "out_of_hours" : "026fc253-d2d2-4c66-8275-235610de2bf6",
            "price_category" : 1,
            "required_address_type" : 1,
            "trunk" : "aa432e40-6c55-4f19-8407-adf9ca66b652",
            "updated_on" : "2023-06-07",
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
        }
    ],
    "status_code" : 200,
    "status_message" : "OK"
}

GET/voip/number/{uuid}

Gets the details for a specific number on an account

Request Details

Response Details

Request Details

URL and Query String Parameters

Name
Type
Required

- uuid
- String
- True
The UUID of the Number to be queried

Response Details

200 Response

{
    "result" : {
        "call_flow" : "b6493b1a-b70c-428f-ad55-f9197fec8e01",
        "can_invite_anonymously" : true,
        "country_code" : "44",
        "created_on" : "2023-06-07",
        "emergency_address" : "b6493b1a-b70c-428f-ad55-f9197fec8e01",
        "name" : "Pete's Direct Dial",
        "number" : "505505",
        "number_address" : "b6493b1a-b70c-428f-ad55-f9197fec8e01",
        "out_of_hours" : "026fc253-d2d2-4c66-8275-235610de2bf6",
        "price_category" : 1,
        "required_address_type" : 1,
        "trunk" : "aa432e40-6c55-4f19-8407-adf9ca66b652",
        "updated_on" : "2023-06-07",
        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
    },
    "status_code" : 200,
    "status_message" : "OK"
}

404 Response

{
    "result" : {},
    "status_code" : 404,
    "status_message" : "Not Found"
}

Chargeable *

POST/voip/number

Allocate a phone number to an account

Request Details

Response Details

Request Details

This command has no URL/Query String parameters

POST body

Name
Type
Required

- area_code
- String
- True
The area code of this Number
- call_flow
- String
- False
The UUID of the Call Flow assigned to this Number. A Number can have either a Call Flow or a Trunk
- can_invite_anonymously
- Boolean
- True
Whether or not this Number accepts invites from unknown sources
- country_code
- String
- True
The country dialling code of this Number
- emergency_address
- String
- False
The UUID of the Emergency Address assigned to this Number
- name
- String
- True
The name of this Number
- number
- String
- True
The local number
- number_address
- String
- False
The UUID of the address used to activate this number where required (EU numbers)
- out_of_hours
- String
- False
The UUID of the Out of Hours diary assigned to this Number
- price_category
- int
- True
The price category of this Number
- required_address_type
- int
- False
Whether this number needs a Number Address (1), Emergency Address (2) or both (3)
- trunk
- String
- False
The UUID of the Trunk assigned to this Number. A Number can have either a Call Flow or a Trunk

JSON all-fields example:

{
    "area_code" : "1947",
    "call_flow" : "b6493b1a-b70c-428f-ad55-f9197fec8e01",
    "can_invite_anonymously" : true,
    "country_code" : "44",
    "emergency_address" : "b6493b1a-b70c-428f-ad55-f9197fec8e01",
    "name" : "Pete's Direct Dial",
    "number" : "505505",
    "number_address" : "b6493b1a-b70c-428f-ad55-f9197fec8e01",
    "out_of_hours" : "026fc253-d2d2-4c66-8275-235610de2bf6",
    "price_category" : 1,
    "required_address_type" : 1,
    "trunk" : "aa432e40-6c55-4f19-8407-adf9ca66b652"
}

Response Details

201 Response

{
    "result" : {
        "call_flow" : "b6493b1a-b70c-428f-ad55-f9197fec8e01",
        "can_invite_anonymously" : true,
        "country_code" : "44",
        "created_on" : "2023-06-07",
        "emergency_address" : "b6493b1a-b70c-428f-ad55-f9197fec8e01",
        "name" : "Pete's Direct Dial",
        "number" : "505505",
        "number_address" : "b6493b1a-b70c-428f-ad55-f9197fec8e01",
        "out_of_hours" : "026fc253-d2d2-4c66-8275-235610de2bf6",
        "price_category" : 1,
        "required_address_type" : 1,
        "trunk" : "aa432e40-6c55-4f19-8407-adf9ca66b652",
        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
    },
    "status_code" : 201,
    "status_message" : "Created"
}

400 Response

{
    "result" : {},
    "status_code" : 400,
    "status_message" : "Bad Request"
}

PUT/voip/number/{uuid}

Update an allocated phone number

Request Details

Response Details

Request Details

URL and Query String Parameters

Name
Type
Required

- uuid
- String
- True
The UUID of the number to be updated

PUT body

Name
Type
Required

- area_code
- String
- True
The area code of this Number
- call_flow
- String
- False
The UUID of the Call Flow assigned to this Number. A Number can have either a Call Flow or a Trunk
- can_invite_anonymously
- Boolean
- True
Whether or not this Number accepts invites from unknown sources
- country_code
- String
- True
The country dialling code of this Number
- emergency_address
- String
- False
The UUID of the Emergency Address assigned to this Number
- name
- String
- True
The name of this Number
- number
- String
- True
The local number
- number_address
- String
- False
The UUID of the address used to activate this number where required (EU numbers)
- out_of_hours
- String
- False
The UUID of the Out of Hours diary assigned to this Number
- price_category
- int
- True
The price category of this Number
- required_address_type
- int
- False
Whether this number needs a Number Address (1), Emergency Address (2) or both (3)
- trunk
- String
- False
The UUID of the Trunk assigned to this Number. A Number can have either a Call Flow or a Trunk

JSON all-fields example:

{
    "call_flow" : "b6493b1a-b70c-428f-ad55-f9197fec8e01",
    "can_invite_anonymously" : true,
    "emergency_address" : "b6493b1a-b70c-428f-ad55-f9197fec8e01",
    "name" : "Pete's Direct Dial",
    "number_address" : "b6493b1a-b70c-428f-ad55-f9197fec8e01",
    "out_of_hours" : "026fc253-d2d2-4c66-8275-235610de2bf6",
    "required_address_type" : 1,
    "trunk" : "aa432e40-6c55-4f19-8407-adf9ca66b652"
}

Response Details

200 Response

{
    "result" : {
        "call_flow" : "b6493b1a-b70c-428f-ad55-f9197fec8e01",
        "can_invite_anonymously" : true,
        "country_code" : "44",
        "created_on" : "2023-06-07",
        "emergency_address" : "b6493b1a-b70c-428f-ad55-f9197fec8e01",
        "name" : "Pete's Direct Dial",
        "number" : "505505",
        "number_address" : "b6493b1a-b70c-428f-ad55-f9197fec8e01",
        "out_of_hours" : "026fc253-d2d2-4c66-8275-235610de2bf6",
        "price_category" : 1,
        "required_address_type" : 1,
        "trunk" : "aa432e40-6c55-4f19-8407-adf9ca66b652",
        "updated_on" : "2023-06-07",
        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
    },
    "status_code" : 200,
    "status_message" : "OK"
}

400 Response

{
    "result" : {},
    "status_code" : 400,
    "status_message" : "Bad Request"
}

404 Response

{
    "result" : {},
    "status_code" : 404,
    "status_message" : "Not Found"
}

DELETE/voip/number/{uuid}?policy={policy}

Delete an allocated number from an account
Back to top

Request Details

Response Details
Request Details

URL and Query String Parameters
- Name
- Type
- Required
- uuid
  
  String
  
  True
  
  The UUID of the number to be deleted
Response Details

204 Response
```
{
    "result" : {},
    "status_code" : 204,
    "status_message" : "No Content"
}
```
404 Response
```
{
    "result" : {},
    "status_code" : 404,
    "status_message" : "Not Found"
}
```

POST/voip/number/{uuid}/label

Adds a label to the specified number

Request Details

Response Details

Request Details

URL and Query String Parameters

Name
Type
Required

- uuid
- String
- True
The UUID of the number to be updated

POST body

Name
Type
Required

- label_name
- String
- True
The label to be applied

JSON all-fields example:

{
    "label_name" : "london-office"
}

Response Details

200 Response

{
    "result" : {
        "call_flow" : "b6493b1a-b70c-428f-ad55-f9197fec8e01",
        "can_invite_anonymously" : true,
        "country_code" : "44",
        "created_on" : "2023-06-07",
        "emergency_address" : "b6493b1a-b70c-428f-ad55-f9197fec8e01",
        "name" : "Pete's Direct Dial",
        "number" : "505505",
        "number_address" : "b6493b1a-b70c-428f-ad55-f9197fec8e01",
        "out_of_hours" : "026fc253-d2d2-4c66-8275-235610de2bf6",
        "price_category" : 1,
        "required_address_type" : 1,
        "trunk" : "aa432e40-6c55-4f19-8407-adf9ca66b652",
        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
    },
    "status_code" : 200,
    "status_message" : "OK"
}

400 Response

{
    "result" : {},
    "status_code" : 400,
    "status_message" : "Bad Request"
}

404 Response

{
    "result" : {},
    "status_code" : 404,
    "status_message" : "Not Found"
}

409 Response

{
    "result" : {},
    "status_code" : 409,
    "status_message" : "Conflict"
}

DELETE/voip/number/{uuid}/label/{label}

Deletes the specified label from the specified number
Back to top

Request Details

Response Details
Request Details

URL and Query String Parameters
- Name
- Type
- Required
- uuid
  
  String
  
  True
  
  The UUID of the number to be updated
- label
  
  String
  
  True
  
  The label to be deleted
Response Details

204 Response
```
{
    "result" : {},
    "status_code" : 204,
    "status_message" : "No Content"
}
```
400 Response
```
{
    "result" : {},
    "status_code" : 400,
    "status_message" : "Bad Request"
}
```
404 Response
```
{
    "result" : {},
    "status_code" : 404,
    "status_message" : "Not Found"
}
```