Set SIP Settings
Configures Session Initiation Protocol (SIP) settings
- application/json
Request Body required
- enable boolean required
Determines whether the SIP is enabled
- proxy ipv4|dns required
SIP proxy
- realm ipv4|dns required
SIP realm address
- user string required
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 required
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
- timeout integer required
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 required
STUN settings
ip ipv4|dns requiredSTUN IP address
port integer requiredSTUN port
- 200
- 400
- 401
OK
- Missed json body or wrong param.
Response sample:
"error": "Wrong JSON body"
- Required field is not provided.
Response sample:where
"error": "Wrong JSON body: no value for `param`"
param
- is a required field that was not provided - Field was of the wrong type.
Response sample:where
"error": "Wrong JSON body: value `param` was of the wrong type"
param
- is a field of the wrong type
- application/json
- Schema
- Example (from schema)
- Base
- Missed param
- Wrong param type
Schema
- error string
Error information
{
"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 information
{
"error": "Log In"
}
{
"error": "Log In"
}