post GET_SERVICES (RENT)
https://{yourserver.com}/getServicesRent
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.
IMPORTANT NOTE! &br; 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.
IMPORTANT NOTE! &br; 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. &br; Violation of this condition will cause the system to automatically block receiving numbers from you for 30 minutes. &br; 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.
IMPORTANT NOTE! &br;
operatorMap
must contain operatorany
that includes summarized amount of numbers of all operators listed for rent.
Parameters
Global params
Request Body
- Schema
- Examples
- objectExample:
{"action":"GET_SERVICES","key":"string"}
Properties:action
stringRequiredMethod name, in this case `GET_SERVICES`Example:"GET_SERVICES"
Enum:GET_SERVICES
key
stringRequiredAPI key of your Onlinesim partner's profileExample:"string"
Responses
200
Content-Type
- stringExample:
"application/json; charset=utf-8"
Enum:application/json; charset=utf-8
- Schema
- Examples
- objectExample:
{"countryList":[{"#countryname#":"string","operatorMap":{"any":{"#service_name#":0,"rent":0},"#operator_name#":{"#service_name#":0,"rent":0}}}],"status":"SUCCESS"}
Properties:countryList
arrayExample:[{"#countryname#":"string","operatorMap":{"any":{"#service_name#":0,"rent":0},"#operator_name#":{"#service_name#":0,"rent":0}}}]
Items:- objectExample:
{"#countryname#":"string","operatorMap":{"any":{"#service_name#":0,"rent":0},"#operator_name#":{"#service_name#":0,"rent":0}}}
status
stringRequest status (`SUCCESS` or `ERROR`)Example:"SUCCESS"
Enum:SUCCESS
ERROR