FaxMessages APIs
-
Create New Fax Message
Description: Creates a new fax messageUsage:
POST api/Messages/Fax/Create
Parameter Type Source Description FaxObject Message_Profile FromBody Fax_Message object Returns:
the new Fax_Message
Examples:
<!-- POST to the following url http://api.v4.swiftreach.com/api/Messages/Fax/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="Fax_Message"> <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>123456</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>