Skip to main content

Getting Started

Welcome to the Spirius Developer Documentation! This guide will help you get started with our APIs and services.

Overview​

Spirius provides comprehensive messaging and communication APIs that enable you to:

  • Send SMS messages globally
    • Send single SMS messages (single transactions)
    • Send batches of SMS messages (bulk transactions)
  • Send RCS messages (beta)
  • Manage delivery reports and analytics
  • Access advanced routing and failover capabilities

Authentication​

Most API's require basic authentication:

Basic Authentication​

Authorization: Basic your-base64-encoded-user-name-and-password

Some API's have additional authentication methods, such as Oauth2, please check the API references for more information.

Quick Start​

1. Get Your API Credentials​

Contact our support team to obtain your API credentials:

2. Make Your First API Call​

curl -X POST https://rest.spirius.com/v1/sms/send \
  -H "Authorization: Basic your-base64-encoded-user-name-and-password" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+1234567890",
    "message": "Hello from Spirius!",
    "from": "SPIRIUS"
  }'

3. Handle the Response​

{
  "messageId": "<uuid>"
}

Rate Limits​

  • Configurable per account, specified in contract
  • Contact your account manager if you need to increase your rate limits

Support​

Need help? We're here to assist:

  • Documentation: Browse our comprehensive guides and examples
  • API Reference: Detailed OpenAPI specifications
  • Support Team: Contact us for technical assistance at support@spirius.com