5.1 Global Settings (General Settings)

Menu path:

• Settings → General Settings → SMS

Settings (stored as system parameters):

• Use IAP (sms.use_iap) * Default: False * Effect:

  • When enabled, Odoo uses IAP for all SMS and ignores custom gateways.

• Default Gateway (sms.sms_gateway_id) * Default: empty * Effect:

  • Used when no country prefix matches the destination number.

• IAP Fallback (sms.iap_fallback) * Default: False * Effect:

  • When enabled and no gateway is found for a recipient, Odoo falls back to IAP (instead of failing).
  • This setting only applies when Use IAP is disabled.

Advanced (system parameter, no UI field):

• sms.default_success_200 * Default: False * Effect:

  • If enabled, a gateway response with HTTP 200/201/202 can be treated as Success in some “unclear” cases.

5.2 SMS Gateway Records

Menu path:

• Settings → Technical → SMS / Phone → SMS Gateways

Model: sms.gateway

Core fields:

• Gateway Name (name) — Display name for the gateway.
• Priority (sequence) — Lower number = higher priority.
• Active (active) — Archive/unarchive the gateway.
• State (state) — New, Active, or Disabled (used in routing).

API Settings (page API Settings):

• Service Doc Link (gateway_documentation_link) — Provider documentation URL.
• Base URL (base_url) — Endpoint URL (placeholders are supported).
• Country Prefixes (country_prefixes) — Comma-separated prefixes (example: +1,+92,0091).
• HTTP Method (method) — GET or POST.
• Request Type (request_type) — For POST: Form Data or JSON.
• Supports Multiple Recipients (supports_multiple_recipients)
• Recipient Separator (multi_recipient_separator) — Used when sending multiple numbers in one request.
• Message ID Regex (message_id_regex) — Extract provider message id from response text (enables callback matching when UUID is not returned).
• Success HTTP Codes (success_http_codes) — Comma-separated list (default includes 200/201/202).
• Success Substring (success_substring) — If present in response body, treat as success.
• Track Status (create_status) — Store status rows for each SMS.

Authentication (page Authentication):

• Authentication Type (auth_type): None / API Key / Token / Basic / Custom
• Credentials (depending on auth type): * API Key (api_key) * Token (token) * Username (username) * Password (password)

Parameters (page Parameters):

Model: sms.gateway.parameter

• Key (key) — parameter name (e.g. to / text).
• Value (value) — can include placeholders.
• Parameter Type (param_type) — controls how Odoo fills values (number, multi-number, message, auth, other).

Headers (page Headers):

Model: sms.gateway.header

• Key (key) — header name (e.g. Authorization).
• Value (value) — can include placeholders (example: Bearer {token}).

JSON Body (page JSON Body, visible when Request Type = JSON):

• JSON Body Template (body_template)
• Supports placeholders such as {phone}, {phones}, {message}, {api_key}, {token}, {username}, {password}
• Also supports typed tokens inside JSON values: * __phone__, __phones_list__, __message__, __api_key__, __token__, __username__, __password__

Status (page Status, visible when Track Status is enabled):

• Success Key (success_key) — optional legacy marker string.
• Error Key (error_key) — optional legacy marker string.
• SMS Statuses (sms_status_ids) — status rows linked to this gateway.

Request Preview (page Request Preview):

• Request Preview (request_preview) — computed preview of the request.

Delivery Callbacks (page Delivery Callbacks):

• Delivery Callback Enabled (delivery_callback_enabled)
• Callback URL (delivery_callback_url) — generated using your base URL + token.
• Callback Token (delivery_callback_token)
• Callback payload keys: * UUID Param (delivery_callback_uuid_param) — default uuid * Message ID Param (delivery_callback_message_id_param) — default message_id * Status Param (delivery_callback_status_param) — default status * Error Code Param (delivery_callback_error_code_param) * Error Message Param (delivery_callback_error_message_param)
• Status mapping (comma-separated values): * Success Values (delivery_callback_status_success) * Pending Values (delivery_callback_status_pending) * Error Values (delivery_callback_status_error) * Canceled Values (delivery_callback_status_canceled)
• Failure code mapping (model sms.gateway.callback.failure.map): * Provider Code (provider_code) * Failure Type (failure_type) — mapped to Odoo’s SMS failure types

6.1 Configure or duplicate a gateway template

1. Go to Settings → Technical → SMS / Phone → SMS Gateways.
2. Open a template gateway (State will typically be New).
3. Duplicate the gateway (recommended) so updates/templates don’t override your credentials.
4. Configure: * Base URL * Authentication (token/api key/basic) * Parameters / Headers / JSON body * Country Prefixes (optional but recommended)
5. Set State to Active.

6.2 Configure global routing behavior

1. Go to Settings → General Settings → SMS.
2. Disable Use IAP to route via gateways.
3. Set a Default Gateway (recommended).
4. Optionally enable IAP Fallback.
5. Save.

6.3 Send an SMS from Odoo

Send SMS using Odoo’s standard features (provided by the sms module), for example from a Contact or any document that offers SMS.

At send time, routing works as follows:

1. If Use IAP is enabled → IAP is used.
2. Otherwise, Odoo selects the first Active gateway whose Country Prefixes match the phone number (lowest sequence wins).
3. If no match exists: * Use Default Gateway if set, otherwise the first active gateway by sequence.
4. If no gateway exists and IAP Fallback is enabled → IAP is used.

6.4 Monitor results per gateway

1. Open the gateway record.
2. Use the smart buttons: * Total SMS * Sent SMS * Failed SMS
3. Review response text/HTTP code and the extracted provider message id (if configured).

7.1 Menus

• Settings → Technical → SMS / Phone → SMS Gateways

7.2 Buttons (header buttons, smart buttons)

On the SMS Gateway form:

• Toggle State (header) — cycles state: New → Active → Disabled → Active.
• Archive/Unarchive (button box) — toggles the active field (standard Odoo behavior).
• Docs Link (button box, when a link exists) — opens gateway_documentation_link in a new window/tab.
• Total SMS — opens status rows for this gateway.
• Sent SMS — opens status rows where State = Success.
• Failed SMS — opens status rows where State ∈ (Error, Server Error).

7.3 Forms, notebooks, and info panels

SMS Gateway form notebook pages:

• API Settings
• Authentication
• Parameters
• Headers
• JSON Body (only when POST + JSON)
• Status (only when Track Status is enabled)
• Request Preview
• Delivery Callbacks

8.1 Scheduled actions / cron jobs

This module does not add scheduled actions (cron jobs) by default.

8.2 Delivery callback endpoint

If Delivery Callback Enabled is enabled on a gateway, you can configure your provider to call the generated URL.

Endpoint pattern:

• /eis_sms/callback/<token>

Notes:

• The endpoint accepts GET or POST.
• Payload fields are mapped using the gateway’s Delivery Callback configuration (UUID param, status param, etc.).
• If the provider does not send the Odoo UUID back, configure Message ID Regex so the module can store a provider message id and match callbacks later.