VoiceMessages APIs
-
List Voice Messages
Description: Returns a list of either recorded or yet to be recorded voice messagesUsage:
GET api/Messages/Voice/List/{Recorded}
Parameter Type Source Description Recorded String FromUri Specifies whether to return voice messages that are recorded or those which still require recordings. Returns:
Returns a list of Message objects
Examples:
<!-- Intent: retrieve a list of existing voice messages that have all required recordings. For unrecorded, a value of 0 would be passed into {Recorded} instead of 1. GET to the following url http://api.v4.swiftreach.com/api/Messages/Voice/List/1 --> <!-- No XML input is required --> <!-- Example Return Value --> <ArrayOfMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SwiftReach.Swift911.Core.Messages.Voice"> <Message> <ChangeStamp>2012-07-21T22:15:34.64</ChangeStamp> <ChangedByUser/> <CreateStamp>2012-07-21T22:15:34.64</CreateStamp> <CreatedByUser>SYSTEM</CreatedByUser> <DeleteLocked>false</DeleteLocked> <Description>call with confirmation code</Description> <LastUsed>2012-09-27T10:05:19.077</LastUsed> <Name>Confirm</Name> <Visibility>Visible</Visibility> <VoiceCode>643507</VoiceCode> <VoiceType>voice_message</VoiceType> </Message> <Message> <ChangeStamp>2012-12-21T11:00:22.79</ChangeStamp> <ChangedByUser>sample</ChangedByUser> <CreateStamp>2012-07-22T09:15:59.7</CreateStamp> <CreatedByUser>sample</CreatedByUser> <DeleteLocked>true</DeleteLocked> <Description>this is a test</Description> <LastUsed>2013-01-09T15:23:55.393</LastUsed> <Name>Test TTS</Name> <Visibility>Visible</Visibility> <VoiceCode>643547</VoiceCode> <VoiceType>voice_message</VoiceType> </Message> </ArrayOfMessage>