Skip to main content

Comparando os endpoints v1.1 e v2 de gerenciamento de Mensagens Diretas

Ambas as versões v1.1 e v2 dos endpoints de Mensagens Diretas fornecem métodos para criar mensagens 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 gerenciar Mensagens Diretas:
  • POST direct_messages/events/new - Cria uma Mensagem Direta individual. Este endpoint v1.1 pode criar apenas mensagens individuais e não suporta mensagens em grupo.
  • DELETE direct_messages/events/destroy - Exclui uma mensagem individual da visualização do usuário autenticado.
Com esta versão v2, existem três métodos POST para criar Mensagens Diretas:
  • POST /2/dm_conversations/with/:participant_id/messages - Cria uma Mensagem Direta individual. Este método adiciona a mensagem a uma conversa individual existente ou cria uma nova. O parâmetro de caminho :participant_id é o User ID da conta que recebe a mensagem.
  • POST /2/dm_conversations - Cria uma nova conversa em grupo e adiciona uma Mensagem Direta a ela. Essas solicitações exigem uma lista de participantes da conversa. Observe que você pode criar várias conversas com a mesma lista de participantes. Essas solicitações sempre retornarão um novo ID de conversa.
  • POST /2/dm_conversations/:dm_conversation_id/messages - Cria uma Mensagem Direta e a adiciona a uma conversa existente. O parâmetro de caminho :dm_conversation_id é o ID da conversa à qual a mensagem será adicionada.
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 v1.1 e v2 de gerenciamento de Mensagens Diretas. 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 POST v2 com a versão v1.1. Observe que essas ofertas v2 ampliam as capacidades disponíveis ao dar suporte a conversas em grupo. Criar uma nova Mensagem Direta individual Caminho: POST /2/dm_conversations/with/:participant_id/messages Criar uma nova conversa em grupo de Mensagens Diretas e adicionar uma mensagem a ela Caminho: POST /2/dm_conversations Adicionar uma Mensagem Direta a uma conversa existente por ID Caminho: POST /2/dm_conversations/:dm_conversation_id/messages