usecallmanager.pingleware.work/dial-template.html at master · pingleware/usecallmanager.pingleware.work · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
<!DOCTYPE html>
<html lang="en">
  <head>
    <title>Dial Template</title>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width,initial-scale=1,shrink-to-fit=no">
    <link rel="shortcut icon" href="images/logo.svg">
    <link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Roboto">
    <link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:FILL@0..1">
    <link rel="stylesheet" href="includes/theme.css">
    <link rel="stylesheet" href="includes/prettify.css">
    <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script>
    <script src="includes/prettify.js"></script>
    <script>
      jQuery(window).on("load", function () {
          prettyPrint();
      });
    </script>
  </head>
  <body>
    <header>
      <a href="/"><img src="images/logo.svg" alt=""></a>
      <h2>&lt;<span>proxy</span>&gt;</h2><h1><span>USECALLMANAGER</span>.nz</h1><h2>&lt;/<span>proxy</span>&gt;</h2>
    </header>
    <main>
      <nav>
        <ul>
          <li><a href="documentation-overview.html"><span class="icon">home</span> Documentation Overview</a></li>
          <li><a href="patching-asterisk.html"><span class="icon">build</span> Patching Asterisk</a></li>
          <li><a href="change-log.html"><span class="icon">news</span> Change Log</a></li>
        </ul>
        <ul>
          <li><h3>Network Configuration</h3></li>
          <li><a href="dhcp-options.html"><span class="icon">settings_ethernet</span> DHCP Options</a></li>
          <li><a href="http-provisioning.html"><span class="icon">file_download</span> HTTP Provisioning</a></li>
          <li><a href="tftp-provisioning.html"><span class="icon">file_download</span> TFTP Provisioning</a></li>
        </ul>
        <ul>
          <li><h3>Phone Configuration</h3></li>
          <li><a href="sepmac-cnf-xml.html"><span class="icon">settings_phone</span> SEPMAC.cnf.xml</a></li>
          <li><span class="icon selected">dialpad</span> <b>Dial Template</b></li>
          <li><a href="application-dial-rules.html"><span class="icon">bluetooth</span> Application Dial Rules</a></li>
          <li><a href="soft-keys.html"><span class="icon">power_input</span> Soft Keys</a></li>
          <li><a href="line-keys.html"><span class="icon">format_list_bulleted</span> Line Keys</a></li>
          <li><a href="feature-policy.html"><span class="icon">fact_check</span> Feature Policy</a></li>
          <li><a href="network-locale.html"><span class="icon">language</span> Network Locale</a></li>
          <li><a href="user-locale.html"><span class="icon">face</span> User Locale</a></li>
          <li><a href="load-information.html"><span class="icon">file_upload</span> Firmware Load Information</a></li>
          <li><a href="background-images.html"><span class="icon">wallpaper</span> Background Images</a></li>
          <li><a href="ring-tones.html"><span class="icon">ring_volume</span> Ring Tones</a></li>
          <li><a href="device-security.html"><span class="icon">security</span> Device Security</a></li>
          <li><a href="trust-verification.html"><span class="icon">verified</span> Trust Verification</a></li>
          <li><a href="certificate-enrollment.html"><span class="icon">card_membership</span> Certificate Enrollment</a></li>
          <li><a href="vpn-connection.html"><span class="icon">vpn_key</span> VPN Connection</a></li>
        </ul>
        <ul>
          <li><h3>Asterisk Configuration</h3></li>
          <li><a href="sip-peers.html"><span class="icon">dialer_sip</span> SIP Peers</a></li>
          <li><a href="sip-notify-commands.html"><span class="icon">settings_power</span> SIP Notify Commands</a></li>
          <li><a href="dialplan-extensions.html"><span class="icon">format_list_numbered</span> Dialplan Extensions</a></li>
          <li><a href="call-parking.html"><span class="icon">local_parking</span> Call Parking</a></li>
          <li><a href="sip-peer-options.html"><span class="icon">code</span> SIPPEER Options</a></li>
          <li><a href="rtp-streaming.html"><span class="icon">volume_up</span> RTP Streaming</a></li>
          <li><a href="command-line.html"><span class="icon">keyboard_arrow_right</span> Command Line</a></li>
          <li><a href="freepbx-integration.html"><span class="icon">view_kanban</span> FreePBX Integration</a></li>
        </ul>
        <ul>
          <li><h3>XML Services</h3></li>
          <li><a href="phone-services.html"><span class="icon">settings</span> Phone Services</a></li>
          <li><a href="cgi-execute.html"><span class="icon">phone_forwarded</span> CGI Execute</a></li>
        </ul>
        <ul>
          <li><h3>Additional Features</h3></li>
          <li><a href="as-feature-events.html"><span class="icon">extension</span> AS Feature Events</a></li>
        </ul>
      </nav>
      <article>
        <h1>Dial Template</h1>
        Dial templates control what number patterns are valid and how many seconds to wait for extra digits before dialing. File is specified by &lt;<code class="tag">dialTemplate</code>&gt; in <a href="sepmac-cnf-xml.html#dialTemplate">SEPMAC.cnf.xml</a>.<br>
        <br>
        <code class="prettify lang-xml">&lt;dialTemplate&gt;
  &lt;versionStamp&gt;e68d54c1-0354-4b1a-aca4-adffc4b7de2f&lt;/versionStamp&gt;</code>
        <br>
        <h2 id="TEMPLATE">TEMPLATE <a href="#TEMPLATE" title="Link">link</a></h2>
        Specifies a pattern to match dialed digits against. <b>Note</b>: &lt;<code class="tag">TEMPLATE</code>&gt; must be in uppercase.<br>
        <br>
        <table>
          <tbody>
            <tr>
              <td><b>match</b></td>
              <td>Pattern to match, consists of one or more elements</td>
            </tr>
            <tr>
              <td></td>
              <td>
                <table>
                  <tbody>
                    <tr>
                      <td><b>0 1 2 3 4 5 6 7 8 9</b></td>
                      <td>Match digit</td>
                    </tr>
                    <tr>
                      <td><b>#</b></td>
                      <td>Match a literal <code class="literal">#</code></td>
                    </tr>
                    <tr>
                      <td><b>.</b></td>
                      <td>Match one digit, <code class="literal">#</code> or <code class="literal">*</code></td>
                    </tr>
                    <tr>
                      <td><b>*</b></td>
                      <td>Match zero or more digits, <code class="literal">#</code> or <code class="literal">*</code></td>
                    </tr>
                    <tr>
                      <td><b>\*</b></td>
                      <td>Match a literal <code class="literal">*</code></td>
                    </tr>
                    <tr>
                      <td><b>,</b></td>
                      <td>Play secondary dial-tone specified by <code class="literal">tone</code></td>
                    </tr>
                  </tbody>
                </table>
              </td>
            </tr>
            <tr>
              <td><b>timeout</b></td>
              <td>Number of seconds to wait for more digits if this pattern matches</td>
            </tr>
            <tr>
              <td><b>line</b></td>
              <td>Only apply template to the specified line (optional)</td>
            </tr>
            <tr>
              <td><b>rewrite</b></td>
              <td>Rewrite the matched digits before dialing, consists of one or more elements (optional)</td>
            </tr>
            <tr>
              <td></td>
              <td>
                <table>
                  <tbody>
                    <tr>
                      <td><b>0 1 2 3 4 5 6 7 8 9</b></td>
                      <td>Replace with digit</td>
                    </tr>
                    <tr>
                      <td><b>.</b></td>
                      <td>Each <code class="literal">.</code> is replaced by the digit that was matched by the corresponding <code class="literal">.</code> in the pattern</td>
                    </tr>
                    <tr>
                      <td><b>%0</b></td>
                      <td>The entire match</td>
                    </tr>
                    <tr>
                      <td><b>%1 %2 %3 %4 %5</b></td>
                      <td>Replace with group of digits matched, grouping is done by consecutive literal digit or <code class="literal">.</code> elements</td>
                    </tr>
                    <tr>
                      <td><b>%%</b></td>
                      <td>A literal <code class="literal">%</code></td>
                    </tr>
                    <tr>
                      <td><b>%.</b></td>
                      <td>A literal <code class="literal">.</code></td>
                    </tr>
                  </tbody>
                </table>
              </td>
            </tr>
            <tr>
              <td><b>tone</b></td>
              <td>Secondary dial-tone to play when a <code class="literal">,</code> is matched, up to <code class="literal">3</code> can be specified (optional)</td>
            </tr>
            <tr>
              <td></td>
              <td>
                <table>
                  <tbody>
                    <tr>
                      <td><b>Bellcore-Inside</b></td>
                      <td class="vertical-rule"><b>Bellcore-Outside</b></td>
                      <td class="vertical-rule"><b>Bellcore-Busy</b></td>
                      <td class="vertical-rule"><b>Bellcore-Reorder</b></td>
                      <td class="vertical-rule"><b>Bellcore-CallWaiting</b></td>
                    </tr>
                    <tr>
                      <td><b>Bellcore-Hold</b></td>
                      <td class="vertical-rule"><b>Bellcore-Reminder</b></td>
                      <td class="vertical-rule"><b>Bellcore-Confirmation</b></td>
                      <td class="vertical-rule"><b>Bellcore-Permanent</b></td>
                      <td class="vertical-rule"><b>Bellcore-None</b></td>
                    </tr>
                    <tr>
                      <td><b>Cisco-Zip</b></td>
                      <td class="vertical-rule"><b>Cisco-ZipZip</b></td>
                      <td class="vertical-rule"><b>Cisco-BeepBonk</b></td>
                    </tr>
                  </tbody>
                </table>
              </td>
            </tr>
          </tbody>
        </table>
        <br>
        <code class="prettify lang-xml">  &lt;TEMPLATE match="3.." timeout="1" /&gt;
  &lt;TEMPLATE match=&quot;...&quot; timeout=&quot;2&quot; /&gt;
  &lt;TEMPLATE match=&quot;.......&quot; timeout=&quot;2&quot; /&gt;
  &lt;TEMPLATE match=&quot;0........&quot; timeout=&quot;2&quot; /&gt;
  &lt;TEMPLATE match=&quot;*&quot; timeout=&quot;3&quot; /&gt;
&lt;/dialTemplate&gt;</code>
        <br>
        <h2 id="Hotline">Hotline <a href="#Hotline" title="Link">link</a></h2>
        To create a line that automatically dials a number when the phone goes off-hook use an empty pattern with a timeout of <code class="literal">0</code> and <code class="literal">rewrite</code> containing the number to dial.<br>
        <br>
        <code class="prettify lang-xml">&lt;dialTemplate&gt;
  &lt;TEMPLATE match=&quot;&quot; timeout=&quot;0&quot; rewrite=&quot;300&quot; /&gt;
&lt;/dialTemplate&gt;</code>
        <br>
        <h2 id="Intercom">Intercom <a href="#Intercom" title="Link">link</a></h2>
        Similar to a hotline, automatically dials an extension only for the Intercom line. The <code class="literal">line</code> attribute must match the <code class="literal">lineIndex</code> specified in <a href="sepmac-cnf-xml.html#line">SEPMAC.cnf.xml</a>.<br>
        <br>
        <code class="prettify lang-xml">&lt;dialTemplate&gt;
  ...
  &lt;TEMPLATE match=&quot;&quot; timeout=&quot;0&quot; rewrite=&quot;390&quot; line=&quot;2&quot; /&gt;
&lt;/dialTemplate&gt;</code>
      </article>
    </main>
    <footer>
      <span class="icon">copyright</span> Gareth Palmer and individual contributors. Documentation distributed under <a href="LICENSE">CC BY 4.0</a>.
    </footer>
  </body>
</html>