> ## 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.

# addResultadoLigacaoCsv

> Cadastra resultados de ligação em lote a partir de um arquivo CSV.

O CSV usa separador ponto e vírgula (;). Campos que contenham ponto e vírgula ou caracteres especiais HTML devem ser envolvidos por aspas duplas.

**Parâmetros (form-data):**

| Parâmetro | Tipo | Obrigatório | Descrição |
| --- | --- | --- | --- |
| arqCsv | file | Sim | Arquivo CSV com os resultados de ligação |
| importarPrimeiraLinha | string | Não | Se Y, importa a primeira linha como dado. Se N, trata a primeira linha como cabeçalho e ignora. (padrão: N) |
| atualizarResultadoExistente | string | Não | Se Y, atualiza resultados existentes com mesma descrição+fila ao invés de inserir novos. Se N ou não informado, sempre insere. (padrão: N) |

**Formato do CSV (9 colunas, separador ;):**

| Coluna | Campo | Obrigatório | Descrição |
| --- | --- | --- | --- |
| 1 | descricao | Sim | Descrição/nome do resultado |
| 2 | ativo | Não | Y ou N (padrão: Y) |
| 3 | acao | Condicional | Código ou descrição da ação. Obrigatório para filas Ativas. |
| 4 | adseconds | Não | Tempo de agendamento em segundos (padrão: 0) |
| 5 | fila | Sim | ID ou descrição da fila |
| 6 | fichaPreenchida | Não | Y ou N (padrão: N) |
| 7 | postUrl | Não | URL para envio POST. Usar aspas duplas se contiver ; ou caracteres HTML. |
| 8 | postUrlEncode | Não | Codificar URL. Y ou N (padrão: Y) |
| 9 | smsTexto | Não | ID ou descrição do texto SMS |

**Exemplo de cabeçalho CSV:**  
descricao;ativo;acao;adseconds;fila;fichaPreenchida;postUrl;postUrlEncode;smsTexto

**Exemplo de linha CSV:**  
Venda Realizada;Y;Prospect tornou-se cliente;0;Vendas;N;"[https://api.exemplo.com/webhook?tipo=venda&status=ok";Y](https://api.exemplo.com/webhook?tipo=venda&status=ok);

**Notas:**

- Linhas com descrição vazia são ignoradas.
    
- Linhas vazias ou contendo apenas separadores são ignoradas.
    
- Erros em linhas individuais não interrompem o processamento das demais.
    
- Os campos `acao`, `fila` e `smsTexto` aceitam tanto ID quanto descrição (case-insensitive para descrição).
    
- O campo `ativo` é respeitado conforme informado no CSV (Y ou N). Se vazio, assume Y.



## OpenAPI

````yaml /openapi.yaml post /ipbox/api/addResultadoLigacaoCsv
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/addResultadoLigacaoCsv:
    post:
      tags:
        - Filas
      summary: addResultadoLigacaoCsv
      description: >-
        Cadastra resultados de ligação em lote a partir de um arquivo CSV.


        O CSV usa separador ponto e vírgula (;). Campos que contenham ponto e
        vírgula ou caracteres especiais HTML devem ser envolvidos por aspas
        duplas.


        **Parâmetros (form-data):**


        | Parâmetro | Tipo | Obrigatório | Descrição |

        | --- | --- | --- | --- |

        | arqCsv | file | Sim | Arquivo CSV com os resultados de ligação |

        | importarPrimeiraLinha | string | Não | Se Y, importa a primeira linha
        como dado. Se N, trata a primeira linha como cabeçalho e ignora.
        (padrão: N) |

        | atualizarResultadoExistente | string | Não | Se Y, atualiza resultados
        existentes com mesma descrição+fila ao invés de inserir novos. Se N ou
        não informado, sempre insere. (padrão: N) |


        **Formato do CSV (9 colunas, separador ;):**


        | Coluna | Campo | Obrigatório | Descrição |

        | --- | --- | --- | --- |

        | 1 | descricao | Sim | Descrição/nome do resultado |

        | 2 | ativo | Não | Y ou N (padrão: Y) |

        | 3 | acao | Condicional | Código ou descrição da ação. Obrigatório para
        filas Ativas. |

        | 4 | adseconds | Não | Tempo de agendamento em segundos (padrão: 0) |

        | 5 | fila | Sim | ID ou descrição da fila |

        | 6 | fichaPreenchida | Não | Y ou N (padrão: N) |

        | 7 | postUrl | Não | URL para envio POST. Usar aspas duplas se contiver
        ; ou caracteres HTML. |

        | 8 | postUrlEncode | Não | Codificar URL. Y ou N (padrão: Y) |

        | 9 | smsTexto | Não | ID ou descrição do texto SMS |


        **Exemplo de cabeçalho CSV:**  

        descricao;ativo;acao;adseconds;fila;fichaPreenchida;postUrl;postUrlEncode;smsTexto


        **Exemplo de linha CSV:**  

        Venda Realizada;Y;Prospect tornou-se
        cliente;0;Vendas;N;"[https://api.exemplo.com/webhook?tipo=venda&status=ok";Y](https://api.exemplo.com/webhook?tipo=venda&status=ok);


        **Notas:**


        - Linhas com descrição vazia são ignoradas.
            
        - Linhas vazias ou contendo apenas separadores são ignoradas.
            
        - Erros em linhas individuais não interrompem o processamento das
        demais.
            
        - Os campos `acao`, `fila` e `smsTexto` aceitam tanto ID quanto
        descrição (case-insensitive para descrição).
            
        - O campo `ativo` é respeitado conforme informado no CSV (Y ou N). Se
        vazio, assume Y.
      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:
          multipart/form-data:
            schema:
              type: object
              properties:
                arqCsv:
                  type: string
                  description: '[Obrigatório] Arquivo CSV com os resultados de ligação'
                  example: null
                importarPrimeiraLinha:
                  type: string
                  description: >-
                    [Opcional] Se Y, importa a primeira linha como dado. Se N,
                    trata a primeira linha como cabeçalho e ignora. (padrão: N)
                  example: importarPrimeiraLinha
                atualizarResultadoExistente:
                  type: string
                  description: >-
                    [Opcional] Se Y, atualiza resultados existentes com mesma
                    descrição+fila ao invés de inserir novos. Se N ou não
                    informado, sempre insere. (padrão: N)
                  example: atualizarResultadoExistente
              required:
                - arqCsv
                - importarPrimeiraLinha
                - 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 `.

````