<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_PRESENCE_STATE">Asterisk 11 Function_PRESENCE_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_PRESENCE_STATE-PRESENCESTATE%28%29"></a>PRESENCE_STATE()</h1>
<h3><a name="Asterisk11Function_PRESENCE_STATE-Synopsis"></a>Synopsis</h3>
<p>Get or Set a presence state.</p>
<h3><a name="Asterisk11Function_PRESENCE_STATE-Description"></a>Description</h3>
<p>The PRESENCE_STATE function can be used to retrieve the presence from any presence provider. For example:</p>
<p>NoOp(SIP/mypeer has presence ${PRESENCE_STATE(SIP/mypeer,value)})</p>
<p>NoOp(Conference number 1234 has presence message ${PRESENCE_STATE(MeetMe:1234,message)})</p>
<p>The PRESENCE_STATE function can also be used to set custom presence state from the dialplan. The <tt>CustomPresence:</tt> prefix must be used. For example:</p>
<p>Set(PRESENCE_STATE(CustomPresence:lamp1)=away,temporary,Out to lunch)</p>
<p>Set(PRESENCE_STATE(CustomPresence:lamp2)=dnd,,Trying to get work done)</p>
<p>You can subscribe to the status of a custom presence state using a hint in the dialplan:</p>
<p>exten => 1234,hint,CustomPresence:lamp1</p>
<p>The possible values for both uses of this function are:</p>
<p>not_set | unavailable | available | away | xa | chat | dnd</p>
<h3><a name="Asterisk11Function_PRESENCE_STATE-Syntax"></a>Syntax</h3>
<div class="preformatted panel" style="border-width: 1px;"><div class="preformattedContent panelContent">
<pre>PRESENCE_STATE(provider,field[,options])</pre>
</div></div>
<h5><a name="Asterisk11Function_PRESENCE_STATE-Arguments"></a>Arguments</h5>
<ul>
<li>provider - The provider of the presence, such as <tt>CustomPresence</tt></li>
<li>field - Which field of the presence state information is wanted.
<ul>
<li>value - The current presence, such as <tt>away</tt></li>
<li>subtype - Further information about the current presence</li>
<li>message - A custom message that may indicate further details about the presence</li>
</ul>
</li>
<li>options
<ul>
<li>e - Base-64 encode the data.</li>
</ul>
</li>
</ul>
<h3><a name="Asterisk11Function_PRESENCE_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_PRESENCE_STATE">View Online</a>
|
<a href="https://wiki.asterisk.org/wiki/display/AST/Asterisk+11+Function_PRESENCE_STATE?showComments=true&showCommentArea=true#addcomment">Add Comment</a>
</div>
</div>
</div>
</div>
</div>
</body>
</html>