{"items":[{"type":"link","label":"Faxolution for Applications status push notification API","link":"/fax/status-push-api","routeSlug":"/fax/status-push-api","content":{"contentType":"overview","meta":{"name":"Faxolution for Applications status push notification API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"status-push-api.json","url":"/_bundle/fax/status-push-api.json?download"},{"kind":"download","label":"status-push-api.yaml","url":"/_bundle/fax/status-push-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/status-push-api","description":"Mock server","isMockServer":true}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Faxolution for Applications status push notification API (v1)","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":"This document describes usage and possible content of the status push API. You can use it to be proactively"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"informed about the outcome of the fax messages you sent with Faxolution for Applications. Both XML and JSON"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are available as file type. We recommend to use this option rather than polling the status via the Faxolution"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for Applications API or getting a notification via email."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The following schema description as well as the examples refer to the default layout"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of the push message for XML and JSON. You can request an individual status push template from our"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"implementation team. Also, some elements only show up in the push message, if they were referenced in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the fax request. This is reflected in the examples."},"children":[]}]}]}]}],"sectionId":"/fax/status-push-api"}],"sectionId":"/fax/status-push-api"}]}]}},{"type":"group","label":"status push","link":"/fax/status-push-api/status-push","routeSlug":"/fax/status-push-api/status-push","items":[{"label":"Send a status push message to the URL of your choice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/fax/status-push-api/status-push/paths/~1your~1desired~1path/post","routeSlug":"/fax/status-push-api/status-push/paths/~1your~1desired~1path/post","metadata":{"seo":{"title":"Send a status push message to the URL of your choice","description":"Notification via HTTP implies the customer is operating an HTTP server that accepts the specified URL HTTP POST requests from Retarus' infrastructure. The customer should provide and configure:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Send a status push message to the URL of your choice","isWebhook":false,"pointer":"/paths/~1your~1desired~1path/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send a status push message to the URL of your choice","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":"Notification via HTTP implies the customer is operating an HTTP server that accepts the specified URL HTTP POST requests from Retarus' infrastructure. The customer should provide and configure:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A target web service accepting HTTP POST requests"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An authentication method. The following are supported at the moment:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP_BASIC"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP_DIGEST"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAUTH2"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NONE"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The parameters should be provided in each HTTP request made in Faxolution for Applications."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, the format of the status push is the same as the response to a getFaxReports in the Faxolution for Applications SOAP API. If you prefer to use a custom format, please contact Retarus."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the corresponding HTTP response from the customer’s server, a status code in the 200-299 range is expected if the HTTP request was successfully received."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If there are errors, a status code in the 400-499 range (in cases of erroneous requests) or the 500-599 range (in cases of HTTP server errors) should be provided."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["text/xml","application/json"],"mediaTypeSchemas":{"text/xml":{"schemaId":"components/schemas/ReportResponse","exampleIds":["paths/~1your~1desired~1path/post/requestBody/content/text~1xml/examples/sendStatusPushSmall","paths/~1your~1desired~1path/post/requestBody/content/text~1xml/examples/sendStatusPushLarge"]},"application/json":{"schemaId":"components/schemas/ReportResponse","exampleIds":["paths/~1your~1desired~1path/post/requestBody/content/application~1json/examples/sendStatusPushSmall","paths/~1your~1desired~1path/post/requestBody/content/application~1json/examples/sendStatusPushLarge"]}},"schemaId":"components/schemas/ReportResponse","exampleIds":["paths/~1your~1desired~1path/post/requestBody/content/text~1xml/examples/sendStatusPushSmall","paths/~1your~1desired~1path/post/requestBody/content/text~1xml/examples/sendStatusPushLarge"],"pointer":"/paths/~1your~1desired~1path/post/requestBody","description":"Fax status push message as a ReportResponse object"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/your/desired/path","servers":[{"url":"/_mock/fax/status-push-api","description":"Mock server","isMockServer":true}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"text/xml":{"schemaId":"components/schemas/ReportResponse","exampleIds":["paths/~1your~1desired~1path/post/requestBody/content/text~1xml/examples/sendStatusPushSmall","paths/~1your~1desired~1path/post/requestBody/content/text~1xml/examples/sendStatusPushLarge"]},"application/json":{"schemaId":"components/schemas/ReportResponse","exampleIds":["paths/~1your~1desired~1path/post/requestBody/content/application~1json/examples/sendStatusPushSmall","paths/~1your~1desired~1path/post/requestBody/content/application~1json/examples/sendStatusPushLarge"]}},"responseCodes":["200","400","500"],"pointer":"/your/desired/path","href":"status-push/paths/~1your~1desired~1path/post","summary":"Send a status push message to the URL of your choice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/fax/status-push-api","description":"Mock server","isMockServer":true}],"schemaId":"components/schemas/ReportResponse","exampleIds":["paths/~1your~1desired~1path/post/requestBody/content/text~1xml/examples/sendStatusPushSmall","paths/~1your~1desired~1path/post/requestBody/content/text~1xml/examples/sendStatusPushLarge"],"mediaTypes":["text/xml","application/json"],"mediaTypeSchemas":{"text/xml":{"schemaId":"components/schemas/ReportResponse","exampleIds":["paths/~1your~1desired~1path/post/requestBody/content/text~1xml/examples/sendStatusPushSmall","paths/~1your~1desired~1path/post/requestBody/content/text~1xml/examples/sendStatusPushLarge"]},"application/json":{"schemaId":"components/schemas/ReportResponse","exampleIds":["paths/~1your~1desired~1path/post/requestBody/content/application~1json/examples/sendStatusPushSmall","paths/~1your~1desired~1path/post/requestBody/content/application~1json/examples/sendStatusPushLarge"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK: The job was processed properly on your side (example)"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BAD_REQUEST: Client side error (example)"},"children":[]}]}]}]},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SERVER_ERROR: Server side error (example)"},"children":[]}]}]}]}],"pointer":"/paths/~1your~1desired~1path/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/status-push/paths/~1your~1desired~1path/post"}],"panels":[]}]},"httpPath":"/your/desired/path"}],"content":{"contentType":"group","meta":{"name":"status push"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"status push","showPageActions":true},{"nodeType":"markdoc","content":"Sends a status push message"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/your/desired/path","summary":"Send a status push message to the URL of your choice","prefix":{"name":"post","color":"post"},"badges":[],"link":"/status-push/paths/~1your~1desired~1path/post","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/ReportResponse":{"id":"components/schemas/ReportResponse","kind":"json-schema","title":"ReportResponse","data":{"type":"object","description":"The root element of the fax job report","properties":{"jobId":{"type":"string","description":"The Job ID. Summarizes all faxes of a send request, if there is more than one."},"reportMail":{"$ref":"#/components/schemas/reportMail"},"httpStatusPush":{"$ref":"#/components/schemas/httpStatusPush"},"faxRecipients":{"$ref":"#/components/schemas/faxRecipients"},"documents":{"$ref":"#/components/schemas/documents"},"options":{"$ref":"#/components/schemas/options"},"pages":{"$ref":"#/components/schemas/pages"}}}},"components/schemas/reportMail":{"id":"components/schemas/reportMail","kind":"json-schema","title":"reportMail","data":{"type":"object","properties":{"successAddress":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email address, to which delivery confirmations notifications should be sent."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Example:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" \"john.doe@retarus.com\""},"children":[]}]}]}]},"failureAddress":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Email address, to which a notification should be sent when errors occur."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Example:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" \"jane.doe@retarus.com\""},"children":[]}]}]}]}}}},"components/schemas/httpStatusPush":{"id":"components/schemas/httpStatusPush","kind":"json-schema","title":"httpStatusPush","data":{"type":"object","properties":{"url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL where the status is pushed to."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Example:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" \"http://retarus.com/testpath/test-target\""},"children":[]}]}]}]},"principal":{"type":"string","description":"The user name to authenticate with the status push endpoint, if required. When using OAUTH2 this is the client id to obtain access tokens."},"credentials":{"type":"string","description":"The password to authenticate with the status push endpoint, if required. When using OAUTH2 this is the client secret to obtain access tokens."},"authMethod":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication method. Possible values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP_BASIC"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP_DIGEST"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAUTH2"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NONE"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Default:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" \"NONE\""},"children":[]}]}]}]}}}},"components/schemas/faxRecipients":{"id":"components/schemas/faxRecipients","kind":"json-schema","title":"faxRecipients","data":{"type":"array","items":{"$ref":"#/components/schemas/faxRecipient"},"xml":{"wrapped":true}}},"components/schemas/faxRecipient":{"id":"components/schemas/faxRecipient","kind":"json-schema","title":"faxRecipient","data":{"type":"object","properties":{"number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dialed number (international format, e.g., +4989123456789)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Example:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" \"+4989123456789\""},"children":[]}]}]}]},"faxID":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of an individual fax transmission, set by Faxolution for Applications"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Example:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" FNIJPNJYNA06EDIJNFUO1Q"},"children":[]}]}]}]},"properties":{"type":["array","null"],"description":"Personalized data used for the cover page.","items":{"$ref":"#/components/schemas/property"},"xml":{"wrapped":true}},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Job status. Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OK: All pages were successfully delivered."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUSY: Destination number busy, e.g. recipient fax machine receiving long fax or high fax volume."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sender action:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Retry, contact recipient if necessary."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOFAX: Call not received by fax device – call answered by a person, answering machine or modem. Could also indicate Carrier interconnect issue."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sender action:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Retry, contact recipient if necessary. Open Retarus support ticket if issue persists."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOFAX_DIS: Call not received by fax device (disconnect) – recipient ended the communication, call answered by a person who hung up. Could also indicate Carrier interconnect issue."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sender action:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Retry, contact recipient if necessary. Open Retarus support ticket if issue persists."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOFAX_TO: Call was accepted but no fax protocol signal was provided (timeout). Timeout occurred while waiting for recipient to be identified as a fax device. Could also indicate Carrier interconnect issue."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sender action:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Retry, contact recipient if necessary. Open Retarus support ticket if issue persists."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RING_TO: Timeout occurred while waiting for response – fax device not answering, e.g. fax device powered off, call automatically transferred to a telephone, fax device out of paper."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sender action:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Retry, contact recipient if necessary. Open Retarus support ticket if issue persists."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHANGED_NO: Changed Number, received recorded message that dialed number has changed."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sender action:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Contact recipient."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIAL_NC: No Connection, call setup failed at Carrier level, e.g. telephone company rejected dialed number as incomplete, invalid or temporarily disconnected."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sender action:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Verify number. Retry. Open Retarus support ticket if issue persists."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIAL_TO: Timeout occurred at Carrier level during call setup."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sender action:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Verify number. Retry. Contact recipient. Open Retarus support ticket if issue persists."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WRONG_NO: Wrong, invalid, or unassigned number."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sender action:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Verify number. Retry."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INVALID_NO: Invalid number structure"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sender action:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Verify number. Retry."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WOUT_TO: Output Window Timeout, call setup timeout before there is a ring tone (this is normally a carrier problem)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sender action:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Verify number. Contact recipient. Open Retarus support ticket if issue persists."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CANCELLED: The fax job was manually cancelled by the sender."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sender action:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Resend, if applicable."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EXP_CANC: Expiry Cancellation, the fax job was not completed and was automatically cancelled at the expiry timestamp."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sender action:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Contact Administrator regarding expiry timestamp setting or root causes."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RENDERING_ERROR: Unable to convert attachment(s) and / or coversheet into a fax document, e.g., a password protected PDF document."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sender action:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Verify document is in a supported file format and not password protected or encrypted, then retry. Contact Administrator regarding list configuration in the EAS* portal."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UNKNOWN_FAX_FILE: At least one of the files to be sent is missing or the file name is missing. Faxolution for Applications only:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sender action:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Resend with file name(s)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UNSUPPORTED_FILETYPE: Unable to convert document into a fax because the document has an attachment which lacks a supported filename extension."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sender action:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Verify if the document is in a supported file format and has a valid file name extension, then retry."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BAD_LINES: Fax might be illegible due to degraded transmission or line errors and / or the remote station does not support error correction."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sender action:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Retry. Contact recipient. Open Retarus support ticket if issue persists."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DIAL_GF: Dial General Failure, call setup failure at the carrier level."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sender action:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Retry. Contact recipient. Open Retarus support ticket if issue persists."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EOD_FAILED: The fax is confirmed as not received, although in practice it often still successfully reaches the recipient. For example, the reverse channel is suddenly broken in one direction because the party is not protocol-compliant or there is a communication problem."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"May be due to line quality (noise). Appears at a later stage in transmission than the PAGE_SEND_ERR code."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sender action:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Retry. Open Retarus support ticket if issue persists."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FANS_GF: Fax General Failure, connection was interrupted due to protocol errors in counterpart station during protocol interchange."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sender action:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Retry. Contact recipient. Open Retarus support ticket if issue persists."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NO_REMOTEINFO: Remote station hung up before it transmitted its identity name or before it was able to configure arrange a different transmission mode."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sender action:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Retry. Contact recipient. Open Retarus support ticket if issue persists."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NO_TRAIN/ NO_TRAINING: No Successful Training Possible Remote disconnect during negotiation of fax speed and features before the final page is delivered. May also map to the NOFAX_DIS status code."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sender action:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Retry. Open Retarus support ticket if issue persists."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PAGE_SEND_ERR: Fax job could not be sent, e.g. fax device out of paper, connection was interrupted, or protocol error terminated transmission prior to final page Appears at earlier stage in transmission than EOD_FAILED status code:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sender action:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Retry. Open Retarus support ticket if issue persists."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"REM_DIS . Remote disconnect after detection of fax tones. Recipient hung up."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sender action:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Retry, contact recipient if necessary. Open Retarus support ticket if issue persists."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BLACKLIST: Public Blacklist, number may be registered with, e.g., BITKOM Robinson List (Germany- based numbers) or ECOFAX (France-based numbers) and cannot be contacted because the applicable list has been activated by regulatory authorities."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sender action:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Contact recipient."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BAD_FILE: An internal error occurred during processing prior to establishing a fax transmission."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sender action:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Retry. Open Retarus support ticket if issue persists."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EXPIRED: An internal error occurred during processing prior to establishing a fax transmission."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sender action:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Retry. Open Retarus support ticket if issue persists."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FAXUNIT_NA: An internal error occurred during processing prior to establishing a fax transmission."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sender action:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Retry. Open Retarus support ticket if issue persists."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MISSING_FAX_FILE: An internal error occurred during processing prior to establishing a fax transmission."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sender action:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Retry. Open Retarus support ticket if issue persists."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOFILE: An internal error occurred during processing prior to establishing a fax transmission."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sender action:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Retry. Open Retarus support ticket if issue persists."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"COMERROR: An unknown error has occurred during transmission. An internal error occurred during processing prior to establishing a fax transmission."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sender action:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Retry. Open Retarus support ticket if issue persists."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FAILURE: An unknown error has occurred when preparing the job for transmission. An internal error occurred during processing prior to establishing a fax transmission."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Sender action:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Retry. Check the provided reason for hints. Open Retarus support ticket if issue persists."},"children":[]}]}]}]}]},"reason":{"type":"string","description":"Explanation of the status."},"sentTs":{"type":"string","description":"Timestamp which indicates when the fax was sent (in ISO 8601 format)."},"durationInSecs":{"type":"integer","description":"Duration of the fax transmission until received by the fax recipient."},"sentToNumber":{"type":"string","description":"Number to which the fax was sent."},"remoteCsid":{"type":"string","description":"Fax ID which identifies the fax recipient."}},"xml":{"name":"faxRecipient"}}},"components/schemas/property":{"id":"components/schemas/property","kind":"json-schema","title":"property","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cover page can be personalized for each individual recipient and then attached to the front of each fax document."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This object allows specifying a value for each of the keys in the template."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See <<common-fax4ba-cover-page-personalization>> for additional information."},"children":[]}]}]}],"required":["key","value"],"properties":{"key":{"type":"string","description":"The key in a key / value pair used to fill the variables of a cover page in the fax send request.   \n","examples":["key123"]},"value":{"type":"string","description":"The value in a key / value pair used to fill the variables of a cover page in the fax send request.\n","examples":["value123"]}},"xml":{"name":"property"}}},"components/schemas/documents":{"id":"components/schemas/documents","kind":"json-schema","title":"documents","data":{"type":"array","items":{"$ref":"#/components/schemas/document"},"xml":{"wrapped":true}}},"components/schemas/document":{"id":"components/schemas/document","kind":"json-schema","title":"document","data":{"type":"object","properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Document file name; the file extension is important for determining the file type, e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invoice-2023-01.pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Please note: The maximum possible length of a file name is 32 characters."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allowed characters are: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"a-zA-Z0-9-_."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and no whitespaces, slashes, or other special characters are permitted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Example:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" \"test-document-inline-byte-array.txt\""},"children":[]}]}]}]},"isText":{"type":"boolean","description":"Currently is not enabled in this version"},"charset":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Character encoding of plain text documents (*.txt). Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"US-ASCII"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UTF-8"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UTF-16"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UTF-16BE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UTF-16LE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO-8859-1"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Windows-1252"},"children":[]}]}]}]}]}},"xml":{"name":"document"}}},"components/schemas/options":{"id":"components/schemas/options","kind":"json-schema","title":"options","data":{"type":"object","properties":{"resolution":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fax’s resolution. Possible values are:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LOW"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HIGH"},"children":[]}]}]}]}]},"tsid":{"type":"string","description":"Fax ID which identifies the fax sender."},"header":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The content of the header, including control characters."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Example:"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" \"%tz=CEST Testfax: CSID: %C Recipient number: %# Date: %d.%m.%Y %H:%M %z\""},"children":[]}]}]}]},"isBlacklistEnabled":{"type":"boolean","description":"Flag for the use of the Robinson List (only for numbers in Germany), ECOFAX (for numbers in France), or Retarus' own deny list."},"isExpress":{"type":"boolean","description":"Flag for transmissions sent as express."},"overlay":{"$ref":"#/components/schemas/overlay"},"coverpageTemplateName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the cover page’s template"},"children":[]}]}]}]},"scheduleTS":{"type":"string","description":"scheduled transmission start in the future, if not being sent immediately"},"jobExpiryMinutes":{"type":"integer","description":"Termination time for attempts to send a fax job"},"billingCode":{"type":"string","description":"Information on the cost center; format is arbitrary (max. 80 characters)"},"billingInfo":{"type":"string","description":"Additional data for internal customer accounting (max. 80 characters)"},"jobReference":{"type":"string","description":"reference information on the fax job; format is arbitrary, e.g., for a customer-defined equivalent to the Job ID (this would be concurrently managed along with the actual Job ID, but will not overwrite it; max. 256 characters)\n"}}}},"components/schemas/overlay":{"id":"components/schemas/overlay","kind":"json-schema","title":"overlay","data":{"type":"object","properties":{"name":{"type":"string","description":"the template name, without the path information and file extension.\n","examples":["overlay_template1"]},"mode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"specifies the page in the document where the template (overlay) will be applied. Possible values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ALL_PAGES: the overlay is applied to all pages"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NO_OVERLAY: no overlay is used (returns the same result as if \"no overlay\" had been specified in the options)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FIRST_PAGE: the overlay is applied only to the first page (if you are using a cover  page, it is considered the first page)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"LAST_PAGE: the overlay is applied only to the last page"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ALL_BUT_FIRST_PAGE: the overlay is applied to all pages except for the first (if you are using a cover page, the overlay will be applied to all other pages because the cover page is considered the first page)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ALL_BUT_LAST_PAGE: the overlay is applied to all pages except the last one"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ALL_BUT_FIRST_AND_LAST_PAGE: the overlay is applied to all pages except for the first and the last (the cover page is considered the first page if this mode is used)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FIRST_FILE: if the faxed document consists of multiple files, the overlay will only be used on the first file's pages (the cover page is considered not to belong to any file and does not an overlay in this mode)"},"children":[]}]}]}]}]}}}},"components/schemas/pages":{"id":"components/schemas/pages","kind":"json-schema","title":"pages","data":{"type":"integer","description":"Number of pages in the fax document, as long as it was successfully delivered."}}},"exampleStore":{"components/examples/sendStatusPushSmall":{"id":"components/examples/sendStatusPushSmall","value":{"jobId":"FJIJPNJYN906EDIJNFGI5S","faxRecipients":[{"number":"+4989123456789","status":"OK","sentTs":"2023-01-03T15:38:08Z","sentToNumber":"004989123456789","remoteCsid":"+49/89/1234567-89"}],"documents":[{"name":"document.pdf"}],"options":{"billingCode":"My BC 123","billingInfo":"Default billing code","jobReference":"My Reference ID"},"pages":2},"summary":"Example for a lean message"},"components/examples/sendStatusPushLarge":{"id":"components/examples/sendStatusPushLarge","value":{"jobId":"FJIJPNJYN906EDIJNFGI5T","reportMail":{"successAddress":"john.doe@retarus.com","failureAddress":"jane.doe@retarus.com"},"httpStatusPush":{"url":"https://statuslistener.example.com:9564/Faxolution- v3.0"},"faxRecipients":[{"number":"+4989123456789","faxID":"FNIJPNJYNA06EDIJNFUO1Q","properties":[{"key":"FromName","value":"Jane Doe"},{"key":"ToName","value":"Jill Doe"}],"status":"OK","reason":"OK","sentTs":"2023-01-03T15:38:08Z","durationInSecs":26,"sentToNumber":"004989123456789","remoteCsid":"+49/89/1234567-89"},{"number":"+4989123456790","faxID":"FNIJPNJYNA06EDIJNFUO2Q","properties":[{"key":"FromName","value":"Jane Doe"},{"key":"ToName","value":"John Doe"}],"status":"OK","reason":"OK","sentTs":"2023-01-03T15:38:08Z","durationInSecs":26,"sentToNumber":"004989123456790","remoteCsid":"John Doe"}],"documents":[{"name":"document1.pdf","isText":false,"charset":"UTF-8"},{"name":"document2.pdf","isText":false,"charset":"UTF-8"}],"options":{"resolution":"HIGH","tsid":"Example Inc.","header":"Fax from %C to %#%r%Y-%m-%d","isBlacklistEnabled":false,"isExpress":true,"overlay":{"name":"overlay_template1","mode":"ALL_PAGES"},"coverpageTemplateName":"my_coverpage","jobExpiryMinutes":50,"billingCode":"My BC 123","billingInfo":"Default billing code","jobReference":"My Reference ID"},"pages":2},"summary":"Example for a full-scale message"},"paths/~1your~1desired~1path/post/requestBody/content/text~1xml/examples/sendStatusPushSmall":{"value":{"jobId":"FJIJPNJYN906EDIJNFGI5S","faxRecipients":[{"number":"+4989123456789","status":"OK","sentTs":"2023-01-03T15:38:08Z","sentToNumber":"004989123456789","remoteCsid":"+49/89/1234567-89"}],"documents":[{"name":"document.pdf"}],"options":{"billingCode":"My BC 123","billingInfo":"Default billing code","jobReference":"My Reference ID"},"pages":2},"key":"sendStatusPushSmall","summary":"Example for a lean message","id":"paths/~1your~1desired~1path/post/requestBody/content/text~1xml/examples/sendStatusPushSmall"},"paths/~1your~1desired~1path/post/requestBody/content/text~1xml/examples/sendStatusPushLarge":{"value":{"jobId":"FJIJPNJYN906EDIJNFGI5T","reportMail":{"successAddress":"john.doe@retarus.com","failureAddress":"jane.doe@retarus.com"},"httpStatusPush":{"url":"https://statuslistener.example.com:9564/Faxolution- v3.0"},"faxRecipients":[{"number":"+4989123456789","faxID":"FNIJPNJYNA06EDIJNFUO1Q","properties":[{"key":"FromName","value":"Jane Doe"},{"key":"ToName","value":"Jill Doe"}],"status":"OK","reason":"OK","sentTs":"2023-01-03T15:38:08Z","durationInSecs":26,"sentToNumber":"004989123456789","remoteCsid":"+49/89/1234567-89"},{"number":"+4989123456790","faxID":"FNIJPNJYNA06EDIJNFUO2Q","properties":[{"key":"FromName","value":"Jane Doe"},{"key":"ToName","value":"John Doe"}],"status":"OK","reason":"OK","sentTs":"2023-01-03T15:38:08Z","durationInSecs":26,"sentToNumber":"004989123456790","remoteCsid":"John Doe"}],"documents":[{"name":"document1.pdf","isText":false,"charset":"UTF-8"},{"name":"document2.pdf","isText":false,"charset":"UTF-8"}],"options":{"resolution":"HIGH","tsid":"Example Inc.","header":"Fax from %C to %#%r%Y-%m-%d","isBlacklistEnabled":false,"isExpress":true,"overlay":{"name":"overlay_template1","mode":"ALL_PAGES"},"coverpageTemplateName":"my_coverpage","jobExpiryMinutes":50,"billingCode":"My BC 123","billingInfo":"Default billing code","jobReference":"My Reference ID"},"pages":2},"key":"sendStatusPushLarge","summary":"Example for a full-scale message","id":"paths/~1your~1desired~1path/post/requestBody/content/text~1xml/examples/sendStatusPushLarge"},"paths/~1your~1desired~1path/post/requestBody/content/application~1json/examples/sendStatusPushSmall":{"value":{"jobId":"FJIJPNJYN906EDIJNFGI5S","faxRecipients":[{"number":"+4989123456789","status":"OK","sentTs":"2023-01-03T15:38:08Z","sentToNumber":"004989123456789","remoteCsid":"+49/89/1234567-89"}],"documents":[{"name":"document.pdf"}],"options":{"billingCode":"My BC 123","billingInfo":"Default billing code","jobReference":"My Reference ID"},"pages":2},"key":"sendStatusPushSmall","summary":"Example for a lean message","id":"paths/~1your~1desired~1path/post/requestBody/content/application~1json/examples/sendStatusPushSmall"},"paths/~1your~1desired~1path/post/requestBody/content/application~1json/examples/sendStatusPushLarge":{"value":{"jobId":"FJIJPNJYN906EDIJNFGI5T","reportMail":{"successAddress":"john.doe@retarus.com","failureAddress":"jane.doe@retarus.com"},"httpStatusPush":{"url":"https://statuslistener.example.com:9564/Faxolution- v3.0"},"faxRecipients":[{"number":"+4989123456789","faxID":"FNIJPNJYNA06EDIJNFUO1Q","properties":[{"key":"FromName","value":"Jane Doe"},{"key":"ToName","value":"Jill Doe"}],"status":"OK","reason":"OK","sentTs":"2023-01-03T15:38:08Z","durationInSecs":26,"sentToNumber":"004989123456789","remoteCsid":"+49/89/1234567-89"},{"number":"+4989123456790","faxID":"FNIJPNJYNA06EDIJNFUO2Q","properties":[{"key":"FromName","value":"Jane Doe"},{"key":"ToName","value":"John Doe"}],"status":"OK","reason":"OK","sentTs":"2023-01-03T15:38:08Z","durationInSecs":26,"sentToNumber":"004989123456790","remoteCsid":"John Doe"}],"documents":[{"name":"document1.pdf","isText":false,"charset":"UTF-8"},{"name":"document2.pdf","isText":false,"charset":"UTF-8"}],"options":{"resolution":"HIGH","tsid":"Example Inc.","header":"Fax from %C to %#%r%Y-%m-%d","isBlacklistEnabled":false,"isExpress":true,"overlay":{"name":"overlay_template1","mode":"ALL_PAGES"},"coverpageTemplateName":"my_coverpage","jobExpiryMinutes":50,"billingCode":"My BC 123","billingInfo":"Default billing code","jobReference":"My Reference ID"},"pages":2},"key":"sendStatusPushLarge","summary":"Example for a full-scale message","id":"paths/~1your~1desired~1path/post/requestBody/content/application~1json/examples/sendStatusPushLarge"}},"securitySchemeStore":{},"servers":[{"url":"/_mock/fax/status-push-api","isMockServer":true,"description":"Mock server"}]},"options":{"layout":"stacked","hideSidebar":true,"mockServer":{"url":"/_mock/fax/status-push-api","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/fax/status-push-api.json?download"},{"url":"/_bundle/fax/status-push-api.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Faxolution for Applications status push notification API","description":"This document describes usage and possible content of the status push API. You can use it to be proactively\ninformed about the outcome of the fax messages you sent with Faxolution for Applications. Both XML and JSON\nare available as file type. We recommend to use this option rather than polling the status via the Faxolution \nfor Applications API or getting a notification via email. \n\n**Please note:** The following schema description as well as the examples refer to the default layout\nof the push message for XML and JSON. You can request an individual status push template from our \nimplementation team. Also, some elements only show up in the push message, if they were referenced in\nthe fax request. This is reflected in the examples.\n"}},"baseSlug":"/fax/status-push-api","routesMapping":{}}