Version 4.0

HOME

VoiceMessages APIs

• Get Voice Message Profile

  
  
  Description: Returns the Message_Profile object for the given voicecode

  Usage:

  GET api/Messages/Voice/{VoiceCode}

  Parameter	Type	Source	Description
  VoiceCode	Int32	FromUri	The unique numerical code identifying the voice message to return

  Returns:

  Returns Message_Profile object for the given voicecode. This can be up cast to its original type.

  Examples:

  XML | JSON | C# | PHP | JAVA

  
  <!-- Intent: retrieve the profile for voice message with voicecode of 100000
  	GET to the following url
  	http://api.v4.swiftreach.com/api/Messages/Voice/100000
  	-->
  
  <!-- No XML input is required -->
  
  <!-- 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>100000</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>