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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>Asterisk Project : Function_SMDI_MSG_RETRIEVE</title>
<link rel="stylesheet" href="styles/site.css" type="text/css" />
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
</head>
<body>
<table class="pagecontent" border="0" cellpadding="0" cellspacing="0" width="100%" bgcolor="#ffffff">
<tr>
<td valign="top" class="pagebody">
<div class="pageheader">
<span class="pagetitle">
Asterisk Project : Function_SMDI_MSG_RETRIEVE
</span>
</div>
<div class="pagesubheading">
This page last changed on Mar 30, 2011 by <font color="#0050B2">wikibot</font>.
</div>
<h1><a name="Function_SMDI_MSG_RETRIEVE-SMDIMSGRETRIEVE%28%29"></a>SMDI_MSG_RETRIEVE()</h1>
<h3><a name="Function_SMDI_MSG_RETRIEVE-Synopsis"></a>Synopsis</h3>
<p>Retrieve an SMDI message.</p>
<h3><a name="Function_SMDI_MSG_RETRIEVE-Description"></a>Description</h3>
<p>This function is used to retrieve an incoming SMDI message. It returns an ID which can be used with the SMDI_MSG() function to access details of the message. Note that this is a destructive function in the sense that once an SMDI message is retrieved using this function, it is no longer in the global SMDI message queue, and can not be accessed by any other Asterisk channels. The timeout for this function is optional, and the default is 3 seconds. When providing a timeout, it should be in milliseconds. </p>
<p>The default search is done on the forwarding station ID. However, if you set one of the search key options in the options field, you can change this behavior.</p>
<h3><a name="Function_SMDI_MSG_RETRIEVE-Syntax"></a>Syntax</h3>
<div class="preformatted panel" style="border-width: 1px;"><div class="preformattedContent panelContent">
<pre>SMDI_MSG_RETRIEVE(smdi port,search key[,timeout[,options]])</pre>
</div></div>
<h5><a name="Function_SMDI_MSG_RETRIEVE-Arguments"></a>Arguments</h5>
<ul>
<li><tt>smdi port</tt></li>
<li><tt>search key</tt></li>
<li><tt>timeout</tt></li>
<li><tt>options</tt>
<ul>
<li><tt>t</tt> - Instead of searching on the forwarding station, search on the message desk terminal.</li>
<li><tt>n</tt> - Instead of searching on the forwarding station, search on the message desk number.</li>
</ul>
</li>
</ul>
<h3><a name="Function_SMDI_MSG_RETRIEVE-SeeAlso"></a>See Also</h3>
<p><a href="Function_SMDI_MSG.html" title="Function_SMDI_MSG">Function_SMDI_MSG</a></p>
<h3><a name="Function_SMDI_MSG_RETRIEVE-ImportVersion"></a>Import Version</h3>
<p>This documentation was imported from Asterisk version SVN-branch-1.8-r311874.</p>
</td>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td height="12" background="https://wiki.asterisk.org/wiki/images/border/border_bottom.gif"><img src="images/border/spacer.gif" width="1" height="1" border="0"/></td>
</tr>
<tr>
<td align="center"><font color="grey">Document generated by Confluence on Oct 04, 2011 12:42</font></td>
</tr>
</table>
</body>
</html>
|
