RTXServer web api接口一个小实例

一个RTXServer web api接口的小实例，最后返回的是xml文件，与其它的区别不大，有兴趣的同学可参考学习。

109天没发表博客，破了记录，至从换了公司后就没有机会使用CI，重要的原因是自己懒惰了，下班后的时间几乎都在玩吉他，所以一直没有找到可以分享的技术点

不过在这109天里可以肯定的事情是：我变了

在新公司接触得最多的是oa与RTX，而RTX其实也是很多玩法，这里就先将前几天趁空闲的时间整理下来的RTX可以通过web方式调用的接口列一下

值得提醒的是这些接口都需要设置访问权限不然访问时会提醒“IP受限制”

RTX Server强加了SDK访问安性,因此通过http方式访问cgi文件需要在SDKProperty.xml添加远程访问机器的IP地址，如下图所示，允许192.168.10.100通过http方式访问cgi文件

以下为所有接口的清单，你也可以访问这个地方来查看相关的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=XXXX

GetSession.cgi
获取指定用户的RTX session

支持GET与POST传值

@param string receiver RTX用户名

@return RTX用户session

@example http://localhost:8012/GetSession.cgi?receiver=XXXX

GetAllDepts.php
获取RTX所有部门数据

@return 所有部门数据(json)

@example http://localhost:8012/GetAllDepts.php

GetAllUsers.php
获取RTX所有用户数据

@return 所有用户数据(json)

@example http://localhost:8012/GetAllUsers.php

GetUserBasicInfo.php
获取指定用户基本信息

仅支持GET

@param string user RTX用户名

@return 所有用户数据(json)

@example http://localhost:8012/GetUserBasicInfo.php?user=XXXX

Login.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=XXXX

SendIM.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=XXXX

SendNotify.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=2000

SendSMS.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=2000

SignAuth.cgi
验证签名 仅支持GET 参数顺序随意

@param string user RTX用户ID

@param string sign 签名

@return string 成功为success! 失败为failed!

@example http://localhost:8012/SignAuth.cgi?user=XXXX&sign=XXXX

getstatus.php
获取用户在线状态仅支持GET

@param string username RTX用户名

@return int 0不在线 1在线

@example http://localhost:8012/getstatus.php?username=XXXX

userlist.php
获取所有用户列表（只含id与name）

@return string 用户列表（json）

@example http://localhost:8012/userlist.php