ការផ្ទៀងផ្ទាត់ភាពត្រឹមត្រូវ

ផ្ញើគ្រាប់ចុច API ជាតូកែន bearer ។ ចំណុចបញ្ចប់នេះមិនបញ្ជាក់ពីសិទ្ធិជាក់លាក់ណាមួយនៅក្នុងការបញ្ជាក់នោះទេ ដូច្នេះសូមផ្ដល់សិទ្ធិអប្បបរមាដែលគ្រាប់ចុចរបស់អ្នកត្រូវការ ហើយពិនិត្យមើលការឆ្លើយតបជំនួសឱ្យការសន្មត់។

ចំនុចបញ្ចប់នេះមិនត្រូវការលេខសម្គាល់ស្ថាប័នទេ។ ពស័្ដកូនរបស់អ្នករួចហើយកំណត់អត្តសញ្ញាណស្ថាប័នដែលវាជាកម្មសិទ្ធិ ហើយការឆ្លើយតបគឺត្រូវបានកំណត់វិសាលភាពទៅតាមនោះ។

សាកល្បង

ជំនួសអ្វីមួយនៅក្នុងសញ្ញាពងក្រពើ < > ដោយប្រើតម្លៃផ្ទាល់ខ្លួនរបស់អ្នក ហើយជំនួសកន្លែងរក្សាទុកសោដោយប្រើសោចេញពីផ្ទាំងគ្រប់គ្រងរបស់អ្នក។

curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/chat-agent \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

បានចូលគណនីរួចហើយមែនទេ? កុងសូល API ក្នុងផ្ទាំងគ្រប់គ្រងរបស់អ្នក បំពេញលេខសម្គាល់ស្ថាប័នពិតប្រាកដរបស់អ្នក និងសោផ្ទាល់ខ្លួនរបស់អ្នក ហើយដំណើរការសំណើទល់នឹង API ផ្ទាល់ ដូច្នេះអ្នកអាចមើលឃើញការឆ្លើយតបពិតប្រាកដ។ បើកចំណុចបញ្ចប់នេះក្នុងកុងសូល API

ព័ត៌មានលម្អិត

Creates the agent, named after the site and pre-authorised for the site's own domains so the snippet works the moment it is pasted. ⛔ Refuses with 422 when the product has not been bought for this site, or when the account is not in good standing — two different refusals with two different remedies, told apart by the code in the error details (not_purchased / not_in_good_standing). A suspension is not cleared by credit, so that refusal deliberately offers no top-up. Calling it twice returns the existing agent with 200 rather than an error.

ប៉ារ៉ាម៉ែត្រ

ឈ្មោះប្រភេទតម្រូវការតើវាជាអ្វី
siteId (path)Uuidបាទ/ចាសSite ID (UUIDv7).

សំណើរបស់រាងកាយ

ឈ្មោះប្រភេទតម្រូវការតើវាជាអ្វី
namestringទេ
greetingstringទេ
personastringទេ
brand_colourstringទេ
launcher_positionstring<left, right>ទេ
handoff_enabledbooleanទេ
statusstring<active, paused>ទេ
allowed_originsstring[]ទេ
monthly_message_capintegerទេ

ផ្អាកដំណើរការ

ឈ្មោះប្រភេទតម្រូវការតើវាជាអ្វី
idstringបាទ/ចាស
site_idstringទេ
namestringបាទ/ចាសWhat the agent calls itself to visitors. The customer's brand, not ours.
greetingstringទេ
personastringទេFree text describing tone and what to say. ⛔ It cannot widen what the agent may read — retrieval decides that before the model sees anything.
brand_colourstringទេ
launcher_positionstring<left, right>ទេ
statusstring<active, paused>បាទ/ចាសpaused stops it answering and keeps everything it has learned, so switching back on is instant rather than a re-index.
handoff_enabledbooleanទេOffer to pass the visitor to a person when the agent cannot answer.
public_keystringបាទ/ចាសCarried in the embed snippet. It identifies the agent and authorises nothing a page's reader could not already do — the fence is allowed_origins.
allowed_originsstring[]បាទ/ចាសOrigins the public endpoints will answer for. ⛔ Empty refuses everything — it means "not installed yet", never "allow anything".
monthly_message_capintegerទេMessages included per calendar month. Checked before each answer.
messages_this_monthintegerទេ
indexed_chunksintegerទេPassages of the site currently searchable. Zero means it knows nothing yet.
embed_snippetstringទេThe two lines to paste into any website.
sourcesChatAgentSource[]បាទ/ចាស

កំហុសដែលចំណុចបញ្ចប់នេះអាចបង្វិលត្រឡប់មកវិញ

401 · 403 · 404 · 422