Hangup
Definition
The Hangup
verb is used to hang up a call. It can be used to end a call that is currently in progress.
Hangup
will answer the call and then immediately hang up. To reject the call without answering, use Reject
instead.
Optionally, you can use the callInfo
attribute to include a reason string in the SIP Call-Info header when the call is terminated.
Supported Attributes
Attribute | Data Type | Description |
---|---|---|
callInfo | string | Adds a Call-Info header to the SIP BYE message to provide additional information about why the call was ended. |
Example
In this example, the Hangup
verb is used to hang up the call and send a custom reason code.
<Response>
<Hangup callInfo="soft hangup from IO"/>
</Response>
Nesting Rules
- You cannot nest other verbs or nouns within the
Hangup
verb. - You cannot nest the
Hangup
verb within other FlexML verbs.