Login

Get login status of current session

Get login status of current session.

get

/login

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://HOSTNAME:8887/api/login'

200

401

200

{
  "access_token": "4DFCF1D4C30B4D798ECE3AE43769F008.",
  "expires_at": "2017-07-21T17:32:28Z",
  "expires_in": 1800,
  "role": "User"
}

OK

Login into system

Login with username and password.

post

/login

Body

usernamestring · min: 1 · max: 64required

The user's account name.
Only letters, numbers, and the following special characters can be added: underscore, dash, single quote, and period (_, -, ', and .).
Username cannot start or end with period (.).
admin, system, administrator, and root are reserved names for system admin only with case ignored.

passwordstringrequired

The password of user.

domainstring · min: 1 · max: 280

The SIP domain of tenant.
It is usually a fully qualified domain name (FQDN). If there is no FQDN, you can also use the IP address of the PBX server as the SIP domain. The SIP domain name is only used for SIP message authentication and does not require analysis.

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/login' \
  --header 'Content-Type: application/json' \
  --data '{
    "username": "text",
    "password": "text",
    "domain": "text"
  }'

200

4XX

200

No body

OK