experience_id eller channel_id.
Denne side dækker Chat API’et på serversiden, hvor du kalder Whop fra din backend for at poste, læse eller moderere beskeder. Hvis du vil vise en live Whop-chat-brugerflade i din egen frontend, så se i stedet quickstarten til indlejret chat.
Initialiser SDK’et
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")))
Send en besked
Beskeder understøtter Markdown og valgfrie vedhæftninger, der uploades via Files API’et.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)
Læs beskeder
Listeoperationer paginerer automatisk. Iterér over svaret, så henter SDK’et yderligere sider for dig.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
Administrer kanaler
Brug Update Channel til at ændre en community-kanals moderationsindstillinger: forbudte ord, ventetid mellem opslag, og hvem der kan poste eller reagere. Brug List Channels medkind sat til community til at liste chatkanalerne på en konto.
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 accepterer everyone eller admins. who_can_react accepterer everyone eller no_one. Account API-nøgler kan kun opdatere community-kanaler.
Reager på en besked
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)
}
Supportkanaler
Supportkanaler er 1:1-tråde mellem en kunde og en konto. Brug dem til helpdesks eller concierge-forløb. Create Channel medkind sat til support returnerer den eksisterende kanal, hvis der allerede findes en for kunden. Hvis du vil liste din kontos supportindbakke, skal du kalde List Channels med kind sat til support og support_role sat til staff.
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"
Påkrævede tilladelser
Tilføj disse fra guiden til tilladelser, før du udgiver din app.| Tilladelse | Kræves til |
|---|---|
chat:read | Læsning af beskeder, kanaler og reaktioner |
chat:message:create | Opslag af beskeder |
chat:moderate | Opdatering af kanalindstillinger |
support_chat:create | Åbning af supportkanaler |
support_chat:read | Læsning af supportkanaler |
Message-objektets struktur
Message-objektets struktur
{
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 };
}
Næste trin
Lyt til hændelser med webhooks
Modtag chathændelser på din server i stedet for at polle.
Send notifikationer
Send push-notifikationer til brugere, der ikke er aktive i chatten.
Upload filer
Vedhæft billeder og videoer til beskeder.
Indlejr chat i din app
Færdig Whop-chat-brugerflade til din frontend (separat produkt).

