Skip to content

POST /getServices

Get list of available services and countries

This request is sent from Onlinesim server to yours every 2 minutes to get a quantity of available numbers. Your server should return a relevant list of available numbers in format described below.

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

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 within 10 seconds of the request. Otherwise current request will be cancelled.

INFO

operatorMap should contain operator any that includes summarized amount of numbers of all operators for each service

Each successful operation has to reduce count of available numbers for the service by 1. If operation was cancelled or failed (SMS hasn't been received), the counter has to remain unchanged.

Operation result is passed as status parameter in FINISH_ACTIVATION request.

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