Démarrage rapide

Ce guide vous explique comment récupérer les événements de messages privés pour l’utilisateur authentifié.

PrérequisAvant de commencer, vous aurez besoin des éléments suivants :

Un compte développeur avec une App approuvée
Un jeton d’accès utilisateur (OAuth 1.0a ou OAuth 2.0 PKCE)

Récupérer tous les événements de DM

Récupérez tous les événements de DM pour l’utilisateur authentifié :

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")

# Récupérer tous les événements de DM avec 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" });

// Récupérer tous les événements de DM avec 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}`);
  });
}

Réponse

{
  "data": [
    {
      "id": "1234567890",
      "event_type": "MessageCreate",
      "text": "Bonjour ! Comment allez-vous ?",
      "sender_id": "9876543210",
      "created_at": "2024-01-15T10:30:00.000Z"
    }
  ],
  "meta": {
    "result_count": 1,
    "next_token": "abc123"
  }
}

Récupérer une conversation individuelle

Récupérez les événements de DM d’une conversation individuelle spécifique :

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")

# Récupérer les événements de DM d'une conversation individuelle
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" });

// Récupérer les événements de DM d'une conversation individuelle
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}`);
  });
}

Remplacez 9876543210 par l’identifiant utilisateur de l’autre participant.

Récupérer une conversation par identifiant

Récupérez les événements de DM à partir de l’identifiant d’une conversation spécifique :

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")

# Récupérer les événements de DM d’une conversation par identifiant
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" });

// Récupérer les événements de DM d’une conversation par identifiant
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}`);
  });
}

Filtrer par type d’événement

Obtenez uniquement certains types d’événements :

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")

# Récupérer uniquement les événements 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" });

// Récupérer uniquement les événements 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);
  });
}

Types d’événements

Type	Description
`MessageCreate`	Un message a été envoyé
`ParticipantsJoin`	L’utilisateur a rejoint la conversation
`ParticipantsLeave`	L’utilisateur a quitté la conversation

Inclure des données utilisateur

Étendre les informations relatives à l’expéditeur :

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")

# Récupérer les événements de DM avec les informations sur l’expéditeur
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:
        # Faire correspondre l’expéditeur depuis includes
        print(f"{event.sender_id}: {event.text}")

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

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

// Récupérer les événements de DM avec les informations sur l’expéditeur
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}`);
  });
  # Les objets utilisateur de l’expéditeur se trouvent dans page.includes.users
}

Réponse avec expansion

{
  "data": [
    {
      "id": "1234567890",
      "event_type": "MessageCreate",
      "text": "Hello!",
      "sender_id": "9876543210"
    }
  ],
  "includes": {
    "users": [
      {
        "id": "9876543210",
        "username": "example_user",
        "profile_image_url": "https://..."
      }
    ]
  }
}

Paramètres courants

Paramètre	Description
`max_results`	Événements par page (1-100, valeur par défaut : 100)
`pagination_token`	Jeton pour la page suivante
`dm_event.fields`	Champs d’événement à retourner
`event_types`	Filtrer par type d’événement
`expansions`	Objets associés à inclure

Prochaines étapes

Envoyer des DM

Envoyer des messages directs

Guide d’intégration

Concepts clés et bonnes pratiques

Référence de l’API

Documentation complète de l’endpoint

Vue d’ensemble

Publications

Utilisateurs

Messages privés

Mentions J’aime

Listes

Espaces

Communautés

Notes de la communauté

Tendances

Actualités

Médias

Activité sur X

Utilisation

Connexions de flux

Conformité

Enterprise v2

Flux des J’aime

GNIP 2.0

Démarrage rapide

Récupérer tous les événements de DM

Réponse

Récupérer une conversation individuelle

Récupérer une conversation par identifiant

Filtrer par type d’événement

Types d’événements

Inclure des données utilisateur

Réponse avec expansion

Paramètres courants

Prochaines étapes

Envoyer des DM

Guide d’intégration

Référence de l’API