{"id":5121,"date":"2025-02-05T13:25:22","date_gmt":"2025-02-05T19:25:22","guid":{"rendered":"http:\/\/www.multitech.net\/developer\/?page_id=5121"},"modified":"2025-02-05T13:27:42","modified_gmt":"2025-02-05T19:27:42","slug":"viewing-inbound-fax-logs","status":"publish","type":"page","link":"https:\/\/www.multitech.net\/developer\/software\/faxfinder\/web-services-api\/fax-log-apis\/viewing-inbound-fax-logs\/","title":{"rendered":"Viewing Inbound Fax Logs"},"content":{"rendered":"

Requires FaxFinder 3.0.4 or higher.<\/em><\/p>\n\n\n\n\n\n
\n

Query Parameters<\/p>\n<\/td>\n

\n

limit=LIMIT<\/strong><\/p>\n

Limit the number of results to LIMIT.<\/p>\n

index=INDEX (Must be used with limit)<\/strong> <\/p>\n

Index indicates where to start reading the data in the database. Use to page through data.<\/p>\n

include_call_info=true|false <\/strong><\/p>\n

Set to true to include call details. Requesting this information increases the response size.\n<\/p>\n<\/td>\n<\/tr>\n

\n

HTTP Request Line<\/p>\n<\/td>\n

\n

GET \/ffws\/v1\/inbound_log HTTP\/1.1<\/p>\n

GET \/ffws\/v1\/inbound_log\/FAXKEY HTTP\/1.1<\/p>\n<\/td>\n<\/tr>\n

\n

HTTP Response Status Codes<\/p>\n<\/td>\n

\n

200 OK<\/p>\n<\/td>\n

\n

Shows inbound fax log.<\/p>\n<\/td>\n<\/tr>\n

\n

400 Bad Request<\/p>\n<\/td>\n

\n

The provided XML is not valid.<\/p>\n<\/td>\n<\/tr>\n<\/table>\n

Example<\/h4>\n
\r\nGET \/ffws\/v1\/inbound_log HTTP\/1.1 \r\ncontent-type: application\/xml \r\nauthorization: Basic YWRtaW46YWRtaW4= \r\n----------------------------------- \r\nHTTP\/1.1 200 OK \r\ncontent-type: application\/xml\r\n<?xml version=\u201d1.0\u201d encoding=\u201dUTF-8\u201d?> \r\n<response>\r\n\t  <message>Success<\/message>\r\n\t  <inbound_fax_entry>\r\n\t\t\t<filename>fax_inbound_20131023_135211_recv0000.tif<\/filename>\r\n\t\t\t<status>complete<\/status>\r\n\t\t\t<complete_time>07\/24\/2013 09:50:18 PM<\/complete_time>\r\n\t\t\t<remote_id>POTS modem - 5739<\/remote_id>\r\n\t\t\t<pages>1<\/pages>\r\n\t\t\t<extension><\/extension>\r\n\t\t\t<recipient_name>Line 2<\/recipient_name>\r\n\t\t\t<channel>2<channel> OR <modem>2<\/modem>\r\n\t\t\t<delivered_to>\r\n\t\t\t\t  <type>Email<\/type>\r\n\t\t\t\t  <destination>cla@mts.test<\/destination>\r\n\t\t\t<\/delivered_to>\r\n\t\t\t<delivered_to>\r\n\t\t\t\t  <type>Email<\/type>\r\n\t\t\t\t  <destination>sdfa@sdf.com<\/destination>\r\n\t\t\t<\/delivered_to>\r\n\t\t\t<delivery_error>  (Only if there were errors)\r\n\t\t\t\t<error><\/error>\r\n\t\t\t<\/delivery_error>\r\n\t\t\t<call_entry>\r\n\t\t\t\t<modem_number>2<\/modem_number>\r\n\t\t\t\t<status>pass<\/status>\r\n\t\t\t\t<remote_id>POTS modem - 5739<\/remote_id>\r\n\t\t\t\t<size>24298<\/size>\r\n\t\t\t\t<pages>1<\/pages>\r\n\t\t\t\t<resolution>Fine<\/resolution>\r\n\t\t\t\t<baud_rate>14400<\/baud_rate>\r\n\t\t\t\t<width>1728<\/width>\r\n\t\t\t\t<height>Variable<\/height>\r\n\t\t\t\t<data_compression>mh<\/data_compression>\r\n\t\t\t\t<error_correction>on<\/error_correction>\r\n\t\t\t\t<init_time>2013-07-24T17:25:49<\/init_time>\r\n\t\t\t\t<off_hook_time>2013-07-24T18:49:36<\/off_hook_time>\r\n\t\t\t\t<connect_time>2013-07-24T18:49:49<\/connect_time>\r\n\t\t\t\t<elapsed_time>25<\/elapsed_time>\r\n\t\t\t\t<scan_line_time>0<\/scan_line_time>\r\n\t\t\t<\/call_entry>\r\n\t\t\t<location>\/\/172.16.0.5\/share\/archive\/inbound\/user1\/fax_inbound_20131023_135211_recv0000.tif<\/location>\r\n\t  <\/inbound_fax_entry>\r\n<\/response>\r\n<\/pre>\n","protected":false},"excerpt":{"rendered":"
Requires FaxFinder 3.0.4 or higher. Query Parameters limit=LIMIT 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. Requesting this information increases the response size. HTTP Request Line […]<\/p>\n","protected":false},"author":537,"featured_media":0,"parent":5415,"menu_order":27,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_bbp_topic_count":0,"_bbp_reply_count":0,"_bbp_total_topic_count":0,"_bbp_total_reply_count":0,"_bbp_voice_count":0,"_bbp_anonymous_reply_count":0,"_bbp_topic_count_hidden":0,"_bbp_reply_count_hidden":0,"_bbp_forum_subforum_count":0,"footnotes":""},"class_list":["post-5121","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/5121","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/users\/537"}],"replies":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/comments?post=5121"}],"version-history":[{"count":10,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/5121\/revisions"}],"predecessor-version":[{"id":33697,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/5121\/revisions\/33697"}],"up":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/5415"}],"wp:attachment":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/media?parent=5121"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}