[{"data":1,"prerenderedAt":980},["ShallowReactive",2],{"navigation":3,"\u002Frent":43,"\u002Frent-surround":975},[4,8,13,18,23,28,33,38],{"title":5,"path":6,"stem":7},"Getting started","\u002F","index",{"title":9,"path":10,"stem":11,"order":12},"Numbers","\u002Fnumbers","numbers",1,{"title":14,"path":15,"stem":16,"order":17},"Rent","\u002Frent","rent",2,{"title":19,"path":20,"stem":21,"order":22},"User","\u002Fuser","user",3,{"title":24,"path":25,"stem":26,"order":27},"Free numbers","\u002Ffree","free",4,{"title":29,"path":30,"stem":31,"order":32},"Webhooks","\u002Fwebhooks","webhooks",5,{"title":34,"path":35,"stem":36,"order":37},"Testing","\u002Ftesting","testing",6,{"title":39,"path":40,"stem":41,"order":42},"Changelog","\u002Fchangelog","changelog",7,{"id":44,"title":14,"body":45,"description":969,"extension":970,"meta":971,"navigation":972,"path":15,"seo":973,"stem":16,"__hash__":974},"docs\u002Frent.md",{"type":46,"value":47,"toc":960},"minimark",[48,61,104,176,179,182,240,327,418,443,446,449,462,566,569,572,589,627,635,637,655,680,729,738,741,752,770,793,807,809,816,829,842,864,867,870,891,948,956],[49,50,51,52,56,57,60],"p",{},"A rent keeps a number for ",[53,54,55],"code",{},"days"," days. Its SMS come in ",[53,58,59],{},"\"messages\"",", newest first.",[49,62,63,66,67,70,71,74,75,78,79,74,82,85,86,89,90,74,92,95,96,99,100,103],{},[53,64,65],{},"get"," reserves the price (it shows in ",[53,68,69],{},"zbalance","): the rent starts with ",[53,72,73],{},"status"," ",[53,76,77],{},"0"," and ",[53,80,81],{},"checked",[53,83,84],{},"false"," and waits up to 20 minutes for its first SMS. The first SMS that is not a ",[53,87,88],{},"notify"," notice confirms it (",[53,91,73],{},[53,93,94],{},"1",") and charges the price; without one the rent closes and the reservation is released. Some countries (",[53,97,98],{},"confirm"," in ",[53,101,102],{},"tariffs",", e.g. US numbers) are confirmed and charged at once.",[49,105,106,107,110,111,114,115,118,119,122,123,126,127,130,131,74,134,136,137,139,140,143,144,147,148,151,152,155,156,159,160,162,163,166,167,74,170,172,173,175],{},"A rent item: ",[53,108,109],{},"{\"tzid\", \"status\", \"number\", \"country\", \"sum\", \"days\", \"hours\", \"time\", \"time_seconds\"?, \"extension\", \"extend\", \"messages\", \"start_time\", \"stop_time\", \"day_extend\"?, …}"," —\n",[53,112,113],{},"sum"," is the cost in USD incl. extensions (a ",[53,116,117],{},"Float","; ",[53,120,121],{},"rent.state"," gets it from the server as a decimal string), ",[53,124,125],{},"time"," minutes left, ",[53,128,129],{},"time_seconds"," seconds left,\n",[53,132,133],{},"extension",[53,135,77],{}," not extendable \u002F ",[53,138,94],{}," extendable \u002F ",[53,141,142],{},"2"," auto-extension, ",[53,145,146],{},"extend"," maps days to the extension price (",[53,149,150],{},"{}"," when not extendable),\n",[53,153,154],{},"messages"," is a list of ",[53,157,158],{},"{\"id\", \"service\", \"text\", \"code\", \"created_at\"}"," — ",[53,161,53],{}," is ",[53,164,165],{},"\"\""," when no code was found and the ",[53,168,169],{},"Integer",[53,171,77],{}," for a ",[53,174,88],{}," SMS (a prohibited sender).",[177,178,65],"h2",{"id":65},[49,180,181],{},"Rent a number. The price is reserved; the first SMS charges it.",[183,184,189],"pre",{"className":185,"code":186,"language":187,"meta":188,"style":188},"language-ruby shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","get(country = 7, days = 1, extension: true) # => Hash\n","ruby","",[53,190,191],{"__ignoreMap":188},[192,193,195,198,202,206,209,213,216,219,221,224,226,229,233,236],"span",{"class":194,"line":12},"line",[192,196,65],{"class":197},"s2Zo4",[192,199,201],{"class":200},"sMK4o","(",[192,203,205],{"class":204},"sTEyZ","country ",[192,207,208],{"class":200},"=",[192,210,212],{"class":211},"sbssI"," 7",[192,214,215],{"class":200},",",[192,217,218],{"class":204}," days ",[192,220,208],{"class":200},[192,222,223],{"class":211}," 1",[192,225,215],{"class":200},[192,227,228],{"class":200}," extension:",[192,230,232],{"class":231},"sfNiH"," true",[192,234,235],{"class":200},")",[192,237,239],{"class":238},"sHwdD"," # => Hash\n",[241,242,243,262],"table",{},[244,245,246],"thead",{},[247,248,249,253,256,259],"tr",{},[250,251,252],"th",{},"Param",[250,254,255],{},"Type",[250,257,258],{},"Default",[250,260,261],{},"Description",[263,264,265,285,305],"tbody",{},[247,266,267,273,277,282],{},[268,269,270],"td",{},[53,271,272],{},"country",[268,274,275],{},[53,276,169],{},[268,278,279],{},[53,280,281],{},"7",[268,283,284],{},"Country code.",[247,286,287,291,295,299],{},[268,288,289],{},[53,290,55],{},[268,292,293],{},[53,294,169],{},[268,296,297],{},[53,298,94],{},[268,300,301,302,304],{},"One of the tariff's ",[53,303,55],{}," keys.",[247,306,307,312,317,322],{},[268,308,309],{},[53,310,311],{},"extension:",[268,313,314],{},[53,315,316],{},"Boolean",[268,318,319],{},[53,320,321],{},"true",[268,323,324,326],{},[53,325,84],{}," makes the rent non-extendable for good.",[183,328,330],{"className":185,"code":329,"language":187,"meta":188,"style":188},"rent = client.rent.get(7, 7)\nputs rent.values_at(\"tzid\", \"number\", \"sum\").join(\" \")\n",[53,331,332,362],{"__ignoreMap":188},[192,333,334,337,339,342,345,347,349,351,353,355,357,359],{"class":194,"line":12},[192,335,336],{"class":204},"rent ",[192,338,208],{"class":200},[192,340,341],{"class":204}," client",[192,343,344],{"class":200},".",[192,346,16],{"class":197},[192,348,344],{"class":200},[192,350,65],{"class":197},[192,352,201],{"class":200},[192,354,281],{"class":211},[192,356,215],{"class":200},[192,358,212],{"class":211},[192,360,361],{"class":200},")\n",[192,363,364,367,370,372,375,377,380,384,386,388,391,394,396,398,400,402,404,407,410,412,414,416],{"class":194,"line":17},[192,365,366],{"class":197},"puts",[192,368,369],{"class":204}," rent",[192,371,344],{"class":200},[192,373,374],{"class":197},"values_at",[192,376,201],{"class":200},[192,378,379],{"class":200},"\"",[192,381,383],{"class":382},"sfazB","tzid",[192,385,379],{"class":200},[192,387,215],{"class":200},[192,389,390],{"class":200}," \"",[192,392,393],{"class":382},"number",[192,395,379],{"class":200},[192,397,215],{"class":200},[192,399,390],{"class":200},[192,401,113],{"class":382},[192,403,379],{"class":200},[192,405,406],{"class":200},").",[192,408,409],{"class":197},"join",[192,411,201],{"class":200},[192,413,379],{"class":200},[192,415,390],{"class":200},[192,417,361],{"class":200},[49,419,420,421,118,424,74,427,430,431,430,434,430,437,430,440,344],{},"Errors: ",[53,422,423],{},"NoNumberError",[53,425,426],{},"ApiError",[53,428,429],{},"UNDEFINED_DAYS",", ",[53,432,433],{},"UNDEFINED_COUNTRY",[53,435,436],{},"WARNING_LOW_BALANCE",[53,438,439],{},"INTERVAL_CONCURRENT_REQUESTS_ERROR",[53,441,442],{},"TRY_AGAIN_LATER",[177,444,445],{"id":445},"state",[49,447,448],{},"All rents of the account.",[183,450,452],{"className":185,"code":451,"language":187,"meta":188,"style":188},"state # => Array of Hash\n",[53,453,454],{"__ignoreMap":188},[192,455,456,459],{"class":194,"line":12},[192,457,458],{"class":204},"state ",[192,460,461],{"class":238},"# => Array of Hash\n",[183,463,465],{"className":185,"code":464,"language":187,"meta":188,"style":188},"client.rent.state.each do |rent|\n  puts \"#{rent['number']} #{rent['messages'].first&.fetch('code')}\"\nend\n",[53,466,467,497,561],{"__ignoreMap":188},[192,468,469,472,474,476,478,480,482,485,489,492,494],{"class":194,"line":12},[192,470,471],{"class":204},"client",[192,473,344],{"class":200},[192,475,16],{"class":197},[192,477,344],{"class":200},[192,479,445],{"class":197},[192,481,344],{"class":200},[192,483,484],{"class":197},"each",[192,486,488],{"class":487},"s7zQu"," do",[192,490,491],{"class":200}," |",[192,493,16],{"class":204},[192,495,496],{"class":200},"|\n",[192,498,499,502,504,507,509,512,515,517,519,522,525,527,529,531,533,535,538,541,544,547,549,551,553,555,558],{"class":194,"line":17},[192,500,501],{"class":197},"  puts",[192,503,390],{"class":200},[192,505,506],{"class":200},"#{",[192,508,16],{"class":204},[192,510,511],{"class":200},"[",[192,513,514],{"class":200},"'",[192,516,393],{"class":382},[192,518,514],{"class":200},[192,520,521],{"class":200},"]}",[192,523,524],{"class":200}," #{",[192,526,16],{"class":204},[192,528,511],{"class":200},[192,530,514],{"class":200},[192,532,154],{"class":382},[192,534,514],{"class":200},[192,536,537],{"class":200},"].",[192,539,540],{"class":197},"first",[192,542,543],{"class":200},"&.",[192,545,546],{"class":197},"fetch",[192,548,201],{"class":200},[192,550,514],{"class":200},[192,552,53],{"class":382},[192,554,514],{"class":200},[192,556,557],{"class":200},")}",[192,559,560],{"class":200},"\"\n",[192,562,563],{"class":194,"line":22},[192,564,565],{"class":487},"end\n",[177,567,568],{"id":568},"state_one",[49,570,571],{},"One rent.",[183,573,575],{"className":185,"code":574,"language":187,"meta":188,"style":188},"state_one(tzid) # => Hash\n",[53,576,577],{"__ignoreMap":188},[192,578,579,581,583,585,587],{"class":194,"line":12},[192,580,568],{"class":197},[192,582,201],{"class":200},[192,584,383],{"class":204},[192,586,235],{"class":200},[192,588,239],{"class":238},[183,590,592],{"className":185,"code":591,"language":187,"meta":188,"style":188},"messages = client.rent.state_one(tzid)[\"messages\"]\n",[53,593,594],{"__ignoreMap":188},[192,595,596,599,601,603,605,607,609,611,613,615,618,620,622,624],{"class":194,"line":12},[192,597,598],{"class":204},"messages ",[192,600,208],{"class":200},[192,602,341],{"class":204},[192,604,344],{"class":200},[192,606,16],{"class":197},[192,608,344],{"class":200},[192,610,568],{"class":197},[192,612,201],{"class":200},[192,614,383],{"class":204},[192,616,617],{"class":200},")[",[192,619,379],{"class":200},[192,621,154],{"class":382},[192,623,379],{"class":200},[192,625,626],{"class":200},"]\n",[49,628,420,629,74,631,634],{},[53,630,426],{},[53,632,633],{},"ERROR_NO_OPERATIONS"," for an unknown tzid.",[177,636,146],{"id":146},[49,638,639,640,642,643,74,645,647,648,651,652,344],{},"Extend a rent by ",[53,641,55],{}," days and charge the balance at once. Only confirmed rents (",[53,644,73],{},[53,646,94],{}," or ",[53,649,650],{},"4",") created with ",[53,653,654],{},"extension: true",[183,656,658],{"className":185,"code":657,"language":187,"meta":188,"style":188},"extend(tzid, days = 1) # => Hash\n",[53,659,660],{"__ignoreMap":188},[192,661,662,664,666,668,670,672,674,676,678],{"class":194,"line":12},[192,663,146],{"class":211},[192,665,201],{"class":200},[192,667,383],{"class":204},[192,669,215],{"class":200},[192,671,218],{"class":204},[192,673,208],{"class":200},[192,675,223],{"class":211},[192,677,235],{"class":200},[192,679,239],{"class":238},[183,681,683],{"className":185,"code":682,"language":187,"meta":188,"style":188},"rent = client.rent.extend(tzid, 3)\nputs rent[\"stop_time\"]\n",[53,684,685,712],{"__ignoreMap":188},[192,686,687,689,691,693,695,697,699,701,703,705,707,710],{"class":194,"line":12},[192,688,336],{"class":204},[192,690,208],{"class":200},[192,692,341],{"class":204},[192,694,344],{"class":200},[192,696,16],{"class":197},[192,698,344],{"class":200},[192,700,146],{"class":211},[192,702,201],{"class":200},[192,704,383],{"class":204},[192,706,215],{"class":200},[192,708,709],{"class":211}," 3",[192,711,361],{"class":200},[192,713,714,716,718,720,722,725,727],{"class":194,"line":17},[192,715,366],{"class":197},[192,717,369],{"class":204},[192,719,511],{"class":200},[192,721,379],{"class":200},[192,723,724],{"class":382},"stop_time",[192,726,379],{"class":200},[192,728,626],{"class":200},[49,730,420,731,74,733,735,736,344],{},[53,732,426],{},[53,734,442],{}," (unknown tzid, not confirmed yet or closed, not extendable, unknown period, a repeat within 10 s), ",[53,737,436],{},[177,739,740],{"id":740},"close",[49,742,743,744,74,746,748,749,751],{},"Return the number before the period ends. A rent that is not confirmed yet (",[53,745,73],{},[53,747,77],{},") and has no SMS can be closed only after 120 s; then, or with only ",[53,750,88],{}," SMS, the reservation is released. With a real SMS the rent is confirmed (charged) and closed. A confirmed rent closes without a refund. US numbers cannot be closed early.",[183,753,755],{"className":185,"code":754,"language":187,"meta":188,"style":188},"close(tzid) # => true\n",[53,756,757],{"__ignoreMap":188},[192,758,759,761,763,765,767],{"class":194,"line":12},[192,760,740],{"class":197},[192,762,201],{"class":200},[192,764,383],{"class":204},[192,766,235],{"class":200},[192,768,769],{"class":238}," # => true\n",[183,771,773],{"className":185,"code":772,"language":187,"meta":188,"style":188},"client.rent.close(tzid)\n",[53,774,775],{"__ignoreMap":188},[192,776,777,779,781,783,785,787,789,791],{"class":194,"line":12},[192,778,471],{"class":204},[192,780,344],{"class":200},[192,782,16],{"class":197},[192,784,344],{"class":200},[192,786,740],{"class":197},[192,788,201],{"class":200},[192,790,383],{"class":204},[192,792,361],{"class":200},[49,794,420,795,74,797,430,799,430,802,430,805,344],{},[53,796,426],{},[53,798,633],{},[53,800,801],{},"NO_COMPLETE_TZID",[53,803,804],{},"NO_CLOSE_RENT_US",[53,806,442],{},[177,808,102],{"id":102},[49,810,811,812,815],{},"Rent prices of every country, keyed by country code (a ",[53,813,814],{},"String","). No API key needed.",[183,817,819],{"className":185,"code":818,"language":187,"meta":188,"style":188},"tariffs # => Hash of country code => Hash\n",[53,820,821],{"__ignoreMap":188},[192,822,823,826],{"class":194,"line":12},[192,824,825],{"class":204},"tariffs ",[192,827,828],{"class":238},"# => Hash of country code => Hash\n",[49,830,831,832,159,835,837,838,841],{},"A tariff: ",[53,833,834],{},"{\"code\", \"name\", \"enabled\", \"new\", \"position\", \"extend\", \"confirm\"?, \"days\", \"count\", \"ext_counts\"?}",[53,836,55],{}," maps rent days to the price in USD, ",[53,839,840],{},"count"," to the numbers available.",[183,843,845],{"className":185,"code":844,"language":187,"meta":188,"style":188},"tariffs = client.rent.tariffs\n",[53,846,847],{"__ignoreMap":188},[192,848,849,851,853,855,857,859,861],{"class":194,"line":12},[192,850,825],{"class":204},[192,852,208],{"class":200},[192,854,341],{"class":204},[192,856,344],{"class":200},[192,858,16],{"class":197},[192,860,344],{"class":200},[192,862,863],{"class":197},"tariffs\n",[177,865,866],{"id":866},"tariffs_one",[49,868,869],{},"Rent prices of one country.",[183,871,873],{"className":185,"code":872,"language":187,"meta":188,"style":188},"tariffs_one(country = 7) # => Hash\n",[53,874,875],{"__ignoreMap":188},[192,876,877,879,881,883,885,887,889],{"class":194,"line":12},[192,878,866],{"class":197},[192,880,201],{"class":200},[192,882,205],{"class":204},[192,884,208],{"class":200},[192,886,212],{"class":211},[192,888,235],{"class":200},[192,890,239],{"class":238},[183,892,894],{"className":185,"code":893,"language":187,"meta":188,"style":188},"days = client.rent.tariffs_one(7)[\"days\"]\nputs days[\"7\"] # price of 7 days\n",[53,895,896,927],{"__ignoreMap":188},[192,897,898,901,903,905,907,909,911,913,915,917,919,921,923,925],{"class":194,"line":12},[192,899,900],{"class":204},"days ",[192,902,208],{"class":200},[192,904,341],{"class":204},[192,906,344],{"class":200},[192,908,16],{"class":197},[192,910,344],{"class":200},[192,912,866],{"class":197},[192,914,201],{"class":200},[192,916,281],{"class":211},[192,918,617],{"class":200},[192,920,379],{"class":200},[192,922,55],{"class":382},[192,924,379],{"class":200},[192,926,626],{"class":200},[192,928,929,931,934,936,938,940,942,945],{"class":194,"line":17},[192,930,366],{"class":197},[192,932,933],{"class":204}," days",[192,935,511],{"class":200},[192,937,379],{"class":200},[192,939,281],{"class":382},[192,941,379],{"class":200},[192,943,944],{"class":200},"]",[192,946,947],{"class":238}," # price of 7 days\n",[49,949,420,950,74,952,955],{},[53,951,426],{},[53,953,954],{},"NO_COUNTRY"," for a country without rent.",[957,958,959],"style",{},"html pre.shiki code .s2Zo4, html code.shiki .s2Zo4{--shiki-light:#6182B8;--shiki-default:#82AAFF;--shiki-dark:#82AAFF}html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}html pre.shiki code .sbssI, html code.shiki .sbssI{--shiki-light:#F76D47;--shiki-default:#F78C6C;--shiki-dark:#F78C6C}html pre.shiki code .sfNiH, html code.shiki .sfNiH{--shiki-light:#FF5370;--shiki-default:#FF9CAC;--shiki-dark:#FF9CAC}html pre.shiki code .sHwdD, html code.shiki .sHwdD{--shiki-light:#90A4AE;--shiki-light-font-style:italic;--shiki-default:#546E7A;--shiki-default-font-style:italic;--shiki-dark:#676E95;--shiki-dark-font-style:italic}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html pre.shiki code .s7zQu, html code.shiki .s7zQu{--shiki-light:#39ADB5;--shiki-light-font-style:italic;--shiki-default:#89DDFF;--shiki-default-font-style:italic;--shiki-dark:#89DDFF;--shiki-dark-font-style:italic}",{"title":188,"searchDepth":17,"depth":17,"links":961},[962,963,964,965,966,967,968],{"id":65,"depth":17,"text":65},{"id":445,"depth":17,"text":445},{"id":568,"depth":17,"text":568},{"id":146,"depth":17,"text":146},{"id":740,"depth":17,"text":740},{"id":102,"depth":17,"text":102},{"id":866,"depth":17,"text":866},"Rent a number for days and receive every SMS sent to it — client.rent.","md",{},{"order":17},{"title":14,"description":969},"-5LT8vp4OE7CggTENSYaMLRW33qxdGYpC4HmDIUwMzk",[976,978],{"title":9,"path":10,"stem":11,"description":977,"order":12},"Order a number, read its SMS, close it — client.numbers.",{"title":34,"path":35,"stem":36,"description":979,"order":37},"Test your integration offline with MockOnlineSim — no network, key or money.",1795163990845]