Phone Book

A Phone Book is the high level container user to store contacts, Phone Books can be manually added or synchronised from CRM intergrations

Become a Reseller

Filter:

All
GET
POST
PUT
DELETE
Chargeable *

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

GET/voip/phone-book

Get's all of the active Phone Books on the account

Request Details

Response Details

Request Details

This command has no URL/Query String parameters

Response Details

200 Response

{
    "result" : [
        {
            "created_on" : "2023-06-07",
            "has_integration_link" : true,
            "linked_integrations" : "",
            "name" : "My Phone Book",
            "password" : "o9qkbr4cpv",
            "total_contacts" : 100,
            "updated_on" : "2023-06-07",
            "username" : "mkaeaetq2b25",
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
        }
    ],
    "status_code" : 200,
    "status_message" : "OK"
}

GET/voip/phone-book/{uuid}

Get's the specific phone book

Request Details

Response Details

Request Details

URL and Query String Parameters

Name
Type
Required

- uuid
- String
- True
The UUID of the Phone Book to query

Response Details

200 Response

{
    "result" : {
        "created_on" : "2023-06-07",
        "has_integration_link" : true,
        "linked_integrations" : "",
        "name" : "My Phone Book",
        "password" : "o9qkbr4cpv",
        "total_contacts" : 100,
        "updated_on" : "2023-06-07",
        "username" : "mkaeaetq2b25",
        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
    },
    "status_code" : 200,
    "status_message" : "OK"
}

400 Response

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

403 Response

{
    "result" : {},
    "status_code" : 403,
    "status_message" : "Internal Server Error"
}

404 Response

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

POST/voip/phone-book

Creates a new Phone Book, you must have a suitable VoIP plan to use this command
Back to top

Request Details

Response Details
Request Details

This command has no URL/Query String parameters

POST body
- Name
- Type
- Required
- has_integration_link
  
  boolean
  
  True
  
  Indicates if this Phone Book was created by, or is linked to an integration
- linked_integrations
  
  Array of String
  
  True
  
  List of integrations that this phonebook is linked to
- name
  
  String
  
  True
  
  The nickname for this Phone Book
- password
  
  String
  
  True
  
  HTTP password to access the Phone Book
- total_contacts
  
  int
  
  True
  
  Total number of contacts linked to this Phone Book
- username
  
  String
  
  True
  
  HTTP Username to access this Phone Book
JSON all-fields example:
{ "has_integration_link" : true, "linked_integrations" : "", "name" : "My Phone Book", "password" : "o9qkbr4cpv", "total_contacts" : 100, "username" : "mkaeaetq2b25" }
Response Details

201 Response
```
{
    "result" : {
        "created_on" : "2023-06-07",
        "has_integration_link" : true,
        "linked_integrations" : "",
        "name" : "My Phone Book",
        "password" : "o9qkbr4cpv",
        "total_contacts" : 100,
        "username" : "mkaeaetq2b25",
        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
    },
    "status_code" : 201,
    "status_message" : "Created"
}
```
400 Response
```
{
    "result" : {},
    "status_code" : 400,
    "status_message" : "Bad Request"
}
```
PUT/voip/phone-book/{uuid}

Update the provided Phone Book, this command should only be used to change the username/password or nickname, it does not allow contacts to be changed
Back to top

Request Details

Response Details
Request Details

URL and Query String Parameters
- Name
- Type
- Required
- uuid
  
  String
  
  True
  
  The UUID of the Phone Book to be updated
PUT body
- Name
- Type
- Required
- has_integration_link
  
  boolean
  
  True
  
  Indicates if this Phone Book was created by, or is linked to an integration
- linked_integrations
  
  Array of String
  
  True
  
  List of integrations that this phonebook is linked to
- name
  
  String
  
  True
  
  The nickname for this Phone Book
- password
  
  String
  
  True
  
  HTTP password to access the Phone Book
- total_contacts
  
  int
  
  True
  
  Total number of contacts linked to this Phone Book
- username
  
  String
  
  True
  
  HTTP Username to access this Phone Book
JSON all-fields example:
{ "has_integration_link" : true, "linked_integrations" : "", "name" : "My Phone Book", "password" : "o9qkbr4cpv", "total_contacts" : 100, "username" : "mkaeaetq2b25" }
Response Details

200 Response
```
{
    "result" : {
        "created_on" : "2023-06-07",
        "has_integration_link" : true,
        "linked_integrations" : "",
        "name" : "My Phone Book",
        "password" : "o9qkbr4cpv",
        "total_contacts" : 100,
        "updated_on" : "2023-06-07",
        "username" : "mkaeaetq2b25",
        "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/phone-book/{uuid}

Delete the specified Phone Book, a Phone Book can't be deleted if it is being used by an active Integration, you must delete the Integration first
Back to top

Request Details

Response Details
Request Details

URL and Query String Parameters
- Name
- Type
- Required
- uuid
  
  String
  
  True
  
  The UUID of the Phone Book 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"
}
```
409 Response
```
{
    "result" : {},
    "status_code" : 409,
    "status_message" : "Conflict"
}
```