Quick Start Guide
Send your first SMS in 5 minutes! This guide will walk you through getting your API key and sending your first message.
Get API Key
2 min
Send First SMS
1 min
Check Status
1 min
Check Balance
1 min
Get Your API Key
Copy your API key:
Need help? Check our Authentication Guide for detailed instructions.
Send Your First SMS
Choose your preferred language and copy the code below. Replace YOUR_API_KEY_HERE with your actual API key.
import requests
# Your API credentials
API_KEY = "YOUR_API_KEY_HERE"
API_URL = "https://roycetalk.com/api/v1/sms-api/send/"
# Prepare the SMS
headers = {
"Authorization": f"Bearer {API_KEY}",
"Content-Type": "application/json"
}
data = {
"phone_number": "+254712345678",
"sender_id": "RoyceLTD",
"text_message": "Hello! This is my first SMS from RoyceBulkSMS API."
}
# Send the SMS
response = requests.post(API_URL, json=data, headers=headers)
# Check the result
if response.status_code == 200:
result = response.json()
print("✓ SMS sent successfully!")
print(f"Message ID: {result['data']['message_id']}")
print(f"Status: {result['data']['status']}")
print(f"Cost: KES {result['data']['cost']}")
else:
print(f"✗ Error: {response.status_code}")
print(response.text)Success Response
If successful, you'll receive a response like this:
Save the message_id! You'll need it to check delivery status.
Check Message Status
Use the message_id from Step 2 to check delivery status:
Expected statuses:
- • pending - Message queued, awaiting delivery
- • sent - Submitted to carrier
- • delivered - Successfully delivered ✓
- • failed - Delivery failed
Learn more: Message Status Documentation
Check Your Balance
Check how many SMS units you have remaining:
Response:
Learn more: Check Balance Documentation
🎉 Congratulations!
You've successfully sent your first SMS with RoyceBulkSMS API!
Next Steps
Send Bulk SMS →
Send messages to multiple recipients at once for campaigns and notifications.
Odoo Integration →
Install our Odoo module to send SMS directly from your Odoo system.
Track Delivery →
Monitor message delivery status and get detailed delivery reports.
Security Best Practices →
Learn how to secure your API keys and follow security best practices.