Administrations | PortSIP Knowledge Base

Retrieve network configurations

get

Get network configurations.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

get

/network

GET /api/network HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "web_domain": null,
  "private_ipv4": null,
  "public_ipv4": null,
  "enable_ipv6": null,
  "private_ipv6": null,
  "public_ipv6": null,
  "primary_dns_server": null,
  "secondary_dns_server": null
}

Update network configurations

post

Update network configurations for PortSIP PBX.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

web_domainstringOptional

The web domain for PortSIP PBX

private_ipv4stringOptional

The private IPv4 of system.

public_ipv4stringOptional

The public IPv4 of system.

enable_ipv6booleanOptional

Indicates if IPv6 would be enabled.

Default: true

private_ipv6stringOptional

The private IPv6 of system.

public_ipv6stringOptional

The public IPv6 of system.

primary_dns_serverstringOptional

The primary DNS server.

secondary_dns_serverstringOptional

The secondary DNS server.

Responses

200

OK

No content

4XX

Error

post

/network

POST /api/network HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 170

{
  "web_domain": null,
  "private_ipv4": null,
  "public_ipv4": null,
  "enable_ipv6": null,
  "private_ipv6": null,
  "public_ipv6": null,
  "primary_dns_server": null,
  "secondary_dns_server": null
}

No content

List users

get

List a collection of users.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

filterstringOptional

Use the filter query parameter to retrieve just a subset of a collection.

searchstringOptional

Use the search query parameter to restrict the results of a request to match a search criterion.

orderbystringOptional

Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.

skipinteger · int32Optional

Use the skip query parameter to set the number of items to skip at the start of a collection.

Default: 0

topinteger · int32 · min: 1 · max: 100Optional

Use the top query parameter to specify the page size of the result set.

Default: 100

Responses

200

OK

application/json

4XX

Error

get

/admin/users

GET /api/admin/users HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 1,
  "items": [
    {
      "id": null,
      "name": null,
      "enabled": null,
      "protected": null,
      "email": null,
      "display_name": null,
      "role_id": null,
      "role_name": null,
      "mobile_phone": null,
      "work_phone": null,
      "home_phone": null,
      "address": null,
      "department": null,
      "website": null,
      "created_at": null,
      "login_at": null,
      "logout_at": null,
      "avatar_file_name": null,
      "avatar_file_size": null,
      "avatar_file_url": null
    }
  ]
}

Create a user

post

Create a user.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

namestring · 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.

emailall ofRequired

The email address of user.

string · max: 128Optional

The email address.

Example: [email protected]

display_namestring · max: 1024Required

The display name of user.

enabledbooleanOptional

Whether user is enabled.

Default: true

rolestring · min: 1 · max: 64Required

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.
OperationsAdmin: the operations administrator.
SiteAdmin: the site administrator.
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

mobile_phonestring · max: 32Optional

The mobile phone number of user.

work_phonestring · max: 32Optional

The office phone number of user.

home_phonestring · max: 32Optional

The home phone number of user.

addressstring · max: 128Optional

The address.

departmentstring · max: 128Optional

The department of user.

websitestringOptional

The website of user.

Responses

201

Created

application/json

4XX

Error

post

/admin/users

POST /api/admin/users HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 191

{
  "name": null,
  "password": null,
  "email": null,
  "display_name": null,
  "enabled": null,
  "role": null,
  "mobile_phone": null,
  "work_phone": null,
  "home_phone": null,
  "address": null,
  "department": null,
  "website": ""
}

{
  "id": "xxxxxxxx"
}

Get a user

get

Retrieves information of a user.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

4XX

Error

get

/admin/users/{id}

GET /api/admin/users/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": null,
  "name": null,
  "email": null,
  "display_name": null,
  "role_id": null,
  "role_name": null,
  "enabled": null,
  "protected": null,
  "mobile_phone": null,
  "work_phone": null,
  "home_phone": null,
  "address": null,
  "department": null,
  "website": null,
  "created_at": null,
  "login_at": null,
  "logout_at": null,
  "avatar_file_name": null,
  "avatar_file_size": null,
  "avatar_file_url": null
}

Update a user

post

Change configurations of user.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

emailall ofOptional

The email address of user.

string · max: 128Optional

The email address.

Example: [email protected]

display_namestring · max: 1024Optional

The display name of user.

enabledbooleanOptional

Whether user is enabled.

Default: true

mobile_phonestring · max: 32Optional

The mobile phone number of user.

work_phonestring · max: 32Optional

The office phone number of user.

home_phonestring · max: 32Optional

The home phone number of user.

addressstring · max: 128Optional

The address.

departmentstring · max: 128Optional

The department of user.

websitestringOptional

The website of user.

Responses

200

OK

No content

4XX

Error

post

/admin/users/{id}

POST /api/admin/users/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 153

{
  "email": null,
  "display_name": null,
  "enabled": null,
  "mobile_phone": null,
  "work_phone": null,
  "home_phone": null,
  "address": null,
  "department": null,
  "website": null
}

No content

Change username

post

Change admin user username.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

namestring · 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.

Responses

200

OK

No content

4XX

Error

post

/admin/users/{id}/username

POST /api/admin/users/{id}/username HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 13

{
  "name": null
}

No content

Change user password

post

Change admin user password.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

passwordall ofRequired

The new password of admin user.

stringOptional

The password of system admin.

Responses

200

OK

No content

4XX

Error

post

/admin/users/{id}/password

POST /api/admin/users/{id}/password HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "password": "xxxxxxxxxxxx"
}

No content

Change user role

post

Change admin user role.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

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.
OperationsAdmin: the operations administrator.
SiteAdmin: the site administrator.
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

Responses

200

OK

No content

4XX

Error

post

/admin/users/{id}/role

POST /api/admin/users/{id}/role HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 13

{
  "role": null
}

No content

Delete a user

post

Delete a user.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of user.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

4XX

Error

post

/admin/users/{id}/destroy

POST /api/admin/users/{id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get current user

get

Retrieves information about the currently logged-in administrator user.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

get

/admin/user

GET /api/admin/user HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": null,
  "name": null,
  "email": null,
  "display_name": null,
  "role_id": null,
  "role_name": null,
  "enabled": null,
  "protected": null,
  "mobile_phone": null,
  "work_phone": null,
  "home_phone": null,
  "address": null,
  "department": null,
  "website": null,
  "created_at": null,
  "login_at": null,
  "logout_at": null,
  "avatar_file_name": null,
  "avatar_file_size": null,
  "avatar_file_url": null
}

Update current user

post

Change configurations of currently logged-in administrator user.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

emailall ofOptional

The email address of user.

string · max: 128Optional

The email address.

Example: [email protected]

display_namestring · max: 1024Optional

The display name of user.

mobile_phonestring · max: 32Optional

The mobile phone number of user.

work_phonestring · max: 32Optional

The office phone number of user.

home_phonestring · max: 32Optional

The home phone number of user.

addressstring · max: 128Optional

The address.

departmentstring · max: 128Optional

The department of user.

websitestringOptional

The website of user.

Responses

200

OK

No content

4XX

Error

post

/admin/user

POST /api/admin/user HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 138

{
  "email": null,
  "display_name": null,
  "mobile_phone": null,
  "work_phone": null,
  "home_phone": null,
  "address": null,
  "department": null,
  "website": null
}

No content

Change current user username

post

Change current admin user username.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

namestring · 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.

Responses

200

OK

No content

4XX

Error

post

/admin/user/username

POST /api/admin/user/username HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 13

{
  "name": null
}

No content

Change current user password

post

Change current admin user password.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

old_passwordall ofRequired

The old password of admin user.

stringOptional

The password of system admin.

new_passwordall ofRequired

The new password of admin user.

stringOptional

The password of system admin.

Responses

200

OK

No content

4XX

Error

post

/admin/user/password

POST /api/admin/user/password HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "old_password": null,
  "new_password": null
}

No content

Retrieve current system status

get

Get current status of system.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

get

/admin/status

GET /api/admin/status HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "version": null,
  "news": null,
  "license_key": null,
  "license_type": null,
  "maintenance_expires_at": null,
  "max_concurrent_calls": null,
  "licensed_users": null,
  "current_users": null,
  "online_users": null,
  "current_tenants": null,
  "current_dealers": null,
  "current_calls": null,
  "current_trunks": null,
  "current_conference_servers": null,
  "current_media_servers": null,
  "current_call_queue_servers": null,
  "current_ivr_servers": null
}

Retrieve system settings

get

Retrieve settings for PortSIP PBX.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

get

/admin/settings

GET /api/admin/settings HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "user_agent": null,
  "blocked_user_agents": null,
  "enable_shared_address_space_address_range": null,
  "enable_digest_auth": null,
  "enable_auth_mid_dialog": null,
  "enable_digest_auth_int": null,
  "enable_external_recording": null,
  "enable_reject_bad_nonce": null,
  "statistics_log_interval": null,
  "dead_session_timeout": null,
  "enable_session_timer": null,
  "session_timer_duration": null,
  "enable_to_tag_in_register": null,
  "enable_congestion_management": null,
  "congestion_management_metric": null,
  "congestion_management_tolerance": null,
  "enable_create_non_exist_extension": null,
  "enable_prack": null,
  "enable_tenant_level_trunk": null,
  "enable_diversion_support": null,
  "enable_history_info_support": null,
  "enable_outbound_support": null,
  "flow_timer": null,
  "register_expiration_time": null,
  "enable_auto_answer_alert_info_header": null,
  "auto_answer_alert_info_header": null,
  "enable_auto_answer_call_info_header": null,
  "enable_require_answer_mode": null,
  "enable_www_auth": null,
  "user_equal_required_for_auth_name": null,
  "trace_server_host": null,
  "trace_server_port": null,
  "web_failed_auth_amount": null,
  "web_blacklist_time_interval": null,
  "sip_failed_auth_amount": null,
  "sip_failed_challenge_requests_amount": null,
  "sip_blacklist_time_interval": null,
  "sip_detection_period": null,
  "sip_barrier_1_packets": null,
  "sip_barrier_1_blocking_time": null,
  "sip_barrier_2_packets": null,
  "sip_barrier_2_blocking_time": null,
  "stir_shaken_cert": null,
  "stir_shaken_key": null,
  "custom_options": null
}

Update system settings

post

Update settings for PortSIP PBX

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

user_agentstring · min: 1 · max: 1024Optional

User agent.

Default: PortSIP UC

blocked_user_agentsstringOptional

The semicolon separated list of blocked user agents.

enable_shared_address_space_address_rangebooleanOptional

Enable Shared Address Space Address Range or not (RFC 6598).

Default: true

enable_digest_authbooleanOptional

Indicates if DIGEST authentication would be enabled.

Default: true

enable_auth_mid_dialogbooleanOptional

Indicates if PortSIP PBX requires authentication against all subsequent requests originated from one calling.

Default: false

enable_digest_auth_intbooleanOptional

Indicates if auth-int DIGEST authentication mode would be enabled.

Default: false

enable_external_recordingbooleanOptional

Allow external calls recording.

Default: true

enable_reject_bad_noncebooleanOptional

When a client sends a bad nonce in their credentials, return 403 message if this parameter is true, or send a new challenge if this parameter is false.

Default: false

statistics_log_intervalinteger · int32Optional

Interval for statistics logs, in seconds.

Default: 600

dead_session_timeoutinteger · int32Optional

Close the session if no RTP packets received within specified duration, in seconds.

Default: 600

enable_session_timerbooleanOptional

Indicates if session timer (RFC 4028) would be enabled. This also requires client support.

Default: true

session_timer_durationinteger · int32 · min: 90 · max: 3600Optional

Duration recorded by Session timer. Precondition: "enable_session_timer" MUST be set to true.

Default: 3600

enable_to_tag_in_registerbooleanOptional

Indicates if "to" tag is allowed in REGISTER message.

Default: false

enable_congestion_managementbooleanOptional

Indicates if congestion management would be enabled.

Default: true

congestion_management_metricstring · enumOptional

Precondition: "enable_congestion_management" parameter MUST be set to true. The recommended is WAIT_TIME based on the expected wait time for each FIFO.

WAIT_TIME:
TIME_DEPTH:
SIZE:

Possible values:

congestion_management_toleranceinteger · int32Optional

Precondition: "enable_congestion_management" parameter MUST be set to true. Congestion management tolerance for the given metric. This parameter determines when the Rejection Behavior changes.

Default: 600

enable_create_non_exist_extensionbooleanOptional

Indicates if the extension would be automatically created when a non-existent extension try to register. If it is set to true, when a non-included extension tries to send registry message to PBX, the PBX will create the extension with default password "portsip" automatically.

Default: false

enable_prackbooleanOptional

Enable prack or not.

Default: false

enable_tenant_level_trunkbooleanOptional

Whether to enable tenant-level trunk.

Default: true

enable_diversion_supportbooleanOptional

Enable Diversion support or not (RFC 5806).

Default: false

enable_history_info_supportbooleanOptional

Enable History-Info support (RFC 7044).

Default: false

enable_outbound_supportbooleanOptional

Enable Outbound Support or not (RFC 5626).

Default: true

flow_timerinteger · int32Optional

The flow timer interval in seconds.

Default: 0

register_expiration_timeinteger · min: 90 · max: 3600Optional

The register expiration time in seconds.

Default: 300

enable_auto_answer_alert_info_headerbooleanOptional

Enable call-info header for auto answer or not.

Default: false

auto_answer_alert_info_headerstring · enumOptional

Alert-info header to be added in INVITE message when PBX is forwarding the page/intercom. Values includes:

INTERCOM: info=intercom.
ALERT_AUTO_ANSWER: Alert-Info:;info=alert-autoanswer;delay=0.
AUTO_ANSWER: info=Auto Answer.

Possible values:

enable_auto_answer_call_info_headerbooleanOptional

Enable call-info header for auto answer. The value is "sip:portsip.com;answer-after=0".

Default: true

enable_require_answer_modebooleanOptional

Enable Require Answer Mode (RFC 5373) for auto answer.

Default: false

enable_www_authbooleanOptional

Enable WWW authentication or not.

Default: false

user_equal_required_for_auth_namebooleanOptional

User equal required for authentication name.

Default: true

trace_server_hoststringOptional

Tracer server host.

trace_server_portall ofOptional

The tracer server port.

integer · int32 · max: 65535Optional

A port number is a 16-bit unsigned integer, thus ranging from 0 to 65535. For TCP, port number 0 is reserved and cannot be used, while for UDP, the source port is optional and a value of zero means no port

Example: 80

web_failed_auth_amountinteger · int32Optional

Block if failed to login PortSIP PBX Web more than this times.

Default: 5

web_blacklist_time_intervalinteger · int32Optional

The web blocked time in seconds.

Default: 3600

sip_failed_auth_amountinteger · int32Optional

The number of authentication failures.

Default: 50

sip_failed_challenge_requests_amountinteger · int32Optional

DOS attacks can send REGISTER/INVITE requests but do not reply to Challenge (407). Configure the amount of "fake" requests that PortSIP PBX will accept per IP Address. If this value is exceeded in "Detection Period" interval the source IP address is put in the Blacklist. IP will remain blacklisted till "SIP Blacklist time interval" expires.

Default: 1000

sip_blacklist_time_intervalinteger · int32Optional

The sip blocked time in seconds.

Default: 3600

sip_detection_periodinteger · int32Optional

The detection period in seconds.

Default: 10

sip_barrier_1_packetsinteger · int32Optional

If the amount of packets is exceeded, the PBX will block the source IP for "Level 1 blacklist time interval" seconds.

Default: 5000

sip_barrier_1_blocking_timeinteger · int32Optional

This is the time interval in seconds that an abusive IP Address remains in the blacklist

Default: 3600

sip_barrier_2_packetsinteger · int32Optional

If the amount of packets is exceeded, the PBX will block the source IP for "Level 2 blacklist time interval" seconds.

Default: 2000

sip_barrier_2_blocking_timeinteger · int32Optional

This is the time interval in seconds that an abusive IP Address remains in the blacklist

Default: 30

stir_shaken_certstringOptional

Content of this certificate file for STIR/SHAKEN support.

stir_shaken_keystringOptional

Content of this private certificate file for STIR/SHAKEN support.

custom_optionsstringOptional

Some custom configuration options serialized as json string.

Responses

200

OK

No content

4XX

Error

post

/admin/settings

POST /api/admin/settings HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1419

{
  "user_agent": null,
  "blocked_user_agents": null,
  "enable_shared_address_space_address_range": null,
  "enable_digest_auth": null,
  "enable_auth_mid_dialog": null,
  "enable_digest_auth_int": null,
  "enable_external_recording": null,
  "enable_reject_bad_nonce": null,
  "statistics_log_interval": null,
  "dead_session_timeout": null,
  "enable_session_timer": null,
  "session_timer_duration": null,
  "enable_to_tag_in_register": null,
  "enable_congestion_management": null,
  "congestion_management_metric": null,
  "congestion_management_tolerance": null,
  "enable_create_non_exist_extension": null,
  "enable_prack": null,
  "enable_tenant_level_trunk": null,
  "enable_diversion_support": null,
  "enable_history_info_support": null,
  "enable_outbound_support": null,
  "flow_timer": null,
  "register_expiration_time": null,
  "enable_auto_answer_alert_info_header": null,
  "auto_answer_alert_info_header": null,
  "enable_auto_answer_call_info_header": null,
  "enable_require_answer_mode": null,
  "enable_www_auth": null,
  "user_equal_required_for_auth_name": null,
  "trace_server_host": null,
  "trace_server_port": null,
  "web_failed_auth_amount": null,
  "web_blacklist_time_interval": null,
  "sip_failed_auth_amount": null,
  "sip_failed_challenge_requests_amount": null,
  "sip_blacklist_time_interval": null,
  "sip_detection_period": null,
  "sip_barrier_1_packets": null,
  "sip_barrier_1_blocking_time": null,
  "sip_barrier_2_packets": null,
  "sip_barrier_2_blocking_time": null,
  "stir_shaken_cert": null,
  "stir_shaken_key": null,
  "custom_options": null
}

No content

Retrieve system notification settings

get

Retrieve details of system notification settings.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

get

/admin/notification

GET /api/admin/notification HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "type": null,
  "server": null,
  "port": null,
  "reply_to": null,
  "username": null,
  "auth": null,
  "enable_tls_ssl": null,
  "enable_starttls_auto": null,
  "recipients": null,
  "enable_tenant_access": null,
  "hard_disk_threshold": null,
  "notify_hard_disk_exceeded_threshold": null,
  "cpu_threshold": null,
  "notify_cpu_exceeded_threshold": null,
  "memory_threshold": null,
  "notify_memory_exceeded_threshold": null,
  "notify_ip_blocked": null,
  "notify_license_limited": null,
  "notify_service_disconnected": null,
  "notify_push_certs_update_failed": null
}

Update system notification settings

post

Update system notification settings.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

typestring · enumRequired

The email server type.
Can be either:

SMTP: Use generic SMTP server.
MS365 Use Microsoft 365 email service.
GMAIL Use Google Gmail service.

Possible values:

serverstringOptional

SMTP server used for sending mails.

portinteger · int32 · max: 65535Optional

A port number is a 16-bit unsigned integer, thus ranging from 0 to 65535. For TCP, port number 0 is reserved and cannot be used, while for UDP, the source port is optional and a value of zero means no port

Example: 80

reply_tostringOptional

A Reply-To address is identified by inserting the Reply-To header in your email.
It is the email address that the reply message is sent when you want the reply to go to an email address that is different than the From: address.

usernamestring · max: 128Required

Username or email address.

passwordstringOptional

Password for email account.

authstring · enumOptional

The authentication protocols.
Can be either:

DISABLE: Skip authentication mechanism.
AUTO: Use auto-selected authentication algorithms by server (Currently only supports LOGIN and PLAIN).
LOGIN: Use LOGIN authentication mechanism.
PLAIN Use PLAIN authentication mechanism.

Default: AUTOPossible values:

enable_tls_sslbooleanOptional

Whether to enable TLS/SSL.

Default: true

enable_starttls_autobooleanOptional

Whether StartTLS is automatically enabled.

Default: false

recipientsstringOptional

Comma-separated list of email address that should receive notifications.
Allow up to 15 email addresses.

enable_tenant_accessbooleanOptional

Apply the email server settings to all tenants.

Default: true

hard_disk_thresholdnumber · doubleOptional

The hard disk threshold for email warning.

Example: 0.9

notify_hard_disk_exceeded_thresholdbooleanOptional

Send a notification email when specified hard disk threshold is exceeded.

Default: false

cpu_thresholdnumber · doubleOptional

The CPU threshold for email warning.

Example: 0.9

notify_cpu_exceeded_thresholdbooleanOptional

Send a notification email when specified CPU threshold is exceeded.

Default: false

memory_thresholdnumber · doubleOptional

The memory threshold for email warning.

Example: 0.9

notify_memory_exceeded_thresholdbooleanOptional

Send an email notification when specified memory threshold is exceeded.

Default: false

notify_ip_blockedbooleanOptional

Send a notification email when ip blocked.

Default: false

notify_license_limitedbooleanOptional

Send a notification email when license limit reached.

Default: false

notify_service_disconnectedbooleanOptional

Send a notification email when some service disconnected.

Default: false

notify_push_certs_update_failedbooleanOptional

Send a notification email when push notification certificates update failed.

Default: false

Responses

200

OK

No content

4XX

Error

post

/admin/notification

POST /api/admin/notification HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 516

{
  "type": null,
  "server": null,
  "port": null,
  "reply_to": null,
  "username": null,
  "password": null,
  "auth": null,
  "enable_tls_ssl": null,
  "enable_starttls_auto": null,
  "recipients": null,
  "enable_tenant_access": null,
  "hard_disk_threshold": null,
  "notify_hard_disk_exceeded_threshold": null,
  "cpu_threshold": null,
  "notify_cpu_exceeded_threshold": null,
  "memory_threshold": null,
  "notify_memory_exceeded_threshold": null,
  "notify_ip_blocked": null,
  "notify_license_limited": null,
  "notify_service_disconnected": null,
  "notify_push_certs_update_failed": null
}

No content

Test email

post

Check email server configurations by sending testing email.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

recipientstringRequired

The recipient's e-mail address.

subjectstringRequired

Mail subject.

contentstringRequired

Mail content.

Responses

200

OK

No content

4XX

Error

post

/admin/notification/test_email

POST /api/admin/notification/test_email HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "recipient": null,
  "subject": null,
  "content": null
}

No content

Retrieve SBC configuration

get

Retrieve settings for SBC.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

get

/sbc

GET /api/sbc HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "domain": null,
  "http_port": null,
  "https_port": null,
  "transports": null
}

Update SBC configuration

post

Update SBC configuration.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

domainstringOptional

The SBC domain.

http_portall ofOptional

The SBC web port for http.

Default: 8882

integer · int32 · max: 65535Optional

A port number is a 16-bit unsigned integer, thus ranging from 0 to 65535. For TCP, port number 0 is reserved and cannot be used, while for UDP, the source port is optional and a value of zero means no port

Example: 80

https_portall ofOptional

The SBC web port fot https.

Default: 8883

integer · int32 · max: 65535Optional

A port number is a 16-bit unsigned integer, thus ranging from 0 to 65535. For TCP, port number 0 is reserved and cannot be used, while for UDP, the source port is optional and a value of zero means no port

Example: 80

Responses

200

OK

No content

4XX

Error

post

/sbc

POST /api/sbc HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 68

{
  "domain": null,
  "http_port": null,
  "https_port": null,
  "transports": null
}

No content

Retrieve SBC token

get

Retrieve SBC token

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

get

/sbc/token

GET /api/sbc/token HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "token": "xxxxxxxxxxxxxxxxxxxxxxxxx"
}

Regenerate SBC token

post

Regenerate SBC token

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

post

/sbc/token

POST /api/sbc/token HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "token": "xxxxxxxxxxxxxxxxxxxxx"
}

Destroy SBC Token

post

Destroy SBC Token.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

204

No Content

4XX

Error

post

/sbc/token/destroy

POST /api/sbc/token/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Retrieve IM server configuration

get

Retrieve settings of IM server.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

get

/im

GET /api/im HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "private_ipv4": null,
  "private_ipv6": null,
  "public_ipv4": null,
  "public_ipv6": null
}

Update IM server configuration

post

Update IM server configuration.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

private_ipv4stringOptional

Host IPV4 address.

private_ipv6stringOptional

Host IPV6 address.

public_ipv4stringOptional

Host IPV4 address.

public_ipv6stringOptional

Host IPV6 address.

Responses

200

OK

No content

4XX

Error

post

/im

POST /api/im HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 79

{
  "private_ipv4": null,
  "private_ipv6": null,
  "public_ipv4": null,
  "public_ipv6": null
}

No content

Retrieve IM Server token

get

Retrieve IM server token

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

get

/im/token

GET /api/im/token HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "token": "xxxxxxxxxxxxxxxxxxxxxx"
}

Regenerate IM server token

post

Regenerate IM server token

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

post

/im/token

POST /api/im/token HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "token": "xxxxxxxxxxxxxxxxx"
}

Destroy IM server Token

post

Destroy IM server Token.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

204

No Content

4XX

Error

post

/im/token/destroy

POST /api/im/token/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List dealers

get

List a collection of dealers.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

get

/dealers

GET /api/dealers HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 1,
  "items": [
    {
      "id": null,
      "enabled": null,
      "level": null,
      "name": null,
      "email": null,
      "display_name": null,
      "website": null,
      "phone": null,
      "address": null,
      "description": null,
      "max_tenants": null,
      "max_extensions": null,
      "tenant_full_access": null
    }
  ]
}

Create a dealer

post

Create a dealer.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

enabledbooleanOptional

Enable this dealer or not.

Default: true

levelstring · enumRequired

Dealer level includes:

DISTRIBUTOR: the first level of dealers.
SUB_DISTRIBUTOR: the second level of dealers.
RESELLER: the third level of dealers.

Possible values:

namestring · 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 dealer.

emailall ofOptional

The email address of user.

string · max: 128Optional

The email address.

Example: [email protected]

display_namestring · max: 1024Optional

The display name of user.

websitestringOptional

The website of user.

phonestring · max: 32Optional

The mobile phone number of user.

addressstring · max: 128Optional

The address.

descriptionstringOptional

The description of dealer.

max_tenantsinteger · int32Required

The maximum number of tenants that the dealer is allowed to create.

Default: 100

max_extensionsinteger · int32Required

The maximum number of extensions that the dealer is allowed to create.

Default: 50000

tenant_full_accessbooleanOptional

Whether or not the reseller is allowed to have full control over the tenant.
This attribute is not valid if not modified by first level dealer.

Default: true

Responses

201

Success

application/json

4XX

Error

post

/dealers

POST /api/dealers HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 219

{
  "enabled": null,
  "level": null,
  "name": null,
  "password": null,
  "email": null,
  "display_name": null,
  "website": null,
  "phone": null,
  "address": null,
  "description": null,
  "max_tenants": null,
  "max_extensions": null,
  "tenant_full_access": null
}

{
  "id": "xxxxxxxx"
}

Retrieve a dealer

get

Get details of the dealer by it's unique ID.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of dealer.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

4XX

Error

get

/dealers/{id}

GET /api/dealers/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": null,
  "enabled": null,
  "level": null,
  "name": null,
  "email": null,
  "display_name": null,
  "website": null,
  "phone": null,
  "address": null,
  "description": null,
  "max_tenants": null,
  "max_extensions": null,
  "tenant_full_access": null
}

Update a dealer

post

Modify the settings of the dealer.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of dealer.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

enabledbooleanOptional

Enable this dealer or not.

Default: true

emailall ofOptional

The email address of user.

string · max: 128Optional

The email address.

Example: [email protected]

display_namestring · max: 1024Optional

The display name of user.

websitestringOptional

The website of user.

phonestring · max: 32Optional

The mobile phone number of user.

addressstring · max: 128Optional

The address.

descriptionstringOptional

The description of dealer.

max_tenantsinteger · int32Optional

The maximum number of tenants that the dealer is allowed to create.

Default: 100

max_extensionsinteger · int32Optional

The maximum number of extensions that the dealer is allowed to create.

Default: 50000

tenant_full_accessbooleanOptional

Whether or not the reseller is allowed to have full control over the tenant.
This attribute is not valid if not modified by first level dealer.

Default: true

Responses

200

OK

No content

4XX

Error

post

/dealers/{id}

POST /api/dealers/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 178

{
  "enabled": null,
  "email": null,
  "display_name": null,
  "website": null,
  "phone": null,
  "address": null,
  "description": null,
  "max_tenants": null,
  "max_extensions": null,
  "tenant_full_access": null
}

No content

Reset dealer password

post

Reset dealer's password.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of dealer.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

passwordstringOptional

The password of dealer.

Responses

200

OK

No content

4XX

Error

post

/dealers/{id}/password

POST /api/dealers/{id}/password HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "password": null
}

No content

Delete a dealer

post

Delete a dealer by it's unique ID.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of dealer.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

4XX

Error

post

/dealers/{id}/destroy

POST /api/dealers/{id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List IP rules

get

Retrieve a collection of IP blacklist entries or whitelist entries.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

filterstringOptional

Use the filter query parameter to retrieve just a subset of a collection.

searchstringOptional

Use the search query parameter to restrict the results of a request to match a search criterion.

orderbystringOptional

Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.

skipinteger · int32Optional

Use the skip query parameter to set the number of items to skip at the start of a collection.

Default: 0

topinteger · int32 · min: 1 · max: 100Optional

Use the top query parameter to specify the page size of the result set.

Default: 100

Responses

200

OK

application/json

4XX

Error

get

/ip_filters

GET /api/ip_filters HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 1,
  "items": [
    {
      "value": null,
      "id": null,
      "cidr": null,
      "target": null,
      "expire_at": null,
      "description": null
    }
  ]
}

Create an IP rule

post

Add a new IP blacklist entry or whitelist entry to the system.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

cidrstringRequired

The CIDR notation IP address and prefix length, like "192.0.2.0/24" or "2001:db8::/32", as defined in RFC 4632 and RFC 4291.

targetstring · enumRequired

IP rule's target:

ACCEPT: An accepted rule.
DENY: A rejection rule.

Possible values:

expire_atall ofOptional

IP rule's expire time.

string · date_timeOptional

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

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

descriptionstring · max: 255Optional

Remarks for the IP rule.

Responses

200

OK

application/json

4XX

Error

post

/ip_filters

POST /api/ip_filters HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 63

{
  "cidr": null,
  "target": null,
  "expire_at": null,
  "description": null
}

{
  "id": "xxxxxxxx"
}

Retrieve an IP rule

get

Retrieve IP blacklist entry or whitelist entry.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of IP rule.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

4XX

Error

get

/ip_filters/{id}

GET /api/ip_filters/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": null,
  "cidr": null,
  "target": null,
  "expire_at": null,
  "description": null
}

Update an IP rule

post

Update IP blacklist entry or whitelist entry that already exists.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of IP rule.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

cidrstringOptional

The CIDR notation IP address and prefix length, like "192.0.2.0/24" or "2001:db8::/32", as defined in RFC 4632 and RFC 4291.

targetstring · enumOptional

IP rule's target:

ACCEPT: An accepted rule.
DENY: A rejection rule.

Possible values:

expire_atall ofOptional

IP rule's expire time.

string · date_timeOptional

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

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

descriptionstring · max: 255Optional

Remarks for the IP rule.

Responses

200

OK

No content

4XX

Error

post

/ip_filters/{id}

POST /api/ip_filters/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 63

{
  "cidr": null,
  "target": null,
  "expire_at": null,
  "description": null
}

No content

Delete an IP rule

post

Destroy a certain IP rule.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of IP rule.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

400

Invalid rule ID supplied.

post

/ip_filters/{id}/destroy

POST /api/ip_filters/{id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Export IP rules

get

Export a collection of IP rules to file.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/octet-stream

Responsestring · binary

4XX

Error

get

/ip_filters/export

GET /api/ip_filters/export HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary

List transports

get

Retrieve a collection of transports

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

filterstringOptional

Use the filter query parameter to retrieve just a subset of a collection.

searchstringOptional

Use the search query parameter to restrict the results of a request to match a search criterion.

orderbystringOptional

Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.

skipinteger · int32Optional

Use the skip query parameter to set the number of items to skip at the start of a collection.

Default: 0

topinteger · int32 · min: 1 · max: 100Optional

Use the top query parameter to specify the page size of the result set.

Default: 100

Responses

200

OK

application/json

4XX

Error

get

/transports

GET /api/transports HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 1,
  "items": [
    {
      "id": null,
      "protocol": null,
      "port": null,
      "verification": null
    }
  ]
}

Create a transport

post

Add a new transport.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

protocolstring · enumRequired

The transport protocol:
Can be either:

UDP:
TCP:
TLS:

Possible values:

portall ofRequired

The port of transport.

integer · int32 · max: 65535Optional

A port number is a 16-bit unsigned integer, thus ranging from 0 to 65535. For TCP, port number 0 is reserved and cannot be used, while for UDP, the source port is optional and a value of zero means no port

Example: 80

verificationstring · enumOptional

Indicates if PBX wishes (Optional) or requires (Mandatory) TLS clients to present a client certificate:

DISABLE: disable client certificate.
OPTIONAL: client authentication optional.
MANDATORY: force client authentication.

Possible values:

Responses

201

Created transport

application/json

4XX

Error

post

/transports

POST /api/transports HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "protocol": null,
  "port": null,
  "verification": null
}

{
  "id": "xxxxxxxx"
}

Retrieve a transport

get

Retrieve a transport by it's unique ID.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

4XX

Error

get

/transports/{id}

GET /api/transports/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": null,
  "protocol": null,
  "port": null,
  "verification": null
}

Update transport

post

Update a new transport.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of transport.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

portall ofOptional

The port of transport.

integer · int32 · max: 65535Optional

A port number is a 16-bit unsigned integer, thus ranging from 0 to 65535. For TCP, port number 0 is reserved and cannot be used, while for UDP, the source port is optional and a value of zero means no port

Example: 80

verificationstring · enumOptional

Indicates if PBX wishes (Optional) or requires (Mandatory) TLS clients to present a client certificate:

DISABLE: disable client certificate.
OPTIONAL: client authentication optional.
MANDATORY: force client authentication.

Possible values:

Responses

200

OK

No content

4XX

Error

post

/transports/{id}

POST /api/transports/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "port": null,
  "verification": null
}

No content

Destroy transport

post

Destroy transport

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of transport.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

4XX

Error

post

/transports/{id}/destroy

POST /api/transports/{id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Query transport's status

get

Query transport's status

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstring · enumRequired

The transport protocol:
Can be either:

UDP:
TCP:
TLS:

Possible values:

Responses

200

Success

application/json

4XX

Error

get

/transports/{id}/status

GET /api/transports/{id}/status HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": "ACTIVATED"
}

List tenants

get

Returns a list of tenant summary information. Note that it uses a different, smaller representation of a tenant than retrieving a single tenant.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

filterstringOptional

Use the filter query parameter to retrieve just a subset of a collection.

searchstringOptional

Use the search query parameter to restrict the results of a request to match a search criterion.

orderbystringOptional

Use the orderby query parameter to specify the sort order of the items returned from server.
The default order is ascending order.

skipinteger · int32Optional

Use the skip query parameter to set the number of items to skip at the start of a collection.

Default: 0

topinteger · int32 · min: 1 · max: 100Optional

Use the top query parameter to specify the page size of the result set.

Default: 100

Responses

200

OK

application/json

4XX

Error

get

/tenants

GET /api/tenants HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 1,
  "items": [
    {
      "id": null,
      "name": null,
      "domain": null,
      "max_extensions": 100,
      "current_extensions": 100,
      "max_concurrent_calls": null,
      "enabled": null,
      "website": null,
      "timezone": null,
      "currency": null,
      "region": null,
      "avatar_file_name": null,
      "avatar_file_size": null,
      "avatar_file_url": null,
      "created_at": null
    }
  ]
}

Create a tenant

post

Create an new tenant.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

namestring · min: 1 · max: 1024Required

The name of the tenant.

domainstring · min: 1 · max: 280Required

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.

websitestring · max: 255Optional

The official website of tenant.

timezoneall ofRequired

Timezone for tenant.

stringOptional

The IANA Time Zone names, such as "Asia/Shanghai".

currencystringRequired

The Currency code (ISO 4217).

Example: USD

regionstringRequired

A valid country code based on iso3166-1 alpha-3 standard. see: https://www.iso.org/iso-3166-country-codes.html

enabledbooleanOptional

Enable this tenant or not.

Default: true

enable_video_recordingbooleanOptional

Allow extension video recording.

Default: false

allow_password_retrievalbooleanOptional

Allow the user result api to return the user password and the user extension password.

Default: false

enable_audio_recordingbooleanOptional

Allow extension audio recording.

Default: false

enable_dual_track_recordingbooleanOptional

Allow dual track recording for calls.

Default: false

enable_billingbooleanOptional

Enable call billing or not.

Default: false

enable_feature_billingbooleanOptional

Enable call billing feature or not.

Default: false

enable_feature_call_statisticsbooleanOptional

Enable call statistics feature or not.

Default: true

enable_feature_contact_centerbooleanOptional

Enable contact center feature or not.

Default: true

enable_feature_message_channelsbooleanOptional

Enable message channels feature or not.

Default: true

enable_feature_microsoft_teamsbooleanOptional

Enable Microsoft Teams feature or not.

Default: true

enable_feature_trunksbooleanOptional

Enable trunks feature or not.

Default: true

enable_feature_whats_appbooleanOptional

Enable WhatsApp feature or not.

Default: true

enable_feature_ai_transcriptionbooleanOptional

Enable AI transcription feature or not.

Default: true

enable_feature_crmbooleanOptional

Enable CRM integrations feature or not.

Default: true

enable_night_modebooleanOptional

Whether to enable night mode.

Default: false

enable_two_factor_authenticationbooleanOptional

Whether to enable two-factor authentication.

Default: false

custom_optionsstringOptional

Some custom configuration options serialized as json string

max_extensionsinteger · int32Optional

The maximum number of users that the tenant is allowed to create.

Default: 1000

max_concurrent_callsinteger · int32Optional

The maximum number of concurrent calls that the tenant is allowed to have.

Default: 20

max_ring_groupsinteger · int32Optional

The maximum number of ring groups that the tenant is allowed to create.

Default: 20

max_virtual_receptionistsinteger · int32Optional

The maximum number of virtual receptionists that the tenant is allowed to create.

Default: 20

max_call_queuesinteger · int32Optional

The maximum number of call queues that the tenant is allowed to create.

Default: 20

max_conference_roomsinteger · int32Optional

The maximum number of conference rooms that the tenant is allowed to be online at the same time.

Default: 20

disk_quotastringOptional

The maximum size of disk space that the tenant is allowed to have.
Specify a positive number and specify the unit at the same time, KB, MB, GB, PB are all allowed.
For example: 100MB, 1000GB. Leave it empty, means unlimited.

Default: ""

im_disk_quotastringOptional

The maximum size of disk space that the tenant is allowed to have for IM service.
Specify a positive number and specify the unit at the same time, KB, MB, GB, PB are all allowed.
For example: 100MB, 1000GB. Leave it empty, means unlimited.

Default: ""

extension_im_disk_quotastringOptional

The maximum size of disk space that the extension user is allowed to have for IM service.
Specify a positive number and specify the unit at the same time, KB, MB, GB, PB are all allowed.
For example: 100MB, 1000GB. Leave it empty, means unlimited.

Default: 1GB

recording_retentioninteger · int32 · min: 1Optional

The retention period in days of recordings.

Default: 180

call_report_retentioninteger · min: 1Optional

The retention period in days of call report files.

Default: 30

log_retentioninteger · min: 1Optional

The retention period in days of audit logs and event logs.

Default: 180

temp_file_retentioninteger · min: 1Optional

The retention period in days of temporary files.

Default: 30

contact_match_typestring · enumOptional

The match method of contact:
Can be either:

DISABLE: Disable match.
MATCH_EXACTLY: Match exactly.
MATCH_LENGTH: Match at least specified number of characters.

Default: MATCH_EXACTLYPossible values:

contact_match_lengthinteger · int32Optional

The matched length of characters when contact_match_type is MATCH_LENGTH.

contact_append_typestring · enumOptional

Method for adding Group, Queue or DID/DDI Names to Caller ID:
Can be either:

DISABLE: Do not add.
APPEND: Append names.
PREPEND: Prepend names.

Default: APPENDPossible values:

contact_inbound_rule_append_typestring · enumOptional

Method for adding Group, Queue or DID/DDI Names to Caller ID:
Can be either:

DISABLE: Do not add.
APPEND: Append names.
PREPEND: Prepend names.

Default: APPENDPossible values:

contact_update_intervalinteger · uint32 · min: 1 · max: 43200Optional

The interval for synchronizing contacts from the server, in minutes.

Default: 720

email_recipientsstringOptional

Comma-separated list of email address that should receive notifications.
Allow up to 15 email addresses.

password_force_resetbooleanOptional

Whether to force reset the initial password.

Default: false

Responses

201

Created

application/json

4XX

Error

post

/tenants

POST /api/tenants HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1174

{
  "name": null,
  "domain": null,
  "website": null,
  "timezone": null,
  "currency": null,
  "region": null,
  "enabled": null,
  "enable_video_recording": null,
  "ai_engine": null,
  "enable_audio_recording": null,
  "enable_dual_track_recording": null,
  "enable_billing": null,
  "enable_feature_billing": null,
  "enable_feature_call_statistics": null,
  "enable_feature_contact_center": null,
  "enable_feature_message_channels": null,
  "enable_feature_microsoft_teams": null,
  "enable_feature_trunks": null,
  "enable_feature_whats_app": null,
  "enable_night_mode": null,
  "enable_two_factor_authentication": null,
  "custom_options": null,
  "max_extensions": null,
  "max_concurrent_calls": null,
  "max_ring_groups": null,
  "max_virtual_receptionists": null,
  "max_call_queues": null,
  "max_conference_rooms": null,
  "disk_quota": null,
  "im_disk_quota": null,
  "extension_im_disk_quota": null,
  "recording_retention": null,
  "call_report_retention": null,
  "log_retention": null,
  "temp_file_retention": null,
  "office_hours": null,
  "e164": null,
  "cdr_event": null,
  "extension_event": null,
  "contact_match_type": null,
  "contact_match_length": null,
  "contact_append_type": null,
  "contact_inbound_rule_append_type": null,
  "contact_update_interval": null,
  "email_recipients": null,
  "password_force_reset": null
}

{
  "id": "xxxxxxxx"
}

Retrieve a tenant

get

Get detailed properties for a tenant.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of tenant.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

4XX

Error

get

/tenants/{id}

GET /api/tenants/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": null,
  "name": null,
  "domain": null,
  "website": null,
  "timezone": null,
  "currency": null,
  "region": null,
  "enabled": null,
  "enable_video_recording": null,
  "ai_engine": null,
  "enable_audio_recording": null,
  "enable_dual_track_recording": null,
  "enable_billing": null,
  "enable_feature_billing": null,
  "enable_feature_call_statistics": null,
  "enable_feature_contact_center": null,
  "enable_feature_message_channels": null,
  "enable_feature_microsoft_teams": null,
  "enable_feature_trunks": null,
  "enable_feature_whats_app": null,
  "enable_night_mode": null,
  "enable_two_factor_authentication": null,
  "custom_options": null,
  "max_extensions": null,
  "max_concurrent_calls": null,
  "max_ring_groups": null,
  "max_virtual_receptionists": null,
  "max_call_queues": null,
  "max_conference_rooms": null,
  "disk_quota": null,
  "used_disk_quota": null,
  "im_disk_quota": null,
  "extension_im_disk_quota": null,
  "recording_retention": null,
  "call_report_retention": null,
  "log_retention": null,
  "temp_file_retention": null,
  "office_hours": null,
  "outbound_caller_ids": null,
  "e164": null,
  "cdr_event": null,
  "extension_event": null,
  "contact_match_type": null,
  "contact_match_length": null,
  "contact_append_type": null,
  "contact_inbound_rule_append_type": null,
  "contact_update_interval": null,
  "email_recipients": null,
  "password_force_reset": null,
  "created_at": null,
  "avatar_file_name": null,
  "avatar_file_size": null,
  "avatar_file_url": null
}

Update a tenant

post

Update tenant properties by it's unique ID.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of tenant.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

namestring · min: 1 · max: 1024Optional

The name of the tenant.

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.

websitestring · max: 255Optional

The official website of tenant.

timezoneall ofOptional

Timezone for tenant.

stringOptional

The IANA Time Zone names, such as "Asia/Shanghai".

currencystringOptional

The Currency code (ISO 4217).

Example: USD

regionstringOptional

A valid country code based on iso3166-1 alpha-3 standard. see: https://www.iso.org/iso-3166-country-codes.html

enabledbooleanOptional

Enable this tenant or not.

Default: true

enable_video_recordingbooleanOptional

Allow extension video recording.

Default: false

enable_audio_recordingbooleanOptional

Allow extension audio recording.

Default: false

enable_dual_track_recordingbooleanOptional

Allow dual track recording for calls.

Default: false

enable_billingbooleanOptional

Enable call billing or not.

Default: false

enable_feature_billingbooleanOptional

Enable call billing feature or not.

Default: false

allow_password_retrievalbooleanOptional

Allow the user result api to return the user password and the user extension password.

Default: false

enable_feature_call_statisticsbooleanOptional

Enable call statistics feature or not.

Default: true

enable_feature_contact_centerbooleanOptional

Enable contact center feature or not.

Default: true

enable_feature_message_channelsbooleanOptional

Enable message channels feature or not.

Default: true

enable_feature_microsoft_teamsbooleanOptional

Enable Microsoft Teams feature or not.

Default: true

enable_feature_trunksbooleanOptional

Enable trunks feature or not.

Default: true

enable_feature_whats_appbooleanOptional

Enable WhatsApp feature or not.

Default: true

enable_feature_ai_transcriptionbooleanOptional

Enable AI transcription feature or not.

Default: true

enable_feature_crmbooleanOptional

Enable CRM integrations feature or not.

Default: true

enable_night_modebooleanOptional

Whether to enable night mode.

Default: false

enable_two_factor_authenticationbooleanOptional

Whether to enable two-factor authentication.

Default: false

custom_optionsstringOptional

Some custom configuration options serialized as json string

max_extensionsinteger · int32Optional

The maximum number of users that the tenant is allowed to create.

Default: 1000

max_concurrent_callsinteger · int32Optional

The maximum number of concurrent calls that the tenant is allowed to have.

Default: 20

max_ring_groupsinteger · int32Optional

The maximum number of ring groups that the tenant is allowed to create.

Default: 20

max_virtual_receptionistsinteger · int32Optional

The maximum number of virtual receptionists that the tenant is allowed to create.

Default: 20

max_call_queuesinteger · int32Optional

The maximum number of call queues that the tenant is allowed to create.

Default: 20

max_conference_roomsinteger · int32Optional

The maximum number of conference rooms that the tenant is allowed to be online at the same time.

Default: 20

disk_quotastringOptional

The maximum size of disk space that the tenant is allowed to have.
Specify a positive number and specify the unit at the same time, KB, MB, GB, PB are all allowed.
For example: 100MB, 1000GB. Leave it empty, means unlimited.

Default: ""

im_disk_quotastringOptional

The maximum size of disk space that the tenant is allowed to have for IM service.
Specify a positive number and specify the unit at the same time, KB, MB, GB, PB are all allowed.
For example: 100MB, 1000GB. Leave it empty, means unlimited.

Default: ""

extension_im_disk_quotastringOptional

The maximum size of disk space that the extension user is allowed to have for IM service.
Specify a positive number and specify the unit at the same time, KB, MB, GB, PB are all allowed.
For example: 100MB, 1000GB. Leave it empty, means unlimited.

Default: 1GB

recording_retentioninteger · int32 · min: 1Optional

The retention period in days of recordings.

Default: 180

call_report_retentioninteger · min: 1Optional

The retention period in days of call report files.

Default: 30

log_retentioninteger · min: 1Optional

The retention period in days of audit logs and event logs.

Default: 180

temp_file_retentioninteger · min: 1Optional

The retention period in days of temporary files.

Default: 30

contact_match_typestring · enumOptional

The match method of contact:
Can be either:

DISABLE: Disable match.
MATCH_EXACTLY: Match exactly.
MATCH_LENGTH: Match at least specified number of characters.

Default: MATCH_EXACTLYPossible values:

contact_match_lengthinteger · int32Optional

The matched length of characters when contact_match_type is MATCH_LENGTH.

contact_append_typestring · enumOptional

Method for adding Group, Queue or DID/DDI Names to Caller ID:
Can be either:

DISABLE: Do not add.
APPEND: Append names.
PREPEND: Prepend names.

Default: APPENDPossible values:

contact_inbound_rule_append_typestring · enumOptional

Method for adding Group, Queue or DID/DDI Names to Caller ID:
Can be either:

DISABLE: Do not add.
APPEND: Append names.
PREPEND: Prepend names.

Default: APPENDPossible values:

contact_update_intervalinteger · uint32 · min: 1 · max: 43200Optional

The interval for synchronizing contacts from the server, in minutes.

Default: 720

email_recipientsstringOptional

Comma-separated list of email address that should receive notifications.
Allow up to 15 email addresses.

password_force_resetbooleanOptional

Whether to force reset the initial password.

Default: false

Responses

200

OK

No content

4XX

Error

post

/tenants/{id}

POST /api/tenants/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1174

{
  "name": null,
  "domain": null,
  "website": null,
  "timezone": null,
  "currency": null,
  "region": null,
  "enabled": null,
  "enable_video_recording": null,
  "ai_engine": null,
  "enable_audio_recording": null,
  "enable_dual_track_recording": null,
  "enable_billing": null,
  "enable_feature_billing": null,
  "enable_feature_call_statistics": null,
  "enable_feature_contact_center": null,
  "enable_feature_message_channels": null,
  "enable_feature_microsoft_teams": null,
  "enable_feature_trunks": null,
  "enable_feature_whats_app": null,
  "enable_night_mode": null,
  "enable_two_factor_authentication": null,
  "custom_options": null,
  "max_extensions": null,
  "max_concurrent_calls": null,
  "max_ring_groups": null,
  "max_virtual_receptionists": null,
  "max_call_queues": null,
  "max_conference_rooms": null,
  "disk_quota": null,
  "im_disk_quota": null,
  "extension_im_disk_quota": null,
  "recording_retention": null,
  "call_report_retention": null,
  "log_retention": null,
  "temp_file_retention": null,
  "office_hours": null,
  "e164": null,
  "cdr_event": null,
  "extension_event": null,
  "contact_match_type": null,
  "contact_match_length": null,
  "contact_append_type": null,
  "contact_inbound_rule_append_type": null,
  "contact_update_interval": null,
  "email_recipients": null,
  "password_force_reset": null
}

No content

Switch between tenants

post

Switch between tenants.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

idall ofOptional

The unique ID of tenant.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

No content

4XX

Error

post

/tenants/switch

POST /api/tenants/switch HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Retrieve dealer information the tenant belongs

get

Get the dealer to which the tenant belongs.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of tenant.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

4XX

Error

get

/tenants/{id}/dealers

GET /api/tenants/{id}/dealers HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": null,
      "enabled": null,
      "level": null,
      "name": null,
      "display_name": null
    }
  ]
}

Designate tenant to dealer

post

Designate tenant to dealer.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of tenant.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

dealer_idall ofRequired

The unique ID of dealer.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

No content

4XX

Error

post

/tenants/{id}/dealers/{dealer_id}

POST /api/tenants/{id}/dealers/{dealer_id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Remove tenant to dealer

post

Remove tenant from dealer.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of tenant.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

dealer_idall ofRequired

The unique ID of dealer.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

4XX

Error

post

/tenants/{id}/dealers/{dealer_id}/destroy

POST /api/tenants/{id}/dealers/{dealer_id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Delete a tenant

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of tenant.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

400

Invalid name supplied

404

Tenant not found

post

/tenants/{id}/destroy

POST /api/tenants/{id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Retrieve license information

get

Retrieve license information

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

get

/license

GET /api/license HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "api_version": null,
  "product_name": null,
  "max_sim_calls": null,
  "license_key": null,
  "company_name": null,
  "contact_email": null
}

Update license

post

Update license

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

license_keystringRequired

License key of PortSIP PBX.

Responses

200

OK

No content

4XX

Error

post

/license

POST /api/license HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "license_key": "xxxxxxxxxxxxxxxxxxxxx"
}

No content

Show certificate key

get

Retrieve content of certificate key.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

get

/key

GET /api/key HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "crt": null,
  "key": null
}

Update certificate key

post

Update certificate key.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

crtstringRequired

Content of this certificate file for TLS or WSS transport protocol. The certificate file MUST be PEM-encoded with X.509.

keystringRequired

Content of this private certificate file for TLS or WSS transport protocol.

Responses

204

No Content

4XX

Error

post

/key

POST /api/key HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "crt": null,
  "key": null
}

No content

Update brand information

post

Update brand information.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

themestring · enumOptional

The color scheme:
Can be either:

BLUE: Blue
DARK: Dark
GREEN: Green
LIGHT_BLUE: Light Blue
PURPLE: Purple

Possible values:

logoall ofOptional

The unique ID of file from your file library.
This file will be used as the logo image.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

faviconall ofOptional

The unique ID of file from your file library.
This file will be used as the favicon image.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

titlestringOptional

The title text.
This text will be displayed as the title.

copyrightstringOptional

The copyright text.
This text will be displayed as the copyright.

productstringOptional

The product name text.
This text will be displayed as the product name.

websitestringOptional

The website text.
This text will be displayed as the product website.

forumstringOptional

The forum url.
This text will be displayed as the forum url.

bottom_textstringOptional

The bottom text, maximum size is 256 characters. This text will be displayed at the bottom of the login page. It can be either plain text or HTML code.

Responses

200

OK

No content

4XX

Error

post

/brand

POST /api/brand HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 135

{
  "theme": "BLUE",
  "logo": null,
  "favicon": null,
  "title": null,
  "copyright": null,
  "product": null,
  "website": null,
  "forum": null,
  "bottom_text": null
}

No content

Retrieve current dealer

get

Get details of current dealer.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

get

/dealer

GET /api/dealer HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": null,
  "enabled": null,
  "level": null,
  "name": null,
  "email": null,
  "display_name": null,
  "website": null,
  "phone": null,
  "address": null,
  "description": null,
  "max_tenants": null,
  "max_extensions": null
}

Update current dealer

post

Modify the settings of the current dealer.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

emailall ofOptional

The email address of user.

string · max: 128Optional

The email address.

Example: [email protected]

display_namestring · max: 1024Optional

The display name of user.

websitestringOptional

The website of user.

phonestring · max: 32Optional

The mobile phone number of user.

addressstring · max: 128Optional

The address.

descriptionstringOptional

The description of dealer.

Responses

200

OK

No content

4XX

Error

post

/dealer

POST /api/dealer HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 96

{
  "email": null,
  "display_name": null,
  "website": null,
  "phone": null,
  "address": null,
  "description": null
}

No content

Retrieve current dealer status

get

Get status of current dealer.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

get

/dealer/status

GET /api/dealer/status HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "version": null,
  "max_dealers": null,
  "current_dealers": null,
  "max_users": null,
  "current_users": null,
  "max_tenants": null,
  "current_tenants": null
}

Change current dealer username

post

Change current dealer username.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

namestring · 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.

Responses

200

OK

No content

4XX

Error

post

/dealer/username

POST /api/dealer/username HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 13

{
  "name": null
}

No content

Reset current dealer password

post

Reset current dealer password.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

old_passwordstringOptional

The password of dealer.

new_passwordstringOptional

The password of dealer.

Responses

200

OK

No content

4XX

Error

post

/dealer/password

POST /api/dealer/password HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "old_password": null,
  "new_password": null
}

No content

List provider assignees

get

Get a collection of assignees of provider.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of trunk.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

4XX

Error

get

/providers/{id}/assignees

GET /api/providers/{id}/assignees HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "tenant_id": null,
      "did_numbers": null,
      "concurrency": null
    }
  ]
}

Check provider assignee

get

Check if a provider is assigned to the tenant.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of trunk.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

tenant_idall ofRequired

The unique ID of tenant.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

404

Not Found

get

/providers/{id}/assignees/{tenant_id}

GET /api/providers/{id}/assignees/{tenant_id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "did_numbers": null,
  "concurrency": null
}

Assign provider

post

Assign provider to tenant.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of trunk.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

tenant_idall ofRequired

The unique ID of tenant.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Body

did_numbersstringOptional

The semicolon-separated list of DID/DDI pool number range or DID/DDI number. Assign a DID/DDI pool number range or DID/DDI number to the tenant. For example: 3000;12000-18000. The DID/DDI pool number range should not overlap with other tenant DID/DDI pool number ranges and numbers.

concurrencyinteger · int32Optional

The max number of concurrent calls.

Responses

204

No Content

4XX

Error

post

/providers/{id}/assignees/{tenant_id}

POST /api/providers/{id}/assignees/{tenant_id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "did_numbers": null,
  "concurrency": null
}

No content

Destroy a provider assignee

post

Unassign provider from tenant.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of trunk.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

tenant_idall ofRequired

The unique ID of tenant.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

204

No Content

4XX

Error

post

/providers/{id}/assignees/{tenant_id}/destroy

POST /api/providers/{id}/assignees/{tenant_id}/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get server

get

Retrieve settings of data flow server.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

get

/dataflow

GET /api/dataflow HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "private_ipv4": null,
  "private_ipv6": null,
  "public_ipv4": null,
  "public_ipv6": null
}

Update server

post

Update data flow server configurations.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

private_ipv4stringOptional

Host IPV4 address.

private_ipv6stringOptional

Host IPV6 address.

public_ipv4stringOptional

Host IPV4 address.

public_ipv6stringOptional

Host IPV6 address.

Responses

200

OK

No content

4XX

Error

post

/dataflow

POST /api/dataflow HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 79

{
  "private_ipv4": null,
  "private_ipv6": null,
  "public_ipv4": null,
  "public_ipv6": null
}

No content

Get Server token

get

Retrieve data flow server token

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

get

/dataflow/token

GET /api/dataflow/token HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "token": "xxxxxxxxxxxxxxxxxxxxxx"
}

Regenerate server token

post

Regenerate data flow server token

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

4XX

Error

post

/dataflow/token

POST /api/dataflow/token HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "token": "xxxxxxxxxxxxxxxxx"
}

Delete server Token

post

Destroy data flow server Token.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

204

No Content

4XX

Error

post

/dataflow/token/destroy

POST /api/dataflow/token/destroy HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content