[{"data":1,"prerenderedAt":210},["ShallowReactive",2],{"openapi-specs-catalog":3,"openapi-nav-en-Reseller-API-UN":38,"openapi-doc-\u002FReseller-API-UN\u002Fcustom\u002Ftesting":207},["Reactive",4],{"defaultLocale":5,"base":6,"specs":7,"specsMeta":11,"locales":35},"en","\u002Fopenapi_docs\u002F",[8,9,10],"Onlinesim-API-UN","Reseller-API-UN","Alternative-API-UN",[12,22,29],{"name":8,"fileName":8,"title":13,"version":14,"description":15,"basePath":16,"specsPath":17,"locales":18,"defaultLocale":5},"Onlinesim API","1.1","General description This API will allow you to access all services provided by Onlinesim: SMS receiving from a single specific service on a virtual nu","Onlinesim-API-UN\u002F","\u002Fopenapi_docs\u002Fspecs\u002FOnlinesim-API-UN",{"en":19,"ru":20,"de":21},"English","Русский","Deutsch",{"name":9,"fileName":9,"title":23,"version":24,"description":25,"basePath":26,"specsPath":27,"locales":28,"defaultLocale":5},"Reseller API","1.0","General description The API is intended for current and potential Onlinesim partners. It allows you to monetize your numbers by providing them to our ","Reseller-API-UN\u002F","\u002Fopenapi_docs\u002Fspecs\u002FReseller-API-UN",{"en":19,"ru":20,"de":21},{"name":10,"fileName":10,"title":30,"version":24,"description":31,"basePath":32,"specsPath":33,"locales":34,"defaultLocale":5},"Alternative API","General description Alternative API for integration with Onlinesim. This API will allow you to access two main services of Onlinesim: rent numbers to ","Alternative-API-UN\u002F","\u002Fopenapi_docs\u002Fspecs\u002FAlternative-API-UN",{"en":19,"ru":20,"de":21},[5,36,37],"ru","de",[39,43,48,53,86,105,170,184],{"text":23,"link":40,"icon":41,"description":42},"\u002FReseller-API-UN\u002Finfo","icons\u002Fdocs\u002Finfo","API overview and introduction",{"text":44,"link":45,"icon":46,"description":47},"Authorization","\u002FReseller-API-UN\u002Fauth","icons\u002Fdocs\u002Fauth","API keys, OAuth, and security schemes",{"text":49,"link":50,"icon":51,"description":52},"Components","\u002FReseller-API-UN\u002Fcomponents","icons\u002Fdocs\u002Fcomponents","Schemas, parameters, and reusable models",{"text":54,"collapsed":55,"items":56,"description":84,"icon":85},"v1",false,[57,63,68,73,79],{"text":58,"link":59,"method":60,"path":61,"description":62,"deprecated":55},"getServices","\u002FReseller-API-UN\u002FReseller-API-UN-post-getservices","POST","\u002FgetServices","Get list of available services and countries",{"text":64,"link":65,"method":60,"path":66,"description":67,"deprecated":55},"getNumber","\u002FReseller-API-UN\u002FReseller-API-UN-post-getnumber","\u002FgetNumber","Order a virtual number for the specified service",{"text":69,"link":70,"method":60,"path":71,"description":72,"deprecated":55},"finishActivation","\u002FReseller-API-UN\u002FReseller-API-UN-post-finishactivation","\u002FfinishActivation","Finish current operation",{"text":74,"link":75,"method":76,"path":77,"description":78,"deprecated":55},"services","\u002FReseller-API-UN\u002FReseller-API-UN-get-services","GET","\u002Fservices","Get service names list",{"text":80,"link":81,"method":76,"path":82,"description":83,"deprecated":55},"countries","\u002FReseller-API-UN\u002FReseller-API-UN-get-countries","\u002Fcountries","Get country names list","v1 API for partners (our server requests numbers from yours)","icons\u002Fdocs\u002Ffolder",{"text":87,"collapsed":55,"items":88,"description":104,"icon":85},"v1 rent",[89,94,99],{"text":90,"link":91,"method":60,"path":92,"description":93,"deprecated":55},"getServicesRent","\u002FReseller-API-UN\u002FReseller-API-UN-post-getservicesrent","\u002FgetServicesRent","Get list of available services and countries for rent",{"text":95,"link":96,"method":60,"path":97,"description":98,"deprecated":55},"getNumberRent","\u002FReseller-API-UN\u002FReseller-API-UN-post-getnumberrent","\u002FgetNumberRent","Order rent of a virtual phone number",{"text":100,"link":101,"method":60,"path":102,"description":103,"deprecated":55},"finishActivationRent","\u002FReseller-API-UN\u002FReseller-API-UN-post-finishactivationrent","\u002FfinishActivationRent","Finish rent operation of a virtual phone number","v1 API for renting your numbers (our server requests numbers from yours)",{"text":106,"collapsed":55,"items":107,"description":169,"icon":85},"v2",[108,113,118,123,128,133,138,143,149,154,159,164],{"text":109,"link":110,"method":60,"path":111,"description":112,"deprecated":55},"sendNumbersOnline","\u002FReseller-API-UN\u002FReseller-API-UN-post-api-resellers-sendnumbersonline","\u002Fapi\u002Fresellers\u002FsendNumbersOnline","Send phone numbers in bulk to Onlinesim server list",{"text":114,"link":115,"method":60,"path":116,"description":117,"deprecated":55},"addMessage","\u002FReseller-API-UN\u002FReseller-API-UN-post-api-resellers-addmessage","\u002Fapi\u002Fresellers\u002FaddMessage","Forward received SMS to Onlinesim server",{"text":119,"link":120,"method":60,"path":121,"description":122,"deprecated":55},"addMessages","\u002FReseller-API-UN\u002FReseller-API-UN-post-api-resellers-addmessages","\u002Fapi\u002Fresellers\u002FaddMessages","Batch forward received SMS to Onlinesim server",{"text":124,"link":125,"method":76,"path":126,"description":127,"deprecated":55},"takeOffNumbers","\u002FReseller-API-UN\u002FReseller-API-UN-get-api-resellers-takeoffnumbers","\u002Fapi\u002Fresellers\u002FtakeOffNumbers","Get information about numbers income",{"text":129,"link":130,"method":60,"path":131,"description":132,"deprecated":55},"addNumber","\u002FReseller-API-UN\u002FReseller-API-UN-post-api-resellers-addnumber","\u002Fapi\u002Fresellers\u002FaddNumber","Forward specified phone numbers to Onlinesim server",{"text":134,"link":135,"method":76,"path":136,"description":137,"deprecated":55},"checkNumber","\u002FReseller-API-UN\u002FReseller-API-UN-get-api-resellers-checknumber","\u002Fapi\u002Fresellers\u002FcheckNumber","Get detailed information about phone number and it's status",{"text":139,"link":140,"method":76,"path":141,"description":142,"deprecated":55},"checkWork","\u002FReseller-API-UN\u002FReseller-API-UN-get-api-resellers","\u002Fapi\u002Fresellers","Confirm server uptime status",{"text":144,"link":145,"method":146,"path":147,"description":148,"deprecated":55},"removeNumber","\u002FReseller-API-UN\u002FReseller-API-UN-delete-api-resellers-removenumber","DELETE","\u002Fapi\u002Fresellers\u002FremoveNumber","Remove phone number from Onlinesim server list",{"text":150,"link":151,"method":60,"path":152,"description":153,"deprecated":55},"addNumbers","\u002FReseller-API-UN\u002FReseller-API-UN-post-api-resellers-addnumbers","\u002Fapi\u002Fresellers\u002FaddNumbers","Add multiple phone numbers to the existing list",{"text":155,"link":156,"method":76,"path":157,"description":158,"deprecated":55},"checkNumbers","\u002FReseller-API-UN\u002FReseller-API-UN-get-api-resellers-checknumbers","\u002Fapi\u002Fresellers\u002FcheckNumbers","Get detailed information about specified phone numbers in your profile and their statuses",{"text":160,"link":161,"method":146,"path":162,"description":163,"deprecated":55},"removeNumbers","\u002FReseller-API-UN\u002FReseller-API-UN-delete-api-resellers-removenumbers","\u002Fapi\u002Fresellers\u002FremoveNumbers","Remove multiple phone numbers from the existing list",{"text":165,"link":166,"method":60,"path":167,"description":168,"deprecated":55},"saveConfig","\u002FReseller-API-UN\u002FReseller-API-UN-post-api-auth-me","\u002Fapi\u002Fauth\u002Fme","Change the list of the disabled services","v2 API for partners (your server sends a list of available numbers to our\nserver)",{"text":171,"collapsed":55,"items":172,"icon":183},"Webhooks",[173,178],{"text":174,"link":175,"method":60,"path":176,"description":177,"deprecated":55},"pushSms","\u002FReseller-API-UN\u002FReseller-API-UN-post-v1-push_sms","\u002Fv1\u002FPUSH_SMS","Send SMS to Onlinesim",{"text":179,"link":180,"method":60,"path":181,"description":182,"deprecated":55},"pushSmsRent","\u002FReseller-API-UN\u002FReseller-API-UN-post-v1-push_sms_rent","\u002Fv1\u002FPUSH_SMS_RENT","Send SMS to Onlinesim for rent operation","icons\u002Fdocs\u002Fwebhook",{"text":185,"collapsed":55,"items":186,"icon":85},"Custom",[187,193,197,202],{"text":188,"link":189,"method":190,"path":80,"description":191,"icon":192},"Countries","\u002FReseller-API-UN\u002Fcustom\u002Fcountries","PAGE","List of supported country codes","icons\u002Fdocs\u002Fpage",{"text":194,"link":195,"method":190,"path":74,"description":196,"icon":192},"Services","\u002FReseller-API-UN\u002Fcustom\u002Fservices","List of supported services",{"text":198,"link":199,"method":190,"path":200,"description":201,"icon":192},"Operators","\u002FReseller-API-UN\u002Fcustom\u002Foperators","operators","List of supported operators",{"text":203,"link":204,"method":190,"path":205,"description":206,"icon":192},"Testing","\u002FReseller-API-UN\u002Fcustom\u002Ftesting","testing","Testing protocol and requirements",{"title":203,"kind":208,"locale":5,"specName":9,"path":204,"body":209,"description":203,"summary":206},"custom","\u003Ch2>Testing Protocol\u003C\u002Fh2>\n\u003Cp>After implementing the protocol, Onlinesim developers will test it. When you are ready, please send your URL to our support team. After that, your server must be available 24\u002F7. We will start testing as soon as possible. The tests we will conduct:\u003C\u002Fp>\n\u003Col>\n  \u003Cli>\u003Cstrong>Simultaneous number issuance for the same service.\u003C\u002Fstrong> The most important test. Your system must correctly handle simultaneous requests and must not issue the same number again. For example, the system will send 30 requests with the same criteria: russia, megafon, vk. If you issued a number again - test failed.\u003C\u002Fli>\n  \u003Cli>\u003Cstrong>Correct handling of activation completion request.\u003C\u002Fstrong> Activation management is done ONLY on the Onlinesim side. For reasons beyond our control (network issues), we may not receive a response from you about the successful status change. Therefore, if Onlinesim sends the activation completion status again, you must check for the existence of such an activation by id and if the activation exists, send status SUCCESS. Also, you should NOT complete the activation on your side independently. Only a request from Onlinesim to complete the operation should complete the activation on your side.\u003C\u002Fli>\n  \u003Cli>\u003Cstrong>SMS Test.\u003C\u002Fstrong> After the SMS has reached your database, you must forward it to us as soon as possible. When an SMS arrives - send it to us immediately. If you receive a response with status SUCCESS, mark the SMS in your database as successfully delivered and do not send it again. If a status other than SUCCESS is returned, repeat the request with a 10-second delay until you receive status SUCCESS. If you send the same SMS after we respond to you with status SUCCESS - test failed.\u003C\u002Fli>\n  \u003Cli>\u003Cstrong>Field types.\u003C\u002Fstrong> Carefully check the field types you send via the protocol. If the protocol description says that the field is of numeric type, and you send smsId: «123» - test failed.\u003C\u002Fli>\n  \u003Cli>\u003Cstrong>The phone number must include the country code.\u003C\u002Fstrong> In the phone number request, the field number and in the SMS delivery request, the field phone must be NUMERIC and WITH the country code.\u003C\u002Fli>\n  \u003Cli>\u003Cstrong>The time to issue a number from you should be minimal.\u003C\u002Fstrong> If the time to issue a number is more than 3 seconds - test failed.\u003C\u002Fli>\n  \u003Cli>\u003Cstrong>The number of numbers returned by the GET_SERVICES request should reflect reality.\u003C\u002Fstrong> If you return 100 vk, but in reality there are 30, and 70 requests will return with the response NO_NUMBERS - test failed.\u003C\u002Fli>\n  \u003Cli>\u003Cstrong>Test for excluding prefixes.\u003C\u002Fstrong> You must correctly handle the exceptionPhoneSet field when requesting GET_NUMBER. If you issue a phone number whose prefix is in the list - test failed.\u003C\u002Fli>\n\u003C\u002Fol>",1789123201179]