Number Address

Number Address can be assigned to numbers for number calls

Become a Reseller

Filter:

All
GET
POST
PUT
DELETE
Chargeable *

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

GET/voip/number-address

Gets all active number addresses on an account

Request Details

Response Details

Request Details

This command has no URL/Query String parameters

Response Details

200 Response

{
    "result" : [
        {
            "city" : "Guildford",
            "country_code" : "GB",
            "country_personal_id" : "N12345678",
            "created_on" : "2023-06-01",
            "forename" : "Pete",
            "is_default" : true,
            "name" : "Pete",
            "nickname" : "Work Address",
            "postcode" : "GU1 4UG",
            "premises" : "22",
            "state" : "Surrey",
            "street" : "Station Road",
            "title" : "Mr",
            "type_id" : 2,
            "updated_on" : "2023-06-01",
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
        }
    ],
    "status_code" : 200,
    "status_message" : "OK"
}

GET/voip/number-address/{uuid}

Gets the details for a specific number address 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 Address to be queried

Response Details

200 Response

{
    "result" : {
        "city" : "Guildford",
        "country_code" : "GB",
        "country_personal_id" : "N12345678",
        "created_on" : "2023-06-01",
        "forename" : "Pete",
        "is_default" : true,
        "name" : "Pete",
        "nickname" : "Work Address",
        "postcode" : "GU1 4UG",
        "premises" : "22",
        "state" : "Surrey",
        "street" : "Station Road",
        "title" : "Mr",
        "type_id" : 2,
        "updated_on" : "2023-06-01",
        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
    },
    "status_code" : 200,
    "status_message" : "OK"
}

404 Response

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

POST/voip/number-address

Creates a new Number Address
Back to top

Request Details

Response Details
Request Details

This command has no URL/Query String parameters

POST body
- Name
- Type
- Required
- city
  
  String
  
  True
  
  Village or area within a town, and the town
- country_code
  
  String
  
  True
  
  The Countries 2 letter ISO Code
- country_personal_id
  
  String
  
  True
  
  The customer's ID number applicable to the country, for example a Spanish CIF/NIF
- forename
  
  String
  
  True
  
  The first name of the person this address is for. Required for Individual addresses only
- is_default
  
  Boolean
  
  True
  
  Whether or not this is the default number address for this Reseller
- name
  
  String
  
  True
  
  The surname of the person this address is for if an Individual address. The Business Name if a Business address
- nickname
  
  String
  
  True
  
  The nickname for this number address
- postcode
  
  String
  
  True
  
  The addresses post or zip code
- premises
  
  String
  
  True
  
  The premises on a thoroughfare, e.g. a house number or name
- state
  
  String
  
  True
  
  The state or county
- street
  
  String
  
  True
  
  The street name
- title
  
  String
  
  True
  
  The title of the person this address is for. Required for Individual addresses only
- type_id
  
  int
  
  True
  
  What type of address is this, Use 1 for an individual, 2 for a business
JSON all-fields example:
{ "city" : "Guildford", "country_code" : "GB", "country_personal_id" : "N12345678", "forename" : "Pete", "is_default" : true, "name" : "Pete", "nickname" : "Work Address", "postcode" : "GU1 4UG", "premises" : "22", "state" : "Surrey", "street" : "Station Road", "title" : "Mr", "type_id" : 2 }
Response Details

201 Response
```
{
    "result" : {
        "city" : "Guildford",
        "country_code" : "GB",
        "country_personal_id" : "N12345678",
        "created_on" : "2023-06-01",
        "forename" : "Pete",
        "is_default" : true,
        "name" : "Pete",
        "nickname" : "Work Address",
        "postcode" : "GU1 4UG",
        "premises" : "22",
        "state" : "Surrey",
        "street" : "Station Road",
        "title" : "Mr",
        "type_id" : 2,
        "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-address/{uuid}

Updates the specified number address
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 Address to be updated
PUT body
- Name
- Type
- Required
- city
  
  String
  
  True
  
  Village or area within a town, and the town
- country_code
  
  String
  
  True
  
  The Countries 2 letter ISO Code
- country_personal_id
  
  String
  
  True
  
  The customer's ID number applicable to the country, for example a Spanish CIF/NIF
- forename
  
  String
  
  True
  
  The first name of the person this address is for. Required for Individual addresses only
- is_default
  
  Boolean
  
  True
  
  Whether or not this is the default number address for this Reseller
- name
  
  String
  
  True
  
  The surname of the person this address is for if an Individual address. The Business Name if a Business address
- nickname
  
  String
  
  True
  
  The nickname for this number address
- postcode
  
  String
  
  True
  
  The addresses post or zip code
- premises
  
  String
  
  True
  
  The premises on a thoroughfare, e.g. a house number or name
- state
  
  String
  
  True
  
  The state or county
- street
  
  String
  
  True
  
  The street name
- title
  
  String
  
  True
  
  The title of the person this address is for. Required for Individual addresses only
- type_id
  
  int
  
  True
  
  What type of address is this, Use 1 for an individual, 2 for a business
JSON all-fields example:
{ "city" : "Guildford", "country_code" : "GB", "country_personal_id" : "N12345678", "forename" : "Pete", "is_default" : true, "name" : "Pete", "nickname" : "Work Address", "postcode" : "GU1 4UG", "premises" : "22", "state" : "Surrey", "street" : "Station Road", "title" : "Mr", "type_id" : 2 }
Response Details

200 Response
```
{
    "result" : {
        "city" : "Guildford",
        "country_code" : "GB",
        "country_personal_id" : "N12345678",
        "created_on" : "2023-06-01",
        "forename" : "Pete",
        "is_default" : true,
        "name" : "Pete",
        "nickname" : "Work Address",
        "postcode" : "GU1 4UG",
        "premises" : "22",
        "state" : "Surrey",
        "street" : "Station Road",
        "title" : "Mr",
        "type_id" : 2,
        "updated_on" : "2023-06-01",
        "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"
}
```