Chuyển tới nội dung chính

Clan Webhook

Clan webhook gửi tin nhắn trực tiếp (DM) vào hộp thư đến của từng người; ai nhận tin phụ thuộc vào username hoặc user ID được cung cấp trên URL.

Tạo Clan Mezon Webhook

Làm theo các bước sau để tạo webhook cho clan của bạn.

  1. Vào clan bạn muốn tạo webhook, nhấp vào banner clan để mở popup các thao tác có thể thực hiện trên clan đó.

    mezon-webhook-005

  2. Nhấp Clan Settings rồi vào tab Integrations.

  • Với tư cách quản lý clan, bạn cũng có thể quản lý cả channel webhook và clan webhook tại đây.

    mezon-webhook-006

  1. Nhấp Clan Webhooks rồi New Clan Webhook để tạo webhook mới.

    mezon-webhook-007

  • Bạn sẽ có một user (ở đây tên Komu Knight) và có thể tùy chỉnh tên và avatar của bot này.

  • Nhấp Copy Webhook URL để lấy endpoint webhook, dùng cùng payload webhook để gửi tin nhắn tới người dùng trong clan.

  • Có hai cách tạo Webhook URL đầy đủ sau khi sao chép URL cơ sở bằng nút Copy Webhook URL

    • Cách 1: Kết hợp URL đã sao chép với Mezon Username hợp lệ để có Webhook URL đầy đủ. Mezon Username có trong Account Settings của người dùng.

    mezon-webhook-008

    • Cách 2: Hoặc dùng URL đã sao chép kết hợp với Mezon User ID hợp lệ. Mezon User ID có trong popup tài khoản người dùng.

    mezon-webhook-009

Lưu ý

Nếu bạn cho rằng token trên URL đã bị lộ hoặc lỗi thời, hãy reset và sao chép URL mới, đồng thời đảm bảo người dùng đã tham gia clan của bạn.

Đặc tả Webhook

Endpoint

Webhook được gửi qua yêu cầu HTTP POST tới URL duy nhất được tạo cho mỗi tích hợp webhook, kết hợp với định danh người dùng duy nhất.

Cấu trúc URL:

https://webhook.mezon.ai/clanwebhooks/{token}/{user-identifier}

Tham số URL:

Tham sốKiểuMô tả
tokenstringToken bảo mật để xác thực yêu cầu. Có vẻ là chuỗi base64 hoặc JSON Web Token (JWT) chứa thông tin xác minh tính xác thực của yêu cầu.
user-identifierstringĐịnh danh duy nhất của người dùng Mezon. Có thể là username hoặc user ID.

Request Header

HeaderGiá trịMô tả
Content-Typeapplication/jsonCho biết body yêu cầu ở định dạng JSON.

Request Body

Body yêu cầu chứa đối tượng JSON với nội dung và tệp đính kèm của tin nhắn sẽ gửi dưới dạng tin nhắn trực tiếp tới người dùng.

Đối tượng gốc

TrườngKiểuBắt buộcMô tả
contentstringChuỗi JSON-encoded chứa chi tiết nội dung tin nhắn
attachmentsarray of objectsKhôngMảng đối tượng đính kèm (ảnh, video, tệp, v.v.)

Nội dung tin nhắn

Trường content chứa chuỗi JSON-encoded cần parse để truy cập cấu trúc tin nhắn.

Đối tượng Content đã parse:

TrườngKiểuBắt buộcMô tả
tstringNội dung văn bản thô của tin nhắn.
mkarray of objectsKhôngMảng đối tượng mô tả markdown hoặc định dạng đặc biệt.

Đối tượng mk (markdown)

TrườngKiểuBắt buộcMô tả
typestringLoại định dạng (ví dụ "lk" cho link, "pre" cho văn bản định dạng sẵn).
sintegerChỉ số ký tự bắt đầu của đoạn định dạng trong chuỗi t.
eintegerChỉ số ký tự kết thúc của đoạn định dạng trong chuỗi t.

Tệp đính kèm

Mảng attachments chứa các đối tượng đại diện tệp đính kèm tin nhắn.

Đối tượng Attachment

TrườngKiểuBắt buộcMô tả
urlstringURL CDN công khai để truy cập tệp đính kèm.
filetypestringMIME type của tệp (ví dụ "image/png", "video/mp4").

Ví dụ Clan Webhook

curl --location --globoff 'https://webhook.mezon.ai/clanwebhooks/{YOUR_TOKEN}/{username_or_userid}' \
--header 'Content-Type: application/json' \
--data '{
"content": "{\"t\":\"Welcome to Mezon Clan webhook!!! [pre] This is a block message. [lk] https://mezon.ai\",\"mk\":[{\"type\":\"pre\",\"s\":33,\"e\":64},{\"type\":\"lk\",\"s\":68,\"e\":85}]}",
"attachments": [
{
"url": "https://cdn.mezon.vn/0/1843962578301095936/1829065039080853500/95_0thumbnail_dog1.jpg",
"filetype": "image/png"
},
{
"url": "https://cdn.mezon.vn/109056000/255856640/4198400/477_0bandicam_2024_11_19_11_10_14_507.mp4",
"filetype": "video/mp4"
}
]
}'

Kết quả

Bạn có thể xem tin nhắn gửi từ clan webhook trong Inbox của mình.

mezon-webhook-010

ghi chú

Thay YOUR_TOKEN bằng webhook token thực tế và username_or_userid bằng Mezon username hoặc user ID của người nhận. Người dùng phải là thành viên clan của bạn mới nhận được tin nhắn trực tiếp.