Documentation

If you're integrating SIMRelay into your own product, agent, or internal tooling — this is the starting point. The docs are split into a quickstart, concept-by-concept reference, and the exhaustive API reference. Quickstart and reference pages in progress; this page will expand as we publish each section.

Quickstart (5 minutes)

  1. Sign up for a SIMRelay account and complete onboarding.
  2. From the dashboard, navigate to API keys and create a key. Scope it to numbers.read, messages.read, and webhooks.write if you don't need more.
  3. Make your first API call: GET /api/numbers with the key as a Bearer token.
  4. Claim a number, send yourself a test SMS, and watch it arrive via webhook or polling.

Core concepts

  • Hosted SIM — a real SIM card we host on your behalf. Identified by an internal ID and an MSISDN.
  • Organization — billing and access boundary. Has many users; can own many hosted SIMs.
  • Team — sub-grouping inside an organization. Used to scope access to specific numbers.
  • Message log — the durable record of every inbound (and outbound) SMS.
  • Number lock — temporary exclusive access to a hosted SIM by a specific user.
  • API key — scoped credential with one or more permissions (e.g., numbers.write, messages.send).

Authentication

Bearer tokens in the Authorization header. Either a Sanctum personal-access token (for one-off scripts) or an API key (for production). API keys can be scoped, rotated, and revoked independently of user accounts.

Errors

Standard HTTP status codes. Error bodies are JSON with error.code and error.message. Don't parse the human-readable message — it can change. Switch on the code.

Next steps