Module: Voxbone::Inventory

Included in:
Voxbone
Defined in:
lib/voxbone/inventory.rb

Instance Method Summary collapse

Instance Method Details

#list_did_group(**options) ⇒ Object

List DID Group

‘list_did_group` 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.

options - Type: Hash. Parameters used to refine the selection.

:country_code_a3   - Type: String. 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.). (required)
:page_number       - Type: Integer. The page number, starting at
                     0. (required)
:page_size         - Type: Integer. The page size (max number of
                     entities that are displayed in the
                     response). (required)
:did_group_ids     - Type: Integer (multiple). Can be used if
                     you want information about specific DID
                     groups.
:state_id          - Type: String. The numerical identifier for
                     the didGroup's state. Please see the
                     `list_state` operation to retrieve a valid
                     state identifier.
:city_name_pattern - Type: String. 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       - Type: String. 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         - Type: String. The area code of the DID
                     group (e.g. "646").
:did_type          - Type: String. The type of DID. The possible
                     values are GEOGRAPHIC, TOLL_FREE, NATIONAL,
                     MOBILE, SHARED_COST, SPECIAL, or INUM.
:show_empty        - Type: Boolean. Set to true if you want to
                     show the didGroups with no stock currently
                     available.
:feature_ids       - Type: Integer (multiple). 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). Note
                     that you can specify multiple features by
                     repeating the query parameter.



53
54
55
 
# File 'lib/voxbone/inventory.rb', line 53

def list_did_group(**options)
  send_get('/inventory/didgroup', options)
end