Skip to main content

Get SIP Settings​

Returns settings needed to configure calls with SIP.

Actual password value is hidden. 'WebPass' placeholder is used.

Responses

OK

Schema
  • proxy ipv4|dns

    Possible values: Value must match regular expression ^sip:(\b((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?(?::\d{1,5})?)(\.|$)){4}\b)|([0-9]*[A-Za-z+\-_]+[0-9]*)((\.([0-9]*[A-Za-z+\-_]+[0-9]*))+\b)(?::\d{1,5})?$

    SIP proxy

  • realm ipv4|dns

    Possible values: Value must match regular expression ^\b((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?(?::\d{1,5})?)(\.|$)){4}\b|([0-9]*[A-Za-z+\-_]+[0-9]*)((\.([0-9]*[A-Za-z+\-_]+[0-9]*))+\b)(?::\d{1,5})?$

    SIP Realm

  • user string

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

    User name

  • password string

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

    SIP password. Actual value cannot be retrieved using GET request. 'WebPass' placeholder is used.

  • transport string

    Possible values: [udp, tcp, tls]

    Transport protocol

  • user_id string

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

    User ID

  • stun object

    STUN settings

  • ip ipv4|dns

    Possible values: Value must match regular expression ^\b((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\.|$)){4}\b|([0-9]*[A-Za-z+\-_]+[0-9]*)((\.([0-9]*[A-Za-z+\-_]+[0-9]*))+\b)$

    STUN IP address

  • port integer

    STUN port

  • registration_interval integer

    Possible values: >= 30 and <= 900

    Session expire timeout in seconds

Loading...