Phone Book Contact

A Phone Book Contact represents the contact details for a single individual or company, Contacts can store multiple labelled numbers and email addresses

Become a Reseller

Filter:

All
GET
POST
PUT
DELETE
Chargeable *

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

GET/voip/phone-book/{phone-book-uuid}

Gets all of the active Contacts for the provided Phone Book UUID
Back to top

Request Details

Response Details
Request Details

URL and Query String Parameters
- Name
- Type
- Required
- search
  
  String
  
  False
  
  A string to search the contacts for
- page
  
  String
  
  False
  
  Which page of contacts to return, defaults to 1 if not provided
- limit
  
  String
  
  False
  
  How many contacts to return, defaults to 10 if not provided, must be between 1 and 100 if provided
- sort
  
  String
  
  False
  
  Which field to sort the contacts by? Valid options are 'id', 'first_name', 'last_name', 'company_name', when 'id' is provided the contacts are ordered by the date added to the Phone Book
- uuid
  
  String
  
  True
  
  The UUID of the Phone Book to fetch the contacts for
Response Details

200 Response
```
{
    "result" : [
        {}
    ],
    "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"
}
```
GET/voip/phone-book/{phone-book-uuid}/contact/{uuid}

Gets a specific Phone Book Contact
Back to top

Request Details

Response Details
Request Details

URL and Query String Parameters
- Name
- Type
- Required
- phone-book-uuid
  
  String
  
  True
  
  The UUID of the Phone Book containing this contact
- uuid
  
  String
  
  True
  
  The UUID of the Contact to be queried
Response Details

200 Response
```
{
    "result" : {},
    "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"
}
```
POST/voip/phone-book/{phone-book-uuid}/contact

Creates a new contact in the provided Phone Book
Back to top

Request Details

Response Details
Request Details

URL and Query String Parameters
- Name
- Type
- Required
- phone-book-uuid
  
  String
  
  True
  
  The UUID of the Phone Book to create the contact in
POST body
- Name
- Type
- Required
JSON all-fields example:
{}
Response Details

201 Response
```
{
    "result" : {},
    "status_code" : 201,
    "status_message" : "Created"
}
```
400 Response
```
{
    "result" : {},
    "status_code" : 400,
    "status_message" : "Bad Request"
}
```
404 Response
```
{
    "result" : {},
    "status_code" : 404,
    "status_message" : "Not Found"
}
```
PUT/voip/phone-book/{phone-book-uuid}/contact/{uuid}

Update the specified contact in the specified phone book
Back to top

Request Details

Response Details
Request Details

URL and Query String Parameters
- Name
- Type
- Required
- uuid
  
  String
  
  True
  
  The UUID of the contact to be updated
- phone-book-uuid
  
  String
  
  True
  
  The UUID of the Phone Book to update the contact in
PUT body
- Name
- Type
- Required
JSON all-fields example:
{}
Response Details

200 Response
```
{
    "result" : {},
    "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/{phone-book-uuid}/contact/{uuid}

Delete the specified contact from the specified phone book
Back to top

Request Details

Response Details
Request Details

URL and Query String Parameters
- Name
- Type
- Required
- uuid
  
  String
  
  True
  
  The UUID of the contact to be delete
- phone-book-uuid
  
  String
  
  True
  
  The UUID of the Phone Book to delete the contact from
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"
}
```
504 Response
```
{
    "result" : {},
    "status_code" : 504,
    "status_message" : "Internal Server Error"
}
```