sms.composer: fields, relations and API
The sms.composer model ("Send SMS Wizard") is a transient model declared by the SMS gateway module, then extended by 2 other modules. It exposes 30 fields, 24 of them declared directly on the model. Below you will find every field with its technical name, type, label and relations, followed by an Odoo 19 JSON-2 API call.
Model identity
- Technical name
sms.composer- Label
- Send SMS Wizard
- Type
- Transient (models.TransientModel)
- SQL table
sms_composer- Origin module
- SMS gateway (
sms) - Extended by
- mass_mailing_sms, sms_twilio
Model fields
24 own fields, 0 inherited from mixins and 6 automatic ORM fields. Click a name to get a direct link to that field.
30 of 30 fields shown
| Technical name | Label | Type | Details |
|---|---|---|---|
| body | Message | text | requiredcomputed, stored |
| comment_single_recipient | Single Mode Indicates if the SMS composer targets a single specific recipient | boolean | computed |
| composition_mode | Composition Mode | selection | requiredcomputed, stored Values: |
| mailing_id | Mailing | many2one | added by SMS Marketing ( |
| mass_force_send | Send directly | boolean | |
| mass_keep_log | Keep a note on document | boolean | |
| mass_sms_allow_unsubscribe | Include opt-out link | boolean | added by SMS Marketing ( |
| number_field_name | Number Field | char | |
| numbers | Recipients (Numbers) | char | |
| recipient_invalid_count | # Invalid recipients | integer | computed |
| recipient_single_description | Recipients (Partners) | text | computed |
| recipient_single_number | Stored Recipient Number | char | computed |
| recipient_single_number_itf | Recipient Number Phone number of the recipient. If changed, it will be recorded on recipient's profile. | char | computed, stored |
| recipient_single_valid | Is valid | boolean | computed |
| recipient_valid_count | # Valid recipients | integer | computed |
| res_id | Document ID | integer | |
| res_ids | Document IDs | char | |
| res_ids_count | Visible records count Number of recipients that will receive the SMS if sent in mass mode, without applying the Active Domain value | integer | computed |
| res_model | Document Model Name | char | |
| res_model_description | Document Model Description | char | computed |
| sanitized_numbers | Sanitized Number | char | computed |
| template_id | Use Template | many2one | |
| use_exclusion_list | Use Exclusion List Prevent sending messages to blacklisted contacts. Disable only when absolutely necessary. | boolean | |
| utm_campaign_id | Campaign | many2one | added by SMS Marketing ( |
| create_date | Created on | datetime | read-onlyautomatic |
| create_uid | Created by | many2one | read-onlyautomatic |
| display_name | Display Name | char | read-onlycomputedautomatic |
| id | ID | integer | read-onlyautomatic |
| write_date | Last Updated on | datetime | read-onlyautomatic |
| write_uid | Last Updated by | many2one | read-onlyautomatic |
Relations
Models linked from this model
- mailing.mailing: mailing_id
- sms.template: template_id
- utm.campaign: utm_campaign_id
Fields of other models pointing here
No Many2one or Many2many field of another model points to this model.
Reading this model through the API
Odoo 19 JSON-2 API call reading the first five records with real fields of the model. Replace the instance, database and API key with your own.
curl -X POST "https://your-instance.odoo.com/json/2/sms.composer/search_read" \
-H "Authorization: bearer $ODOO_API_KEY" \
-H "X-Odoo-Database: your-db" \
-H "Content-Type: application/json" \
-d '{"domain":[],"fields":["body","composition_mode","mailing_id","template_id","utm_campaign_id"],"limit":5}'import requests
BASE_URL = "https://your-instance.odoo.com/json/2"
headers = {"Authorization": f"bearer {API_KEY}", "X-Odoo-Database": "your-db"}
res = requests.post(
f"{BASE_URL}/sms.composer/search_read",
headers=headers,
json={"domain": [], "fields": ["body","composition_mode","mailing_id","template_id","utm_campaign_id"], "limit": 5},
)
res.raise_for_status()
print(res.json())- External API access requires Odoo's Custom plan.
- XML-RPC and JSON-RPC will be removed in Odoo 22 (fall 2028): use JSON-2.
- The access rights and record rules of the key's user apply.
Cite this tool
Writing a tutorial, internal documentation or a forum answer? Copy this link to send your readers to the up-to-date reference.
<a href="https://aidoo.ai/en/outils/explorateur-modeles-odoo/sms-composer">sms.composer (Odoo 19.0)</a>Sources
Data verified on September 23, 2026 · Odoo 19.0 Community
Have an Odoo project, or want to put your ERP to work with AI? Let's talk
Implementation, custom module development, connecting Claude or ChatGPT to your data: tell us about your context and we will reply within 24 business hours.