RTX web API调用接口,记在这里备查
以下为所有接口的清单,你也可以访问这个地方来查看相关的API http://iamlze.cn/demo/RTX-API/
GetImage.cgi
获取指定用户的状态图片
仅支持GET传值
@param string receiver RTX用户名
@return 用户状态图片
@example http://localhost:8012/GetImage.cgi?receiver=XXXX
GetMobile.cgi
获取指定用户的手机号码
支持GET与POST传值
@param string receiver RTX用户名
@return 用户手机
@example http://localhost:8012/GetMobile.cgi?receiver=XXXXGetSession.cgi
获取指定用户的RTX session
支持GET与POST传值
@param string receiver RTX用户名
@return RTX用户session
@example http://localhost:8012/GetSession.cgi?receiver=XXXXGetAllDepts.php
获取RTX所有部门数据
@return 所有部门数据(json)
@example http://localhost:8012/GetAllDepts.phpGetAllUsers.php
获取RTX所有用户数据
@return 所有用户数据(json)
@example http://localhost:8012/GetAllUsers.phpGetUserBasicInfo.php
获取指定用户基本信息
仅支持GET
@param string user RTX用户名
@return 所有用户数据(json)
@example http://localhost:8012/GetUserBasicInfo.php?user=XXXXLogin.php
判断指定用户ID与密码是否存在RTXserver中
仅支持GET
@param string user RTX用户名
@param string pwd RTX密码
@return string 正确输出true 用户或密码错误输出false 参数缺失输出params is null
@example http://localhost:8012/Login.php?user=XXXX&pwd=XXXXSendIM.cgi
发送IM信息
支持GET与POST传值 参数顺序随意
@param string sender 发消息人RTXid
@param string pwd 发送消息人RTX密码
@param string receivers 接收人(多个接收人之间使用,隔开)
@param string msg 消息内容
@param string sessionid RTX session
@return string
@example http://localhost:8012/SendIM.cgi?sender=XXXX&pwd=XXX&receivers=A;B&msg=CS么&sessionid=XXXXSendNotify.cgi
发送通知信息
支持GET与POST传值 参数顺序随意
@param string title 通知标题
@param string msg 通知内容
@param string receiver 接收人(多个接收人之间使用,隔开,若为空表示广播)[option]
@param int delaytime 消息提醒框的停留时间(毫秒),0表示不自动消失
@param string okurl 成功后IE自动定位到指定的url 格式类似为:okurl=rtx.tencent.com 或者 okurl=http://tx.tencent.com 注意:这里的url必须为绝对地址[option]
@param string errurl 失败后IE自动定位到指定的url[option]
@example http://localhost:8012/SendNotify.cgi?title=XXXX&msg=吃饭了&receiver=A;B&delaytime=2000SendSMS.cgi
发送短信信息
支持GET与POST传值 参数顺序随意
@param string msg 短信内容
@param string receiver 接收人(多个接收人之间使用,隔开)
@param string sender 发送人
@param string okurl 成功后IE自动定位到指定的url 格式类似为:okurl=rtx.tencent.com 或者okurl=http://tx.tencent.com 注意:这里的url必须为绝对地址[option]
@param string errurl 失败后IE自动定位到指定的url[option]
@example http://localhost:8012/SendNotify.cgi?title=XXXX&msg=吃饭了&receiver=A;B&delaytime=2000SignAuth.cgi
验证签名 仅支持GET 参数顺序随意
@param string user RTX用户ID
@param string sign 签名
@return string 成功为success! 失败为failed!
@example http://localhost:8012/SignAuth.cgi?user=XXXX&sign=XXXXgetstatus.php
获取用户在线状态仅支持GET
@param string username RTX用户名
@return int 0不在线 1在线
@example http://localhost:8012/getstatus.php?username=XXXXuserlist.php
获取所有用户列表(只含id与name)
@return string 用户列表(json)
@example http://localhost:8012/userlist.php
另附IP受限”的问题解决:
RTX Server强加了SDK访问安性,因此通过http方式访问cgi文件需要在SDKProperty.xml
(C:/Program Files/Tencent/RTXServer/SDKProperty.xml)
添加远程访问机器的IP地址,如下xml所示,允许192.168.17.1通过http方式访问cgi文件。
` <?xml version="1.0"?>
<Property>
<APIClient>
<IPLimit Enabled="1">
<IP>127.0.0.1</IP>
</IPLimit>
</APIClient>
<sdkhttp>
<IPLimit Enabled="1">
<IP>192.168.17.1</IP>
</IPLimit>
</sdkhttp>
</Property>`
例子:
http://192.168.1.5:8012/sendnotify.cgi?msg=收到请回复,并提供截图&receiver=阿芳
如果需要在其它计算机上使用SDK包,必须将这台计算机的IP地址也加入,只不过位置在<APIClient>段
`
<?xml version="1.0"?>
<Property>
<APIClient>
<IPLimit Enabled="1">
<IP>127.0.0.1</IP>
<IP>192.168.17.1</IP>
</IPLimit>
</APIClient>
<sdkhttp>
<IPLimit Enabled="1">
<IP>192.168.17.1</IP>
</IPLimit>
</sdkhttp>
</Property>`
测试通过。
经测试,消息支持简单的HTML(隐式URL链接),语法格式:[链接名称|URL地址]
如:http://192.168.1.5:8012/sendnotify.cgi?msg=[我的博客|http://hi.baidu.com/dgnankai]|&receiver=阿珊
本文由 donque 创作,采用 知识共享署名4.0 国际许可协议进行许可
本站文章除注明转载/出处外,均为本站原创或翻译,转载前请务必署名
最后编辑时间为: Jan 20, 2019 at 06:48 pm