Skip to main content
GET
cURL

Authorizations

​
X-Auth-ID
string
header
required

Your Vobiz account Auth ID (MA_XXXXXXXX).

​
X-Auth-Token
string
header
required

Your Vobiz account Auth Token.

Query Parameters

​
country
string
required

Country to search, as an ISO 3166-1 alpha-2 code such as US, CA or GB. Case-insensitive. A value that is not two letters returns 400 with country must be an ISO 3166-1 alpha-2 code.

Pattern: ^[A-Za-z]{2}$
​
capabilities
string
default:SMS

Comma-separated capabilities the number must have: SMS, MMS, or SMS,MMS. Case-insensitive, defaults to SMS. Any other value returns 400 with capabilities must be SMS and/or MMS.

​
areaCode
string

Three-digit area code to search in, for example 415. Accepted only when country is US or CA; other countries return 400 with areaCode is only supported for US and CA.

Pattern: ^[0-9]{3}$
​
limit
integer
default:10

Maximum number of results, from 1 to 100. Defaults to 10, and each search returns at most 10 numbers whatever you pass. A value outside the range returns 400 with limit must be between 1 and 100.

Required range: 1 <= x <= 10

Response

Numbers you can buy.

One page of inventory search results.

​
numbers
object[]

Numbers that match your filters, at most 10 per search. Empty array when nothing matches, and for country=IN.

​
page
integer

The zero-based page index you requested, echoed back.

Example:

0

​
limit
integer

Page size applied to this search, at most 10.

Example:

10

​
hasMore
boolean

Reserved for pagination; false on every response. Run a new search with different filters to see other numbers.

Example:

false

​
hint
string

Guidance returned only for country=IN, explaining that Indian traffic is sent from DLT-registered sender IDs rather than purchased numbers. Absent for every other country.

Example:

"India uses DLT sender IDs, not long codes"