> ## Documentation Index > Fetch the complete documentation index at: https://docs.ipbox.com.br/llms.txt > Use this file to discover all available pages before exploring further. # addResultadoLigacao > Cadastra um novo resultado de ligação. **Parâmetros (form-data ou x-www-form-urlencoded):** | Parâmetro | Tipo | Obrigatório | Descrição | | --- | --- | --- | --- | | descricao | string | Sim | Descrição/nome do resultado de ligação | | fila | string | Sim | ID ou descrição da fila | | acao | string | Condicional | Código ou descrição da ação. **Obrigatório para filas do tipo Ativa (A).** Se não informado em fila Receptiva, assume "Nenhuma". | | tempoAgendamento | int | Não | Tempo de agendamento em segundos (padrão: 0) | | fichaPreenchida | string | Não | Checar ficha preenchida. Y ou N (padrão: N) | | smsTexto | string | Não | ID ou descrição do texto SMS a enviar. | | lote | string | Condicional | ID ou descrição do lote. **Obrigatório quando a ação é MOVE_LOTE.** | | postUrl | string | Não | URL para envio. | | postUrlEncode | string | Não | Codificar URL. Y ou N (padrão: Y) | | atualizarResultadoExistente | string | Não | Se Y, atualiza o resultado existente com mesma descrição+fila ao invés de inserir um novo. Se N ou não informado, sempre insere. (padrão: N) | **Códigos de ação válidos por tipo de fila:** Fila Ativa (A): | Código | Descrição | | --- | --- | | NONE | Nenhuma | | AG_ESP | Agendamento Especifico | | AG_GEN | Agendamento Generico | | LIGAR_AGORA | Liga imediatamente p/ o prospect | | EX_FONE | Exclui o Fone | | EX_PROSPECT | Exclui o Prospect | | CLIENTE | Prospect tornou-se cliente | | VOLTAR_FILA | Prospect volta para fila | | BLACKLIST | Adiciona prospect na blacklist | | MOVE_LOTE | Move prospect para o lote | _Fila Receptiva (R):_ | Código | Descrição | | --- | --- | | NONE | Nenhuma | | AD_LOTE | Adiciona no lote e agenda retorno | | CLIENTE_REC | Marca prospect como Cliente e nao volta a ligar | | EX_PROSPECT_REC | Exclui o prospect e nao volta a ligar | | BLACKLIST_REC | Adiciona ao blacklist | **Nota:** O campo `acao` aceita tanto o código (ex: `AG_ESP`) quanto a descrição (ex: `Agendamento Especifico`). A busca por descrição é case-insensitive. ## OpenAPI ````yaml /openapi.yaml post /ipbox/api/addResultadoLigacao openapi: 3.0.0 info: title: IPBoX Api Documentation v1.1 description: >- Nesse documento são descritos os comandos presentes na API Rest do IPBoX. Os comandos são executados com chamadas POST e com respostas em formato JSON. version: 1.0.0 servers: - url: https://{baseUrl} description: Dominio (e porta, se houver) do servidor IPBoX do cliente variables: baseUrl: default: cliente.ipboxcloud.com.br:9052 description: >- Substitua pelo dominio real do seu servidor IPBoX. A maioria dos servidores usa uma porta especifica - inclua-a junto ao dominio (ex.: cliente.ipboxcloud.com.br:9052) security: - ApiToken: [] tags: - name: Agente - name: Ligações - name: Prospects - name: Agendamentos - name: Listas - name: Filas - name: Lotes - name: Relatórios - name: Outros - name: Times - name: Blacklist - name: Áudios - name: URAs paths: /ipbox/api/addResultadoLigacao: post: tags: - Filas summary: addResultadoLigacao description: >- Cadastra um novo resultado de ligação. **Parâmetros (form-data ou x-www-form-urlencoded):** | Parâmetro | Tipo | Obrigatório | Descrição | | --- | --- | --- | --- | | descricao | string | Sim | Descrição/nome do resultado de ligação | | fila | string | Sim | ID ou descrição da fila | | acao | string | Condicional | Código ou descrição da ação. **Obrigatório para filas do tipo Ativa (A).** Se não informado em fila Receptiva, assume "Nenhuma". | | tempoAgendamento | int | Não | Tempo de agendamento em segundos (padrão: 0) | | fichaPreenchida | string | Não | Checar ficha preenchida. Y ou N (padrão: N) | | smsTexto | string | Não | ID ou descrição do texto SMS a enviar. | | lote | string | Condicional | ID ou descrição do lote. **Obrigatório quando a ação é MOVE_LOTE.** | | postUrl | string | Não | URL para envio. | | postUrlEncode | string | Não | Codificar URL. Y ou N (padrão: Y) | | atualizarResultadoExistente | string | Não | Se Y, atualiza o resultado existente com mesma descrição+fila ao invés de inserir um novo. Se N ou não informado, sempre insere. (padrão: N) | **Códigos de ação válidos por tipo de fila:** Fila Ativa (A): | Código | Descrição | | --- | --- | | NONE | Nenhuma | | AG_ESP | Agendamento Especifico | | AG_GEN | Agendamento Generico | | LIGAR_AGORA | Liga imediatamente p/ o prospect | | EX_FONE | Exclui o Fone | | EX_PROSPECT | Exclui o Prospect | | CLIENTE | Prospect tornou-se cliente | | VOLTAR_FILA | Prospect volta para fila | | BLACKLIST | Adiciona prospect na blacklist | | MOVE_LOTE | Move prospect para o lote | _Fila Receptiva (R):_ | Código | Descrição | | --- | --- | | NONE | Nenhuma | | AD_LOTE | Adiciona no lote e agenda retorno | | CLIENTE_REC | Marca prospect como Cliente e nao volta a ligar | | EX_PROSPECT_REC | Exclui o prospect e nao volta a ligar | | BLACKLIST_REC | Adiciona ao blacklist | **Nota:** O campo `acao` aceita tanto o código (ex: `AG_ESP`) quanto a descrição (ex: `Agendamento Especifico`). A busca por descrição é case-insensitive. parameters: - name: Authorization in: header schema: type: string example: '{{token}}' - name: Content-Type in: header schema: type: string example: application/x-www-form-urlencoded requestBody: content: application/x-www-form-urlencoded: schema: type: object properties: descricao: type: string description: '[Obrigatório] Descrição/nome do resultado de ligação' example: descricao fila: type: string description: '[Obrigatório] ID ou descrição da fila' example: fila acao: type: string description: >- [Condicional] Código ou descrição da ação. **Obrigatório para filas do tipo Ativa (A).** Se não informado em fila Receptiva, assume "Nenhuma". example: acao tempoAgendamento: type: string description: '[Opcional] Tempo de agendamento em segundos (padrão: 0)' example: tempoAgendamento fichaPreenchida: type: string description: '[Opcional] Checar ficha preenchida. Y ou N (padrão: N)' example: fichaPreenchida smsTexto: type: string description: '[Opcional] ID ou descrição do texto SMS a enviar.' example: smsTexto lote: type: string description: >- [Condicional] ID ou descrição do lote. **Obrigatório quando a ação é MOVE_LOTE.** example: lote postUrl: type: string description: '[Opcional] URL para envio.' example: postUrl postUrlEncode: type: string description: '[Opcional] Codificar URL. Y ou N (padrão: Y)' example: postUrlEncode atualizarResultadoExistente: type: string description: >- [Opcional] Se Y, atualiza o resultado existente com mesma descrição+fila ao invés de inserir um novo. Se N ou não informado, sempre insere. (padrão: N) example: atualizarResultadoExistente required: - descricao - fila - acao - tempoAgendamento - fichaPreenchida - smsTexto - lote - postUrl - postUrlEncode - atualizarResultadoExistente responses: '200': description: Successful response content: application/json: {} components: securitySchemes: ApiToken: type: apiKey in: header name: Authorization description: >- Token gerado em IPBoX > API > Token. Aceita o token puro, ou com prefixo `Bearer ` / `Basic `. ````