iMessage API

Resource-level API reference for iMessage lines, chats, and messages

Attachments resource<p>Pre-upload files; retrieve metadata; delete unused attachments.</p> <h2 id="how-it-works">How it works</h2> <p>Pre-upload files; retrieve metadata; delete unused attachments.→
Available number and phone numbers resources<p>Retrieve an available number; list and update numbers; start and get reputation audits.</p> <h2 id="how-it-works">How it works</h2> <p>Retrieve an available number; list and update numbers; start and get reputation au→
Blocked handles resource<p>Block a handle; list blocked handles; unblock a handle.</p> <h2 id="how-it-works">How it works</h2> <p>Block a handle; list blocked handles; unblock a handle.→
Capability resource<p>Check iMessage capability for a recipient.</p> <h2 id="how-it-works">How it works</h2> <p>Check iMessage capability for a recipient.→
Chat background and location resources<p>Set or remove a background; request, retrieve, and stop location sharing.</p> <h2 id="how-it-works">How it works</h2> <p>Set or remove a background; request, retrieve, and stop location sharing.→
Chat messages and participants resources<p>List and send messages; add or remove participants.</p> <h2 id="how-it-works">How it works</h2> <p>List and send messages; add or remove participants.→
Chats resource<p>Create, list, retrieve, update, leave, mark read, share contact cards, and send voice memos.</p> <h2 id="how-it-works">How it works</h2> <p>Create, list, retrieve, update, leave, mark read, share contact cards, and se→
Contact card and experiences resources<p>Set up, retrieve, and update contact cards; list and retrieve experiences.</p> <h2 id="how-it-works">How it works</h2> <p>Set up, retrieve, and update contact cards; list and retrieve experiences.→
Legacy and compatibility resources<p>Identify deprecated number routes and migrate callers to the current contract.</p> <h2 id="how-it-works">How it works</h2> <p>Identify deprecated number routes and migrate callers to the current contract.→
Messages resource<p>Send, retrieve, list, edit, delete, react, update cards, and move stickers.</p> <h2 id="how-it-works">How it works</h2> <p>Send, retrieve, list, edit, delete, react, update cards, and move stickers.→
Payment resources<p>Manage providers, handles, requests, agent-assisted payments, and credential handoff.</p> <h2 id="how-it-works">How it works</h2> <p>Manage providers, handles, requests, agent-assisted payments, and credential handoff→
Polls and typing resources<p>Create polls; add options; vote; retrieve tallies; start or stop typing.</p> <h2 id="how-it-works">How it works</h2> <p>Create polls; add options; vote; retrieve tallies; start or stop typing.→
Webhook event and subscription resources<p>List event types; create, list, retrieve, update, and delete subscriptions.</p> <h2 id="how-it-works">How it works</h2> <p>List event types; create, list, retrieve, update, and delete subscriptions.→