<html>
<head>
<base href="https://wiki.asterisk.org/wiki">
<link rel="stylesheet" href="/wiki/s/en/2172/18/9/_/styles/combined.css?spaceKey=AST&forWysiwyg=true" type="text/css">
</head>
<body style="background: white;" bgcolor="white" class="email-body">
<div id="pageContent">
<div id="notificationFormat">
<div class="wiki-content">
<div class="email">
<h2><a href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+11+Function_DEVICE_STATE">Asterisk 11 Function_DEVICE_STATE</a></h2>
<h4>Page <b>added</b> by <a href="https://wiki.asterisk.org/wiki/display/~wikibot">Wiki Bot</a>
</h4>
<br/>
<div class="notificationGreySide">
<h1><a name="Asterisk11Function_DEVICE_STATE-DEVICESTATE%28%29"></a>DEVICE_STATE()</h1>
<h3><a name="Asterisk11Function_DEVICE_STATE-Synopsis"></a>Synopsis</h3>
<p>Get or Set a device state.</p>
<h3><a name="Asterisk11Function_DEVICE_STATE-Description"></a>Description</h3>
<p>The DEVICE_STATE function can be used to retrieve the device state from any device state provider. For example:</p>
<p>NoOp(SIP/mypeer has state ${DEVICE_STATE(SIP/mypeer)})</p>
<p>NoOp(Conference number 1234 has state ${DEVICE_STATE(MeetMe:1234)})</p>
<p>The DEVICE_STATE function can also be used to set custom device state from the dialplan. The <tt>Custom:</tt> prefix must be used. For example:</p>
<p>Set(DEVICE_STATE(Custom:lamp1)=BUSY)</p>
<p>Set(DEVICE_STATE(Custom:lamp2)=NOT_INUSE)</p>
<p>You can subscribe to the status of a custom device state using a hint in the dialplan:</p>
<p>exten => 1234,hint,Custom:lamp1</p>
<p>The possible values for both uses of this function are:</p>
<p>UNKNOWN | NOT_INUSE | INUSE | BUSY | INVALID | UNAVAILABLE | RINGING | RINGINUSE | ONHOLD</p>
<h3><a name="Asterisk11Function_DEVICE_STATE-Syntax"></a>Syntax</h3>
<div class="preformatted panel" style="border-width: 1px;"><div class="preformattedContent panelContent">
<pre>DEVICE_STATE(device)</pre>
</div></div>
<h5><a name="Asterisk11Function_DEVICE_STATE-Arguments"></a>Arguments</h5>
<ul>
<li>device</li>
</ul>
<h3><a name="Asterisk11Function_DEVICE_STATE-ImportVersion"></a>Import Version</h3>
<p>This documentation was imported from Asterisk Version SVN-trunk-r370322</p>
</div>
<div id="commentsSection" class="wiki-content pageSection">
<div style="float: right;" class="grey">
<a href="https://wiki.asterisk.org/wiki/users/removespacenotification.action?spaceKey=AST">Stop watching space</a>
<span style="padding: 0px 5px;">|</span>
<a href="https://wiki.asterisk.org/wiki/users/editmyemailsettings.action">Change email notification preferences</a>
</div>
<a href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+11+Function_DEVICE_STATE">View Online</a>
|
<a href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+11+Function_DEVICE_STATE?showComments=true&showCommentArea=true#addcomment">Add Comment</a>
</div>
</div>
</div>
</div>
</div>
</body>
</html>