mirror of
https://github.com/jambonz/next-static-site.git
synced 2026-10-31 15:54:30 +00:00
32 lines
1.0 KiB
Markdown
32 lines
1.0 KiB
Markdown
# sip:decline
|
|
|
|
The sip:decline action is used to reject an incoming call with a specific status and, optionally, a reason and SIP headers to include on the response.
|
|
|
|
This action must be the first and only action returned in the JSON payload for an incoming call.
|
|
|
|
The sip:decline action is a non-blocking action and the session ends immediately after the action is executed.
|
|
|
|
```json
|
|
{
|
|
"verb": "sip:decline",
|
|
"status": 480,
|
|
"reason": "Gone Fishing",
|
|
"headers" : {
|
|
"Retry-After": 1800
|
|
}
|
|
}
|
|
```
|
|
|
|
You can use the following options in the `sip:decline` action:
|
|
|
|
| option | description | required |
|
|
| ------------- |-------------| -----|
|
|
| status | a valid SIP status code in the range 4XX - 6XX | yes |
|
|
| reason | a brief description | no (default: the well-known SIP reasons associated with the specified status code |
|
|
| headers | SIP headers to include in the response | no
|
|
|
|
<p>
|
|
<a href="/docs/webhooks/say" style="float: left;">Prev: say</a>
|
|
<a href="/docs/webhooks/tag" style="float: right;">Next: tag</a>
|
|
</p>
|