Methods

Objects

did/areacode

Area codes, DID types and countries.

Method Description
did/areacode.countries Get available countries in the DID store
did/areacode.get_list Get area codes available in the store, for a specific country and DID ...
did/areacode.types Get DID types available in the store for a specific country.

Methods

did/areacode.countries

Description

Get available countries in the DID store

Signature

method: did/areacode.countries

params: []

Parameters

No parameters.

Result

Type Description Format/Object
array Countries available in the DID store Array of DID.Country objects.

did/areacode.get_list

Description

Get area codes available in the store, for a specific country and DID type.

Signature

method: did/areacode.get_list

params: [string country_code, string type]

Parameters

Parameter Type Description NULL
country_code string Country code
Format: country_code (ISO 3166-1 alpha-2 country code. Example: "US")
NO
type string DID type. Send NULL to ignore.
Values: "GEOGRAPHIC", "MOBILE", "NON-GEOGRAPHIC", "PERSONAL", "SHAREDREVENUE", "SMS-ONLY", "SPECIAL", "TOLLFREE"
YES

Result

Type Description Format/Object
array Area codes. Array of DID.AreaCode objects.

did/areacode.types

Description

Get DID types available in the store for a specific country.

Signature

method: did/areacode.types

params: [string country_code]

Parameters

Parameter Type Description NULL
country_code string Country code
Format: country_code (ISO 3166-1 alpha-2 country code. Example: "US")
NO

Result

Type Description Format/Object
array DID types Array of DID.Type objects.