Quickstart

Esta guía te lleva paso a paso a recuperar los eventos de Mensajes Directos del usuario autenticado.

Requisitos previosAntes de comenzar, necesitarás:

Una cuenta de desarrollador con una App aprobada
Un User Access Token (OAuth 1.0a u OAuth 2.0 PKCE)

Obtener todos los eventos de DM

Recupera todos los eventos de 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")

# 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}`);
  });
}

Respuesta

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

Obtener una conversación uno a uno

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

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}`);
  });
}

Reemplaza 9876543210 con el ID de usuario del otro participante.

Obtener conversación por ID

Recupera los eventos de DM 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")

# 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}`);
  });
}

Filtrar por tipo de evento

Obtén solo tipos de eventos específicos:

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);
  });
}

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 del usuario

Expande la información 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")

# 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
}

Respuesta con expansion

MessageCreate

{
  "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, por defecto 100)
`pagination_token`	Token para la siguiente página
`dm_event.fields`	Campos del evento a devolver
`event_types`	Filtrar por tipo de evento
`expansions`	Objetos relacionados a incluir

Próximos pasos

Enviar DMs

Envía Mensajes Directos

Guía de integración

Conceptos clave y buenas prácticas

Referencia de la API

Documentación completa de endpoints

Getting Started

Products

Fundamentals

Partners & Customers

Resources

Quickstart

Obtener todos los eventos de DM

Respuesta

Obtener una conversación uno a uno

Obtener conversación por ID

Filtrar por tipo de evento

Tipos de eventos

Incluir datos del usuario

Respuesta con expansion

Parámetros comunes

Próximos pasos

Enviar DMs

Guía de integración

Referencia de la API

​Obtener todos los eventos de DM

​Respuesta

​Obtener una conversación uno a uno

​Obtener conversación por ID

​Filtrar por tipo de evento

​Tipos de eventos

​Incluir datos del usuario

​Respuesta con expansion

​Parámetros comunes

​Próximos pasos

Enviar DMs

Guía de integración

Referencia de la API

Obtener todos los eventos de DM

Respuesta

Obtener una conversación uno a uno

Obtener conversación por ID

Filtrar por tipo de evento

Tipos de eventos

Incluir datos del usuario

Respuesta con expansion

Parámetros comunes

Próximos pasos