एकीकरण मार्गदर्शिका

यह मार्गदर्शिका उन मुख्य अवधारणाओं को समझाती है जिनकी आपको डायरेक्ट मैसेज lookup endpoints को अपने ऐप में एकीकृत करने के लिए आवश्यकता होगी।

प्रमाणीकरण

निजी बातचीतों तक पहुँचने के लिए DM एंडपॉइंट्स पर उपयोगकर्ता प्रमाणीकरण आवश्यक है:

Method	Description
PKCE के साथ OAuth 2.0 Authorization Code	अनुशंसित
OAuth 1.0a User Context	लीगेसी समर्थन

सिर्फ़ ऐप-आधारित प्रमाणीकरण समर्थित नहीं है। सभी डायरेक्ट मैसेज निजी होते हैं।

आवश्यक scopes (OAuth 2.0)

Scope	इसके लिए आवश्यक
`dm.read`	इवेंट पढ़ने के लिए
`tweet.read`	dm.read के साथ आवश्यक
`users.read`	dm.read के साथ आवश्यक

वार्तालाप के प्रकार

एक-से-एक

इसमें हमेशा ठीक दो प्रतिभागी होते हैं। वार्तालाप ID का प्रारूप: {smaller_user_id}-{larger_user_id}

समूह

इसमें दो या अधिक प्रतिभागी होते हैं। सदस्यता समय के साथ बदल सकती है।

इवेंट के प्रकार

इवेंट	विवरण	मुख्य फ़ील्ड्स
`MessageCreate`	एक संदेश भेजा गया	`text`, `sender_id`
`ParticipantsJoin`	उपयोगकर्ता समूह में शामिल हुआ	`participant_ids`, `sender_id`
`ParticipantsLeave`	उपयोगकर्ता समूह से बाहर निकल गया	`participant_ids`

उदाहरण इवेंट

MessageCreate

{
  "id": "1582838499983564806",
  "event_type": "MessageCreate",
  "text": "Hi everyone.",
  "sender_id": "944480690",
  "dm_conversation_id": "1578398451921985538",
  "created_at": "2022-10-19T20:58:00.000Z"
}

ParticipantsJoin

{
  "id": "1582835469712138240",
  "event_type": "ParticipantsJoin",
  "participant_ids": ["944480690"],
  "sender_id": "17200003",
  "dm_conversation_id": "1578398451921985538",
  "created_at": "2022-10-19T20:45:58.000Z"
}

ParticipantsLeave

{
  "id": "1582838535115067392",
  "event_type": "ParticipantsLeave",
  "participant_ids": ["944480690"],
  "dm_conversation_id": "1578398451921985538",
  "created_at": "2022-10-19T20:58:09.000Z"
}

फ़ील्ड्स और expansions

डिफ़ॉल्ट फ़ील्ड्स

इवेंट प्रकार	डिफ़ॉल्ट फ़ील्ड्स
MessageCreate	`id`, `event_type`, `text`
ParticipantsJoin/Leave	`id`, `event_type`, `participant_ids`

उपलब्ध फ़ील्ड्स

फ़ील्ड	विवरण	इवेंट्स
`dm_conversation_id`	वार्तालाप ID	सभी
`created_at`	इवेंट का टाइमस्टैम्प	सभी
`sender_id`	किसने भेजा/आमंत्रित किया	MessageCreate, Join
`attachments`	मीडिया संलग्नक	MessageCreate
`referenced_tweets`	साझा की गई पोस्ट्स	MessageCreate

उपलब्ध expansions

Expansion	लौटाए गए ऑब्जेक्ट
`sender_id`	प्रेषक का User ऑब्जेक्ट
`participant_ids`	प्रतिभागियों के User ऑब्जेक्ट
`attachments.media_keys`	Media ऑब्जेक्ट
`referenced_tweets.id`	पोस्ट ऑब्जेक्ट

expansions के साथ उदाहरण

cURL

curl "https://api.x.com/2/dm_events?\
dm_event.fields=created_at,sender_id,attachments&\
expansions=sender_id,attachments.media_keys&\
user.fields=username,profile_image_url&\
media.fields=url,type" \
  -H "Authorization: Bearer $USER_ACCESS_TOKEN"

from xdk import Client

client = Client(bearer_token="YOUR_USER_ACCESS_TOKEN")

# expansions के साथ DM इवेंट प्राप्त करें
for page in client.dm_events.list(
    dm_event_fields=["created_at", "sender_id", "attachments"],
    expansions=["sender_id", "attachments.media_keys"],
    user_fields=["username", "profile_image_url"],
    media_fields=["url", "type"],
    max_results=100
):
    for event in page.data:
        print(f"Event: {event.event_type} - {event.text}")

import { Client } from "@xdevplatform/xdk";

const client = new Client({ accessToken: "YOUR_USER_ACCESS_TOKEN" });

const paginator = client.dmEvents.list({
  dmEventFields: ["created_at", "sender_id", "attachments"],
  expansions: ["sender_id", "attachments.media_keys"],
  userFields: ["username", "profile_image_url"],
  mediaFields: ["url", "type"],
  maxResults: 100,
});

for await (const page of paginator) {
  page.data?.forEach((event) => {
    console.log(`Event: ${event.event_type} - ${event.text}`);
  });
}

पेजिनेशन

DM इवेंट उल्टे कालानुक्रमिक क्रम में लौटाए जाते हैं (सबसे नए पहले):

cURL

# पहला अनुरोध
curl "https://api.x.com/2/dm_events?max_results=100" \
  -H "Authorization: Bearer $USER_ACCESS_TOKEN"

# पेजिनेशन टोकन के साथ अगला अनुरोध
curl "https://api.x.com/2/dm_events?max_results=100&pagination_token=NEXT_TOKEN" \
  -H "Authorization: Bearer $USER_ACCESS_TOKEN"

from xdk import Client

client = Client(bearer_token="YOUR_USER_ACCESS_TOKEN")

# SDK पेजिनेशन को अपने-आप संभालता है
all_events = []

for page in client.dm_events.list(max_results=100):
    if page.data:
        all_events.extend(page.data)

print(f"Found {len(all_events)} DM events")

import { Client } from "@xdevplatform/xdk";

const client = new Client({ accessToken: "YOUR_USER_ACCESS_TOKEN" });

async function getAllDMEvents() {
  const allEvents = [];

  // SDK पेजिनेशन को अपने-आप संभालता है
  const paginator = client.dmEvents.list({ maxResults: 100 });

  for await (const page of paginator) {
    if (page.data) {
      allEvents.push(...page.data);
    }
  }

  return allEvents;
}

// उपयोग
const events = await getAllDMEvents();
console.log(`Found ${events.length} DM events`);

30 दिन पहले तक के इवेंट उपलब्ध हैं।

v1.1 के साथ ID की संगतता

वार्तालाप और इवेंट ID, v1.1 और v2 endpoint के बीच साझा किए जाते हैं। इसका मतलब है कि आप यह कर सकते हैं:

इवेंट प्राप्त करने के लिए v2 का उपयोग करें, फिर विशिष्ट संदेशों को हटाने के लिए v1.1 का उपयोग करें
API अनुरोधों में x.com URL से वार्तालाप ID का संदर्भ दें

अगले चरण

त्वरित शुरुआत

अपना पहला DM lookup अनुरोध भेजें

DMs भेजें

डायरेक्ट मैसेज भेजें

API संदर्भ

एंडपॉइंट का पूरा दस्तावेज़

नमूना कोड

काम करने वाले कोड के उदाहरण

अवलोकन

पोस्ट्स

उपयोगकर्ता

डायरेक्ट मैसेज

लाइक्स

सूचियाँ

Spaces

Communities

Community Notes

ट्रेंड्स

समाचार

मीडिया

X गतिविधि

उपयोग

स्ट्रीम कनेक्शन

अनुपालन

Enterprise v2

लाइक्स स्ट्रीम्स

GNIP 2.0

एकीकरण मार्गदर्शिका

प्रमाणीकरण

आवश्यक scopes (OAuth 2.0)

वार्तालाप के प्रकार

एक-से-एक

समूह

इवेंट के प्रकार

उदाहरण इवेंट

फ़ील्ड्स और expansions

डिफ़ॉल्ट फ़ील्ड्स

उपलब्ध फ़ील्ड्स

उपलब्ध expansions

expansions के साथ उदाहरण

v1.1 के साथ ID की संगतता

अगले चरण

त्वरित शुरुआत

DMs भेजें

API संदर्भ

नमूना कोड