Skip to content

POST /getServicesRent

Get list of available services and countries for rent

This request is sent from Onlinesim server to yours to get a list of available for rent numbers. Your server should return a list of numbers in format described below.

Your partner's API key will be passed in the request in a payload.

TIP

You can either add a result field that contains quantity of available numbers for rent to your existing GET_SERVICES endpoint response for singe-service activations (v1) or create a new endpoint for rent only.

WARNING

It is necessary to return actual number of simultaneously available numbers. For example, if you have SIM bank with 512 ports and only 64 GSM-modules, then you should return 64, not 512.

DANGER

Violation of this condition will cause the system to automatically block receiving numbers from you for 30 minutes.

WARNING

Your server must issue a list with quantity of available numbers for rent within 10 seconds of the request. Otherwise current request will be cancelled.

INFO

operatorMap must contain operator any that includes summarized amount of numbers of all operators listed for rent.

Parameters

NameTypeDescription
Authorization*string

see more here

Example:Bearer apikey

Request Body

Request payload from Onlinesim server

Content-Type:application/json
Bodyobject
actionstringRequired

Method name, in this case GET_SERVICES

Enum:GET_SERVICES
Default:GET_SERVICES
Example:GET_SERVICES
keystringRequired

API key of your Onlinesim partner’s profile

Responses

200

The response of your server for GET_SERVICES request must be in
following format:

Code Samples