[{"data":1,"prerenderedAt":815},["ShallowReactive",2],{"navigation":3,"\u002Fuser":43,"\u002Fuser-surround":810},[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":19,"body":45,"description":804,"extension":805,"meta":806,"navigation":807,"path":20,"seo":808,"stem":21,"__hash__":809},"docs\u002Fuser.md",{"type":46,"value":47,"toc":796},"minimark",[48,52,56,93,110,193,213,216,219,238,247,315,318,321,360,399,507,510,517,546,575,587,590,593,611,630,633,636,667,705,792],[49,50,51],"h2",{"id":51},"balance",[53,54,55],"p",{},"Balance in USD.",[57,58,63],"pre",{"className":59,"code":60,"language":61,"meta":62,"style":62},"language-python shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","def balance() -> Balance  # {\"balance\": float, \"zbalance\": float, \"income\"?: float}\n","python","",[64,65,66],"code",{"__ignoreMap":62},[67,68,70,74,78,82,85,89],"span",{"class":69,"line":12},"line",[67,71,73],{"class":72},"spNyl","def",[67,75,77],{"class":76},"s2Zo4"," balance",[67,79,81],{"class":80},"sMK4o","()",[67,83,84],{"class":80}," ->",[67,86,88],{"class":87},"sTEyZ"," Balance  ",[67,90,92],{"class":91},"sHwdD","# {\"balance\": float, \"zbalance\": float, \"income\"?: float}\n",[53,94,95,97,98,101,102,105,106,109],{},[64,96,51],{}," includes the sum frozen by numbers and unconfirmed rents in progress (",[64,99,100],{},"zbalance",", which may be negative): available = ",[64,103,104],{},"balance − max(zbalance, 0)",". ",[64,107,108],{},"income"," is the partner income. The server caches the answer for 60 s.",[57,111,113],{"className":59,"code":112,"language":61,"meta":62,"style":62},"b = client.user.balance()\navailable = b[\"balance\"] - max(b[\"zbalance\"], 0)\n",[64,114,115,139],{"__ignoreMap":62},[67,116,117,120,123,126,129,132,134,136],{"class":69,"line":12},[67,118,119],{"class":87},"b ",[67,121,122],{"class":80},"=",[67,124,125],{"class":87}," client",[67,127,128],{"class":80},".",[67,130,21],{"class":131},"swJcz",[67,133,128],{"class":80},[67,135,51],{"class":76},[67,137,138],{"class":80},"()\n",[67,140,141,144,146,149,152,155,158,160,163,166,169,172,175,177,179,181,183,186,190],{"class":69,"line":17},[67,142,143],{"class":87},"available ",[67,145,122],{"class":80},[67,147,148],{"class":87}," b",[67,150,151],{"class":80},"[",[67,153,154],{"class":80},"\"",[67,156,51],{"class":157},"sfazB",[67,159,154],{"class":80},[67,161,162],{"class":80},"]",[67,164,165],{"class":80}," -",[67,167,168],{"class":76}," max",[67,170,171],{"class":80},"(",[67,173,174],{"class":76},"b",[67,176,151],{"class":80},[67,178,154],{"class":80},[67,180,100],{"class":157},[67,182,154],{"class":80},[67,184,185],{"class":80},"],",[67,187,189],{"class":188},"sbssI"," 0",[67,191,192],{"class":80},")\n",[53,194,195,196,199,200,203,204,203,207,203,210,128],{},"Errors: ",[64,197,198],{},"ApiError"," ",[64,201,202],{},"ERROR_WRONG_KEY",", ",[64,205,206],{},"ACCOUNT_BLOCKED",[64,208,209],{},"API_ACCESS_DISABLED",[64,211,212],{},"API_ACCESS_IP",[49,214,215],{"id":215},"profile",[53,217,218],{},"The account profile.",[57,220,222],{"className":59,"code":221,"language":61,"meta":62,"style":62},"def profile() -> Profile\n",[64,223,224],{"__ignoreMap":62},[67,225,226,228,231,233,235],{"class":69,"line":12},[67,227,73],{"class":72},[67,229,230],{"class":76}," profile",[67,232,81],{"class":80},[67,234,84],{"class":80},[67,236,237],{"class":87}," Profile\n",[53,239,240,243,244,128],{},[64,241,242],{},"Profile",": ",[64,245,246],{},"{id, name, username, email, locale, currency, number_country, number_reject, webhook_url, api_access, …}",[57,248,250],{"className":59,"code":249,"language":61,"meta":62,"style":62},"profile = client.user.profile()\nprint(profile.get(\"email\"), profile.get(\"webhook_url\"))\n",[64,251,252,271],{"__ignoreMap":62},[67,253,254,257,259,261,263,265,267,269],{"class":69,"line":12},[67,255,256],{"class":87},"profile ",[67,258,122],{"class":80},[67,260,125],{"class":87},[67,262,128],{"class":80},[67,264,21],{"class":131},[67,266,128],{"class":80},[67,268,215],{"class":76},[67,270,138],{"class":80},[67,272,273,276,278,280,282,285,287,289,292,294,297,299,301,303,305,307,310,312],{"class":69,"line":17},[67,274,275],{"class":76},"print",[67,277,171],{"class":80},[67,279,215],{"class":76},[67,281,128],{"class":80},[67,283,284],{"class":76},"get",[67,286,171],{"class":80},[67,288,154],{"class":80},[67,290,291],{"class":157},"email",[67,293,154],{"class":80},[67,295,296],{"class":80},"),",[67,298,230],{"class":76},[67,300,128],{"class":80},[67,302,284],{"class":76},[67,304,171],{"class":80},[67,306,154],{"class":80},[67,308,309],{"class":157},"webhook_url",[67,311,154],{"class":80},[67,313,314],{"class":80},"))\n",[49,316,317],{"id":317},"payment_history",[53,319,320],{},"Top-up orders (paginated, newest first) and the available payment methods.",[57,322,324],{"className":59,"code":323,"language":61,"meta":62,"style":62},"def payment_history(page: int = 1) -> PaymentHistory\n",[64,325,326],{"__ignoreMap":62},[67,327,328,330,333,335,339,342,346,349,352,355,357],{"class":69,"line":12},[67,329,73],{"class":72},[67,331,332],{"class":76}," payment_history",[67,334,171],{"class":80},[67,336,338],{"class":337},"sHdIc","page",[67,340,341],{"class":80},":",[67,343,345],{"class":344},"sBMFI"," int",[67,347,348],{"class":80}," =",[67,350,351],{"class":188}," 1",[67,353,354],{"class":80},")",[67,356,84],{"class":80},[67,358,359],{"class":87}," PaymentHistory\n",[53,361,362,243,365,368,369,372,373,105,376,379,380,383,384,387,388,391,392,105,395,398],{},[64,363,364],{},"PaymentHistory",[64,366,367],{},"{orders, paylist, domains?, forms?, currency?, buttons?}"," — ",[64,370,371],{},"orders"," is a paginator of ",[64,374,375],{},"PaymentOrder",[64,377,378],{},"PaymentOrder[\"sum\"]"," stays a decimal string (",[64,381,382],{},"\"89.00\"","); ",[64,385,386],{},"currency"," and ",[64,389,390],{},"form_text"," may be ",[64,393,394],{},"None",[64,396,397],{},"paylist"," maps a group id to its payment methods, or is a list when the ids are 0, 1, 2… (the server sends a JSON array then).",[57,400,402],{"className":59,"code":401,"language":61,"meta":62,"style":62},"orders = client.user.payment_history()[\"orders\"]\nprint(f\"{orders['total']} orders, page {orders['current_page']}\u002F{orders['last_page']}\")\n",[64,403,404,433],{"__ignoreMap":62},[67,405,406,409,411,413,415,417,419,421,424,426,428,430],{"class":69,"line":12},[67,407,408],{"class":87},"orders ",[67,410,122],{"class":80},[67,412,125],{"class":87},[67,414,128],{"class":80},[67,416,21],{"class":131},[67,418,128],{"class":80},[67,420,317],{"class":76},[67,422,423],{"class":80},"()[",[67,425,154],{"class":80},[67,427,371],{"class":157},[67,429,154],{"class":80},[67,431,432],{"class":80},"]\n",[67,434,435,437,439,442,444,447,449,451,454,457,459,461,464,467,469,471,473,475,478,480,482,484,486,488,490,492,494,497,499,501,503,505],{"class":69,"line":17},[67,436,275],{"class":76},[67,438,171],{"class":80},[67,440,441],{"class":72},"f",[67,443,154],{"class":157},[67,445,446],{"class":188},"{",[67,448,371],{"class":76},[67,450,151],{"class":80},[67,452,453],{"class":80},"'",[67,455,456],{"class":157},"total",[67,458,453],{"class":80},[67,460,162],{"class":80},[67,462,463],{"class":188},"}",[67,465,466],{"class":157}," orders, page ",[67,468,446],{"class":188},[67,470,371],{"class":76},[67,472,151],{"class":80},[67,474,453],{"class":80},[67,476,477],{"class":157},"current_page",[67,479,453],{"class":80},[67,481,162],{"class":80},[67,483,463],{"class":188},[67,485,6],{"class":157},[67,487,446],{"class":188},[67,489,371],{"class":76},[67,491,151],{"class":80},[67,493,453],{"class":80},[67,495,496],{"class":157},"last_page",[67,498,453],{"class":80},[67,500,162],{"class":80},[67,502,463],{"class":188},[67,504,154],{"class":157},[67,506,192],{"class":80},[49,508,509],{"id":509},"set_webhook_url",[53,511,512,513,516],{},"Set the URL that receives SMS webhooks (see ",[514,515,29],"a",{"href":30},").",[57,518,520],{"className":59,"code":519,"language":61,"meta":62,"style":62},"def set_webhook_url(url: str) -> bool\n",[64,521,522],{"__ignoreMap":62},[67,523,524,526,529,531,534,536,539,541,543],{"class":69,"line":12},[67,525,73],{"class":72},[67,527,528],{"class":76}," set_webhook_url",[67,530,171],{"class":80},[67,532,533],{"class":337},"url",[67,535,341],{"class":80},[67,537,538],{"class":344}," str",[67,540,354],{"class":80},[67,542,84],{"class":80},[67,544,545],{"class":344}," bool\n",[57,547,549],{"className":59,"code":548,"language":61,"meta":62,"style":62},"client.user.set_webhook_url(\"https:\u002F\u002Fexample.com\u002Fonlinesim-hook\")\n",[64,550,551],{"__ignoreMap":62},[67,552,553,556,558,560,562,564,566,568,571,573],{"class":69,"line":12},[67,554,555],{"class":87},"client",[67,557,128],{"class":80},[67,559,21],{"class":131},[67,561,128],{"class":80},[67,563,509],{"class":76},[67,565,171],{"class":80},[67,567,154],{"class":80},[67,569,570],{"class":157},"https:\u002F\u002Fexample.com\u002Fonlinesim-hook",[67,572,154],{"class":80},[67,574,192],{"class":80},[53,576,195,577,199,579,582,583,586],{},[64,578,198],{},[64,580,581],{},"VALIDATION_ERROR"," for an invalid URL; ",[64,584,585],{},"message"," holds the server's field messages.",[49,588,589],{"id":589},"clear_webhook_url",[53,591,592],{},"Remove the webhook URL, also from operations in progress.",[57,594,596],{"className":59,"code":595,"language":61,"meta":62,"style":62},"def clear_webhook_url() -> bool\n",[64,597,598],{"__ignoreMap":62},[67,599,600,602,605,607,609],{"class":69,"line":12},[67,601,73],{"class":72},[67,603,604],{"class":76}," clear_webhook_url",[67,606,81],{"class":80},[67,608,84],{"class":80},[67,610,545],{"class":344},[57,612,614],{"className":59,"code":613,"language":61,"meta":62,"style":62},"client.user.clear_webhook_url()\n",[64,615,616],{"__ignoreMap":62},[67,617,618,620,622,624,626,628],{"class":69,"line":12},[67,619,555],{"class":87},[67,621,128],{"class":80},[67,623,21],{"class":131},[67,625,128],{"class":80},[67,627,589],{"class":76},[67,629,138],{"class":80},[49,631,632],{"id":632},"webhook_logs",[53,634,635],{},"Webhook delivery log, newest first, 10 per page.",[57,637,639],{"className":59,"code":638,"language":61,"meta":62,"style":62},"def webhook_logs(page: int = 1) -> WebhookLogs\n",[64,640,641],{"__ignoreMap":62},[67,642,643,645,648,650,652,654,656,658,660,662,664],{"class":69,"line":12},[67,644,73],{"class":72},[67,646,647],{"class":76}," webhook_logs",[67,649,171],{"class":80},[67,651,338],{"class":337},[67,653,341],{"class":80},[67,655,345],{"class":344},[67,657,348],{"class":80},[67,659,351],{"class":188},[67,661,354],{"class":80},[67,663,84],{"class":80},[67,665,666],{"class":87}," WebhookLogs\n",[53,668,669,372,672,243,675,368,678,681,682,685,686,203,689,681,692,203,695,685,698,203,701,704],{},[64,670,671],{},"WebhookLogs",[64,673,674],{},"WebhookLog",[64,676,677],{},"{id, user_id, webhook_url, type, params, status, error, created_at, updated_at}",[64,679,680],{},"type"," is ",[64,683,684],{},"receiving_sms"," or ",[64,687,688],{},"rent_sms",[64,690,691],{},"status",[64,693,694],{},"success",[64,696,697],{},"fail",[64,699,700],{},"pending",[64,702,703],{},"params"," the payload that was sent.",[57,706,708],{"className":59,"code":707,"language":61,"meta":62,"style":62},"for log in client.user.webhook_logs()[\"data\"]:\n    print(log[\"created_at\"], log[\"status\"], log[\"error\"])\n",[64,709,710,744],{"__ignoreMap":62},[67,711,712,716,719,722,724,726,728,730,732,734,736,739,741],{"class":69,"line":12},[67,713,715],{"class":714},"s7zQu","for",[67,717,718],{"class":87}," log ",[67,720,721],{"class":714},"in",[67,723,125],{"class":87},[67,725,128],{"class":80},[67,727,21],{"class":131},[67,729,128],{"class":80},[67,731,632],{"class":76},[67,733,423],{"class":80},[67,735,154],{"class":80},[67,737,738],{"class":157},"data",[67,740,154],{"class":80},[67,742,743],{"class":80},"]:\n",[67,745,746,749,751,754,756,758,761,763,765,768,770,772,774,776,778,780,782,784,787,789],{"class":69,"line":17},[67,747,748],{"class":76},"    print",[67,750,171],{"class":80},[67,752,753],{"class":76},"log",[67,755,151],{"class":80},[67,757,154],{"class":80},[67,759,760],{"class":157},"created_at",[67,762,154],{"class":80},[67,764,185],{"class":80},[67,766,767],{"class":76}," log",[67,769,151],{"class":80},[67,771,154],{"class":80},[67,773,691],{"class":157},[67,775,154],{"class":80},[67,777,185],{"class":80},[67,779,767],{"class":76},[67,781,151],{"class":80},[67,783,154],{"class":80},[67,785,786],{"class":157},"error",[67,788,154],{"class":80},[67,790,791],{"class":80},"])\n",[793,794,795],"style",{},"html pre.shiki code .spNyl, html code.shiki .spNyl{--shiki-light:#9C3EDA;--shiki-default:#C792EA;--shiki-dark:#C792EA}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 .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 .swJcz, html code.shiki .swJcz{--shiki-light:#E53935;--shiki-default:#F07178;--shiki-dark:#F07178}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html pre.shiki code .sbssI, html code.shiki .sbssI{--shiki-light:#F76D47;--shiki-default:#F78C6C;--shiki-dark:#F78C6C}html pre.shiki code .sHdIc, html code.shiki .sHdIc{--shiki-light:#90A4AE;--shiki-light-font-style:italic;--shiki-default:#EEFFFF;--shiki-default-font-style:italic;--shiki-dark:#BABED8;--shiki-dark-font-style:italic}html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}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":62,"searchDepth":17,"depth":17,"links":797},[798,799,800,801,802,803],{"id":51,"depth":17,"text":51},{"id":215,"depth":17,"text":215},{"id":317,"depth":17,"text":317},{"id":509,"depth":17,"text":509},{"id":589,"depth":17,"text":589},{"id":632,"depth":17,"text":632},"Balance, profile, payments and the webhook URL — client.user.","md",{},{"order":22},{"title":19,"description":804},"DaH_5o-OgggjYGA2t4zgqz0ccTNmhAqzN5HIZbUt9x8",[811,813],{"title":34,"path":35,"stem":36,"description":812,"order":37},"Test your integration offline with MockOnlineSim — no network, key or money.",{"title":29,"path":30,"stem":31,"description":814,"order":32},"Receive SMS as HTTP callbacks and parse them with parse_webhook.",1795164115454]