Developer Resources - API Documentation & Getting Started

Welcome to SIMRelay's developer resources. Our comprehensive API allows you to integrate SMS relay functionality directly into your applications, automate message forwarding, and build custom solutions around our virtual SIM infrastructure.

API Documentation

Get started with our full API documentation, including endpoints, authentication, request/response examples, and integration guides.

View Complete API Documentation

Getting Started

Follow these steps to begin integrating with SIMRelay's API:

1. Create Your API Token

To access our API, you'll need to generate an API token from your dashboard:

  1. Log in to your SIMRelay dashboard
  2. Navigate to Settings > API Tokens
  3. Click Generate New Token
  4. Give your token a descriptive name (e.g., "Production App", "Development Environment")
  5. Copy and securely store your token immediately - it won't be shown again

2. Authentication

Include your API token in the Authorization header of all requests:

Authorization: Bearer YOUR_API_TOKEN

3. Base URL

All API requests should be made to:

https://api.simrelay.com/v1/

Common Use Cases

Our API enables powerful automation and integration scenarios:

  • Automated Message Routing: Programmatically configure forwarding rules based on message content or sender
  • Custom Dashboards: Build internal tools to monitor SMS activity and manage team access
  • Webhook Processing: Receive real-time notifications when messages arrive
  • Number Management: Dynamically lock/unlock numbers for exclusive team member access
  • Integration Workflows: Connect SMS notifications to your existing business systems

Rate Limits & Best Practices

To ensure optimal performance and fair usage:

  • API requests are limited to 100 requests per minute per token
  • Use webhook endpoints for real-time notifications instead of polling
  • Implement proper error handling and retry logic
  • Cache responses when appropriate to reduce API calls

Support & Resources

Need help with your integration? We're here to assist:

  • API Documentation: Complete reference at simrelay.com/docs/api/
  • Code Examples: Sample implementations in popular programming languages
  • Developer Support: Technical assistance via email or chat
  • Webhook Testing: Tools to test and debug webhook integrations

Ready to build with SIMRelay? Explore our API documentation and start integrating SMS relay capabilities into your applications today.