API Documentation

Ringslack API Documentation

Integrate Ringslack communication APIs into your projects. Send SMS, make voice calls, send emails, and create video rooms with our comprehensive API.

API Overview

Base URL

/api/v1

Main API endpoint for all services

Authentication

Customer Authentication

API Key: Your customer API key

Header: x-api-key

Note: Customer API keys work for SMS, email, voice, and video services

App-Level Authentication

API Key + Secret: For full API access

Headers: x-api-key + x-api-secret

Note: Required for all v1 API endpoints

Available Endpoints

SMS

POST
?sms

Send and receive SMS messages

Voice

POST
?voice

Make and receive voice calls

Video

POST
?video

Create video conference rooms (customer auth only)

Email

POST
?email

Send transactional emails

Phone Numbers

POST
?phone-numbers

Manage phone numbers

Login

POST
?login

Authentication endpoint (no API key required)

HTTP Methods

Important

The v1 API endpoint only accepts POST requests for all operations. GET requests will return a 401 Unauthorized error.

POST /api/v1?[service]

Note: All API calls use query parameters to specify the service (?sms, ?email, ?voice, ?video, ?phone-numbers, ?login).