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

# getEstado

> <h2>Retorna o estado do agente</h2>

<ul><li><div>online</div></li><li><div>offline</div></li><li><div>paused</div></li><li><div>busy</div></li><li><div>ringing</div></li></ul>

Retorna também o id da operação, fila e time.

nota: Se estado=paused, retorna também o id e descrição da pausa.

###### Response:

<table><tbody><tr><td><div>status</div></td><td><div>Texto descritivo do status, conforme relação acima</div></td></tr></tbody></table>



## OpenAPI

````yaml /openapi.yaml post /ipbox/api/getEstado
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/getEstado:
    post:
      tags:
        - Agente
      summary: getEstado
      description: >-
        <h2>Retorna o estado do agente</h2>


        <ul><li><div>online</div></li><li><div>offline</div></li><li><div>paused</div></li><li><div>busy</div></li><li><div>ringing</div></li></ul>


        Retorna também o id da operação, fila e time.


        nota: Se estado=paused, retorna também o id e descrição da pausa.


        ###### Response:


        <table><tbody><tr><td><div>status</div></td><td><div>Texto descritivo do
        status, conforme relação acima</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:
                user:
                  type: string
                  description: Login/username do agente.
                  example: usuario
              required:
                - user
      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 `.

````