Quickstart
Create an account, generate a sandbox-scoped key, send one request, and then choose the next workflow.
1. Create Your Account
Sign up from the AfriRoute console and complete the required email, phone, and identity checks for your account type.
New accounts may be limited to onboarding and verification screens until approved for broader console access.
2. Create A Sandbox Key
Create a scoped API key from the console and store it in your local or deployment environment:
AFRIROUTE_API_BASE_URL=https://api.afriroute.ai
AFRIROUTE_API_KEY=YOUR_SANDBOX_KEY
Do not hardcode the key in source code, mobile apps, browser JavaScript, or public documentation.
3. Send One Message
curl --request POST "$AFRIROUTE_API_BASE_URL/api/v1/sms/send" \
--header "Authorization: Bearer $AFRIROUTE_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"to": "+251900000000",
"message": "Hello from AfriRoute",
"country": "ET",
"senderId": "AFRIROUTE"
}'
Keep the first request minimal. Add delivery callbacks, scheduling, templates, and SDKs only after the basic request works.
4. Verify The Response
A successful first response should include a message identifier and a queued or accepted status.
{
"messageId": "msg_01JPFZ0D4PT4X6YQ8ZZ8E1KS8R",
"status": "queued"
}
Do not treat queued as delivered. Use message status lookups or webhooks for delivery confirmation.