Sends a PDF as a fax from one of your Allo lines. The line must be a US or Canada local number on which fax is turned on in the number settings (“Send and receive faxes”), and fax must be enabled on your account. Each page uses message credits.
The request is multipart/form-data, not JSON. The fax is sent asynchronously: the response returns the new conversation item with statusPENDING, and page_count is set once the fax has been sent.
The response is 201 with the new conversation item: typeSMS, message_typeFAX, statusPENDING, and the PDF in attachments. The fax goes out in the background. page_count is null in this response and is set once the fax has been sent. Fetch the item later with Get conversation item to follow its status.
from is a US or Canada local number you can use, with Send and receive faxes turned on in its number settings in the Allo app. Toll-free numbers and sender IDs cannot send faxes.
file is a PDF sent with content type application/pdf, of at most 12 MB.
Your team has enough credits. Each faxed page uses message credits.
See Fax overview for how faxes appear in conversations.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Allo — Help Center","description":"Documentation and support for Allo, the business phone system that does the work your calls create","colors":{"primary":"#002C2A","light":"#F7F5F0","dark":"#005C48"},"logo":{"light":"https://mintcdn.com/themobilefirstcompany/lUQseAX2HkM5_D4I/Allo-logo-dark.svg?fit=max\u0026auto=format\u0026n=lUQseAX2HkM5_D4I\u0026q=85\u0026s=fc710c4b2d7fad80babb5aff40fd445f","dark":"https://mintcdn.com/themobilefirstcompany/lUQseAX2HkM5_D4I/Allo-logo-white.svg?fit=max\u0026auto=format\u0026n=lUQseAX2HkM5_D4I\u0026q=85\u0026s=6aafc66adc4822b700749ea65edfd057","href":"https://help.withallo.com"},"favicon":"https://mintcdn.com/themobilefirstcompany/rQqa1VZUBtU6450W/icon.ico?fit=max\u0026auto=format\u0026n=rQqa1VZUBtU6450W\u0026q=85\u0026s=93c598907844385de27769ff740b1660","appearance":{"default":"light","strict":true},"background":{"color":{"dark":"#002C2A"}},"navbar":{"links":[{"href":"https://withallo.com/changelog","label":"Changelog"},{"href":"https://withallo.com/download","label":"Download"}],"primary":{"type":"button","label":"Get Started","href":"https://start.withallo.com"}},"footer":{"socials":{"x":"https://x.com/mobilefirstco","linkedin":"https://www.linkedin.com/company/the-mobile-first-company","website":"https://withallo.com"},"links":[{"header":"Product","items":[{"label":"Pricing","href":"https://withallo.com/pricing"},{"label":"Download","href":"https://withallo.com/download"},{"label":"Features","href":"https://withallo.com/features"}]},{"header":"Resources","items":[{"label":"Help Center","href":"https://help.withallo.com"},{"label":"Contact Support","href":"https://help.withallo.com/en/support/contact"},{"label":"System status","href":"https://status.withallo.com"},{"label":"Trust center","href":"https://trust.themobilefirstcompany.com/"}]},{"header":"Company","items":[{"label":"About","href":"https://withallo.com/about"},{"label":"Blog","href":"https://withallo.com/blog"}]},{"header":"Legal","items":[{"label":"Privacy Policy","href":"https://withallo.com/privacy-policy"},{"label":"Terms of Service","href":"https://withallo.com/terms-conditions"},{"label":"Trust Center","href":"https://trust.themobilefirstcompany.com"}]}]},"search":{"prompt":"Search documentation..."},"seo":{"metatags":{"canonical":"https://help.withallo.com","og:locale":"en_US","twitter:site":"@mobilefirstco"}},"icons":{"library":"lucide"},"integrations":{"ga4":{"measurementId":"G-BJ9CLYY37R"},"intercom":{"appId":"q4vb84fg"},"telemetry":{"enabled":true}},"contextual":{"options":["copy","view","chatgpt","claude","cursor"],"display":"header"},"thumbnails":{"fonts":{"family":"Inter"}},"interaction":{"drilldown":false},"styling":{"latex":true},"navigation":{"languages":[{"language":"en","navbar":{"links":[{"href":"/en/support/contact","label":"Contact support"},{"href":"https://withallo.com/changelog","label":"Changelog"},{"href":"https://withallo.com/download","label":"Download"}],"primary":{"type":"button","label":"Get Started","href":"https://start.withallo.com"}},"href":"en/get-started"},{"language":"fr","navbar":{"links":[{"href":"/fr/support/contact","label":"Contacter le support"},{"href":"https://withallo.com/changelog","label":"Changelog"},{"href":"https://withallo.com/download","label":"Download"}],"primary":{"type":"button","label":"Get Started","href":"https://start.withallo.com"}},"href":"fr/get-started"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"themobilefirstcompany","hasAudioNarration":false,"actualSubdomain":"themobilefirstcompany","customDomains":["help.withallo.com"],"gitSource":{"type":"github","owner":"themobilefirstco","repo":"doc-allo","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6af63ffe9bd18884b91c2b2f","clientVersion":"0.0.4117","searchFilterCounts":[{"language":"en","tag":"API Reference","count":148},{"language":"fr","tag":"Référence API","count":148},{"language":"en","tag":"Help","count":110},{"language":"fr","tag":"Aide","count":110},{"language":"en","tag":"Integrations","count":45},{"language":"fr","tag":"Intégrations","count":45},{"language":"en","tag":"CRM","count":23},{"language":"fr","tag":"CRM","count":23},{"language":"fr","tag":"Numéros de téléphone","count":15},{"language":"en","tag":"Partner","count":14},{"language":"fr","tag":"Partner","count":14},{"language":"en","tag":"Webhooks","count":13},{"language":"fr","tag":"Webhooks","count":13},{"language":"en","tag":"AI Receptionist","count":12},{"language":"fr","tag":"Réceptionniste IA","count":12},{"language":"en","tag":"Incoming calls","count":11},{"language":"fr","tag":"Appels entrants","count":11},{"language":"en","tag":"SMS","count":10},{"language":"en","tag":"Conversations","count":10},{"language":"fr","tag":"SMS","count":10}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"en/v2/api-reference/fax/send-fax","slug":"/en/v2/api-reference/fax/send-fax","pageMetadata":{"title":"Send fax","openapi":"POST /v2/api/faxes","description":"Sends a PDF as a fax from one of your Allo lines. The line must be a US or Canada local number on which fax is turned on in the number settings (\"Send and receive faxes\"), and fax must be enabled on your account. Each page uses message credits.\n\nThe request is `multipart/form-data`, not JSON. The fax is sent asynchronously: the response returns the new conversation item with `status` `PENDING`, and `page_count` is set once the fax has been sent.","href":"/en/v2/api-reference/fax/send-fax"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Sends a PDF as a fax from one of your Allo lines. The line must be a US or Canada local number on which fax is turned on in the number settings (“Send and receive faxes”), and fax must be enabled on your account. Each page uses message credits.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"The request is \", _jsx(_components.code, {\n children: \"multipart/form-data\"\n }), \", not JSON. The fax is sent asynchronously: the response returns the new conversation item with \", _jsx(_components.code, {\n children: \"status\"\n }), \" \", _jsx(_components.code, {\n children: \"PENDING\"\n }), \", and \", _jsx(_components.code, {\n children: \"page_count\"\n }), \" is set once the fax has been sent.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Note,Table}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Required scope:`}),` `,_jsx(_components.code,{children:`FAX_SEND`})]})}),`\n`,_jsx(Heading,{level:`2`,id:`behavior`,children:`Behavior`}),`\n`,_jsxs(_components.p,{children:[`Sends a PDF as a fax from one of your Allo lines. The request is `,_jsx(_components.code,{children:`multipart/form-data`}),` with three parts: `,_jsx(_components.code,{children:`from`}),`, `,_jsx(_components.code,{children:`to`}),` and `,_jsx(_components.code,{children:`file`}),`.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`5`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`5`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api.withallo.com/v2/api/faxes`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Api-Key YOUR_API_KEY\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -F`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"from=+14155550100\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -F`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"to=+14155551234\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -F`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"[email protected];type=application/pdf\"`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`The response is `,_jsx(_components.code,{children:`201`}),` with the new conversation item: `,_jsx(_components.code,{children:`type`}),` `,_jsx(_components.code,{children:`SMS`}),`, `,_jsx(_components.code,{children:`message_type`}),` `,_jsx(_components.code,{children:`FAX`}),`, `,_jsx(_components.code,{children:`status`}),` `,_jsx(_components.code,{children:`PENDING`}),`, and the PDF in `,_jsx(_components.code,{children:`attachments`}),`. The fax goes out in the background. `,_jsx(_components.code,{children:`page_count`}),` is `,_jsx(_components.code,{children:`null`}),` in this response and is set once the fax has been sent. Fetch the item later with `,_jsx(_components.a,{href:`/en/v2/api-reference/conversations/get-item`,children:`Get conversation item`}),` to follow its `,_jsx(_components.code,{children:`status`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`requirements`,children:`Requirements`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Fax is enabled on your account.`}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`from`}),` is a US or Canada local number you can use, with `,_jsx(_components.strong,{children:`Send and receive faxes`}),` turned on in its number settings in the Allo app. Toll-free numbers and sender IDs cannot send faxes.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`file`}),` is a PDF sent with content type `,_jsx(_components.code,{children:`application/pdf`}),`, of at most 12 MB.`]}),`\n`,_jsxs(_components.li,{children:[`Your team has enough `,_jsx(_components.a,{href:`/en/billing/credits`,children:`credits`}),`. Each faxed page uses message credits.`]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`See `,_jsx(_components.a,{href:`/en/v2/api-reference/fax/overview`,children:`Fax overview`}),` for how faxes appear in conversations.`]}),`\n`,_jsx(Heading,{level:`2`,id:`errors`,children:`Errors`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Status`}),_jsx(_components.th,{children:`Code`}),_jsx(_components.th,{children:`When`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`MISSING_PARAMETER`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`from`}),`, `,_jsx(_components.code,{children:`to`}),` or `,_jsx(_components.code,{children:`file`}),` is missing`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`FAX_NOT_SUPPORTED_ON_NUMBER`})}),_jsxs(_components.td,{children:[`The `,_jsx(_components.code,{children:`from`}),` line cannot send faxes`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`FAX_NOT_ENABLED_ON_LINE`})}),_jsxs(_components.td,{children:[_jsx(_components.strong,{children:`Send and receive faxes`}),` is turned off on the `,_jsx(_components.code,{children:`from`}),` line`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`FAX_FILE_NOT_PDF`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`file`}),` is not sent as `,_jsx(_components.code,{children:`application/pdf`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`FAX_FILE_EMPTY`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`file`}),` is empty`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`MAX_UPLOAD_SIZE_EXCEEDED`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`file`}),` is larger than 12 MB`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`402`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`INSUFFICIENT_CREDITS`})}),_jsx(_components.td,{children:`Your team does not have enough credits to send the fax`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`403`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`FAX_NOT_AVAILABLE`})}),_jsx(_components.td,{children:`Fax is not enabled on your account. Contact Allo support.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`404`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`FROM_NUMBER_NOT_FOUND`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`from`}),` is not a line you can use`]})]})]})]}),`\n`,_jsxs(_components.p,{children:[`Other errors, such as an invalid `,_jsx(_components.code,{children:`to`}),` number, are the same as for `,_jsx(_components.a,{href:`/en/v2/api-reference/sms/send-sms`,children:`sending an SMS`}),`. See `,_jsx(_components.a,{href:`/en/v2/api-reference/guides/error-codes`,children:`Error codes`}),`.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Send fax","openapi":"POST /v2/api/faxes","description":"Sends a PDF as a fax from one of your Allo lines. The line must be a US or Canada local number on which fax is turned on in the number settings (\"Send and receive faxes\"), and fax must be enabled on your account. Each page uses message credits.\n\nThe request is `multipart/form-data`, not JSON. The fax is sent asynchronously: the response returns the new conversation item with `status` `PENDING`, and `page_count` is set once the fax has been sent.","href":"/en/v2/api-reference/fax/send-fax"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Behavior","slug":"behavior","depth":2,"children":[]},{"title":"Requirements","slug":"requirements","depth":2,"children":[]},{"title":"Errors","slug":"errors","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/themobilefirstcompany/4c5a33aa336424b3/webmcp.js"],"openApiReferenceData":{"operation":{"summary":"Send fax","description":"Sends a PDF as a fax from one of your Allo lines. The line must be a US or Canada local number on which fax is turned on in the number settings (\"Send and receive faxes\"), and fax must be enabled on your account. Each page uses message credits.\n\nThe request is `multipart/form-data`, not JSON. The fax is sent asynchronously: the response returns the new conversation item with `status` `PENDING`, and `page_count` is set once the fax has been sent.","operationId":"sendFax","tags":["Fax"],"security":["71997d11-8494-41d5-b50a-d43df9938a72"],"requestBody":"71ad622e-9eb6-4e22-8be7-c10e8ed98837","responses":{"201":"22f42707-81ff-426a-8704-b3940bb5aa5c","400":"bd1439eb-eabe-40ba-85f4-d594497ade4e","401":"efb441dd-2198-467a-8e47-cda3cd813434","402":"ddf692b8-17e9-4e35-a6a2-8dc7bae1ef84","403":"33a00384-9908-4f1f-b35e-0dd682840353","404":"20a6f685-90e1-4d3c-b0df-70d1d3a56621","429":"e53a1f7d-2a04-490e-adba-99cd4372093f"},"method":"post","type":"path","servers":["2e20366c-15ad-453a-a7b1-978bb0673e81"],"path":"/v2/api/faxes","baseUrlOptions":["https://api.withallo.com"],"title":"Send fax","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"from":{"type":"string","description":"Allo line to send from, in E.164 format. Must be a line you can use with fax turned on. List your lines with `GET /v2/api/numbers`.","example":"+14155550100","isRequired":true,"uniqueKey":"from","typeLabel":"string"},"to":{"type":"string","description":"Fax number of the recipient, in E.164 format.","example":"+14155551234","isRequired":true,"uniqueKey":"to","typeLabel":"string"},"file":{"type":"string","format":"binary","description":"The document to fax: a PDF (`application/pdf`) of at most 12 MB.","isRequired":true,"uniqueKey":"file","typeLabel":"file"}},"required":["from","to","file"],"uniqueKey":"","typeLabel":"object"},"encoding":{"file":{"contentType":"application/pdf"}},"examples":{"Example":{"title":"Example","value":{"from":"+14155550100","to":"+14155551234","file":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"22f42707-81ff-426a-8704-b3940bb5aa5c":{"description":"Fax accepted for sending. Returns the new conversation item.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","example":"cll-abc123","uniqueKey":"data.id","typeLabel":"string"},"type":{"type":"string","enum":["CALL","SMS"],"description":"`CALL` for a call, `SMS` for a message. Faxes are `SMS` items with `message_type` set to `FAX`.","uniqueKey":"data.type","typeLabel":"enum\u003cstring>"},"direction":{"type":"string","enum":["INBOUND","OUTBOUND"],"uniqueKey":"data.direction","typeLabel":"enum\u003cstring>"},"allo_number":{"type":"string","example":"+14155550100","uniqueKey":"data.allo_number","typeLabel":"string"},"contact_number":{"type":"string","example":"+14155551234","uniqueKey":"data.contact_number","typeLabel":"string"},"contacts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"cnt-abc123","uniqueKey":"data.contacts.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","example":"Sarah Johnson","uniqueKey":"data.contacts.items.[INDEX].name","typeLabel":"string"},"company":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","example":"com-xyz789","uniqueKey":"data.contacts.items.[INDEX].company.oneOf.0.id","typeLabel":"string"},"name":{"type":"string","example":"Acme Corp","uniqueKey":"data.contacts.items.[INDEX].company.oneOf.0.name","typeLabel":"string"}},"uniqueKey":"data.contacts.items.[INDEX].company.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"id":{"type":"string","example":"com-xyz789"},"name":{"type":"string","example":"Acme Corp"}},"uniqueKey":"data.contacts.items.[INDEX].company.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.contacts.items.[INDEX].company","typeLabel":"object | null"},"deals":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"dea-def456","uniqueKey":"data.contacts.items.[INDEX].deals.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","example":"Enterprise Plan","uniqueKey":"data.contacts.items.[INDEX].deals.items.[INDEX].name","typeLabel":"string"},"status":{"type":"string","enum":["OPEN","WON","LOST"],"uniqueKey":"data.contacts.items.[INDEX].deals.items.[INDEX].status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.contacts.items.[INDEX].deals.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.contacts.items.[INDEX].deals","typeLabel":"object[]"}},"uniqueKey":"data.contacts.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.contacts","typeLabel":"object[]"},"user":{"type":"object","properties":{"id":{"type":"string","example":"usr-abc123","uniqueKey":"data.user.id","typeLabel":"string"},"name":{"type":"string","example":"John","uniqueKey":"data.user.name","typeLabel":"string"},"email":{"type":"string","example":"[email protected]","uniqueKey":"data.user.email","typeLabel":"string"}},"uniqueKey":"data.user","typeLabel":"object"},"date":{"type":"string","format":"date-time","uniqueKey":"data.date","typeLabel":"string\u003cdate-time>"},"duration":{"oneOf":[{"type":"integer","description":"Total call length in seconds, from when the call starts (ringing included) to when it ends. For the talk time shown in the Allo app, use `recording_duration`.","uniqueKey":"data.duration.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Total call length in seconds, from when the call starts (ringing included) to when it ends. For the talk time shown in the Allo app, use `recording_duration`.","uniqueKey":"data.duration.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.duration","typeLabel":"integer | null"},"result":{"oneOf":[{"type":"string","enum":["ANSWERED","VOICEMAIL","TRANSFERRED_AI","TRANSFERRED_EXTERNAL","BLOCKED","FAILED","FAILED_EXTERNAL","RECEIVED","CLOSED"],"description":"Call outcome. Null for SMS items. An outbound call that reached voicemail reports `VOICEMAIL`. `FAILED_EXTERNAL` only appears on older calls. New values may be added: handle unknown values gracefully.","uniqueKey":"data.result.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["ANSWERED","VOICEMAIL","TRANSFERRED_AI","TRANSFERRED_EXTERNAL","BLOCKED","FAILED","FAILED_EXTERNAL","RECEIVED","CLOSED"],"description":"Call outcome. Null for SMS items. An outbound call that reached voicemail reports `VOICEMAIL`. `FAILED_EXTERNAL` only appears on older calls. New values may be added: handle unknown values gracefully.","uniqueKey":"data.result.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.result","typeLabel":"enum\u003cstring> | null"},"detected_outbound_voicemail":{"oneOf":[{"type":"boolean","description":"Outbound calls only. `true` when the call was answered by an answering machine, `false` when a human answered, `null` when no detection ran for this call (never set on inbound calls or SMS). Note that `result` stays `ANSWERED` for these calls — the carrier considers a machine pickup an answer.","uniqueKey":"data.detected_outbound_voicemail.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Outbound calls only. `true` when the call was answered by an answering machine, `false` when a human answered, `null` when no detection ran for this call (never set on inbound calls or SMS). Note that `result` stays `ANSWERED` for these calls — the carrier considers a machine pickup an answer.","uniqueKey":"data.detected_outbound_voicemail.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.detected_outbound_voicemail","typeLabel":"boolean | null"},"voicemail_left":{"oneOf":[{"type":"boolean","description":"Outbound calls only. `true` when a message was actually left on the voicemail, `false` when the caller hung up without leaving one, `null` when not determined. Independent of `detected_outbound_voicemail`: either can be set without the other.","uniqueKey":"data.voicemail_left.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Outbound calls only. `true` when a message was actually left on the voicemail, `false` when the caller hung up without leaving one, `null` when not determined. Independent of `detected_outbound_voicemail`: either can be set without the other.","uniqueKey":"data.voicemail_left.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.voicemail_left","typeLabel":"boolean | null"},"recording_url":{"oneOf":[{"type":"string","description":"Link to the call recording. Absent when the call was not recorded, and for accounts sold under a white-label partner's brand: use `recording_download_url` there.","uniqueKey":"data.recording_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"Link to the call recording. Absent when the call was not recorded, and for accounts sold under a white-label partner's brand: use `recording_download_url` there.","uniqueKey":"data.recording_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.recording_url","typeLabel":"string | null"},"recording_download_url":{"oneOf":[{"type":"string","description":"Signed link that downloads the recording with no login, valid for 48 hours. Returned only for lines of accounts created by a partner, never for a call on a HIPAA-enabled team, and only when the key's user can play the recording. For a fresh link, call `GET /v2/api/conversations/items/{id}/recording`.","uniqueKey":"data.recording_download_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"Signed link that downloads the recording with no login, valid for 48 hours. Returned only for lines of accounts created by a partner, never for a call on a HIPAA-enabled team, and only when the key's user can play the recording. For a fresh link, call `GET /v2/api/conversations/items/{id}/recording`.","uniqueKey":"data.recording_download_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.recording_download_url","typeLabel":"string | null"},"recording_download_expires_at":{"oneOf":[{"type":"string","format":"date-time","description":"When `recording_download_url` stops working.","uniqueKey":"data.recording_download_expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When `recording_download_url` stops working.","uniqueKey":"data.recording_download_expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.recording_download_expires_at","typeLabel":"string\u003cdate-time> | null"},"recording_duration":{"oneOf":[{"type":"integer","description":"Length of the call recording in seconds: the talk time, excluding ringing. This is the duration shown in the Allo app for recorded calls. `null` when the call was not recorded.","uniqueKey":"data.recording_duration.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Length of the call recording in seconds: the talk time, excluding ringing. This is the duration shown in the Allo app for recorded calls. `null` when the call was not recorded.","uniqueKey":"data.recording_duration.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.recording_duration","typeLabel":"integer | null"},"summary":{"oneOf":[{"type":"string","uniqueKey":"data.summary.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.summary.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.summary","typeLabel":"string | null"},"tags":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"data.tags.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.tags.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"uniqueKey":"data.tags.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.tags","typeLabel":"string[] | null"},"extracted_data":{"oneOf":[{"type":"object","description":"Contact details Allo's AI picked up from the call transcript, under a `contact` object: `name`, `company`, `job_title`, `website`, `address` (strings, empty when not mentioned) and `emails` (array). Null for SMS items and for calls Allo has not analyzed.","properties":{"contact":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"data.extracted_data.oneOf.0.contact.name","typeLabel":"string"},"company":{"type":"string","uniqueKey":"data.extracted_data.oneOf.0.contact.company","typeLabel":"string"},"job_title":{"type":"string","uniqueKey":"data.extracted_data.oneOf.0.contact.job_title","typeLabel":"string"},"website":{"type":"string","uniqueKey":"data.extracted_data.oneOf.0.contact.website","typeLabel":"string"},"address":{"type":"string","uniqueKey":"data.extracted_data.oneOf.0.contact.address","typeLabel":"string"},"emails":{"type":"array","items":{"type":"string","uniqueKey":"data.extracted_data.oneOf.0.contact.emails.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.extracted_data.oneOf.0.contact.emails","typeLabel":"string[]"}},"uniqueKey":"data.extracted_data.oneOf.0.contact","typeLabel":"object"}},"additionalProperties":true,"example":{"contact":{"name":"Marie Dupont","company":"Vibrant Events","job_title":"Office manager","website":"vibrantevents.com","address":"12 rue de la Paix, Paris","emails":["[email protected]"]}},"uniqueKey":"data.extracted_data.oneOf.0","typeLabel":"object"},{"type":"null","description":"Contact details Allo's AI picked up from the call transcript, under a `contact` object: `name`, `company`, `job_title`, `website`, `address` (strings, empty when not mentioned) and `emails` (array). Null for SMS items and for calls Allo has not analyzed.","properties":{"contact":{"type":"object","properties":{"name":{"type":"string"},"company":{"type":"string"},"job_title":{"type":"string"},"website":{"type":"string"},"address":{"type":"string"},"emails":{"type":"array","items":{"type":"string"}}}}},"additionalProperties":true,"example":{"contact":{"name":"Marie Dupont","company":"Vibrant Events","job_title":"Office manager","website":"vibrantevents.com","address":"12 rue de la Paix, Paris","emails":["[email protected]"]}},"uniqueKey":"data.extracted_data.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.extracted_data","typeLabel":"object | null"},"data_collected":{"oneOf":[{"type":"object","additionalProperties":{"type":"string","uniqueKey":"data.data_collected.oneOf.0.additionalProperties","typeLabel":"string"},"description":"Legacy field kept for compatibility. An empty object on current calls. Null for SMS items.","uniqueKey":"data.data_collected.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"string","uniqueKey":"data.data_collected.oneOf.1.additionalProperties","typeLabel":"string"},"description":"Legacy field kept for compatibility. An empty object on current calls. Null for SMS items.","uniqueKey":"data.data_collected.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.data_collected","typeLabel":"object | null"},"transcript":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"source":{"type":"string","enum":["USER","EXTERNAL"],"uniqueKey":"data.transcript.oneOf.0.items.[INDEX].source","typeLabel":"enum\u003cstring>"},"time":{"type":"string","format":"date-time","uniqueKey":"data.transcript.oneOf.0.items.[INDEX].time","typeLabel":"string\u003cdate-time>"},"text":{"type":"string","uniqueKey":"data.transcript.oneOf.0.items.[INDEX].text","typeLabel":"string"}},"uniqueKey":"data.transcript.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.transcript.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"source":{"type":"string","enum":["USER","EXTERNAL"]},"time":{"type":"string","format":"date-time"},"text":{"type":"string"}}},"uniqueKey":"data.transcript.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.transcript","typeLabel":"object[] | null"},"content":{"oneOf":[{"type":"string","uniqueKey":"data.content.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.content.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.content","typeLabel":"string | null"},"status":{"oneOf":[{"type":"string","enum":["PENDING","SENT","DELIVERED","FAILED"],"uniqueKey":"data.status.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["PENDING","SENT","DELIVERED","FAILED"],"uniqueKey":"data.status.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.status","typeLabel":"enum\u003cstring> | null"},"message_type":{"oneOf":[{"type":"string","enum":["SMS","MMS","WHATSAPP","FAX"],"uniqueKey":"data.message_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["SMS","MMS","WHATSAPP","FAX"],"uniqueKey":"data.message_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.message_type","typeLabel":"enum\u003cstring> | null"},"attachments":{"oneOf":[{"type":"array","description":"Photos and other files sent with the message, in the order they were sent. For a fax, the faxed PDF. An empty array for a message with no files, and `null` for a call.","items":{"type":"object","properties":{"file_name":{"type":"string","example":"IMG_0412.jpg","uniqueKey":"data.attachments.oneOf.0.items.[INDEX].file_name","typeLabel":"string"},"content_type":{"type":"string","description":"MIME type of the file.","example":"image/jpeg","uniqueKey":"data.attachments.oneOf.0.items.[INDEX].content_type","typeLabel":"string"},"file_size":{"oneOf":[{"type":"integer","format":"int64","description":"Size of the file in bytes.","example":245760,"uniqueKey":"data.attachments.oneOf.0.items.[INDEX].file_size.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","format":"int64","description":"Size of the file in bytes.","example":245760,"uniqueKey":"data.attachments.oneOf.0.items.[INDEX].file_size.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.attachments.oneOf.0.items.[INDEX].file_size","typeLabel":"integer\u003cint64> | null"},"download_url":{"oneOf":[{"type":"string","description":"Signed link that downloads the file with no login, valid for 30 minutes. `null` for a message on a HIPAA-enabled team. For a fresh link, fetch the item again.","uniqueKey":"data.attachments.oneOf.0.items.[INDEX].download_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"Signed link that downloads the file with no login, valid for 30 minutes. `null` for a message on a HIPAA-enabled team. For a fresh link, fetch the item again.","uniqueKey":"data.attachments.oneOf.0.items.[INDEX].download_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.attachments.oneOf.0.items.[INDEX].download_url","typeLabel":"string | null"},"download_expires_at":{"oneOf":[{"type":"string","format":"date-time","description":"When `download_url` stops working.","uniqueKey":"data.attachments.oneOf.0.items.[INDEX].download_expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When `download_url` stops working.","uniqueKey":"data.attachments.oneOf.0.items.[INDEX].download_expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.attachments.oneOf.0.items.[INDEX].download_expires_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"data.attachments.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.attachments.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"Photos and other files sent with the message, in the order they were sent. For a fax, the faxed PDF. An empty array for a message with no files, and `null` for a call.","items":{"type":"object","properties":{"file_name":{"type":"string","example":"IMG_0412.jpg"},"content_type":{"type":"string","description":"MIME type of the file.","example":"image/jpeg"},"file_size":{"oneOf":[{"type":"integer","format":"int64","description":"Size of the file in bytes.","example":245760},{"type":"null","format":"int64","description":"Size of the file in bytes.","example":245760}]},"download_url":{"oneOf":[{"type":"string","description":"Signed link that downloads the file with no login, valid for 30 minutes. `null` for a message on a HIPAA-enabled team. For a fresh link, fetch the item again."},{"type":"null","description":"Signed link that downloads the file with no login, valid for 30 minutes. `null` for a message on a HIPAA-enabled team. For a fresh link, fetch the item again."}]},"download_expires_at":{"oneOf":[{"type":"string","format":"date-time","description":"When `download_url` stops working."},{"type":"null","format":"date-time","description":"When `download_url` stops working."}]}}},"uniqueKey":"data.attachments.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.attachments","typeLabel":"object[] | null"},"page_count":{"oneOf":[{"type":"integer","description":"Number of pages of a fax. `null` for calls, for messages that are not faxes, and for a fax whose page count is not known yet.","example":4,"uniqueKey":"data.page_count.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Number of pages of a fax. `null` for calls, for messages that are not faxes, and for a fax whose page count is not known yet.","example":4,"uniqueKey":"data.page_count.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.page_count","typeLabel":"integer | null"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"data":{"id":"msg-abc123","type":"SMS","direction":"OUTBOUND","allo_number":"+14155550100","contact_number":"+14155551234","contacts":[],"user":{"id":"usr-abc123","name":"Alex Kim","email":"[email protected]"},"date":"2026-11-10T14:30:00","content":"","status":"PENDING","message_type":"FAX","attachments":[{"file_name":"contract.pdf","content_type":"application/pdf","file_size":184320,"download_url":"https://...contract.pdf?X-Amz-Expires=1800\u0026X-Amz-Signature=...","download_expires_at":"2026-11-10T15:00:00Z"}],"page_count":null}},"examples":{"Example":{"title":"Example","value":{"data":{"id":"msg-abc123","type":"SMS","direction":"OUTBOUND","allo_number":"+14155550100","contact_number":"+14155551234","contacts":[],"user":{"id":"usr-abc123","name":"Alex Kim","email":"[email protected]"},"date":"2026-11-10T14:30:00","content":"","status":"PENDING","message_type":"FAX","attachments":[{"file_name":"contract.pdf","content_type":"application/pdf","file_size":184320,"download_url":"https://...contract.pdf?X-Amz-Expires=1800\u0026X-Amz-Signature=...","download_expires_at":"2026-11-10T15:00:00Z"}],"page_count":null}}}},"exampleType":"examples"}},"exampleType":"examples"},"bd1439eb-eabe-40ba-85f4-d594497ade4e":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","uniqueKey":"error.type","typeLabel":"string"},"code":{"type":"string","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","uniqueKey":"error.retryable","typeLabel":"boolean"},"request_id":{"type":"string","uniqueKey":"error.request_id","typeLabel":"string"},"retry_after_seconds":{"oneOf":[{"type":"integer","uniqueKey":"error.retry_after_seconds.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"error.retry_after_seconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.retry_after_seconds","typeLabel":"integer | null"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"\u003cstring>","code":"\u003cstring>","message":"\u003cstring>","retryable":true,"request_id":"\u003cstring>","retry_after_seconds":123}}}},"exampleType":"generated"}},"exampleType":"generated"},"efb441dd-2198-467a-8e47-cda3cd813434":{"description":"Invalid or missing API key","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","uniqueKey":"error.type","typeLabel":"string"},"code":{"type":"string","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","uniqueKey":"error.retryable","typeLabel":"boolean"},"request_id":{"type":"string","uniqueKey":"error.request_id","typeLabel":"string"},"retry_after_seconds":{"oneOf":[{"type":"integer","uniqueKey":"error.retry_after_seconds.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"error.retry_after_seconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.retry_after_seconds","typeLabel":"integer | null"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"\u003cstring>","code":"\u003cstring>","message":"\u003cstring>","retryable":true,"request_id":"\u003cstring>","retry_after_seconds":123}}}},"exampleType":"generated"}},"exampleType":"generated"},"ddf692b8-17e9-4e35-a6a2-8dc7bae1ef84":{"description":"Not enough message credits to send the fax","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","uniqueKey":"error.type","typeLabel":"string"},"code":{"type":"string","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","uniqueKey":"error.retryable","typeLabel":"boolean"},"request_id":{"type":"string","uniqueKey":"error.request_id","typeLabel":"string"},"retry_after_seconds":{"oneOf":[{"type":"integer","uniqueKey":"error.retry_after_seconds.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"error.retry_after_seconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.retry_after_seconds","typeLabel":"integer | null"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"\u003cstring>","code":"\u003cstring>","message":"\u003cstring>","retryable":true,"request_id":"\u003cstring>","retry_after_seconds":123}}}},"exampleType":"generated"}},"exampleType":"generated"},"33a00384-9908-4f1f-b35e-0dd682840353":{"description":"API key lacks the required scope or access to the resource","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","uniqueKey":"error.type","typeLabel":"string"},"code":{"type":"string","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","uniqueKey":"error.retryable","typeLabel":"boolean"},"request_id":{"type":"string","uniqueKey":"error.request_id","typeLabel":"string"},"retry_after_seconds":{"oneOf":[{"type":"integer","uniqueKey":"error.retry_after_seconds.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"error.retry_after_seconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.retry_after_seconds","typeLabel":"integer | null"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"\u003cstring>","code":"\u003cstring>","message":"\u003cstring>","retryable":true,"request_id":"\u003cstring>","retry_after_seconds":123}}}},"exampleType":"generated"}},"exampleType":"generated"},"20a6f685-90e1-4d3c-b0df-70d1d3a56621":{"description":"Resource not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","uniqueKey":"error.type","typeLabel":"string"},"code":{"type":"string","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","uniqueKey":"error.retryable","typeLabel":"boolean"},"request_id":{"type":"string","uniqueKey":"error.request_id","typeLabel":"string"},"retry_after_seconds":{"oneOf":[{"type":"integer","uniqueKey":"error.retry_after_seconds.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"error.retry_after_seconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.retry_after_seconds","typeLabel":"integer | null"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"\u003cstring>","code":"\u003cstring>","message":"\u003cstring>","retryable":true,"request_id":"\u003cstring>","retry_after_seconds":123}}}},"exampleType":"generated"}},"exampleType":"generated"},"e53a1f7d-2a04-490e-adba-99cd4372093f":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","uniqueKey":"error.type","typeLabel":"string"},"code":{"type":"string","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","uniqueKey":"error.retryable","typeLabel":"boolean"},"request_id":{"type":"string","uniqueKey":"error.request_id","typeLabel":"string"},"retry_after_seconds":{"oneOf":[{"type":"integer","uniqueKey":"error.retry_after_seconds.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"error.retry_after_seconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.retry_after_seconds","typeLabel":"integer | null"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"\u003cstring>","code":"\u003cstring>","message":"\u003cstring>","retryable":true,"request_id":"\u003cstring>","retry_after_seconds":123}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"71997d11-8494-41d5-b50a-d43df9938a72":{"FaxAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Scope needed: `FAX_SEND`","scopes":[],"schemeName":"FaxAuth"}}},"servers":{"2e20366c-15ad-453a-a7b1-978bb0673e81":{"url":"https://api.withallo.com","description":"Production server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"Authorization","description":"Scope needed: `FAX_SEND`","scopes":[],"schemeName":"FaxAuth"},"schema":{"title":"Authorization","type":"string","description":"Scope needed: `FAX_SEND`","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"FaxAuth","name":"Authorization"}],"title":"FaxAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"themobilefirstcompany","siteName":"Allo — Help Center","title":"Send fax - Allo — Help Center","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/en/v2/api-reference/fax/send-fax","matchLevel":0},"fr":{"href":"/fr/v2/api-reference/fax/send-fax","matchLevel":1}}},"lastModified":"2026-11-12T19:38:01.384Z","originalFileLocation":"en/v2/api-reference/fax/send-fax.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"light\";if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Sends a PDF as a fax from one of your Allo lines. The line must be a US or Canada local number on which fax is turned on in the number settings (\u0026quot;Send and receive faxes\u0026quot;), and fax must be enabled on your account. Each page uses message credits. The request is multipart/form-data, not JSON. The fax is sent asynchronously: the response returns the new conversation item with status PENDING, and page_count is set once the fax has been sent.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Allo — Help Center\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/themobilefirstcompany/XpmSCPLu2mWezDP7/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/themobilefirstcompany/XpmSCPLu2mWezDP7/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/themobilefirstcompany/XpmSCPLu2mWezDP7/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/themobilefirstcompany/XpmSCPLu2mWezDP7/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/themobilefirstcompany/XpmSCPLu2mWezDP7/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/themobilefirstcompany/XpmSCPLu2mWezDP7/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/themobilefirstcompany/XpmSCPLu2mWezDP7/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/themobilefirstcompany/XpmSCPLu2mWezDP7/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/themobilefirstcompany/XpmSCPLu2mWezDP7/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Send fax - Allo — Help Center\">\u003cmeta data-mint-head property=\"og:description\" content=\"Sends a PDF as a fax from one of your Allo lines. The line must be a US or Canada local number on which fax is turned on in the number settings (\u0026quot;Send and receive faxes\u0026quot;), and fax must be enabled on your account. Each page uses message credits. The request is multipart/form-data, not JSON. The fax is sent asynchronously: the response returns the new conversation item with status PENDING, and page_count is set once the fax has been sent.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Allo — Help Center\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://help.withallo.com/en/v2/api-reference/fax/send-fax\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://themobilefirstcompany.mintlify.site/_mintlify/api/og/v2?division=Fax\u0026amp;title=Send+fax\u0026amp;description=Sends+a+PDF+as+a+fax+from+one+of+your+Allo+lines.+The+line+must+be+a+US+or+Canada+local+number+on+which+fax+is+turned+on+in+the+number+settings+%28%22Send+and+recei\u0026amp;theme=d52a52b70fc68cc035df5145\u0026amp;signature=2e22478a66a47015367fce9859bd41c453f2732a9943e7e96563c164629d5458\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Send fax - Allo — Help Center\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Sends a PDF as a fax from one of your Allo lines. The line must be a US or Canada local number on which fax is turned on in the number settings (\u0026quot;Send and receive faxes\u0026quot;), and fax must be enabled on your account. Each page uses message credits. The request is multipart/form-data, not JSON. The fax is sent asynchronously: the response returns the new conversation item with status PENDING, and page_count is set once the fax has been sent.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://themobilefirstcompany.mintlify.site/_mintlify/api/og/v2?division=Fax\u0026amp;title=Send+fax\u0026amp;description=Sends+a+PDF+as+a+fax+from+one+of+your+Allo+lines.+The+line+must+be+a+US+or+Canada+local+number+on+which+fax+is+turned+on+in+the+number+settings+%28%22Send+and+recei\u0026amp;theme=d52a52b70fc68cc035df5145\u0026amp;signature=2e22478a66a47015367fce9859bd41c453f2732a9943e7e96563c164629d5458\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/themobilefirstcompany/XpmSCPLu2mWezDP7/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Allo — Help Center\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#002C2A\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003clink data-mint-head rel=\"canonical\" href=\"https://help.withallo.com/en/v2/api-reference/fax/send-fax\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/en/v2/api-reference/fax/send-fax.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://help.withallo.com/en/v2/api-reference/fax/send-fax\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"fr\" href=\"https://help.withallo.com/fr/v2/api-reference/fax/send-fax\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://help.withallo.com/en/v2/api-reference/fax/send-fax\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://help.withallo.com/#organization\",\"name\":\"Allo — Help Center\",\"url\":\"https://help.withallo.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/themobilefirstcompany/lUQseAX2HkM5_D4I/Allo-logo-dark.svg?fit=max\u0026auto=format\u0026n=lUQseAX2HkM5_D4I\u0026q=85\u0026s=fc710c4b2d7fad80babb5aff40fd445f\"}},{\"@type\":\"WebSite\",\"@id\":\"https://help.withallo.com#website\",\"name\":\"Allo — Help Center\",\"url\":\"https://help.withallo.com\",\"publisher\":{\"@id\":\"https://help.withallo.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://help.withallo.com/en/v2/api-reference/fax/send-fax#webpage\",\"url\":\"https://help.withallo.com/en/v2/api-reference/fax/send-fax\",\"name\":\"Send fax\",\"description\":\"Sends a PDF as a fax from one of your Allo lines. The line must be a US or Canada local number on which fax is turned on in the number settings (\\\"Send and receive faxes\\\"), and fax must be enabled on your account. Each page uses message credits. The request is multipart/form-data, not JSON. The fax is sent asynchronously: the response returns the new conversation item with status PENDING, and page_count is set once the fax has been sent.\",\"dateModified\":\"2026-11-12T19:38:01.384Z\",\"isPartOf\":{\"@id\":\"https://help.withallo.com#website\"},\"breadcrumb\":{\"@id\":\"https://help.withallo.com/en/v2/api-reference/fax/send-fax#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://help.withallo.com/en/v2/api-reference/fax/send-fax#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Fax\",\"item\":\"https://help.withallo.com/en/v2/api-reference/fax/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Send fax\",\"item\":\"https://help.withallo.com/en/v2/api-reference/fax/send-fax\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://help.withallo.com/en/v2/api-reference/fax/send-fax#apireference\",\"headline\":\"Send fax\",\"name\":\"Send fax\",\"description\":\"Sends a PDF as a fax from one of your Allo lines. The line must be a US or Canada local number on which fax is turned on in the number settings (\\\"Send and receive faxes\\\"), and fax must be enabled on your account. Each page uses message credits. The request is multipart/form-data, not JSON. The fax is sent asynchronously: the response returns the new conversation item with status PENDING, and page_count is set once the fax has been sent.\",\"url\":\"https://help.withallo.com/en/v2/api-reference/fax/send-fax\",\"mainEntityOfPage\":{\"@id\":\"https://help.withallo.com/en/v2/api-reference/fax/send-fax#webpage\"},\"dateModified\":\"2026-11-12T19:38:01.384Z\",\"publisher\":{\"@id\":\"https://help.withallo.com/#organization\"},\"isPartOf\":{\"@id\":\"https://help.withallo.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Allo — Help Center\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Allo — Help Center\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/en/v2/api-reference/fax/send-fax.md","siteName":"Allo — Help Center","nav":{"global":null,"languages":[{"language":"en","navbar":{"links":[{"href":"/en/support/contact","label":"Contact support"},{"href":"https://withallo.com/changelog","label":"Changelog"},{"href":"https://withallo.com/download","label":"Download"}],"primary":{"type":"button","label":"Get Started","href":"https://start.withallo.com"}},"tabs":[{"tab":"Help","pages":[{"title":"Help","href":"/en/get-started"}]},{"tab":"API Reference","groups":[{"group":"API","pages":[{"title":"Overview","href":"/en/v2/api-reference/introduction"},{"title":"Authentication","href":"/en/v2/api-reference/guides/authentication"},{"title":"Rate limits","href":"/en/v2/api-reference/guides/rate-limits"},{"title":"Pagination","href":"/en/v2/api-reference/guides/pagination"},{"title":"Error handling","href":"/en/v2/api-reference/guides/error-handling"},{"title":"Error codes","href":"/en/v2/api-reference/guides/error-codes"},{"title":"Common use cases","href":"/en/v2/api-reference/guides/common-use-cases"}]},{"group":"Webhooks","pages":[{"title":"Overview","href":"/en/v2/api-reference/webhooks/overview"},{"title":"List webhooks","openapi":"GET /v2/api/webhooks","href":"/en/v2/api-reference/webhooks/get-webhooks"},{"title":"Get webhook","openapi":"GET /v2/api/webhooks/{webhook_id}","href":"/en/v2/api-reference/webhooks/get-webhook"},{"title":"Create webhook","openapi":"POST /v2/api/webhooks","href":"/en/v2/api-reference/webhooks/create-webhook"},{"title":"Update webhook","openapi":"PUT /v2/api/webhooks/{webhook_id}","href":"/en/v2/api-reference/webhooks/update-webhook"},{"title":"Delete webhook","openapi":"DELETE /v2/api/webhooks/{webhook_id}","href":"/en/v2/api-reference/webhooks/delete-webhook"},{"title":"List event types","openapi":"GET /v2/api/webhooks/event_types","href":"/en/v2/api-reference/webhooks/list-event-types"},{"title":"Event catalog","href":"/en/v2/api-reference/webhooks/event-catalog"},{"title":"Verifying webhook signatures","href":"/en/v2/api-reference/webhooks/verifying-signatures"},{"title":"Delivery and retries","href":"/en/v2/api-reference/webhooks/delivery-and-retries"},{"title":"Testing webhooks","href":"/en/v2/api-reference/webhooks/testing"},{"title":"Best practices","href":"/en/v2/api-reference/webhooks/best-practices"},{"title":"Troubleshoot","href":"/en/v2/api-reference/webhooks/troubleshooting"}]},{"group":"Conversations","pages":[{"title":"Overview","href":"/en/v2/api-reference/conversations/overview"},{"title":"List conversations","openapi":"GET /v2/api/conversations","href":"/en/v2/api-reference/conversations/list-conversations"},{"title":"Get conversation item","openapi":"GET /v2/api/conversations/items/{id}","href":"/en/v2/api-reference/conversations/get-item"},{"title":"Get recording download link","openapi":"GET /v2/api/conversations/items/{id}/recording","href":"/en/v2/api-reference/conversations/get-item-recording"},{"title":"Search conversation items","openapi":"POST /v2/api/conversations/items/search","href":"/en/v2/api-reference/conversations/search-conversation-items"},{"title":"Get many conversation items","openapi":"POST /v2/api/conversations/items/batch","href":"/en/v2/api-reference/conversations/batch-get"},{"title":"Execute conversation action","openapi":"PUT /v2/api/conversations/{contact_number}/action","href":"/en/v2/api-reference/conversations/execute-action"},{"title":"Update call summary","openapi":"PATCH /v2/api/conversations/items/{id}/summary","href":"/en/v2/api-reference/conversations/update-summary"},{"title":"Pin conversation","openapi":"PUT /v2/api/conversations/{contact_number}/pin","href":"/en/v2/api-reference/conversations/pin-conversation"},{"title":"Unpin conversation","openapi":"DELETE /v2/api/conversations/{contact_number}/pin","href":"/en/v2/api-reference/conversations/unpin-conversation"}]},{"group":"CRM","pages":[{"title":"Overview","href":"/en/v2/api-reference/crm/overview"}]},{"group":"People","pages":[{"title":"Overview","href":"/en/v2/api-reference/crm/people-overview"},{"title":"Get person","openapi":"GET /v2/api/crm/people/{id}","href":"/en/v2/api-reference/crm/get-person"},{"title":"Create person","openapi":"POST /v2/api/crm/people","href":"/en/v2/api-reference/crm/create-person"},{"title":"Update person","openapi":"PUT /v2/api/crm/people/{id}","href":"/en/v2/api-reference/crm/update-person"},{"title":"Search people","openapi":"POST /v2/api/crm/people/search","href":"/en/v2/api-reference/crm/search-people"}]},{"group":"Custom fields","pages":[{"title":"Overview","href":"/en/v2/api-reference/crm/attributes-overview"},{"title":"List custom fields","openapi":"GET /v2/api/crm/attributes","href":"/en/v2/api-reference/crm/list-attributes"},{"title":"Create custom field","openapi":"POST /v2/api/crm/attributes","href":"/en/v2/api-reference/crm/create-attribute"},{"title":"Update custom field","openapi":"PATCH /v2/api/crm/attributes/{key}","href":"/en/v2/api-reference/crm/update-attribute"},{"title":"Delete custom field","openapi":"DELETE /v2/api/crm/attributes/{key}","href":"/en/v2/api-reference/crm/delete-attribute"}]},{"group":"Views","pages":[{"title":"Overview","href":"/en/v2/api-reference/crm/views-overview"},{"title":"List views","openapi":"GET /v2/api/crm/views","href":"/en/v2/api-reference/crm/list-views"},{"title":"Get view","openapi":"GET /v2/api/crm/views/{id}","href":"/en/v2/api-reference/crm/get-view"},{"title":"Create view","openapi":"POST /v2/api/crm/views","href":"/en/v2/api-reference/crm/create-view"},{"title":"Update view","openapi":"PATCH /v2/api/crm/views/{id}","href":"/en/v2/api-reference/crm/update-view"},{"title":"Delete view","openapi":"DELETE /v2/api/crm/views/{id}","href":"/en/v2/api-reference/crm/delete-view"}]},{"group":"Companies","pages":[{"title":"Overview","href":"/en/v2/api-reference/crm/companies-overview"},{"title":"Get company","openapi":"GET /v2/api/crm/companies/{id}","href":"/en/v2/api-reference/crm/get-company"},{"title":"Create company","openapi":"POST /v2/api/crm/companies","href":"/en/v2/api-reference/crm/create-company"},{"title":"Update company","openapi":"PUT /v2/api/crm/companies/{id}","href":"/en/v2/api-reference/crm/update-company"},{"title":"Search companies","openapi":"POST /v2/api/crm/companies/search","href":"/en/v2/api-reference/crm/search-companies"},{"title":"List company attributes","openapi":"GET /v2/api/crm/companies/attributes","href":"/en/v2/api-reference/crm/list-company-attributes"},{"title":"Create company attribute","openapi":"POST /v2/api/crm/companies/attributes","href":"/en/v2/api-reference/crm/create-company-attribute"},{"title":"Update company attribute","openapi":"PATCH /v2/api/crm/companies/attributes/{key}","href":"/en/v2/api-reference/crm/update-company-attribute"},{"title":"Delete company attribute","openapi":"DELETE /v2/api/crm/companies/attributes/{key}","href":"/en/v2/api-reference/crm/delete-company-attribute"}]},{"group":"Deals","pages":[{"title":"Overview","href":"/en/v2/api-reference/crm/deals-overview"},{"title":"Search deals","openapi":"POST /v2/api/crm/deals/search","href":"/en/v2/api-reference/crm/search-deals"},{"title":"Get deal","openapi":"GET /v2/api/crm/deals/{id}","href":"/en/v2/api-reference/crm/get-deal"}]},{"group":"Notes","pages":[{"title":"Overview","href":"/en/v2/api-reference/notes/overview"},{"title":"List conversation notes","openapi":"GET /v2/api/conversations/{contact_number}/notes","href":"/en/v2/api-reference/notes/list-conversation-notes"},{"title":"Create conversation note","openapi":"POST /v2/api/conversations/{contact_number}/notes","href":"/en/v2/api-reference/notes/create-conversation-note"},{"title":"Get conversation note","openapi":"GET /v2/api/conversations/notes/{id}","href":"/en/v2/api-reference/notes/get-conversation-note"},{"title":"Update conversation note","openapi":"PATCH /v2/api/conversations/notes/{id}","href":"/en/v2/api-reference/notes/update-conversation-note"},{"title":"Delete conversation note","openapi":"DELETE /v2/api/conversations/notes/{id}","href":"/en/v2/api-reference/notes/delete-conversation-note"},{"title":"List person notes","openapi":"GET /v2/api/crm/people/{person_id}/notes","href":"/en/v2/api-reference/notes/list-person-notes"},{"title":"Create person note","openapi":"POST /v2/api/crm/people/{person_id}/notes","href":"/en/v2/api-reference/notes/create-person-note"},{"title":"Update person note","openapi":"PATCH /v2/api/crm/people/{person_id}/notes/{note_id}","href":"/en/v2/api-reference/notes/update-person-note"},{"title":"Delete person note","openapi":"DELETE /v2/api/crm/people/{person_id}/notes/{note_id}","href":"/en/v2/api-reference/notes/delete-person-note"}]},{"group":"Threads","pages":[{"title":"Overview","href":"/en/v2/api-reference/threads/overview"},{"title":"Get thread","openapi":"GET /v2/api/threads/{id}","href":"/en/v2/api-reference/threads/get-thread"},{"title":"Find thread","openapi":"GET /v2/api/threads","href":"/en/v2/api-reference/threads/find-thread"},{"title":"Create thread","openapi":"POST /v2/api/threads","href":"/en/v2/api-reference/threads/create-thread"},{"title":"Create thread comment","openapi":"POST /v2/api/threads/{id}/comments","href":"/en/v2/api-reference/threads/create-comment"},{"title":"Update thread comment","openapi":"PATCH /v2/api/threads/comments/{comment_id}","href":"/en/v2/api-reference/threads/update-comment"},{"title":"Resolve thread","openapi":"POST /v2/api/threads/{id}/resolve","href":"/en/v2/api-reference/threads/resolve-thread"},{"title":"Unresolve thread","openapi":"POST /v2/api/threads/{id}/unresolve","href":"/en/v2/api-reference/threads/unresolve-thread"}]},{"group":"Inboxes","pages":[{"title":"Overview","href":"/en/v2/api-reference/inboxes/overview"},{"title":"List inboxes","openapi":"GET /v2/api/inboxes","href":"/en/v2/api-reference/inboxes/list-inboxes"},{"title":"Get inbox suggestions","openapi":"GET /v2/api/inboxes/suggestions","href":"/en/v2/api-reference/inboxes/get-inbox-suggestions"},{"title":"List menu options","openapi":"GET /v2/api/numbers/{number}/menu_options","href":"/en/v2/api-reference/inboxes/list-menu-options"},{"title":"Create inbox","openapi":"POST /v2/api/inboxes","href":"/en/v2/api-reference/inboxes/create-inbox"},{"title":"Update inbox","openapi":"PATCH /v2/api/inboxes/{inbox_id}","href":"/en/v2/api-reference/inboxes/update-inbox"},{"title":"Delete inbox","openapi":"DELETE /v2/api/inboxes/{inbox_id}","href":"/en/v2/api-reference/inboxes/delete-inbox"}]},{"group":"Phone Numbers","pages":[{"title":"Overview","href":"/en/v2/api-reference/phone-numbers/overview"},{"title":"List phone numbers","openapi":"GET /v2/api/numbers","href":"/en/v2/api-reference/phone-numbers/list-numbers"},{"title":"Get call flow","openapi":"GET /v2/api/numbers/{number}/call_flow","href":"/en/v2/api-reference/phone-numbers/get-call-flow"},{"title":"Get call flow draft","openapi":"GET /v2/api/numbers/{number}/call_flow/draft","href":"/en/v2/api-reference/phone-numbers/get-call-flow-draft"},{"title":"Save call flow draft","openapi":"PUT /v2/api/numbers/{number}/call_flow/draft","href":"/en/v2/api-reference/phone-numbers/save-call-flow-draft"},{"title":"Publish call flow","openapi":"POST /v2/api/numbers/{number}/call_flow/publish","href":"/en/v2/api-reference/phone-numbers/publish-call-flow"}]},{"group":"AI Receptionist","pages":[{"title":"Overview","href":"/en/v2/api-reference/agent/overview"},{"title":"Get configuration","openapi":"GET /v2/api/numbers/{number}/agent","href":"/en/v2/api-reference/agent/get-agent"},{"title":"Update configuration","openapi":"PATCH /v2/api/numbers/{number}/agent","href":"/en/v2/api-reference/agent/update-agent"},{"title":"Set prompt","openapi":"PUT /v2/api/numbers/{number}/agent/prompt","href":"/en/v2/api-reference/agent/set-agent-prompt"},{"title":"Turn on or off","openapi":"PUT /v2/api/numbers/{number}/agent/status","href":"/en/v2/api-reference/agent/set-agent-status"},{"title":"Add website knowledge","openapi":"POST /v2/api/numbers/{number}/agent/knowledge/websites","href":"/en/v2/api-reference/agent/add-website-knowledge"},{"title":"Enable or disable a website","openapi":"PATCH /v2/api/numbers/{number}/agent/knowledge/websites/{id}","href":"/en/v2/api-reference/agent/update-website-knowledge"},{"title":"Delete website knowledge","openapi":"DELETE /v2/api/numbers/{number}/agent/knowledge/websites/{id}","href":"/en/v2/api-reference/agent/delete-website-knowledge"},{"title":"Delete file knowledge","openapi":"DELETE /v2/api/numbers/{number}/agent/knowledge/files/{id}","href":"/en/v2/api-reference/agent/delete-file-knowledge"},{"title":"List calendars","openapi":"GET /v2/api/calendars","href":"/en/v2/api-reference/agent/list-calendars"},{"title":"Get a calendar","openapi":"GET /v2/api/calendars/{id}","href":"/en/v2/api-reference/agent/get-calendar"},{"title":"List voices","openapi":"GET /v2/api/voices","href":"/en/v2/api-reference/agent/list-voices"}]},{"group":"Tags","pages":[{"title":"Overview","href":"/en/v2/api-reference/tags/overview"},{"title":"List tags","openapi":"GET /v2/api/tags","href":"/en/v2/api-reference/tags/list-tags"},{"title":"Create tag","openapi":"POST /v2/api/tags","href":"/en/v2/api-reference/tags/create-tag"},{"title":"Delete tag","openapi":"DELETE /v2/api/tags/{id}","href":"/en/v2/api-reference/tags/delete-tag"},{"title":"Add tags","openapi":"POST /v2/api/conversations/items/{id}/tags","href":"/en/v2/api-reference/tags/add-tags"},{"title":"Remove tag","openapi":"DELETE /v2/api/conversations/items/{id}/tags/{tag}","href":"/en/v2/api-reference/tags/remove-tag"}]},{"group":"Summary Templates","pages":[{"title":"Overview","href":"/en/v2/api-reference/summary-templates/overview"},{"title":"List summary templates","openapi":"GET /v2/api/summary_templates","href":"/en/v2/api-reference/summary-templates/list-summary-templates"},{"title":"Get summary template","openapi":"GET /v2/api/summary_templates/{id}","href":"/en/v2/api-reference/summary-templates/get-summary-template"},{"title":"Create summary template","openapi":"POST /v2/api/summary_templates","href":"/en/v2/api-reference/summary-templates/create-summary-template"},{"title":"Update summary template","openapi":"PUT /v2/api/summary_templates/{id}","href":"/en/v2/api-reference/summary-templates/update-summary-template"},{"title":"Delete summary template","openapi":"DELETE /v2/api/summary_templates/{id}","href":"/en/v2/api-reference/summary-templates/delete-summary-template"},{"title":"Set a number's default template","openapi":"PUT /v2/api/numbers/{number}/default_summary_template","href":"/en/v2/api-reference/summary-templates/set-number-default-summary-template"}]},{"group":"Users","pages":[{"title":"Overview","href":"/en/v2/api-reference/users/overview"},{"title":"Me","openapi":"GET /v2/api/me","href":"/en/v2/api-reference/users/me"},{"title":"List users","openapi":"GET /v2/api/users","href":"/en/v2/api-reference/users/list-users"},{"title":"Get user","openapi":"GET /v2/api/users/{id}","href":"/en/v2/api-reference/users/get-user"}]},{"group":"SMS","pages":[{"title":"Overview","href":"/en/v2/api-reference/sms/overview"},{"title":"Send SMS","openapi":"POST /v1/api/sms","href":"/en/v2/api-reference/sms/send-sms"},{"title":"Send SMS (France)","openapi":"POST /v1/api/sms#france","href":"/en/v2/api-reference/sms/send-sms-france"}]},{"group":"Fax","pages":[{"title":"Overview","description":"Send a PDF as a fax from your Allo line, and read sent and received faxes","href":"/en/v2/api-reference/fax/overview"},{"title":"Send fax","openapi":"POST /v2/api/faxes","href":"/en/v2/api-reference/fax/send-fax"}]},{"group":"Analytics","pages":[{"title":"Overview","description":"Pre-computed call metrics and team performance analytics","href":"/en/v2/api-reference/analytics/overview"},{"title":"Team metrics","openapi":"POST /v2/api/analytics/overview","href":"/en/v2/api-reference/analytics/team-summary"},{"title":"Outbound metrics","openapi":"POST /v2/api/analytics/outbound","href":"/en/v2/api-reference/analytics/outbound"}]},{"group":"Power Dialer","pages":[{"title":"Overview","href":"/en/v2/api-reference/dialing-queues/overview"},{"title":"List current queue numbers","openapi":"GET /v2/api/dialing-queues/current","href":"/en/v2/api-reference/dialing-queues/get-current"},{"title":"Upsert current queue","openapi":"PATCH /v2/api/dialing-queues/current","href":"/en/v2/api-reference/dialing-queues/update-current"},{"title":"Append numbers","openapi":"POST /v2/api/dialing-queues/current/numbers","href":"/en/v2/api-reference/dialing-queues/append-numbers"},{"title":"Clear queue numbers","openapi":"DELETE /v2/api/dialing-queues/current/numbers","href":"/en/v2/api-reference/dialing-queues/clear-numbers"},{"title":"Reset current queue","openapi":"POST /v2/api/dialing-queues/current","href":"/en/v2/api-reference/dialing-queues/reset-current"},{"title":"Reassign queue","openapi":"PATCH /v2/api/dialing-queues/{queue_id}/assignee","href":"/en/v2/api-reference/dialing-queues/assign-queue"}]},{"group":"Partner","pages":[{"title":"Overview","href":"/en/v2/api-reference/partner/overview"},{"title":"Get account price","openapi":"GET /v2/api/partner/accounts/price","href":"/en/v2/api-reference/partner/get-price"},{"title":"Create account","openapi":"POST /v2/api/partner/accounts","href":"/en/v2/api-reference/partner/create-account"},{"title":"Get account","openapi":"GET /v2/api/partner/accounts/{id}","href":"/en/v2/api-reference/partner/get-account"},{"title":"Deactivate account","openapi":"DELETE /v2/api/partner/accounts/{id}","href":"/en/v2/api-reference/partner/delete-account"},{"title":"Get number price","openapi":"GET /v2/api/partner/accounts/{id}/numbers/price","href":"/en/v2/api-reference/partner/get-number-price"},{"title":"Add number","openapi":"POST /v2/api/partner/accounts/{id}/numbers","href":"/en/v2/api-reference/partner/add-number"},{"title":"Add member","openapi":"POST /v2/api/partner/accounts/{id}/members","href":"/en/v2/api-reference/partner/add-member"},{"title":"List members","openapi":"GET /v2/api/partner/accounts/{id}/members","href":"/en/v2/api-reference/partner/list-members"},{"title":"Get prepaid credit","openapi":"GET /v2/api/partner/credit","href":"/en/v2/api-reference/partner/get-credit"},{"title":"Get eSIM offer","openapi":"GET /v2/api/partner/accounts/{account_id}/esims/offer","href":"/en/v2/api-reference/partner/get-esim-offer"},{"title":"Order eSIM","openapi":"POST /v2/api/partner/accounts/{account_id}/esims","href":"/en/v2/api-reference/partner/order-esim"},{"title":"Get eSIM","openapi":"GET /v2/api/partner/esims/{id}","href":"/en/v2/api-reference/partner/get-esim"},{"title":"Get eSIM activation code","openapi":"GET /v2/api/partner/esims/{id}/activation_code","href":"/en/v2/api-reference/partner/get-esim-activation-code"}]}]}]},{"language":"fr","navbar":{"links":[{"href":"/fr/support/contact","label":"Contacter le support"},{"href":"https://withallo.com/changelog","label":"Changelog"},{"href":"https://withallo.com/download","label":"Download"}],"primary":{"type":"button","label":"Get Started","href":"https://start.withallo.com"}},"pages":[{"title":"fr","href":"/fr/v2/api-reference/fax/send-fax"}]}]},"basePath":"","title":"Send fax - Allo — Help Center","buildId":"dpl_41S5Z2jG9QnfDRwN1KZrLdBwj7DM","deploymentId":"dpl_41S5Z2jG9QnfDRwN1KZrLdBwj7DM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DDP9JXtj.js","utils-8yQyvEtx.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CBCFR8Sn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-rQaXkUHa.js","snippetPresets-J5KpBTgV.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BVxVH4Cj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BxdQ2vIi.js","shallow-BjV2tFiD.js","getApiPlaygroundDisplay-C_55tL4O.js","CodeSnippet-C0JpiCOC.js","CodeSnippets-w9Ps7djG.js","Page-DTNSD-0M.js","getPastedJson-BDfB-H8d.js","icon-g-kUkkO9.js","MethodPill-v4l6fq0h.js","DuplicateIcon-CvLo-CfU.js","createIcon-165clrrV.js","DynamicMarkdown-D3RQ-fEj.js","SectionHeading-vvo-3yLf.js","axios-vUo_bRtp.js","Markdown-CMT1uFWQ.js","clsx-C8f2yC9R.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CI2D8R2Y.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-k78Wrw_e.js"]}