Skip to main content
POST
login

Authorizations

Authorization
string
header
required

Token gerado em IPBoX > API > Token. Aceita o token puro, ou com prefixo Bearer / Basic.

Body

application/x-www-form-urlencoded
user
string
required

Login/username do agente.

Example:

"usuario"

senha
string
required

Senha do agente.

Example:

"senha"

time
string
required

ID de um time ao qual o usuário pertence — o time precisa estar associado a pelo menos uma fila. Use getTime para consultar os times cadastrados.

Example:

"time"

ramal
string

Ramal do agente (ex.: 2000). Se informado, é usado para localizar uma sessão existente nesse ramal; se omitido, a sessão existente é localizada pelo IP.

Example:

"ramal"

ip
string

[Opcional] IP da máquina do agente; se não for informado será capturado automaticamente.

Example:

"ip"

Response

Login efetuado com sucesso.

data
object