Parameters
Request Body Parameters
For POST, PUT, and PATCH requests, set Content-Type: application/json. The body must be a JSON object.
| Parameter | Type | Required | Description |
|---|---|---|---|
phone | string | Yes | Phone number in international format (e.g., 255712345678). Used in send-sms. |
message | string | Yes | SMS message content (max 160 characters). Used in send-sms and send-bulk-sms. |
sender_id | string | No | Approved sender name (max 11 chars). If omitted, the SMS uses the RafikiSMS default company sender name instead of your brand. Used in send-sms, send-bulk-sms, otp/generate. |
recipients | array<string> | Yes | Array of phone numbers for bulk SMS (e.g., ["255712345678","255621728109"]). Used in send-bulk-sms. |
phone_number | string | Yes | Destination number in E.164 format (e.g., 255712345678). Used in otp/generate, otp/verify. |
otp_code | string | Yes | The 6-digit code the user received via SMS. Used in otp/verify. |
reference_id | uuid | Yes | UUID returned by otp/generate. Used in otp/verify. |
senderid | string | Yes | Desired sender ID (max 11 chars, alphanumeric with spaces/hyphens/dots). Used in sender-names/request. |
sample_content | string | Yes | Sample message content (min 15 chars). Used in sender-names/request. |
delivery_webhook_url | string (uri) | No | HTTPS URL for delivery status callbacks. Pass null to disable. Used in vendors/delivery-webhook. |
Query Parameters
Appended to the URL after ? for filtering and pagination.
| Parameter | Type | Applies To | Description |
|---|---|---|---|
page | integer | sms-logs, sender-names | Page number. Defaults to 1. |
per_page | integer | sms-logs, sender-names | Items per page. Defaults to 10 (max 100). |
status | string | sms-logs, sender-names | Filter by status. Options: sent, failed, pending (sms-logs) or active, pending, rejected (sender-names). |
start_date | string | sms-logs | Start date for log filtering (ISO 8601 or YYYY-MM-DD). |
end_date | string | sms-logs | End date for log filtering (ISO 8601 or YYYY-MM-DD). |
dest_addr | string | delivery-reports | Destination phone number (required). |
request_id | string | delivery-reports | SMS request/transaction ID from send response (required). |