1. Manuals
  2. Brands
  3. Multitech Manuals
  4. Fax Machine
  5. FaxFinder FF240-IP
  6. Developer's manual

Multitech FaxFinder FF240-IP Developer's Manual

Fax over ip server
Hide thumbs Also See for FaxFinder FF240-IP:
Table of Contents

Advertisement

Quick Links

Download this manual See also: Administrator's Manual, User Manual
COPYRIGHT AND TECHNICAL SUPPORT
FaxFinder® Web Services API
FF240-IP, FF240, FF440, FF840 Developer Guide
1
Multi-Tech Systems, Inc. FaxFinder Web Service API Developer Guider

Advertisement

Table of Contents
loading

Related Manuals for Multitech FaxFinder FF240-IP

Summary of Contents for Multitech FaxFinder FF240-IP

  • Page 1 COPYRIGHT AND TECHNICAL SUPPORT FaxFinder® Web Services API FF240-IP, FF240, FF440, FF840 Developer Guide Multi-Tech Systems, Inc. FaxFinder Web Service API Developer Guider...
  • Page 2 The Knowledge Base provides immediate access to support information and resolutions for all Multi-Tech products. Visit http://www.multitech.com/kb.go. Support Portal To create an account and submit a support case directly to our technical support team, visit: https://support.multitech.com Support Business Hours: M-F, 9am to 5pm CT...

  • Page 3: Table Of Contents

    CONTENTS Contents General Information ..............................5 Authorization ..................................5 HTTPS ....................................5 Examples ..................................... 5 Additional Information ................................ 5 Faxing ..................................6 Scheduling a Fax .................................. 6 Viewing Fax Entries ................................8 Aborting a Fax Entry ................................9 Rescheduling a Fax Entry ..............................10 User Functions .................................
  • Page 4 CONTENTS Logs ..................................29 Viewing Inbound Fax Logs ..............................29 Viewing Outbound Fax Logs .............................. 30 Viewing Call Log ................................32 Viewing Inbound or Outbound Log Count ........................34 FaxFinder Configuration ............................35 Viewing Inbound Routes ..............................35 Deleting Inbound Routes ..............................37 Editing Inbound Routes ..............................

  • Page 5: General Information

    Examples Examples included in this document are also available through the Multi-Tech System Developer Resources website at multitech.net. This site includes a developer forum. Additional Information For more information about these functions, consult your FaxFinder Administrator Guide or Help File.

  • Page 6: Faxing

    FAXING Faxing Scheduling a Fax An application can schedule a fax by posting the schedule fax XML to the ofax resource. If the fax is scheduled successfully, a response is returned with the scheduled entries. Notes:  Place each file that you want to attach as fax pages in an attachment element. ...
  • Page 7 FAXING <phone_number>218-555-3336</phone_number> </recipient> <attachment> <location>inline</location> <name>attachment1.txt</name> <content_type>text/plain</content_type> <content_transfer_encoding>base64</content_transfer_encoding> <content>dGVzdA==</content> </attachment> <max_tries>3</max_tries> <priority>3</priority> <try_interval>30</try_interval> <receipt>failure</receipt> <receipt_attachment>none</receipt_attachment> <schedule_all_at>2008-08-07T20:30:00</schedule_all_at> </schedule_fax> ----------------------------------- HTTP/1.1 201 Created content-type: application/xml <?xml version=”1.0” encoding=”UTF-8”?> <response> <message>Success</message> <fax_entry> <fax_entry_url>https://192.168.2.1/ffws/v1/ofax/0000001B/0000</fax_entry_url> <fax_url>https://192.168.2.1/ffws/v1/ofax/0000001B</fax_url> <state>preprocessing</state> <schedule_message>New fax entry</schedule_message> <created>2008-08-01 08:43:29</created> <stime>2008-08-01 08:52:29</stime> <try_number>1</try_number> <agent>FFWS</agent>...

  • Page 8: Viewing Fax Entries

    FAXING <approval_time></approval_time> </fax_entry> </response> Viewing Fax Entries Query all_users=true|false Parameters An Admin level user can set this option to query all users instead of just faxes belonging to the authenticated user. complete_limit=LIMIT Limit the number of completed faxes returned in a general query (/ffws/v1/ofax) to LIMIT.

  • Page 9: Aborting A Fax Entry

    FAXING <comments>Test Message</comments> </cover_page> <sender> <username>admin</username> <name>Sender Name</name> <organization>Sender Org</organization> <phone_number>218-555-3333</phone_number> <fax_number>-218-555-3334</fax_number> <email_address>sender@Example.com</email_address> </sender> <recipient> <name>Rcpt 1 Name</name> <organization>Rcpt 1 Org</organization> <fax_number>218-555-3335</fax_number> <phone_number>218-555-3336</phone_number> </recipient> <max_tries>3</max_tries> <priority>3</priority> <try_interval>30</try_interval> <receipt>failure</receipt> <receipt_attachment>none</receipt_attachment> <pages>1</pages> </fax_entry> </response> Aborting a Fax Entry HTTP Request DELETE /ffws/v1/ofax/FAXKEY HTTP/1.1 Line DELETE /ffws/v1/ofax/FAXKEY/ENTRYKEY HTTP/1.1 HTTP Response...

  • Page 10: Rescheduling A Fax Entry

    FAXING Rescheduling a Fax Entry Query at=TIME Parameters TIME := now | DATETIME_UTC_URLENCODED DATETIME_UTC_URLENCODED := YYYY-MM-DDTHH%3AMM%3ASS PUT /ffws/v1/ofax/FAXKEY/ENTRYKEY?at=TIME HTTP/1.1 HTTP Request Line HTTP Response 202 Accepted Attempting to reschedule faxes. There is no guarantee that all Status Codes entries will be rescheduled. For instance, entries that are sending when the reschedule is received will not be rescheduled.

  • Page 11: User Functions

    USER FUNCTIONS User Functions Viewing User Information HTTP Request GET /ffws/v1/users/USERNAME HTTP/1.1 Line HTTP Response 200 OK Shows user information. Status Codes 403 Forbidden Authenticated user does not have permission to view data associated with username. 404 Not Found No user found with that username. Example GET /ffws/v1/users/admin HTTP/1.1 content-type: application/xml...

  • Page 12: Adding A User

    USER FUNCTIONS Example GET /ffws/v1/verify HTTP/1.1 content-type: application/xml authorization: Basic YWRtaW46YWRtaW4= ----------------------------------- HTTP/1.1 200 OK content-type: application/xml <?xml version=”1.0” encoding=”UTF-8”?> <response> <message>Verified</message> </response> Adding a User HTTP Request POST /ffws/v1/users HTTP/1.1 Line HTTP Response 200 OK Created user. Status Codes 403 Forbidden Authenticated user does not have permission to change data associated with username.

  • Page 13: Editing A User

    USER FUNCTIONS <max_attempts>2</max_attempts> <interval>600</interval> <receipt>never</receipt> <receipt_attachment>none</receipt_attachment> </user> </response> Editing a User HTTP Request PUT /ffws/v1/users/USERNAME HTTP/1.1 Line HTTP Response 200 OK Modified successfully. Status Codes 403 Forbidden Authenticated user does not have permission to change data. 404 Not Found User not found. 400 Bad Request The provided XML is not valid.

  • Page 14: Contact And Group Functions

    CONTACT AND GROUP FUNCTIONS Contact and Group Functions Viewing Contacts Query limit=LIMIT Parameters Limit the number of results to LIMIT. offset=OFFSET Skip OFFSET entries from the start. Only valid when limit is specified. name=SUBSTR fax_number=SUBSTR phone_number=SUBSTR organization=SUBSTR Search for contacts by field name. If you specify more than one, they are concatenated with AND.

  • Page 15: Adding New Contacts

    CONTACT AND GROUP FUNCTIONS Adding New Contacts HTTP Request POST /ffws/v1/contacts/USERNAME HTTP/1.1 Line HTTP Response 200 OK Created Status Codes 403 Forbidden Authenticated user does not have permission to change data associated with username. 404 Not Found No user found with that username. 400 Bad Request The provided XML is not valid.

  • Page 16: Deleting Contacts

    CONTACT AND GROUP FUNCTIONS Example PUT /ffws/v1/contacts/admin/6 HTTP/1.1 content-type: application/xml authorization: Basic YWRtaW46YWRtaW4= <?xml version=”1.0” encoding=”UTF-8”?> <contact> <name> Change name </name> <fax_number>218-555-3335</fax_number> <phone_number>218-555-3336</phone_number> <organization>Some org</organization> </contact> ----------------------------------- HTTP/1.1 200 OK content-type: application/xml <?xml version=”1.0” encoding=”UTF-8”?> <response> <message>Modified</message> </response> Deleting Contacts DELETE /ffws/v1/contacts/USERNAME/id HTTP/1.1 HTTP Request Line...

  • Page 17: Viewing Groups

    CONTACT AND GROUP FUNCTIONS Example GET /ffws/v1/contact_oids/admin HTTP/1.1 content-type: application/xml authorization: Basic YWRtaW46YWRtaW4= ----------------------------------- HTTP/1.1 200 OK content-type: application/xml <?xml version=”1.0” encoding=”UTF-8”?> <response> <message>Success</message> <oids>1,2,3,4,5,6,7,8,9,10,11,12,13,14,33,34,35</oids> </response> Viewing Groups Query limit=LIMIT Parameters Limit the number of results to LIMIT. offset=OFFSET Skip OFFSET entries from the start. Only valid when limit is specified. name=SUBSTR description=SUBSTR Search for groups by field name.

  • Page 18: Creating A New Group

    CONTACT AND GROUP FUNCTIONS Example GET /ffws/v1/contact_groups/admin HTTP/1.1 content-type: application/xml authorization: Basic YWRtaW46YWRtaW4= ----------------------------------- HTTP/1.1 200 OK content-type: application/xml <?xml version=”1.0” encoding=”UTF-8”?> <response> <message>Success</message> <contact_group> <contact_group_url>https://172.16.128.5/ffws/v1/contact_groups/admin/4</contact_group_url> <name>g one</name> <description>g one</description> <contact>https://172.16.128.5/ffws/v1/contacts/admin/1</contact> <contact>https://172.16.128.5/ffws/v1/contacts/admin/2</contact> <contact>https://172.16.128.5/ffws/v1/contacts/global_contact_list/3</contact> </contact_group> <contact_group> <contact_group_url>https://172.16.128.5/ffws/v1/contact_groups/admin/6</contact_group_url> <name>g two</name> <description>g two org</description> <contact>https://172.16.128.5/ffws/v1/contacts/admin/2</contact>...

  • Page 19: Editing Groups

    CONTACT AND GROUP FUNCTIONS Example POST /ffws/v1/contact_groups/admin HTTP/1.1 content-type: application/xml authorization: Basic YWRtaW46YWRtaW4= <?xml version=”1.0” encoding=”UTF-8”?> <contact_group> <name>New Group from API</name> <description>Can I create one from the API</description> <contact>https://dot3/ffws/v1/contacts/admin/23</contact> <contact>https://dot3/ffws/v1/contacts/admin/24</contact> <contact>https://dot3/ffws/v1/contacts/admin/25</contact> <contact>https://dot3/ffws/v1/contacts/admin/26</contact> </contact_group> ---------------------- <?xml version=”1.0” encoding=”UTF-8”?> <response> <message>Created</message> <contact_group> <contact_group_url>https://dot3/ffws/v1/contact_groups/admin/14</contact_group_url>...

  • Page 20: Deleting Groups

    CONTACT AND GROUP FUNCTIONS Example PUT /ffws/v1/contact_groups/admin/6 HTTP/1.1 content-type: application/xml authorization: Basic YWRtaW46YWRtaW4= <?xml version=”1.0” encoding=”UTF-8”?> <contact_group> <contact_group_url>https://172.16.128.5/ffws/v1/contact_groups/admin/4</contact_group_url> <name>Change name</name> <description>change description</description> <contact>https://172.16.128.5/ffws/v1/contacts/admin/1</contact> <contact>https://172.16.128.5/ffws/v1/contacts/admin/2</contact> <contact>https://172.16.128.5/ffws/v1/contacts/global_contact_list/3</contact> </contact_group> ----------------------------------- HTTP/1.1 200 OK content-type: application/xml <?xml version=”1.0” encoding=”UTF-8”?> <response> <message>Modified</message> </response> Deleting Groups HTTP Request DELETE /ffws/v1/contact_groups/USERNAME/id HTTP/1.1 Line...
  • Page 21 CONTACT AND GROUP FUNCTIONS Example GET /ffws/v1/contact_group_oids/admin HTTP/1.1 content-type: application/xml authorization: Basic YWRtaW46YWRtaW4= ----------------------------------- HTTP/1.1 200 OK content-type: application/xml <?xml version=”1.0” encoding=”UTF-8”?> <response> <message>Success</message> <oids>1,2,3,4,5,6,7,8,9,10,11,12,13,14,33,34,35</oids> </response> FaxFinder Web Services API Developer Guide...

  • Page 22: Cover Page

    Basic YWRtaW46YWRtaW4= ----------------------------------- HTTP/1.1 200 OK content-type: application/xml <?xml version=”1.0” encoding=”UTF-8”?> <response> <message>Success</message> <file> <name>default.pdf</name> <type>application/pdf</type> <url>https://192.168.2.1/ffws/v1/data/cover_pages/default.pdf</url> </file> <file> <name>multitech.pdf</name> <type>application/pdf</type> <url>https://192.168.2.1/ffws/v1/data/cover_pages/multitech.pdf</url> </file> <file> <name>sample1.pdf</name> <type>application/pdf</type> <url>https://192.168.2.1/ffws/v1/data/cover_pages/sample1.pdf</url> </file> <file> <name>sample2.pdf</name> <type>application/pdf</type> <url>https://192.168.2.1/ffws/v1/data/cover_pages/sample2.pdf</url> </file> </response> FaxFinder Web Services API Developer Guide...

  • Page 23: Fax Status

    FAX STATUS Fax Status Viewing Modem, Channel, System, Printer, and Share Status HTTP Request GET /ffws/v1/status HTTP/1.1 Line GET /ffws/v1/status/MODEM HTTP/1.1 (FF240, FF440, or FF840) GET /ffws/v1/status/CHANNEL HTTP/1.1 (FF240-IP) GET /ffws/v1/status/SYSTEM HTTP/1.1 GET /ffws/v1/status/PRINTER HTTP/1.1 GET /ffws/v1/status/SHARE HTTP/1.1 HTTP Response 200 OK Shows status information.

  • Page 24: Viewing Channel Status (Ff240-Ip Only)

    LOG FUNCTIONS content-type: application/xml <?xml version=”1.0” encoding=”UTF-8”?> <response> <message>Success</message> <status> <channel> <number_inbound></number_inbound> <number_outbound></number_outbound> <number_idle></number_idle> </channel> <system> <uptime></uptime> <current_time></current_time> <time_server></time_server> </system> <printer> <name></name> <status></status> <jobs></jobs> </printer> <network_share> <share></share> <status></status> </network_share> </status> </response> Viewing Channel Status (FF240-IP only) HTTP Request GET /ffws/v1/channel_status HTTP/1.1 Line GET /ffws/v1/channel_status/CHANNEL HTTP/1.1 (Where CHANNEL is the channel number)

  • Page 25: Viewing Modem Status (Ff240, Ff440, Ff840)

    FAX STATUS Example GET /ffws/v1/channel_status/1 HTTP/1.1 content-type: application/xml authorization: Basic YWRtaW46YWRtaW4= <?xml version=”1.0” encoding=”UTF-8”?> <response> <message>Success</message> <channel_status> <channel_number>1</channel_number> <state>Waiting for Ring</state> <pages_sent_recd>0</pages_sent_recd> <baud_rate></baud_rate> <fax_number></fax_number> <ecm></ecm> <line_encoding></line_encoding> <resolution></resolution> <remote_id></remote_id> <modulation></modulation> </channel_status> </response> Viewing Modem Status (FF240, FF440, FF840) HTTP Request GET /ffws/v1/modem_status HTTP/1.1 Line GET /ffws/v1/modem_status/MODEM HTTP/1.1 (where MODEM is a number from 1-24 depending on FaxFinder model and if using an Expansion Module.)

  • Page 26: Viewing Outbound Fax Status

    LOG FUNCTIONS Line HTTP Response 200 OK Shows status for currently inbound faxes. Status Codes 400 Bad Request The provided XML is not valid. FF240, FF440, or FF840 Example GET /ffws/v1/inbound_status HTTP/1.1 content-type: application/xml authorization: Basic YWRtaW46YWRtaW4= <?xml version=”1.0” encoding=”UTF-8”?> <response>...
  • Page 27 FAX STATUS Use with class. Limits sending faxes to specified number. If sending_limit is not specified, class returns ten sending faxes. HTTP Request GET /ffws/v1/outbound_status HTTP/1.1 Line HTTP Response 200 OK Shows status for currently outbound faxes. Status Codes 404 Not Found No current outbound faxes found.
  • Page 28 LOG FUNCTIONS Example GET /ffws/v1/outbound_status HTTP/1.1 content-type: application/xml authorization: Basic YWRtaW46YWRtaW4= ----------------------------------- HTTP/1.1 200 OK content-type: application/xml <?xml version=”1.0” encoding=”UTF-8”?> <response> <message>Success</message> <fax_entry> <fax_entry_url>https://dot10/ffws/v1/ofax/00000109/0001</fax_entry_url> <fax_url>https://dot10/ffws/v1/ofax/00000109</fax_url> <state>sending</state> <schedule_message></schedule_message> <created>2013-07-16T21:25:17</created> <stime>2013-07-16T21:25:30</stime> <try_number>1</try_number> <agent>WebClient</agent> <!--To view the fax --> <preview>https://dot10/ffws/v1/data/preview/00000109-0001.pdf</preview> <cover_page> <enabled>true</enabled> <url>https://dot10/ffws/v1/data/cover_pages/mts_template3.pdf</url> <subject>test</subject>...

  • Page 29: Logs

    LOG FUNCTIONS Logs Viewing Inbound Fax Logs Query limit=LIMIT Parameters Limit the number of results to LIMIT. index=INDEX (Must be used with limit) Index indicates where to start reading the data in the database. Use to page through data. include_call_info=true|false Set to true to include call details.

  • Page 30: Viewing Outbound Fax Logs

    LOG FUNCTIONS <status>pass</status> <remote_id>POTS modem - 5739</remote_id> <size>24298</size> <pages>1</pages> <resolution>Fine</resolution> <baud_rate>14400</baud_rate> <width>1728</width> <height>Variable</height> <data_compression>mh</data_compression> <error_correction>on</error_correction> <init_time>2013-07-24T17:25:49</init_time> <off_hook_time>2013-07-24T18:49:36</off_hook_time> <connect_time>2013-07-24T18:49:49</connect_time> <elapsed_time>25</elapsed_time> <scan_line_time>0</scan_line_time> </call_entry> <location>//172.16.0.5/share/archive/inbound/user1/fax_inbound_20131023_135211_recv0000.tif</location> </inbound_fax_entry> </response> Viewing Outbound Fax Logs Query limit=LIMIT Parameters Limit the number of results to LIMIT. index=INDEX (Must be used with limit) Index indicates where to start reading the data in the database.
  • Page 31 LOG FUNCTIONS Example GET /ffws/v1/outbound_log HTTP/1.1 content-type: application/xml authorization: Basic YWRtaW46YWRtaW4= ----------------------------------- HTTP/1.1 200 OK content-type: application/xml <?xml version=”1.0” encoding=”UTF-8”?> <response> <message>Success</message> <outbound_fax_entry> <fax_entry_url>https://dot10/ffws/v1/outbound_log/00000110/0000</fax_entry_url> <fax_url>https://dot10/ffws/v1/outbound_log/00000110</fax_url> <!--To view the fax --> <preview>https://dot10/ffws/v1/data/preview/00000110-0000.pdf</preview> <status>sent</status> <start_time>07/23/2013 04:02:16 PM</start_time> <end_time>07/23/2013 04:03:05 PM</end_time> <username>admin</username> <agent>WebClient</agent> <pages>0</pages>...

  • Page 32: Viewing Call Log

    LOG FUNCTIONS Viewing Call Log Query limit=LIMIT Parameters Limit the number of results to LIMIT. index=INDEX (Must be used with limit) Index indicates where to start reading the data in the database. Use to page through data. HTTP Request GET /ffws/v1/call_log HTTP/1.1 Line 200 OK Shows call logs.
  • Page 33 LOG FUNCTIONS FF240-IP Example GET /ffws/v1/call_log HTTP/1.1 content-type: application/xml authorization: Basic YWRtaW46YWRtaW4= ----------------------------------- HTTP/1.1 200 OK content-type: application/xml <?xml version=”1.0” encoding=”UTF-8”?> <response> <message>Success</message> <call_entry> <channel></channel> <status></status> <fax_number></fax_number> <direction></direction> <pages></pages> <size></size> <connect_time></connect_time> <elapsed_time></elapsed_time> <baud_rate></baud_rate> <data_compression></data_compression> <error_correction></error_correction> <modulation></modulation> <!--Inbound calls only. --> <all_call_digits></all_call_digits>...

  • Page 34: Viewing Inbound Or Outbound Log Count

    LOG FUNCTIONS Viewing Inbound or Outbound Log Count HTTP Request GET /ffws/v1/outbound_log_count HTTP/1.1 Line GET /ffws/v1/inbound_log_count HTTP/1.1 HTTP Response 200 OK Shows current T38 configuration. Status Codes 400 Bad Request The provided XML is not valid. Example GET /ffws/v1/outbound_log_count HTTP/1.1 content-type: application/xml authorization: Basic YWRtaW46YWRtaW4= -----------------------------------...

  • Page 35: Faxfinder Configuration

    FAXFINDER CONFIGURATION FaxFinder Configuration Viewing Inbound Routes HTTP Request GET /ffws/v1/routes HTTP/1.1 Line GET /ffws/v1/routes/global HTTP/1.1 GET /ffws/v1/routes/lines HTTP/1.1 (FF240, FF440, or FF840) GET /ffws/v1/routes/lines/line_number HTTP/1.1 (FF240, FF440, or FF840) GET /ffws/v1/routes/default HTTP/1.1 (FF240-IP only) GET /ffws/v1/routes/recipients HTTP/1.1 GET /ffws/v1/routes/recipients/ID HTTP/1.1 200 OK Shows inbound routes.
  • Page 36 FAXFINDER CONFIGURATION <recipients> <recipient> <recipient_id>1</recipient_id> <extension>1234</extension> <description>Yoda</description> <destination> <type>Email</type> <value>test2@email</value> </destination> </recipient> </recipients> </response> FF240, FF440, or FF840 Example Inbound Routes for Lines GET /ffws/v1/routes/lines HTTP/1.1 content-type: application/xml authorization: Basic YWRtaW46YWRtaW4= ----------------------------------- HTTP/1.1 200 OK content-type: application/xml <?xml version=”1.0” encoding=”UTF-8”?> <response>...

  • Page 37: Deleting Inbound Routes

    FAXFINDER CONFIGURATION </default> </response> Deleting Inbound Routes HTTP Request DELETE /ffws/v1/routes/global HTTP/1.1 Line DELETE /ffws/v1/routes/lines/line_number HTTP/1.1 (FF240, FF440, or FF840) DELETE /ffws/v1/routes/default HTTP/1.1 (FF240-IP only) DELETE /ffws/v1/routes/recipient/ID HTTP/1.1 HTTP Response 200 OK Deleted specified inbound routes. Status Codes 403 Forbidden Authenticated user does not have permission to change data.

  • Page 38: Viewing Store And Forward (T.37) Settings

    FAXFINDER CONFIGURATION Example PUT /ffws/v1/routes/global HTTP/1.1 content-type: application/xml authorization: Basic YWRtaW46YWRtaW4= <?xml version=”1.0” encoding=”UTF-8”?> <global> <destination> <type>User</type> <value>admin</value> </destination> <destination> <type>Email</type> <value>newb@mts.test</value> </destination> <destination> <type>Notify</type> <value>new_fax@mts.test</value> </destination> </global> Viewing Store and Forward (T.37) Settings HTTP Request GET /ffws/v1/t37 HTTP/1.1 Line 200 OK Shows current store and forward settings.

  • Page 39: Editing Store And Forward (T.37) Settings

    FAXFINDER CONFIGURATION Editing Store and Forward (T.37) Settings HTTP Request PUT /ffws/v1/t37 HTTP/1.1 Line HTTP Response 200 OK Store and forward setting successfully changed. Status Codes 400 Bad Request The provided XML is not valid. Example PUT /ffws/v1/t37 HTTP/1.1 content-type: application/xml authorization: Basic YWRtaW46YWRtaW4= <?xml version=”1.0”...

  • Page 40: Editing Modem Settings (Ff240, Ff440, Or Ff840)

    FAXFINDER CONFIGURATION Example GET /ffws/v1/modem content-type: application/xml authorization: Basic YWRtaW46YWRtaW4= ----------------------------------- HTTP/1.1 200 OK content-type: application/xml <?xml version=”1.0” encoding=”UTF-8”?> <response> <message>Success</message> <modem> <number>1</number> <fax_id>x40 Modem 1</fax_id> <country_code>United States(US)</country_code> <answer_on>2</answer_on> <max_extension_digits>4</max_extension_digits> <routing>Pots Line</routing> <routing_definition></routing_definition> <baud_rate>33600</baud_rate> <dial_prefix></dial_prefix> <init_string></init_string> <fax_direction></fax_direction> <error_correction>true</error_correction> <smart_dial>true</smart_dial> <tone_dial>true</tone_dial> <fax_debugging>false</fax_direction>...

  • Page 41: Viewing Sip Settings (Ff240-Ip Only)

    FAXFINDER CONFIGURATION <fax_debugging>false</fax_direction> </modem> ----------------------------------- HTTP/1.1 200 OK content-type: application/xml <?xml version=”1.0” encoding=”UTF-8”?> <response> <message>Modified</message> </response> Viewing SIP Settings (FF240-IP only) HTTP Request GET /ffws/v1/sip HTTP/1.1 Line HTTP Response 200 OK Shows current SIP configuration. Status Codes 400 Bad Request The provided XML is not valid.

  • Page 42: Editing Sip Settings (Ff240-Ip Only)

    FAXFINDER CONFIGURATION Editing SIP Settings (FF240-IP only) HTTP Request PUT /ffws/v1/sip HTTP/1.1 Line HTTP Response 200 OK SIP settings successfully changed. Status Codes 400 Bad Request The provided XML is not valid. Example PUT /ffws/v1/sip HTTP/1.1 content-type: application/xml authorization: Basic YWRtaW46YWRtaW4= <?xml version=”1.0”...

  • Page 43: Editing T38 Settings (Ff240-Ip Only)

    FAXFINDER CONFIGURATION <fax_id>FF240-IP</fax_id> <max_rate>14400</max_rate> <fax_method>T.38 Re-Invite</fax_method> <error_correction>true</error_correction> <fax_codec>alaw,ulaw</fax_codec> <dial_prefix></dial_prefix> <redundancy_level>3</redundancy_level> <jitter_buffer_delay>300</jitter_buffer_delay> <max_buffer>4000</max_buffer> <max_datagram>948</max_datagram> <extension_source>SIP To Header</extension_source> <extension_digits>Use All</extension_digits> <extension_length>0</extension_length> <channel_reservation_inbound>0</channel_reservation_inbound> <channel_reservation_outbound>0</channel_reservation_outbound> </t38> </response> Editing T38 Settings (FF240-IP only) PUT /ffws/v1/T38 HTTP/1.1 HTTP Request Line HTTP Response 200 OK T38 settings successfully changed. Status Codes 400 Bad Request The provided XML is not valid.

  • Page 44: Viewing Add Global Contacts Status Of Non-Admin Users

    FAXFINDER CONFIGURATION Viewing Add Global Contacts Status of Non-Admin Users HTTP Request GET /ffws/v1/user_options HTTP/1.1 Line HTTP Response 200 OK Current status of global contacts. Status Codes 400 Bad Request The provided XML is not valid. Example GET /ffws/v1/user_options HTTP/1.1 content-type: application/xml authorization: Basic YWRtaW46YWRtaW4= -----------------------------------...

  • Page 45: About Faxfinder

    FAXFINDER CONFIGURATION About FaxFinder Viewing Information about the FaxFinder HTTP Request Line GET /ffws/v1/about HTTP/1.1 HTTP Response Status 200 OK Success Codes Example GET /ffws/v1/verify HTTP/1.1 content-type: application/xml authorization: Basic YWRtaW46YWRtaW4= ----------------------------------- HTTP/1.1 200 OK content-type: application/xml <?xml version=”1.0” encoding=”UTF-8”?> <response>...

  • Page 46: Elements

    ELEMENTS Elements General Status Codes Be aware that other Status Codes that do not pertain specifically to the resource requested may be returned. See RFC 2616 for a listing of all possible codes. Some FFWS general errors: Error Description 401 Unauthorized Authorization required.
  • Page 47 ELEMENTS <!-- default: “” --> <!-- required: no --> <!-- value: string --> <organization>Sender Org</organization> <!-- Sender phone number --> <!-- default: “” --> <!-- required: no --> <!-- value: string --> <phone_number>218-555-3333</phone_number> <!-- Sender fax number --> <!-- default: “” --> <!-- required: no -->...
  • Page 48 ELEMENTS <!-- application/postscript --> <!-- text/plain --> <!-- image/tiff --> <!-- required: yes if location == inline --> <!-- value: string --> <content_type>text/plain</content_type> <!-- Content encoding --> <!-- Must be set to base64 --> <!-- required: yes if location == inline --> <!-- value: string -->...

  • Page 49: Fax Entry Element

    ELEMENTS <!-- scheduled to send as soon as possible. --> <!-- Format: %FT%T --> <!-- required: no --> <!-- value: string --> <schedule_all_at>2008-08-07T20:30:00</schedule_all_at> </schedule_fax> Fax Entry Element This element represents an actual fax that will be sent. Some of the elements are the same as elements provided in schedule_fax.
  • Page 50 ELEMENTS <preview>https://172.16.0.13/ffws/v1/data/preview/00000FD1-0000.pdf</preview> <cover_page> <enabled>false</enabled> <url></url> <subject></subject> <comments></comments> </cover_page> <sender> <username>admin</username> <name></name> <organization></organization> <phone_number></phone_number> <fax_number></fax_number> <email_address></email_address> </sender> <recipient> <name>test recipient</name> <organization>test org</organization> <fax_number>5816</fax_number> <phone_number></phone_number> </recipient> <max_tries>3</max_tries> <priority>3</priority> <try_interval>300</try_interval> <receipt>failure</receipt> <receipt_attachment>failure</receipt_attachment> <pages>6</pages> <approver>_SYSTEM_</approver> <approval_time>2009-01-30T04:43:28</approval_time> <!-- Modem level information included when include_modem_info=true. --> <!-- A modem entry is added for each attempt and is only available -->...

  • Page 51: User Element

    ELEMENTS User Element This element represents a user registered on the FaxFinder. <!-- Describes a User --> <user> <!-- Url of this user --> <!-- value: string --> <user_url>https://192.168.2.1/ffws/v1/users/admin</user_url> <!-- Full name of user --> <!-- required: yes --> <!-- value: string --> <name>Administrator</name>...

  • Page 52: Contact Element

    ELEMENTS Contact Element This element represents a user contact. <!-- Describes a Contact --> <contact> <!-- URL of this contact --> <!-- value: string --> <contact_url>https://192.168.2.1/ffws/v1/contacts/admin/1</contact_url> <!-- Contact Name --> <!-- required: yes --> <!-- value: string --> <name>contact name</name> <!-- Contact Fax number -->...

  • Page 53: Inbound Routing Fax Element

    ELEMENTS Inbound Routing Fax Element This element represents an inbound route. <!-- Describes global route destination--> <global> <destination> <!-- Describes destination option--> <!-- required: yes --> <!-- Can be one of: --> <!--Email --> <!--Notify --> <!-- User -> <!--Notify User --> <!--Share -->...
  • Page 54 ELEMENTS <!-- For Notify User value = username --> <!-- For Share value = network share folder--> <!-- For Sftp value = SFTP server --> <!-- For Print value = printer name --> <!-- For Trash no value needed--> <value>cla@mts.test</value> </destination>...
  • Page 55 ELEMENTS <type>Email</type> <!-- Additional information required based on type --> <!--For Email value = the email address --> <!-- For Notify value = the email address --> <!-- For User value = username - -> <!-- For Notify User value = username --> <!-- For Share value = network share folder-->...

This manual is also suitable for:

Faxfinder ff240Faxfinder ff440Faxfinder ff840

Table of Contents