Guide Genetics SMS API

A secure, reliable SMS messaging API powered by Bird platform with multi-tenant organization management.

🚀 Quick Start for Developers

Base URL: https://sms.guidegenetics.com/api/v1

Send your first SMS:

bash

curl -X POST https://sms.guidegenetics.com/api/v1/sms/send \
  -H "X-API-Key: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"to": "+1234567890", "message": "Hello World!"}'

📖 Documentation Sections

Section	Description
Quick Start	Get up and running in minutes with code examples
API Reference	Complete endpoint documentation with request/response examples
Changelog	Version history and recent changes

🔑 Key Features

SMS API - Send SMS messages via Bird platform with simple REST API
Secure Authentication - Token-based API keys with bcrypt hashing
Multi-tenant - Apps → Organizations → API Keys structure
Admin Dashboard - Web interface for managing apps, organizations and API keys
FROM_NUMBER Auto-detection - Phone numbers automatically selected from app configuration
Cross-platform - Support for Ruby, Node.js, Python, and cURL clients

🔗 Main API Endpoints

POST /api/v1/sms/send - Send an SMS message
GET /api/v1/sms/messages/:id - Get message status
GET /api/v1/sms/messages - List messages with pagination
GET /api/v1/sms/from-numbers - Get available phone numbers (optional)

🛡️ Authentication

All API requests require authentication via:

X-API-Key header (recommended): X-API-Key: your_api_key
Authorization header: Authorization: Bearer your_api_key
Query parameter: ?api_key=your_api_key

💡 Example Response

json

{
  "success": true,
  "message": {
    "id": 123,
    "status": "sent",
    "bird_message_id": "msg_abc123"
  }
}

Need to set up your own instance? See the GitHub repository for setup and deployment instructions.

Guide Genetics SMS API Documentation

📚 About