すべての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")
# ページネーションを使ってすべてのDMイベントを取得
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" });
// ページネーションを使ってすべてのDMイベントを取得
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}`);
});
}
レスポンス
{
"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の会話を取得する
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")
# 1対1の会話からDMイベントを取得
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" });
// 1対1の会話からDMイベントを取得
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 を、相手の参加者のユーザーIDに置き換えてください。
会話 ID で取得する
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")
# 会話 ID を指定して DM イベントを取得
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" });
// 会話 ID を指定して DM イベントを取得
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")
# MessageCreate イベントのみを取得
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" });
// MessageCreate イベントのみを取得
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);
});
}
イベントtype
| Type | 説明 |
|---|---|
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")
# 送信者情報付きのDMイベントを取得する
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:
# includes から送信者を特定する
print(f"{event.sender_id}: {event.text}")
import { Client } from "@xdevplatform/xdk";
const client = new Client({ accessToken: "YOUR_USER_ACCESS_TOKEN" });
// 送信者情報付きのDMイベントを取得する
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}`);
});
// 送信者のユーザーオブジェクトは page.includes.users に含まれます
}
展開付きレスポンス
{
"data": [
{
"id": "1234567890",
"event_type": "MessageCreate",
"text": "Hello!",
"sender_id": "9876543210"
}
],
"includes": {
"users": [
{
"id": "9876543210",
"username": "example_user",
"profile_image_url": "https://..."
}
]
}
}
共通パラメータ
| Parameter | Description |
|---|---|
max_results | 1 ページあたりのイベント数 (1〜100、デフォルト 100) |
pagination_token | 次ページを取得するためのトークン |
dm_event.fields | 返すイベントのフィールド |
event_types | イベントの種類でフィルター |
expansions | レスポンスに含める関連オブジェクト |
次のステップ
DMを送信
ダイレクトメッセージを送信
連携ガイド
基本概念とベストプラクティス
APIリファレンス
エンドポイントの完全なドキュメント