REST API cURL Examples & Fixtures

Executable cURL snippets for fetching active numbers, simulating inbound SMS, and replaying failed webhooks with authenticated headers.

synthetic_sms.sh

REST API v1

curl -X POST https://smsriver.com/api/v1/synthetic/sms/ \
  -H "Authorization: Bearer sk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+12025550101",
    "from": "AuthService",
    "body": "Your verification code is 482910"
  }'

list_countries.sh

REST API v1

curl -X GET https://smsriver.com/api/v1/countries/?source_type=native \
  -H "Authorization: Bearer sk_live_your_api_key"

Implementation Walkthrough

Authenticate with Bearer Token

Include your active API key in the standard Authorization header with Bearer prefix.

Dispatch Synthetic Test Events

Send test messages with custom sender, destination, and body without incurring carrier segment fees.

Inspect Recorded Webhook Deliveries

Query recorded test events and delivery latencies directly via the `/api/v1/webhooks/test/` endpoint.

Supported MCP Agent Tools

list_countries

alias: sms_list_numbers

Discover supported countries, inventory counts, and carrier capabilities by source type.

get_number_capabilities

alias: sms_get_capabilities

Check line types, SMS capabilities, carrier limitations, and rental costs for a phone number or ISO country.

create_test_inbox

alias: sms_create_inbox

Create an isolated synthetic test inbox for deterministic webhook integration testing without real carriers.

generate_test_sms

aliases: sms_generate_sms, sms_create_synthetic_message

Inject zero-carrier-cost synthetic SMS inbound events directly into webhook endpoints for CI/CD test automation.

simulate_delivery_failure

alias: sms_simulate_failure

Simulate carrier drops, 10DLC rejections, DND blocks, and queue timeouts to verify retry handling.

inspect_webhook_events

alias: sms_inspect_webhooks

Query recorded test events, delivery status, latency, and raw carrier webhook payloads within plan retention.

replay_test_event

alias: sms_replay_event

Replay an existing test event to re-trigger local webhooks or reproduce failed integration test cases.

get_usage_summary

alias: sms_get_usage

Inspect current billing plan, monthly quota, consumed requests, and remaining units across REST and MCP.