Quickstart

Send your first SMS through the API in about five minutes. You need a Falconzo account with SMS turned on (Settings › Apps › SMS in the app).

Steps

1. Create a test key

   Open API keys and create a test key with the sms.send and sms.read permissions. Copy it: it is shown only once. Test keys never send a real SMS and cost nothing.

2. Send a message

   Put your key in an environment variable called FALCONZO_API_KEY and run one of these.

   curlNode.jsPythonPHP

   Copy

   curl -X POST "https://api.falconzo.com/v1/sms/messages" \
     -H "Authorization: Bearer fz_test_YOUR_KEY" \
     -H "Idempotency-Key: order-1042-shipped" \
     -H "Content-Type: application/json" \
     -d '{"to":["0771234567"],"message":"Your order #1042 has shipped.","clientReference":"1042"}'

3. Check what happened

   The answer lists each number with a messageId and the status QUEUED. A few seconds later a test message moves to SENT and then DELIVERED. Read it back with Get an SMS, or have Falconzo tell you with webhooks.

   bashCopy

   curl https://api.falconzo.com/v1/sms/messages/MESSAGE_ID \
     -H "Authorization: Bearer $FALCONZO_API_KEY"

4. Go live

   When it works, create a live key and swap it in. Nothing else in your code changes. Until one of your sender IDs is verified, live messages only go to your verified test numbers; see Test mode.