Introduction
With the Developer API, you can interact with many VoiceMeUp services and features using simple HTTP requests, so you can easily integrate those services and features into your applications and other APIs. To use the API, you need to sign up for an API authentication key, and then follow the instructions below.
The API is not always up to date with newest features offered through the client control panel. If you would like a new feature to be implemented in the API do not hesitate to send us your requests, comments and suggestions.
Getting Started
HTTP Query syntax
The Developer API is called with plain HTTP queries. Each request must be sent in its own query—only one API operation per HTTP call. Parameter values must be URL-encoded when they contain characters that could conflict with query string syntax.
Deprecated
API v1.0
Do not use this endpoint for new integrations. It is kept only for legacy compatibility and will be retired at the end of 2026.
https://developer.voicemeup.com/xml_engine/xml_engine.php?request_type=get_request_types&client_account_id=80012345&auth_token=1A2B3C4D5E6 ...
Current
API v1.1
Use these endpoints for all new integrations. Prefer a Authorization: Bearer header for authentication instead of passing auth_token in the URL (see [Authentication](#started_authentication)).
https://clients.voicemeup.com/api/v1.1/json/get_request_types?client_user_id=123456 ...
https://client.beevox.com/api/v1.1/json/get_request_types?client_user_id=123456 ...
Will also work with your whitelabel custom domain:
https://yourcustomdomain.com/api/v1.1/json/get_request_types?client_user_id=123456 ...
Authentication
Every API v1.1 request must identify the caller and include a valid auth_token.
The preferred method is to send the token in an HTTP header so it is not exposed in URLs, proxy logs, or browser history:
Authorization: Bearer <auth_token>
The same 32-character hexadecimal token can still be supplied as the auth_token query parameter or form field for compatibility, but header authentication is recommended for all new integrations.
Simple GET with Bearer token
Simple GET with Bearer token
curl -sS -G 'https://clients.voicemeup.com/api/v1.1/json/get_request_types' \
--data-urlencode 'client_user_id=123456' \
-H 'Authorization: Bearer REDACTED'
GET with auth_token query parameter (alternative)
GET with auth_token query parameter (alternative)
curl -sS -G 'https://clients.voicemeup.com/api/v1.1/json/get_request_types' \
--data-urlencode 'client_user_id=123456' \
--data-urlencode 'auth_token=REDACTED'
HTTP methods
For API v1.1, JSON is the preferred and recommended response format (use the /json/ path segment in the endpoint URL).
Request parameters may be sent as a JSON document in the request body with Content-Type: application/json.
GET is supported for most read-only request types when parameters are simple and the URL stays within normal length limits. Use POST with a JSON body when you need richer payloads or when GET is not suitable.
GET will not work when:
- One or more files must be uploaded (requires
multipart/form-data) - A parameter value needs special encoding that is awkward or unsafe in a query string
- The full set of parameters would make the URL too long for the server or client
POST with JSON body (recommended)
POST with JSON body (recommended)
curl -sS -X POST 'https://clients.voicemeup.com/api/v1.1/json/get_calls' \
-H 'Authorization: Bearer REDACTED' \
-H 'Content-Type: application/json' \
-d '{
"client_user_id": "123456",
"date_from": "2024-01-01",
"date_to": "2024-01-31",
"limit": "25"
}'
POST with file upload (multipart)
POST with file upload (multipart)
curl -sS -X POST 'https://clients.voicemeup.com/api/v1.1/json/queue_fax' \
-H 'Authorization: Bearer REDACTED' \
-F 'client_user_id=123456' \
-F 'fax_profile_id=12345' \
-F 'destination_number=15145551234' \
-F 'file=@/path/to/document.pdf;type=application/pdf'
Initial query parameters
The Developer API requires initial query parameters for any request type.
| 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. |
| request_type | string | Required (Obsolete in v1.1) | Value must be a valid request_type. Call get_request_types to list request types and whether your user may access each one, or browse the full Request types section. |
| 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) |
| username | string | Optionally Required (v1.1 Only) | Value must be a valid username. |
| client_user_id | digits[4-8] | Optionally Required (v1.1 Only) | 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). Prefer sending this value in an Authorization: Bearer header instead of a query parameter (see Authentication). |
| 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.
Response format
Responses are only formatted in two formats:
- XML Extensible Markup Language (Default)
- JSON JavaScript Object Notation
Sample response
Sample response
{
"request_details": {
"request_datetime": "2017-12-13 13:44:57",
"request_arguments": {
"client_account_id": "80012345",
"auth_token": "REDACTED",
"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": ""
}
}
...<?xml version="1.0" encoding="utf-8"?>
<response>
<request_details>
<request_datetime>2007-05-17 09:21:38</request_datetime>
<request_arguments>
<client_account_id>80012345</client_account_id>
<auth_token>REDACTED</auth_token>
<request_type>get_recordings</request_type>
<call_hash>11ac028b9acccfe4914ca6a792b6abcd</call_hash>
</request_arguments>
</request_details>
<response_details>
<server_name>epsilondraco.hostmeup.com</server_name>
<response_delay>0.10781908035278</response_delay>
<response_status>success</response_status>
<response_messages/>
</response_details>
...
</response>
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 :
Limitation
To avoid abuse, the Developer API has an hourly limit. Some request types have a specific limit as shown below; request types without a specific limit count toward 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 (Soft Limit) |
|---|---|
| delete_faxes | 1500 |
| delete_recordings | 1500 |
| delete_voicemails | 1500 |
| get_file | 1500 |
| dispatch_call | 900 |
| voicemail_broadcast | 900 |
| queue_fax | 600 |
| queue_sms | 600 |
| shared_pool (all other request types combined) | 1200 |
When the soft limit is reached, the request is still processed successfully. The response includes a notice message with the error code requests_soft_limit_reached, indicating that further requests may be denied if usage continues to increase.
We recommend using simulate_response to test limit behavior in your integration. Its rate_limited_soft and rate_limited_hard response types return the same notice and warning messages as production, without consuming your hourly quota. Treat a soft limit notice as a signal to throttle requests before the hard limit is reached.
Sample response with soft limit notice
Sample response with soft limit notice
{
"request_details": {
"request_datetime": "2017-12-13 13:44:57",
"request_arguments": {
"client_account_id": "80012345",
"auth_token": "REDACTED",
"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": {
"message": {
"type": "notice",
"code": "requests_soft_limit_reached",
"_content": "1250 requests in 60 minute(s), soft limit: 1200, type: 'shared_pool'"
}
}
},
"recordings": {
...
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
<request_details>
<request_datetime>2007-05-17 09:21:38</request_datetime>
<request_arguments>
<client_account_id>80012345</client_account_id>
<auth_token>REDACTED</auth_token>
<request_type>get_recordings</request_type>
<call_hash>11ac028b9acccfe4914ca6a792b6abcd</call_hash>
</request_arguments>
</request_details>
<response_details>
<server_name>epsilondraco.hostmeup.com</server_name>
<response_delay>0.10781908035278</response_delay>
<response_status>success</response_status>
<response_messages>
<message type="notice" code="requests_soft_limit_reached"><![CDATA[1250 requests in 60 minute(s), soft limit: 1200, type: 'shared_pool']]></message>
</response_messages>
</response_details>
<recordings>
...
</recordings>
</response>
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
Getting started
Get request types
Request Type:
Returns every Developer API request type, along with whether the authenticated user is allowed to call each one. This request type is always available when valid credentials are supplied, so it is the recommended way to discover which API methods your integration can use before calling them.
Each entry includes a permission attribute set to
allowed or denied
for the current client_user_id.
Sample response
Sample response for get_request_types
{
...
"request_types": {
"request_type": [
{
"permission": "allowed",
"_content": "get_faxes"
},
{
"permission": "allowed",
"_content": "get_request_types"
},
{
"permission": "allowed",
"_content": "get_sms"
},
{
"permission": "denied",
"_content": "queue_fax"
},
{
"permission": "denied",
"_content": "queue_sms"
}
]
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<request_types>
<request_type permission="allowed">get_faxes</request_type>
<request_type permission="allowed">get_request_types</request_type>
<request_type permission="allowed">get_sms</request_type>
<request_type permission="denied">queue_fax</request_type>
<request_type permission="denied">queue_sms</request_type>
...
</request_types>
</response>
Simulate Response
Request Type:
This method allows you to simulate different API response scenarios including success, failures, timeouts, server errors, and other HTTP status codes. This is useful for testing error handling, timeout behavior, and various edge cases in your applications without affecting real data.
Note: This method is designed for testing and development purposes only.
Important: The timeout and server_error response types immediately terminate the connection and do not return XML responses, simulating real-world connection failures.
Response Types:
- success - Returns HTTP 200 with successful response data and mock values
- failed - Returns HTTP 200 with error in response (business logic failure)
- timeout - Returns HTTP 408 and immediately terminates connection (no XML response)
- server_error - Returns HTTP 500 and immediately terminates connection (no XML response)
- unauthorized - Returns HTTP 200 with authentication warning error
- rate_limited_soft - Returns success with notice error
- rate_limited_hard - Returns failure with warning error
- maintenance - Returns HTTP 200 with maintenance_mode fatal error
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| response_type | string | required | Type of response to simulate. Valid values: success, failed, timeout, server_error, unauthorized, rate_limited_soft, rate_limited_hard, maintenance |
| delay | integer | optional | Delay in seconds before responding (0-30). Useful for testing timeout handling. Default: 0 |
Sample response (success)
Sample response (success) for simulate_response_success
{
...
"response_details": {
"response_status": "success",
"response_delay": "0.0234",
"response_messages": ""
},
"simulate_response": {
"mock_data": {
"sample_id": "12345",
"sample_name": "Test Item",
"sample_value": "42.50",
"sample_date": "2025-09-26 10:30:15"
},
"simulated_scenario": "Simulated successful response"
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<response_details>
<response_status>success</response_status>
<response_delay>0.0234</response_delay>
<response_messages/>
</response_details>
<simulate_response>
<mock_data>
<sample_id>12345</sample_id>
<sample_name>Test Item</sample_name>
<sample_value>42.50</sample_value>
<sample_date>2025-09-26 10:30:15</sample_date>
</mock_data>
<simulated_scenario>Simulated successful response</simulated_scenario>
</simulate_response>
</response>
Sample response (failed)
Sample response (failed) for simulate_response_failed
{
...
"response_details": {
"response_status": "failed",
"response_delay": "0.2243",
"response_messages": {
"message": {
"type": "warning",
"code": "simulate_failed_response",
"field": "test",
"_content": "This is a simulated failed response"
}
}
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<response_details>
<response_status>failed</response_status>
<response_delay>0.2243</response_delay>
<response_messages>
<message>
<type>warning</type>
<code>simulate_failed_response</code>
<field>test</field>
<_content>This is a simulated failed response</_content>
</message>
</response_messages>
</response_details>
</response>
Calls & recordings
Get call history
Request Type:
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.
| 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) |
Sample response
Sample response for get_calls
{
...
"calls": {
"call_details": {
"call_hash": [
"e7d970de310b197b2d7498c92d58f72a",
"e7d970de310b197b2d7498c92d58f72a"
],
"originator_uuid": "54c7361a-7ee3-4f95-8088-cdb301536bd5",
"datetime_start": "2014-06-06 10:34:57",
"datetime_end": "2014-06-06 10:35:53",
"date": "2014-06-06",
"time": "10:34:57",
"direction": "outbound",
"source": "14504540000",
"destination": "15146851000",
"client_peer_id": "1000",
"country_id": "38",
"state_id": "11",
"exchange_id": [
"514685",
"514685"
],
"ratecenter_id": "171610",
"duration": "56",
"callerid_name": "14504541000",
"callerid_number": "14504541000",
"bindings": "",
"status": "answered",
"disposition": "answered",
"normalized": "15146851000",
"billsec": "46",
"billed_duration": "46",
"billed_amount": "0.00",
"routing_type": "local_termination",
"billing_override": "below_channel_limit",
"current_rate": "0.00",
"client_channel_id": "0",
"client_subaccount_id": "18",
"metadata": "",
"source_country_id": "38",
"source_state_id": "11",
"source_ratecenter_id": "174200",
"source_country_name": "Canada",
"source_state_name": "Quebec",
"source_district": "Saint-Remi",
"destination_country_id": "38",
"destination_state_id": "11",
"destination_ratecenter_id": "172380",
"destination_country_name": "Canada",
"destination_state_name": "Quebec",
"destination_district": "Roxboro",
"failure_code": "NORMAL_CLEARING",
"sip_response_code": "200",
"account_usage_inbound": "0",
"account_usage_outbound": "0",
"account_call_limit": "0",
"subaccount_usage_inbound": "0",
"subaccount_usage_outbound": "0",
"subaccount_call_limit": "0",
"channel_usage_inbound": "0",
"channel_usage_outbound": "0",
"channel_usage_excess": "0"
}
}
}<?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
Request Type:
Gather statistical information about calls for given period.
| 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) |
Sample response with no subaccount_ids specified.
Sample response with no subaccount_ids specified. for get_calls_stats_no_subaccount
{
...
"calls_stats": {
"account": {
"whole_account": {
"local_termination": {
"routing_type": "internal",
"total_calls": "12345",
"total_duration": "44437",
"billed_amount": "0.00",
"billed_duration": "42318",
"asr": "58.852660",
"fsr": "5.10300",
"acd": "204.3957"
},
"total": {
"routing_type": "total",
"total_calls": "54321",
"total_duration": "95539",
"billed_amount": "169.3",
"billed_duration": "91307",
"asr": "88.473696",
"fsr": "5.10300",
"acd": "264.1441",
"peak_concurrent_inbound": "6",
"peak_concurrent_outbound": "4",
"peak_concurrent_combined": "6"
}
},
"main_account": {
"local_termination": {
"routing_type": "internal",
"total_calls": "12345",
"total_duration": "44425",
"billed_amount": "0.00",
"billed_duration": "42317",
"asr": "72.555752",
"fsr": "5.10300",
"acd": "207.0657"
},
"total": {
"routing_type": "total",
"total_calls": "54321",
"total_duration": "85864",
"billed_amount": "159.55",
"billed_duration": "81987",
"asr": "85.260800",
"fsr": "5.10300",
"acd": "250.6725",
"peak_concurrent_inbound": "6",
"peak_concurrent_outbound": "4",
"peak_concurrent_combined": "6"
}
}
}
}
}<?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>
Sample response with subaccount_ids specified.
Sample response with subaccount_ids specified. for get_calls_stats_subaccount
{
...
"calls_stats": {
"subaccounts": {
"subaccount": [
{
"client_subaccount_id": [
"123",
"123"
],
"internal": "",
"total": {
"routing_type": "total",
"total_calls": "272",
"total_duration": "737",
"billed_amount": "0.05",
"billed_duration": "701",
"asr": "77.119500",
"acd": "286.5167"
}
},
{
"client_subaccount_id": [
"321",
"321"
],
"internal": {
"routing_type": "internal",
"total_calls": "26",
"total_duration": "9",
"billed_amount": "0.00",
"billed_duration": "1",
"asr": "53.140000",
"acd": "29.2857"
},
"total": {
"routing_type": "total",
"total_calls": "104",
"total_duration": "22",
"billed_amount": "0",
"billed_duration": "8",
"asr": "77.409032",
"acd": "21.8065"
}
}
]
}
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<calls_stats>
<subaccounts>
<subaccount client_subaccount_id="123">
<client_subaccount_id>123</client_subaccount_id>
<internal/>
...
<total>
<routing_type>total</routing_type>
<total_calls>272</total_calls>
<total_duration>737</total_duration>
<billed_amount>0.05</billed_amount>
<billed_duration>701</billed_duration>
<asr>77.119500</asr>
<acd>286.5167</acd>
</total>
</subaccount>
<subaccount client_subaccount_id="321">
<client_subaccount_id>321</client_subaccount_id>
<internal>
<routing_type>internal</routing_type>
<total_calls>26</total_calls>
<total_duration>9</total_duration>
<billed_amount>0.00</billed_amount>
<billed_duration>1</billed_duration>
<asr>53.140000</asr>
<acd>29.2857</acd>
</internal>
...
<total>
<routing_type>total</routing_type>
<total_calls>104</total_calls>
<total_duration>22</total_duration>
<billed_amount>0</billed_amount>
<billed_duration>8</billed_duration>
<asr>77.409032</asr>
<acd>21.8065</acd>
</total>
</subaccount>
</subaccounts>
</calls_stats>
</response>
Get recorded calls
Request Type:
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.
| 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) |
| client_subaccount_id | integer | Optional | Value must be a valid client_subaccount_id. (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) |
Sample response
Sample response for get_recordings
{
...
"recordings": {
"recording_details": {
"call_recording_id": "12345678",
"call_hash": "11ac028b9acccfe4914ca6a792b6abcd",
"recording_hash": "2f369527fbffee39d553b5a9f897abcd",
"recording_url": "http://www.voicemeup.com/recordings//80012345-123/2f369527fbffee39d553b5a9f897abcd.mp3",
"size": "10928",
"length": "309"
}
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<recordings>
<recording_details>
<call_recording_id>12345678</call_recording_id>
<call_hash>11ac028b9acccfe4914ca6a792b6abcd</call_hash>
<recording_hash>2f369527fbffee39d553b5a9f897abcd</recording_hash>
<recording_url>http://www.voicemeup.com/recordings//80012345-123/2f369527fbffee39d553b5a9f897abcd.mp3</recording_url>
<size>10928</size>
<length>309</length>
</recording_details>
</recordings>
</response>
Delete recorded calls
Request Type:
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.
| 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 |
Sample response
Sample response for delete_recordings
{
...
"response_details": {
"server_name": "alphavirgo.hostmeup.com",
"response_delay": "0.35800981521606",
"response_status": "success",
"response_messages": {
"message": {
"type": "notice",
"code": "deleted_entries",
"_content": "3"
}
}
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<response_details>
<server_name>alphavirgo.hostmeup.com</server_name>
<response_delay>0.35800981521606</response_delay>
<response_status>success</response_status>
<response_messages>
<message type="notice" code="deleted_entries">
<![CDATA[ 3 ]]>
</message>
</response_messages>
</response_details>
</response>
Get voicemails
Request Type:
If you have enabled a mailbox on one of you DID, you will be able to retrieve the messages by using this request type.
| 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) |
| 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) |
| 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". |
Sample response
Sample response for get_voicemails
{
...
"voicemails": {
"voicemail_details": {
"call_voicemail_id": "12345678",
"client_subaccount_id": "1011",
"call_hash": "11ac028b9acccfe4914ca6a792b6abcd",
"voicemail_hash": "2f369527fbffee39d553b5a9f897abcd",
"voicemail_url": "http://www.voicemeup.com/clients_medias/voicemails/1012/201203/2f369527fbffee39d553b5a9f897abcd.mp3",
"size": "10928",
"length": "309"
}
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<voicemails>
<voicemail_details>
<call_voicemail_id>12345678</call_voicemail_id>
<client_subaccount_id>1011</client_subaccount_id>
<call_hash>11ac028b9acccfe4914ca6a792b6abcd</call_hash>
<voicemail_hash>2f369527fbffee39d553b5a9f897abcd</voicemail_hash>
<voicemail_url>http://www.voicemeup.com/clients_medias/voicemails/1012/201203/2f369527fbffee39d553b5a9f897abcd.mp3</voicemail_url>
<size>10928</size>
<length>309</length>
</voicemail_details>
</voicemails>
</response>
Delete voicemails
Request Type:
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.
| 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 |
Sample response
Sample response for delete_voicemails
{
...
"response_details": {
"server_name": "alphavirgo.hostmeup.com",
"response_delay": "0.35800981521606",
"response_status": "success",
"response_messages": {
"message": {
"type": "notice",
"code": "deleted_entries",
"_content": "3"
}
}
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<response_details>
<server_name>alphavirgo.hostmeup.com</server_name>
<response_delay>0.35800981521606</response_delay>
<response_status>success</response_status>
<response_messages>
<message type="notice" code="deleted_entries">
<![CDATA[ 3 ]]>
</message>
</response_messages>
</response_details>
</response>
Report call issue
Request Type:
Report an issue for a specific call.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| call_hash | string | Required | Value must be a 32 characters alphanumeric Call Hash referencing the last call previously returned by your last request made with get_calls. |
| issue_type_id | int | Required | Value must be an integer referencing and issue type returned by a request made with get_issues_types. |
| kayako_ticket_id | string | Optional | Value must have the following format: 'AAA-999-99999'. |
| comments | string | Optional |
Get Issues details
Request Type:
Get reported call issues.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| call_hash | string | Required | Value must be a 32 characters alphanumeric call hash. (default is NULL) |
| call_issue_id | int | Required | Value must be a valid call_issue_id. (default is NULL) |
| client_subaccount_id | integer | Optional | Value must be a valid client_subaccount_id. (default is NULL) |
Sample response
Sample response for get_call_issues
{
...
"call_issues": {
"call_issue_details": {
"call_issue_id": "60",
"call_time": "18:18:34",
"call_date": "2007-10-26",
"call_hash": "f777ce694e1af59282f8c84fa2b85473",
"issue_type_id": "54",
"kayako_ticket_id": "",
"client_account_id": "1234",
"client_subaccount_id": "5678",
"comments": "Appel manque le channel droit",
"status": "ignored",
"user_created": "1006",
"datetime_created": "2008-04-08 15:47:08"
}
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<call_issues>
<call_issue_details>
<call_issue_id>60</call_issue_id>
<call_time>18:18:34</call_time>
<call_date>2007-10-26</call_date>
<call_hash>f777ce694e1af59282f8c84fa2b85473</call_hash>
<issue_type_id>54</issue_type_id>
<kayako_ticket_id></kayako_ticket_id>
<client_account_id>1234</client_account_id>
<client_subaccount_id>5678</client_subaccount_id>
<comments>Appel manque le channel droit</comments>
<status>ignored</status>
<user_created>1006</user_created>
<datetime_created>2008-04-08 15:47:08</datetime_created>
</call_issue_details>
</call_issues>
</response>
Dispatch Call
Request Type:
This request allows you to establish a call between two distinct endpoints. It can be used to connect an agent to a local phone number or link any other combinations of the two endpoint types.
The meta_data parameter can be used to store any information about the call being dispatched in order to be retrieved later with get_calls request.This will work great with serialized data.
Note:
- Recordings of 2 seconds or less are automatically deleted.
- Both endpoints will be imported in the call history of account that made the request regardless if peer belongs to another account.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| client_subaccount_id | integer | Optional | Value must be a valid client_subaccount_id |
| source_type | string | Deprecated | Use sources[0][type] instead. |
| source | digits [10] alphanum [6-16] | Deprecated | Use sources[0][value] instead. |
| destination_type | string | Deprecated | Use destinations[0][type] instead. |
| destination | digits [10] alphanum [6-16] | Deprecated | Use destinations[0][value] instead. |
| callerid_name | string [3-15] | Optional | Value must be alphanumeric string from 3 to 15 characters. (default is account's global callerid_name) |
| callerid_number | string [10] | Optional | Value must be a valid Caller ID number. (default is account's global callerid_number) |
| enable_recording | integer | Optional | 1 = enabled, 0 = disabled (default is 0) |
| wait_time | integer | Optional | Value must be between 5 and 60 (inclusively) (default is 15) |
| meta_data | string | Optional | Any value is accepted. |
| sources[n][type] // destinations[n][type] | integer | Optional | If type is "number" then value must be valid phone number of at least 10 digits. If type is "peer" then value must be a valid peer username. If type is "uri" then value must be a valid SIP URI. |
| sources[n][callerid_name] // destinations[n][callerid_name] | string [3-15] | Optional | Value must be alphanumeric string from 3 to 15 characters. (defaults to provided callerid_name) |
| sources[n][callerid_number] // destinations[n][callerid_number] | string [10-15] | Optional | Value must be a valid CallerID Number. (default to provided callerid_number) |
| sources[n][language] // destinations[n][language] | string (en|fr) | Optional | Language used for default prompts. |
| sources[n][send_dtmf] // destinations[n][send_dtmf] | string | Optional | DTMF sequence to send |
| sources[n][announce_media_id] // destinations[n][announce_media_id] | integer | Optional | Media ID of annoucement |
| sources[n][confirm_required] // destinations[n][confirm_required] | boolean [0|1] | Optional | Call must be confirmed to be considered answered 1 = enabled, 0 = disabled (default is 0) |
| sources[n][confirm_media_id] // destinations[n][confirm_media_id] | integer | Optional | Media ID of call confirmation message |
| sources[n][retries] // destinations[n][retries] | integer | Optional | Number of retries for call confirmation |
| sources[n][accept_key] // destinations[n][accept_key] | integer | Optional | Key to press to accept call (default is 1) |
| sources[n][reject_key] // destinations[n][reject_key] | integer | Optional | Key to press to reject call (default is 2) |
Voicemail Broadcast
Request Type:
Experimental feature for the sole purpose of leaving a voicemail in a mailbox for a given destination number.
The meta_data parameter can be used to store any information about the call being broadcasted in order to be retrieved later with get_calls request.This will work great with serialized data, JSON or XML.
Note:
- Recordings of 2 seconds or less are automatically deleted.
- Both calls will be imported in the call history if
fork_callis used.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| destination_number | digits [10] | Required | Must be valid phone number of at least 10 digits. |
| callerid_name | string [3-15] | Optional | Value must be alphanumeric string from 3 to 15 characters. (default is account's global callerid_name) |
| callerid_number | string [10] | Optional | Value cannot start with the following: "1", "800", "888", "877", "866" or "855" (default is account's global callerid_number) |
| privacy | integer | Optional | Enable privacy for this call. Please note that a valid callerid_number is required 1 = enabled, 0 = disabled (default is 0) |
| enable_recording | integer | Optional | 1 = enabled, 0 = disabled (default is 0) |
| wait_time | integer | Optional | Value must be between 5 and 60 (inclusively) (default is 15) |
| client_media_file_id | string | Optionally required | Media file ID used for playback to voice mailbox.Must be provided unless media_url is set. (default is NULL) |
| media_url | string | Optional | Use a media file located in the cloud.Value must be a valid URL. (default is NULL) |
| voicemail_detect | integer | Optional | Works great with fork_call. Automatically start playback if voicemail tone is detected.1 = enabled, 0 = disabled (default is 1) |
| fork_call | integer | Optional | Works great with voicemail_detect, will make two calls to destination to force voicemail to pick-up and automatically cancel second call. 1 = enabled, 0 = disabled (default is 1) |
| pre_dtmf | string | Optional | DTMF sequence to play once call is answered, before playback.Valid DTMF are : 0 1 2 3 4 5 6 7 8 9 A B C D # * w W |
| post_dtmf | string | Optional | DTMF sequence to play once call is answered, after playback.Valid DTMF are : 0 1 2 3 4 5 6 7 8 9 A B C D # * w W |
| dtmf_duration | integer | Optional | Change duration of DTMF tones.Value must be between 100 and 1500 (inclusively) (default is 500) |
| notify_callback_triggers | string | Optionally required | Value must be one (or more, comma separated) of the following: "on_create", "on_ring", "on_answer", "on_hangup", "on_record" (default is NULL) Required if notify_callback_url is set. |
Fax
Get faxes
Request Type:
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.
| 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) |
Sample response
Sample response for get_faxes
{
...
"faxes": {
"fax_details": {
"call_fax_id": "1",
"client_fax_profile_id": "1001",
"client_subaccount_id": "0",
"call_hash": "11ac028b9acccfe4914ca6a792b6abcd",
"fax_url": "http://www.voicemeup.com/faxes/80012345/2f369527fbffee39d553b5a9f897abcd.pdf",
"fax_thumbnail": "http://www.voicemeup.com/faxes/80012345/2f369527fbffee39d553b5a9f897abcd.png",
"date": "2008-12-29",
"time": "12:56:52",
"name_from": "",
"email_from": "",
"direction": "inbound",
"destination_number": "5145551234",
"callerid_name": "INTERNET INFINITY",
"callerid_number": "5145554921",
"size": "16041",
"complete_pages": "1",
"total_pages": "1",
"remote_ident": "Internet Infinity",
"result_code": "0",
"status": "enabled",
"transmission_status": "completed"
}
}
}<?xml version="1.0" encoding="utf-8"; ?>
<response>
...
<faxes>
<fax_details>
<call_fax_id>1</call_fax_id>
<client_fax_profile_id>1001</client_fax_profile_id>
<client_subaccount_id>0</client_subaccount_id>
<call_hash>11ac028b9acccfe4914ca6a792b6abcd</call_hash>
<fax_url>http://www.voicemeup.com/faxes/80012345/2f369527fbffee39d553b5a9f897abcd.pdf</fax_url>
<fax_thumbnail>http://www.voicemeup.com/faxes/80012345/2f369527fbffee39d553b5a9f897abcd.png</fax_thumbnail>
<date>2008-12-29</date>
<time>12:56:52</time>
<name_from></name_from>
<email_from></email_from>
<direction>inbound</direction>
<destination_number>5145551234</destination_number>
<callerid_name>INTERNET INFINITY</callerid_name>
<callerid_number>5145554921</callerid_number>
<size>16041</size>
<complete_pages>1</complete_pages>
<total_pages>1</total_pages>
<remote_ident>Internet Infinity</remote_ident>
<result_code>0</result_code>
<status>enabled</status>
<transmission_status>completed</transmission_status>
</fax_details>
</faxes>
</response>
Delete stored faxes
Request Type:
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.
| 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 |
Sample response
Sample response for delete_faxes
{
...
"response_details": {
"server_name": "alphavirgo.hostmeup.com",
"response_delay": "0.35800981521606",
"response_status": "success",
"response_messages": {
"message": {
"type": "notice",
"code": "deleted_entries",
"_content": "3"
}
}
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<response_details>
<server_name>alphavirgo.hostmeup.com</server_name>
<response_delay>0.35800981521606</response_delay>
<response_status>success</response_status>
<response_messages>
<message type="notice" code="deleted_entries">
<![CDATA[ 3 ]]>
</message>
</response_messages>
</response_details>
</response>
Queue Fax
Request Type:
You can send a fax with this request type. It is important to note that this is a POST request.
| 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). |
Sample response
Sample response for queue_fax
{
"response_messages": {
"message": [
{
"type": "notice",
"code": "queued_call_fax_id",
"_content": "100000"
},
{
"type": "notice",
"code": "fax_preview_url",
"_content": "http://www.voicemeup.com/faxes/80000000/aaaaa812ce1a9c78fbe2db607310d917.jpg"
},
{
"type": "notice",
"code": "fax_file_url",
"_content": "http://www.voicemeup.com/faxes/80000000/aaaaa812ce1a9c78fbe2db607310d917.pdf"
}
]
}
}<?xml version="1.0" encoding="utf-8"?>
<response_messages>
<message type="notice" code="queued_call_fax_id"><![CDATA[100000]]></message>
<message type="notice" code="fax_preview_url">
<![CDATA[http://www.voicemeup.com/faxes/80000000/aaaaa812ce1a9c78fbe2db607310d917.jpg]]>
</message>
<message type="notice" code="fax_file_url">
<![CDATA[http://www.voicemeup.com/faxes/80000000/aaaaa812ce1a9c78fbe2db607310d917.pdf]]>
</message>
</response_messages>
Get Fax profiles
Request Type:
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.
| 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) |
Sample response
Sample response for get_fax_profiles
{
...
"fax_profiles": {
"fax_profile_details": {
"client_fax_profile_id": "1001",
"client_account_id": "1001",
"client_subaccount_id": "1001",
"friendly_name": "Default",
"local_ident": "Internet Infinity",
"fax_header": "Internet Infinity",
"callerid_name": "INFINITY FAX",
"callerid_number": "5555555555",
"contact_name": "Fax Recipient",
"email": "noreply@getinfinity.com",
"language": "",
"allowed_senders": "noreply@getinfinity.com",
"retry_limit": "2",
"page_format": "letter",
"resolution": "super_fine",
"callback_url": "",
"backup_url": "",
"options": "inbound_failed_notification,inbound_completed_notification,outbound_failed_notification,\n outbound_completed_notification,enable_cover_page,enable_inbound_send_attachment,\n enable_outbound_send_attachment",
"comments": "",
"status": "enabled"
}
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<fax_profiles>
<fax_profile_details>
<client_fax_profile_id>1001</client_fax_profile_id>
<client_account_id>1001</client_account_id>
<client_subaccount_id>1001</client_subaccount_id>
<friendly_name>Default</friendly_name>
<local_ident>Internet Infinity</local_ident>
<fax_header>Internet Infinity</fax_header>
<callerid_name>INFINITY FAX</callerid_name>
<callerid_number>5555555555</callerid_number>
<contact_name>Fax Recipient</contact_name>
<email>noreply@getinfinity.com</email>
<language/>
<allowed_senders>noreply@getinfinity.com</allowed_senders>
<retry_limit>2</retry_limit>
<page_format>letter</page_format>
<resolution>super_fine</resolution>
<callback_url/>
<backup_url/>
<options>
inbound_failed_notification,inbound_completed_notification,outbound_failed_notification,
outbound_completed_notification,enable_cover_page,enable_inbound_send_attachment,
enable_outbound_send_attachment
</options>
<comments/>
<status>enabled</status>
</fax_profile_details>
</fax_profiles>
</response>
Update Fax Profile
Request Type:
Allows you to create or simply update a 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. |
| 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", "force_cover_page", "enable_inbound_send_attachment", "enable_outbound_send_attachment", "enable_callback". force_cover_page requires enable_cover_page. (default is NULL) |
| status | string | Required | Value must be one of the following: "enabled" or "disabled" |
| comments | string | Optional |
Delete fax profile
Request Type:
Delete a fax profile from your account.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| client_fax_profile_id | integer | Required | Value must be a valid client_fax_profile_id. |
Phone numbers (DIDs)
Get DIDs details
Request Type:
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.
| 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) |
| special_attributes | enum | Optional | Only entries matching the given special attribute will be returned. Value must be one of the following: 'none','temporary','redemption','inventory','reserved' (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) |
| 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) |
Sample response
Sample response for get_dids
{
...
"dids": {
"did_details": {
"client_did_id": "1234",
"npa": "514",
"nxx": "312",
"ratecenter_id": "123456",
"phone_number": "5143127030",
"phone_number_e164": "15143127030",
"friendly_name": "5143127030",
"enable_peer": "1",
"peers_to_ring": "1234,1235",
"peer_timeout": "25",
"peer_contact_mode": "sequential",
"client_queue_ids": "1001,1002,1004",
"enable_forwarding": "1",
"enable_fax": "0",
"ondemand_recording": "0",
"forward_number": "5143127031",
"forward_timeout": "disabled",
"enable_voicemail": "1",
"client_ivr_profile_id": "0",
"client_director_profile_id": "0",
"client_conference_profile_id": "1037",
"destination_mailbox": "1234",
"client_fax_profile_id": "12",
"exclude_e411_list": "1",
"exclude_e911_list": "1",
"announce_media_file_id": "0",
"client_mailbox_id": "1234",
"enable_dnis": "0",
"enable_auth": "0",
"enable_recording": "1",
"status": "enabled",
"send_dtmf": "",
"dnis_rewrite": "",
"client_filter_ids": "",
"district": "Montreal",
"state_id": "11",
"country_id": "38",
"sms_autoreply_message": "",
"callerid_name_rewrite": "",
"confirm_media_file_id": "0",
"callerid_number_rewrite": "",
"client_sms_profile_id": "1234",
"sms_notify_email": "support@voicemeup.com",
"sms_forward_number": "5143127030",
"sms_callback_url": "http://www.voicemeup.com",
"bridge_uri": "2724881@vancouver6.voip.ms:5060",
"options": "enable_peer,enable_voicemail,enable_forwarding,enable_recording",
"voice_language": "",
"sms_supported": "0",
"mms_supported": "0",
"fax_supported": "1",
"ported_in": "1",
"special_attributes": "pattern_double_digits_pair",
"type": "local",
"usage_type": "default",
"client_channel_id": "0",
"client_subaccount_id": "0",
"notify_callback_url": "https://www.google.com",
"notify_callback_triggers": "on_create,on_hangup",
"simultaneous_calls_limit": "0",
"comments": "",
"datetime_created": "2012-11-09 14:08:04",
"datetime_updated": "2010-07-14 10:35:54",
"metadata": {
"raw_metadata": "a:3:{s:13:\"tout_le_monde\";s:8:\"en parle\";s:6:\"piment\";s:4:\"fort\";s:5:\"super\";s:3:\"man\";}",
"metadata_attributes": {
"attribute_count": "3",
"tout_le_monde": "en parle",
"piment": "fort",
"super": "man"
}
}
}
}
}<?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</mms_supported>
<fax_supported>1</fax_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
Request Type:
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.
| 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_callback_subtype | string | Optionally required | Comma-separated list of SMS event types that will trigger the callback. (default is null) Required if enable_sms_callback is set. Value must be one or more of the following: "inbound_success", "outbound_success", "outbound_failed", "delivered". |
| 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. |
| 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) |
| special_attributes | string | Optional | Value must be one of the following : "none", "temporary", "redemption", "inventory", "reserved". (default is "none") |
| comments | string | Optional | |
| status | enum | Optional | Value must be one of the following: "enabled" or "disabled" |
Delete DID
Request Type:
Delete a did from your account.
| 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 ) |
Sample response
Sample response for delete_did
{
...
"response_details": {
"server_name": "alphavirgo.hostmeup.com",
"response_delay": "0.35800981521606",
"response_status": "success",
"response_messages": {
"message": [
{
"type": "notice",
"code": "deleted_entry",
"_content": "12345"
},
{
"type": "notice",
"code": "cancellation_fees",
"_content": "4"
}
]
}
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<response_details>
<server_name>alphavirgo.hostmeup.com</server_name>
<response_delay>0.35800981521606</response_delay>
<response_status>success</response_status>
<response_messages>
<message type="notice" code="deleted_entry">
<![CDATA[ 12345 ]]>
</message>
<message type="notice" code="cancellation_fees">
<![CDATA[ 4 ]]>
</message>
</response_messages>
</response_details>
</response>
Get list of new DIDs
Request Type:
If you wish to get a list of DIDs in our inventory, you may request it with one of the following parameter.
| 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). |
| result_limit | integer | Optional | Value must be between 1 and 50 (default is 15) |
| result_offset | integer | Optional | Value must be a valid number (default is NULL) |
Sample response
Sample response for get_new_dids
{
...
"dids": {
"did_details": {
"did_id": "58",
"npa": "514",
"nxx": "777",
"ratecenter_id": "123456",
"phone_number": "5147778888",
"type": "local",
"country": "Canada",
"state": "Quebec",
"region": "Montreal",
"options": "rare_number,pattern_quadruple_digits",
"sms_support": "0",
"fax_support": "0",
"price_mrc": "3.75",
"price_nrc": "75",
"cancellation_fees": "4"
}
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<dids>
<did_details>
<did_id>58</did_id>
<npa>514</npa>
<nxx>777</nxx>
<ratecenter_id>123456</ratecenter_id>
<phone_number>5147778888</phone_number>
<type>local</type>
<country>Canada</country>
<state>Quebec</state>
<region>Montreal</region>
<options>rare_number,pattern_quadruple_digits</options>
<sms_support>0</sms_support>
<fax_support>0</fax_support>
<price_mrc>3.75</price_mrc>
<price_nrc>75</price_nrc>
<cancellation_fees>4</cancellation_fees>
</did_details>
</dids>
</response>
Activate new DID
Request Type:
Add the specified DID to your account.
| 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. |
Sample response
Sample response for activate_new_did
{
...
"did": {
"client_did_id": "10001",
"price_mrc": "3.75",
"price_nrc": "75",
"cancellation_fees": "4"
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<did>
<client_did_id>10001</client_did_id>
<price_mrc>3.75</price_mrc>
<price_nrc>75</price_nrc>
<cancellation_fees>4</cancellation_fees>
</did>
</response>
Order New DIDs
Request Type:
Request dids from a specific ratecenter or with a certain prefix that couldn't not be found in the inventory.
| 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: . (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. |
Get port requests
Request Type:
If you wish to get details of a port request, you simply have to pass the `port_request_id` or PON. If no additional parameter is specified, the complete list of port requests will be returned.
| 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) |
Sample response
Sample response for get_port_requests
{
...
"port_requests": {
"port_request": {
"port_request_id": "1000",
"client_subaccount_id": "1234",
"friendly_name": "My cellphone",
"phone_number_type": "local",
"phone_numbers": "15143127030",
"phone_numbers_to_keep": "",
"phone_numbers_to_cancel": "",
"features": "sms",
"capacity": "0",
"requested_date": "2019-01-04",
"tentative_date": "2019-01-04",
"firm_date": "2019-01-04",
"organization": "Internet Infinity",
"current_provider": "Bell",
"current_reseller": "",
"current_account": "101010110",
"box_number": "",
"civic_number": "1882",
"street": "BOUL Corbusier",
"unit_number": "201",
"city": "Laval",
"state_id": "11",
"country_id": "38",
"postal_code": "H7L 5R2",
"comments": "",
"instructions": "",
"ticket_id": "ABS-123-12345",
"notification_client_user_id": "1234",
"extra_recipients": "user1@domain1.con,user2@domain2.com",
"user_created": "1234",
"datetime_created": "2021-06-14 10:12:28",
"user_updated": "1234",
"datetime_updated": "2021-07-21 11:07:05",
"status": "completed",
"metadata": ""
}
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<port_requests>
<port_request>
<port_request_id>1000</port_request_id>
<client_subaccount_id>1234</client_subaccount_id>
<friendly_name>My cellphone</friendly_name>
<phone_number_type>local</phone_number_type>
<phone_numbers>15143127030</phone_numbers>
<phone_numbers_to_keep></phone_numbers_to_keep>
<phone_numbers_to_cancel></phone_numbers_to_cancel>
<features>sms</features>
<capacity>0</capacity>
<requested_date>2019-01-04</requested_date>
<tentative_date>2019-01-04</tentative_date>
<firm_date>2019-01-04</firm_date>
<organization>Internet Infinity</organization>
<current_provider>Bell</current_provider>
<current_reseller></current_reseller>
<current_account>101010110</current_account>
<box_number></box_number>
<civic_number>1882</civic_number>
<street>BOUL Corbusier</street>
<unit_number>201</unit_number>
<city>Laval</city>
<state_id>11</state_id>
<country_id>38</country_id>
<postal_code>H7L 5R2</postal_code>
<comments></comments>
<instructions></instructions>
<ticket_id>ABS-123-12345</ticket_id>
<notification_client_user_id>1234</notification_client_user_id>
<extra_recipients>user1@domain1.con,user2@domain2.com</extra_recipients>
<user_created>1234</user_created>
<datetime_created>2021-06-14 10:12:28</datetime_created>
<user_updated>1234</user_updated>
<datetime_updated>2021-07-21 11:07:05</datetime_updated>
<status>completed</status>
<metadata/>
</port_request>
</port_requests>
</response>
Update Port Request
Request Type:
You can update the port request with this request type.
| 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 |
Lookup DID
Request Type:
Lookup DID information.
Notice: Charges apply for this request type. Please contact your account manager for more details.| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| phone_number | digits[10-15] | Required | Value must be a valid phone_number. |
Sample response
Sample response for lookup_did
{
...
"lookup_result": {
"lookup_number": "15143127030",
"npa": "514",
"nxx": "312",
"subscriber": "7030",
"country_id": "38",
"country_code": "CA",
"state_id": "11",
"state_code": "PQ",
"region": "Montréal",
"exchange_id": "514312",
"ratecenter_id": "171610",
"current_carrier": {
"ocn": "083E",
"name": "Distributel"
},
"original_carrier": {
"ocn": "4727",
"name": "ISP Telecom"
}
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<lookup_result>
<lookup_number>15143127030</lookup_number>
<npa>514</npa>
<nxx>312</nxx>
<subscriber>7030</subscriber>
<country_id>38</country_id>
<country_code>CA</country_code>
<state_id>11</state_id>
<state_code>PQ</state_code>
<region>Montréal</region>
<exchange_id>514312</exchange_id>
<ratecenter_id>171610</ratecenter_id>
<current_carrier>
<ocn>083E</ocn>
<name>Distributel</name>
</current_carrier>
<original_carrier>
<ocn>4727</ocn>
<name>ISP Telecom</name>
</original_carrier>
</lookup_result>
</response>
Get list of DID area codes
Request Type:
This request type will provide information regarding available are codes. If you wish to get details about a specific area code, you may specify the `npa` parameter to do so.
| 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. |
Sample response
Sample response for get_did_areacodes
{
...
"did_areacodes": {
"did_areacode_details": {
"npa": "450",
"total_nxx": "570",
"country_id": "38",
"country_code": "CA",
"state_id": "11",
"state_code": "PQ"
}
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<did_areacodes>
<did_areacode_details>
<npa>450</npa>
<total_nxx>570</total_nxx>
<country_id>38</country_id>
<country_code>CA</country_code>
<state_id>11</state_id>
<state_code>PQ</state_code>
</did_areacode_details>
</did_areacodes>
</response>
Get list of DID exchanges
Request Type:
Get a list of available ratecenter exchanges by providing an area code or optionally a specific prefix. This is the request type to use if you wish to check the portability of availability of a ratecenter.
Note: This response is reference data that changes slowly. Store it locally, reuse your local data for lookups, and refresh your local copy about once a day.
| 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) |
Sample response
Sample response for get_did_exchanges
{
...
"did_exchanges": {
"did_exchange_details": {
"npa": "514",
"nxx": "750",
"country_id": "38",
"country_code": "CA",
"state_id": "11",
"state_code": "PQ",
"region": "Montreal",
"availability": "1",
"portability": "1",
"sms_supported": "1",
"fax_supported": "1",
"available_since": "2009-01-01",
"portable_since": "2009-01-01",
"sms_since": "2009-01-01",
"fax_since": "2009-01-01",
"stock": "0",
"exchange_id": "514750",
"ratecenter_id": "171610",
"updated_since": "2012-01-25",
"price_mrc": "3.75"
}
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<did_exchanges>
<did_exchange_details>
<npa>514</npa>
<nxx>750</nxx>
<country_id>38</country_id>
<country_code>CA</country_code>
<state_id>11</state_id>
<state_code>PQ</state_code>
<region>Montreal</region>
<availability>1</availability>
<portability>1</portability>
<sms_supported>1</sms_supported>
<fax_supported>1</fax_supported>
<available_since>2009-01-01</available_since>
<portable_since>2009-01-01</portable_since>
<sms_since>2009-01-01</sms_since>
<fax_since>2009-01-01</fax_since>
<stock>0</stock>
<exchange_id>514750</exchange_id>
<ratecenter_id>171610</ratecenter_id>
<updated_since>2012-01-25</updated_since>
<price_mrc>3.75</price_mrc>
</did_exchange_details>
</did_exchanges>
</response>
Get list of Ratecenters
Request Type:
Get a list of available ratecenters by providing an area code or optionally a specific prefix. This is the request type to use if you wish to check the origin of a call and details about the ratecenter.
Note: When only providing NPA, it is recommended to use a reasonable result_limit to avoid extraneous load.
| 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) |
Sample response
Sample response for get_ratecenters
{
...
"ratecenters": {
"ratecenter_details": {
"ratecenter_id": "170580",
"country_id": "38",
"country_code": "CA",
"state_id": "11",
"state_code": "PQ",
"region": "Ile-Perrot",
"availability": "1",
"portability": "1",
"available_since": "2009-01-01",
"portable_since": "2009-01-01",
"il_ocn": "8050",
"il_name": "BELL CANADA - QC",
"lata": "888",
"rcv": "4182",
"rch": "2018",
"latitude": "45.376352",
"longitude": "-73.922945",
"updated_since": "2011-02-05"
}
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<ratecenters>
<ratecenter_details>
<ratecenter_id>170580</ratecenter_id>
<country_id>38</country_id>
<country_code>CA</country_code>
<state_id>11</state_id>
<state_code>PQ</state_code>
<region>Ile-Perrot</region>
<availability>1</availability>
<portability>1</portability>
<available_since>2009-01-01</available_since>
<portable_since>2009-01-01</portable_since>
<il_ocn>8050</il_ocn>
<il_name>BELL CANADA - QC</il_name>
<lata>888</lata>
<rcv>4182</rcv>
<rch>2018</rch>
<latitude>45.376352</latitude>
<longitude>-73.922945</longitude>
<updated_since>2011-02-05</updated_since>
</ratecenter_details>
</ratecenters>
</response>
SMS
Get sms
Request Type:
If you have enabled sms on one of your DIDs, your sms will generate a new entry in the sms database and you will be able to retrieve it using this request type.
| 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) |
Sample response
Sample response for get_sms
{
...
"sms": {
"sms_details": {
"sms_log_id": "1429",
"client_subaccount_id": "1000",
"sms_hash": "a7f2d6c965ba9c43ea13d6fa91a26d2a",
"date": "2016-01-09",
"time": "17:15:40",
"direction": "outbound",
"source_number": "5145551234",
"destination_number": "5145551234",
"message": "This is a sample message",
"attachment": "http://www.google.com/picture.jpg",
"attachment_size": "0",
"nb_segment": "1",
"status": "enabled",
"transmission_status": "pending",
"datetime_transmission": "2016-01-09 17:15:40"
}
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<sms>
<sms_details>
<sms_log_id>1429</sms_log_id>
<client_subaccount_id>1000</client_subaccount_id>
<sms_hash>a7f2d6c965ba9c43ea13d6fa91a26d2a</sms_hash>
<date>2016-01-09</date>
<time>17:15:40</time>
<direction>outbound</direction>
<source_number>5145551234</source_number>
<destination_number>5145551234</destination_number>
<message>This is a sample message</message>
<attachment>http://www.google.com/picture.jpg</attachment>
<attachment_size>0</attachment_size>
<nb_segment>1</nb_segment>
<status>enabled</status>
<transmission_status>pending</transmission_status>
<datetime_transmission>2016-01-09 17:15:40</datetime_transmission>
</sms_details>
</sms>
</response>
Get SMS statistics
Request Type:
Gather statistical information about SMS and MMS for given period.
| 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) |
Sample response with no subaccount_ids specified.
Sample response with no subaccount_ids specified. for get_sms_stats_no_subaccount
{
...
"sms_stats": {
"account": {
"whole_account": {
"sms_inbound": {
"message_type": "sms_inbound",
"total_messages": "12345",
"total_segments": "44437",
"billed_amount": "5.24",
"length": "599"
},
"mms_outbound": {
"message_type": "mms_outbound",
"total_messages": "1",
"total_segments": "1",
"billed_amount": "0.02",
"bytes": "34"
},
"total": {
"message_type": "mms_outbound",
"total_messages": "12346",
"total_segments": "44438",
"billed_amount": "5.26",
"bytes": "34",
"length": "599"
}
},
"main_account": {
"sms_inbound": {
"message_type": "sms_inbound",
"total_messages": "12345",
"total_segments": "44437",
"billed_amount": "5.24",
"length": "599"
},
"mms_outbound": {
"message_type": "mms_outbound",
"total_messages": "1",
"total_segments": "1",
"billed_amount": "0.02",
"bytes": "34"
},
"total": {
"message_type": "mms_outbound",
"total_messages": "12346",
"total_segments": "44438",
"billed_amount": "5.26",
"bytes": "34",
"length": "599"
}
}
}
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<sms_stats>
<account>
<whole_account>
<sms_inbound>
<message_type>sms_inbound</message_type>
<total_messages>12345</total_messages>
<total_segments>44437</total_segments>
<billed_amount>5.24</billed_amount>
<length>599</length>
</sms_inbound>
...
<mms_outbound>
<message_type>mms_outbound</message_type>
<total_messages>1</total_messages>
<total_segments>1</total_segments>
<billed_amount>0.02</billed_amount>
<bytes>34</bytes>
</mms_outbound>
<total>
<message_type>mms_outbound</message_type>
<total_messages>12346</total_messages>
<total_segments>44438</total_segments>
<billed_amount>5.26</billed_amount>
<bytes>34</bytes>
<length>599</length>
</total>
</whole_account>
<main_account>
<sms_inbound>
<message_type>sms_inbound</message_type>
<total_messages>12345</total_messages>
<total_segments>44437</total_segments>
<billed_amount>5.24</billed_amount>
<length>599</length>
</sms_inbound>
...
<mms_outbound>
<message_type>mms_outbound</message_type>
<total_messages>1</total_messages>
<total_segments>1</total_segments>
<billed_amount>0.02</billed_amount>
<bytes>34</bytes>
</mms_outbound>
<total>
<message_type>mms_outbound</message_type>
<total_messages>12346</total_messages>
<total_segments>44438</total_segments>
<billed_amount>5.26</billed_amount>
<bytes>34</bytes>
<length>599</length>
</total>
</main_account>
</account>
</sms_stats>
</response>
Sample response with subaccount_ids specified.
Sample response with subaccount_ids specified. for get_sms_stats_subaccount
{
...
"sms_stats": {
"subaccounts": {
"subaccount": [
{
"client_subaccount_id": [
"123",
"123"
],
"sms_inbound": {
"message_type": "sms_inbound"
},
"mms_outbound": {
"message_type": "mms_outbound",
"total_messages": "1",
"total_segments": "1",
"billed_amount": "0.02",
"bytes": "34"
},
"total": {
"message_type": "mms_outbound",
"total_messages": "12346",
"total_segments": "44438",
"billed_amount": "5.26",
"bytes": "34",
"length": "599"
}
},
{
"client_subaccount_id": [
"321",
"321"
],
"sms_inbound": {
"message_type": "sms_inbound",
"total_messages": "12345",
"total_segments": "44437",
"billed_amount": "5.24",
"length": "599"
},
"mms_outbound": {
"message_type": "mms_outbound",
"total_messages": "1",
"total_segments": "1",
"billed_amount": "0.02",
"bytes": "34"
},
"total": {
"message_type": "mms_outbound",
"total_messages": "12346",
"total_segments": "44438",
"billed_amount": "5.26",
"bytes": "34",
"length": "599"
}
}
]
}
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<sms_stats>
<subaccounts>
<subaccount client_subaccount_id="123">
<client_subaccount_id>123</client_subaccount_id>
<sms_inbound>
<message_type>sms_inbound</message_type>
</sms_inbound>
...
<mms_outbound>
<message_type>mms_outbound</message_type>
<total_messages>1</total_messages>
<total_segments>1</total_segments>
<billed_amount>0.02</billed_amount>
<bytes>34</bytes>
</mms_outbound>
<total>
<message_type>mms_outbound</message_type>
<total_messages>12346</total_messages>
<total_segments>44438</total_segments>
<billed_amount>5.26</billed_amount>
<bytes>34</bytes>
<length>599</length>
</total>
</subaccount>
<subaccount client_subaccount_id="321">
<client_subaccount_id>321</client_subaccount_id>
<sms_inbound>
<message_type>sms_inbound</message_type>
<total_messages>12345</total_messages>
<total_segments>44437</total_segments>
<billed_amount>5.24</billed_amount>
<length>599</length>
</sms_inbound>
...
<mms_outbound>
<message_type>mms_outbound</message_type>
<total_messages>1</total_messages>
<total_segments>1</total_segments>
<billed_amount>0.02</billed_amount>
<bytes>34</bytes>
</mms_outbound>
<total>
<message_type>mms_outbound</message_type>
<total_messages>12346</total_messages>
<total_segments>44438</total_segments>
<billed_amount>5.26</billed_amount>
<bytes>34</bytes>
<length>599</length>
</total>
</subaccount>
</subaccounts>
</sms_stats>
</response>
Queue SMS
Request Type:
You can send a SMS with this request type. It is important to note that a DID with SMS support is required to use this feature. The endpoint supports both single and multi-recipient SMS queuing - pass destination_number as a string for single recipient or as an array for multiple recipients.
| 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] or array | Required | Single recipient: digits value must be a valid phone number. Multiple recipients: array of valid phone numbers (e.g., 55512345675559876543). When an array is provided, individual SMS messages are created for each recipient with per-recipient error tracking. |
| 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) |
| datetime_scheduled | datetime | Optional | Value must be a valid datetime (YYYY-MM-DD HH:II:SS). |
Sample response
Sample response for queue_sms
{
"response_messages": {
"message": [
{
"type": "notice",
"code": "queued_sms_id",
"_content": "100000"
},
{
"type": "notice",
"code": "queued_sms_hash",
"_content": "ABCDEF0123456789ABCDEF0123456789"
}
]
}
}<?xml version="1.0" encoding="utf-8"?>
<response_messages>
<message type="notice" code="queued_sms_id"><![CDATA[100000]]></message>
<message type="notice" code="queued_sms_hash"><![CDATA[ABCDEF0123456789ABCDEF0123456789]]>
</message>
</response_messages>
Sample response (Multi-Recipient)
Sample response (Multi-Recipient) for queue_sms_multi
{
"response_messages": {
"message": {
"type": "notice",
"code": "queued_message",
"_content": "<queued_messages>\n\t\t\t \t\t<message>\n\t\t\t \t\t\t<destination_number>5551234567</destination_number>\n\t\t\t \t\t\t<status>success</status>\n\t\t\t \t\t\t<id>100001</id>\n\t\t\t \t\t\t<hash>ABCDEF0123456789ABCDEF0123456789</hash>\n\t\t\t \t\t\t<error></error>\n\t\t\t \t\t\t<error_data></error_data>\n\t\t\t \t\t</message>\n\t\t\t \t\t<message>\n\t\t\t \t\t\t<destination_number>5559876543</destination_number>\n\t\t\t \t\t\t<status>success</status>\n\t\t\t \t\t\t<id>100002</id>\n\t\t\t \t\t\t<hash>FEDCBA9876543210FEDCBA9876543210</hash>\n\t\t\t \t\t\t<error></error>\n\t\t\t \t\t\t<error_data></error_data>\n\t\t\t \t\t</message>\n\t\t\t \t\t<message>\n\t\t\t \t\t\t<destination_number>invalid</destination_number>\n\t\t\t \t\t\t<status>error</status>\n\t\t\t \t\t\t<id></id>\n\t\t\t \t\t\t<hash></hash>\n\t\t\t \t\t\t<error>invalid_phone_number</error>\n\t\t\t \t\t\t<error_data>Phone number validation failed</error_data>\n\t\t\t \t\t</message>\n\t\t\t \t</queued_messages>"
}
}
}<?xml version="1.0" encoding="utf-8"?>
<response_messages>
<message type="notice" code="queued_message"><![CDATA[
<queued_messages>
<message>
<destination_number>5551234567</destination_number>
<status>success</status>
<id>100001</id>
<hash>ABCDEF0123456789ABCDEF0123456789</hash>
<error></error>
<error_data></error_data>
</message>
<message>
<destination_number>5559876543</destination_number>
<status>success</status>
<id>100002</id>
<hash>FEDCBA9876543210FEDCBA9876543210</hash>
<error></error>
<error_data></error_data>
</message>
<message>
<destination_number>invalid</destination_number>
<status>error</status>
<id></id>
<hash></hash>
<error>invalid_phone_number</error>
<error_data>Phone number validation failed</error_data>
</message>
</queued_messages>
]]></message>
</response_messages>
Get SMS profiles
Request Type:
If you wish to get details of a sms profile, you simply have to pass the `client_sms_profile_id`. If no additional parameter is specified, the complete list of sms profiles will be returned.
| 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) |
Sample response
Sample response for get_sms_profiles
{
...
"sms_profiles": {
"sms_profile_details": {
"client_sms_profile_id": "1001",
"client_account_id": "1001",
"client_subaccount_id": "1001",
"friendly_name": "Default",
"language": "",
"allowed_senders": "*@getinfinity.com,*@voicemeup.com",
"notify_name": "Internet Infinity",
"notify_email": "noreply@getinfinity.com",
"forward_number": "5555555555",
"callback_url": "",
"backup_url": "",
"autoreply_message": "",
"client_did_id": "1001",
"options": "",
"status": "enabled",
"metadata": ""
}
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<sms_profiles>
<sms_profile_details>
<client_sms_profile_id>1001</client_sms_profile_id>
<client_account_id>1001</client_account_id>
<client_subaccount_id>1001</client_subaccount_id>
<friendly_name>Default</friendly_name>
<language/>
<allowed_senders>*@getinfinity.com,*@voicemeup.com</allowed_senders>
<notify_name>Internet Infinity</notify_name>
<notify_email>noreply@getinfinity.com</notify_email>
<forward_number>5555555555</forward_number>
<callback_url/>
<backup_url/>
<autoreply_message/>
<client_did_id>1001</client_did_id>
<options/>
<status>enabled</status>
<metadata/>
</sms_profile_details>
</sms_profiles>
</response>
Update SMS profile
Request Type:
Allows you to create or simply update a SMS profile.
| 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. |
| callback_subtype | string | Optionally required | Comma-separated list of SMS event types that will trigger the callback. Required if option "enable_callback" is selected. Value must be one or more of the following: "inbound_success", "outbound_success", "outbound_failed", "delivered". |
| 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 |
Peers & channels
Get Peers details
Request Type:
If you wish to get details of a specific peer, you simply have to pass the `client_peer_id`. If no additional parameter is specified, the complete list of peers will be returned.
| 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) |
Sample response
Sample response for get_peers
{
...
"peers": {
"peer_details": {
"client_peer_id": "116",
"protocole": "SIP",
"username": "test",
"friendly_name": "Test",
"host_usage": "dynamic",
"host_type": "dynamic",
"host": "",
"port": "0",
"proxy_id": "15",
"transport": "udp",
"codecs": "g729,ulaw",
"callerid_name": "Caller Name",
"callerid_number": "4502223333",
"callerid_type": "rpid",
"callerid_format": "e164",
"internal_cid_mode": "custom",
"internal_cid_name": "Debug",
"internal_cid_number": "9999",
"dtmf_mode": "rfc2833",
"enable_nat": "1",
"enable_reinvite": "0",
"dnis_mode": "auto",
"dnis_format": "e164",
"e911": "blocked",
"client_channel_id": "0",
"client_subaccount_id": "0",
"options": "enable_nat,force_ring_signal,enable_notify_callback",
"notify_callback_url": "https://www.google.com",
"notify_callback_triggers": "on_ring,on_hangup",
"client_callerid_profile_id": "1000",
"simultaneous_calls_limit": "0",
"status": "enabled",
"comments": "",
"datetime_registered": "N/A"
}
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<peers>
<peer_details>
<client_peer_id>116</client_peer_id>
<protocole>SIP</protocole>
<username>test</username>
<friendly_name>Test</friendly_name>
<host_usage>dynamic</host_usage>
<host_type>dynamic</host_type>
<host/>
<port>0</port>
<proxy_id>15</proxy_id>
<transport>udp</transport>
<codecs>g729,ulaw</codecs>
<callerid_name>Caller Name</callerid_name>
<callerid_number>4502223333</callerid_number>
<callerid_type>rpid</callerid_type>
<callerid_format>e164</callerid_format>
<internal_cid_mode>custom</internal_cid_mode>
<internal_cid_name>Debug</internal_cid_name>
<internal_cid_number>9999</internal_cid_number>
<dtmf_mode>rfc2833</dtmf_mode>
<enable_nat>1</enable_nat>
<enable_reinvite>0</enable_reinvite>
<dnis_mode>auto</dnis_mode>
<dnis_format>e164</dnis_format>
<e911>blocked</e911>
<client_channel_id>0</client_channel_id>
<client_subaccount_id>0</client_subaccount_id>
<options>enable_nat,force_ring_signal,enable_notify_callback</options>
<notify_callback_url>https://www.google.com</notify_callback_url>
<notify_callback_triggers>on_ring,on_hangup</notify_callback_triggers>
<client_callerid_profile_id>1000</client_callerid_profile_id>
<simultaneous_calls_limit>0</simultaneous_calls_limit>
<status>enabled</status>
<comments></comments>
<datetime_registered>N/A</datetime_registered>
</peer_details>
</peers>
</response>
Update Peer
Request Type:
You can update the configuration of a peer with this request type.
Note: Not all the option for peers are available through the API. Please request any new feature to our support department.
| 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 |
| 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_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", "disable_t38", "enable_identity_passthrough", "enable_rtcp". (default is NULL) |
| status | string | Optionally Required | Required on mode update. Value must be one of the following: "enabled" or "disabled" |
| comments | string | Optional |
Get channels details
Request Type:
Get the full list of channels or you can get a single entry by providing `client_channel_id`. System row represent all channels the account possess throught plans and services.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| client_channel_id | integer | Optional | Value must be a valid client_channel_id. (default is NULL) |
Sample response
Sample response for get_channels
{
...
"channels": {
"channel_details": {
"client_channel_id": "159",
"friendly_name": "Client 18",
"quantity_inbound": "5",
"quantity_outbound": "0",
"quantity_bidirectional": "0",
"date_activated": "2016-11-29",
"minimum_cancellation_date": "2016-12-04",
"datetime_updated": "2016-11-28 15:06:30",
"user_updated": "10"
}
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<channels>
<channel_details>
<client_channel_id>159</client_channel_id>
<friendly_name>Client 18</friendly_name>
<quantity_inbound>5</quantity_inbound>
<quantity_outbound>0</quantity_outbound>
<quantity_bidirectional>0</quantity_bidirectional>
<date_activated>2016-11-29</date_activated>
<minimum_cancellation_date>2016-12-04</minimum_cancellation_date>
<datetime_updated>2016-11-28 15:06:30</datetime_updated>
<user_updated>10</user_updated>
</channel_details>
</channels>
</response>
Update Channel
Request Type:
This request type allows you to create a new channel or update configuration of an existing channel.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| mode | string | Optional | Value must be "update" or "create". (default is update) |
| client_channel_id | integer | Optionally required | If mode is "update", value must be a valid client_channel_id |
| friendly_name | string | Required | Value must be alphanumeric string from 2 to 32 characters. |
| quantity_inbound | integer | Required | Value must be a number between 0 and 999 (inclusively). |
| quantity_outbound | integer | Required | Value must be a number between 0 and 999 (inclusively). |
| quantity_bidirectional | integer | Required | Value must be a number between 0 and 999 (inclusively). |
Delete channel
Request Type:
Delete a channel group from your account.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| client_channel_id | integer | Required | Value must be a valid client_channel_id. |
Call routing & caller ID
Get call director profiles
Request Type:
If you wish to get details of a call director profile, you simply have to pass the `client_director_profile_id`. If no additional parameter is specified, the complete list of peers will be returned.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| client_director_profile_id | integer | Optional | Value must be a valid client_director_profile_id. (default is NULL) |
| client_subaccount_id | integer | Optional | Value must be a valid client_subaccount_id. (default is NULL) |
Sample response
Sample response for get_call_director_profiles
{
...
"call_director_profiles": {
"call_director_details": {
"client_director_profile_id": "10",
"client_subaccount_id": "123",
"friendly_name": "Hunt for Francois",
"status": [
"enabled",
"enabled"
],
"comments": "",
"actions": {
"action": [
{
"usage_type": "forward",
"forward_number": "5555555555",
"announce_media_file_id": "0",
"confirm_media_file_id": "0",
"send_dtmf": "W123#",
"options": "confirm_required",
"offset": "15",
"duration": "15",
"comments": "0"
},
{
"usage_type": "peer",
"client_peer_id": "1001",
"offset": "0",
"duration": "15",
"comments": "0"
},
{
"usage_type": "sip_uri",
"sip_uri": "root@8.8.8.8",
"offset": "0",
"duration": "15",
"comments": "0"
}
]
}
}
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<call_director_profiles>
<call_director_details>
<client_director_profile_id>10</client_director_profile_id>
<client_subaccount_id>123</client_subaccount_id>
<friendly_name>Hunt for Francois</friendly_name>
<status>enabled</status>
<comments/>
<status>enabled</status>
<actions>
<action>
<usage_type>forward</usage_type>
<forward_number>5555555555</forward_number>
<announce_media_file_id>0</announce_media_file_id>
<confirm_media_file_id>0</confirm_media_file_id>
<send_dtmf>W123#</send_dtmf>
<options>confirm_required</options>
<offset>15</offset>
<duration>15</duration>
<comments>0</comments>
</action>
<action>
<usage_type>peer</usage_type>
<client_peer_id>1001</client_peer_id>
<offset>0</offset>
<duration>15</duration>
<comments>0</comments>
</action>
<action>
<usage_type>sip_uri</usage_type>
<sip_uri>root@8.8.8.8</sip_uri>
<offset>0</offset>
<duration>15</duration>
<comments>0</comments>
</action>
</actions>
</call_director_details>
</call_director_profiles>
</response>
Update Call director profile
Request Type:
Allows you to create or simply update a Call director profile.
| 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_director_profile_id | integer | Optionally required | If mode is "update", value must be a valid client_director_profile_id |
| client_subaccount_id | integer | Optional | Value must be a valid client_subaccount_id |
| friendly_name | string | Required | Value must be alphanumeric string from 2 to 32 characters. |
| action | array | At least 1 required | Ordered list of routing steps for the profile. Each index is one step (action[0], action[1], ?). See action array parameters and Providing action data below. |
| status | string | Optional | Value must be one of the following: "enabled" or "disabled" |
| comments | string | Optional |
action array parameters
These fields are submitted on each action[n] entry (form fields) or as objects inside the action JSON array.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| usage_type | string | Required | Value must be one of the following: 'forward', 'peer', 'sip_uri' |
| offset | integer | Required | When to start this action (in seconds). Must be between 0 and 115 and an increment of 5. |
| duration | integer | Required | How long to take this action (in seconds). Max total 120. Must be betweeb 5 and 120. |
| client_peer_id | integer | Optionally required | Required if usage_type is 'peer'. Must be a valid client_peer_id |
| forward_number | digits | Optionally required | Required if usage_type is 'forward'. Must be a valid phone number. |
| sip_uri | string | Optionally required | Required if usage_type is 'sip_uri'. Must be a valid SIP uri. |
| announce_media_file_id | integer | Optionally required | Only used for usage_type 'forward'. Required if announce_caller is set. Must be between a valid announce_media_file_id. |
| send_dtmf | string | Optional | Only used for usage_type 'forward'. Must be valid DTMF tones (0-9,a,b,c,d,w and W). |
| confirm_media_file_id | integer | Optional | Only used for usage_type 'forward'. 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. |
| options | Array | Optional | Only used for usage_type 'forward'. Value must be one or more of the following : "confirm_required", "announce_caller" (default is NULL). |
| comments | string | Optional |
Providing action data
Use POST for profiles with multiple steps. Send other top-level fields (mode, friendly_name, ?) in the same request. The cURL sample uses application/x-www-form-urlencoded; the JSON sample uses application/json.
Sample request body
Sample request body for update_call_director_profile
curl -sS -X POST 'https://clients.voicemeup.com/api/v1.1/json/update_call_director_profile' \
-H 'Authorization: Bearer REDACTED' \
-H 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'mode=update' \
--data-urlencode 'friendly_name=Main profile' \
--data-urlencode 'action[0][usage_type]=forward' \
--data-urlencode 'action[0][forward_number]=5145555555' \
--data-urlencode 'action[0][offset]=0' \
--data-urlencode 'action[0][duration]=60' \
--data-urlencode 'action[1][usage_type]=peer' \
--data-urlencode 'action[1][client_peer_id]=12345' \
--data-urlencode 'action[1][offset]=60' \
--data-urlencode 'action[1][duration]=60'{
"mode": "update",
"client_director_profile_id": "12345",
"friendly_name": "Main profile",
"action": [
{
"usage_type": "forward",
"forward_number": "5145555555",
"offset": "0",
"duration": "60"
},
{
"usage_type": "peer",
"client_peer_id": "12345",
"offset": "60",
"duration": "60"
}
]
}
Delete Call Director Profile
Request Type:
Delete a Call Director Profile from your account.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| client_director_profile_id | integer | Required | Value must be a valid client_director_profile_id. |
Get Callerid Profiles Details
Request Type:
If you wish to get details of a specific callerid_profile, you simply have to pass the `client_callerid_profile_id`. If no additional parameter is specified, the complete list of callerid_profiles will be returned.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| client_callerid_profile_id | integer | Optional | Value must be a valid client_callerid_profile_id. (default is NULL) |
| client_subaccount_id | integer | Optional | Value must be a valid client_subaccount_id. (default is NULL) |
Sample response
Sample response for get_callerid_profiles
{
...
"callerid_profiles": {
"callerid_profile_details": {
"client_callerid_profile_id": "1080",
"client_account_id": "3",
"client_subaccount_id": "2",
"friendly_name": "Cats are awesome",
"callerid_name": "Cats",
"client_did_ids": "",
"default_client_did_id": "28676",
"callerid_number": "14387932640",
"privacy": "disable",
"status": "enabled",
"comments": "",
"date_activated": "2018-06-01",
"date_cancelled": "0000-00-00",
"user_created": "1003",
"user_updated": "8925",
"datetime_created": "2018-06-01 13:57:16",
"datetime_updated": "2021-09-17 15:27:28",
"conditions_data": [
{
"client_callerid_profile_data_id": "274",
"client_callerid_profile_id": "1080",
"callerid_name": "5143127030",
"client_did_id": "51486",
"callerid_number": "14388585010",
"privacy": "keep",
"callerid_ratecenter_id": "171610",
"callerid_latitude": "45.502395",
"callerid_longitude": "-73.567681",
"country_id": "0",
"state_id": "0",
"ratecenter_id": "000000",
"radius_distance": "10",
"source_number": "5143127032",
"source_regexp": "",
"destination_number": "",
"destination_regexp": null,
"match_methods": "source_number_match",
"order_index": "0",
"comments": ""
},
{
"client_callerid_profile_data_id": "273",
"client_callerid_profile_id": "1080",
"callerid_name": "Croissant Fax N",
"client_did_id": "28676",
"callerid_number": "14387932640",
"privacy": "enable",
"callerid_ratecenter_id": "171610",
"callerid_latitude": "45.502395",
"callerid_longitude": "-73.567681",
"country_id": "0",
"state_id": "0",
"ratecenter_id": "000000",
"radius_distance": "10",
"source_number": "",
"source_regexp": "banane",
"destination_number": "",
"destination_regexp": null,
"match_methods": "source_regexp",
"order_index": "2",
"comments": "Croissant are good"
}
]
}
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<callerid_profiles>
<callerid_profile_details>
<client_callerid_profile_id>1080</client_callerid_profile_id>
<client_account_id>3</client_account_id>
<client_subaccount_id>2</client_subaccount_id>
<friendly_name>Cats are awesome</friendly_name>
<callerid_name>Cats</callerid_name>
<client_did_ids/>
<default_client_did_id>28676</default_client_did_id>
<callerid_number>14387932640</callerid_number>
<privacy>disable</privacy>
<status>enabled</status>
<comments/>
<date_activated>2018-06-01</date_activated>
<date_cancelled>0000-00-00</date_cancelled>
<user_created>1003</user_created>
<user_updated>8925</user_updated>
<datetime_created>2018-06-01 13:57:16</datetime_created>
<datetime_updated>2021-09-17 15:27:28</datetime_updated>
<conditions_data>
[
{
"client_callerid_profile_data_id": "274",
"client_callerid_profile_id": "1080",
"callerid_name": "5143127030",
"client_did_id": "51486",
"callerid_number": "14388585010",
"privacy": "keep",
"callerid_ratecenter_id": "171610",
"callerid_latitude": "45.502395",
"callerid_longitude": "-73.567681",
"country_id": "0",
"state_id": "0",
"ratecenter_id": "000000",
"radius_distance": "10",
"source_number": "5143127032",
"source_regexp": "",
"destination_number": "",
"destination_regexp": null,
"match_methods": "source_number_match",
"order_index": "0",
"comments":""
},
{
"client_callerid_profile_data_id": "273",
"client_callerid_profile_id": "1080",
"callerid_name": "Croissant Fax N",
"client_did_id": "28676",
"callerid_number": "14387932640",
"privacy": "enable",
"callerid_ratecenter_id": "171610",
"callerid_latitude": "45.502395",
"callerid_longitude": "-73.567681",
"country_id": "0",
"state_id": "0",
"ratecenter_id": "000000",
"radius_distance": "10",
"source_number": "",
"source_regexp": "banane",
"destination_number": "",
"destination_regexp": null,
"match_methods": "source_regexp",
"order_index": "2",
"comments":"Croissant are good"
}
]
</conditions_data>
</callerid_profile_details>
</callerid_profiles>
</response>
Update Callerid Profile
Request Type:
You can update the configuration of a callerid_profile with this request type.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| mode | string | Optional | Value must be "update" or "create". (default is update) |
| client_callerid_profile_id | integer | Optionally required | If mode is "update", value must be a valid client_callerid_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. |
| callerid_name | string | Optional | Value must be alphanumeric string from 2 to 15 characters. |
| client_did_ids | enum | Optional | Value(s) must be valid client_did_id(s) (comma separated). |
| default_client_did_id | integer | Optional | Value must be a valid client_did_id. |
| callerid_number | integer | Optional | Value must be a valid phone number of 10 digits. |
| privacy | integer | Optional | Value must be one of the following: "enable", "keep" or "disable" |
| status | string | Required | Value must be one of the following: "enabled" or "disabled" |
| comments | string | Optional | |
| purge_conditions | integer | Optional | If value is set to 1 it will remove all the callerid profile datas not listed in the conditions_data |
| conditions_data | JSON | Optional | Array of matching rules for the profile. Each entry defines one condition. See conditions_data array parameters and Providing conditions_data below. |
conditions_data array parameters
These fields are submitted on each condition object in the conditions_data array.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| client_callerid_profile_data_id | integer | Optionally required | Value used to edit an existing condition. Must be a valid client_callerid_profile_data_id. |
| callerid_name | string | Optional | If added will use the callerid_name provided as the callerId name. |
| client_did_id | integer | Optional | If added will use the client_did_id provided as the callerId number. |
| callerid_number | integer | Optional | If added will use the callerid_number provided as the callerId number. |
| privacy | enum | Optional | Value must be one of the following: "enable", "keep" or "disable". Default is "keep". |
| country_id | integer | Optional | Value must be a valid country_id. |
| state_id | integer | Optional | Value must be a valid state_id. |
| ratecenter_id | integer | Optional | Value must be a valid ratecenter_id. |
| radius_distance | integer | Optional | Value is a distance in km between 10 and 1000. |
| source_number | integer | Optional | Value must be between 1 and 10 digits. |
| source_regexp | string | Optional | Value must be a valid regexp. |
| destination_number | integer | Optional | Value must be between 1 and 10 digits. |
| destination_regexp | string | Optional | Value must be a valid regexp. |
| match_methods | enum | Optional | Value must be one (or more, comma separated) of the following: "local_to_destination", "radius_from_destination", "source_number_match", "destination_number_match", "region", "source_regexp" or "destination_regexp". |
| order_index | integer | Optional | Value used to set the priority of the condition. |
| comments | string | Optional |
Providing conditions_data
Use POST when updating conditions. Send profile fields (mode, friendly_name, status, ?) in the same request. The cURL sample passes conditions_data as a form field; the JSON sample uses a native array.
Sample request body
Sample request body for update_callerid_profile
curl -sS -X POST 'https://clients.voicemeup.com/api/v1.1/json/update_callerid_profile' \
-H 'Authorization: Bearer REDACTED' \
-H 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'mode=update' \
--data-urlencode 'client_callerid_profile_id=1080' \
--data-urlencode 'friendly_name=Office' \
--data-urlencode 'status=enabled' \
--data-urlencode 'conditions_data=[{"client_callerid_profile_data_id":"1234","callerid_name":"NewName"},{"callerid_name":"NewCondition","client_did_id":"12345"}]'{
"mode": "update",
"client_callerid_profile_id": "1080",
"friendly_name": "Office",
"status": "enabled",
"conditions_data": [
{
"client_callerid_profile_data_id": "1234",
"callerid_name": "NewName"
},
{
"callerid_name": "NewCondition",
"client_did_id": "12345"
}
]
}
Voicemail & mailboxes
Get voice mailboxes details
Request Type:
Get details for a single voice mailbox or the entire list by omitting the `client_mailbox_id`.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| client_mailbox_id | integer | Optional | Value must be a valid client_mailbox_id. (default is NULL) |
Sample response
Sample response for get_mailboxes
{
...
"mailboxes": {
"mailbox_details": {
"client_mailbox_id": "15",
"client_subaccount_id": "1010",
"friendly_name": "General",
"passcode": "4567",
"enable_peer_notification": "1",
"notification_peers": "175,172,178",
"notification_duration": "5",
"enable_mail_notification": "1",
"notification_email": "user@domain.com"
}
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<mailboxes>
<mailbox_details>
<client_mailbox_id>15</client_mailbox_id>
<client_subaccount_id>1010</client_subaccount_id>
<friendly_name>General</friendly_name>
<passcode>4567</passcode>
<enable_peer_notification>1</enable_peer_notification>
<notification_peers>175,172,178</notification_peers>
<notification_duration>5</notification_duration>
<enable_mail_notification>1</enable_mail_notification>
<notification_email>user@domain.com</notification_email>
</mailbox_details>
</mailboxes>
</response>
Update Mailbox
Request Type:
Allows you to create or simply update a mailbox.
| 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. |
| 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 |
Get Text-to-Speech voice name
Request Type:
Get all available Text-to-Speech (TTS) voice names available
Sample response
Sample response for get_tts_voice_name
{
...
"voices": {
"voice_details": [
{
"voice_name": "fr-CA-Standard-A",
"language": "fr-CA",
"gender": "FEMALE"
},
{
"voice_name": "fr-CA-Standard-B",
"language": "fr-CA",
"gender": "MALE"
},
{
"voice_name": "fr-CA-Standard-C",
"language": "fr-CA",
"gender": "FEMALE"
}
]
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<voices>
<voice_details>
<voice_name>fr-CA-Standard-A</voice_name>
<language>fr-CA</language>
<gender>FEMALE</gender>
</voice_details>
<voice_details>
<voice_name>fr-CA-Standard-B</voice_name>
<language>fr-CA</language>
<gender>MALE</gender>
</voice_details>
<voice_details>
<voice_name>fr-CA-Standard-C</voice_name>
<language>fr-CA</language>
<gender>FEMALE</gender>
</voice_details>
...
</voices>
</response>
Update Mailbox Greeting
Request Type:
Allows you to create or simply update a mailbox greeting's. It is important to note that this is a POST request.
| 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. |
Extensions
Get extensions details
Request Type:
Get the full list of extensions or you can get a single entry by providing `client_extension_id`.
| 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) |
Sample response
Sample response for get_extensions
{
...
"extensions": {
"extension_details": {
"client_account_id": "80012312",
"client_subaccount_id": "0",
"friendly_name": "Friendly Name",
"client_extension_id": "38",
"extension": "1233",
"enable_peer": "1",
"peers_to_ring": "176,116",
"peer_timeout": "disabled",
"client_queue_ids": "1001,1002,1004",
"enable_forwarding": "1",
"forward_number": "4501234567",
"forward_timeout": "50",
"enable_voicemail": "0",
"announce_media_file_id": "500",
"confirm_media_file_id": "502",
"send_dtmf": "w1W143",
"voice_language": "fr",
"options": "announce_caller",
"destination_mailbox": "1127"
}
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<extensions>
<extension_details>
<client_account_id>80012312</client_account_id>
<client_subaccount_id>0</client_subaccount_id>
<friendly_name>Friendly Name</friendly_name>
<client_extension_id>38</client_extension_id>
<extension>1233</extension>
<enable_peer>1</enable_peer>
<peers_to_ring>176,116</peers_to_ring>
<peer_timeout>disabled</peer_timeout>
<client_queue_ids>1001,1002,1004</client_queue_ids>
<enable_forwarding>1</enable_forwarding>
<forward_number>4501234567</forward_number>
<forward_timeout>50</forward_timeout>
<enable_voicemail>0</enable_voicemail>
<announce_media_file_id>500</announce_media_file_id>
<confirm_media_file_id>502</confirm_media_file_id>
<send_dtmf>w1W143</send_dtmf>
<voice_language>fr</voice_language>
<options>announce_caller</options>
<destination_mailbox>1127</destination_mailbox>
</extension_details>
</extensions>
</response>
Update Extension
Request Type:
This request type allows you to create a new extension or update configuration of an existing extension.
| 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) |
| 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 |
Queues
Get queues details
Request Type:
If you wish to get details of a specific queue, you simply have to pass the `client_queue_id`. If no additional parameter is specified, the complete list of queues will be returned.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| client_queue_id | integer | Optional | Value must be a valid client_queue_id. (default is NULL) |
| client_subaccount_id | integer | Optional | Value must be a valid client_subaccount_id. (default is NULL) |
Sample response
Sample response for get_queues
{
...
"queues": {
"queue_details": {
"client_queue_id": "1000",
"client_account_id": "123",
"client_subaccount_id": "0",
"friendly_name": "I am a queue",
"comments": "",
"strategy": "round-robin",
"agents_data": "",
"client_moh_profile_id": "0",
"max_wait_time": "300",
"max_wait_time_no_agent": "90",
"progressive_ring_delay": "200",
"discard_abandoned_delay": "900",
"max_no_agent": "0",
"tier_escalate_delay": "120",
"datetime_suspended_until": "0000-00-00 00:00:00",
"options": "",
"status": "enabled",
"date_activated": "2021-05-14",
"date_cancelled": "0000-00-00",
"user_created": "3",
"user_updated": "3",
"datetime_created": "2021-05-14 13:12:40",
"datetime_updated": "2021-05-14 13:21:10",
"datetime_synched": "0000-00-00 00:00:00",
"agents": "1022"
}
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<queues>
<queue_details>
<client_queue_id>1000</client_queue_id>
<client_account_id>123</client_account_id>
<client_subaccount_id>0</client_subaccount_id>
<friendly_name>I am a queue</friendly_name>
<comments/>
<strategy>round-robin</strategy>
<agents_data/>
<client_moh_profile_id>0</client_moh_profile_id>
<max_wait_time>300</max_wait_time>
<max_wait_time_no_agent>90</max_wait_time_no_agent>
<progressive_ring_delay>200</progressive_ring_delay>
<discard_abandoned_delay>900</discard_abandoned_delay>
<max_no_agent>0</max_no_agent>
<tier_escalate_delay>120</tier_escalate_delay>
<datetime_suspended_until>0000-00-00 00:00:00</datetime_suspended_until>
<options/>
<status>enabled</status>
<date_activated>2021-05-14</date_activated>
<date_cancelled>0000-00-00</date_cancelled>
<user_created>3</user_created>
<user_updated>3</user_updated>
<datetime_created>2021-05-14 13:12:40</datetime_created>
<datetime_updated>2021-05-14 13:21:10</datetime_updated>
<datetime_synched>0000-00-00 00:00:00</datetime_synched>
<agents>1022</agents>
</queue_details>
</queues>
</response>
Update Queue
Request Type:
You can update the configuration of a queue with this request type.
Note: Not all the option for queues are available through the API. Please request any new feature to our support department.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| mode | string | Optional | Value must be "update" or "create". (default is update) |
| client_queue_id | integer | Optionally required | If mode is "update", value must be a valid client_queue_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 60 characters. |
| comments | string | Optional | |
| client_moh_profile_id | integer | Optional | Value must be a valid client_moh_profile_id. (default is 0) |
| max_wait_time | integer | Optional | Value must be between 10 and 7200. (default is 300) |
| max_wait_time_no_agent | integer | Optional | Value must be between 30 and 600. (default is 90) |
| progressive_ring_delay | integer | Optional | Value must be between 5 and 300. (default is 10) |
| discard_abandoned_delay | integer | Optional | Value must be between 300 and 86400. (default is 900) |
| max_no_agent | integer | Optional | Value must be between 0 and 99. (default is 0) |
| tier_escalate_delay | integer | Optional | Value must be between 30 and 3600. (default is 120) |
| datetime_suspended_until | string | Optional | Value must be a valid datetime in format 'yyyy-mm-dd H:i:s' (default is 0000-00-00 00:00:00) |
| agents | string | Optional | Value must be a list of agent ids comma seperated. |
| options | string | Optional | Value must be any of the following comma seperated: "enable_resume_abandoned", "enable_tiers_escalation", "enable_escalate_no_agent" or "enable_escalate_multiply_delay" |
| status | string | Optional | Value must be one of the following: "enabled" or "disabled" |
Get queue agents details
Request Type:
If you wish to get details of a specific queue agent, you simply have to pass the `client_queue_agent_id`. If no additional parameter is specified, the complete list of queue agents will be returned.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| client_queue_agent_id | integer | Optional | Value must be a valid client_queue_agent_id. (default is NULL) |
| client_subaccount_id | integer | Optional | Value must be a valid client_subaccount_id. (default is NULL) |
Sample response
Sample response for get_queue_agents
{
...
"queue_agents": {
"queue_agent_details": {
"client_queue_agent_id": "1016",
"client_account_id": "3",
"client_subaccount_id": "2",
"client_peer_id": "13204",
"client_director_profile_id": "0",
"friendly_name": "jimenez",
"comments": "",
"ring_delay": "10",
"wrap_up_delay": "15",
"on_busy_delay": "120",
"on_reject_delay": "300",
"on_unanswered_delay": "30",
"max_unanswered": "0",
"status": "enabled",
"date_activated": "2020-03-18",
"date_cancelled": "0000-00-00",
"user_created": "1007",
"user_updated": "8925",
"datetime_created": "2020-03-18 09:18:49",
"datetime_updated": "2021-05-07 12:50:43",
"datetime_synched": "2021-05-28 13:58:49",
"queue_status": "offline"
}
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<queue_agents>
<queue_agent_details>
<client_queue_agent_id>1016</client_queue_agent_id>
<client_account_id>3</client_account_id>
<client_subaccount_id>2</client_subaccount_id>
<client_peer_id>13204</client_peer_id>
<client_director_profile_id>0</client_director_profile_id>
<friendly_name>jimenez</friendly_name>
<comments/>
<ring_delay>10</ring_delay>
<wrap_up_delay>15</wrap_up_delay>
<on_busy_delay>120</on_busy_delay>
<on_reject_delay>300</on_reject_delay>
<on_unanswered_delay>30</on_unanswered_delay>
<max_unanswered>0</max_unanswered>
<status>enabled</status>
<date_activated>2020-03-18</date_activated>
<date_cancelled>0000-00-00</date_cancelled>
<user_created>1007</user_created>
<user_updated>8925</user_updated>
<datetime_created>2020-03-18 09:18:49</datetime_created>
<datetime_updated>2021-05-07 12:50:43</datetime_updated>
<datetime_synched>2021-05-28 13:58:49</datetime_synched>
<queue_status>offline</queue_status>
</queue_agent_details>
</queue_agents>
</response>
Update Queue Agent
Request Type:
You can update the configuration of a queue agent with this request type.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| mode | string | Optional | Value must be "update" or "create". (default is update) |
| client_queue_agent_id | integer | Optionally required | If mode is "update", value must be a valid client_queue_agent_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 60 characters. |
| comments | string | Optional | |
| client_peer_id | integer | Optional | Value must be a valid client_peer_id. (default is 0) |
| client_director_profile_id | integer | Optional | Value must be a valid client_director_profile_id. (default is 0) |
| client_schedule_id | integer | Optional | Value must be a valid client_schedule_id. (default is NULL) |
| ring_delay | integer | Optional | Value must be between 5 and 120. (default is 10) |
| wrap_up_delay | integer | Optional | Value must be between 0 and 600. (default is 15) |
| on_busy_delay | integer | Optional | Value must be between 0 and 3600. (default is 120) |
| on_reject_delay | integer | Optional | Value must be between 0 and 3600. (default is 300) |
| on_unanswered_delay | integer | Optional | Value must be between 0 and 3600. (default is 30) |
| max_unanswered | integer | Optional | Value must be between 0 and 99. (default is 0) |
| agent_status | string | Optional | Availability of the agent in the queue system. Value must be one of the following: "online" , "offline" , "break"or "automatic" (default is null) |
| status | string | Optional | Value must be one of the following: "enabled" or "disabled" |
IVR
Get IVR profiles details
Request Type:
If you wish to get details of a specific IVR profile, you simply have to pass the `client_ivr_profile_id`. If no additional parameter is specified, the complete list of IVRs will be returned.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| client_ivr_profile_id | integer | Optional | Value must be a valid client_ivr_profile_id. (default is NULL) |
| client_subaccount_id | integer | Optional | Value must be a valid client_subaccount_id. (default is NULL) |
Sample response
Sample response for get_ivr_profiles
{
...
"ivr_profiles": {
"ivr_profile_details": {
"client_ivr_profile_id": "1783",
"client_account_id": "3",
"client_subaccount_id": "2472",
"friendly_name": "abc",
"default_language": "en",
"pre_ivr_extension": "5272",
"pre_ivr_delay": "2",
"client_office_hour_id": "126",
"time_zone_id": "0",
"client_moh_profile_id": "1016",
"options": "disable_moh",
"admin_options": "",
"status": "enabled",
"comments": "abc",
"metadata": "",
"date_activated": "2021-10-15",
"date_cancelled": "0000-00-00",
"user_created": "3",
"user_updated": "3",
"datetime_created": "2021-10-15 13:45:25",
"datetime_updated": "2021-10-15 13:45:25",
"datetime_synched": "0000-00-00 00:00:00"
}
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<ivr_profiles>
<ivr_profile_details>
<client_ivr_profile_id>1783</client_ivr_profile_id>
<client_account_id>3</client_account_id>
<client_subaccount_id>2472</client_subaccount_id>
<friendly_name>abc</friendly_name>
<default_language>en</default_language>
<pre_ivr_extension>5272</pre_ivr_extension>
<pre_ivr_delay>2</pre_ivr_delay>
<client_office_hour_id>126</client_office_hour_id>
<time_zone_id>0</time_zone_id>
<client_moh_profile_id>1016</client_moh_profile_id>
<options>disable_moh</options>
<admin_options/>
<status>enabled</status>
<comments>abc</comments>
<metadata></metadata>
<date_activated>2021-10-15</date_activated>
<date_cancelled>0000-00-00</date_cancelled>
<user_created>3</user_created>
<user_updated>3</user_updated>
<datetime_created>2021-10-15 13:45:25</datetime_created>
<datetime_updated>2021-10-15 13:45:25</datetime_updated>
<datetime_synched>0000-00-00 00:00:00</datetime_synched>
</ivr_profile_details>
</ivr_profiles>
</response>
Update IVR Profile
Request Type:
You can update the configuration of an IVR profile with this request type.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| mode | string | Optional | Value must be "update" or "create". (default is update) |
| client_ivr_profile_id | integer | Optionally required | If mode is "update", value must be a valid client_ivr_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 60 characters. |
| default_language | string | Optional | Value must be one of the following: ""(empty), "en" or "fr" |
| pre_ivr_extension | integer | Optional | Value must be a valid client_extension_id. (default is 0) |
| pre_ivr_delay | string | Optional | Value must be one of the following: "2", "5", "10", "15", "20", "25" or "30" (default is 10) |
| client_office_hour_id | integer | Optional | Value must be a valid client_office_hour_id. (default is 0) |
| client_moh_profile_id | integer | Optional | Value must be a valid client_moh_profile_id. (default is 0) |
| options | string | Optional | Value must be any of the following comma seperated: "enable_directory","disable_moh" |
| status | string | Required | Value must be one of the following: "enabled" or "disabled" |
| comments | string | Optional | |
| [raw_metadata] | see doc | see doc | Additional information for the metadata can be found here. |
Schedules
Get Schedules
Request Type:
Get details for schedules (office hours).
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| client_schedule_id | integer | Optional | Value must be a valid client_schedule_id. (default is NULL) |
| client_subaccount_id | integer | Optional | Value must be a valid client_subaccount_id. (default is NULL) |
Sample response
Sample response for get_schedules
{
...
"schedules": {
"schedule": {
"client_schedule_id": "\"1234\"",
"client_subaccount_id": "\"0\"",
"friendly_name": "\"Test\"",
"business_hours": "{\"weekday0\":{\"default\":[{\"start\":\"00:00:00\",\"end\":\"06:00:00\"},{\"start\":\"08:00:00\",\"end\":\"24:00:00\"}],\"month1\":{\"day1\":[{\"start\":\"00:00:00\",\"end\":\"06:00:00\"}]}},\"weekday1\":{\"default\":[{\"start\":\"00:00:00\",\"end\":\"06:00:00\"},{\"start\":\"08:00:00\",\"end\":\"24:00:00\"}]},\"weekday2\":{\"default\":[{\"start\":\"00:00:00\",\"end\":\"06:00:00\"},{\"start\":\"08:00:00\",\"end\":\"24:00:00\"}]},\"weekday3\":{\"default\":[{\"start\":\"00:00:00\",\"end\":\"06:00:00\"},{\"start\":\"08:00:00\",\"end\":\"24:00:00\"}]},\"weekday4\":{\"default\":[{\"start\":\"00:00:00\",\"end\":\"06:00:00\"},{\"start\":\"08:00:00\",\"end\":\"24:00:00\"}]},\"weekday5\":{\"default\":[{\"start\":\"00:00:00\",\"end\":\"06:00:00\"},{\"start\":\"08:00:00\",\"end\":\"24:00:00\"}]},\"weekday6\":{\"default\":[{\"start\":\"00:00:00\",\"end\":\"06:00:00\"},{\"start\":\"08:00:00\",\"end\":\"24:00:00\"}]}}",
"time_zone_id": "\"155\"",
"range_date": "\"daily\"",
"status": "\"enabled\"",
"metadata": {
"raw_metadata": "{\"test\":1234}",
"metadata_attributes": {
"attribute_count": "1",
"test": "1234"
}
},
"comments": "\"\"",
"date_activated": "\"2022-06-09\"",
"date_cancelled": "\"0000-00-00\"",
"user_created": "\"1000\"",
"user_updated": "\"1000\"",
"datetime_created": "\"2022-06-09 18:32:06\"",
"datetime_updated": "\"2022-06-10 09:27:22\"",
"check_business_hours": "open"
}
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<schedules>
<schedule>
<client_schedule_id>"1234"</client_schedule_id>
<client_subaccount_id>"0"</client_subaccount_id>
<friendly_name>"Test"</friendly_name>
<business_hours>
<![CDATA[{"weekday0":{"default":[{"start":"00:00:00","end":"06:00:00"},{"start":"08:00:00","end":"24:00:00"}],"month1":{"day1":[{"start":"00:00:00","end":"06:00:00"}]}},"weekday1":{"default":[{"start":"00:00:00","end":"06:00:00"},{"start":"08:00:00","end":"24:00:00"}]},"weekday2":{"default":[{"start":"00:00:00","end":"06:00:00"},{"start":"08:00:00","end":"24:00:00"}]},"weekday3":{"default":[{"start":"00:00:00","end":"06:00:00"},{"start":"08:00:00","end":"24:00:00"}]},"weekday4":{"default":[{"start":"00:00:00","end":"06:00:00"},{"start":"08:00:00","end":"24:00:00"}]},"weekday5":{"default":[{"start":"00:00:00","end":"06:00:00"},{"start":"08:00:00","end":"24:00:00"}]},"weekday6":{"default":[{"start":"00:00:00","end":"06:00:00"},{"start":"08:00:00","end":"24:00:00"}]}}]]>
</business_hours>
<time_zone_id>"155"</time_zone_id>
<range_date>"daily"</range_date>
<status>"enabled"</status>
<metadata>
<raw_metadata>
<![CDATA[{"test":1234}]]>
</raw_metadata>
<metadata_attributes attribute_count="1">
<test>
<![CDATA[1234]]>
</test>
</metadata_attributes>
</metadata>
<comments>""</comments>
<date_activated>"2022-06-09"</date_activated>
<date_cancelled>"0000-00-00"</date_cancelled>
<user_created>"1000"</user_created>
<user_updated>"1000"</user_updated>
<datetime_created>"2022-06-09 18:32:06"</datetime_created>
<datetime_updated>"2022-06-10 09:27:22"</datetime_updated>
<check_business_hours>open</check_business_hours>
</schedule>
</schedules>
</response>
Update Schedule
Request Type:
You can update the configuration of a schedule with this request type.
Note: Not all the option for schedule are available through the API. Please request any new feature to our support department.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| mode | string | Optional | Value must be "update" or "create". (default is 'update') |
| client_schedule_id | integer | Optionally required | If mode is "update", value must be a valid client_schedule_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 60 characters. |
| comments | string | Optional | |
| time_zone_id | integer | Optional | Value must be a valid time_zone_id. (default is based on account preferences) |
| range_date | string | Optional | Value must be one of 'daily', 'weekly', 'custom'. (default is 'daily') |
| shift_start_date | string | Optional | Value must be between a valid date in format "YYYY-MM-DD". (default is current date) |
| business_hours | json | Optional | Note: Not yet fully implemented, only month-day exceptions are accepted. Example JSON string: {"month4":{"day22":[{"start":"00:00:00","end":"10:30:00","type":"exception"}]}} |
| shift | json/array | Optional | Example URI array: shift[0][status]=on&shift[0][days]=2&shift[1][status]=off&shift[1][days]=2 Example JSON string: [{"status":"on","days":"2"},{"status":"off","days":"2"}] |
| status | string | Optional | Value must be one of the following: "enabled" or "disabled" |
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| status | string | Required | Value must be one of the following: 'one', 'off' |
| days | integer | Required | Value must be a number of days |
Account & billing
Get account details
Request Type:
You can get some of the account details by using this request type. More information related to account is also provided in request types get_account_preferences and get_funding_details.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| - | - | - | - |
Sample response
Sample response for get_account_details
{
...
"account_details": {
"account_name": "myaccount",
"subaccounts": {
"subaccount_details": {
"client_subaccount_id": "12",
"friendly_name": "Client #28",
"call_limit": "10"
}
}
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<account_details>
<account_name>myaccount</account_name>
<subaccounts>
<subaccount_details>
<client_subaccount_id>12</client_subaccount_id>
<friendly_name>Client #28</friendly_name>
<call_limit>10</call_limit>
</subaccount_details>
...
</subaccounts>
</account_details>
</response>
Get account preferences
Request Type:
This request type will provide details for information found in clients sections Account Preferences and Global Settings.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| - | - | - | - |
Sample response
Sample response for get_account_preferences
{
...
"account_preferences": {
"currency": "USD",
"cash_advance_limit": "5.0000",
"low_funds_trigger": "15.0000",
"insufficient_funds_behavior": "delay_prompt",
"account_suspension_behavior": "force_congestion",
"preferred_language": "en",
"global_callerid_name": "Caller Name",
"global_callerid_number": "4508886666",
"voice_language": "en",
"default_mailbox": "1"
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<account_preferences>
<currency>USD</currency>
<cash_advance_limit>5.0000</cash_advance_limit>
<low_funds_trigger>15.0000</low_funds_trigger>
<insufficient_funds_behavior>delay_prompt</insufficient_funds_behavior>
<account_suspension_behavior>force_congestion</account_suspension_behavior>
<preferred_language>en</preferred_language>
<global_callerid_name>Caller Name</global_callerid_name>
<global_callerid_number>4508886666</global_callerid_number>
<voice_language>en</voice_language>
<default_mailbox>1</default_mailbox>
</account_preferences>
</response>
Get Subaccounts details
Request Type:
You can get the details and settings of your Subaccounts by specifying the `client_subaccount_id`. If you do not provide the value, the details for all Subaccounts will be returned.
| 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) |
| custom_id | string | Optional | Value must be a valid custom_id string. Allows filtering subaccounts by custom identifier. (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. |
Sample response
Sample response for get_subaccounts
{
...
"subaccounts": {
"subaccount_details": {
"client_subaccount_id": "1234",
"custom_id": "",
"friendly_name": "Corporate",
"call_limit": "15",
"allow_international_call": "1",
"international_call_limit": "12",
"require_international_nip": "yes",
"international_nip": "123456,7777777,10101939",
"organization": "15",
"organization_type": "15",
"client_profile": "15",
"voice_language": "",
"notification_language": "",
"callerid_name": "Name",
"callerid_number": "5143334444",
"client_moh_profile_id": "15",
"default_provisioned_endpoint_id": "15",
"options": "enable_billing_module,enable_billing_notification",
"comments": "15",
"associations": {
"client_peer_ids": "1234",
"client_did_ids": "1,2,3",
"client_extension_ids": "1000,1001,1002",
"clients_fax_profile_ids": "1000",
"client_mailbox_ids": "1003"
},
"addresses": {
"address_details": {
"client_address_id": [
"1234",
"1234"
],
"type": [
"billing",
"billing"
],
"box_number": "",
"precision": "Bernardo",
"civic_number": "1234",
"street": "Street",
"unit_number": "123",
"city": "Montreal",
"country_id": "38",
"state_id": "11",
"state_other": "",
"postal_code": "H1H 1H1",
"formatted": "Att-Bernardo\n 1234 Street 123\n Montreal, Québec (Canada)\n H1H 1H1"
}
},
"metadata": {
"raw_metadata": "a:3:{s:13:\"tout_le_monde\";s:8:\"en parle\";s:6:\"piment\";s:4:\"fort\";s:5:\"super\";s:3:\"man\";}",
"metadata_attributes": {
"attribute_count": "3",
"tout_le_monde": "en parle",
"piment": "fort",
"super": "man"
}
}
}
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<subaccounts>
<subaccount_details>
<client_subaccount_id>1234</client_subaccount_id>
<custom_id></custom_id>
<friendly_name>Corporate</friendly_name>
<call_limit>15</call_limit>
<allow_international_call>1</allow_international_call>
<international_call_limit>12</international_call_limit>
<require_international_nip>yes</require_international_nip>
<international_nip>123456,7777777,10101939</international_nip>
<organization>15</organization>
<organization_type>15</organization_type>
<client_profile>15</client_profile>
<voice_language></voice_language>
<notification_language></notification_language>
<callerid_name>Name</callerid_name>
<callerid_number>5143334444</callerid_number>
<client_moh_profile_id>15</client_moh_profile_id>
<default_provisioned_endpoint_id>15</default_provisioned_endpoint_id>
<options>enable_billing_module,enable_billing_notification</options>
<comments>15</comments>
<associations>
<client_peer_ids>1234</client_peer_ids>
<client_did_ids>1,2,3</client_did_ids>
<client_extension_ids>1000,1001,1002</client_extension_ids>
<clients_fax_profile_ids>1000</clients_fax_profile_ids>
<client_mailbox_ids>1003</client_mailbox_ids>
</associations>
<addresses>
<address_details client_address_id="1234" type="billing">
<client_address_id>1234</client_address_id>
<type>billing</type>
<box_number/>
<precision>Bernardo</precision>
<civic_number>1234</civic_number>
<street>Street</street>
<unit_number>123</unit_number>
<city>Montreal</city>
<country_id>38</country_id>
<state_id>11</state_id>
<state_other/>
<postal_code>H1H 1H1</postal_code>
<formatted>Att-Bernardo
1234 Street 123
Montreal, Québec (Canada)
H1H 1H1</formatted>
</address_details>
</addresses>
<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>
</subaccount_details>
</subaccounts>
...
</response>
Update Subaccount
Request Type:
Allows you to create or simply update a 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) |
Update Subaccount Associations
Request Type:
You can update the associations of a subaccount with this request type.
| 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 |
Update a Subaccount Address
Request Type:
Allows you to create or simply update an address for the subaccount.
| 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 |
Get funding details
Request Type:
This request will allow you to get your account's funding details and status.
Note: The value returned for account_balance and funds_left are negative amount if not followed by 'CR'.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| - | - | - | - |
Sample response
Sample response for get_funding_details
{
...
"funding_details": {
"currency": "CAD",
"billing_type": "prepaid",
"low_funds_trigger": "10.00",
"funding_status": "sufficient",
"account_balance": "40.00 CR",
"liable_charges": "7.98",
"funds_left": "32.02 CR"
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<funding_details>
<currency>CAD</currency>
<billing_type>prepaid</billing_type>
<low_funds_trigger>10.00</low_funds_trigger>
<funding_status>sufficient</funding_status>
<account_balance>40.00 CR</account_balance>
<liable_charges>7.98</liable_charges>
<funds_left>32.02 CR</funds_left>
</funding_details>
</response>
Get billing activity
Request Type:
This request will provide a list of invoices, payments, credits and returns and refunds. If date range is not provided, the complete list of transactions will be returned.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| 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". |
Sample response
Sample response for get_billing_activity
{
...
"billing_activities": {
"billing_activity": {
"billing_date": "2007-07-01",
"type": "charge",
"amount": "50.0000",
"invoice_url": "http://clients.voicemeup.com/billing/invoice_display.php?web_key=89DG56F&lang=en&action=print"
}
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<billing_activities>
<billing_activity>
<billing_date>2007-07-01</billing_date>
<type>charge</type>
<amount>50.0000</amount>
<invoice_url>http://clients.voicemeup.com/billing/invoice_display.php?web_key=89DG56F&lang=en&action=print</invoice_url>
</billing_activity>
</billing_activities>
</response>
Get account invoices
Request Type:
Get a full list of all main account invoices.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| invoice_id | integer | Optional | Must be a valid invoice invoice_id. (default is NULL) |
| web_key | string | Optional | Must be a valid invoice web_key (public access identifier, e.g. 89DG56F). (default is NULL) |
| date_from | date | Optional | Value must be a valid date. Based on date_billing (default is NULL) |
| date_to | date | Optional | Value must be a valid date. Based on date_billing (default is NULL) |
| include_items | boolean | Optional | This will add invoice items to the result (default is FALSE) |
Sample response
Sample response for get_invoices
{
...
"invoices": {
"invoice": {
"invoice_id": "123",
"client_account_id": "3",
"date_billing": "2020-09-01",
"date_generated": "0000-00-00",
"subtotal": "29.68",
"current_charges": "34.13",
"web_key": "89DG56F",
"status": "enabled",
"datetime_updated": "2020-09-02 14:14:22",
"currency": "CAD",
"invoice_items": {
"invoice_item": {
"invoice_item_id": "123",
"client_account_id": "3",
"invoice_id": "123",
"parent_id": "0",
"type": "other",
"service_id": "62",
"client_service_id": "",
"order_index": "126",
"order_group": "",
"quantity": "0.00",
"amount": "4.45",
"prorata_amount": "0.00",
"date_started": "0000-00-00",
"date_ended": "0000-00-00",
"currency": "CAD"
},
...
}
},
...
}
}<?php print '
<?xml version="1.0" encoding="utf-8"?>' . "\n"; ?>
<response>
...
<invoices>
<invoice>
<invoice_id>123</invoice_id>
<client_account_id>3</client_account_id>
<date_billing>2020-09-01</date_billing>
<date_generated>0000-00-00</date_generated>
<subtotal>29.68</subtotal>
<current_charges>34.13</current_charges>
<web_key>89DG56F</web_key>
<status>enabled</status>
<datetime_updated>2020-09-02 14:14:22</datetime_updated>
<currency>CAD</currency>
<invoice_items>
<invoice_item>
<invoice_item_id>123</invoice_item_id>
<client_account_id>3</client_account_id>
<invoice_id>123</invoice_id>
<parent_id>0</parent_id>
<type>other</type>
<service_id>62</service_id>
<client_service_id></client_service_id>
<order_index>126</order_index>
<order_group></order_group>
<quantity>0.00</quantity>
<amount>4.45</amount>
<prorata_amount>0.00</prorata_amount>
<date_started>0000-00-00</date_started>
<date_ended>0000-00-00</date_ended>
<currency>CAD</currency>
</invoice_item>
...
</invoice_items>
</invoice>
...
</invoices>
</response>
Get Account Services Rates & Pricing
Request Type:
Get the rates that apply to the authenticated account for self-serve add-on services
and metered usage (including communication services such as local and toll-free calling).
Matches the rates shown on the client portal Plans → Service rates tab.
Each returned service includes a type field with the service catalog types
from the database (comma-separated SET values such as self_serve,
usage, option, plan, bundle),
the applicable rate, order_index for display ordering,
and related billing fields. Use the optional request parameter type
to filter by pricing category (self_serve or usage),
using the same FIND_IN_SET rules as the portal Service rates tab.
For international destination lookup by prefix or country, use Get Calls Rates instead.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| date | date | Optional | Effective date for plan and rate lookup (default is today) |
| service_id | integer | Optional | Return pricing for a single enabled service only |
| type | string | Optional | Filter by pricing category: self_serve (self-serve services, excluding usage) or usage (usage services, excluding self-serve). Same rules as the portal Service rates tab. |
Sample response
Sample response for get_pricing
{
...
"services": {
"service": [
{
"service_id": "8",
"alias": "comm_local_termination",
"title": "Local outbound calls",
"type": "usage",
"rate": "0.0125",
"currency": "CAD",
"default_term": "none",
"prorated": "no",
"unit": "minute",
"order_index": "8"
},
{
"service_id": "12",
"alias": "did_local",
"title": "Local DID",
"type": "option,plan",
"rate": "1.25",
"currency": "CAD",
"default_term": "monthly",
"prorated": "yes",
"unit": "",
"order_index": "12"
}
]
...
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<services>
<service>
<service_id>8</service_id>
<alias>comm_local_termination</alias>
<title>Local outbound calls</title>
<type>usage</type>
<rate>0.0125</rate>
<currency>CAD</currency>
<default_term>none</default_term>
<prorated>no</prorated>
<unit>minute</unit>
<order_index>8</order_index>
</service>
<service>
<service_id>12</service_id>
<alias>did_local</alias>
<title>Local DID</title>
<type>option,plan</type>
<rate>1.25</rate>
<currency>CAD</currency>
<default_term>monthly</default_term>
<prorated>yes</prorated>
<unit></unit>
<order_index>12</order_index>
</service>
...
</services>
</response>
Get Calls Rates
Request Type:
Get per-destination call rates (international and toll termination). Filter by dialing prefix (code) or country_id (one is required). For account service and usage rates, use Get Account Services Rates & Pricing instead.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| code | string | Optionally required | Value must be a valid code_prefix. |
| country_id | integer | Optionally required | Value must be a valid country_id. |
| state_id | integer | Optional | Value must be a valid state_id. |
Sample response
Sample response for get_rates
{
...
"rates": {
"rate_details": {
"code_prefix": "1514771",
"country_id": "38",
"country": "Canada",
"state_id": "11",
"state": "Quebec",
"region": "Montreal",
"rate": "0.0190"
}
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<rates>
<rate_details>
<code_prefix>1514771</code_prefix>
<country_id>38</country_id>
<country>Canada</country>
<state_id>11</state_id>
<state>Quebec</state>
<region>Montreal</region>
<rate>0.0190</rate>
</rate_details>
</rates>
</response>
Get plans
Request Type:
Get the list of current plans available along with their included services.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| plan_id | integer | Optional | Value must be a valid plan_id. |
| plan_groups_id | integer | Optional | Value must be a valid plan_group_id. |
Sample response
Sample response for get_plans
{
...
"plans": {
"plans_details": {
"plan_id": "1",
"price": "0.00",
"plan": "On Demand Calling",
"plan_description": "This plan is ideal if you do not have a constant usage or if you want to have unlimited channels.",
"plan_group_id": "2",
"services": {
"service_details": {
"service_id": "1",
"service": "SIP / IAX Account",
"quantity": "10.00",
"price": "0.00"
}
}
}
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<plans>
<plans_details>
<plan_id>1</plan_id>
<price>0.00</price>
<plan>On Demand Calling</plan>
<plan_description>This plan is ideal if you do not have a constant usage or if you want to have unlimited channels.</plan_description>
<plan_group_id>2</plan_group_id>
<services>
<service_details>
<service_id>1</service_id>
<service>SIP / IAX Account</service>
<quantity>10.00</quantity>
<price>0.00</price>
</service_details>
...
</services>
</plans_details>
</plans>
</response>
Reference data
Get countries
Request Type:
Get a list of countries, their country code and country ID for use with other request types.
Note: This response is reference data that changes infrequently. Store it locally, reuse your local data for lookups, and call this request type again only when you need fresh values.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| - | - | - | - |
Sample response
Sample response for get_countries
{
...
"countries": {
"country_details": {
"country_id": "38",
"country": "Canada"
}
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<countries>
<country_details>
<country_id>38</country_id>
<country>Canada</country>
</country_details>
</countries>
</response>
Get states
Request Type:
Get a list of states/provinces, their state code and state ID for use with other request types.
Note: This response is reference data that changes infrequently. Store it locally, reuse your local data for lookups, and call this request type again only when you need fresh values.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| country_id | integer | Required | Value must be a valid country_id. |
Sample response
Sample response for get_states
{
...
"states": {
"state_details": {
"country_id": "38",
"state_id": "11",
"state": "Quebec"
}
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<states>
<state_details>
<country_id>38</country_id>
<state_id>11</state_id>
<state>Quebec</state>
</state_details>
</states>
</response>
Get City codes
Request Type:
Get the list of city.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| - | - | - | - |
Sample response
Sample response for get_city_codes
{
...
"city_codes": {
"city_code": [
{
"municipality": "MONTREAL",
"code": "MTL",
"region": "COMMUNAUTE URBAINE DE MONTREAL"
},
{
"municipality": "LAVAL",
"code": "LAV",
"region": "LAVAL"
}
]
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<city_codes>
<city_code>
<municipality>MONTREAL</municipality>
<code>MTL</code>
<region>COMMUNAUTE URBAINE DE MONTREAL</region>
</city_code>
<city_code>
<municipality>LAVAL</municipality>
<code>LAV</code>
<region>LAVAL</region>
</city_code>
...
</city_codes>
</response>
Get issues types
Request Type:
Retreive the list of possible issues, description and their issue ID for use with `report_call_issue` request type.
Note: This response is reference data that changes rarely. Store it locally, reuse your local data for lookups, and refresh your local copy about once a month.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| - | - | - | - |
Sample response
Sample response for get_issues_types
{
...
"issues_types": {
"issue_type": {
"name": "Dropped call",
"issue_type_id": "53",
"short_description": "Call timer should have stopped",
"long_description": "",
"parent_id": "52",
"level": "2",
"type": "issue"
}
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<issues_types>
<issue_type>
<name>Dropped call</name>
<issue_type_id>53</issue_type_id>
<short_description>Call timer should have stopped</short_description>
<long_description></long_description>
<parent_id>52</parent_id>
<level>2</level>
<type>issue</type>
</issue_type>
</issues_types>
</response>
Get Proxies
Request Type:
Get the list of available proxies.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| proxy_id | integer | Optional | Value must be a valid proxy_id. |
Sample response
Sample response for get_proxies
{
...
"proxies": {
"proxy_details": [
{
"proxy_id": "3",
"availability": "no"
},
{
"proxy_id": "10",
"availability": "yes",
"alias": "sip-slb-cola.voicemeup.com",
"title": "Cluster SIP (Montréal - Couture/Lacordaire)",
"short_description": "Cluster SIP (HA Actif/Actif)",
"long_description": "Cluster SIP (HA Actif/Actif Haute Disponiblité)",
"ip": "72.55.158.150",
"public_port": "5060",
"type": "SIP",
"default": "yes",
"options": "georedundancy_support,acl_support"
}
]
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<proxies>
<proxy_details>
<proxy_id>3</proxy_id>
<availability>no</availability>
</proxy_details>
<proxy_details>
<proxy_id>10</proxy_id>
<availability>yes</availability>
<alias>sip-slb-cola.voicemeup.com</alias>
<title>Cluster SIP (Montréal - Couture/Lacordaire)</title>
<short_description>Cluster SIP (HA Actif/Actif)</short_description>
<long_description>Cluster SIP (HA Actif/Actif Haute Disponiblité)</long_description>
<ip>72.55.158.150</ip>
<public_port>5060</public_port>
<type>SIP</type>
<default>yes</default>
<options>georedundancy_support,acl_support</options>
</proxy_details>
</proxies>
</response>
Get Network Status
Request Type:
If you wish to get the list of network status. If no additional parameter is specified, the first 5 entries will be returned.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| mode | string | Optional | Value must be either 'latest' or 'unresolved'. (default is latest) |
| limit | integer | Optional | Value must be a valid positive number. (default is 5) |
| offset | integer | Optional | Value must be a valid positive number. (default is 0) |
Sample response
Sample response for get_network_status
{
...
"events": {
"event_details": {
"title": "Tout les services sont présentement opérationnels",
"description": "",
"date": "2011-11-21",
"time": "12:00:00",
"category": "minor",
"comments": "",
"data": {
"data_entry": [
{
"type": "update",
"datetime": "2011-11-21 13:00:00",
"description": "Engineers are investigating the issue."
},
{
"type": "full_resolution",
"datetime": "2011-11-21 14:30:00",
"description": "The issue has been resolved."
}
]
}
}
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<events>
<event_details>
<title>Tout les services sont présentement opérationnels</title>
<description></description>
<date>2011-11-21</date>
<time>12:00:00</time>
<category>minor</category>
<comments></comments>
<data>
<data_entry>
<type>update</type>
<datetime>2011-11-21 13:00:00</datetime>
<description>Engineers are investigating the issue.</description>
</data_entry>
<data_entry>
<type>full_resolution</type>
<datetime>2011-11-21 14:30:00</datetime>
<description>The issue has been resolved.</description>
</data_entry>
</data>
</event_details>
</events>
</response>
E911
Get E911 provisioned status
Request Type:
Returns provisioned status of a DID
Note : Will return all e911 endpoints locations if no argument is given. If both argument are given, the client_endpoint_id will be used.
| 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 ) |
| client_endpoint_id | integer | Optionally required | Value must be a valid client_endpoint_id |
| client_subaccount_id | integer | Optional | Value must be a valid client_subaccount_id. (default is NULL) |
| result_limit | integer | Optional | Value must be between 1 and 1000 (default is 1000) |
| result_offset | integer | Optional | Value must be a valid number (default is NULL) |
Sample response
Sample response for get_e911
{
...
"client_endpoints": {
"client_endpoint_details": {
"client_endpoint_id": "1455",
"phone_number": "5143127030",
"client_did_id": "10",
"first_name": "John",
"last_name": "Doe",
"civic_number": "1882",
"street": "BOUL ST-MARTIN O.",
"address_type": "suite",
"address_type_number": "200",
"city": "LAVAL",
"country_id": "38",
"state_id": "11",
"postal_code": "H7S 1S8",
"language": "fr",
"provision_status": "enabled",
"status": "enabled"
}
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<client_endpoints>
<client_endpoint_details>
<client_endpoint_id>1455</client_endpoint_id>
<phone_number>5143127030</phone_number>
<client_did_id>10</client_did_id>
<first_name>John</first_name>
<last_name>Doe</last_name>
<civic_number>1882</civic_number>
<street>BOUL ST-MARTIN O.</street>
<address_type>suite</address_type>
<address_type_number>200</address_type_number>
<city>LAVAL</city>
<country_id>38</country_id>
<state_id>11</state_id>
<postal_code>H7S 1S8</postal_code>
<language>fr</language>
<provision_status>enabled</provision_status>
<status>enabled</status>
</client_endpoint_details>
</client_endpoints>
</response>
Check address validity for E911
Request Type:
Verify if an address is valid with the E911 service.
IMPORTANT : This function may return failed and still contain alternate addresses until an exact match is provided. See below for example
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| phone_number | integer | Optional | Value must be a valid phone_number ( No space or - symbol ). |
| civic_number | integer | Required | Value must be a valid civic_number |
| street | string | Required | Must be an exact match to the street name. |
| city | string | Required | Must be an exact match to the city name. |
| state_code | string | Optionaly Required | Value must be a valid 2 letter state code. |
| state_id | integer | Optionaly Required | Value must be a valid country_id |
| country_code | string | Optionaly Required | Value must be a valid 2 letter country code. |
| country_id | integer | Optionaly Required | Value must be a valid country_id |
| postal_code | string | Required | Must be a valid postal_code |
| address_type | string | Optional | Must be one of the following : "apartment", "basement", "building", "department", "floor", "front", "hanger", "key", "lobby", "lot", "lower", "office", "penthouse", "pier", "rear", "room", "side", "slip", "space", "stop", "suite", "trailer", "unit", "upper" |
| address_type_number | string | Optional | Must be a valid address_type_number |
View alternate addresses error sample response
View alternate addresses error sample response
{
"request_details": {
"request_datetime": "2010-07-16 15:58:06",
"request_arguments": {
"client_account_id": "80013833",
"auth_token": "REDACTED",
"request_type": "update_e911",
"civic_number": "123",
"street": "rue des perdus",
"city": "Montreal",
"state": "QC",
"country": "CA",
"postal_code": "J5RXXX"
}
},
"response_details": {
"server_name": "alphalyra.hostmeup.com",
"response_delay": "1.2758688926697",
"response_status": "failed",
"response_messages": {
"message": [
{
"type": "warning",
"code": "alternate_address_provided",
"_content": "Array\n(\n [number] => 85 ~ 295\n [street] => RUE DES PERDUS\n [city] => MONTREAL\n [state] => QUEBEC\n [state_code] => PQ\n [zip] => J5R XXX\n)"
},
{
"type": "warning",
"code": "alternate_address_provided",
"_content": "Array\n(\n [number] => 80 ~ 290\n [street] => RUE DES PERDUS\n [city] => MONTREAL\n [state] => QUEBEC\n [state_code] => PQ\n [zip] => J5R XXX\n)"
},
{
"type": "notice",
"code": "alternate_address_hint"
}
]
}
},
"alternate_addresses": {
"alternate_address": [
{
"civic_number": "85 ~ 295",
"street": "RUE DES PERDUS",
"city": "MONTREAL",
"state": "QUEBEC",
"state_code": "PQ",
"postal_code": "J5R XXX"
},
{
"civic_number": "80 ~ 290",
"street": "RUE DES PERDUS",
"city": "MONTREAL",
"state": "QUEBEC",
"state_code": "PQ",
"postal_code": "J5R XXX"
}
]
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
<request_details>
<request_datetime>2010-07-16 15:58:06</request_datetime>
<request_arguments>
<client_account_id>80013833</client_account_id>
<auth_token>REDACTED</auth_token>
<request_type>update_e911</request_type>
<civic_number>123</civic_number>
<street>rue des perdus</street>
<city>Montreal</city>
<state>QC</state>
<country>CA</country>
<postal_code>J5RXXX</postal_code>
</request_arguments>
</request_details>
<response_details>
<server_name>alphalyra.hostmeup.com</server_name>
<response_delay>1.2758688926697</response_delay>
<response_status>failed</response_status>
<response_messages>
<message type="warning" code="alternate_address_provided">Array
(
[number] => 85 ~ 295
[street] => RUE DES PERDUS
[city] => MONTREAL
[state] => QUEBEC
[state_code] => PQ
[zip] => J5R XXX
)
</message>
<message type="warning" code="alternate_address_provided">Array
(
[number] => 80 ~ 290
[street] => RUE DES PERDUS
[city] => MONTREAL
[state] => QUEBEC
[state_code] => PQ
[zip] => J5R XXX
)
</message>
<message type="notice" code="alternate_address_hint"></message>
</response_messages>
</response_details>
<alternate_addresses>
<alternate_address>
<civic_number>85 ~ 295</civic_number>
<street>RUE DES PERDUS</street>
<city>MONTREAL</city>
<state>QUEBEC</state>
<state_code>PQ</state_code>
<postal_code>J5R XXX</postal_code>
</alternate_address>
<alternate_address>
<civic_number>80 ~ 290</civic_number>
<street>RUE DES PERDUS</street>
<city>MONTREAL</city>
<state>QUEBEC</state>
<state_code>PQ</state_code>
<postal_code>J5R XXX</postal_code>
</alternate_address>
</alternate_addresses>
</response>
Associate peer to did for E911
Request Type:
Associate a peer to a provisioned DID.
IMPORTANT : Ignore if the trunk associated is a server and many different endpoint addresses are provisioned.
| 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 ) |
| client_endpoint_id | integer | Optionally required | Value must be a valid client_endpoint_id |
| client_peer_id | integer | Required | Value must be a valid client_peer_id |
Disassociate peer to did for E911
Request Type:
Disassociate a peer to a provisionned DID.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| client_peer_id | integer | Required | Value must be a valid client_peer_id |
Update E911 provisioned address.
Request Type:
Update the provisioned address for a did for the e911 service.
IMPORTANT : This function may return failed and still contain alternate addresses until an exact match is provided. See below for example
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| phone_number | integer | Required | Value must be a valid phone number of 10 digits. ( No space or - symbol ) |
| first_name | string | Deprecated | Value must be a valid first_name. |
| last_name | string | Deprecated | Value must be a valid last_name |
| full_name | string | Required | Value must be a string between 2 and 32 characters. |
| civic_number | integer | Required | Value must be a valid civic_number |
| street | string | Required | Must be an exact match to the street name. |
| city | string | Required | Must be an exact match to the city name. |
| state_code | string | Optionally Required | Value must be a valid 2 letter state code. |
| state_id | integer | Optionally Required | Value must be a valid country_id |
| country_code | string | Optionally Required | Value must be a valid 2 letter country code. |
| country_id | integer | Optionally Required | Value must be a valid country_id |
| postal_code | string | Required | Must be a valid postal_code |
| language | string | Deprecated | Value must valid one of the following: "en", "fr". Default is account preferred language. Ignored outside of Canada. This parameter has been replaced by e911_language and will eventually be removed. |
| e911_language | string | Optional | Value must valid one of the following: "en", "fr". Default is account preferred language. Ignored outside of Canada. |
| address_type | string | Optional | Must be one of the following : "apartment", "basement", "building", "department", "floor", "front", "hanger", "key", "lobby", "lot", "lower", "office", "penthouse", "pier", "rear", "room", "side", "slip", "space", "stop", "suite", "trailer", "unit", "upper" |
| address_type_number | string | Optional | Must be a valid address_type_number |
| rate_provider_id | integer | Optional | Must be a valid rate_provider_id |
View alternate addresses error sample response
View alternate addresses error sample response
{
"request_details": {
"request_datetime": "2010-07-16 15:58:06",
"request_arguments": {
"client_account_id": "80013833",
"auth_token": "REDACTED",
"request_type": "update_e911",
"civic_number": "123",
"street": "rue des perdus",
"city": "Montreal",
"state": "QC",
"country": "CA",
"postal_code": "J5RXXX"
}
},
"response_details": {
"server_name": "alphalyra.hostmeup.com",
"response_delay": "1.2758688926697",
"response_status": "failed",
"response_messages": {
"message": [
{
"type": "warning",
"code": "alternate_address_provided",
"_content": "Array\n(\n [number] => 85 ~ 295\n [street] => RUE DES PERDUS\n [city] => MONTREAL\n [state] => QUEBEC\n [state_code] => PQ\n [zip] => J5R XXX\n)"
},
{
"type": "warning",
"code": "alternate_address_provided",
"_content": "Array\n(\n [number] => 80 ~ 290\n [street] => RUE DES PERDUS\n [city] => MONTREAL\n [state] => QUEBEC\n [state_code] => PQ\n [zip] => J5R XXX\n)"
},
{
"type": "notice",
"code": "alternate_address_hint"
}
]
}
},
"alternate_addresses": {
"alternate_address": [
{
"civic_number": "85 ~ 295",
"street": "RUE DES PERDUS",
"city": "MONTREAL",
"state": "QUEBEC",
"state_code": "PQ",
"postal_code": "J5R XXX"
},
{
"civic_number": "80 ~ 290",
"street": "RUE DES PERDUS",
"city": "MONTREAL",
"state": "QUEBEC",
"state_code": "PQ",
"postal_code": "J5R XXX"
}
]
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
<request_details>
<request_datetime>2010-07-16 15:58:06</request_datetime>
<request_arguments>
<client_account_id>80013833</client_account_id>
<auth_token>REDACTED</auth_token>
<request_type>update_e911</request_type>
<civic_number>123</civic_number>
<street>rue des perdus</street>
<city>Montreal</city>
<state>QC</state>
<country>CA</country>
<postal_code>J5RXXX</postal_code>
</request_arguments>
</request_details>
<response_details>
<server_name>alphalyra.hostmeup.com</server_name>
<response_delay>1.2758688926697</response_delay>
<response_status>failed</response_status>
<response_messages>
<message type="warning" code="alternate_address_provided">Array
(
[number] => 85 ~ 295
[street] => RUE DES PERDUS
[city] => MONTREAL
[state] => QUEBEC
[state_code] => PQ
[zip] => J5R XXX
)
</message>
<message type="warning" code="alternate_address_provided">Array
(
[number] => 80 ~ 290
[street] => RUE DES PERDUS
[city] => MONTREAL
[state] => QUEBEC
[state_code] => PQ
[zip] => J5R XXX
)
</message>
<message type="notice" code="alternate_address_hint"></message>
</response_messages>
</response_details>
<alternate_addresses>
<alternate_address>
<civic_number>85 ~ 295</civic_number>
<street>RUE DES PERDUS</street>
<city>MONTREAL</city>
<state>QUEBEC</state>
<state_code>PQ</state_code>
<postal_code>J5R XXX</postal_code>
</alternate_address>
<alternate_address>
<civic_number>80 ~ 290</civic_number>
<street>RUE DES PERDUS</street>
<city>MONTREAL</city>
<state>QUEBEC</state>
<state_code>PQ</state_code>
<postal_code>J5R XXX</postal_code>
</alternate_address>
</alternate_addresses>
</response>
Delete E911 provided address
Request Type:
Delete the provisioned address of a did. Also remove any association for peers using this address.
Note: Only one of the arguments is needed. If both are given, the client_endpoint_id will override.
| 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 ) |
| client_endpoint_id | integer | Optionally required | Value must be a valid client_endpoint_id |
Resellers
Get list of reseller transactions
Request Type:
Get a full list of all reseller transactions.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| reseller_transaction_id | integer | Optional | Must be a valid reseller_transaction_id. (default is NULL) |
| client_subaccount_id | integer | Optional | Value must be a valid client_subaccount_id. (default is NULL) |
| date_from | date | Optional | Value must be a valid date. Based on date_applied (default is NULL) |
| date_to | date | Optional | Value must be a valid date. Based on date_applied (default is NULL) |
Sample response
Sample response for get_resellers_transactions
{
...
"reseller_transactions": {
"reseller_transaction_details": {
"reseller_transaction_id": "C00001013",
"client_account_id": "3",
"client_subaccount_id": "1820",
"reseller_payment_id": "0",
"reseller_invoice_id": "0",
"date_billing": "2020-07-01",
"date_applied": "2020-07-20",
"time_applied": "15:35:34",
"type": "charge",
"amount": "68.99",
"amount_subtotal": "60.00",
"tax_hst": "0.00",
"tax_qst": "5.99",
"tax_gst": "3.00",
"comments": "",
"notes": "",
"status": "enabled",
"user_created": "0",
"user_updated": "1",
"datetime_created": "0000-00-00 00:00:00",
"datetime_updated": "2020-07-20 15:35:34",
"currency": "CAD"
}
}
}<?php print '
<?xml version="1.0" encoding="utf-8"?>' . "\n"; ?>
<response>
...
<reseller_transactions>
<reseller_transaction_details>
<reseller_transaction_id>C00001013</reseller_transaction_id>
<client_account_id>3</client_account_id>
<client_subaccount_id>1820</client_subaccount_id>
<reseller_payment_id>0</reseller_payment_id>
<reseller_invoice_id>0</reseller_invoice_id>
<date_billing>2020-07-01</date_billing>
<date_applied>2020-07-20</date_applied>
<time_applied>15:35:34</time_applied>
<type>charge</type>
<amount>68.99</amount>
<amount_subtotal>60.00</amount_subtotal>
<tax_hst>0.00</tax_hst>
<tax_qst>5.99</tax_qst>
<tax_gst>3.00</tax_gst>
<comments/>
<notes/>
<status>enabled</status>
<user_created>0</user_created>
<user_updated>1</user_updated>
<datetime_created>0000-00-00 00:00:00</datetime_created>
<datetime_updated>2020-07-20 15:35:34</datetime_updated>
<currency>CAD</currency>
</reseller_transaction_details>
</reseller_transactions>
</response>
Update reseller transactions
Request Type:
You can update and create the reseller transactions.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| mode | string | Optional | Value must be "update" or "create". (default is update) |
| reseller_transaction_id | integer | Required On Update | If mode is "update", value must be a valid reseller_transaction_id |
| client_subaccount_id | integer | Required On Create | Value must be a valid client_subaccount_id. |
| type | string | Required On Create | Value must be one of the following: "payment", "credit", "refund", "return" or "deposit". |
| amount | float | Optional | |
| reseller_payment_method_id | integer | Optionally Required On Create | Value required for type "payment". Must be a valid reseller payment method id. |
| transaction_data | integer | Optionally Required On Create | Value optionaly required for type "payment". Depends on the payment method configuration. But is most likely a confirmation number. |
| add_taxes | boolean | Optional | If set to false we will asume your amount has taxes included. Value used for type "credit". (default is FALSE) |
| date_billing | date | Optional | Value must be a valid date formatted as "YYYY-MM". (default is this year and month) |
| date_applied | date | Optional | Value must be a valid date formatted as "YYYY-MM-DD". (default is today) |
| time_applied | time | Optional | Value must be a valid date formatted as "HH:II:SS". (default is now) |
| comments | string | Optional | |
| notes | string | Optional | |
| status | string | Optional | Value must be one of the following: "enabled" or "deleted" |
Get list of reseller invoices
Request Type:
Get a full list of all reseller invoices.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| reseller_invoice_id | integer | Optional | Must be a valid invoice reseller_invoice_id. (default is NULL) |
| web_key | string | Optional | Must be a valid invoice web_key. (default is NULL) |
| client_subaccount_id | integer | Optional | Value must be a valid client_subaccount_id. (default is NULL) |
| date_from | date | Optional | Value must be a valid date. Based on date_applied (default is NULL) |
| date_to | date | Optional | Value must be a valid date. Based on date_applied (default is NULL) |
| include_items | boolean | Optional | This will add invoice items to the result (default is FALSE) |
Sample response
Sample response for get_resellers_invoices
{
...
"reseller_invoices": {
"reseller_invoice": {
"reseller_invoice_id": "123",
"client_account_id": "3",
"client_subaccount_id": "123",
"date_billing": "2020-09-01",
"date_generated": "0000-00-00",
"subtotal": "29.68",
"current_charges": "34.13",
"web_key": "WEBKEY",
"status": "deleted",
"datetime_updated": "2020-09-02 14:14:22",
"currency": "CAD",
"reseller_invoice_items": {
"reseller_invoice_item": {
"reseller_invoice_item_id": "123",
"client_account_id": "3",
"client_subaccount_id": "123",
"reseller_invoice_id": "123",
"parent_id": "0",
"type": "other",
"service_id": "62",
"reseller_client_service_id": "",
"order_index": "126",
"order_group": "",
"quantity": "0.00",
"amount": "4.45",
"prorata_amount": "0.00",
"date_started": "0000-00-00",
"date_ended": "0000-00-00",
"status": "enabled",
"currency": "CAD"
}
}
}
}
}<?php print '
<?xml version="1.0" encoding="utf-8"?>' . "\n"; ?>
<response>
...
<reseller_invoices>
<reseller_invoice>
<reseller_invoice_id>123</reseller_invoice_id>
<client_account_id>3</client_account_id>
<client_subaccount_id>123</client_subaccount_id>
<date_billing>2020-09-01</date_billing>
<date_generated>0000-00-00</date_generated>
<subtotal>29.68</subtotal>
<current_charges>34.13</current_charges>
<web_key>WEBKEY</web_key>
<status>deleted</status>
<datetime_updated>2020-09-02 14:14:22</datetime_updated>
<currency>CAD</currency>
<reseller_invoice_items>
<reseller_invoice_item>
<reseller_invoice_item_id>123</reseller_invoice_item_id>
<client_account_id>3</client_account_id>
<client_subaccount_id>123</client_subaccount_id>
<reseller_invoice_id>123</reseller_invoice_id>
<parent_id>0</parent_id>
<type>other</type>
<service_id>62</service_id>
<reseller_client_service_id></reseller_client_service_id>
<order_index>126</order_index>
<order_group></order_group>
<quantity>0.00</quantity>
<amount>4.45</amount>
<prorata_amount>0.00</prorata_amount>
<date_started>0000-00-00</date_started>
<date_ended>0000-00-00</date_ended>
<status>enabled</status>
<currency>CAD</currency>
</reseller_invoice_item>
...
</reseller_invoice_items>
</reseller_invoice>
</reseller_invoices>
</response>
Get resellers clients plans
Request Type:
Get the list of resellers clients plans.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| reseller_plan_id | integer | Optional | Value must be a valid reseller_plan_id. |
| billing_qualification | string | Optional | Value must be one of the following: "disabled", "partial" or "complete" |
| funding_status | string | Optional | Value must be one of the following: "sufficient", "deficient" , "past_due" or "negative" |
Sample response
Sample response for get_resellers_clients_plans
{
...
"reseller_client_plans": {
"reseller_client_plan": {
"reseller_client_plan_id": "1763",
"client_subaccount_id": "1919",
"friendly_name": "test20190126",
"custom_id": "test-12394034",
"datetime_created": "2019-01-26 12:25:28",
"client_brand_id": "0",
"reseller_plan_id": "1105",
"resellers_plans_friendly_name": "Cattio Plan",
"organization": "Brad Hello",
"organization_type": "personal",
"client_profile": "undefined",
"address": "4080 Boul Corbusier Laval, Quebec (Canada) H7L 5R2",
"account_balance": "80.7058",
"liable_charges": "17.1134",
"funds_left": "97.8192",
"renewable_amount": "17.1134",
"currency": "CAD",
"net_term": "0",
"grace_period": "0",
"cash_advance_limit": "0.0000",
"billing_type": "postpaid",
"funding_status": "deficient",
"funding_change_date": "2023-08-24",
"billable_status": "active",
"billing_qualification": "partial",
"billing_qualification_reason": "preview_mode_only,no_user_notification_billing"
}
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<reseller_client_plans>
<reseller_client_plan>
<reseller_client_plan_id>1763</reseller_client_plan_id>
<client_subaccount_id>1919</client_subaccount_id>
<friendly_name>test20190126</friendly_name>
<custom_id>test-12394034</custom_id>
<datetime_created>2019-01-26 12:25:28</datetime_created>
<client_brand_id>0</client_brand_id>
<reseller_plan_id>1105</reseller_plan_id>
<resellers_plans_friendly_name>Cattio Plan</resellers_plans_friendly_name>
<organization>Brad Hello</organization>
<organization_type>personal</organization_type>
<client_profile>undefined</client_profile>
<address>4080 Boul Corbusier Laval, Quebec (Canada) H7L 5R2</address>
<account_balance>80.7058</account_balance>
<liable_charges>17.1134</liable_charges>
<funds_left>97.8192</funds_left>
<renewable_amount>17.1134</renewable_amount>
<currency>CAD</currency>
<net_term>0</net_term>
<grace_period>0</grace_period>
<cash_advance_limit>0.0000</cash_advance_limit>
<billing_type>postpaid</billing_type>
<funding_status>deficient</funding_status>
<funding_change_date>2023-08-24</funding_change_date>
<billable_status>active</billable_status>
<billing_qualification>partial</billing_qualification>
<billing_qualification_reason>preview_mode_only,no_user_notification_billing</billing_qualification_reason>
</reseller_client_plan>
...
</reseller_client_plans>
</response>
Get Subaccount Services Rates & Pricing
Request Type:
Get the rates billed to a reseller subaccount for optional add-on services
and metered usage (including communication services such as local and toll-free calling).
Requires client_subaccount_id. Response structure matches
Get Account Services Rates & Pricing,
plus service_origin (internal for platform services,
custom for reseller-defined services). Each service includes
a type field with the service catalog types from the database
(comma-separated SET values such as option, usage,
other, plan, bundle), the applicable
rate, order_index for display ordering, and related billing fields.
Use the optional request parameter type to filter by pricing category (option or usage),
which applies FIND_IN_SET rules against those catalog types - not the billing source self_serve.
For international destination lookup by prefix or country, use Get Calls Rates instead.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| client_subaccount_id | integer | Required | Must be a valid subaccount client_subaccount_id belonging to the authenticated account |
| date | date | Optional | Effective date for plan and rate lookup (default is today) |
| service_id | integer | Optional | Return pricing for a single enabled service only |
| type | string | Optional | Filter by pricing category: option (catalog types option/other, excluding usage) or usage (catalog type usage, excluding option/other). Uses FIND_IN_SET on the response type SET. |
Sample response
Sample response for get_reseller_pricing
{
...
"services": {
"service": [
{
"service_id": "8",
"alias": "comm_local_termination",
"title": "Local outbound calls",
"type": "usage",
"rate": "0.0125",
"currency": "CAD",
"default_term": "none",
"prorated": "no",
"unit": "minute",
"order_index": "8",
"service_origin": "internal"
},
{
"service_id": "12",
"alias": "did_local",
"title": "Local DID",
"type": "option,plan",
"rate": "1.25",
"currency": "CAD",
"default_term": "monthly",
"prorated": "yes",
"unit": "",
"order_index": "12",
"service_origin": "internal"
},
{
"service_id": "1001",
"alias": "custom_support",
"title": "Custom support",
"type": "option",
"rate": "25.00",
"currency": "CAD",
"default_term": "monthly",
"prorated": "no",
"unit": "each",
"order_index": "50",
"service_origin": "custom"
}
]
...
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<services>
<service>
<service_id>8</service_id>
<alias>comm_local_termination</alias>
<title>Local outbound calls</title>
<type>usage</type>
<rate>0.0125</rate>
<currency>CAD</currency>
<default_term>none</default_term>
<prorated>no</prorated>
<unit>minute</unit>
<order_index>8</order_index>
<service_origin>internal</service_origin>
</service>
<service>
<service_id>12</service_id>
<alias>did_local</alias>
<title>Local DID</title>
<type>option,plan</type>
<rate>1.25</rate>
<currency>CAD</currency>
<default_term>monthly</default_term>
<prorated>yes</prorated>
<unit></unit>
<order_index>12</order_index>
<service_origin>internal</service_origin>
</service>
<service>
<service_id>1001</service_id>
<alias>custom_support</alias>
<title>Custom support</title>
<type>option</type>
<rate>25.00</rate>
<currency>CAD</currency>
<default_term>monthly</default_term>
<prorated>no</prorated>
<unit>each</unit>
<order_index>50</order_index>
<service_origin>custom</service_origin>
</service>
...
</services>
</response>
Storage & files
Get Storage statistics
Request Type:
Gather statistical information about storage stats for given period.
| 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)) |
| storage_types | enum | Optional | List of all the client storage types wanted separated by a comma. (default is NULL) |
Sample response with no subaccount_ids specified.
Sample response with no subaccount_ids specified. for get_storage_stats_no_subaccount
{
...
"storage_stats": {
"account": {
"whole_account": {
"recordings_size": {
"storage_type": "recordings_size",
"bytes": "177054096",
"billed_amount": "1.94"
},
"pbx3cxbackup_size": {
"storage_type": "pbx3cxbackup_size",
"bytes": "16793982",
"billed_amount": "0.18"
},
"total": {
"storage_type": "total_size",
"bytes": "193848078",
"billed_amount": "2.12"
}
},
"main_account": {
"recordings_size": {
"storage_type": "recordings_size",
"bytes": "66395286",
"billed_amount": "0.73"
},
"mms_size": {
"storage_type": "mms_size",
"bytes": "3927920",
"billed_amount": "0.04"
},
"total": {
"storage_type": "total_size",
"bytes": "70323206",
"billed_amount": "0.77"
}
}
}
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<storage_stats>
<account>
<whole_account>
<recordings_size>
<storage_type>recordings_size</storage_type>
<bytes>177054096</bytes>
<billed_amount>1.94</billed_amount>
</recordings_size>
...
<pbx3cxbackup_size>
<storage_type>pbx3cxbackup_size</storage_type>
<bytes>16793982</bytes>
<billed_amount>0.18</billed_amount>
</pbx3cxbackup_size>
<total>
<storage_type>total_size</storage_type>
<bytes>193848078</bytes>
<billed_amount>2.12</billed_amount>
</total>
</whole_account>
<main_account>
<recordings_size>
<storage_type>recordings_size</storage_type>
<bytes>66395286</bytes>
<billed_amount>0.73</billed_amount>
</recordings_size>
...
<mms_size>
<storage_type>mms_size</storage_type>
<bytes>3927920</bytes>
<billed_amount>0.04</billed_amount>
</mms_size>
...
<total>
<storage_type>total_size</storage_type>
<bytes>70323206</bytes>
<billed_amount>0.77</billed_amount>
</total>
</main_account>
</account>
</storage_stats>
</response>
Sample response with subaccount_ids specified.
Sample response with subaccount_ids specified. for get_storage_stats_subaccount
{
...
"storage_stats": {
"subaccounts": {
"subaccount": [
{
"client_subaccount_id": [
"123",
"123"
],
"recordings_size": {
"storage_type": "recordings_size",
"bytes": "177054096",
"billed_amount": "1.94"
},
"pbx3cxbackup_size": {
"storage_type": "pbx3cxbackup_size",
"bytes": "16793982",
"billed_amount": "0.18"
},
"total": {
"storage_type": "total_size",
"bytes": "193848078",
"billed_amount": "2.12"
}
},
{
"client_subaccount_id": "321",
"recordings_size": {
"storage_type": "recordings_size",
"bytes": "66395286",
"billed_amount": "0.73"
},
"mms_size": {
"storage_type": "mms_size",
"bytes": "3927920",
"billed_amount": "0.04"
},
"total": {
"storage_type": "total_size",
"bytes": "70323206",
"billed_amount": "0.77"
}
}
]
}
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<storage_stats>
<subaccounts>
<subaccount client_subaccount_id="123">
<client_subaccount_id>123</client_subaccount_id>
<recordings_size>
<storage_type>recordings_size</storage_type>
<bytes>177054096</bytes>
<billed_amount>1.94</billed_amount>
</recordings_size>
...
<pbx3cxbackup_size>
<storage_type>pbx3cxbackup_size</storage_type>
<bytes>16793982</bytes>
<billed_amount>0.18</billed_amount>
</pbx3cxbackup_size>
<total>
<storage_type>total_size</storage_type>
<bytes>193848078</bytes>
<billed_amount>2.12</billed_amount>
</total>
</subaccount>
<subaccount client_subaccount_id="321">
<recordings_size>
<storage_type>recordings_size</storage_type>
<bytes>66395286</bytes>
<billed_amount>0.73</billed_amount>
</recordings_size>
...
<mms_size>
<storage_type>mms_size</storage_type>
<bytes>3927920</bytes>
<billed_amount>0.04</billed_amount>
</mms_size>
...
<total>
<storage_type>total_size</storage_type>
<bytes>70323206</bytes>
<billed_amount>0.77</billed_amount>
</total>
</subaccount>
</subaccounts>
</storage_stats>
</response>
Get Media Files
Request Type:
Get details for media failes.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| client_media_file_id | integer | Optional | Search for a specific media file.Value must be a valid client_media_file_id. (default is NULL) |
| client_media_folder_id | integer | Optional | Search for files in a specific folder.Value must be a valid client_media_folder_id. (default is NULL) |
| client_subaccount_id | integer | Optional | Value must be a valid client_subaccount_id. (default is NULL) |
Sample response
Sample response for get_media_files
{
...
"media_files": {
"media_file": {
"client_media_file_id": "00001234",
"client_media_folder_id": "123",
"friendly_name": "Test file",
"description": "",
"file_hash": "6abd29f31a7e9bc946a1967a3123456",
"preview_media_url": "https://clients.voicemeup.com/file/6abd29f31a7e9bc946a1967a3123456.medias.preview.mp3",
"original_media_url": "https://clients.voicemeup.com/file/6abd29f31a7e9bc946a1967a3123456.medias.wav",
"size": "388746",
"length": "24",
"tts_text": "",
"tts_voice_name": "",
"volume": "1.00",
"options": "",
"is_shared": "0",
"status": "enabled",
"comments": "",
"user_created": "1000",
"user_updated": "1000",
"datetime_created": "2018-08-09 15:20:23",
"datetime_updated": "2023-02-07 11:33:00",
"datetime_synced": "0000-00-00 00:00:00",
"client_subaccount_id": "0",
"original_filename": "test-file.mp3",
"metadata": "{\"test\":123}"
}
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<media_files>
<media_file>
<client_media_file_id>00001234</client_media_file_id>
<client_media_folder_id>123</client_media_folder_id>
<friendly_name>Test file</friendly_name>
<description></description>
<file_hash>6abd29f31a7e9bc946a1967a3123456</file_hash>
<preview_media_url>https://clients.voicemeup.com/file/6abd29f31a7e9bc946a1967a3123456.medias.preview.mp3</preview_media_url>
<original_media_url>https://clients.voicemeup.com/file/6abd29f31a7e9bc946a1967a3123456.medias.wav</original_media_url>
<size>388746</size>
<length>24</length>
<tts_text></tts_text>
<tts_voice_name></tts_voice_name>
<volume>1.00</volume>
<options></options>
<is_shared>0</is_shared>
<status>enabled</status>
<comments></comments>
<user_created>1000</user_created>
<user_updated>1000</user_updated>
<datetime_created>2018-08-09 15:20:23</datetime_created>
<datetime_updated>2023-02-07 11:33:00</datetime_updated>
<datetime_synced>0000-00-00 00:00:00</datetime_synced>
<client_subaccount_id>0</client_subaccount_id>
<original_filename>test-file.mp3</original_filename>
<metadata>{"test":123}</metadata>
</media_file>
</media_files>
</response>
Get file
Request Type:
This request type allows you to securely retrieve files associated with your account using a token-based authentication system. The file content is directly streamed to the client.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| token | string | Required | Secure token for file access authentication. This token identifies and authorizes access to a specific file. |
Sample response
Sample response for get_file
Note: This request type does not return XML/Json data. Instead, it directly streams the requested file content with appropriate headers for file download or display.
The response will include:
- Appropriate Content-Type header based on file type
- Content-Disposition header for file download
- File content streamed directly to the client
Example file types that can be retrieved:
- PDF documents (application/pdf)
- Image files (image/jpeg, image/png, etc.)
- Audio files (audio/wav, audio/mp3, etc.)
Devices & autoprovision
Get Devices
Request Type:
Get all available autoprovision devices
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| make | string | Optional | Value must be a valid make. (default is NULL) |
Sample response
Sample response for get_devices
{
...
"devices": {
"device_details": {
"device_id": "1102",
"make": "Yealink",
"model": "T43U",
"version": "66.84.0.90",
"number_of_lines": "12",
"number_of_buttons": "21",
"features_of_buttons": "line,presence,call_park,speed_dial,paging,intercom,call_pickup,webhook,manual",
"protocol": "https",
"options": "timezone_supported,timeformat_supported,mailbox_supported,extension_supported,language_supported,resync_supported,display_name_supported,admin_password_supported,vlan_supported,rps_supported"
}
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<devices>
<device_details>
<device_id>1102</device_id>
<make>Yealink</make>
<model>T43U</model>
<version>66.84.0.90</version>
<number_of_lines>12</number_of_lines>
<number_of_buttons>21</number_of_buttons>
<features_of_buttons>line,presence,call_park,speed_dial,paging,intercom,call_pickup,webhook,manual</features_of_buttons>
<protocol>https</protocol>
<options>timezone_supported,timeformat_supported,mailbox_supported,extension_supported,language_supported,resync_supported,display_name_supported,admin_password_supported,vlan_supported,rps_supported</options>
</device_details>
</devices>
</response>
Get Device Endpoint (Autoprovision)
Request Type:
If you wish to get details of a device endpoint, you simply have to pass the `client_device_endpoint_id`. If no additional parameter is specified, the complete list of endpoints will be returned.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| client_device_endpoint_id | integer | Optional | Value must be a valid client_device_endpoint_id. (default is NULL) |
| client_subaccount_id | integer | Optional | Value must be a valid client_subaccount_id. (default is NULL) |
| device_mac | string | Optional | Value must be a valid device_mac. (default is NULL) |
| device_id | integer | Optional | Value must be a valid device_id. (default is NULL) |
Sample response
Sample response for get_device_endpoints
{
...
"device_endpoints": {
"device_endpoint_details": {
"client_device_endpoint_id": "1234",
"client_account_id": "1",
"client_subaccount_id": "1",
"device_id": "1082",
"client_peer_ids": "1,2",
"client_mailbox_id": "0",
"client_extension_id": "0",
"button_config": "{\"1\":{\"feature\":\"presence\",\"label\":\"\\u00e9\\u00e9\\u00e7\\u00e7\\u00ee\\u00ee\",\"line\":\"1\",\"feature_value\":\"\"},\"2\":{\"feature\":\"\",\"label\":\"L2\",\"line\":\"1\"},\"3\":{\"feature\":\"\",\"label\":\"L3\",\"line\":\"1\"},\"4\":{\"feature\":\"\",\"label\":\"L4\",\"line\":\"1\"},\"5\":{\"feature\":\"\",\"label\":\"L5\",\"line\":\"1\"},\"6\":{\"feature\":\"\",\"label\":\"L6\",\"line\":\"1\"},\"7\":{\"feature\":\"\",\"label\":\"L7\",\"line\":\"1\"},\"8\":{\"feature\":\"\",\"label\":\"L8\",\"line\":\"1\"},\"9\":{\"feature\":\"\",\"label\":\"L9\",\"line\":\"1\"},\"10\":{\"feature\":\"\",\"label\":\"L10\",\"line\":\"1\"},\"11\":{\"feature\":\"\",\"label\":\"L11\",\"line\":\"1\"},\"12\":{\"feature\":\"\",\"label\":\"L12\",\"line\":\"1\"},\"13\":{\"feature\":\"\",\"label\":\"L13\",\"line\":\"1\"},\"14\":{\"feature\":\"\",\"label\":\"L14\",\"line\":\"1\"},\"15\":{\"feature\":\"\",\"label\":\"L15\",\"line\":\"1\"},\"16\":{\"feature\":\"\",\"label\":\"L16\",\"line\":\"1\"}}",
"admin_password": "password",
"device_name": "",
"friendly_name": "Test Dev",
"token": "3ff221573d96c0352307678963b26456",
"token_date_created": "2018-11-16",
"token_user_created": "1003",
"provision_url": "http://test.com//ap/3ff221573d96c0352307678963b26456/",
"device_mac": "AA:BB:CC:DD:EE:FF",
"serial_number": "",
"time_zone_id": "0",
"client_password": "",
"language": "fr",
"is_time_format24h": "",
"is_vlan_enabled": "0",
"vlan": "0",
"call_waiting": "active",
"call_forwarding": "allow",
"factory_reset": "allow",
"status": "enabled",
"comments": "",
"metadata": {
"raw_metadata": "",
"metadata_attributes": {
"attribute_count": "1"
}
}
}
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<device_endpoints>
<device_endpoint_details>
<client_device_endpoint_id>1234</client_device_endpoint_id>
<client_account_id>1</client_account_id>
<client_subaccount_id>1</client_subaccount_id>
<device_id>1082</device_id>
<client_peer_ids>1,2</client_peer_ids>
<client_mailbox_id>0</client_mailbox_id>
<client_extension_id>0</client_extension_id>
<button_config>{"1":{"feature":"presence","label":"\u00e9\u00e9\u00e7\u00e7\u00ee\u00ee","line":"1","feature_value":""},"2":{"feature":"","label":"L2","line":"1"},"3":{"feature":"","label":"L3","line":"1"},"4":{"feature":"","label":"L4","line":"1"},"5":{"feature":"","label":"L5","line":"1"},"6":{"feature":"","label":"L6","line":"1"},"7":{"feature":"","label":"L7","line":"1"},"8":{"feature":"","label":"L8","line":"1"},"9":{"feature":"","label":"L9","line":"1"},"10":{"feature":"","label":"L10","line":"1"},"11":{"feature":"","label":"L11","line":"1"},"12":{"feature":"","label":"L12","line":"1"},"13":{"feature":"","label":"L13","line":"1"},"14":{"feature":"","label":"L14","line":"1"},"15":{"feature":"","label":"L15","line":"1"},"16":{"feature":"","label":"L16","line":"1"}}</button_config>
<admin_password>password</admin_password>
<device_name></device_name>
<friendly_name>Test Dev</friendly_name>
<token>3ff221573d96c0352307678963b26456</token>
<token_date_created>2018-11-16</token_date_created>
<token_user_created>1003</token_user_created>
<provision_url>http://test.com//ap/3ff221573d96c0352307678963b26456/</provision_url>
<device_mac>AA:BB:CC:DD:EE:FF</device_mac>
<serial_number></serial_number>
<time_zone_id>0</time_zone_id>
<client_password></client_password>
<language>fr</language>
<is_time_format24h></is_time_format24h>
<is_vlan_enabled>0</is_vlan_enabled>
<vlan>0</vlan>
<call_waiting>active</call_waiting>
<call_forwarding>allow</call_forwarding>
<factory_reset>allow</factory_reset>
<status>enabled</status>
<comments></comments>
<metadata>
<raw_metadata></raw_metadata>
<metadata_attributes attribute_count="1"></metadata_attributes>
</metadata>
</device_endpoint_details>
</device_endpoints>
</response>
Update Device Endpoint (Autoprovision)
Request Type:
Allows you to create or simply update a Device Endpoint (Autoprovision).
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| mode | string | Optional | Value must be "update" or "create". (default is update) |
| client_device_endpoint_id | integer | Optionally required | If mode is "update", value must be a valid client_device_endpoint_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. |
| device_id | integer | Required | Value must be a valid device_id see Get devices. |
| device_name | string | Optional | |
| client_peer_ids | string | Optional | List of all the client_peer_id used separated by a comma. If the device supports label can also include labels using the | symbol (eg: 1234|Mike Phone,5678|Barbara) |
| client_extension_id | integer | Optionally required | Value must be a valid client_extension_id |
| client_mailbox_id | integer | Optionally required | Value must be a valid client_mailbox_id |
| device_mac | string | Optional | Value must be a valid mac address, we support (AABBCCDDEE or AA:BB:CC:DD:EE) |
| serial_number | string | Optional | Device Serial Number |
| timezone_id | string | Optional | Value must be a valid timezone_id. |
| admin_password | string | Optional | Administrator password for accessing device settings and configuration |
| client_password | string | Optional | Client/user password for device access |
| language | string | Optional | Value must be one of the following: "fr" or "en" |
| is_time_format24h | boolean | Optional | Value must be one of the following: "1" or "0" |
| is_vlan_enabled | string | Optional | Value must be one of the following: "1" or "0" |
| vlan | number | Optional | If Vlan is enabled put the Vlan ID here |
| call_waiting | string | Optional | Value must be one of the following: "active" or "inactive" |
| call_forwarding | string | Optional | Value must be one of the following: "allow" or "disallow" |
| is_vlan_enabled | string | Optional | Value must be one of the following: "allow" or "disallow" |
| button_config | JSON | Optional | The button config in JSON format. Example : {"1":{"feature":"presence","label":"Steve Ruck","line":"1","feature_value":"dnis_test"},"2":{"feature":"speed_dial","label":"PARK","line":"3","feature_value":"5141234568"}} Detailed documentation will be provided soon, in the meantime I suggest building it through the client section and getting the results via Get device endpoints (Autoprovision) and go from there. |
| status | string | Optional | Value must be one of the following: "enabled", "disabled" or "deleted" |
| comments | string | Optional |
Delete Device Endpoint (Autoprovision)
Request Type:
Delete a Device Endpoint from your account.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| client_device_endpoint_id | integer | Required | Value must be a valid client_device_endpoint_id. |
3CX integration
Get 3cx Server Details
Request Type:
If you wish to get details of a 3cx server, you simply have to pass the `pbx3cx_server_id`. If no additional parameter is specified, the complete list of servers will be returned.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| pbx3cx_server_id | integer | Optional | Value must be a valid pbx3cx_server_id. (default is NULL) |
| client_subaccount_id | integer | Optional | Value must be a valid client_subaccount_id. (default is NULL) |
| friendly_name | string | Optional | Value must be a valid string. (default is NULL) |
| server_fqdn | string | Optional | Value must be a valid string. (default is NULL) |
| license_key | string | Optional | Value must be a valid string. (default is NULL) |
| level | integer | Optional | Value must be a valid service level (1, 2 or 3). (default is NULL) |
Sample response
Sample response for get_3cx_servers
{
...
"pbx3cx_servers": {
"pbx3cx_server_details": {
"pbx3cx_server_id": "1603",
"client_account_id": "3",
"client_subaccount_id": "0",
"friendly_name": "Serveur 2",
"level": "1",
"server_fqdn": "serveur2.vmu.3cx.qc.ca.gouv",
"server_port": "5001",
"server_username": "",
"is_connection_allowed": "0",
"license_key": "12345678946",
"license_expiration": "2025-01-30",
"license_status": "",
"product_edition": "Professional",
"product_simultaneous_calls": "4",
"options": "backup_includes_voicemails",
"backup_hour": "1",
"backup_frequency": "1_day",
"backup_retention": "1_day",
"call_retention": "1_year",
"dns_service": "dns_cloudns",
"auth_type": "account",
"auth_id": "",
"auth_password": "",
"certificate_token": "",
"ssl_last_deploy_datetime": "0000-00-00 00:00:00",
"ssl_last_restart_datetime": "0000-00-00 00:00:00",
"ssl_expiration_date": "0000-00-00",
"monitoring_status": "",
"subscribed_monitoring": "system,trunks,services",
"alert_status": "",
"subscribed_alerts": "services,callflows,sip_test",
"alert_recipients": "hello1@test.com",
"maintenance_mode_expiration_datetime": "0000-00-00 00:00:00",
"maintenance_mode": "",
"metadata": [
"",
{
"raw_metadata": "",
"metadata_attributes": ""
}
],
"comments": "",
"status": "enabled",
"foreign_entities_list": ""
}
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<pbx3cx_servers>
<pbx3cx_server_details>
<pbx3cx_server_id>1603</pbx3cx_server_id>
<client_account_id>3</client_account_id>
<client_subaccount_id>0</client_subaccount_id>
<friendly_name>Serveur 2</friendly_name>
<level>1</level>
<server_fqdn>serveur2.vmu.3cx.qc.ca.gouv</server_fqdn>
<server_port>5001</server_port>
<server_username></server_username>
<is_connection_allowed>0</is_connection_allowed>
<license_key>12345678946</license_key>
<license_expiration>2025-01-30</license_expiration>
<license_status></license_status>
<product_edition>Professional</product_edition>
<product_simultaneous_calls>4</product_simultaneous_calls>
<options>backup_includes_voicemails</options>
<backup_hour>1</backup_hour>
<backup_frequency>1_day</backup_frequency>
<backup_retention>1_day</backup_retention>
<call_retention>1_year</call_retention>
<dns_service>dns_cloudns</dns_service>
<auth_type>account</auth_type>
<auth_id></auth_id>
<auth_password></auth_password>
<certificate_token></certificate_token>
<ssl_last_deploy_datetime>0000-00-00 00:00:00</ssl_last_deploy_datetime>
<ssl_last_restart_datetime>0000-00-00 00:00:00</ssl_last_restart_datetime>
<ssl_expiration_date>0000-00-00</ssl_expiration_date>
<monitoring_status></monitoring_status>
<subscribed_monitoring>system,trunks,services</subscribed_monitoring>
<alert_status></alert_status>
<subscribed_alerts>services,callflows,sip_test</subscribed_alerts>
<alert_recipients>hello1@test.com</alert_recipients>
<maintenance_mode_expiration_datetime>0000-00-00 00:00:00</maintenance_mode_expiration_datetime>
<maintenance_mode></maintenance_mode>
<metadata></metadata>
<comments></comments>
<status>enabled</status>
<foreign_entities_list></foreign_entities_list>
<metadata>
<raw_metadata></raw_metadata>
<metadata_attributes/>
</metadata>
</pbx3cx_server_details>
</pbx3cx_servers>
</response>
Update a 3cx Server
Request Type:
Allows you to create or simply update a 3cx Server.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| mode | string | Optional | Value must be "update" or "create". (default is update) |
| pbx3cx_server_id | integer | Optionally required | If mode is "update", value must be a valid pbx3cx_server_id |
| client_subaccount_id | integer | Optional | Value must be a valid client_subaccount_id. |
| friendly_name | string | Required | Value must be alphanumeric string from 2 to 32 characters. |
| server_port | integer | Optional | Value must a valid port (default 443). |
| level | string | Optional | Value must be one of the following service level values: "1" or "2" or "3" |
| server_fqdn | string | Optional | Value must be a valid FQDN. |
| is_connection_allowed | boolean | Optional | Value must be one of the following: "1" or "0" (default 0). If set will connect to the server using the "server_name" and "server_password" for synchronisation and maintenance. Required for the following options : 'sync_calls','sync_recording_media','sync_voicemail_media','sync_backups','auto_renew_ssl' Required for "monitoring_status" enabled. |
| server_name | string | Optionally Required | Value must be alphanumeric. Required for "is_connection_allowed". |
| server_password | string | Optionally Required | Value must be alphanumeric. Required for "is_connection_allowed". |
| license_key | string | Optional | Value must be a valid 3cx License Key. |
| license_expiration | date | Optional | Value must be a valid date in "Y-m-d" format. |
| product_edition | string | Optional | Value must be one of the following: 'Professional','Standard','Enterprise','Startup' |
| product_simultaneous_calls | string | Optional | Value must be one of the following: '4','8','16','24','32','48','64','96','128','192','256','512','1024' |
| options | string | Optional | Value must be any of the following comma seperated: 'sync_calls', 'sync_recording_media', 'sync_voicemail_media', 'backup_includes_voicemails', 'sync_backups', 'backup_includes_templates', 'encrypt_backup', 'auto_renew_ssl' |
| encrypt_backup_password | string | Optionally Required | Value must be alphanumeric. Required for "encrypt_backup". |
| backup_frequency | string | Optional | Value must be one of the following: '1_day','3_day','1_week','2_week','1_month','3_month' (default 3_day) |
| backup_retention | string | Optional | Value must be one of the following: 'none', '1_day','3_day','1_week','2_week','1_month','3_month' (default 3_day) |
| call_retention | string | Optional | Value must be one of the following: 'none','1_week','1_month','3_month','6_month','1_year','2_year','3_year','5_year','8_year','10_year' (default 3_year) |
| dns_service | string | Optional | Value must be one of the following: 'dns_cloudns','dns_cf'. Please see FAQ for more details. |
| auth_type | string | Optional | Value must be one of the following: 'account','subaccount'. Please see FAQ for more details. Required for 'dns_cloudns' |
| auth_id | string | Optional | Value must be alphanumeric. Please see FAQ for more details. Required for 'dns_cloudns' |
| auth_password | string | Optional | Value must be alphanumeric. Please see FAQ for more details. Required for 'dns_cloudns' |
| certificate_token | string | Optional | Value must be alphanumeric. Please see FAQ for more details. Required for 'dns_cf' |
| monitoring_status | string | Optional | Value must be one of the following: "enabled" or "disabled" |
| subscribed_monitoring | string | Optional | Value must be one of the following: 'system','trunks','services','callflows','sip_test','call_test','system_additional','voicemail','backup','ssl' |
| alert_status | string | Optional | Value must be one of the following: "enabled" or "disabled" |
| subscribed_alerts | string | Optional | Value must be one of the following: 'connectivity','system','trunks','services','callflows','sip_test','call_test','system_additional','voicemail','backup','ssl' Services must be active in 'subscribed_monitoring' for alerting to work. |
| alert_recipients | string | Optional | Coma separated list of email recipients for all alerts |
| status | string | Optional | Value must be one of the following: "enabled", "disabled" or "deleted" |
| comments | string | Optional |
Delete a 3CX Server
Request Type:
Delete a 3cx Server from your account.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| pbx3cx_server_id | integer | Required | Value must be a valid pbx3cx_server_id. |
Get 3CX call history
Request Type:
Retrieve 3CX Calls History.
| 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". |
| 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. |
| 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) |
| bindings | string | Optional | Value must be one of the following: "recording", "voicemail" (default is all) |
| client_subaccount_id | integer | Optional | Value must be a valid client_subaccount_id. (default is NULL) |
Sample response
Sample response for get_3cx_calls
{
...
"calls": {
"entries_count": "225",
"call_details": {
"call_hash": [
"e7d970de310b197b2d7498c92d58f72a",
"b199f37fbdvf69db52113f608c5e5911"
],
"pbx3cx_server_id": "1234",
"datetime_start": "2025-01-03 08:57:50",
"datetime_end": "2025-01-03 09:00:10",
"date": "2025-01-03",
"time": "08:57:50",
"direction": "outbound",
"disposition": "answered",
"routing_type": "local_termination",
"duration": "140",
"callerid_name": "George Bush",
"callerid_number": "226",
"source": "226",
"destination": "15142357594",
"privacy": "no",
"country_id": "38",
"state_id": "11",
"exchange_id": "514235",
"ratecenter_id": "171610",
"bindings": "recording",
"recording_id": "27161",
"file_name": "[George Bush]_226-5142357594_20250103115759(873)",
"file_extension": "mp3",
"file_size": "281808",
"file_url": "https://clients.voicemeup.com/file/b199f37fbdvf69db52113f608c5e5911.3cx_calls.mp3",
"comments": "",
"status": "enabled"
}
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<calls entries_count="225">
<call_details call_hash="e7d970de310b197b2d7498c92d58f72a">
<pbx3cx_server_id>1234</pbx3cx_server_id>
<call_hash>b199f37fbdvf69db52113f608c5e5911</call_hash>
<datetime_start>2025-01-03 08:57:50</datetime_start>
<datetime_end>2025-01-03 09:00:10</datetime_end>
<date>2025-01-03</date>
<time>08:57:50</time>
<direction>outbound</direction>
<disposition>answered</disposition>
<routing_type>local_termination</routing_type>
<duration>140</duration>
<callerid_name>George Bush</callerid_name>
<callerid_number>226</callerid_number>
<source>226</source>
<destination>15142357594</destination>
<privacy>no</privacy>
<country_id>38</country_id>
<state_id>11</state_id>
<exchange_id>514235</exchange_id>
<ratecenter_id>171610</ratecenter_id>
<bindings>recording</bindings>
<recording_id>27161</recording_id>
<file_name>[George Bush]_226-5142357594_20250103115759(873)</file_name>
<file_extension>mp3</file_extension>
<file_size>281808</file_size>
<file_url>https://clients.voicemeup.com/file/b199f37fbdvf69db52113f608c5e5911.3cx_calls.mp3</file_url>
<comments/>
<status>enabled</status>
. . .
</call_details>
</calls>
</response>
Messaging & testing
Queue Message
Request Type:
You can send an email message to a custom recipient with this request type. This API allows you to queue email messages using a predefined message template with custom subject, content, and recipient information.
The API includes duplicate detection based on recipient contact information and message content to prevent sending duplicate messages.
On success, the API returns the number of emails queued and the message_log_ids for tracking purposes. On failure, it returns false.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| contact_email | Required | Value must be a valid email address for the recipient. | |
| contact_name | string [255] | Required | Value must be the full name of the recipient. |
| language | string [2] | Optional | Language code for the message template (e.g., 'en', 'fr', 'es'). If not specified, the default language will be used. |
| client_subaccount_id | integer | Optional | Value must be a valid client subaccount ID for message personalization. |
| email_subject | string | Required | The subject line for the email message. |
| email_content | string | Required | The content/body of the email message. |
| client_brand_id | integer | Optionall | The brand ID to use for the message. Brand must belong to your account. This parameter is ignored if client_subaccount_id is specified. |
| message_id | integer | Required | Value must be a valid message template ID from the EMAIL_TEMPLATES table. |
| test_only | boolean | Optional | Value must be true or false. When true, message is processed but not actually sent. (default is false) |
Sample response
Sample response for queue_message
{
"response_messages": {
"message": [
{
"type": "notice",
"code": "emails_queued",
"_content": "1"
},
{
"type": "notice",
"code": "message_log_ids",
"_content": "98765"
}
]
}
}<?xml version="1.0" encoding="utf-8"?>
<response_messages>
<message type="notice" code="emails_queued"><![CDATA[1]]></message>
<message type="notice" code="message_log_ids"><![CDATA[98765]]></message>
</response_messages>
Error types
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 Calls 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. |
Api Metadata
Metadata update (input)
Metadata can be submitted as serialized_metadata or raw_metadata.
| Parameter | Type ? | Requirement | Description |
|---|---|---|---|
| serialized_metadata | serialized array | Optional | Value must be a valid array converted to a serialized string (using php's serialize). (default is NULL) |
| raw_metadata | string | Optional | Value can be anything and will be returned as such [JSON Format is preferred]. (default is NULL) |
Applicable request types: update_did, update_peer,
update_mailbox, update_extension,
update_subaccount, update_port_request.
Retreive metadata (output)
Metadata is output in the main <metadata> tag.
Any data in the metadata field of the entry will be returned as CDATA under the <raw_metadata> tag.
If the data was supplied as an array, or pair of attributes (also called Name-Value Pairs), it will be returned as an XML tree under the <metadata_attributes> tag with an attribute_count property.
Sample response
Sample response
{
...
"metadata": {
"raw_metadata": "a:3:{s:13:\"tout_le_monde\";s:8:\"en parle\";s:6:\"piment\";s:4:\"fort\";s:5:\"super\";s:3:\"man\";}",
"metadata_attributes": {
"attribute_count": "3",
"tout_le_monde": "en parle",
"piment": "fort",
"super": "man"
}
}
}<?xml version="1.0" encoding="utf-8"?>
<response>
...
<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>
</response>
get_dids, get_peers, get_mailboxes,
get_extensions, get_fax_profiles, get_sms_profiles,
get_subaccounts, get_port_requests.
Changelog
2026-07-06
- Updated: update_fax_profile added new option force_cover_page - Requires a cover page when sending faxes via the client Send Fax app. Requires option
enable_cover_pageto be selected.
2026-07-01
- Added : API now supports the get_pricing request type
- Added : API now supports the get_reseller_pricing request type
2026-06-30
- Added : API now supports the get_invoices request type
2026-05-28
- Modified : get_network_status now returns a data node inside each event_details, containing data_entry elements with type, datetime, and description fields.
- Modified : get_network_status removed unused solution field from response.
2026-05-19
- Updated: update_sms_profile added new parameter callback_subtype - Specifies which SMS event types trigger the webhook callback. Required when option
enable_callbackis selected. Accepted values:inbound_success,outbound_success,outbound_failed,delivered. - Updated: update_did added new parameter sms_callback_subtype - Specifies which SMS event types trigger the DID-level SMS callback. Required when option
enable_sms_callbackis set. Accepted values:inbound_success,outbound_success,outbound_failed,delivered.
2026-04-01
- Added: update_reseller_transaction - New request type for adding or modifying reseller transaction.
2026-01-05
- Added: queue_sms now supports multi-recipient SMS - Pass
destination_numberas an array to send to multiple recipients in a single request. Each recipient receives an individual SMS message with per-recipient error tracking and a type-safe response structure.
2025-10-29
- Updated: get_subaccounts added new parameter for : custom_id - Allows filtering subaccounts by custom identifier
2025-10-21
- Added: get_file - New request type for secure file retrieval using token-based authentication. Allows direct streaming of file content with appropriate headers for various file types including PDFs, images, audio files, and other documents.
2025-10-01
- Updated : update_did added new parameter for : special_attributes
- Updated : get_dids added new parameter for : special_attributes
2025-09-26
- Added: simulate_response - New request type for testing different API response scenarios including success, failures, timeouts, server errors, rate limiting, unauthorized access, and maintenance mode. Useful for testing error handling and various edge cases without affecting real data.
2025-09-15
- Added: queue_message - New request type for sending email messages to custom recipients using predefined message templates with personalization tokens
2025-06-04
- Updated : get_recordings added new parameter for : client_subaccount_id
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_codeparameter.
2024-09-20
- Updated : update_peer added missing
internal_cid_modeargument. - Updated : update_peer added missing
internal_cid_nameargument. - Updated : update_peer added missing
internal_cid_numberargument.
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_idparameter. - Added : get_dids added
announce_media_file_idparameter. - Added : get_dids added
bridge_uriparameter. - Added : get_dids added
client_conference_profile_idparameter. - Added : get_dids added
enable_faxparameter. - Added : get_dids added
ondemand_recordingparameter. - Added : get_dids added
client_fax_profile_idparameter. - Added : get_dids added
dnis_rewriteparameter. - Added : get_dids added
enable_voicemailparameter. - Added : get_dids added
confirm_media_file_idparameter. - Added : get_dids added
sms_dnis_rewriteparameter. - Added : get_dids added
usage_typeparameter. - Added : get_dids added
playback_media_file_idparameter. - Added : get_dids added
sms_autoreply_messageparameter. - Added : get_dids added
recording_notify_recipient_nameparameter. - Added : get_dids added
recording_notify_recipient_emailparameter. - Added : get_dids added
peer_failover_causesparameter. - Added : get_dids added
sip_responseparameter. - Added : get_dids added
exclude_e411_listparameter. - Added : get_dids added
exclude_e911_listparameter. - Added : get_dids added
client_moh_profile_idparameter. - Added : update_did added
typeparameter. - Added : update_did added
usage_typeparameter. - Added : update_did added
recording_notify_recipient_nameparameter. - Added : update_did added
recording_notify_recipient_emailparameter. - Added : update_did added
peer_failover_causesparameter. - Added : update_did added
pickup_group_idsparameter. - Added : update_did added
sms_dnis_rewriteparameter. - Added : update_did added
exclude_e411_listparameter. - Added : update_did added
exclude_e911_listparameter.
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_idargument. - Fixed : queue_status was replaced with correct agent_status argument in update_queue_agent.
2023-12-18
- Updated : update_extension added
dnis_rewriteargument.
2023-12-08
- Updated : update_e911
rate_provider_idparameter is now available to set desired provider if has access.
2023-08-28
- Updated : update_peer
usernameparameter is now deprecated in favor ofpeer_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_urlandoptionnow hasenable_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_idfor get_fax_profiles - Modified : get_plans added
plan_idparameter andplan_groups_idparameter.
2018-10-11
- Added : API now supports deleting peers using delete_peers
- Added : API now supports creating peers using update_peers and the
modeparameter. - Modified : get_peers added
status,port,proxy_id,host_type,client_mailbox_id,commentsto output. - Modified : update_peers added
portparameter.
2018-10-04
- Modified : get_subaccounts added
statusparameter. - Modified : get_subaccounts added
get_associationsparameter. - Modified : get_subaccounts removed
get_peers_detailsparameter. - Modified : get_subaccounts removed
get_dids_detailsparameter. - 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_limitandresult_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_inandspecial_attributeselements.
2018-09-04
- Modified : get_subaccounts added
get_peers_detailsparameter. - Modified : get_subaccounts added
get_dids_detailsparameter.
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_formatargument. - Modified : get_peers added
dnis_modeanddnis_formatto returned values.
2018-05-24
- Added : update_peer added
smartvalue to the argumentcallerid_mode. - Added : update_peer added
client_callerid_profile_idargument.
2018-05-09
- Modified : update_peer added
dnis_modeargument. - Modified : update_peer
enable_dnisis now deprecated in favor ofdnis_mode. Original fields will keep working and will setdnis_modeto forced. - Modified : get_peers added
e911to api return.
2018-03-26
- Modified : queue_fax added
page_formatargument. - 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_autoreplyoption andsms_autoreply_messageargument.
2017-10-23
- Modified : get_network_status added
modeargument.
2017-09-11
- Modified : get_recordings added
latest_hoursargument. - Modified : get_calls added
latest_hoursargument.
2017-09-01
- Modified : order_new_dids added
mms_supportedargument. - Modified : get_dids added
attachment_size(in bytes) to api return. - Modified : get_dids added
mms_supportargument and addedmms_supportto 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_urlnow are optionally required when their option are selected.
2017-08-02
- Modified : update_did
notify_callback_urlhas extra validation. A test hit will be made and expect an HTTP code 200. - Modified : update_peer
notify_callback_urlhas extra validation. A test hit will be made and expect an HTTP code 200. - Added : update_did added
voice_languageparameter. - Added : update_extensions added
voice_languageparameter. - 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_huntoption is now removed in favor ofpeer_contact_mode.
2017-07-24
- Added : update_call_director_profile added
announce_media_file_idparameter and theannounce_calleroption. - Added : update_did added
announce_media_file_idparameter and theannounce_calleroption. - Added : update_extensions added
announce_media_file_idparameter and theannounce_calleroption.
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_idin favor ofcall_hash. - Deprecated : report_call_issue Deprecated
unique_idin favor ofcall_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_triggersparameters and theenable_notify_callbackoption. - Added : update_peer added
notification_callback_url,notification_callback_triggersandenable_notify_callbackparameters.
2017-05-12
- Added : get_calls 10 new fields returned if argument
extrasis set toyes.
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)