[{"data":1,"prerenderedAt":546},["ShallowReactive",2],{"navigation":3,"\u002Fwebhooks":43,"\u002Fwebhooks-surround":542},[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":29,"body":45,"description":536,"extension":537,"meta":538,"navigation":539,"path":30,"seo":540,"stem":31,"__hash__":541},"docs\u002Fwebhooks.md",{"type":46,"value":47,"toc":532},"minimark",[48,80,85,88,136,147,329,333,528],[49,50,51,52,60,61,64,65,68,69,72,73,79],"p",{},"Set a URL with ",[53,54,56],"a",{"href":55},"\u002Fuser#setwebhookurl",[57,58,59],"code",{},"$client->user->setWebhookUrl",". For each SMS the server POSTs a JSON body to it: ",[57,62,63],{},"webhook_type"," ",[57,66,67],{},"receiving_sms"," for numbers, ",[57,70,71],{},"rent_sms"," for rents. Delivery attempts are listed by ",[53,74,76],{"href":75},"\u002Fuser#webhooklogs",[57,77,78],{},"$client->user->webhookLogs",".",[81,82,84],"h2",{"id":83},"parsewebhook","parseWebhook",[49,86,87],{},"Parse an inbound webhook body from a JSON string or an already decoded array. A namespaced function, not a client method.",[89,90,95],"pre",{"className":91,"code":92,"language":93,"meta":94,"style":94},"language-php shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","function parseWebhook(string|array $payload): array\n","php","",[57,96,97],{"__ignoreMap":94},[98,99,101,105,109,113,117,120,123,126,130,133],"span",{"class":100,"line":12},"line",[98,102,104],{"class":103},"spNyl","function",[98,106,108],{"class":107},"s2Zo4"," parseWebhook",[98,110,112],{"class":111},"sMK4o","(",[98,114,116],{"class":115},"sbssI","string",[98,118,119],{"class":111},"|",[98,121,122],{"class":115},"array",[98,124,125],{"class":111}," $",[98,127,129],{"class":128},"sTEyZ","payload",[98,131,132],{"class":111},"):",[98,134,135],{"class":115}," array\n",[49,137,138,139,142,143,146],{},"Lenient: numeric fields may arrive as strings, missing or malformed fields become ",[57,140,141],{},"null",", unknown fields are dropped. It throws ",[57,144,145],{},"OnlineSimError"," only when the input is not a JSON object.",[89,148,150],{"className":91,"code":149,"language":93,"meta":94,"style":94},"use function s00d\\OnlineSimApi\\parseWebhook;\n\n\u002F\u002F webhook.php, the URL you passed to setWebhookUrl\n$hook = parseWebhook((string) file_get_contents('php:\u002F\u002Finput'));\nif ($hook['webhook_type'] === 'receiving_sms') {\n    error_log(\"operation {$hook['operation_id']}: code {$hook['code']}\");\n}\necho 'ok';\n",[57,151,152,176,182,188,226,265,309,314],{"__ignoreMap":94},[98,153,154,157,160,163,166,169,171,173],{"class":100,"line":12},[98,155,156],{"class":115},"use",[98,158,159],{"class":103}," function",[98,161,162],{"class":128}," s00d",[98,164,165],{"class":111},"\\",[98,167,168],{"class":128},"OnlineSimApi",[98,170,165],{"class":111},[98,172,84],{"class":128},[98,174,175],{"class":111},";\n",[98,177,178],{"class":100,"line":17},[98,179,181],{"emptyLinePlaceholder":180},true,"\n",[98,183,184],{"class":100,"line":22},[98,185,187],{"class":186},"sHwdD","\u002F\u002F webhook.php, the URL you passed to setWebhookUrl\n",[98,189,190,193,196,199,201,204,206,209,212,214,217,221,223],{"class":100,"line":27},[98,191,192],{"class":111},"$",[98,194,195],{"class":128},"hook ",[98,197,198],{"class":111},"=",[98,200,108],{"class":107},[98,202,203],{"class":111},"((",[98,205,116],{"class":103},[98,207,208],{"class":111},")",[98,210,211],{"class":107}," file_get_contents",[98,213,112],{"class":111},[98,215,216],{"class":111},"'",[98,218,220],{"class":219},"sfazB","php:\u002F\u002Finput",[98,222,216],{"class":111},[98,224,225],{"class":111},"));\n",[98,227,228,232,235,238,241,243,245,247,250,253,256,258,260,262],{"class":100,"line":32},[98,229,231],{"class":230},"s7zQu","if",[98,233,234],{"class":111}," ($",[98,236,237],{"class":128},"hook",[98,239,240],{"class":111},"[",[98,242,216],{"class":111},[98,244,63],{"class":219},[98,246,216],{"class":111},[98,248,249],{"class":111},"]",[98,251,252],{"class":111}," ===",[98,254,255],{"class":111}," '",[98,257,67],{"class":219},[98,259,216],{"class":111},[98,261,208],{"class":111},[98,263,264],{"class":111}," {\n",[98,266,267,270,272,275,278,281,283,286,289,292,295,297,299,301,303,306],{"class":100,"line":37},[98,268,269],{"class":107},"    error_log",[98,271,112],{"class":111},[98,273,274],{"class":111},"\"",[98,276,277],{"class":219},"operation ",[98,279,280],{"class":111},"{$",[98,282,237],{"class":128},[98,284,285],{"class":111},"['",[98,287,288],{"class":219},"operation_id",[98,290,291],{"class":111},"']}",[98,293,294],{"class":219},": code ",[98,296,280],{"class":111},[98,298,237],{"class":128},[98,300,285],{"class":111},[98,302,57],{"class":219},[98,304,305],{"class":111},"']}\"",[98,307,308],{"class":111},");\n",[98,310,311],{"class":100,"line":42},[98,312,313],{"class":111},"}\n",[98,315,317,320,322,325,327],{"class":100,"line":316},8,[98,318,319],{"class":107},"echo",[98,321,255],{"class":111},[98,323,324],{"class":219},"ok",[98,326,216],{"class":111},[98,328,175],{"class":111},[81,330,332],{"id":331},"payload-fields","Payload fields",[334,335,336,352],"table",{},[337,338,339],"thead",{},[340,341,342,346,349],"tr",{},[343,344,345],"th",{},"Field",[343,347,348],{},"Type",[343,350,351],{},"Description",[353,354,355,370,387,401,415,449,466,480,497,514],"tbody",{},[340,356,357,362,367],{},[358,359,360],"td",{},[57,361,63],{},[358,363,364],{},[57,365,366],{},"'receiving_sms'|'rent_sms'|null",[358,368,369],{},"Kind of operation.",[340,371,372,376,381],{},[358,373,374],{},[57,375,288],{},[358,377,378],{},[57,379,380],{},"?int",[358,382,383,386],{},[57,384,385],{},"tzid"," of the operation or rent.",[340,388,389,394,398],{},[358,390,391],{},[57,392,393],{},"user_id",[358,395,396],{},[57,397,380],{},[358,399,400],{},"Account id.",[340,402,403,408,412],{},[358,404,405],{},[57,406,407],{},"country_code",[358,409,410],{},[57,411,380],{},[358,413,414],{},"Country code of the number.",[340,416,417,422,427],{},[358,418,419],{},[57,420,421],{},"number",[358,423,424],{},[57,425,426],{},"?string",[358,428,429,430,433,434,437,438,441,442,444,445,448],{},"Numbers: ",[57,431,432],{},"+"," and the full number (",[57,435,436],{},"+79001234567","), or ",[57,439,440],{},"hidden",". Rent: the full number in digits without ",[57,443,432],{}," (",[57,446,447],{},"79001234567",").",[340,450,451,456,460],{},[358,452,453],{},[57,454,455],{},"sender",[358,457,458],{},[57,459,426],{},[358,461,462,463,79],{},"Sender of the SMS, e.g. ",[57,464,465],{},"VK",[340,467,468,473,477],{},[358,469,470],{},[57,471,472],{},"message",[358,474,475],{},[57,476,426],{},[358,478,479],{},"Full SMS text.",[340,481,482,486,490],{},[358,483,484],{},[57,485,57],{},[358,487,488],{},[57,489,426],{},[358,491,492,493,496],{},"Code extracted from the SMS; ",[57,494,495],{},"''"," when none was found.",[340,498,499,504,508],{},[358,500,501],{},[57,502,503],{},"time_start",[358,505,506],{},[57,507,426],{},[358,509,510,511,79],{},"Numbers: when the operation was ordered. Rent: when the SMS arrived. ",[57,512,513],{},"YYYY-MM-DD HH:MM:SS",[340,515,516,521,525],{},[358,517,518],{},[57,519,520],{},"time_left",[358,522,523],{},[57,524,380],{},[358,526,527],{},"Time left: seconds for numbers, minutes for rent.",[529,530,531],"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 .sbssI, html code.shiki .sbssI{--shiki-light:#F76D47;--shiki-default:#F78C6C;--shiki-dark:#F78C6C}html pre.shiki code .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}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 .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 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":94,"searchDepth":17,"depth":17,"links":533},[534,535],{"id":83,"depth":17,"text":84},{"id":331,"depth":17,"text":332},"Receive SMS as HTTP callbacks and parse them with parseWebhook.","md",{},{"order":32},{"title":29,"description":536},"AWhl4zzaT9ZVH7QY0BqGDRzMF2SedaWrCVpmP6v7AxY",[543,545],{"title":19,"path":20,"stem":21,"description":544,"order":22},"Balance, profile, payments and the webhook URL — $client->user.",null,1795164122570]