voxbone v0.3.0 Voxbone.Api.Inventory
API calls for all endpoints tagged Inventory.
Link to this section Summary
Functions
Allows you to display details for a country available in the Voxbone coverage
Allows you to search for countries available in the Voxbone coverage
This method is used to retrieve the list of packages that are available for prepaid credits top-ups (e.g. $100 Prepaid Credits package which shows a value multiplied by 100: 'Price100=10000')
This method allows you to search for DIDs within your own inventory. This method can be useful to get the current configuration of one or multiple DIDs
Allows you to retrieve the list of DID groups. A DID group can be defined as the smallest set of DIDs which is usually DIDs that share the same city or area code attributes. It is a method which is useful to get pricing info on a DID and to get didGroupIds which is a required parameter when placing a DID order
Allows you to retrieve the list of features (featureID, name and description) that DIDs can have such as VoxFAX or VoxSMS. This method will now also return Voice as a feature
Allows you to get the list of restrictions per country in a text format
Allows you to get the list of states for a country that has states such as USA and CAN
This method allows you to get the list of the trunks that are available in your account
Allows you to display all the zones currently configured in your account
Link to this section Functions
get_country(Tesla.Env.client(), String.t(), keyword()) :: {:ok, Voxbone.Model.ListCountryResponse.t()} | {:error, Tesla.Env.t()}
Allows you to display details for a country available in the Voxbone coverage.
Parameters
- connection (Voxbone.Connection): Connection to server
- country_code_a3 (String.t): The three letter identifier of the country.
- opts (KeywordList): [optional] Optional parameters
Returns
{:ok, %Voxbone.Model.ListCountryResponse{}} on success {:error, info} on failure
list_country(Tesla.Env.client(), integer(), integer(), keyword()) :: {:ok, Voxbone.Model.ListCountryResponse.t()} | {:error, Tesla.Env.t()}
Allows you to search for countries available in the Voxbone coverage.
Parameters
- connection (Voxbone.Connection): Connection to server
- page_number (integer()): The page number, starting at 0.
- page_size (integer()): The page size (max number of entities that are displayed in the response).
opts (KeywordList): [optional] Optional parameters
- :country_code_a3 (String.t): The country code for the DID in its ISO 3166-1 alpha-3 format (e.g. 'GBR' for United Kingdom, 'USA' for United States of America, 'BEL' for Belgium, and special code 'WLD' for iNum numbers).
- :did_type (String.t): The type of DIDs (service) offered for the country.
Returns
{:ok, %Voxbone.Model.ListCountryResponse{}} on success {:error, info} on failure
list_credit_package(Tesla.Env.client(), keyword()) :: {:ok, Voxbone.Model.ListCreditPackageResponse.t()} | {:error, Tesla.Env.t()}
This method is used to retrieve the list of packages that are available for prepaid credits top-ups (e.g. $100 Prepaid Credits package which shows a value multiplied by 100: 'Price100=10000').
Parameters
- connection (Voxbone.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
Returns
{:ok, %Voxbone.Model.ListCreditPackageResponse{}} on success {:error, info} on failure
list_did(Tesla.Env.client(), integer(), integer(), keyword()) :: {:ok, Voxbone.Model.ListDidResponse.t()} | {:error, Tesla.Env.t()}
This method allows you to search for DIDs within your own inventory. This method can be useful to get the current configuration of one or multiple DIDs.
Parameters
- connection (Voxbone.Connection): Connection to server
- page_number (integer()): The page number, starting at 0.
- page_size (integer()): The page size (max number of entities that are displayed in the response).
opts (KeywordList): [optional] Optional parameters
- :did_ids ([integer()]): Can be specified to get detailed info about the corresponding DIDs. Note that you can specify multiple ids by repeating the query parameter.
- :did_group_ids ([integer()]): Can be specified to filter your DIDs based on their location or any other info contained in the DID Group. Note that you can specify multiple ids by repeating the query parameter.
- :e164_pattern (String.t): You can search a specific DID in your inventory with a specific pattern e.g. %25123 (number contains 123). %-sign needs to be escaped using %25
- :regulation_address_id (integer()): This is an ID that you get when creating a regulation address. The DIDs can be filtered by the regulation address on which they are linked.
- :voice_uri_id (integer()): The identifier of the voice uri the numbers are mapped to.
- :fax_uri_id (integer()): The identifier of the fax uri the numbers are mapped to.
- :sms_link_group_id (integer()): The identifier of the sms link group the numbers are mapped to.
- :need_address_link (boolean()): A boolean flag indicating if the numbers need to be linked to an address for regulation purposes.
- :service_type (String.t): This can be used if you want to filter by service type. The possible values are 'VOX800' for toll-free numbers or 'VOXDID' for geographic or national numbers.
- :country_code_a3 (String.t): The country code for the DID in its ISO 3166-1 alpha-3 format (e.g. 'GBR' for United Kingdom, 'USA' for United States of America, 'BEL' for Belgium, etc.).
- :order_reference (String.t): Indicates which purchase order the DID was in. You can get a list of orders with the order details (date and status) in the ordering module using the listOrder method.
- :porting_reference (String.t): The reference for the numbers' porting request.
- :delivery_id (integer()): The identifier of the pop the numbers are mapped to.
- :sms_outbound (boolean()): Allows you to filter your DIDs that you have enabled for outbound SMS (the feature is only available for accounts that are registered for the SMS outbound service).
- :web_rtc_enabled (boolean()): Indicates whether the DID is enabled for WebRTC use (the feature is only available for accounts that are registered for the WebRTC service).
- :voxout_national_enabled (boolean()): Indicates whether the DID is enabled for voxoutNational use (the feature is only available for accounts that are registered for the voxoutNational service).
- :voxout_international_enabled (boolean()): Indicates whether the DID is enabled for voxoutInternational use (the feature is only available for accounts that are registered for the voxoutInternational service).
Returns
{:ok, %Voxbone.Model.ListDidResponse{}} on success {:error, info} on failure
list_did_group(Tesla.Env.client(), String.t(), integer(), integer(), keyword()) :: {:ok, Voxbone.Model.ListDidGroupResponse.t()} | {:error, Tesla.Env.t()}
Allows you to retrieve the list of DID groups. A DID group can be defined as the smallest set of DIDs which is usually DIDs that share the same city or area code attributes. It is a method which is useful to get pricing info on a DID and to get didGroupIds which is a required parameter when placing a DID order.
Parameters
- connection (Voxbone.Connection): Connection to server
- country_code_a3 (String.t): Indicates the country code of the DID group in its ISO 3166-1 alpha-3 format (e.g. 'GBR' for United Kingdom, 'USA' for United States of America, 'BEL' for Belgium, etc.).
- page_number (integer()): The page number, starting at 0.
- page_size (integer()): The page size (max number of entities that are displayed in the response).
opts (KeywordList): [optional] Optional parameters
- :did_group_ids ([integer()]): Can be used if you want information about specific DID groups. Note that you can specify multiple ids by repeating the query parameter.
- :state_id (integer()): The numerical identifier for the didGroup's state. Please see the listState operation to retrieve a valid state identifier.
- :city_name_pattern (String.t): A string pattern for the beginning of city name: 'New York%' will return all New York DID groups. On the contrary, 'w York%' will return none.
- :rate_center (String.t): The rate center can be defined as a zone (which can be equivalent to a city or the area of a city) e.g. the rate center of 'NEW YORK CITY ZONE 1' would be 'NWYRCYZN01'. The rate center is a notion usually used in north America.
- :area_code (String.t): The area code of the DID group (e.g. '646').
- :did_type (String.t): The type of DID.
- :show_empty (String.t): Set to true if you want to show the didGroups with no stock currently available.
- :feature_ids ([integer()]): Can be used if you want to list DID groups that support certain features such as VoxSMS or VoxFAX. (eg. 6 for VoxFAX, 25 for VoxSMS, 50 for Voice). Note that you can specify multiple features by repeating the query parameter.
Returns
{:ok, %Voxbone.Model.ListDidGroupResponse{}} on success {:error, info} on failure
list_feature(Tesla.Env.client(), keyword()) :: {:ok, Voxbone.Model.ListFeatureResponse.t()} | {:error, Tesla.Env.t()}
Allows you to retrieve the list of features (featureID, name and description) that DIDs can have such as VoxFAX or VoxSMS. This method will now also return Voice as a feature.
Parameters
- connection (Voxbone.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
Returns
{:ok, %Voxbone.Model.ListFeatureResponse{}} on success {:error, info} on failure
list_restriction(Tesla.Env.client(), String.t(), keyword()) :: {:ok, Voxbone.Model.ListRestrictionResponse.t()} | {:error, Tesla.Env.t()}
Allows you to get the list of restrictions per country in a text format.
Parameters
- connection (Voxbone.Connection): Connection to server
- country_code_a3 (String.t): The country code for the DID in its ISO 3166-1 alpha-3 format (e.g. 'GBR' for United Kingdom, 'USA' for United States of America, 'BEL' for Belgium, etc.).
- opts (KeywordList): [optional] Optional parameters
Returns
{:ok, %Voxbone.Model.ListRestrictionResponse{}} on success {:error, info} on failure
list_state(Tesla.Env.client(), String.t(), keyword()) :: {:ok, Voxbone.Model.ListStateResponse.t()} | {:error, Tesla.Env.t()}
Allows you to get the list of states for a country that has states such as USA and CAN.
Parameters
- connection (Voxbone.Connection): Connection to server
- country_code_a3 (String.t): It indicates the country code of the country in its ISO 3166-1 alpha-3 format. Note that only countryCodeA3 for countries that have states are valid values.
- opts (KeywordList): [optional] Optional parameters
Returns
{:ok, %Voxbone.Model.ListStateResponse{}} on success {:error, info} on failure
list_trunk(Tesla.Env.client(), keyword()) :: {:ok, Voxbone.Model.ListTrunkResponse.t()} | {:error, Tesla.Env.t()}
This method allows you to get the list of the trunks that are available in your account.
Parameters
- connection (Voxbone.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
Returns
{:ok, %Voxbone.Model.ListTrunkResponse{}} on success {:error, info} on failure
list_zone(Tesla.Env.client(), keyword()) :: {:ok, Voxbone.Model.ListZoneResponse.t()} | {:error, Tesla.Env.t()}
Allows you to display all the zones currently configured in your account.
Parameters
- connection (Voxbone.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
Returns
{:ok, %Voxbone.Model.ListZoneResponse{}} on success {:error, info} on failure