[{"data":1,"prerenderedAt":754},["ShallowReactive",2],{"navigation_docs":3,"-api-reference-sessions":67,"-api-reference-sessions-surround":749},[4,41],{"title":5,"icon":6,"path":7,"stem":8,"children":9,"page":40},"Getting started","i-lucide-rocket","\u002Fgetting-started","1.getting-started",[10,15,20,25,30,35],{"title":11,"path":12,"stem":13,"icon":14},"Introduction","\u002Fgetting-started\u002Fintroduction","1.getting-started\u002F2.introduction","i-lucide-house",{"title":16,"path":17,"stem":18,"icon":19},"Authentication","\u002Fgetting-started\u002Fauthentication","1.getting-started\u002F3.authentication","i-lucide-key-round",{"title":21,"path":22,"stem":23,"icon":24},"Quickstart","\u002Fgetting-started\u002Fquickstart","1.getting-started\u002F4.quickstart","i-lucide-zap",{"title":26,"path":27,"stem":28,"icon":29},"Base URL","\u002Fgetting-started\u002Fbase-url","1.getting-started\u002F5.base-url","i-lucide-server",{"title":31,"path":32,"stem":33,"icon":34},"Responses","\u002Fgetting-started\u002Fresponses","1.getting-started\u002F6.responses","i-lucide-braces",{"title":36,"path":37,"stem":38,"icon":39},"Troubleshooting","\u002Fgetting-started\u002Ftroubleshooting","1.getting-started\u002F7.troubleshooting","i-lucide-circle-help",false,{"title":42,"icon":43,"path":44,"stem":45,"children":46,"page":40},"API reference","i-lucide-book-open","\u002Fapi-reference","2.api-reference",[47,52,57,62],{"title":48,"path":49,"stem":50,"icon":51},"Sessions","\u002Fapi-reference\u002Fsessions","2.api-reference\u002F1.sessions","i-lucide-smartphone",{"title":53,"path":54,"stem":55,"icon":56},"Messages","\u002Fapi-reference\u002Fmessages","2.api-reference\u002F2.messages","i-lucide-message-square",{"title":58,"path":59,"stem":60,"icon":61},"Webhooks","\u002Fapi-reference\u002Fwebhooks","2.api-reference\u002F3.webhooks","i-lucide-webhook",{"title":63,"path":64,"stem":65,"icon":66},"Limits and errors","\u002Fapi-reference\u002Flimits-and-errors","2.api-reference\u002F4.limits-and-errors","i-lucide-shield-alert",{"id":68,"title":48,"body":69,"description":740,"extension":741,"links":742,"meta":743,"navigation":744,"path":49,"seo":745,"stem":50,"__hash__":748},"docs\u002F2.api-reference\u002F1.sessions.md",{"type":70,"value":71,"toc":730},"minimark",[72,76,88,93,109,158,308,312,321,324,391,396,447,451,460,492,498,502,511,543,631,639,643,652,712,715,719,726],[73,74,75],"p",{},"A session represents one WhatsApp number connected to your ChatKazi account.",[73,77,78,79,83,84,87],{},"If you do not provide a ",[80,81,82],"code",{},"sessionId",", ChatKazi uses ",[80,85,86],{},"default",".",[89,90,92],"h2",{"id":91},"list-sessions","List sessions",[94,95,100],"pre",{"className":96,"code":97,"language":98,"meta":99,"style":99},"language-txt shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","GET \u002Fsessions\n","txt","",[80,101,102],{"__ignoreMap":99},[103,104,107],"span",{"class":105,"line":106},"line",1,[103,108,97],{},[94,110,115],{"className":111,"code":112,"filename":113,"language":114,"meta":99,"style":99},"language-bash shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","curl \"$CHATKAZI_BASE_URL\u002Fsessions\" \\\n  -H \"x-api-key: $CHATKAZI_API_KEY\"\n","Terminal","bash",[80,116,117,141],{"__ignoreMap":99},[103,118,119,123,127,131,135,138],{"class":105,"line":106},[103,120,122],{"class":121},"sBMFI","curl",[103,124,126],{"class":125},"sMK4o"," \"",[103,128,130],{"class":129},"sTEyZ","$CHATKAZI_BASE_URL",[103,132,134],{"class":133},"sfazB","\u002Fsessions",[103,136,137],{"class":125},"\"",[103,139,140],{"class":129}," \\\n",[103,142,144,147,149,152,155],{"class":105,"line":143},2,[103,145,146],{"class":133},"  -H",[103,148,126],{"class":125},[103,150,151],{"class":133},"x-api-key: ",[103,153,154],{"class":129},"$CHATKAZI_API_KEY",[103,156,157],{"class":125},"\"\n",[94,159,164],{"className":160,"code":161,"filename":162,"language":163,"meta":99,"style":99},"language-json shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","{\n  \"data\": [\n    {\n      \"sessionId\": \"default\",\n      \"phoneNumber\": \"254712345678\",\n      \"connected\": true,\n      \"state\": \"connected\",\n      \"updatedAt\": \"2026-05-29T08:30:00.000Z\"\n    }\n  ]\n}\n","Response","json",[80,165,166,171,188,194,215,236,251,271,290,296,302],{"__ignoreMap":99},[103,167,168],{"class":105,"line":106},[103,169,170],{"class":125},"{\n",[103,172,173,176,180,182,185],{"class":105,"line":143},[103,174,175],{"class":125},"  \"",[103,177,179],{"class":178},"spNyl","data",[103,181,137],{"class":125},[103,183,184],{"class":125},":",[103,186,187],{"class":125}," [\n",[103,189,191],{"class":105,"line":190},3,[103,192,193],{"class":125},"    {\n",[103,195,197,200,202,204,206,208,210,212],{"class":105,"line":196},4,[103,198,199],{"class":125},"      \"",[103,201,82],{"class":121},[103,203,137],{"class":125},[103,205,184],{"class":125},[103,207,126],{"class":125},[103,209,86],{"class":133},[103,211,137],{"class":125},[103,213,214],{"class":125},",\n",[103,216,218,220,223,225,227,229,232,234],{"class":105,"line":217},5,[103,219,199],{"class":125},[103,221,222],{"class":121},"phoneNumber",[103,224,137],{"class":125},[103,226,184],{"class":125},[103,228,126],{"class":125},[103,230,231],{"class":133},"254712345678",[103,233,137],{"class":125},[103,235,214],{"class":125},[103,237,239,241,244,246,248],{"class":105,"line":238},6,[103,240,199],{"class":125},[103,242,243],{"class":121},"connected",[103,245,137],{"class":125},[103,247,184],{"class":125},[103,249,250],{"class":125}," true,\n",[103,252,254,256,259,261,263,265,267,269],{"class":105,"line":253},7,[103,255,199],{"class":125},[103,257,258],{"class":121},"state",[103,260,137],{"class":125},[103,262,184],{"class":125},[103,264,126],{"class":125},[103,266,243],{"class":133},[103,268,137],{"class":125},[103,270,214],{"class":125},[103,272,274,276,279,281,283,285,288],{"class":105,"line":273},8,[103,275,199],{"class":125},[103,277,278],{"class":121},"updatedAt",[103,280,137],{"class":125},[103,282,184],{"class":125},[103,284,126],{"class":125},[103,286,287],{"class":133},"2026-05-29T08:30:00.000Z",[103,289,157],{"class":125},[103,291,293],{"class":105,"line":292},9,[103,294,295],{"class":125},"    }\n",[103,297,299],{"class":105,"line":298},10,[103,300,301],{"class":125},"  ]\n",[103,303,305],{"class":105,"line":304},11,[103,306,307],{"class":125},"}\n",[89,309,311],{"id":310},"start-session","Start session",[94,313,315],{"className":96,"code":314,"language":98,"meta":99,"style":99},"POST \u002Fsession\u002Fstart\n",[80,316,317],{"__ignoreMap":99},[103,318,319],{"class":105,"line":106},[103,320,314],{},[73,322,323],{},"Starts a WhatsApp session and prepares a QR login flow.",[94,325,327],{"className":111,"code":326,"filename":113,"language":114,"meta":99,"style":99},"curl -X POST \"$CHATKAZI_BASE_URL\u002Fsession\u002Fstart\" \\\n  -H \"x-api-key: $CHATKAZI_API_KEY\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{ \"sessionId\": \"support\" }'\n",[80,328,329,350,364,377],{"__ignoreMap":99},[103,330,331,333,336,339,341,343,346,348],{"class":105,"line":106},[103,332,122],{"class":121},[103,334,335],{"class":133}," -X",[103,337,338],{"class":133}," POST",[103,340,126],{"class":125},[103,342,130],{"class":129},[103,344,345],{"class":133},"\u002Fsession\u002Fstart",[103,347,137],{"class":125},[103,349,140],{"class":129},[103,351,352,354,356,358,360,362],{"class":105,"line":143},[103,353,146],{"class":133},[103,355,126],{"class":125},[103,357,151],{"class":133},[103,359,154],{"class":129},[103,361,137],{"class":125},[103,363,140],{"class":129},[103,365,366,368,370,373,375],{"class":105,"line":190},[103,367,146],{"class":133},[103,369,126],{"class":125},[103,371,372],{"class":133},"Content-Type: application\u002Fjson",[103,374,137],{"class":125},[103,376,140],{"class":129},[103,378,379,382,385,388],{"class":105,"line":196},[103,380,381],{"class":133},"  -d",[103,383,384],{"class":125}," '",[103,386,387],{"class":133},"{ \"sessionId\": \"support\" }",[103,389,390],{"class":125},"'\n",[392,393,395],"h3",{"id":394},"body","Body",[397,398,399,418],"table",{},[400,401,402],"thead",{},[403,404,405,409,412,415],"tr",{},[406,407,408],"th",{},"Field",[406,410,411],{},"Type",[406,413,414],{},"Required",[406,416,417],{},"Notes",[419,420,421],"tbody",{},[403,422,423,428,431,434],{},[424,425,426],"td",{},[80,427,82],{},[424,429,430],{},"string",[424,432,433],{},"No",[424,435,436,437,439,440,443,444,87],{},"Defaults to ",[80,438,86],{},". Use letters, numbers, ",[80,441,442],{},"_",", and ",[80,445,446],{},"-",[89,448,450],{"id":449},"get-session-status","Get session status",[94,452,454],{"className":96,"code":453,"language":98,"meta":99,"style":99},"GET \u002Fsession\u002Fstatus?sessionId=support\n",[80,455,456],{"__ignoreMap":99},[103,457,458],{"class":105,"line":106},[103,459,453],{},[94,461,463],{"className":111,"code":462,"filename":113,"language":114,"meta":99,"style":99},"curl \"$CHATKAZI_BASE_URL\u002Fsession\u002Fstatus?sessionId=support\" \\\n  -H \"x-api-key: $CHATKAZI_API_KEY\"\n",[80,464,465,480],{"__ignoreMap":99},[103,466,467,469,471,473,476,478],{"class":105,"line":106},[103,468,122],{"class":121},[103,470,126],{"class":125},[103,472,130],{"class":129},[103,474,475],{"class":133},"\u002Fsession\u002Fstatus?sessionId=support",[103,477,137],{"class":125},[103,479,140],{"class":129},[103,481,482,484,486,488,490],{"class":105,"line":143},[103,483,146],{"class":133},[103,485,126],{"class":125},[103,487,151],{"class":133},[103,489,154],{"class":129},[103,491,157],{"class":125},[73,493,494,495,497],{},"Use this endpoint to check whether the session is ",[80,496,243],{},", waiting for QR, or disconnected.",[89,499,501],{"id":500},"get-qr-code","Get QR code",[94,503,505],{"className":96,"code":504,"language":98,"meta":99,"style":99},"GET \u002Fsession\u002Fqr?sessionId=support\n",[80,506,507],{"__ignoreMap":99},[103,508,509],{"class":105,"line":106},[103,510,504],{},[94,512,514],{"className":111,"code":513,"filename":113,"language":114,"meta":99,"style":99},"curl \"$CHATKAZI_BASE_URL\u002Fsession\u002Fqr?sessionId=support\" \\\n  -H \"x-api-key: $CHATKAZI_API_KEY\"\n",[80,515,516,531],{"__ignoreMap":99},[103,517,518,520,522,524,527,529],{"class":105,"line":106},[103,519,122],{"class":121},[103,521,126],{"class":125},[103,523,130],{"class":129},[103,525,526],{"class":133},"\u002Fsession\u002Fqr?sessionId=support",[103,528,137],{"class":125},[103,530,140],{"class":129},[103,532,533,535,537,539,541],{"class":105,"line":143},[103,534,146],{"class":133},[103,536,126],{"class":125},[103,538,151],{"class":133},[103,540,154],{"class":129},[103,542,157],{"class":125},[94,544,546],{"className":160,"code":545,"filename":162,"language":163,"meta":99,"style":99},"{\n  \"data\": {\n    \"sessionId\": \"support\",\n    \"state\": \"qr_ready\",\n    \"qr\": \"https:\u002F\u002Fwa.me\u002Fsettings\u002Flinked_devices#...\"\n  }\n}\n",[80,547,548,552,565,585,604,622,627],{"__ignoreMap":99},[103,549,550],{"class":105,"line":106},[103,551,170],{"class":125},[103,553,554,556,558,560,562],{"class":105,"line":143},[103,555,175],{"class":125},[103,557,179],{"class":178},[103,559,137],{"class":125},[103,561,184],{"class":125},[103,563,564],{"class":125}," {\n",[103,566,567,570,572,574,576,578,581,583],{"class":105,"line":190},[103,568,569],{"class":125},"    \"",[103,571,82],{"class":121},[103,573,137],{"class":125},[103,575,184],{"class":125},[103,577,126],{"class":125},[103,579,580],{"class":133},"support",[103,582,137],{"class":125},[103,584,214],{"class":125},[103,586,587,589,591,593,595,597,600,602],{"class":105,"line":196},[103,588,569],{"class":125},[103,590,258],{"class":121},[103,592,137],{"class":125},[103,594,184],{"class":125},[103,596,126],{"class":125},[103,598,599],{"class":133},"qr_ready",[103,601,137],{"class":125},[103,603,214],{"class":125},[103,605,606,608,611,613,615,617,620],{"class":105,"line":217},[103,607,569],{"class":125},[103,609,610],{"class":121},"qr",[103,612,137],{"class":125},[103,614,184],{"class":125},[103,616,126],{"class":125},[103,618,619],{"class":133},"https:\u002F\u002Fwa.me\u002Fsettings\u002Flinked_devices#...",[103,621,157],{"class":125},[103,623,624],{"class":105,"line":238},[103,625,626],{"class":125},"  }\n",[103,628,629],{"class":105,"line":253},[103,630,307],{"class":125},[73,632,633,634,636,637,87],{},"Show the ",[80,635,610],{}," value as a QR code in your UI. Once the QR is scanned from WhatsApp linked devices, the session state becomes ",[80,638,243],{},[89,640,642],{"id":641},"log-out-session","Log out session",[94,644,646],{"className":96,"code":645,"language":98,"meta":99,"style":99},"POST \u002Fsession\u002Flogout\n",[80,647,648],{"__ignoreMap":99},[103,649,650],{"class":105,"line":106},[103,651,645],{},[94,653,655],{"className":111,"code":654,"filename":113,"language":114,"meta":99,"style":99},"curl -X POST \"$CHATKAZI_BASE_URL\u002Fsession\u002Flogout\" \\\n  -H \"x-api-key: $CHATKAZI_API_KEY\" \\\n  -H \"Content-Type: application\u002Fjson\" \\\n  -d '{ \"sessionId\": \"support\" }'\n",[80,656,657,676,690,702],{"__ignoreMap":99},[103,658,659,661,663,665,667,669,672,674],{"class":105,"line":106},[103,660,122],{"class":121},[103,662,335],{"class":133},[103,664,338],{"class":133},[103,666,126],{"class":125},[103,668,130],{"class":129},[103,670,671],{"class":133},"\u002Fsession\u002Flogout",[103,673,137],{"class":125},[103,675,140],{"class":129},[103,677,678,680,682,684,686,688],{"class":105,"line":143},[103,679,146],{"class":133},[103,681,126],{"class":125},[103,683,151],{"class":133},[103,685,154],{"class":129},[103,687,137],{"class":125},[103,689,140],{"class":129},[103,691,692,694,696,698,700],{"class":105,"line":190},[103,693,146],{"class":133},[103,695,126],{"class":125},[103,697,372],{"class":133},[103,699,137],{"class":125},[103,701,140],{"class":129},[103,703,704,706,708,710],{"class":105,"line":196},[103,705,381],{"class":133},[103,707,384],{"class":125},[103,709,387],{"class":133},[103,711,390],{"class":125},[73,713,714],{},"Logging out disconnects the WhatsApp number and clears the stored session state.",[89,716,718],{"id":717},"session-limits","Session limits",[73,720,721,722,725],{},"Each subscription plan has an instance limit. If you reach the limit, ",[80,723,724],{},"POST \u002Fsession\u002Fstart"," returns an upgrade message before adding another WhatsApp number.",[727,728,729],"style",{},"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 .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 .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html pre.shiki code .spNyl, html code.shiki .spNyl{--shiki-light:#9C3EDA;--shiki-default:#C792EA;--shiki-dark:#C792EA}",{"title":99,"searchDepth":143,"depth":143,"links":731},[732,733,736,737,738,739],{"id":91,"depth":143,"text":92},{"id":310,"depth":143,"text":311,"children":734},[735],{"id":394,"depth":190,"text":395},{"id":449,"depth":143,"text":450},{"id":500,"depth":143,"text":501},{"id":641,"depth":143,"text":642},{"id":717,"depth":143,"text":718},"Manage WhatsApp connection sessions.","md",null,{},{"icon":51},{"title":746,"description":747},"ChatKazi sessions API","Start, list, inspect, and log out ChatKazi WhatsApp sessions.","g9AOtobgzLG9S54EGVc9hvjCb6dwLf4lJqMyN6bPapg",[750,752],{"title":36,"path":37,"stem":38,"description":751,"icon":39,"children":-1},"Fix common integration issues.",{"title":53,"path":54,"stem":55,"description":753,"icon":56,"children":-1},"Send WhatsApp text, interactive, and media messages.",1784048139989]