Files
next-static-site/markdown/docs/webhooks/sip-decline.md
T
Dave Horton 469518e776 0.6.7 content (#23)
* added docs for sip refer and bidrectional audio

* typos

* more detail on bidirectional audio

* say supports azure in 0.6.7

* minor updates

* minor
2021-11-20 14:20:30 -05:00

32 lines
1019 B
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 class="flex">
<a href="/docs/webhooks/say">Prev: say</a>
<a href="/docs/webhooks/sip-refer">Next: sip:refer</a>
</p>