live-chat
PATCH /v1/chat/widgets/{widgetId}
Change a chat's settings, or switch it on.
પ્રમાણીકરણ
એપીઆઈ કી (API key) ને બેરર ટોકન તરીકે મોકલો. કી પાસે livechat.manage પરવાનગી હોવી આવશ્યક છે; તેના વગરની કીને 404 ને બદલે 403 સાથે અસ્વીકાર કરવામાં આવશે.
આ એન્ડપૉઇન્ટ કોઈ સંસ્થા આઈડી (organisation id) લેતું નથી. તમારી કી (key) પહેલેથી જ તે જે સંસ્થા સાથે સંબંધિત છે તેની ઓળખ કરે છે, અને પ્રતિસાદ (response) તે જ પૂરતો મર્યાદિત છે.
આયમાવો
કોઈપણ કૌંસમાં રહેલી બાબતને તમારા પોતાના મૂલ્યોથી બદલો અને કી પ્લેસહોલ્ડરને તમારા ડેશબોર્ડની કીથી બદલો.
curl -X PATCH https://api.zinndigital.com/v1/chat/widgets/{widgetId} \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'साइन ઇન કરેલ છે? તમારા ડેશબોર્ડમાં આવેલું API કન્સોલ તમારી વાસ્તવિક સંસ્થાની આઈડી અને તમારી પોતાની કી ભરે છે, અને લાઇવ 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