VoiceMessages APIs
-
Create New Voice Message
Description: Creates a new voice messageUsage:
POST api/Messages/Voice/Create
Parameter Type Source Description VoiceObject Message_Profile FromBody Message_Profile base class. You must pass in one of the following which inherit from Message_Profile: Voice_Message, Voice_Link_Message, Secure_Voice_Message, Conference_Blast_Message, Voice_Feedback_Message, User_Defined_Voice_Message Returns:
the new Message_Profile including any fragment codes. This object may be up cast to its original type.
Examples:
<!-- Intent: Create a new Voice_Message POST to the following url http://api.v4.swiftreach.com/api/Messages/Voice/Create --> <Message_Profile xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema/SwiftReach.Swift911.Core.Messages.Voice" xsi:type="Voice_Message"> <Name>API Voice Message</Name> <Description>created by api</Description> <DefaultSpokenLanguage>English</DefaultSpokenLanguage> <AutoReplays>1</AutoReplays> <RequireResponse>false</RequireResponse> <ValidResponses/> <EnableAnsweringMachineDetection>false</EnableAnsweringMachineDetection> <EnableAnsweringMachineMessage>false</EnableAnsweringMachineMessage> <CallerID>2012361344</CallerID> <CapacityLimit>0</CapacityLimit> <RingSeconds>60</RingSeconds> <CongestionAttempts>3</CongestionAttempts> <AutoRetries>0</AutoRetries> <AutoRetriesInterval>3</AutoRetriesInterval> <EnableWaterfall>false</EnableWaterfall> <VoiceType>voice_message</VoiceType> <ContentProfile> <VOICE_ALERT_PROFILE> <SpokenLanguage>English</SpokenLanguage> <TTY_Text>This is what I want to show up on a TTY</TTY_Text> <VoiceItem> <VOICE_ALERT_CONTENT> <VoiceItemType>alert_human</VoiceItemType> <AudioSource> <AUDIO_SOURCE xsi:type="AUDIO_SOURCE_TTS_TEXT"> <AudioType>audio_source_tts_text</AudioType> <TTSText>This is the message.</TTSText> </AUDIO_SOURCE> </AudioSource> </VOICE_ALERT_CONTENT> </VoiceItem> </VOICE_ALERT_PROFILE> </ContentProfile> </Message_Profile> <!-- example return value --> <Message_Profile xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema/SwiftReach.Swift911.Core.Messages.Voice" xsi:type="Voice_Message"> <VoiceCode>123456</VoiceCode> <Name>API Voice Message</Name> <Description>created by api</Description> <DefaultSpokenLanguage>English</DefaultSpokenLanguage> <AutoReplays>1</AutoReplays> <RequireResponse>false</RequireResponse> <ValidResponses/> <EnableAnsweringMachineDetection>false</EnableAnsweringMachineDetection> <EnableAnsweringMachineMessage>false</EnableAnsweringMachineMessage> <CallerID>2012361344</CallerID> <CapacityLimit>0</CapacityLimit> <RingSeconds>60</RingSeconds> <CongestionAttempts>3</CongestionAttempts> <AutoRetries>0</AutoRetries> <AutoRetriesInterval>3</AutoRetriesInterval> <EnableWaterfall>false</EnableWaterfall> <VoiceType>voice_message</VoiceType> <ContentProfile> <VOICE_ALERT_PROFILE> <SpokenLanguage>English</SpokenLanguage> <TTY_Text>This is what I want to show up on a TTY</TTY_Text> <VoiceItem> <VOICE_ALERT_CONTENT> <VoiceItemType>alert_human</VoiceItemType> <AudioSource> <AUDIO_SOURCE xsi:type="AUDIO_SOURCE_TTS_TEXT"> <AudioType>audio_source_tts_text</AudioType> <TTSText>This is the message.</TTSText> </AUDIO_SOURCE> </AudioSource> </VOICE_ALERT_CONTENT> </VoiceItem> </VOICE_ALERT_PROFILE> </ContentProfile> </Message_Profile>