get getRentStatus

http://api-conserver.onlinesim.io/stubs/handler_api.php?action=getRentStatus
rent
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

Parameters

action
Required
Method name, in this case `getRentStatus`
In: query
Schema:
  • string
    Example: "getRentStatus"
    Enum: getRentStatus
id
Required

Operation ID (assigned upon order, see getRentList)

In: query
Schema:
  • integer
    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 Type:
application/json
  • Schema
  • Examples
  • object
    Example: {"status":"success","quantity":0,"values":{"#sms_index#":{"phoneFrom":"+79089102030","text":"Your verification code is 070501","service":"twitter","date":"2021-02-02T14:46:49+03:00"}}}
    Properties:
    • status
      string
      Request execution status
      Example: "success"
    • quantity
      integer
      Total messages received by this number
      Example: 0
    • values
      object
      List of SMS messages
      Example: {"#sms_index#":{"phoneFrom":"+79089102030","text":"Your verification code is 070501","service":"twitter","date":"2021-02-02T14:46:49+03:00"}}