Quickstart

Este guia mostra como recuperar eventos de Mensagens Diretas para o usuário autenticado.

Pré-requisitosAntes de começar, você precisará de:

Uma conta de desenvolvedor com um App aprovado
User Access Token (OAuth 1.0a ou OAuth 2.0 PKCE)

Obter todos os eventos de DM

Recupere todos os eventos de DM para o usuário 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}`);
  });
}

Resposta

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

Obter conversa individual

Recupere eventos de DM de uma conversa individual 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}`);
  });
}

Substitua 9876543210 pelo user ID do outro participante.

Obter conversa por ID

Recupere eventos de DM de um ID de conversa 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

Obtenha apenas tipos específicos 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")

# 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	Descrição
`MessageCreate`	Uma mensagem foi enviada
`ParticipantsJoin`	Usuário entrou na conversa
`ParticipantsLeave`	Usuário saiu da conversa

Incluir dados do usuário

Expanda as informações do remetente:

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
}

Resposta com 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 comuns

Parâmetro	Descrição
`max_results`	Eventos por página (1-100, padrão 100)
`pagination_token`	Token para a próxima página
`dm_event.fields`	Campos do evento a retornar
`event_types`	Filtrar por tipo de evento
`expansions`	Objetos relacionados a incluir

Próximos passos

Enviar DMs

Envie Mensagens Diretas

Guia de integração

Conceitos-chave e boas práticas

Referência da API

Documentação completa do endpoint

Getting Started

Products

Fundamentals

Partners & Customers

Resources

Quickstart

Obter todos os eventos de DM

Resposta

Obter conversa individual

Obter conversa por ID

Filtrar por tipo de evento

Tipos de eventos

Incluir dados do usuário

Resposta com expansion

Parâmetros comuns

Próximos passos

Enviar DMs

Guia de integração

Referência da API

​Obter todos os eventos de DM

​Resposta

​Obter conversa individual

​Obter conversa por ID

​Filtrar por tipo de evento

​Tipos de eventos

​Incluir dados do usuário

​Resposta com expansion

​Parâmetros comuns

​Próximos passos

Enviar DMs

Guia de integração

Referência da API

Obter todos os eventos de DM

Resposta

Obter conversa individual

Obter conversa por ID

Filtrar por tipo de evento

Tipos de eventos

Incluir dados do usuário

Resposta com expansion

Parâmetros comuns

Próximos passos