🍊 OrangeAPI

Enter your Admin password to access the control panel

⚠️ Too many failed attempts. Locked out for 15:00
🍊 OrangeAPI Dashboard
Initializing

WhatsApp Accounts

Manage multiple concurrent WhatsApp sessions and sending nodes.

WhatsApp Testing Suite

System Credentials

Global API Key:

••••••••••••

Troubleshooting:

🔒

SMS Gateway Locked

Enter your SMS Gateway password to access devices and API keys.

🚫 Too many failed attempts.
Please wait 15:00 before trying again.

⚠️ Firebase Not Configured

To send SMS, you must create a Firebase project, download your service account JSON file, rename it to firebase-key.json, and upload it to the root of your Node.js application directory.

Connected SMS Devices

List of active mobile devices registered as SMS gateways.

Device ID Model SIM Slots Battery Network Last Active Action
No devices connected. Install the app on your phone.

Send SMS (Test API)

Characters: 0 Parts: 0/1 (GSM)

🔐 Change Gateway Password

Update the SMS Gateway unlock password. Can be any length for extra security.

🛡️ Security Info

🔒 Password Guidelines

Use a strong, unique password of any length. We recommend including uppercase and lowercase letters, numbers, and symbols.

⏱️ Rate Limiting

After 5 failed attempts, the gateway lock screen will be locked for 15 minutes to prevent brute force attacks.

💡 Admin vs Gateway Password

The Admin Password unlocks the full control panel. The Gateway Password protects device & API key management inside the Gateway tab.

Generate New API Key

Register devices first.

Active API Keys

View, copy, set default, and delete custom API keys. Click ✏️ to edit.

Label API Key Default Routing Assigned Devices & SIMs Actions
No API keys generated yet.

✈️ Telegram Bot & Channel Gateway

Send high-speed notifications, photos, documents, and interactive buttons with 0% ban risk.

Checking Bot...

🤖 Bot Configuration

Connect your Telegram bot token created via @BotFather.

If target chat is omitted in API call, this default recipient will be used.

💡 1-Minute Telegram Setup Guide:

  1. Open Telegram and search for @BotFather.
  2. Send /newbot command and choose a Name & Username.
  3. Copy the HTTP API Token and paste it in the box above.
  4. To get your personal Chat ID, send a message to @userinfobot.
  5. For Channels: Add your bot as an Administrator in your channel, then use @channel_username as the Chat ID!

🚀 Send Test Telegram Message

Test sending rich formatted messages, photos, documents, and buttons.

✈️ Telegram Outgoing Message Logs

History of Telegram notifications and channel broadcasts sent through OrangeAPI.

Time Target Chat / Channel Type Message Content Status
No Telegram logs available.

WhatsApp Outgoing Queue & Logs

History of WhatsApp messages enqueued and processed via Baileys.

Time Recipient Type Content Status Action
Loading logs...

SMS Outgoing Queue & Logs

History of SMS requests enqueued and processed via Firebase to mobile gateways.

Time Device SIM Recipient Message Status Action
No SMS logs available.

API Docs for AI Agents

Copy this markdown block directly to any AI coding assistant (like Claude, ChatGPT, Gemini, Cursor) to instantly teach them how to write code for your API.

Interactive API Explorer

Use the following endpoints to integrate WhatsApp messaging into your own applications.

Headers

Header Value Description
x-api-key your-api-key Your secret API key shown in the Device Status card.
Content-Type application/json or multipart/form-data Use application/json for text, multipart/form-data for media/files.

Request Body (JSON - Text Message)

Parameter Type Required Description
to string Yes Recipient's WhatsApp number (with country code, e.g., 919876543210) or Group JID.
message string Yes The message text to send.
isGroup boolean No Set to true if the recipient is a Group ID. Default: false.

Request Body (Multipart Form - Media Message)

Parameter Type Required Description
to string Yes Recipient's WhatsApp number or Group JID.
media file Yes The file to send (image, video, audio, or document).
message string No Optional caption to accompany the image, video, or document.
isGroup boolean No Set to true if the recipient is a Group ID. 
Loading...
Loading...
Loading...
Loading...

Headers

Header Value Description
x-api-key your-api-key Your secret API key.
Content-Type application/json Use application/json.

Request Body (JSON)

Parameter Type Required Description
to string Yes Recipient's mobile number with country code (e.g. +919876543210).
message string Yes The message text.
deviceId string No Target specific Device ID (e.g. Rajib-Pixel-7). Defaults to most recently active device.
sim integer No SIM Slot index (0 for SIM 1, 1 for SIM 2). Default is 0. 
Loading...
Loading...
Loading...
Loading...

Request Details

Send a GET request to quickly check the connection status of the WhatsApp bot.

Method URL Description
GET http://domain/api/status Returns current connection state. 
Loading...
Loading...
Loading...
Loading...

Headers

HeaderValueDescription
x-api-keyyour-api-keyYour secret API key.
Content-Typeapplication/jsonUse application/json.

Request Body (JSON)

ParameterTypeRequiredDescription
phonestringYes10-digit number (e.g. 9933557706) or with country code (e.g. 919933557706). +91 is auto-added if omitted.
sessionIdstringNoOptional session ID to query from.
 
Loading...
Loading...
Loading...
Loading...

Headers

HeaderValueDescription
x-api-keyyour-api-keyYour secret API key.
Content-Typeapplication/jsonUse application/json.

Request Body (JSON)

ParameterTypeRequiredDescription
tostringYesRecipient's WhatsApp number or group JID.
namestringYesPoll title / question.
valuesarrayYesArray of option strings (e.g. ["Choice 1", "Choice 2"]).
selectableCountnumberNoMaximum selectable choices (Default: 1).
 
Loading...
Loading...
Loading...
Loading...

Headers

HeaderValueDescription
x-api-keyyour-api-keyYour secret API key.
Content-Typeapplication/json or multipart/form-dataUse JSON for text status, form-data for image/video.

Request Body

ParameterTypeRequiredDescription
textstringOptionalText content for announcement status.
mediafileOptionalImage or video file to post to status.
captionstringOptionalCaption for media status.
 
Loading...
Loading...
Loading...
Loading...

Headers

HeaderValueDescription
x-api-keyyour-api-keyYour secret API key.
Content-Typeapplication/json or multipart/form-dataUse JSON for text messages, form-data for media file upload.

Request Body (JSON / Form Data)

ParameterTypeRequiredDescription
to / chat_idstringYesRecipient's User Chat ID (e.g. 123456789) or Channel / Group Username (e.g. @my_channel).
message / textstringYesMessage text content. Supports HTML tags like <b>bold</b>, <i>italic</i>, and links.
mediafileNoOptional image, video, audio or PDF document to attach.
buttonsarray/jsonNoOptional inline keyboard buttons (e.g. [[{"text":"Visit","url":"https://..."}]]).
botTokenstringNoOptional override if you want to send from a specific bot token.
 
Loading...
Loading...
Loading...
Loading...

Generate WhatsApp API Key

Loading accounts...

Active WhatsApp API Keys

Use these keys in client headers as x-api-key for sending WhatsApp messages.

Label Routing Assigned Accounts API Key Created At Actions
No WhatsApp API keys generated yet.

Security Settings

💡 SMS Gateway password can be changed from inside the Gateway tab (after unlocking).

Delay & Limits Settings

WhatsApp Sending Delays

SMS Gateway Limits & Delays