302 lines
8.1 KiB
HTML
302 lines
8.1 KiB
HTML
<!-- title: SMS Settings -->
|
|
|
|
|
|
|
|
|
|
|
|
<div class="dev-header">
|
|
|
|
<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
|
|
Version 6.x.x</a>
|
|
|
|
|
|
<a class="btn btn-default btn-sm" href="https://github.com/frappe/erpnext/tree/develop/erpnext/setup/doctype/sms_settings"
|
|
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a>
|
|
|
|
</div>
|
|
|
|
<span class="label label-info">Single</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Fields</h3>
|
|
|
|
<table class="table table-bordered">
|
|
<thead>
|
|
<tr>
|
|
<th style="width: 5%">Sr</th>
|
|
<th style="width: 25%">Fieldname</th>
|
|
<th style="width: 20%">Type</th>
|
|
<th style="width: 25%">Label</th>
|
|
<th style="width: 25%">Options</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr >
|
|
<td>1</td>
|
|
<td ><code>column_break0</code></td>
|
|
<td class="info">
|
|
Column Break</td>
|
|
<td >
|
|
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>2</td>
|
|
<td class="danger" title="Mandatory"><code>sms_gateway_url</code></td>
|
|
<td >
|
|
Data</td>
|
|
<td >
|
|
SMS Gateway URL
|
|
<p class="text-muted small">
|
|
Eg. smsgateway.com/api/send_sms.cgi</p>
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>3</td>
|
|
<td class="danger" title="Mandatory"><code>message_parameter</code></td>
|
|
<td >
|
|
Data</td>
|
|
<td >
|
|
Message Parameter
|
|
<p class="text-muted small">
|
|
Enter url parameter for message</p>
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>4</td>
|
|
<td class="danger" title="Mandatory"><code>receiver_parameter</code></td>
|
|
<td >
|
|
Data</td>
|
|
<td >
|
|
Receiver Parameter
|
|
<p class="text-muted small">
|
|
Enter url parameter for receiver nos</p>
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>5</td>
|
|
<td ><code>sms_sender_name</code></td>
|
|
<td >
|
|
Data</td>
|
|
<td >
|
|
SMS Sender Name
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>6</td>
|
|
<td ><code>static_parameters_section</code></td>
|
|
<td class="info">
|
|
Column Break</td>
|
|
<td >
|
|
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>7</td>
|
|
<td ><code>parameters</code></td>
|
|
<td >
|
|
Table</td>
|
|
<td >
|
|
Static Parameters
|
|
<p class="text-muted small">
|
|
Enter static url parameters here (Eg. sender=ERPNext, username=ERPNext, password=1234 etc.)</p>
|
|
</td>
|
|
<td>
|
|
|
|
|
|
|
|
|
|
<a href="https://frappe.github.io/erpnext/current/models/setup/sms_parameter">SMS Parameter</a>
|
|
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<hr>
|
|
<h3>Controller</h3>
|
|
<h4>erpnext.setup.doctype.sms_settings.sms_settings</h4>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 style="font-weight: normal;">Class <b>SMSSettings</b></h3>
|
|
|
|
<p style="padding-left: 30px;"><i>Inherits from frappe.model.document.Document</i></h4>
|
|
|
|
<div class="docs-attr-desc"><p></p>
|
|
</div>
|
|
<div style="padding-left: 30px;">
|
|
|
|
</div>
|
|
<hr>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="erpnext.setup.doctype.sms_settings.sms_settings.create_sms_log" href="#erpnext.setup.doctype.sms_settings.sms_settings.create_sms_log" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
erpnext.setup.doctype.sms_settings.sms_settings.<b>create_sms_log</b>
|
|
<i class="text-muted">(args, sent_to)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p><span class="label label-info">Public API</span>
|
|
<br><code>/api/method/erpnext.setup.doctype.sms_settings.sms_settings.get_contact_number</code>
|
|
</p>
|
|
<p class="docs-attr-name">
|
|
<a name="erpnext.setup.doctype.sms_settings.sms_settings.get_contact_number" href="#erpnext.setup.doctype.sms_settings.sms_settings.get_contact_number" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
erpnext.setup.doctype.sms_settings.sms_settings.<b>get_contact_number</b>
|
|
<i class="text-muted">(contact_name, value, key)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>returns mobile number of the contact</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="erpnext.setup.doctype.sms_settings.sms_settings.get_sender_name" href="#erpnext.setup.doctype.sms_settings.sms_settings.get_sender_name" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
erpnext.setup.doctype.sms_settings.sms_settings.<b>get_sender_name</b>
|
|
<i class="text-muted">()</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p>returns name as SMS sender</p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="erpnext.setup.doctype.sms_settings.sms_settings.scrub_gateway_url" href="#erpnext.setup.doctype.sms_settings.sms_settings.scrub_gateway_url" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
erpnext.setup.doctype.sms_settings.sms_settings.<b>scrub_gateway_url</b>
|
|
<i class="text-muted">(url)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="erpnext.setup.doctype.sms_settings.sms_settings.send_request" href="#erpnext.setup.doctype.sms_settings.sms_settings.send_request" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
erpnext.setup.doctype.sms_settings.sms_settings.<b>send_request</b>
|
|
<i class="text-muted">(gateway_url, args)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p><span class="label label-info">Public API</span>
|
|
<br><code>/api/method/erpnext.setup.doctype.sms_settings.sms_settings.send_sms</code>
|
|
</p>
|
|
<p class="docs-attr-name">
|
|
<a name="erpnext.setup.doctype.sms_settings.sms_settings.send_sms" href="#erpnext.setup.doctype.sms_settings.sms_settings.send_sms" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
erpnext.setup.doctype.sms_settings.sms_settings.<b>send_sms</b>
|
|
<i class="text-muted">(receiver_list, msg, sender_name=)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="erpnext.setup.doctype.sms_settings.sms_settings.send_via_gateway" href="#erpnext.setup.doctype.sms_settings.sms_settings.send_via_gateway" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
erpnext.setup.doctype.sms_settings.sms_settings.<b>send_via_gateway</b>
|
|
<i class="text-muted">(arg)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="erpnext.setup.doctype.sms_settings.sms_settings.validate_receiver_nos" href="#erpnext.setup.doctype.sms_settings.sms_settings.validate_receiver_nos" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
erpnext.setup.doctype.sms_settings.sms_settings.<b>validate_receiver_nos</b>
|
|
<i class="text-muted">(receiver_list)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- autodoc -->
|
|
<!-- jinja -->
|
|
<!-- static --> |