# messages (GET)

Retorna uma lista de mensagens acumuladas (tanto de e para os clientes) Se Viber Business,ViberPublicouLivechat (widget)são usados, status de entrega também são retornados.&#x20;

Importante! Não use esse método muito frequentemente com o número alto de registro de números (limite). Você atingirá o limite de requisições da API muito rápido. Use webhooks, no lugar.&#x20;

Adicionalmente, o parâmetro start\_id agora substitui o parâmetro offset para reduzir a carga sobre o servidor.&#x20;

Request:

![](https://617700087-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1mdVFjIyp8q7yeGIckbq%2Fuploads%2FIDfqhFZBOub8o7Khmxa6%2Fimage.png?alt=media\&token=6038360a-7a6f-4d3d-8387-f4b8221adc37)

Parâmetros:&#x20;

• \<id> – id da mensagem.&#x20;

Quando esse commando é usado sem \<id> ele retorna uma lista de todas as mensagens acumuladas. Quando \<id> é especificado, o comando retorna informação adicional sobre a mensagem especificada, incluindo dialog\_id, operator\_id e channel\_id.&#x20;

Ao requisitar uma lista de mensagems, os seguintes filtros são suportados:&#x20;

• transport&#x20;

• channel\_id&#x20;

• client\_id&#x20;

• type (to\_client, from\_client, autoreply or system) (para o cliente, do cliente, resposta automática ou do sistema)&#x20;

• dialog\_id&#x20;

• read (lida ou não por um operador)&#x20;

• order (asc ou desc) – ordem de registros retornados. O padrão é ordem crescent.&#x20;

• start\_date & finish\_date – período de tempo&#x20;

• operator\_id – id do operador&#x20;

• start\_id New – retorna array de mensagens, começando de um message\_id particular (mensagens com id ⩾ start\_id)&#x20;

Exemplo de request com filtros:

![](https://617700087-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1mdVFjIyp8q7yeGIckbq%2Fuploads%2F5y2Fb6wIj8QyfZZDAU3b%2Fimage.png?alt=media\&token=d3eaad16-1ed8-477a-b7d4-416c1bdfbe1d)

Alguns campos na resposta:

• coordinates – geocoordenadas.&#x20;

• type:&#x20;

o from\_client – uma mensagem do cliente.&#x20;

o to\_client – uma mensagem para o cliente.&#x20;

o system –mensagem do sistema (como “conversa atribuída…”).Tal mensagem não é enviada para o cliente. o autoreply – resposta automática para um cliente ou mensagem do menu.&#x20;

• read – status: lido ou não pelo operador.&#x20;

• created – data da criação de mensagem (UTC).&#x20;

• recipient\_status – informações sobre o status da entrega da mensagem (agora aplica-se apenas a Viber Business/Public, conta do WhatsApp Business API e Live chat).&#x20;

• attachments– array de anexos na mensagem com nome e link de cada arquivo. Para compatibilidade retroativa, alguns tipos de anexo são retornados adicionalmente em campos separados foto, vídeo e áudio.&#x20;

• insta\_comment – verdadeiro para Mensagem de comentário do Instagra;&#x20;

• extra data – pode conter informação adicional, como : o id externo passado via messages/inbox (POST);&#x20;

o post\_url -link para o post de comentários do Instagram&#x20;

Resposta típico:

![](https://617700087-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1mdVFjIyp8q7yeGIckbq%2Fuploads%2FC93AhYQxDtrg8yZglksN%2Fimage.png?alt=media\&token=fd99d205-43a7-4491-bd30-db99884d8656)

![](https://617700087-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1mdVFjIyp8q7yeGIckbq%2Fuploads%2F8QYzaNRWQYWmFriguPpF%2Fimage.png?alt=media\&token=9f350e19-a174-408c-a2d6-fc39be0f50e4)
