experience_id가 포럼 콘텐츠의 범위를 지정하므로, 커뮤니티 사이드바의 각 포럼 타일은 별도의 경험입니다.
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을 지원합니다. 선택적 필드를 사용해 게시물을 고정하거나, 유료로 설정하거나, 멘션으로 표시할 수 있습니다.const post = await client.forumPosts.create({
experience_id: "exp_xxxxxxxxxxxxx",
content: "This is the post body in **Markdown**.",
title: "Optional title for paywalled posts",
pinned: false,
is_mention: false,
paywall_amount: 0, // cents; 500 = $5.00
});
post = client.forum_posts.create(
experience_id="exp_xxxxxxxxxxxxx",
content="This is the post body in **Markdown**.",
title="Optional title for paywalled posts",
pinned=False,
is_mention=False,
paywall_amount=0,
)
let post = client
.forum_posts
.create(
&CreateForumPostsRequest {
experience_id: "exp_xxxxxxxxxxxxx".to_string(),
content: Some("This is the post body in **Markdown**.".to_string()),
title: Some("Optional title for paywalled posts".to_string()),
pinned: Some(false),
is_mention: Some(false),
paywall_amount: Some(0.0), // cents; 500 = $5.00
..Default::default()
},
None,
)
.await?;
post, err := client.ForumPosts.Create(context.TODO(), &whopsdk.CreateForumPostsRequest{
ExperienceID: "exp_xxxxxxxxxxxxx",
Content: whopsdk.String("This is the post body in **Markdown**."),
Title: whopsdk.String("Optional title for paywalled posts"),
Pinned: whopsdk.Bool(false),
IsMention: whopsdk.Bool(false),
PaywallAmount: whopsdk.Float64(0), // cents; 500 = $5.00
})
if err != nil {
log.Fatal(err)
}
_ = post
게시물 읽기
목록 작업은 자동으로 페이지를 나눕니다.const posts = await client.forumPosts.list({
experience_id: "exp_xxxxxxxxxxxxx",
first: 10,
});
for await (const item of posts) {
console.log(item);
}
const post = await client.forumPosts.retrieve({ id: "post_xxxxxxxxxxxxx" });
for item in client.forum_posts.list(
experience_id="exp_xxxxxxxxxxxxx",
first=10,
):
print(item)
post = client.forum_posts.retrieve("post_xxxxxxxxxxxxx")
let posts = client
.forum_posts
.list(
&ForumPostsListQueryRequest {
experience_id: "exp_xxxxxxxxxxxxx".to_string(),
first: Some(10),
..Default::default()
},
None,
)
.await?;
for item in posts.data {
println!("{item:?}");
}
let post = client
.forum_posts
.retrieve(&"post_xxxxxxxxxxxxx".to_string(), None)
.await?;
page, err := client.ForumPosts.List(context.TODO(), &whopsdk.ListForumPostsRequest{
ExperienceID: "exp_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)
}
post, err := client.ForumPosts.Retrieve(context.TODO(), &whopsdk.RetrieveForumPostsRequest{
ID: "post_xxxxxxxxxxxxx",
})
if err != nil {
log.Fatal(err)
}
_ = post
게시물에 댓글 달기
댓글은parent_id가 있는 게시물입니다. 상위 게시물의 ID를 list에 전달하여 댓글을 가져오세요.
const comment = await client.forumPosts.create({
experience_id: "exp_xxxxxxxxxxxxx",
content: "Great post!",
parent_id: "post_xxxxxxxxxxxxx",
});
const comments = await client.forumPosts.list({
experience_id: "exp_xxxxxxxxxxxxx",
parent_id: "post_xxxxxxxxxxxxx",
first: 10,
});
for await (const item of comments) {
console.log(item);
}
comment = client.forum_posts.create(
experience_id="exp_xxxxxxxxxxxxx",
content="Great post!",
parent_id="post_xxxxxxxxxxxxx",
)
for item in client.forum_posts.list(
experience_id="exp_xxxxxxxxxxxxx",
parent_id="post_xxxxxxxxxxxxx",
first=10,
):
print(item)
let comment = client
.forum_posts
.create(
&CreateForumPostsRequest {
experience_id: "exp_xxxxxxxxxxxxx".to_string(),
content: Some("Great post!".to_string()),
parent_id: Some("post_xxxxxxxxxxxxx".to_string()),
..Default::default()
},
None,
)
.await?;
let comments = client
.forum_posts
.list(
&ForumPostsListQueryRequest {
experience_id: "exp_xxxxxxxxxxxxx".to_string(),
parent_id: Some("post_xxxxxxxxxxxxx".to_string()),
first: Some(10),
..Default::default()
},
None,
)
.await?;
for item in comments.data {
println!("{item:?}");
}
comment, err := client.ForumPosts.Create(context.TODO(), &whopsdk.CreateForumPostsRequest{
ExperienceID: "exp_xxxxxxxxxxxxx",
Content: whopsdk.String("Great post!"),
ParentID: whopsdk.String("post_xxxxxxxxxxxxx"),
})
if err != nil {
log.Fatal(err)
}
_ = comment
page, err := client.ForumPosts.List(context.TODO(), &whopsdk.ListForumPostsRequest{
ExperienceID: "exp_xxxxxxxxxxxxx",
ParentID: whopsdk.String("post_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)
}
게시물 좋아요
포럼 반응은 항상
:heart:입니다. 채팅 메시지는 모든 이모지를 허용하지만, 포럼 반응은 다른 값을 무시합니다.await client.reactions.create({
resource_id: "post_xxxxxxxxxxxxx",
emoji: ":heart:",
});
client.reactions.create(
resource_id="post_xxxxxxxxxxxxx",
emoji=":heart:",
)
client
.reactions
.create(
&CreateReactionsRequest {
resource_id: "post_xxxxxxxxxxxxx".to_string(),
emoji: Some(":heart:".to_string()),
..Default::default()
},
None,
)
.await?;
_, err := client.Reactions.Create(context.TODO(), &whopsdk.CreateReactionsRequest{
ResourceID: "post_xxxxxxxxxxxxx",
Emoji: whopsdk.String(":heart:"),
})
if err != nil {
log.Fatal(err)
}
고급 기능
고정 게시물
고정 게시물은 피드 상단에 표시됩니다. 게시물을 작성할 때pinned: true를 사용하세요.
await client.forumPosts.create({
experience_id: "exp_xxxxxxxxxxxxx",
content: "Important announcement!",
pinned: true,
});
client.forum_posts.create(
experience_id="exp_xxxxxxxxxxxxx",
content="Important announcement!",
pinned=True,
)
client
.forum_posts
.create(
&CreateForumPostsRequest {
experience_id: "exp_xxxxxxxxxxxxx".to_string(),
content: Some("Important announcement!".to_string()),
pinned: Some(true),
..Default::default()
},
None,
)
.await?;
_, err := client.ForumPosts.Create(context.TODO(), &whopsdk.CreateForumPostsRequest{
ExperienceID: "exp_xxxxxxxxxxxxx",
Content: whopsdk.String("Important announcement!"),
Pinned: whopsdk.Bool(true),
})
if err != nil {
log.Fatal(err)
}
사용자 멘션하기
본문에<@username>을 사용하세요. 멘션된 사용자는 알림을 받습니다.
await client.forumPosts.create({
experience_id: "exp_xxxxxxxxxxxxx",
content: "Hey <@username> check this out!",
});
client.forum_posts.create(
experience_id="exp_xxxxxxxxxxxxx",
content="Hey <@username> check this out!",
)
client
.forum_posts
.create(
&CreateForumPostsRequest {
experience_id: "exp_xxxxxxxxxxxxx".to_string(),
content: Some("Hey <@username> check this out!".to_string()),
..Default::default()
},
None,
)
.await?;
_, err := client.ForumPosts.Create(context.TODO(), &whopsdk.CreateForumPostsRequest{
ExperienceID: "exp_xxxxxxxxxxxxx",
Content: whopsdk.String("Hey <@username> check this out!"),
})
if err != nil {
log.Fatal(err)
}
유료 게시물
paywall_amount는 센트 단위입니다. 독자는 전체 콘텐츠를 보려면 결제해야 합니다.
await client.forumPosts.create({
experience_id: "exp_xxxxxxxxxxxxx",
title: "Premium post",
content: "Exclusive content here",
paywall_amount: 500, // $5.00
});
client.forum_posts.create(
experience_id="exp_xxxxxxxxxxxxx",
title="Premium post",
content="Exclusive content here",
paywall_amount=500,
)
client
.forum_posts
.create(
&CreateForumPostsRequest {
experience_id: "exp_xxxxxxxxxxxxx".to_string(),
title: Some("Premium post".to_string()),
content: Some("Exclusive content here".to_string()),
paywall_amount: Some(500.0), // $5.00
..Default::default()
},
None,
)
.await?;
_, err := client.ForumPosts.Create(context.TODO(), &whopsdk.CreateForumPostsRequest{
ExperienceID: "exp_xxxxxxxxxxxxx",
Title: whopsdk.String("Premium post"),
Content: whopsdk.String("Exclusive content here"),
PaywallAmount: whopsdk.Float64(500), // $5.00
})
if err != nil {
log.Fatal(err)
}
커서를 사용한 페이지네이션
자동 페이지네이션 외에도, 응답의page_info에 있는 end_cursor를 사용해 페이지를 수동으로 넘길 수 있습니다.
const firstPage = await client.forumPosts.list({
experience_id: "exp_xxxxxxxxxxxxx",
first: 10,
});
const next = await client.forumPosts.list({
experience_id: "exp_xxxxxxxxxxxxx",
first: 10,
after: firstPage.response.page_info.end_cursor ?? undefined,
});
first = client.forum_posts.list(
experience_id="exp_xxxxxxxxxxxxx",
first=10,
)
next_page = client.forum_posts.list(
experience_id="exp_xxxxxxxxxxxxx",
first=10,
after=first.response.page_info.end_cursor,
)
let first_page = client
.forum_posts
.list(
&ForumPostsListQueryRequest {
experience_id: "exp_xxxxxxxxxxxxx".to_string(),
first: Some(10),
..Default::default()
},
None,
)
.await?;
let next = client
.forum_posts
.list(
&ForumPostsListQueryRequest {
experience_id: "exp_xxxxxxxxxxxxx".to_string(),
first: Some(10),
after: first_page.page_info.end_cursor.clone(),
..Default::default()
},
None,
)
.await?;
for item in next.data {
println!("{item:?}");
}
firstPage, err := client.ForumPosts.List(context.TODO(), &whopsdk.ListForumPostsRequest{
ExperienceID: "exp_xxxxxxxxxxxxx",
First: whopsdk.Int(10),
})
if err != nil {
log.Fatal(err)
}
// Step to the next page manually
nextPage, err := firstPage.GetNextPage(context.TODO())
if err != nil {
log.Fatal(err)
}
_ = nextPage
필요한 권한
게시하기 전에 권한 가이드를 참고하여 앱의 권한 목록에 다음 항목을 추가하세요.| 권한 | 필요한 작업 |
|---|---|
forum:read | 게시물 및 댓글 읽기 |
forum:post:create | 게시물 및 댓글 작성 |
chat:read | 반응 생성 및 읽기 |
게시물 객체 구조
게시물 객체 구조
{
id: string;
comment_count: number;
content: string | null;
is_edited: boolean;
is_pinned: boolean;
is_poster_admin: boolean;
like_count: number | null;
parent_id: string | null; // null = top-level, set = comment
title: string | null;
view_count: number | null;
user: { id: string; name: string | null; username: string };
}
다음 단계
챗봇 만들기
같은 커뮤니티에서 포럼 게시물과 실시간 채팅 메시지를 함께 사용하세요.
웹훅으로 이벤트 수신하기
서버에서 포럼 게시물과 댓글에 실시간으로 대응하세요.
알림 보내기
새로운 소식이 있을 때 사용자를 포럼으로 다시 불러오세요.
파일 업로드하기
게시물에 이미지와 동영상을 첨부하세요.

