Signals
| DivertedToVoicemail | (u: AllowedDuration, u: Reason) |
Properties
| RecordVoicemail | b | Read only | Immutable, Sometimes requestable | |
| RecordGreeting | b | Read only | Immutable, Sometimes requestable | |
| AllowedDuration | u | Read only | Immutable |
Types
| Voicemail_Diversion_Reason | Enum | u |
Description
This interface may be present on voice (or potentially video) channels for protocols that support voicemail (or videomail?).
The interface can notify the user when their call has been diverted to voicemail (via the DivertedToVoicemail signal).
On protocols that allow it, the RecordVoicemail property can be used to leave a voicemail for a remote user without first placing an outgoing call.
To retreive voicemails, have a look at the Connection.Interface.Voicemail.DRAFT and Channel.Interface.VoicemailRetrieval.DRAFT interfaces.
Signals
DivertedToVoicemail (u: AllowedDuration, u: Reason)
Parameters
- AllowedDuration — u
- Reason — u (Voicemail_Diversion_Reason)
This signal SHOULD be emitted when a call has been diverted to Voicemail, if the Connection Manager is able to determine such an event has taken place.
This signal heralds the change in properties on this interface. The RecordVoicemail property MUST be set True before emitting this signal, as well as any other properties whos values can now be determined by the Connection Manager.
Properties
RecordVoicemail — b
This property is requestable for channels where the protocol supports leaving a voicemail without needing a call to be diverted to voicemail.
Protocols that support leaving voicemail without first making a call will have a requestable channel class featuring this property.
Rationale:
Protocols that do not support leaving voicemails without placing a call MUST return NotCapable if this property is included in the request.
This property SHOULD appear in the immutable properties, if the channel was requested with it.
In the case where a call is diverted to voicemail, this property SHOULD also change to True, if this event can be detected by the Connection Manager. Its change will be heralded by the DivertedToVoicemail signal.
RecordGreeting — b
Including this property in a channel request indicates that the requested channel is for recording a voicemail greeting that will be played to other users when they leave you voicemail.
This property SHOULD appear in the channel's immutable properties.
On protocols where a different voicemail greeting can be recorded for different users or contact groups, the channel request MAY include a TargetHandle or TargetID of TargetHandleType Contact or Group. Omitting a target sets the default greeting. If a greeting for a specific user/group cannot be set, the channel request MUST fail with NotCapable.
Rationale:
Protocols that support recording greetings will have up to three requestable channel classes: one for recording the default greeting; one for recording a per-user greeting; and one for recording a per-group greeting.
AllowedDuration — u
Permitted voicemail duration in seconds. 0 if voicemails may be of indefinite duration, or the allowable duration is unknown.
This property MUST be included in the channel's immutable properties if the channel was requested with RecordVoicemail; or it SHOULD be set prior to the emission of DivertedToVoicemail.
Rationale:
Types
Voicemail_Diversion_Reason — u
The reason why the call was diverted to voicemail.
Rationale:
- Unknown (0)
- User_Busy (1)
- No_Reply (2)
- Unconditional (3)
- Deflection_During_Alerting (4)
- Deflection_Immediate_Response (5)
- Mobile_Subscriber_Not_Reachable (6)