사전 요구 사항시작하기 전에 다음이 필요합니다:
- 승인된 App이 있는 developer account
- 사용자 Access Token (OAuth 1.0a 또는 OAuth 2.0 PKCE)
모든 DM 이벤트 가져오기
인증된 사용자의 모든 DM 이벤트를 조회합니다:cURL
curl "https://api.x.com/2/dm_events?\
dm_event.fields=created_at,sender_id,text&\
max_results=100" \
-H "Authorization: Bearer $USER_ACCESS_TOKEN"
from xdk import Client
client = Client(bearer_token="YOUR_USER_ACCESS_TOKEN")
# Get all DM events with pagination
for page in client.dm_events.list(
dm_event_fields=["created_at", "sender_id", "text"],
max_results=100
):
for event in page.data:
print(f"{event.event_type}: {event.text}")
import { Client } from "@xdevplatform/xdk";
const client = new Client({ accessToken: "YOUR_USER_ACCESS_TOKEN" });
// Get all DM events with pagination
const paginator = client.dmEvents.list({
dmEventFields: ["created_at", "sender_id", "text"],
maxResults: 100,
});
for await (const page of paginator) {
page.data?.forEach((event) => {
console.log(`${event.event_type}: ${event.text}`);
});
}
응답
MessageCreate{
"data": [
{
"id": "1234567890",
"event_type": "MessageCreate",
"text": "Hello! How are you?",
"sender_id": "9876543210",
"created_at": "2024-01-15T10:30:00.000Z"
}
],
"meta": {
"result_count": 1,
"next_token": "abc123"
}
}
1:1 대화 가져오기
특정 1:1 대화의 DM 이벤트를 조회합니다:cURL
curl "https://api.x.com/2/dm_conversations/with/9876543210/dm_events?\
dm_event.fields=created_at,sender_id,text" \
-H "Authorization: Bearer $USER_ACCESS_TOKEN"
from xdk import Client
client = Client(bearer_token="YOUR_USER_ACCESS_TOKEN")
# Get DM events from a one-to-one conversation
for page in client.dm_events.get_by_participant(
participant_id="9876543210",
dm_event_fields=["created_at", "sender_id", "text"]
):
for event in page.data:
print(f"{event.created_at}: {event.text}")
import { Client } from "@xdevplatform/xdk";
const client = new Client({ accessToken: "YOUR_USER_ACCESS_TOKEN" });
// Get DM events from a one-to-one conversation
const paginator = client.dmEvents.getByParticipant("9876543210", {
dmEventFields: ["created_at", "sender_id", "text"],
});
for await (const page of paginator) {
page.data?.forEach((event) => {
console.log(`${event.created_at}: ${event.text}`);
});
}
9876543210을 다른 참가자의 user ID로 교체하세요.
ID로 대화 가져오기
특정 대화 ID의 DM 이벤트를 조회합니다:cURL
curl "https://api.x.com/2/dm_conversations/1234567890-9876543210/dm_events?\
dm_event.fields=created_at,sender_id,text" \
-H "Authorization: Bearer $USER_ACCESS_TOKEN"
from xdk import Client
client = Client(bearer_token="YOUR_USER_ACCESS_TOKEN")
# Get DM events from a conversation by ID
for page in client.dm_events.get_by_conversation(
dm_conversation_id="1234567890-9876543210",
dm_event_fields=["created_at", "sender_id", "text"]
):
for event in page.data:
print(f"{event.created_at}: {event.text}")
import { Client } from "@xdevplatform/xdk";
const client = new Client({ accessToken: "YOUR_USER_ACCESS_TOKEN" });
// Get DM events from a conversation by ID
const paginator = client.dmEvents.getByConversation("1234567890-9876543210", {
dmEventFields: ["created_at", "sender_id", "text"],
});
for await (const page of paginator) {
page.data?.forEach((event) => {
console.log(`${event.created_at}: ${event.text}`);
});
}
이벤트 유형으로 필터링
특정 이벤트 유형만 가져오기:cURL
curl "https://api.x.com/2/dm_events?\
event_types=MessageCreate&\
dm_event.fields=created_at,sender_id,text" \
-H "Authorization: Bearer $USER_ACCESS_TOKEN"
from xdk import Client
client = Client(bearer_token="YOUR_USER_ACCESS_TOKEN")
# Get only MessageCreate events
for page in client.dm_events.list(
event_types=["MessageCreate"],
dm_event_fields=["created_at", "sender_id", "text"]
):
for event in page.data:
print(f"{event.text}")
import { Client } from "@xdevplatform/xdk";
const client = new Client({ accessToken: "YOUR_USER_ACCESS_TOKEN" });
// Get only MessageCreate events
const paginator = client.dmEvents.list({
eventTypes: ["MessageCreate"],
dmEventFields: ["created_at", "sender_id", "text"],
});
for await (const page of paginator) {
page.data?.forEach((event) => {
console.log(event.text);
});
}
이벤트 유형
| 유형 | 설명 |
|---|---|
MessageCreate | 메시지가 전송됨 |
ParticipantsJoin | 사용자가 대화에 참여함 |
ParticipantsLeave | 사용자가 대화에서 나감 |
사용자 데이터 포함
발신자 정보 확장:cURL
curl "https://api.x.com/2/dm_events?\
dm_event.fields=created_at,sender_id,text&\
expansions=sender_id&\
user.fields=username,profile_image_url" \
-H "Authorization: Bearer $USER_ACCESS_TOKEN"
from xdk import Client
client = Client(bearer_token="YOUR_USER_ACCESS_TOKEN")
# Get DM events with sender info
for page in client.dm_events.list(
dm_event_fields=["created_at", "sender_id", "text"],
expansions=["sender_id"],
user_fields=["username", "profile_image_url"]
):
for event in page.data:
# Match sender from includes
print(f"{event.sender_id}: {event.text}")
import { Client } from "@xdevplatform/xdk";
const client = new Client({ accessToken: "YOUR_USER_ACCESS_TOKEN" });
// Get DM events with sender info
const paginator = client.dmEvents.list({
dmEventFields: ["created_at", "sender_id", "text"],
expansions: ["sender_id"],
userFields: ["username", "profile_image_url"],
});
for await (const page of paginator) {
page.data?.forEach((event) => {
console.log(`${event.sender_id}: ${event.text}`);
});
// Sender user objects are in page.includes.users
}
expansion을 포함한 응답
MessageCreate{
"data": [
{
"id": "1234567890",
"event_type": "MessageCreate",
"text": "Hello!",
"sender_id": "9876543210"
}
],
"includes": {
"users": [
{
"id": "9876543210",
"username": "example_user",
"profile_image_url": "https://..."
}
]
}
}
공통 파라미터
| 파라미터 | 설명 |
|---|---|
max_results | 페이지당 이벤트 수 (1-100, 기본 100) |
pagination_token | 다음 페이지 토큰 |
dm_event.fields | 반환할 이벤트 field |
event_types | 이벤트 유형 필터링 |
expansions | 포함할 관련 객체 |
다음 단계
DM 전송
Direct Message 전송하기
통합 가이드
핵심 개념 및 모범 사례
API 레퍼런스
전체 endpoint 문서