SETTING

Retrieve settings

GET /show

Retrieve settings for PortSIP PBX.

Path parameters

access_token

string

required

token to be passed as a header

minLength: 64

maxLength: 64

Sample Request

                      curl -v -X GET http://127.0.0.1:8990/api/settings/show \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \

Responses

`200`

Successful operation

application/json

blf

object

Show child attributes
- pick_ringing_call_prefix
  
  string
  
  Placeholder
- enable_dialog_state_agent
  
  string
  
  Placeholder
- pick_held_call_prefix
  
  string
  
  Placeholder
paging_intercom

object

Show child attributes
- auto_answer_alert_info_header
  
  integer
  
  Alert-info header to be added in INVITE message when PBX is forwarding the page/intercom. Values: 1 - info=intercom; 2 – Alert-Info:;info=alert-autoanswer;delay=0; 3 - info=Auto Answer.
- enable_auto_answer_call_info_header
  
  boolean
  
  Enable call-info header for auto answer. The value is "sip:portsip.com;answer-after=0".
- dial_code
  
  string
  
  Dial code. If user is calling a number prefixed with dial_code, PBX will recognize this call as page/intercom and forward it with the dial_code stripped.
- enable_require_answer_mode
  
  boolean
  
  Enable Require Answer Mode (RFC 5373) for auto answer.
general

object

Show child attributes
- user_agent
  
  string
  
  user agent.
- sip_message_log_level
  
  string
  
  Log level for PBX.
  
  enum : ['NONE', 'INFO', 'DEBUG']
- pbx_public_ip_v4
  
  string
  
  public IPv4 address for PortSIP PBX
- pbx_public_ip_v6
  
  string
  
  public IPv6 address for PortSIP PBX
- enable_congestion_management
  
  boolean
  
  Indicates if congestion management would be enabled.
- congestion_management_tolerance
  
  string
  
  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. Recommended value is 80.
  
  enum : ['80', '100', '200']
- dead_session_timeout
  
  integer
  
  Close the session if no RTP packets received within specified duration, in seconds.
- enable_digest_auth
  
  boolean
  
  Indicates if DIGEST authentication would be enabled.
- congestion_management_metric
  
  string
  
  Precondition: "enable_congestion_management" parameter MUST be set to true. The recommended is WAIT_TIME based on the expected wait time for each FIFO.
  
  enum : ['WAIT_TIME', 'TIME_DEPTH', 'SIZE']
- enable_digest_auth_int
  
  boolean
  
  Indicates if auth-int DIGEST authentication mode would be enabled.
- session_timer_duration
  
  integer
  
  Duration recorded by Session timer. Precondition: "enable_session_timer" MUST be set to true.
- primary_dns_server
  
  string
  
  Primary DNS Server.
- auto_cleaning_logs_days
  
  integer
  
  Clean logs after certain interval.
- enable_prack
  
  boolean
  
  Enable prack or not.
- enable_reject_bad_nonce
  
  boolean
  
  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.
- enable_ipv6
  
  boolean
  
  Indicates if IPv6 would be enabled.
- secondary_dns_server
  
  string
  
  Seconday DNS Server.
- statistics_log_interval
  
  integer
  
  Interval for statistics logs, in seconds.
- enable_auth_mid_dialog
  
  boolean
  
  Indicates if PortSIP PBX requires authentication against all subsequent requests originated from one calling.
- enable_session_timer
  
  boolean
  
  Indicates if session timer (RFC 4028) would be enabled. This also requires client support.
- pbx_private_ip_v4
  
  string
  
  private IPv4 address for PortSIP PBX
- pbx_web_domain
  
  string
  
  web domain for PortSIP PBX
- pbx_private_ip_v6
  
  string
  
  private IPv6 address for PortSIP PBX
- enable_to_tag_in_register
  
  boolean
  
  Indicates if "to" tag is allowed in REGISTER message.
- enable_create_non_exist_extension
  
  boolean
  
  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.

Sample Response

{}

Update PBX mode and ip

POST /pbx_mode_ip/update

Update PBX mode and ip

Path parameters

access_token

string

required

token to be passed as a header

minLength: 64

maxLength: 64

Request body

application/json

pbx_private_ip_v4

string

required

private IPv4 address for PortSIP PBX
pbx_public_ip_v6

string

required

public IPv6 address for PortSIP PBX
pbx_private_ip_v6

string

required

private IPv6 address for PortSIP PBX
pbx_web_domain

string

required

web domain for PortSIP PBX
pbx_public_ip_v4

string

required

public IPv4 address for PortSIP PBX

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/settings/pbx_mode_ip/update \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{}'

Responses

`200`

Successful operation

Sample Response

Update setting entry

POST /update

Update settings for PortSIP PBX

Path parameters

access_token

string

required

token to be passed as a header

minLength: 64

maxLength: 64

Request body

application/json

blf

object

required

Show child attributes
- pick_ringing_call_prefix
  
  string
  
  required
  
  Placeholder
- enable_dialog_state_agent
  
  string
  
  required
  
  Placeholder
- pick_held_call_prefix
  
  string
  
  required
  
  Placeholder
paging_intercom

object

required

Show child attributes
- auto_answer_alert_info_header
  
  integer
  
  required
  
  Alert-info header to be added in INVITE message when PBX is forwarding the page/intercom. Values: 1 - info=intercom; 2 – Alert-Info:;info=alert-autoanswer;delay=0; 3 - info=Auto Answer.
- enable_auto_answer_call_info_header
  
  boolean
  
  required
  
  Enable call-info header for auto answer. The value is "sip:portsip.com;answer-after=0".
- dial_code
  
  string
  
  required
  
  Dial code. If user is calling a number prefixed with dial_code, PBX will recognize this call as page/intercom and forward it with the dial_code stripped.
- enable_require_answer_mode
  
  boolean
  
  required
  
  Enable Require Answer Mode (RFC 5373) for auto answer.
general

object

required

Show child attributes
- user_agent
  
  string
  
  required
  
  user agent.
- sip_message_log_level
  
  string
  
  required
  
  Log level for PBX.
  
  enum : ['NONE', 'INFO', 'DEBUG']
- pbx_public_ip_v4
  
  string
  
  required
  
  public IPv4 address for PortSIP PBX
- pbx_public_ip_v6
  
  string
  
  required
  
  public IPv6 address for PortSIP PBX
- enable_congestion_management
  
  boolean
  
  required
  
  Indicates if congestion management would be enabled.
- congestion_management_tolerance
  
  string
  
  required
  
  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. Recommended value is 80.
  
  enum : ['80', '100', '200']
- dead_session_timeout
  
  integer
  
  required
  
  Close the session if no RTP packets received within specified duration, in seconds.
- enable_digest_auth
  
  boolean
  
  required
  
  Indicates if DIGEST authentication would be enabled.
- congestion_management_metric
  
  string
  
  required
  
  Precondition: "enable_congestion_management" parameter MUST be set to true. The recommended is WAIT_TIME based on the expected wait time for each FIFO.
  
  enum : ['WAIT_TIME', 'TIME_DEPTH', 'SIZE']
- enable_digest_auth_int
  
  boolean
  
  required
  
  Indicates if auth-int DIGEST authentication mode would be enabled.
- session_timer_duration
  
  integer
  
  required
  
  Duration recorded by Session timer. Precondition: "enable_session_timer" MUST be set to true.
- primary_dns_server
  
  string
  
  required
  
  Primary DNS Server.
- auto_cleaning_logs_days
  
  integer
  
  required
  
  Clean logs after certain interval.
- enable_prack
  
  boolean
  
  required
  
  Enable prack or not.
- enable_reject_bad_nonce
  
  boolean
  
  required
  
  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.
- enable_ipv6
  
  boolean
  
  required
  
  Indicates if IPv6 would be enabled.
- secondary_dns_server
  
  string
  
  required
  
  Seconday DNS Server.
- statistics_log_interval
  
  integer
  
  required
  
  Interval for statistics logs, in seconds.
- enable_auth_mid_dialog
  
  boolean
  
  required
  
  Indicates if PortSIP PBX requires authentication against all subsequent requests originated from one calling.
- enable_session_timer
  
  boolean
  
  required
  
  Indicates if session timer (RFC 4028) would be enabled. This also requires client support.
- pbx_private_ip_v4
  
  string
  
  required
  
  private IPv4 address for PortSIP PBX
- pbx_web_domain
  
  string
  
  required
  
  web domain for PortSIP PBX
- pbx_private_ip_v6
  
  string
  
  required
  
  private IPv6 address for PortSIP PBX
- enable_to_tag_in_register
  
  boolean
  
  required
  
  Indicates if "to" tag is allowed in REGISTER message.
- enable_create_non_exist_extension
  
  boolean
  
  required
  
  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.

Sample Request

                      curl -v -X POST http://127.0.0.1:8990/api/settings/update \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \
                          -d '{}'

Responses

`200`

Successful operation

Sample Response

Retrieve PBX system ip and mode.

GET /pbx_mode_ip/show

Path parameters

access_token

string

required

token to be passed as a header

minLength: 64

maxLength: 64

Sample Request

                      curl -v -X GET http://127.0.0.1:8990/api/settings/pbx_mode_ip/show \
                        -H "Content-Type: application/json" \
                        -H "access_token: 4DFCF1D4C30B4D798ECE3AE43769F008" \

Responses

`200`

Successful operation

application/json

pbx_web_domain

string

web domain for PortSIP PBX

Sample Response

{}

Sample Request

200

application/json

blf

pick_ringing_call_prefix

enable_dialog_state_agent

pick_held_call_prefix

paging_intercom

auto_answer_alert_info_header

enable_auto_answer_call_info_header

dial_code

enable_require_answer_mode

general

user_agent

sip_message_log_level

pbx_public_ip_v4

pbx_public_ip_v6

enable_congestion_management

congestion_management_tolerance

dead_session_timeout

enable_digest_auth

congestion_management_metric

enable_digest_auth_int

session_timer_duration

primary_dns_server

auto_cleaning_logs_days

enable_prack

enable_reject_bad_nonce

enable_ipv6

secondary_dns_server

statistics_log_interval

enable_auth_mid_dialog

enable_session_timer

pbx_private_ip_v4

pbx_web_domain

pbx_private_ip_v6

enable_to_tag_in_register

enable_create_non_exist_extension

Sample Response

Sample Request

200

Sample Response

Sample Request

200

Sample Response

Sample Request

200

application/json

pbx_web_domain

Sample Response

`200`

`blf`

`pick_ringing_call_prefix`

`enable_dialog_state_agent`

`pick_held_call_prefix`

`paging_intercom`

`auto_answer_alert_info_header`

`enable_auto_answer_call_info_header`

`dial_code`

`enable_require_answer_mode`

`general`

`user_agent`

`sip_message_log_level`

`pbx_public_ip_v4`

`pbx_public_ip_v6`

`enable_congestion_management`

`congestion_management_tolerance`

`dead_session_timeout`

`enable_digest_auth`

`congestion_management_metric`

`enable_digest_auth_int`

`session_timer_duration`

`primary_dns_server`

`auto_cleaning_logs_days`

`enable_prack`

`enable_reject_bad_nonce`

`enable_ipv6`

`secondary_dns_server`

`statistics_log_interval`

`enable_auth_mid_dialog`

`enable_session_timer`

`pbx_private_ip_v4`

`pbx_web_domain`

`pbx_private_ip_v6`

`enable_to_tag_in_register`

`enable_create_non_exist_extension`

`200`

`200`

`200`

`pbx_web_domain`