VoiceMeUp - Developer API Guide

Understanding HTTP Requests

The Developer API is an information exchange service that you can interact with by doing simple HTTP Requests. Every command that you wish to send to either submit information or retreive

Initial query parameters

The Developer API requires initial query parameter for any of the request types.

Parameter	Type [?]	Requirement	Description
client_account_id	digits[8]	Required (Obsolete in v1.1)	Value must be a valid `client_account_id` of 8 digits.
username	string	Optionally Required (v1.1)	Value must be a valid `username`.
client_user_id	digits[4-8]	Optionally Required (v1.1)	Value must be a valid `client_user_id` of 4 to 8 digits.
auth_token	hex[32]	Required	Value must be a valid `auth_token` of 32 hexadecimal characters (lowercase).
request_type	string	Required (Obsolete in v1.1)	Value must be a valid `request_type`. List of available request types is available here.
output_format	string	Optional (Obsolete in v1.1)	Value must be a valid `output_format`. List of available output formats is available here. (default XML)
language	string	Optional	Value must be one of the following : "en" or "fr". (default en)
currency	string	Optional	Value must be one of the following : "CAD", "USD" or "EUR". (default CAD)

Additional parameters types

Each request types can accept different optional or required parameters. Those parameters will be validated according to the request type made.

Here is a list of definition of the different parameters types interpreted by the Developer API:

digits: Characters from 0 to 9 inclusively.
hex: Characters from 0 to 9, and from A to F inclusively.
date: A valid date goes as follow: YYYY-MM-DD, example: 2007-04-16
string: Any ascii characters.
alphanum: Any letters or numbers, including hyphen '-' and underscores '_'.
integer: Any value contaning only numeric characters.
enum: A string value within offered choices.

HTTP Query syntax

As mentioned earlier, the requests are made using plain HTTP queries. Building a query requires to Encode URL because some values might contain characters that could conflict with the query string syntax.

v1.0 (Deprecated)

https://developer.voicemeup.com/xml_engine/xml_engine.php?request_type=get_request_types&client_account_id=80012345&auth_token=1A2B3C4D5E6 ...

v1.1

https://clients.voicemeup.com/api/v1.1/json/get_request_types?client_user_id=123456&auth_token=1A2B3C4D5E6 ...

https://client.beevox.com/api/v1.1/json/get_request_types?client_user_id=123456&auth_token=1A2B3C4D5E6 ...

Will also work with your whitelabel custom domain

Response format

Responses are only formatted in two formats:

XML Extensible Markup Language (Default)
JSON JavaScript Object Notation

Show Sample XML response

Show Sample JSON response

{
  "request_details": {
    "request_datetime": "2017-12-13 13:44:57",
    "request_arguments": {
      "client_account_id": "80012345",
      "auth_token": "4d695127fbeedd39d423b5f9c47eabcd",
      "request_type": "get_recordings",
      "call_hash": "11ac028b9acccfe4914ca6a792b6abcd",
      "output_format": "json"
    }
  },
  "response_details": {
    "server_name": "ini-web-php53x-02.getinfinity.com",
    "response_delay": "0.1798369884491",
    "response_status": "success",
    "response_messages": ""
  }
}
  ...

Webhook

A webhook is used to notify an external system of an event. The URL given will be called when the configured event is triggered. Each webhook's return is unique, please consult the method documentation for more info.

Some VoiceMeUp services have been configured to support this feature. Here are the methods that support it :

update_did
update_peer
voicemail_broadcast
update_sms_profile

Limitation

To avoid abuse, the Developer API has a hourly limit. Some request types have a specific limit as shown below, any request not listed below falls in the shared pool. Once the limit is reached, we will send you an email about the abuse. If the limit is exceeded too greatly, we will refuse subsequent API requests for the next 60 minutes with the error code "requests_hard_limit_exceeded".

Request Type	Limit per hour
delete_faxes	1500
delete_recordings	1500
delete_voicemails	1500
dispatch_call	900
voicemail_broadcast	900
queue_fax	600
queue_sms	600
shared_pool (all other request types combined)	1200

Routing types

internal, emergency_call, directory_assistance, international_termination, international_origination, local_termination, local_origination, tollfree_origination, tollfree_termination, paypercall_origination, total

Message types

sms_inbound, sms_outbound, mms_inbound, mms_outbound, total

Storage types

recordings_size, voicemails_size, medias_size, faxes_size, mms_size, export_size, pbx3cxmedia_size, pbx3cxbackup_size, total

Request Types

Get request types

Get all available request types

Request Type: get_request_types

Show Sample XML response

Get call history

One of the most important and practical feature is the call history which allows you to get call details as soon as it is available in our databases.

If you wish to query the Developer API on a regular basis in order to always have an updated version, it is possible to request calls that has been logged after the last request you made by using the `call_hash`parameter.

Request Type: get_calls

Parameter	Type [?]	Requirement	Description
date_from	date	Optionally Required	If set, date_to must also be set. Value must be a valid date formatted as "YYYY-MM-DD".
date_to	date	Optionally Required	If set, date_from must also be set. Value must be a valid date formatted as "YYYY-MM-DD".
latest_hours	int	Optionally Required	Must be an int above 0.
call_hash	string	Optionally Required	Value must be a 32 characters alphanumeric call_hash referencing the last call previously returned by your last request made with `get_calls`.
unique_id	string	Deprecated	Deprecated, use `call_hash` instead.
direction	string	Optional	Value must be one of the following: "inbound" or "outbound" (default is NULL)
routing_type	string	Optional	Value must be one of the following: "undefined","internal","emergency_call","directory_assistance","international_termination","international_origination","local_termination","local_origination","tollfree_origination","tollfree_termination" More than one value can be used separated by comma (default is NULL)
disposition	string	Optional	Value must be one of the following: "answered","busy","failed","no_answer","cancelled","denied","invalid","unknown" More than one value can be used separated by comma (default is NULL)
result_limit	integer	Optional	Value must be between 1 and 1000 (default is 25 with date_to and date_from set, 1 with call_hash set)
result_offset	integer	Optional	Value must be a valid number (default is NULL)
extras	string	Optional	Value must be one of the following: "yes", "no". Will return the following extra fields : failure_code, sip_response_code, account_usage_inbound account_usage_outbound, account_call_limit, subaccount_usage_inbound subaccount_usage_outbound, subaccount_call_limit, subaccount_channel_inbound, subaccount_channel_outbound",channel_usage_inbound channel_usage_outbound, channel_usage_excess (default is no)
metadata	string	Optional	Value must be one of the following: "yes", "only", "all" or "no" (default is no)
routing_details	string	Optional	Value must be one of the following: "yes" or "no" (default is no). This will return more details about the source and destination.
client_channel_id	integer	Optional	Value must be a valid `client_channel_id`. (default is NULL)
client_subaccount_id	integer	Optional	Value must be a valid `client_subaccount_id`. (default is NULL)

Show Sample XML response

<?xml version="1.0" encoding="utf-8"?>
<response>
 
  ...
 
  <calls>
    <call_details call_hash="e7d970de310b197b2d7498c92d58f72a">
        <call_hash>e7d970de310b197b2d7498c92d58f72a</call_hash>
        <originator_uuid>54c7361a-7ee3-4f95-8088-cdb301536bd5</originator_uuid>
        <datetime_start>2014-06-06 10:34:57</datetime_start>
        <datetime_end>2014-06-06 10:35:53</datetime_end>
        <date>2014-06-06</date>
        <time>10:34:57</time>
        <direction>outbound</direction>
        <source>14504540000</source>
        <destination>15146851000</destination>
        <client_peer_id>1000</client_peer_id>
        <country_id>38</country_id>
        <state_id>11</state_id>
        <exchange_id>514685</exchange_id>
        <ratecenter_id>171610</ratecenter_id>
        <duration>56</duration>
        <callerid_name>14504541000</callerid_name>
        <callerid_number>14504541000</callerid_number>
        <bindings/>
        <status>answered</status><!-- deprecated, use disposition instead -->
        <disposition>answered</disposition>
        <normalized>15146851000</normalized>
        <exchange_id>514685</exchange_id>
        <billsec>46</billsec><!-- deprecated, use billed_duration instead -->
        <billed_duration>46</billed_duration>
        <billed_amount>0.00</billed_amount>
        <routing_type>local_termination</routing_type>
        <billing_override>below_channel_limit</billing_override>
        <current_rate>0.00</current_rate>
        <client_channel_id>0</client_channel_id>
        <client_subaccount_id>18</client_subaccount_id>
 
        <!-- Additional field when using 'metadata' -->
        <metadata/>
 
        <!-- Additional fields using 'routing_details' -->
        <source_country_id>38</source_country_id>
        <source_state_id>11</source_state_id>
        <source_ratecenter_id>174200</source_ratecenter_id>
        <source_country_name>Canada</source_country_name>
        <source_state_name>Quebec</source_state_name>
        <source_district>Saint-Remi</source_district>
        <destination_country_id>38</destination_country_id>
        <destination_state_id>11</destination_state_id>
        <destination_ratecenter_id>172380</destination_ratecenter_id>
        <destination_country_name>Canada</destination_country_name>
        <destination_state_name>Quebec</destination_state_name>
        <destination_district>Roxboro</destination_district>
 
        <!-- Additional fields using 'extras' -->
        <failure_code>NORMAL_CLEARING</failure_code>
        <sip_response_code>200</sip_response_code>
        <account_usage_inbound>0</account_usage_inbound>
        <account_usage_outbound>0</account_usage_outbound>
        <account_call_limit>0</account_call_limit>
        <subaccount_usage_inbound>0</subaccount_usage_inbound>
        <subaccount_usage_outbound>0</subaccount_usage_outbound>
        <subaccount_call_limit>0</subaccount_call_limit>
        <channel_usage_inbound>0</channel_usage_inbound>
        <channel_usage_outbound>0</channel_usage_outbound>
        <channel_usage_excess>0</channel_usage_excess>
 
    </call_details>
  </calls>
</response>

Get call statistics

Gather statistical information about calls for given period.

Request Type: get_calls_stats

Parameter	Type [?]	Requirement	Description
date_from	date	Optional	Value must be a valid date formatted as "YYYY-MM-DD". Max date range between `date_to` and `date_from` is 12 months. (default is today)
date_to	date	Optional	Value must be a valid date formatted as "YYYY-MM-DD". Max date range between `date_to` and `date_from` is 12 months. (default is today)
client_subaccount_ids	enum	Optional	List of all the `client_subaccount_id` wanted separated by a comma. Max 10 `client_subaccount_id`. (default is main_account and whole_account (main_account + subaccounts))
routing_types	enum	Optional	List of all the client routing types wanted separated by a comma. (default is NULL)

Show Sample XML response with no subaccount_ids specified.

<?xml version="1.0" encoding="utf-8"?>
<response>
 
    ...
 
    <calls_stats>
        <account>
            <whole_account>
                <local_termination>
                    <routing_type>internal</routing_type>
                    <total_calls>12345</total_calls>
                    <total_duration>44437</total_duration>
                    <billed_amount>0.00</billed_amount>
                    <billed_duration>42318</billed_duration>
                    <asr>58.852660</asr>
                    <fsr>5.10300</fsr>
                    <acd>204.3957</acd>
                </local_termination>
                ...
                <total>
                    <routing_type>total</routing_type>
                    <total_calls>54321</total_calls>
                    <total_duration>95539</total_duration>
                    <billed_amount>169.3</billed_amount>
                    <billed_duration>91307</billed_duration>
                    <asr>88.473696</asr>
                    <fsr>5.10300</fsr>
                    <acd>264.1441</acd>
                    <peak_concurrent_inbound>6</peak_concurrent_inbound>
                    <peak_concurrent_outbound>4</peak_concurrent_outbound>
                    <peak_concurrent_combined>6</peak_concurrent_combined>
                </total>
            </whole_account>
            <main_account>
                <local_termination>
                    <routing_type>internal</routing_type>
                    <total_calls>12345</total_calls>
                    <total_duration>44425</total_duration>
                    <billed_amount>0.00</billed_amount>
                    <billed_duration>42317</billed_duration>
                    <asr>72.555752</asr>
                    <fsr>5.10300</fsr>
                    <acd>207.0657</acd>
                </local_termination>
                ...
                <total>
                    <routing_type>total</routing_type>
                    <total_calls>54321</total_calls>
                    <total_duration>85864</total_duration>
                    <billed_amount>159.55</billed_amount>
                    <billed_duration>81987</billed_duration>
                    <asr>85.260800</asr>
                    <fsr>5.10300</fsr>
                    <acd>250.6725</acd>
                    <peak_concurrent_inbound>6</peak_concurrent_inbound>
                    <peak_concurrent_outbound>4</peak_concurrent_outbound>
                    <peak_concurrent_combined>6</peak_concurrent_combined>
                </total>
            </main_account>
        </account>
    </calls_stats>
</response>

Show Sample XML response with subaccount_ids specified.

Get recorded calls

If you have enabled recording on one of your Peer, on one of you DID or if you've made calls using the "call_dispatch" request, your calls will generate a new entry in the call recording database and you will be able to retrieve it using this request type.

Note: The "Call record" feature is only supported through the Developer API for now.

Request Type: get_recordings

Parameter	Type [?]	Requirement	Description
call_recording_id	integer	Optional	Value must be a valid `call_recording_id`. (default is NULL)
recording_hash	alphanum [36]	Optional	NEW : Value must be a 36 characters alphanumeric with dashes unique id referencing to a recording previously returned by a request made with `get_recordings`. (default is NULL)
call_hash	alphanum [32]	Optional	Value must be a 32 characters alphanumeric unique id referencing to a call previously returned by a request made with `get_calls`. (default is NULL)
date_from	date	Optional	Value must be a valid date formatted as "YYYY-MM-DD".
date_to	date	Optional	If set, date_from must also be set. Value must be a valid date formatted as "YYYY-MM-DD".
latest_hours	int	Optional	Must be an int above 0.
status	enum	Optional	Value must be one (or more, comma separated) of the following: "unverified", "verified" or "deleted" (default is NULL)
result_limit	integer	Optional	Value must be between 1 and 1000 (default is 25 with date_to and date_from setted, 1 with call_hash setted)
result_offset	integer	Optional	Value must be a valid number (default is NULL)

Show Sample XML response

Delete recorded calls

You can delete recordings assigned to your account either by specifying a valid `call_recording_id `or `call_hash`. Optionally you can omit those and specify a valid `date` and delete all of your recordings before that date.

Request Type: delete_recordings

Request Type Added on June 3rd 2010

Parameter	Type [?]	Requirement	Description
call_recording_id	integer	Optionally required	Value must be a valid `call_recording_id`. Comma separated values are accepted. (default is NULL)
call_hash	alphanum [32]	Optionally required	Value must be a 32 characters alphanumeric unique id referencing to a call previously returned by a request made with `get_calls`. Comma separated values are accepted. (default is NULL)
date	date	Optionally required	If set and no other parameter is sent, will delete all recordings prior to that date. (default is NULL)
comments	string	Optional

Show Sample XML response

Get voicemails

If you have enabled a mailbox on one of you DID, you will be able to retrieve the messages by using this request type.

Request Type: get_voicemails

Request Type Added on March 8th 2012

Parameter	Type [?]	Requirement	Description
call_voicemail_id	integer	Optional	Value must be a valid `call_voicemail_id`. (default is NULL)
client_subaccount_id	integer	Optional	Value must be a valid `client_subaccount_id`. (default is NULL)
voicemail_hash	alphanum [32]	Optional	Value must be a 32 characters alphanumeric with dashes unique id referencing to a voicemail previously returned by a request made with `get_voicemails`. (default is NULL)
result_limit	integer	Optional	Value must be between 1 and 1000 (default is 25)
result_offset	integer	Optional	Value must be a valid number (default is NULL)
date_from	date	Optional	Value must be a valid date formatted as "YYYY-MM-DD".
date_to	date	Optional	Value must be a valid date formatted as "YYYY-MM-DD".

Show Sample XML response

Delete voicemails

You can delete voicemails assigned to your account either by specifying a valid `call_voicemail_id` or `voicemail_hash` . Optionally you can omit those and specify a valid `date` and delete all of your voicemails before that date.

Request Type: delete_voicemails

Request Type Added on March 8th 2012

Parameter	Type [?]	Requirement	Description
call_voicemail_id	integer	Optionally required	Value must be a valid `call_voicemail_id`. Comma separated values are accepted. (default is NULL)
voicemail_hash	alphanum [32]	Optional	Value must be a 32 characters alphanumeric with dashes unique id referencing to a voicemail previously returned by a request made with `get_voicemails`. Comma separated values are accepted. (default is NULL)
date	date	Optionally required	If set and no other parameter is sent, will delete all voicemails prior to that date. (default is NULL)
comments	string	Optional

Show Sample XML response

Get faxes

If you have a virtual fax profile, your faxes will generate a new entry in the faxes database and you will be able to retrieve it using this request type.

Request Type: get_faxes

Request Type Added on June 3rd 2010

Parameter	Type [?]	Requirement	Description
call_fax_id	integer	Optional	Value must be a valid `call_fax_id`. (default is NULL)
client_fax_profile_id	integer	Optional	Value must be a valid `client_fax_profile_id`. (default is NULL)
client_subaccount_id	integer	Optional	Value must be a valid `client_subaccount_id`. (default is NULL)
date_from	date	Optionally Required	If set, date_to must also be set. Value must be a valid date formatted as "YYYY-MM-DD".
date_to	date	Optionally Required	If set, date_from must also be set. Value must be a valid date formatted as "YYYY-MM-DD".
call_hash	alphanum [32]	Optional	Value must be a 32 characters alphanumeric unique id referencing to a call previously returned by a request made with `get_calls`. (default is NULL)
status	enum	Optional	Value must be one (or more, comma separated) of the following: "enabled", "deleted", "purged" (default is NULL)
transmission_status	enum	Optional	Value must be one (or more, comma separated) of the following: "pending", "processing", "completed", "failed", "cancelled", "paused" (default is NULL)

Show Sample XML response

Delete stored faxes

You can delete your faxes assigned to your account either by specifying a valid `call_fax_id ` or `call_hash`. Optionally you can omit those and specify a valid `date` and delete all of your faxes for that date.

Request Type: delete_faxes

Request Type Added on June 3rd 2010

Parameter	Type [?]	Requirement	Description
call_fax_id	integer	Optionally required	Value must be a valid `call_fax_id`. Comma separated values are accepted. (default is NULL)
call_hash	alphanum [32]	Optionally required	Value must be a 32 characters alphanumeric unique id referencing to a call previously returned by a request made with `get_calls`. Comma separated values are accepted. (default is NULL)
date	date	Optionally required	If set and no other parameter is sent, will delete all faxes for that date. (default is NULL)
comments	string	Optional

Show Sample XML response

Get Fax profiles

If you wish to get details of a fax profiles, you simply have to pass the `client_fax_profile_id`. If no additional parameter is specified, the complete list of fax profiles will be returned.

Request Type: get_fax_profiles

Parameter	Type [?]	Requirement	Description
client_fax_profile_id	integer	Optional	Value must be a valid `client_fax_profile_id`. (default is NULL)
client_subaccount_id	integer	Optional	Value must be a valid `client_subaccount_id`. (default is NULL)

Show Sample XML response

Update Fax Profile

Allows you to create or simply update a fax profile.

Request Type: update_fax_profile

Parameter	Type [?]	Requirement	Description
mode	string	Optional	Value must be "update" or "create". (default is update)
client_fax_profile_id	integer	Optionally required	If mode is "update", value must be a valid `client_fax_profile_id`
client_subaccount_id	integer	Optional	Value must be a valid `client_subaccount_id`. (default is 0)
friendly_name	string	Required	Value must be alphanumeric string from 2 to 32 characters.
local_ident	string	Required	Value must be alphanumeric string from 2 to 20 characters.
fax_header	string	Required	Value must be alphanumeric string from 2 to 20 characters.
callerid_name	string	Required	Value must be alphanumeric string from 3 to 15 characters.
callerid_number	digits [10]	Required	Value must be a valid phone number of 10 digits.
contact_name	string	Optional	Value must be alphanumeric string from 4 to 60 characters.
email	string	Required	Value must be a valid email address.
language	string	Required	Value must be one of the following : "en" or "fr".
allowed_senders	string	Required	List of all the `allowed_senders` wanted separated by a comma.
retry_limit	integer	Optional	The number of times we should retry sending. (default is 2)
page_format	string	Required	Value must be one of the following : "letter", "legal", "a4"
resolution	string	Required	Value must be one of the following : "standard", "fine"," super_fine", "ultra_fine", "color"
callback_url	string	Optionally required	Must be a valid Webhook. Can contain GET arguments. Details will be sent as JSON in the POST body. Required if option "enable_callback" is selected.
backup_url	string	Optional	Must be a valid Webhook. Can contain GET arguments. Details will be sent as JSON in the POST body. Will be called if `callback_url` does not respond.
options	Array	Optional	Value must be one or more of the following : "inbound_completed_notification", "inbound_failed_notification", "outbound_completed_notification", "outbound_failed_notification", "enable_cover_page", "enable_inbound_send_attachment", "enable_outbound_send_attachment", "enable_callback". (default is NULL)
status	string	Required	Value must be one of the following: "enabled" or "disabled"
comments	string	Optional

Delete fax profile

Delete a fax profile from your account.

Request Type: delete_fax_profile

Parameter	Type [?]	Requirement	Description
client_fax_profile_id	integer	Required	Value must be a valid `client_fax_profile_id`.

Queue Fax

You can send a fax with this request type. It is important to note that this is a POST request.

Request Type: queue_fax

Parameter	Type [?]	Requirement	Description
destination_number	string	Required	Value must be a valid phone number.
client_fax_profile_id	integer	Required	Value must be a valid `client_fax_profile_id`.
attachments	file	Required	Value must be valid files.
unique_id	string	Optional	Value must be alphanumeric string. It will be used as a seed with `client_fax_profile_id`. Must be unique. (Default is time)
name_from	string	Optional	Value must be alphanumeric string. (Default is fax profile contact name)
email_from	string	Optional	Value must be alphanumeric string. (Default is fax profile contact email)
page_format	string	Optional	Value must be one of the following : 'letter', 'legal', 'a4'. (Default is fax profile page_format)
resolution	string	Optional	Value must be one of the following : 'standard', 'fine', 'super_fine', 'ultra_fine'. (Default is fax profile resolution)
retry_limit	string	Optional	Value must between 1 and 9. (Default is fax profile retry limit)
datetime_scheduled	datetime	Optional	Value must be a valid datetime (YYYY-MM-DD HH:II:SS).

Show Sample XML response

Get DIDs details

You can get the details and settings of DIDs assigned to your account by either specifying the `client_did_id` or the `phone_number`. If you do not provide either value, the details for all DIDs will be returned.

Request Type: get_dids

Parameter	Type [?]	Requirement	Description
client_did_id	integer	Optional	Value must be a valid `client_did_id`. (default is NULL)
phone_number	integer	Optional	Value must be a valid phone number of 10 digits. (default is NULL)
npa	digits [3]	Optional	Value must be a 3 digits NPA area code. (only for local) (default is NULL)
nxx	digits [3]	Optional	Value must be a 3 digits NXX prefix. (only for local) (default is NULL)
ratecenter_id	integer	Optional	Value must be a valid `ratecenter_id`. (default is NULL)
district	string	Optional	Value must be a valid `district`. (default is NULL)
state_id	integer	Optional	Value must be a valid `state_id`. (default is NULL)
country_id	integer	Optional	Value must be a valid `country_id`. (default is NULL)
options	enum	Optional	Only entries matching all the given options will be returned. Value must be one (or more, comma separated) of the following: 'enable_ivr','enable_disa','enable_director','enable_fax','enable_peer', 'enable_forwarding','enable_uri','enable_voicemail','enable_recording','ondemand_recording', 'announce_monitor','announce_caller','enable_filtering','enable_conference','enable_disa', 'enable_uri','force_ring_signal','discard_redirect','confirm_required','enable_sms', 'enable_sms_email_notify','enable_sms_forwarding','enable_sms_callback','enable_sms_callback_retry', 'enable_queue' (default is NULL)
client_peer_id	integer	Optional	Value must be a valid `client_peer_id`. Since `peer_to_rings` may contain multiple `client_peer_id`, if the given value matches one, the entry will be returned (default is NULL)
client_mailbox_id	integer	Optional	Value must be a valid `client_mailbox_id`.
announce_media_file_id	integer	Optional	Value must be a valid client_media_file_id.
bridge_uri	string	Optional	Must be a valid string uri of 240 or less characters.
pickup_group_ids	string	Optional	Must be a valid string og pickup group ids of 64 or less characters.
client_conference_profile_id	integer	Optional	Must be a valid `client_conference_profile_id`.
client_fax_profile_id	integer	Optional	Value must be a valid `client_fax_profile_id`.
dnis_rewrite	string	Optional	Must be 30 or less characters.
confirm_media_file_id	integer	Optional	Value must be a valid client_media_file_id.
playback_media_file_id	integer	Optional	Value must be a valid playback_media_file_id.
sms_autoreply_message	string	Optional	Must be a valid string of 160 or less characters.
recording_notify_recipient_name	string	Optional	Must be a valid string of 255 or less characters.
peer_failover_causes	string	Optional	Must be a valid string of 240 or less characters.
recording_notify_recipient_email	string	Optional	Must be a valid string of 255 or less characters.
type	string	Optional	Value must be one of the following: 'local', 'tollfree', 'paypercall', 'international', 'inum', 'shadow', 'interexchange'
usage_type	string	Required	Value must be one of the following: 'default', 'paging', 'parking', 'conference', 'disa', 'uri'
sms_dnis_rewrite	string	Optional	Must be 30 or less characters.
sip_response	digits [3]	Optional	Value must be a 3 digits sip response (default is NULL)
exclude_e411_list	integer	Optional	Value must be 0 or 1
exclude_e911_list	integer	Optional	Value must be 0 or 1
t38_support	bool	Optional	Value must be one of the following: "1" or "0" This parameter indicates if your did(s) support t38/fax.
sms_support	bool	Optional	Value must be one of the following: "1" or "0" This parameter indicates if your did(s) support SMS.
mms_support	bool	Optional	Value must be one of the following: "1" or "0" This parameter indicates if your did(s) support MMS.
enable_voicemail	bool	Optional	Value must be one of the following: "1" or "0" This parameter indicates if your did(s) enable voicemail.
ondemand_recording	bool	Optional	Value must be one of the following: "1" or "0" This parameter indicates if your did(s) enable ondemand recording.
enable_fax	bool	Optional	Value must be one of the following: "1" or "0" This parameter indicates if your did(s) enable fax.
client_channel_id	integer	Optional	Value must be a valid `client_channel_id`. (default is NULL)
client_subaccount_id	integer	Optional	Value must be a valid `client_subaccount_id`. (default is NULL)
status	enum	Optional	Value must be one of the following: "enabled", "deleted", "disabled" (default is NULL)

Show Sample XML response

            <?xml version="1.0" encoding="utf-8"?>
            <response>
 
                ...
 
                <dids>
                    <did_details>
                        <client_did_id>1234</client_did_id>
                        <npa>514</npa>
                        <nxx>312</nxx>
                        <ratecenter_id>123456</ratecenter_id>
                        <phone_number>5143127030</phone_number>
                        <phone_number_e164>15143127030</phone_number_e164>
                        <friendly_name>5143127030</friendly_name>
                        <enable_peer>1</enable_peer> <!-- Deprecated; Use 'options' instead. -->
                        <peers_to_ring>1234,1235</peers_to_ring>
                        <peer_timeout>25</peer_timeout>
                        <peer_contact_mode>sequential</peer_contact_mode>
                        <client_queue_ids>1001,1002,1004</client_queue_ids>
                        <enable_forwarding>1</enable_forwarding> <!-- Deprecated; Use 'options' instead. -->
                        <enable_fax>0</enable_fax>
                        <ondemand_recording>0</ondemand_recording>
                        <forward_number>5143127031</forward_number>
                        <forward_timeout>disabled</forward_timeout>
                        <enable_voicemail>1</enable_voicemail> <!-- Deprecated; Use 'options' instead. -->
                        <client_ivr_profile_id>0</client_ivr_profile_id>
                        <client_director_profile_id>0</client_director_profile_id>
                        <client_conference_profile_id>1037</client_conference_profile_id>
                        <destination_mailbox>1234</destination_mailbox>
                        <client_fax_profile_id>12</client_fax_profile_id>
                        <exclude_e411_list>1</exclude_e411_list>
                        <exclude_e911_list>1</exclude_e911_list>
                        <announce_media_file_id>0</announce_media_file_id>
                        <client_mailbox_id>1234</client_mailbox_id>
                        <enable_dnis>0</enable_dnis>
                        <enable_auth>0</enable_auth>
                        <enable_recording>1</enable_recording>  <!-- Deprecated; Use 'options' instead. -->
                        <status>enabled</status>
                        <send_dtmf></send_dtmf>
                        <dnis_rewrite></dnis_rewrite>
                        <client_filter_ids><client_filter_ids />
                        <district>Montreal<district />
                        <state_id>11<state_id />
                        <country_id>38<country_id />
                        <sms_autoreply_message></sms_autoreply_message>
                        <callerid_name_rewrite><callerid_name_rewrite/>
                        <confirm_media_file_id>0</confirm_media_file_id>
                        <callerid_number_rewrite><callerid_number_rewrite />
                        <client_sms_profile_id>1234<client_sms_profile_id />
                        <sms_notify_email>support@voicemeup.com</sms_notify_email>
                        <sms_forward_number>5143127030</sms_forward_number>
                        <sms_callback_url>http://www.voicemeup.com</sms_callback_url>
                        <bridge_uri>2724881@vancouver6.voip.ms:5060</bridge_uri>
                        <options>enable_peer,enable_voicemail,enable_forwarding,enable_recording</options>
                        <voice_language></voice_language>
                        <sms_supported>0</sms_supported>
                        <mms_supported>0</sms_supported>
                        <fax_supported>1</sms_supported>
                        <ported_in>1</ported_in>
                        <special_attributes>pattern_double_digits_pair</special_attributes>
                        <type>local</type>
                        <usage_type>default</usage_type>
                        <client_channel_id>0</client_channel_id>
                        <client_subaccount_id>0</client_subaccount_id>
                        <notify_callback_url>https://www.google.com</notify_callback_url>
                        <notify_callback_triggers>on_create,on_hangup</notify_callback_triggers>
                        <simultaneous_calls_limit>0</simultaneous_calls_limit>
                        <comments><comments/>
                        <datetime_created>2012-11-09 14:08:04</datetime_created>
                        <datetime_updated>2010-07-14 10:35:54</datetime_updated>
                        <metadata>
                        <raw_metadata><![CDATA[a:3:{s:13:"tout_le_monde";s:8:"en parle";s:6:"piment";s:4:"fort";s:5:"super";s:3:"man";} ]]></raw_metadata>
                        <metadata_attributes attribute_count="3">
                            <tout_le_monde><![CDATA[en parle ]]></tout_le_monde>
                            <piment><![CDATA[fort ]]></piment>
                            <super><![CDATA[man ]]></super>
                        </metadata_attributes>
                        </metadata>
                    </did_details>
                </dids>
            </response>

Update DID

It is possible to update the DIDs configuration with this request type.

Note: Not all the option for DIDs are available through the API. Please request any new feature to our support department.

Request Type: update_did

Parameter	Type [?]	Requirement	Description
preserve_missing_data	boolean	Optional	This will allow you to modify only the provided fields when updating an entry (default is FALSE)
client_did_id	integer	Optionally required	Value must be a valid `client_did_id`
phone_number	digits [10]	Optionally required	Value must be a valid DID number.
friendly_name	string	Optional	Value must be alphanumeric string from 2 to 32 characters.
forward_number	integer	Optional	Value must be a valid phone number. (default is NULL)
forward_timeout	string	Optional	Value must be one of the following : "disabled", "2", "5", "10", "15", "20", "25", "30", "35", "40", "45", "50" or "55". (default is NULL)
send_dtmf	string	Optional	Must be valid DTMF tones (0-9,a,b,c,d,w and W).
voice_language	string	Optional	Value must valid one of the following: "en", "fr". Default is account preferred language.
client_mailbox_id	integer	Optional	Value must be a valid `client_mailbox_id`. (default is NULL)
client_ivr_profile_id	integer	Optional	Value must be a valid `client_ivr_profile_id`. (default is NULL)
client_fax_profile_id	integer	Optional	Value must be a valid `client_fax_profile_id`. (default is NULL)
client_director_profile_id	integer	Optional	Value must be a valid `client_director_profile_id`. (default is NULL)
client_sms_profile_id	integer	Optional	Value must be a valid `client_sms_profile_id`. (default is NULL)
client_peer_ids	enum	Optional	Value(s) must be valid client_peer_id(s) (comma separated). (default is NULL)
peer_timeout	string	Optional	Value must be one of the following : "disabled", "2", "5", "10", "15", "20", "25", "30", "35", "40", "45", "50" or "55". (default is NULL)
peer_contact_mode	string	Optional	Value must be one of the following : "sequential", "simultaneous" or "round_robin". (default is NULL)
client_queue_ids	enum	Optional	Value(s) must be valid client_queue_id(s) (comma separated). (default is NULL)
bridge_uri	string	Optional	Must be a valid SIP uri. (default is null)
client_conference_profile_id	string	Optional	Must be a valid `client_conference_profile_id`. (default is null)
ondemand_recording	integer	Optional	1 = enabled, 0 = disabled (default is 0)
dnis_rewrite	digits [10]	Optional	Value must be a valid DID number.
client_filter_ids	Array	Optional	Value must be one or more valid client_filter_id. (default is NULL)
announce_media_file_id	string	Optionally required	Value must be a valid client_media_file_id. (default is 0) Required if `announce_caller` is set, will play the message to the callee before connecting the call.
monitor_media_file_id	string	Optional	Value must be a valid client_media_file_id. (default is 0) If specified alongside the `announce_monitor` option, will override the default "This call may be recorded [...]" prompt played to the caller before connecting the call.
confirm_media_file_id	string	Optional	Value must be a valid client_media_file_id. (default is 0) If specified alongside the `confirm_required` option, will play this message when asking the callee to confirm answering.
callerid_name_rewrite	alphanum	Optional	Must be between 3 and 15 characters. (default is null)
callerid_number_rewrite	digits	Optional	Must be between 1 and 20 characters. Also supports the symbol '+'. (default is null)
sms_notify_email	string	Optionally required	Must be a valid email address. (default is null) Required if `enable_sms_email_notify` is set, will send an email if an sms was received.
sms_forward_number	digits [15]	Optionally required	Value must be a valid phone number. (default is null) Required if `enable_sms_forwarding` is set, will forward sms to selected number.
sms_callback_url	string	Optionally required	Must be a valid Webhook. Can contain GET arguments. Details will be sent as JSON in the POST body. (default is null) Required if `enable_sms_callback` is set.
sms_autoreply_message	string	Optionally required	Must be a valid string of 160 or less characters. (default is null) Required if `enable_sms_autoreply` is set, will automatically reply with this text on every incoming SMS.
client_channel_id	integer	Optional	Value must be a valid `client_channel_id`. (default is 0)
client_subaccount_id	integer	Optional	Value must be a valid `client_subaccount_id`. (default is 0)
notify_callback_triggers	Array	Optionally required	Value must be one (or more, comma separated) of the following: "on_create", "on_ring", "on_answer", "on_hangup", "on_test", "on_record" (default is NULL) Required if `enable_notify_callback` is set, will set the triggers selected to the notify callback.
notify_callback_url	string	Optionally required	Value must be a valid URL. If this value is changed, we will hit the url and expect an HTTP Code 200. The test hit will have the trigger on_test. (default is NULL) Required if `enable_notify_callback` is set, will set the callback URL to the one selected.
simultaneous_calls_limit	integer	Optional	Value must be a number between 0 and 255
type	string	Optional	Value must be one of the following: 'local', 'tollfree', 'paypercall', 'international', 'inum', 'shadow', 'interexchange'
usage_type	string	Required	Value must be one of the following: 'default', 'paging', 'parking', 'conference', 'disa', 'uri'
recording_notify_recipient_name	string	Optional	Must be a valid string of 255 or less characters.
recording_notify_recipient_email	string	Optional	Must be a valid string of 255 or less characters.
peer_failover_causes	string	Optional	Must be a valid string of 240 or less characters.
pickup_group_ids	string	Optional	Must be a valid string of 64 or less characters.
sms_dnis_rewrite	string	Optional	Must be 30 or less characters.
exclude_e411_list	integer	Optional	Value must be 0 or 1
exclude_e911_list	integer	Optional	Value must be 0 or 1
options	Array	Optional	Value must be one or more of the following : "enable_forwarding", "enable_voicemail", "enable_peer", "ondemand_recording", "announce_monitor", "enable_recording", "enable_ivr", "enable_fax", "announce_caller", "enable_sms", "enable_sms_email_notify", "enable_sms_forwarding", "enable_sms_callback", "enable_sms_callback_retry", "enable_sms_autoreply", "enable_uri", "enable_georedundancy", "force_ring_signal", "discard_redirect", "confirm_required", "enable_filtering", "enable_director", "enable_notify_callback". (default is NULL)
comments	string	Optional
status	enum	Optional	Value must be one of the following: "enabled" or "disabled"

Delete DID

Delete a did from your account.

Request Type: delete_did

Parameter	Type [?]	Requirement	Description
client_did_id	integer	Optionally required	Value must be a valid `client_did_id`
phone_number	integer	Optionally required	Value must be a valid phone number of 10 digits. ( No space or - symbol )

Show Sample XML response

Parameter	Type [?]	Requirement	Description
type	string	Optional	Value must be one of the following : "local", "tollfree", "inum", "international". (default is NULL)
npa	digits [3]	Optional	Value must be a 3 digits NPA area code. (only for local) (default is NULL)
nxx	digits [3]	Optional	Value must be a 3 digits NXX prefix. (only for local) (default is NULL)
ratecenter_id	digits[6]	Optional	Value must be a 6 digits `ratecenter_id`. (default is NULL)
district	string	Optional	Value must be a partial or complete district name. Complete match will be returned first. (default is NULL)
state_id	string	Optional	Value must be a `state_id`. (default is NULL)
included_patterns	string	Optional	Value must be a one or many of the following : 'all_numbers' will return all entries 'no_patterns' will return numbers with no pattern 'rare_number','pattern_double_digits','pattern_double_digits_pair','pattern_double_digits_trio','pattern_tripple_digits','pattern_quadruple_digits' will return numbers will match at least one of the given pattern (default is all_numbers)
order	string	Optional	Values must be one of the following : default, random. (default is default)
t38_support	bool	Optional	Value must be one of the following: "1" or "0" This parameter indicates if you require t38/fax support for your did(s).
sms_support	bool	Optional	Value must be one of the following: "1" or "0" This parameter indicates if you require SMS support for your did(s).

Parameter	Type [?]	Requirement	Description
phone_number	digits[10-15]	Optionally Required	Value must be a valid phone_number.
did_id	integer	Optionally Required	Value must be a valid did_id.
skip_notification	bool	Optional	Will skip the new did assigned email.

Parameter	Type [?]	Requirement	Description
prefix	digits	Optionally Required	Value must be a valid 6 digits NPA/NXX code for local or an international code with country code but without the 011. (default is NULL)
ratecenter_id	digits[6]	Optionally Required	Value must be a 6 digits `ratecenter_id`. (default is NULL) NOTE : A ratecenter may contain more than one NPA/NXX combination, you will receive one at random.
type	string	Optional	Value must be one of the following : "local", "international". (default is local)
quantity	integer	Required	Value must be valid number.
prefix_preference	string	Optional	Value must be one of the following: "in_ratecenter", "prefix_only". (default is "in_ratecenter") This parameter indicates if you require the specific NPA/NXX given or if you only need a number in the ratecenter. NOTE : You cannot use prefix_only without setting `prefix` or if type is international.
sequential	string	Optional	Value must be one of the following: "random", "sequential". (default is "random")
t38_support	bool	Optional	Value must be one of the following: "1" or "0" This parameter indicates if you require t38/fax support for your did(s).
sms_support	bool	Optional	Value must be one of the following: "1" or "0" This parameter indicates if you require SMS support for your did(s).
mms_support	bool	Optional	Value must be one of the following: "1" or "0" This parameter indicates if you require MMS support for your did(s).
capacity	string	Optional	Value must be one of the following: "0", "1-2", "2-5", "5-10", "10-15", "15-25", "25-50", "50+". (default is "1-2") This parameter indicates how many simultaneous call this number will have at peak usage.
comments	string	Optional	A comment to be displayed on your order.

Parameter	Type [?]	Requirement	Description
port_request_id	int	Optional	Value can either be a valid `port_request_id` or a fully qualified PON 'PON00000000'. (default is NULL)
client_subaccount_id	integer	Optional	Value must be a valid `client_subaccount_id`. (default is NULL)
current_owner	string	Optional	Will add a wildcard before and after the string comparison. Case and accent insensitive. (default is NULL)
phone_number	int	Optional	Will check for the number being ported. Does not search in numbers to keep or disconnect. (default is NULL)
status	enum	Optional	Value must be one (or more, comma separated) of the following: "not_ready", "sent_to_staff", "approved_by_staff", "rejected_by_staff", "rejected_by_client", "expired", "sent_to_provider", "cancelled_by_client", "tentative_confirm", "firm_confirm", "rejected_by_provider", "completed", "modified_by_staff" (default is NULL)
date_from	date	Optional	Value must be a valid date formatted as "YYYY-MM-DD". Will search for the firm date. Does not search in the tentative or requested date. (default is NULL)
date_to	date	Optional	Value must be a valid date formatted as "YYYY-MM-DD". Will search for the firm date. Does not search in the tentative or requested date. (default is NULL)

Parameter	Type [?]	Requirement	Description
mode	string	Optional	Value must be "update" or "create". (default is update)
port_request_id	integer	Optionally required	If mode is "update", value must be a valid `port_request_id`
client_subaccount_id	integer	Optional	Value must be a valid `client_subaccount_id`. (default is 0)
friendly_name	string	Optional	Value must be alphanumeric string from 2 to 60 characters. (default is NULL).
phone_number_type	string	Optionally Required	Value must be one of the following: "local" or "tollfree"
phone_numbers	string	Optionally Required	Value must be a valid phone number of 10 digits. More than one value can be used separated by comma
phone_numbers_to_keep	string	Optional	Value must be a valid phone number of 10 digits. More than one value can be used separated by comma (default is NULL).
phone_numbers_to_cancel	string	Optional	Value must be a valid phone number of 10 digits. More than one value can be used separated by comma (default is NULL).
features	string	Optional	Value must be one or more of the following : "sms", "mms", "t38" (default is NULL).
capacity	string	Optionally Required	Value must be one or more of the following : "1-2", "2-5", "5-10", "10-15", "15-25", "25-50", "50+"
requested_firm_date	string	Optional	Value must be a valid date formatted as "YYYY-MM-DD". Desired port date. Must be between 3 to 15 business days (default is "As soon as possible").
organization	string	Optionally Required	Value must be alphanumeric string from 2 to 60 characters.
organization_type	string	Optionally Required	Value must be one of the following: "personal", "business"
current_provider	string	Optionally Required	Value must be alphanumeric string from 2 to 60 characters.
current_reseller	string	Optional	Value must be alphanumeric string from 2 to 60 characters. (default is NULL).
current_reseller_account	string	Optional	Value must be alphanumeric string from 2 to 60 characters. (default is NULL).
box_number	string	Optional
civic_number	integer	Optionally Required	Value must be a number.
street	string	Optionally Required	Value must be alphanumeric string.
unit_number	integer	Optional	Value must be a number.
city	string	Optionally Required	Value must be alphanumeric string.
country_id	integer	Optionally Required	Value must be a valid `country_id`
state_id	string	Optionally required	If country_id is "38" or "223", must be a valid `state_id`.
state_other	string	Optionally required	If country_id is not is "38" or "223", must be alphanumeric string.
postal_code	string	Optionally Required	Must be a valid `postal_code`.
client_instructions	string	Optional	Instructions to be provided to the carrier. Eg: "New BTN is 514-xxx-xxxx" (default is NULL).
is_notify_creation	bool	Optional	Value must be one of the following: "1" or "0" (default is 0). Create a kayako ticket immediately upon sending to staff
notification_client_user_id	string	Optionally Required	Must be a valid `client_user_id`. This user will receive the Kayako ticket notifications
extra_recipients	string	Optional	Extra recipient to receive the Kayako notifications. More than one value can be used separated by comma (default is NULL).
loa	file	Optional	Must be a valid file. (default is NULL).
bill	file	Optional	Must be a valid file. (default is NULL).
other	file	Optional	Must be a valid file. (default is NULL).
send_to_staff	bool	Optionally Required	Value must be one of the following: "1" or "0" (default is 0). Set to 1 to submit the port. Fields become required when trying to send to staff.
comments	string	Optional
[raw_metadata]	see doc	see doc

Parameter	Type [?]	Requirement	Description
phone_number	digits[10-15]	Required	Value must be a valid phone_number.

Parameter	Type [?]	Requirement	Description
npa	digits[3]	Optional	Value must be a 3 digits NPA area code. (default is NULL)
ratecenter_id	digits[6]	Optional	Value must be a 6 digits ratecenter. (default is NULL)
country_id	integer	Optional	Value must be a valid `country_id`.
state_id	integer	Optional	Value must be a valid `state_id`.

Parameter	Type [?]	Requirement	Description
npa	digits[3]	Optional	Value must be a 3 digits NPA area code. (default is NULL)
nxx	digits[3]	Optional	Value must be a 3 digits NXX prefix. (default is NULL)
ratecenter_id	digits[6]	Optional	Value must be a 6 digits `ratecenter_id`. (default is NULL)
state_id	integer	Optional	Value must be a valid `state_id`. (default is NULL)
country_id	integer	Optional	Value must be a valid `country_id`. (default is NULL)
portability	integer	Optional	Value must be 1 or 0. (default is both)
availability	integer	Optional	Value must be 1 or 0. (default is both)
updated_since	date	Optional	Will return all entries updated since given date. Must be a valid date. (default is NULL)
result_limit	integer	Optional	Value must be between 1 and 1000 (default is 25)
result_offset	integer	Optional	Value must be a valid number (default is NULL)

Parameter	Type [?]	Requirement	Description
npa	digits[3]	Optional	Value must be a 3 digits NPA area code. (default is NULL)
nxx	digits[3]	Optional	Value must be a 3 digits NXX prefix. (default is NULL)
ratecenter_id	digits[6]	Optional	Value must be a 6 digits `ratecenter_id`. (default is NULL)
state_id	integer	Optional	Value must be a valid `state_id`. (default is NULL)
country_id	integer	Optional	Value must be a valid `country_id`. (default is NULL)
updated_since	date	Optional	Will return all entries updated since given date. Must be a valid date. (default is NULL)
result_limit	integer	Optional	Value must be between 1 and 1000 (default is 25)
result_offset	integer	Optional	Value must be a valid number (default is NULL)

Parameter	Type [?]	Requirement	Description
sms_log_id	integer	Optional	Value must be a valid `sms_log_id`. (default is NULL)
client_subaccount_id	integer	Optional	Value must be a valid `client_subaccount_id`. (default is NULL)
sms_hash	alphanum [32]	Optional	Value must be a 32 characters alphanumeric unique id referencing to a call previously returned by a request made with `get_sms`. (default is NULL)
direction	enum	Optional	Value must be one of the following: "inbound", "outbound" (default is NULL)
status	enum	Optional	Value must be one (or more, comma separated) of the following: "enabled", "deleted", "purged" (default is NULL)
transmission_status	enum	Optional	Value must be one (or more, comma separated) of the following: "pending", "processing", "completed", "failed", "cancelled", "paused" (default is NULL)
source_number	integer	Optional	Value must be valid phone number (default is NULL)
destination_number	integer	Optional	Value must be valid phone number (default is NULL)
date_from	date	Optional	Value must be a valid date formatted as "YYYY-MM-DD".
date_to	date	Optional	Value must be a valid date formatted as "YYYY-MM-DD".
result_limit	integer	Optional	Value must be between 1 and 1000 (default is 25 with date_to and date_from setd, 1 with sms_hash set)

Parameter	Type [?]	Requirement	Description
sms_log_id	integer	Required	Value must be a valid `sms_log_id`.

Parameter	Type [?]	Requirement	Description
date_from	date	Optional	Value must be a valid date formatted as "YYYY-MM-DD". Max date range between `date_to` and `date_from` is 12 months. (default is today)
date_to	date	Optional	Value must be a valid date formatted as "YYYY-MM-DD". Max date range between `date_to` and `date_from` is 12 months. (default is today)
client_subaccount_ids	enum	Optional	List of all the `client_subaccount_id` wanted separated by a comma. Max 10 `client_subaccount_id`. (default is main_account and whole_account (main_account + subaccounts))
message_types	enum	Optional	List of all the client message types wanted separated by a comma. (default is NULL)

Parameter	Type [?]	Requirement	Description
client_did_id	integer	Optionally Required	Value must be a valid `client_did_id`.
source_number	digits [10]	Optionally Required	Value must be a valid phone number.
destination_number	digits [10]	Required	Value must be a valid phone number.
message	string [160]	Optionally Required	Value must be valid string up to 1000 characters. You must provide either a message or an attachment. Depending on carrier message may be split into multiple 160 character sms.
attachments	file	Optionally Required	Value must be a valid file, only one file supported for now. You must provide either a message or an attachment.
retry_limit	integer	Optional	Value must between 0 and 5. (default is 0)

Parameter	Type [?]	Requirement	Description
client_sms_profile_id	integer	Optional	Value must be a valid `client_sms_profile_id`. (default is NULL)
client_subaccount_id	integer	Optional	Value must be a valid `client_subaccount_id`. (default is NULL)

Parameter	Type [?]	Requirement	Description
mode	string	Optional	Value must be "update" or "create". (default is update)
client_sms_profile_id	integer	Optionally required	If mode is "update", value must be a valid `client_sms_profile_id`
client_subaccount_id	integer	Optional	Value must be a valid `client_subaccount_id`.
friendly_name	string	Optional	Value must be alphanumeric string from 2 to 32 characters.
language	string	Optional	Value must be one of the following : "en" or "fr".
allowed_senders	string	Optional	List of all the `allowed_senders` wanted separated by a comma.
notify_name	integer	Optionally required	Value must be alphanumeric string. Required if option "inbound_completed_notification" is selected.
notify_email	string	Optionally required	Value must be alphanumeric string. Required if option "inbound_completed_notification" is selected.
forward_number	string	Optionally required	Value must be a valid phone number of 10 digits. Required if option "enable_forwarding" is selected.
callback_url	string	Optionally required	Must be a valid Webhook. Can contain GET arguments. Details will be sent as JSON in the POST body. Required if option "enable_callback" is selected.
backup_url	string	Optional	Must be a valid Webhook. Can contain GET arguments. Details will be sent as JSON in the POST body. Will be called if `callback_url` does not respond.
autoreply_message	string	Optionally required	Value must be alphanumeric string of maximum 160 characters. Required if option "enable_autoreply" is selected.
client_did_id	string	Optional	Value must be a valid `client_did_id`.
options	string	Required	Value must be any of the following comma seperated: "inbound_completed_notification", "outbound_completed_notification", "outbound_failed_notification", "enable_forwarding", "enable_callback", "enable_autoreply" or "enable_callback_retry"
status	string	Optional	Value must be one of the following: "enabled", "disabled" or "deleted"
comments	string	Optional

Parameter	Type [?]	Requirement	Description
client_sms_profile_id	integer	Required	Value must be a valid `client_sms_profile_id`.

Parameter	Type [?]	Requirement	Description
client_peer_id	integer	Optional	Value must be a valid `client_peer_id`. (default is NULL)
client_channel_id	integer	Optional	Value must be a valid `client_channel_id`. (default is NULL)
client_subaccount_id	integer	Optional	Value must be a valid `client_subaccount_id`. (default is NULL)

Parameter	Type [?]	Requirement	Description
mode	string	Optional	Value must be "update" or "create". (default is update)
preserve_missing_data	boolean	Optional	This will allow you to modify only the provided fields when updating an entry (default is FALSE)
client_peer_id	integer	Optionally required	If mode is "update", value must be a valid `client_peer_id`
proxy_id	integer	Optionally required	Only available on mode `create`. Value must be a valid `proxy_id`
friendly_name	string	Required	Value must be alphanumeric string from 2 to 32 characters.
host_type	string	Required	Value must be one of the following: "dynamic" or "static" (default is NULL)
host	string	Optional	Value must be a valid ip address
port	string	Optional	Value must be a valid port
peer_username	string	Optionally required	Only available on mode `create`. Value must be alphanumeric string from 6 to 32 characters.
username	string	Deprecated	Only available on mode `create`. Value must be alphanumeric string from 6 to 32 characters.
password	string	Optional	Value must be alphanumeric string from 6 to 32 characters.
callerid_name	string	Optional	Value must be alphanumeric string from 3 to 15 characters.
callerid_number	digits [10]	Optional	Value must be a valid phone number of 10 digits.
callerid_mode	string	Required	Value must be one of the following: "global", "privacy", "custom", "device" or "smart"
callerid_type	string	Optionally Required	Required on mode `update`. Value must be one of the following: "rpid", "pid" or "none"
callerid_format	string	Optionally Required	Required on mode `update`. Value must be one of the following: "e164", "unaltered" or "national"
internal_cid_mode	string	Optional	Value must be "default" or "custom".
internal_cid_name	string	Optionally Required	Required if internal_cid_mode is set to "custom". Must be a string that consists of 2 to 15 characters
internal_cid_number	string	Optionally Required	Required if internal_cid_mode is set to "custom". Must be a string that consists of exactly four digits where the first digit is not a zero.
client_callerid_profile_id	integer	See description	Required if callerid_mode is set to "smart". Must be a valid client_callerid_profile_id.
transport	string	Optionally Required	Required when using static IP or ACL `update`. Value must be one of the following: "udp", "tcp", "tls"
codecs	enum	Optionally Required	Required on mode `update`. Value must be one (or more, comma separated) of the following: "g729", "ulaw", "alaw", "g726", "gsm" or "ilbc"
dtmf_mode	string	Optionally Required	Required on mode `update`. Value must be one of the following: "rfc2833", "inband", "info" or "auto"
dnis_mode	string	Optionally Required	Required on mode `update`. Value must be one of the following: "auto", "forced" or "disabled" (default is auto)
dnis_format	string	Optionally Required	Required on mode `update`. Value must be one of the following: "national" or "e164" (default is auto)
force_ring_signal	boolean	Optional	1 = enabled, 0 = disabled (default is 0)
enable_nat	boolean	Optional	1 = enabled, 0 = disabled (default is 0)
enable_reinvite	boolean	Optional	1 = enabled, 0 = disabled (default is 0)
enable_recording	boolean	Optional	1 = enabled, 0 = disabled (default is 0)
ondemand_recording	boolean	Optional	1 = enabled, 0 = disabled (default is 0)
enable_dnis	boolean	Deprecated	1 = enabled, 0 = disabled (default is 0) will set the dnis_mode at forced
enable_notification	boolean	Optional	1 = enabled, 0 = disabled (default is 0)
simultaneous_calls_limit	integer	Optional	Value must be a number between 0 and 255
enable_auth	boolean	Optional	1 = enabled, 0 = disabled (default is 0)
auth_username	string	Optional	Value must be alphanumeric string from 3 to 32 characters.
default_ip	string	Optional	Value must be a valid ip address
client_channel_id	integer	Optional	Value must be a valid `client_channel_id`. (default is 0)
client_subaccount_id	integer	Optional	Value must be a valid `client_subaccount_id`. (default is 0)
client_filter_ids	Array	Optional	Value must be one or more valid client_filter_id. (default is NULL)
enable_notify_callback	boolean	Optional	1 = enabled, 0 = disabled (default is 0)
notify_callback_triggers	Array	Optional	Value must be one (or more, comma separated) of the following: "on_create", "on_ring", "on_answer", "on_hangup", "on_test", "on_record" (default is NULL)
notify_callback_url	string	Optional	Value must be a valid Webhook. If this value is changed, we will hit the url and expect an HTTP Code 200. The test hit will have the trigger on_test. (default is NULL)
register_timeout	string	Optional	Only available on mode `create`. Value must be between 120 and 7200.
progress_timeout	string	Optionally required	Only available on mode `create`. Value must be between 1 and 10.
provisioned_endpoint_id	integer	Optional	Value must be a valid `client_endpoint_id` or one of the following values: 0 = default, 1 = dynamic, 2 = block, 3 = unprovisioned
options	Array	Optional	Value must be one or more of the following : "enable_nat", "enable_reinvite", "enable_recording", "ondemand_recording", "enable_notification", "enable_dnis", "enable_auth", "force_ring_signal", "enable_notify_callback", "disable_rtp_timer", "force_contact", "disable_moh", "enable_acl", "secure_media", "sticky_contact", "inband_ringback", "ignore_early_media", "static_failure_response", "enable_recording_transcribe", "enable_recording_notify". (default is NULL)
status	string	Optionally Required	Required on mode `update`. Value must be one of the following: "enabled" or "disabled"
comments	string	Optional

Parameter	Type [?]	Requirement	Description
client_peer_id	integer	Required	Value must be a valid `client_peer_id`.

Parameter	Type [?]	Requirement	Description
client_mailbox_id	integer	Optional	Value must be a valid `client_mailbox_id`. (default is NULL)

Parameter	Type [?]	Requirement	Description
mode	string	Optional	Value must be "update" or "create". (default is update)
client_mailbox_id	integer	Optionally required	If mode is "update", value must be a valid `client_mailbox_id`
client_subaccount_id	integer	Optional	Value must be a valid `client_subaccount_id`. (default is 0)
friendly_name	string	Optional	Value must be alphanumeric string from 2 to 32 characters.
passcode	digits[4-12]	Optional	Value must be a number from 4 to 12 characters.
email	string	Optional	Value must be a valid email address.
enable_mail_notification	integer	Optional	1 = enabled, 0 = disabled (default is 0)
contact_name	string	See description	Required if enable_mail_notification is set to 1. Must be between 4 to 60 characters.
enable_peer_notification	integer	Optional	1 = enabled, 0 = disabled (default is 0)
notification_peers	string	See description	Required if enable_peer_notification is set to 1. Must be between 1 and 10 peer ids (comma separated). (default is 0)
notification_duration	integer	See description	Required if enable_mail_notification and enable_peer_notification is set to 1. Must be between 5 and 60 minutes. (default is 0)
status	string	Optional	Value must be one of the following: "enabled" or "disabled"
comments	string	Optional

Parameter	Type [?]	Requirement	Description
client_mailbox_id	integer	Required	Value must be a valid `client_mailbox_id`.

Parameter	Type [?]	Requirement	Description
mode	string	Required	Value must be "text_to_speech", "existing_file" or "post_file".
client_mailbox_id	integer	Required	Value must be a valid `client_mailbox_id`
friendly_name	string	Optional	Value must be alphanumeric string from 2 to 32 characters. By default if a new media file is create it will be named "greeting_mailbox_{client_mailbox_id}", where client_mailbox_id is the mailbox we are adding the greeting at.
text	string	Optionally Required	Value must be present when the mode is "text_to_speech" and is used to create the new file with the text given.
voice_name	string	Optionally Required	Value must be a valid voice_name for the Text-to-Speech. By default it is "fr-CA-Standard-A".
client_media_file_id	integer	Optionally Required	Value must be present when the mode is "existing_file" and be a valid `client_media_file_id`.
attachments	integer	Optionally Required	Value must be present when the mode is "post_file" and be a valid file.

Parameter	Type [?]	Requirement	Description
client_extension_id	integer	Optional	Value must be a valid `client_extension_id`. (default is NULL)
client_subaccount_id	integer	Optional	Value must be a valid `client_subaccount_id`. (default is NULL)

Parameter	Type [?]	Requirement	Description
mode	string	Optional	Value must be "update" or "create". (default is update)
client_extension_id	integer	Optionally required	If mode is "update", value must be a valid `client_extension_id`
extension	integer	Optional	Value must be a number between 1 000 and 9 999 (inclusively).
friendly_name	string	Optional	Value must be alphanumeric string from 2 to 32 characters.
client_peer_ids	array	Optional	Values must valid `client_peer_id`.
peer_timeout	string	Optional	Value must valid one of the following: "disabled", "2", "5", "10", "15", "20", "25", "30", "35", "40", "45", "50", "55".
enable_peer	integer	Optional	1 = enabled, 0 = disabled (default is 0)
client_queue_ids	enum	Optional	Value(s) must be valid client_queue_id(s) (comma separated). (default is NULL)
forward_number	integer	Optional	Value must be a valid phone number of 10 digits. (default is NULL)
forward_timeout	string	Optional	Value must valid one of the following: "disabled", "2", "5", "10", "15", "20", "25", "30", "35", "40", "45", "50", "55".
enable_forwarding	integer	Optional	1 = enabled, 0 = disabled (default is 0)
announce_media_file_id	integer	Optionally required	Required if `announce_caller` is set. Must be between a valid `announce_media_file_id`.
send_dtmf	string	Optional	Must be valid DTMF tones (0-9,a,b,c,d,w and W).
voice_language	string	Optional	Value must valid one of the following: "en", "fr". Default is account preferred language.
confirm_media_file_id	integer	Optional	>If specified alongside the `confirm_required` option, will play this message when asking the callee to confirm answering.
client_mailbox_id	integer	Optional	Value must valid `client_mailbox_id`.
enable_voicemail	integer	Optional	1 = enabled, 0 = disabled (default is 0)
enable_parking	integer	Optional	1 = enabled, 0 = disabled (default is 0)
options	Array	Optional	Value must be one or more of the following : "confirm_required", "announce_caller" (default is NULL).
dnis_rewrite	digits [10]	Optional	Value must be a valid DID number.
client_subaccount_id	integer	Optional	Value must be a valid `client_subaccount_id`
status	string	Optional	Value must be one of the following: "enabled" or "disabled"
comments	string	Optional

Parameter	Type [?]	Requirement	Description
-	-	-	-

Parameter	Type [?]	Requirement	Description
-	-	-	-

Parameter	Type [?]	Requirement	Description
client_subaccount_id	integer	Optional	Value must be a valid `client_subaccount_id`. (default is NULL)
client_brand_id	integer	Optional	Value must be a valid `client_brand_id`. (default is NULL)
status	enum	Optional	Value must be one (or more, comma separated) of the following: "enabled", "disabled" or "deleted" (default is NULL)
get_associations	bool	Optional	Value must be one of the following: "1" or "0" (default is 0). This will return the list of ids of peer, did, extension and mailbox associated to the client_subaccount.

Parameter	Type [?]	Requirement	Description
mode	string	Optional	Value must be "update" or "create". (default is update)
client_subaccount_id	integer	Optionally required	If mode is "update", value must be a valid `client_subaccount_id`
client_brand_id	integer	Optional	Value must be a valid `client_brand_id`. If `client_brand_id` is not provided, default brand will be assumed.
custom_id	string	Optional
friendly_name	string	Required	Value must be alphanumeric string from 2 to 32 characters.
call_limit	integer	Optional	Value must be a number between 0 and 999
allow_international_call	string	Optional	Value must be one of the following: "yes" or "no" (default is "no")
international_call_limit	integer	Optional	(default is 1)
require_international_nip	string	Optional	Value must be one of the following: "yes" or "no". (default is "no")
international_nip	string	Optional	Value must be a number between 6 and 8 character. More than one value can be used separated by comma. (default is "NULL")
multi_tenancy_mode	string	Required	Value must be one of the following: "disabled", "global", "self" or "shared"
multi_tenancy_subaccount_id	string	Optionally required	If "multi_tenancy_mode" is shared must be a valid `client_subaccount_id`
organization	string	Optional
organization_type	string	Optional	Value must be one of the following: "personal" or "business"
client_profile	string	Optional	Value must be one of the following: "undefined", "residential_client", "commercial_client", "callcenter_client" or "internal" (default is "undefined")
voice_language	string	Optional	Value must be one of the following: "en" or "fr" (default is NULL)
notification_language	string	Optional	Value must be one of the following: "en" or "fr" (default is NULL)
callerid_name	string	Optional	Value must be alphanumeric string from 3 to 15 characters.
callerid_number	digits [10]	Optional	Value must be a valid phone number of 10 digits.
client_moh_profile_id	string	Optional	Value must must be a valid `client_moh_profile_id` (default is NULL)
default_provisioned_endpoint_id	string	Optional	Value must must be a valid `provisioned_client_did_id` (default is NULL)
options	Array	Optional	Value must be one or more of the following : "subaccount_override_enabled", "enable_billing_module", "enable_billing_notification", "disable_411_access", "disable_public_service_access". (default is NULL)
status	string	Required	Value must be one of the following: "enabled", "disabled" or "deleted"
comments	string	Optional

Parameter	Type [?]	Requirement	Description
client_subaccount_id	integer	Required	Value must be a valid `client_subaccount_id`
associated_peers	enum	Optional	Only the list of all the given ids will be saved, erasing missing values. Value must be one (or more, comma seperated) valid `client_peer_id`
associated_dids	enum	Optional	Only the list of all the given ids will be saved, erasing missing values. Value must be one (or more, comma seperated) valid `client_did_id`
associated_extensions	enum	Optional	Only the list of all the given ids will be saved, erasing missing values. Value must be one (or more, comma seperated) valid `client_extension_id`
associated_fax_profiles	enum	Optional	Only the list of all the given ids will be saved, erasing missing values. Value must be one (or more, comma seperated) valid `client_fax_profiles`
associated_sms_profiles	enum	Optional	Only the list of all the given ids will be saved, erasing missing values. Value must be one (or more, comma seperated) valid `client_sms_profiles`
associated_mailboxes	enum	Optional	Only the list of all the given ids will be saved, erasing missing values. Value must be one (or more, comma seperated) valid `client_mailbox_id`

Parameter	Type [?]	Requirement	Description
mode	string	Optional	Value must be "update" or "create". (default is update)
client_subaccount_id	integer	Required	Value must be a valid `client_subaccount_id`
client_address_id	integer	Optionally required	If mode is "update", value must be a valid `client_address_id`
type	string	Optional	Value must be one of the following: "billing" There can be only one subaccount with an address of the type "billing". (default is "billing")
box_number	string	Optional
civic_number	integer	Required	Value must be a number.
street	string	Required	Value must be alphanumeric string.
unit_number	integer	Required	Value must be a number.
city	string	Required	Value must be alphanumeric string.
country_id	integer	Required	Value must be a valid `country_id`
state_id	string	Optionally required	If country_id is "38" or "223", must be a valid `state_id`.
state_other	string	Optionally required	If country_id is not is "38" or "223", must be alphanumeric string.
postal_code	string	Required	Must be a valid `postal_code`.
precision	string	Optionally required

Parameter	Type [?]	Requirement	Description
client_subaccount_id	integer	Required	Value must be a valid `client_subaccount_id`.

The following information gives you details about possible errors returned by the different request types.

Global

Error type	Description
auth_username_invalid	Auth username is invalid.
auth_username_required	Auth username is required.
authentication_failed	Authentication failed. Please verify 'client_account_id' and 'auth_token'.
authentication_token_required	Auth token is required.
requests_soft_limit_reached	The limit of requests has been reached. Further requests may be denied
requests_hard_limit_exceeded	The limit of requests allowed has been exceeded. Request is denied.
callerid_name_invalid	Caller ID name is invalid.
callerid_name_required	Caller ID name is required.
callerid_number_invalid	Caller ID number is invalid.
callerid_number_required	Caller ID number is required.
callerid_rejection_notice	Some providers might reject toll free Caller ID.
client_account_id_invalid	Client account ID is invalid.
client_account_id_required	Client account ID is required.
client_did_id_invalid	Client DID ID is invalid.
client_extension_id_invalid	Client account ID is invalid.
client_mailbox_id_invalid	Client mailbox ID is invalid.
client_peer_id_invalid	Client peer ID is invalid.
country_id_invalid	Country ID is invalid.
country_id_required	Country ID is required.
date_from_invalid	Date from is invalid.
date_to_invalid	Date to is invalid.
email_invalid	Email address is invalid.
email_required	Email address is required.
forward_number_invalid	Forward number is invalid.
forward_number_required	Forward number is required.
forward_timeout_invalid	Call forward ring timeout is invalid.
forward_timeout_required	Call forward ring timeout is required.
friendly_name_invalid	Friendly name is invalid.
friendly_name_required	Friendly name is required.
internal_error-database_error	There was an internal error with our database.
internal_error-invalid_argument	Invalid argument.
language_invalid	Language is invalid.
mailbox_invalid	Mailbox is invalid.
mode_invalid	Mode is invalid.
npa_invalid	NPA is invalid.
nxx_invalid	NXX is invalid.
npa_required	NPA is required.
nxx_required	NXX is required.
options_invalid	Options are invalid.
password_invalid	Password is invalid.
password_mismatch	The password verification did not match.
password_required	Password is required.
peer_required	Peer is required.
peer_timeout_invalid	Peer ring timeout is invalid.
peer_timeout_required	Peer ring timeout is required.
peers_to_ring_limit_reached	Please choose a maximum of 5 peers.
phone_number_invalid	Phone number is invalid.
request_type_invalid	Request type is invalid.
request_type_not_implemented	Request type is not implemented.
request_type_required	Request type is required.
required_parameter_not_found	Required parameters missing.
result_limit_invalid	Result limit is invalid.
result_offset_invalid	Result offset is invalid.
state_id_invalid	State ID is invalid.
status_invalid	Status is invalid.
status_required	Status is required.
username_invalid	Username is invalid.
username_required	Username is required.

Dispatch Call

Error type	Description
destination_invalid	Destination is invalid.
destination_required	Destination is required.
destination_type_invalid	Destination type is invalid.
destination_type_required	Destination type is required.
enable_recording_invalid	Enable recording value is invalid.
global_callerid_name_undefined	Global caller ID name is not defined.
max_retries_invalid	Maximum retries is invalid.
retry_delay_invalid	Retry delay is invalid.
socket_error	A socket error occured.
source_invalid	Source is invalid.
source_required	Source is required.
source_type_invalid	Source type is invalid.
source_type_required	Source type is required.
wait_time_invalid	Wait time is invalid.

Get Calls

Error type	Description
direction_invalid	Direction is invalid.
call_hash_invalid	Call Hash is invalid.

Get Rates

Error type	Description
code_invalid	Code is invalid.
search_parameters_required	Search parameters are required.

Report Call Issue

Error type	Description
call_hash_invalid	Call Hash is invalid.
call_issue_id_invalid	Call Issue ID is invalid.

Get Recordings

Error type	Description
call_hash_invalid	Call hash is invalid.
call_recording_id_invalid	Call recording id is invalid.
recording_hash_invalid	Recording hash is invalid.

Process Payment

Error type	Description
amount_invalid	Amount is invalid.
amount_required	Amount is required.
bank_account_number_invalid	Bank account number is invalid.
bank_account_number_required	Bank account number is required.
bank_account_type_invalid	Bank account type is invalid.
bank_account_type_required	Bank account type is required.
bank_name_invalid	Bank name is invalid.
bank_name_required	Bank name is required.
bank_routing_number_invalid	Bank routing number is invalid.
bank_routing_number_required	Bank routing number is required.
billing_contact_not_found	Account's billing contact could not be found.
credit_card_cvd_invalid	The credit card CVD number is invalid.
credit_card_cvd_required	The credit card CVD number is required.
credit_card_expiration_month_invalid	The credit card expiration month is invalid.
credit_card_expiration_month_required	The credit card expiration month is required.
credit_card_type_invalid	The credit card type is invalid.
credit_card_type_required	The credit card type is required.
credit_card_expiration_year_invalid	The credit card expiration year is invalid.
credit_card_expiration_year_required	The credit card expiration year is required.
credit_card_number_invalid	The credit card number is invalid.
credit_card_number_required	The credit card number is required.
currency_invalid	Currency is invalid.
currency_not_supported	Currency is not supported for given type of payment.
currency_required	Currency is required.
minimum_amount_required	The minimum amount is not met.
payment_attempt_failed	Payment attempt has failed.
payment_denied	Payment denied.
payment_method_invalid	Payment method is invalid.
payment_method_required	Payment method is required.

Update DID

Error type	Description
forward_number_used_by_did	Forward number already in use.

Update Extension

Error type	Description
extension_already_in_use	Extension is already in use.
extension_invalid	Extension is invalid.
extension_required	Extension is required.

Update Mailbox

Error type	Description
default_mailbox_dependency	You cannot disable this mailbox because it is set as default.
mailbox_did_dependency	You cannot disable this mailbox because it is associated to a DID number.
passcode_invalid	Passcode is invalid.
passcode_required	Passcode is required.
voice_mailboxes_limit_reached	Voice mailboxes limit is reached.

Update Peer

Error type	Description
callerid_mode_invalid	Caller ID mode is invalid.
callerid_mode_required	Caller ID mode is required.
codecs_invalid	Codecs are invalid.
codecs_required	Codecs are required.
default_ip_invalid	Default IP is invalid.
dtmf_invalid	The dtmf mode is invalid.
global_callerid_infos_undefined	Global caller ID settings are not defined.
host_type_invalid	Host type is invalid.
host_type_required	Host type is required.
peer_did_dependency	You cannot disable this peer because it is associated to a DID number.
peer_excluded_from_sync	This peer is currently excluded from synchronization and changes will not affect live configuration.
peer_exist	The username is already in use.
peers_limit_reached	Peers limit is reached.
type_invalid	The peer protocol is invalid.

e911 Errors

Error type	Description
alternate_address_provided	Alternate Address is Provided.
client_endpoint_id_not_found	Client Endpoint ID Not Found.
client_peer_id_not_found	Client Peer ID Not Found.
client_did_id_not_found	Client DID ID Not Found.
phone_number_not_found	Phone Number Not Foudn.
no_e911_endpoint_found	Number is not provisioned.
no_e911_endpoint_found	Number is not provisioned.
civic_number_not_found	Civic number not found.
street_not_found	Street not found.
city_not_found	City not found.
state_not_found	State not found.
country_not_found	Country not found.
first_name_not_found	First name not found.
last_name_not_found	Last name not found.
postal_code_not_found	Postal Code not found.
last_endpoint_was_deleted	The last endpoint was deleted. Any calls to 911 after this notice and before another DID is provisionned will be billed an E911 unprovision fee in your account.
entry_is_default_endpoint	The endpoint is currently the default endpoint for the account. Set the default to another one before deleting this one.

Order new dids

Error type	Description
prefix_required	No prefix nor ratecenter id was given.
prefix_invalid	Prefix is not valid.
ratecenter_id_invalid	Ratecenter id is not valid.
type_invalid	Type must be either "local" or "international".
quantity_required	Quantity is required.
quantity_invalid	Quantity must be a number above 0 and under 1000.
prefix_preference_invalid	Preference must be either "in_ratecenter" or "prefix_only".
sequential_invalid	Preference must be either "random" or "sequential".
t38_support_invalid	Preference must be either "optional" or "required".
capacity_invalid	Preference must be either "1-5", "5-25" or "25+".
prefix_not_found	Could not find the prefix in our database.
ratecenter_id_not_found	Could not find the ratecenter id in our database.
could_not_send	An error occurred while trying to send the request, please contact us.

2025-03-03

Added : API now implements the get_3cx_calls request type

2025-01-21

Added : API now supports the get_resellers_clients_plans request type

2024-12-20

Added : API now supports the get_city_codes request type

2024-12-03

Updated : get_new_dids now return prices for Consumers.
Added : update_e911 added `city_code` parameter.

2024-09-20

Updated : update_peer added missing `internal_cid_mode` argument.
Updated : update_peer added missing `internal_cid_name` argument.
Updated : update_peer added missing `internal_cid_number` argument.

2024-05-02

Updated : update_peer added new parameter for : preserve_missing_data

2024-04-08

Added : API now supports the delete_ivr_profiles request type

2024-04-05

Added : API now supports the delete_subaccount request type

2024-02-23

Modified : get_dids now returns client_mailbox_id
Modified : get_dids now returns client_fax_profile_id
Modified : get_dids now returns enable_voicemail
Modified : get_dids now returns dnis_rewrite
Modified : get_dids now returns announce_media_file_id
Modified : get_dids now returns send_dtmf
Modified : get_dids now returns bridge_uri
Modified : get_dids now returns client_conference_profile_id
Modified : get_dids now returns ondemand_recording
Modified : get_dids now returns confirm_media_file_id
Modified : get_dids now returns sms_autoreply_message

Added : get_dids added `client_mailbox_id` parameter.
Added : get_dids added `announce_media_file_id` parameter.
Added : get_dids added `bridge_uri` parameter.
Added : get_dids added `client_conference_profile_id` parameter.
Added : get_dids added `enable_fax` parameter.
Added : get_dids added `ondemand_recording` parameter.
Added : get_dids added `client_fax_profile_id` parameter.
Added : get_dids added `dnis_rewrite` parameter.
Added : get_dids added `enable_voicemail` parameter.
Added : get_dids added `confirm_media_file_id` parameter.
Added : get_dids added `sms_dnis_rewrite` parameter.
Added : get_dids added `usage_type` parameter.
Added : get_dids added `playback_media_file_id` parameter.
Added : get_dids added `sms_autoreply_message` parameter.
Added : get_dids added `recording_notify_recipient_name` parameter.
Added : get_dids added `recording_notify_recipient_email` parameter.
Added : get_dids added `peer_failover_causes` parameter.
Added : get_dids added `sip_response` parameter.
Added : get_dids added `exclude_e411_list` parameter.
Added : get_dids added `exclude_e911_list` parameter.
Added : get_dids added `client_moh_profile_id` parameter.

Added : update_did added `type` parameter.
Added : update_did added `usage_type` parameter.
Added : update_did added `recording_notify_recipient_name` parameter.
Added : update_did added `recording_notify_recipient_email` parameter.
Added : update_did added `peer_failover_causes` parameter.
Added : update_did added `pickup_group_ids` parameter.
Added : update_did added `sms_dnis_rewrite` parameter.
Added : update_did added `exclude_e411_list` parameter.
Added : update_did added `exclude_e911_list` parameter.

2024-01-30

Added : New request type get_3cx_servers has been added.
Added : New request type update_3cx_server has been added.
Added : New request type delete_3cx_server has been added.

2024-01-18

Updated : update_queue_agent added missing `client_schedule_id` argument.
Fixed : queue_status was replaced with correct agent_status argument in update_queue_agent.

2023-12-18

Updated : update_extension added `dnis_rewrite` argument.

2023-12-08

Updated : update_e911 `rate_provider_id` parameter is now available to set desired provider if has access.

2023-08-28

Updated : update_peer `username` parameter is now deprecated in favor of `peer_username`.

2023-06-20

Updated : update_call_director_profile added new parameter for : preserve_missing_data

2023-06-15

Updated : API now supports being passed argument using JSON body in POST. "Content Type" header must be "application/json" for this method to work.

2023-03-20

Added : API now supports fetching Text-to-Speech (TTS) voices with get_tts_voice_name request type
Added : API now supports setting a new/existing media as a mailbox greeting with update_mailbox_greeting request type

2023-02-20

Added : API now supports fetching (Phone) Devices with get_devices request type
Added : API now supports fetching Device Endpoints (Autoprovision) with get_device_endpoints request type
Added : API now supports deleting a Device Endpoint (Autoprovision) with delete_device_endpoint request type
Added : API now supports creating/updating a Device Endpoint (Autoprovision) with update_device_endpoint request type

2023-02-07

Added : API now supports fetching media files with get_media_files request type

2023-01-31

Updated : 'voicemail_broadcast' added new parameter 'privacy' to enable privacy on outgoing call.

2023-01-23

Updated : 'get_calls' added new parameter 'routing_details' to add more details for source and destination.

2022-12-20

Added : API now supports deleting SMS profiles with the delete_sms_profile request type
Added : API now supports deleting SMS with the delete_sms request type

2022-11-01

Updated : update_subaccount added new parameter for : require_international_nip
Updated : update_subaccount added new parameter for : international_nip
Updated : get_subaccounts added new return value : require_international_nip
Updated : get_subaccounts added new return value : international_nip

2022-09-07

Fixed : output_format=json should return data for nested JSON rather than JSON string.

2022-08-08

Updated : get_dids added new parameter status for : getDids

2022-06-10

Added : API now supports the get_schedules request type

2022-02-07

Fixed : type filter and subaccount filter forget_sms_stats

2022-02-01

Added : API now supports the get_storage_stats request type

2022-01-14

Updated : update_did added new parameter for : preserve_missing_data

2021-11-02

Updated : update_port_request added all parameters from client section.

2021-10-25

Added : API now has metadata in get_port_requests
Added : API now supports the update_port_request request type

2021-10-15

Added : API now supports the get_ivr_profiles request type
Added : API now supports the update_ivr_profiles request type

2021-10-06

Updated : update_queue_agent added new parameter for : conditions_data
Updated : update_queue_agent added new parameter for : purge_conditions

2021-09-20

Updated : dispatch_call added new parameter for : client_subaccount_id
Updated : dispatch_call added new parameters for : sources[] and destinations[]

2021-05-28

Added : API now supports the get_queue_agents request type
Added : API now supports the update_queue_agent request type

2021-05-14

Added : API now supports the get_queues request type
Added : API now supports the update_queue request type

2021-04-12

Fixed : update_fax_profile parameter retry_limit was made mandatory by accident. It now has it's previous behavior of default 2.

2021-03-15

Updated : order_new_dids added new ranges for : capacity

2021-03-01

Updated : update_subaccount added new parameter : voice_language, notification_language, callerid_name, callerid_number, client_moh_profile_id, default_provisioned_endpoint_id and options.
Updated : get_subaccounts now includes voice_language, notification_language, callerid_name, callerid_number, client_moh_profile_id, default_provisioned_endpoint_id and options values.

2021-01-18

Updated : update_peer added new parameter : simultaneous_calls_limit.
Updated : get_peers now includes simultaneous_calls_limit value.
Updated : update_did added new parameter : simultaneous_calls_limit.
Updated : get_dids now includes simultaneous_calls_limit value.

2020-12-22

Modified : get_sms now has following new search parameters: source_number, destination_number
Added : API now supports the get_request_types request type

2020-11-24

Modified : update_peer added new parameter : transport.
Modified : get_peers now includes transport value.

2020-10-23

Added : API now supports the get_call_issues request type
Added : API now supports the report_call_issues request type

2020-10-13

Modified : get_peers now includes last time it was successfully registered: datetime_registered

2020-10-09

Added : update_fax_profiles added new parameters : `callback_url`, `backup_url` and `option` now has `enable_callback`.

2020-10-07

Added : API now supports the delete_mailbox request type

2020-10-05

Modified : get_resellers_invoices now has following new search parameters: reseller_invoice_id

2020-09-23

Added : API now supports the get_resellers_transactions request type

2020-08-24

Added : API now supports deleting fax profiles with the delete_fax_profile request type

2020-08-18

Added : API now supports adding and updating fax profiles with the update_fax_profile request type

2020-08-13

Modified : get_extensions now has following new search parameters: client_subaccount_id
Modified : get_extensions now returns client_account_id and client_subaccount_id

2020-08-13

Modified : get_sms_profiles now returns backup_url
Modified : set_sms_profiles now supports backup_url

2020-08-03

Added : documentation for get_resellers_transactions request type.

2020-06-17

Added : API now supports providing "routing_type" with get_calls request type
Fixed : get_calls was not properly taking "results_limit" now return if get_associations is set to 1 the client_mailbox_ids

2020-06-01

Added : API now supports setting client_queue_ids with update_did request type
Added : API now supports setting client_queue_ids with update_extension request type
Modified : get_dids now returns client_queue_ids
Modified : get_extensions now returns client_queue_ids

2020-05-21

Modified : API now accepts results limit up to 25,000 entries. Keep in mind that those queries can take more time to return content.
Modified : get_call_faxes now returns the client_subaccount_id in fax_details and can be searched on it
Modified : get_call_faxes now has following new search parameters: date_from, date_to, client_fax_profile_id

2020-05-19

Added : API now supports setting client_subaccount_id with update_call_director_profile request type
Modified : get_call_director_profiles now returns the client_subaccount_id in call_director_profiles and can be searched on it

2019-12-02

Added : API now supports setting client_subaccount_id with update_extension request type
Added : API now supports setting enable_parking with update_extension request type

2019-08-16

Added : API now supports adding and updating whitepages (411) listings with update_whitepages request type
Added : API now supports deleting whitepages (411) listings with delete_whitepages request type

2019-07-08

Modified : get_subaccounts now return if get_associations is set to 1 the client_mailbox_ids
Modified : update_subaccount_associations now can update associated_mailboxes
Modified : get_mailboxes now returns the client_subaccount_id in the mailbox_details
Modified : update_mailbox now updates the client_subaccount_id
Modified : get_voicemails now returns the client_subaccount_id in the voicemail_details and can be searched on it

2019-06-06

Added : API now supports getting list of sms profiles with get_sms_profiles request type and update it with update_sms_profile
Modified : get_dids and update_did to have the client_sms_profile_id

2019-05-30

Added : documentation for webhooks

2019-05-15

Added : API now supports getting list of port requests with get_port_requests request type

2018-12-13

Added : API now supports getting list of available proxies with get_proxies request type

2018-11-28

Modified : get_sms added new parameters : `client_subaccount_id`.

2018-11-22

Added : API now supports getting sms statistics with get_sms_stats request type

2018-11-14

Added : API now supports getting whitepages (411) using get_whitepages
Added : API now supports DID lookup using did_lookup
Added : API now supports updating Fax Profiles -> Sub-Account associations with update_subaccount_associations request type
Added : API now supports filtering on `client_subaccount_id` for get_fax_profiles
Modified : get_plans added `plan_id` parameter and `plan_groups_id` parameter.

2018-10-11

Added : API now supports deleting peers using delete_peers
Added : API now supports creating peers using update_peers and the `mode` parameter.
Modified : get_peers added `status`, `port`, `proxy_id`, `host_type`, `client_mailbox_id`, `comments` to output.
Modified : update_peers added `port` parameter.

2018-10-04

Modified : get_subaccounts added `status` parameter.
Modified : get_subaccounts added `get_associations` parameter.
Modified : get_subaccounts removed `get_peers_details` parameter.
Modified : get_subaccounts removed `get_dids_details` parameter.
Added : API now supports updating Peers, Dids, Extensions -> Sub-Account associations with update_subaccount_associations request type
Added : API now supports updating Sub-Account with update_subaccount request type
Added : API now supports updating Sub-Account address with update_subaccount_address request type

2018-09-25

Modified : get_e911 added 3 new parameters : `client_subaccount_id`, `result_limit` and `result_offset`.

2018-09-19

Added : API now supports getting calls statistic with get_calls_stats request type

2018-09-12

Modified : get_dids added `ported_in` and `special_attributes` elements.

2018-09-04

Modified : get_subaccounts added `get_peers_details` parameter.
Modified : get_subaccounts added `get_dids_details` parameter.

2018-08-21

Modified : documentation of our new hourly limitation for the API
Modified : hourly limitation for the API will trigger notice when exceeding limits, before cutoff.
Added : new request per minute limitations implemented.
Added : documentation for experimental voicemail_broadcast request type.

2018-08-14

Added : get_subaccounts new request type to get Sub-Accounts and details.

2018-07-26

Modified : update_peer added `dnis_format` argument.
Modified : get_peers added `dnis_mode` and `dnis_format` to returned values.

2018-05-24

Added : update_peer added `smart` value to the argument `callerid_mode`.
Added : update_peer added `client_callerid_profile_id` argument.

2018-05-09

Modified : update_peer added `dnis_mode` argument.
Modified : update_peer `enable_dnis` is now deprecated in favor of `dnis_mode`. Original fields will keep working and will set `dnis_mode` to forced.
Modified : get_peers added `e911` to api return.

2018-03-26

Modified : queue_fax added `page_format` argument.
Modified : get_fax_profiles now returns 'page_format'.

2018-03-13

Modified : update_peer now accepts 'on_test' for argument `notify_callback_triggers`.
Modified : update_did now accepts 'on_test' for argument `notify_callback_triggers`.

2018-01-09

Modified : queue_sms now accepts up to 1000 character for message. Depending on carrier message may be split into multiple 160 character SMS.
Modified : get_sms now returns segment quantity (for billing purpose).

2017-12-19

Added : documentation of our new hourly limitation for the API.

2017-11-22

Modified : update_did added `enable_sms_autoreply` option and `sms_autoreply_message` argument.

2017-10-23

Modified : get_network_status added `mode` argument.

2017-09-11

Modified : get_recordings added `latest_hours` argument.
Modified : get_calls added `latest_hours` argument.

2017-09-01

Modified : order_new_dids added `mms_supported` argument.
Modified : get_dids added `attachment_size` (in bytes) to api return.
Modified : get_dids added `mms_support` argument and added `mms_support` to api return.

2017-08-22

Modified : queue_sms MMS is now supported you must post a file as `attachments` (support for multiple files coming soon).

2017-08-16

Modified : update_did `sms_notify_email`, `sms_forward_number`, `sms_callback_url`, `notify_callback_triggers`, `notify_callback_url` now are optionally required when their option are selected.

2017-08-02

Modified : update_did `notify_callback_url` has extra validation. A test hit will be made and expect an HTTP code 200.
Modified : update_peer `notify_callback_url` has extra validation. A test hit will be made and expect an HTTP code 200.
Added : update_did added `voice_language` parameter.
Added : update_extensions added `voice_language` parameter.
Added : get_dids now returns extra fields for `voice_language`.
Added : get_extension now returns extra fields for `voice_language`.

2017-07-31

Added : get_dids new returned values : `peer_contact_mode`.
Modified : update_did `asynchronous_peer_hunt` option is now removed in favor of `peer_contact_mode`.

2017-07-24

Added : update_call_director_profile added `announce_media_file_id` parameter and the `announce_caller` option.
Added : update_did added `announce_media_file_id` parameter and the `announce_caller` option.
Added : update_extensions added `announce_media_file_id` parameter and the `announce_caller` option.

2017-07-17

Added : get_call_director_profile now returns extra fields for `usage_type` "forward".

2017-07-12

Added : update_call_director_profile new request type to modify/create Call director profiles.
Added : delete_call_director_profile new request type to delete Call director profiles.

2017-07-10

Deprecated : get_calls Deprecated `unique_id` in favor of `call_hash`.
Deprecated : report_call_issue Deprecated `unique_id` in favor of `call_hash`.

2017-07-10

Added : update_dids Added multiple options to allow for newer functions of DIDs to be set via the api. Options added are : { "asynchronous_peer_hunt","enable_uri","enable_georedundancy","force_ring_signal","discard_redirect","confirm_required","enable_filtering","enable_director" }.
Added : update_dids Added multiple fields to allow for newer functions of DIDs to be set via the api. Fields added are : { "client_conference_profile_id","confirm_media_file_id","bridge_uri","client_director_profile_id","send_dtmf" }.
Removed : update_dids Removed the deprecated "enable_forwarding", "enable_voicemail", "enable_peer" and "enable_recording" fields as they are now options.

2017-05-12

Added : update_did added `notification_callback_url`, `notification_callback_triggers` parameters and the `enable_notify_callback` option.

Added : update_peer added `notification_callback_url`, `notification_callback_triggers` and `enable_notify_callback` parameters.

2017-05-12

Added : get_calls 10 new fields returned if argument `extras` is set to `yes`.

2017-05-04

Modified : update_e911 first_name and last_name are now deprecated in favor of full_name. Original fields will keep working but they cannot exceed more than 32 characters when combined.
Modified : get_e911 first_name and last_name are now deprecated in favor of full_name. Original fields will keep working based on a split on full_name using the last space found.

2017-04-10

Added : update_e911 new fields e911_language to replace the language. Previous field conflicted with the global language argument.

2017-03-31

Added : get_sms returns new field `client_did_id`.
Added : get_fax_profiles returns new field `client_account_id`.

2017-01-30

Added : queue_sms new values : retry_limit.

2016-11-29

Added : get_account_details new returned values : Sub-Accounts details.

2016-11-29

Added : get_peers new filters and returned values : client_subaccount_id and client_filter_ids.
Added : get_dids new filters and returned values : client_subaccount_id and client_filter_ids.
Added : get_calls new filters and returned values : client_subaccount_id and client_filter_ids.
Added : update_dids new fields : client_subaccount_id and client_filter_ids.
Added : update_peers new fields : client_subaccount_id and client_filter_ids.

2016-11-28

Added : get_channels allows you list all your current channels.
Added : update_channel allows you to update your channels.
Added : delete_channel allows you to delete your channels.

2016-11-21

Added : get_new_dids now returns a new field : cancellation_fees.
Added : activate_new_did now returns a new field : cancellation_fees.
Added : delete_did now returns two new messages : deleted_entry (client_did_id) and cancellation_fees.

2016-10-19

Added : get_peers now returns two new field : callerid_type, callerid_format.
Added : update_peer now supports two new arguments: callerid_type, callerid_format.

2016-10-17

Added : get_did_exchanges now returns four new field : fax_supported, sms_supported, fax_since, sms_since.

2016-10-14

Added : activate_new_did now returns two new fields : price_mrc and price_nrc.
Added : get_new_dids now returns two new fields : price_mrc and price_nrc.
Added : get_did_exchanges now returns one new field : price_mrc.

2016-10-12

Added : get_dids now has 6 new filters : ratecenter_id, district, state_id, country_id, options, client_peer_id.
Modified : get_dids will now only return active dids or the ones in the redemption process ( recently deleted ).

2016-10-04

Added : get_dids now has a new fax_support, sms_support, npa and nxx filters.
Modified : get_dids now returns sms_support and fax_support for each matched did.

2016-08-22

Added : get_new_dids now has a new fax_support option to allow ordering of Fax/t38 compatible numbers.
Modified : get_new_dids now filters on sms_support. It previously silently failed.
Modified : get_new_dids now returns sms_support and fax_support for each matched did.

2016-08-15

Modified : order_new_dids now has a different syntax for the t38_support option to better match other api methods.
Added : order_new_dids now has a new sms_support option to allow ordering of SMS compatible numbers.

2016-02-26

Modified : get_did now returns the forward number, email notification and callback url fields.

2016-02-01

Modified : update_did now supports 5 new options and 3 new fields related to SMS features.

2016-01-19

Modified : API now supports getting SMS with get_sms request type

2015-11-09

Modified : API now supports sending SMS with queue_sms request type (*requires DID with SMS support)

2015-06-15

Update : The API now forces SSL connexions over HTTPS. All traffic will be redirected from HTTP.

2015-06-01

Update : SSL connexions must now use TLS 1.2 or greater

2015-05-07

Update : updated security measures

2015-04-21

Added : delete_did is a new request_type

2015-04-17

Added : update_did has a new argument callerid_name_rewrite
Added : update_did has a new argument callerid_number_rewrite

2015-04-01

Added : get_new_dids has a new argument district
Added : activate_new_did has a new argument skip_notification
Added : get_new_dids has a new argument order
Added : get_new_dids has a new argument state_id

2015-03-30

Added : get_new_dids has a new argument included_patterns

2015-02-25

Modified : Core lib for did will not accept 0 as a valid media file id anymore

2015-02-24

Modified : get_e911 will only return active e911 provisions

2015-02-18

Modified : get_calls return to include billed_duration which was previously matched to billsec now both fields are returned

2015-02-09

Modified : API now supports e911 custom phone_numbers that are not actual dids in the client account (*requires activation of option by administration)