Set SIP Settings

application/json

Request Body required

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

Responses

Missed json body or wrong param. Response sample:
```
  "error": "Wrong JSON body"
```
Required field is not provided. Response sample:
```
  "error": "Wrong JSON body: no value for `param`"
```
where param - is a required field that was not provided
Field was of the wrong type. Response sample:
```
  "error": "Wrong JSON body: value `param` was of the wrong type"
```
where param - is a field of the wrong type

application/json

Schema
Example (from schema)
Base
Missed param
Wrong param type

Schema

error string
Error message

{
  "error": true
}

{
  "error": "Wrong JSON body"
}

{
  "error": "Wrong JSON body: no value for `param`"
}

{
  "error": "Wrong JSON body: value `param` was of the wrong type"
}

Unauthorized request. Log In

application/json

Schema
Example (from schema)
Log In

Schema

error string
Error message

{
  "error": "Log In"
}

{
  "error": "Log In"
}

Set SIP Settings​

Set SIP Settings