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

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

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

\n

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

GET \/ffws\/v1\/routes\/global HTTP\/1.1<\/p>\n

GET \/ffws\/v1\/routes\/lines HTTP\/1.1 (FF240, FF440, or FF840)<\/p>\n

GET \/ffws\/v1\/routes\/lines\/line_number HTTP\/1.1 (FF240, FF440, or FF840)<\/p>\n

GET \/ffws\/v1\/routes\/default HTTP\/1.1 (FF240-IP only)<\/p>\n

GET \/ffws\/v1\/routes\/recipients HTTP\/1.1<\/p>\n

GET \/ffws\/v1\/routes\/recipients\/ID 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 routes.<\/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

FF240, FF440, or FF840 Example All Inbound Routes<\/h4>\n
\r\nGET \/ffws\/v1\/routes 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<global>\r\n\t\t<destination>\r\n\t\t\t  <type>Email<\/type>\r\n\t\t\t  <value>cla@mts.test<\/value>\r\n\t\t<\/destination>\r\n\t\t<destination>\r\n\t\t\t  <destination_id>2<\/destination_id>\r\n\t\t\t  <type>Print<\/type>\r\n\t\t\t  <value>hp_printer<\/value>\r\n\t\t<\/destination>\r\n\t<\/global>\r\n\t<lines>\r\n\t\t<line>\r\n\t\t\t<line_number>1<\/line_number>\r\n\t\t\t<description>first line<\/description>\r\n\t\t\t<destination>\r\n\t\t\t<type>Email<\/type>\r\n\t\t\t<value>cla@mts.test<\/value>\r\n\t\t\t<\/destination>\r\n\t\t<\/line>\r\n\t\t<line>\r\n\t\t\t<line_number>2<\/line_number>\r\n\t\t\t<description>second line<\/description>\r\n\t\t\t<destination>\r\n\t\t\t<type>Notify<\/type>\t\r\n\t\t\t<value>test@mts.test<\/value>\r\n\t\t\t<\/destination>\r\n\t\t<\/line>\r\n\t<\/lines>\r\n\t<recipients>\r\n\t\t<recipient>\r\n\t\t\t<recipient_id>1<\/recipient_id>\r\n\t\t\t<extension>1234<\/extension>\r\n\t\t\t<description>Yoda<\/description>\r\n\t\t\t<destination>\r\n\t\t\t<type>Email<\/type>\r\n\t\t\t<value>test2@email<\/value>\r\n\t\t\t<\/destination>\r\n\t\t<\/recipient>\r\n\t<\/recipients>\r\n<\/response>\r\n<\/pre>\n
FF240, FF440, or FF840 Example Inbound Routes for Lines <\/h4>\n
\r\nGET \/ffws\/v1\/routes\/lines 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\t<lines>\r\n\t\t<line>\r\n\t\t\t<line_number>1<\/line_number>\r\n\t\t\t<description>first line<\/description>\r\n\t\t\t<destination>\r\n\t\t\t<type>Email<\/type>\r\n\t\t\t<value>cla@mts.test<\/value>\r\n\t\t\t<\/destination>\r\n\t\t<\/line>\r\n\t\t<line>\r\n\t\t\t<line_number>2<\/line_number>\r\n\t\t\t<description>second line<\/description>\r\n\t\t\t<destination>\r\n\t\t\t<type>Notify<\/type>\t\r\n\t\t\t<value>test@mts.test<\/value>\r\n\t\t\t<\/destination>\r\n\t\t<\/line>\r\n\t<\/lines>\r\n<\/response>\r\n<\/pre>\n
FF240-IP Example Inbound Default Routes <\/h4>\n
\r\nGET \/ffws\/v1\/routes\/lines 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<default>\r\n\t\t<destination>\r\n\t\t\t<type>User <\/type>\r\n\t\t\t<value>admin<\/value>\r\n\t\t<\/destination>\r\n\t<\/default>\r\n<\/response>\r\n<\/pre>\n","protected":false},"excerpt":{"rendered":"
Requires FaxFinder 3.0.4 or higher. HTTP Request Line GET \/ffws\/v1\/routes HTTP\/1.1 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 HTTP Response Status Codes 200 OK Shows inbound routes. 400 Bad Request The provided XML is […]<\/p>\n","protected":false},"author":537,"featured_media":0,"parent":5417,"menu_order":28,"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-5157","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/5157","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=5157"}],"version-history":[{"count":10,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/5157\/revisions"}],"predecessor-version":[{"id":33704,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/5157\/revisions\/33704"}],"up":[{"embeddable":true,"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/pages\/5417"}],"wp:attachment":[{"href":"https:\/\/www.multitech.net\/developer\/wp-json\/wp\/v2\/media?parent=5157"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}