FaxMessages APIs
-
Update Existing Fax Message
Description: Updates the fax message parameters and content.Usage:
PUT api/Messages/Fax/Update/{FaxCode}
Parameter Type Source Description FaxCode Int32 FromUri The unique numerical code of the fax message to update FaxObject Message_Profile FromBody The Fax_Message object containing the modifications Returns:
Returns the updated Fax_Message object which includes any new fragment codes in its content.
Examples:
<!-- Intent: Update fax message with faxcode of 100000 PUT to the following url http://api.v4.swiftreach.com/api/Messages/Fax/Update/100000 --> <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="Fax_Message"> <VoiceCode>100000</VoiceCode> <Name>API Fax</Name> <Description>created by api</Description> <CallerID>2012361344</CallerID> <CapacityLimit>0</CapacityLimit> <RingSeconds>60</RingSeconds> <CongestionAttempts>3</CongestionAttempts> <AutoRetries>1</AutoRetries> <AutoRetriesInterval>3</AutoRetriesInterval> <EnableWaterfall>false</EnableWaterfall> <EnableAnsweringMachineDetection>false</EnableAnsweringMachineDetection> <VoiceType>fax_message</VoiceType> <Body> <FAX_TEXT_SOURCE xsi:type="FAX_TEXT_SOURCE_TEXT"> <Text>this is the body of my fax</Text> <TextType>fax_text_source_text</TextType> </FAX_TEXT_SOURCE> </Body> </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="Fax_Message"> <VoiceCode>100000</VoiceCode> <Name>API Fax</Name> <Description>created by api</Description> <CallerID>2012361344</CallerID> <CapacityLimit>0</CapacityLimit> <RingSeconds>60</RingSeconds> <CongestionAttempts>3</CongestionAttempts> <AutoRetries>1</AutoRetries> <AutoRetriesInterval>3</AutoRetriesInterval> <EnableWaterfall>false</EnableWaterfall> <EnableAnsweringMachineDetection>false</EnableAnsweringMachineDetection> <VoiceType>fax_message</VoiceType> <Body> <FAX_TEXT_SOURCE xsi:type="FAX_TEXT_SOURCE_TEXT"> <Text>this is the body of my fax</Text> <TextType>fax_text_source_text</TextType> </FAX_TEXT_SOURCE> </Body> </Message_Profile>