Skip to main content
GET
Obtenha mensagens ou conversas de uma plataforma de mensagens. Os tempos de recuperação diferem em cada rede social. No Facebook, Instagram e WhatsApp, as mensagens estão disponíveis via Ayrshare em tempo real. No X/Twitter, há um atraso de até 3 minutos para ver novas atualizações de mensagens. Entre em contato com o suporte para saber mais sobre o Enterprise Plan se você precisar de acesso em tempo real às mensagens do X/Twitter.
Cache de respostas: para Facebook e Instagram, as respostas são armazenadas em cache por 60 segundos. Para X/Twitter, as respostas são armazenadas em cache por 15 segundos para suportar melhor o polling. O WhatsApp lê mensagens já recebidas por meio de webhooks da Meta, então uma mensagem recém-recebida pode aparecer assim que a Ayrshare processar seu webhook. A resposta ainda inclui os metadados lastUpdated e nextUpdate.
A recuperação inicial do histórico de mensagens para Facebook e Instagram é limitada às últimas 20 mensagens. Consulte a seção Recuperação do histórico de mensagens para Facebook e Instagram para mais informações.
As conversas do WhatsApp são identificadas pelo número de telefone do interlocutor (apenas dígitos, E.164 sem o + inicial). Uma mensagem de saída armazenada pode incluir um valor de status sent, delivered, read ou failed.
As mensagens do WhatsApp enviadas por meio de Send Message não são adicionadas atualmente ao histórico de Get Messages. Mensagens recebidas do WhatsApp por webhooks são armazenadas e retornadas aqui.

Parâmetros do header

Parâmetros de path

string
obrigatório
A plataforma para obter a mensagem: facebook, instagram, twitter, whatsapp

Parâmetros de query

string
padrão:"active"
obrigatório
Retorna conversas ativas ou arquivadas. Valores: active ou archived.
string
Retorna apenas a conversa específica.
string
Retornar apenas as mensagens de um sentido. Valores: sent ou received. Omita para retornar ambos.
boolean
padrão:false
Retorna conversas em vez de mensagens. Retorna uma página de conversas — siga meta.pagination.next para as demais. Se true, conversationId é ignorado.
Quando conversationsOnly=true, os detalhes da conversa são retornados em converstationsDetails. Essa grafia faz parte da resposta atual da API.
integer
Tamanho de página para mensagens e para listas de conversas: inteiro de 1 a 100, com padrão e máximo de 100.No X/Twitter, limit também escolhe qual conjunto de mensagens você lê. Omita-o para paginar suas mensagens armazenadas, que é o que todas as outras plataformas fazem e onde status, action e conversationsOnly se aplicam. Informe-o para paginar a linha do tempo ao vivo do X pelo cursor do próprio X, que não aplica nenhum desses três filtros.Essa escolha é feita apenas pela primeira solicitação. Depois que você passa a seguir um cursor, é o cursor que decide: um cursor de mensagens armazenadas continua retornando mensagens armazenadas mesmo que você envie limit, e um cursor do X continua retornando a linha do tempo ao vivo mesmo que você o omita. Não é possível alternar entre os dois no meio da paginação.
string
Cursor opaco de meta.pagination.next. Envie-o como next com o mesmo perfil, plataforma e filtros. Continue enquanto meta.pagination.hasMore for true, mesmo que uma página filtrada volte curta ou vazia. limit pode ser omitido nas solicitações seguintes (padrão 100); no X/Twitter o cursor já registra de qual conjunto veio, então enviar ou omitir limit não vai trocá-lo para o outro.

Buscando a próxima página

Comece com GET /api/messages/instagram?limit=100. Para continuar, codifique em URL o valor retornado em meta.pagination.next e envie GET /api/messages/instagram?limit=100&next=<opaque cursor>. O parâmetro é next, não cursor. Mantenha o mesmo Profile-Key e os mesmos filtros de query durante todo o processo. Verifique meta.pagination.hasMore, e não o número de resultados, para decidir quando parar. Uma solicitação filtrada pode retornar menos que limit resultados, ou uma página vazia com continuação, porque cada solicitação varre uma parte limitada do histórico. As mensagens no histórico armazenado são ordenadas da mais recente para a mais antiga, com o ID do documento como critério de desempate. As listas de conversas são ordenadas pelo ID do documento. A paginação não é um snapshot congelado: novas mensagens aparecem quando você recomeça pela primeira página, e mudanças no status das conversas podem alterar os resultados filtrados. Os campos de mensagem existentes e a grafia converstationsDetails permanecem inalterados. Integrações que antes esperavam uma lista completa em uma única solicitação — seja de mensagens ou de conversas, em qualquer plataforma — devem seguir o cursor de continuação; aumentar limit acima de 100 não é suportado.