Retrieve general settings for PortSIP PBX

GET /settings/show
Retrieves the global settings of PortSIP PBX.

Request

Placeholders
  • access_token

    string

    required

    Access token is a 32-byte string with validity of 30 seconds.

Sample Request

https://example.com/api/settings/show?access_token=196ACE20C6F34027895F7F95402BB164

Response

Placeholders
  • general

    object

    required

    General settings for PortSIP PBX.
    Show child attributes
  • paging_intercom

    object

    required

    Paging/Intercom settings for PortSIP PBX.
    Show child attributes
  • blf

    object

    required

    BLF settings for PortSIP PBX.
    Show child attributes

Sample Response

{
    "general": {
        "enable_flow_routing": false,
        "enable_prack": true,
        "sip_message_log_level": "DEBUG",
        "auto_cleaning_logs_days": 5,
        "enable_ipv6": true,
        "enable_digest_auth": true,
        "enable_digest_auth_int": false,
        "enable_auth_mid_dialog": false,
        "enable_reject_bad_nonce": false,
        "enable_create_non_exist_extension": false,
        "statistics_log_interval": 600,
        "dead_session_timeout": 300,
        "enable_session_timer": false,
        "session_timer_duration": 120,
        "enable_to_tag_in_register": false,
        "enable_congestion_management": true,
        "congestion_management_metric": "WAIT_TIME",
        "congestion_management_tolerance": 80,
        "presence_mode": "P2P",
        "primary_dns_server": "",
        "secondary_dns_server": "",
        "pbx_ip_v4": "127.0.0.1",
        "pbx_ip_v6": "",
        "pbx_mode": "PRIVATE_NETWORK"
    },
    "paging_intercom": {
        "dial_code": "*10",
        "auto_answer_alert_info_header": 1,
        "enable_auto_answer_call_info_header": false,
        "enable_require_answer_mode": false
    },
    "blf": {
        "enable_dialog_state_agent": true,
        "pick_ringing_call_prefix": "**",
        "pick_held_call_prefix": "##"
    }
}

Update settings for PortSIP PBX

POST /settings/update
Modify the global settings of PortSIP PBX.

Request

Placeholders
  • access_token

    string

    required

    Access token is a 32-byte string with validity of 30 seconds.
  • general

    object

    optional

    General settings for PortSIP PBX.
    Show child attributes
  • paging_intercom

    object

    optional

    Paging and intercom settings for PortSIP PBX.
    Show child attributes
  • blf

    object

    optional

    BLF settings for PortSIP PBX.
    Show child attributes

Sample Request

{
    "access_token": "196ACE20C6F34027895F7F95402BB164",
    "general": {
        "enable_flow_routing": false,
        "enable_prack": true,
        "sip_message_log_level": "DEBUG",
        "auto_cleaning_logs_days": 5,
        "enable_ipv6": true,
        "enable_digest_auth": true,
        "enable_digest_auth_int": false,
        "enable_auth_mid_dialog": false,
        "enable_reject_bad_nonce": false,
        "enable_create_non_exist_extension": false,
        "statistics_log_interval": 600,
        "dead_session_timeout": 300,
        "enable_session_timer": false,
        "session_timer_duration": 120,
        "enable_to_tag_in_register": false,
        "enable_congestion_management": true,
        "congestion_management_metric": "WAIT_TIME",
        "congestion_management_tolerance": 80,
        "presence_mode": "P2P",
        "primary_dns_server": "",
        "secondary_dns_server": "",
        "pbx_ip_v4": "127.0.0.1",
        "pbx_ip_v6": "",
        "pbx_mode": "PRIVATE_NETWORK"
    },
    "paging_intercom": {
        "dial_code": "*10",
        "auto_answer_alert_info_header": 1,
        "enable_auto_answer_call_info_header": false,
        "enable_require_answer_mode": false
    },
    "blf": {
        "enable_dialog_state_agent": true,
        "pick_ringing_call_prefix": "**",
        "pick_held_call_prefix": "##"
    }
}

Response

Placeholders

Sample Response

Retrive IP and working mode for PBX

GET /settings/pbx_mode_ip/show
Returns the PBX IP and working mode.

Request

Placeholders
  • access_token

    string

    required

    Access token is a 32-byte string with validity of 30 seconds.

Sample Request

https://example.com/api/settings/pbx_mode_ip/show?access_token=196ACE20C6F34027895F7F95402BB164

Response

Placeholders
  • pbx_mode

    string

    optional

    Working mode for PortSIP PBX. It could be either "PUBLIC_NETWORK" or "PRIVATE_NETWORK".
  • pbx_ip_v4

    string

    optional

    IPv4 address for PortSIP PBX
  • pbx_ip_v6

    string

    optional

    IPv6 address for PortSIP PBX

Sample Response

{
    "pbx_mode": "PRIVATE_NETWORK",
    "pbx_ip_v4": "127.0.0.1",
    "pbx_ip_v6": ""
}

Update settings for PBX IP and working mode

POST /settings/pbx_mode_ip/update
Modify the settings for PBX IP and working mode.

Request

Placeholders
  • access_token

    string

    required

    Access token is a 32-byte string with validity of 30 seconds.
  • pbx_mode

    string

    optional

    Working mode for PortSIP PBX. It could be either "PUBLIC_NETWORK" or "PRIVATE_NETWORK".
  • pbx_ip_v4

    string

    optional

    IPv4 address for PortSIP PBX
  • pbx_ip_v6

    string

    optional

    IPv6 address for PortSIP PBX

Sample Request

{
    "access_token": "196ACE20C6F34027895F7F95402BB164",
    "pbx_mode": "PRIVATE_NETWORK",
    "pbx_ip_v4": "127.0.0.1",
    "pbx_ip_v6": ""
}

Response

Placeholders

Sample Response