Quickstart

Get from signup to your first message in under five minutes. Create an account, grab your API key from the dashboard, and make your first request.

Authentication

All requests are authenticated with a bearer token. Pass your API key in the Authorization header. Keys are scoped per project and can be rotated at any time.

auth.sh
export RELAYWIRE_API_KEY="rw_live_…"

curl https://api.relaywire.io/v3/account \
  -H "Authorization: Bearer $RELAYWIRE_API_KEY"

Send a message

POST /v3/messages queues a message for delivery and returns a message id you can use to track status via webhook or polling.

send.sh
curl https://api.relaywire.io/v3/messages \
  -H "Authorization: Bearer $RELAYWIRE_API_KEY" \
  -d to="+1 555 0142" \
  -d channel="sms" \
  -d body="Your verification code is 4827"

Request parameters:

FieldTypeDescription
tostringDestination number in E.164 format.
channelstringOne of sms, rcs, voice, push.
bodystringMessage content (up to 1,600 chars).

Message status

Retrieve delivery status with GET /v3/messages/{id}, or subscribe to a webhook to receive delivered, failed, and read events in real time.

Official SDKs

First-party libraries are available for Node.js, Python, Go, Ruby, and PHP. Each ships with typed clients, retries, and idempotency support.

LanguageInstall
Node.jsnpm install relaywire
Pythonpip install relaywire
Gogo get relaywire.io/sdk