gethttp://api-conserver.onlinesim.io/stubs/handler_api.php?action=getNumbersStatus

GET /stubs/handler_api.php?action=getNumbersStatus

Get information on the number of available numbers by services

This request returns a list of available numbers by country and service. You might want to use it to check if the numbers of desired country are available for order and if so, how many.

Security

api_key

BearerAuth

OAuth2Scopes: sms-scope

sms-scope: grants access to manage numbers for the SMS receiving service from Onlinesim

Parameters

query2

Name	Type	Description
`action`*	`string`	Method name, in this case `getNumbersStatus` Enum:`getNumbersStatus`Default:`getNumbersStatus`
`country`	`integer` ≥ 1	International dialing code of the country (Е.164 standard, without "+" sign) Default:`7`Example:`46`

Responses

200

Successful getNumbersStatus response from the server: either returns detailed information on available numbers by service or throws an exception.

Content-Typeapplication/json

Schema

Responseobject

List of services and corresponding available numbers

#service_slug#integer

Service name (countryID): amount of available numbers

Examples

List of available numbers by services for Philippine numbers

{
  "vk_0": 2016,
  "fb_0": 0,
  "ma_0": 28,
  "vi_0": 2006,
  "ok_0": 28,
  "ig_0": 0,
  "go_0": 2015,
  "ya_0": 0,
  "mb_0": 2028,
  "tw_0": 2000,
  "wa_0": 0
}

Code Samples

Generating examples...