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

GET /stubs/handler_api.php?action=setStatus

Change operation status

This request allows you to change the status of the operation according to its results (cancel operation, get next SMS code, close operation).

You might want to use this request when you want explicitly change the status of the operation, for example when your application needs to retrieve information from the second message received by this number.

Security

api_key
BearerAuth
OAuth2Scopes: sms-scope
sms-scope
grants access to manage numbers for the SMS receiving service from Onlinesim

Parameters

query3
NameTypeDescription
action*string

Method name, in this case setStatus

Enum:setStatusDefault:setStatus
id*integer
≥ 1

Operation ID (according to getNumber or getStatus responses)

Example:10000
status*integer

Status code:

1 - inform when the phone number is ready (SMS was sent to this number),

3 - request digital code from the next message,

6 - close the operation

Enum:136Example:6

Responses

200

Successful setStatus response from the server: either switches operation status to the specified or throws an exception.

Content-Typetext/html
Schema
Responsestring

Examples

`Operation closed` response
ACCESS_ACTIVATION
`Ready to receive another message` response
ACCESS_RETRY_GET

Code Samples

Generating examples...