> ## Documentation Index
> Fetch the complete documentation index at: https://docs.x.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Guia de integração

> Este guia aborda os conceitos-chave necessários para integrar os endpoints de consulta de Mensagens Diretas. Referência para o nível standard da API do X v2 cobrindo consulta.

export const Button = ({href, children}) => {
  return <div className="not-prose">
    <a href={href}>
      <button className="x-btn">
        <span>{children}</span>
        <svg width="3" height="24" viewBox="0 -9 3 24" class="h-6 rotate-0 overflow-visible"><path d="M0 0L3 3L0 6" fill="none" stroke="currentColor" stroke-width="1.5" stroke-linecap="round"></path></svg>
      </button>
    </a>
  </div>;
};

Este guia aborda os conceitos-chave necessários para integrar os endpoints de consulta de Mensagens Diretas em sua aplicação.

***

## Autenticação

Os endpoints de DM exigem autenticação de usuário para acessar conversas privadas:

| Método                                                                                                                         | Descrição      |
| :----------------------------------------------------------------------------------------------------------------------------- | :------------- |
| [OAuth 2.0 Authorization Code with PKCE](/resources/fundamentals/authentication#oauth-2-0-authorization-code-flow-with-pkce-2) | Recomendado    |
| [OAuth 1.0a User Context](/resources/fundamentals/authentication)                                                              | Suporte legado |

<Warning>
  A autenticação App-Only não é suportada. Todas as Mensagens Diretas são privadas.
</Warning>

### Escopos necessários (OAuth 2.0)

| Escopo       | Necessário para        |
| :----------- | :--------------------- |
| `dm.read`    | Ler eventos de DM      |
| `tweet.read` | Necessário com dm.read |
| `users.read` | Necessário com dm.read |

***

## Tipos de conversa

<CardGroup cols={2}>
  <Card title="Individual" icon="https://mintcdn.com/x-preview/ygI6sSJPehlc0qNT/icons/xds/icon-chat.svg?fit=max&auto=format&n=ygI6sSJPehlc0qNT&q=85&s=9fde7d51b4f18c96d3a38a81d519761f" width="24" height="24" data-path="icons/xds/icon-chat.svg">
    Sempre tem exatamente dois participantes. Formato do ID de conversa: `{smaller_user_id}-{larger_user_id}`
  </Card>

  <Card title="Grupo" icon="https://mintcdn.com/x-preview/ygI6sSJPehlc0qNT/icons/xds/icon-chat-unread.svg?fit=max&auto=format&n=ygI6sSJPehlc0qNT&q=85&s=ce6313d8c0b7b4e5363f2ce80b89f7e4" width="24" height="24" data-path="icons/xds/icon-chat-unread.svg">
    Dois ou mais participantes. A composição pode mudar ao longo do tempo.
  </Card>
</CardGroup>

***

## Tipos de eventos

| Evento              | Descrição                | Campos-chave                   |
| :------------------ | :----------------------- | :----------------------------- |
| `MessageCreate`     | Uma mensagem foi enviada | `text`, `sender_id`            |
| `ParticipantsJoin`  | Usuário entrou no grupo  | `participant_ids`, `sender_id` |
| `ParticipantsLeave` | Usuário saiu do grupo    | `participant_ids`              |

### Exemplos de eventos

<AccordionGroup>
  <Accordion title="MessageCreate">
    ```json theme={null}
    {
      "id": "1582838499983564806",
      "event_type": "MessageCreate",
      "text": "Hi everyone.",
      "sender_id": "944480690",
      "dm_conversation_id": "1578398451921985538",
      "created_at": "2022-10-19T20:58:00.000Z"
    }
    ```
  </Accordion>

  <Accordion title="ParticipantsJoin">
    ```json theme={null}
    {
      "id": "1582835469712138240",
      "event_type": "ParticipantsJoin",
      "participant_ids": ["944480690"],
      "sender_id": "17200003",
      "dm_conversation_id": "1578398451921985538",
      "created_at": "2022-10-19T20:45:58.000Z"
    }
    ```
  </Accordion>

  <Accordion title="ParticipantsLeave">
    ```json theme={null}
    {
      "id": "1582838535115067392",
      "event_type": "ParticipantsLeave",
      "participant_ids": ["944480690"],
      "dm_conversation_id": "1578398451921985538",
      "created_at": "2022-10-19T20:58:09.000Z"
    }
    ```
  </Accordion>
</AccordionGroup>

***

## Fields e expansions

### Campos padrão

| Tipo de evento         | Campos padrão                         |
| :--------------------- | :------------------------------------ |
| MessageCreate          | `id`, `event_type`, `text`            |
| ParticipantsJoin/Leave | `id`, `event_type`, `participant_ids` |

### Campos disponíveis

| Field                | Descrição            | Eventos             |
| :------------------- | :------------------- | :------------------ |
| `dm_conversation_id` | ID da conversa       | Todos               |
| `created_at`         | Timestamp do evento  | Todos               |
| `sender_id`          | Quem enviou/convidou | MessageCreate, Join |
| `attachments`        | Anexos de mídia      | MessageCreate       |
| `referenced_tweets`  | Posts compartilhados | MessageCreate       |

### Expansions disponíveis

| Expansion                | Retorna                        |
| :----------------------- | :----------------------------- |
| `sender_id`              | Objeto User do remetente       |
| `participant_ids`        | Objetos User dos participantes |
| `attachments.media_keys` | Objetos Media                  |
| `referenced_tweets.id`   | Objetos Post                   |

### Exemplo com expansions

<CodeGroup dropdown>
  ```bash cURL theme={null}
  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"
  ```

  ```python title="Python SDK" lines wrap icon="python" theme={null}
  from xdk import Client

  client = Client(bearer_token="YOUR_USER_ACCESS_TOKEN")

  # Get DM events with expansions
  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}")
  ```

  ```javascript title="JavaScript SDK" lines wrap icon="square-js" theme={null}
  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}`);
    });
  }
  ```
</CodeGroup>

***

## Paginação

Os eventos de DM são retornados em ordem cronológica reversa (mais recentes primeiro):

<CodeGroup dropdown>
  ```bash cURL theme={null}
  # First request
  curl "https://api.x.com/2/dm_events?max_results=100" \
    -H "Authorization: Bearer $USER_ACCESS_TOKEN"

  # Subsequent request with pagination token
  curl "https://api.x.com/2/dm_events?max_results=100&pagination_token=NEXT_TOKEN" \
    -H "Authorization: Bearer $USER_ACCESS_TOKEN"
  ```

  ```python title="Python SDK" lines wrap icon="python" theme={null}
  from xdk import Client

  client = Client(bearer_token="YOUR_USER_ACCESS_TOKEN")

  # The SDK handles pagination automatically
  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")
  ```

  ```javascript title="JavaScript SDK" lines wrap icon="square-js" theme={null}
  import { Client } from "@xdevplatform/xdk";

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

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

    // The SDK handles pagination automatically
    const paginator = client.dmEvents.list({ maxResults: 100 });

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

    return allEvents;
  }

  // Usage
  const events = await getAllDMEvents();
  console.log(`Found ${events.length} DM events`);
  ```
</CodeGroup>

<Note>
  Eventos de até **30 dias atrás** estão disponíveis.
</Note>

***

## Compatibilidade de IDs com a v1.1

Os IDs de conversa e evento são compartilhados entre os endpoints v1.1 e v2. Isso significa que você pode:

* Usar a v2 para recuperar eventos e, em seguida, usar a v1.1 para excluir mensagens específicas
* Referenciar IDs de conversa das URLs do x.com em solicitações da API

***

## Próximos passos

<CardGroup cols={2}>
  <Card title="Quickstart" icon="https://mintcdn.com/x-preview/oR-aRNyj1BKPJtxM/icons/xds/icon-rocket.svg?fit=max&auto=format&n=oR-aRNyj1BKPJtxM&q=85&s=b978d7a9225de31709efbbed5b84e92d" href="/x-api/direct-messages/lookup/quickstart" width="24" height="24" data-path="icons/xds/icon-rocket.svg">
    Faça sua primeira solicitação de consulta de DM
  </Card>

  <Card title="Enviar DMs" icon="paper-plane" href="/x-api/direct-messages/manage/introduction">
    Envie Mensagens Diretas
  </Card>

  <Card title="Referência da API" icon="https://mintcdn.com/x-preview/ygI6sSJPehlc0qNT/icons/xds/icon-code.svg?fit=max&auto=format&n=ygI6sSJPehlc0qNT&q=85&s=488e23401b19225b89acc0136d242219" href="/x-api/direct-messages/get-dm-events" width="24" height="24" data-path="icons/xds/icon-code.svg">
    Documentação completa do endpoint
  </Card>

  <Card title="Código de exemplo" icon="github" href="https://github.com/xdevplatform/Twitter-API-v2-sample-code">
    Exemplos de código funcionais
  </Card>
</CardGroup>