GET /api/rent/getRentState.php

Get information about the state of virtual phone number rent operation

This request returns a list of active rental numbers.

You can use it to quickly browse all your active rental numbers (or only specific one) and their received messages.

Security

apikey
BearerAuth
OAuth2 (Scopes: rent-scope)
- rent-scope: grants access to renting phone numbers from Onlinesim

Name	Type	Description
`tzid`	`integer`	'Operation ID. If not specified, request will return the entire list of active rental operations’
`pagination`	`boolean`	Pagination mode for message browsing (disabled if `false`) Default:`false`Example:`false`
`lang`	`string`	Response language: `fr` - French, `de` - German, `ru` - Russian, `en` - English, `zh` - Chinese. Please note that the translation applies only to string field values, such as service names or country names. Field names themselves, error messages, and standard values (for example, true/false for boolean fields) remain in English. Enum:`frderuenzh`Default:`ru`Example:`en`

No code samples available