Developer documentation

A sk-ams-test- key runs the complete request flow, including validation, pricing, queueing and tracking, against a simulated gateway. Use it to build and test your integration without spending money.

What test mode does

• No SMS is ever sent to a handset, and your wallet is never charged. total_cost still shows what the same send would cost with a live key.
• Messages move from queued to sent within seconds.
• Numbers ending in 0000, such as 01712340000, always fail. The message becomes failed with refunded: true, so you can exercise your failure and refund handling.
• Validation, scopes, rate limits and idempotency behave exactly as in live mode.
• GET /wallet/balance returns your real balance for both modes.

Test and live data never mix

Every batch and message created with a test key is marked "mode": "test". List endpoints only return rows that match the calling key's mode: a test key never sees live history, and a live key never sees test history.

Groups are the exception: they are shared between modes. A test key can read your groups and their contacts and simulate a group send, but it cannot change them. Creating, updating or deleting a group, and adding or removing contacts, with a test key returns 403 forbidden under permission with "Test keys cannot change groups, use a live key".

How long test data is kept

Test batches and messages are deleted after 3 days. Live data is never deleted this way.

Going live

Create a sk-ams-live- key with the same scopes and swap it in. No code change is needed. Live sends are charged from your wallet, so top it up first.