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

Requires FaxFinder 3.0.4 or higher.<\/em><\/p>\n\n\n\n\n\n\n
Query Parameters<\/td>\nclass=pending|sending (Default=pending and sending)<\/strong><\/p>\n

Limit outbound status listing to a set number of pending and sending faxes.p><\/p>\n

pending_limit=PEND_LIMIT (Default=10)<\/strong><\/p>\n

Use with class. Limits pending faxes to specified number. If pending_limit is not specified, class returns ten pending faxes. p><\/p>\n

sending_limit=SEND_LIMIT (Default=10)<\/strong><\/p>\n

Use with class. Limits sending faxes to specified number. If sending_limit is not specified, class returns ten sending faxes.<\/td>\n<\/tr>\n

HTTP Request Line<\/td>\nGET \/ffws\/v1\/outbound_status HTTP\/1.1<\/td>\n<\/tr>\n
HTTP Response Status Codes<\/td>\n200 OK<\/td>\nShows status for currently outbound faxes.<\/td>\n<\/tr>\n
404 Not Found<\/td>\nNo current outbound faxes found.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Example<\/h4>\n
GET \/ffws\/v1\/outbound_status 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  <fax_entry>\r\n\t\t\t<fax_entry_url>https:\/\/dot10\/ffws\/v1\/ofax\/00000109\/0001<\/fax_entry_url>\r\n\t\t\t<fax_url>https:\/\/dot10\/ffws\/v1\/ofax\/00000109<\/fax_url>\r\n\t\t\t<state>sending<\/state>\r\n\t\t\t<schedule_message><\/schedule_message>\r\n\t\t\t<created>2013-07-16T21:25:17<\/created>\r\n\t\t\t<stime>2013-07-16T21:25:30<\/stime>\r\n\t\t\t<try_number>1<\/try_number>\r\n\t\t\t<agent>WebClient<\/agent>\r\n<!--To view the fax -->\r\n\t\t\t<preview>https:\/\/dot10\/ffws\/v1\/data\/preview\/00000109-0001.pdf<\/preview>   \r\n\t\t\t<cover_page>\r\n\t\t\t\t  <enabled>true<\/enabled>\r\n\t\t\t\t  <url>https:\/\/dot10\/ffws\/v1\/data\/cover_pages\/mts_template3.pdf<\/url>\r\n\t\t\t\t  <subject>test<\/subject>\r\n\t\t\t\t  <comments>test faxes for outbound and inbound status<\/comments>\r\n\t\t\t<\/cover_page>\r\n\t\t\t<sender>\r\n\t\t\t\t  <username>admin<\/username>\r\n\t\t\t\t  <name>Administrator<\/name>\r\n\t\t\t\t  <organization><\/organization>\r\n\t\t\t\t  <phone_number>1234<\/phone_number>\r\n\t\t\t\t  <fax_number><\/fax_number>\r\n\t\t\t\t  <email_address>cla@mts.test<\/email_address>\r\n\t\t\t<\/sender>\r\n\t\t\t<recipient>\r\n\t\t\t\t  <name>Avaya and Back 2<\/name>\r\n\t\t\t\t  <organization><\/organization>\r\n\t\t\t\t  <fax_number>8102<\/fax_number>\r\n\t\t\t\t  <phone_number><\/phone_number>\r\n\t\t\t<\/recipient>\r\n\t\t\t<max_tries>1<\/max_tries>\r\n\t\t\t<priority>3<\/priority>\r\n\t\t\t<try_interval>300<\/try_interval>\r\n\t\t\t<receipt>failure<\/receipt>\r\n\t\t\t<receipt_attachment>pdf<\/receipt_attachment>\r\n\t\t\t<pages>2<\/pages>\r\n\t\t\t<approver>_SYSTEM_<\/approver>\r\n\t\t\t<approval_time>2013-07-16T21:25:24<\/approval_time>\r\n\t  <\/fax_entry>\r\n<\/response><\/pre>\n","protected":false},"excerpt":{"rendered":"
Requires FaxFinder 3.0.4 or higher. Query Parameters class=pending|sending (Default=pending and sending) Limit outbound status listing to a set number of pending and sending faxes.p> pending_limit=PEND_LIMIT (Default=10) Use with class. Limits pending faxes to specified number. If pending_limit is not specified, class returns ten pending faxes. p> sending_limit=SEND_LIMIT (Default=10) Use with class. Limits sending faxes to […]<\/p>\n","protected":false},"author":537,"featured_media":0,"parent":5412,"menu_order":26,"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-5106","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/5106","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=5106"}],"version-history":[{"count":17,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/5106\/revisions"}],"predecessor-version":[{"id":33695,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/5106\/revisions\/33695"}],"up":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/5412"}],"wp:attachment":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/media?parent=5106"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}