Service: zimbraVoice
Namespace: "urn:zimbraVoice"
VoiceMsgAction SOAP Command

Perform an action on a voice message

Authorization token required true
Admin Authorization token required false

VoiceMsgActionRequest

    <VoiceMsgActionRequest> ## VoiceMsgActionRequest
        <storeprincipal [id="{id-of-user-in-the-backing-store}"] [name="{name-of-user-in-the-backing-store}"]
                            [accountNumber="{account-number}"] /> ## StorePrincipalSpec
        <action op="{operation}" phone="{phone-number}" [l="{location}"] id="{list}" /> ## VoiceMsgActionSpec
    </VoiceMsgActionRequest>

The following table describes elements and attributes you can define within a <VoiceMsgActionRequest> element:

XPath Required / Optional Description
/storeprincipal Optional (0 or 1) Store principal specification
/storeprincipal@id Optional (0 or 1) Type:String
ID of user in the backing store
/storeprincipal@name Optional (0 or 1) Type:String
Name of user in the backing store
/storeprincipal@accountNumber Optional (0 or 1) Type:String
Account Number
/action Required (only 1) Action specification
/action@op Required (only 1) Type:String
move|[!]read|empty|delete
  • read op can be preceeded by a "!" to negate it
  • for move:
    • if dest location is a trash folder, server assumes source folder is voicemail and performs a gateway undelete
    • if dest location is a voicemail folder, server assumes source folder is trash and performs a gateway soft delete
  • for delete:
    • hard deletes the voice msgs. location/dest folder can be null for this op.
/action@phone Required (only 1) Type:String
Phone number
/action@l Optional (0 or 1) Type:String
Folder ID of the destination location for the move
  • required for op="move"
  • ignored for all other ops
/action@id Required (only 1) Type:String
IDs list.
  • for move and read operations: list of message ids to act on
  • for empty operation: single value of folder id to act on.
    Currently the empty op is only supported for a trash folder. If {location} points to a folder that is not of type trash, server will return INVALID_REQUEST error.

VoiceMsgActionResponse

    <VoiceMsgActionResponse> ## VoiceMsgActionResponse
        <action id="{successes}" op="{operation-move|read|empty}" /> ## VoiceMsgActionInfo
    </VoiceMsgActionResponse>

The following table describes elements and attributes you can define within a <VoiceMsgActionResponse> element:

XPath Required / Optional Description
/action Required (only 1) Information on action performed
/action@id Required (only 1) Type:String
List of ids that were acted on
/action@op Required (only 1) Type:String
Operation - move|read|empty