Skip to main content

Get SIP Settings​

Returns Session Initiation Protocol (SIP) Settings

Responses

OK

Schema
  • enable boolean

    Determines whether the SIP is enabled

  • host_to_id boolean

    Host id

  • proxy ipv4|dns

    SIP proxy

  • realm ipv4|dns

    SIP realm address

  • user string

    Possible values: non-empty and <= 31 characters, Value must match regular expression ^[0-9a-zA-Z\s~!@#$%^&;*()_-+={[}]|"<,>.?/]{1,31}?$`

    SIP account user name

  • password string

    Possible values: >= 6 characters and <= 31 characters, Value must match regular expression ^[0-9a-zA-Z\s~!@#$%^&;*()_-+={[}]|"<,>.?/]{6,31}?$`

    SIP account user password. 'Password is an any symbol from a to z uppercase or lowercase, from 0 to 9 in digits. Available special symbols: ~`!@#$%^&;*()_-+={[}]|"<,>.?/'

  • transport string

    Possible values: [udp, tcp, tls]

    Secure SIP Protocol

  • user_id string

    Possible values: non-empty and <= 31 characters, Value must match regular expression ^[0-9a-zA-Z\s~!@#$%^&;*()_-+={[}]|"<,>.?/]{0,31}?$`

    SIP user id

  • is_enable_ring_code boolean

    Determines whether the ring code is enabled

  • user_agent string

    User agent Voip v2.0

  • timeout integer

    Possible values: [120, 300, 600, 1200, 1800]

    Call timeout

  • registration_interval integer

    Possible values: >= 30 and <= 900

    SIP server registration interval in seconds

  • stun object

    STUN settings

  • ip ipv4|dns

    STUN IP address

  • port integer

    STUN port

  • net integer

    Interface used for DNS resolution (0 = Ethernet, 1 = Wi-Fi)

  • fixed_net integer

    Bind SIP/multicast calls to the net interface (0 = no, 1 = yes)

  • multicast string

    Multicast address and port for SIP communication.

Loading...