openapi: 3.1.0
x-stoplight:
  id: m9c13yrm4apo7
info:
  title: Onlinesim API
  version: '1.1'
  x-locales:
    en: English
    ru: Русский
  x-description-ru: |-
    ## Общее описание



    Это API позволит Вам получить доступ ко всем услугам, предоставляемым Onlinesim:
    - прием SMS от одного конкретного сервиса на виртуальный номер;
    - аренда виртуального номера для получения SMS от нескольких различных отправителей в течение длительного времени;
    - Вы также можете воспользоваться нашими бесплатными номерами, для тестирования функционала сервиса перед покупкой.



    >**Это API доступно только для зарегистрированных пользователей Onlinesim!**
    >
    > Вам необходимо иметь зарегистрированную учетную запись, чтобы получить доступ к этому API. В этой документации мы будем использовать авторизацию по API ключу для простоты, однако помимо этого доступны и другие методы (более подробно о доступных способах авторизации можно узнать в разделе [Авторизация](/ru/openapi_docs/Onlinesim-API-UN/auth)).
    >
    >**Прием сообщений от платежных систем, банков и других кредитных организаций недоступен на нашей платформе. Для получения более подробной информации, в том числе о перечне таких сервисов, пожалуйста, ознакомьтесь с [Публичной офертой](https://onlinesim.io/ru/documentation/offer).**

    ### Список API запросов
    Запросы различаются в зависимости от вида услуги и разбиты по соответствующим подразделам:

    #### Раздел "Профиль"
    Данные запросы относятся либо к профилю клиента, либо ко всем предоставляемым Onlinesim услугам одновременно:
    - [getBalance](/ru/openapi_docs/Onlinesim-API-UN/get/api_getBalance_php) - возвращает текущий доступный баланс Вашего профиля, замороженный баланс (зарезервированные средства для активных операций, которые вернутся при их отмене) и информацию о доходе по реферальной программе.
    - [webhook](/ru/openapi_docs/Onlinesim-API-UN/post/newSms) - позволяет Вам установить URI, на который будут пересылаться все сообщения с Ваших активных операций . Это касается как SMS с услуги "Прием SMS", так и с "Аренда номера".

    #### Раздел "Прием SMS"
    Позволяет получить номер для приёма неограниченного количества SMS от одного выбранного сервиса в течение короткого промежутка времени (для большинства сервисов — 15 минут).
    Пожалуйста, обратите внимание, что Вы не можете менять сервис во время операции. Для приема SMS от разных сервисов, Вам необходимо будет заказать новые номера с соответствующими параметрами.
    - [getTariffs](/ru/openapi_docs/Onlinesim-API-UN/get/api_getTariffs_php) - запрашивает количество доступных номеров, сгруппированных по странам и сервисам (если такие указаны в запросе);
    - [getNum](/ru/openapi_docs/Onlinesim-API-UN/get/api_getNum_php) - заказывает номер выбранной страны для приема SMS от указанного сервиса;
    - [getState](/ru/openapi_docs/Onlinesim-API-UN/get/api_getState_php) - возвращает подробную информацию обо всех активных номерах Вашего профиля (включая полученные ими SMS-сообщения);
    - [setOperationRevise](/ru/openapi_docs/Onlinesim-API-UN/get/api_setOperationRevise_php) - запрашивает следующее полученное этим номером SMS-сообщение из очереди, если первое не содержало необходимый код и/или нужную информацию.
    - [setOperationOk](/ru/openapi_docs/Onlinesim-API-UN/get/api_setOperationOk_php) - меняет статус операции на успешно выполненную и закрывает её.

    #### Раздел "Аренда"
    Эта услуга предполагает, что номер будет использоваться для приема SMS от множества различных отправителей (включая SMS с других мобильных номеров), за исключением запрещенных.

    - [tariffsRent](/ru/openapi_docs/Onlinesim-API-UN/get/api_rent_tariffsRent_php) - запрашивает список стран с подробной информацией о тарифах арендны;
    - [getRentNum](/ru/openapi_docs/Onlinesim-API-UN/get/api_rent_getRentNum_php) - заказывает в аренду номер выбранной страны на указанный срок;
    - [getRentState](/ru/openapi_docs/Onlinesim-API-UN/get/api_rent_getRentState_php) - возвращает список номеров Вашего профиля с активной арендой и полученными ими сообщениями;
    - [extendRentState](/ru/openapi_docs/Onlinesim-API-UN/get/api_rent_extendRentState_php) - продляет аренду выбранного номера;
    - [closeRentNum](/ru/openapi_docs/Onlinesim-API-UN/get/api_rent_closeRentNum_php) - закрывает операцию аренды.

    #### Раздел "Бесплатные номера"
    Данное API предоставляет доступ к функционалу по использованию бесплатных номеров Onlinesim, которые можно найти на
    главной странице сайта.

    Вы можете использовать бесплатные номера для тестирования предоставляемых нами услуг, однако просим Вас учесть, что
    количество доступных стран и номеров ограничено. Также стоит отметить, что сообщения, полученные на бесплатные номера, не являются приватными, они отображаются в соответствующем виджете на главной странице и доступны другим пользователям сайта.

    В этом API доступен один универсальный запрос, который позволяет Вам получить доступ ко всей необходимой информации для использования бесплатных номеров:
    - [getFreeList](/ru/openapi_docs/Onlinesim-API-UN/get/api_getFreeList) - возвращает подробную информацию о списке доступных стран, бесплатных номеров и сообщений, которые они приняли.

    Коллекция запросов для Postman доступна здесь:

    [<img src="https://run.pstmn.io/button.svg" alt="Run In Postman" style="width: 128px; height: 32px;">](https://god.gw.postman.com/run-collection/283141-f610f828-4b8b-4d2b-98b2-4ed7ac4d1cd1?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D283141-f610f828-4b8b-4d2b-98b2-4ed7ac4d1cd1%26entityType%3Dcollection%26workspaceId%3Dc34edf2d-2fc9-4961-9df0-fbc231bd016f#?env%5Benv%5D=W3sia2V5IjoiYmFzZVVybCIsInZhbHVlIjoiaHR0cHM6Ly9vbmxpbmVzaW0uaW8vYXBpIiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6ImRlZmF1bHQiLCJkZXNjcmlwdGlvbiI6ImJhc2VVcmwg4oCUIHByaW1hcnkgYmFzZSBVUkwgZm9yIEFQSSByZXF1ZXN0cyAoZS5nLiwgXG5odHRwczovL2FwaS5leGFtcGxlLmNvbVxuKS4gVXNlZCBhcyB7e2Jhc2VVcmx9fSBpbiByZXF1ZXN0IFVSTHMuIiwic2Vzc2lvblZhbHVlIjoiaHR0cHM6Ly9vbmxpbmVzaW0uaW8vYXBpIiwiY29tcGxldGVTZXNzaW9uVmFsdWUiOiJodHRwczovL29ubGluZXNpbS5pby9hcGkiLCJzZXNzaW9uSW5kZXgiOjB9LHsia2V5IjoiYWx0QmFzZVVybCIsInZhbHVlIjoiaHR0cHM6Ly9vbmxpbmVzaW0uaW8vYXBpIiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6ImRlZmF1bHQiLCJkZXNjcmlwdGlvbiI6ImFsdEJhc2VVcmwg4oCUIGFsdGVybmF0ZSBiYXNlIFVSTCAoZm9yIHN0YWdpbmcsIGZhbGxiYWNrLCBvciBzZWNvbmRhcnkgaG9zdCkuIFVzZWQgYXMge3thbHRCYXNlVXJsfX0uIiwic2Vzc2lvblZhbHVlIjoiaHR0cHM6Ly9vbmxpbmVzaW0uaW8vYXBpIiwiY29tcGxldGVTZXNzaW9uVmFsdWUiOiJodHRwczovL29ubGluZXNpbS5pby9hcGkiLCJzZXNzaW9uSW5kZXgiOjF9LHsia2V5IjoiYXBpa2V5IiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlLCJ0eXBlIjoiZGVmYXVsdCIsImRlc2NyaXB0aW9uIjoiYXBpa2V5IOKAlCBBUEkga2V5IHZhbHVlICh3b3Jrc3BhY2UvZ2xvYmFsLWxldmVsIGtleSkuIE1heSBiZSB1c2VkIGluIGhlYWRlcnMgb3IgcXVlcnkgcGFyYW1zIGFzIHt7YXBpa2V5fX0uIiwic2Vzc2lvblZhbHVlIjoiIiwiY29tcGxldGVTZXNzaW9uVmFsdWUiOiIiLCJzZXNzaW9uSW5kZXgiOjJ9LHsia2V5IjoiYXBpX2tleSIsInZhbHVlIjoie3thcGlrZXl9fSIsImVuYWJsZWQiOnRydWUsInR5cGUiOiJkZWZhdWx0IiwiZGVzY3JpcHRpb24iOiJhcGlfa2V5IOKAlCBkdXBsaWNhdGUgb3IgYWx0ZXJuYXRlIEFQSSBrZXkgdmFyaWFibGUgKHNvbWUgcmVxdWVzdHMgZXhwZWN0IGFwaV9rZXkgaW5zdGVhZCBvZiBhcGlrZXkpLiBVc2UgYWNjb3JkaW5nbHkuIiwic2Vzc2lvblZhbHVlIjoie3thcGlrZXl9fSIsImNvbXBsZXRlU2Vzc2lvblZhbHVlIjoie3thcGlrZXl9fSIsInNlc3Npb25JbmRleCI6M30seyJrZXkiOiJjb3VudHJ5IiwidmFsdWUiOiIxIiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6ImRlZmF1bHQiLCJkZXNjcmlwdGlvbiI6ImNvdW50cnkg4oCUIGNvdW50cnkgY29kZSBvciBuYW1lIHVzZWQgYnkgcmVxdWVzdHMgKGUuZy4sIFwiMVwiIG9yIFwiNzdcIikuIFJlZmVyZW5jZWQgYXMge3tjb3VudHJ5fX0uIiwic2Vzc2lvblZhbHVlIjoiMSIsImNvbXBsZXRlU2Vzc2lvblZhbHVlIjoiMSIsInNlc3Npb25JbmRleCI6NH0seyJrZXkiOiJjb3VudHJ5SWQiLCJ2YWx1ZSI6Int7Y291bnRyeX19IiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6ImRlZmF1bHQiLCJkZXNjcmlwdGlvbiI6ImNvdW50cnlJZCDigJQgbnVtZXJpYyBvciBzdHJpbmcgaWRlbnRpZmllciBmb3IgY291bnRyeSBpbiB0aGUgQVBJIChlLmcuLCAxLCA2NDMpLiBVc2VkIGFzIHt7Y291bnRyeUlkfX0uIiwic2Vzc2lvblZhbHVlIjoie3tjb3VudHJ5fX0iLCJjb21wbGV0ZVNlc3Npb25WYWx1ZSI6Int7Y291bnRyeX19Iiwic2Vzc2lvbkluZGV4Ijo1fSx7ImtleSI6InNlcnZpY2UiLCJ2YWx1ZSI6Imdvb2dsZSIsImVuYWJsZWQiOnRydWUsInR5cGUiOiJkZWZhdWx0IiwiZGVzY3JpcHRpb24iOiJzZXJ2aWNlIOKAlCBzZXJ2aWNlIGlkZW50aWZpZXIgb3IgbmFtZSAod2hpY2ggc2VydmljZS90eXBlIHRvIHJlcXVlc3QpLiBVc2VkIGFzIHt7c2VydmljZX19LiIsInNlc3Npb25WYWx1ZSI6Imdvb2dsZSIsImNvbXBsZXRlU2Vzc2lvblZhbHVlIjoiZ29vZ2xlIiwic2Vzc2lvbkluZGV4Ijo2fSx7ImtleSI6InR6aWQiLCJ2YWx1ZSI6IjEiLCJlbmFibGVkIjp0cnVlLCJ0eXBlIjoiZGVmYXVsdCIsImRlc2NyaXB0aW9uIjoidHppZCDigJQgdGltZXpvbmUgaWRlbnRpZmllciB1c2VkIGluIHJlcXVlc3RzIChmb3Igc2NoZWR1bGVkIG9wZXJhdGlvbnMgb3IgdGltZXN0YW1wcykuIFJlZmVyZW5jZWQgYXMge3t0emlkfX0uIiwic2Vzc2lvblZhbHVlIjoiMSIsImNvbXBsZXRlU2Vzc2lvblZhbHVlIjoiMSIsInNlc3Npb25JbmRleCI6N30seyJrZXkiOiJvcGVyYXRpb25JZCIsInZhbHVlIjoie3t0emlkfX0iLCJlbmFibGVkIjp0cnVlLCJ0eXBlIjoiZGVmYXVsdCIsImRlc2NyaXB0aW9uIjoib3BlcmF0aW9uSWQg4oCUIG9wZXJhdGlvbiBpZGVudGlmaWVyIGZvciBzcGVjaWZpYyBBUEkgYWN0aW9ucyAodXNlZCBpbiBVUkxzIG9yIGJvZGllcykuIFJlZmVyZW5jZWQgYXMge3tvcGVyYXRpb25JZH19LiIsInNlc3Npb25WYWx1ZSI6Int7dHppZH19IiwiY29tcGxldGVTZXNzaW9uVmFsdWUiOiJ7e3R6aWR9fSIsInNlc3Npb25JbmRleCI6OH0seyJrZXkiOiJkYXlzIiwidmFsdWUiOiI3IiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6ImRlZmF1bHQiLCJkZXNjcmlwdGlvbiI6ImRheXMg4oCUIG51bWVyaWMgb3Igc3RyaW5nIHZhbHVlIHJlcHJlc2VudGluZyBudW1iZXIgb2YgZGF5cyAodXNlZCBhcyBwYXJhbWV0ZXIgZm9yIHF1ZXJpZXMpLiBSZWZlcmVuY2VkIGFzIHt7ZGF5c319LiIsInNlc3Npb25WYWx1ZSI6IjciLCJjb21wbGV0ZVNlc3Npb25WYWx1ZSI6IjciLCJzZXNzaW9uSW5kZXgiOjl9LHsia2V5IjoiaG91cnMiLCJ2YWx1ZSI6IjI0IiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6ImRlZmF1bHQiLCJkZXNjcmlwdGlvbiI6ImhvdXJzIOKAlCBudW1lcmljIG9yIHN0cmluZyB2YWx1ZSByZXByZXNlbnRpbmcgbnVtYmVyIG9mIGhvdXJzICh1c2VkIGluIHRpbWUtd2luZG93IHBhcmFtZXRlcnMpLiBSZWZlcmVuY2VkIGFzIHt7aG91cnN9fS4iLCJzZXNzaW9uVmFsdWUiOiIyNCIsImNvbXBsZXRlU2Vzc2lvblZhbHVlIjoiMjQiLCJzZXNzaW9uSW5kZXgiOjEwfSx7ImtleSI6InlvdXJVUkwiLCJ2YWx1ZSI6Imh0dHBzOi8vZXhhbXBsZS5jb20vd2ViaG9vayIsImVuYWJsZWQiOnRydWUsInR5cGUiOiJkZWZhdWx0IiwiZGVzY3JpcHRpb24iOiJ5b3VyVVJMIOKAlCB1c2VyLXByb3ZpZGVkIGNhbGxiYWNrIG9yIHJlZGlyZWN0IFVSTCB1c2VkIGJ5IHNvbWUgZW5kcG9pbnRzLiBSZWZlcmVuY2VkIGFzIHt7eW91clVSTH19LiIsInNlc3Npb25WYWx1ZSI6Imh0dHBzOi8vZXhhbXBsZS5jb20vd2ViaG9vayIsImNvbXBsZXRlU2Vzc2lvblZhbHVlIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS93ZWJob29rIiwic2Vzc2lvbkluZGV4IjoxMX1d)

    [Документация в Postman](https://documenter.getpostman.com/view/283141/2sB3dSRUqx)

    Каждый запрос содержит свое описание, тип, URL эндпойнта, параметры, примеры тела запроса и ответа. В описании отдельных запросов также может быть указан список специфичных ошибок, получаемых в виде ответа, которые могут появиться при вызове этих методов.
    Ответы представлены в JSON или TXT формате в зависимости от вызванного метода и результатов.

    ## Обработка исключений


    | Ответ сервера         | Описание                                                                        |
    |-----------------------|---------------------------------------------------------------------------------|
    | `ACCOUNT_BLOCKED`     | Аккаунт заблокирован                                                            |
    | `ERROR_WRONG_KEY`     | Некорректный API ключ                                                           |
    | `ERROR_NO_KEY`        | API ключ отсутствует                                                            |
    | `ERROR_NO_SERVICE`    | Название сервиса некорректное или отсутствует                                   |
    | `REQUEST_NOT_FOUND`   | Имя вызываемого метода некорректное или отсутствует                             |
    | `API_ACCESS_DISABLED` | Доступ к API отключен в настройках профиля                                      |
    | `API_ACCESS_IP`       | Разрешение на доступ к API с текущего IP-адреса отсутствует в настройках профиля|
    | `WARNING_LOW_BALANCE` | Недостаточно средств на балансе                                                 |
  description: |-
    ## General description



    This API will allow you to access all services provided by Onlinesim:
    - SMS receiving from a single specific service on a virtual number;
    - rent a number to receive SMS from multiple different senders (apps/websites/mobile numbers);
    - you can also use our free numbers to test the service before the purchase.



    >**This API is available for registered Onlinesim users only!**
    >
    > You need to have Onlinesim profile to be able to access this API. Several methods of authentication are available ([Authentication](/openapi_docs/Onlinesim-API-UN/auth)), but we will use API key authentication in this documentation for reasons of simplicity.
    >
    >**Receiving messages from payment services, banks, and other financial institutions is not available on our platform. For more detailed information, including a list of such services, please refer to the [Public Offer](https://onlinesim.io/documentation/offer).**


    ### List of API requests
    Requests are specific for each service provided by Onlinesim and allocated in corresponding sections:

    #### Profile section
    These requests are related to the profile or all the services provided by Onlinesim:
    - [getBalance](/openapi_docs/Onlinesim-API-UN/get/api_getBalance_php) - returns the current available balance of your profile, the frozen balance (the funds reserved for active operations, which will be returned if those operations are cancelled), and information about your referral program income.
    - [webhook](/openapi_docs/Onlinesim-API-UN/post/newSms) - allows you to set a URI to which all the messages from your active operations will be forwarded to. This includes messages from both single-service and long term rental.

    #### Single-service activations section
    Allows you to order a number to receive an unlimited number of SMS from a single service within a short time window (15 minutes for most of the services). Please note that you cannot change the service during the operation. To receive SMS from different services, you will need to order new numbers with the appropriate parameters.
    - [getTariffs](/openapi_docs/Onlinesim-API-UN/get/api_getTariffs_php) - returns a quantity of available numbers for each service and country (if specified);
    - [getNum](/openapi_docs/Onlinesim-API-UN/get/api_getNum_php) - orders a number for a particular service, allowing to receive SMS messages from it;
    - [getState](/openapi_docs/Onlinesim-API-UN/get/api_getState_php) - returns detailed information on all active numbers of the profile (including received messages);
    - [setOperationRevise](/openapi_docs/Onlinesim-API-UN/get/api_setOperationRevise_php) - requests next received by the specified number SMS from the queue, if first one didn't have the right code and/or expected information;
    - [setOperationOk](/openapi_docs/Onlinesim-API-UN/get/api_setOperationOk_php) - sets operation status as successful and closes the operation.

    #### Rent section
    This service implies that the number will be used to receive SMS from multiple different senders (including SMS from other mobile numbers), except for those that are prohibited.

    - [tariffsRent](/openapi_docs/Onlinesim-API-UN/get/api_rent_tariffsRent_php) - returns a list of countries with detailed information on rental plans;
    - [getRentNum](/openapi_docs/Onlinesim-API-UN/get/api_rent_getRentNum_php) - orders a number of a chosen country for rent for a certain period;
    - [getRentState](/openapi_docs/Onlinesim-API-UN/get/api_rent_getRentState_php) - returns a list of numbers of your profile with current active rent and received messages;
    - [extendRentState](/openapi_docs/Onlinesim-API-UN/get/api_rent_extendRentState_php) - extends the rent of a given number;
    - [closeRentNum](/openapi_docs/Onlinesim-API-UN/get/api_rent_closeRentNum_php) - closes the rental number.

    #### Free numbers
    This API allows you to access the functions to use free Onlinesim numbers available on the home page of our website.

    You can use these numbers for testing, but please note that the quantity of available numbers as well as list of available
    countries are limited. It is also worth noting that messages received on free numbers are not private — they are displayed in the corresponding widget on the main page and are accessible to other users of the site.

    There is one general request that allows you to access free numbers:
    - [getFreeList](/openapi_docs/Onlinesim-API-UN/get/api_getFreeList) - returns detailed information on available list of countries, free numbers and messages they've received.

    Postman collection available here:

    [<img src="https://run.pstmn.io/button.svg" alt="Run In Postman" style="width: 128px; height: 32px;">](https://god.gw.postman.com/run-collection/283141-f610f828-4b8b-4d2b-98b2-4ed7ac4d1cd1?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D283141-f610f828-4b8b-4d2b-98b2-4ed7ac4d1cd1%26entityType%3Dcollection%26workspaceId%3Dc34edf2d-2fc9-4961-9df0-fbc231bd016f#?env%5Benv%5D=W3sia2V5IjoiYmFzZVVybCIsInZhbHVlIjoiaHR0cHM6Ly9vbmxpbmVzaW0uaW8vYXBpIiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6ImRlZmF1bHQiLCJkZXNjcmlwdGlvbiI6ImJhc2VVcmwg4oCUIHByaW1hcnkgYmFzZSBVUkwgZm9yIEFQSSByZXF1ZXN0cyAoZS5nLiwgXG5odHRwczovL2FwaS5leGFtcGxlLmNvbVxuKS4gVXNlZCBhcyB7e2Jhc2VVcmx9fSBpbiByZXF1ZXN0IFVSTHMuIiwic2Vzc2lvblZhbHVlIjoiaHR0cHM6Ly9vbmxpbmVzaW0uaW8vYXBpIiwiY29tcGxldGVTZXNzaW9uVmFsdWUiOiJodHRwczovL29ubGluZXNpbS5pby9hcGkiLCJzZXNzaW9uSW5kZXgiOjB9LHsia2V5IjoiYWx0QmFzZVVybCIsInZhbHVlIjoiaHR0cHM6Ly9vbmxpbmVzaW0uaW8vYXBpIiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6ImRlZmF1bHQiLCJkZXNjcmlwdGlvbiI6ImFsdEJhc2VVcmwg4oCUIGFsdGVybmF0ZSBiYXNlIFVSTCAoZm9yIHN0YWdpbmcsIGZhbGxiYWNrLCBvciBzZWNvbmRhcnkgaG9zdCkuIFVzZWQgYXMge3thbHRCYXNlVXJsfX0uIiwic2Vzc2lvblZhbHVlIjoiaHR0cHM6Ly9vbmxpbmVzaW0uaW8vYXBpIiwiY29tcGxldGVTZXNzaW9uVmFsdWUiOiJodHRwczovL29ubGluZXNpbS5pby9hcGkiLCJzZXNzaW9uSW5kZXgiOjF9LHsia2V5IjoiYXBpa2V5IiwidmFsdWUiOiIiLCJlbmFibGVkIjp0cnVlLCJ0eXBlIjoiZGVmYXVsdCIsImRlc2NyaXB0aW9uIjoiYXBpa2V5IOKAlCBBUEkga2V5IHZhbHVlICh3b3Jrc3BhY2UvZ2xvYmFsLWxldmVsIGtleSkuIE1heSBiZSB1c2VkIGluIGhlYWRlcnMgb3IgcXVlcnkgcGFyYW1zIGFzIHt7YXBpa2V5fX0uIiwic2Vzc2lvblZhbHVlIjoiIiwiY29tcGxldGVTZXNzaW9uVmFsdWUiOiIiLCJzZXNzaW9uSW5kZXgiOjJ9LHsia2V5IjoiYXBpX2tleSIsInZhbHVlIjoie3thcGlrZXl9fSIsImVuYWJsZWQiOnRydWUsInR5cGUiOiJkZWZhdWx0IiwiZGVzY3JpcHRpb24iOiJhcGlfa2V5IOKAlCBkdXBsaWNhdGUgb3IgYWx0ZXJuYXRlIEFQSSBrZXkgdmFyaWFibGUgKHNvbWUgcmVxdWVzdHMgZXhwZWN0IGFwaV9rZXkgaW5zdGVhZCBvZiBhcGlrZXkpLiBVc2UgYWNjb3JkaW5nbHkuIiwic2Vzc2lvblZhbHVlIjoie3thcGlrZXl9fSIsImNvbXBsZXRlU2Vzc2lvblZhbHVlIjoie3thcGlrZXl9fSIsInNlc3Npb25JbmRleCI6M30seyJrZXkiOiJjb3VudHJ5IiwidmFsdWUiOiIxIiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6ImRlZmF1bHQiLCJkZXNjcmlwdGlvbiI6ImNvdW50cnkg4oCUIGNvdW50cnkgY29kZSBvciBuYW1lIHVzZWQgYnkgcmVxdWVzdHMgKGUuZy4sIFwiMVwiIG9yIFwiNzdcIikuIFJlZmVyZW5jZWQgYXMge3tjb3VudHJ5fX0uIiwic2Vzc2lvblZhbHVlIjoiMSIsImNvbXBsZXRlU2Vzc2lvblZhbHVlIjoiMSIsInNlc3Npb25JbmRleCI6NH0seyJrZXkiOiJjb3VudHJ5SWQiLCJ2YWx1ZSI6Int7Y291bnRyeX19IiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6ImRlZmF1bHQiLCJkZXNjcmlwdGlvbiI6ImNvdW50cnlJZCDigJQgbnVtZXJpYyBvciBzdHJpbmcgaWRlbnRpZmllciBmb3IgY291bnRyeSBpbiB0aGUgQVBJIChlLmcuLCAxLCA2NDMpLiBVc2VkIGFzIHt7Y291bnRyeUlkfX0uIiwic2Vzc2lvblZhbHVlIjoie3tjb3VudHJ5fX0iLCJjb21wbGV0ZVNlc3Npb25WYWx1ZSI6Int7Y291bnRyeX19Iiwic2Vzc2lvbkluZGV4Ijo1fSx7ImtleSI6InNlcnZpY2UiLCJ2YWx1ZSI6Imdvb2dsZSIsImVuYWJsZWQiOnRydWUsInR5cGUiOiJkZWZhdWx0IiwiZGVzY3JpcHRpb24iOiJzZXJ2aWNlIOKAlCBzZXJ2aWNlIGlkZW50aWZpZXIgb3IgbmFtZSAod2hpY2ggc2VydmljZS90eXBlIHRvIHJlcXVlc3QpLiBVc2VkIGFzIHt7c2VydmljZX19LiIsInNlc3Npb25WYWx1ZSI6Imdvb2dsZSIsImNvbXBsZXRlU2Vzc2lvblZhbHVlIjoiZ29vZ2xlIiwic2Vzc2lvbkluZGV4Ijo2fSx7ImtleSI6InR6aWQiLCJ2YWx1ZSI6IjEiLCJlbmFibGVkIjp0cnVlLCJ0eXBlIjoiZGVmYXVsdCIsImRlc2NyaXB0aW9uIjoidHppZCDigJQgdGltZXpvbmUgaWRlbnRpZmllciB1c2VkIGluIHJlcXVlc3RzIChmb3Igc2NoZWR1bGVkIG9wZXJhdGlvbnMgb3IgdGltZXN0YW1wcykuIFJlZmVyZW5jZWQgYXMge3t0emlkfX0uIiwic2Vzc2lvblZhbHVlIjoiMSIsImNvbXBsZXRlU2Vzc2lvblZhbHVlIjoiMSIsInNlc3Npb25JbmRleCI6N30seyJrZXkiOiJvcGVyYXRpb25JZCIsInZhbHVlIjoie3t0emlkfX0iLCJlbmFibGVkIjp0cnVlLCJ0eXBlIjoiZGVmYXVsdCIsImRlc2NyaXB0aW9uIjoib3BlcmF0aW9uSWQg4oCUIG9wZXJhdGlvbiBpZGVudGlmaWVyIGZvciBzcGVjaWZpYyBBUEkgYWN0aW9ucyAodXNlZCBpbiBVUkxzIG9yIGJvZGllcykuIFJlZmVyZW5jZWQgYXMge3tvcGVyYXRpb25JZH19LiIsInNlc3Npb25WYWx1ZSI6Int7dHppZH19IiwiY29tcGxldGVTZXNzaW9uVmFsdWUiOiJ7e3R6aWR9fSIsInNlc3Npb25JbmRleCI6OH0seyJrZXkiOiJkYXlzIiwidmFsdWUiOiI3IiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6ImRlZmF1bHQiLCJkZXNjcmlwdGlvbiI6ImRheXMg4oCUIG51bWVyaWMgb3Igc3RyaW5nIHZhbHVlIHJlcHJlc2VudGluZyBudW1iZXIgb2YgZGF5cyAodXNlZCBhcyBwYXJhbWV0ZXIgZm9yIHF1ZXJpZXMpLiBSZWZlcmVuY2VkIGFzIHt7ZGF5c319LiIsInNlc3Npb25WYWx1ZSI6IjciLCJjb21wbGV0ZVNlc3Npb25WYWx1ZSI6IjciLCJzZXNzaW9uSW5kZXgiOjl9LHsia2V5IjoiaG91cnMiLCJ2YWx1ZSI6IjI0IiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6ImRlZmF1bHQiLCJkZXNjcmlwdGlvbiI6ImhvdXJzIOKAlCBudW1lcmljIG9yIHN0cmluZyB2YWx1ZSByZXByZXNlbnRpbmcgbnVtYmVyIG9mIGhvdXJzICh1c2VkIGluIHRpbWUtd2luZG93IHBhcmFtZXRlcnMpLiBSZWZlcmVuY2VkIGFzIHt7aG91cnN9fS4iLCJzZXNzaW9uVmFsdWUiOiIyNCIsImNvbXBsZXRlU2Vzc2lvblZhbHVlIjoiMjQiLCJzZXNzaW9uSW5kZXgiOjEwfSx7ImtleSI6InlvdXJVUkwiLCJ2YWx1ZSI6Imh0dHBzOi8vZXhhbXBsZS5jb20vd2ViaG9vayIsImVuYWJsZWQiOnRydWUsInR5cGUiOiJkZWZhdWx0IiwiZGVzY3JpcHRpb24iOiJ5b3VyVVJMIOKAlCB1c2VyLXByb3ZpZGVkIGNhbGxiYWNrIG9yIHJlZGlyZWN0IFVSTCB1c2VkIGJ5IHNvbWUgZW5kcG9pbnRzLiBSZWZlcmVuY2VkIGFzIHt7eW91clVSTH19LiIsInNlc3Npb25WYWx1ZSI6Imh0dHBzOi8vZXhhbXBsZS5jb20vd2ViaG9vayIsImNvbXBsZXRlU2Vzc2lvblZhbHVlIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS93ZWJob29rIiwic2Vzc2lvbkluZGV4IjoxMX1d)

    [Postman documentation](https://documenter.getpostman.com/view/283141/2sB3dSRUqx)

    Each request has its own description, type, endpoint's URL, parameters, request and response schemas. Some responses can have examples of specific errors that might appear.
    Responses are represented in JSON or TXT format based on method called and results.

    ## Common exceptions


    | Result               | Description                                            |
    |----------------------|--------------------------------------------------------|
    | `ACCOUNT_BLOCKED`    | Account has been banned                                |
    | `ERROR_WRONG_KEY`    | API key is invalid or incorrect                        |
    | `ERROR_NO_KEY`       | API key is missing                                     |
    | `ERROR_NO_SERVICE`   | Service name is invalid or missing                     |
    | `REQUEST_NOT_FOUND`  | Method called is invalid or missing                    |
    | `API_ACCESS_DISABLED`| API disabled                                           |
    | `API_ACCESS_IP`      | Access from this IP-address is disabled in the profile |
    | `WARNING_LOW_BALANCE`| Not enough funds to buy the service                    |
  contact:
    name: Artem
    url: 'https://onlinesim.io'
    email: support@onlinesim.io
  termsOfService: 'https://onlinesim.io/documentation/offer'
  license:
    name: 'GNU General Public License, version 3.0'
    url: 'https://www.gnu.org/licenses/gpl-3.0.en.html'
servers:
  - url: 'https://onlinesim.io'
    x-description-ru: Сервер Onlinesim
    description: Onlinesim server
webhooks:
  /newSms:
    get:
      summary: Webhook
      servers:
        - url: 'https://{yourserver.com}'
      x-description-ru: |-
        Мы добавили возможность пересылки SMS на Ваш сервер!
        Вы можете установить URL для отправки в [настройках](https://onlinesim.io/v2/ru/profile/api) Вашего профиля и как только SMS поступит на любой из заказанных Вами номеров, мы отправим его Вам.


        Это работает как для приема, так и для долгосрочной аренды!



        ![Вебхук](https://onlinesim.io/assets/schemes/Webhook(RU).png)



        Схема тела запроса, который будет содержать сообщения описана ниже, в разделе "Ответы".
      description: |-
        We've added a webhook feature for you!
        You can set a URL in your profile [settings](https://onlinesim.io/v2/profile/api) and as soon as we get SMS for any number that you've ordered, it will be forwarded to you.


        This works for both single-service activations and long term rental!



        ![Webhook](https://onlinesim.io/assets/schemes/Webhook(EN).png)



        The schema of the payload is described in the response section.
      operationId: get-v2-profile-api
      responses:
        '200':
          description: Successful request example
          content:
            application/json:
              schema:
                type: object
                properties:
                  user_id:
                    type: string
                    x-description-ru: ID Вашего профиля
                    description: Your Profile's ID
                  country_code:
                    type: string
                    x-description-ru: 'Международный телефонный код страны, которой принадлежит номер, получивший SMS'
                    description: 'International dialing code of the country of the number, that has received SMS'
                  number:
                    type: string
                    x-description-ru: Номер телефона в международном формате
                    description: Phone number in international format
                  sender:
                    type: string
                    x-description-ru: Имя или номер отправителя
                    description: Sender's name or phone number
                  message:
                    type: string
                    x-description-ru: Текст SMS
                    description: SMS context
                  time_start:
                    type: string
                    x-description-ru: Дата и время начала операции
                    description: Date and time when operation was ordered
                  time_left:
                    type: string
                    x-description-ru: Оставшееся время для операции
                    description: Remaining time for the operation
                  operation_id:
                    type: string
                    x-description-ru: ID операции
                    description: Operation ID
                  webhook_type:
                    enum:
                      - receiving_sms
                      - rent_sms
                    x-description-ru: Тип услуги (прием или аренда)
                    description: Type of service (single service activations or rent)
                  code:
                    type: string
                    x-description-ru: SMS ID
                    description: SMS ID
                x-examples:
                  Example 1:
                    user_id: '204355'
                    country_code: '7'
                    number: '+79918397701'
                    sender: OKru
                    message: текст смс
                    time_start: '2023-04-26 12:37:55'
                    time_left: '880'
                    operation_id: '91763432'
                    webhook_type: receiving_sms
                    code: '612045'
      security:
        - OAuth2:
            - sms-scope
            - rent-scope
        - apikey: []
        - BearerAuth: []
paths:
  /api/getTariffs.php:
    get:
      summary: getTariffs
      x-description-ru: |
        Этот запрос позволяет получить информацию о тарифах на услугу "Прием SMS".



        По своей сути является репрезентацией списка сервисов (блока "Купить номер"), расположенного в личном кабинете.



        ![Список сервисов](https://onlinesim.io/assets/schemes/NumberList(RU).png)
      description: |
        This request will provide you Onlinesim tariff list for single-service activations.



        It is actually a representation of a service list ("Buy a number" section) located in the user dashboard.



        ![Service list](https://onlinesim.io/assets/schemes/NumberList(EN).png)
      operationId: get-api-getTariffs.php
      parameters:
        - name: locale_price
          in: query
          x-description-ru: Стоимость услуги в валюте Вашего баланса (по умолчанию USD)
          description: Price charged for the service in the currency of your profile (USD by default)
          schema:
            type: string
        - name: country
          in: query
          x-description-ru: Страна, по которой Вы хотели бы получить данные о тарифах на услугу "Прием SMS"
          description: Country for which you want to get a tariff list for single-service activations
          schema:
            type: string
        - name: filter_country
          in: query
          x-description-ru: Фильтр для стран
          description: Filter for country
          schema:
            type: string
        - name: filter_service
          in: query
          x-description-ru: Фильтр для сервисов
          description: Filter for service
          schema:
            type: string
        - name: count
          in: query
          x-description-ru: Фильтр для количества
          description: Filter for count
          schema:
            type: string
        - name: page
          in: query
          x-description-ru: Страница списка тарифов (навигация через пагинацию)
          description: Page of the tariff list (pagination navigation)
          schema:
            type: string
        - $ref: '#/components/parameters/lang'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  response:
                    x-description-ru: '1, если запрос был выполнен успешно, либо выведет сообщение об ошибке'
                    description: '1, if the request has been completed successfully, or an error message'
                    oneOf:
                      - type: integer
                      - type: string
                    example: 1
                  countries:
                    type: object
                    properties:
                      country_code:
                        type: object
                        properties:
                          name:
                            type: string
                            x-description-ru: Название страны
                            description: Country name
                          original:
                            type: string
                            x-description-ru: Название страны (необходимо при заказе номера)
                            description: Country name (required upon ordering a number)
                          code:
                            type: integer
                            x-description-ru: Международный телефонный код страны
                            description: International dialing code of the country
                          pos:
                            type: integer
                            x-description-ru: Позиция страны в списке в личном кабинете (по умолчанию)
                            description: Country position in the list in the user dashboard (by default)
                          other:
                            type: boolean
                            x-description-ru: Доступность сервиса "Другие сайты" для этой страны (если `false` - сервис отсутствует)
                            description: '"Other sites" service availability for this country (if `false` the service is unavailable)'
                          new:
                            type: boolean
                            x-description-ru: Недавно добавленная страна (да/нет)
                            description: Recently added country (true/false)
                          enable:
                            type: boolean
                            x-description-ru: Доступность страны для заказа (доступна/недоступна)
                            description: Availability for order for this country (available/unavailable)
                  services:
                    type: object
                    properties:
                      service_name:
                        type: object
                        x-description-ru: Название сервиса
                        description: Service name
                        properties:
                          id:
                            type: integer
                            x-description-ru: ID сервиса (место сервиса в списке по умолчанию)
                            description: Service ID (service position by default)
                          count:
                            type: integer
                            x-description-ru: Количество доступных номеров для данного сервиса
                            description: Amount of available numbers for this service
                          price:
                            type: string
                            x-description-ru: Цена сервиса
                            description: Service price
                          service:
                            type: string
                            x-description-ru: Полное название сервиса
                            description: Full service name
                          slug:
                            type: string
                            x-description-ru: Короткое название сервиса (необходимо для заказа номера)
                            description: Short service name (required upon ordering a number)
                  favorite_countries:
                    type: object
                    x-description-ru: Список избранных стран (добавить страну в избранное можно в личном кабинете нажатием на иконку пина в списке стран)
                    description: List of favorite countries (country can be added to your favorites in the user dashboard by clicking pin icon in the country list)
                  favorite_services:
                    type: array
                    items:
                      type: object
                      x-description-ru: Список любимых сервисов (добавить сервис в избранное можно в личном кабинете нажатием на иконку пина в списке сервисов)
                      description: List of favorite services (service can be added to your favorites in the user dashboard by clicking pin icon in the service list)
                  page:
                    type: integer
                    x-description-ru: Страница (для навигации)
                    description: Pagination index (for navigation)
                  country:
                    type: integer
                    x-description-ru: Выбранная страна
                    description: Selected country
                  filter:
                    type: string
                    x-description-ru: Список используемых фильтров
                    description: List of enabled filters
                  end:
                    type: boolean
                    x-description-ru: Является ли данная страница последней в списке (вспомогательный параметр для навигации)
                    description: Check if this page is the last one (auxiliary parameter for navigation)
                  favorites:
                    type: object
                    x-description-ru: Список избранного
                    description: Favorites list
                x-examples:
                  Example 1:
                    response: '1'
                    countries:
                      '_7':
                        name: Russia
                        original: russia
                        code: 7
                        pos: 0
                        other: false
                        new: false
                        enable: true
                    services:
                      _vkcom:
                        id: 1
                        count: 3721
                        price: '0.55'
                        service: VKontakte
                        slug: vkcom
                    favorite_countries: {}
                    favorite_services: []
                    page: 1
                    country: 7
                    filter: ''
                    end: false
                    favorites: {}
      security:
        - apikey: []
        - BearerAuth: []
        - OAuth2:
            - sms-scope
      servers:
        - url: 'https://onlinesim.io'
          description: Onlinesim server
      tags:
        - single-service activations
  /api/getNum.php:
    get:
      x-summary-ru:
      summary: getNum
      tags:
        - single-service activations
      responses:
        '200':
          x-description-ru: 'Успешный ответ на запрос `getNum`: сервер выдает виртуальный номер для приема SMS от указанного сервиса или выбрасывает исключение.'
          description: 'Successful response for `getNum` request: the server issues a dedicated virtual number for specified service or throws an exception.'
          content:
            application/json:
              schema:
                type: object
                x-examples:
                  example-1:
                    response: 1
                    tzid: 10000
                properties:
                  response:
                    x-description-ru: '1, если запрос был выполнен успешно, либо выведет сообщение об ошибке'
                    description: '1, if the request has been completed successfully, or an error message'
                    example: 1
                    oneOf:
                      - type: integer
                      - type: string
                  tzid:
                    type: integer
                    example: 10000
                    minimum: 1
                    x-description-ru: ID операции
                    description: Operation ID
                required:
                  - response
                  - tzid
              examples:
                Successful getNum response example:
                  value:
                    response: 1
                    tzid: 10000
      operationId: getNum
      x-description-ru: |
        Запрашивает номер для приема SMS от выбранного сервиса.



        Позволяет заказать номер выбранной страны для получения SMS-сообщения от конкретного сайта/приложения.



        По своей сути является аналогом кнопки покупки номера, расположенной в личном кабинете.


        >**ВАЖНО!**
        >
        >Вы также можете указать дополнительные параметры, например, исключения для маски номера на случай, если у сервиса есть подобные требования.
        >
        >Некоторые сайты и приложения могут блокировать номера с определенной последовательностью цифр для регистрации на их сервисе.
        >
        >В таком случае этот параметр может помочь Вам обойти блокировку.
      description: |
        Requests a number for a particular service, allowing to receive SMS messages from it.



        Allows you to order a number of a specified country to receive SMS from the website/app that you want.



        This request in fact plays the same role as the "Buy number" button located on the user dashboard.


        >**IMPORTANT NOTES!**
        >
        >You can also specify additional parameters such as masks for exception in case if the service has specific requirements.
        >
        >Some websites and applications might block numbers with certain digit sequence (masks) from registration.
        >
        >In this case, this parameter might come in handy.
      parameters:
        - name: service
          in: query
          required: true
          schema:
            type: string
            example: facebook
          x-description-ru: 'Название сервиса (может принимать лишь значения сервисов, указанные в [списке](/ru/openapi_docs/reseller-api-un/custom/services))'
          description: Service name (can only accept values of services in [this](/openapi_docs/reseller-api-un/custom/services) list)
        - name: country
          in: query
          required: false
          schema:
            type: integer
            default: 7
            example: 46
            minimum: 1
          x-description-ru: 'Международный телефонный код страны (согласно стандарту E.164, без знака "+"), смотри список [стран](/ru/openapi_docs/reseller-api-un/custom/countries)'
          description: 'International dialing code of the country (Е.164 standard, without "+" sign), see [country](/openapi_docs/reseller-api-un/custom/countries) list'
        - name: reject
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
            example:
              - '911'
          x-description-ru: 'Массив исключений для масок номеров (включая код страны)
            Например: при передаче [911, 912123] не будет выдавать номера Индии, начинающиеся с +911* и +912123*.'
          description: 'Array for mask exception (including country code)
            Example: when [911, 912123] is passed, the server won''t issue numbers of India, that starts with +911* and +912123*.'
        - name: dev_id
          in: query
          required: false
          schema:
            type: integer
            example: 100000
          x-description-ru: ID аккаунта для разработчиков ПО (ID профиля Onlinesim).
          description: Account ID for software developers (Onlinesim profile's ID).
        - name: number
          in: query
          required: false
          schema:
            type: boolean
            example: false
          x-description-ru: Отображать номер в ответе сервера. При переданном значении `true` запрос вернет номер заказанного телефона в ответе.
          description: 'Display number in response. If `true`, the phone number will be displayed in the response.'
        - $ref: '#/components/parameters/lang'
      security:
        - apikey: []
        - BearerAuth: []
        - OAuth2:
            - sms-scope
  /api/getState.php:
    get:
      x-summary-ru:
      summary: getState
      tags:
        - single-service activations
      responses:
        '200':
          x-description-ru: 'Успешный ответ на запрос `getState`: сервер возвращает текущую информацию об активных номерах Вашего аккаунта или выбрасывает исключение.'
          description: 'Successful response for `getState` request: the server returns detailed information on active numbers of your account or throws an exception.'
          content:
            application/json:
              schema:
                type: array
                x-examples:
                  example-1:
                    - country: 7
                      sum: 31
                      service: vkcom
                      number: '+79771249315'
                      response: TZ_NUM_ANSWER
                      tzid: 10000
                      time: 596
                      msg: '053818'
                      form: index
                x-description-ru: Массив активных номеров (текущих операций) по Вашему аккаунту
                description: Array of active numbers (current operations) on your account
                items:
                  type: object
                  x-description-ru: Информация об операции
                  description: Operation information
                  properties:
                    country:
                      type: integer
                      example: 46
                      x-description-ru: 'Международный телефонный код страны (согласно стандарту E.164, без знака "+")'
                      description: 'International dialing code of the country (Е.164 standard, without "+" sign)'
                      default: 7
                      minimum: 1
                    sum:
                      type: integer
                      x-description-ru: 'Стоимость услуги, в рублях'
                      description: Price for current service (in RUB)
                      example: 14
                      minimum: 0
                    service:
                      type: string
                      x-description-ru: 'Название сервиса, с теми же значениями, что и в запросе [getNum](/ru/openapi_docs/Onlinesim-API-UN/get/api_getNum_php)'
                      description: 'Service name, with the same values as in the [getNum](/openapi_docs/Onlinesim-API-UN/get/api_getNum_php) method'
                      example: Facebook
                    number:
                      type: string
                      x-description-ru: Номер телефона в международном формате
                      description: Phone number in international format
                      example: '+46050101010'
                    response:
                      type: string
                      x-description-ru: 'Текущий статус операции (enum):


                        `TZ_INPOOL` - операция ожидает выдачи номера


                        `TZ_NUM_WAIT` - ожидание получения SMS


                        `TZ_NUM_ANSWER` - SMS было получено


                        `TZ_OVER_EMPTY` - SMS не было получено за отведенное время


                        `TZ_OVER_OK` - операция была успешно завершена


                        `ERROR_NO_TZID` - не указан tzid (ID операции)


                        `ERROR_NO_OPERATIONS` - нет активных операций на Вашем аккаунте'
                      description: 'Current status of the operation (enum):


                        `TZ_INPOOL` - waiting for a number to be dedicated to the operation


                        `TZ_NUM_WAIT` - waiting for SMS


                        `TZ_NUM_ANSWER` - SMS has been received


                        `TZ_OVER_EMPTY` - SMS was not received during the operation period


                        `TZ_OVER_OK` - operation has been successfully completed


                        `ERROR_NO_TZID` - tzid (operation ID) is not specified


                        `ERROR_NO_OPERATIONS` - no active operations'
                      example: TZ_NUM_ANSWER
                      enum:
                        - TZ_INPOOL
                        - TZ_NUM_WAIT
                        - TZ_NUM_ANSWER
                        - TZ_OVER_OK
                        - ERROR_NO_TZID
                        - ERROR_NO_OPERATIONS
                    tzid:
                      type: integer
                      example: 10000
                      minimum: 1
                      x-description-ru: ID операции
                      description: Operation ID
                    time:
                      type: integer
                      x-description-ru: 'Оставшееся время операции, в секундах'
                      description: 'Time remaining for current operation, in seconds'
                      example: 281
                      minimum: 0
                    form:
                      type: string
                      x-description-ru: Вид приема (онлайн прием — index)
                      description: Type of service (single-service activations — index)
                      example: index
              examples:
                Successful getState response example:
                  value:
                    - country: 7
                      sum: 14
                      service: Facebook
                      number: '+46050101010'
                      response: TZ_INPOOL
                      tzid: 10000
                      time: 281
                      form: index
      operationId: getState
      x-description-ru: |
        Возвращает подробную информацию обо всех активных номерах профиля (или только об указанном номере).



        Позволяет проверить статус операций Вашего аккаунта и прочесть полученные на заказанные Вами номера SMS-сообщения.



        Вы можете использовать этот запрос для получения списка всех сообщений с активных номеров для их последующей обработки.



        Фактически является репрезентацией блока активных операций ("Мои номера") личного кабинета.



        ![Активные операции](https://onlinesim.io/assets/schemes/MyNumbers(RU).png)
      description: |
        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](https://onlinesim.io/assets/schemes/MyNumbers(EN).png)
      security:
        - apikey: []
        - BearerAuth: []
        - OAuth2:
            - sms-scope
      parameters:
        - name: tzid
          in: query
          required: false
          schema:
            type: integer
            example: 10000
            minimum: 1
          x-description-ru: ID операции
          description: Operation ID
        - name: message_to_code
          in: query
          required: false
          schema:
            type: integer
            enum:
              - 0
              - 1
            example: 1
          x-description-ru: 'Режим отображения SMS:


            `0` - показать SMS целиком,


            `1` - показать только код из SMS'
          description: 'SMS display mode:


            `0` - show the entire SMS,


            `1` - display only the code from the SMS'
        - name: orderby
          in: query
          required: false
          schema:
            type: string
            default: asc
            enum:
              - asc
              - desc
            example: asc
          x-description-ru: 'Порядок сортировки:


            `asc` - сортировка по возрастанию;


            `desc` - сортировка по убыванию'
          description: 'Sorting order:


            `asc` - ascending;


            `desc` - descending'
        - name: msg_list
          in: query
          required: false
          schema:
            type: integer
            enum:
              - 0
              - 1
            example: 1
            minimum: 0
            maximum: 1
          x-description-ru: 'Режим отображения списка сообщений:


            `0` - только активное сообщение,


            `1` - в виде списка'
          description: 'Message list display mode:


            `0` - show only the active message,


            `1` - show the whole list'
        - name: clean
          in: query
          required: false
          schema:
            type: integer
            enum:
              - 0
              - 1
            example: 1
            minimum: 0
            maximum: 1
          x-description-ru: 'Режим отображения сообщений (только при переданном параметре msg_list = 0):


            `0` - отображать ранее показанные сообщения,


            `1` - не отображать ранее показанные сообщения'
          description: 'Message display mode (only for msg_list = 0):


            `0` - show previosly shown messages,


            `1` - do not show previously shown messages'
        - $ref: '#/components/parameters/lang'
  /api/setOperationRevise.php:
    get:
      x-summary-ru:
      summary: setOperationRevise
      tags:
        - single-service activations
      responses:
        '200':
          x-description-ru: 'Успешный ответ на запрос `setOperationRevise`: сервер успешно обрабатывает следующее SMS, поступившее на этот номер, или выбрасывает исключение.'
          description: 'Successful response for `setOperationRevise` request: the server successfully processing another SMS received by this number or throws an exception.'
          content:
            application/json:
              schema:
                type: object
                x-examples:
                  example-1:
                    tzid: '10000'
                    response: '1'
                properties:
                  response:
                    x-description-ru: '1, если запрос был выполнен успешно, либо выведет сообщение об ошибке'
                    description: '1, if the request has been completed successfully, or an error message'
                    example: 1
                    oneOf:
                      - type: integer
                      - type: string
                  tzid:
                    type: integer
                    example: 10000
                    minimum: 1
                    x-description-ru: ID операции
                    description: Operation ID
              examples:
                Successful setOperationRevise response example:
                  value:
                    response: 1
                    tzid: 10000
      operationId: setOperationRevise
      x-description-ru: |-
        Запрашивает следующее полученное этим номером SMS сообщение, если первое не содержало нужный код и/или необходимую информацию.



        Данный запрос может быть полезен, когда сервис отправляет несколько SMS-сообщений подряд или вам небходимо получить более одного сообщения от того же сервиса на один номер.



        Например, если первое сообщение содержит общую информацию, условия пользования или какой-либо промо материал и Вам необходимо получить код, содержащийся во второй SMS, используйте этот запрос для получения необходимых данных.
      description: |-
        Requests next received SMS from this number, if first the one didn't have the right code and/or expected information.



        This request can be useful when a service sends multiple SMS messages in a row or when you need to receive more than one message from the same service on a single number.



        For example if the first SMS only contains general information, terms or any promo material and you need the code that is contained in the second SMS, use this request to get the data you need.
      parameters:
        - name: tzid
          in: query
          required: true
          schema:
            type: integer
            example: 10000
            minimum: 1
          x-description-ru: ID операции
          description: Operation ID
        - $ref: '#/components/parameters/lang'
      security:
        - apikey: []
        - BearerAuth: []
        - OAuth2:
            - sms-scope
  /api/setOperationOk.php:
    get:
      summary: setOperationOk
      tags:
        - single-service activations
      responses:
        '200':
          x-description-ru: 'Успешный ответ на запрос `setOperationOk`: сервер успешно закрывает указанную операцию или выбрасывает исключение.'
          description: 'Successful response for `setOperationOk` request: the server successfully closes the specified operation or throws an exception.'
          content:
            application/json:
              schema:
                type: object
                x-examples:
                  example-1:
                    response: 1
                    tzid: 10000
                x-description-ru: 'Описание результата.
                  Ответ `NO_COMPLETE_TZID` означает, что операция не может быть закрыта до истечения защитного интервала. По умолчанию его срок составляет 2 минуты, но для ряда сервисов он может быть больше.'
                description: '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.'
                properties:
                  response:
                    x-description-ru: '1, если запрос был выполнен успешно, либо выведет сообщение об ошибке'
                    description: '1, if the request has been completed successfully, or an error message'
                    example: 1
                    oneOf:
                      - type: integer
                      - type: string
                  tzid:
                    type: integer
                    example: 10000
                    minimum: 1
                    x-description-ru: ID операции
                    description: Operation ID
              examples:
                setOperationOk exception example (closing operation attempt during protective interval):
                  value:
                    response: NO_COMPLETE_TZID
      operationId: setOperationOk
      x-description-ru: |-
        Меняет статус операции на успешный и закрывает операцию.



        Этот запрос необходимо посылать, когда Вы хотите явно закрыть операцию после получения нужного Вам SMS сообщения.


        >**ВАЖНО!**
        >
        >Использование этого запроса аналогично закрытию операции в блоке "Мои номера" интерфейса личного кабинета. Повторное использование этого номера после закрытия операции будет недоступно!



        ![Закрытие операции](https://onlinesim.io/assets/schemes/OperationClosing(RU).png)
      description: |-
        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.


        >**IMPORTANT NOTE!**
        >
        >Executing of this request is similar to closing active operation in "My numbers" section of the user interface on the website. After closing the operation, you will no longer be able to order or use this number again!



        ![Operation closing](https://onlinesim.io/assets/schemes/OperationClosing(EN).png)
      security:
        - apikey: []
        - BearerAuth: []
        - OAuth2:
            - sms-scope
      parameters:
        - name: tzid
          in: query
          required: true
          schema:
            type: integer
            example: 10000
            minimum: 1
          x-description-ru: ID операции
          description: Operation ID
        - name: ban
          in: query
          required: false
          schema:
            type: integer
            enum:
              - 0
              - 1
            example: 1
          x-description-ru: Этот параметр может быть использован в случае, если выданный Вами номер имел некорректный формат или не получил SMS-сообщение в течение 5 минут.
            Вы можете передать параметр со значением `1`, чтобы заблокировать номер
          description: 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
        - $ref: '#/components/parameters/lang'
  /api/rent/tariffsRent.php:
    get:
      summary: tariffsRent
      tags:
        - rent
      operationId: tariffsRent
      x-description-ru: |
        Получение информации о доступных для аренды номерах указанной страны (или всех странах, если не указана конкретная): тарифах и других параметрах аренды.



        В отличие от обычного приема SMS, аренда номера подразумевает более длительный срок использования. Также в отличие от обычного приема, Вы можете получать любое количество SMS сообщений во время всего срока действия аренды от различных отправителей: начиная от сайтов и приложений, заканчивая SMS от обычных мобильных номеров.



        Если Вы изначально выбрали номер с возможностью продления, Вы сможете продлить аренду в любой момент до её окончания.


        >**ВАЖНО!**
        >
        >Пожалуйста, обратите внимание, что некоторые сервисы запрещены для использования (и прием SMS-сообщений от таких сервисов будет доступен). Вы можете найти список таких сервисов на главной странице сайта или в [Публичной оферте](https://onlinesim.io/ru/documentation/offer).
      description: |
        Returnes information on available for rent numbers of specified country (or all of countries, if not specified): rental plans and other parameters of rent.



        Unlike regular SMS receiving, rental implies a longer period of use. Also, unlike regular receiving, you can receive any number of SMS messages during the entire rental period from various senders: from websites and applications to SMS sent from regular mobile numbers.



        If you initially chose a number with the extention option, you can extend the rental at any time before it expires.


        >**IMPORTANT NOTE!**
        >
        >Please note that some services are prohibited for use (and SMS from these services will not be received), you can find the list of such services on the front page or in [Public offer](https://onlinesim.io/documentation/offer).
      security:
        - apikey: []
        - BearerAuth: []
        - OAuth2:
            - rent-scope
      parameters:
        - schema:
            type: string
            minLength: 1
            example: '7'
          in: query
          x-description-ru: 'Международный телефонный код страны (согласно стандарту E.164, без знака "+"),
            смотри список [стран](/ru/openapi_docs/reseller-api-un/custom/countries)'
          description: 'International dialing code of the country (Е.164 standard, without "+" sign),
            see [country](/openapi_docs/reseller-api-un/custom/countries) list'
          name: country
        - $ref: '#/components/parameters/lang'
      responses:
        '200':
          x-description-ru: 'Успешный ответ на запрос `tariffsRent`: сервер возвращает информацию о доступных тарифах аренды или выбрасывает исключение.'
          description: 'Successful response for `tariffsRent` request: the server returns information on available rental plans or throws an exception.'
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: integer
                    example: 46
                    x-description-ru: 'Международный телефонный код страны (согласно стандарту E.164, без знака "+"), смотри список кодов [стран](/ru/openapi_docs/reseller-api-un/custom/countries)'
                    description: 'International dialing code of the country (Е.164 standard, without "+" sign), see [country](/openapi_docs/reseller-api-un/custom/countries) list'
                    default: 7
                    minimum: 1
                  enabled:
                    x-description-ru: Доступность виртуальных номеров страны для аренды (доступны/недоступны)
                    description: Availability of virtual numbers of a country (available/unavailable)
                    type: boolean
                  new:
                    type: boolean
                    x-description-ru: Недавно ли страна была добавлена в список
                    description: Was the country recently added to the list
                  position:
                    type: integer
                    x-description-ru: Позиция страны в списке в личном кабинете (по умолчанию)
                    description: Country position in the list in the user dashboard (by default)
                    example: 1
                    minimum: 0
                  count:
                    type: object
                    x-description-ru: Содержит информацию о количестве доступных номеров по каждому из доступных периодов аренды
                    description: Contains information on the amount of available numbers for each available rental period
                    properties:
                      '"period_in_days"':
                        type: integer
                        example: 20
                        minimum: 0
                        x-description-ru: Количество доступных номеров для аренды по каждому из начальных периодов аренды
                        description: Amount of available numbers for each initial rental period
                  days:
                    type: object
                    x-description-ru: Содержит информацию о стоимости услуги для каждого из начальных периодов аренды
                    description: Contains information on the price for each initial rental period
                    properties:
                      '"period_in_days"':
                        type: number
                        x-description-ru: Стоимость за указанный начальный период аренды
                        description: Price of rent for each inital rental period
                  extend:
                    type: integer
                    x-description-ru: Количество доступных номеров для аренды с продлением
                    description: Amount of available numbers for rent with extention option
                  confirm:
                    type: boolean
              examples:
                Successful tariffsRent response example:
                  value:
                    '1':
                      code: 1
                      enabled: true
                      name: usa
                      new: false
                      position: 1
                      count:
                        '7': 10
                      days:
                        '7': 6615.5
                      extend: 0
                      confirm: true
                    '7':
                      code: 7
                      enabled: true
                      name: russia
                      new: false
                      position: 7
                      count:
                        '1': 1153
                        '3': 1153
                        '7': 1153
                        '15': 1153
                        '30': 1153
                      days:
                        '1': 121
                        '3': 215.5
                        '7': 400
                        '15': 700
                        '30': 1078.5
                      extend: 1153
                      confirm: false
                    '31':
                      code: 31
                      enabled: true
                      name: netherlands
                      new: false
                      position: 31
                      count:
                        '7': 16
                        '15': 16
                        '30': 16
                      days:
                        '7': 1150
                        '15': 2013
                        '30': 3451.5
                      extend: 16
                      confirm: false
                    '33':
                      code: 33
                      enabled: true
                      name: france
                      new: false
                      position: 33
                      count:
                        '7': 15
                        '15': 15
                        '30': 15
                      days:
                        '7': 2876
                        '15': 5177
                        '30': 9203.5
                      extend: 15
                      confirm: false
                    '34':
                      code: 34
                      enabled: true
                      name: spain
                      new: false
                      position: 34
                      count:
                        '7': 3
                        '30': 3
                      days:
                        '7': 4194.5
                        '30': 9287.5
                      extend: 0
                      confirm: true
                    '39':
                      code: 39
                      enabled: true
                      name: italy
                      new: false
                      position: 39
                      count:
                        '30': 10
                      days:
                        '30': 14980
                      extend: 0
                      confirm: true
                    '40':
                      code: 40
                      enabled: true
                      name: romania
                      new: false
                      position: 40
                      count:
                        '7': 1
                        '15': 1
                      days:
                        '7': 3745.5
                        '15': 7490
                      extend: 1
                      confirm: false
                    '44':
                      code: 44
                      enabled: true
                      name: united_kingdom
                      new: false
                      position: 44
                      count:
                        '7': 93
                        '15': 93
                        '30': 93
                      days:
                        '7': 1323.5
                        '15': 2876
                        '30': 5752.5
                      extend: 72
                      confirm: false
                    '45':
                      code: 45
                      enabled: true
                      name: denmark
                      new: false
                      position: 45
                      count:
                        '7': 9
                        '30': 9
                      days:
                        '7': 4098.5
                        '30': 11360.5
                      extend: 9
                      confirm: false
                    '46':
                      code: 46
                      enabled: true
                      name: sweden
                      new: false
                      position: 46
                      count:
                        '7': 7
                        '30': 7
                      days:
                        '7': 4494
                        '30': 9587
                      extend: 0
                      confirm: true
                    '48':
                      code: 48
                      enabled: false
                      name: poland
                      new: false
                      position: 48
                      count:
                        '1': 0
                        '3': 0
                        '7': 0
                        '15': 0
                        '30': 0
                      days:
                        '1': 460.5
                        '3': 633
                        '7': 1035.5
                        '15': 1840.5
                        '30': 2876
                      extend: 0
                    '49':
                      code: 49
                      enabled: false
                      name: germany
                      new: false
                      position: 49
                      count:
                        '7': 0
                        '15': 0
                        '30': 0
                      days:
                        '7': 1438
                        '15': 3020
                        '30': 6040
                      extend: 0
                    '57':
                      code: 57
                      enabled: true
                      name: colombia
                      new: false
                      position: 57
                      count:
                        '1': 4
                        '3': 4
                        '15': 4
                        '30': 4
                      days:
                        '1': 599
                        '3': 839
                        '15': 2277
                        '30': 3595
                      extend: 4
                      confirm: false
                    '61':
                      code: 61
                      enabled: true
                      name: australia
                      new: false
                      position: 61
                      count:
                        '30': 10
                      days:
                        '30': 15028
                      extend: 0
                      confirm: true
                    '63':
                      code: 63
                      enabled: true
                      name: philippines
                      new: false
                      position: 63
                      count:
                        '1': 1
                        '3': 1
                        '15': 1
                        '30': 1
                      days:
                        '1': 575
                        '3': 790.5
                        '15': 2301
                        '30': 3595
                      extend: 0
                      confirm: false
                    '77':
                      code: 77
                      enabled: true
                      name: kazakhstan
                      new: false
                      position: 77
                      count:
                        '1': 13
                        '3': 13
                        '7': 13
                      days:
                        '1': 569.5
                        '3': 1198.5
                        '7': 2397
                      extend: 13
                      confirm: false
                    '212':
                      code: 212
                      enabled: true
                      name: morocco
                      new: false
                      position: 212
                      count:
                        '7': 4
                        '15': 4
                        '30': 4
                      days:
                        '7': 863
                        '15': 1150
                        '30': 1726
                      extend: 4
                      confirm: false
                    '223':
                      code: 223
                      enabled: true
                      name: mali
                      new: false
                      position: 223
                      count:
                        '1': 9
                        '3': 9
                        '15': 9
                        '30': 9
                      days:
                        '1': 575
                        '3': 790.5
                        '15': 2301
                        '30': 3595
                      extend: 9
                      confirm: false
                    '351':
                      code: 351
                      enabled: true
                      name: portugal
                      new: false
                      position: 351
                      count:
                        '7': 7
                        '30': 7
                      days:
                        '7': 5033.5
                        '30': 9287.5
                      extend: 0
                      confirm: true
                    '358':
                      code: 358
                      enabled: true
                      name: finland
                      new: false
                      position: 358
                      count:
                        '7': 7
                        '30': 7
                      days:
                        '7': 4494
                        '30': 9587
                      extend: 0
                      confirm: true
                    '370':
                      code: 370
                      enabled: true
                      name: lithuania
                      new: false
                      position: 370
                      count:
                        '7': 6
                        '15': 6
                        '30': 6
                      days:
                        '7': 1222.5
                        '15': 1438
                        '30': 2876
                      extend: 6
                      confirm: false
                    '371':
                      code: 371
                      enabled: true
                      name: latvia
                      new: false
                      position: 371
                      count:
                        '7': 7
                        '30': 7
                      days:
                        '7': 5033.5
                        '30': 7478
                      extend: 3
                      confirm: true
                    '372':
                      code: 372
                      enabled: true
                      name: estonia
                      new: false
                      position: 372
                      count:
                        '1': 10
                        '7': 10
                        '30': 10
                      days:
                        '1': 719
                        '7': 3295.5
                        '30': 7430
                      extend: 0
                      confirm: true
                    '373':
                      code: 373
                      enabled: true
                      name: moldova
                      new: false
                      position: 373
                      count:
                        '1': 17
                        '3': 17
                        '15': 17
                        '30': 17
                      days:
                        '1': 575
                        '3': 790.5
                        '15': 2301
                        '30': 3595
                      extend: 1
                      confirm: false
                    '380':
                      code: 380
                      enabled: true
                      name: ukraine
                      new: false
                      position: 380
                      count:
                        '7': 13
                        '15': 13
                        '30': 13
                      days:
                        '7': 402.5
                        '15': 633
                        '30': 920.5
                      extend: 13
                      confirm: false
                    '385':
                      code: 385
                      enabled: true
                      name: croatia
                      new: false
                      position: 385
                      count:
                        '7': 1
                        '15': 1
                      days:
                        '7': 3745.5
                        '15': 7490
                      extend: 1
                      confirm: false
                    '420':
                      code: 420
                      enabled: false
                      name: czech
                      new: false
                      position: 420
                      count:
                        '1': 0
                        '3': 0
                        '7': 0
                        '15': 0
                        '30': 0
                      days:
                        '1': 575
                        '3': 790.5
                        '7': 1294
                        '15': 2301
                        '30': 3595
                      extend: 0
                    '998':
                      code: 998
                      enabled: true
                      name: uzbekistan
                      new: false
                      position: 998
                      count:
                        '1': 2
                        '3': 2
                        '7': 2
                      days:
                        '1': 719
                        '3': 1534.5
                        '7': 2685
                      extend: 2
                      confirm: false
  /api/rent/getRentNum.php:
    get:
      summary: getRentNum
      tags:
        - rent
      responses:
        '200':
          x-description-ru: |
            Успешный ответ на запрос `getRentNum`: сервер выдает для аренды номер с заданными параметрами или выбрасывает исключение.
          description: |
            Successful response for `getRentNum` request: the server issues a number with requested parameters for rent or throws an exception.
          content:
            application/json:
              schema:
                type: object
                x-examples:
                  example-1:
                    response: 1
                    item:
                      status: 0
                      messages:
                        current_page: 1
                        data: []
                        from: 1
                        last_page: 0
                        per_page: 20
                        to: 0
                        total: 0
                      country: 7
                      rent: 3
                      extension: 1
                      checked_time: '2022-07-17 11:55:13'
                      sum: 215.5
                      number: '9830767598'
                      tzid: 22867400
                      time: 19
                      days: 0
                      hours: 0
                      extend:
                        '1': 36
                        '3': 108
                        '7': 252
                        '15': 540
                        '30': 1080
                      checked: false
                      reload: 0
                      day_extend: 36
                      m_ext: false
                      freeze: false
                properties:
                  response:
                    x-description-ru: '1, если запрос был выполнен успешно, либо выведет сообщение об ошибке'
                    description: '1, if the request has been completed successfully, or an error message'
                    example: 1
                    oneOf:
                      - type: integer
                      - type: string
                  item:
                    type: object
                    properties:
                      status:
                        type: integer
                        x-description-ru: 'Код статуса аренды, сразу после выдачи всегда `0`:


                          `0` - ожидание подтверждения операции (SMS должна быть получена в течение 20 минут после заказа, в противном случае операция будет отменена, а средства возвращены на баланс аккаунта)


                          `1` - аренда активна


                          `2` - **DEPRECATED** номер отключен


                          `3` - **DEPRECATED** ошибка аренды


                          `4` - номер был заморожен'
                        description: 'Status code of rent, upon issuing always `0`:


                          `0` - awaiting operation confirmation (SMS has to be received in the first 20 minutes after the order, else the operation will be refunded)


                          `1` - rent is active


                          `2` - **DEPRECATED** number is disabled


                          `3` - **DEPRECATED** rent error


                          `4` - number has been frozen/put on hold (rent has been paused)'
                        example: 0
                      messages:
                        type: object
                        properties:
                          current_page:
                            type: integer
                            x-description-ru: 'Все сообщения отсортированы в обратном хронологическом порядке и сгруппированы по страницам, каждая из которых содержит 10 сообщений (первая страница содержит последние 10 сообщений)'
                            description: 'All messages are sorted in reverse chronological order and are grouped into pages, each containing 10 messages in (first page contains the last 10 messages)'
                            minimum: 1
                            example: 1
                          data:
                            type: array
                            items:
                              type: object
                          from:
                            type: integer
                            x-description-ru: Номер первого сообщения на этой странице
                            description: Number of the first message on this page
                            minimum: 1
                            example: 1
                          last_page:
                            type: integer
                            x-description-ru: Номер последней страницы с полученными SMS-сообщениями
                            description: Number of last page with received SMS messages
                            example: 12
                            minimum: 0
                          per_page:
                            type: integer
                            x-description-ru: Количество сообщений, отображаемых на одной странице
                            description: Amount of messages displayed on a single page
                            example: 20
                            default: 20
                          to:
                            type: integer
                            x-description-ru: Номер последнего сообщения на этой странице
                            description: Number of the last message on this page
                            minimum: 0
                            example: 2
                          total:
                            type: integer
                            x-description-ru: Общее количество полученных этим номером сообщений
                            description: Total amount of SMS received by this number
                            minimum: 0
                            example: 4
                      country:
                        type: integer
                        example: 46
                        x-description-ru: 'Международный телефонный код страны (согласно стандарту E.164, без знака "+"), смотри список кодов [стран](/ru/openapi_docs/reseller-api-un/custom/countries)'
                        description: 'International dialing code of the country (Е.164 standard, without "+" sign), see [country](/openapi_docs/reseller-api-un/custom/countries) list'
                        default: 7
                        minimum: 1
                      rent:
                        type: integer
                        x-description-ru: 'Код статуса аренды, сразу после выдачи всегда `0`:


                          `0` - ожидание подтверждения (SMS должна быть получена в первые 20 минут после заказа, в противном случае по операции будет выполнен возврат средств)


                          `1` - аренда активна


                          `2` - **DEPRECATED** номер недоступен


                          `3` - **DEPRECATED** ошибка аренды


                          `4` - номер был заморожен'
                        description: 'Status code of rent, upon issuing always `0`:


                          `0` - awaiting operation confirmation (SMS has to be received in the first 20 minutes after the order, else the operation will be refunded)


                          `1` - rent is active


                          `2` - **DEPRECATED** number is disabled


                          `3` - **DEPRECATED** rent error


                          `4` - number has been frozen/put on hold (rent has been paused)'
                        enum:
                          - 0
                          - 1
                          - 2
                          - 3
                          - 4
                      extension:
                        type: integer
                        x-description-ru: 'Доступность продления аренды этого номера:


                          `0` - продление недоступно


                          `1` - продление доступно


                          `2` - автопродление (аренда автоматически продлится на 30 дней по истечении текущего срока, если на балансе достаточно средств)'
                        description: 'Extention availability for this number:


                          `0` - extention is unavailable


                          `1` - extention is available


                          `2` - Auto-renewal (the rental will be automatically extended for 30 days upon expiration, provided there are sufficient funds in the account)'
                        example: 1
                        enum:
                          - 0
                          - 1
                          - 2
                      checked_time:
                        type: string
                        x-description-ru: Дата и время, когда номер был выдан для аренды
                        description: Date and time when this number was issued for rent operation
                        format: date-time
                        example: '2022-07-17 11:55:13'
                      sum:
                        type: number
                        x-description-ru: Стоимость аренды
                        description: Price of rent
                        minimum: 0
                        example: 215.5
                      number:
                        type: string
                        x-description-ru: 'Номер телефона, без кода страны'
                        description: 'Phone number, without a country code'
                        example: '9108501010'
                      tzid:
                        type: integer
                        example: 10000
                        minimum: 1
                        x-description-ru: ID операции
                        description: Operation ID
                      time:
                        type: integer
                        x-description-ru: 'Оставшееся время аренды, (в минутах)'
                        description: 'Remaining rent time, (in minutes)'
                        minimum: 0
                        example: 19
                      days:
                        type: integer
                        x-description-ru: 'Оставшееся время аренды, (в днях)'
                        description: 'Remaining rent time, (in days)'
                        minimum: 0
                        example: 0
                      hours:
                        type: integer
                        x-description-ru: 'Оставшееся время аренды, (в часах)'
                        description: 'Remaining rent time, (in hours)'
                        minimum: 0
                        example: 14
                      extend:
                        type: object
                        x-description-ru: Стоимость продления
                        description: Extension prices
                        properties:
                          '"extension_period_in days"':
                            type: integer
                            x-description-ru: Стоимость продления аренды на X дней
                            description: Extension price for X days
                      checked:
                        type: boolean
                        x-description-ru: 'Статус активации номера (для активации номер должен принять SMS в течение 20 минут после начала операции, в противном случае будет автоматически выполнен возврат средств, а операция закрыта)'
                        description: 'Rent status confirmation: if false SMS has to be received in the first 20 minutes after the order (after that status is switched to `true`), else the operation will be refunded.'
                      reload:
                        type: integer
                        x-description-ru: 'Доступность перезагрузки номера:


                          `0` - перезагрузка недоступна


                          `1` - перезагрузка доступна'
                        description: 'Availabitiy of reloading the number function:


                          `0` - reset unavailable


                          `1` - reset available'
                        example: 1
                      day_extend:
                        type: integer
                        x-description-ru: Стоимость продления аренды на 1 день
                        description: Price of rental extension for 1 day
                        example: 36
                        minimum: 1
                      m_ext:
                        type: boolean
                        x-description-ru: Аналоговый алгоритм для продления
                        description: Analog algorythm for extention is enabled
                      freeze:
                        type: boolean
                        x-description-ru: 'Статус "заморозки" номера: если `true` - номер заморожен, и для продолжения аренды необходимо его разморозить'
                        description: 'Current "on hold" status: if `true` - the number was frozen/put on hold and it is required to *unfreeze* it before continue to use it again (to do so, go to the user dashboard)'
              examples:
                Successfully issued rental number:
                  value:
                    response: 1
                    item:
                      status: 0
                      messages:
                        current_page: 1
                        data: []
                        from: 1
                        last_page: 0
                        per_page: 20
                        to: 0
                        total: 0
                      country: 7
                      rent: 3
                      extension: 1
                      checked_time: '2022-07-17 21:41:20'
                      sum: 215.5
                      number: '9915584307'
                      tzid: 22867974
                      time: 19
                      days: 0
                      hours: 0
                      extend:
                        '1': 36
                        '3': 108
                        '7': 252
                        '15': 540
                        '30': 1080
                      checked: false
                      reload: 0
                      day_extend: 36
                      m_ext: false
                      freeze: false
      operationId: getRentNum
      x-description-ru: |-
        Данный запрос позволяет Вам арендовать номер конкретной страны для приема SMS-сообщений.



        Вы можете использовать данный запрос, когда Вам необходимо принять сообщения от нескольких различных сервисов или от одного, но в течение длительного времени.


        >**ВАЖНО!**
        >
        >Пожалуйста, обратите внимание, что каждая новая операция аренды имеет защитный 20-минутный интервал, в течение которого номером должна быть получена SMS. Если Вы не используете номер в этот промежуток времени, операция будет закрыта, а средства возвращены на баланс профиля.
        >
        >Также некоторые сервисы запрещены для использования (и SMS-сообщения от таких сервисов не будут доступны). Вы можете найти список таких сервисов на главной странице сайта или в [Публичной оферте](https://onlinesim.io/ru/documentation/offer).
      description: |-
        This request allows you to rent a number of a specific country for SMS receiving.



        You can use this request when you need to receive messages from multiple different services or from a single one, but over a long time period.


        >**IMPORTANT NOTES!**
        >
        >Please note that every new rent operation has a 20 minute protective interval, during which SMS must be received by issued number. If you won't use the number within this timeframe the operation will be terminated automatically and the cost of rent will be refunded.
        >
        >Also some services are prohibited for use (and SMS from these services are not available), you can find the list of such services on the front page or in [Public offer](https://onlinesim.io/documentation/offer).
      security:
        - apikey: []
        - BearerAuth: []
        - OAuth2:
            - rent-scope
      parameters:
        - name: country
          in: query
          required: false
          schema:
            type: integer
            default: 7
            example: 46
            minimum: 1
          x-description-ru: 'Международный телефонный код страны (согласно стандарту E.164, без знака "+"),
            смотри список кодов [стран](/ru/openapi_docs/reseller-api-un/custom/countries)'
          description: 'International dialing code of the country (Е.164 standard, without "+" sign),
            see [country](/openapi_docs/reseller-api-un/custom/countries) list'
        - name: days
          in: query
          required: true
          schema:
            type: integer
            example: 1
            minimum: 1
          x-description-ru: 'Начальный срок аренды (в днях), доступные срок указаны в ответе [tariffsRent](/ru/openapi_docs/Onlinesim-API-UN/get/api_rent_tariffsRent_php)'
          description: 'Initial rental period (in days), see available values in [tariffsRent](/openapi_docs/Onlinesim-API-UN/get/api_rent_tariffsRent_php) response'
        - schema:
            type: boolean
            default: true
          in: query
          name: extension
          x-description-ru: 'Автопродление (когда включено, по истечению срока аренды автоматически продляет её на 30 дней, если на балансе достаточно средств)'
          description: 'Auto-renewal (when enabled, automatically extends the rental for 30 days upon expiration)'
        - schema:
            type: boolean
          in: query
          name: pagination
          x-description-ru: Пагинация сообщений
          description: Message pagination
        - $ref: '#/components/parameters/lang'
  /api/rent/extendRentState.php:
    get:
      summary: extendRentState
      tags:
        - rent
      responses:
        '200':
          x-description-ru: 'Успешный ответ на запрос `extendRentState`: продляет аренду номера с заданными параметрами или выбрасывает исключение.'
          description: 'Successful response for `extendRentState` request: extends the rent of a number with requested parameters or throws an exception.'
          content:
            application/json:
              schema:
                type: object
                x-examples:
                  example-1:
                    response: 1
                    item:
                      status: 1
                      extension: 1
                      messages:
                        current_page: 1
                        data:
                          - - id: 1
                              service: Google
                              text: G-249833 – Ваш проверочный код.
                              code: '249833'
                              created_at: '2022-07-17 21:46:58'
                        from: 1
                        last_page: 1
                        per_page: 20
                        to: 1
                        total: 1
                      sum: 251.5
                      country: 7
                      checked_time: '2022-07-17 21:41:20'
                      number: '9915584307'
                      rent: 4
                      tzid: 22867974
                      time: 5750
                      days: 3
                      hours: 95
                      extend:
                        '1': 36
                        '3': 108
                        '7': 252
                        '15': 540
                        '30': 1080
                      checked: true
                      reload: 0
                      day_extend: 36
                      m_ext: false
                      freeze: false
                properties:
                  response:
                    oneOf:
                      - type: integer
                      - type: string
                    x-description-ru: '1, если запрос был выполнен успешно, либо выведет сообщение об ошибке'
                    description: '1, if the request has been completed successfully, or an error message'
                    example: 1
                  item:
                    type: object
                    x-description-ru: Список активных арендных номеров Вашего профиля
                    description: List of active rental numbers of your profile
                    properties:
                      status:
                        type: integer
                        example: 1
                      extension:
                        type: integer
                        x-description-ru: 'Доступность продления аренды этого номера:


                          `0` - продление недоступно


                          `1` - продление доступно


                          `2` - автопродление (аренда автоматически продлится на 30 дней по истечении текущего срока, если на балансе достаточно средств)'
                        description: 'Extention availability for this number:


                          `0` - extention is unavailable


                          `1` - extention is available


                          `2` - auto-renewal (the rental will be automatically extended for 30 days upon expiration, provided there are sufficient funds in the account)'
                        example: 1
                        enum:
                          - 0
                          - 1
                          - 2
                      messages:
                        type: object
                        properties:
                          current_page:
                            type: integer
                            example: 1
                            x-description-ru: 'Все сообщения отсортированы в обратном хронологическом порядке и сгруппированы по страницам, каждая из которых содержит 20 сообщений (первая страница содержит 20 последних сообщений)'
                            description: 'All messages are sorted in reverse chronological order and are grouped into pages, each containing 20 messages (first page contains the last 20 messages)'
                          data:
                            type: array
                            items:
                              oneOf:
                                - type: object
                                - type: array
                              properties:
                                id:
                                  type: integer
                                  x-description-ru: ID сообщения
                                  description: Message ID
                                  example: 1
                                  minimum: 1
                                service:
                                  type: string
                                  x-description-ru: Номер или имя отправителя
                                  description: Phone number or a name of a sender
                                  example: Google
                                text:
                                  type: string
                                  x-description-ru: Текст SMS-сообщения
                                  description: Context of the SMS
                                  example: Your verification code is 070051
                                code:
                                  type: string
                                  x-description-ru: Цифровой код из SMS-сообщения
                                  description: Short code
                                  example: '070051'
                                created_at:
                                  type: string
                                  x-description-ru: Дата и время приема SMS-сообщения
                                  description: Date and time when the message was received
                                  example: '2022-07-17 21:46:58'
                          from:
                            type: integer
                            x-description-ru: Номер первого сообщения на этой странице
                            description: Number of the first message on this page
                            example: 1
                            minimum: 1
                          last_page:
                            type: integer
                            x-description-ru: Номер последней страницы с полученными SMS-сообщениями
                            description: Number of last page with received SMS messages
                            minimum: 1
                            example: 12
                          per_page:
                            type: integer
                            x-description-ru: Количество сообщений, отображаемых на одной странице (20 по умолчанию)
                            description: Amount of messages displayed on a single page (20 by default)
                            default: 20
                            example: 20
                          to:
                            type: integer
                            x-description-ru: Номер последнего сообщения на текущей странице
                            description: Number of the last message on the current page
                            example: 12
                            minimum: 1
                          total:
                            type: integer
                            x-description-ru: Общее количество полученных этим номером сообщений
                            description: Total amount of SMS received by this number
                            minimum: 1
                            example: 234
                      sum:
                        type: number
                        x-description-ru: Общая стоимость аренды (начальный период + периоды продления)
                        description: Total rental cost (initial period + extension periods)
                        minimum: 1
                        example: 251.5
                      country:
                        type: integer
                        x-description-ru: 'Международный телефонный код страны (согласно стандарту E.164, без знака "+"), смотри список кодов [стран](/ru/openapi_docs/reseller-api-un/custom/countries)'
                        description: 'International dialing code of the country (Е.164 standard, without "+" sign), see [country](/openapi_docs/reseller-api-un/custom/countries) list'
                        example: 46
                      checked_time:
                        type: string
                        x-description-ru: Дата и время, когда этот номер был арендован клиентом
                        description: Date and time when this number was ordered for rent
                        example: '2022-07-17 21:41:20'
                      number:
                        type: string
                        x-description-ru: Выданный виртуальный номер (без кода страны)
                        description: Issued virtual number (without country code)
                        example: '9915584307'
                      rent:
                        type: integer
                        x-description-ru: 'Код статуса аренды, сразу после выдачи всегда `0`:


                          `0` - ожидание подтверждения операции (SMS должна быть получена в течение 20 минут после заказа, в противном случае операция будет отменена, а средства возвращены на баланс аккаунта)


                          `1` - аренда активна


                          `2` - **DEPRECATED** номер отключен


                          `3` - **DEPRECATED** ошибка аренды


                          `4` - номер был заморожен'
                        description: 'Status code of rent, upon issuing always `0`:


                          `0` - awaiting operation confirmation (SMS has to be received in the first 20 minutes after the order, else the operation will be refunded)


                          `1` - rent is active


                          `2` - **DEPRECATED** number is disabled


                          `3` - **DEPRECATED** rent error


                          `4` - number has been frozen/put on hold (rent has been paused)'
                        example: 4
                        enum:
                          - 0
                          - 1
                          - 2
                          - 3
                          - 4
                      tzid:
                        type: integer
                        x-description-ru: ID операции
                        description: Operation ID
                        minimum: 1
                        example: 10000
                      time:
                        type: integer
                        x-description-ru: 'Оставшееся время аренды, (в минутах)'
                        description: 'Remaining rent time, (in minutes)'
                        minimum: 1
                        example: 5750
                      days:
                        type: integer
                        x-description-ru: 'Оставшееся время аренды, (в днях)'
                        description: 'Remaining rent time, (in days)'
                        minimum: 0
                        example: 3
                      hours:
                        type: integer
                        x-description-ru: 'Оставшееся время аренды, (в часах)'
                        description: 'Remaining rent time, (in hours)'
                        minimum: 1
                        example: 95
                      extend:
                        type: object
                        x-description-ru: Стоимость продления
                        description: Extention price
                        properties:
                          '#period_in_days#':
                            type: integer
                            x-description-ru: Стоимость продления аренды на указанный период
                            description: Extention price for each available extention period
                            minimum: 1
                            example: 36
                      checked:
                        type: boolean
                        x-description-ru: 'Статус активации номера (для активации номер должен принять SMS в течение 20 минут после начала операции аренды, в противном случае будет автоматически выполнен возврат средств, а операция закрыта)'
                        description: 'Rent status confirmation: if false SMS has to be received in the first 20 minutes after the order (after that status is switched to `true`), else the operation will be refunded.'
                      reload:
                        type: integer
                        x-description-ru: 'Доступность перезагрузки номера:


                          `0` - перезагрузка недоступна


                          `1` - перезагрузка доступна'
                        description: 'Availabitiy of reloading the number function:


                          `0` - reset unavailable


                          `1` - reset available'
                        example: 1
                      day_extend:
                        type: integer
                        x-description-ru: Стоимость продления аренды на 1 день
                        description: Price of rental extention for 1 day
                        example: 36
                        minimum: 1
                      m_ext:
                        type: boolean
                        x-description-ru: Аналоговый алгоритм для продления
                        description: Analog algorythm for extention is enabled
                      freeze:
                        type: boolean
                        x-description-ru: 'Статус "заморозки" номера: если `true` - номер заморожен, и для продолжения аренды необходимо его разморозить'
                        description: 'Current "on hold" status: if `true` - the number was frozen/put on hold and it is required to `unfreeze` it before continue to use it again (to do so, go to the user dashboard)'
              examples:
                Successful rental extention response:
                  value:
                    response: 1
                    item:
                      status: 1
                      extension: 1
                      messages:
                        current_page: 1
                        data:
                          - - id: 1
                              service: Google
                              text: G-249833 – Ваш проверочный код.
                              code: '249833'
                              created_at: '2022-07-17 21:46:58'
                        from: 1
                        last_page: 1
                        per_page: 20
                        to: 1
                        total: 1
                      sum: 251.5
                      country: 7
                      checked_time: '2022-07-17 21:41:20'
                      number: '9915584307'
                      rent: 4
                      tzid: 22867974
                      time: 5750
                      days: 3
                      hours: 95
                      extend:
                        '1': 36
                        '3': 108
                        '7': 252
                        '15': 540
                        '30': 1080
                      checked: true
                      reload: 0
                      day_extend: 36
                      m_ext: false
                      freeze: false
      operationId: extendRentState
      security:
        - apikey: []
        - BearerAuth: []
        - OAuth2:
            - rent-scope
      x-description-ru: |-
        Продляет аренду на указанный период (в днях).



        Данный запрос необходим, когда срок аренды номера скоро истечет, но Вы планируете продолжить им пользоваться.


        >**ВАЖНО!**
        >
        >Стоит отметить, что данный запрос необходимо использовать только тогда, когда аренда все еще активна. Если срок аренды уже истек, Вы не сможете воспользоваться продлением.
      description: |-
        Extends a rent for a specified period (in days).



        This request is needed when your rental period is about to expire, but you plan to continue using it.


        >**IMPORTANT NOTE!**
        >
        >It is worth to mention, that this request is need to be sended only when the rent is still active. If the rent is already expired, you won't be able to extend it.
      parameters:
        - name: tzid
          in: query
          required: true
          schema:
            type: integer
            example: 10000
            minimum: 1
          x-description-ru: ID операции
          description: Operation ID
        - name: days
          in: query
          required: true
          schema:
            type: integer
            minimum: 0
            example: 15
          x-description-ru: 'Период продления аренды (в днях). Может принимать только значения, указанные в разделе `extend` ответа [getRentState](/ru/openapi_docs/Onlinesim-API-UN/get/api_rent_getRentState_php)'
          description: Extention period for rental number (in days). Can only accept values listed in `extend` section of [getRentState](/openapi_docs/Onlinesim-API-UN/get/api_rent_getRentState_php) response
        - $ref: '#/components/parameters/lang'
  /api/rent/getRentState.php:
    get:
      summary: getRentState
      tags:
        - rent
      responses:
        '200':
          x-description-ru: 'Успешный ответ на запрос `getRentState`: сервер возвращает информацию об указанной активной операции аренды (или обо всех текущих операциях аренды) или выбрасывает исключение.'
          description: 'Successful response for `getRentState` request: the server returns information of specified active rental operation (or all of them) or throws an exception.'
          content:
            application/json:
              schema:
                type: object
                x-examples:
                  example-1:
                    response: 1
                    list:
                      - status: 1
                        extension: 1
                        messages:
                          - id: 1
                            service: Google
                            text: G-249833 – Ваш проверочный код.
                            code: '249833'
                            created_at: '2022-07-17 21:46:58'
                        sum: '251.50'
                        country: 7
                        checked_time: '2022-07-17 21:41:20'
                        number: '9915584307'
                        rent: 4
                        tzid: 22867974
                        time: 5728
                        days: 3
                        hours: 95
                        extend:
                          '1': 36
                          '3': 108
                          '7': 252
                          '15': 540
                          '30': 1080
                        checked: true
                        reload: 0
                        day_extend: 36
                        m_ext: false
                        freeze: false
                properties:
                  response:
                    oneOf:
                      - type: integer
                      - type: string
                    x-description-ru: '1, если запрос был выполнен успешно, либо выведет сообщение об ошибке'
                    description: '1, if the request has been completed successfully, or an error message'
                    example: 1
                  list:
                    type: array
                    x-description-ru: Список текущих арендных операций
                    description: List of active rental operations
                    items:
                      type: object
                      properties:
                        status:
                          type: integer
                          example: 1
                          x-description-ru: 'Код статуса аренды, сразу после выдачи всегда `0`:


                            `0` - ожидание подтверждения операции (SMS должна быть получена в течение 20 минут после заказа, в противном случае операция будет отменена, а средства возвращены на баланс аккаунта)


                            `1` - аренда активна


                            `2` - **DEPRECATED** номер отключен


                            `3` - **DEPRECATED** ошибка аренды


                            `4` - номер был заморожен'
                          description: 'Status code of rent, upon issuing always `0`:


                            `0` - awaiting operation confirmation (SMS has to be received in the first 20 minutes after the order, else the operation will be refunded)


                            `1` - rent is active


                            `2` - **DEPRECATED** number is disabled


                            `3` - **DEPRECATED** rent error


                            `4` - number has been frozen/put on hold (rent has been paused)'
                          enum:
                            - 0
                            - 1
                            - 2
                            - 3
                            - 4
                        extension:
                          type: integer
                          x-description-ru: 'Доступность продления аренды этого номера:


                            `0` - продление недоступно


                            `1` - продление доступно


                            `2` - автопродление (аренда автоматически продлится на 30 дней по истечении текущего срока, если на балансе достаточно средств)'
                          description: 'Extention availability for this number:


                            `0` - extention is unavailable


                            `1` - extention is available


                            `2` - auto-renewal (the rental will be automatically extended for 30 days upon expiration, provided there are sufficient funds in the account)'
                          example: 1
                          enum:
                            - 0
                            - 1
                            - 2
                        messages:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                                x-description-ru: ID сообщения
                                description: Message ID
                                example: 1
                                minimum: 1
                              service:
                                type: string
                                x-description-ru: Номер или имя отправителя
                                description: Phone number or a name of a sender
                                example: Google
                              text:
                                type: string
                                x-description-ru: Текст SMS-сообщения
                                description: Context of the SMS
                                example: Your verification code is 070051
                              code:
                                type: string
                                x-description-ru: Цифровой код из SMS-сообщения
                                description: Short code
                                example: '070051'
                              created_at:
                                type: string
                                x-description-ru: Дата и время приема SMS-сообщения
                                description: Date and time when the message was received
                                example: '2022-07-17 21:46:58'
                        sum:
                          type: string
                          x-description-ru: Общая стоимость аренды (начальный период + периоды продления)
                          description: Total rental cost (initial period + extension periods)
                          example: '251.5'
                        country:
                          type: integer
                          x-description-ru: 'Международный телефонный код страны (согласно стандарту E.164, без знака "+"), смотри список кодов [стран](/ru/openapi_docs/reseller-api-un/custom/countries)'
                          description: 'International dialing code of the country (Е.164 standard, without "+" sign), see [country](/openapi_docs/reseller-api-un/custom/countries) list'
                          example: 46
                        checked_time:
                          type: string
                          x-description-ru: 'Дата и время взятия номера в аренду'
                          description: Date and time of number rental
                          example: '2022-07-17 21:41:20'
                        number:
                          type: string
                          x-description-ru: Выданный виртуальный номер (без кода страны)
                          description: Issued virtual phone number (without country code)
                          example: '9915584307'
                        rent:
                          type: integer
                          x-description-ru: 'Код статуса аренды, сразу после выдачи всегда `0`:


                            `0` - ожидание подтверждения операции (SMS должна быть получена в течение 20 минут после заказа, в противном случае операция будет отменена, а средства возвращены на баланс аккаунта)


                            `1` - аренда активна


                            `2` - **DEPRECATED** номер отключен


                            `3` - **DEPRECATED** ошибка аренды


                            `4` - номер был заморожен'
                          description: 'Status code of rent, upon issuing always `0`:


                            `0` - awaiting operation confirmation (SMS has to be received in the first 20 minutes after the order, else the operation will be refunded)


                            `1` - rent is active


                            `2` - **DEPRECATED** number is disabled


                            `3` - **DEPRECATED** rent error


                            `4` - number has been frozen/put on hold (rent has been paused)'
                          example: 4
                          enum:
                            - 0
                            - 1
                            - 2
                            - 3
                            - 4
                        tzid:
                          type: integer
                          x-description-ru: ID операции
                          description: Operation ID
                          minimum: 1
                          example: 10000
                        time:
                          type: integer
                          x-description-ru: 'Оставшееся время аренды, (в минутах)'
                          description: 'Remaining rent time, (in minutes)'
                          minimum: 1
                          example: 5750
                        days:
                          type: integer
                          x-description-ru: 'Оставшееся время аренды, (в днях)'
                          description: 'Remaining rent time, (in days)'
                          minimum: 0
                          example: 3
                        hours:
                          type: integer
                          x-description-ru: 'Оставшееся время аренды, (в часах)'
                          description: 'Remaining rent time, (in hours)'
                          minimum: 1
                          example: 95
                        extend:
                          type: object
                          x-description-ru: Стоимость продления
                          description: Extention price
                          properties:
                            '#period_in_days#':
                              type: integer
                              x-description-ru: Стоимость каждого доступного периода продления
                              description: Extention price for each available extention period
                              minimum: 1
                              example: 36
                        checked:
                          type: boolean
                          x-description-ru: 'Статус активации номера (для активации номер должен принять SMS в течение 20 минут после начала операции, в противном случае будет автоматически выполнен возврат средств, а операция закрыта)'
                          description: 'Rent status confirmation: if false SMS has to be received in the first 20 minutes after the order (after that status is switched to `true`), else the operation will be refunded.'
                        reload:
                          type: integer
                          x-description-ru: 'Доступность перезагрузки номера:


                            `0` - перезагрузка недоступна


                            `1` - перезагрузка доступна'
                          description: 'Availabitiy of reloading the number function:


                            `0` - reset unavailable


                            `1` - reset available'
                          example: 1
                        day_extend:
                          type: integer
                          x-description-ru: Стоимость продления аренды на 1 день
                          description: Price of rental extention for 1 day
                          example: 36
                          minimum: 1
                        m_ext:
                          type: boolean
                          x-description-ru: Аналоговый алгоритм для продления
                          description: Analog algorythm for rental extention is enabled
                        freeze:
                          type: boolean
                          x-description-ru: 'Статус "заморозки" номера: если `true` - номер заморожен, и для продолжения аренды необходимо его разморозить'
                          description: 'Current "on hold" status: if `true` - the number was frozen/put on hold and it is required to `unfreeze` it before continue to use it again (to do so, go to the user dashboard)'
              examples:
                Successful response to get all active rental operations:
                  value:
                    response: 1
                    list:
                      - status: 1
                        extension: 1
                        messages:
                          - id: 1
                            service: Google
                            text: G-249833 – Ваш проверочный код.
                            code: '249833'
                            created_at: '2022-07-17 21:46:58'
                        sum: '251.50'
                        country: 7
                        checked_time: '2022-07-17 21:41:20'
                        number: '9915584307'
                        rent: 4
                        tzid: 22867974
                        time: 5728
                        days: 3
                        hours: 95
                        extend:
                          '1': 36
                          '3': 108
                          '7': 252
                          '15': 540
                          '30': 1080
                        checked: true
                        reload: 0
                        day_extend: 36
                        m_ext: false
                        freeze: false
      operationId: getRentState
      x-description-ru: |
        Этот запрос возвращает список активных арендных номеров.



        Вы можете использовать его для быстрого просмотра всех активных арендных номеров (или только одного выбранного Вами) и полученных ими сообщений.
      description: |
        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:
            - rent-scope
      parameters:
        - schema:
            type: integer
          in: query
          name: tzid
          x-description-ru: 'ID операции.

            Если не указано, запрос вернет полный список арендных номеров Вашего профиля.'
          description: 'Operation ID.

            If not specified, request will return the entire list of active rental operations'
        - schema:
            type: boolean
            default: false
            example: false
          in: query
          name: pagination
          x-description-ru: Режим пагинации для обзора списка сообщений (если `false` - выключен)
          description: Pagination mode for message browsing (disabled if `false`)
        - $ref: '#/components/parameters/lang'
  /api/rent/closeRentNum.php:
    get:
      summary: closeRentNum
      tags:
        - rent
      responses:
        '200':
          x-description-ru: 'Успешный ответ на запрос `closeRentNum`: сервер закрывает текущую арендную операцию и возвращает информацию о ней или выбрасывает исключение.'
          description: 'Successful response for `closeRentNum` request: the server closes the current rental operation and returns information for it or throws an exception.'
          content:
            application/json:
              schema:
                type: object
                x-examples:
                  example-1:
                    response: true
                properties:
                  response:
                    type: boolean
                    x-description-ru: 'Статус выполнения запроса (если `true`, операция закрыта)'
                    description: 'Request execution status (if `true`, rental operation is closed)'
              examples:
                Successfuly closed rent operation:
                  value:
                    response: true
      operationId: closeRentNum
      x-description-ru: |
        Этот запрос закрывает указанную операцию аренды.


        >**ВАЖНО!**
        >
        >Закрытие операции аренды - это необратимый процесс: после закрытия Вы не сможете использовать данный номер, а восстановить доступ к нему будет невозможно!


        Этот запрос следует использовать только в том случае, когда Вы больше не планируете использовать данный арендный номер.
      description: |
        This request closes the specified rent operation.


        >**IMPORTANT NOTE!**
        >
        >Closing the operation is irreversible process: once you close the operation, you won't be able to use this rental number again.


        You should only use this request when you certain that this number is no longer needed.
      parameters:
        - name: tzid
          in: query
          required: true
          schema:
            type: integer
            example: 10000
            minimum: 1
          x-description-ru: ID операции
          description: Operation ID
        - $ref: '#/components/parameters/lang'
      security:
        - apikey: []
        - BearerAuth: []
        - OAuth2:
            - rent-scope
  /api/getBalance.php:
    get:
      summary: getBalance
      tags:
        - profile
      responses:
        '200':
          x-description-ru: 'Успешный ответ на запрос `getBalance`: сервер возвращает информацию о текущем статусе Вашего баланса или выбрасывает исключение.'
          description: 'Successful response for `getBalance` request: the server returns information on your current balance status or throws an exception.'
          content:
            application/json:
              schema:
                type: object
                x-examples:
                  example-1:
                    response: 1
                    balance: 2300.25
                    zbalance: 95.23
                properties:
                  response:
                    oneOf:
                      - type: integer
                      - type: string
                    x-description-ru: '1, если запрос был выполнен успешно, либо выведет сообщение об ошибке'
                    description: '1, if the request has been completed successfully, or an error message'
                    example: 1
                  balance:
                    type: string
                    x-description-ru: Текущий доступный баланс
                    description: Current available balance
                    example: '230.25'
                  zbalance:
                    type: number
                    x-description-ru: 'Замороженный баланс (зарезервированные средства для активных операций, которые вернутся при их отмене)'
                    description: Frozen balance (the funds reserved for active operations, which will be returned if those operations are cancelled)
                    example: 120.5
              examples:
                Successfull getBalance response example:
                  value:
                    response: '1'
                    balance: '106.32'
                    zbalance: 0
      operationId: getBalance
      x-description-ru: |-
        Этот запрос может быть использован для получения Вашего текущего баланса.



        Вы можете использовать данный запрос для проверки баланса профиля для создания уведомлений о необходимости пополнения, например для обработки исключения `WARNING_LOW_BALANCE`.
      description: |-
        This request can be used to get your current balance.



        You might use it to check the balance of the profile to top it up when needed (for example to handle `WARNING_LOW_BALANCE` exceptions).
      parameters:
        - schema:
            type: boolean
          in: query
          name: income
          x-description-ru: Информация о доходе по реферальной программе
          description: Information on affiliate program earnings
        - $ref: '#/components/parameters/lang'
      security:
        - apikey: []
        - BearerAuth: []
        - OAuth2:
            - sms-scope
    parameters: []
  /api/getFreeList:
    get:
      summary: getFreeList
      tags:
        - free numbers
      responses:
        '200':
          x-description-ru: 'Успешный ответ на запрос `getFreeList`: сервер возвращает информацию о бесплатных номерах и полученных ими сообщениях.'
          description: 'Successful response for `getFreeList` request: the server returns information on free numbers and messages they''ve received.'
          content:
            application/json:
              schema:
                type: object
                x-examples:
                  example-1:
                    response: 1
                    countries:
                      - country: 7
                        country_text: Россия
                      - country: 44
                        country_text: Британия
                      - country: 371
                        country_text: Латвия
                      - country: 31
                        country_text: Нидерланды
                      - country: 34
                        country_text: Испания
                      - country: 372
                        country_text: Эстония
                      - country: 33
                        country_text: Франция
                      - country: 370
                        country_text: Литва
                      - country: 358
                        country_text: Финляндия
                      - country: 1
                        country_text: США
                      - country: 46
                        country_text: Швеция
                      - country: 45
                        country_text: Дания
                      - country: 39
                        country_text: Италия
                      - country: 373
                        country_text: Молдова
                      - country: 351
                        country_text: Португалия
                      - country: 63
                        country_text: Филиппины
                      - country: 40
                        country_text: Румыния
                      - country: 212
                        country_text: Марокко
                    numbers:
                      '9915584911':
                        country: 7
                        data_humans: 6 дней назад
                        full_number: '+79915584911'
                        is_archive: false
                      '9915585003':
                        country: 7
                        data_humans: 6 дней назад
                        full_number: '+79915585003'
                        is_archive: false
                      '9585022921':
                        country: 7
                        data_humans: 6 дней назад
                        full_number: '+79585022921'
                        is_archive: false
                      '9647110985':
                        country: 7
                        data_humans: 3 дня назад
                        full_number: '+79647110985'
                        is_archive: false
                      '9099317316':
                        country: 7
                        data_humans: 3 дня назад
                        full_number: '+79099317316'
                        is_archive: false
                    messages:
                      current_page: 1
                      data:
                        - text: 74957982601 received from onlinesim.io
                          in_number: '***2601'
                          my_number: 9915584911
                          created_at: '2022-07-24 15:32:14'
                          data_humans: 1 минуту назад
                        - text: |-
                            Код для входа в ЛК: 4760
                            Zp7J+kC+gZH received from onlinesim.io
                          in_number: MegaMarket
                          my_number: 9915584911
                          created_at: '2022-07-24 15:27:46'
                          data_humans: 5 минут назад
                        - text: ​​347555 – код для входа в профиль CберМаркета urYIeVzPy+U received from onlinesim.io
                          in_number: Sbermarket
                          my_number: 9915584911
                          created_at: '2022-07-24 15:26:29'
                          data_humans: 6 минут назад
                        - text: 74997534479 received from onlinesim.io
                          in_number: '***4479'
                          my_number: 9915584911
                          created_at: '2022-07-24 15:25:02'
                          data_humans: 8 минут назад
                        - text: 79242727032 received from onlinesim.io
                          in_number: '***7032'
                          my_number: 9915584911
                          created_at: '2022-07-24 15:24:14'
                          data_humans: 9 минут назад
                        - text: 79094164115 received from onlinesim.io
                          in_number: '***4115'
                          my_number: 9915584911
                          created_at: '2022-07-24 15:23:12'
                          data_humans: 10 минут назад
                        - text: 74957982601 received from onlinesim.io
                          in_number: '***2601'
                          my_number: 9915584911
                          created_at: '2022-07-24 15:21:55'
                          data_humans: 11 минут назад
                        - text: 'Для входа на bookvoed.ru используйте Ваш номер телефона и пароль: 41123431 received from onlinesim.io'
                          in_number: bookvoed.ru
                          my_number: 9915584911
                          created_at: '2022-07-24 15:21:24'
                          data_humans: 12 минут назад
                        - text: 734570 – код для входа в профиль CберМаркета received from onlinesim.io
                          in_number: Sbermarket
                          my_number: 9915584911
                          created_at: '2022-07-24 15:21:04'
                          data_humans: 12 минут назад
                        - text: 74952133190 received from onlinesim.io
                          in_number: '***3190'
                          my_number: 9915584911
                          created_at: '2022-07-24 15:20:38'
                          data_humans: 12 минут назад
                      first_page_url: 'https://onlinesim.io/api/getFreeList?page=1'
                      from: 1
                      last_page: 610
                      last_page_url: 'https://onlinesim.io/api/getFreeList?page=610'
                      links:
                        - url: null
                          label: '&laquo; Назад'
                          active: false
                        - url: 'https://onlinesim.io/api/getFreeList?page=1'
                          label: '1'
                          active: true
                        - url: 'https://onlinesim.io/api/getFreeList?page=2'
                          label: '2'
                          active: false
                        - url: 'https://onlinesim.io/api/getFreeList?page=3'
                          label: '3'
                          active: false
                        - url: 'https://onlinesim.io/api/getFreeList?page=4'
                          label: '4'
                          active: false
                        - url: 'https://onlinesim.io/api/getFreeList?page=5'
                          label: '5'
                          active: false
                        - url: 'https://onlinesim.io/api/getFreeList?page=6'
                          label: '6'
                          active: false
                        - url: 'https://onlinesim.io/api/getFreeList?page=7'
                          label: '7'
                          active: false
                        - url: 'https://onlinesim.io/api/getFreeList?page=8'
                          label: '8'
                          active: false
                        - url: 'https://onlinesim.io/api/getFreeList?page=9'
                          label: '9'
                          active: false
                        - url: 'https://onlinesim.io/api/getFreeList?page=10'
                          label: '10'
                          active: false
                        - url: null
                          label: ...
                          active: false
                        - url: 'https://onlinesim.io/api/getFreeList?page=609'
                          label: '609'
                          active: false
                        - url: 'https://onlinesim.io/api/getFreeList?page=610'
                          label: '610'
                          active: false
                        - url: 'https://onlinesim.io/api/getFreeList?page=2'
                          label: Вперёд &raquo;
                          active: false
                      next_page_url: 'https://onlinesim.io/api/getFreeList?page=2'
                      path: 'https://onlinesim.io/api/getFreeList'
                      per_page: 10
                      prev_page_url: null
                      to: 10
                      total: 6100
                      number: '9915584911'
                      country: 7
                    ignore: '<p><strong>Номера телефонов, полученные на данном сервисе, не должны быть использованы в любых противозаконных действиях. Запрещено использовать номера телефонов для сайтов имеющих статус повышенного риска, к которым относятся: платежные системы, банки, кредитные организации, в том числе и некоторые букмекерские конторы, через которые возможна регистрация QIWI кошелька.</strong></p><p>Имена отправителей, от которых сервис не принимает СМС:</p><p>creditman, joyzaim.ru, qiwi_wallet, ideabank, zaimy.rf, colendi, banknote, paysending, cimb_bank, mrmoney@, paysenger, elecsnet, groshivsim, onefinrucom, telemaster, megafontv, web-zaim.ru, otkritie, rublimo.ru, soscredit, creditnice, ckasa24@, paycenter, rubliru.ru, bank.ipb, novikredyty, gosuslugi, banksoyuz, monebo.ru, freezaym.ru, monexy, moneyqlo.ru, ax-airbnk, cashtoyouru, dengidengi, bystro-zaim, credit7, gurucash, altyn-i@, BeelineClub, z_korona, erubli.ru, bankpekaosa, expobank, pimpay, 4slovo.ru, vodafone, cash4brands.ru, unocreditru, ad-walrsz, creditbox, dengas.ru, bankera, sgroshi7, 2mycard@, pumb, cash credit, finmoll@, kf.ua, megafon, migcredit, lovilave, mchsrt, paynamics, jk-jiopay, rosbank, centrzaim, slot78, denga34.ru, truemoney, concredit24, cash-u.com, expresdengi, manivam.ru, oschadbank, proleads, zaim-fin.ru, dit_dogm, moonpay@, joompay, gcash, kviku, ripplebank, fin2fin@, wallethub, shv.groshi, zaimer.kz, smartcredit, kaspikredit, enot.io, privatbank, budget4me34, vivid money, mangomoney, my_creditua, apollonzaym, boc, right-zaim, skrill, m-faktura, ininal, wmmini, helpkredit, sportbank, gotivo4ka, gpay, zaimol.ru, mili.ru, nicezaimonl, moniepoint, vkpay, 3339, zaimov.ru, thinkmoney, mistercash, otp bank, rsb.ru, anc, etzaimo.ru, migcred.ru, zaimika, tbankrot, skredit.su, bank_akcept, kit_notify, moneygo@, credit-pro, 20697, cash-u, kasa credit, likecentre, mycreditua, givemoney, kaspi gold, ukrpozyka, vitrinmoney, mts-bank, odobrim.ru, firstbank, miloan.ua, credit7.ru, stripe, accessbank, cash-1.ru, finanso_kz, aviracredit, homecredit, netcredit, mywallet, dinero, pochtabank, hyperpay, wooppay.com, activebc, ckasa, websetting, phonecode, kumo, denizbank, neteller, shgroshi, denvzaimy, zamzam, kreditker, 3karmana.ru, vtbconnect, loanklik, airtel, trans kod, юнистрим, sberid, pluscardsru, payps, credinf24ru, qppiru,  kyivstar, monzo, creditax.ru, topcredit, cashpoint, good-zaimru, bankdki, dkb ag, uplata, goodmoneyru, krplusso.ru, microklad, monezp.ru, 9138, airbnk, qicard, ukrgasbank, wurussia, money-my.ru, icard, swedbank, wemabank, resobank, muchbetter, papazaim, jd-payzap, kredit-3000, credify@, zecredit, max.credit, ^zen$, dobrokredi, rostelecom, veomini@, denga, 0dobren0.ru, asakabank, moneyveo, nakartuuua, smsfinance, lime-zaim, mc_bbonus, el-plat.ru, alexcredit, sms2money, ferratum, paylaterph, moneyyourgo, am-airbnk, magnitpay, jysan bank, bank mellat, paysafecard, epa, boomaney.ru , greenmoney, glavfinans, cashrush, ya.invest, ecopayz, alfabank, fingo, tw team, mikrozaym, sovest, kazinfo, eurogroshi, kredizka.ru, joymoney, bkapmahe, mastercard, belkacredit, koronapay, globalcredi, medialid.ru, monobank, ezaem, imoney, tele2, vivus, modulbank, moneyextra, zaem48.ru, tobizaim, shvgroshi, pays.de, payzap, garantibbva, pozyka, tcktswallet, vipzaym, vivus.ru, 900, rublikom.ru, credit, mzaim24.ru, pancredit, finterra, bistrodenga.ru, kaspi.kz, banktochka, 24h.tv, simply, my-credit, bankamoney, proplati, tinkoff, rubli.ru, ekapusta, vostbank.ru, kaspi bank, beeline@, mtc.gid@, spoko, ubank, kreditcentr, yandexmoney, touch bank, dengimy.ru, gcb bank, paymaya@, psb, nuum, raiffeisen, zaimy24_7ru, mmoney24.ru, walletone, revolut@, monese, sirumobile, vloan, megafon_web, portmone, dengisrazu, grivni, dcredit, centrofin, usovromv, qiwi, zaimall24ru, rschs, vsemzaim, n26, my beeline, globalmoney, swizo, privatbank24, creditplus, way for pay, vzaimy24ru, kredit-24, payoneer, mobitel, payqr, prem-zaimru, zaim_online, creditter, gratapay, 9016451088, creditnice., free-zaim, slavzaim.ru, homebank, mzaim365.ru, boomaney.ru, paysend.com, home_credit, oncredit, lovizaim, gotivka, kapitalbank, web setting, seabank@, 9705844559, amzaim.ru, payeer.com, spishi.vip, indosat@, dzbr.ru@, sloncredit, fincredit, bankapp, zaymigo.com, dengga, wm check, bankffin, tendopay, cashni.ru, vm-mobikw, jm-payzap, weststein, wmcheck, zaimm365.ru, enot, darimcashru, halkbank, bp-ipaytm, turbomoney, money4you, rencredit, megafonpro, ccloan, cashdrive, advcash, 1clickmoney, clubzaim.ru, kerimov@, gazprombank, authy, sfurf.ru, mecred.ru, rnko card, gammamedia, creditport, alfa-bank, mtinkoff, unicredit, halkbank., megafon@, papara, wu russia, starkredit, e-cash, interkassa, whoosh.bike, izibank, sberbank.kz, mycredit, post kassa, mycredit.ua, creditkinsu, wirex, fortebank, platipotom, finkot.ru, cardcompact, paycell, jusan bank, creditstar, vm-homecr, mykreditpin, finspin, 5151, loanklik.ru, creditkasa, b-gift, finansbyrg, fastmoney, ad-payzap, pay-zaim.ru, unistream, paysera@, khan bank, bankera@, openbroker, 1020, tengeda.kz], paypal, teremzaim, sms.kaz@, todobank, credit_plus, fedorosu, fidorbank, cr911.ru, rightzaimon, zaimco, sberbank_ua, moneypay, mts.dengi, moneyman, 43676800325055, go2bank, 396, nakredit, whoosh, zaim_tobi, ruszaim24, cardsmobile, creditronic, halykbank, cashinsky, finme.ua, jaiz bank, mts.invest, unicom24, carduri, papaya, kredito24, spasibo, kyivstar, bestzaimo.ru, bistrodengi, klarna, vsezaimy24, wallet one, bilgimsj, smszaym.ru, ukrmoney, jiopay, kaspi pay, kto zvonil, kredit, 679, bankovo@, finica.ru, yoomoney, liqpay, concordbank, smartiway, 878, beeinfo, 6058464526, robotmoney, eurozaem, cashmo, cash22.ru, cryptowallet, bankvtb@, monebo, investrum, you banka, konga, mnedenga.ru, dit_emp@, skycash, paygoo, credit-help, sbrf, rshb, swip.one, moneysend, alizaim, finmarket, wink, inbank, wmru, mobi.dengi, vakifbank, abank, qppi.ru, frisbi24, denegna.ru, webbankir, colibrideng, needzaim.ru, mtc, vivadengi, Kyivstar, a-business, bp-paytmb, 131881, na kartu, ckassa.ru, qiwi wallet, egroshicom, lycamobile, platiza, beelineroam, safebank.ru, leupay, paysend, ddmoney.ru, jd-dbsbnk, ffcredit, [mywallet], tengo, ukredit, slimpay, gofingo, beeline, creditseven, 243897238, 1711, zaymigo@, boostra@, fin4go, vtb, much money, bank_dom.rf, 0500, sdb bank, ja-jiopay, binbankcard, vm-pnbacs, skb-bank, debetkredit, paycam, rubasy.ru, av-airbnk, kasacredit, alfa, activ, zaymer.ru, ay-airbnk, dengisrazy, [money2dayru], platiza.ru, yota, keny.cc, citibank, forzacredit, crediton, wise, 99deneg.ru, easypay, vozmi365.ru, 1cashu.ru, 4915730302462, jy-jiopay, notify_kz, neocredit, extracredi, onlinecred, 1415, bankasi, smartbank, ruszaim24ru, unionbank, sbankers, zaimm24.ru, smartmoney, gigalifeapp, ziraatbank, kupinekopi, infobankcrp, getzaim24ru, vimpay, zaimy24.ru, sumup, webmoney.ua, moynalog, tx-walrsz, cash app, 2017536013, rnko_card, metrokredit, moneyhy.ru, creditup, bankovo.ru, creditka, bankacredit, cec bank, dengi dozp, atzaim.ru, rncb, webmoney, solcredito, globusbank, mchs, ae-airbnk, ad-kblbnk, mobikw, mtspodpiski, goodcredit, ezaem.ru, solarisbank, zaim, zen.com, 111, transferwise, big-zaim.ru, pscb, touch_bank, kontist, dit_moslog, robmoney.ru, qiwiinfo, 12264019433, zaimexpress, mos.com.ru, ipakyuli, gojek, cashberry, credit25000, microcash, planetacash, ax-mobikw, 37128914187, mccquattro, rocketbank, +447385577408, arbuzo, sovcombank, kachaigrosi, zajavka@, mos.ru, corezaimonl, sharpay, khanbank, visa, qiwiwallet, wm mini, fns_russia, moneza, akbank, turbozaim, moneyboom, touchbank, unicom24ru, khan, cpzaim.ru, webzaim-mkk, centrzaimov, uazaimi@, dozarplati, platizaru, dukascopy, telepay, avantmoney, rubliner.ru</p>'
                properties:
                  response:
                    anyOf:
                      - type: string
                        properties: {}
                      - type: number
                        properties: {}
                    x-description-ru: '1, если запрос был выполнен успешно, либо выведет сообщение об ошибке'
                    description: '1, if the request has been completed successfully, or an error message'
                  countries:
                    type: array
                    x-description-ru: Массив стран с их соответствующими международными телефонными кодами
                    description: Array of countries with their corresponding international phone codes
                    items:
                      type: object
                      properties:
                        country:
                          type: integer
                          x-description-ru: 'Международный телефонный код страны (согласно стандарту E.164, без знака "+"), смотри список кодов [стран](/ru/openapi_docs/reseller-api-un/custom/countries)'
                          description: 'International dialing code of the country (Е.164 standard, without "+" sign), see [country](/openapi_docs/reseller-api-un/custom/countries) list'
                          minimum: 1
                          example: 46
                          default: 7
                        country_text:
                          type: string
                          x-description-ru: Название страны, которой принадлежит мобильный номер
                          description: Country name, to which mobile number belongs
                          example: Sweden
                  numbers:
                    type: object
                    properties:
                      '#number#':
                        type: object
                        x-description-ru: 'Номер телефона, без кода страны'
                        description: Phone number without a country code
                        properties:
                          country:
                            type: integer
                            x-description-ru: 'Международный телефонный код страны (согласно стандарту E.164, без знака "+"), смотри список кодов [стран](/ru/openapi_docs/reseller-api-un/custom/countries)'
                            description: 'International dialing code of the country (Е.164 standard, without "+" sign), see [country](/openapi_docs/reseller-api-un/custom/countries) list'
                            minimum: 1
                            example: 46
                            default: 7
                          data_humans:
                            type: string
                            x-description-ru: Как давно номер был размещен
                            description: How long ago the number was placed
                            example: 6 days ago
                          full_number:
                            type: string
                            x-description-ru: 'Номер телефона в между народном формате, со знаком "+"'
                            description: Phone number in the international format with "+" sign
                            example: '+79915584911'
                          is_archive:
                            type: boolean
                            x-description-ru: Был ли номер помещен в архив (недоступен для использования на момент запроса) - true/false
                            description: Was number placed in archive (unavailable for use at the time of request) - true/false
                  messages:
                    type: object
                    x-description-ru: Сообщения с бесплатных номеров
                    description: Free numbers messages
                    properties:
                      current_page:
                        type: integer
                        x-description-ru: 'Все сообщения отсортированы в обратном хронологическом порядке и сгруппированы по страницам, каждая из которых содержит 10 сообщений (первая страница содержит последние 10 сообщений)'
                        description: 'All messages are sorted in reverse chronological order and are grouped into pages, each containing 10 messages (first page contains the last 10 messages)'
                        example: 1
                        minimum: 1
                      data:
                        type: array
                        items:
                          type: object
                          properties:
                            text:
                              type: string
                              x-description-ru: Текст SMS-сообщения
                              description: SMS context
                            in_number:
                              type: string
                              x-description-ru: Номер или имя отправителя
                              description: Phone number or name of a sender
                            my_number:
                              type: integer
                              x-description-ru: Бесплатный номер, который получил данное SMS
                              description: Free number that has received the current SMS
                            created_at:
                              type: string
                              x-description-ru: Дата и время получения сообщения
                              description: Date and time when the message was received
                            data_humans:
                              type: string
                              x-description-ru: Как давно номер был размещен
                              description: How long ago the number was placed
                              example: 6 days ago
                      first_page_url:
                        type: string
                        x-description-ru: URL первой страницы этого списка сообщений
                        description: URL of the first page of this message list
                      from:
                        type: integer
                        x-description-ru: Номер первого сообщения на этой странице
                        description: Number of the first message on this page
                      last_page:
                        type: integer
                        x-description-ru: Номер последней страницы с полученными SMS-сообщениями
                        description: Number of last page with received SMS messages
                      last_page_url:
                        type: string
                        x-description-ru: URL последней страницы этого списка сообщений
                        description: URL of the last page of this message list
                      links:
                        type: array
                        x-description-ru: Массив URL'ов для навигации по страницам
                        description: Array of URLs for navigation
                        items:
                          type: object
                          properties:
                            url:
                              type: string
                              x-description-ru: URL'ы для пагинации
                              description: URLs for pagination
                            label:
                              type: string
                              x-description-ru: Отображаемое имя кнопки с указанием номера страницы
                              description: Displayed name of the button (page number indication)
                            active:
                              type: boolean
                              x-description-ru: Активна ли эта кнопка сейчас (находится ли пользователь на данной странице сообщений)
                              description: Is this button active (is user currently on this page of SMS messages)
                      next_page_url:
                        type: string
                        x-description-ru: URL для следующей страницы (переходит следующую страницу сообщений)
                        description: URL for the next page (opens the next page)
                      path:
                        type: string
                        x-description-ru: Адрес endpoint'a текущего API
                        description: API endpoint path
                      per_page:
                        type: integer
                        x-description-ru: Количество сообщений, отображаемых на одной странице
                        description: Amount of messages displayed on a single page
                      prev_page_url:
                        type: string
                        x-description-ru: URL для кнопки "Назад" (возвращает на одну страницу из списка назад)
                        description: URL for the "Back" button (returns one page back)
                      to:
                        type: integer
                        x-description-ru: Номер последнего сообщения на текущей странице
                        description: Number of the last message on the current page
                      total:
                        type: integer
                        x-description-ru: Общее количество полученных этим номером сообщений
                        description: Total amount of SMS received by this number
                      number:
                        type: string
                        x-description-ru: Номер телефона, без кода страны
                        description: Phone number without a country code
                      country:
                        type: integer
                        x-description-ru: 'Международный телефонный код страны (согласно стандарту E.164, без знака "+"), смотри список кодов [стран](/ru/openapi_docs/reseller-api-un/custom/countries)'
                        description: 'International dialing code of the country (Е.164 standard, without "+" sign), see [country](/openapi_docs/reseller-api-un/custom/countries) list'
                        example: 46
                        default: 7
                        minimum: 1
                  ignore:
                    type: string
                    x-description-ru: Список запрещенных сервисов (SMS-сообщения от этих сервисов недоступны)
                    description: List of restricted services (SMS from these services are unavailable)
              examples:
                Successful getFreeList response example (no parameters passed):
                  value:
                    response: 1
                    countries:
                      - country: 7
                        country_text: Россия
                      - country: 380
                        country_text: Украина
                      - country: 77
                        country_text: Казахстан
                      - country: 44
                        country_text: Британия
                      - country: 371
                        country_text: Латвия
                      - country: 31
                        country_text: Нидерланды
                      - country: 34
                        country_text: Испания
                      - country: 372
                        country_text: Эстония
                      - country: 33
                        country_text: Франция
                      - country: 358
                        country_text: Финляндия
                      - country: 1
                        country_text: США
                      - country: 46
                        country_text: Швеция
                      - country: 39
                        country_text: Италия
                      - country: 351
                        country_text: Португалия
                      - country: 57
                        country_text: Колумбия
                      - country: 40
                        country_text: Румыния
                      - country: 212
                        country_text: Марокко
                    numbers:
                      '9099317316':
                        country: 7
                        data_humans: 6 дней назад
                        full_number: '+79099317316'
                        is_archive: false
                      '9585027963':
                        country: 7
                        data_humans: 2 дня назад
                        full_number: '+79585027963'
                        is_archive: false
                      '9915584205':
                        country: 7
                        data_humans: 2 дня назад
                        full_number: '+79915584205'
                        is_archive: false
                      '9915584176':
                        country: 7
                        data_humans: 2 дня назад
                        full_number: '+79915584176'
                        is_archive: false
                    messages:
                      current_page: 1
                      data:
                        - text: 78123854000 received from onlinesim.io
                          in_number: '***4000'
                          my_number: 9099317316
                          created_at: '2022-07-27 16:44:21'
                          data_humans: 51 секунду назад
                        - text: 78123854000 received from onlinesim.io
                          in_number: '***4000'
                          my_number: 9099317316
                          created_at: '2022-07-27 16:43:47'
                          data_humans: 1 минуту назад
                        - text: 74957907277 received from onlinesim.io
                          in_number: '***7277'
                          my_number: 9099317316
                          created_at: '2022-07-27 16:36:44'
                          data_humans: 8 минут назад
                        - text: 74952235485 received from onlinesim.io
                          in_number: '***5485'
                          my_number: 9099317316
                          created_at: '2022-07-27 16:35:29'
                          data_humans: 9 минут назад
                        - text: Ваш пароль 32166113 received from onlinesim.io
                          in_number: FCKRASNODAR
                          my_number: 9099317316
                          created_at: '2022-07-27 16:35:00'
                          data_humans: 10 минут назад
                        - text: 'Введите 5407, чтобы подтвердить телефон в интернет-магазине е2е4 received from onlinesim.io'
                          in_number: e2e4
                          my_number: 9099317316
                          created_at: '2022-07-27 16:31:13'
                          data_humans: 13 минут назад
                        - text: 79515984891 received from onlinesim.io
                          in_number: '***4891'
                          my_number: 9099317316
                          created_at: '2022-07-27 16:27:23'
                          data_humans: 17 минут назад
                        - text: 79622137000 received from onlinesim.io
                          in_number: '***7000'
                          my_number: 9099317316
                          created_at: '2022-07-27 16:24:37'
                          data_humans: 20 минут назад
                        - text: 79622137000 received from onlinesim.io
                          in_number: '***7000'
                          my_number: 9099317316
                          created_at: '2022-07-27 16:20:51'
                          data_humans: 24 минуты назад
                        - text: 79628078162 received from onlinesim.io
                          in_number: '***8162'
                          my_number: 9099317316
                          created_at: '2022-07-27 16:11:23'
                          data_humans: 33 минуты назад
                      first_page_url: 'https://onlinesim.io/api/getFreeList?page=1'
                      from: 1
                      last_page: 341
                      last_page_url: 'https://onlinesim.io/api/getFreeList?page=341'
                      links:
                        - url: null
                          label: '&laquo; Назад'
                          active: false
                        - url: 'https://onlinesim.io/api/getFreeList?page=1'
                          label: '1'
                          active: true
                        - url: 'https://onlinesim.io/api/getFreeList?page=2'
                          label: '2'
                          active: false
                        - url: 'https://onlinesim.io/api/getFreeList?page=3'
                          label: '3'
                          active: false
                        - url: 'https://onlinesim.io/api/getFreeList?page=4'
                          label: '4'
                          active: false
                        - url: 'https://onlinesim.io/api/getFreeList?page=5'
                          label: '5'
                          active: false
                        - url: 'https://onlinesim.io/api/getFreeList?page=6'
                          label: '6'
                          active: false
                        - url: 'https://onlinesim.io/api/getFreeList?page=7'
                          label: '7'
                          active: false
                        - url: 'https://onlinesim.io/api/getFreeList?page=8'
                          label: '8'
                          active: false
                        - url: 'https://onlinesim.io/api/getFreeList?page=9'
                          label: '9'
                          active: false
                        - url: 'https://onlinesim.io/api/getFreeList?page=10'
                          label: '10'
                          active: false
                        - url: null
                          label: ...
                          active: false
                        - url: 'https://onlinesim.io/api/getFreeList?page=340'
                          label: '340'
                          active: false
                        - url: 'https://onlinesim.io/api/getFreeList?page=341'
                          label: '341'
                          active: false
                        - url: 'https://onlinesim.io/api/getFreeList?page=2'
                          label: Вперёд &raquo;
                          active: false
                      next_page_url: 'https://onlinesim.io/api/getFreeList?page=2'
                      path: 'https://onlinesim.io/api/getFreeList'
                      per_page: 10
                      prev_page_url: null
                      to: 10
                      total: 3404
                      number: '9099317316'
                      country: 7
                    ignore: '<p><strong>Номера телефонов, полученные на данном сервисе, не должны быть использованы в любых противозаконных действиях. Запрещено использовать номера телефонов для сайтов имеющих статус повышенного риска, к которым относятся: платежные системы, банки, кредитные организации, в том числе и некоторые букмекерские конторы, через которые возможна регистрация QIWI кошелька.</strong></p><p>Имена отправителей, от которых сервис не принимает СМС:</p><p>creditman, joyzaim.ru, qiwi_wallet, ideabank, zaimy.rf, colendi, banknote, paysending, cimb_bank, mrmoney@, paysenger, elecsnet, groshivsim, onefinrucom, telemaster, megafontv, web-zaim.ru, otkritie, rublimo.ru, soscredit, creditnice, ckasa24@, paycenter, rubliru.ru, bank.ipb, novikredyty, gosuslugi, banksoyuz, monebo.ru, freezaym.ru, monexy, moneyqlo.ru, ax-airbnk, cashtoyouru, dengidengi, bystro-zaim, credit7, gurucash, altyn-i@, BeelineClub, z_korona, erubli.ru, bankpekaosa, expobank, pimpay, 4slovo.ru, vodafone, cash4brands.ru, unocreditru, ad-walrsz, creditbox, dengas.ru, bankera, sgroshi7, 2mycard@, pumb, cash credit, finmoll@, kf.ua, megafon, migcredit, lovilave, mchsrt, paynamics, jk-jiopay, rosbank, centrzaim, slot78, denga34.ru, truemoney, concredit24, cash-u.com, expresdengi, manivam.ru, oschadbank, proleads, zaim-fin.ru, dit_dogm, moonpay@, joompay, gcash, kviku, ripplebank, fin2fin@, wallethub, shv.groshi, zaimer.kz, smartcredit, kaspikredit, enot.io, privatbank, budget4me34, vivid money, mangomoney, my_creditua, apollonzaym, boc, right-zaim, skrill, m-faktura, ininal, wmmini, helpkredit, sportbank, gotivo4ka, gpay, zaimol.ru, mili.ru, nicezaimonl, moniepoint, vkpay, 3339, zaimov.ru, thinkmoney, mistercash, otp bank, rsb.ru, anc, etzaimo.ru, migcred.ru, zaimika, tbankrot, skredit.su, bank_akcept, kit_notify, moneygo@, credit-pro, 20697, cash-u, kasa credit, likecentre, mycreditua, givemoney, kaspi gold, ukrpozyka, vitrinmoney, mts-bank, odobrim.ru, firstbank, miloan.ua, credit7.ru, stripe, accessbank, cash-1.ru, finanso_kz, aviracredit, homecredit, netcredit, mywallet, dinero, pochtabank, hyperpay, wooppay.com, activebc, ckasa, websetting, phonecode, kumo, denizbank, neteller, shgroshi, denvzaimy, zamzam, kreditker, 3karmana.ru, vtbconnect, otzovik, loanklik, airtel, trans kod, юнистрим, sberid, pluscardsru, payps, credinf24ru, qppiru,  kyivstar, monzo, creditax.ru, topcredit, cashpoint, good-zaimru, bankdki, dkb ag, uplata, goodmoneyru, krplusso.ru, microklad, monezp.ru, 9138, airbnk, qicard, ukrgasbank, wurussia, money-my.ru, icard, swedbank, wemabank, resobank, muchbetter, papazaim, jd-payzap, kredit-3000, credify@, zecredit, max.credit, ^zen$, dobrokredi, rostelecom, veomini@, denga, 0dobren0.ru, asakabank, moneyveo, nakartuuua, smsfinance, lime-zaim, mc_bbonus, el-plat.ru, alexcredit, sms2money, ferratum, paylaterph, moneyyourgo, am-airbnk, magnitpay, jysan bank, bank mellat, paysafecard, epa, boomaney.ru , greenmoney, glavfinans, cashrush, ya.invest, ecopayz, alfabank, fingo, tw team, mikrozaym, sovest, kazinfo, eurogroshi, kredizka.ru, joymoney, bkapmahe, mastercard, belkacredit, koronapay, globalcredi, medialid.ru, monobank, ezaem, imoney, tele2, vivus, modulbank, moneyextra, zaem48.ru, tobizaim, shvgroshi, pays.de, payzap, garantibbva, pozyka, tcktswallet, vipzaym, vivus.ru, 900, rublikom.ru, credit, mzaim24.ru, pancredit, finterra, bistrodenga.ru, kaspi.kz, banktochka, 24h.tv, simply, my-credit, bankamoney, proplati, tinkoff, rubli.ru, ekapusta, vostbank.ru, kaspi bank, beeline@, mtc.gid@, spoko, ubank, kreditcentr, yandexmoney, touch bank, dengimy.ru, gcb bank, paymaya@, psb, nuum, raiffeisen, zaimy24_7ru, mmoney24.ru, walletone, revolut@, monese, sirumobile, vloan, megafon_web, portmone, dengisrazu, grivni, dcredit, centrofin, usovromv, qiwi, zaimall24ru, rschs, vsemzaim, n26, my beeline, globalmoney, swizo, privatbank24, creditplus, way for pay, vzaimy24ru, kredit-24, payoneer, mobitel, payqr, prem-zaimru, zaim_online, creditter, gratapay, 9016451088, creditnice., free-zaim, slavzaim.ru, homebank, mzaim365.ru, boomaney.ru, paysend.com, home_credit, oncredit, lovizaim, gotivka, kapitalbank, web setting, seabank@, 9705844559, amzaim.ru, payeer.com, spishi.vip, indosat@, dzbr.ru@, sloncredit, fincredit, bankapp, zaymigo.com, dengga, wm check, bankffin, tendopay, cashni.ru, vm-mobikw, jm-payzap, weststein, wmcheck, zaimm365.ru, enot, darimcashru, halkbank, bp-ipaytm, turbomoney, money4you, rencredit, megafonpro, ccloan, cashdrive, advcash, 1clickmoney, clubzaim.ru, kerimov@, gazprombank, authy, sfurf.ru, mecred.ru, rnko card, gammamedia, creditport, alfa-bank, mtinkoff, unicredit, halkbank., megafon@, papara, wu russia, starkredit, e-cash, interkassa, whoosh.bike, izibank, sberbank.kz, mycredit, post kassa, mycredit.ua, creditkinsu, wirex, fortebank, platipotom, finkot.ru, cardcompact, paycell, jusan bank, creditstar, vm-homecr, mykreditpin, finspin, 5151, loanklik.ru, creditkasa, b-gift, finansbyrg, fastmoney, ad-payzap, pay-zaim.ru, unistream, paysera@, khan bank, bankera@, openbroker, 1020, tengeda.kz], paypal, teremzaim, sms.kaz@, todobank, credit_plus, fedorosu, fidorbank, cr911.ru, rightzaimon, zaimco, sberbank_ua, moneypay, mts.dengi, moneyman, 43676800325055, go2bank, 396, nakredit, whoosh, zaim_tobi, ruszaim24, cardsmobile, creditronic, halykbank, cashinsky, finme.ua, jaiz bank, mts.invest, unicom24, carduri, papaya, kredito24, spasibo, kyivstar, bestzaimo.ru, bistrodengi, klarna, vsezaimy24, wallet one, bilgimsj, smszaym.ru, ukrmoney, jiopay, kaspi pay, kto zvonil, kredit, 679, bankovo@, finica.ru, yoomoney, liqpay, concordbank, smartiway, 878, beeinfo, 6058464526, robotmoney, eurozaem, cashmo, cash22.ru, cryptowallet, bankvtb@, monebo, investrum, you banka, konga, mnedenga.ru, dit_emp@, skycash, paygoo, credit-help, sbrf, rshb, swip.one, moneysend, alizaim, finmarket, wink, inbank, wmru, mobi.dengi, vakifbank, abank, qppi.ru, frisbi24, denegna.ru, webbankir, colibrideng, needzaim.ru, mtc, vivadengi, Kyivstar, a-business, bp-paytmb, 131881, na kartu, ckassa.ru, qiwi wallet, egroshicom, lycamobile, platiza, beelineroam, safebank.ru, leupay, paysend, ddmoney.ru, jd-dbsbnk, ffcredit, [mywallet], tengo, ukredit, slimpay, gofingo, beeline, creditseven, 243897238, 1711, zaymigo@, boostra@, fin4go, vtb, much money, bank_dom.rf, 0500, sdb bank, ja-jiopay, binbankcard, vm-pnbacs, skb-bank, debetkredit, paycam, rubasy.ru, av-airbnk, kasacredit, alfa, activ, zaymer.ru, ay-airbnk, dengisrazy, [money2dayru], platiza.ru, yota, keny.cc, citibank, forzacredit, crediton, wise, 99deneg.ru, easypay, vozmi365.ru, 1cashu.ru, 4915730302462, jy-jiopay, notify_kz, neocredit, extracredi, onlinecred, 1415, bankasi, smartbank, ruszaim24ru, unionbank, sbankers, zaimm24.ru, smartmoney, gigalifeapp, ziraatbank, kupinekopi, infobankcrp, getzaim24ru, vimpay, zaimy24.ru, sumup, webmoney.ua, moynalog, tx-walrsz, cash app, 2017536013, rnko_card, metrokredit, moneyhy.ru, creditup, bankovo.ru, creditka, bankacredit, cec bank, dengi dozp, atzaim.ru, rncb, webmoney, solcredito, globusbank, mchs, ae-airbnk, ad-kblbnk, mobikw, mtspodpiski, goodcredit, ezaem.ru, solarisbank, zaim, zen.com, 111, transferwise, big-zaim.ru, pscb, touch_bank, kontist, dit_moslog, robmoney.ru, qiwiinfo, 12264019433, zaimexpress, mos.com.ru, ipakyuli, gojek, cashberry, credit25000, microcash, planetacash, ax-mobikw, 37128914187, mccquattro, rocketbank, +447385577408, arbuzo, sovcombank, kachaigrosi, zajavka@, mos.ru, corezaimonl, sharpay, khanbank, visa, qiwiwallet, wm mini, fns_russia, moneza, akbank, turbozaim, moneyboom, touchbank, unicom24ru, khan, cpzaim.ru, webzaim-mkk, centrzaimov, uazaimi@, dozarplati, platizaru, dukascopy, telepay, avantmoney, rubliner.ru</p>'
      operationId: getFreeList
      x-description-ru: |-
        В зависимости от параметров возвращает информацию о доступных странах с бесплатными номерами, полученных ими сообщениях и списком запрещенных сервисов.



        Без параметров: возвращает список доступных стран с бесплатными номерами, сообщениями, полученным первым номером из этого списка и списком запрещенных сервисов.



        С параметром `country`: возвращает список доступных бесплатных номеров этой страны, сообщений, полученных первым номером из этого списка и списком запрещенных сервисов.



        С параметрами `country` и `number`: возвращает список SMS-сообщений, полученных этим номером и списком запрещенных сервисов.



        Вы можете использовать данный запрос для получения номера и последующего приема SMS-сообщений на него, например, для теста.


        >**ВАЖНО!**
        >
        >Пожалуйста, обратите внимание, что некоторые сервисы запрещены для использования (и SMS-сообщения от таких сервисов не будут доступны). Вы можете найти список таких сервисов на главной странице сайта или в [Публичной оферте](https://onlinesim.io/ru/documentation/offer).
        >
        >Стоит отметить, что поскольку доступ к этим номерам имеют все пользователи сайта, мы не рекомендуем использовать их для создания аккаунтов для личного использования с какой-либо важной или конфиденциальной информацией.
      description: |-
        Depending on the parameters returns information on available countries with free numbers, received messages and the list of restricted services.



        Without parameters: returns a list of available countries with free numbers, messages received by the first number from the list and the list of restricted services.



        With `country` parameter: returns a list of available free numbers of that country, messages received by the first number from the list and the list of restricted services.



        With `country` and `number` parameters: returns a list of SMS messages received by this number and the list of restrices services.



        You can send this request to get a number that can be used for SMS receiving, for example for testing.

        >**IMPORTANT NOTES!**
        >
        >Please note that some services are prohibited for use (and SMS from these services are not available), you can find the list of such services on the front page or in [Public offer](https://onlinesim.io/documentation/offer).
        >
        >It is worth to mention that since the access for these numbers is public we do not recommend to use them to create accounts for personal use with any personal information.
      security: []
      parameters:
        - schema:
            type: integer
            default: 7
            example: 46
            minimum: 1
          in: query
          name: country
          x-description-ru: 'Международный телефонный код страны (согласно стандарту E.164, без знака "+"),
            смотри список [стран](/ru/openapi_docs/reseller-api-un/custom/countries)'
          description: 'International dialing code of the country (Е.164 standard, without "+" sign),
            see [country](/openapi_docs/reseller-api-un/custom/countries) list'
        - schema:
            type: string
            example: '9100100101'
          in: query
          name: number
          x-description-ru: 'Бесплатный номер телефона, без кода страны'
          description: 'Free phone number, without country code'
        - $ref: '#/components/parameters/lang'
components:
  schemas: {}
  securitySchemes:
    apikey:
      name: apikey
      type: apiKey
      in: query
      x-description-ru: |
        Секретный ключ, используемый для упрощенной авторизации в API Onlinesim.

        ---

        #### Как получить API ключ:

        1. Авторизоваться в [личном кабинете](/auth/login), перейти настройки профиля, выбрать вкладку "API".
        2. Ключ будет указан в строке `API key`. Его необходимо скопировать и добавить в Ваше приложение/программу.

        ---

        #### Как использовать:

        1. Все запросы к текущего API Onlinesim (за исключением [getFreeList](/ru/openapi_docs/onlinesim-api-un/get/api_getFreeList)) должны содержать API ключ.
        2. API ключ можно указать как параметр запроса:

              >Например:

                  https://onlinesim.io/api/getTariffs.php?apikey={apikey}

        **Использование API ключа представляет собой способ для упрощенной авторизации запросов. Мы рекомендуем использовать OAuth 2.0 для более безопасной работы с данными.**
      description: |
        API key is a secret key for a simplified authorization in Onlinesim API.

        ---

        #### How to get an API key:

        1. Log in to [personal account](/auth/login), go to the 'User Profile' and click on "API" tab.
        2. Copy the key from the `API Key` field and add it to your application.

        ---

        #### How to use it:

        1. All Onlinesim API requests (except for [getFreeList](/openapi_docs/onlinesim-api-un/get/api_getFreeList)) must contain an API key.
        2. API key can be specified as a query parameter

              >For example:

                  https://onlinesim.io/api/getTariffs.php?apikey={apikey}

        **Using an API key provides a simplified way to authorize requests. We recommend using OAuth 2.0 for more secure data handling.**
    BearerAuth:
      type: http
      scheme: bearer
      x-description-ru: |
        API ключ также можно использовать для авторизации в заголовке запроса, используя схему `Authorization: Bearer`

        >Например (Postman запрос):

        ```bash
        Authorization: Bearer {{apikey}}
        User-Agent: PostmanRuntime/7.29.2
        Accept: */\*
        Cache-Control: no-cache
        Postman-Token: 948bc880-8d25-4298-994f-fe6e22ada339
        Host: onlinesim.io
        Accept-Encoding: gzip, deflate, br
        Connection: keep-alive
        Cookie: xxxx
        ```

        **Использование API ключа представляет собой способ для упрощенной авторизации запросов. Мы рекомендуем использовать OAuth 2.0 для более безопасной работы с данными.**
      description: |
        The API key can also be used for authorization in the request header using the `Authorization: Bearer` scheme

        >For example (Postman request):

        ```bash
        Authorization: Bearer {{apikey}}
        User-Agent: PostmanRuntime/7.29.2
        Accept: */\*
        Cache-Control: no-cache
        Postman-Token: 948bc880-8d25-4298-994f-fe6e22ada339
        Host: onlinesim.io
        Accept-Encoding: gzip, deflate, br
        Connection: keep-alive
        Cookie: xxxx
        ```

        **Using an API key provides a simplified way to authorize requests. We recommend using OAuth 2.0 for more secure data handling.**
    OAuth2:
      type: oauth2
      flows:
        implicit:
          authorizationUrl: 'https://onlinesim.io/oauth/authorize'
          refreshUrl: 'https://onlinesim.io/oauth/token'
          scopes:
            sms-scope: Grants access single-service activations API
            rent-scope: Grants access rent API
            free-scope: Grants access free numbers API
        authorizationCode:
          authorizationUrl: 'https://onlinesim.io/oauth/authorize'
          scopes:
            sms-scope: Grants access single-service activations API
            rent-scope: Grants access rent API
            free-scope: Grants access free numbers API
          tokenUrl: 'https://onlinesim.io/oauth/token'
      x-description-ru: |
        <a name="OAUTH"></a>
        ### OAUTH 2.0
        Протокол OAuth 2.0 поддерживает несколько сценариев авторизации, для работы с нашим API можно использовать сценарии Authorization Code Flow или Implicit Flow. Для получения подробной информации о протоколе OAuth 2.0 и дополнительной помощи, пожалуйста, обратитесь к официальной документации.

        Authorization URL: https://onlinesim.io/oauth/authorize

        Token URL: https://onlinesim.io/oauth/token

        Scopes:

        **sms-scope** открывает доступ к управлению номерами для услуги "Прием SMS" от Onlinesim;
        **rent-scope** открывает доступ к аренде телефонных номеров пользователя Onlinesim;
        **free-scope** открывает доступ к использованию бесплатныых номеров Onlinesim.

        ### **Регистрация вашего приложения на нашем сервисе авторизации:**

        1. Перейдите на [страницу OAuth](https://onlinesim.io/oauth)
        2. Создайте новый клиент, указав:
              * `Name` - название приложения или любое другое название, которое Вы и Ваши пользователи будут ассоциировать с приложением;
              * `Redirect URL` - URL, на который будет перенаправлен клиент после авторизации и куда будет направлен код авторизации приложения;
              * `Confidential` - необзятально, отметье клиент как `Confidential`, если ваше приложение работает на сервере и может безопасно хранить Client Secret.

        ![Создание клиента](https://onlinesim.io/assets/schemes/CreateClientOAuth(UN).png)

        3. Нажмите "Create". Добавленное Вами приложение будет отображаться в списке клиентов.

        ![Список токенов](https://onlinesim.io/assets/schemes/TokenListOAuth(UN).png)

        4. Сохраните `Client ID` и `Secret` в безопасном месте, далее они будут использоваться Вашим приложении для авторизации.

        <a name="AUTHCODE"></a>
        ### OAuth 2.0. Authorization Сode Flow

        #### **Авторизация пользователя и получение токена:**

        1. Авторизуйте клиент через GET запрос к https://onlinesim.io/oauth/authorize с параметрами `client_id`, `redirect_uri`, `response_type`, `scope`, `state`:

        ##### Описание параметров

          Название параметра | Тип данных | Описание
          -------------------|:----------:|---------
          client_id | STRING | `Client ID`, который был получен после регистрации приложения
          redirect_uri | STRING | Адрес на который будет перенаправлен клиент, после успешной авторизации, должен совпадать с `Redirect URL`, который Вы указали при регистрации приложения.
          response_type | STRING | Указать `code`
          scope | STRING | Права доступа, разрешение на которые запрашивает Ваше приложение у пользователя. Возможные варианты: `sms-scope`, `rent-scope`, `free-scope`. Можно указать несколько значений
          state | STRING | Случайная строка для защиты от CSRF (проверьте её после редиректа)

        2. После запроса к https://onlinesim.io/oauth/authorize пользователь из Вашего приложения будет перенаправлен на страницу авторизации, где ему необходимо указать логин пароль и, в случае успеха, авторизовать Ваше приложение для работы с данными пользователя в сервисе Onlinesim. Для этого ему необходимо будет нажать кнопку *`Authorize`*:

        ![OAuth запрос](https://onlinesim.io/assets/schemes/OAuthRequest(UN).png)

        3. В случае успешной авторизации пользователь будет перенаправлен по адресу `redirect_uri` с параметром `code`. Теперь Вы можете получить `access token`, для этого необходимо сделать POST запрос к https://onlinesim.io/oauth/token:

        >На этом этапе Вы можете проверить параметр `state`, для подтверждения безопасного взаимодействия с сервисом авторизации

        ##### Описание параметров

          Название параметра | Тип данных | Описание
          ---------|:--------:|---------
          grant_type | STRING | Сценарий авторизации, для сценария Authorization Сode необходимо указать `authorization_code`
          client_id | STRING | `Client ID`, который был получен после регистрации приложения
          client_secret | STRING |`Сlient_secret`, который был получен после регистрации приложения
          redirect_uri | STRING | Адрес на который будет перенаправлен клиент, после успешной авторизации, должен совпадать с `Redirect URL`, который Вы указали при регистрации приложения
          code | STRING | Код авторизации, который был получен на предыдущем этапе

          >ВАЖНО! Так как `client_secret` -  это приватный ключ, поэтому не рекомендуется его хранить в фронтенде клиента. Для большей безопасности необходимо хранить его в бэкенде Вашего приложения. Для реализации сценария с авторизационным кодом нужно передать полученный код фронтендем в бэкэнд Вашего сервиса, а уже он должен обратится в авторизационный сервис для получения токена.

        4. В результате успешного выполнения запроса к https://onlinesim.io/oauth/token, в ответ получите JSON, содержащий поля `access_token`, `refresh_token` и `expires_in`. Поле `expires_in` определяет количество секунд до истечения срока действия токена доступа, `refresh_token` используется для обновления токена доступа при истечении его срока действия.

        ---

        #### **Авторизация запросов к API Onlinesim и обновление токена:**

        Во все запросы к API нужно добавлять заголовок **Authorization: Bearer *`access_token`***.
        Если в ответ на ваш запрос пришел `ERROR_WRONG_KEY`, Вам необходимо обновить токен или получить новый.

          ```json
          {
            "response": "ERROR_WRONG_KEY"
          }
          ```

        Для обновления токена необходимо сделать POST запрос к https://onlinesim.io/oauth/token с параметрами `grant_type`, `client_id`, `client_secret` и `refresh_token`. Для поля `refresh_token` необходимо использовать значение, которое было получено в шаге 4.

        ##### Описание параметров

          Название параметра | Тип данных | Описание
          ---------|:--------:|---------
          grant_type | STRING | Необходимо указать `refresh_token`
          client_id | STRING | `client ID`, который Вы получили при регистрации приложения
          client_secret | STRING | `client_secret`, который был получен при регистрации приложения
          refresh_token | STRING | `refresh_token` был получен вместе с `access_token`. Имеет гораздо большее время жизни и используется для обновления `access_token`


        <a name="IMPLICIT"></a>
        ### OAuth 2.0. Implicit flow

        #### **Авторизация пользователя и получение токена:**
        1. Авторизуйте клиент через GET запрос к https://onlinesim.io/oauth/authorize с параметрами `client_id`, `redirect_uri`, `response_type`, `scope`, `state`:

        ##### Описание параметров

          Название параметра | Тип данных | Описание
          ---------|:--------:|---------
          client_id | STRING | `Client ID`, который был получен при регистрации приложения
          redirect_uri | STRING | Адрес на который будет перенаправлен клиент, после успешной авторизации, должен совпадать с `Redirect URL`, который Вы указали при добавлении приложения.
          response_type | STRING | Используйте `token` в качестве значения
          scope | STRING | Права доступа, разрешение на которые запрашивает Ваше приложение у пользователя. Возможные варианты: `sms-scope`, `rent-scope`, `free-scope`. Можно указать несколько значений
          state | STRING | Случайная строка для защиты от CSRF (проверьте её после редиректа)

        2. После запроса к https://onlinesim.io/oauth/authorize, пользователь из Вашего приложения будет перенаправлен на страницу авторизации, где ему необходимо указать логин пароль и, в случае успеха, авторизовать Ваше приложение для работы с данными пользователя в сервисе Onlinesim. Для этого ему необходимо будет нажать кнопку *`Authorize`*:

        ![OAuth запрос](https://onlinesim.io/assets/schemes/OAuthRequest(UN).png)

        3. В случае успешной авторизации пользователь будет перенаправлен по адрес `redirect_uri` с параметром `access_token`. Это и есть необходимый токен для авторизации в API Onlinesim.

        >На этом этапе Вы можете проверить параметр `state`, для подтверждения безопасного взаимодействия с сервисом авторизации

        ---

        #### **Авторизация запросов к API onlineSIM:**

        Во все запросы к API нужно добавлять заголовок **Authorization: Bearer *`access_token`***.
        Если в ответ на ваш запрос пришел `ERROR_WRONG_KEY`, Вам необходимо получить новый токен.

          ```json
          {
            "response": "ERROR_WRONG_KEY"
          }
          ```
      description: |

        <a name="OAUTH"></a>
        ### OAUTH 2.0
        The OAuth 2.0 authorization protocol provides several authorization scenarios, in our case Authorization Code and Implicit Flow types are available. For detailed information about the OAuth 2.0 protocol and additional guidance, please refer to the official documentation.

        Authorization URL: https://onlinesim.io/oauth/authorize

        Token URL: https://onlinesim.io/oauth/token

        Scopes:

            **sms-scope** grants access to manage numbers for the "SMS Receiving" service from Onlinesim;
            **rent-scope** grants access to renting phone numbers from an Onlinesim user;
            **free-scope** grants access to using Onlinesim's free numbers.

        ### **Register the app in our authorization service:**

        1. Open [OAuth](https://onlinesim.io/oauth) page
        2. Add your app by clicking "Create New Client", then fill the fields below:
              * `Name` - could be the app name or any other name you and your users will associate with the app;
              * `Redirect URL` - after user authorization on our server, the client will be redirected with authorization code to this URL.
              * `Confidential` - (optional), mark the client as Confidential if your application runs on a server and can securely store the Client Secret.

        ![Client creation](https://onlinesim.io/assets/schemes/CreateClientOAuth(UN).png)

        3. Click "Create". New client will appear in the list of applications.

        ![Token list](https://onlinesim.io/assets/schemes/TokenListOAuth(UN).png)

        4. Save the `Client ID` and `Secret` in a secure location; they will be used by your application for authorization.

        <a name="AUTHCODE"></a>
        ### OAuth 2.0. Authorization code flow

        #### **Authorize a user and get a token:**

        1. Authorize a client with a GET request to https://onlinesim.io/oauth/authorize with parameters `client_id`, `redirect_uri`, `response_type`, `scope`, `state`:

        ##### Parameter Description

          Parameter Name | Data Type | Description
          ---------|:--------:|---------
          client_id | STRING | `Client ID` (returned when the app registration process is complete)
          redirect_uri | STRING | Redirect destination for the client after a successful authorization, it must match the value of `Redirect URL` field you've set during app registration process.
          response_type | STRING | Use `code` as a value
          scope | STRING | Access rights that your app asks from the user. Possible values: `sms-scope`, `rent-scope`, `free-scope`. You can specify multiple values
          state | STRING | A random string for CSRF protection (verify it after the redirect)

        2. After the request to https://onlinesim.io/oauth/authorize is sent, the user from your app will be redirected to the authorization page to enter the login&password and, if successful, authorize your app to work with user data in the Onlinesim service. To do so, he has to click on the *`Authorize`* button:

        ![OAuthRequest](https://onlinesim.io/assets/schemes/OAuthRequest(UN).png)

        3. If the authorization is successful, the user will be redirected to `redirect_uri` with the parameter `code`. Now you can get the `access token` after making a POST request to https://onlinesim.io/oauth/token:

        >At this point, you can check the `state` parameter, to confirm secure communication with the authorization service

        ##### Parameter Description


          Parameter name | Data type | Description
          ---------|:--------:|---------
          grant_type | STRING | Authorization scenario type, use `authorization_code` when using the Authorization Code flow.
          client_id | STRING | `Client ID` (returned when the app registration process is complete)
          client_secret | STRING |`Client_secret` (returned when the app registration process is complete)
          redirect_uri | STRING | Redirect URL for the client after a successful authorization, it must match the `Redirect URL` parameter used during app registration process.
          code | STRING | Authorization code, obtained in the previous step

          >Since `client_secret` is a private key, it is not recommended to store it in the frontend of the client. For better security, you should store it in the backend of your app. To implement the Authorization Code scenario, you need to pass this code from the frontend to the backend of your service.

        4. As a result of a successful request to https://onlinesim.io/oauth/token, you get JSON in reply, which contains `access_token`, `refresh_token`, and `expires_in` attributes. The `expires_in` attribute contains the number of seconds before the access token is expired.

        ---

        #### **Authorization and token refreshment:**

        For all API requests, add the **Authorization: Bearer *`access_token`*** header.
        If your request results in `ERROR_WRONG_KEY`, you need to refresh your token or get a new one.

          ```json
          {
            "response": "ERROR_WRONG_KEY"
          }
          ```

        To refresh the token you must make a POST request to https://onlinesim.io/oauth/token with the parameters `grant_type`, `client_id`, `client_secret`, and `refresh_token`. For the `refresh_token` field, use the value obtained in step 4.

        ##### Parameter Description

          Parameter name | Data type | Description
          ---------|:--------:|---------
          grant_type | STRING | Use `refresh_token` as a value
          client_id | STRING | `Client ID` (returned when the app registration process is complete)
          client_secret | STRING | `Client_secret` (returned when the app registration process is complete)
          refresh_token | STRING | `Refresh_token` is obtained along with the `access_token`. It has a much longer lifetime and is used to refresh `access_token`
          code | STRING | Authorization code, obtained in the previous step


        <a name="IMPLICIT"></a>
        ### OAuth 2.0. Implicit flow

        #### **Authorize a user and get a token:**
        1. Authorize a client with a GET request to the endpoint https://onlinesim.io/oauth/authorize with parameters `client_id`, `redirect_uri`, `response_type`, `scope`, `state`:

        ##### Parameter Description

          Parameter name | Data type | Description
          ---------|:--------:|---------
          client_id | STRING | `Client ID` (returned when the app registration process is complete)
          redirect_uri | STRING | Redirect destination for the client after a successful authorization, it must match the `Redirect URL` parameter used during app registration process.
          response_type | STRING | Use `token` as a value
          scope | STRING | Access rights that your app asks from the user. Possible values: `sms-scope`, `rent-scope`, `free-scope`. You can specify multiple values
          state | STRING | A random string for CSRF protection (verify it after the redirect)

        2. After the request to https://onlinesim.io/oauth/authorize is sent, the user will be redirected from your app to the authorization page to enter the login & password and, if successful, authorize your app to work with user data in the Onlinesim service. To do so, he has to click on *`Authorize`* button:

        ![OAuth request](https://onlinesim.io/assets/schemes/OAuthRequest(UN).png)

        3. In case of successful authorization, the user will be redirected to the `redirect_uri` address with the parameter `access_token`. This token is required for authorization in Onlinesim API.

        >At this point, you can check the `state` parameter, to confirm secure communication with the authorization service

        ---

        ### **Authorization of requests to the Onlinesim API:**

        Add to all API requests **Authorization: Bearer *`access_token`*** header.
        If your request results in `ERROR_WRONG_KEY`, you should get a new token.

          ```json
          {
            "response": "ERROR_WRONG_KEY"
          }
          ```
  responses: {}
  parameters:
    lang:
      name: lang
      in: query
      required: false
      schema:
        type: string
        default: ru
        enum:
          - fr
          - de
          - ru
          - en
          - zh
        example: en
      x-description-ru: 'Язык ответа:


        `fr` - французский,


        `de` - немецкий,


        `ru` - русский,


        `en` - английский,


        `zh` - китайский.
        Обратите внимание, что перевод производится лишь для строковых значений полей, например, названий сервисов или стран. Сами названия полей, ошибки выполнения запросов и общепринятые значения (например, значения полей true/false для булевых параметров) остаются на английском языке.'
      description: '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.'
tags:
  - name: free numbers
    x-description-ru: разрешает доступ к API бесплатных номеров
    description: allows to access free numbers API
  - name: profile
    x-description-ru: разрешает доступ к API запросам, относящимся к профилю
    description: allows to access profile-related API requests
  - name: rent
    x-description-ru: разрешает доступ к API аренды
    description: allows to access rent API
  - name: single-service activations
    x-description-ru: разрешает доступ к API для приема SMS от отдельных сервисов
    description: allows to access single-service activations API
security:
  - OAuth2:
      - sms-scope
      - rent-scope
      - free-scope
  - apikey: []
  - BearerAuth: []
