{"templateId":"openapi_docs","sharedDataIds":{"openAPIDocsStore":"oas-docs/fax/api-reference/fax.yaml","sidebar":"sidebar-docs/fax/sidebars.yaml"},"props":{"definitionId":"docs/fax/api-reference/fax.yaml","dynamicMarkdocComponents":["openapi"],"baseSlug":"/docs/fax/api-reference/fax","seo":{"title":"Errors & statuses","siteUrl":"https://developers.sinch.com","llmstxt":{"title":"Sinch Developer Documentation","description":"LLMs.txt containing a map of all the documentation files for Sinch.","sections":[{"title":"SMS API","description":"The SMS API allows you to send and receive SMS messages with a few easy steps. You can also send bulk SMS messages to multiple customers using the Sinch SMS service.","includeFiles":["docs/sms/**/*.md","docs/sms/**/*.yaml"],"excludeFiles":["docs/sms/index.md"]},{"title":"Numbers API","description":"The Numbers API enables you to search for, view, and activate numbers. It's considered a precursor to other APIs in the Sinch product family. The numbers API can be used in tandem with any of our APIs that perform messaging or calling.","includeFiles":["docs/numbers/**/*.md","docs/numbers/**/*.yaml"],"excludeFiles":["docs/numbers/index.md"]},{"title":"Conversation API","description":"Send and receive messages globally on many popular channels with ease and confidence when using Sinch's Conversation API. Conversation API is the preferred API for sending mobile messages on SMS and other social channels with Sinch. It is a simple API with unified error messages, consistent request payloads, and common webhook payloads that are channel-agnostic.","includeFiles":["docs/conversation/**/*.md","docs/conversation/**/*.yaml"],"excludeFiles":["docs/conversation/index.md"]},{"title":"Voice API","description":"The Voice API works as a big telephony switch. The Voice API handles incoming phone calls (also known as incoming call “legs”), sets up outgoing phone calls (or outgoing call “legs”), and bridges the two. The incoming call leg may come in over a data connection (from a smartphone or web application using the Sinch SDKs) or through a local phone number (from the PSTN network). Similarly, the outgoing call leg can be over data (to another smartphone or web application using the Sinch SDKs) or the PSTN network.","includeFiles":["docs/voice/**/*.md","docs/voice/**/*.yaml"],"excludeFiles":["docs/voice/index.md"]},{"title":"Verification API","description":"The Verification API is a platform for phone number verification. It consists of the API and different software development kits (the Sinch SDKs) that you integrate with your smartphone or web application and cloud based back-end services. Together they enable SMS, Flashcall, Phone Call and Data verification in your application.","includeFiles":["docs/verification/**/*.md","docs/verification/**/*.yaml"],"excludeFiles":["docs/verification/index.md"]},{"title":"Provisioning API","description":"Provisioning API allows you to programmatically set up your senders, accounts and templates on your favorite messaging platforms on the Conversation API. For now, you can create your first WhatsApp channel through Meta's Embedded sign up, you can configure your first SMS App and configure your webhooks. As development continues, we will be adding the most commonly used channels.","includeFiles":["docs/provisioning-api/**/*.md","docs/provisioning-api/**/*.json"],"excludeFiles":["docs/provisioning-api/index.md"]},{"title":"Elastic SIP Trunking API","description":"With Elastic SIP Trunking you can create and manage your SIP trunks and phone numbers programmatically.","includeFiles":["docs/est/**/*.md","docs/est/**/*.yaml"],"excludeFiles":["docs/est/index.md"]},{"title":"Fax API","description":"Send and receive HIPAA compliant faxes on our modern fax platform using our developer-friendly API.","includeFiles":["docs/fax/**/*.md","docs/fax/**/*.yaml"],"excludeFiles":["docs/fax/index.md"]},{"title":"In-app Voice and Video SDK","description":"The In-app Voice and Video SDK enables you to add voice and video calling capabilities directly into your mobile or web application using the Sinch SDKs.","includeFiles":["docs/in-app-calling/**/*.md"],"excludeFiles":["docs/in-app-calling/index.md"]}],"hide":false,"excludeFiles":[]},"description":""},"itemId":"section/errors-and-statuses","disableAutoScroll":true,"metadata":{"product":"Fax","subType":"openapi-operation"},"compilationErrors":[],"markdown":{"partials":{"partials/fax/errors/_schemas.md":{"$$mdtype":"Node","errors":[],"lines":[],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[0,1],"inline":false,"attributes":{"level":3},"children":[{"$$mdtype":"Node","errors":[],"lines":[0,1],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[0,1],"inline":true,"attributes":{"content":"Document Conversion Error"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"partials/fax/errors/_schemas.md","start":{"line":0},"end":{"line":1}}}],"type":"inline","annotations":[],"slots":{},"location":{"file":"partials/fax/errors/_schemas.md","start":{"line":0},"end":{"line":1}}}],"type":"heading","annotations":[],"slots":{},"location":{"file":"partials/fax/errors/_schemas.md","start":{"line":0},"end":{"line":1}}},{"$$mdtype":"Node","errors":[],"lines":[2,3],"inline":false,"attributes":{"schema":{"$ref":"../../../docs/fax/api-reference/fax.yaml#/components/schemas/DocumentConversionError"},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/DocumentConversionError"},"DocumentConversionError":{"type":"object","description":"Conversion errors usually occur when there is a problem with one of the files you posted.","properties":{"errorType":{"description":"Type of error for the Document conversion","type":"string","enum":["DOCUMENT_CONVERSION_ERROR"],"x-enumDescriptions":{"DOCUMENT_CONVERSION_ERROR":"An error related to document conversion."},"example":"DOCUMENT_CONVERSION_ERROR"},"errorMessage":{"description":"The error message","type":"string","example":"There was a problem in converting and merging files to the output file format. Contact support."},"errorCode":{"type":"integer","description":"The error code returned during document conversion.","enum":[4,54,55,57,69,122,128,129,130,133],"x-enumDescriptions":{"4":"There was a problem in converting and merging files to the output file format. Contact support.","54":"Could not access the url you provided. {contentUrl}","55":"The string_data URL you provided is invalid","57":"There was a problem storing the file you provided.","69":"There was a problem storing the file you provided.","122":"User simulated Document Conversion Error","128":"Could not determine mimetype for file.","129":"Mimetype not supported.","130":"Mimetype not supported: application/xml","133":"Failed to normalize PDF document"}}}}}}}},"children":[],"type":"tag","tag":"json-schema","annotations":[{"type":"attribute","name":"schema","value":{"$ref":"../../../docs/fax/api-reference/fax.yaml#/components/schemas/DocumentConversionError"}}],"slots":{},"location":{"file":"partials/fax/errors/_schemas.md","start":{"line":2},"end":{"line":3}}},{"$$mdtype":"Node","errors":[],"lines":[4,5],"inline":false,"attributes":{"level":3},"children":[{"$$mdtype":"Node","errors":[],"lines":[4,5],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[4,5],"inline":true,"attributes":{"content":"Call Error"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"partials/fax/errors/_schemas.md","start":{"line":4},"end":{"line":5}}}],"type":"inline","annotations":[],"slots":{},"location":{"file":"partials/fax/errors/_schemas.md","start":{"line":4},"end":{"line":5}}}],"type":"heading","annotations":[],"slots":{},"location":{"file":"partials/fax/errors/_schemas.md","start":{"line":4},"end":{"line":5}}},{"$$mdtype":"Node","errors":[],"lines":[6,7],"inline":false,"attributes":{"schema":{"$ref":"../../../docs/fax/api-reference/fax.yaml#/components/schemas/CallError"},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/CallError"},"CallError":{"type":"object","description":"There was a problem with the phone line. The call could not be placed. Many times you can just try again","properties":{"errorType":{"description":"Type of error for the Call","type":"string","enum":["CALL_ERROR"],"x-enumDescriptions":{"CALL_ERROR":"An error related to the call."},"example":"CALL_ERROR"},"errorMessage":{"description":"A developer-facing error message","type":"string","example":"Busy"},"errorCode":{"type":"integer","description":"The error code returned describing the error of the call.","enum":[11,15,16,17,19,30,32,34,43,49],"x-enumDescriptions":{"11":"The call dropped prematurely","15":"Congestion","16":"Ring Timeout","17":"Busy","19":"Immediate Hangup","30":"No answer from a fax machine.","32":"Incompatible destination","34":"Phone number not operational","43":"Problem establishing connection","49":"The destination phone number Is Not active"}}}}}}}},"children":[],"type":"tag","tag":"json-schema","annotations":[{"type":"attribute","name":"schema","value":{"$ref":"../../../docs/fax/api-reference/fax.yaml#/components/schemas/CallError"}}],"slots":{},"location":{"file":"partials/fax/errors/_schemas.md","start":{"line":6},"end":{"line":7}}},{"$$mdtype":"Node","errors":[],"lines":[8,9],"inline":false,"attributes":{"level":3},"children":[{"$$mdtype":"Node","errors":[],"lines":[8,9],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[8,9],"inline":true,"attributes":{"content":"Fax Error"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"partials/fax/errors/_schemas.md","start":{"line":8},"end":{"line":9}}}],"type":"inline","annotations":[],"slots":{},"location":{"file":"partials/fax/errors/_schemas.md","start":{"line":8},"end":{"line":9}}}],"type":"heading","annotations":[],"slots":{},"location":{"file":"partials/fax/errors/_schemas.md","start":{"line":8},"end":{"line":9}}},{"$$mdtype":"Node","errors":[],"lines":[10,11],"inline":false,"attributes":{"schema":{"$ref":"../../../docs/fax/api-reference/fax.yaml#/components/schemas/FaxError"},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/FaxError"},"FaxError":{"type":"object","description":"A problem occurred during the fax communication process.","properties":{"errorType":{"description":"Type of error for the fax","type":"string","enum":["FAX_ERROR"],"x-enumDescriptions":{"FAX_ERROR":"An error related to the fax."},"example":"FAX_ERROR"},"errorMessage":{"description":"A developer-facing error message","type":"string","example":"Could not establish a connection to the fax server."},"errorCode":{"type":"integer","description":"The error code returned describing the error of the call","enum":[6,7,8,10,12,13,14,18,20,21,22,25,26,28,29,31,38,40,41,44,46,48,53,60,63,68,75,76,77,79,80,82,84,113,117,119,131,132,133],"x-enumDescriptions":{"6":"There was an error communicating with the far side.","7":"Far end cannot receive at the size of image","8":"No response after sending a page","10":"Disconnected after permitted retries","12":"Received no response to DCS or TCF","13":"Timed out waiting for the first message","14":"Timed out waiting for initial communication","18":"Unexpected message received","20":"The HDLC carrier did not stop in a timely manner","21":"Received a DCN from remote after sending a page","22":"Received bad response to DCS or training","25":"Far end cannot receive at the resolution of the image","26":"The remote fax machine failed to respond","28":"Failed to train with any of the compatible modems","29":"Invalid response after sending a page","31":"Fax machine incompatibility","38":"The remote fax machine hung up before receiving fax","40":"Telephony error","41":"Unexpected DCN while waiting for DCS or DIS","44":"Telephony Error","46":"Insufficient funds to send fax and not able to auto recharge; There was a problem charging your credit card. Please check your payment information and try again.","48":"No answer (The Receiving Machine May Be Out Of Paper)","53":"Unexpected DCN after EOM or MPS sequence","60":"Transmission error after page break","63":"Fax protocol error","68":"Far end is not compatible","75":"Manually canceled by user","76":"Canceled automatically because timeout exceeded","77":"Timed out waiting for receiver ready (ECM mode)","79":"Can't cancel the fax, it's already complete!","80":"Received a DCN while waiting for a DIS","82":"There was an error communicating with the far side","84":"Unexpected command after page received","113":"The file for this fax has been deleted or is not accessible.","117":"No pages received","119":"User requested simulated faxError","131":"Incomplete transmission","132":"No fax tone detected","133":"Phone number is not permitted"}}}}}}}},"children":[],"type":"tag","tag":"json-schema","annotations":[{"type":"attribute","name":"schema","value":{"$ref":"../../../docs/fax/api-reference/fax.yaml#/components/schemas/FaxError"}}],"slots":{},"location":{"file":"partials/fax/errors/_schemas.md","start":{"line":10},"end":{"line":11}}}],"type":"document","annotations":[],"slots":{}}},"variables":{"rbac":{"teams":["anonymous"]},"user":{},"remoteAddr":{"hostname":"developers.sinch.com","port":4000,"ipAddress":"216.73.217.18"},"lang":"default_locale","env":{"PUBLIC_REDOCLY_BRANCH_NAME":"main"}}},"pagePropGetterError":{"message":"","name":""}},"slug":"/docs/fax/api-reference/fax/section/errors-and-statuses","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}