Odoo SMS Gateway Integration

Odoo is a popular open-source ERP/CRM platform. Odoo's native SMS functionality uses either its built-in IAP (In-App Purchase) service or direct Twilio integration. It does not natively expose a generic HTTP SMS gateway for custom providers.

To use SMSDESK as the SMS gateway, you need a third-party module that adds configurable HTTP SMS gateway support to Odoo. Popular options include:

• eis_sms_apis (Dynamic SMS Gateway) — allows defining custom REST endpoints with user-configurable parameter names and placeholders like {phone}, {message}, {api_key}
• send_sms — community module that supports HTTP GET/POST gateways with {mobile} and {message} placeholders
• Custom modules — developers can build modules that call any HTTP endpoint via Odoo's requests or urllib libraries

Endpoint

GET POST https://{host}/api/http/odoo/main.ashx

Supports GET (query string), POST form-encoded, and JSON POST (Content-Type: application/json). The handler auto-detects the format.

Authentication

Pass your SMSDESK API key in the apikey or key parameter. This is the same API key used across all SMSDESK integrations.

Getting Your API Key

1. Log in to the SMSDESK Portal
2. Navigate to your SMS Channel settings
3. Copy your existing API key or generate a new one

Parameters

For form-encoded requests, parameters can be sent via query string (GET) or form body (POST). For JSON requests, send as a JSON object body.

Response Format

Plain Text (default for form-encoded)

12345:264811234567:PENDING,12346:264812345678:PENDING

JSON (with ?format=json or JSON POST)

{
  "status": "ok",
  "messages": [
    { "sms_id": "12345", "recipient": "264811234567", "status": "PENDING" }
  ]
}

Error (plain text)

ERROR: [apikey] or [key] NOT PROVIDED

Odoo SMS Gateway Configuration

Option 1: Using eis_sms_apis Module (Recommended)

The eis_sms_apis (Dynamic SMS Gateway) module is a popular Odoo community module that allows configuring custom HTTP SMS gateways with user-defined parameter mappings.

1. Install the eis_sms_apis module in Odoo (available from Odoo Apps store)
2. Enable Developer Mode (Settings → scroll to bottom → Activate Developer Mode)
3. Navigate to Settings → Technical → SMS / Phone → SMS Gateways
4. Click Create and configure:
   • Name: SMSDESK
   • Base URL: https://{host}/api/http/odoo/main.ashx
   • HTTP Method: POST (Form Data) or GET
   • Auth Type: API Key
   • Parameter Mapping:

     Param Type	Placeholder	Map To
     Number	{phone}	phone
     Message	{message}	message
     Auth	{api_key}	apikey

   • API Key Value: Your SMSDESK API key
5. Save and send a test SMS

Option 2: Using send_sms Community Module

The send_sms module uses {mobile} as the recipient placeholder.

1. Install the send_sms module from Odoo Apps
2. Navigate to SMS Gateway settings
3. Configure:
   • Gateway URL: https://{host}/api/http/odoo/main.ashx
   • Method: POST or GET
   • Parameters:
     • mobile = {mobile}
     • message = {message}
     • apikey = your SMSDESK API key
4. Save and test

Option 3: Custom Odoo Module

If you have a custom Odoo module, use Odoo's requests library to call the SMSDESK endpoint directly:

import requests

class SmsSms(models.Model):
    _inherit = 'sms.sms'

    def _send_sms(self, numbers, message):
        url = "https://{host}/api/http/odoo/main.ashx"
        params = {
            "apikey": "your-smsdesk-api-key",
            "number": ",".join(numbers),
            "message": message,
        }
        response = requests.post(url, data=params)
        return response.text

Code Examples

cURL (GET - form mode)

curl "https://{host}/api/http/odoo/main.ashx?apikey=your-api-key&phone=264811234567&message=Your+order+SO001+is+confirmed"

cURL (POST - form mode)

curl -X POST "https://{host}/api/http/odoo/main.ashx" \
  -d "apikey=your-api-key&mobile=264811234567&message=Your order SO001 is confirmed&sms_pid=SO001"

cURL (POST - JSON mode)

curl -X POST "https://{host}/api/http/odoo/main.ashx" \
  -H "Content-Type: application/json" \
  -d '{
    "apikey": "your-api-key",
    "number": "264811234567",
    "message": "Your order SO001 is confirmed and will be shipped tomorrow.",
    "sms_pid": "SO001"
  }'

Python (Form-encoded mode)

import requests

# Form-encoded mode (typical Odoo gateway call)
url = "https://{host}/api/http/odoo/main.ashx"
data = {
    "apikey": "your-api-key",
    "phone": "264811234567",  # eis_sms_apis uses 'phone' placeholder
    "message": "Your order SO001 is confirmed.",
    "sms_pid": "SO001"
}

response = requests.post(url, data=data)
print(response.text)
# Output: 12345:264811234567:PENDING

Python (JSON mode)

import requests

url = "https://{host}/api/http/odoo/main.ashx"
headers = {"Content-Type": "application/json"}
data = {
    "apikey": "your-api-key",
    "number": "264811234567,264812345678",
    "message": "Stock alert: Product XYZ is running low.",
    "sms_pid": "STOCK-ALERT-001"
}

response = requests.post(url, json=data, headers=headers)
print(response.json())
# {"status": "ok", "messages": [{"sms_id": "12345", "recipient": "264811234567", "status": "PENDING"}, ...]}

PHP

<?php
$url = "https://{host}/api/http/odoo/main.ashx";
$data = http_build_query([
    "apikey" => "your-api-key",
    "mobile" => "264811234567",  // send_sms module uses 'mobile'
    "message" => "Your invoice INV/2026/001 is ready. Amount: N$ 3,450.00",
    "sms_pid" => "INV-001"
]);

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
// Output: 12345:264811234567:PENDING
?>

Odoo Custom Module (Python)

from odoo import models, api
import requests

class SmsSms(models.Model):
    _inherit = 'sms.sms'

    @api.model
    def _send_sms_via_smsdesk(self, numbers, message):
        """Send SMS via SMSDESK gateway endpoint."""
        url = "https://{host}/api/http/odoo/main.ashx"
        params = {
            "apikey": self.env['ir.config_parameter'].sudo().get_param('smsdesk.api_key'),
            "number": ",".join(numbers),
            "message": message,
        }
        response = requests.post(url, data=params, timeout=30)
        return response.text

    def action_send_sms(self):
        """Override to use SMSDESK instead of IAP/Twilio."""
        numbers = [r.mobile for r in self.partner_ids if r.mobile]
        message = self.body
        result = self._send_sms_via_smsdesk(numbers, message)
        # Parse result: "12345:264811234567:PENDING"
        for line in result.split(','):
            parts = line.split(':')
            if len(parts) >= 3:
                sms_id, recipient, status = parts[0], parts[1], parts[2]
                self._update_sms_status(sms_id, status)

Official References

• Odoo SMS Marketing Documentation: odoo.com/documentation/sms_configuration — Covers IAP and Twilio setup for native SMS
• Odoo Twilio Integration: odoo.com/documentation/twilio — How to configure Twilio as SMS provider in Odoo
• Odoo Apps Store: apps.odoo.com — Search for "SMS gateway" to find third-party modules like eis_sms_apis
• Odoo Development Documentation: odoo.com/documentation/developer — For building custom SMS gateway modules

Troubleshooting

← Back to Custom Integrations