experience_id 또는 channel_id로 식별합니다.
이 페이지는 백엔드에서 Whop을 호출해 메시지를 게시, 읽기, 모더레이션하는 서버 측 Chat API를 다룹니다. 자체 프런트엔드 안에 실시간 Whop 채팅 UI를 렌더링하려면 대신 임베디드 채팅 빠른 시작을 참고하세요.
SDK 초기화하기
import { WhopClient } from "@whop/sdk";
const client = new WhopClient({
token: process.env.WHOP_API_KEY,
});
import os
from whop_sdk import Whop
client = Whop(
token=os.environ["WHOP_API_KEY"],
)
use whop_sdk::prelude::*;
let config = ClientConfig {
token: Some(std::env::var("WHOP_API_KEY").unwrap()),
..Default::default()
};
let client = Whop::new(config).expect("Failed to build client");
import (
"os"
"github.com/whopio/whopsdk-go/v2/client"
"github.com/whopio/whopsdk-go/v2/option"
)
client := client.NewWhop(option.WithToken(os.Getenv("WHOP_API_KEY")))
메시지 보내기
메시지는 Markdown과, Files API로 업로드한 선택적 첨부 파일을 지원합니다.const message = await client.messages.create({
channel_id: "chat_feed_xxxxxxxxxxxxx", // or an experience_id
content: "Hello! **Markdown** is supported.",
attachments: [
{ id: "file_xxxxxxxxxxxxx" }, // upload via the Files API first
],
});
message = client.messages.create(
channel_id="chat_feed_xxxxxxxxxxxxx",
content="Hello! **Markdown** is supported.",
attachments=[
{"id": "file_xxxxxxxxxxxxx"},
],
)
let message = client
.messages
.create(
&CreateMessagesRequest {
channel_id: "chat_feed_xxxxxxxxxxxxx".to_string(), // or an experience_id
content: "Hello! **Markdown** is supported.".to_string(),
attachments: Some(vec![CreateMessagesRequestAttachmentsItem {
id: "file_xxxxxxxxxxxxx".to_string(), // upload via the Files API first
}]),
..Default::default()
},
None,
)
.await?;
println!("{}", message.id);
message, err := client.Messages.Create(context.TODO(), &whopsdk.CreateMessagesRequest{
ChannelID: "chat_feed_xxxxxxxxxxxxx", // or an experience_id
Content: "Hello! **Markdown** is supported.",
})
if err != nil {
log.Fatal(err)
}
fmt.Println(message.ID)
메시지 읽기
목록 작업은 자동으로 페이지를 나눕니다. 응답을 반복하면 SDK가 추가 페이지를 가져옵니다.const messages = await client.messages.list({
channel_id: "chat_feed_xxxxxxxxxxxxx",
direction: "desc",
first: 20,
});
for await (const message of messages) {
console.log(message);
}
const single = await client.messages.retrieve({ id: "msg_xxxxxxxxxxxxx" });
for message in client.messages.list(
channel_id="chat_feed_xxxxxxxxxxxxx",
direction="desc",
first=20,
):
print(message)
single = client.messages.retrieve("msg_xxxxxxxxxxxxx")
let messages = client
.messages
.list(
&MessagesListQueryRequest {
channel_id: "chat_feed_xxxxxxxxxxxxx".to_string(),
direction: Some(Direction::Desc),
first: Some(20),
..Default::default()
},
None,
)
.await?;
for message in messages.data {
println!("{message:?}");
}
let single = client
.messages
.retrieve(&"msg_xxxxxxxxxxxxx".to_string(), None)
.await?;
page, err := client.Messages.List(context.TODO(), &whopsdk.ListMessagesRequest{
ChannelID: "chat_feed_xxxxxxxxxxxxx",
Direction: whopsdk.DirectionDesc.Ptr(),
First: whopsdk.Int(20),
})
if err != nil {
log.Fatal(err)
}
iter := page.Iterator()
for iter.Next(context.TODO()) {
fmt.Println(iter.Current())
}
if err := iter.Err(); err != nil {
log.Fatal(err)
}
single, err := client.Messages.Retrieve(context.TODO(), &whopsdk.RetrieveMessagesRequest{
ID: "msg_xxxxxxxxxxxxx",
})
if err != nil {
log.Fatal(err)
}
_ = single
채널 관리하기
Update Channel을 사용해 커뮤니티 채널의 모더레이션 설정(금지어, 게시 쿨다운, 게시 또는 반응 가능 대상)을 변경하세요. 계정의 채팅 채널을 나열하려면kind를 community로 설정해 List Channels를 사용하세요.
const channel = await client.channels.update({
id: "chat_feed_xxxxxxxxxxxxx",
moderation: {
ban_media: false,
ban_urls: false,
banned_words: ["spam", "scam"],
user_posts_cooldown_seconds: 10,
who_can_post: "admins",
who_can_react: "everyone",
},
});
const channels = await client.channels.list({
kind: "community",
account_id: "biz_xxxxxxxxxxxxx",
first: 10,
});
for await (const item of channels) {
console.log(item);
}
channel = client.channels.update(
"chat_feed_xxxxxxxxxxxxx",
moderation={
"ban_media": False,
"ban_urls": False,
"banned_words": ["spam", "scam"],
"user_posts_cooldown_seconds": 10,
"who_can_post": "admins",
"who_can_react": "everyone",
},
)
for item in client.channels.list(
kind="community",
account_id="biz_xxxxxxxxxxxxx",
first=10,
):
print(item)
channel, err := client.Channels.Update(context.TODO(), &whopsdk.UpdateChannelsRequest{
ID: "chat_feed_xxxxxxxxxxxxx",
Moderation: &whopsdk.UpdateChannelsRequestModeration{
BanMedia: whopsdk.Bool(false),
BanURLs: whopsdk.Bool(false),
BannedWords: []string{"spam", "scam"},
UserPostsCooldownSeconds: whopsdk.Int(10),
WhoCanPost: whopsdk.UpdateChannelsRequestModerationWhoCanPostAdmins.Ptr(),
WhoCanReact: whopsdk.UpdateChannelsRequestModerationWhoCanReactEveryone.Ptr(),
},
})
if err != nil {
log.Fatal(err)
}
_ = channel
page, err := client.Channels.List(context.TODO(), &whopsdk.ListChannelsRequest{
Kind: []*whopsdk.ListChannelsRequestKindItem{whopsdk.ListChannelsRequestKindItemCommunity.Ptr()},
AccountID: whopsdk.String("biz_xxxxxxxxxxxxx"),
First: whopsdk.Int(10),
})
if err != nil {
log.Fatal(err)
}
iter := page.Iterator()
for iter.Next(context.TODO()) {
fmt.Println(iter.Current())
}
if err := iter.Err(); err != nil {
log.Fatal(err)
}
curl -X PATCH https://api.whop.com/api/v1/channels/chat_feed_xxxxxxxxxxxxx \
-H "Authorization: Bearer $WHOP_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"moderation": {
"ban_media": false,
"ban_urls": false,
"banned_words": ["spam", "scam"],
"user_posts_cooldown_seconds": 10,
"who_can_post": "admins",
"who_can_react": "everyone"
}
}'
curl -G https://api.whop.com/api/v1/channels \
-H "Authorization: Bearer $WHOP_API_KEY" \
--data-urlencode "kind=community" \
--data-urlencode "account_id=biz_xxxxxxxxxxxxx" \
--data-urlencode "first=10"
who_can_post는 everyone 또는 admins를 받습니다. who_can_react는 everyone 또는 no_one을 받습니다. 계정 API 키는 커뮤니티 채널만 업데이트할 수 있습니다.
메시지에 반응하기
await client.reactions.create({
resource_id: "msg_xxxxxxxxxxxxx",
emoji: "😀", // Unicode or ':heart:' shortcode
});
client.reactions.create(
resource_id="msg_xxxxxxxxxxxxx",
emoji="😀",
)
client
.reactions
.create(
&CreateReactionsRequest {
resource_id: "msg_xxxxxxxxxxxxx".to_string(),
emoji: Some("😀".to_string()), // Unicode or ':heart:' shortcode
..Default::default()
},
None,
)
.await?;
_, err := client.Reactions.Create(context.TODO(), &whopsdk.CreateReactionsRequest{
ResourceID: "msg_xxxxxxxxxxxxx",
Emoji: whopsdk.String("😀"), // Unicode or ':heart:' shortcode
})
if err != nil {
log.Fatal(err)
}
지원 채널
지원 채널은 고객과 계정 간의 1:1 스레드입니다. 헬프 데스크나 컨시어지 흐름에 사용하세요.kind를 support로 설정한 Create Channel은 해당 고객의 채널이 이미 있으면 기존 채널을 반환합니다. 계정의 지원 받은편지함을 나열하려면 kind를 support로, support_role을 staff로 설정해 List Channels를 호출하세요.
const support = await client.channels.create({
kind: "support",
account_id: "biz_xxxxxxxxxxxxx",
customer_user_id: "user_xxxxxxxxxxxxx",
});
const supportChannels = await client.channels.list({
kind: "support",
support_role: "staff",
account_id: "biz_xxxxxxxxxxxxx",
status: "unresolved",
order: "last_message_at",
direction: "desc",
first: 10,
});
for await (const item of supportChannels) {
console.log(item);
}
support = client.channels.create(
kind="support",
account_id="biz_xxxxxxxxxxxxx",
customer_user_id="user_xxxxxxxxxxxxx",
)
for item in client.channels.list(
kind="support",
support_role="staff",
account_id="biz_xxxxxxxxxxxxx",
status="unresolved",
order="last_message_at",
direction="desc",
first=10,
):
print(item)
support, err := client.Channels.Create(context.TODO(), &whopsdk.CreateChannelsRequest{
Kind: whopsdk.CreateChannelsRequestKindSupport,
AccountID: whopsdk.String("biz_xxxxxxxxxxxxx"),
CustomerUserID: whopsdk.String("user_xxxxxxxxxxxxx"),
})
if err != nil {
log.Fatal(err)
}
_ = support
page, err := client.Channels.List(context.TODO(), &whopsdk.ListChannelsRequest{
Kind: []*whopsdk.ListChannelsRequestKindItem{whopsdk.ListChannelsRequestKindItemSupport.Ptr()},
SupportRole: whopsdk.ListChannelsRequestSupportRoleStaff.Ptr(),
AccountID: whopsdk.String("biz_xxxxxxxxxxxxx"),
Status: whopsdk.ListChannelsRequestStatusUnresolved.Ptr(),
Order: whopsdk.ListChannelsRequestOrderLastMessageAt.Ptr(),
Direction: whopsdk.ListChannelsRequestDirectionDesc.Ptr(),
First: whopsdk.Int(10),
})
if err != nil {
log.Fatal(err)
}
iter := page.Iterator()
for iter.Next(context.TODO()) {
fmt.Println(iter.Current())
}
if err := iter.Err(); err != nil {
log.Fatal(err)
}
curl -X POST https://api.whop.com/api/v1/channels \
-H "Authorization: Bearer $WHOP_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"kind": "support",
"account_id": "biz_xxxxxxxxxxxxx",
"customer_user_id": "user_xxxxxxxxxxxxx"
}'
curl -G https://api.whop.com/api/v1/channels \
-H "Authorization: Bearer $WHOP_API_KEY" \
--data-urlencode "kind=support" \
--data-urlencode "support_role=staff" \
--data-urlencode "account_id=biz_xxxxxxxxxxxxx" \
--data-urlencode "status=unresolved" \
--data-urlencode "order=last_message_at" \
--data-urlencode "direction=desc" \
--data-urlencode "first=10"
필수 권한
앱을 게시하기 전에 권한 가이드에서 다음 권한을 추가하세요.| 권한 | 필요한 작업 |
|---|---|
chat:read | 메시지, 채널, 반응 읽기 |
chat:message:create | 메시지 게시 |
chat:moderate | 채널 설정 업데이트 |
support_chat:create | 지원 채널 열기 |
support_chat:read | 지원 채널 읽기 |
메시지 객체 구조
메시지 객체 구조
{
id: string;
content: string | null;
created_at: string;
is_edited: boolean;
is_pinned: boolean;
message_type: "text" | "image" | "video" | "poll";
poll: { options: Array<{ id: string; text: string }> | null } | null;
poll_votes: Array<{ count: number; option_id: string | null }>;
reaction_counts: Array<{ count: number; emoji: string | null }>;
replying_to_message_id: string | null;
updated_at: string;
user: { id: string; name: string | null; username: string };
}
다음 단계
웹훅으로 이벤트 수신하기
폴링 대신 서버에서 채팅 이벤트를 받으세요.
알림 보내기
채팅에 접속해 있지 않은 사용자에게 푸시 알림을 보냅니다.
파일 업로드하기
메시지에 이미지와 동영상을 첨부합니다.
앱에 채팅 임베드하기
프런트엔드에 바로 넣을 수 있는 Whop 채팅 UI(별도 제품).

