> For the complete documentation index, see [llms.txt](https://kb.stoque.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://kb.stoque.com.br/zeev/apis/all/instances/messages.md).

# Listar ou adicionar mensagens em  solicitação

## Como adicionar mensagens em uma solicitação ou tarefa utilizando as API's do Zeev?

Para adicionar mensagens em uma instância de solicitação utilizando as API's do Zeev, siga os seguintes passos:

1. **Autenticação**: Primeiro obtenha um [token de autenticação](https://kb.zeev.it/apis/como-gerar-tokens-para-autenticar-nas-apis) com permissão de realizar essa operação;
2. **Identificar a solicitação**: O Id é o código único da solicitação, você pode encontrar ele  buscando em monitorar -> solicitações, ou   utilizando o endpoint para consultar instâncias através de filtros conforme descrito nesta em [Listar todas as solicitações do sistema](/zeev/apis/all/instances/report.md);
3. **Enviar a Requisição**: Utilize o endpoint [#api-2-messages](#api-2-messages "mention") para enviar a requisição conforme modelo e exemplo (troque seu\_endereco.do.zeev pelo endereço que você usa para acessar o Zeev):

{% openapi src="/files/DYIxvabeLXa2mL6uE2si" path="/api/2/messages" method="post" %}
[ZeevApi's\_new.json](https://3371003943-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MD66pBdRalAQgnhNstG%2Fuploads%2Ff5huLIsAqm88oSjkTavv%2FZeevApi's_new.json?alt=media\&token=aae47f9f-90ca-48d0-b250-fc38fe74e6c0)
{% endopenapi %}

Exemplos de requisição do para adicionar mensagens em uma instância de solicitação

{% tabs %}
{% tab title="Node.js" %}

```javascript
const myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Authorization", "Bearer TOKEN_DO_USUARIO");

const raw = JSON.stringify({
  "instanceId": 890360388, //Id da solicitação
  "messageBody": "Sou uma mensagem de texto que será incluida na instancia",
  "requesterCanSee": true
});

const requestOptions = {
  method: "POST",
  headers: myHeaders,
  body: raw
};

try {
  const response = await fetch("https://seu_endereco.do.zeev/api/2/messages", requestOptions);
  const result = await response.json();
  console.log(result)
} catch (error) {
  console.error(error);
};
```

{% endtab %}
{% endtabs %}

***

## Como adicionar mensagens em uma  solicitação utilizando API e código identificador da tarefa?

Para adicionar mensagens em uma instância de solicitação utilizando as API's do Zeev, siga os seguintes passos:

1. **Autenticação**: Primeiro obtenha um [token de autenticação](https://kb.zeev.it/apis/como-gerar-tokens-para-autenticar-nas-apis) com permissão de realizar essa operação;
2. **Identificar da tarefa**: O instanceTaskId é o código único de uma atividade da solicitação. Você pode encontrar-lo utilizando o endpoint para consultar instâncias através de filtros conforme descrito nesta em [Listar todas as solicitações do sistema](/zeev/apis/all/instances/report.md);
3. **Enviar a Requisição**: Utilize o endpoint [#api-2-messages-instance-task](#api-2-messages-instance-task "mention") para enviar a requisição conforme modelo e exemplo (troque seu\_endereco.do.zeev pelo endereço que você usa para acessar o Zeev):

{% openapi src="/files/DYIxvabeLXa2mL6uE2si" path="/api/2/messages/instance-task" method="post" %}
[ZeevApi's\_new.json](https://3371003943-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MD66pBdRalAQgnhNstG%2Fuploads%2Ff5huLIsAqm88oSjkTavv%2FZeevApi's_new.json?alt=media\&token=aae47f9f-90ca-48d0-b250-fc38fe74e6c0)
{% endopenapi %}

***

### Como listar mensagens de instâncias do Zeev utilizando API's?

Para consultar mensagens de uma instância utilizando  as API's do Zeev, siga os seguintes passos:

1. **AutenticaAutenticação**: Primeiro obtenha um [token de autenticação](https://kb.zeev.it/apis/como-gerar-tokens-para-autenticar-nas-apis) com permissão de realizar essa operação;
2. **Identificar a Solicitação**: O Id é o código único da solicitação, você pode encontrar ele  buscando em monitorar -> solicitações, ou   utilizando o endpoint de API do Zeev para
3. **Enviar a Requisição**: Utilize o endpoint abaixo para enviar a requisição conforme modelo e exemplo (troque seu\_endereco.do.zeev pelo endereço que você usa para acessar o Zeev):

{% openapi src="/files/DYIxvabeLXa2mL6uE2si" path="/api/2/messages/instance/{instanceid}" method="get" %}
[ZeevApi's\_new.json](https://3371003943-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MD66pBdRalAQgnhNstG%2Fuploads%2Ff5huLIsAqm88oSjkTavv%2FZeevApi's_new.json?alt=media\&token=aae47f9f-90ca-48d0-b250-fc38fe74e6c0)
{% endopenapi %}

Exemplo de requisição para listar mensagens de uma solicitação

{% tabs %}
{% tab title="Node.js" %}

```javascript
let instanceId = 1234;

const myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Authorization", "Bearer TOKEN_DO_USUARIO");

const requestOptions = {
  method: "GET",
  headers: myHeaders
};

try {
  const response = await fetch(`https://seu_endereco.do.zeev/api/2/messages/instance/${instanceId}?useCache=true`, requestOptions);
  const result = await response.json();
  console.log(result)
} catch (error) {
  console.error(error);
}
```

{% endtab %}
{% endtabs %}

***

Links relacionados:

* [O que é preciso para fazer integrações do Zeev para outros sistemas?](/zeev/integracoes/o-que-e-preciso-para-fazer-integracoes.md)
* [Como autenticar nas APIs do Zeev](/zeev/apis/como-utilizar-as-apis-do-zeev/como-gerar-tokens-para-autenticar-nas-apis.md)
* [Como controlar o volume máximo de requisições à APIs](/zeev/apis/como-utilizar-as-apis-do-zeev/como-controlar-o-volume-maximo-de-requisicoes-a-apis.md)
* [Como acessar o Swagger / OpenAPI](/zeev/apis/como-utilizar-as-apis-do-zeev/como-acessar-o-swagger-openapi.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://kb.stoque.com.br/zeev/apis/all/instances/messages.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.