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

GET /stubs/handler_api.php?action=getRentStatus

Get rent operation status

This request returns a list of SMS received on a rental virtual number.

You might want to use this request to check the received message on a specified rental number to process this data in your application.

Security

api_key
BearerAuth
OAuth2Scopes: rent-scope
rent-scope
grants access to renting phone numbers from Onlinesim

Parameters

query2
NameTypeDescription
action*string

Method name, in this case getRentStatus

Enum:getRentStatusDefault:getRentStatus
id*integer

Operation ID (assigned upon order, according to getRentList)

Example:10000

Responses

200

Successful getRentStatus response from the server: either returns a list of received messages by the specified virtual rental number or throws an exception.

Content-Typeapplication/json
Schema
Responseobject
statusstring

Request execution status

Example:success
quantityinteger

Total messages received by this number

valuesobject

List of SMS messages

#sms_index#object

Message ID starting with 0

phoneFromstring

Rental number that has received the message (international format with "+" sign)

Example:+79089102030
textstring

Context of the message

Example:Your verification code is 070501
servicestring

Sender's name or phone number

Example:twitter
datestring

Date and time of receipt

Example:2021-02-02T14:46:49+03:00

Examples

List of received messages example response
{
  "status": "success",
  "quantity": 1,
  "values": {
    "#sms_index#": {
      "phoneFrom": "+79089102030",
      "text": "Your verification code is 070501",
      "service": "twitter",
      "date": "2021-02-02T14:46:49+03:00"
    }
  }
}

Code Samples

Generating examples...