Overview

About

The IDT Express API is built to allow our users seamless integration into their back office systems. For v1.0 of our APIs posted here, we support phone number (DID) purchasing. With this API, you will be able to view what locations we offer, buy numbers, and manage the IDT Express numbers that you own. Additional functionality is being added monthly, so please check back often.

For access to this API, please contact your IDT Express Account Manager.

Once you have access, your API credentials will be shared and managed through the IDT Express Portal.

Environments

Once you have credentials to the API, you will be able to access both our Sandbox and Live environments.

Here are the servers for each of the environments:

Environment	Server
Sandbox	https://sandbox-api.idtexpress.com
Live	https://api.idtexpress.com

Sandbox

The Sandbox environment is the environment that you will use when testing our APIs or developing your application.

The data used for the Sandbox environment is all fake. For example, the phone numbers returned from the Get Numbers endpoint are not your phone numbers. The orders created with the Create Order endpoint are not creating orders on your production account.

No API calls made here affect your account. The Sandbox environment is only to be used to test our APIs or develop your application.

Live

The Live environment is the real, production environment. API calls in this environment affect your production account.

For example, ordering a new phone number with the Create Order endpoint will generate an order in your production account and use the funds necessary to purchase that number.

Authentication

To access our APIs, you will need to use your account's API Key and the API Secret for the environment you are calling. Log in to the IDT Express Portal to view your account's API key and each environment's API Secret.

You will need to pass both the API Key and the environment's API Secret in the request headers.

Header Name	Value
x-api-key	The account's API Key
x-api-secret	The environment's API Secret

Example: curl -H 'x-api-key: 1234567890' \ -H 'x-api-secret: 10987654321' \ 'https://api.idtexpress.com/v1/dids/coverage/countries'

HTTP Status Codes, Error Responses and Codes

Successful API responses will either return an HTTP status code of 200 or 201.

Application or client level errors will return 4xx codes.

Common HTTP Status Codes

Status Code	Description
200	Successful response
201	Resource created
403	Access is Denied. You may no longer have access to the API or have incorrect credentials set. Reach out to your account manager
404	The endpoint you are using does not exist. Check the url that you are using
422	Validation error. The data that you are sending is incorrect. Check the response body for more details
429	You have either been throttled or you reached your request limit. Reach out to your account manager

Error object

For 4xx HTTP responses, we will return an object that will help identify what the issues are.

Some Example Responses
----------------------

A response like this would be returned if there were not enough funds available to complete what was ordered:
{
   "status":422,
   "api_request_id":"f5263b41-6935-4823-b118-72c759645dfc",
   "errors":[
      {
         "code":3001,
         "title":"Insufficient Funds",
         "detail":"Insufficient Funds (cost: 6.39, account balance: 0.31)",
         "source":"/"
      }
   ]
}

In this example, the quantity field for the order item did not pass validation:
{
   "status":422,
   "api_request_id":"a171cfe8-a18c-49cc-be94-41511eaac645",
   "errors":[
      {
         "code": 1002,
         "title": "Invalid Field",
         "detail": "Quantity must be greater than 0",
         "field": "quantity",
         "source": "/order_items/0/quantity"
      }
   ]
}

Attribute	Description	Required
status	The HTTP status code applicable to this problem expressed as an integer	Yes
errors	An array of Error objects that will always have at least 1 Error object	Yes
api_request_id	A system generated string that can help us troubleshoot the error	Yes

The Error object returned in the errors array looks like the following:

Attribute	Description	Required
code	An application-specific code representing the type of problem encountered	Yes
title	A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem	Yes
detail	A human-readable explanation specific to this occurrence of the problem	Yes
field	The field or parameter name that is causing the issue. This field will only be present if applicable	No
source	a JSON Pointer [RFC6901] to the associated entity in the request body. This field will only be present if the request has a JSON body, and a valid pointer can be generated. Error responses from GET/DELETE requests will never return this field	No

Here is a list of common errors codes that you may run into:

Code	Title	Description
1000	Invalid Request	Used when we have not defined a more specific error code
1001	Required Field Missing	A required field or parameter is missing
1002	Invalid Field	A validation error on a field or parameter
1003	Resource Not Found	A request to a resource or endpoint that does not exist
2000	Access Denied	Request access is denied
2001	Quota Exceeded	Quota exceeded allotment for your account. Please contact your Account Manager for more information
2002	Throttled	Throttling request limit exceeded for your account. Please contact your Account Manager for more information
3000	DIDs Feature Not Enabled	Your account no longer has access to purchase DIDs/numbers
3001	Insufficient Funds	Insufficient funds available on the account to complete the requested order
4000	Toll-Free Number Not Offered	A request to browse for Toll-Free DID Groups was not allowed because Toll-Free numbers are not available in the Region or Country
4001	Number Not Found	An action was attempted on a number that does not belong to the Account or the number is not found
4002	Region Not Offered	A request to browse for DID Groups in a region that is not offered
4003	Country Not Offered	A request to browse for DID Groups in a country that is not offered
4004	Invalid DID Group	A request to order from a DID Group that is not offered
4005	Trunk Group Not Found	A request using a Trunk Group id that does not belong to the Account or is not found
4006	Cannot Delete Trunk Group	Deleting the default Trunk Group on the Account is prohibited
4007	Cannot Update CNAM setting	Number does not support CNAM, or a CNAM update is already in progress
4008	Cannot Delete CNAM setting	Number does not have a CNAM setting, or a CNAM update is already in progress

API Reference

This section lists all of the endpoints for the IDT Express API.

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

You can replace **** with the your API Key and environment's API Secret in all examples.

Purchase Numbers

Use these API endpoints to order new DID numbers for your account.

Get Countries

Code samples

curl -v \
-H "x-api-key: ****" \
-H "x-api-secret: ****" \
"https://api.idtexpress.com/v1/dids/coverage/countries"

require "uri"
require "net/http"

url = URI("https://api.idtexpress.com/v1/dids/coverage/countries")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = "****"
request["x-api-secret"] = "****"

response = https.request(request)
puts response.read_body

import http.client

conn = http.client.HTTPSConnection("api.idtexpress.com")
payload = ''
headers = {
   'x-api-key': '****',
   'x-api-secret': '****'
}
conn.request("GET", "/v1/dids/coverage/countries", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

var settings = {
   "url": "https://api.idtexpress.com/v1/dids/coverage/countries",
   "method": "GET",
   "timeout": 0,
   "headers": {
      "x-api-key": "****",
      "x-api-secret": "****"
   },
};

$.ajax(settings).done(function (response) {
   console.log(response);
});

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
   'method': 'GET',
   'hostname': 'api.idtexpress.com',
   'path': '/v1/dids/coverage/countries',
   'headers': {
      'x-api-key': '****',
      'x-api-secret': '****'
   },
   'maxRedirects': 20
};

var req = https.request(options, function (res) {
   var chunks = [];

   res.on("data", function (chunk) {
      chunks.push(chunk);
   });

   res.on("end", function (chunk) {
      var body = Buffer.concat(chunks);
      console.log(body.toString());
   });

   res.on("error", function (error) {
      console.error(error);
   });
});

req.end();

package main

import (
   "fmt"
   "net/http"
   "io"
)

func main() {

   url := "https://api.idtexpress.com/v1/dids/coverage/countries"
   method := "GET"

   client := &http.Client {
   }
   req, err := http.NewRequest(method, url, nil)

   if err != nil {
      fmt.Println(err)
      return
   }
   req.Header.Add("x-api-key", "****")
   req.Header.Add("x-api-secret", "****")

   res, err := client.Do(req)
   if err != nil {
      fmt.Println(err)
      return
   }
   defer res.Body.Close()

   body, err := io.ReadAll(res.Body)
   if err != nil {
      fmt.Println(err)
      return
   }
   fmt.Println(string(body))
}

var request = URLRequest(url: URL(string: "https://api.idtexpress.com/v1/dids/coverage/countries")!,timeoutInterval: Double.infinity)
request.addValue("****", forHTTPHeaderField: "x-api-key")
request.addValue("****", forHTTPHeaderField: "x-api-secret")

request.httpMethod = "GET"

let task = URLSession.shared.dataTask(with: request) { data, response, error in 
   guard let data = data else {
      print(String(describing: error))
      return
   }
   print(String(data: data, encoding: .utf8)!)
}

task.resume()

OkHttpClient client = new OkHttpClient().newBuilder()
   .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
   .url("https://api.idtexpress.com/v1/dids/coverage/countries")
   .method("GET", body)
   .addHeader("x-api-key", "****")
   .addHeader("x-api-secret", "****")
   .build();
Response response = client.newCall(request).execute();

var options = new RestClientOptions("https://api.idtexpress.com")
{
   MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("/v1/dids/coverage/countries", Method.Get);
request.AddHeader("x-api-key", "****");
request.AddHeader("x-api-secret", "****");
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
   CURLOPT_URL => 'https://api.idtexpress.com/v1/dids/coverage/countries',
   CURLOPT_RETURNTRANSFER => true,
   CURLOPT_ENCODING => '',
   CURLOPT_MAXREDIRS => 10,
   CURLOPT_TIMEOUT => 0,
   CURLOPT_FOLLOWLOCATION => true,
   CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
   CURLOPT_CUSTOMREQUEST => 'GET',
   CURLOPT_HTTPHEADER => array(
      'x-api-key: ****',
      'x-api-secret: ****'
   ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Retrieves all of the countries that you can purchase phone numbers from.

Endpoint

GET /v1/dids/coverage/countries

Example responses

200 Response

{
  "countries": [
    {
      "name": "Poland",
      "iso": "PL",
      "has_regions": false,
      "supports_toll_free": false
    },
    {
      "name": "Puerto Rico",
      "iso": "PR",
      "has_regions": false,
      "supports_toll_free": false
    },
    {
      "name": "USA",
      "iso": "US",
      "has_regions": true,
      "supports_toll_free": true
    }
  ],
  "meta": {
    "total": 3
  }
}

Response Schema

Status Code 200

Get Regions

Code samples

curl -v \
-H "x-api-key: ****" \
-H "x-api-secret: ****" \
"https://api.idtexpress.com/v1/dids/coverage/countries/CA/regions"

require "uri"
require "net/http"

url = URI("https://api.idtexpress.com/v1/dids/coverage/countries/CA/regions")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = "****"
request["x-api-secret"] = "****"

response = https.request(request)
puts response.read_body

import http.client

conn = http.client.HTTPSConnection("api.idtexpress.com")
payload = ''
headers = {
   'x-api-key': '****',
   'x-api-secret': '****'
}
conn.request("GET", "/v1/dids/coverage/countries/CA/regions", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

var settings = {
   "url": "https://api.idtexpress.com/v1/dids/coverage/countries/CA/regions",
   "method": "GET",
   "timeout": 0,
   "headers": {
      "x-api-key": "****",
      "x-api-secret": "****"
   },
};

$.ajax(settings).done(function (response) {
   console.log(response);
});

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
   'method': 'GET',
   'hostname': 'api.idtexpress.com',
   'path': '/v1/dids/coverage/countries/CA/regions',
   'headers': {
      'x-api-key': '****',
      'x-api-secret': '****'
   },
   'maxRedirects': 20
};

var req = https.request(options, function (res) {
   var chunks = [];

   res.on("data", function (chunk) {
      chunks.push(chunk);
   });

   res.on("end", function (chunk) {
      var body = Buffer.concat(chunks);
      console.log(body.toString());
   });

   res.on("error", function (error) {
      console.error(error);
   });
});

req.end();

package main

import (
   "fmt"
   "net/http"
   "io"
)

func main() {

   url := "https://api.idtexpress.com/v1/dids/coverage/countries/CA/regions"
   method := "GET"

   client := &http.Client {
   }
   req, err := http.NewRequest(method, url, nil)

   if err != nil {
      fmt.Println(err)
      return
   }
   req.Header.Add("x-api-key", "****")
   req.Header.Add("x-api-secret", "****")

   res, err := client.Do(req)
   if err != nil {
      fmt.Println(err)
      return
   }
   defer res.Body.Close()

   body, err := io.ReadAll(res.Body)
   if err != nil {
      fmt.Println(err)
      return
   }
   fmt.Println(string(body))
}

var request = URLRequest(url: URL(string: "https://api.idtexpress.com/v1/dids/coverage/countries/CA/regions")!,timeoutInterval: Double.infinity)
request.addValue("****", forHTTPHeaderField: "x-api-key")
request.addValue("****", forHTTPHeaderField: "x-api-secret")

request.httpMethod = "GET"

let task = URLSession.shared.dataTask(with: request) { data, response, error in 
   guard let data = data else {
      print(String(describing: error))
      return
   }
   print(String(data: data, encoding: .utf8)!)
}

task.resume()

OkHttpClient client = new OkHttpClient().newBuilder()
   .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
   .url("https://api.idtexpress.com/v1/dids/coverage/countries/CA/regions")
   .method("GET", body)
   .addHeader("x-api-key", "****")
   .addHeader("x-api-secret", "****")
   .build();
Response response = client.newCall(request).execute();

var options = new RestClientOptions("https://api.idtexpress.com")
{
   MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("/v1/dids/coverage/countries/CA/regions", Method.Get);
request.AddHeader("x-api-key", "****");
request.AddHeader("x-api-secret", "****");
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
   CURLOPT_URL => 'https://api.idtexpress.com/v1/dids/coverage/countries/CA/regions',
   CURLOPT_RETURNTRANSFER => true,
   CURLOPT_ENCODING => '',
   CURLOPT_MAXREDIRS => 10,
   CURLOPT_TIMEOUT => 0,
   CURLOPT_FOLLOWLOCATION => true,
   CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
   CURLOPT_CUSTOMREQUEST => 'GET',
   CURLOPT_HTTPHEADER => array(
      'x-api-key: ****',
      'x-api-secret: ****'
   ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Returns all the regions for a specific country. Currently this endpoint only supports US and Canada.

Endpoint

GET /v1/dids/coverage/countries/{country_iso}/regions

Parameters

Name	In	Type	Required	Description
country_iso	path	string	true	2 letter country code. See Get Countries

Example responses

200 Response

{
  "regions": [
    {
      "name": "Alberta",
      "code": "CA-AB"
    },
    {
      "name": "British Columbia",
      "code": "CA-BC"
    },
    {
      "name": "Manitoba",
      "code": "CA-MB"
    },
    {
      "name": "Newfoundland and Labrador",
      "code": "CA-NF"
    },
    {
      "name": "Nova Scotia",
      "code": "CA-NS"
    },
    {
      "name": "Ontario",
      "code": "CA-ON"
    },
    {
      "name": "Quebec",
      "code": "CA-QC"
    }
  ],
  "meta": {
    "total": 7
  }
}

Response Schema

Status Code 200

Get DID Groups

Code samples

curl -v \
-H "x-api-key: ****" \
-H "x-api-secret: ****" \
"https://api.idtexpress.com/v1/dids/coverage/did_groups?country_iso=US&region_code=US-AK"

require "uri"
require "net/http"

url = URI("https://api.idtexpress.com/v1/dids/coverage/did_groups?country_iso=US&region_code=US-AK")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = "****"
request["x-api-secret"] = "****"

response = https.request(request)
puts response.read_body

import http.client

conn = http.client.HTTPSConnection("api.idtexpress.com")
payload = ''
headers = {
   'x-api-key': '****',
   'x-api-secret': '****'
}
conn.request("GET", "/v1/dids/coverage/did_groups?country_iso=US&region_code=US-AK", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

var settings = {
   "url": "https://api.idtexpress.com/v1/dids/coverage/did_groups?country_iso=US&region_code=US-AK",
   "method": "GET",
   "timeout": 0,
   "headers": {
      "x-api-key": "****",
      "x-api-secret": "****"
   },
};

$.ajax(settings).done(function (response) {
   console.log(response);
});

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
   'method': 'GET',
   'hostname': 'api.idtexpress.com',
   'path': '/v1/dids/coverage/did_groups?country_iso=US&region_code=US-AK',
   'headers': {
      'x-api-key': '****',
      'x-api-secret': '****'
   },
   'maxRedirects': 20
};

var req = https.request(options, function (res) {
   var chunks = [];

   res.on("data", function (chunk) {
      chunks.push(chunk);
   });

   res.on("end", function (chunk) {
      var body = Buffer.concat(chunks);
      console.log(body.toString());
   });

   res.on("error", function (error) {
      console.error(error);
   });
});

req.end();

package main

import (
   "fmt"
   "net/http"
   "io"
)

func main() {

   url := "https://api.idtexpress.com/v1/dids/coverage/did_groups?country_iso=US&region_code=US-AK"
   method := "GET"

   client := &http.Client {
   }
   req, err := http.NewRequest(method, url, nil)

   if err != nil {
      fmt.Println(err)
      return
   }
   req.Header.Add("x-api-key", "****")
   req.Header.Add("x-api-secret", "****")

   res, err := client.Do(req)
   if err != nil {
      fmt.Println(err)
      return
   }
   defer res.Body.Close()

   body, err := io.ReadAll(res.Body)
   if err != nil {
      fmt.Println(err)
      return
   }
   fmt.Println(string(body))
}

var request = URLRequest(url: URL(string: "https://api.idtexpress.com/v1/dids/coverage/did_groups?country_iso=US&region_code=US-AK")!,timeoutInterval: Double.infinity)
request.addValue("****", forHTTPHeaderField: "x-api-key")
request.addValue("****", forHTTPHeaderField: "x-api-secret")

request.httpMethod = "GET"

let task = URLSession.shared.dataTask(with: request) { data, response, error in 
   guard let data = data else {
      print(String(describing: error))
      return
   }
   print(String(data: data, encoding: .utf8)!)
}

task.resume()

OkHttpClient client = new OkHttpClient().newBuilder()
   .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
   .url("https://api.idtexpress.com/v1/dids/coverage/did_groups?country_iso=US&region_code=US-AK")
   .method("GET", body)
   .addHeader("x-api-key", "****")
   .addHeader("x-api-secret", "****")
   .build();
Response response = client.newCall(request).execute();

var options = new RestClientOptions("https://api.idtexpress.com")
{
   MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("/v1/dids/coverage/did_groups?country_iso=US&region_code=US-AK", Method.Get);
request.AddHeader("x-api-key", "****");
request.AddHeader("x-api-secret", "****");
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
   CURLOPT_URL => 'https://api.idtexpress.com/v1/dids/coverage/did_groups?country_iso=US&region_code=US-AK',
   CURLOPT_RETURNTRANSFER => true,
   CURLOPT_ENCODING => '',
   CURLOPT_MAXREDIRS => 10,
   CURLOPT_TIMEOUT => 0,
   CURLOPT_FOLLOWLOCATION => true,
   CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
   CURLOPT_CUSTOMREQUEST => 'GET',
   CURLOPT_HTTPHEADER => array(
      'x-api-key: ****',
      'x-api-secret: ****'
   ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Returns a list of DID Groups that are available based on the given query parameters.

All phone numbers in our system are associated with a DID Group. A DID Group is the location, region, and country that the number belongs to.

This endpoint also returns the pricing information for each DID Group, such as monthly and setup fees.

Additionally, a supports_browse flag is returned indicating if the DID Group can be used with Browse Avaliable Numbers.

You will need to use the DID Group ID to order phone numbers in Create Order.

Endpoint

GET /v1/dids/coverage/did_groups

Parameters

Name	In	Type	Required	Description
country_iso	query	string	true	2 letter country code. See Get Countries
region_code	query	string	false	Region code (example format: "US-AK"). This field is required for countries that support regions, such as US and CA. Exception: DO NOT include region code if you are browsing for Toll-Free numbers. See Get Regions
toll_free	query	boolean	false	Indicates if you are looking for Toll-Free numbers. If you are looking for Toll-Free numbers in US or Canada, do not pass in the region code

Example responses

200 Response

{
   "did_groups":[
      {
         "id":2992,
         "name":"FANWOOD (908) 312",
         "country_calling_code":"1",
         "area_code":"908",
         "nxx":"312",
         "toll_free":false,
         "supports_browse":true,
         "quantity": 141,
         "country":{
            "name":"USA",
            "iso":"US",
            "has_regions":true,
            "supports_toll_free":true
         },
         "region":{
            "name":"Alaska",
            "code":"US-AK"
         },
         "fees":{
            "setup_fee":"0.00",
            "monthly_fee":"5.00",
            "per_minute_rate":"4.7354"
         }
      },
      {
         "id":4884,
         "name":"Monroe (318) 450",
         "country_calling_code":"1",
         "area_code":"318",
         "nxx":"450",
         "toll_free":false,
         "supports_browse":true,
         "quantity": 219,
         "country":{
            "name":"USA",
            "iso":"US",
            "has_regions":true,
            "supports_toll_free":true
         },
         "region":{
            "name":"Alaska",
            "code":"US-AK"
         },
         "fees":{
            "setup_fee":"0.00",
            "monthly_fee":"5.00",
            "per_minute_rate":"4.7354"
         }
      }
   ],
   "meta":{
      "total":2
   }
}

Response Schema

Status Code 200

Browse Available Numbers

Code sampless

curl -v \
-H "x-api-key: ****" \
-H "x-api-secret: ****" \
"https://api.idtexpress.com/v1/dids/coverage/did_groups/39145/browse_numbers"

require "uri"
require "net/http"

url = URI("https://api.idtexpress.com/v1/dids/coverage/did_groups/39145/browse_numbers")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = "****"
request["x-api-secret"] = "****"

response = https.request(request)
puts response.read_body

import http.client

conn = http.client.HTTPSConnection("api.idtexpress.com")
payload = ''
headers = {
   'x-api-key': '****',
   'x-api-secret': '****'
}
conn.request("GET", "/v1/dids/coverage/did_groups/39145/browse_numbers", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

var settings = {
   "url": "https://api.idtexpress.com/v1/dids/coverage/did_groups/39145/browse_numbers",
   "method": "GET",
   "timeout": 0,
   "headers": {
      "x-api-key": "****",
      "x-api-secret": "****"
   },
};

$.ajax(settings).done(function (response) {
   console.log(response);
});

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
   'method': 'GET',
   'hostname': 'api.idtexpress.com',
   'path': '/v1/dids/coverage/did_groups/39145/browse_numbers',
   'headers': {
      'x-api-key': '****',
      'x-api-secret': '****'
   },
   'maxRedirects': 20
};

var req = https.request(options, function (res) {
   var chunks = [];

   res.on("data", function (chunk) {
      chunks.push(chunk);
   });

   res.on("end", function (chunk) {
      var body = Buffer.concat(chunks);
      console.log(body.toString());
   });

   res.on("error", function (error) {
      console.error(error);
   });
});

req.end();

package main

import (
   "fmt"
   "net/http"
   "io"
)

func main() {

   url := "https://api.idtexpress.com/v1/dids/coverage/did_groups/39145/browse_numbers"
   method := "GET"

   client := &http.Client {
   }
   req, err := http.NewRequest(method, url, nil)

   if err != nil {
      fmt.Println(err)
      return
   }
   req.Header.Add("x-api-key", "****")
   req.Header.Add("x-api-secret", "****")

   res, err := client.Do(req)
   if err != nil {
      fmt.Println(err)
      return
   }
   defer res.Body.Close()

   body, err := io.ReadAll(res.Body)
   if err != nil {
      fmt.Println(err)
      return
   }
   fmt.Println(string(body))
}

var request = URLRequest(url: URL(string: "https://api.idtexpress.com/v1/dids/coverage/did_groups/39145/browse_numbers")!,timeoutInterval: Double.infinity)
request.addValue("****", forHTTPHeaderField: "x-api-key")
request.addValue("****", forHTTPHeaderField: "x-api-secret")

request.httpMethod = "GET"

let task = URLSession.shared.dataTask(with: request) { data, response, error in 
   guard let data = data else {
      print(String(describing: error))
      return
   }
   print(String(data: data, encoding: .utf8)!)
}

task.resume()

OkHttpClient client = new OkHttpClient().newBuilder()
   .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
   .url("https://api.idtexpress.com/v1/dids/coverage/did_groups/39145/browse_numbers")
   .method("GET", body)
   .addHeader("x-api-key", "****")
   .addHeader("x-api-secret", "****")
   .build();
Response response = client.newCall(request).execute();

var options = new RestClientOptions("https://api.idtexpress.com")
{
   MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("/v1/dids/coverage/did_groups/39145/browse_numbers", Method.Get);
request.AddHeader("x-api-key", "****");
request.AddHeader("x-api-secret", "****");
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
   CURLOPT_URL => 'https://api.idtexpress.com/v1/dids/coverage/did_groups/39145/browse_numbers',
   CURLOPT_RETURNTRANSFER => true,
   CURLOPT_ENCODING => '',
   CURLOPT_MAXREDIRS => 10,
   CURLOPT_TIMEOUT => 0,
   CURLOPT_FOLLOWLOCATION => true,
   CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
   CURLOPT_CUSTOMREQUEST => 'GET',
   CURLOPT_HTTPHEADER => array(
      'x-api-key: ****',
      'x-api-secret: ****'
   ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Retrieves DID numbers available for purchase for a given DID Group. An array of available numbers and their corresponding skus are returned. Use the skus for ordering the specific numbers you want. See Create Order

Note: only DID Groups where the supports_browse value is true can be used with this endpoint (See Get DID Groups).

Endpoint

GET /v1/dids/coverage/did_groups/{did_group_id}/browse_numbers

Parameters

Name	In	Type	Required	Description
did_group_id	path	string	true	The DID Group you want to browse for available numbers. Use any DID Group ID from Get DID Groups where the supports_browse value is true

Example responses

200 Response (US DID Group)

{
  "numbers": [
    {
      "number": "12074063052",
      "sku": "BW-US-2074063052"
    },
    {
      "number": "12074063062",
      "sku": "BW-US-2074063062"
    },
    {
      "number": "12074063064",
      "sku": "BW-US-2074063064"
    },
    {
      "number": "12074063076",
      "sku": "BW-US-2074063076"
    }
  ]
}

200 Response (non-US DID Group)

{
  "numbers": [
    {
      "number": "01144146120055",
      "sku": "DW-GB-146120055-DG-52806d35-224a-4e72-8f52-9b930505e72a-DI-fe332db0-361c-4799-80e3-a3ca9ab9a80f"
    },
    {
      "number": "01144146120062",
      "sku": "DW-GB-146120062-DG-52806d35-224a-4e72-8f52-9b930505e72a-DI-9f060243-bd21-4068-aedd-d3650662f248"
    },
    {
      "number": "01144146120096",
      "sku": "DW-GB-146120096-DG-52806d35-224a-4e72-8f52-9b930505e72a-DI-8b8ccefa-29aa-4181-b365-b8630463d32a"
    },
    {
      "number": "01144146120102",
      "sku": "DW-GB-146120102-DG-52806d35-224a-4e72-8f52-9b930505e72a-DI-683e9f3f-4c8c-4ab5-861a-1b5a94fa5552"
    }
  ]
}

Response Schema

Status Code 200

Create Order

Code samples

Order by quantity

curl -v \
-X POST "https://api.idtexpress.com/v1/dids/orders" \
-H "x-api-key: ****" \
-H "x-api-secret: ****" \
-H 'Content-Type: application/json; charset=utf-8' \
-d '{ "order_items": [ { "did_group_id": 16847, "quantity": 3 } ]}'

require "uri"
require "net/http"

url = URI("https://api.idtexpress.com/v1/dids/orders")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = "****"
request["x-api-secret"] = "****"
request["Content-Type"] = "application/json; charset=utf-8"
request.body = "{ \"order_items\": [ { \"did_group_id\": 16847, \"quantity\": 3 } ]}"

response = https.request(request)
puts response.read_body

import http.client

conn = http.client.HTTPSConnection("api.idtexpress.com")
payload = "{ \"order_items\": [ { \"did_group_id\": 16847, \"quantity\": 3 } ]}"
headers = {
   'x-api-key': '****',
   'x-api-secret': '****',
   'Content-Type': 'application/json; charset=utf-8'
}
conn.request("POST", "/v1/dids/orders", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

var settings = {
   "url": "https://api.idtexpress.com/v1/dids/orders",
   "method": "POST",
   "timeout": 0,
   "headers": {
      "x-api-key": "****",
      "x-api-secret": "****",
      "Content-Type": "application/json; charset=utf-8"
   },
   "data": "{ \"order_items\": [ { \"did_group_id\": 16847, \"quantity\": 3 } ]}",
};

$.ajax(settings).done(function (response) {
   console.log(response);
});

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
   'method': 'POST',
   'hostname': 'api.idtexpress.com',
   'path': '/v1/dids/orders',
   'headers': {
      'x-api-key': '****',
      'x-api-secret': '****',
      'Content-Type': 'application/json; charset=utf-8'
   },
   'maxRedirects': 20
};

var req = https.request(options, function (res) {
   var chunks = [];

   res.on("data", function (chunk) {
      chunks.push(chunk);
   });

   res.on("end", function (chunk) {
      var body = Buffer.concat(chunks);
      console.log(body.toString());
   });

   res.on("error", function (error) {
      console.error(error);
   });
});

var postData =  "{ \"order_items\": [ { \"did_group_id\": 16847, \"quantity\": 3 } ]}";

req.write(postData);

req.end();

package main

import (
   "fmt"
   "strings"
   "net/http"
   "io"
)

func main() {

   url := "https://api.idtexpress.com/v1/dids/orders"
   method := "POST"

   payload := strings.NewReader(`{ "order_items": [ { "did_group_id": 16847, "quantity": 3 } ]}`)

   client := &http.Client {
   }
   req, err := http.NewRequest(method, url, payload)

   if err != nil {
      fmt.Println(err)
      return
   }
   req.Header.Add("x-api-key", "****")
   req.Header.Add("x-api-secret", "****")
   req.Header.Add("Content-Type", "application/json; charset=utf-8")

   res, err := client.Do(req)
   if err != nil {
      fmt.Println(err)
      return
   }
   defer res.Body.Close()

   body, err := io.ReadAll(res.Body)
   if err != nil {
      fmt.Println(err)
      return
   }
   fmt.Println(string(body))
}

let parameters = "{ \"order_items\": [ { \"did_group_id\": 16847, \"quantity\": 3 } ]}"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "https://api.idtexpress.com/v1/dids/orders")!,timeoutInterval: Double.infinity)
request.addValue("****", forHTTPHeaderField: "x-api-key")
request.addValue("****", forHTTPHeaderField: "x-api-secret")
request.addValue("application/json; charset=utf-8", forHTTPHeaderField: "Content-Type")

request.httpMethod = "POST"
request.httpBody = postData

let task = URLSession.shared.dataTask(with: request) { data, response, error in 
   guard let data = data else {
      print(String(describing: error))
      return
   }
   print(String(data: data, encoding: .utf8)!)
}

task.resume()

OkHttpClient client = new OkHttpClient().newBuilder()
   .build();
MediaType mediaType = MediaType.parse("application/json; charset=utf-8");
RequestBody body = RequestBody.create(mediaType, "{ \"order_items\": [ { \"did_group_id\": 16847, \"quantity\": 3 } ]}");
Request request = new Request.Builder()
   .url("https://api.idtexpress.com/v1/dids/orders")
   .method("POST", body)
   .addHeader("x-api-key", "****")
   .addHeader("x-api-secret", "****")
   .addHeader("Content-Type", "application/json; charset=utf-8")
   .build();
Response response = client.newCall(request).execute();

var options = new RestClientOptions("https://api.idtexpress.com")
{
   MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("/v1/dids/orders", Method.Post);
request.AddHeader("x-api-key", "****");
request.AddHeader("x-api-secret", "****");
request.AddHeader("Content-Type", "application/json; charset=utf-8");
var body = @"{ ""order_items"": [ { ""did_group_id"": 16847, ""quantity"": 3 } ]}";
request.AddParameter("application/json; charset=utf-8", body,  ParameterType.RequestBody);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
   CURLOPT_URL => 'https://api.idtexpress.com/v1/dids/orders',
   CURLOPT_RETURNTRANSFER => true,
   CURLOPT_ENCODING => '',
   CURLOPT_MAXREDIRS => 10,
   CURLOPT_TIMEOUT => 0,
   CURLOPT_FOLLOWLOCATION => true,
   CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
   CURLOPT_CUSTOMREQUEST => 'POST',
   CURLOPT_POSTFIELDS =>'{ "order_items": [ { "did_group_id": 16847, "quantity": 3 } ]}',
   CURLOPT_HTTPHEADER => array(
      'x-api-key: ****',
      'x-api-secret: ****',
      'Content-Type: application/json; charset=utf-8'
   ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Order by number sku

curl -v \
-X POST "https://api.idtexpress.com/v1/dids/orders" \
-H "x-api-key: ****" \
-H "x-api-secret: ****" \
-H 'Content-Type: application/json; charset=utf-8' \
-d '{ "order_items": [ { "did_group_id": 39145, "did_skus": [ "BW-US-2074063052", "BW-US-2074063062" ] } ]}'

require "uri"
require "net/http"

url = URI("https://api.idtexpress.com/v1/dids/orders")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = "****"
request["x-api-secret"] = "****"
request["Content-Type"] = "application/json; charset=utf-8"
request.body = "{ \"order_items\": [ { \"did_group_id\": 39145, \"did_skus\": [ \"BW-US-2074063052\", \"BW-US-2074063062\" ] } ]}"

response = https.request(request)
puts response.read_body

import http.client

conn = http.client.HTTPSConnection("api.idtexpress.com")
payload = "{ \"order_items\": [ { \"did_group_id\": 39145, \"did_skus\": [ \"BW-US-2074063052\", \"BW-US-2074063062\" ] } ]}"
headers = {
   'x-api-key': '****',
   'x-api-secret': '****',
   'Content-Type': 'application/json; charset=utf-8'
}
conn.request("POST", "/v1/dids/orders", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

var settings = {
   "url": "https://api.idtexpress.com/v1/dids/orders",
   "method": "POST",
   "timeout": 0,
   "headers": {
      "x-api-key": "****",
      "x-api-secret": "****",
      "Content-Type": "application/json; charset=utf-8"
   },
   "data": "{ \"order_items\": [ { \"did_group_id\": 39145, \"did_skus\": [ \"BW-US-2074063052\", \"BW-US-2074063062\" ] } ]}",
};

$.ajax(settings).done(function (response) {
   console.log(response);
});

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
   'method': 'POST',
   'hostname': 'api.idtexpress.com',
   'path': '/v1/dids/orders',
   'headers': {
      'x-api-key': '****',
      'x-api-secret': '****',
      'Content-Type': 'application/json; charset=utf-8'
   },
   'maxRedirects': 20
};

var req = https.request(options, function (res) {
   var chunks = [];

   res.on("data", function (chunk) {
      chunks.push(chunk);
   });

   res.on("end", function (chunk) {
      var body = Buffer.concat(chunks);
      console.log(body.toString());
   });

   res.on("error", function (error) {
      console.error(error);
   });
});

var postData =  "{ \"order_items\": [ { \"did_group_id\": 39145, \"did_skus\": [ \"BW-US-2074063052\", \"BW-US-2074063062\" ] } ]}";

req.write(postData);

req.end();

package main

import (
   "fmt"
   "strings"
   "net/http"
   "io"
)

func main() {

   url := "https://api.idtexpress.com/v1/dids/orders"
   method := "POST"

   payload := strings.NewReader(`{ "order_items": [ { "did_group_id": 39145, "did_skus": [ "BW-US-2074063052", "BW-US-2074063062" ] } ]}`)

   client := &http.Client {
   }
   req, err := http.NewRequest(method, url, payload)

   if err != nil {
      fmt.Println(err)
      return
   }
   req.Header.Add("x-api-key", "****")
   req.Header.Add("x-api-secret", "****")
   req.Header.Add("Content-Type", "application/json; charset=utf-8")

   res, err := client.Do(req)
   if err != nil {
      fmt.Println(err)
      return
   }
   defer res.Body.Close()

   body, err := io.ReadAll(res.Body)
   if err != nil {
      fmt.Println(err)
      return
   }
   fmt.Println(string(body))
}

let parameters = "{ \"order_items\": [ { \"did_group_id\": 39145, \"did_skus\": [ \"BW-US-2074063052\", \"BW-US-2074063062\" ] } ]}"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "https://api.idtexpress.com/v1/dids/orders")!,timeoutInterval: Double.infinity)
request.addValue("****", forHTTPHeaderField: "x-api-key")
request.addValue("****", forHTTPHeaderField: "x-api-secret")
request.addValue("application/json; charset=utf-8", forHTTPHeaderField: "Content-Type")

request.httpMethod = "POST"
request.httpBody = postData

let task = URLSession.shared.dataTask(with: request) { data, response, error in 
   guard let data = data else {
      print(String(describing: error))
      return
   }
   print(String(data: data, encoding: .utf8)!)
}

task.resume()

OkHttpClient client = new OkHttpClient().newBuilder()
   .build();
MediaType mediaType = MediaType.parse("application/json; charset=utf-8");
RequestBody body = RequestBody.create(mediaType, "{ \"order_items\": [ { \"did_group_id\": 39145, \"did_skus\": [ \"BW-US-2074063052\", \"BW-US-2074063062\" ] } ]}");
Request request = new Request.Builder()
   .url("https://api.idtexpress.com/v1/dids/orders")
   .method("POST", body)
   .addHeader("x-api-key", "****")
   .addHeader("x-api-secret", "****")
   .addHeader("Content-Type", "application/json; charset=utf-8")
   .build();
Response response = client.newCall(request).execute();

var options = new RestClientOptions("https://api.idtexpress.com")
{
   MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("/v1/dids/orders", Method.Post);
request.AddHeader("x-api-key", "****");
request.AddHeader("x-api-secret", "****");
request.AddHeader("Content-Type", "application/json; charset=utf-8");
var body = @"{ ""order_items"": [ { ""did_group_id"": 39145, ""did_skus"": [ ""BW-US-2074063052"", ""BW-US-2074063062"" ] } ]}";
request.AddParameter("application/json; charset=utf-8", body,  ParameterType.RequestBody);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
   CURLOPT_URL => 'https://api.idtexpress.com/v1/dids/orders',
   CURLOPT_RETURNTRANSFER => true,
   CURLOPT_ENCODING => '',
   CURLOPT_MAXREDIRS => 10,
   CURLOPT_TIMEOUT => 0,
   CURLOPT_FOLLOWLOCATION => true,
   CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
   CURLOPT_CUSTOMREQUEST => 'POST',
   CURLOPT_POSTFIELDS =>'{ "order_items": [ { "did_group_id": 39145, "did_skus": [ "BW-US-2074063052", "BW-US-2074063062" ] } ]}',
   CURLOPT_HTTPHEADER => array(
      'x-api-key: ****',
      'x-api-secret: ****',
      'Content-Type: application/json; charset=utf-8'
   ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Creates an order for phone numbers. We support placing an order by DID Group ID and quantity, or by DID Group ID and number skus. You can get the DID Group ID from Get DID Groups, and number skus from Browse Available Numbers.

Order By Quantity

To create an order by quantity, add an order item with a value for did_group_id and quantity to the order items array.

For Example: { "order_items": [ { "did_group_id": 16847, "quantity": 3 } ]}

For non-US DID Groups: You can place an order with a quantity greater than the available quantity indicated in the DID Group. Requests exceeding the available stock will be backordered if possible. See Get DID Groups.

Order By Number SKUs

To create an order for specific DID numbers, add an order item with a value for did_group_id and an array of associated did_skus to the order items array.

For Example: { "order_items": [ { "did_group_id": 39145, "did_skus": [ "BW-US-2074063052", "BW-US-2074063062" ] } ]}

We currently only support 1 order item per order. Passing more than 1 order item will result in an error.

Numbers are not added to the account until the order starts processing.

Order Status

An order has a status field and it can be one of the following statuses:

• Preview - This status is only used when passing the preview flag as "true" into Create Order
• Created - We created your order and it is waiting to be processed
• Processing - We are processing your order
• Complete - The order is complete

Order Item Status

You can get more details on the status of an order by looking at an order item's status. Here is a list of possible order item statuses:

Order Item Status	Description	Cancelable
Preview	This status is only used when passing the preview flag as "true" into Create Order
Received	The order item has been received and is getting ready to be processed	No
Processing	We started processing the order item	No
Fulfilled - Complete	We successfully fulfilled the item	No
Partially Fulfilled – Complete	We were only able to partially fulfill your item	No
Backordered	The order item is on backorder	Yes
Backorder Canceled	The backorder was canceled	No
Partially Fulfilled – Backordered	We partially fulfilled your order item, and put the remaining quantity on backorder	Yes
Partially Fulfilled – Backorder Canceled	The backorder was canceled	No
Canceled – Insufficient Funds	There were not enough funds to complete this order item	No
Canceled – Insufficient Inventory	There were not enough DIDs in inventory to fulfill the order item	No
Partially Fulfilled – Insufficient Funds	We were only able to partially fulfill the item because your account ran out of funds	No

Use Get Order to check the status of the order.

The API currently does not support canceling an order item, but it will be added soon. In the meantime, canceling the item can be done in the IDT Express Portal.

Endpoint

POST /v1/dids/orders

Parameters

Name	In	Type	Required	Description
preview	json body	boolean	false	If the value is true then the call does not create an order, but it still goes through all validations such as checking if the account has sufficient funds to process the order. The default value is false
order_items	json body	[Object]	true	The request needs 1 order item to be successful
order_items[].did_group_id	json body	integer	true	The DID Group that you want to order. Use a DID Group ID from Get DID Groups
order_items[].quantity	json body	integer	true	The amount of numbers that you want to order. The maximum amount of numbers that can be ordered is 100. Note: your request must include either 'quantity' or 'did_skus' to be successful
order_items[].did_skus[]	json body	[string]	true	The specific number sku(s) you want to order. Use sku values returned from Browse Available Numbers. Note: your request must include either 'quantity' or 'did_skus' to be successful

Example responses

200 Response (order by quantity)

{
   "order":{
      "id":"f52-6d9-261b",
      "created_at":"2020-06-26T11:01:16.000Z",
      "status":"Created",
      "ordered": {
         "quantity": 3
      },
      "fulfilled": {
         "quantity": 0
      },
      "order_items":[
         {
            "id":162455,
            "status":"Processing",
            "order_item_type":"quantity",
            "ordered": {
               "quantity": 3
            },
            "fulfilled": {
               "quantity": 0
            },
            "cancelable":false,
            "did_group":{
               "id":16847,
               "name":"SALVADOR ",
               "country_calling_code":"55",
               "area_code":"71",
               "nxx":null,
               "toll_free":false,
               "country":{
                  "name":"BRAZIL",
                  "iso":"BR",
                  "has_regions":false
               },
               "fees":{
                  "setup_fee":"0.00",
                  "monthly_fee":"3.00"                  
               }
            },
            "numbers":[

            ]
         }
      ]
   },
   "meta":{

   }
}

200 Response (order by number sku)

{
   "order":{
      "id":"ba1-18f-0c9b",
      "created_at":"2021-08-19T20:43:43.000Z",
      "status":"Created",
      "ordered":{
         "quantity":2
      },
      "fulfilled":{
         "quantity":0
      },
      "order_items":[
         {
            "id":238750,
            "status":"Processing",
            "order_item_type":"number_skus",
            "ordered":{
               "quantity":2,
               "numbers":[
                  {
                     "number":"12074063052",
                     "sku":"BW-US-2074063052"
                  },
                  {
                     "number":"12074063062",
                     "sku":"BW-US-2074063062"
                  }
               ]
            },
            "fulfilled":{
               "quantity":0
            },
            "cancelable":false,
            "did_group":{
               "id":39145,
               "name":"Brunswick (207) 406",
               "country_calling_code":"1",
               "area_code":"207",
               "nxx":"406",
               "toll_free":false,
               "country":{
                  "name":"USA",
                  "iso":"US",
                  "has_regions":true
               },
               "region":{
                  "name":"Maine",
                  "code":"US-ME"
               },
               "fees":{
                  "setup_fee":"0.00",
                  "monthly_fee":"4.25"
               }
            },
            "numbers":[

            ]
         }
      ]
   },
   "meta":{

   }
}

Response Schema

Status Code 200

Get Order

Code samples

curl -v \
-H "x-api-key: ****" \
-H "x-api-secret: ****" \
"https://api.idtexpress.com/v1/dids/orders/9c2-2e2-4b6f"

require "uri"
require "net/http"

url = URI("https://api.idtexpress.com/v1/dids/orders/9c2-2e2-4b6f")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = "****"
request["x-api-secret"] = "****"

response = https.request(request)
puts response.read_body

import http.client

conn = http.client.HTTPSConnection("api.idtexpress.com")
payload = ''
headers = {
   'x-api-key': '****',
   'x-api-secret': '****'
}
conn.request("GET", "/v1/dids/orders/9c2-2e2-4b6f", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

var settings = {
   "url": "https://api.idtexpress.com/v1/dids/orders/9c2-2e2-4b6f",
   "method": "GET",
   "timeout": 0,
   "headers": {
      "x-api-key": "****",
      "x-api-secret": "****"
   },
};

$.ajax(settings).done(function (response) {
   console.log(response);
});

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
   'method': 'GET',
   'hostname': 'api.idtexpress.com',
   'path': '/v1/dids/orders/9c2-2e2-4b6f',
   'headers': {
      'x-api-key': '****',
      'x-api-secret': '****'
   },
   'maxRedirects': 20
};

var req = https.request(options, function (res) {
   var chunks = [];

   res.on("data", function (chunk) {
      chunks.push(chunk);
   });

   res.on("end", function (chunk) {
      var body = Buffer.concat(chunks);
      console.log(body.toString());
   });

   res.on("error", function (error) {
      console.error(error);
   });
});

req.end();

package main

import (
   "fmt"
   "net/http"
   "io"
)

func main() {

   url := "https://api.idtexpress.com/v1/dids/orders/9c2-2e2-4b6f"
   method := "GET"

   client := &http.Client {
   }
   req, err := http.NewRequest(method, url, nil)

   if err != nil {
      fmt.Println(err)
      return
   }
   req.Header.Add("x-api-key", "****")
   req.Header.Add("x-api-secret", "****")

   res, err := client.Do(req)
   if err != nil {
      fmt.Println(err)
      return
   }
   defer res.Body.Close()

   body, err := io.ReadAll(res.Body)
   if err != nil {
      fmt.Println(err)
      return
   }
   fmt.Println(string(body))
}

var request = URLRequest(url: URL(string: "https://api.idtexpress.com/v1/dids/orders/9c2-2e2-4b6f")!,timeoutInterval: Double.infinity)
request.addValue("****", forHTTPHeaderField: "x-api-key")
request.addValue("****", forHTTPHeaderField: "x-api-secret")

request.httpMethod = "GET"

let task = URLSession.shared.dataTask(with: request) { data, response, error in 
   guard let data = data else {
      print(String(describing: error))
      return
   }
   print(String(data: data, encoding: .utf8)!)
}

task.resume()

OkHttpClient client = new OkHttpClient().newBuilder()
   .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
   .url("https://api.idtexpress.com/v1/dids/orders/9c2-2e2-4b6f")
   .method("GET", body)
   .addHeader("x-api-key", "****")
   .addHeader("x-api-secret", "****")
   .build();
Response response = client.newCall(request).execute();

var options = new RestClientOptions("https://api.idtexpress.com")
{
   MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("/v1/dids/orders/9c2-2e2-4b6f", Method.Get);
request.AddHeader("x-api-key", "****");
request.AddHeader("x-api-secret", "****");
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
   CURLOPT_URL => 'https://api.idtexpress.com/v1/dids/orders/9c2-2e2-4b6f',
   CURLOPT_RETURNTRANSFER => true,
   CURLOPT_ENCODING => '',
   CURLOPT_MAXREDIRS => 10,
   CURLOPT_TIMEOUT => 0,
   CURLOPT_FOLLOWLOCATION => true,
   CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
   CURLOPT_CUSTOMREQUEST => 'GET',
   CURLOPT_HTTPHEADER => array(
      'x-api-key: ****',
      'x-api-secret: ****'
   ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Gets the details of an order, including any DIDs that were purchased.

Endpoint

GET /v1/dids/orders/{order_id}

Parameters

Name	In	Type	Required	Description
order_id	path	string	true	The id returned in Create Order

Example responses

200 Response (order by quantity)

{
   "order":{
      "id":"9c2-2e2-4b6f",
      "created_at":"2020-06-25T13:47:00.000Z",
      "status":"complete",
      "ordered": {
         "quantity": 1
      },
      "fulfilled": {
         "quantity": 1
      },
      "order_items":[
         {
            "id":162336,
            "status":"Fulfilled – Complete",
            "order_item_type":"quantity",
            "ordered": {
               "quantity": 1
            },
            "fulfilled": {
               "quantity": 1
            },
            "cancelable":false,
            "did_group":{
               "id":19500,
               "name":"PIOTRKOW TRYBUNALSKI",
               "country_calling_code":"48",
               "area_code":"44",
               "nxx":null,
               "toll_free":false,
               "country":{
                  "name":"POLAND",
                  "iso":"PL",
                  "has_regions":false
               },
               "fees":{
                  "setup_fee":"0.00",
                  "monthly_fee":"2.50"
               }
            },
            "numbers":[
               {
                  "number":"01148448881015"
               }
            ]
         }
      ]
   },
   "meta":{

   }
}

200 Response (order by number sku)

{
   "order":{
      "id":"9c2-2e2-4b6f",
      "created_at":"2021-08-19T20:43:43.000Z",
      "status":"Complete",
      "ordered":{
         "quantity":2
      },
      "fulfilled":{
         "quantity":2
      },
      "order_items":[
         {
            "id":238750,
            "status":"Fulfilled – Complete",
            "order_item_type":"number_skus",
            "ordered":{
               "quantity":2,
               "numbers":[
                  {
                     "number":"12074063052",
                     "sku":"BW-US-2074063052"
                  },
                  {
                     "number":"12074063062",
                     "sku":"BW-US-2074063062"
                  }
               ]
            },
            "fulfilled":{
               "quantity":2
            },
            "cancelable":false,
            "did_group":{
               "id":39145,
               "name":"Brunswick (207) 406",
               "country_calling_code":"1",
               "area_code":"207",
               "nxx":"406",
               "toll_free":false,
               "country":{
                  "name":"USA",
                  "iso":"US",
                  "has_regions":true
               },
               "region":{
                  "name":"Maine",
                  "code":"US-ME"
               },
               "fees":{
                  "setup_fee":"0.00",
                  "monthly_fee":"4.25"
               }
            },
            "numbers":[
               {
                  "number":"12074063052"
               },
               {
                  "number":"12074063062"
               }
            ]
         }
      ]
   },
   "meta":{

   }
}

Response Schema

Status Code 200

Get Orders

Code samples

curl -v \
-H "x-api-key: ****" \
-H "x-api-secret: ****" \
"https://api.idtexpress.com/v1/dids/orders?page=1&page_size=10&filter_by_status=Complete"

require "uri"
require "net/http"

url = URI("https://api.idtexpress.com/v1/dids/orders?page=1&page_size=10&filter_by_status=Complete")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = "****"
request["x-api-secret"] = "****"

response = https.request(request)
puts response.read_body

import http.client

conn = http.client.HTTPSConnection("api.idtexpress.com")
payload = ''
headers = {
   'x-api-key': '****',
   'x-api-secret': '****'
}
conn.request("GET", "/v1/dids/orders?page=1&page_size=10&filter_by_status=Complete", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

var settings = {
   "url": "https://api.idtexpress.com/v1/dids/orders?page=1&page_size=10&filter_by_status=Complete",
   "method": "GET",
   "timeout": 0,
   "headers": {
      "x-api-key": "****",
      "x-api-secret": "****"
   },
};

$.ajax(settings).done(function (response) {
   console.log(response);
});

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
   'method': 'GET',
   'hostname': 'api.idtexpress.com',
   'path': '/v1/dids/orders?page=1&page_size=10&filter_by_status=Complete',
   'headers': {
      'x-api-key': '****',
      'x-api-secret': '****'
   },
   'maxRedirects': 20
};

var req = https.request(options, function (res) {
   var chunks = [];

   res.on("data", function (chunk) {
      chunks.push(chunk);
   });

   res.on("end", function (chunk) {
      var body = Buffer.concat(chunks);
      console.log(body.toString());
   });

   res.on("error", function (error) {
      console.error(error);
   });
});

req.end();

package main

import (
   "fmt"
   "net/http"
   "io"
)

func main() {

   url := "https://api.idtexpress.com/v1/dids/orders?page=1&page_size=10&filter_by_status=Complete"
   method := "GET"

   client := &http.Client {
   }
   req, err := http.NewRequest(method, url, nil)

   if err != nil {
      fmt.Println(err)
      return
   }
   req.Header.Add("x-api-key", "****")
   req.Header.Add("x-api-secret", "****")

   res, err := client.Do(req)
   if err != nil {
      fmt.Println(err)
      return
   }
   defer res.Body.Close()

   body, err := io.ReadAll(res.Body)
   if err != nil {
      fmt.Println(err)
      return
   }
   fmt.Println(string(body))
}

var request = URLRequest(url: URL(string: "https://api.idtexpress.com/v1/dids/orders?page=1&page_size=10&filter_by_status=Complete")!,timeoutInterval: Double.infinity)
request.addValue("****", forHTTPHeaderField: "x-api-key")
request.addValue("****", forHTTPHeaderField: "x-api-secret")

request.httpMethod = "GET"

let task = URLSession.shared.dataTask(with: request) { data, response, error in 
   guard let data = data else {
      print(String(describing: error))
      return
   }
   print(String(data: data, encoding: .utf8)!)
}

task.resume()

OkHttpClient client = new OkHttpClient().newBuilder()
   .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
   .url("https://api.idtexpress.com/v1/dids/orders?page=1&page_size=10&filter_by_status=Complete")
   .method("GET", body)
   .addHeader("x-api-key", "****")
   .addHeader("x-api-secret", "****")
   .build();
Response response = client.newCall(request).execute();

var options = new RestClientOptions("https://api.idtexpress.com")
{
   MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("/v1/dids/orders?page=1&page_size=10&filter_by_status=Complete", Method.Get);
request.AddHeader("x-api-key", "****");
request.AddHeader("x-api-secret", "****");
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
   CURLOPT_URL => 'https://api.idtexpress.com/v1/dids/orders?page=1&page_size=10&filter_by_status=Complete',
   CURLOPT_RETURNTRANSFER => true,
   CURLOPT_ENCODING => '',
   CURLOPT_MAXREDIRS => 10,
   CURLOPT_TIMEOUT => 0,
   CURLOPT_FOLLOWLOCATION => true,
   CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
   CURLOPT_CUSTOMREQUEST => 'GET',
   CURLOPT_HTTPHEADER => array(
      'x-api-key: ****',
      'x-api-secret: ****'
   ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Returns a summary of all the orders on your account, or filtered by order status.

Endpoint

GET /v1/dids/orders?page={page}&page_size={page_size}

Parameters

Name	In	Type	Required	Description
page	query	integer	false	The current page. The default is page 1
page_size	query	integer	false	The current page size. The default is a page size of 100
filter_by_status	query	string	false	Filter orders by order status

List all DID Orders

Example responses

200 Response

{
    "orders": [
        {
            "id": "710-1be-a8d7",
            "created_at": "2020-07-05T22:58:23.000Z",
            "status": "Processing",
            "ordered": {
                "quantity": 2               
            },
            "fulfilled": {
                "quantity": 0
            }
        },
        {
            "id": "929-bcc-ed00",
            "created_at": "2020-07-05T22:48:31.000Z",
            "status": "Complete",
            "ordered": {
                "quantity": 17               
            },
            "fulfilled": {
                "quantity": 17
            }            
        },
        {
            "id": "018-7cb-5832",
            "created_at": "2020-07-05T10:29:51.000Z",
            "status": "Complete",
            "ordered": {
                "quantity": 2
            },
            "fulfilled": {
                "quantity": 0
            },
            "currency": "USD"
        }

    ],
    "meta": {
        "page": 1,
        "page_size": 100,
        "total": 3
    }
}

Response Schema

Status Code 200

My Numbers

Use these API endpoints to manage your account DID numbers.

Get Numbers

Code samples

curl -v \
-H "x-api-key: ****" \
-H "x-api-secret: ****" \
"https://api.idtexpress.com/v1/dids/numbers?page=1&page_size=10"

require "uri"
require "net/http"

url = URI("https://api.idtexpress.com/v1/dids/numbers?page=1&page_size=10")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = "****"
request["x-api-secret"] = "****"

response = https.request(request)
puts response.read_body

import http.client

conn = http.client.HTTPSConnection("api.idtexpress.com")
payload = ''
headers = {
   'x-api-key': '****',
   'x-api-secret': '****'
}
conn.request("GET", "/v1/dids/numbers?page=1&page_size=10", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

var settings = {
   "url": "https://api.idtexpress.com/v1/dids/numbers?page=1&page_size=10",
   "method": "GET",
   "timeout": 0,
   "headers": {
      "x-api-key": "****",
      "x-api-secret": "****"
   },
};

$.ajax(settings).done(function (response) {
   console.log(response);
});

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
   'method': 'GET',
   'hostname': 'api.idtexpress.com',
   'path': '/v1/dids/numbers?page=1&page_size=10',
   'headers': {
      'x-api-key': '****',
      'x-api-secret': '****'
   },
   'maxRedirects': 20
};

var req = https.request(options, function (res) {
   var chunks = [];

   res.on("data", function (chunk) {
      chunks.push(chunk);
   });

   res.on("end", function (chunk) {
      var body = Buffer.concat(chunks);
      console.log(body.toString());
   });

   res.on("error", function (error) {
      console.error(error);
   });
});

req.end();

package main

import (
   "fmt"
   "net/http"
   "io"
)

func main() {

   url := "https://api.idtexpress.com/v1/dids/numbers?page=1&page_size=10"
   method := "GET"

   client := &http.Client {
   }
   req, err := http.NewRequest(method, url, nil)

   if err != nil {
      fmt.Println(err)
      return
   }
   req.Header.Add("x-api-key", "****")
   req.Header.Add("x-api-secret", "****")

   res, err := client.Do(req)
   if err != nil {
      fmt.Println(err)
      return
   }
   defer res.Body.Close()

   body, err := io.ReadAll(res.Body)
   if err != nil {
      fmt.Println(err)
      return
   }
   fmt.Println(string(body))
}

var request = URLRequest(url: URL(string: "https://api.idtexpress.com/v1/dids/numbers?page=1&page_size=10")!,timeoutInterval: Double.infinity)
request.addValue("****", forHTTPHeaderField: "x-api-key")
request.addValue("****", forHTTPHeaderField: "x-api-secret")

request.httpMethod = "GET"

let task = URLSession.shared.dataTask(with: request) { data, response, error in 
   guard let data = data else {
      print(String(describing: error))
      return
   }
   print(String(data: data, encoding: .utf8)!)
}

task.resume()

OkHttpClient client = new OkHttpClient().newBuilder()
   .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
   .url("https://api.idtexpress.com/v1/dids/numbers?page=1&page_size=10")
   .method("GET", body)
   .addHeader("x-api-key", "****")
   .addHeader("x-api-secret", "****")
   .build();
Response response = client.newCall(request).execute();

var options = new RestClientOptions("https://api.idtexpress.com")
{
   MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("/v1/dids/numbers?page=1&page_size=10", Method.Get);
request.AddHeader("x-api-key", "****");
request.AddHeader("x-api-secret", "****");
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
   CURLOPT_URL => 'https://api.idtexpress.com/v1/dids/numbers?page=1&page_size=10',
   CURLOPT_RETURNTRANSFER => true,
   CURLOPT_ENCODING => '',
   CURLOPT_MAXREDIRS => 10,
   CURLOPT_TIMEOUT => 0,
   CURLOPT_FOLLOWLOCATION => true,
   CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
   CURLOPT_CUSTOMREQUEST => 'GET',
   CURLOPT_HTTPHEADER => array(
      'x-api-key: ****',
      'x-api-secret: ****'
   ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Returns all of the active and recently removed numbers on your account.

Endpoint

GET /v1/dids/numbers?page={page}&page_size={page_size}&{filters}&{sorts}

Parameters

Name	In	Type	Required	Description
page	query	integer	false	The current page. The default is page 1
page_size	query	integer	false	The current page size. The default is a page size of 100
filter_by_country_name	query	string	false	Filter response by Country name, or partial Country name
filter_by_region_name	query	string	false	Filter response by Region name, or partial Region name
filter_by_did_group_name	query	string	false	Filter response by DID Group name, or partial DID Group name
filter_by_number	query	string	false	Filter response by number, or partial number
order_by_country_name	query	string	false	Sort response by Country name, asc or desc
order_by_region_name	query	string	false	Sort response by Region name, asc or desc
order_by_did_group_name	query	string	false	Sort response by DID Group name, asc or desc
order_by_number	query	string	false	Sort response by number, asc or desc
order_by_added_at	query	string	false	Sort response by added_at date, asc or desc

Example responses

200 Response

{
   "numbers":[
      {
         "number":"0115117304800",
         "status":"active",
         "added_at":"2020-06-24T19:02:30.000Z",
         "trunk_group_id":268476,
         "did_group":{
            "name":"LIMA",
            "id":11895,
            "country_calling_code":"51",
            "area_code":"1",
            "nxx":null,
            "toll_free":false,
            "country":{
               "name":"PERU",
               "iso":"PE",
               "has_regions":false,
               "supports_toll_free":false
            },
            "fees":{
               "setup_fee":"0.00",
               "monthly_fee":"5.25",
               "per_minute_rate":"4.7354"
            }
         },
         "supports_cnam":false,
         "cnam":null
      },
      {
         "number":"011557135001442",
         "status":"active",
         "added_at":"2020-06-24T19:02:51.000Z",
         "trunk_group_id":268476,
         "did_group":{
            "name":"SALVADOR",
            "id":16847,
            "country_calling_code":"55",
            "area_code":"71",
            "nxx":null,
            "toll_free":false,
            "country":{
               "name":"BRAZIL",
               "iso":"BR",
               "has_regions":false,
               "supports_toll_free":true
            },
            "fees":{
               "setup_fee":"0.00",
               "monthly_fee":"3.00",
               "per_minute_rate":"4.7354"
            }
         },
         "supports_cnam":false,
         "cnam":null
      },
      {
         "number":"011557135001540",
         "status":"active",
         "added_at":"2020-06-26T07:01:28.000Z",
         "trunk_group_id":null,
         "did_group":{
            "name":"SALVADOR",
            "id":16847,
            "country_calling_code":"55",
            "area_code":"71",
            "nxx":null,
            "toll_free":false,
            "country":{
               "name":"BRAZIL",
               "iso":"BR",
               "has_regions":false,
               "supports_toll_free":true
            },
            "fees":{
               "setup_fee":"0.00",
               "monthly_fee":"3.00",
               "per_minute_rate":"4.7354"
            }
         },
         "supports_cnam":false,
         "cnam":null
      },
      {
         "number":"19288516549",
         "status":"active",
         "added_at":"2025-12-09T14:17:58.649Z",
         "trunk_group_id":null,
         "did_group":{
            "name":"Bouse (928) 851",
            "id":990994,
            "country_calling_code":"1",
            "area_code":"928",
            "area_name":null,
            "nxx":"851",
            "toll_free":false,
            "country":{
               "name":"USA",
               "iso":"US",
               "has_regions":true,
               "supports_toll_free":true
            },
            "region":{
               "name":"Arizona",
               "code":"US-AZ"
            },
            "fees":{
               "setup_fee":"0.00",
               "monthly_fee":"4.25",
               "per_minute_rate":"0.0200"
            }
         },
         "supports_cnam":true,
         "cnam":{
            "current":{
               "name":"My Caller ID",
               "type":"residential",
               "display":"allow"
            },
            "pending":{
               "action":"enable",
               "name":"New Caller ID",
               "type":"residential",
               "display":"allow"
            },
            "per_dip_fee":"0.0018",
            "update_fee":"0.1"
         }
      }
   ],
   "meta":{
      "page":1,
      "page_size":100,
      "total":4
   }
}

Response Schema

Status Code 200

Delete Number

Code samples

curl -v \
-X DELETE \
-H "x-api-key: ****" \
-H "x-api-secret: ****" \
"https://api.idtexpress.com/v1/dids/numbers/01133975182372"

require "uri"
require "net/http"

url = URI("https://api.idtexpress.com/v1/dids/numbers/01133975182372")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["x-api-key"] = "****"
request["x-api-secret"] = "****"

response = https.request(request)
puts response.read_body

import http.client

conn = http.client.HTTPSConnection("api.idtexpress.com")
payload = ''
headers = {
   'x-api-key': '****',
   'x-api-secret': '****'
}
conn.request("DELETE", "/v1/dids/numbers/01133975182372", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

var settings = {
   "url": "https://api.idtexpress.com/v1/dids/numbers/01133975182372",
   "method": "DELETE",
   "timeout": 0,
   "headers": {
      "x-api-key": "****",
      "x-api-secret": "****"
   },
};

$.ajax(settings).done(function (response) {
   console.log(response);
});

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
   'method': 'DELETE',
   'hostname': 'api.idtexpress.com',
   'path': '/v1/dids/numbers/01133975182372',
   'headers': {
      'x-api-key': '****',
      'x-api-secret': '****'
   },
   'maxRedirects': 20
};

var req = https.request(options, function (res) {
   var chunks = [];

   res.on("data", function (chunk) {
      chunks.push(chunk);
   });

   res.on("end", function (chunk) {
      var body = Buffer.concat(chunks);
      console.log(body.toString());
   });

   res.on("error", function (error) {
      console.error(error);
   });
});

req.end();

package main

import (
   "fmt"
   "net/http"
   "io"
)

func main() {

   url := "https://api.idtexpress.com/v1/dids/numbers/01133975182372"
   method := "DELETE"

   client := &http.Client {
   }
   req, err := http.NewRequest(method, url, nil)

   if err != nil {
      fmt.Println(err)
      return
   }
   req.Header.Add("x-api-key", "****")
   req.Header.Add("x-api-secret", "****")

   res, err := client.Do(req)
   if err != nil {
      fmt.Println(err)
      return
   }
   defer res.Body.Close()

   body, err := io.ReadAll(res.Body)
   if err != nil {
      fmt.Println(err)
      return
   }
   fmt.Println(string(body))
}

var request = URLRequest(url: URL(string: "https://api.idtexpress.com/v1/dids/numbers/01133975182372")!,timeoutInterval: Double.infinity)
request.addValue("****", forHTTPHeaderField: "x-api-key")
request.addValue("****", forHTTPHeaderField: "x-api-secret")

request.httpMethod = "DELETE"

let task = URLSession.shared.dataTask(with: request) { data, response, error in 
   guard let data = data else {
      print(String(describing: error))
      return
   }
   print(String(data: data, encoding: .utf8)!)
}

task.resume()

OkHttpClient client = new OkHttpClient().newBuilder()
   .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
   .url("https://api.idtexpress.com/v1/dids/numbers/01133975182372")
   .method("DELETE", body)
   .addHeader("x-api-key", "****")
   .addHeader("x-api-secret", "****")
   .build();
Response response = client.newCall(request).execute();

var options = new RestClientOptions("https://api.idtexpress.com")
{
   MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("/v1/dids/numbers/01133975182372", Method.Delete);
request.AddHeader("x-api-key", "****");
request.AddHeader("x-api-secret", "****");
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
   CURLOPT_URL => 'https://api.idtexpress.com/v1/dids/numbers/01133975182372',
   CURLOPT_RETURNTRANSFER => true,
   CURLOPT_ENCODING => '',
   CURLOPT_MAXREDIRS => 10,
   CURLOPT_TIMEOUT => 0,
   CURLOPT_FOLLOWLOCATION => true,
   CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
   CURLOPT_CUSTOMREQUEST => 'DELETE',
   CURLOPT_HTTPHEADER => array(
      'x-api-key: ****',
      'x-api-secret: ****'
   ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Removes a number from your account.

Endpoint

DELETE /v1/dids/numbers/{number}

Parameters

Name	In	Type	Required	Description
number	path	string	true	A number returned from Get Numbers

Example responses

200 Response

{
  "number":"01133975182372",
  "status":"removed"
}

Response Schema

Status Code 200

Set CNAM

Code samples

curl -v \
-X POST "https://api.idtexpress.com/v1/dids/numbers/17078675309/cnam" \
-H "x-api-key: ****" \
-H "x-api-secret: ****" \
-H 'Content-Type: application/json; charset=utf-8' \
-d '{ "name":"Jenny", "type":"residential", "display":"allow" }'

require "uri"
require "net/http"

url = URI("https://api.idtexpress.com/v1/dids/numbers/17078675309/cnam")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = "****"
request["x-api-secret"] = "****"
request["Content-Type"] = "application/json; charset=utf-8"
request.body = "{ \"name\":\"Jenny\", \"type\":\"residential\", \"display\":\"allow\" }"

response = https.request(request)
puts response.read_body

import http.client

conn = http.client.HTTPSConnection("api.idtexpress.com")
payload = "{ \"name\":\"Jenny\", \"type\":\"residential\", \"display\":\"allow\" }"
headers = {
   'x-api-key': '****',
   'x-api-secret': '****',
   'Content-Type': 'application/json; charset=utf-8'
}
conn.request("POST", "/v1/dids/numbers/17078675309/cnam", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

var settings = {
   "url": "https://api.idtexpress.com/v1/dids/numbers/17078675309/cnam",
   "method": "POST",
   "timeout": 0,
   "headers": {
      "x-api-key": "****",
      "x-api-secret": "****",
      "Content-Type": "application/json; charset=utf-8"
   },
   "data": "{ \"name\":\"Jenny\", \"type\":\"residential\", \"display\":\"allow\" }",
};

$.ajax(settings).done(function (response) {
   console.log(response);
});

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
   'method': 'POST',
   'hostname': 'api.idtexpress.com',
   'path': '/v1/dids/numbers/17078675309/cnam',
   'headers': {
      'x-api-key': '****',
      'x-api-secret': '****',
      'Content-Type': 'application/json; charset=utf-8'
   },
   'maxRedirects': 20
};

var req = https.request(options, function (res) {
   var chunks = [];

   res.on("data", function (chunk) {
      chunks.push(chunk);
   });

   res.on("end", function (chunk) {
      var body = Buffer.concat(chunks);
      console.log(body.toString());
   });

   res.on("error", function (error) {
      console.error(error);
   });
});

var postData =  "{ \"name\":\"Jenny\", \"type\":\"residential\", \"display\":\"allow\" }";

req.write(postData);

req.end();

package main

import (
   "fmt"
   "strings"
   "net/http"
   "io"
)

func main() {

   url := "https://api.idtexpress.com/v1/dids/numbers/17078675309/cnam"
   method := "POST"

   payload := strings.NewReader(`{ "name":"Jenny", "type":"residential", "display":"allow" }`)

   client := &http.Client {
   }
   req, err := http.NewRequest(method, url, payload)

   if err != nil {
      fmt.Println(err)
      return
   }
   req.Header.Add("x-api-key", "****")
   req.Header.Add("x-api-secret", "****")
   req.Header.Add("Content-Type", "application/json; charset=utf-8")

   res, err := client.Do(req)
   if err != nil {
      fmt.Println(err)
      return
   }
   defer res.Body.Close()

   body, err := io.ReadAll(res.Body)
   if err != nil {
      fmt.Println(err)
      return
   }
   fmt.Println(string(body))
}

let parameters = "{ \"name\":\"Jenny\", \"type\":\"residential\", \"display\":\"allow\" }"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "https://api.idtexpress.com/v1/dids/numbers/17078675309/cnam")!,timeoutInterval: Double.infinity)
request.addValue("****", forHTTPHeaderField: "x-api-key")
request.addValue("****", forHTTPHeaderField: "x-api-secret")
request.addValue("application/json; charset=utf-8", forHTTPHeaderField: "Content-Type")

request.httpMethod = "POST"
request.httpBody = postData

let task = URLSession.shared.dataTask(with: request) { data, response, error in 
   guard let data = data else {
      print(String(describing: error))
      return
   }
   print(String(data: data, encoding: .utf8)!)
}

task.resume()

OkHttpClient client = new OkHttpClient().newBuilder()
   .build();
MediaType mediaType = MediaType.parse("application/json; charset=utf-8");
RequestBody body = RequestBody.create(mediaType, "{ \"name\":\"Jenny\", \"type\":\"residential\", \"display\":\"allow\" }");
Request request = new Request.Builder()
   .url("https://api.idtexpress.com/v1/dids/numbers/17078675309/cnam")
   .method("POST", body)
   .addHeader("x-api-key", "****")
   .addHeader("x-api-secret", "****")
   .addHeader("Content-Type", "application/json; charset=utf-8")
   .build();
Response response = client.newCall(request).execute();

var options = new RestClientOptions("https://api.idtexpress.com")
{
   MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("/v1/dids/numbers/17078675309/cnam", Method.Post);
request.AddHeader("x-api-key", "****");
request.AddHeader("x-api-secret", "****");
request.AddHeader("Content-Type", "application/json; charset=utf-8");
var body = @"{ ""name"":""Jenny"", ""type"":""residential"", ""display"":""allow"" }";
request.AddParameter("application/json; charset=utf-8", body,  ParameterType.RequestBody);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
   CURLOPT_URL => 'https://api.idtexpress.com/v1/dids/numbers/17078675309/cnam',
   CURLOPT_RETURNTRANSFER => true,
   CURLOPT_ENCODING => '',
   CURLOPT_MAXREDIRS => 10,
   CURLOPT_TIMEOUT => 0,
   CURLOPT_FOLLOWLOCATION => true,
   CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
   CURLOPT_CUSTOMREQUEST => 'POST',
   CURLOPT_POSTFIELDS =>'{ "name":"Jenny", "type":"residential", "display":"allow" }',
   CURLOPT_HTTPHEADER => array(
      'x-api-key: ****',
      'x-api-secret: ****',
      'Content-Type: application/json; charset=utf-8'
   ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Creates a request to update the CNAM settings (Caller ID) for the given number on your account. Your account administrator(s) will be notified by email for all CNAM requests, fulfillments, and/or processing errors.

Note: only numbers where the supports_cnam value is true can be used with this endpoint (See Get Numbers).

• It may take up to 24 hours for a Set CNAM request to complete.
• CNAM settings cannot be modified while a request is still pending for the given number. Before creating another request, you must wait until the CNAM pending value (returned from Get Numbers) is null.

Endpoint

POST /v1/dids/numbers/{number}/cnam

Parameters

Name	In	Type	Required	Description
number	path	string	true	Any active DID number returned from Get Numbers where the supports_cnam value is true.
name	json body	string	true	The name (Caller ID) you want displayed to called parties. Maximum 15 characters and can include special characters.
type	json body	string	false	business (default) or residential, indicating the typical usage of this number.
display	json body	string	false	allow (default) or block, indicating that you are allowing the caller information to be displayed to called parties or not.

Example responses

204 Response

No Content

Response Schema

Status Code 204

Delete CNAM

Code samples

curl -v \
-X DELETE "https://api.idtexpress.com/v1/dids/numbers/17078675309/cnam" \
-H "x-api-key: ****" \
-H "x-api-secret: ****" \

require "uri"
require "net/http"

url = URI("https://api.idtexpress.com/v1/dids/numbers/17078675309/cnam")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["x-api-key"] = "****"
request["x-api-secret"] = "****"

response = https.request(request)
puts response.read_body

import http.client

conn = http.client.HTTPSConnection("api.idtexpress.com")
payload = ''
headers = {
   'x-api-key': '****',
   'x-api-secret': '****'
}
conn.request("DELETE", "/v1/dids/numbers/17078675309/cnam", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

var settings = {
   "url": "https://api.idtexpress.com/v1/dids/numbers/17078675309/cnam",
   "method": "DELETE",
   "timeout": 0,
   "headers": {
      "x-api-key": "****",
      "x-api-secret": "****"
   },
};

$.ajax(settings).done(function (response) {
   console.log(response);
});

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
   'method': 'DELETE',
   'hostname': 'api.idtexpress.com',
   'path': '/v1/dids/numbers/17078675309/cnam',
   'headers': {
      'x-api-key': '****',
      'x-api-secret': '****'
   },
   'maxRedirects': 20
};

var req = https.request(options, function (res) {
   var chunks = [];

   res.on("data", function (chunk) {
      chunks.push(chunk);
   });

   res.on("end", function (chunk) {
      var body = Buffer.concat(chunks);
      console.log(body.toString());
   });

   res.on("error", function (error) {
      console.error(error);
   });
});

req.end();

package main

import (
   "fmt"
   "net/http"
   "io"
)

func main() {

   url := "https://api.idtexpress.com/v1/dids/numbers/17078675309/cnam"
   method := "DELETE"

   client := &http.Client {
   }
   req, err := http.NewRequest(method, url, nil)

   if err != nil {
      fmt.Println(err)
      return
   }
   req.Header.Add("x-api-key", "****")
   req.Header.Add("x-api-secret", "****")

   res, err := client.Do(req)
   if err != nil {
      fmt.Println(err)
      return
   }
   defer res.Body.Close()

   body, err := io.ReadAll(res.Body)
   if err != nil {
      fmt.Println(err)
      return
   }
   fmt.Println(string(body))
}

var request = URLRequest(url: URL(string: "https://api.idtexpress.com/v1/dids/numbers/17078675309/cnam")!,timeoutInterval: Double.infinity)
request.addValue("****", forHTTPHeaderField: "x-api-key")
request.addValue("****", forHTTPHeaderField: "x-api-secret")

request.httpMethod = "DELETE"

let task = URLSession.shared.dataTask(with: request) { data, response, error in 
   guard let data = data else {
      print(String(describing: error))
      return
   }
   print(String(data: data, encoding: .utf8)!)
}

task.resume()

OkHttpClient client = new OkHttpClient().newBuilder()
   .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
   .url("https://api.idtexpress.com/v1/dids/numbers/17078675309/cnam")
   .method("DELETE", body)
   .addHeader("x-api-key", "****")
   .addHeader("x-api-secret", "****")
   .build();
Response response = client.newCall(request).execute();

var options = new RestClientOptions("https://api.idtexpress.com")
{
   MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("/v1/dids/numbers/17078675309/cnam", Method.Delete);
request.AddHeader("x-api-key", "****");
request.AddHeader("x-api-secret", "****");
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
   CURLOPT_URL => 'https://api.idtexpress.com/v1/dids/numbers/17078675309/cnam',
   CURLOPT_RETURNTRANSFER => true,
   CURLOPT_ENCODING => '',
   CURLOPT_MAXREDIRS => 10,
   CURLOPT_TIMEOUT => 0,
   CURLOPT_FOLLOWLOCATION => true,
   CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
   CURLOPT_CUSTOMREQUEST => 'DELETE',
   CURLOPT_HTTPHEADER => array(
      'x-api-key: ****',
      'x-api-secret: ****'
   ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Creates a request to remove CNAM settings from the given number on your account. Your account administrator(s) will be notified by email for all CNAM requests, fulfillments, and/or processing errors.

Note: only numbers where the supports_cnam value is true can be used with this endpoint (See Get Numbers).

• It may take up to 24 hours for a Delete CNAM request to complete.
• CNAM settings cannot be removed while a request is still pending for the given number. Before creating another request, you must wait until the CNAM pending value (returned from Get Numbers) is null.
• It is not necessary to call Delete CNAM for numbers that you remove from your account. The CNAM setting will be automatically removed when your number is deleted.

Endpoint

DELETE /v1/dids/numbers/{number}/cnam

Parameters

Name	In	Type	Required	Description
number	path	string	true	Any active DID number returned from Get Numbers that has CNAM settings (the CNAM current value is not null).

Example responses

204 Response

No Content

Response Schema

Status Code 204

Manage Trunk Groups

Use these API endpoints to manage the DID Trunk Groups in your account.

Create Trunk Group

Code samples

curl -v \
-X POST "https://api.idtexpress.com/v1/dids/trunk_groups" \
-H "x-api-key: ****" \
-H "x-api-secret: ****" \
-H 'Content-Type: application/json; charset=utf-8' \
-d '{ "name":"Trunk Group #1", "ring_type":"simultaneous", "pop":"US", "is_default":true, "switches": [ { "ip":"10.232.12.255", "port":5060 }, { "ip":"10.242.34.56", "port":6000 } ]}'

require "uri"
require "net/http"

url = URI("https://api.idtexpress.com/v1/dids/trunk_groups")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = "****"
request["x-api-secret"] = "****"
request["Content-Type"] = "application/json; charset=utf-8"
request.body = "{ \"name\":\"Trunk Group \\#1\", \"ring_type\":\"simultaneous\", \"pop\":\"US\", \"is_default\":true, \"switches\": [ { \"ip\":\"10.232.12.255\", \"port\":5060 }, { \"ip\":\"10.242.34.56\", \"port\":6000 } ]}"

response = https.request(request)
puts response.read_body

import http.client

conn = http.client.HTTPSConnection("api.idtexpress.com")
payload = "{ \"name\":\"Trunk Group #1\", \"ring_type\":\"simultaneous\", \"pop\":\"US\", \"is_default\":true, \"switches\": [ { \"ip\":\"10.232.12.255\", \"port\":5060 }, { \"ip\":\"10.242.34.56\", \"port\":6000 } ]}"
headers = {
   'x-api-key': '****',
   'x-api-secret': '****',
   'Content-Type': 'application/json; charset=utf-8'
}
conn.request("POST", "/v1/dids/trunk_groups", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

var settings = {
   "url": "https://api.idtexpress.com/v1/dids/trunk_groups",
   "method": "POST",
   "timeout": 0,
   "headers": {
      "x-api-key": "****",
      "x-api-secret": "****",
      "Content-Type": "application/json; charset=utf-8"
   },
   "data": "{ \"name\":\"Trunk Group #1\", \"ring_type\":\"simultaneous\", \"pop\":\"US\", \"is_default\":true, \"switches\": [ { \"ip\":\"10.232.12.255\", \"port\":5060 }, { \"ip\":\"10.242.34.56\", \"port\":6000 } ]}",
};

$.ajax(settings).done(function (response) {
   console.log(response);
});

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
   'method': 'POST',
   'hostname': 'api.idtexpress.com',
   'path': '/v1/dids/trunk_groups',
   'headers': {
      'x-api-key': '****',
      'x-api-secret': '****',
      'Content-Type': 'application/json; charset=utf-8'
   },
   'maxRedirects': 20
};

var req = https.request(options, function (res) {
   var chunks = [];

   res.on("data", function (chunk) {
      chunks.push(chunk);
   });

   res.on("end", function (chunk) {
      var body = Buffer.concat(chunks);
      console.log(body.toString());
   });

   res.on("error", function (error) {
      console.error(error);
   });
});

var postData =  "{ \"name\":\"Trunk Group #1\", \"ring_type\":\"simultaneous\", \"pop\":\"US\", \"is_default\":true, \"switches\": [ { \"ip\":\"10.232.12.255\", \"port\":5060 }, { \"ip\":\"10.242.34.56\", \"port\":6000 } ]}";

req.write(postData);

req.end();

package main

import (
   "fmt"
   "strings"
   "net/http"
   "io"
)

func main() {

   url := "https://api.idtexpress.com/v1/dids/trunk_groups"
   method := "POST"

   payload := strings.NewReader(`{ "name":"Trunk Group #1", "ring_type":"simultaneous", "pop":"US", "is_default":true, "switches": [ { "ip":"10.232.12.255", "port":5060 }, { "ip":"10.242.34.56", "port":6000 } ]}`)

   client := &http.Client {
   }
   req, err := http.NewRequest(method, url, payload)

   if err != nil {
      fmt.Println(err)
      return
   }
   req.Header.Add("x-api-key", "****")
   req.Header.Add("x-api-secret", "****")
   req.Header.Add("Content-Type", "application/json; charset=utf-8")

   res, err := client.Do(req)
   if err != nil {
      fmt.Println(err)
      return
   }
   defer res.Body.Close()

   body, err := io.ReadAll(res.Body)
   if err != nil {
      fmt.Println(err)
      return
   }
   fmt.Println(string(body))
}

let parameters = "{ \"name\":\"Trunk Group #1\", \"ring_type\":\"simultaneous\", \"pop\":\"US\", \"is_default\":true, \"switches\": [ { \"ip\":\"10.232.12.255\", \"port\":5060 }, { \"ip\":\"10.242.34.56\", \"port\":6000 } ]}"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "https://api.idtexpress.com/v1/dids/trunk_groups")!,timeoutInterval: Double.infinity)
request.addValue("****", forHTTPHeaderField: "x-api-key")
request.addValue("****", forHTTPHeaderField: "x-api-secret")
request.addValue("application/json; charset=utf-8", forHTTPHeaderField: "Content-Type")

request.httpMethod = "POST"
request.httpBody = postData

let task = URLSession.shared.dataTask(with: request) { data, response, error in 
   guard let data = data else {
      print(String(describing: error))
      return
   }
   print(String(data: data, encoding: .utf8)!)
}

task.resume()

OkHttpClient client = new OkHttpClient().newBuilder()
   .build();
MediaType mediaType = MediaType.parse("application/json; charset=utf-8");
RequestBody body = RequestBody.create(mediaType, "{ \"name\":\"Trunk Group #1\", \"ring_type\":\"simultaneous\", \"pop\":\"US\", \"is_default\":true, \"switches\": [ { \"ip\":\"10.232.12.255\", \"port\":5060 }, { \"ip\":\"10.242.34.56\", \"port\":6000 } ]}");
Request request = new Request.Builder()
   .url("https://api.idtexpress.com/v1/dids/trunk_groups")
   .method("POST", body)
   .addHeader("x-api-key", "****")
   .addHeader("x-api-secret", "****")
   .addHeader("Content-Type", "application/json; charset=utf-8")
   .build();
Response response = client.newCall(request).execute();

var options = new RestClientOptions("https://api.idtexpress.com")
{
   MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("/v1/dids/trunk_groups", Method.Post);
request.AddHeader("x-api-key", "****");
request.AddHeader("x-api-secret", "****");
request.AddHeader("Content-Type", "application/json; charset=utf-8");
var body = @"{ ""name"":""Trunk Group #1"", ""ring_type"":""simultaneous"", ""pop"":""US"", ""is_default"":true, ""switches"": [ { ""ip"":""10.232.12.255"", ""port"":5060 }, { ""ip"":""10.242.34.56"", ""port"":6000 } ]}";
request.AddParameter("application/json; charset=utf-8", body,  ParameterType.RequestBody);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
   CURLOPT_URL => 'https://api.idtexpress.com/v1/dids/trunk_groups',
   CURLOPT_RETURNTRANSFER => true,
   CURLOPT_ENCODING => '',
   CURLOPT_MAXREDIRS => 10,
   CURLOPT_TIMEOUT => 0,
   CURLOPT_FOLLOWLOCATION => true,
   CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
   CURLOPT_CUSTOMREQUEST => 'POST',
   CURLOPT_POSTFIELDS =>'{ "name":"Trunk Group #1", "ring_type":"simultaneous", "pop":"US", "is_default":true, "switches": [ { "ip":"10.232.12.255", "port":5060 }, { "ip":"10.242.34.56", "port":6000 } ]}',
   CURLOPT_HTTPHEADER => array(
      'x-api-key: ****',
      'x-api-secret: ****',
      'Content-Type: application/json; charset=utf-8'
   ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Creates a new DID Trunk Group on your account. To receive DID traffic, you must have at least one Trunk Group configured, but you can add as many Trunk Groups as needed. All active numbers on your account will be assigned to a Trunk Group.

Default Trunk Group

The default Trunk Group is used for routing DIDs when no specific Trunk Group has been set for a DID number (see Set Trunk Group). It is also used as a fallback if we are unable to determine the proper route for a DID.

• All accounts must have one default Trunk Group configured.
• The default Trunk Group cannot be deleted.
• All new DIDs are assigned to the default Trunk Group. They can be moved to another Trunk Group at any time using Set Trunk Group.
• When deleting a Trunk Group, all DIDs assigned will be automatically moved to your default Trunk Group. See Delete Trunk Group.

Ring Type

We support two types of call routing methods for your Trunk Groups: simultaneous and sequential.

• simultaneous sends a call to all Switch IPs in the switches array. The first one that answers is selected.
• sequential starts with the first IP in the switches array and rolls to the next IP in the list if the other is unreachable.

Point of Presence (PoP)

We support three Point of Presence (PoP) locations US, UK and HK, to receive your call media. To ensure the best quality, we recommend selecting the PoP that is geographically closest to your switch.

Inbound Traffic Configuration

Set up your switch as follows to start receiving inbound traffic to your DIDs:

• If using the US PoP, allow traffic from 169.132.196.47 or 206.20.196.38
• If using the HK PoP, allow traffic from 111.235.152.142
• If using the UK PoP, allow traffic from 213.166.103.22

We support the following CODECS: G.711A, G711U, G.729A, G729AB, G.723. We also support T38 for faxing but cannot offer any guarantees.

Endpoint

POST /v1/dids/trunk_groups

Parameters

Name	In	Type	Required	Description
name	json body	string	true	Then name of the new Trunk Group. Maximum 50 characters, must be unique.
ring_type	json body	string	false	simultaneous (default), or sequential
pop	json body	string	false	US (default), UK or HK
is_default	json body	boolean	false	false (default), or true
switches	json body	[Array]	false	Array of switches. If ring_type is sequential, switches are chosen in array order.
switches[].ip	json body	string	true	IPv4 address of your switch (ex. ‘120.34.1.253’). Note: CIDR block notation is not supported.
switches[].port	json body	integer	false	Port of your switch (5060 default). Range 1024-65535

Example responses

200 Response

{
  "trunk_group": {
    "id": 268476,
    "name": "Trunk Group #1",
    "ring_type": "simultaneous",
    "pop": "US",
    "is_default": true,
    "switches": [
      {
        "ip": "10.232.12.255",
        "port": 5060
      },
      {
        "ip": "10.242.34.56",
        "port": 6000
      }
    ]
  },
  "meta": {}
}

Response Schema

Status Code 200

Get Trunk Group

Code samples

curl -v \
-H "x-api-key: ****" \
-H "x-api-secret: ****" \
"https://api.idtexpress.com/v1/dids/trunk_groups/268476"

require "uri"
require "net/http"

url = URI("https://api.idtexpress.com/v1/dids/trunk_groups/268476")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = "****"
request["x-api-secret"] = "****"

response = https.request(request)
puts response.read_body

import http.client

conn = http.client.HTTPSConnection("api.idtexpress.com")
payload = ''
headers = {
   'x-api-key': '****',
   'x-api-secret': '****'
}
conn.request("GET", "/v1/dids/trunk_groups/268476", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

var settings = {
   "url": "https://api.idtexpress.com/v1/dids/trunk_groups/268476",
   "method": "GET",
   "timeout": 0,
   "headers": {
      "x-api-key": "****",
      "x-api-secret": "****"
   },
};

$.ajax(settings).done(function (response) {
   console.log(response);
});

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
   'method': 'GET',
   'hostname': 'api.idtexpress.com',
   'path': '/v1/dids/trunk_groups/268476',
   'headers': {
      'x-api-key': '****',
      'x-api-secret': '****'
   },
   'maxRedirects': 20
};

var req = https.request(options, function (res) {
   var chunks = [];

   res.on("data", function (chunk) {
      chunks.push(chunk);
   });

   res.on("end", function (chunk) {
      var body = Buffer.concat(chunks);
      console.log(body.toString());
   });

   res.on("error", function (error) {
      console.error(error);
   });
});

req.end();

package main

import (
   "fmt"
   "net/http"
   "io"
)

func main() {

   url := "https://api.idtexpress.com/v1/dids/trunk_groups/268476"
   method := "GET"

   client := &http.Client {
   }
   req, err := http.NewRequest(method, url, nil)

   if err != nil {
      fmt.Println(err)
      return
   }
   req.Header.Add("x-api-key", "****")
   req.Header.Add("x-api-secret", "****")

   res, err := client.Do(req)
   if err != nil {
      fmt.Println(err)
      return
   }
   defer res.Body.Close()

   body, err := io.ReadAll(res.Body)
   if err != nil {
      fmt.Println(err)
      return
   }
   fmt.Println(string(body))
}

var request = URLRequest(url: URL(string: "https://api.idtexpress.com/v1/dids/trunk_groups/268476")!,timeoutInterval: Double.infinity)
request.addValue("****", forHTTPHeaderField: "x-api-key")
request.addValue("****", forHTTPHeaderField: "x-api-secret")

request.httpMethod = "GET"

let task = URLSession.shared.dataTask(with: request) { data, response, error in 
   guard let data = data else {
      print(String(describing: error))
      return
   }
   print(String(data: data, encoding: .utf8)!)
}

task.resume()

OkHttpClient client = new OkHttpClient().newBuilder()
   .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
   .url("https://api.idtexpress.com/v1/dids/trunk_groups/268476")
   .method("GET", body)
   .addHeader("x-api-key", "****")
   .addHeader("x-api-secret", "****")
   .build();
Response response = client.newCall(request).execute();

var options = new RestClientOptions("https://api.idtexpress.com")
{
   MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("/v1/dids/trunk_groups/268476", Method.Get);
request.AddHeader("x-api-key", "****");
request.AddHeader("x-api-secret", "****");
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
   CURLOPT_URL => 'https://api.idtexpress.com/v1/dids/trunk_groups/268476',
   CURLOPT_RETURNTRANSFER => true,
   CURLOPT_ENCODING => '',
   CURLOPT_MAXREDIRS => 10,
   CURLOPT_TIMEOUT => 0,
   CURLOPT_FOLLOWLOCATION => true,
   CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
   CURLOPT_CUSTOMREQUEST => 'GET',
   CURLOPT_HTTPHEADER => array(
      'x-api-key: ****',
      'x-api-secret: ****'
   ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Returns the details of a specific DID Trunk Group on your account.

Endpoint

GET /v1/dids/trunk_groups/{trunk_group_id}

Parameters

Name	In	Type	Required	Description
trunk_group_id	path	string	true	The id of the Trunk Group you are interested in. This is the value returned in Create Trunk Group

Example responses

200 Response

{
  "trunk_group": {
    "id": 268476,
    "name": "Trunk Group #1",
    "ring_type": "simultaneous",
    "pop": "US",
    "is_default": true,
    "switches": [
      {
        "ip": "10.232.12.255",
        "port": 5060
      },
      {
        "ip": "10.242.34.56",
        "port": 6000
      }
    ]
  },
  "meta": {}
}

Response Schema

Status Code 200

Get Trunk Groups

Code samples

curl -v \
-H "x-api-key: ****" \
-H "x-api-secret: ****" \
"https://api.idtexpress.com/v1/dids/trunk_groups?page=1&page_size=10"

require "uri"
require "net/http"

url = URI("https://api.idtexpress.com/v1/dids/trunk_groups?page=1&page_size=10")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = "****"
request["x-api-secret"] = "****"

response = https.request(request)
puts response.read_body

import http.client

conn = http.client.HTTPSConnection("api.idtexpress.com")
payload = ''
headers = {
   'x-api-key': '****',
   'x-api-secret': '****'
}
conn.request("GET", "/v1/dids/trunk_groups?page=1&page_size=10", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

var settings = {
   "url": "https://api.idtexpress.com/v1/dids/trunk_groups?page=1&page_size=10",
   "method": "GET",
   "timeout": 0,
   "headers": {
      "x-api-key": "****",
      "x-api-secret": "****"
   },
};

$.ajax(settings).done(function (response) {
   console.log(response);
});

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
   'method': 'GET',
   'hostname': 'api.idtexpress.com',
   'path': '/v1/dids/trunk_groups?page=1&page_size=10',
   'headers': {
      'x-api-key': '****',
      'x-api-secret': '****'
   },
   'maxRedirects': 20
};

var req = https.request(options, function (res) {
   var chunks = [];

   res.on("data", function (chunk) {
      chunks.push(chunk);
   });

   res.on("end", function (chunk) {
      var body = Buffer.concat(chunks);
      console.log(body.toString());
   });

   res.on("error", function (error) {
      console.error(error);
   });
});

req.end();

package main

import (
   "fmt"
   "net/http"
   "io"
)

func main() {

   url := "https://api.idtexpress.com/v1/dids/trunk_groups?page=1&page_size=10"
   method := "GET"

   client := &http.Client {
   }
   req, err := http.NewRequest(method, url, nil)

   if err != nil {
      fmt.Println(err)
      return
   }
   req.Header.Add("x-api-key", "****")
   req.Header.Add("x-api-secret", "****")

   res, err := client.Do(req)
   if err != nil {
      fmt.Println(err)
      return
   }
   defer res.Body.Close()

   body, err := io.ReadAll(res.Body)
   if err != nil {
      fmt.Println(err)
      return
   }
   fmt.Println(string(body))
}

var request = URLRequest(url: URL(string: "https://api.idtexpress.com/v1/dids/trunk_groups?page=1&page_size=10")!,timeoutInterval: Double.infinity)
request.addValue("****", forHTTPHeaderField: "x-api-key")
request.addValue("****", forHTTPHeaderField: "x-api-secret")

request.httpMethod = "GET"

let task = URLSession.shared.dataTask(with: request) { data, response, error in 
   guard let data = data else {
      print(String(describing: error))
      return
   }
   print(String(data: data, encoding: .utf8)!)
}

task.resume()

OkHttpClient client = new OkHttpClient().newBuilder()
   .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
   .url("https://api.idtexpress.com/v1/dids/trunk_groups?page=1&page_size=10")
   .method("GET", body)
   .addHeader("x-api-key", "****")
   .addHeader("x-api-secret", "****")
   .build();
Response response = client.newCall(request).execute();

var options = new RestClientOptions("https://api.idtexpress.com")
{
   MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("/v1/dids/trunk_groups?page=1&page_size=10", Method.Get);
request.AddHeader("x-api-key", "****");
request.AddHeader("x-api-secret", "****");
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
   CURLOPT_URL => 'https://api.idtexpress.com/v1/dids/trunk_groups?page=1&page_size=10',
   CURLOPT_RETURNTRANSFER => true,
   CURLOPT_ENCODING => '',
   CURLOPT_MAXREDIRS => 10,
   CURLOPT_TIMEOUT => 0,
   CURLOPT_FOLLOWLOCATION => true,
   CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
   CURLOPT_CUSTOMREQUEST => 'GET',
   CURLOPT_HTTPHEADER => array(
      'x-api-key: ****',
      'x-api-secret: ****'
   ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Returns all of the DID Trunk Groups on your account.

Endpoint

GET /v1/dids/trunk_groups?page={page}&page_size={page_size}

Parameters

Name	In	Type	Required	Description
page	query	integer	false	The current page. The default is page 1
page_size	query	integer	false	The current page size. The default is a page size of 100

Example responses

200 Response

{
  "trunk_groups": [
    {
      "id": 10897,
      "name": "Trunk Group #1",
      "ring_type": "simultaneous",
      "pop": "UK",
      "is_default": true,
      "switches": [
        {
          "ip": "2.2.2.2",
          "port": 5060
        }
      ]
    },
    {
      "id": 8375,
      "name": "Trunk Group #2",
      "ring_type": "sequential",
      "pop": "UK",
      "is_default": false,
      "switches": [
        {
          "ip": "10.232.12.35",
          "port": 5060
        },
        {
          "ip": "10.242.34.56",
          "port": 5060
        },
        {
          "ip": "10.242.53.63",
          "port": 5060
        },
        {
          "ip": "216.97.147.10",
          "port": 5060
        }
      ]
    }
  ],
  "meta": {
    "page": 1,
    "page_size": 100,
    "total": 2
  }
}

Response Schema

Status Code 200

Update Trunk Group

Code samples

curl -v \
-X PUT "https://api.idtexpress.com/v1/dids/trunk_groups/268476" \
-H "x-api-key: ****" \
-H "x-api-secret: ****" \
-H 'Content-Type: application/json; charset=utf-8' \
-d '{ "name":"Trunk Group #1", "ring_type":"simultaneous", "pop":"US", "is_default":true, "switches": [ { "ip":"10.232.12.255", "port":5060 }, { "ip":"10.242.34.56", "port":6000 } ]}'

require "uri"
require "net/http"

url = URI("https://api.idtexpress.com/v1/dids/trunk_groups/268476")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Put.new(url)
request["x-api-key"] = "****"
request["x-api-secret"] = "****"
request["Content-Type"] = "application/json; charset=utf-8"
request.body = "{ \"name\":\"Trunk Group \\#1\", \"ring_type\":\"simultaneous\", \"pop\":\"US\", \"is_default\":true, \"switches\": [ { \"ip\":\"10.232.12.255\", \"port\":5060 }, { \"ip\":\"10.242.34.56\", \"port\":6000 } ]}"

response = https.request(request)
puts response.read_body

import http.client

conn = http.client.HTTPSConnection("api.idtexpress.com")
payload = "{ \"name\":\"Trunk Group #1\", \"ring_type\":\"simultaneous\", \"pop\":\"US\", \"is_default\":true, \"switches\": [ { \"ip\":\"10.232.12.255\", \"port\":5060 }, { \"ip\":\"10.242.34.56\", \"port\":6000 } ]}"
headers = {
   'x-api-key': '****',
   'x-api-secret': '****',
   'Content-Type': 'application/json; charset=utf-8'
}
conn.request("PUT", "/v1/dids/trunk_groups/268476", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

var settings = {
   "url": "https://api.idtexpress.com/v1/dids/trunk_groups/268476",
   "method": "PUT",
   "timeout": 0,
   "headers": {
      "x-api-key": "****",
      "x-api-secret": "****",
      "Content-Type": "application/json; charset=utf-8"
   },
   "data": "{ \"name\":\"Trunk Group #1\", \"ring_type\":\"simultaneous\", \"pop\":\"US\", \"is_default\":true, \"switches\": [ { \"ip\":\"10.232.12.255\", \"port\":5060 }, { \"ip\":\"10.242.34.56\", \"port\":6000 } ]}",
};

$.ajax(settings).done(function (response) {
   console.log(response);
});

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
   'method': 'PUT',
   'hostname': 'api.idtexpress.com',
   'path': '/v1/dids/trunk_groups/268476',
   'headers': {
      'x-api-key': '****',
      'x-api-secret': '****',
      'Content-Type': 'application/json; charset=utf-8'
   },
   'maxRedirects': 20
};

var req = https.request(options, function (res) {
   var chunks = [];

   res.on("data", function (chunk) {
      chunks.push(chunk);
   });

   res.on("end", function (chunk) {
      var body = Buffer.concat(chunks);
      console.log(body.toString());
   });

   res.on("error", function (error) {
      console.error(error);
   });
});

var postData =  "{ \"name\":\"Trunk Group #1\", \"ring_type\":\"simultaneous\", \"pop\":\"US\", \"is_default\":true, \"switches\": [ { \"ip\":\"10.232.12.255\", \"port\":5060 }, { \"ip\":\"10.242.34.56\", \"port\":6000 } ]}";

req.write(postData);

req.end();

package main

import (
   "fmt"
   "strings"
   "net/http"
   "io"
)

func main() {

   url := "https://api.idtexpress.com/v1/dids/trunk_groups/268476"
   method := "PUT"

   payload := strings.NewReader(`{ "name":"Trunk Group #1", "ring_type":"simultaneous", "pop":"US", "is_default":true, "switches": [ { "ip":"10.232.12.255", "port":5060 }, { "ip":"10.242.34.56", "port":6000 } ]}`)

   client := &http.Client {
   }
   req, err := http.NewRequest(method, url, payload)

   if err != nil {
      fmt.Println(err)
      return
   }
   req.Header.Add("x-api-key", "****")
   req.Header.Add("x-api-secret", "****")
   req.Header.Add("Content-Type", "application/json; charset=utf-8")

   res, err := client.Do(req)
   if err != nil {
      fmt.Println(err)
      return
   }
   defer res.Body.Close()

   body, err := io.ReadAll(res.Body)
   if err != nil {
      fmt.Println(err)
      return
   }
   fmt.Println(string(body))
}

let parameters = "{ \"name\":\"Trunk Group #1\", \"ring_type\":\"simultaneous\", \"pop\":\"US\", \"is_default\":true, \"switches\": [ { \"ip\":\"10.232.12.255\", \"port\":5060 }, { \"ip\":\"10.242.34.56\", \"port\":6000 } ]}"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "https://api.idtexpress.com/v1/dids/trunk_groups/268476")!,timeoutInterval: Double.infinity)
request.addValue("****", forHTTPHeaderField: "x-api-key")
request.addValue("****", forHTTPHeaderField: "x-api-secret")
request.addValue("application/json; charset=utf-8", forHTTPHeaderField: "Content-Type")

request.httpMethod = "PUT"
request.httpBody = postData

let task = URLSession.shared.dataTask(with: request) { data, response, error in 
   guard let data = data else {
      print(String(describing: error))
      return
   }
   print(String(data: data, encoding: .utf8)!)
}

task.resume()

OkHttpClient client = new OkHttpClient().newBuilder()
   .build();
MediaType mediaType = MediaType.parse("application/json; charset=utf-8");
RequestBody body = RequestBody.create(mediaType, "{ \"name\":\"Trunk Group #1\", \"ring_type\":\"simultaneous\", \"pop\":\"US\", \"is_default\":true, \"switches\": [ { \"ip\":\"10.232.12.255\", \"port\":5060 }, { \"ip\":\"10.242.34.56\", \"port\":6000 } ]}");
Request request = new Request.Builder()
   .url("https://api.idtexpress.com/v1/dids/trunk_groups/268476")
   .method("PUT", body)
   .addHeader("x-api-key", "****")
   .addHeader("x-api-secret", "****")
   .addHeader("Content-Type", "application/json; charset=utf-8")
   .build();
Response response = client.newCall(request).execute();

var options = new RestClientOptions("https://api.idtexpress.com")
{
   MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("/v1/dids/trunk_groups/268476", Method.Put);
request.AddHeader("x-api-key", "****");
request.AddHeader("x-api-secret", "****");
request.AddHeader("Content-Type", "application/json; charset=utf-8");
var body = @"{ ""name"":""Trunk Group #1"", ""ring_type"":""simultaneous"", ""pop"":""US"", ""is_default"":true, ""switches"": [ { ""ip"":""10.232.12.255"", ""port"":5060 }, { ""ip"":""10.242.34.56"", ""port"":6000 } ]}";
request.AddParameter("application/json; charset=utf-8", body,  ParameterType.RequestBody);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
   CURLOPT_URL => 'https://api.idtexpress.com/v1/dids/trunk_groups/268476',
   CURLOPT_RETURNTRANSFER => true,
   CURLOPT_ENCODING => '',
   CURLOPT_MAXREDIRS => 10,
   CURLOPT_TIMEOUT => 0,
   CURLOPT_FOLLOWLOCATION => true,
   CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
   CURLOPT_CUSTOMREQUEST => 'PUT',
   CURLOPT_POSTFIELDS =>'{ "name":"Trunk Group #1", "ring_type":"simultaneous", "pop":"US", "is_default":true, "switches": [ { "ip":"10.232.12.255", "port":5060 }, { "ip":"10.242.34.56", "port":6000 } ]}',
   CURLOPT_HTTPHEADER => array(
      'x-api-key: ****',
      'x-api-secret: ****',
      'Content-Type: application/json; charset=utf-8'
   ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Updates an existing DID Trunk Group on your account. See Create Trunk Group for more detail.

Note: setting the is_default value to false here is ignored. You cannot 'unset' the current default Trunk Group this way. Instead, set is_default to true for the Trunk Group you choose as the new default.

Endpoint

PUT /v1/dids/trunk_groups/{trunk_group_id}

Parameters

Name	In	Type	Required	Description
trunk_group_id	path	string	true	The id of the Trunk Group you are updating. This is the value returned in Create Trunk Group
name	json body	string	true	Then name of the new Trunk Group. Maximum 50 characters, must be unique.
ring_type	json body	string	false	simultaneous (default), or sequential
pop	json body	string	false	US (default), UK or HK
is_default	json body	boolean	false	false (default), or true
switches	json body	[Array]	false	Array of switches. If ring_type is sequential, switches are chosen in array order.
switches[].ip	json body	string	true	IPv4 address of your switch (ex. ‘120.34.1.253’). Note: CIDR block notation is not supported.
switches[].port	json body	integer	false	Port of your switch (5060 default). Range 1024-65535

Example responses

200 Response

{
  "trunk_group": {
    "id": 268476,
    "name": "Trunk Group #1",
    "ring_type": "simultaneous",
    "pop": "US",
    "is_default": true,
    "switches": [
      {
        "ip": "10.232.12.255",
        "port": 5060
      },
      {
        "ip": "10.242.34.56",
        "port": 6000
      }
    ]
  },
  "meta": {}
}

Response Schema

Status Code 200

Delete Trunk Group

Code samples

curl -v \
-X DELETE "https://api.idtexpress.com/v1/dids/trunk_groups/268476" \
-H "x-api-key: ****" \
-H "x-api-secret: ****" \

require "uri"
require "net/http"

url = URI("https://api.idtexpress.com/v1/dids/trunk_groups/268476")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["x-api-key"] = "****"
request["x-api-secret"] = "****"

response = https.request(request)
puts response.read_body

import http.client

conn = http.client.HTTPSConnection("api.idtexpress.com")
payload = ''
headers = {
   'x-api-key': '****',
   'x-api-secret': '****'
}
conn.request("DELETE", "/v1/dids/trunk_groups/268476", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

var settings = {
   "url": "https://api.idtexpress.com/v1/dids/trunk_groups/268476",
   "method": "DELETE",
   "timeout": 0,
   "headers": {
      "x-api-key": "****",
      "x-api-secret": "****"
   },
};

$.ajax(settings).done(function (response) {
   console.log(response);
});

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
   'method': 'DELETE',
   'hostname': 'api.idtexpress.com',
   'path': '/v1/dids/trunk_groups/268476',
   'headers': {
      'x-api-key': '****',
      'x-api-secret': '****'
   },
   'maxRedirects': 20
};

var req = https.request(options, function (res) {
   var chunks = [];

   res.on("data", function (chunk) {
      chunks.push(chunk);
   });

   res.on("end", function (chunk) {
      var body = Buffer.concat(chunks);
      console.log(body.toString());
   });

   res.on("error", function (error) {
      console.error(error);
   });
});

req.end();

package main

import (
   "fmt"
   "net/http"
   "io"
)

func main() {

   url := "https://api.idtexpress.com/v1/dids/trunk_groups/268476"
   method := "DELETE"

   client := &http.Client {
   }
   req, err := http.NewRequest(method, url, nil)

   if err != nil {
      fmt.Println(err)
      return
   }
   req.Header.Add("x-api-key", "****")
   req.Header.Add("x-api-secret", "****")

   res, err := client.Do(req)
   if err != nil {
      fmt.Println(err)
      return
   }
   defer res.Body.Close()

   body, err := io.ReadAll(res.Body)
   if err != nil {
      fmt.Println(err)
      return
   }
   fmt.Println(string(body))
}

var request = URLRequest(url: URL(string: "https://api.idtexpress.com/v1/dids/trunk_groups/268476")!,timeoutInterval: Double.infinity)
request.addValue("****", forHTTPHeaderField: "x-api-key")
request.addValue("****", forHTTPHeaderField: "x-api-secret")

request.httpMethod = "DELETE"

let task = URLSession.shared.dataTask(with: request) { data, response, error in 
   guard let data = data else {
      print(String(describing: error))
      return
   }
   print(String(data: data, encoding: .utf8)!)
}

task.resume()

OkHttpClient client = new OkHttpClient().newBuilder()
   .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
   .url("https://api.idtexpress.com/v1/dids/trunk_groups/268476")
   .method("DELETE", body)
   .addHeader("x-api-key", "****")
   .addHeader("x-api-secret", "****")
   .build();
Response response = client.newCall(request).execute();

var options = new RestClientOptions("https://api.idtexpress.com")
{
   MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("/v1/dids/trunk_groups/268476", Method.Delete);
request.AddHeader("x-api-key", "****");
request.AddHeader("x-api-secret", "****");
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
   CURLOPT_URL => 'https://api.idtexpress.com/v1/dids/trunk_groups/268476',
   CURLOPT_RETURNTRANSFER => true,
   CURLOPT_ENCODING => '',
   CURLOPT_MAXREDIRS => 10,
   CURLOPT_TIMEOUT => 0,
   CURLOPT_FOLLOWLOCATION => true,
   CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
   CURLOPT_CUSTOMREQUEST => 'DELETE',
   CURLOPT_HTTPHEADER => array(
      'x-api-key: ****',
      'x-api-secret: ****'
   ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Removes a DID Trunk Group from your account. Any numbers associated with the removed Trunk Group will be reset to your default Trunk Group.

Note: you cannot delete your designated default Trunk Group. See Default Trunk Group.

Endpoint

DELETE /v1/dids/trunk_groups/{trunk_group_id}

Parameters

Name	In	Type	Required	Description
trunk_group_id	path	string	true	The id of the Trunk Group you are deleting. This is the value returned in Create Trunk Group

Example responses

204 Response

No Content

Response Schema

Status Code 204

Set Trunk Group

Code samples

curl -v \
-X PUT "https://api.idtexpress.com/v1/dids/set_trunk_group" \
-H "x-api-key: ****" \
-H "x-api-secret: ****" \
-H 'Content-Type: application/json; charset=utf-8' \
-d '{ "trunk_group_id":268476, "numbers":[ "0115117304800", "011557135001580" ] }'

require "uri"
require "net/http"

url = URI("https://api.idtexpress.com/v1/dids/set_trunk_group")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Put.new(url)
request["x-api-key"] = "****"
request["x-api-secret"] = "****"
request["Content-Type"] = "application/json; charset=utf-8"
request.body = "{ \"trunk_group_id\":268476, \"numbers\":[ \"0115117304800\", \"011557135001580\" ] }"

response = https.request(request)
puts response.read_body

import http.client

conn = http.client.HTTPSConnection("api.idtexpress.com")
payload = "{ \"trunk_group_id\":268476, \"numbers\":[ \"0115117304800\", \"011557135001580\" ] }"
headers = {
   'x-api-key': '****',
   'x-api-secret': '****',
   'Content-Type': 'application/json; charset=utf-8'
}
conn.request("PUT", "/v1/dids/set_trunk_group", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

var settings = {
   "url": "https://api.idtexpress.com/v1/dids/set_trunk_group",
   "method": "PUT",
   "timeout": 0,
   "headers": {
      "x-api-key": "****",
      "x-api-secret": "****",
      "Content-Type": "application/json; charset=utf-8"
   },
   "data": "{ \"trunk_group_id\":268476, \"numbers\":[ \"0115117304800\", \"011557135001580\" ] }",
};

$.ajax(settings).done(function (response) {
   console.log(response);
});

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
   'method': 'PUT',
   'hostname': 'api.idtexpress.com',
   'path': '/v1/dids/set_trunk_group',
   'headers': {
      'x-api-key': '****',
      'x-api-secret': '****',
      'Content-Type': 'application/json; charset=utf-8'
   },
   'maxRedirects': 20
};

var req = https.request(options, function (res) {
   var chunks = [];

   res.on("data", function (chunk) {
      chunks.push(chunk);
   });

   res.on("end", function (chunk) {
      var body = Buffer.concat(chunks);
      console.log(body.toString());
   });

   res.on("error", function (error) {
      console.error(error);
   });
});

var postData =  "{ \"trunk_group_id\":268476, \"numbers\":[ \"0115117304800\", \"011557135001580\" ] }";

req.write(postData);

req.end();

package main

import (
   "fmt"
   "strings"
   "net/http"
   "io"
)

func main() {

   url := "https://api.idtexpress.com/v1/dids/set_trunk_group"
   method := "PUT"

   payload := strings.NewReader(`{ "trunk_group_id":268476, "numbers":[ "0115117304800", "011557135001580" ] }`)

   client := &http.Client {
   }
   req, err := http.NewRequest(method, url, payload)

   if err != nil {
      fmt.Println(err)
      return
   }
   req.Header.Add("x-api-key", "****")
   req.Header.Add("x-api-secret", "****")
   req.Header.Add("Content-Type", "application/json; charset=utf-8")

   res, err := client.Do(req)
   if err != nil {
      fmt.Println(err)
      return
   }
   defer res.Body.Close()

   body, err := io.ReadAll(res.Body)
   if err != nil {
      fmt.Println(err)
      return
   }
   fmt.Println(string(body))
}

let parameters = "{ \"trunk_group_id\":268476, \"numbers\":[ \"0115117304800\", \"011557135001580\" ] }"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "https://api.idtexpress.com/v1/dids/set_trunk_group")!,timeoutInterval: Double.infinity)
request.addValue("****", forHTTPHeaderField: "x-api-key")
request.addValue("****", forHTTPHeaderField: "x-api-secret")
request.addValue("application/json; charset=utf-8", forHTTPHeaderField: "Content-Type")

request.httpMethod = "PUT"
request.httpBody = postData

let task = URLSession.shared.dataTask(with: request) { data, response, error in 
   guard let data = data else {
      print(String(describing: error))
      return
   }
   print(String(data: data, encoding: .utf8)!)
}

task.resume()

OkHttpClient client = new OkHttpClient().newBuilder()
   .build();
MediaType mediaType = MediaType.parse("application/json; charset=utf-8");
RequestBody body = RequestBody.create(mediaType, "{ \"trunk_group_id\":268476, \"numbers\":[ \"0115117304800\", \"011557135001580\" ] }");
Request request = new Request.Builder()
   .url("https://api.idtexpress.com/v1/dids/set_trunk_group")
   .method("PUT", body)
   .addHeader("x-api-key", "****")
   .addHeader("x-api-secret", "****")
   .addHeader("Content-Type", "application/json; charset=utf-8")
   .build();
Response response = client.newCall(request).execute();

var options = new RestClientOptions("https://api.idtexpress.com")
{
   MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("/v1/dids/set_trunk_group", Method.Put);
request.AddHeader("x-api-key", "****");
request.AddHeader("x-api-secret", "****");
request.AddHeader("Content-Type", "application/json; charset=utf-8");
var body = @"{ ""trunk_group_id"":268476, ""numbers"":[ ""0115117304800"", ""011557135001580"" ] }";
request.AddParameter("application/json; charset=utf-8", body,  ParameterType.RequestBody);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
   CURLOPT_URL => 'https://api.idtexpress.com/v1/dids/set_trunk_group',
   CURLOPT_RETURNTRANSFER => true,
   CURLOPT_ENCODING => '',
   CURLOPT_MAXREDIRS => 10,
   CURLOPT_TIMEOUT => 0,
   CURLOPT_FOLLOWLOCATION => true,
   CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
   CURLOPT_CUSTOMREQUEST => 'PUT',
   CURLOPT_POSTFIELDS =>'{ "trunk_group_id":268476, "numbers":[ "0115117304800", "011557135001580" ] }',
   CURLOPT_HTTPHEADER => array(
      'x-api-key: ****',
      'x-api-secret: ****',
      'Content-Type: application/json; charset=utf-8'
   ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Assigns a DID Trunk Group to selected number(s).

Endpoint

PUT /v1/dids/set_trunk_group

Parameters

Name	In	Type	Required	Description
trunk_group_id	json body	integer	true	The id of the Trunk Group you are assigning. This is the value returned in Create Trunk Group. NOTE: set trunk_group_id to null in order to assign the default Trunk Group
numbers	json body	[string]	true	Array of one or more of your active DID numbers for Trunk Group assignment

Example responses

204 Response

No Content

Response Schema

Status Code 204