Create/Update call forward rule
- Create/Update forward rule. Forward incoming call from logic number (
apartment_id
) to SIP numbers at once or sequentially. Forwarding will work if SIP is configured and enabled withPOST /device/sip/settings
andPOST /device/sip/enable
. - If there is already forward rule with same
forward_number
it will be updated - Available forward number patterns:
\d+
- digits only, for example,101
^sip:([0-9A-Za-z+\-_]*@)((\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))$
- full SIP URI, for example,sip:[email protected]
orsip:[email protected]
^sip:(\b((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?(?:\:\d{1,5})?)(\.|$)){4}\b)$
- SIP URI without name and host, for examplesip:192.168.1.2
^laskomex:\d+$
- for devices with hybrid adapter, for example,laskomex:10
^vizit:\d+$
- another number format for devices with hybrid adapter, for example,vizit:10
Path Parameters
- forward-uid int64 required
Possible values:
>= 1
Forward number for forward scheme
- application/json
Request Body required
- forward_entity_list string[]
List of Forwards
Responses
- 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 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"
}
Loading...