gethttps://onlinesim.io/api/setOperationOk.php

GET /api/setOperationOk.php

Complete activation operation

Sets operation status as successful and closes the operation.

This request is send when you want to close the operation explicitly after receiving the required SMS message.

Operation closing

Security

apikey

BearerAuth

OAuth2Scopes: sms-scope

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

Parameters

query3

Name	Type	Description
`tzid`*	`integer` ≥ 1	Operation ID Example:`10000`
`ban`	`integer`	This parameter can be used in case if you were issued invalid number or did not receive the SMS within 5 minutes. You can pass `1` as the value for this parameter to block the number Enum:`01`Example:`1`
`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`

Responses

200

'Successful response for setOperationOk request: the server successfully closes the specified operation or throws an exception.'

Content-Typeapplication/json

Schema

Responseobject

'Result description. Response NO_COMPLETE_TZID means that operation can not be closed until the protective interval has elapsed. By default, this interval is 2 minutes, but for some services it may be longer.'

responseoneOf

1, if the request has been completed successfully, or an error message

Example:1

One Of

[0]integer

[1]string

tzidinteger

Operation ID

≥ 1

Example:10000

Examples

setOperationOk exception example (closing operation attempt during protective interval)

{
  "response": "NO_COMPLETE_TZID"
}

Code Samples

Generating examples...