Login

Get login status of current session

Get login status of current session.

GEThttp://127.0.0.1:8888/api/login

Response

200401

OK

Body

application/json

access_tokenstring

Access token to be passed as a header

Example: "4DFCF1D4C30B4D798ECE3AE43769F008."

expires_atstring (date_time)

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 (int32)

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

Example: 1800

rolestring

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"

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/login', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Login into system

Login with username and password.

POSThttp://127.0.0.1:8888/api/login

Body

application/json

username*string

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.

password*string

The password of user.

domainstring

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.

Response

2004XX

OK

Request

JavaScriptCurlPython

const response = await fetch('http://127.0.0.1:8888/api/login', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "username": "text",
      "password": "text"
    }),
});
const data = await response.json();