live-chat

GET `/v1/chat/widgets/{widgetId}`

One chat's settings and its AI allowance.

การยืนยันตัวตน

ส่ง API key ในรูปแบบ bearer token คีย์ดังกล่าวต้องมีสิทธิ์ livechat.view หากไม่มีสิทธิ์ ระบบจะปฏิเสธด้วยรหัส 403 แทนที่จะเป็น 404

ปลายทางนี้ไม่ต้องใช้รหัสองค์กร คีย์ของคุณระบุองค์กรที่เป็นเจ้าของอยู่แล้ว และการตอบกลับจะถูกจำกัดขอบเขตไว้เฉพาะองค์กรนั้น

ทดลองใช้เลย

แทนที่สิ่งใดๆ ที่อยู่ภายในวงเล็บแหลมด้วยค่าของคุณเอง และตัวยึดตำแหน่งคีย์ด้วยคีย์จากแดชบอร์ดของคุณ

curl -X GET https://api.zinndigital.com/v1/chat/widgets/{widgetId} \
  -H "Authorization: Bearer zdk_live_…"

เข้าสู่ระบบแล้วใช่ไหม คอนโซล API ในแดชบอร์ดของคุณจะเติมรหัสองค์กรจริงและคีย์ของคุณเองโดยอัตโนมัติ และทำการส่งคำขอไปยัง API จริง เพื่อให้คุณเห็นผลลัพธ์ที่เป็นข้อมูลจริง เปิดจุดสิ้นสุดนี้ในคอนโซล API

รายละเอียด

Requires `livechat.view` or `livechat.manage`.

พารามิเตอร์

ชื่อ	ประเภท	จำเป็นต้องมี	ลักษณะของสิ่งนี้
`widgetId (path)`	`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 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

GET /v1/chat/widgets/{widgetId}