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

# discarParaRamal

> <h2>Disca um número e encaminha a ligação para o agente que está logado no ramal indicadao.</h2>

###### Response:

Se aguardar_retorno = Y, aguarda o resultado da ligação e retorna o uniqueid da ligação;

Se aguardar_retorno = N, retorna o id da ligação e o resultado da ligação deve ser obtido pelo método getResult.

Se discagem_pelo_ramal = Y, a discagem é feita pelo ramal senão a discagem é feita pelo discador e encaminhada para o ramal.

<table><tbody><tr><td><div>id</div></td><td><div>Id da ligação para o Ramal</div></td></tr></tbody></table>



## OpenAPI

````yaml /openapi.yaml post /ipbox/api/discarParaRamal
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/discarParaRamal:
    post:
      tags:
        - Ligações
      summary: discarParaRamal
      description: >-
        <h2>Disca um número e encaminha a ligação para o agente que está logado
        no ramal indicadao.</h2>


        ###### Response:


        Se aguardar_retorno = Y, aguarda o resultado da ligação e retorna o
        uniqueid da ligação;


        Se aguardar_retorno = N, retorna o id da ligação e o resultado da
        ligação deve ser obtido pelo método getResult.


        Se discagem_pelo_ramal = Y, a discagem é feita pelo ramal senão a
        discagem é feita pelo discador e encaminhada para o ramal.


        <table><tbody><tr><td><div>id</div></td><td><div>Id da ligação para o
        Ramal</div></td></tr></tbody></table>
      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:
                numero:
                  type: string
                  description: 'Informar o 0+ddd+numero; exemplo: numero=01138192014.'
                  example: numero
                ramal:
                  type: string
                  description: 'Ramal do agente; exemplo: 2000.'
                  example: ramal
                aguardar_resposta:
                  type: string
                  description: Y ou N (padrão N)
                  example: aguardar_resposta
                discagem_pelo_ramal:
                  type: string
                  description: Y ou N (pafrão N)
                  example: discagem_pelo_ramal
              required:
                - numero
                - ramal
                - aguardar_resposta
      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 `.

````