Show/hide List Operations Expand Operations

Accounts

/accounts

GET /accounts

Get the list of all accounts

Documentation
Sandbox

Documentation

Allow the admin to get the list of all accounts.

Response Format

 {
    "code": 200,
    "data": {
        "limit": 1,
        "page": 1,
        "results": [
            {
                "number": 1234567,
                "email": "user@exmaple.com",
                "contact_number": "1234567890",
                "firstname": "Regular",
                "lastname": "User",
            }
        ],
        "total": 1
    }
 }

Filters

Name

Information

page

Requirement	\d+
Description	Zero based offset index for the results. e.g. 0 would start at the first result and 10 would start at the eleventh result.
Default	1

limit

Requirement	\d+
Description	Maximum number of results to return in the response.
Default	10

filter

Requirement

Description

Allowed fields: number, email, contact_number, firstname, lastname. Use the following delimiters to build your filters params. The vertical bar ('|') to separate individual filter phrases and a double colon ('::') to separate the names and values. The delimiter of the double colon (':') separates the property name from the comparison value, enabling the comparison value to contain spaces. Example: www.example.com\\\/users?filter='name::todd|city::denver|title::grand poobah

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
200	Returned when successful
404	Resource not found

Input

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

POST /accounts

Create a new account

Documentation
Sandbox

Documentation

Create a new account.

Request Format

 {
    "account": {
        "number": "99674698089",
        "roles": ["USER"],
        "email": "coolmint@test.com",
        "contact_number": "4079876543",
        "firstname": "Cool",
        "lastname": "Mint"
    }
 }

Response Format

 {
    "number": 1234567,
    "email": "user@exmaple.com",
    "contact_number": "1234567890",
    "firstname": "Regular",
    "lastname": "User"
 }

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
201	Resource created successful
400	Request could not be understood
404	Resource not found

Input

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/accounts/{account_number}

DELETE /accounts/{account_number}

Delete an account

Documentation
Sandbox

Documentation

Delete an account

Requirements

Name	Requirement	Type	Description
account_number		string	The account number

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
204	Resource updated successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /accounts/{account_number}

Get specific a specific account

Documentation
Sandbox

Documentation

Allow clients to get a specific account.

Response Format

 {
    "code": 200,
    "data": {
        "number": "99674698089",
        "roles": "USER",
        "email": "coolmint@test.com",
        "contact_number": "4079876543",
        "firstname": "Cool",
        "lastname": "Mint"
    }
 }

Requirements

Name	Requirement	Type	Description
account_number		string

Return

Parameter	Type	Versions	Description
number	string	*

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

PUT /accounts/{account_number}

Update the account

Documentation
Sandbox

Documentation

Update an account by a given account_number

Request Format

 {
    "account": {
        "number": "99674698089",
        "roles": "USER",
        "email": "coolmint@test.com",
        "contact_number": "4079876543",
        "firstname": "Cool",
        "lastname": "Mint"
    }
 }

Requirements

Name	Requirement	Type	Description
account_number		string	account number

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
201	Resource created successful
204	Resource updated successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/accounts/{account_number}/access-tokens

GET /accounts/{account_number}/access-tokens

Get the list of tokens for the specific account

Documentation
Sandbox

Documentation

Allow clients to get the list of tokens for the specific account.

Response Format

 {
    "code": 200,
    "data": {
      "limit": 1,
      "total": 5,
      "page": 1,
      "results": [
        {
            "is_active": true,
            "token": "justatoken",
            "created": "2016-02-17T16:29:25+0000"
        }
      ]
    }
  }

Requirements

Name	Requirement	Type	Description
account_number		string

Filters

Name

Information

page

Requirement	\d+
Description	Zero based offset index for the results. e.g. 0 would start at the first result and 10 would start at the eleventh result.
Default	1

limit

Requirement	\d+
Description	Maximum number of results to return in the response.
Default	10

Return

Parameter	Type	Versions
is_active	boolean	*
token	string	*
created	DateTime	*

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

POST /accounts/{account_number}/access-tokens

Create a new account

Documentation
Sandbox

Documentation

Create a new Access Token.

Response Format

 {
    "is_active": true,
    "token": "justatoken",
    "created": "2016-02-17T16:29:25+0000"
 }

Requirements

Name	Requirement	Type	Description
account_number

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
201	Resource created successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/accounts/{account_number}/access-tokens/{token}

DELETE /accounts/{account_number}/access-tokens/{token}

Delete an access token

Documentation
Sandbox

Documentation

Delete an access token

Requirements

Name	Requirement	Type	Description
account_number		string	The account number
token		string

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
204	Resource updated successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /accounts/{account_number}/access-tokens/{token}

Get specific a specific account

Documentation
Sandbox

Documentation

Allow clients to get a specific token.

Response Format

{
    "code": 200,
    "data": {
        "is_active": true,
        "token": "3ddea000f222f2aaa16f4cac7ac5d669a65eea65",
        "created": "2016-02-17T16:29:25+0000"
    }
}

Requirements

Name	Requirement	Type	Description
account_number		string
token		string

Return

Parameter	Type	Versions
is_active	boolean	*
token	string	*
created	DateTime	*

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

PATCH /accounts/{account_number}/access-tokens/{token}

Update the account

Documentation
Sandbox

Documentation

Update an account by a given account_number

Request Format

 {
    "token": {
        "is_active": true
    }
 }

Requirements

Name	Requirement	Type	Description
account_number		string	account number
token		string

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
201	Resource created successful
204	Resource updated successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/accounts/{account_number}/caller_locations

DELETE /accounts/{account_number}/caller_locations

Delete a caller location

Documentation
Sandbox

Documentation

Delete a caller location

Requirements

Name	Requirement	Type	Description
account_number		string	The account number

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
204	Resource updated successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /accounts/{account_number}/caller_locations

Get the list of all caller location in accounts

Documentation
Sandbox

Documentation

Allow clients to get the list of caller locations for the specific account.

Response Format

 {
   "code": 200,
   "data": {
       "limit": 1,
       "page": 1,
       "results": [
        {
            "name":"John Smith",
            "address":"123 Street Name",
            "city":"Orlando",
            "region":"FL",
            "postal_code":32819,
            "unit_type":"unit or suite or apt",
            "unit_number": 123
        }
       ],
       "total": 1
   }
 }

Requirements

Name	Requirement	Type	Description
account_number

Filters

Name

Information

page

Requirement	\d+
Description	Zero based offset index for the results. e.g. 0 would start at the first result and 10 would start at the eleventh result.
Default	1

limit

Requirement	\d+
Description	Maximum number of results to return in the response.
Default	10

filter

Requirement

Description

Allowed fields: trunk_handle. Use the following delimiters to build your filters params. The vertical bar ('|') to separate individual filter phrases and a double colon ('::') to separate the names and values. The delimiter of the double colon (':') separates the property name from the comparison value, enabling the comparison value to contain spaces. Example: www.example.com\\\/users?filter='name::todd|city::denver|title::grand poobah

Return

Parameter	Type	Versions
name	string	*
unit_type	object (UUnitType)	*
unit_type[handle]	string	*
unit_type[name]	string	*
unit_number	string	*

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

POST /accounts/{account_number}/caller_locations

Create a new caller location

Documentation
Sandbox

Documentation

Create a new caller location.

Request Format

 {
    "caller_location": {
        "name":"John Smith",
        "address":"123 Street Name",
        "city":"Orlando",
        "region":"FL",
        "postal_code":32819,
        "unit_type":"unit",
        "unit_number": 123,
        "country": "US"
    }
 }

Response Format

 {
    "name":"John Smith",
    "address":"123 Street Name",
    "city":"Orlando",
    "region":"FL",
    "postal_code":32819,
    "unit_type":"unit or suite or apt",
    "unit_number": 123
 }

Requirements

Name	Requirement	Type	Description
account_number

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
201	Resource created successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/accounts/{account_number}/caller_locations/{caller_location_id}

DELETE /accounts/{account_number}/caller_locations/{caller_location_id}

Delete a caller location by ID

Documentation
Sandbox

Documentation

Delete a caller location by ID

Requirements

Name	Requirement	Type	Description
account_number		string	The account number
caller_location_id		string	The caller location id

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
204	Resource updated successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /accounts/{account_number}/caller_locations/{caller_location_id}

Get specific trunk

Documentation
Sandbox

Documentation

Allow clients to get the a specific caller locations.

Response Format

 {
   "code": 200,
   "data": {
        "name":"John Smith",
        "address":"123 Street Name",
        "city":"Orlando",
        "region":"FL",
        "postal_code":32819,
        "unit_type":"unit",
        "unit_number": 123,
        "country": "US"
     }
 }

Requirements

Name	Requirement	Type	Description
account_number
caller_location_id		integer

Return

Parameter	Type	Versions
name	string	*
unit_type	object (UUnitType)	*
unit_type[handle]	string	*
unit_type[name]	string	*
unit_number	string	*

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

PUT /accounts/{account_number}/caller_locations/{caller_location_id}

Create a new caller location

Documentation
Sandbox

Documentation

Update a caller location.

Request Format

 {
    "caller_location": {
        "name":"John Smith",
        "address":"123 Street Name",
        "city":"Orlando",
        "region":"FL",
        "postal_code":32819,
        "unit_type":"unit",
        "unit_number": 123,
        "country": "US"
    }
 }

Requirements

Name	Requirement	Type	Description
account_number
caller_location_id

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
201	Resource created successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/accounts/{account_number}/carts

DELETE /accounts/{account_number}/carts

Delete all carts

Documentation
Sandbox

Documentation

Delete all carts

Requirements

Name	Requirement	Type	Description
account_number		string	The account number

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
204	Resource updated successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /accounts/{account_number}/carts

Get all carts

Documentation
Sandbox

Documentation

Allow clients to get the list of carts.

Response Format

{
   "code":200,
   "data":{
      "limit":10,
      "total":1,
      "page":1,
      "results":[
         {
            "cart_id":"104",
            "cart_status_handle":"OPEN",
            "total_items":3,
            "cart_items":[
               {
                  "item_id":"341",
                  "channels":10,
                  "sip_uri":"sip.example.com",
                  "item_type":"TRUNK"
               },
               {
                  "item_id":"342",
                  "phone_number":"1234567890",
                  "_caller_location":{
                     "name":"Magic Telecom",
                     "address":"6314 Kingspointe Parkway",
                     "city":"Orlando",
                     "region":"FL",
                     "country":"US",
                     "postal_code":"32819",
                     "unit_type":"suite",
                     "unit_number":"6413"
                  },
                  "did_type_handle":"STANDARD",
                  "item_type":"DID"
               },
               {
                  "item_id":"343",
                  "quantity":"2",
                  "trunk_id":"35",
                  "location_handle":"ORLANDO__580___OK",
                  "_caller_location":{
                     "name":"Magic Telecom",
                     "address":"6314 Kingspointe Parkway",
                     "city":"Orlando",
                     "region":"FL",
                     "country":"US",
                     "postal_code":"32819",
                     "unit_type":"suite",
                     "unit_number":"6413"
                  },
                  "did_type_handle":"STANDARD",
                  "item_type":"LOCATION"
               }
            ]
         }
      ]
   }
}

Requirements

Name	Requirement	Type	Description
account_number

Filters

Name

Information

page

Requirement	\d+
Description	Zero based offset index for the results. e.g. 0 would start at the first result and 10 would start at the eleventh result.
Default	1

limit

Requirement	\d+
Description	Maximum number of results to return in the response.
Default	10

filter

Requirement

Description

Allowed fields: cart_status_handle, created. Use the following delimiters to build your filters params. The vertical bar ('|') to separate individual filter phrases and a double colon ('::') to separate the names and values. The delimiter of the double colon (':') separates the property name from the comparison value, enabling the comparison value to contain spaces. Example: www.example.com\\/users?filter='name::todd|city::denver|title::grand poobah'

sort

Requirement

Description

Allowed fields: created. Use sort query-string parameter that contains a delimited set of property names. For each property name, sort in ascending order, and for each property prefixed with a dash ('-') sort in descending order. Separate each property name with a vertical bar ('|'), which is consistent with the separation of the name\\/value pairs in filtering, above. For example, if we want to retrieve users in order of their last name (ascending), first name (ascending) and hire date (descending), the request might look like this www.example.com\\/users?sort='last_name|first_name|-hire_date'

Return

Parameter	Type	Versions
cart_id	string	*
cart_items[]	array of objects (TCartItem)	*
cart_items[][channels]	integer	*
cart_items[][sip_uri]	string	*
cart_items[][attributes]	string	*
cart_items[][_routing]	string	*
cart_items[][quantity]	integer	*
cart_items[][_caller_location]	object (TCartItemCallerLocation)	*
cart_items[][_caller_location][name]	string	*
cart_items[][_caller_location][address]	string	*
cart_items[][_caller_location][city]	string	*
cart_items[][_caller_location][region]	string	*
cart_items[][_caller_location][country]	string	*
cart_items[][_caller_location][postal_code]	string	*
cart_items[][_caller_location][unit_type]	string	*
cart_items[][_caller_location][unit_number]	string	*
cart_items[][phone_number]	string	*
cart_items[][item_type]	string	*
cart_items[][initial_cost]	float	*
cart_items[][monthly_cost]	float	*
created	DateTime	*

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

POST /accounts/{account_number}/carts

Create a cart

Documentation
Sandbox

Documentation

Create an cart

Response Format

 {
    "cart_id":18,
    "cart_status_handle":"OPEN",
    "total_items":3,
    "cart_items":[]
 }

Requirements

Name	Requirement	Type	Description
account_number		string	the account number

Status Codes

Status Code	Description
403	User not authorized to perform the operation
201	Resource created successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/accounts/{account_number}/carts/{cart_id}

DELETE /accounts/{account_number}/carts/{cart_id}

Delete an cart

Documentation
Sandbox

Documentation

Delete a cart

Requirements

Name	Requirement	Type	Description
account_number		string	The account number
cart_id		string	The cart id

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
204	Resource updated successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /accounts/{account_number}/carts/{cart_id}

Get cart

Documentation
Sandbox

Documentation

Allow clients to get a specific cart.

Response Format

 {
    "code":200,
    "data":{
       "cart_id":18,
       "cart_status_handle":"OPEN",
       "total_items":3,
       "cart_items":[
          {
                "item_id":"341",
                "channels":10,
                "sip_uri":"sip.example.com",
                "item_type":"TRUNK"
             },
             {
                "item_id":"342",
                "phone_number":"1234567890",
                "_caller_location":{
                   "name":"Magic Telecom",
                   "address":"6314 Kingspointe Parkway",
                   "city":"Orlando",
                   "region":"FL",
                   "country":"US",
                   "postal_code":"32819",
                   "unit_type":"suite",
                   "unit_number":"6413"
                },
                "did_type_handle":"STANDARD",
                "item_type":"DID"
             },
             {
                "item_id":"343",
                "quantity":"2",
                "trunk_id":"35",
                "location_handle":"ORLANDO__580___OK",
                "_caller_location":{
                   "name":"Magic Telecom",
                   "address":"6314 Kingspointe Parkway",
                   "city":"Orlando",
                   "region":"FL",
                   "country":"US",
                   "postal_code":"32819",
                   "unit_type":"suite",
                   "unit_number":"6413"
                },
                "did_type_handle":"STANDARD",
                "item_type":"LOCATION"
             }
       ]
    }
 }

Requirements

Name	Requirement	Type	Description
account_number		string
cart_id		string

Return

Parameter	Type	Versions
cart_id	string	*
cart_items[]	array of objects (TCartItem)	*
cart_items[][channels]	integer	*
cart_items[][sip_uri]	string	*
cart_items[][attributes]	string	*
cart_items[][_routing]	string	*
cart_items[][quantity]	integer	*
cart_items[][_caller_location]	object (TCartItemCallerLocation)	*
cart_items[][_caller_location][name]	string	*
cart_items[][_caller_location][address]	string	*
cart_items[][_caller_location][city]	string	*
cart_items[][_caller_location][region]	string	*
cart_items[][_caller_location][country]	string	*
cart_items[][_caller_location][postal_code]	string	*
cart_items[][_caller_location][unit_type]	string	*
cart_items[][_caller_location][unit_number]	string	*
cart_items[][phone_number]	string	*
cart_items[][item_type]	string	*
cart_items[][initial_cost]	float	*
cart_items[][monthly_cost]	float	*
created	DateTime	*

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/accounts/{account_number}/carts/{cart_id}/checkout

POST /accounts/{account_number}/carts/{cart_id}/checkout

Checkout a cart

Documentation
Sandbox

Documentation

Checkout a cart and create an order

Request Format

  {
    "checkout":
    {
        "external_order_reference": "123456"
    }
  }

Response Format

  {
    "created": "2016-02-08T16:47:46+0000",
    "order_id": "13",
    "_items": [
        {
            "item_id": "12",
            "status": "COMPLETE",
            "item_type": "TRUNK",
            "channels": 10,
            "sip_uri": "108.188.149.120",
            "attributes": "sms,fax",
            "trunk_handle": "WORLD_WIDE"
        },
        {
            "quantity": 10,
            "item_id": "13",
            "status": "PROCESSING",
            "item_type": "LOCATION",
            "attributes": "sms,fax",
            "location_handle": "ORLANDO__580___OK",
            "trunk_id": "30",
            "did_type_handle": "STANDARD",
            "_caller_location": {
                "name": "John Smith",
                "address": "6314 Kingspointe Parkway",
                "city": "Orlando",
                "region": "FL",
                "country": "US",
                "postal_code": "32819",
                "unit_type": "SUIT",
                "unit_number": "1"
            }
        },
        {
            "item_id": "14",
            "status": "PROCESSING",
            "item_type": "DID",
            "trunk_id": "30",
            "did_type_handle": "STANDARD",
            "_caller_location": {
                "name": "John Smith",
                "address": "6314 Kingspointe Parkway",
                "city": "Orlando",
                "region": "FL",
                "country": "US",
                "postal_code": "32819",
                "unit_type": "SUIT",
                "unit_number": "1"
            },
            "phone_number": "14075557777"
        }
    ]
  }

Requirements

Name	Requirement	Type	Description
account_number		string	the account number
cart_id		string	the cart id

Status Codes

Status Code	Description
403	User not authorized to perform the operation
201	Resource created successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/accounts/{account_number}/carts/{cart_id}/items

DELETE /accounts/{account_number}/carts/{cart_id}/items

Delete all carts items

Documentation
Sandbox

Documentation

Delete all carts items

Requirements

Name	Requirement	Type	Description
account_number		string	The account number
cart_id		string	The cart id

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
204	Resource updated successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /accounts/{account_number}/carts/{cart_id}/items

Get all cart items

Documentation
Sandbox

Documentation

Allow clients to get the list of cart items.

Response Format

  {
    "code":200,
    "data":{
    "limit":10,
    "total":3,
    "page":1,
    "results":[
        {
            "item_id":"338",
            "channels":10,
            "sip_uri":"sip.example.com",
            "item_type":"TRUNK"
        },
        {
            "item_id":"339",
            "phone_number":"1234567890",
            "_caller_location":{
                "name":"Magic Telecom",
                "address":"6314 Kingspointe Parkway",
                "city":"Orlando",
                "region":"FL",
                "country":"US",
                "postal_code":"32819",
                "unit_type":"suite",
                "unit_number":"6413"
            },
            "did_type_handle":"STANDARD",
            "item_type":"DID"
        },
        {
            "item_id":"340",
            "quantity":"2",
            "trunk_id":"33",
            "location_handle":"ORLANDO__580___OK",
            "_caller_location":{
                "name":"Magic Telecom",
                "address":"6314 Kingspointe Parkway",
                "city":"Orlando",
                "region":"FL",
                "country":"US",
                "postal_code":"32819",
                "unit_type":"suite",
                "unit_number":"6413"
            },
            "did_type_handle":"STANDARD",
            "item_type":"LOCATION"
        }
    ]
    }
  }

Requirements

Name	Requirement	Type	Description
account_number
cart_id

Filters

Name

Information

page

Requirement	\d+
Description	Zero based offset index for the results. e.g. 0 would start at the first result and 10 would start at the eleventh result.
Default	1

limit

Requirement	\d+
Description	Maximum number of results to return in the response.
Default	10

Return

Parameter	Type	Versions
channels	integer	*
sip_uri	string	*
attributes	string	*
_routing	string	*
quantity	integer	*
_caller_location	object (TCartItemCallerLocation)	*
_caller_location[name]	string	*
_caller_location[address]	string	*
_caller_location[city]	string	*
_caller_location[region]	string	*
_caller_location[country]	string	*
_caller_location[postal_code]	string	*
_caller_location[unit_type]	string	*
_caller_location[unit_number]	string	*
phone_number	string	*
item_type	string	*
initial_cost	float	*
monthly_cost	float	*

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

POST /accounts/{account_number}/carts/{cart_id}/items

Create a cart item

Documentation
Sandbox

Documentation

Add and item to the cart

When testing, try to buy one of the following locations so that we you can get the order fully processed:

MEXICO_CITY_MX MEXICALI_686_MX SAO_PAULO_BR SANTOS_BR BELO_HORIZONTE_BR CORRIENTES_3794_AR

Request Format

  {
  "item":
    {
        "item_type": "DID",
        "phone_number": 14075556666,
        "trunk_id": 33,
        "did_type_handle":"STANDARD",
        "_caller_location": {
            "name":"John Smith",
            "address":"123 Street Name",
            "city":"Orlando",
            "region":"FL",
            "country": "US",
            "postal_code":32819,
            "unit_type":"UNIT",
            "unit_number": 123
        }
    }
  }

  ---------------------- OR ------------------------

  {
  "item":
    {
        "item_type": "DID",
        "phone_number": 14075557777,
        "trunk_id": 33,
        "did_type_handle":"STANDARD",
        "_caller_location": {
            "name":"John Smith",
            "address":"123 Street Name",
            "city":"Orlando",
            "region":"FL",
            "country": "US",
            "postal_code":32819,
            "unit_type":"UNIT",
            "unit_number": 123
        }
    }
  }

  ----------------------- OR -----------------------

  {
    "item":
    {
        "item_type":"LOCATION",
        "location_handle":"ORLANDO__580___OK",
        "did_type_handle":"STANDARD",
        "quantity":10,
        "trunk_id": 123,
        "attributes":"sms,fax"
    }
  }

  ------------------------ OR ----------------------

  {
    "item":
        {
            "item_type":"LOCATION",
            "location_handle":"ORLANDO__580___OK",
            "did_type_handle":"STANDARD",
            "quantity":10,
            "trunk_id": 123,
            "attributes":"sms,fax",
            "_caller_location": {
                "name":"John Smith",
                "address":"123 Street Name",
                "city":"Orlando",
                "region":"FL",
                "country": "US",
                "postal_code":32819,
                "unit_type":"UNIT",
                "unit_number": 123
        }
    }
  }

  ------------------------ OR ----------------------

  {
    "item":
      {
          "item_type":"TRUNK",
          "channels":10,
          "trunk_handle":"WORLD_WIDE",
          "sip_uri": "108.188.149.120",
          "attributes":"sms,fax"
      }
  }

 ------------------------ OR ----------------------

  {
    "item":
      {
          "item_type":"TRUNK_CHANNELS",
          "additional_channels":2,
          "trunk_id": 123
      }
  }

Response Format

  {
    "item_id":"338",
    "channels":10,
    "sip_uri":"sip.example.com",
    "item_type":"TRUNK"
  }

  ------------------------ OR ----------------------

  {
    "item_id":"339",
    "phone_number":"1234567890",
    "_caller_location":{
        "name":"Magic Telecom",
        "address":"6314 Kingspointe Parkway",
        "city":"Orlando",
        "region":"FL",
        "country":"US",
        "postal_code":"32819",
        "unit_type":"suite",
        "unit_number":"6413"
    },
    "did_type_handle":"STANDARD",
    "item_type":"DID"
  }

  ------------------------ OR ----------------------

  {
    "item_id":"340",
    "quantity":"2",
    "trunk_id":"33",
    "location_handle":"ORLANDO__580___OK",
    "_caller_location":{
        "name":"Magic Telecom",
        "address":"6314 Kingspointe Parkway",
        "city":"Orlando",
        "region":"FL",
        "country":"US",
        "postal_code":"32819",
        "unit_type":"suite",
        "unit_number":"6413"
    },
    "did_type_handle":"STANDARD",
    "item_type":"LOCATION"
  }

Requirements

Name	Requirement	Type	Description
account_number		string	the account number
cart_id		string	the cart id

Status Codes

Status Code	Description
403	User not authorized to perform the operation
201	Resource created successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/accounts/{account_number}/carts/{cart_id}/items/{item_id}

DELETE /accounts/{account_number}/carts/{cart_id}/items/{item_id}

Delete an cart item

Documentation
Sandbox

Documentation

Delete a cart item

Requirements

Name	Type	Description
account_number	string	The account number
cart_id	string	The cart id
item_id	string	The item id

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
204	Resource updated successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /accounts/{account_number}/carts/{cart_id}/items/{item_id}

Get cart item

Documentation
Sandbox

Documentation

Allow clients to get a specific cart item.

Response Format

  {
    "code":200,
    "data":{
        "item_id":"263",
        "channels":10,
        "sip_uri":"sip.example.com",
        "item_type":"TRUNK"
    }
  }

Requirements

Name	Requirement	Type	Description
account_number		integer
cart_id		integer
item_id		integer

Return

Parameter	Type	Versions
channels	integer	*
sip_uri	string	*
attributes	string	*
_routing	string	*
quantity	integer	*
_caller_location	object (TCartItemCallerLocation)	*
_caller_location[name]	string	*
_caller_location[address]	string	*
_caller_location[city]	string	*
_caller_location[region]	string	*
_caller_location[country]	string	*
_caller_location[postal_code]	string	*
_caller_location[unit_type]	string	*
_caller_location[unit_number]	string	*
phone_number	string	*
item_type	string	*
initial_cost	float	*
monthly_cost	float	*

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/accounts/{account_number}/cdrs

DELETE /accounts/{account_number}/cdrs

Delete cdrs requests

Documentation
Sandbox

Documentation

Deletes all cdrs requests from customer's account.

Requirements

Name	Requirement	Type	Description
account_number

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
204	Resource updated successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /accounts/{account_number}/cdrs

Get cdrs requests

Documentation
Sandbox

Documentation

Allow clients to get the list of cdr request for the specific account.

Response Format

 {
   "code": 200,
   "data": {
       "limit": 1,
       "page": 1,
       "results": [
             {
        "id":123,
        "service_type": {
            "service_type_id": 3,
            "handle": "ORIGINATION",
            "description": "origination"
        }
     }
       ],
       "total": 1
   }
 }

Requirements

Name	Requirement	Type	Description
account_number

Filters

Name

Information

page

Requirement	\d+
Description	Zero based offset index for the results. e.g. 0 would start at the first result and 10 would start at the eleventh result.
Default	1

limit

Requirement	\d+
Description	Maximum number of results to return in the response.
Default	10

filter

Requirement

Description

Allowed fields: null_path, service_type, from, to and created. Use the following delimiters to build your filters params. The vertical bar ('|') to separate individual filter phrases and a double colon ('::') to separate the names and values. The delimiter of the double colon (':') separates the property name from the comparison value, enabling the comparison value to contain spaces. Example: www.example.com\\\/users?filter='name::todd|city::denver|title::grand poobah

Return

Parameter	Type	Versions
id	string	*
path	string	*
service_type	object (UServiceType)	*
service_type[service_type_id]	string	*
service_type[handle]	string	*
service_type[description]	string	*

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

POST /accounts/{account_number}/cdrs

Creates a cdr request

Documentation
Sandbox

Documentation

Creates a cdr request.

Request Format

 {
    "cdrs": {
        "service_type": "ORIGINATION",
        "start_date": "2015-12-15",
        "end_date": "2015-12-15"
    }
 }

Response Format

 {
    "id":123,
    "service_type": {
        "service_type_id": 3,
        "handle": "ORIGINATION",
        "description": "origination"
    }
 }

Requirements

Name	Requirement	Type	Description
account_number

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
201	Resource created successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/accounts/{account_number}/cdrs/{cdr_id}

DELETE /accounts/{account_number}/cdrs/{cdr_id}

Delete a cdr file in an account

Documentation
Sandbox

Documentation

Deletes a cdr file from customer's account.

Requirements

Name	Requirement	Type	Description
account_number
cdr_id

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
204	Resource updated successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /accounts/{account_number}/cdrs/{cdr_id}

Allow clients to download the cdrs in a file

Documentation
Sandbox

Documentation

Allow clients to download the cdrs in a file.

Request Format

Requirements

Name	Requirement	Type	Description
account_number
cdr_id

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
201	Resource created successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/accounts/{account_number}/dids

DELETE /accounts/{account_number}/dids

Delete dids in an account

Documentation
Sandbox

Documentation

Deletes all phone_number from customer's account. These numbers must be unassigned and returned to Magic stock.

Requirements

Name	Requirement	Type	Description
account_number		string	The account number

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
204	Resource updated successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /accounts/{account_number}/dids

Get the list of numbers for the specific account

Documentation
Sandbox

Documentation

Allow clients to get the list of numbers for the specific account.

Response Format

  {
    "code": 200,
    "data": {
        "limit": 1,
        "total": 5,
        "page": 1,
        "results": [
            {
                "phone_number": "14071234567",
                "location_name": "Orlando (407), FL",
                "location_handle": "ORLANDO__407___FL",
                "prefix": 1407,
                "npa": "407",
                "nxx": "123",
                "trunk_id": "46",
                "_rates": {
                "DID_PRODUCT_1": {
                    "initial_cost": 2,
                    "monthly_cost": 1
                }
            },
            "_country": {
                "iso2": "US",
                "handle": "UNITED_STATES",
                "dial_code": 1,
                "name": "United States",
                "iso3": "USA"
            },
            "_region": {
                "region_handle": "FL",
                "name": "Florida"
            },
            "did_number_name": "my trunk ww",
            "sip_endpoint_uri": "102.225.231.365",
            "_routing_logic": {
                "logic": "single-endpoint"
                }
            }
        ]
    }
  }

Requirements

Name	Requirement	Type	Description
account_number		string

Filters

Name

Information

page

Requirement	\d+
Description	Zero based offset index for the results. e.g. 0 would start at the first result and 10 would start at the eleventh result.
Default	1

limit

Requirement	\d+
Description	Maximum number of results to return in the response.
Default	10

filter

Requirement

Description

Allowed fields: trunk_id, phone_number, country_iso2, region_handle, location_handle, sip_end_point_uri.\n * Use the following delimiters to build your filters params. The vertical bar ('|') to separate individual filter phrases and a double colon ('::') to separate the names and values.\n * The delimiter of the double colon (':') separates the property name from the comparison value, enabling the comparison value to contain spaces.\n * Example: www.example.com\\\/users?filter='name::todd|city::denver|title::grand poobah

Return

Parameter	Type	Versions	Description
phone_number	string	*

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/accounts/{account_number}/dids/{telephone_number}

DELETE /accounts/{account_number}/dids/{telephone_number}

Delete dids in an account

Documentation
Sandbox

Documentation

Deletes a phone_number from customer's account. This number must be unassigned and returned to Magic stock.

Requirements

Name	Requirement	Type	Description
account_number		string
telephone_number		string

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
204	Resource updated successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /accounts/{account_number}/dids/{telephone_number}

Get specific a specific account

Documentation
Sandbox

Documentation

Allow clients to get the a specific phone number.

Response Format

  {
    "code": 200,
    "data": {
        "phone_number": "14075556666",
        "_status": {
            "handle": "ASSIGNED"
        },
        "location_name": "Orlando (407), FL",
        "location_handle": "ORLANDO__407___FL",
        "prefix": 1407,
        "npa": "407",
        "nxx": "555",
        "trunk_id": "16",
        "sip_endpoint_uri": "102.225.231.65",
        "_rates": {
            "STANDARD": {
                "initial_cost": 2,
                "monthly_cost": 1
            }
        },
        "_country": {
            "iso2": "US",
            "handle": "UNITED_STATES",
            "dial_code": 1,
            "name": "United States",
            "iso3": "USA"
        },
        "_region": {
            "region_handle": "FL",
            "name": "Florida",
            "country": {
                "iso2": "US",
                "handle": "UNITED_STATES",
                "dial_code": 1,
                "name": "United States",
                "iso3": "USA"
            }
        },
        "alias": "Home",
        "_routing_logic": {
            "sip_user": "108.188.149.75",
            "logic": "load-balanced",
            "_endpoint": [
                {
                    "uri": "108.188.149.28",
                    "attrs": "maxChannels=2"
                }
            ]
        }
    }
  }

Requirements

Name	Requirement	Type	Description
account_number		string
telephone_number		string

Return

Parameter	Type	Versions	Description
phone_number	string	*

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

PATCH /accounts/{account_number}/dids/{telephone_number}

Allow client to perform operations on a specific did

Documentation
Sandbox

Documentation

Allow client to perform operations on a specific did

Request Format

  {
    "telephone_number": {
        "trunk_id":3,
        "alias":"My did",
        "sip_end_point_uri": "108.188.149.120",
        "_routing": {
            "logic": "load-balanced",
            "endpoints": [{
                "uri": "108.188.149.102",
                "attrs": "maxChannels=10"
            }, {
                "uri": "108.188.149.100",
                "attrs": "maxChannels=10"
            }]
            },
        "channels":2
    }
  }

Requirements

Name	Requirement	Type	Description
account_number		string
telephone_number		string

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
201	Resource created successful
204	Resource updated successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/accounts/{account_number}/orders

GET /accounts/{account_number}/orders

Get all orders of an account

Documentation
Sandbox

Documentation

Allow clients to get the list of orders.

Response Format

 {
    "code": 200,
    "data": {
      "limit": 1,
      "total": 3,
      "page": 1,
      "results": [
        {
          "created": "2016-02-08T16:21:55+0000",
          "order_id": "11",
          "_items": [
            {
              "item_id": "8",
              "status": "COMPLETE",
              "item_type": "TRUNK",
              "channels": 10,
              "sip_uri": "108.188.149.120",
              "attributes": "sms,fax",
              "trunk_handle": "WORLD_WIDE",
              "trunk_id": "398"
            },
            {
              "quantity": 2,
              "item_id": "9",
              "status": "PROCESSING",
              "item_type": "LOCATION",
              "attributes": "sms,fax",
              "location_handle": "ORLANDO__580___OK",
              "trunk_id": "30",
              "did_type_handle": "STANDARD",
              "_caller_location": {
                "name": "John Smith",
                "address": "6314 Kingspointe Parkway",
                "city": "Orlando",
                "region": "FL",
                "country": "US",
                "postal_code": "32819",
                "unit_type": "SUIT",
                "unit_number": "1"
              },
              "_phone_number": [
                "15805812433",
                "15809293757"
              ]
            }
          ]
        }
      ]
    }
  }

Requirements

Name	Requirement	Type	Description
account_number

Filters

Name

Information

page

Requirement	\d+
Description	Zero based offset index for the results. e.g. 0 would start at the first result and 10 would start at the eleventh result.
Default	1

limit

Requirement	\d+
Description	Maximum number of results to return in the response.
Default	10

filter

Requirement

Description

Allowed fields: item_type, order_item_status_handle, not_order_item_status_handle, external_order_reference, from, to, created. Use the following delimiters to build your filters params. The vertical bar ('|') to separate individual filter phrases and a double colon ('::') to separate the names and values. The delimiter of the double colon (':') separates the property name from the comparison value, enabling the comparison value to contain spaces. Example: www.example.com\\\/users?filter='name::todd|city::denver|title::grand poobah

sort

Requirement
Description	Allowed sort: created. Example: http:\/\/www.example.com\/users?sort=last_name\|first_name\|-hire_date

Return

Parameter	Type	Versions
external_order_reference	string	*
created	DateTime	*
order_id	string	*
_items[]	array of objects (TDidOrderItem)	*
_items[][quantity]	integer	*
_items[][item_id]	string	*
_items[][address]	object (TDidOrderAddress)	*
_items[][address][salutation]	string	*
_items[][address][firstname]	string	*
_items[][address][surname]	string	*
_items[][address][company]	string	*
_items[][address][building_number]	string	*
_items[][address][street]	string	*
_items[][address][city]	string	*
_items[][address][zip_code]	string	*
_items[][address][country_code]	string	*
_items[][address][did_order_address_id]	string	*
_items[][address][did_order_item]	object (TDidOrderItem)	*

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/accounts/{account_number}/orders/{order_id}

DELETE /accounts/{account_number}/orders/{order_id}

Cancel an order

Documentation
Sandbox

Documentation

Allow clients to cancel a specific order.

Requirements

Name	Requirement	Type	Description
account_number		integer
order_id		integer

Return

Parameter	Type	Versions
external_order_reference	string	*
created	DateTime	*
order_id	string	*
_items[]	array of objects (TDidOrderItem)	*
_items[][quantity]	integer	*
_items[][item_id]	string	*
_items[][address]	object (TDidOrderAddress)	*
_items[][address][salutation]	string	*
_items[][address][firstname]	string	*
_items[][address][surname]	string	*
_items[][address][company]	string	*
_items[][address][building_number]	string	*
_items[][address][street]	string	*
_items[][address][city]	string	*
_items[][address][zip_code]	string	*
_items[][address][country_code]	string	*
_items[][address][did_order_address_id]	string	*
_items[][address][did_order_item]	object (TDidOrderItem)	*

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /accounts/{account_number}/orders/{order_id}

Get an order

Documentation
Sandbox

Documentation

Allow clients to get a specific order.

Response Format

 {
    "code": 200,
    "data": {
      "created": "2016-02-08T16:47:46+0000",
      "order_id": "13",
      "_items": [
        {
          "item_id": "12",
          "status": "COMPLETE",
          "item_type": "TRUNK",
          "channels": 10,
          "sip_uri": "108.188.149.120",
          "attributes": "sms,fax",
          "trunk_handle": "WORLD_WIDE"
        },
        {
          "quantity": 2,
          "item_id": "13",
          "status": "PROCESSING",
          "item_type": "LOCATION",
          "attributes": "sms,fax",
          "location_handle": "ORLANDO__580___OK",
          "trunk_id": "30",
          "did_type_handle": "STANDARD",
          "_caller_location": {
            "name": "John Smith",
            "address": "6314 Kingspointe Parkway",
            "city": "Orlando",
            "region": "FL",
            "country": "US",
            "postal_code": "32819",
            "unit_type": "SUIT",
            "unit_number": "1"
          }
        },
        "_phone_number": [
            "15805812433",
            "15809293757"
        ]
        }
      ]
    }
  }

Requirements

Name	Requirement	Type	Description
account_number		integer
order_id		integer

Return

Parameter	Type	Versions
external_order_reference	string	*
created	DateTime	*
order_id	string	*
_items[]	array of objects (TDidOrderItem)	*
_items[][quantity]	integer	*
_items[][item_id]	string	*
_items[][address]	object (TDidOrderAddress)	*
_items[][address][salutation]	string	*
_items[][address][firstname]	string	*
_items[][address][surname]	string	*
_items[][address][company]	string	*
_items[][address][building_number]	string	*
_items[][address][street]	string	*
_items[][address][city]	string	*
_items[][address][zip_code]	string	*
_items[][address][country_code]	string	*
_items[][address][did_order_address_id]	string	*
_items[][address][did_order_item]	object (TDidOrderItem)	*

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/accounts/{account_number}/orders/{order_id}/items/{item_id}

DELETE /accounts/{account_number}/orders/{order_id}/items/{item_id}

Cancel an order item

Documentation
Sandbox

Documentation

Allow clients to cancel an specific order item.

Requirements

Name	Requirement	Type	Description
account_number		integer
order_id		integer
item_id		integer

Return

Parameter	Type	Versions
quantity	integer	*
item_id	string	*
address	object (TDidOrderAddress)	*
address[salutation]	string	*
address[firstname]	string	*
address[surname]	string	*
address[company]	string	*
address[building_number]	string	*
address[street]	string	*
address[city]	string	*
address[zip_code]	string	*
address[country_code]	string	*
address[did_order_address_id]	string	*
address[did_order_item]	object (TDidOrderItem)	*
address[did_order_item][quantity]	integer	*
address[did_order_item][item_id]	string	*
address[did_order_item][address]	object (TDidOrderAddress)	*

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /accounts/{account_number}/orders/{order_id}/items/{item_id}

Get an order item

Documentation
Sandbox

Documentation

Allow clients to get a specific order item.

Response Format

 {
    "code": 200,
    "data": {
      "item_id": "33",
      "status": "COMPLETE",
      "item_type": "TRUNK",
      "channels": 10,
      "sip_uri": "108.188.149.120",
      "attributes": "sms,fax",
      "trunk_handle": "WORLD_WIDE"
    }
  }

Requirements

Name	Requirement	Type	Description
account_number		integer
order_id		integer
item_id		integer

Return

Parameter	Type	Versions
quantity	integer	*
item_id	string	*
address	object (TDidOrderAddress)	*
address[salutation]	string	*
address[firstname]	string	*
address[surname]	string	*
address[company]	string	*
address[building_number]	string	*
address[street]	string	*
address[city]	string	*
address[zip_code]	string	*
address[country_code]	string	*
address[did_order_address_id]	string	*
address[did_order_item]	object (TDidOrderItem)	*
address[did_order_item][quantity]	integer	*
address[did_order_item][item_id]	string	*
address[did_order_item][address]	object (TDidOrderAddress)	*

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/accounts/{account_number}/orders/{order_id}/items/{item_id}/address

GET /accounts/{account_number}/orders/{order_id}/items/{item_id}/address

Get address details linked to an order item

Documentation
Sandbox

Documentation

Get the address details for an order item

Requirements

Name	Requirement	Type	Description
account_number		string
order_id		int
item_id		int

Return

Parameter	Type	Versions
salutation	string	*
firstname	string	*
surname	string	*
company	string	*
building_number	string	*
street	string	*
city	string	*
zip_code	string	*
country_code	string	*
did_order_address_id	string	*
did_order_item	object (TDidOrderItem)	*
did_order_item[quantity]	integer	*
did_order_item[item_id]	string	*
did_order_item[address]	object (TDidOrderAddress)	*
did_order_item[address][salutation]	string	*
did_order_item[address][firstname]	string	*
did_order_item[address][surname]	string	*
did_order_item[address][company]	string	*
did_order_item[address][building_number]	string	*
did_order_item[address][street]	string	*
did_order_item[address][city]	string	*
did_order_item[address][zip_code]	string	*
did_order_item[address][country_code]	string	*
did_order_item[address][did_order_address_id]	string	*
did_order_item[address][did_order_item]	object (TDidOrderItem)	*

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

POST /accounts/{account_number}/orders/{order_id}/items/{item_id}/address

Update address details linked to an order item

Documentation
Sandbox

Documentation

Update the address details for an order item

Requirements

Name	Requirement	Type	Description
account_number		string
order_id		int
item_id		int

Return

Parameter	Type	Versions
salutation	string	*
firstname	string	*
surname	string	*
company	string	*
building_number	string	*
street	string	*
city	string	*
zip_code	string	*
country_code	string	*
did_order_address_id	string	*
did_order_item	object (TDidOrderItem)	*
did_order_item[quantity]	integer	*
did_order_item[item_id]	string	*
did_order_item[address]	object (TDidOrderAddress)	*
did_order_item[address][salutation]	string	*
did_order_item[address][firstname]	string	*
did_order_item[address][surname]	string	*
did_order_item[address][company]	string	*
did_order_item[address][building_number]	string	*
did_order_item[address][street]	string	*
did_order_item[address][city]	string	*
did_order_item[address][zip_code]	string	*
did_order_item[address][country_code]	string	*
did_order_item[address][did_order_address_id]	string	*
did_order_item[address][did_order_item]	object (TDidOrderItem)	*

Status Codes

Status Code	Description
400	Invalid data
401	You are not authenticated
403	This action needs a valid WSSE header
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/accounts/{account_number}/trunks

DELETE /accounts/{account_number}/trunks

Delete trunks in an account

Documentation
Sandbox

Documentation

Deletes all trunks from customer's account. Numbers on that trunk must be unassigned and returned to Magic stock.

Requirements

Name	Requirement	Type	Description
account_number		string

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
204	Resource updated successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /accounts/{account_number}/trunks

Get the list of all accounts

Documentation
Sandbox

Documentation

Allow clients to get the list of trunks for the specific account.

Response Format

 {
   "code": 200,
   "data": {
       "limit": 1,
       "page": 1,
       "results": [
       {
            "channels": 2,
            "description": "New trunk",
            "sip_endpoint_uri": "102.225.231.365",
            "active": true,
            "default": true,
            "id": "7",
            "trunk_name": "World Wide",
            "trunk_handle": "WORLD_WIDE",
            "did_active": 1,
            "did_inactive": 0,
            "_routing_logic": {
                "logic": "single-endpoint"
            }
        }
       ],
       "total": 1
   }
 }

Requirements

Name	Requirement	Type	Description
account_number		string

Filters

Name

Information

page

Requirement	\d+
Description	Zero based offset index for the results. e.g. 0 would start at the first result and 10 would start at the eleventh result.
Default	1

limit

Requirement	\d+
Description	Maximum number of results to return in the response.
Default	10

filter

Requirement

Description

Allowed fields: trunk_handle, active. Use the following delimiters to build your filters params. The vertical bar ('|') to separate individual filter phrases and a double colon ('::') to separate the names and values. The delimiter of the double colon (':') separates the property name from the comparison value, enabling the comparison value to contain spaces. Example: www.example.com\\\/users?filter='name::todd|city::denver|title::grand poobah

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/accounts/{account_number}/trunks/{trunk_id}

DELETE /accounts/{account_number}/trunks/{trunk_id}

Delete trunks in an account

Documentation
Sandbox

Documentation

Deletes a trunk from customer's account. Numbers on that trunk must be unassigned and returned to Magic stock.

Requirements

Name	Requirement	Type	Description
account_number		string
trunk_id		integer

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
204	Resource updated successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /accounts/{account_number}/trunks/{trunk_id}

Get specific trunk

Documentation
Sandbox

Documentation

Allow clients to get the a specific trunk.

Response Format

 {
   "code": 200,
   "data": {
        "channels": 2,
        "description": "New trunk",
        "sip_endpoint_uri": "102.225.231.365",
        "active": true,
        "default": true,
        "id": "7",
        "trunk_name": "World Wide",
        "trunk_handle": "WORLD_WIDE",
        "did_active": 1,
        "did_inactive": 0,
        "_routing_logic": {
            "logic": "single-endpoint"
        }
     }
 }

Requirements

Name	Requirement	Type	Description
account_number		string
trunk_id		integer

Return

Parameter	Type	Versions
channels	integer	*
did_channels	integer	*
description	string	*
id	integer	*
sip_endpoint_uri	string	*
active	boolean	*
default	boolean	*

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

PATCH /accounts/{account_number}/trunks/{trunk_id}

Create a new account

Documentation
Sandbox

Documentation

Update a trunk.

Request Format

 {
    "trunk": {
    "sip_end_point_uri": "108.188.149.120",
    "description": "I am doing a update",
    "_routing": {
                "logic": "load-balanced",
                "endpoints": [{
        "uri": "108.188.149.102",
        "attrs": "maxChannels=10"
                }, {
                    "uri": "108.188.149.100",
        "attrs": "maxChannels=10"
                }],
                "sip_user": "108.188.149.80"
    }
}
  }

Requirements

Name	Requirement	Type	Description
account_number		string	account number
trunk_id		integer	trunk id

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
201	Resource created successful
400	Request could not be understood
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

Show/hide List Operations Expand Operations

Dids

/dids/location/countries

GET /dids/location/countries

Get all coutries

Documentation
Sandbox

Documentation

Allow clients to get the list of available countries.

Response Format

{
  "code": 200,
  "data": {
    "limit": 1,
    "total": 86,
    "page": 1,
    "results": [
      {
        "iso2": "DZ",
        "handle": "ALGERIA",
        "dial_code": 213,
        "name": "Algeria",
        "iso3": "DZA"
      }
    ]
  }
}

Filters

Name

Information

page

Requirement	\d+
Description	Zero based offset index for the results. e.g. 0 would start at the first result and 10 would start at the eleventh result.
Default	1

limit

Requirement	\d+
Description	Maximum number of results to return in the response.
Default	10

Return

Parameter	Type	Versions
iso2	string	*
handle	string	*
dial_code	integer	*
name	string	*
iso3	string	*

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
200	Returned when successful
404	Resource not found

Input

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/dids/location/countries/{country_iso2}

GET /dids/location/countries/{country_iso2}

Get specific did country by Iso2

Documentation
Sandbox

Documentation

Allow clients to get a specific country.

Response Format

 {
    "code": 200,
    "data": {
          "iso2":"US",
          "handle":"UNITED_STATES",
          "dial_code":93,
          "name":"United States", 
          "iso3":"USA"
     }
 }

Requirements

Name	Requirement	Type	Description
country_iso2		string

Return

Parameter	Type	Versions
iso2	string	*
handle	string	*
dial_code	integer	*
name	string	*
iso3	string	*

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/dids/location/countries/{country_iso2}/regions

GET /dids/location/countries/{country_iso2}/regions

Get all did regions by country code

Documentation
Sandbox

Documentation

Allow clients to get the list of available regions per country.

Response Format

 {
    "code": 200,
    "data": {
        "limit": 1,
        "page": 1,
        "results": [
            {
          "region_handle":"FL",
          "name":"Florida", 
          "country": {
            "iso2": "US",
            "handle": "UNITED_STATES",
            "dial_code": 1,
            "name": "United States",
            "iso3": "USA"
          }
    }
        ],
        "total": 1
    }
}

Requirements

Name	Requirement	Type	Description
country_iso2		string

Filters

Name

Information

page

Requirement	\d+
Description	Zero based offset index for the results. e.g. 0 would start at the first result and 10 would start at the eleventh result.
Default	1

limit

Requirement	\d+
Description	Maximum number of results to return in the response.
Default	10

Return

Parameter	Type	Versions
region_handle	string	*
name	string	*
country	object (UCountry)	*
country[iso2]	string	*
country[handle]	string	*
country[dial_code]	integer	*
country[name]	string	*
country[iso3]	string	*

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/dids/location/countries/{country_iso2}/regions/{region_handle}

GET /dids/location/countries/{country_iso2}/regions/{region_handle}

Allow clients to get a specific region for a specific country.

Documentation
Sandbox

Documentation

Allow clients to get a specific region for a specific country.

Response Format

 {
    "code": 200,
    "data": {
          "region_handle":"FL",
          "name":"Florida",
          "country": {
            "iso2": "US",
            "handle": "UNITED_STATES",
            "dial_code": 1,
            "name": "United States",
            "iso3": "USA"
          } 
     }
 }

Requirements

Name	Requirement	Type	Description
country_iso2		string
region_handle		string

Return

Parameter	Type	Versions
region_handle	string	*
name	string	*
country	object (UCountry)	*
country[iso2]	string	*
country[handle]	string	*
country[dial_code]	integer	*
country[name]	string	*
country[iso3]	string	*

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/dids/types

GET /dids/types

Get all did types

Documentation
Sandbox

Documentation

Allow clients to get the list of available did types.

Response Format

 {
    "code":200,
    "data":{
       "total":2,
       "results":[
          {
             "handle":"DID_PRODUCT_1",
             "name":"Did Product 1"
          },
          {
             "handle":"DID_PRODUCT_2",
             "name":"Did Product 2"
          }
       ]
    }
 }

Return

Parameter	Type	Versions	Description
handle	string	*
name	string	*

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
200	Returned when successful
404	Resource not found

Input

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/dids/types/{did_type_handle}

GET /dids/types/{did_type_handle}

Get specific did type

Documentation
Sandbox

Documentation

Allow clients to get a specific did type.

Response Format

 {
      "code":200,
      "data":{
         "handle":"DID_PRODUCT_1",
         "name":"Did Product 1"
      }
 }

Requirements

Name	Requirement	Type	Description
did_type_handle		string

Return

Parameter	Type	Versions	Description
handle	string	*
name	string	*

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

Show/hide List Operations Expand Operations

Dids Products

/dids/products/dids

GET /dids/products/dids

Allow clients to get the list of available phone_numbers.

Documentation
Sandbox

Documentation

Allow clients to get the list of available phone_numbers.

Response Format

 {
    "code": 200,
    "data": {
      "limit": 1,
      "total": 477847,
      "page": 1,
      "results": [
        {
          "phone_number": "13475181002",
          "location_name": "New York City Zone 03 (347), NY",
          "location_handle": "NEW_YORK_CITY_ZONE_03__347___NY",
          "prefix": 1347,
          "npa": "347",
          "nxx": "518",
          "trunk_id": [],
          "_rates": {
            "STANDARD": {
              "initial_cost": "0.25",
              "monthly_cost": "0.25"
            }
          },
          "_country": {
            "dial_code": 1,
            "iso3": "USA"
          },
          "_region": {},
          "_rate_center": {
            "name": "NEW YORK CITY ZONE 03",
            "short_name": "NWYRCYZN03",
            "lata_number": "132"
          },
          "_local_rate_center": [
            {
              "name": "NEW YORK CITY ZONE 01, NY"
            },
            {
              "name": "NEW YORK CITY ZONE 04, NY"
            },
            {
              "name": "NEW YORK CITY ZONE 05, NY"
            },
            {
              "name": "NEW YORK CITY ZONE 06, NY"
            },
            {
              "name": "NEW YORK CITY ZONE 07, NY"
            },
            {
              "name": "NEW YORK CITY ZONE 08, NY"
            },
            {
              "name": "NEW YORK CITY ZONE 09, NY"
            },
            {
              "name": "NEW YORK CITY ZONE 10, NY"
            },
            {
              "name": "NEW YORK CITY ZONE 11, NY"
            },
            {
              "name": "NEW YORK CITY ZONE 12, NY"
            },
            {
              "name": "NEW YORK CITY ZONE 13, NY"
            },
            {
              "name": "NEW YORK CITY ZONE 14, NY"
            },
            {
              "name": "NEW YORK CITY ZONE 15, NY"
            }
          ]
        }
      ]
    }
  }

Filters

Name

Information

page

Requirement	\d+
Description	Zero based offset index for the results. e.g. 0 would start at the first result and 10 would start at the eleventh result.
Default	1

limit

Requirement	\d+
Description	Maximum number of results to return in the response.
Default	10

filter

Requirement
Description	Allowed fields: country_iso2, region_handle, location_handle, location_name, phone_number, phone_number_type, zip_code.

Return

Parameter	Type	Versions	Description
phone_number	string	*

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
200	Returned when successful
404	Resource not found

Input

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/dids/products/dids/{phone_number}

GET /dids/products/dids/{phone_number}

Allow clients to get a specific phone_number.

Documentation
Sandbox

Documentation

Allow clients to get a specific phone_number.

Response Format

 {
    "code": 200,
    "data": {
      "phone_number": "13475181002",
      "_status": {
        "handle": "UNASSIGNED"
      },
      "location_name": "New York City Zone 03 (347), NY",
      "location_handle": "NEW_YORK_CITY_ZONE_03__347___NY",
      "prefix": 1347,
      "npa": "347",
      "nxx": "518",
      "trunk_id": [],
      "_rates": {
        "STANDARD": {
          "initial_cost": "0.25",
          "monthly_cost": "0.25"
        }
      },
      "_country": {
        "iso2": "US",
        "handle": "UNITED_STATES",
        "dial_code": 1,
        "name": "United States",
        "iso3": "USA"
      },
      "_region": {
        "region_handle": "NY",
        "name": "New York",
        "country": {
          "iso2": "US",
          "handle": "UNITED_STATES",
          "dial_code": 1,
          "name": "United States",
          "iso3": "USA"
        }
      },
      "_rate_center": {
        "name": "NEW YORK CITY ZONE 03",
        "short_name": "NWYRCYZN03",
        "lata_number": "132"
      },
      "_local_rate_center": [
        {
          "name": "NEW YORK CITY ZONE 01, NY"
        },
        {
          "name": "NEW YORK CITY ZONE 04, NY"
        },
        {
          "name": "NEW YORK CITY ZONE 05, NY"
        },
        {
          "name": "NEW YORK CITY ZONE 06, NY"
        },
        {
          "name": "NEW YORK CITY ZONE 07, NY"
        },
        {
          "name": "NEW YORK CITY ZONE 08, NY"
        },
        {
          "name": "NEW YORK CITY ZONE 09, NY"
        },
        {
          "name": "NEW YORK CITY ZONE 10, NY"
        },
        {
          "name": "NEW YORK CITY ZONE 11, NY"
        },
        {
          "name": "NEW YORK CITY ZONE 12, NY"
        },
        {
          "name": "NEW YORK CITY ZONE 13, NY"
        },
        {
          "name": "NEW YORK CITY ZONE 14, NY"
        },
        {
          "name": "NEW YORK CITY ZONE 15, NY"
        }
      ]
    }
  }

Requirements

Name	Requirement	Type	Description
phone_number		string

Return

Parameter	Type	Versions	Description
phone_number	string	*

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/dids/products/locations

GET /dids/products/locations

Allow clients to get the list of available locations.

Documentation
Sandbox

Documentation

Allow clients to get the list of available locations.

Response Format

 {
    "code": 200,
    "data": {
      "limit": 1,
      "total": 210,
      "page": 1,
      "results": [
        {
          "handle": "APOPKA__321___FL",
          "name": "Apopka (321), FL",
          "dialcode": 1321,
          "active": true,
          "in_stock": true,
          "npa": "321",
          "_country": {
            "iso2": "US",
            "handle": "UNITED_STATES",
            "dial_code": 1,
            "name": "United States",
            "iso3": "USA"
          },
          "_region": {
            "region_handle": "FL",
            "name": "Florida"
          },
          "_rates": {
            "STANDARD": {
              "initial_cost": "0.25",
              "monthly_cost": "0.25"
            }
          },
          "_rate_center": {
            "name": "APOPKA",
            "short_name": "APOPKA",
            "lata_number": "45808"
          },
          "_local_rate_center": [
            {
              "name": "MOUNT DORA, FL"
            },
            {
              "name": "EAST ORANGE, FL"
            },
            {
              "name": "ORLANDO, FL"
            },
            {
              "name": "CELEBRATION, FL"
            },
            {
              "name": "LAKE BUENA VISTA, FL"
            },
            {
              "name": "MONTVERDE, FL"
            },
            {
              "name": "REEDY CREEK, FL"
            },
            {
              "name": "WINDERMERE, FL"
            },
            {
              "name": "WINTER GARDEN, FL"
            },
            {
              "name": "WINTER PARK, FL"
            }
          ],
          "_npanxx": [
            {
              "npanxx": "321248"
            },
            {
              "npanxx": "321256"
            },
            {
              "npanxx": "321322"
            },
            {
              "npanxx": "321396"
            }
          ]
        }
      ]
    }
  }

Filters

Name

Information

page

Requirement	\d+
Description	Zero based offset index for the results. e.g. 0 would start at the first result and 10 would start at the eleventh result.
Default	1

limit

Requirement	\d+
Description	Maximum number of results to return in the response.
Default	10

filter

Requirement
Description	Allowed fields: in_stock, country_iso2, country_name, region_handle, location_handle, location_name, prefix, npanxx, rate_center_name, rate_center_short_name, local_rate_center, lata, query_logic.

Return

Parameter	Type	Versions
handle	string	*
name	string	*
dialcode	integer	*
active	boolean	*

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
200	Returned when successful
404	Resource not found

Input

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/dids/products/locations/{location_handle}

GET /dids/products/locations/{location_handle}

Allow clients to get a specific location.

Documentation
Sandbox

Documentation

Allow clients to get a specific location.

Response Format

 {
    "code": 200,
    "data": {
      "handle": "ORLANDO__407___FL",
      "name": "Orlando (407), FL",
      "dialcode": 1407,
      "active": true,
      "in_stock": true,
      "npa": "407",
      "restriction_address_type": "LOCAL",
      "restriction_address_proof": true,
      "_country": {
        "iso2": "US",
        "handle": "UNITED_STATES",
        "dial_code": 1,
        "name": "United States",
        "iso3": "USA"
      },
      "_region": {
        "region_handle": "FL",
        "name": "Florida",
        "country": {
          "iso2": "US",
          "handle": "UNITED_STATES",
          "dial_code": 1,
          "name": "United States",
          "iso3": "USA"
        }
      },
        "_rates": {
          "DID_PRODUCT_1": {
            "initial_cost": 2,
            "monthly_cost": 1
          },
          "DID_PRODUCT_2": {
            "initial_cost": 5,
            "monthly_cost": 2
          }
        },
        "_local_rate_center": {
            "name": "KISSIMMEE, FL",
            "name": "SAINT CLOUD, FL",
            "name": "WINDERMERE, FL",
            "name": "WINTER GARDEN, FL",
            "name": "WINTER PARK, FL"
        },
        "_npanxx": {
            "npanxx": "407651",
            "npanxx": "407658",
            "npanxx": "407666",
            "npanxx": "407668"
        }
    }
 }

Requirements

Name	Requirement	Type	Description
location_handle		string

Return

Parameter	Type	Versions
handle	string	*
name	string	*
dialcode	integer	*
active	boolean	*

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/dids/products/trunks

GET /dids/products/trunks

Get the list of available trunk

Documentation
Sandbox

Documentation

Allow clients to get the list of available trunks.

Response Format

 {
    "code": 200,
    "data": {
      "limit": 1,
      "total": 4,
      "page": 1,
      "results": [
        {
          "handle": "WORLD_WIDE",
          "name": "World Wide",
          "trunk_zone_handle": "WORLD_WIDE",
          "_rates": {
            "initial_cost": "20.00",
            "monthly_cost": "5.00"
          }
        }
      ]
    }
  }

Filters

Name

Information

page

Requirement	\d+
Description	Zero based offset index for the results. e.g. 0 would start at the first result and 10 would start at the eleventh result.
Default	1

limit

Requirement	\d+
Description	Maximum number of results to return in the response.
Default	10

Return

Parameter	Type	Versions	Description
handle	string	*
name	string	*

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
200	Returned when successful
404	Resource not found

Input

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/dids/products/trunks/countries

GET /dids/products/trunks/countries

Allow clients to get trunk zones.

Documentation
Sandbox

Documentation

Allow clients to get trunk zones.

Response Format

 {
    "code": 200,
    "data": {
        "limit": 10,
        "total": 1,
        "page": 1,
        "results": [
        {
            "_trunk_zone": {
              "handle": "WORLD_WIDE",
              "name": "World Wide"
            },
            "_country": {
              "iso2": "AU",
              "handle": "AUSTRALIA",
              "dial_code": 61,
              "name": "Australia",
              "iso3": "AUS"
            }
        }
      ]
    }
  }

Filters

Name

Information

page

Requirement	\d+
Description	Zero based offset index for the results. e.g. 0 would start at the first result and 10 would start at the eleventh result.
Default	1

limit

Requirement	\d+
Description	Maximum number of results to return in the response.
Default	10

filter

Requirement
Description	Allowed fields: country_iso2, trunk_handle.

Return

Parameter	Type	Versions
iso2	string	*
handle	string	*
dial_code	integer	*
name	string	*
iso3	string	*

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
200	Returned when successful
404	Resource not found

Input

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/dids/products/trunks/{trunk_handle}

GET /dids/products/trunks/{trunk_handle}

Allow clients to get a specific trunk.

Documentation
Sandbox

Documentation

Allow clients to get a specific trunk.

Response Format

 {
    "code": 200,
    "data": {
      "handle": "WORLD_WIDE",
      "name": "World Wide",
      "trunk_zone_handle": "WORLD_WIDE",
      "_rates": {
        "initial_cost": "5.00",
        "monthly_cost": "5.00"
      }
    }
 }

Requirements

Name	Requirement	Type	Description
trunk_handle		string

Return

Parameter	Type	Versions	Description
handle	string	*
name	string	*

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
200	Returned when successful
404	Resource not found

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

Show/hide List Operations Expand Operations

Users

/authentications

GET /authentications

Test authentication

Documentation
Sandbox

Documentation

Allow clients to test authentication.

Expected Response

 {
    "code": 200,
    "message": "Hello jonh@example.com!, You've successfully authenticated on our platform."
 }

Status Codes

Status Code	Description
401	You are not authenticated
403	This action needs a valid WSSE header
200	Returned when successful

Input

Headers

= -

Content

= Replaces header if set

Magic Telecom API

Welcome to our RESTful API

Accounts

/accounts

GET /accounts

Documentation

Filters

Status Codes

Filters

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

POST /accounts

Documentation

Status Codes

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/accounts/{account_number}

DELETE /accounts/{account_number}

Documentation

Requirements

Status Codes

Requirements

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /accounts/{account_number}

Documentation

Requirements

Return

Status Codes

Requirements

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

PUT /accounts/{account_number}

Documentation

Requirements

Status Codes

Requirements

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/accounts/{account_number}/access-tokens

GET /accounts/{account_number}/access-tokens

Documentation

Requirements

Filters

Return

Status Codes

Requirements

Filters

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

POST /accounts/{account_number}/access-tokens

Documentation

Requirements

Status Codes

Requirements

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/accounts/{account_number}/access-tokens/{token}

DELETE /accounts/{account_number}/access-tokens/{token}

Documentation

Requirements

Status Codes

Requirements

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /accounts/{account_number}/access-tokens/{token}

Documentation

Requirements

Return

Status Codes

Requirements

Request URL