Delete tenant
Path parameters
-
access_token
string
required
token to be passed as a header
Request body
application/json
-
id
integer
required
The userid of the tenant or admin user. Admin user has access to details for his account and other tenantusers, whilst tenant user has access to his account info only.
Sample Request
curl -v -X POST http://localhoost:8888/api/account/destroy \
-H "Content-Type: application/json" \
-H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
-d '{
"id": 1231334
}'
Responses
200
404
400
Sample Response
List tenants
Path parameters
-
access_token
string
required
token to be passed as a header -
pagination
integer
required
The pagination of paging. -
pagesize
integer
required
The size of paging. -
sort_by
string
required
Values include "DEFAULT" and "Optional". Default value will be used when user does not specify value for this field.
Sample Request
curl -v -X GET http://localhoost:8888/api/account/list \
-H "Content-Type: application/json" \
-H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
Responses
200
application/json
-
sort_by
string
-
pagesize
integer
-
pagination
integer
-
tenants
array
-
count
integer
Sample Response
{
"sort_by": "DEFAULT",
"pagesize": 10,
"pagination": 8,
"tenants": {
"max_concurrent_calls": 10,
"id": 1231334,
"first_name": "Jack",
"name": "tenant",
"company_name": "example Inc.",
"max_extensions": 1000,
"domain": "tenant.com",
"last_name": "Sparrow",
"enabled": true
},
"count": 100
}
Show tenant
Path parameters
-
access_token
string
required
token to be passed as a header -
id
integer
required
The tenant id of the tenant or admin user. Admin user has access to details for his account and other tenantusers, whilst tenant user has access to his account info only.
Sample Request
curl -v -X GET http://localhoost:8888/api/account/show \
-H "Content-Type: application/json" \
-H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
Responses
200
application/json
-
sms
object
-
id
integer
The userid of the tenant or admin user. Admin user has access to details for his account and other tenantusers, whilst tenant user has access to his account info only. -
capability
object
-
domain
string
Tenant's domain. -
password
string
By default, password for admin user is admin. For extension, the password should be the "Web Access Password" of extensioninstead of extension's SIP password. -
smtp
object
-
office_hours
object
-
quota
object
-
cdr
object
-
name
string
The name of the tenant or admin user. Admin user has access to details for his account and other tenantusers, whilst tenant user has access to his account info only. -
profile
object
-
extension_event
object
-
enabled
boolean
Indicates if it has been enabled for the new user.
Sample Response
{
"sms": {
"provider": "Twilio",
"password": "",
"token": "",
"username": "",
"enabled": false
},
"id": 1231334,
"capability": {
"max_conference_rooms": 1000,
"max_concurrent_calls": 10,
"max_extensions": 1000,
"max_virtual_receptionists": 1000,
"max_ring_groups": 1000,
"max_call_queues": 1000
},
"name": "tenant",
"enabled": true,
"domain": "tenant.com",
"password": "ABCabc123",
"extension_event": {
"username": "BASIC",
"authentication_method": "BASIC",
"password": "BASIC",
"event_url": "",
"enabled": false
},
"cdr": {
"cdr_url": "",
"authentication_method": "",
"password": "",
"username": "",
"enabled": false
},
"smtp": {
"smtp_passwd": "ABCabc123",
"smtp_server_port": 5000,
"smtp_username": "example",
"smtp_security_type": "NO_SECURITY",
"smtp_server": "example.com",
"smtp_reply_addr": "example.com"
}
}
Logs out current logged in user session
Path parameters
-
access_token
string
required
token to be passed as a header
Sample Request
curl -v -X POST http://localhoost:8888/api/account/sign_out \
-H "Content-Type: application/json" \
-H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
Responses
200
Sample Response
Update tenant
Path parameters
-
access_token
string
required
token to be passed as a header
Request body
application/json
-
sms
object
required
-
id
integer
required
The userid of the tenant or admin user. Admin user has access to details for his account and other tenantusers, whilst tenant user has access to his account info only. -
capability
object
required
-
domain
string
required
Tenant's domain. -
password
string
required
By default, password for admin user is admin. For extension, the password should be the "Web Access Password" of extensioninstead of extension's SIP password. -
smtp
object
required
-
office_hours
object
required
-
quota
object
required
-
cdr
object
required
-
name
string
required
The name of the tenant or admin user. Admin user has access to details for his account and other tenantusers, whilst tenant user has access to his account info only. -
profile
object
required
-
extension_event
object
required
-
enabled
boolean
required
Indicates if it has been enabled for the new user.
Sample Request
curl -v -X POST http://localhoost:8888/api/account/update \
-H "Content-Type: application/json" \
-H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
-d '{
"sms": {
"provider": "Twilio",
"password": "",
"token": "",
"username": "",
"enabled": false
},
"quota": {
"auto_clean_recordings_days": 100,
"auto_clean_call_reports_days": 100,
"auto_clean_voicemail_days": 100,
"disk_quota": 100
},
"id": 1231334,
"capability": {
"max_conference_rooms": 1000,
"max_concurrent_calls": 10,
"max_extensions": 1000,
"max_virtual_receptionists": 1000,
"max_ring_groups": 1000,
"max_call_queues": 1000
},
"name": "tenant",
"enabled": true,
"domain": "tenant.com",
"password": "ABCabc123",
"extension_event": {
"username": "BASIC",
"authentication_method": "BASIC",
"password": "BASIC",
"event_url": "",
"enabled": false
},
"cdr": {
"cdr_url": "",
"authentication_method": "",
"password": "",
"username": "",
"enabled": false
},
"smtp": {
"smtp_passwd": "ABCabc123",
"smtp_server_port": 5000,
"smtp_username": "example",
"smtp_security_type": "NO_SECURITY",
"smtp_server": "example.com",
"smtp_reply_addr": "example.com"
}
}'
Responses
200
Sample Response
Retrive domain settings
Path parameters
-
access_token
string
required
token to be passed as a header
Sample Request
curl -v -X GET http://localhoost:8888/api/domain/show \
-H "Content-Type: application/json" \
-H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
Responses
200
application/json
-
domain
string
Tenant's domain.
Sample Response
{
"domain": "tenant.com"
}
Update domain
Path parameters
-
access_token
string
required
token to be passed as a header
Request body
application/json
-
domain
string
required
Tenant's domain.
Sample Request
curl -v -X POST http://localhoost:8888/api/domain/update \
-H "Content-Type: application/json" \
-H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
-d '{
"domain": "tenant.com"
}'
Responses
200
Sample Response
Periodic refreshment of access token
Path parameters
-
access_token
string
required
token to be passed as a header
Sample Request
curl -v -X POST http://localhoost:8888/api/account/token/refresh \
-H "Content-Type: application/json" \
-H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
Responses
200
application/json
-
expires
integer
Time interval for access token expiration, in seconds. If the access token is not refreshed before the expiry, the token will become invalid.
Sample Response
{
"expires": 3600
}
Logs user into the system by email
Path parameters
-
x-forwarded-for
string
optional
host of request client.
Request body
application/json
-
email
string
required
The email address of tenant or admin user. -
web_password
string
required
By default, password for admin user is admin. For extension, the password should be the "Web Access Password" of extensioninstead of extension's SIP password. -
domain
string
required
Tenant's domain. -
language
string
required
Sample Request
curl -v -X POST http://localhoost:8888/api/account/email/verify \
-H "Content-Type: application/json" \
-H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
-d '{
"email": "example@example.com",
"web_password": "ABCabc123",
"domain": "tenant.com"
}'
Responses
200
application/json
-
extension_password
string
By default, password for admin user is admin. For extension, the password should be the "Web Access Password" of extensioninstead of extension's SIP password. -
expires
integer
Time interval for access token expiration, in seconds. If the access token is not refreshed before the expiry, the token will become invalid. -
name
string
The name of the tenant or admin user. Admin user has access to details for his account and other tenantusers, whilst tenant user has access to his account info only. -
extension_number
string
-
access_token
string
token to be passed as a header -
role
string
User type. It could be "administrator", "tenant" or "extension". -
domain
string
Tenant's domain. -
id
integer
The userid of the tenant or admin user. Admin user has access to details for his account and other tenantusers, whilst tenant user has access to his account info only. -
transports
array
-
api_version
string
API version number.
Sample Response
{
"extension_password": "ABCabc123",
"expires": 3600,
"name": "tenant",
"access_token": "4DFCF1D4C30B4D798ECE3AE43769F008",
"role": "tenant",
"domain": "tenant.com",
"id": 1231334,
"api_version": "12.0"
}
Logs user into the system by name and password
Path parameters
-
x-forwarded-for
string
optional
host of request client.
Request body
application/json
-
password
string
required
By default, password for admin user is admin. For extension, the password should be the "Web Access Password" of extensioninstead of extension's SIP password. -
name
string
required
The name of the tenant or admin user. Admin user has access to details for his account and other tenantusers, whilst tenant user has access to his account info only. -
language
string
required
Sample Request
curl -v -X POST http://localhoost:8888/api/account/credentials/verify \
-H "Content-Type: application/json" \
-H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
-d '{
"password": "ABCabc123",
"name": "tenant"
}'
Responses
200
application/json
-
expires
integer
Time interval for access token expiration, in seconds. If the access token is not refreshed before the expiry, the token will become invalid. -
name
string
The name of the tenant or admin user. Admin user has access to details for his account and other tenantusers, whilst tenant user has access to his account info only. -
access_token
string
token to be passed as a header -
role
string
User type. It could be "administrator", "tenant" or "extension". -
id
integer
The userid of the tenant or admin user. Admin user has access to details for his account and other tenantusers, whilst tenant user has access to his account info only. -
api_version
string
API version number.
Sample Response
{
"expires": 3600,
"name": "tenant",
"access_token": "4DFCF1D4C30B4D798ECE3AE43769F008",
"role": "tenant",
"id": 1231334,
"api_version": "12.0"
}
Add a new tenant to the system.
Path parameters
-
access_token
string
required
token to be passed as a header
Request body
application/json
-
sms
object
required
-
password
string
required
By default, password for admin user is admin. For extension, the password should be the "Web Access Password" of extensioninstead of extension's SIP password. -
capability
object
required
-
domain
string
required
Tenant's domain. -
cdr
object
required
-
smtp
object
required
-
office_hours
object
required
-
quota
object
required
-
name
string
required
The name of the tenant or admin user. Admin user has access to details for his account and other tenantusers, whilst tenant user has access to his account info only. -
profile
object
required
-
extension_event
object
required
-
enabled
boolean
required
Indicates if it has been enabled for the new user.
Sample Request
curl -v -X POST http://localhoost:8888/api/account/create \
-H "Content-Type: application/json" \
-H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
-d '{
"sms": {
"provider": "Twilio",
"password": "",
"token": "",
"username": "",
"enabled": false
},
"quota": {
"auto_clean_recordings_days": 100,
"auto_clean_call_reports_days": 100,
"auto_clean_voicemail_days": 100,
"disk_quota": 100
},
"cdr": {
"cdr_url": "",
"authentication_method": "",
"password": "",
"username": "",
"enabled": false
},
"capability": {
"max_conference_rooms": 1000,
"max_concurrent_calls": 10,
"max_extensions": 1000,
"max_virtual_receptionists": 1000,
"max_ring_groups": 1000,
"max_call_queues": 1000
},
"name": "tenant",
"enabled": true,
"domain": "tenant.com",
"password": "ABCabc123",
"extension_event": {
"username": "BASIC",
"authentication_method": "BASIC",
"password": "BASIC",
"event_url": "",
"enabled": false
},
"smtp": {
"smtp_passwd": "ABCabc123",
"smtp_server_port": 5000,
"smtp_username": "example",
"smtp_security_type": "NO_SECURITY",
"smtp_server": "example.com",
"smtp_reply_addr": "example.com"
}
}'
Responses
200
application/json
-
id
integer
The userid of the tenant or admin user. Admin user has access to details for his account and other tenantusers, whilst tenant user has access to his account info only.
Sample Response
{
"id": 1231334
}
Logs user into the system by extension web password
Path parameters
-
x-forwarded-for
string
optional
host of request client.
Request body
application/json
-
extension_number
string
required
-
domain
string
required
Tenant's domain. -
web_password
string
required
By default, password for admin user is admin. For extension, the password should be the "Web Access Password" of extensioninstead of extension's SIP password. -
language
string
required
Sample Request
curl -v -X POST http://localhoost:8888/api/account/extension/web/verify \
-H "Content-Type: application/json" \
-H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
-d '{
"domain": "tenant.com",
"web_password": "ABCabc123"
}'
Responses
200
application/json
-
extension_password
string
By default, password for admin user is admin. For extension, the password should be the "Web Access Password" of extensioninstead of extension's SIP password. -
expires
integer
Time interval for access token expiration, in seconds. If the access token is not refreshed before the expiry, the token will become invalid. -
name
string
The name of the tenant or admin user. Admin user has access to details for his account and other tenantusers, whilst tenant user has access to his account info only. -
extension_number
string
-
indept_password
string
By default, password for admin user is admin. For extension, the password should be the "Web Access Password" of extensioninstead of extension's SIP password. -
role
string
User type. It could be "administrator", "tenant" or "extension". -
domain
string
Tenant's domain. -
access_token
string
token to be passed as a header -
id
integer
The userid of the tenant or admin user. Admin user has access to details for his account and other tenantusers, whilst tenant user has access to his account info only. -
transports
array
-
api_version
string
API version number.
Sample Response
{
"extension_password": "ABCabc123",
"expires": 3600,
"name": "tenant",
"indept_password": "ABCabc123",
"role": "tenant",
"domain": "tenant.com",
"access_token": "4DFCF1D4C30B4D798ECE3AE43769F008",
"id": 1231334,
"api_version": "12.0"
}
Logs user into the system by extension sip password
Path parameters
-
x-forwarded-for
string
optional
host of request client.
Request body
application/json
-
extension_number
string
required
-
domain
string
required
Tenant's domain. -
language
string
required
-
sip_password
string
required
By default, password for admin user is admin. For extension, the password should be the "Web Access Password" of extensioninstead of extension's SIP password.
Sample Request
curl -v -X POST http://localhoost:8888/api/account/extension/sip/verify \
-H "Content-Type: application/json" \
-H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
-d '{
"domain": "tenant.com",
"sip_password": "ABCabc123"
}'
Responses
200
application/json
-
extension_password
string
By default, password for admin user is admin. For extension, the password should be the "Web Access Password" of extensioninstead of extension's SIP password. -
expires
integer
Time interval for access token expiration, in seconds. If the access token is not refreshed before the expiry, the token will become invalid. -
name
string
The name of the tenant or admin user. Admin user has access to details for his account and other tenantusers, whilst tenant user has access to his account info only. -
extension_number
string
-
indept_password
string
By default, password for admin user is admin. For extension, the password should be the "Web Access Password" of extensioninstead of extension's SIP password. -
role
string
User type. It could be "administrator", "tenant" or "extension". -
domain
string
Tenant's domain. -
access_token
string
token to be passed as a header -
id
integer
The userid of the tenant or admin user. Admin user has access to details for his account and other tenantusers, whilst tenant user has access to his account info only. -
transports
array
-
api_version
string
API version number.
Sample Response
{
"extension_password": "ABCabc123",
"expires": 3600,
"name": "tenant",
"indept_password": "ABCabc123",
"role": "tenant",
"domain": "tenant.com",
"access_token": "4DFCF1D4C30B4D798ECE3AE43769F008",
"id": 1231334,
"api_version": "12.0"
}