SIMcloud API Documentation

This page is the master index for the SIMcloud API documentation.

The currently documented API services are user registration, SMS, airtime, data, VAS, electricity, transaction history, wallet balance, and network lookup.

Authentication

All API services use Bearer token authentication.

Authorization: Bearer YOUR_API_TOKEN

To create or refresh your API token, use the SIMcloud token management page here: https://simcloud.co.za/sms_api_management.php

Generate and manage your API token from the SIMcloud portal, then use the same token across the supported API services below.

Machine-Readable Spec

For LLMs, agent tooling, and API client generation, use the raw OpenAPI spec:

https://simcloud.co.za/api/openapi.yaml

For browser viewing, use the rendered spec page: https://simcloud.co.za/api/openapi.php

For ChatGPT, Codex, and other agentic tools that support OAuth-protected MCP servers, use the AI integration guide: https://simcloud.co.za/api/ai.html

Available Services

User Registration API

Create a normal SIMcloud child account from your app and receive its API token.

Open Registration Documentation

SMS API

Send SMS messages and query SMS delivery status.

Open SMS Documentation

Airtime API

Queue prepaid airtime purchases and poll the order status.

Open Airtime Documentation

Data API

List available data bundle products, queue prepaid data purchases, and poll the order status.

Open Data Documentation

VAS API

List available voucher products, queue VAS purchases, and poll voucher results.

Open VAS Documentation

Electricity API

Check supported prepaid meters, submit electricity requests, and poll the order until the municipality returns the final result.

Open Electricity Documentation

Transaction History API

Retrieve account transaction history across airtime, data, SMS, VAS, and electricity.

Open Transaction History Documentation

Balance API

Fetch the authenticated account's last known SIMcloud wallet balance.

Open Balance Documentation

Network Lookup API

Look up the mobile network for a South African cell number using token-based authentication.

Open Network Lookup Documentation

OpenAPI Spec

Machine-readable API contract for LLMs, tooling, and generated clients.

Open OpenAPI Spec

AI & Codex Integration

Connect SIMcloud to ChatGPT, Codex, and MCP-compatible tools using OAuth and the SIMcloud MCP endpoint.

Open AI Integration Guide

Service Summary

User Registration: Create a separate SIMcloud account under the authenticated parent account and return the child's API token.
SMS: Immediate message submission with status polling.
Airtime: Queue-based prepaid airtime ordering with asynchronous status updates.
Data: Data product catalogue lookup, queue-based prepaid data ordering, and asynchronous status updates.
VAS: Voucher catalog lookup, single voucher ordering, and asynchronous voucher result polling.
Electricity: Meter support checks, municipality-submitted prepaid electricity ordering, asynchronous status updates, and voucher details on success.
Transaction History: Date-range, type-filtered history for account-owned airtime, data, SMS, VAS, and electricity transactions.
Balance: Fetch the authenticated account's last known SIMcloud wallet balance.
Network Lookup: Look up a South African mobile number's network and log the lookup to the authenticated account.
OpenAPI: Machine-readable API contract covering the documented token-auth endpoints.
AI & Codex: OAuth and MCP entry points for connecting SIMcloud to ChatGPT, Codex, and other agentic tools.