Login

Get login status of current session

get

Get login status of current session.

Responses

200

OK

application/json

access_tokenstringOptional

Access token to be passed as a header

Example: 4DFCF1D4C30B4D798ECE3AE43769F008.

expires_atstring · date_timeOptional

The expiration date of the access token in RFC 3339 format, for example, 2017-07-21T17:32:28Z. The RFC 3339 format is defined by RFC 3339, section 5.6

Example: 2017-07-21T17:32:28Z

expires_ininteger · int32Read-onlyOptional

The number of seconds that the access token will be valid.

Example: 1800

rolestring · min: 1 · max: 64Optional

Roles include built-in roles and custom roles.
Built-in roles roles cannot be modified.
Also, the names of built-in roles are reserved words, custom roles are not allowed to use these names to avoid unnecessary confusion.
Built-in roles include:

• SystemAdmin: the system administrator has almost all permissions.
• Replicator: the application permissions collection.
• Dealer: the sales manager has all sold tenant resource permissions
• Admin: the admin has all tenant-wide resource permissions.
• StandardUser: the user all user-wide resource permissions.
• StandardInternationalUser: the user all user-wide resource permissions with international call permissions.
• QueueManager: The call queue manager.

Example: User

401

Unauthorized

get

/login

HTTPcURLJavaScriptPython

GET /api/login HTTP/1.1
Host: HOSTNAME:8887
Accept: */*

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

Login into system

post

Login with username and password.

Body

application/json

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: 280Optional

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

200

OK

No content

4XX

Error

post

/login

HTTPcURLJavaScriptPython

POST /api/login HTTP/1.1
Host: HOSTNAME:8887
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "username": "text",
  "password": "text",
  "domain": "text"
}

No content