Kênh

client.channel quản lý các kênh nhắn tin — điểm đầu vào mà qua đó các liên hệ tiếp cận AI agent của bạn. Các loại kênh được hỗ trợ: Web, WhatsApp, Facebook Messenger, Instagram, Email, WeChat, LINE.

---

Schema

Channel

Trường	Kiểu	Mô tả
object_name	string?	Định danh loại đối tượng
id	string	ID duy nhất của kênh
name	string	Tên hiển thị của kênh
type	"web" | "facebook" | "whatsapp" | "instagram" | "wechat" | "line" | "email" | "wecom"	Loại nền tảng kênh
organization_id	string	Tổ chức sở hữu kênh này
business_unit_id	string?	ID đơn vị kinh doanh
is_active	boolean	Kênh có được bật không
config	object?	Cấu hình theo kênh
created_at	string	ISO 8601 thời gian tạo
updated_at	string	ISO 8601 thời gian cập nhật

ChannelCredential

Trường	Kiểu	Mô tả
_id	string	ID duy nhất của credential
type	string?	Loại credential (vd: facebook, whatsapp)
name	string?	Tên hiển thị

---

Phương thức

CRUD cơ bản

Phương thức	TypeScript	Python	Mô tả
Danh sách kênh	list	list	Danh sách tất cả kênh, có thể lọc theo loại
Lấy kênh	get	get	Lấy kênh theo ID
Tạo kênh	create	create	Tạo kênh tổng quát
Cập nhật kênh	update	update	Bật/tắt trạng thái hoặc cập nhật cấu hình
Xóa kênh	delete / deleteV3	delete / delete_v3	Xóa kênh
Lấy số lượng	getCount	get_count	Tổng số kênh

Tạo theo loại

Phương thức	TypeScript	Python	Mô tả
Tạo Web	createWeb	create_web	Kênh chat Web
Tạo Facebook	createFacebook	create_facebook	Kênh Facebook Messenger
Cập nhật Facebook	updateFacebook	update_facebook	Cập nhật cấu hình Facebook
Tạo Instagram	createInstagram	create_instagram	Kênh Instagram
Tạo Email	createEmail	create_email	Kênh Email
Tạo WeChat	createWechat	create_wechat	Kênh WeChat
Tạo LINE	createLine	create_line	Kênh LINE
Tạo WhatsApp	createWhatsApp	create_whatsapp	Kênh WhatsApp
Cập nhật WhatsApp	updateWhatsApp	update_whatsapp	Cập nhật cấu hình WhatsApp

Thông tin xác thực

Phương thức	TypeScript	Python	Mô tả
Lấy Facebook pages	getFacebookPages	get_facebook_pages	Danh sách Facebook pages cho credential
Lấy credential	getCredential	get_credential	Lấy credential đã lưu
Cập nhật credential	updateCredential	update_credential	Cập nhật credential
Xóa credential	deleteCredential	delete_credential	Xóa credential

Workflow & Nhóm

Phương thức	TypeScript	Python	Mô tả
Cập nhật workflow của kênh	updateChannelWorkflow	update_channel_workflow	Gắn workflow vào kênh
Xóa workflow của kênh	deleteChannelWorkflow	delete_channel_workflow	Gỡ workflow
Danh sách nhóm có thể gán	listAssignableTeams	list_assignable_teams	Nhóm có thể được gán vào kênh này
Danh sách người quan sát nhóm	listTeamObservers	list_team_observers	Người quan sát của một nhóm

---

list / list

TypeScript

const channels = await client.channel.list({ type: "whatsapp" });
for (const ch of channels) {
  console.log(ch.id, ch.name, ch.is_active);
}

Python

channels = client.channel.list(type="whatsapp")
for ch in channels.data:
    print(ch.id, ch.name, ch.is_active)

---

createWeb / create_web

TypeScript

const channel = await client.channel.createWeb({ name: "Website Chat" });
console.log(channel.id);

Python

channel = client.channel.create_web("Website Chat")
print(channel.id)

---

createWhatsApp / create_whatsapp

TypeScript

const channel = await client.channel.createWhatsApp({
  phone_number_id: "phone_number_id",
  access_token: "whatsapp_access_token",
});

Python

channel = client.channel.create_whatsapp({
    "phone_number_id": "phone_number_id",
    "access_token": "whatsapp_access_token",
})

---

createFacebook / create_facebook

TypeScript

// Đầu tiên lấy các pages có sẵn cho một credential
const pages = await client.channel.getFacebookPages("credential_id");

// Sau đó tạo kênh với một page
const channel = await client.channel.createFacebook({
  page_id: pages[0]._id,
  credential_id: "credential_id",
});

Python

pages = client.channel.get_facebook_pages("credential_id")
channel = client.channel.create_facebook({
    "page_id": pages[0]["_id"],
    "credential_id": "credential_id",
})

---

createEmail / create_email

TypeScript

const channel = await client.channel.createEmail({
  name: "Support Inbox",
  email: "support@example.com",
});

Python

channel = client.channel.create_email({
    "name": "Support Inbox",
    "email": "support@example.com",
})

---

update / update

TypeScript

await client.channel.update("channel_id", { active: false });

Python

client.channel.update("channel_id", {"active": False})