[{"data":1,"prerenderedAt":906},["ShallowReactive",2],{"navigation":3,"\u002Fuser":43,"\u002Fuser-surround":901},[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":895,"extension":896,"meta":897,"navigation":898,"path":20,"seo":899,"stem":21,"__hash__":900},"docs\u002Fuser.md",{"type":46,"value":47,"toc":887},"minimark",[48,57,62,65,99,133,215,234,238,241,262,307,379,383,386,419,476,567,571,577,599,630,642,646,649,663,684,688,691,726,783,883],[49,50,51,52,56],"p",{},"Every method also takes a ",[53,54,55],"code",{},"CancellationToken cancellationToken = default"," as its last parameter.",[58,59,61],"h2",{"id":60},"balanceasync","BalanceAsync",[49,63,64],{},"Balance in USD.",[66,67,72],"pre",{"className":68,"code":69,"language":70,"meta":71,"style":71},"language-csharp shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","Task\u003CUserBalance> BalanceAsync()\n","csharp","",[53,73,74],{"__ignoreMap":71},[75,76,78,82,86,89,92,96],"span",{"class":77,"line":12},"line",[75,79,81],{"class":80},"sBMFI","Task",[75,83,85],{"class":84},"sMK4o","\u003C",[75,87,88],{"class":80},"UserBalance",[75,90,91],{"class":84},">",[75,93,95],{"class":94},"s2Zo4"," BalanceAsync",[75,97,98],{"class":84},"()\n",[49,100,101,103,104,107,108,107,111,114,115,118,119,121,122,124,125,128,129,132],{},[53,102,88],{},": ",[53,105,106],{},"Balance",", ",[53,109,110],{},"Zbalance",[53,112,113],{},"Income?"," (all ",[53,116,117],{},"decimal","). ",[53,120,106],{}," includes the sum frozen by numbers and unconfirmed rents in progress (",[53,123,110],{},", which may be negative): available = ",[53,126,127],{},"Balance − max(Zbalance, 0)",". ",[53,130,131],{},"Income"," is the partner income. The server caches the answer for 60 s.",[66,134,136],{"className":68,"code":135,"language":70,"meta":71,"style":71},"var b = await client.User.BalanceAsync();\ndecimal available = b.Balance - Math.Max(b.Zbalance, 0);\n",[53,137,138,168],{"__ignoreMap":71},[75,139,140,143,146,149,152,156,159,161,163,165],{"class":77,"line":12},[75,141,142],{"class":80},"var",[75,144,145],{"class":80}," b",[75,147,148],{"class":84}," =",[75,150,151],{"class":84}," await",[75,153,155],{"class":154},"sTEyZ"," client",[75,157,158],{"class":84},".",[75,160,19],{"class":154},[75,162,158],{"class":84},[75,164,61],{"class":94},[75,166,167],{"class":84},"();\n",[75,169,170,172,175,177,179,181,184,187,190,192,195,198,201,203,205,208,212],{"class":77,"line":17},[75,171,117],{"class":84},[75,173,174],{"class":80}," available",[75,176,148],{"class":84},[75,178,145],{"class":154},[75,180,158],{"class":84},[75,182,183],{"class":154},"Balance ",[75,185,186],{"class":84},"-",[75,188,189],{"class":154}," Math",[75,191,158],{"class":84},[75,193,194],{"class":94},"Max",[75,196,197],{"class":84},"(",[75,199,200],{"class":154},"b",[75,202,158],{"class":84},[75,204,110],{"class":154},[75,206,207],{"class":84},",",[75,209,211],{"class":210},"sbssI"," 0",[75,213,214],{"class":84},");\n",[49,216,217,218,221,222,107,225,107,228,107,231,158],{},"Errors: ",[53,219,220],{},"ApiException"," ",[53,223,224],{},"ERROR_WRONG_KEY",[53,226,227],{},"ACCOUNT_BLOCKED",[53,229,230],{},"API_ACCESS_DISABLED",[53,232,233],{},"API_ACCESS_IP",[58,235,237],{"id":236},"profileasync","ProfileAsync",[49,239,240],{},"The account profile.",[66,242,244],{"className":68,"code":243,"language":70,"meta":71,"style":71},"Task\u003CProfile> ProfileAsync()\n",[53,245,246],{"__ignoreMap":71},[75,247,248,250,252,255,257,260],{"class":77,"line":12},[75,249,81],{"class":80},[75,251,85],{"class":84},[75,253,254],{"class":80},"Profile",[75,256,91],{"class":84},[75,258,259],{"class":94}," ProfileAsync",[75,261,98],{"class":84},[49,263,264,103,266,107,269,107,272,107,275,107,278,107,281,107,284,107,287,107,290,107,293,296,297,299,300,302,303,306],{},[53,265,254],{},[53,267,268],{},"Id",[53,270,271],{},"Name",[53,273,274],{},"Username",[53,276,277],{},"Email",[53,279,280],{},"Locale",[53,282,283],{},"Currency",[53,285,286],{},"NumberCountry",[53,288,289],{},"NumberReject",[53,291,292],{},"WebhookUrl",[53,294,295],{},"ApiAccess",", … (",[53,298,295],{}," and ",[53,301,289],{}," arrive in several shapes and stay ",[53,304,305],{},"JsonElement",").",[66,308,310],{"className":68,"code":309,"language":70,"meta":71,"style":71},"var profile = await client.User.ProfileAsync();\nConsole.WriteLine($\"{profile.Email} {profile.WebhookUrl}\");\n",[53,311,312,335],{"__ignoreMap":71},[75,313,314,316,319,321,323,325,327,329,331,333],{"class":77,"line":12},[75,315,142],{"class":80},[75,317,318],{"class":80}," profile",[75,320,148],{"class":84},[75,322,151],{"class":84},[75,324,155],{"class":154},[75,326,158],{"class":84},[75,328,19],{"class":154},[75,330,158],{"class":84},[75,332,237],{"class":94},[75,334,167],{"class":84},[75,336,337,340,342,345,347,350,353,356,358,360,363,366,368,370,372,374,377],{"class":77,"line":17},[75,338,339],{"class":154},"Console",[75,341,158],{"class":84},[75,343,344],{"class":94},"WriteLine",[75,346,197],{"class":84},[75,348,349],{"class":84},"$\"",[75,351,352],{"class":84},"{",[75,354,355],{"class":154},"profile",[75,357,158],{"class":84},[75,359,277],{"class":154},[75,361,362],{"class":84},"}",[75,364,365],{"class":84}," {",[75,367,355],{"class":154},[75,369,158],{"class":84},[75,371,292],{"class":154},[75,373,362],{"class":84},[75,375,376],{"class":84},"\"",[75,378,214],{"class":84},[58,380,382],{"id":381},"paymenthistoryasync","PaymentHistoryAsync",[49,384,385],{},"Top-up orders (paginated, newest first) and the available payment methods.",[66,387,389],{"className":68,"code":388,"language":70,"meta":71,"style":71},"Task\u003CPaymentHistory> PaymentHistoryAsync(int page = 1)\n",[53,390,391],{"__ignoreMap":71},[75,392,393,395,397,400,402,405,408,411,413,416],{"class":77,"line":12},[75,394,81],{"class":80},[75,396,85],{"class":84},[75,398,399],{"class":80},"PaymentHistory",[75,401,91],{"class":84},[75,403,404],{"class":94}," PaymentHistoryAsync",[75,406,407],{"class":84},"(int",[75,409,410],{"class":80}," page",[75,412,148],{"class":84},[75,414,415],{"class":210}," 1",[75,417,418],{"class":84},")\n",[49,420,421,103,423,426,427,430,431,107,434,107,437,107,440,107,443,128,446,449,450,453,454,299,456,459,460,128,463,465,466,107,469,472,473,158],{},[53,422,399],{},[53,424,425],{},"Orders"," (",[53,428,429],{},"Paginator\u003CPaymentOrder>","), ",[53,432,433],{},"Paylist",[53,435,436],{},"Domains?",[53,438,439],{},"Forms?",[53,441,442],{},"Currency?",[53,444,445],{},"Buttons?",[53,447,448],{},"PaymentOrder.Sum"," stays a decimal string (",[53,451,452],{},"\"89.00\"","); ",[53,455,283],{},[53,457,458],{},"FormText"," may be ",[53,461,462],{},"null",[53,464,433],{}," maps a group id to its payment methods; when the server sends it as a JSON array (ids 0, 1, 2…) it is kept, keyed ",[53,467,468],{},"\"0\"",[53,470,471],{},"\"1\"",", …; fields without a property are in ",[53,474,475],{},"PaymentOrder.Extra",[66,477,479],{"className":68,"code":478,"language":70,"meta":71,"style":71},"var orders = (await client.User.PaymentHistoryAsync()).Orders;\nConsole.WriteLine($\"{orders.Total} orders, page {orders.CurrentPage}\u002F{orders.LastPage}\");\n",[53,480,481,511],{"__ignoreMap":71},[75,482,483,485,488,490,493,495,497,499,501,503,506,508],{"class":77,"line":12},[75,484,142],{"class":80},[75,486,487],{"class":80}," orders",[75,489,148],{"class":84},[75,491,492],{"class":84}," (await",[75,494,155],{"class":154},[75,496,158],{"class":84},[75,498,19],{"class":154},[75,500,158],{"class":84},[75,502,382],{"class":94},[75,504,505],{"class":84},"()).",[75,507,425],{"class":154},[75,509,510],{"class":84},";\n",[75,512,513,515,517,519,521,523,525,528,530,533,535,539,541,543,545,548,550,552,554,556,558,561,563,565],{"class":77,"line":17},[75,514,339],{"class":154},[75,516,158],{"class":84},[75,518,344],{"class":94},[75,520,197],{"class":84},[75,522,349],{"class":84},[75,524,352],{"class":84},[75,526,527],{"class":154},"orders",[75,529,158],{"class":84},[75,531,532],{"class":154},"Total",[75,534,362],{"class":84},[75,536,538],{"class":537},"sfazB"," orders, page ",[75,540,352],{"class":84},[75,542,527],{"class":154},[75,544,158],{"class":84},[75,546,547],{"class":154},"CurrentPage",[75,549,362],{"class":84},[75,551,6],{"class":537},[75,553,352],{"class":84},[75,555,527],{"class":154},[75,557,158],{"class":84},[75,559,560],{"class":154},"LastPage",[75,562,362],{"class":84},[75,564,376],{"class":84},[75,566,214],{"class":84},[58,568,570],{"id":569},"setwebhookurlasync","SetWebhookUrlAsync",[49,572,573,574,306],{},"Set the URL that receives SMS webhooks (see ",[575,576,29],"a",{"href":30},[66,578,580],{"className":68,"code":579,"language":70,"meta":71,"style":71},"Task SetWebhookUrlAsync(string url)\n",[53,581,582],{"__ignoreMap":71},[75,583,584,586,589,591,594,597],{"class":77,"line":12},[75,585,81],{"class":80},[75,587,588],{"class":94}," SetWebhookUrlAsync",[75,590,197],{"class":84},[75,592,593],{"class":84},"string",[75,595,596],{"class":80}," url",[75,598,418],{"class":84},[66,600,602],{"className":68,"code":601,"language":70,"meta":71,"style":71},"await client.User.SetWebhookUrlAsync(\"https:\u002F\u002Fexample.com\u002Fonlinesim-hook\");\n",[53,603,604],{"__ignoreMap":71},[75,605,606,609,611,613,615,617,619,621,623,626,628],{"class":77,"line":12},[75,607,608],{"class":84},"await",[75,610,155],{"class":154},[75,612,158],{"class":84},[75,614,19],{"class":154},[75,616,158],{"class":84},[75,618,570],{"class":94},[75,620,197],{"class":84},[75,622,376],{"class":84},[75,624,625],{"class":537},"https:\u002F\u002Fexample.com\u002Fonlinesim-hook",[75,627,376],{"class":84},[75,629,214],{"class":84},[49,631,217,632,221,634,637,638,641],{},[53,633,220],{},[53,635,636],{},"VALIDATION_ERROR"," for an invalid URL; ",[53,639,640],{},"Message"," holds the server's field messages.",[58,643,645],{"id":644},"clearwebhookurlasync","ClearWebhookUrlAsync",[49,647,648],{},"Remove the webhook URL, also from operations in progress.",[66,650,652],{"className":68,"code":651,"language":70,"meta":71,"style":71},"Task ClearWebhookUrlAsync()\n",[53,653,654],{"__ignoreMap":71},[75,655,656,658,661],{"class":77,"line":12},[75,657,81],{"class":80},[75,659,660],{"class":94}," ClearWebhookUrlAsync",[75,662,98],{"class":84},[66,664,666],{"className":68,"code":665,"language":70,"meta":71,"style":71},"await client.User.ClearWebhookUrlAsync();\n",[53,667,668],{"__ignoreMap":71},[75,669,670,672,674,676,678,680,682],{"class":77,"line":12},[75,671,608],{"class":84},[75,673,155],{"class":154},[75,675,158],{"class":84},[75,677,19],{"class":154},[75,679,158],{"class":84},[75,681,645],{"class":94},[75,683,167],{"class":84},[58,685,687],{"id":686},"webhooklogsasync","WebhookLogsAsync",[49,689,690],{},"Webhook delivery log, newest first, 10 per page.",[66,692,694],{"className":68,"code":693,"language":70,"meta":71,"style":71},"Task\u003CPaginator\u003CWebhookLog>> WebhookLogsAsync(int page = 1)\n",[53,695,696],{"__ignoreMap":71},[75,697,698,700,702,705,707,710,713,716,718,720,722,724],{"class":77,"line":12},[75,699,81],{"class":80},[75,701,85],{"class":84},[75,703,704],{"class":80},"Paginator",[75,706,85],{"class":84},[75,708,709],{"class":80},"WebhookLog",[75,711,712],{"class":84},">>",[75,714,715],{"class":94}," WebhookLogsAsync",[75,717,407],{"class":84},[75,719,410],{"class":80},[75,721,148],{"class":84},[75,723,415],{"class":210},[75,725,418],{"class":84},[49,727,728,103,730,107,732,107,735,107,737,107,740,107,743,107,746,107,749,107,752,755,756,758,759,762,763,107,766,758,768,107,771,762,774,107,777,779,780,306],{},[53,729,709],{},[53,731,268],{},[53,733,734],{},"UserId",[53,736,292],{},[53,738,739],{},"Type",[53,741,742],{},"Params",[53,744,745],{},"Status",[53,747,748],{},"Error",[53,750,751],{},"CreatedAt",[53,753,754],{},"UpdatedAt"," — ",[53,757,739],{}," is ",[53,760,761],{},"receiving_sms"," or ",[53,764,765],{},"rent_sms",[53,767,745],{},[53,769,770],{},"success",[53,772,773],{},"fail",[53,775,776],{},"pending",[53,778,742],{}," the payload that was sent (a ",[53,781,782],{},"WebhookPayload",[66,784,786],{"className":68,"code":785,"language":70,"meta":71,"style":71},"var logs = await client.User.WebhookLogsAsync();\nforeach (var log in logs.Data) Console.WriteLine($\"{log.CreatedAt} {log.Status} {log.Error}\");\n",[53,787,788,811],{"__ignoreMap":71},[75,789,790,792,795,797,799,801,803,805,807,809],{"class":77,"line":12},[75,791,142],{"class":80},[75,793,794],{"class":80}," logs",[75,796,148],{"class":84},[75,798,151],{"class":84},[75,800,155],{"class":154},[75,802,158],{"class":84},[75,804,19],{"class":154},[75,806,158],{"class":84},[75,808,687],{"class":94},[75,810,167],{"class":84},[75,812,813,817,819,821,824,827,829,831,834,837,840,842,844,846,848,850,853,855,857,859,861,863,865,867,869,871,873,875,877,879,881],{"class":77,"line":17},[75,814,816],{"class":815},"s7zQu","foreach",[75,818,426],{"class":84},[75,820,142],{"class":80},[75,822,823],{"class":80}," log",[75,825,826],{"class":815}," in",[75,828,794],{"class":154},[75,830,158],{"class":84},[75,832,833],{"class":154},"Data",[75,835,836],{"class":84},")",[75,838,839],{"class":154}," Console",[75,841,158],{"class":84},[75,843,344],{"class":94},[75,845,197],{"class":84},[75,847,349],{"class":84},[75,849,352],{"class":84},[75,851,852],{"class":154},"log",[75,854,158],{"class":84},[75,856,751],{"class":154},[75,858,362],{"class":84},[75,860,365],{"class":84},[75,862,852],{"class":154},[75,864,158],{"class":84},[75,866,745],{"class":154},[75,868,362],{"class":84},[75,870,365],{"class":84},[75,872,852],{"class":154},[75,874,158],{"class":84},[75,876,748],{"class":154},[75,878,362],{"class":84},[75,880,376],{"class":84},[75,882,214],{"class":84},[884,885,886],"style",{},"html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}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 .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 .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 .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":71,"searchDepth":17,"depth":17,"links":888},[889,890,891,892,893,894],{"id":60,"depth":17,"text":61},{"id":236,"depth":17,"text":237},{"id":381,"depth":17,"text":382},{"id":569,"depth":17,"text":570},{"id":644,"depth":17,"text":645},{"id":686,"depth":17,"text":687},"Balance, profile, payments and the webhook URL — client.User.","md",{},{"order":22},{"title":19,"description":895},"2sRYkdt0ytegbZ98YvhRqq4MnQer_czU7JgXzrQ3Fpw",[902,904],{"title":34,"path":35,"stem":36,"description":903,"order":37},"Test your integration offline with MockOnlineSim — no network, key or money.",{"title":29,"path":30,"stem":31,"description":905,"order":32},"Receive SMS as HTTP callbacks and parse them with Webhook.Parse.",1795164313951]