API Documentation

Integrate our powerful communication services directly into your applications.

Introduction

The smscartesim API allows you to programmatically access our services, including purchasing temporary numbers, checking account balance, and retrieving SMS messages. Our API is built around REST principles and returns JSON responses.

Authentication

Authenticate your requests by including your API key in the request headers.

Authorization: Bearer YOUR_API_KEY

You can generate and manage your API keys in your User Dashboard.

Base URL

All API requests should be made to:

https://smscartesim.com/api/v1
GET

/user/balance

Retrieve your current account balance.

Response Example

{
  "status": "success",
  "balance": 50.00,
  "currency": "USD"
}
GET

/services

Get a list of available services and countries for temporary numbers.

Parameters

Parameter Type Description
country string Optional. Filter by country code (e.g., 'us', 'uk').
POST

/orders

Purchase a new temporary number.

Parameters

Parameter Type Required Description
service string Yes Service code (e.g., 'wa' for WhatsApp).
country string Yes Country ID or code.
GET

/sms

Get SMS messages for your numbers. If no ID is provided, returns a list of active numbers.

Parameters

Parameter Type Required Description
id string No The ID of the number/order to check SMS for.
POST

/messages

Send an SMS or WhatsApp message using your virtual numbers or approved Sender IDs.

Parameters

Parameter Type Required Description
from_sender string Yes Your virtual number or approved Sender ID.
to_number string Yes The recipient phone number (with country code).
message string Yes The message content.
type string No The channel to use: 'sms' or 'whatsapp'.
POST

/otp/send

Generate and send a 6-digit OTP code to a phone number.

Parameters

Parameter Type Required Description
phone string Yes The recipient phone number.
provider string No Specific provider to use (infobip, twilio, etc).
POST

/otp/verify

Verify a previously sent OTP code.

Parameters

Parameter Type Required Description
phone string Yes The phone number the code was sent to.
code string Yes The 6-digit OTP code.