live-chat
POST /v1/chat/widgets
Create a chat for a site.
प्रमाणीकरण
एपिआई कुञ्जीलाई बियरर टोकन (bearer token) को रूपमा पठाउनुहोस्। कुञ्जीसँग livechat.manage अनुमति हुनुपर्छ; अनुमति नभएको कुञ्जीलाई 404 होइन, 403 मार्फत अस्वीकार गरिन्छ।
तपाईंको संस्थाको आइडी राख्ने ठाउँ
यो इन्डपोटले JSON बडीमा एक फिल्डको रूपमा org_id लिन्छ।
तपाईंको संस्थाको आइडी (ID) तपाईंको ड्यासबोर्डमा रहेको API कुञ्जीहरू (keys) स्क्रिनमा, कुञ्जीको छेउमा हुन्छ। तपाईंले गर्ने प्रत्येक कलमा यही आइडी प्रयोग हुन्छ।
प्रयास गर्नुहोस्
कोणीय कोष्ठकभित्र भएका जुनसुकै कुरालाई आफ्नो मानहरूद्वारा बदल्नुहोस्, र मुख्य स्थानहोल्डरलाई तपाईंको ड्यासबोर्डको कुञ्जीद्वारा बदल्नुहोस्।
curl -X POST https://api.zinndigital.com/v1/chat/widgets \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string> }'लगइन गर्नुभएको छ? तपाईंको ड्यासबोर्डमा रहेको API कन्सोलले तपाईंको वास्तविक संस्थाको आईडी र आफ्नै कुञ्जी भरिदिन्छ, र लाइभ API विरुद्ध अनुरोध चलाउँछ ताकि तपाईंले वास्तविक प्रतिक्रिया हेर्न सक्नुहोस्। यो एन्डपोइन्टलाई API कन्सोलमा खोल्नुहोस्
विवरणहरू
Requires livechat.manage. The new widget is created switched off: a chat window that starts talking to a customer's visitors before they have asked for one is a consent problem, not a feature.
अनुरोध बडी
| नाम | प्रकार | आवश्यक | यो के हो |
|---|---|---|---|
org_id | string | हैन | — |
site_id | string | हैन | — |
name | string | हुन्छ | — |
team_name | string | हैन | — |
allowed_origins | string[] | हैन | — |
प्रतिक्रिया
| नाम | प्रकार | आवश्यक | यो के हो |
|---|---|---|---|
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 for… |
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… |
tier | string | हुन्छ | The tier this widget is EFFECTIVELY on. Premium is included free with Zinn® hosting, so this may read premium on a widget nobody has paid for — read purchased_tier for what… |
tier_source | string<free, purchase, hosting> | हुन्छ | Why the widget is on that tier. hosting means it is included with the customer's Zinn® hosting and there is nothing to buy; purchase means the Premium extra was bought for… |
purchased_tier | string | हुन्छ | The tier actually PAID for, independent of any hosting inclusion. |
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 · 422