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

Requires FaxFinder 3.0.4 or higher.<\/em><\/p>\n\n\n\n\n\n\n
Query Parameters<\/td>\nlimit=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.<\/td>\n<\/tr>\n

HTTP Request Line<\/td>\nGET \/ffws\/v1\/outbound_log HTTP\/1.1<\/p>\n

GET \/ffws\/v1\/outbound_log\/FAXKEY HTTP\/1.1<\/p>\n

GET \/ffws\/v1\/outbound_log\/FAXKEY\/ENTRYKEY HTTP\/1.1<\/td>\n<\/tr>\n

HTTP Response Status Codes<\/td>\n200 OK<\/td>\nShows outbound fax log.<\/td>\n<\/tr>\n
400 Bad Request<\/td>\nThe provided XML is not valid.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Example<\/h4>\n
GET \/ffws\/v1\/outbound_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<outbound_fax_entry>\r\n\t\t<fax_entry_url>https:\/\/dot10\/ffws\/v1\/outbound_log\/00000110\/0000<\/fax_entry_url>\r\n\t\t<fax_url>https:\/\/dot10\/ffws\/v1\/outbound_log\/00000110<\/fax_url>\r\n<!--To view the fax -->\r\n\t\t<preview>https:\/\/dot10\/ffws\/v1\/data\/preview\/00000110-0000.pdf<\/preview>   \r\n\t\t<status>sent<\/status>\r\n\t\t<start_time>07\/23\/2013 04:02:16 PM<\/start_time>\r\n\t\t<end_time>07\/23\/2013 04:03:05 PM<\/end_time>\r\n\t\t<username>admin<\/username>\r\n\t\t<agent>WebClient<\/agent>\r\n\t\t<pages>0<\/pages>\r\n\t\t<cover_page_used>1<\/cover_page_used>\r\n\t\t<cover_page_name>mts_template3.pdf<\/cover_page_name>\r\n\t\t<priority>3<\/priority>\r\n\t\t<sender_name>Administrator<\/sender_name>\r\n\t\t<sender_email>cla@mts.test<\/sender_email>\r\n\t\t<sender_phone>1234<\/sender_phone>\r\n\t\t<sender_fax><\/sender_fax>\r\n\t\t<sender_organization><\/sender_organization>\r\n\t\t<recipient_name>Avaya and Back 1<\/recipient_name>\r\n\t\t<recipient_fax>8101<\/recipient_fax>\r\n\t\t<recipient_phone><\/recipient_phone>\r\n\t\t<recipient_organization><\/recipient_organization>\r\n\t\t<subject><\/subject>\r\n\t\t<comments>test<\/comments>\r\n\t\t<call_entry>\r\n\t\t\t<modem_number>4<\/modem_number>\r\n\t\t\t<status>pass<\/status>\r\n\t\t\t<remote_id>FF240-IP<\/remote_id>\r\n\t\t\t<size>60342<\/size>\r\n\t\t\t<pages>1<\/pages>\r\n\t\t\t<resolution>Fine<\/resolution>\r\n\t\t\t<baud_rate>14400<\/baud_rate>\r\n\t\t\t<width><\/width>\r\n\t\t\t<height><\/height>\r\n\t\t\t<data_compression>MMR<\/data_compression>\r\n\t\t\t<error_correction>enabled<\/error_correction>\r\n\t\t\t<init_time><\/init_time>\r\n\t\t\t<off_hook_time><\/off_hook_time>\r\n\t\t\t<connect_time>2013-07-23T21:02:37<\/connect_time>\r\n\t\t\t<elapsed_time>25<\/elapsed_time>\r\n\t\t\t<scan_line_time>0<\/scan_line_time>\r\n\t\t\t<modulation>V17<\/modulation>\r\n\t\t<\/call_entry>\r\n\t<\/outbound_fax_entry>\r\n<\/response><\/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-5128","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/5128","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=5128"}],"version-history":[{"count":16,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/5128\/revisions"}],"predecessor-version":[{"id":33699,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/5128\/revisions\/33699"}],"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=5128"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}