Inicio rápido

Esta guía te explica cómo recuperar eventos de Mensajes Directos del usuario autenticado.

Requisitos previosAntes de comenzar, necesitas:

Una cuenta de desarrollador con una App aprobada
Un token de acceso de usuario (OAuth 1.0a o OAuth 2.0 PKCE)

Obtener todos los eventos de mensajes directos (DM)

Obtén todos los eventos de mensajes directos (DM) del usuario autenticado:

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

# Obtener todos los eventos de DM con paginación
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" });

// Obtener todos los eventos de DM con paginación
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}`);
  });
}

Respuesta

{
  "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"
  }
}

Obtener una conversación uno a uno

Recupera eventos de MD de una conversación específica uno a uno:

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

# Obtener eventos de MD de una conversación uno a uno
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" });

// Obtener eventos de MD de una conversación uno a uno
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}`);
  });
}

Reemplaza 9876543210 por el id de usuario del otro participante.

Obtener una conversación por id

Recupera los eventos de mensajes directos (MD) de un id de conversación específico:

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

# Obtener eventos de mensajes directos de una conversación por 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" });

// Obtener eventos de mensajes directos de una conversación por 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}`);
  });
}

Filtrar por tipo de evento

Obtén solo determinados tipos de eventos:

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

# Obtén solo eventos 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" });

// Obtén solo eventos 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);
  });
}

Tipos de eventos

Tipo	Descripción
`MessageCreate`	Se envió un mensaje
`ParticipantsJoin`	Un usuario se unió a la conversación
`ParticipantsLeave`	Un usuario abandonó la conversación

Incluir datos de usuario

Amplía los datos del remitente:

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

# Obtener eventos de MD con información del remitente
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:
        # Vincular el remitente a partir de includes
        print(f"{event.sender_id}: {event.text}")

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

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

// Obtener eventos de MD con información del remitente
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}`);
  });
  // Los objetos de usuario del remitente están en page.includes.users
}

Respuesta con expansiones

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

Parámetros comunes

Parámetro	Descripción
`max_results`	Eventos por página (1-100, valor predeterminado 100)
`pagination_token`	Token para la página siguiente
`dm_event.fields`	Campos del evento que se devolverán
`event_types`	Filtrar por tipo de evento
`expansions`	Objetos relacionados que se incluirán

Próximos pasos

Enviar MD

Enviar mensajes directos

Guía de integración

Conceptos clave y mejores prácticas

Referencia de la API

Documentación completa del endpoint

Descripción general

Publicaciones

Usuarios

Mensajes directos

Me gusta

Listas

Spaces

Comunidades

Notas de la comunidad

Tendencias

Noticias

Contenido multimedia

Actividad en X

Uso

Conexiones de streaming

Cumplimiento

Enterprise v2

Flujos de Me gusta

GNIP 2.0

Inicio rápido

Obtener todos los eventos de mensajes directos (DM)

Respuesta

Obtener una conversación uno a uno

Obtener una conversación por id

Filtrar por tipo de evento

Tipos de eventos

Incluir datos de usuario

Respuesta con expansiones

Parámetros comunes

Próximos pasos

Enviar MD

Guía de integración

Referencia de la API

​Obtener todos los eventos de mensajes directos (DM)

​Respuesta

​Obtener una conversación uno a uno

​Obtener una conversación por id

​Filtrar por tipo de evento

​Tipos de eventos

​Incluir datos de usuario

​Respuesta con expansiones

​Parámetros comunes

​Próximos pasos

Enviar MD

Guía de integración

Referencia de la API

Obtener todos los eventos de mensajes directos (DM)

Respuesta

Obtener una conversación uno a uno

Obtener una conversación por id

Filtrar por tipo de evento

Tipos de eventos

Incluir datos de usuario

Respuesta con expansiones

Parámetros comunes

Próximos pasos