SMS API

A compact API surface for global messaging teams.

Amiq keeps integration predictable: submit a message, track its state, receive callbacks, and keep route decisions observable.

Create account

Request shape

Readable payloads for high-volume workflows.

The website proxy follows the provided OneHub contract for auth, contact, subscribers, channels, and content. Messaging endpoints can be layered into the same server-side pattern.

api-intent.yaml
identifier: email or phone
site: x-onehub-site
error: code, message, requestId
pagination: limit, offset, hasMore

Endpoint families

Expose only what the site needs.

The implementation avoids turning the API catalog into a public control panel.

01

Authentication

Login accepts a single identifier while registration submits either email or phone plus consent values.

02

Contact intake

Consultation messages are submitted to the public contact endpoint with source URL context.

03

Channel visibility

Public channel rates are fetched through a local route handler with loading, empty, error, and retry states.

Callbacks

Design around eventual outcomes.

A clean SMS API treats delivery as a state machine, not a single yes-or-no event.

Accepted

Request received

Validate parameters, create a traceable request ID, and return a state the app can store.

Queued

Route assigned

Resolve destination and channel logic without leaking provider details to clients.

Delivered

Callback posted

Send a delivery report to the customer's webhook once downstream evidence arrives.

Failed

Reason classified

Group errors into actionable categories for retry, support, or compliance review.

Developer experience

Small primitives, useful states.

The page mirrors a developer-doc feel without becoming a separate docs portal.

REST-first

HTTP and JSON are the default integration primitives for predictable server-to-server messaging.

Operational telemetry

Request IDs, error codes, and pagination fields are preserved through route handlers.

Secret discipline

API keys and admin tokens stay outside client bundles and are configured as environment secrets.

Bring your first message flow.

Amiq can help model OTP, alert, or lifecycle traffic before the production route is turned on.

Plan integration