<!-- If the browser does not support frames put the first topic content here --> <div class="WordSection1"> <div style='border:none;border-bottom:solid #4F81BD 1.0pt;padding:0in 0in 4.0pt 0in'> <p class="MsoTitle" align="center" style='text-align:center'><span class="Heading1Char"><span style='font-size:14.0pt'>Mizu VoIP Server API</span></span><span style='font-size:22.0pt'> </span></p> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <h3><a name="node15" id="node15"></a>Overview</h3> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>This document describes the Mizutech <a href="https://www.mizu-voip.com/Software/VoIPServer.aspx">VoIP server</a> public API.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>The mizu sever API allows a client program to connect to a server instance and issue commands not covered by the SIP protocol.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>The API can accept commands and send answers in various format defined by the request or the “format” parameter.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Supported <b>transport protocols</b>: </p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>UDP (up to 1490 bytes packet size)</p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>TCP (requests must be ended by CR/LF) </p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>TLS (if enabled)</p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>HTTP (1.0 or 1.1)</p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>HTTPS (if TLS is enabled)</p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>websocket (URI must contain “mvstwebsock”. Then send the request in websocket as you would send in HTTP URI)</p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>secure websocket (on port 443 if TLS is enabled)</p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>Tunnel (if encryption/tunneling is enabled)</p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>SIP (via special header if enabled)</p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>SMS (some commands are available also through SMS: p2p, cb, balance, rating, charge, cli. The SMS text must contain the parameters) </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>The API can be used by endusers or to implement various functionalities from:</p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>Any web application (from client side JavaScript using the HTTP transport or server side script such as PHP or .NET)</p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>Any mobile or desktop application</p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>Manually (for example via telnet, curl or browser)</p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>Test from your browser (just copy the API request to your browser URL input box and hit the Enter button)</p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>MManage -> Server Console form (all API commands can be sent also here, but without the authentication parameters as all commands from here will be authenticated as admin requests)</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>The API is listening by default on <b>port 80</b> for both UDP and TCP/HTTP/websocket (can be changed with the “mainaport” global config option or disabled by setting the “usemainaport” to false).</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>A simple key/value protocol is utilized for the request with the following parts:</p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>the “mvapireq” entry point string has to be used with all requests. A fix string as “mvapireq”.</p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>apientry (name of the API function such as “sms”, “balance”). See the “API list” section below.</p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>authentication parameters (“authid” and “authpwd” or “authmd5”/”authsalt”). See the “Authentication” section below.</p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>function parameters (such as “anum”, “bnum”, “txt”, “param1” , “param2”). See the “Parameters” section below.</p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; line-height:normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Supported data <b>format</b>s: </p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>plain text</p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>URL parameters (usually with HTTP GET: http://SERVER/mvapireq/?apientry=function&parameter1=value1)</p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>parameters in http body (usually with HTTP POST)</p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>HTML form (submit)</p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>Ini format (key=value)</p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>XML</p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>SOAP (SOAP+XML)</p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>RDF</p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>JSON</p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>JSONP (<span lang="HU">http://SERVERADDRESS/mvapireq/jppget?url=...)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>For the <b>response</b> a code and/or a text is sent:</p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>code: 200 means success, 499 means failure</p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>text: all answers are suffixed with either “ERROR” or “OK”</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoListParagraph" style='margin-bottom:0in;margin-bottom:.0001pt; line-height:normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>By default the answer format is guessed from the request, unless it is specified by the “format” parameter which can be set to one of the followings (string in lower case):</p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>text</p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>cleartext</p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>html</p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>xml</p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>soap</p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>json</p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>jsonp (will respond with javascript callback code)</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>If the httpstrictresponse is set to 1, then the response code is sent as html answer code (otherwise you will receive HTTP 200 OK for all requests and the real API response code will be in the message body).</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>You can also use the <a href="http://www.mizu-voip.com/Portals/0/Files/HTTP_interface.pdf">old API</a> over this new (all functions in the old API should work as is).</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <h3><a name="node16" id="node16"></a>Examples</h3> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>The examples below are for HTTP GET with URL parameters (however you can also use JSON, XML and other formats). Change domain.com to your server address:port and use valid values for authentication and for the parameters. In these examples we are using authkey + authid/authmd5 based authentication, however you might use others as described below in the “Authentication” section. KEY means the apiv2key global config setting.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806'>Note: You can generate exact examples valid for your server from MManage -> Tools -> Utilities -> Generate API examples menu.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>API test (this is the simplest example without authentication requirements):</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><a href="http://domain.com/mvapireq/?apientry=apitest1">http://domain.com/mvapireq/?apientry=apitest1</a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Request user credit if set as public with no apiv2key set (not recommended in production):</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><a href="http://domain.com/mvapireq/?apientry=balance&authid=USRNAME">http://domain.com/mvapireq/?apientry=balance&authid=USRNAME</a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Request user credit with password in clear text (not recommended in production):</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><a href="http://domain.com/mvapireq/?apientry=balance&authkey=KEY&authid=USRNAME&authpwd=PASSWORD">http://domain.com/mvapireq/?apientry=balance&authkey=KEY&authid=USRNAME&authpwd=PASSWORD</a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span class="MsoHyperlink"><span style='text-decoration:none'> </span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Request user credit with proper authentication (recommended):</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><a href="http://domain.com/mvapireq/?apientry=balance&authkey=KEY&authid=USRNAME&authmd5=MD5">http://domain.com/mvapireq/?apientry=balance&authkey=KEY&authid=USRNAME&authmd5=MD5</a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Initiate callback:</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><a href="http://domain.com/mvapireq/?apientry=callback&authkey=KEY&authid=USRNAME&authmd5=MD5&anum=PHONE1">http://domain.com/mvapireq/?apientry=callback&authkey=KEY&authid=USRNAME&authmd5=MD5&anum=PHONE1</a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Initiate phone to phone call:</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><a href="http://domain.com/mvapireq/?apientry=p2p&authkey=KEY&authid=USRNAME&authmd5=MD5&anum=PHONE1&bnum=PHONE2">http://domain.com/mvapireq/?apientry=p2p&authkey=KEY&authid=USRNAME&authmd5=MD5&anum=PHONE1&bnum=PHONE2</a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Sending SMS message:</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><a href="http://domain.com/mvapireq/?apientry=sms&authkey=KEY&authid=USRNAME&authmd5=MD5&anum=PHONE1&bnum=PHONE2&txt=TEXT">http://domain.com/mvapireq/?apientry=sms&authkey=KEY&authid=USRNAME&authmd5=MD5&anum=PHONE1&bnum=PHONE2&txt=TEXT</a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Request rate to destination:</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><a href="http://domain.com/mvapireq/?apientry=rating&authkey=KEY&authid=USRNAME&authmd5=MD5&anum=PREFIX_OR_NUMBER">http://domain.com/mvapireq/?apientry=rating&authkey=KEY&authid=USRNAME&authmd5=MD5&anum=PREFIX_OR_NUMBER</a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Recharge with PIN code:</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><a href="http://domain.com/mvapireq/?apientry=charge&authkey=KEY&authid=USRNAME&authmd5=MD5&anum=PINCODE&now">http://domain.com/mvapireq/?apientry=charge&authkey=KEY&authid=USRNAME&authmd5=MD5&anum=PINCODE&now</a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Add credit: (from trusted IP only)</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><a href="http://domain.com/mvapireq/?apientry=addcredit&authkey=KEY&authid=USRNAME&authmd5=MD5&pin=USERNAME&credit=AMMOUNT">http://domain.com/mvapireq/?apientry=addcredit&authkey=KEY&authid=USRNAME&authmd5=MD5&pin=USERNAME&credit=AMMOUNT</a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>With raw TCP or UDP you can send in the following format (terminated with a new line if TCP):</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'>/mvapireq/?apientry=apitest&authkey=KEY&authid=USRNAME&authmd5=MD5</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>With websocket, you have to use the uri with the “mvstwebsock” parameter such as:</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'>ws://yourserveraddress/mvstwebsock/</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'>Then send the request within the websocket stream as it would be TCP</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>JSONP works also for remote services if the “enablejsonp” global config option is set to 2.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <h3><a name="node17" id="node17"></a>Parameters</h3> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Parameters can be URI encoded. By default the basic ASCII character set are used.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Parameters can be passed by the parameter names (as listed in the API list section below []) or using param1, param2 … paramn.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Common parameters are the followings:</p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>authentication parameters: described below in the “Authentication” section.</p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>param1,param2,param3: this format can be also usually used. It must be in the same order as documented in the “API list” section below. If you specify the parameters in this way, then the parameter order must be: functionname, apikey, username, password, function parameters (anum, bnum, text)</p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>anum/phone1/from: for first/from/originating phone number</p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>bnum/phone2/to: for second/to/target phone number</p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>txt/message: body for sms, email and others</p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>others: as listed in the “API list” section below</p> <h3><a name="node18" id="node18"></a>Keywords</h3> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>The following keywords are automatically replaced by the Mizu VoIP client apps:</p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal;text-autospace:none'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>KEY: api key</p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal;text-autospace:none'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>USERNAME: sip username</p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal;text-autospace:none'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>PWD: sip password in clear text (should be used only with https)</p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal;text-autospace:none'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>MD5CHECKSUM: mizutech old api: MD5("rD58s:" + username + ":" + pwd+":"+additional)</p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal;text-autospace:none'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>MD5VALUE: mizutech new api: MD5("ck5Gp" + username + pwd + apiv2md5salt + usersalt) //the usersalt is optional</p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal;text-autospace:none'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>MD5WEB: mizutech web MD5("C8y5:" + username + ":" + pwd+":"+additional);</p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal;text-autospace:none'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>MD5NORMAL: MD5(username + pwd + salt)</p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal;text-autospace:none'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>MD5SIMPLE: MD5(username + pwd)</p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal;text-autospace:none'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>SALT: salt for md5 calculation</p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal;text-autospace:none'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>PHONE1, PHONE2, PREFIX_OR_NUMBER, CALLEDNUMBER: caller/called numbers</p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal;text-autospace:none'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>PINCODE: pin code</p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal;text-autospace:none'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>AMMOUNT: credit</p> <h3><a name="node19" id="node19"></a>Security</h3> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Before execution, the server will authorize and authenticate each API request as described in the “Authentication” section below.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Each API has a usage limit to avoid overusing or attacks tied to users, IP’s and global usage.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>For additional security you might use the API over HTTPS (the built-in TLS proxy can be used for this).</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Optionally as a simple encryption/obfuscation, you can also encrypt the requests with XOR + Base64 encoding. The XOR key can be set by the httpapiencryptkey global setting. Replace the ‘=’ char with ‘-‘ in the resulting string if any.</p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>If you wish to encrypt the whole POST URI, then encrypt as described above and pass it as “mcrfs” parameter.</p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>If you wish to encrypt the parameters values, then encrypt as described above and prefix them with “oenc1_” string.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>For an extra protection make sure to set the “httpapikey” to a random value in your global configuration.</p> <h3><a name="node20" id="node20"></a>Authentication</h3> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Each API function requires an <b>authentication</b> which is a combination of the followings:</p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>ip authentication: if client ip must be in the allowed list defined by the “apiv2ipauth” global config</p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>api key: usually a “authkey” parameter have to be sent which have to match the “apiv2key” global config option (old “httpapikey”)</p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>user authentication: a valid username/password combination (or pin/did). For the password you can use the md5 hash and this is strongly recommended instead of the clean text password. TLS/HTTPS can be also used for better security.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>The default API can be divided in the following <b>categories</b>:</p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>Sensitive API: IP authentication is recommended for these. For example “adduser”</p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>Admin API: for server administration, such as “info” to request server status details</p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>User API: API for users (such as “sms” to send SMS or “recharge” to add credit) by default with api key and username + password or md5 authentication.</p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>Public API: for example “status” to request a user online status (for these you might allow username based authentication)</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>The default API’s are set with optimal authentication (sensitive API’s requiring admin or ip access, local and same LAN IP’s are trusted which you can change by adding them to tb_api and set custom authentication), however for custom API’s make sure that you set the proper authentication depending on the API sensitivity.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>For example some API might request IP+apikey+user authentication, while there are some API’s which you can set do require no authentication at all (for example you can set the “status” API to require only a valid username). Usually (and by default) each api require apikey and user authentication (some API’s doesn’t require these from trusted sources). For admin requests an admin user name/password has to be used (unless you change it).</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>For bulk operations you might set the “trustediplist” global config option to your IP. For example your web server IP. Multiple IP can be separated by comma. </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>The following <b>parameters</b> are defined: </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b>authkey</b>: Defined by the “apiv2key” global config option (optional)</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b>authid</b>: Account username (but can represent also the user id, name, pincode or did)</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b>authpwd</b>: Account password in clear text (but can represent also the pin). This should be used only on trusted links such as on the localhost. Otherwise better to use the authmd5 parameter.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b>authsalt</b>: Need to be sent if the authmd5 (below) is used (a short random number or string)</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b>authmd5</b>: MD5(ck5Gp + authid + authpwd + serversalt + authsalt)</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> MD5: message-digest algorithm</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> ck5Gp: hardcoded string “ck5Gp”</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> authid: account user name</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> authpwd: account password</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> serversalt: salt defined by the “apiv2md5salt” global config option (optional)</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> authsalt: as sent by the “authsalt” parameter (optional but highly recommended)</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>The above string parameters just have to be concatenated (no colon or space between them). </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>The authentication can be fine-tuned in the <b>tb_api</b> table. You can specify settings for existing API’s (for example you can force the balance requests to be always authenticated) and you can also create new entries with custom SQL. </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>The following fields are defined:</p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>fname: function name (api entry such as “sms”, “adduser” or “mynewcustomapi”)</p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>req_key: 1 if authkey is required, otherwise 0 (default is 1)</p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>req_ip: 1 if ip is checked, otherwise 0. If 1, then the allowed IP list can be defined by the “apiv2ipauth” global config option (default is empty which means only local ip). Local IP is trusted by default. Private/LAN IP is also trusted by default unless you set the trustlanip global config to false.</p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>req_user: user authentication: 0=default,2=disabled,4=srvadmin,6=admins,8=ownwers and resellers, 10=support,12=all,14=public (default is 6 for admin API and 12 for user API)</p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>req_user_mode: defines how to authenticate the user. 0=default, 2=user + pwd or pin (def), 4=user or pwd or pin (less), 6=username/pwd (most). The default is defined by the “apiv2auth” global config option. Will also check the authentication setting of the user (so it might result in username only or IP based authentication)</p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>customsql: custom api based on an SQL query (in case if you set this for a predefined API, then the predefined behavior will be lost and the API will use your custom SQL). You can write any query supported by the SQL engine, including stored procedure usage if needed</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><i><span style='font-size:10.0pt'>For example if you wish to set an API as public (with no authentication request) just set create a new record in tb_api with api entry string for fname, 14 for req_user and 4 for req_user_mode.</span></i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><i><span style='font-size:10.0pt'> </span></i></p> <h3><a name="node21" id="node21"></a>API list</h3> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>The supported commands (API entries) are listed below.</p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'>Parameters in []</p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'>Short description in {}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>The best way to learn the usage is to try out the requests quickly from your browser. Some valid examples can be generated from MMAnage -> Tools menu -> Utilities -> Generate API examples.</p> <h4><a name="node22" id="node22"></a>User commands</h4> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Commands available for users (authenticated as enduser/reseller/other user type):</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>newuseru {public add user} [u_username,u_password,u_name,u_email,u_phone,u_currency,u_country,u_address]</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>balance {credit request}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>callrating {call rating details returning credit, maxduration and rating} [username, callid]</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>rating {rate request}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>status {self online status. 0=doesn’t exists,1=offline,2=online,3=calling,4=speaking}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>verifyuser [userusername] {request the status of this user. 0=doesn’t exists,1=offline,2=online,3=calling,4=speaking}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:black'>presence_get [userusername/userlist,ptype,domain] { will return the presence status of one ore multiple users; ptype have to be set to 1 if called from timer and 0 when at start; answer: OK: puserlist: user1:status1,user2:status2 OR ERROR: errordescription }</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>presence_set [pstatus,ptype] {set presence status; pstatus means status string, ptype have to be set 0 when called at start, otherwise 1; answer: OK: xxx or ERROR: xxx (doesn't matter since we have nothing to do with it). Also offline messages: XOFFMESSAGE:fromuser:textXOFFMESSAGE:fromuser2:text2XOFFMESSAGE:}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>sendim [bnum/buserlist,txt] {send chat message}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>getconfroom {get/create conference room}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>callback [num] {initiate callback call}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>p2p [bnum, cnum] {phone to phone call request}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>sendfax [from,to,filename]</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>sendmail [from, to, subject, message] {from can be empty}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>sms [anum,bnum,txt] {send sms message}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>sendsms [telnumber,message] {send sms message}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>sendsmsunicode [telnumber,message] {send sms message}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>cli {add pin less number (ANI)}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>charge [pin] {recharge using recharge PIN}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>cccharge [cardnum,expireyear,expmonth,ccv2,ammount]</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>transfercredit [username,credit] (user A can send credit to user B)</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>lockphonenumber {reserve a phone number}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>getphonenumber {return a phone number from the free pool)</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>search {user search}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>callbackaccessnumber {return the callbackaccessnumber}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>addcallbacknumber {add custom callback number}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>changepwd [newpassword,oldpassword]</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>forgotpasswordquestion [email]</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>forgotpasswordanswer [email, forgotpasswordanswer]</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>addcredit [pin] {add credit (Only from trusted IP by default)}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>callforward [anum,bnum,cnum]</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>sendccinfo</p> <h4><a name="node23" id="node23"></a>Admin commands</h4> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Commands available for administrators (authenticated as admin user and/or trusted IP address based authentication).</p> <h5><a name="node24" id="node24"></a>General</h5> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>version {display software version number}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>help { show console command list }</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>reguser [usr] {show registered users/devices}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>newuseri {private fast/unrestricted add user from trusted source} [u_username,u_password,u_name,u_email,u_phone,u_currency,u_country,u_address]</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>newuser {deprecated}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>adduser {deprecated}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>keepalive {keep alive the connection}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>close/exit/quit {close current connection}</p> <h5><a name="node25" id="node25"></a>Diagnostics</h5> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>info {show server status and important parameters}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>routingtest [ip,caller,called] {will return the destination route as it would be for real call}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>gencdr { generate cdr records: <a href="http://www.mizu-voip.com/portals/0/files/gencdr.pdf">www.mizu-voip.com/portals/0/files/gencdr.pdf</a> }</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>routingtest</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>deviceid {show device id}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>fastusers {list cached users}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>quickstat {quick statistics}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>endpoints {list sip endpoint info}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>locks {list of pending loks}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>threadlist {thread list}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>threads {thread list}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>threads2 {thread list}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>querylist {list the guid for the current running queries}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>lists</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>shortinfo</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>tunnelinfo</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>tunnelinfoex</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>tunnellist</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>call</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>showlog [main/sip/gk/sh/tcp,lines] {show the requested logfile}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>log</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>file {will send the requested file}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>logsearch</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>reports</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>showcfg {show the config files}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <h5><a name="node26" id="node26"></a>Commands</h5> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>cmd {exec windows shell command}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>asendemail [from, to, subject, message. from can be empty]</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>asendsms [telnumber,message] {send sms message}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>sendamsg {SendAgentMessage: send message to agents (agentid-all,message) }</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>voicehere [dbcallid] {start realtime call listening}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>voicehere2</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>bannedlist {list of banned ip's}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>delbanned [all] {remove ip from the banned list (ip)}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>disccall [dbcallid]</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>gk {connect to h323 gatekeeper module}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>client {switch to the requested client}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>db {any database query (select,update,etc) only if authenticated user type is admin}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>setip {set new ip (cardname,ip,mask,gateway,gwmetric)}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>timezoneset {set timezone}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>putfile [filename, filedata] {will save a file under the server directory. The filedata should be base64 encoded }</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>getfile [filename] {will load a file from under the server directory }</p> <h5><a name="node27" id="node27"></a>Reset</h5> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>reload {reload current configuration}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>vsiprst {restart sip-h323 router}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>sipreset {will reset the sip stack}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>maintreset {will restart the maintanance thread}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>ftprst</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>webrst</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>resetp</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>servicerst {restart the main service}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>servicerstdaw</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>dbreset {reset database connections}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>pcrst {restart the PC}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>gwrst { restart all gateways }</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>dbrsttgs</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>apireload {useful if you added/modified an entry in tb_api)</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>rulesreload</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>reloaddialplan</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>reloadapikeys</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>reloadnumdircache</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>logrename</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>rebill</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>reindexncache { reindex ccampclient }</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>calcncache { recalc cache size and mode }</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>clearnccache { clear next client cache [operatorid] }</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>upgradeall {selfupgrade all clients (0-vclientgw,1-vclientsrv,2-all)}</p> <h5><a name="node28" id="node28"></a>Various operations</h5> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>predectivet [start,stop,restart] {start-stop predective thread}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>syncmedia {syncronize media files}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>stopcanner {stop number scanner threads}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>checkscanner {check number scanner threads}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>backupdb</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>backup {BackupToOtherServer: launch a database backup to the second server}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>finetune {FinetuneService}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>normalizechk { check number normalization (called,caller,country) }</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>syncusers [oop] {syncroonize fast users list with the database}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>delobj [ep/logic/sqlupd/router/pred/check/simall/maint/logger/dbobj/all] {free objects}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>monthlymaint { run monthly maintanance tasks }</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>weeklymaint { run weekly maintanance tasks }</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>dailymaint { run daily maintanance tasks }</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>hourlymaint { run hourly maintanance tasks }</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>dailyreport { launch the daily report builder thread }</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>unittest [testtype,threads,testtime,parameter] {start unit tests}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>savesettings {write uncommitted settings from db to file}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>setini [section,key,value,file] {write to ini file}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>getini [section,key,file]] {read from ini file}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>saveinifiles {write uncommitted inikeys from db (module,file -or all, notsaved) }</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>loadinifiles {load ini to db (module,file -or all)}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>toclient { send message to client service (clientip or username, message) }</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>togw { send message to gw (clientip or username, message) }</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>call { sim call each other (origsimid,telnum,duration) }</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>toip { send message to the specified (sims,simid,credit,callnum,dialnum) ip }</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>at { send direct message to the specified engine (gwname,line,ATcommand) }</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>updcdrdir</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>createcdrinfo</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>setfastregpwd</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>newuserevent</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>newusersevent</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>checkcredits {check charges and creditrequests need}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>checkpins {will recheck pincodes}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>capcheck { check free capacity (direction -3330630) }</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>parsegsmcdr { reparse cdrr from the specified logfile }</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>willstop { no more creditcheck }</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>checkmails {CheckEmailJobs: check email jobs}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>db [txt] {any sql select/insert/update command}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>setfield [table, fieldtype, fieldname, fieldvalue,rowid, sync] {update a field}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>getfield [table, retfieldname, filterfieldtype, filterfieldname, filterfieldvalue] {request a field}</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> def values: </p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;text-indent:.5in;line-height:normal'>table: tb_users</p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;text-indent:.5in;line-height:normal'>retfieldname: id</p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;text-indent:.5in;line-height:normal'>filterfieldtype: auto guess </p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;text-indent:.5in;line-height:normal'>filterfieldname: auto guess (username/callerid/userid)</p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;text-indent:.5in;line-height:normal'>filterfieldvalue: mandatory</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>pputfile [filename, filedata] {will save a file under the mvweb\filestorage directory. The filedata should be base64 encoded }</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>pgetfile [filename] {will load a file from under the mvweb\filestorage directory }</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <h5><a name="node29" id="node29"></a>Custom</h5> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>You can create your custom API by adding rows to tb_api via the “customsql” field. Iit can contain any sql statement: for SELECT it will display the rows (max 100) and for UPDATE/INSERT it will execute the query.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Make sure to set the proper values for the authentication fields and set any name with the “fname” field.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>You might prefix the sql with * to execute synchronously (otherwise the faster async will be used which can’t tell if the query have failed).<span style='font-size:10.0pt'> </span>The following keywords can be used:</p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal;text-autospace:none'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>[USERID]: will be replaced with the currently logged in user id (tb_users.id)</p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal;text-autospace:none'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>[USERNAME]: will be replaced with the currently logged in username</p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal;text-autospace:none'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>[SPARAM1]: will be replaced with the supplied sparam1 URL parameter</p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal;text-autospace:none'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>[SPARAM2]: will be replaced with the supplied sparam2 URL parameter</p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal;text-autospace:none'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>…</p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal;text-autospace:none'><span style='font-family:Wingdings'>Ø<span style='font:7.0pt "Times New Roman"'> </span></span>[SPARAM99]: will be replaced with the supplied sparam99 URL parameter</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;text-autospace:none'>Be aware of SQL injections. Don’t pass these parameters from user input!</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><i>Note: there are also other ways to interact with the Mizu VoIP server, as described in the “</i><a href="https://www.mizu-voip.com/Portals/0/Files/VoIP_Integration.pdf"><i>Integration Guide</i></a><i>” (for example working directly with the SQL database).</i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><i> </i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><i> </i></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>For more details use the <a href="https://www.mizu-voip.com/Portals/0/Files/MAdminGuide.pdf">Admin Guide</a> or <a href="mailto:serversupport@mizu-voip.com?subject=Callcenter%20support">contact our support</a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal"><i><span style='font-size:8.0pt;line-height:115%'>Copyright © </span></i><i><span style='font-size:8.0pt;line-height:115%'>MizuTech</span></i></p> </div>
Contents
Topics
Search
Overview
Examples
Parameters
Keywords
Security
Authentication
API list
User commands
Admin commands
General
Diagnostics
Commands
Reset
Various operations
Custom
Admin commands
API list
Authentication
Commands
Custom
Diagnostics
Examples
General
Keywords
Overview
Parameters
Reset
Security
User commands
Various operations