Skip to main content

​
Comparando os endpoints de consulta de eventos de Mensagens Diretas v1.1 e v2

Ambas as versões v1.1 e v2 dos endpoints de Mensagens Diretas fornecem métodos para consultar eventos de Mensagens Diretas. Este guia tem como objetivo ajudar a entender as diferenças e fornecer informações para migrar para a v2. Uma diferença importante entre as duas versões é que a v1.1 suporta apenas conversas individuais, enquanto a v2 introduz suporte para conversas em grupo. Um artefato disso é que a v1.1 suporta apenas eventos “message created”, enquanto a v2 também suporta eventos associados a participantes que entram e saem de conversas. Na verdade, uma atualização fundamental da v2 é estabelecer dm_conversations como um objeto central da API. Com a v1.1, existem dois endpoints para recuperar Mensagens Diretas (novamente, novas mensagens são o único tipo de evento suportado com a v1.1):
  • GET direct_messages/events/show - Recupera um único evento por ID.
  • GET direct_messages/events/list - Recupera até 30 dias de Mensagens Diretas individuais enviadas e recebidas pelo usuário autenticado. Observe que este método não é capaz de recuperar mensagens de conversas em grupo.
Com esta versão v2, existem três métodos GET para recuperar eventos de conversa de Mensagens Diretas:
  • GET /2/dm_conversations/with/:participant_id/dm_events - Recupera eventos de Mensagens Diretas associados a uma conversa individual. O parâmetro de caminho :participant_id é o User ID da conta que está tendo a conversa com o usuário autenticado que faz esta solicitação.
  • GET /2/dm_conversations/:dm_conversation_id/dm_events - Recupera eventos de Mensagens Diretas associados a um ID de conversa específico, conforme indicado pelo parâmetro de caminho :dm_conversation_id. Este método suporta conversas individuais e em grupo.
  • GET /2/dm_events - Recupera eventos de Mensagens Diretas associados a um usuário, incluindo conversas individuais e em grupo. Eventos de até 30 dias atrás estão disponíveis.
Um detalhe importante é que os IDs de conversa e evento são compartilhados entre as versões v1.1 e v2 da Plataforma X. Isso significa que ambas as versões podem ser usadas juntas. Por exemplo, os endpoints de Mensagens Diretas v1.1 fornecem métodos para retornar um único evento e para excluir eventos, métodos ainda não disponíveis na v2. Como os IDs são comuns entre v1.1 e v2, você pode fazer solicitações v1.1 com base nos IDs fornecidos pela v2 ou referenciando IDs de conversa exibidos em URLs de conversa no aplicativo X. A tabela a seguir compara aspectos fundamentais dos endpoints de consulta de eventos de Mensagens Diretas v1.1 e v2. As características da API do X v2 compartilhadas aqui são comuns a todos os endpoints de consulta de Mensagens Diretas. As tabelas a seguir comparam os métodos GET v2 com a versão v1.1. Observe que essas ofertas v2 ampliam as capacidades disponíveis ao dar suporte a conversas em grupo. **Obtenha todas as mensagens em uma conversa individual específica **
Caminho: GET /2/dm_conversations/with/:participant_id/dm_events **Obtenha todas as mensagens por ID de conversa ** Caminho: GET /2/dm_conversations/:dm_conversation_id/dm_events Obtenha todos os eventos nas conversas de um usuário autenticado, tanto individuais quanto em grupo Caminho: GET /2/dm_events