2.2.2.83 UmCallerID

  • Article

The email2:UmCallerID element is an optional element that specifies the callback telephone number of the person who called or left an electronic voice message. It is defined as an element in the Email2 namespace.

The string ([MS-ASDTYPE] section 2.7) value of this element is either formatted as an E.164 telephone number, as specified in [E164], or as a session initiated protocol link to initiate a Voice over IP (VoIP) call. For more details about session initiated protocol links, see [RFC3261].

This element is sent from the server to the client, and MUST NOT be sent from the client to the server. The server returns a Status element ([MS-ASCMD] section 2.2.3.177.17) value of 6 in the Sync command response ([MS-ASCMD] section 2.2.1.21) if the client attempts to send the email2:UmCallerId element to the server. The email2:UmCallerID element is not included in the command response, or is empty in the command response, if the call originated as a private, blocked, or otherwise anonymous call meaning the caller’s telephone number was masked and unavailable to the recipient of the call.

This element MUST only be included for messages with one of the following MessageClass values:

  • IPM.Note.Microsoft.Voicemail

  • IPM.Note.Microsoft.Voicemail.UM

  • IPM.Note.Microsoft.Voicemail.UM.CA

  • IPM.Note.RPMSG.Microsoft.Voicemail

  • IPM.Note.RPMSG.Microsoft.Voicemail.UM

  • IPM.Note.RPMSG.Microsoft.Voicemail.UM.CA

  • IPM.Note.Microsoft.Missed.Voice

Only one email2:UmCallerID element is allowed per message. In order to enable future VoIP scenarios, the server SHOULD send this element to the client regardless of the client's current VoIP capabilities.

Protocol Versions

The following table specifies the protocol versions that support this element. The client indicates the protocol version being used by setting either the MS-ASProtocolVersion header, as specified in [MS-ASHTTP] section 2.2.1.1.2.6, or the Protocol version field, as specified in [MS-ASHTTP] section 2.2.1.1.1.1, in the request.

Protocol version

Element support

2.5

12.0

12.1

14.0

Yes

14.1

Yes

16.0

Yes

16.1

Yes