Gets all of the active Contacts for the provided Phone Book UUID

search

Which page of contacts to return, defaults to 1 if not provided

page

How many contacts to return, defaults to 10 if not provided, must be between 1 and 1000 if provided

limit

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

sort

The UUID of the Phone Book to fetch the contacts for

uuid

The UUID of the Phone Book containing this contact

phone-book-uuid

first_name

last_name

company_name

details

Creates a new contact or contacts in the provided Phone Book

The UUID of the Phone Book to create the contact in

Update the specified contact in the specified phone book

The UUID of the Phone Book to update the contact in

Delete the specified contact from the specified phone book

The UUID of the contact to be deleted. If "ALL", removes all contacts from phonebook

The UUID of the Phone Book to delete the contact from

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

Phone Book Contact

Manage audio files and Music on Hold playlists

Audio Management

A Sound represents an audio file used by the system for prompts, greetings and hold music

Sounds

A Playlist is a collection of Sounds that can be used as hold music.

Playlists

Create Queue groups, request stats such as people in queue, average wait time etc.

Call Queueing

Request the stats for a particular call queue

Queue Stats

Queue Notices define the messages that a caller hears while waiting in the queue

Queue Notices

Queue Groups define the members who will answer a queue, and the order in which they will ring

Queue Groups

View caller identification and make requests for alternative caller ID's

Caller ID

Caller IDs are the numbers an account is authorized to display as on outbound calls

Caller IDs

Caller ID Requests track the progress of requests to use numbers not on an account as Caller IDs

Caller ID Requests

Manage your customers, and their hosted VoIP calling plans

Customer Management

Manage and view balances for your Sub Resellers

Reseller Account Balances

A Reseller Address is a geographical address used for billing and delivery for a reseller

Reseller Addresses

Create and Manage Sub Resellers of your account

Sub Resellers

A Reseller User provides access credentials to use the API or Web Portal for a specific reseller

Reseller Users

A Document is a file that can be used for verification of required information for certain actions on an account

Documents

Create and Manage Storefronts on your account

Storefronts

Details about an Integration linked to the account

Integrations

A Bank Account object can be used to request withdrawal of reseller revenue

Bank Accounts

A revenue withdrawal will request a transfer of funds from your account balance to the provided bank account

Revenue Withdrawal

Gets the details for a specific discount on a customer account

Discount

Paginated list of external users on an integration

Integrations Users response

Set authorised senders for eFaxes and manage fax to email

eFax Management

Commands to manage fax messages received on an account

Fax Messages

Commands to manage who is allowed to send faxes via the fax to email system

Fax Authorized Senders

Phone Books store contacts and their phone numbers/email addresses

Phone Books

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

Phone Book

View VoIP call costs, call recordings and CDR data

Phone Calls & CDR Data

Call Packs allow call minutes to be included at a fixed cost

Phone Call Packs

Commands to manage the call recording retention period for an account

Call Recording Retention

Commands to get the cost of making calls from this account

Phone Call Costs

Commands to get the history of calls made on an account

Phone Call History

Call Restrictions allow restrictions to be created for outbound VoIP calls

Phone Call Restrictions

Create outbound calls, there are two ways to use this command, the first is to specify a SIP User or Hunt Group UUID, this method will cause the target users phone to ring.  When the user answers the call, the system will then place an outbound call to the destination number.  The second method is to provide a call route UUID or JSON data, this will trigger an outbound call to the destination number, on answering the call the number will be placed into the provided call route

Outbound Calls

A Call Statistics Report configures a scheduled report that will be emailed to recipients at the sspecified time

Call Statistics Reporting

A Missed Call Notification is a configuration for sending email alerts when the specified User/Number misses a call

Missed Call Notifications

Call Statistics show the number of calls attempted and answered for a set of users or groups

Call Statistics

Create outbound calls, there are two ways to use this command, the first is to specify a SIP User or Hunt Group UUID,
this method will cause the target users phone to ring.  When the user answers the call, the system will then place an
outbound call to the destination number.  The second method is to provide a call route UUID or JSON data, this will
trigger an outbound call to the destination number, on answering the call the number will be placed into the provided call route


Set call routing and call forwarding for your phone numbers. Buy new phone numbers and schedule operating hours

Phone Numbers & Call Routing

Call Flows define the route to be followed when a call is incoming to a number assigned with the call flow

Call Flows, Call Route

Number Transfers track the progress of requests to transfer a number from another provider

Number Transfers

Time Diaries are used to modify routing based on the time of day

Time Diaries

Phone Numbers for incoming calls and outgoing caller ID

Phone Numbers

Number Search

Emergency Address can be assigned to numbers for emergency calls

Emergency Address

Number Address can be assigned to numbers for number calls

Number Address

Manage documents for number transfer requests

Number Transfer Documents

Message Flows define the route to be followed when a message is sent to a number assigned with the message flow

Message Flows

Create and manage SIP accounts and SIP Hunt Groups

SIP Account Management

A Hunt Group is a collection of users who can be called at the same time using the groups extension number, or placed into call routes

Hunt Groups

A SIP User is a set of credentials that can be used to a configure a device to make and receive calls

SIP Users

Manage the invitation of SIP users to the mobile and desktop apps

App Configuration

Department

Add SIP trunks and manage existing to connect our Hosted VoIP solution to any platform

SIP Trunks

A Trunk Authentication is a method of authorizing calls into the system. This can either be by IP, or username/password

Trunk Authentication

Trunks are used to send calls to and from an external PBX

VoIP Trunks

See your Storefronts, Invoice and Credit Notes

Details of orders placed by the customer on the storefront

Invoices

Credit Notes

Send and receive SMS messages from your numbers

Text (SMS) Messaging

Create and manage SMS campaigns for your numbers

Text Message Campaign

Define how mailboxes are accessed and configured

Voicemails & Mailboxes

Mailboxes are used in call routes to allow callers to leave a voicemail message

Mailboxes

Mailbox Menus allow Mailboxes to be accessed using an extension number

Mailbox Menus

Email Recipients receive email notifications when a voicemail is left on their Mailbox

Mailbox Email Recipients

Mailbox Messages are Voicemails that have been left on a Mailbox

Mailbox Messages

Create and manage VoIP Bundle (subscriptions) for customers

VoIP Bundle (Subscriptions)

A VoIP Bundle is a collection of SIP Users and Phone numbers that represent the customers monthly subscription. A VoIP Bundle must be created before any SIP users or numbers can be created

VoIP Subscription Bundle

VoIP Phone Provisioning

A Device is a hardware phone that is linked to an account and can be remotely configured

Devices

Manage short codes that work with your VoIP phone devices

VoIP Phone Short Code

A Short Code is a code that can be dialled to modify the behaviour of a call

Short Codes

VoIP Phone Speed Dial

A Speed Dial is a code that can used to quickly dial numbers that are called on a regular basis

Phone Book Contact

Sign up to our channel newsletter

Solutions

Integrations

Resources

About Us