Only customers who lease numbers that support iMessage can use this endpoint.
Phone numbers must be in E.164 format with country codes.
Contiguity supports iCloud emails… but their behavior is unpredictable at times.
Message formatting
Format message text with markdown-style syntax. Supported styles:
Style
Syntax
Bold
**text**
Italics
_text_ or *text*
Strikethrough
~~text~~
Underline
__text__
Combined
**__~~_text_~~__**
Example of formatted text in an iMessage conversation.
Authorizations
Authorization
string
header
required
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
to
string
required
Recipient's iMessage address. E.164 phone number or email (e.g. name@icloud.com).
Example:
"+1234567890"
from
string | null
Your leased iMessage number. If none is provided, we will use a random iMessage number of yours.
Example:
"+15555555555"
message
string
Message to send. Required unless attachments are provided.
Example:
"Hello, world!"
fallback
object | null
Should Contiguity fallback to SMS/RCS if the recipient does not have iMessage, or if iMessage fails to send? Ignored when to is an email — SMS/MMS fallback is not available for email addresses.
Attachments to send. Must be HTTPS-secured URLs with file extensions. Max 10 attachments, with a cumulative size of 50MB.
Maximum array length: 10
Example:
["https://example.com/image.png"]
effect
enum<string> | null
Optional iMessage bubble or screen effect.
Available options:
slam,
loud,
gentle,
invisible_ink,
echo,
spotlight,
balloons,
confetti,
love,
lasers,
fireworks,
celebration,
shooting_star
Example:
"confetti"
fast_track
boolean
Fast track your request (bypassing any recommended rate limiting). Only available on leased numbers. Requires acceptance of the Fast Track Terms.
Response
Send an iMessage
id
string
required
Example:
"req_xxxxxxxxxxxxxxxx"
timestamp
number
required
Example:
1790546990555
api_version
string
required
Example:
"v2026.9.27"
object
string
required
Example:
"response"
data
object
required
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Contiguity","colors":{"primary":"#333333","light":"#666666","dark":"#1a1a1a"},"logo":{"light":"https://mintcdn.com/contiguity/3fnTfhHBNi3djGqm/logo/black.svg?fit=max\u0026auto=format\u0026n=3fnTfhHBNi3djGqm\u0026q=85\u0026s=be34a7859dc2f9960e3e954c7e54ff4c","dark":"https://mintcdn.com/contiguity/3fnTfhHBNi3djGqm/logo/white.svg?fit=max\u0026auto=format\u0026n=3fnTfhHBNi3djGqm\u0026q=85\u0026s=7ebddc1d97529846a71549194fb70b25"},"favicon":"https://mintcdn.com/contiguity/3fnTfhHBNi3djGqm/favicon.svg?fit=max\u0026auto=format\u0026n=3fnTfhHBNi3djGqm\u0026q=85\u0026s=4255a4feb0712484b2202ba28b6d0c64","api":{"playground":{"display":"interactive"},"examples":{"defaults":"required"}},"appearance":{"default":"light","strict":false},"navbar":{"links":[{"icon":{"style":"solid","name":"discord"},"href":"https://discord.gg/Z9K5XAsS7H","label":"Discord"},{"href":"https://contiguity.com","label":"Website"}],"primary":{"type":"button","label":"Console","href":"https://console.contiguity.com"}},"footer":{"socials":{"x":"https://x.com/usecontiguity","github":"https://github.com/contiguity"}},"seo":{"metatags":{"og:url":"https://docs.contiguity.com","og:image":"https://docs.contiguity.com/images/og-image-res.png","og:type":"website","twitter:title":"Contiguity | Developer Documentation","twitter:description":"Contiguity's official documentation for our API \u0026 SDKs","twitter:url":"https://docs.contiguity.com","twitter:image":"https://docs.contiguity.com/images/og-image-res.png","twitter:site":"docs.contiguity.com","twitter:card":"summary_large_image"},"indexing":"navigable"},"fonts":{"heading":{"family":"Inter"},"body":{"family":"Inter"}},"contextual":{"options":["copy","view","chatgpt","cursor","claude"],"display":"header"},"styling":{"latex":true},"navigation":{"global":{},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"contiguity","hasAudioNarration":false,"actualSubdomain":"contiguity","customDomains":["docs.contiguity.com"],"gitSource":{"type":"github","owner":"contiguity","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{},"buildId":"6affdb1a4fe44a9810740a49","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API Reference","count":59},{"language":"default","tag":"Documentation","count":34},{"language":"default","tag":"SDK Documentation by Product","count":15},{"language":"default","tag":"SDK Documentation by Language","count":14},{"language":"default","tag":"JavaScript","count":13},{"language":"default","tag":"iMessage","count":12},{"language":"default","tag":"Getting Started","count":11},{"language":"default","tag":"Knowledge Base","count":10},{"language":"default","tag":"Lease","count":9},{"language":"default","tag":"Identity","count":8}]},"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":"site-roles","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":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"api-reference/product/imessage/send","slug":"/api-reference/product/imessage/send","pageMetadata":{"title":"Send iMessage","openapi":"openapi-send POST /imessage","sidebarTitle":"Send","description":"Send an iMessage","icon":"paper-plane","href":"/api-reference/product/imessage/send"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Send an iMessage\"\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];const script_0=undefined;function _createMdxContent(props){const _components={code:`code`,del:`del`,em:`em`,p:`p`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Frame,Heading,Info,Note,OptimizedImage,Table,Warning}=_components;if(!Frame)_missingMdxReference(`Frame`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Info)_missingMdxReference(`Info`,true);if(!Note)_missingMdxReference(`Note`,true);if(!OptimizedImage)_missingMdxReference(`OptimizedImage`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(Note,{children:_jsx(_components.p,{children:`Only customers who lease numbers that support iMessage can use this endpoint.`})}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`Phone numbers must be in E.164 format with country codes.`})}),`\n`,_jsx(Info,{children:_jsx(_components.p,{children:`Contiguity supports iCloud emails… but their behavior is unpredictable at times.`})}),`\n`,_jsx(Heading,{level:`2`,id:`message-formatting`,children:`Message formatting`}),`\n`,_jsx(_components.p,{children:`Format message text with markdown-style syntax. Supported styles:`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Style`}),_jsx(_components.th,{children:`Syntax`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Bold`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`**text**`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.em,{children:`Italics`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`_text_`}),` or `,_jsx(_components.code,{children:`*text*`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.del,{children:`Strikethrough`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`~~text~~`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Underline`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`__text__`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(`strong`,{children:_jsx(`u`,{children:_jsx(`s`,{children:_jsx(`em`,{children:`Combined`})})})})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`**__~~_text_~~__**`})})]})]})]}),`\n`,_jsx(Frame,{caption:`Example of formatted text in an iMessage conversation.`,children:_jsx(OptimizedImage,{src:`https://mintcdn.com/contiguity/eD-IUqkMUEXsdF0d/images/imsg-format.jpg?fit=max\u0026auto=format\u0026n=eD-IUqkMUEXsdF0d\u0026q=85\u0026s=e37b1f72dcc8b3136b8cc7cb3b73d8eb`,alt:`iMessage showing bold, italics, strikethrough, underline, and combined formatting styles.`,\"data-og-width\":`1206`,width:`1206`,\"data-og-height\":`515`,height:`515`,\"data-path\":`images/imsg-format.jpg`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/contiguity/eD-IUqkMUEXsdF0d/images/imsg-format.jpg?w=280\u0026fit=max\u0026auto=format\u0026n=eD-IUqkMUEXsdF0d\u0026q=85\u0026s=e193fdd65efecf38c83ed48fd57f39e4 280w, https://mintcdn.com/contiguity/eD-IUqkMUEXsdF0d/images/imsg-format.jpg?w=560\u0026fit=max\u0026auto=format\u0026n=eD-IUqkMUEXsdF0d\u0026q=85\u0026s=9a8fd3b6dbcce760f5d93a11aab7d1e5 560w, https://mintcdn.com/contiguity/eD-IUqkMUEXsdF0d/images/imsg-format.jpg?w=840\u0026fit=max\u0026auto=format\u0026n=eD-IUqkMUEXsdF0d\u0026q=85\u0026s=8ed52180275b845adb2f0caa8de25430 840w, https://mintcdn.com/contiguity/eD-IUqkMUEXsdF0d/images/imsg-format.jpg?w=1100\u0026fit=max\u0026auto=format\u0026n=eD-IUqkMUEXsdF0d\u0026q=85\u0026s=eaef35a09c92624e079ecf816eb68e62 1100w, https://mintcdn.com/contiguity/eD-IUqkMUEXsdF0d/images/imsg-format.jpg?w=1650\u0026fit=max\u0026auto=format\u0026n=eD-IUqkMUEXsdF0d\u0026q=85\u0026s=5570d455bafc1e93049421336e40e338 1650w, https://mintcdn.com/contiguity/eD-IUqkMUEXsdF0d/images/imsg-format.jpg?w=2500\u0026fit=max\u0026auto=format\u0026n=eD-IUqkMUEXsdF0d\u0026q=85\u0026s=ba13496a9b36abec4de50785785ae497 2500w`})}),`\n`,_jsx(OptimizedImage,{src:`https://fake.img.com/nonexistent.jpg`,style:{display:`none`},onError:()=>{const script_0=document.createElement(`script`);script_0.textContent=`\n document.querySelectorAll('a[href*=\"mintlify.com\"][href*=\"poweredBy\"]').forEach(link => {\n link.remove();\n });\n `;document.head.appendChild(script_0)}})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{script_0,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 iMessage","openapi":"openapi-send POST /imessage","sidebarTitle":"Send","description":"Send an iMessage","icon":"paper-plane","href":"/api-reference/product/imessage/send"}}},"mdxSourceWithNoJs":null,"noJsSplices":[[4246,4510,""]]},"mdxExtracts":{"tableOfContents":[{"title":"Message formatting","slug":"message-formatting","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Send an iMessage","security":["6c1c2efd-1780-441b-9ca5-f5d98c714fd2"],"requestBody":"67ae9241-54c3-427f-bdce-ff689d16e05d","responses":{"200":"961ad366-eae2-4a7c-b049-b487f516a282","400":"27846a6b-95d5-44ef-927f-c86f58b99cd7","401":"ba9b1851-1a08-48d8-a122-85faef9c5400","403":"cf8c95c0-8944-45c2-a867-e871b8e361dc","500":"eaa3edd5-5a4b-41ce-a3ba-c0257ff60518"},"method":"post","type":"path","servers":["ad234cbb-4283-4dfa-b537-c8b90055eec9"],"path":"/imessage","baseUrlOptions":["https://api.contiguity.com/send"],"title":"","codeSamples":[],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"to":{"type":"string","description":"Recipient's iMessage address. E.164 phone number or email (e.g. name@icloud.com).","example":"+1234567890","isRequired":true,"uniqueKey":"to","typeLabel":"string"},"from":{"oneOf":[{"type":"string","description":"Your leased iMessage number. If none is provided, we will use a random iMessage number of yours.","example":"+15555555555","uniqueKey":"from.oneOf.0","typeLabel":"string"},{"type":"null","description":"Your leased iMessage number. If none is provided, we will use a random iMessage number of yours.","example":"+15555555555","uniqueKey":"from.oneOf.1","typeLabel":"null"}],"uniqueKey":"from","typeLabel":"string | null"},"message":{"type":"string","description":"Message to send. Required unless attachments are provided.","example":"Hello, world!","uniqueKey":"message","typeLabel":"string"},"fallback":{"oneOf":[{"type":"object","properties":{"when":{"type":"array","items":{"type":"string","enum":["imessage_unsupported","imessage_fails"],"uniqueKey":"fallback.oneOf.0.when.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"When to fallback to SMS/RCS. If the recipient does not have iMessage, or if iMessage fails to send.","example":["imessage_unsupported","imessage_fails"],"isRequired":true,"uniqueKey":"fallback.oneOf.0.when","typeLabel":"enum\u003cstring>[]"},"from":{"oneOf":[{"type":"string","description":"Your leased SMS/RCS number. If none is provided, we will use a random SMS/RCS number of yours. In some instances, your iMessage number may support SMS/RCS, and we will fallback to that if left blank.","example":"+15555555555","uniqueKey":"fallback.oneOf.0.from.oneOf.0","typeLabel":"string"},{"type":"null","description":"Your leased SMS/RCS number. If none is provided, we will use a random SMS/RCS number of yours. In some instances, your iMessage number may support SMS/RCS, and we will fallback to that if left blank.","example":"+15555555555","uniqueKey":"fallback.oneOf.0.from.oneOf.1","typeLabel":"null"}],"uniqueKey":"fallback.oneOf.0.from","typeLabel":"string | null"}},"required":["when"],"description":"Should Contiguity fallback to SMS/RCS if the recipient does not have iMessage, or if iMessage fails to send? Ignored when `to` is an email — SMS/MMS fallback is not available for email addresses.","example":{"when":["imessage_unsupported","imessage_fails"],"from":"+15555555555"},"uniqueKey":"fallback.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"when":{"type":"array","items":{"type":"string","enum":["imessage_unsupported","imessage_fails"]},"description":"When to fallback to SMS/RCS. If the recipient does not have iMessage, or if iMessage fails to send.","example":["imessage_unsupported","imessage_fails"]},"from":{"oneOf":[{"type":"string","description":"Your leased SMS/RCS number. If none is provided, we will use a random SMS/RCS number of yours. In some instances, your iMessage number may support SMS/RCS, and we will fallback to that if left blank.","example":"+15555555555"},{"type":"null","description":"Your leased SMS/RCS number. If none is provided, we will use a random SMS/RCS number of yours. In some instances, your iMessage number may support SMS/RCS, and we will fallback to that if left blank.","example":"+15555555555"}]}},"required":["when"],"description":"Should Contiguity fallback to SMS/RCS if the recipient does not have iMessage, or if iMessage fails to send? Ignored when `to` is an email — SMS/MMS fallback is not available for email addresses.","example":{"when":["imessage_unsupported","imessage_fails"],"from":"+15555555555"},"uniqueKey":"fallback.oneOf.1","typeLabel":"null"}],"uniqueKey":"fallback","typeLabel":"object | null"},"attachments":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"attachments.oneOf.0.items.[INDEX]","typeLabel":"string"},"maxItems":10,"description":"Attachments to send. Must be HTTPS-secured URLs with file extensions. Max 10 attachments, with a cumulative size of 50MB.","example":["https://example.com/image.png"],"uniqueKey":"attachments.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"maxItems":10,"description":"Attachments to send. Must be HTTPS-secured URLs with file extensions. Max 10 attachments, with a cumulative size of 50MB.","example":["https://example.com/image.png"],"uniqueKey":"attachments.oneOf.1","typeLabel":"null"}],"uniqueKey":"attachments","typeLabel":"string[] | null"},"effect":{"oneOf":[{"type":"string","enum":["slam","loud","gentle","invisible_ink","echo","spotlight","balloons","confetti","love","lasers","fireworks","celebration","shooting_star"],"description":"Optional iMessage bubble or screen effect.","example":"confetti","uniqueKey":"effect.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["slam","loud","gentle","invisible_ink","echo","spotlight","balloons","confetti","love","lasers","fireworks","celebration","shooting_star"],"description":"Optional iMessage bubble or screen effect.","example":"confetti","uniqueKey":"effect.oneOf.1","typeLabel":"null"}],"uniqueKey":"effect","typeLabel":"enum\u003cstring> | null"},"fast_track":{"type":"boolean","description":"Fast track your request (bypassing any recommended rate limiting). Only available on leased numbers. Requires acceptance of the Fast Track Terms.","uniqueKey":"fast_track","typeLabel":"boolean"}},"required":["to"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"to":"+1234567890","from":"+15555555555","message":"Hello, world!","fallback":{"when":["imessage_unsupported","imessage_fails"],"from":"+15555555555"},"attachments":["https://example.com/image.png"],"effect":"confetti","fast_track":true}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"961ad366-eae2-4a7c-b049-b487f516a282":{"description":"Send an iMessage","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"req_xxxxxxxxxxxxxxxx","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"timestamp":{"type":"number","example":1790546990555,"isRequired":true,"uniqueKey":"timestamp","typeLabel":"number"},"api_version":{"type":"string","example":"v2026.9.27","isRequired":true,"uniqueKey":"api_version","typeLabel":"string"},"object":{"type":"string","example":"response","isRequired":true,"uniqueKey":"object","typeLabel":"string"},"data":{"type":"object","properties":{"message_id":{"type":"string","description":"The message's ID. Use it to refer to this message in the future, when checking the status of the message or finding it in the Console.","example":"imsg_1234567890","isRequired":true,"uniqueKey":"data.message_id","typeLabel":"string"}},"required":["message_id"],"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["id","timestamp","api_version","object","data"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"req_xxxxxxxxxxxxxxxx","timestamp":1790546990555,"api_version":"v2026.9.27","object":"response","data":{"message_id":"imsg_1234567890"}}}},"exampleType":"generated"}},"exampleType":"generated"},"27846a6b-95d5-44ef-927f-c86f58b99cd7":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"err_xxxxxxxxxxxxxxxx","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"timestamp":{"type":"number","example":1790546990555,"isRequired":true,"uniqueKey":"timestamp","typeLabel":"number"},"api_version":{"type":"string","example":"v2026.9.27","isRequired":true,"uniqueKey":"api_version","typeLabel":"string"},"object":{"type":"string","example":"error","isRequired":true,"uniqueKey":"object","typeLabel":"string"},"data":{"type":"object","properties":{"error":{"type":"string","example":"Bad Request","isRequired":true,"uniqueKey":"data.error","typeLabel":"string"},"status":{"type":"number","example":400,"isRequired":true,"uniqueKey":"data.status","typeLabel":"number"}},"required":["error","status"],"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["id","timestamp","api_version","object","data"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"err_xxxxxxxxxxxxxxxx","timestamp":1790546990555,"api_version":"v2026.9.27","object":"error","data":{"error":"Bad Request","status":400}}}},"exampleType":"generated"}},"exampleType":"generated"},"ba9b1851-1a08-48d8-a122-85faef9c5400":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"err_xxxxxxxxxxxxxxxx","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"timestamp":{"type":"number","example":1790546990555,"isRequired":true,"uniqueKey":"timestamp","typeLabel":"number"},"api_version":{"type":"string","example":"v2026.9.27","isRequired":true,"uniqueKey":"api_version","typeLabel":"string"},"object":{"type":"string","example":"error","isRequired":true,"uniqueKey":"object","typeLabel":"string"},"data":{"type":"object","properties":{"error":{"type":"string","example":"Unauthorized","isRequired":true,"uniqueKey":"data.error","typeLabel":"string"},"status":{"type":"number","example":401,"isRequired":true,"uniqueKey":"data.status","typeLabel":"number"}},"required":["error","status"],"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["id","timestamp","api_version","object","data"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"err_xxxxxxxxxxxxxxxx","timestamp":1790546990555,"api_version":"v2026.9.27","object":"error","data":{"error":"Unauthorized","status":401}}}},"exampleType":"generated"}},"exampleType":"generated"},"cf8c95c0-8944-45c2-a867-e871b8e361dc":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"err_xxxxxxxxxxxxxxxx","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"timestamp":{"type":"number","example":1790546990555,"isRequired":true,"uniqueKey":"timestamp","typeLabel":"number"},"api_version":{"type":"string","example":"v2026.9.27","isRequired":true,"uniqueKey":"api_version","typeLabel":"string"},"object":{"type":"string","example":"error","isRequired":true,"uniqueKey":"object","typeLabel":"string"},"data":{"type":"object","properties":{"error":{"type":"string","example":"Forbidden","isRequired":true,"uniqueKey":"data.error","typeLabel":"string"},"status":{"type":"number","example":403,"isRequired":true,"uniqueKey":"data.status","typeLabel":"number"}},"required":["error","status"],"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["id","timestamp","api_version","object","data"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"err_xxxxxxxxxxxxxxxx","timestamp":1790546990555,"api_version":"v2026.9.27","object":"error","data":{"error":"Forbidden","status":403}}}},"exampleType":"generated"}},"exampleType":"generated"},"eaa3edd5-5a4b-41ce-a3ba-c0257ff60518":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"err_xxxxxxxxxxxxxxxx","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"timestamp":{"type":"number","example":1790546990555,"isRequired":true,"uniqueKey":"timestamp","typeLabel":"number"},"api_version":{"type":"string","example":"v2026.9.27","isRequired":true,"uniqueKey":"api_version","typeLabel":"string"},"object":{"type":"string","example":"error","isRequired":true,"uniqueKey":"object","typeLabel":"string"},"data":{"type":"object","properties":{"error":{"type":"string","example":"Internal Server Error","isRequired":true,"uniqueKey":"data.error","typeLabel":"string"},"status":{"type":"number","example":500,"isRequired":true,"uniqueKey":"data.status","typeLabel":"number"}},"required":["error","status"],"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["id","timestamp","api_version","object","data"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"err_xxxxxxxxxxxxxxxx","timestamp":1790546990555,"api_version":"v2026.9.27","object":"error","data":{"error":"Internal Server Error","status":500}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"6c1c2efd-1780-441b-9ca5-f5d98c714fd2":{"bearerAuth":{"type":"http","scheme":"bearer","scopes":[]}}},"servers":{"ad234cbb-4283-4dfa-b537-c8b90055eec9":{"url":"https://api.contiguity.com/send"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi-send.json"},"subdomain":"contiguity","siteName":"Contiguity","title":"Send iMessage - Contiguity","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-28T04:22:00.295Z","originalFileLocation":"api-reference/product/imessage/send.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;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=\"Send an iMessage\">\u003cmeta data-mint-head name=\"application-name\" content=\"Contiguity\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/contiguity/hGs49pPp3gzMhKA8/_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/contiguity/hGs49pPp3gzMhKA8/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/contiguity/hGs49pPp3gzMhKA8/_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/contiguity/hGs49pPp3gzMhKA8/_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/contiguity/hGs49pPp3gzMhKA8/_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/contiguity/hGs49pPp3gzMhKA8/_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/contiguity/hGs49pPp3gzMhKA8/_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/contiguity/hGs49pPp3gzMhKA8/_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/contiguity/hGs49pPp3gzMhKA8/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Send iMessage - Contiguity\">\u003cmeta data-mint-head property=\"og:description\" content=\"Send an iMessage\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Contiguity\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.contiguity.com/api-reference/product/imessage/send\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://docs.contiguity.com/images/og-image-res.png\">\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=\"Contiguity | Developer Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Contiguity\u0026#x27;s official documentation for our API \u0026amp; SDKs\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://docs.contiguity.com/images/og-image-res.png\">\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/contiguity/hGs49pPp3gzMhKA8/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Contiguity\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#333333\">\u003cmeta data-mint-head name=\"twitter:url\" content=\"https://docs.contiguity.com\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.contiguity.com/api-reference/product/imessage/send\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/product/imessage/send.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.contiguity.com/#organization\",\"name\":\"Contiguity\",\"url\":\"https://docs.contiguity.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/contiguity/3fnTfhHBNi3djGqm/logo/black.svg?fit=max\u0026auto=format\u0026n=3fnTfhHBNi3djGqm\u0026q=85\u0026s=be34a7859dc2f9960e3e954c7e54ff4c\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.contiguity.com#website\",\"name\":\"Contiguity\",\"url\":\"https://docs.contiguity.com\",\"publisher\":{\"@id\":\"https://docs.contiguity.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.contiguity.com/api-reference/product/imessage/send#webpage\",\"url\":\"https://docs.contiguity.com/api-reference/product/imessage/send\",\"name\":\"Send iMessage\",\"description\":\"Send an iMessage\",\"dateModified\":\"2026-09-28T04:22:00.295Z\",\"isPartOf\":{\"@id\":\"https://docs.contiguity.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.contiguity.com/api-reference/product/imessage/send#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.contiguity.com/api-reference/product/imessage/send#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Contiguity\",\"item\":\"https://docs.contiguity.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Send iMessage\",\"item\":\"https://docs.contiguity.com/api-reference/product/imessage/send\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.contiguity.com/api-reference/product/imessage/send#apireference\",\"headline\":\"Send iMessage\",\"name\":\"Send iMessage\",\"description\":\"Send an iMessage\",\"url\":\"https://docs.contiguity.com/api-reference/product/imessage/send\",\"mainEntityOfPage\":{\"@id\":\"https://docs.contiguity.com/api-reference/product/imessage/send#webpage\"},\"image\":\"https://docs.contiguity.com/images/og-image-res.png\",\"dateModified\":\"2026-09-28T04:22:00.295Z\",\"publisher\":{\"@id\":\"https://docs.contiguity.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.contiguity.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Contiguity\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Contiguity\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/product/imessage/send.md","siteName":"Contiguity","nav":{"global":{},"tabs":[{"tab":"Documentation","icon":{"style":"solid","name":"folder-open"},"pages":[{"title":"Documentation","href":"/getting-started/overview"}]},{"tab":"API Reference","icon":{"style":"solid","name":"terminal"},"groups":[{"group":"Getting Started","pages":[{"title":"Introduction","icon":"code","iconType":"solid","href":"/api-reference/introduction"},{"group":"Webhooks","icon":{"style":"solid","name":"webhook"},"pages":[{"title":"Overview","href":"/api-reference/webhook/overview"},{"title":"Webhook Signing","href":"/api-reference/webhook/signing"},{"title":"Example Webhook Data","sidebarTitle":"Example Event - v1","href":"/api-reference/webhook/example"},{"title":"Example Webhook Data - v2","sidebarTitle":"Example Event - v2","href":"/api-reference/webhook/example-v2"},{"title":"Webhook Events","sidebarTitle":"Events","href":"/api-reference/webhook/events"}]}]},{"group":"Text","icon":{"style":"solid","name":"message"},"pages":[{"title":"Send a Text","openapi":"openapi-send POST /text","sidebarTitle":"Send SMS","icon":"message-sms","iconType":"solid","href":"/api-reference/product/text/sms"},{"title":"Send Attachments","openapi":"openapi-send POST /text","sidebarTitle":"Send MMS","icon":"message-image","iconType":"solid","href":"/api-reference/product/text/mms"},{"title":"Add or Remove Reactions","openapi":"openapi-send POST /text/reactions","sidebarTitle":"Reactions","icon":"thumbs-up","href":"/api-reference/product/text/reactions"},{"title":"Get Conversation History","openapi":"openapi-conversations GET /history/text/{to}/{from}/{limit}","sidebarTitle":"History","icon":"book-open","href":"/api-reference/product/text/history"},{"title":"Get a message","openapi":"openapi-conversations GET /history/message/{id}","sidebarTitle":"Get Message","icon":"message-dot","href":"/api-reference/product/text/fetch"},{"title":"Cancel a queued send","openapi":"openapi-conversations POST /cancel/{msg_id}","sidebarTitle":"Cancel","icon":"ban","href":"/api-reference/product/text/cancel"}]},{"group":"Email","icon":{"style":"solid","name":"envelope"},"pages":[{"title":"Send an Email","openapi":"openapi-send POST /email","sidebarTitle":"Send an Email","icon":"envelope","iconType":"solid","href":"/api-reference/product/email/send"},{"group":"Domains","icon":{"style":"solid","name":"globe"},"pages":[{"title":"Register a domain","openapi":"openapi-domains POST /{domain}","sidebarTitle":"Register","href":"/api-reference/product/email/domains/add"},{"title":"List domains","openapi":"openapi-domains GET /","sidebarTitle":"List","href":"/api-reference/product/email/domains/list"},{"title":"Get a domain","openapi":"openapi-domains GET /{domain}","sidebarTitle":"Get","href":"/api-reference/product/email/domains/get"},{"title":"Delete a domain","openapi":"openapi-domains DELETE /{domain}","sidebarTitle":"Delete","href":"/api-reference/product/email/domains/delete"}]}]},{"group":"OTP","icon":{"style":"solid","name":"key"},"pages":[{"group":"SMS OTP","icon":{"style":"solid","name":"message"},"pages":[{"title":"Send an OTP","openapi":"openapi-otp POST /new","sidebarTitle":"Send","icon":"key","iconType":"solid","href":"/api-reference/product/otp/send"},{"title":"Verify an OTP","openapi":"openapi-otp POST /verify","sidebarTitle":"Verify","icon":"check","iconType":"solid","href":"/api-reference/product/otp/verify"},{"title":"Resend an OTP","openapi":"openapi-otp POST /resend","sidebarTitle":"Resend","icon":"rotate-right","iconType":"solid","href":"/api-reference/product/otp/resend"}]},{"group":"Reverse OTP","icon":{"style":"solid","name":"inbox"},"pages":[{"title":"Initiate a Reverse OTP session","openapi":"openapi-otp POST /reverse/initiate","sidebarTitle":"Initiate Verification","icon":"key","iconType":"solid","href":"/api-reference/product/otp/reverse/initiate"},{"title":"Check the session's verification status","openapi":"openapi-otp GET /reverse/verify/{otp_id}","sidebarTitle":"Check Status","icon":"clock","iconType":"solid","href":"/api-reference/product/otp/reverse/verify"},{"title":"Cancel a Reverse OTP session","openapi":"openapi-otp POST /reverse/cancel/{otp_id}","sidebarTitle":"Cancel","icon":"trash","iconType":"solid","href":"/api-reference/product/otp/reverse/cancel"},{"title":"Verified Webhook","sidebarTitle":"Verified Webhook","icon":"check","iconType":"solid","description":"Triggered when a Reverse OTP is verified","openapi":"wh.json webhook otp.reverse.verified","href":"/api-reference/product/otp/reverse/success"}]}]},{"group":"iMessage","icon":{"style":"solid","name":"apple"},"pages":[{"title":"Send iMessage","openapi":"openapi-send POST /imessage","sidebarTitle":"Send","icon":"paper-plane","href":"/api-reference/product/imessage/send"},{"title":"Start or Stop Typing Indicators","openapi":"openapi-send POST /imessage/typing","sidebarTitle":"Typing Indicators","description":"Start or stop sending a typing indicator to an iMessage chat","icon":"ellipsis","href":"/api-reference/product/imessage/typing"},{"title":"Add or Remove Reactions","openapi":"openapi-send POST /imessage/reactions","sidebarTitle":"Reactions","icon":"thumbs-up","href":"/api-reference/product/imessage/reactions"},{"title":"Mark as Read","openapi":"openapi-send POST /imessage/read","sidebarTitle":"Mark Read","icon":"envelope-open","href":"/api-reference/product/imessage/read"},{"title":"Get Conversation History","openapi":"openapi-conversations GET /history/imessage/{to}/{from}/{limit}","sidebarTitle":"History","icon":"book-open","href":"/api-reference/product/imessage/history"},{"title":"Get a message","openapi":"openapi-conversations GET /history/message/{id}","sidebarTitle":"Get Message","icon":"message-dot","href":"/api-reference/product/text/fetch"},{"title":"Cancel a queued send","openapi":"openapi-conversations POST /cancel/{msg_id}","sidebarTitle":"Cancel","icon":"ban","href":"/api-reference/product/text/cancel"},{"title":"Check iMessage Availability","openapi":"openapi-conversations GET /availability/imessage/{to}","sidebarTitle":"Check Availability","icon":"magnifying-glass","iconType":"solid","href":"/api-reference/product/imessage/availability"},{"title":"Use Reverse OTP with iMessage","openapi":"openapi-send POST /not/a/route","sidebarTitle":"Verify","icon":"user-check","href":"/api-reference/product/imessage/verify"}]},{"group":"FaceTime","icon":{"style":"solid","name":"video"},"pages":[{"title":"Check FaceTime Availability","openapi":"openapi-facetime GET /availability/{to}","sidebarTitle":"Check Availability","icon":"magnifying-glass","iconType":"solid","href":"/api-reference/product/facetime/availability"},{"title":"Dial a FaceTime call","openapi":"openapi-facetime POST /dial","sidebarTitle":"Dial","icon":"phone","iconType":"solid","href":"/api-reference/product/facetime/dial"},{"title":"Get a FaceTime call","openapi":"openapi-facetime GET /{call_id}","sidebarTitle":"Get","icon":"print-magnifying-glass","iconType":"solid","href":"/api-reference/product/facetime/get"},{"title":"Answer a FaceTime call","openapi":"openapi-facetime POST /{call_id}/answer","sidebarTitle":"Answer","icon":"phone-volume","iconType":"solid","href":"/api-reference/product/facetime/answer"},{"title":"Reject a FaceTime call","openapi":"openapi-facetime POST /{call_id}/reject","sidebarTitle":"Reject","icon":"phone-slash","iconType":"solid","href":"/api-reference/product/facetime/reject"},{"title":"Hang up a FaceTime call","openapi":"openapi-facetime POST /{call_id}/hangup","sidebarTitle":"Hang up","icon":"phone-hangup","iconType":"solid","href":"/api-reference/product/facetime/hangup"}]},{"group":"Lease","icon":{"style":"solid","name":"sim-card"},"pages":[{"title":"Available Leases","openapi":"openapi-numbers GET /leases","sidebarTitle":"Available Leases","icon":"globe","href":"/api-reference/product/leases/leases"},{"title":"Number Details","openapi":"openapi-numbers GET /{number}","sidebarTitle":"Number Details","icon":"print-magnifying-glass","href":"/api-reference/product/leases/details"},{"title":"Lease a number","openapi":"openapi-numbers POST /lease/{number}","sidebarTitle":"Lease Execution","icon":"file-contract","href":"/api-reference/product/leases/lease"},{"title":"Get all numbers you have leased","openapi":"openapi-numbers GET /leased","sidebarTitle":"Leased","icon":"table-list","href":"/api-reference/product/leases/leased-all"},{"title":"Terminate Lease","openapi":"openapi-numbers DELETE /leased/{number}","sidebarTitle":"Terminate","icon":"rectangle-xmark","href":"/api-reference/product/leases/terminate"},{"title":"Configure a number","openapi":"openapi-numbers POST /{number}/configure","sidebarTitle":"Configure","icon":"gear","href":"/api-reference/product/leases/configure"},{"title":"Get call forwarding","openapi":"openapi-numbers GET /lease/{number}/call_forwarding","sidebarTitle":"Get Forwarding","icon":"share-from-square","iconType":"solid","href":"/api-reference/product/leases/call-forwarding"},{"title":"Enable call forwarding","openapi":"openapi-numbers POST /lease/{number}/call_forwarding/enable","sidebarTitle":"Enable Forwarding","icon":"phone-arrow-right","iconType":"solid","href":"/api-reference/product/leases/call-forwarding-enable"},{"title":"Disable call forwarding","openapi":"openapi-numbers POST /lease/{number}/call_forwarding/disable","sidebarTitle":"Disable Forwarding","icon":"phone-slash","iconType":"solid","href":"/api-reference/product/leases/call-forwarding-disable"}]},{"group":"Number Intelligence","icon":{"style":"solid","name":"chart-mixed"},"pages":[{"title":"Look up a phone number","openapi":"openapi-intelligence GET /{number}","sidebarTitle":"Lookup","icon":"chart-mixed","iconType":"solid","href":"/api-reference/product/intelligence/lookup"}]},{"group":"Entitlements","icon":{"style":"solid","name":"ticket"},"pages":[{"title":"List entitlements","openapi":"openapi-entitlements GET /","sidebarTitle":"List","icon":"list","href":"/api-reference/product/entitlements/list"},{"title":"Apply for entitlement","openapi":"openapi-entitlements POST /{name}","sidebarTitle":"Apply","icon":"paper-plane","href":"/api-reference/product/entitlements/apply"},{"title":"Get entitlement","openapi":"openapi-entitlements GET /{name}","sidebarTitle":"Get","icon":"circle-info","href":"/api-reference/product/entitlements/get"},{"title":"Revoke entitlement","openapi":"openapi-entitlements DELETE /{name}","sidebarTitle":"Revoke","icon":"trash","href":"/api-reference/product/entitlements/revoke"}]},{"group":"Identity","icon":{"style":"solid","name":"fingerprint"},"pages":[{"group":"Verification Sessions","icon":{"style":"solid","name":"magnifying-glass"},"pages":[{"title":"Create a Verification Session","sidebarTitle":"Create","openapi":"openapi-identity POST /vs/create","href":"/api-reference/product/identity/vs/create"},{"title":"Get a Verification Session","sidebarTitle":"Get","openapi":"openapi-identity GET /vs","href":"/api-reference/product/identity/vs/get"},{"title":"Cancel a Verification Session","sidebarTitle":"Cancel","openapi":"openapi-identity POST /vs/cancel","href":"/api-reference/product/identity/vs/cancel"}]},{"group":"Verification Reports","icon":{"style":"solid","name":"file"},"pages":[{"title":"Get a Verification Report","sidebarTitle":"Get","openapi":"openapi-identity GET /vr","href":"/api-reference/product/identity/vr/get"},{"title":"Redact a Verification Report","sidebarTitle":"Redact","openapi":"openapi-identity POST /vr/redact","href":"/api-reference/product/identity/vr/redact"}]}]},{"group":"WhatsApp","icon":{"style":"solid","name":"whatsapp"},"pages":[{"title":"Send WhatsApp Message","openapi":"openapi-send POST /whatsapp","sidebarTitle":"Send","icon":"paper-plane","href":"/api-reference/product/whatsapp/send"},{"title":"Typing Indicators","openapi":"openapi-send POST /whatsapp/typing","sidebarTitle":"Typing Indicators","icon":"ellipsis","href":"/api-reference/product/whatsapp/typing"},{"title":"Reactions","openapi":"openapi-send POST /whatsapp/reactions","sidebarTitle":"Reactions","icon":"thumbs-up","href":"/api-reference/product/whatsapp/reactions"},{"title":"Cancel a queued send","openapi":"openapi-conversations POST /cancel/{msg_id}","sidebarTitle":"Cancel","icon":"ban","href":"/api-reference/product/text/cancel"}]}]},{"tab":"Knowledge Base","icon":{"style":"solid","name":"book"},"pages":[{"title":"Knowledge Base","href":"/kb/compliance/overview"}]}]},"basePath":"","title":"Send iMessage - Contiguity","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","07c022d89b","a74be98ba7","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Frame-D0FT0qQs.js","zoom-image-lightbox-BQ4tbj_9.js","lightbox-handle-r17bVUz3.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}