Administrations

Manage PBX System.

Retrieve network configurations

get

Get network configurations.

Authorizations
Responses
200
OK
application/json
get
GET /api/network HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Update network configurations

post

Update network configurations for PortSIP PBX.

Authorizations
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
post
POST /api/network HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 184

{
  "web_domain": "text",
  "private_ipv4": "text",
  "public_ipv4": "text",
  "enable_ipv6": true,
  "private_ipv6": "text",
  "public_ipv6": "text",
  "primary_dns_server": "text",
  "secondary_dns_server": "text"
}
No content

Retrieve current system status

get

Get current status of system.

Authorizations
Responses
200
OK
application/json
get
GET /api/admin/status HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "version": "text",
  "news": "text",
  "license_key": "text",
  "license_type": "text",
  "maintenance_expires_at": "2017-07-21T17:32:28Z",
  "max_concurrent_calls": 1,
  "licensed_users": 1,
  "current_users": 1,
  "online_users": 1,
  "current_tenants": 1,
  "current_dealers": 1,
  "current_calls": 1,
  "current_trunks": 1,
  "current_conference_servers": 1,
  "current_media_servers": 1,
  "current_call_queue_servers": 1,
  "current_ivr_servers": 1,
  "calls_in_24_hours": [
    {
      "time": "2017-07-21T17:32:28Z",
      "count": 1
    }
  ]
}

Change system admin username

post

Change system admin username.

Authorizations
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
post
POST /api/admin/username HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}
No content

Reset system admin password

post

Reset system admin password.

Authorizations
Body
old_passwordall ofRequired

The old password of system admin.

stringOptional

The password of system admin.

new_passwordall ofRequired

The new password pf system admin.

stringOptional

The password of system admin.

Responses
200
OK
post
POST /api/admin/password HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "old_password": "text",
  "new_password": "text"
}
No content

Retrieve system settings

get

Retrieve settings for PortSIP PBX.

Authorizations
Responses
200
OK
application/json
get
GET /api/admin/settings HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "user_agent": "PortSIP UC",
  "blocked_user_agents": "text",
  "enable_shared_address_space_address_range": true,
  "enable_digest_auth": true,
  "enable_auth_mid_dialog": false,
  "enable_digest_auth_int": false,
  "enable_external_recording": true,
  "enable_reject_bad_nonce": false,
  "statistics_log_interval": 600,
  "dead_session_timeout": 600,
  "enable_session_timer": true,
  "session_timer_duration": 3600,
  "enable_to_tag_in_register": false,
  "enable_congestion_management": true,
  "congestion_management_metric": "WAIT_TIME",
  "congestion_management_tolerance": 600,
  "enable_create_non_exist_extension": false,
  "enable_prack": false,
  "enable_tenant_level_trunk": true,
  "enable_diversion_support": false,
  "enable_history_info_support": false,
  "enable_outbound_support": true,
  "flow_timer": 0,
  "register_expiration_time": 300,
  "enable_auto_answer_alert_info_header": false,
  "auto_answer_alert_info_header": "INTERCOM",
  "enable_auto_answer_call_info_header": true,
  "enable_require_answer_mode": false,
  "enable_www_auth": false,
  "user_equal_required_for_auth_name": true,
  "trace_server_host": "text",
  "trace_server_port": 80,
  "web_failed_auth_amount": 5,
  "web_blacklist_time_interval": 3600,
  "sip_failed_auth_amount": 50,
  "sip_failed_challenge_requests_amount": 1000,
  "sip_blacklist_time_interval": 3600,
  "sip_detection_period": 10,
  "sip_barrier_1_packets": 5000,
  "sip_barrier_1_blocking_time": 3600,
  "sip_barrier_2_packets": 2000,
  "sip_barrier_2_blocking_time": 30,
  "stir_shaken_cert": "text",
  "stir_shaken_key": "text",
  "custom_options": "text"
}

Update system settings

post

Update settings for PortSIP PBX

Authorizations
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
post
POST /api/admin/settings HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1443

{
  "user_agent": "PortSIP UC",
  "blocked_user_agents": "text",
  "enable_shared_address_space_address_range": true,
  "enable_digest_auth": true,
  "enable_auth_mid_dialog": false,
  "enable_digest_auth_int": false,
  "enable_external_recording": true,
  "enable_reject_bad_nonce": false,
  "statistics_log_interval": 600,
  "dead_session_timeout": 600,
  "enable_session_timer": true,
  "session_timer_duration": 3600,
  "enable_to_tag_in_register": false,
  "enable_congestion_management": true,
  "congestion_management_metric": "WAIT_TIME",
  "congestion_management_tolerance": 600,
  "enable_create_non_exist_extension": false,
  "enable_prack": false,
  "enable_tenant_level_trunk": true,
  "enable_diversion_support": false,
  "enable_history_info_support": false,
  "enable_outbound_support": true,
  "flow_timer": 0,
  "register_expiration_time": 300,
  "enable_auto_answer_alert_info_header": false,
  "auto_answer_alert_info_header": "INTERCOM",
  "enable_auto_answer_call_info_header": true,
  "enable_require_answer_mode": false,
  "enable_www_auth": false,
  "user_equal_required_for_auth_name": true,
  "trace_server_host": "text",
  "trace_server_port": 80,
  "web_failed_auth_amount": 5,
  "web_blacklist_time_interval": 3600,
  "sip_failed_auth_amount": 50,
  "sip_failed_challenge_requests_amount": 1000,
  "sip_blacklist_time_interval": 3600,
  "sip_detection_period": 10,
  "sip_barrier_1_packets": 5000,
  "sip_barrier_1_blocking_time": 3600,
  "sip_barrier_2_packets": 2000,
  "sip_barrier_2_blocking_time": 30,
  "stir_shaken_cert": "text",
  "stir_shaken_key": "text",
  "custom_options": "text"
}
No content

Retrieve system notification settings

get

Retrieve details of system notification settings.

Authorizations
Responses
200
OK
application/json
get
GET /api/admin/notification HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "type": "SMTP",
  "server": "text",
  "port": 80,
  "reply_to": "text",
  "username": "text",
  "auth": "AUTO",
  "enable_tls_ssl": true,
  "enable_starttls_auto": false,
  "recipients": "text",
  "enable_tenant_access": true,
  "hard_disk_threshold": 0.9,
  "notify_hard_disk_exceeded_threshold": false,
  "cpu_threshold": 0.9,
  "notify_cpu_exceeded_threshold": false,
  "memory_threshold": 0.9,
  "notify_memory_exceeded_threshold": false,
  "notify_ip_blocked": false,
  "notify_license_limited": false,
  "notify_service_disconnected": false,
  "notify_push_certs_update_failed": false
}

Update system notification settings

post

Update system notification settings.

Authorizations
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
post
POST /api/admin/notification HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 533

{
  "type": "SMTP",
  "server": "text",
  "port": 80,
  "reply_to": "text",
  "username": "text",
  "password": "text",
  "auth": "AUTO",
  "enable_tls_ssl": true,
  "enable_starttls_auto": false,
  "recipients": "text",
  "enable_tenant_access": true,
  "hard_disk_threshold": 0.9,
  "notify_hard_disk_exceeded_threshold": false,
  "cpu_threshold": 0.9,
  "notify_cpu_exceeded_threshold": false,
  "memory_threshold": 0.9,
  "notify_memory_exceeded_threshold": false,
  "notify_ip_blocked": false,
  "notify_license_limited": false,
  "notify_service_disconnected": false,
  "notify_push_certs_update_failed": false
}
No content

Test email

post

Check email server configurations by sending testing email.

Authorizations
Body
recipientstringRequired

The recipient's e-mail address.

subjectstringRequired

Mail subject.

contentstringRequired

Mail content.

Responses
200
OK
post
POST /api/admin/notification/test_email HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 54

{
  "recipient": "text",
  "subject": "text",
  "content": "text"
}
No content

Retrieve SBC configuration

get

Retrieve settings for SBC.

Authorizations
Responses
200
OK
application/json
get
GET /api/sbc HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "domain": "text",
  "http_port": 8882,
  "https_port": 8883,
  "transports": [
    {
      "protocol": "UDP",
      "port": 80
    }
  ]
}

Update SBC configuration

post

Update SBC configuration.

Authorizations
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
post
POST /api/sbc HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 96

{
  "domain": "text",
  "http_port": 8882,
  "https_port": 8883,
  "transports": [
    {
      "protocol": "UDP",
      "port": 80
    }
  ]
}
No content

Retrieve SBC token

get

Retrieve SBC token

Authorizations
Responses
200
OK
application/json
get
GET /api/sbc/token HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "token": "text"
}

Regenerate SBC token

post

Regenerate SBC token

Authorizations
Responses
200
OK
application/json
post
POST /api/sbc/token HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "token": "text"
}

Destroy SBC Token

post

Destroy SBC Token.

Authorizations
Responses
204
No Content
post
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
Responses
200
OK
application/json
get
GET /api/im HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Update IM server configuration

post

Update IM server configuration.

Authorizations
Body
private_ipv4stringOptional

Host IPV4 address.

private_ipv6stringOptional

Host IPV6 address.

public_ipv4stringOptional

Host IPV4 address.

public_ipv6stringOptional

Host IPV6 address.

Responses
200
OK
post
POST /api/im HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 87

{
  "private_ipv4": "text",
  "private_ipv6": "text",
  "public_ipv4": "text",
  "public_ipv6": "text"
}
No content

Retrieve IM Server token

get

Retrieve IM server token

Authorizations
Responses
200
OK
application/json
get
GET /api/im/token HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "token": "text"
}

Regenerate IM server token

post

Regenerate IM server token

Authorizations
Responses
200
OK
application/json
post
POST /api/im/token HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "token": "text"
}

Destroy IM server Token

post

Destroy IM server Token.

Authorizations
Responses
204
No Content
post
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
Responses
200
OK
application/json
get
GET /api/dealers HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 100,
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "enabled": true,
      "level": "DISTRIBUTOR",
      "name": "text",
      "email": "[email protected]",
      "display_name": "text",
      "website": "text",
      "phone": "text",
      "address": "text",
      "description": "text",
      "max_tenants": 100,
      "max_extensions": 50000,
      "tenant_full_access": true
    }
  ]
}

Create a dealer

post

Create a dealer.

Authorizations
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
post
POST /api/dealers HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 259

{
  "enabled": true,
  "level": "DISTRIBUTOR",
  "name": "text",
  "password": "text",
  "email": "[email protected]",
  "display_name": "text",
  "website": "text",
  "phone": "text",
  "address": "text",
  "description": "text",
  "max_tenants": 100,
  "max_extensions": 50000,
  "tenant_full_access": true
}
{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Retrieve a dealer

get

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

Authorizations
Path parameters
idall ofRequired

The unique ID of dealer.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200
OK
application/json
get
GET /api/dealers/{id} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "enabled": true,
  "level": "DISTRIBUTOR",
  "name": "text",
  "email": "[email protected]",
  "display_name": "text",
  "website": "text",
  "phone": "text",
  "address": "text",
  "description": "text",
  "max_tenants": 100,
  "max_extensions": 50000,
  "tenant_full_access": true
}

Update a dealer

post

Modify the settings of the dealer.

Authorizations
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
post
POST /api/dealers/{id} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 205

{
  "enabled": true,
  "email": "[email protected]",
  "display_name": "text",
  "website": "text",
  "phone": "text",
  "address": "text",
  "description": "text",
  "max_tenants": 100,
  "max_extensions": 50000,
  "tenant_full_access": true
}
No content

Reset dealer password

post

Reset dealer's password.

Authorizations
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
post
POST /api/dealers/{id}/password HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "password": "text"
}
No content

Delete a dealer

post

Delete a dealer by it's unique ID.

Authorizations
Path parameters
idall ofRequired

The unique ID of dealer.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
204
No Content
post
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
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
get
GET /api/ip_filters HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 100,
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "cidr": "text",
      "target": "ACCEPT",
      "expire_at": "2017-07-21T17:32:28Z",
      "description": "text"
    }
  ]
}

Create an IP rule

post

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

Authorizations
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
post
POST /api/ip_filters HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 89

{
  "cidr": "text",
  "target": "ACCEPT",
  "expire_at": "2017-07-21T17:32:28Z",
  "description": "text"
}
{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Retrieve an IP rule

get

Retrieve IP blacklist entry or whitelist entry.

Authorizations
Path parameters
idall ofRequired

The unique ID of IP rule.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200
OK
application/json
get
GET /api/ip_filters/{id} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "cidr": "text",
  "target": "ACCEPT",
  "expire_at": "2017-07-21T17:32:28Z",
  "description": "text"
}

Update an IP rule

post

Update IP blacklist entry or whitelist entry that already exists.

Authorizations
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
post
POST /api/ip_filters/{id} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 89

{
  "cidr": "text",
  "target": "ACCEPT",
  "expire_at": "2017-07-21T17:32:28Z",
  "description": "text"
}
No content

Delete an IP rule

post

Destroy a certain IP rule.

Authorizations
Path parameters
idall ofRequired

The unique ID of IP rule.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
204
No Content
post
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
Responses
200
OK
application/octet-stream
Responsestring · binary
get
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
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
get
GET /api/transports HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 100,
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "protocol": "UDP",
      "port": 80,
      "verification": "DISABLE"
    }
  ]
}

Create a transport

post

Add a new transport.

Authorizations
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
post
POST /api/transports HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "protocol": "UDP",
  "port": 80,
  "verification": "DISABLE"
}
{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Retrieve a transport

get

Retrieve a transport by it's unique ID.

Authorizations
Path parameters
idstringRequired

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200
OK
application/json
get
GET /api/transports/{id} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "protocol": "UDP",
  "port": 80,
  "verification": "DISABLE"
}

Update transport

post

Update a new transport.

Authorizations
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
post
POST /api/transports/{id} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "port": 80,
  "verification": "DISABLE"
}
No content

Destroy transport

post

Destroy transport

Authorizations
Path parameters
idall ofRequired

The unique ID of transport.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
204
No Content
post
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
Path parameters
idstring · enumRequired

The transport protocol:
Can be either:

  • UDP:
  • TCP:
  • TLS:
Possible values:
Responses
200
Success
application/json
get
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
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
get
GET /api/tenants HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 100,
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "name": "text",
      "domain": "text",
      "max_extensions": 1000,
      "max_concurrent_calls": 20,
      "enabled": true,
      "website": "text",
      "timezone": "text",
      "currency": "USD",
      "region": "text",
      "avatar_file_name": "text",
      "avatar_file_size": 0,
      "avatar_file_url": "/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK",
      "created_at": "2017-07-21T17:32:28Z"
    }
  ]
}

Create a tenant

post

Create an new tenant.

Authorizations
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
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_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_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
post
POST /api/tenants HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2015

{
  "name": "text",
  "domain": "text",
  "website": "text",
  "timezone": "text",
  "currency": "USD",
  "region": "text",
  "enabled": true,
  "enable_video_recording": false,
  "enable_audio_recording": false,
  "enable_dual_track_recording": false,
  "enable_billing": false,
  "enable_feature_billing": false,
  "enable_feature_call_statistics": true,
  "enable_feature_contact_center": true,
  "enable_feature_message_channels": true,
  "enable_feature_microsoft_teams": true,
  "enable_feature_trunks": true,
  "enable_feature_whats_app": true,
  "enable_night_mode": false,
  "enable_two_factor_authentication": false,
  "custom_options": "text",
  "max_extensions": 1000,
  "max_concurrent_calls": 20,
  "max_ring_groups": 20,
  "max_virtual_receptionists": 20,
  "max_call_queues": 20,
  "max_conference_rooms": 20,
  "disk_quota": "",
  "im_disk_quota": "",
  "extension_im_disk_quota": "1GB",
  "recording_retention": 180,
  "call_report_retention": 30,
  "log_retention": 180,
  "temp_file_retention": 30,
  "office_hours": {
    "monday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "tuesday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "wednesday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "thursday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "friday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "saturday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "sunday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    }
  },
  "e164": {
    "enabled": false,
    "international_code": "text",
    "country": "Angola(244)",
    "area_code": "text",
    "national_code": "text",
    "prefix": "text",
    "remove_special_chars": false,
    "remove_duplicate_countries": true,
    "remove_duplicate_area_codes": true
  },
  "cdr_event": {
    "enabled": false,
    "auth": "DISABLE",
    "username": "text",
    "password": "text",
    "token": "text",
    "url": "text"
  },
  "extension_event": {
    "enabled": false,
    "auth": "DISABLE",
    "username": "text",
    "password": "text",
    "token": "text",
    "url": "text"
  },
  "contact_match_type": "MATCH_EXACTLY",
  "contact_match_length": 1,
  "contact_append_type": "APPEND",
  "contact_update_interval": 720,
  "email_recipients": "text",
  "password_force_reset": false
}
{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Retrieve a tenant

get

Get detailed properties for a tenant.

Authorizations
Path parameters
idall ofRequired

The unique ID of tenant.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200
OK
application/json
get
GET /api/tenants/{id} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "name": "text",
  "domain": "text",
  "website": "text",
  "timezone": "text",
  "currency": "USD",
  "region": "text",
  "enabled": true,
  "enable_video_recording": false,
  "enable_audio_recording": false,
  "enable_dual_track_recording": false,
  "enable_billing": false,
  "enable_feature_billing": false,
  "enable_feature_call_statistics": true,
  "enable_feature_contact_center": true,
  "enable_feature_message_channels": true,
  "enable_feature_microsoft_teams": true,
  "enable_feature_trunks": true,
  "enable_feature_whats_app": true,
  "enable_night_mode": false,
  "enable_two_factor_authentication": false,
  "custom_options": "text",
  "max_extensions": 1000,
  "max_concurrent_calls": 20,
  "max_ring_groups": 20,
  "max_virtual_receptionists": 20,
  "max_call_queues": 20,
  "max_conference_rooms": 20,
  "disk_quota": "",
  "used_disk_quota": "text",
  "im_disk_quota": "",
  "extension_im_disk_quota": "1GB",
  "recording_retention": 180,
  "call_report_retention": 30,
  "log_retention": 180,
  "temp_file_retention": 30,
  "office_hours": {
    "monday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "tuesday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "wednesday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "thursday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "friday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "saturday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "sunday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    }
  },
  "outbound_caller_ids": [
    {
      "provider_id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "caller_id": "text",
      "description": "text"
    }
  ],
  "e164": {
    "enabled": false,
    "international_code": "text",
    "country": "Angola(244)",
    "area_code": "text",
    "national_code": "text",
    "prefix": "text",
    "remove_special_chars": false,
    "remove_duplicate_countries": true,
    "remove_duplicate_area_codes": true
  },
  "cdr_event": {
    "enabled": false,
    "auth": "DISABLE",
    "username": "text",
    "password": "text",
    "token": "text",
    "url": "text"
  },
  "extension_event": {
    "enabled": false,
    "auth": "DISABLE",
    "username": "text",
    "password": "text",
    "token": "text",
    "url": "text"
  },
  "contact_match_type": "MATCH_EXACTLY",
  "contact_match_length": 1,
  "contact_append_type": "APPEND",
  "contact_update_interval": 720,
  "email_recipients": "text",
  "password_force_reset": false,
  "created_at": "2017-07-21T17:32:28Z",
  "avatar_file_name": "text",
  "avatar_file_size": 0,
  "avatar_file_url": "/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK"
}

Update a tenant

post

Update tenant properties by it's unique ID.

Authorizations
Path parameters
idall ofRequired

The unique ID of tenant.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Body
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
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_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_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
post
POST /api/tenants/{id} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2001

{
  "domain": "text",
  "website": "text",
  "timezone": "text",
  "currency": "USD",
  "region": "text",
  "enabled": true,
  "enable_video_recording": false,
  "enable_audio_recording": false,
  "enable_dual_track_recording": false,
  "enable_billing": false,
  "enable_feature_billing": false,
  "enable_feature_call_statistics": true,
  "enable_feature_contact_center": true,
  "enable_feature_message_channels": true,
  "enable_feature_microsoft_teams": true,
  "enable_feature_trunks": true,
  "enable_feature_whats_app": true,
  "enable_night_mode": false,
  "enable_two_factor_authentication": false,
  "custom_options": "text",
  "max_extensions": 1000,
  "max_concurrent_calls": 20,
  "max_ring_groups": 20,
  "max_virtual_receptionists": 20,
  "max_call_queues": 20,
  "max_conference_rooms": 20,
  "disk_quota": "",
  "im_disk_quota": "",
  "extension_im_disk_quota": "1GB",
  "recording_retention": 180,
  "call_report_retention": 30,
  "log_retention": 180,
  "temp_file_retention": 30,
  "office_hours": {
    "monday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "tuesday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "wednesday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "thursday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "friday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "saturday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "sunday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    }
  },
  "e164": {
    "enabled": false,
    "international_code": "text",
    "country": "Angola(244)",
    "area_code": "text",
    "national_code": "text",
    "prefix": "text",
    "remove_special_chars": false,
    "remove_duplicate_countries": true,
    "remove_duplicate_area_codes": true
  },
  "cdr_event": {
    "enabled": false,
    "auth": "DISABLE",
    "username": "text",
    "password": "text",
    "token": "text",
    "url": "text"
  },
  "extension_event": {
    "enabled": false,
    "auth": "DISABLE",
    "username": "text",
    "password": "text",
    "token": "text",
    "url": "text"
  },
  "contact_match_type": "MATCH_EXACTLY",
  "contact_match_length": 1,
  "contact_append_type": "APPEND",
  "contact_update_interval": 720,
  "email_recipients": "text",
  "password_force_reset": false
}
No content

Switch between tenants

post

Switch between tenants.

Authorizations
Query parameters
idall ofOptional

The unique ID of tenant.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200
OK
post
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
Path parameters
idall ofRequired

The unique ID of tenant.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200
OK
application/json
get
GET /api/tenants/{id}/dealers HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "enabled": true,
      "level": "DISTRIBUTOR",
      "name": "text",
      "display_name": "text"
    }
  ]
}

Designate tenant to dealer

post

Designate tenant to dealer.

Authorizations
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
post
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
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
post
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
Path parameters
idall ofRequired

The unique ID of tenant.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
204
No Content
post
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
Responses
200
OK
application/json
get
GET /api/license HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "api_version": "text",
  "product_name": "PortSIP PBX",
  "max_sim_calls": 1,
  "license_key": "text",
  "company_name": "text",
  "contact_email": "text"
}

Update license

post

Update license

Authorizations
Body
license_keystringRequired

License key of PortSIP PBX.

Responses
200
OK
post
POST /api/license HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "license_key": "text"
}
No content

Show certificate key

get

Retrieve content of certificate key.

Authorizations
Responses
200
OK
application/json
get
GET /api/key HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "crt": "text",
  "key": "text"
}

Update certificate key

post

Update certificate key.

Authorizations
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
post
POST /api/key HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "crt": "text",
  "key": "text"
}
No content

Update brand information

post

Update brand information.

Authorizations
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
post
POST /api/brand HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 191

{
  "theme": "BLUE",
  "logo": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "favicon": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "title": "text",
  "copyright": "text",
  "product": "text",
  "website": "text",
  "forum": "text",
  "bottom_text": "text"
}
No content

Retrieve current dealer

get

Get details of current dealer.

Authorizations
Responses
200
OK
application/json
get
GET /api/dealer HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "enabled": true,
  "level": "DISTRIBUTOR",
  "name": "text",
  "email": "[email protected]",
  "display_name": "text",
  "website": "text",
  "phone": "text",
  "address": "text",
  "description": "text",
  "max_tenants": 100,
  "max_extensions": 50000
}

Update current dealer

post

Modify the settings of the current dealer.

Authorizations
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
post
POST /api/dealer HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 123

{
  "email": "[email protected]",
  "display_name": "text",
  "website": "text",
  "phone": "text",
  "address": "text",
  "description": "text"
}
No content

Retrieve current dealer status

get

Get status of current dealer.

Authorizations
Responses
200
OK
application/json
get
GET /api/dealer/status HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Change current dealer username

post

Change current dealer username.

Authorizations
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
post
POST /api/dealer/username HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}
No content

Reset current dealer password

post

Reset current dealer password.

Authorizations
Body
old_passwordstringOptional

The password of dealer.

new_passwordstringOptional

The password of dealer.

Responses
200
OK
post
POST /api/dealer/password HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "old_password": "text",
  "new_password": "text"
}
No content

List provider assignees

get

Get a collection of assignees of provider.

Authorizations
Path parameters
idall ofRequired

The unique ID of trunk.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw
Responses
200
OK
application/json
get
GET /api/providers/{id}/assignees HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "tenant_id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "did_numbers": "text",
      "concurrency": 1
    }
  ]
}

Check provider assignee

get

Check if a provider is assigned to the tenant.

Authorizations
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
get
GET /api/providers/{id}/assignees/{tenant_id} HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "did_numbers": "text",
  "concurrency": 1
}

Assign provider

post

Assign provider to tenant.

Authorizations
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
post
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: 38

{
  "did_numbers": "text",
  "concurrency": 1
}
No content

Destroy a provider assignee

post

Unassign provider from tenant.

Authorizations
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
post
POST /api/providers/{id}/assignees/{tenant_id}/destroy HTTP/1.1
Host: hostname:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content
PreviousAuthenticationNextExtensions