API Documentation
Welcome to the Call Africa API documentation. This guide will help you integrate our SMS sending capabilities into your application.
Authentication
All API requests require authentication using an API key. You can obtain your API key from the dashboard after signing up.
Authorization: Bearer YOUR_API_KEY
Include this header in all your API requests.
Send SMS
Use this endpoint to send SMS messages to one or multiple recipients.
https://api.callafrica.rw/api
POST /sendSMS
Request Body
Important Content-Type Requirements:
- For text area method (textContacts): Use
Content-Type: application/json
- For file upload method (contacts): Use
Content-Type: multipart/form-data
Important Phone number formats:
+2507..., 2507..., 07..., 7...
+25078... or +25079...
// Option 1: Using text area for contacts (Content-Type: application/json) { "textContacts": "+250780000000 250780000000", "message": "Your verification code is 123456", "senderId": "YourApp", } // Option 2: Using file upload for contacts (Content-Type: multipart/form-data) { "contacts": CSV or XLSX File Upload, // File with contacts and optional data columns "message": "Hello [name], your balance is [balance]", // Column references in brackets "senderId": "YourApp", }
Parameters
Field | Type | Description |
---|---|---|
textContacts | String | Phone numbers, one per line (use this OR contacts) |
contacts | File (CSV/XLSX) | File containing phone numbers and optional data columns (phone column is required in the file) |
message | String | The content of the SMS message, can include column references like [columnName] |
senderId | String | The sender ID or name |
Contact Format
There are two ways to provide contacts:
1. Text Area (textContacts)
Enter phone numbers one per line (with country code):
+250780000000 250780000000 0780000000
2. File Upload (contacts)
Upload a CSV or XLSX file with phone numbers and optional data columns:
- Supported formats: CSV (.csv) or Excel (.xlsx)
- First column must contain phone numbers
- Additional columns can be used for personalization
- First row should contain column headers
Example CSV format:
phone,name,balance +250780000000,John Doe,100.50 250780000000,Jane Smith,250785 0780000000,Alex Johnson,75.20