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

# classificarProspect

> <h2>Classifica o prospect.</h2>

Informar **resultadoLigacaoId** ou **resultadoLigacao**.

Se ambos forem informados, será usado o **resultadoLigacaoId**.



## OpenAPI

````yaml /openapi.yaml post /ipbox/api/classificarProspect
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/classificarProspect:
    post:
      tags:
        - Prospects
      summary: classificarProspect
      description: |-
        <h2>Classifica o prospect.</h2>

        Informar **resultadoLigacaoId** ou **resultadoLigacao**.

        Se ambos forem informados, será usado o **resultadoLigacaoId**.
      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:
                prospectId:
                  type: string
                  description: Id do prospect
                  example: prospectId
                resultadoLigacaoId:
                  type: string
                  description: >-
                    Id do resultado de ligação - obter os resultados de ligação
                    da fila usando o método getResultadoLigacao descrito acima.
                  example: resultadoLigacaoId
                resultadoLigacao:
                  type: string
                  description: Descrição do resultado de ligação
                  example: resultadoLigacao
                tipoRetorno:
                  type: string
                  description: >-
                    [Opcional] Tipo do agendamento (G = genérico ou E =
                    específico).
                  example: tipoRetorno
                dataRetorno:
                  type: string
                  description: >-
                    [Opcional] Data e hora do agendamento no formato 'YYYY-MM-DD
                    HH:MM'.
                  example: dataRetorno
                usuarioRetorno:
                  type: string
                  description: >-
                    [obrigatório no caso de agendamento específico] -
                    Login/username do agente.
                  example: usuario
                historico:
                  type: string
                  description: '[Opcional] observação em forma de texto'
                  example: historico
              required:
                - prospectId
                - resultadoLigacaoId
                - resultadoLigacao
                - tipoRetorno
                - dataRetorno
                - usuarioRetorno
      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 `.

````