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