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.
boolean
padrão:false
Retorna todas as conversas. Se true, o campo conversationId é ignorado.
Quando conversationsOnly=true, os detalhes da conversa são retornados em converstationsDetails. Essa grafia faz parte da resposta atual da API.
integer
Apenas X/Twitter. Limita o número de mensagens retornadas por requisição (1–100). Permite polling eficiente sem uma sincronização completa do histórico. Use com next para paginação. Se omitido, o comportamento padrão (recuperação completa de mensagens) é usado.
string
Apenas X/Twitter. Cursor de paginação criptografado retornado do campo meta.pagination.next de uma requisição anterior. Use com limit para buscar a próxima página de resultados.