live-chat
PATCH /v1/chat/widgets/{widgetId}
Change a chat's settings, or switch it on.
Նույնականացում
Ուղարկեք API բանալին որպես bearer token: Բանալին պետք է ունենա livechat.manage թույլտվությունը. առանց դրա բանալին մերժվում է 403, և ոչ թե 404 կարգավիճակով:
Այս վերջնակետը կազմակերպության ID չի ընդունում: Ձեր բանալին արդեն իսկ նույնականացնում է այն կազմակերպությունը, որին պատկանում է, և պատասխանը սահմանափակված է դրանով:
Փորձել
Փոխարինեք անկյունային փակագծերում գտնվող ցանկացած բան ձեր սեփական արժեքներով, և բանալու տեղապահը՝ ձեր վահանակի բանալիով:
curl -X PATCH https://api.zinndigital.com/v1/chat/widgets/{widgetId} \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Մուտք գործե՞լ եք: Ձեր վահանակի API վահանակը լրացնում է ձեր իրական կազմակերպության ID-ն և ձեր սեփական բանալին և գործարկում է հարցումը ուղիղ API-ի դեմ, որպեսզի կարողանաք տեսնել փաստացի պատասխանը: Բացեք այս վերջնակետը API վահանակում
Մանրամասներ
Requires `livechat.manage`. Switching a widget on with no `allowedOrigins` is refused with `422` rather than accepted: the widget only answers pages on origins the customer listed, so an empty list would leave the chat live, looking configured, and invisible on every page with nothing saying why.
Պարամետրեր
| Անուն | Տեսակ | Պահանջվում է | Ինչ է դա |
|---|---|---|---|
widgetId (path) | string | Այո | — |
Հարցման մարմին
| Անուն | Տեսակ | Պահանջվում է | Ինչ է դա |
|---|---|---|---|
name | string | Ոչ | — |
enabled | boolean | Ոչ | — |
allowed_origins | string[] | Ոչ | — |
greeting | string | Ոչ | — |
team_name | string | Ոչ | — |
accent_colour | string | Ոչ | — |
position | string<left, right> | Ոչ | — |
hide_branding | boolean | Ոչ | — |
ai_enabled | boolean | Ոչ | — |
offline_email | string | Ոչ | — |
business_hours | object | Ոչ | — |
Պատասխան
| Անուն | Տեսակ | Պահանջվում է | Ինչ է դա |
|---|---|---|---|
id | string | Այո | — |
site_id | string | Այո | — |
name | string | Այո | — |
public_key | string | Այո | — |
enabled | boolean | Այո | Whether the chat renders. Created FALSE always: the plugin ships in the deploy footprint of every WordPress site we host, so a widget may exist for a customer who never asked fo… |
allowed_origins | string[] | Այո | Origins the widget may be embedded on. An EMPTY list refuses every page rather than allowing any — this is the only control stopping somebody else's site opening conversations a… |
tier | string | Այո | — |
greeting | string | Այո | — |
team_name | string | Այո | — |
accent_colour | string | Այո | — |
position | string<left, right> | Այո | — |
hide_branding | boolean | Այո | — |
ai_enabled | boolean | Այո | — |
offline_email | string | Այո | — |
business_hours | object | Ոչ | — |
open_now | boolean | Այո | — |
ai_allowance | ChatAiAllowance | Այո | — |
limits | object | Այո | — |
premium_extra_code | string | Այո | The catalogue code to buy for the premium tier. |
Այս վերջնակետի կողմից վերադարձվող սխալները
401 · 403 · 404 · 422