{"items":[{"type":"link","label":"Fax2WSPull","link":"/fax/fax2ws-pull-api","routeSlug":"/fax/fax2ws-pull-api","content":{"contentType":"overview","meta":{"name":"Fax2WSPull"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"fax2ws-pull-api.json","url":"/_bundle/fax/fax2ws-pull-api.json?download"},{"kind":"download","label":"fax2ws-pull-api.yaml","url":"/_bundle/fax/fax2ws-pull-api.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://www.retarus.com/","url":"https://www.retarus.com/"},{"kind":"email","title":"Retarus","email":"info@retarus.com","label":"info@retarus.com","withCopyButton":true,"copyContent":"info@retarus.com"},{"kind":"externallink","label":"Terms of Service","labelTranslationKey":"info.termsOfService","url":"https://www.retarus.com/us/legal-disclaimer/"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/fax/fax2ws-pull-api","description":"Mock server","isMockServer":true},{"url":"https://api.de1.retarus.com/faxin/rest/v1","description":"Retarus data center in Frankfurt, Germany"},{"url":"https://api.de2.retarus.com/faxin/rest/v1","description":"Retarus data center in Munich, Germany"},{"url":"https://api.us1.retarus.com/faxin/rest/v1","description":"Retarus data center in Ashburn, United States"},{"url":"https://api.us2.retarus.com/faxin/rest/v1","description":"Retarus data center in Secaucus, United States"},{"url":"https://api.ch1.retarus.com/faxin/rest/v1","description":"Retarus data center in Zurich, Switzerland"},{"url":"https://api.sg1.retarus.com/faxin/rest/v1","description":"Retarus data center in Singapore"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Fax2WSPull (v0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fax2WSPull allows clients to actively retrieve faxes received"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for you via the Retarus cloud-based infrastructure instead of passively"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"waiting for them to be delivered to a web service. The unit of organization for this"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"process is the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"topic"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A topic represents one or more fax numbers that are used to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"receive faxes."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For each topic, the API provides information about received faxes,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"including the URL to the fax documents itself."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every inbound document showed as available is hidden after retrieval. However, fax"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"receipt should be acknowledged by the client in the retrieval process. If"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this doesn't happen within a pre-defined timeout period, the document is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"made available again, assuming that there was some issue with the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application during the retrieval process."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each request or response in this document is JSON serialized and encoded"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"using the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UTF-8"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" character set."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fax documents themselves are automatically deleted "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"7 days"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" after receipt by default,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"regardless of whether they were downloaded or not."},"children":[]}]}]}]}],"sectionId":"/fax/fax2ws-pull-api"}],"sectionId":"/fax/fax2ws-pull-api"}]}]}},{"type":"group","label":"Fax2WSPull Client","link":"/fax/fax2ws-pull-api/fax2wspull-client","routeSlug":"/fax/fax2ws-pull-api/fax2wspull-client","items":[{"label":"Retrieve fax jobs from a topic and confirm the receipt.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/fax/fax2ws-pull-api/fax2wspull-client/pollfaxinformation","routeSlug":"/fax/fax2ws-pull-api/fax2wspull-client/pollfaxinformation","metadata":{"seo":{"title":"Retrieve fax jobs from a topic and confirm the receipt.","description":"This endpoint is used for two types of processes:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"pollFaxInformation","name":"Retrieve fax jobs from a topic and confirm the receipt.","isWebhook":false,"pointer":"/paths/~1topics~1{topic}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve fax jobs from a topic and confirm the receipt.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is used for two types of processes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"On the one hand, you can retrieve a list of unlocked and non-acknowledged fax jobs"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from a topic owned by the authenticated user. The amount of fetched faxes is limited"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fetch"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter. On the other hand, you should acknowledge faxes that you"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"successfully received by specifying an URL-encoded list of fax job ids."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You retrieve the list of available faxes for a topic via a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request to the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"corresponding URL. The response consists of two parts: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"meta"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The  "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"meta"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" part contains information about the request"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and two URLs that the client should call after retreiving the jobs,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL. Retrieving the faxes themselves is described in the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation below."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL is used to retrieve an additional batch of available faxes. The"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"request also confirms that the previous jobs were successfully retrieved by the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"client through the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URL is just another call to the same URL with the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fetch"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter set to 0. It is used to confirm the reception of"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the previous jobs without retreiving information about new ones, for example in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"case a shutdown of the client is requested."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" URLs has the identical"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"structure and function as the ones described here."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" part contains information about the available fax"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"jobs. This includes both the metadata for the fax and the transmission and the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URLs from which the client can retrieve the fax images."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"httpBasicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The format is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<Retarus Customer Number>:<Password>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", encoded via Base 64."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The passwords are provided by Retarus and they can be associated to one or more incoming telephone numbers."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As for example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic OTk5OTk6S0tkUVNHSU1XME1mOTdiVA==\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic OTk5OTk6S0tkUVNHSU1XME1mOTdiVA==\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple processes can be operated concurrently by the Webservice using the same"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password or multiple passwords."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"topic","in":"path","schemaId":"schema_92","description":"Topic to be polled","required":true}],"pointer":"/paths/~1topics~1{topic}/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fetch","in":"query","schemaId":"schema_93","description":"Number of fax jobs requested by the customer to be fetched from the topic"},{"name":"ids","in":"query","schemaId":"schema_94","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of fax job ids to be acknowledged in this request. It must be comma-separated and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"presented in URL encoding, e.g. 365%2C366%2C367%2C368."},"children":[]}]}]}]},{"name":"timeout","in":"query","schemaId":"schema_95","description":"Lock timeout in seconds for a fax (by default 60). Once the metadata for a\nfax has been provided to a client, it will be marked as \"locked\" and not be\nreturned again in subsequent requests. If the timeout expires without the\nclient having acknowledged the correct receipt, the server will assume\nthat a problem has occurred and it will make the fax available again in the\nnext response.\n"}],"pointer":"/paths/~1topics~1{topic}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/topics/{topic}","servers":[{"url":"/_mock/fax/fax2ws-pull-api","description":"Mock server","isMockServer":true},{"url":"https://api.de1.retarus.com/faxin/rest/v1","description":"Retarus data center in Frankfurt, Germany"},{"url":"https://api.de2.retarus.com/faxin/rest/v1","description":"Retarus data center in Munich, Germany"},{"url":"https://api.us1.retarus.com/faxin/rest/v1","description":"Retarus data center in Ashburn, United States"},{"url":"https://api.us2.retarus.com/faxin/rest/v1","description":"Retarus data center in Secaucus, United States"},{"url":"https://api.ch1.retarus.com/faxin/rest/v1","description":"Retarus data center in Zurich, Switzerland"},{"url":"https://api.sg1.retarus.com/faxin/rest/v1","description":"Retarus data center in Singapore"}],"parameters":{"path":[{"name":"topic","in":"path","required":true,"example":"abc123","schemaId":"schema_92"}],"query":[{"name":"fetch","in":"query","required":false,"example":10,"schemaId":"schema_93"},{"name":"ids","in":"query","required":false,"example":"365%2C366%2C367%2C368","schemaId":"schema_94"},{"name":"timeout","in":"query","required":false,"schemaId":"schema_95"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"httpBasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/topics/{topic}","href":"fax2wspull-client/pollfaxinformation","openApiOperationId":"pollFaxInformation","summary":"Retrieve fax jobs from a topic and confirm the receipt."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/fax/fax2ws-pull-api","description":"Mock server","isMockServer":true},{"url":"https://api.de1.retarus.com/faxin/rest/v1","description":"Retarus data center in Frankfurt, Germany"},{"url":"https://api.de2.retarus.com/faxin/rest/v1","description":"Retarus data center in Munich, Germany"},{"url":"https://api.us1.retarus.com/faxin/rest/v1","description":"Retarus data center in Ashburn, United States"},{"url":"https://api.us2.retarus.com/faxin/rest/v1","description":"Retarus data center in Secaucus, United States"},{"url":"https://api.ch1.retarus.com/faxin/rest/v1","description":"Retarus data center in Zurich, Switzerland"},{"url":"https://api.sg1.retarus.com/faxin/rest/v1","description":"Retarus data center in Singapore"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TopicContents","exampleIds":["paths/~1topics~1{topic}/post/responses/200/content/application~1json/examples/twoFaxes","paths/~1topics~1{topic}/post/responses/200/content/application~1json/examples/ConfirmFax"]}},"schemaId":"components/schemas/TopicContents","exampleIds":["paths/~1topics~1{topic}/post/responses/200/content/application~1json/examples/twoFaxes","paths/~1topics~1{topic}/post/responses/200/content/application~1json/examples/ConfirmFax"]},{"code":"401","description":"Forbidden. Authentication information is missing or invalid"},{"code":"403","description":"Unauthorized acess. The authenticated user has no permission to fetch from the specified topic."}],"pointer":"/paths/~1topics~1{topic}/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TopicContents","exampleIds":["paths/~1topics~1{topic}/post/responses/200/content/application~1json/examples/twoFaxes","paths/~1topics~1{topic}/post/responses/200/content/application~1json/examples/ConfirmFax"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TopicContents","exampleIds":["paths/~1topics~1{topic}/post/responses/200/content/application~1json/examples/twoFaxes","paths/~1topics~1{topic}/post/responses/200/content/application~1json/examples/ConfirmFax"]}}},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fax2wspull-client/pollfaxinformation"}],"panels":[]}]},"httpPath":"/topics/{topic}"},{"label":"Download file by  file name (Id.Extension)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/fax/fax2ws-pull-api/fax2wspull-client/pollfaxdocuments","routeSlug":"/fax/fax2ws-pull-api/fax2wspull-client/pollfaxdocuments","metadata":{"seo":{"title":"Download file by  file name (Id.Extension)","description":"Download file by file name (Id.Extension)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"pollFaxDocuments","name":"Download file by  file name (Id.Extension)","isWebhook":false,"pointer":"/paths/~1files~1{id}.{extension}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download file by  file name (Id.Extension)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Download file by  file name (Id.Extension)\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"httpBasicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The format is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<Retarus Customer Number>:<Password>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", encoded via Base 64."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The passwords are provided by Retarus and they can be associated to one or more incoming telephone numbers."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As for example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic OTk5OTk6S0tkUVNHSU1XME1mOTdiVA==\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic OTk5OTk6S0tkUVNHSU1XME1mOTdiVA==\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple processes can be operated concurrently by the Webservice using the same"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password or multiple passwords."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_96","description":"File Id to be downloaded","required":true},{"name":"extension","in":"path","schemaId":"schema_96","description":"Extension of the file to be downloaded","required":true}],"pointer":"/paths/~1files~1{id}.{extension}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/files/{id}.{extension}","servers":[{"url":"/_mock/fax/fax2ws-pull-api","description":"Mock server","isMockServer":true},{"url":"https://api.de1.retarus.com/faxin/rest/v1","description":"Retarus data center in Frankfurt, Germany"},{"url":"https://api.de2.retarus.com/faxin/rest/v1","description":"Retarus data center in Munich, Germany"},{"url":"https://api.us1.retarus.com/faxin/rest/v1","description":"Retarus data center in Ashburn, United States"},{"url":"https://api.us2.retarus.com/faxin/rest/v1","description":"Retarus data center in Secaucus, United States"},{"url":"https://api.ch1.retarus.com/faxin/rest/v1","description":"Retarus data center in Zurich, Switzerland"},{"url":"https://api.sg1.retarus.com/faxin/rest/v1","description":"Retarus data center in Singapore"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_96"},{"name":"extension","in":"path","required":true,"schemaId":"schema_96"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"httpBasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/files/{id}.{extension}","href":"fax2wspull-client/pollfaxdocuments","openApiOperationId":"pollFaxDocuments","summary":"Download file by  file name (Id.Extension)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/fax/fax2ws-pull-api","description":"Mock server","isMockServer":true},{"url":"https://api.de1.retarus.com/faxin/rest/v1","description":"Retarus data center in Frankfurt, Germany"},{"url":"https://api.de2.retarus.com/faxin/rest/v1","description":"Retarus data center in Munich, Germany"},{"url":"https://api.us1.retarus.com/faxin/rest/v1","description":"Retarus data center in Ashburn, United States"},{"url":"https://api.us2.retarus.com/faxin/rest/v1","description":"Retarus data center in Secaucus, United States"},{"url":"https://api.ch1.retarus.com/faxin/rest/v1","description":"Retarus data center in Zurich, Switzerland"},{"url":"https://api.sg1.retarus.com/faxin/rest/v1","description":"Retarus data center in Singapore"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"401","description":"Authentication information is missing or invalid"}],"pointer":"/paths/~1files~1{id}.{extension}/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fax2wspull-client/pollfaxdocuments"}],"panels":[]}]},"httpPath":"/files/{id}.{extension}"}],"content":{"contentType":"group","meta":{"name":"Fax2WSPull Client"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fax2WSPull Client","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/topics/{topic}","summary":"Retrieve fax jobs from a topic and confirm the receipt.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fax2wspull-client/pollfaxinformation","deprecated":false},{"title":"/files/{id}.{extension}","summary":"Download file by  file name (Id.Extension)","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fax2wspull-client/pollfaxdocuments","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/TopicContents":{"id":"components/schemas/TopicContents","kind":"json-schema","title":"TopicContents","data":{"type":"object","required":["meta","results"],"properties":{"meta":{"$ref":"#/components/schemas/meta"},"results":{"type":"array","items":{"$ref":"#/components/schemas/results"}}}}},"components/schemas/meta":{"id":"components/schemas/meta","kind":"json-schema","title":"meta","data":{"type":"object","properties":{"version":{"type":"integer","example":1},"next":{"type":"string","example":"https://api.us1.retarus.com/faxin/rest/v1/topics/abc123?fetch=10&timeout=60&ids=29%2C30"},"exit":{"type":"string","example":"https://api.us1.retarus.com/faxin/rest/v1/topics/abc123?fetch=0&timeout=60&ids=29%2C30"},"topic":{"type":"string","example":"abc123"},"resultSize":{"type":"integer","example":2},"parameters":{"$ref":"#/components/schemas/parameters"}}}},"components/schemas/parameters":{"id":"components/schemas/parameters","kind":"json-schema","title":"parameters","data":{"type":"object","properties":{"fetch":{"type":"integer","example":10},"timeout":{"type":"integer","example":60},"ids":{"type":"array","items":{"$ref":"#/components/schemas/id"}}}}},"components/schemas/id":{"id":"components/schemas/id","kind":"json-schema","title":"id","data":{"type":"string","example":"10001234"}},"components/schemas/results":{"id":"components/schemas/results","kind":"json-schema","title":"results","data":{"type":"array","items":{"$ref":"#/components/schemas/result"}}},"components/schemas/result":{"id":"components/schemas/result","kind":"json-schema","title":"result","data":{"type":"object","properties":{"id":{"type":"string","example":"29"},"callId":{"type":"string","example":"J5WA4IAA@BXATD0S.glagqaseq108.DC2"},"costCenter":{"type":"string","example":"my billing code"},"dateReceived":{"type":"string","example":"2023-08-03T12:09:43+0200"},"totalDuration":{"type":"integer","example":82},"senderIsdn":{"type":"string","example":"00498912345678"},"senderFaxId":{"type":"string","example":"Retarus/Doe"},"receiverIsdn":{"type":"string","example":"+4989262080440"},"receiverFaxId":{"type":"string","example":"Retarus Faxolution"},"faxResolution":{"type":"string","example":"HIGH"},"faxBaudRate":{"type":"integer","example":33600},"faxPageCount":{"type":"integer","example":1},"faxClassicStatus":{"type":"string","example":"OK"},"faxNumericStatus":{"type":"string","example":"2.0.0"},"archivingStatus":{"type":"string","example":"SUCCEEDED"},"archiveExpiry":{"type":"string","example":"2023.08.10"},"documents":{"type":"array","items":{"$ref":"#/components/schemas/documents"}}}}},"components/schemas/documents":{"id":"components/schemas/documents","kind":"json-schema","title":"documents","data":{"type":"array","items":{"type":"object","required":["url","type"],"properties":{"url":{"type":"string","example":"https://api.us1.retarus.com/faxin/rest/v1/files/20.tif"},"type":{"type":"string","example":"image/tiff"}}}}},"schema_92":{"kind":"json-schema","data":{"type":"string","example":"abc123"},"id":"schema_92"},"schema_93":{"kind":"json-schema","data":{"type":"integer","example":10},"id":"schema_93"},"schema_94":{"kind":"json-schema","data":{"type":"string","example":"365%2C366%2C367%2C368"},"id":"schema_94"},"schema_95":{"kind":"json-schema","data":{"type":"integer","default":60},"id":"schema_95"},"schema_96":{"kind":"json-schema","data":{"type":"string"},"id":"schema_96"}},"exampleStore":{"components/examples/TopicContents":{"id":"components/examples/TopicContents","value":{"meta":{"version":1,"next":"https://api.us1.retarus.com/faxin/rest/v1/topics/abc123?fetch=10&timeout=60&ids=29%2C30","exit":"https://api.us1.retarus.com/faxin/rest/v1/topics/abc123?fetch=0&timeout=60&ids=29%2C30","topic":"abc123","resultSize":2,"parameters":{"fetch":10,"timeout":60,"ids":[]}},"results":[{"id":"29","callId":"J5WA4IAA@BXATD0S.glagqaseq108.DC2","costCenter":"my billing code","dateReceived":"2023-08-03T12:09:13+0200","totalDuration":23,"senderIsdn":"00498912345678","senderFaxId":"Retarus/Doe","receiverIsdn":"+4989262080440","receiverFaxId":"Retarus Faxolution","faxResolution":"HIGH","faxBaudRate":33600,"faxPageCount":1,"faxClassicStatus":"OK","faxNumericStatus":"2.0.0","archivingStatus":"NOT_CONFIGURED","archiveExpiry":"","documents":[{"url":"https://api.us1.retarus.com/faxin/rest/v1/files/20.tif","type":"image/tiff"}]},{"id":"30","callId":"J5WA55PT@CXEFXVG.glagqaseq109.DC2","costCenter":"my billing code","dateReceived":"2023-08-03T12:09:43+0200","totalDuration":42,"senderIsdn":"00498912345678","senderFaxId":"Retarus/Doe","receiverIsdn":"+4989262080440","receiverFaxId":"Retarus Faxolution","faxResolution":"HIGH","faxBaudRate":26400,"faxPageCount":1,"faxClassicStatus":"OK","faxNumericStatus":"2.0.0","archivingStatus":"NOT_CONFIGURED","archiveExpiry":"","documents":[{"url":"https://api.us1.retarus.com/faxin/rest/v1/files/21.pdf","type":"application/pdf"}]}]},"summary":"Retrieve polling information"},"components/examples/ConfirmFax":{"id":"components/examples/ConfirmFax","value":{"meta":{"version":1,"next":"https://api.us1.retarus.com/faxin/rest/v1/topics/abc123?fetch=10&timeout=60&ids=29%2C30","exit":"https://api.us1.retarus.com/faxin/rest/v1/topics/abc123?fetch=0&timeout=60&ids=29%2C30","topic":"abc123","resultSize":0,"parameters":{"fetch":0,"timeout":60,"ids":["30"]}},"results":[]},"summary":"Confirm a fax"},"paths/~1topics~1{topic}/post/responses/200/content/application~1json/examples/twoFaxes":{"value":{"meta":{"version":1,"next":"https://api.us1.retarus.com/faxin/rest/v1/topics/abc123?fetch=10&timeout=60&ids=29%2C30","exit":"https://api.us1.retarus.com/faxin/rest/v1/topics/abc123?fetch=0&timeout=60&ids=29%2C30","topic":"abc123","resultSize":2,"parameters":{"fetch":10,"timeout":60,"ids":[]}},"results":[{"id":"29","callId":"J5WA4IAA@BXATD0S.glagqaseq108.DC2","costCenter":"my billing code","dateReceived":"2023-08-03T12:09:13+0200","totalDuration":23,"senderIsdn":"00498912345678","senderFaxId":"Retarus/Doe","receiverIsdn":"+4989262080440","receiverFaxId":"Retarus Faxolution","faxResolution":"HIGH","faxBaudRate":33600,"faxPageCount":1,"faxClassicStatus":"OK","faxNumericStatus":"2.0.0","archivingStatus":"NOT_CONFIGURED","archiveExpiry":"","documents":[{"url":"https://api.us1.retarus.com/faxin/rest/v1/files/20.tif","type":"image/tiff"}]},{"id":"30","callId":"J5WA55PT@CXEFXVG.glagqaseq109.DC2","costCenter":"my billing code","dateReceived":"2023-08-03T12:09:43+0200","totalDuration":42,"senderIsdn":"00498912345678","senderFaxId":"Retarus/Doe","receiverIsdn":"+4989262080440","receiverFaxId":"Retarus Faxolution","faxResolution":"HIGH","faxBaudRate":26400,"faxPageCount":1,"faxClassicStatus":"OK","faxNumericStatus":"2.0.0","archivingStatus":"NOT_CONFIGURED","archiveExpiry":"","documents":[{"url":"https://api.us1.retarus.com/faxin/rest/v1/files/21.pdf","type":"application/pdf"}]}]},"key":"twoFaxes","summary":"Retrieve polling information","id":"paths/~1topics~1{topic}/post/responses/200/content/application~1json/examples/twoFaxes"},"paths/~1topics~1{topic}/post/responses/200/content/application~1json/examples/ConfirmFax":{"value":{"meta":{"version":1,"next":"https://api.us1.retarus.com/faxin/rest/v1/topics/abc123?fetch=10&timeout=60&ids=29%2C30","exit":"https://api.us1.retarus.com/faxin/rest/v1/topics/abc123?fetch=0&timeout=60&ids=29%2C30","topic":"abc123","resultSize":0,"parameters":{"fetch":0,"timeout":60,"ids":["30"]}},"results":[]},"key":"ConfirmFax","summary":"Confirm a fax","id":"paths/~1topics~1{topic}/post/responses/200/content/application~1json/examples/ConfirmFax"}},"securitySchemeStore":{"httpBasicAuth":{"id":"httpBasicAuth","type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The format is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<Retarus Customer Number>:<Password>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", encoded via Base 64."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The passwords are provided by Retarus and they can be associated to one or more incoming telephone numbers."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As for example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Basic OTk5OTk6S0tkUVNHSU1XME1mOTdiVA==\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Basic OTk5OTk6S0tkUVNHSU1XME1mOTdiVA==\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple processes can be operated concurrently by the Webservice using the same"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"password or multiple passwords."},"children":[]}]}]}]}},"servers":[{"url":"/_mock/fax/fax2ws-pull-api","isMockServer":true,"description":"Mock server"},{"url":"https://api.de1.retarus.com/faxin/rest/v1","description":"Retarus data center in Frankfurt, Germany"},{"url":"https://api.de2.retarus.com/faxin/rest/v1","description":"Retarus data center in Munich, Germany"},{"url":"https://api.us1.retarus.com/faxin/rest/v1","description":"Retarus data center in Ashburn, United States"},{"url":"https://api.us2.retarus.com/faxin/rest/v1","description":"Retarus data center in Secaucus, United States"},{"url":"https://api.ch1.retarus.com/faxin/rest/v1","description":"Retarus data center in Zurich, Switzerland"},{"url":"https://api.sg1.retarus.com/faxin/rest/v1","description":"Retarus data center in Singapore"}]},"options":{"layout":"stacked","hideSidebar":true,"mockServer":{"url":"/_mock/fax/fax2ws-pull-api","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/fax/fax2ws-pull-api.json?download"},{"url":"/_bundle/fax/fax2ws-pull-api.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Fax2WSPull","description":"Fax2WSPull allows clients to actively retrieve faxes received \nfor you via the Retarus cloud-based infrastructure instead of passively \nwaiting for them to be delivered to a web service. The unit of organization for this \nprocess is the **topic**. A topic represents one or more fax numbers that are used to \nreceive faxes.\n\nFor each topic, the API provides information about received faxes, \nincluding the URL to the fax documents itself. \n\nEvery inbound document showed as available is hidden after retrieval. However, fax\nreceipt should be acknowledged by the client in the retrieval process. If\nthis doesn't happen within a pre-defined timeout period, the document is\nmade available again, assuming that there was some issue with the\napplication during the retrieval process.\n\nEach request or response in this document is JSON serialized and encoded\nusing the **UTF-8** character set.\n\nThe fax documents themselves are automatically deleted **7 days** after receipt by default, \nregardless of whether they were downloaded or not.\n"}},"baseSlug":"/fax/fax2ws-pull-api","routesMapping":{}}