# Message Blue | Documentation

## Instructions for AI Agents

- For clean Markdown of any page, append `.md` to the page URL
- For section-specific indexes, append `/llms.txt` to any section URL
- For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.messageblue.ai/_mcp/server

## Docs

- [MessageBlue](https://docs.messageblue.ai/welcome.md): Send and receive real iMessages programmatically — and let an AI agent answer them.
- [Core concepts](https://docs.messageblue.ai/concepts.md): The handful of ideas the rest of the documentation assumes you know
- [Support](https://docs.messageblue.ai/support.md): Fix it yourself, or reach the MessageBlue team with the right details
- [Zapier MessageBlue Integration](https://docs.messageblue.ai/zapier-messageblue-integration.md): Connect iMessage to thousands of apps without writing code
- [Set up the Zapier MessageBlue Integration](https://docs.messageblue.ai/zapier-messageblue-integration-setup.md): From credentials to a live Zap, step by step
- [Zapier MessageBlue Integration Troubleshooting](https://docs.messageblue.ai/zapier-messageblue-integration-troubleshooting.md): Every error the connection can return, and the FAQ
- [HubSpot MessageBlue Integration](https://docs.messageblue.ai/hubspot-messageblue-integration.md): Send and receive iMessage from HubSpot Conversations
- [Set up the HubSpot MessageBlue Integration](https://docs.messageblue.ai/hubspot-messageblue-integration-setup.md): Install, connect the portal, and confirm the channel
- [HubSpot MessageBlue Integration Troubleshooting](https://docs.messageblue.ai/hubspot-messageblue-integration-troubleshooting.md): Every status message, what it means, and the FAQ
- [The MessageBlue dashboard](https://docs.messageblue.ai/overview.md): A guided tour of every screen in the web app at app.messageblue.ai
- [Signing in](https://docs.messageblue.ai/sign-in.md): Authentication, sign-up, and what happens when you are not authorised
- [Creating your app](https://docs.messageblue.ai/create-an-app.md): The apps list, app setup, your credentials, and getting a number attached
- [Dashboard](https://docs.messageblue.ai/dashboard.md): Your app at a glance — agent status, phone numbers and billing
- [Messages](https://docs.messageblue.ai/messages.md): The conversation inbox — reading, replying, filtering and managing contacts
- [Group chats](https://docs.messageblue.ai/group-chats.md): Creating and managing multi-participant iMessage threads
- [AI Agent Studio](https://docs.messageblue.ai/ai-agent-studio.md): Model, prompt, knowledge, integrations, testing and activity — everything the agent needs
- [Analytics](https://docs.messageblue.ai/analytics.md): Token spend, contact and sender activity, blocked contacts, and your devices
- [Settings](https://docs.messageblue.ai/settings.md): Team access, webhook delivery, and the credentials that sign your API calls
- [Failed webhooks](https://docs.messageblue.ai/failed-webhooks.md): Inspecting and replaying deliveries that never reached your server
- [Connect your accounts](https://docs.messageblue.ai/customer-connect.md): The link you send to a customer so the agent can act on their behalf
- [Troubleshooting](https://docs.messageblue.ai/troubleshooting.md): Every message the app can show you, and what to do about it
- [MessageBlue Client SDKs](https://docs.messageblue.ai/client-sdks.md): Typed clients generated from the MessageBlue API specification
- [MessageBlue TypeScript SDK](https://docs.messageblue.ai/messageblue-typescript-sdk.md): A typed client for the MessageBlue API, generated from the same spec as these docs
- [API reference](https://docs.messageblue.ai/api-reference.md): The MessageBlue iMessage Gateway REST API

## API Docs

- iMessage Gateway API > Messages [Check whether a phone number supports iMessage](https://docs.messageblue.ai/api-reference/messages/check-i-message.md)
- iMessage Gateway API > Messages [Check whether a participant set would be an iMessage or text group](https://docs.messageblue.ai/api-reference/messages/check-group-i-message.md)
- iMessage Gateway API > Messages [Send a text or attachment to a recipient](https://docs.messageblue.ai/api-reference/messages/send-individual.md)
- iMessage Gateway API > Messages [Send a text or attachment to a group chat](https://docs.messageblue.ai/api-reference/messages/send-group.md)
- iMessage Gateway API > Messages [Send a voice note to an individual recipient](https://docs.messageblue.ai/api-reference/messages/send-voice-note.md)
- iMessage Gateway API > Messages [Send a voice note to a group chat](https://docs.messageblue.ai/api-reference/messages/send-group-voice-note.md)
- iMessage Gateway API > Messages [Create a new group chat and send an intro message](https://docs.messageblue.ai/api-reference/messages/create-group-chat.md)
- iMessage Gateway API > Messages [React to an existing message with emoji or tapback](https://docs.messageblue.ai/api-reference/messages/react.md)
- iMessage Gateway API > Messages [Show typing indicator to a recipient](https://docs.messageblue.ai/api-reference/messages/send-typing-indicator.md)
- iMessage Gateway API > Messages [Stop typing indicator for a recipient](https://docs.messageblue.ai/api-reference/messages/stop-typing-indicator.md)
- iMessage Gateway API > Messages [Mark a conversation as read (send read receipt)](https://docs.messageblue.ai/api-reference/messages/send-read-receipt.md)
- iMessage Gateway API > Agents [List agents scoped to the authenticated account](https://docs.messageblue.ai/api-reference/agents/list-agents.md)
- iMessage Gateway API > Agents [Assign an agent phone number to an account](https://docs.messageblue.ai/api-reference/agents/assign-agent-to-account.md)
- iMessage Gateway API > Agents [Unassign/delete agent ownership from an account](https://docs.messageblue.ai/api-reference/agents/unassign-agent-from-account.md)
- iMessage Gateway API > Agents [Reassign an agent to a different account](https://docs.messageblue.ai/api-reference/agents/reassign-agent-to-account.md)
- iMessage Gateway API > Agents [Unassign/delete agent ownership (POST alias)](https://docs.messageblue.ai/api-reference/agents/unassign-agent-from-account-post.md)
- iMessage Gateway API > Agents [Get a specific agent by phone number](https://docs.messageblue.ai/api-reference/agents/get-agent.md)
- iMessage Gateway API > Agents [Check whether an agent is blocked](https://docs.messageblue.ai/api-reference/agents/get-blocked-status.md)
- iMessage Gateway API > Agents [Block an agent and trigger automatic remapping](https://docs.messageblue.ai/api-reference/agents/block-agent.md)
- iMessage Gateway API > Agents [Unblock a previously blocked agent](https://docs.messageblue.ai/api-reference/agents/unblock-agent.md)
- iMessage Gateway API > Agents [Get all mappings for an agent](https://docs.messageblue.ai/api-reference/agents/get-agent-mappings.md)
- iMessage Gateway API > Agents [Get contacts for an agent](https://docs.messageblue.ai/api-reference/agents/get-agent-contacts.md)
- iMessage Gateway API > Agents [Get mapping history for an agent](https://docs.messageblue.ai/api-reference/agents/get-agent-mappings-mongo.md)
- iMessage Gateway API > Agents [Get the message conversation for a phone number](https://docs.messageblue.ai/api-reference/agents/get-conversation.md)
- iMessage Gateway API > Agents [List recipient phone numbers](https://docs.messageblue.ai/api-reference/agents/list-phone-numbers.md)
- iMessage Gateway API > Agents [Get mappings for multiple agents in one request](https://docs.messageblue.ai/api-reference/agents/bulk-get-agent-mappings.md)
- iMessage Gateway API > Mappings [Get the mapping for a destination number](https://docs.messageblue.ai/api-reference/mappings/get-mapping.md)
- iMessage Gateway API > Mappings [Delete the mapping for a destination number](https://docs.messageblue.ai/api-reference/mappings/delete-mapping.md)
- iMessage Gateway API > Mappings [Assign a specific agent to a user number](https://docs.messageblue.ai/api-reference/mappings/update-mapping.md)
- iMessage Gateway API > Mappings [Delete all mappings for an agent](https://docs.messageblue.ai/api-reference/mappings/delete-agent-mappings.md)
- iMessage Gateway API > Analytics [Get daily send stats for a from-number](https://docs.messageblue.ai/api-reference/analytics/get-stats.md)
- iMessage Gateway API > Webhooks [Set your webhook URLs](https://docs.messageblue.ai/api-reference/webhooks/update-webhooks.md)
- iMessage Gateway API > Webhooks [Inbound message received](https://docs.messageblue.ai/api-reference/webhooks/inbound-message.md)
- iMessage Gateway API > Webhooks [Inbound reaction (tapback) received](https://docs.messageblue.ai/api-reference/webhooks/inbound-reaction.md)
- iMessage Gateway API > Webhooks [Delivery status update](https://docs.messageblue.ai/api-reference/webhooks/message-status.md)
- iMessage Gateway API > Operations [Queue snapshot for all connected agents](https://docs.messageblue.ai/api-reference/operations/queue-status-all.md)
- iMessage Gateway API > Operations [Queue snapshot for a single agent](https://docs.messageblue.ai/api-reference/operations/queue-status-agent.md)
- iMessage Gateway API > System [Health check](https://docs.messageblue.ai/api-reference/system/health-check.md)

## OpenAPI Specification

The raw OpenAPI 3.1 specification for this API is available at:
- [OpenAPI JSON](https://docs.messageblue.ai/openapi.json)
- [OpenAPI YAML](https://docs.messageblue.ai/openapi.yaml)