get getState

https://onlinesim.io/api/getState.php
single-service activations

Returns detailed information on all active numbers you have (or specific one).

It allows you to check the status of operations of your account and read the messages received on ordered numbers.

For example, you can use this request to get a list of all SMS from active numbers to process them.

In fact, this is a representation of active operations section ("My numbers") from the user dashboard.

Active operations

Security

Parameters

tzid
Operation ID
In: query
Schema:
  • integer
    Example: 10000
    >= 1
message_to_code

SMS display mode:

0 - show the entire SMS,

1 - display only the code from the SMS

In: query
Schema:
  • integer
    Example: 1
    Enum: 0 1
orderby
Sorting order: `asc` - ascending; `desc` - descending
In: query
Schema:
  • string
    Example: "asc"
    Enum: asc desc
msg_list

Message list display mode:

0 - show only the active message,

1 - show the whole list

In: query
Schema:
  • integer
    Example: 1
    <= 1
    >= 0
    Enum: 0 1
clean

Message display mode (only for msg_list = 0):

0 - show previosly shown messages,

1 - do not show previously shown messages

In: query
Schema:
  • integer
    Example: 1
    <= 1
    >= 0
    Enum: 0 1
lang

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.

In: query
Schema:
  • string
    Example: "en"
    Enum: fr de ru en zh

Responses

200

Successful response for `getState` request: the server returns detailed information on active numbers of your account or throws an exception.
Content Type:
application/json
  • Schema
  • Examples
  • array
    Array of active numbers (current operations) on your account
    Example: [{"country":46,"sum":14,"service":"Facebook","number":"+46050101010","response":"TZ_NUM_ANSWER","tzid":10000,"time":281,"form":"index"}]
    Items:
    • object
      Operation information
      Example: {"country":46,"sum":14,"service":"Facebook","number":"+46050101010","response":"TZ_NUM_ANSWER","tzid":10000,"time":281,"form":"index"}