Skip to main content

Get SIP settings​

Returns the SIP (Session Initiation Protocol) account settings.

Responses

OK

Schema
  • enable boolean

    Determines whether the SIP is enabled

  • host_to_id boolean

    Use host as SIP 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 password. Allowed characters: letters (a–z, A–Z), digits (0–9), and 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

  • timeout integer

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

    Maximum call duration in seconds before auto hang-up.

  • 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

  • user_agent string

    SIP User-Agent header value.

Loading...