Using AI coding tools with the Mobile Message API

AI coding assistants are good at writing API integrations, but only when they have the real documentation in front of them. Left to their own knowledge they will guess endpoint names, invent parameters, or borrow conventions from other SMS providers. To make that easy to avoid, the Mobile Message API reference is published in formats built for AI tools, and there is a tested prompt you can paste in before you start.

What's available

ResourceURLUse it for
Full API reference, one text filehttps://mobilemessage.com.au/llms-full.txtPoint any AI tool here. Every endpoint, parameter, response field, webhook payload, error and testing note.
Same docs as Markdownhttps://mobilemessage.com.au/api-documentation.mdCopying into a chat, or saving into your repo as reference material.
Short index (llms.txt)https://mobilemessage.com.au/llms.txtTools that follow the llms.txt convention find the rest from here.
OpenAPI 3.0 spechttps://mobilemessage.com.au/assets/openapi.jsonGenerating typed clients, request validation, Postman or Insomnia imports.

The API page and the API documentation both have a Build with your AI assistant panel with one-click buttons for each of these, including "Open in ChatGPT" and "Open in Claude".

The integration prompt

Paste this as the first message in your AI tool, then describe what you're building. It tells the assistant where the docs are and sets the rules that prevent the mistakes we see most often.

I'm integrating the Mobile Message SMS API (Australia). Before writing any code, read the full API reference at https://mobilemessage.com.au/llms-full.txt. The OpenAPI 3.0 spec is at https://mobilemessage.com.au/assets/openapi.json if you need exact schemas.

Follow these rules:
1. Only use endpoints, parameters and response fields that appear in that documentation. Never invent or guess. If the docs don't cover something, say so and point me to the relevant section or to https://help.mobilemessage.com.au/.
2. Base URL is https://api.mobilemessage.com.au/. Auth is HTTP Basic using an API username and password created in the dashboard (app.mobilemessage.com.au, Settings > API). Use my language's native Basic-auth helper rather than hand-building the header.
3. Send with POST /v1/messages (up to 10,000 messages per request). Always include an Idempotency-Key header (a UUID per batch) so a retry after a timeout can't double-send.
4. The account allows 5 concurrent requests. HTTP 429 means wait for an in-flight request to finish, then retry. There is no per-second rate limit.
5. Australian mobile numbers only. Every timestamp the API accepts or returns is UTC.
6. The sender must be a sender ID already approved on the account. Use GET /v1/senders to list them; don't assume one exists.
7. Emojis and other non-GSM characters need enable_unicode set to true, which switches to UCS-2 and shortens each part from 153 to 67 characters. Mention this whenever message length matters.
8. Webhook handlers (inbound messages and delivery receipts) must return 2xx within 5 seconds and be idempotent, because deliveries are retried and can arrive out of order.
9. Handle errors by status: 401 credentials, 400 malformed request, 403 insufficient credits, 429 concurrency, 5xx retry with the same Idempotency-Key.
10. New accounts include 50 free credits, so I can test with real messages straight away. If I need to test without delivering to handsets, a sandbox account is available from hello@mobilemessage.com.au, and on a sandbox, numbers ending in 000 simulate a failed delivery.

Give me a minimal working example in my language, then ask what I'm building.

Setting up each tool

ChatGPT or Claude (chat) Use the "Open in ChatGPT" or "Open in Claude" button on the API page, which starts a conversation that reads the docs first. Or paste the prompt above into a new chat. If your tool can't fetch URLs, click "Copy docs as Markdown" on the API page and paste the docs in, followed by the prompt.

Cursor Add the docs as a source: open Settings, go to Indexing & Docs, choose Add Doc, and enter https://mobilemessage.com.au/llms-full.txt. You can then reference it with @Docs in any chat. Alternatively, save the prompt above as a rule file in your project so it applies to every request.

Claude Code Paste the prompt at the start of your session, or add the rules section to your project's CLAUDE.md so every session starts with them. Claude Code can fetch the reference itself when you give it the URL.

GitHub Copilot and other editor assistants Save https://mobilemessage.com.au/api-documentation.md into your repository, for example as docs/mobile-message-api.md, and attach or reference it in chat. Most assistants can also fetch the URL directly if you paste it.

Code generators Feed the OpenAPI spec to your generator of choice (openapi-generator, Kiota, orval, and similar) to get a typed client. The generated client still needs the account rules above, particularly the Idempotency-Key header and the concurrency limit.

Tips for accurate results

  • Ask it to read the docs before writing code. The prompt does this, but if you start a fresh chat, say it again. Assistants that skip the docs fall back on generic SMS-API guesses.
  • Check the endpoint against the docs. If the assistant produces a path or parameter you can't find in the API documentation, it's invented. Ask it to cite the section.
  • Test with your free credits or a sandbox. Every new account includes 50 free credits, so you can test with real messages straight away. If you'd rather not deliver to handsets, email hello@mobilemessage.com.au for a sandbox account. Sandbox requests return real responses and fire simulated delivery receipts, but never send SMS or use credits, so an AI-written integration can be tested end to end safely.
  • Watch the request log. Every API call appears in the dashboard under Settings > API. See API request logs for how to use it while debugging.
  • Keep idempotency keys. AI-written retry loops are the most common cause of duplicate sends we see. Safely retrying API requests with an Idempotency-Key explains the header.

If the assistant gives you something the docs don't cover, or you hit a case the docs don't explain, email hello@mobilemessage.com.au and we'll help directly.