Skip to content

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.

WARNING

Closing the operation is irreversible process: once you close the operation, you won't be able to use or restore access to this number.

Security

  • api_key
  • BearerAuth
  • OAuth2 (Scopes: sms-scope)
    • sms-scope: grants access to manage numbers for the SMS receiving service from Onlinesim

Parameters

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.

Code Samples