Getting Started with Relay
Welcome to Relay! This section will help you get up and running with the Relay SMS platform quickly and efficiently.
Regional Availability
Relay currently supports SMS messaging to United States and Canada only. We've focused our efforts on optimizing message delivery, compliance, and reliability for North American markets before expanding internationally.
This focused approach allows us to master regional regulations, carrier requirements, and delivery optimization in one territory before adding others.
International expansion is planned based on customer demand.
Quick Navigation
Installation Guide
Complete setup guide for your development environment across multiple languages and frameworks.
What you'll learn:
- Account and API key setup
- Environment configuration for Node.js, Python, PHP
- IDE integration (VS Code)
- Configuration management
- Troubleshooting common issues
Development Setup
Set up the local SMS testing environment with SMS-dev for development without sending real messages.
What you'll learn:
- Install and configure the Relay CLI
- Start the local SMS testing server
- Configure your app for development vs production
- Use the virtual phone UI for testing
- Set up webhooks for local development
Recommended Learning Path
For New Developers
- Installation Guide - Set up your environment properly
- Development Setup - Configure local testing
- Messages API - Learn the core functionality
- SMS Basics - Understand SMS fundamentals
For Experienced Developers
- Installation Guide - Quick environment setup
- Development Setup - Local testing configuration
- API Reference - Explore all endpoints
- SMS Basics - Understand SMS fundamentals
For Production Deployment
- Installation Guide - Production environment setup
- Authentication - Security best practices
- Webhooks - Real-time event handling
- SMS Basics - Compliance and optimization
What's Next?
After completing the getting started guides:
- API Reference - Complete endpoint documentation
- Core Concepts - Understand SMS fundamentals
- Developer Tools - CLI and SDK documentation
Need Help?
- Support: Email support@relay.works
- Community: Join our developer community
Pro Tip: Start with the Installation Guide for a proper development setup, then explore the API Reference to understand all available endpoints.