REST API Documentation - teammessage.de

Interactive API Documentation

Our REST API comes with built-in Swagger UI documentation. Test API calls directly in your browser, explore all endpoints, and generate code snippets.

Open Swagger UI OpenAPI Schema (JSON)

API Features

Modern REST Design

Clean JSON responses, standard HTTP methods, meaningful status codes.

Bearer Token Auth

Secure authentication with API tokens. No passwords in URLs.

OpenAPI 3.0

Auto-generated schema for code generation and IDE integration.

Legacy Compatible

Existing integrations continue to work via PHP proxies.

Available Endpoints

SMS Sending `/api/v1/sms/`

Method	Endpoint	Description
GET	`/api/v1/sms/send/`	Send SMS via HTTP GET (legacy compatible)
POST	`/api/v1/sms/send/`	Send SMS via HTTP POST (recommended)

Team Management `/api/v1/teamlist/`

Method	Endpoint	Description
GET	`/credit/`	Get SMS quota and usage
GET	`/lists/`	List all team lists
GET	`/members/`	List team members
POST	`/member/`	Create member
PUT	`/member/`	Update member
DELETE	`/member/`	Delete member

Delivery Logs `/api/v1/logging/`

Method	Endpoint	Description
GET	`/sms/`	Get SMS delivery log with pagination
GET	`/statuscodes/`	List all delivery status codes
GET	`/reasoncodes/`	List all reason codes

Authentication

Bearer Token Authentication

Create an API token in your account settings and include it in the Authorization header:

Authorization: Bearer your-api-token-here

Secure, easy to rotate, no passwords in logs

Manage API Tokens

Note: This documentation covers the modern REST API. If you have existing integrations using the legacy HTTP interface, they will continue to work unchanged.

Quick Examples

Send SMS with cURL

curl -X POST "https://www.teammessage.de/api/v1/sms/send/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "team_id": 12345,
    "teamlist_email": "myteam@tmsg.de",
    "message": "Hello World!",
    "to_mobile": "+4917612345678"
  }'

Check SMS Credit

curl "https://www.teammessage.de/api/v1/teamlist/credit/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -d "team_id=12345&list_id=67890"

Python Example

import requests

response = requests.post(
    "https://www.teammessage.de/api/v1/sms/send/",
    headers={"Authorization": "Bearer YOUR_TOKEN"},
    json={
        "team_id": 12345,
        "teamlist_email": "myteam@tmsg.de",
        "message": "Hello from Python!",
        "to_mobile": "+4917612345678"
    }
)
print(response.json())

Ready to integrate?

Explore all endpoints interactively with our Swagger documentation.

Open API Documentation

REST API