<Reject>
The <Reject>
verb rejects an incoming call without billing the customer. This is very useful for blocking unwanted calls.
If the first verb in a VoXML document is <Reject>
, Voxtelesys will not answer the call. The call ends with a status of busy
or no-answer
, depending on the verb's reason
attribute. Any verbs after <Reject>
are unreachable and ignored.
<Reject>
Attributes
<Reject>
supports the following attributes that change its behavior:
Attribute | Allowed Values | Default Value |
---|---|---|
history | disable , compact , full | disable |
reason | rejected , busy | rejected |
history
The history
attribute determines if the <Reject>
verb should be logged in the history
array of the CDR. The default is to not log.
For <Reject>
, both compact
and full
have the same effect of logging the following payload to the history
array.
{
"payload": {
"reason": "busy"
}
}
reason
The reason
attribute takes the values rejected
and busy
. This tells Voxtelesys what message to play when rejecting the call. Selecting busy
will play a busy signal to the caller, while selecting rejected
will play a standard non-in-service response.
The actual message played back is determined by the caller's service provider, as reason
is only manipulating the SIP response code.
<Reject>
Examples
Simple Usage
Reject the call with rejected
reason.
<Response>
<Reject reason="rejected"></Redirect>
</Response>