RTX的api開發實例

RTX的api開發實例

最近接觸了RTX的接口開發部份，RTX其實有不少玩法,除了能夠用自帶的客戶端發消息以外還能夠用PHP調用API的方式來作一些事情,下邊整理了一下分享給你們

 

值得提醒的是這些接口都須要設置訪問權限否則訪問時會提醒「IP受限制」

RTX Server強加了SDK訪問安性,所以經過http方式訪問cgi文件須要在SDKProperty.xml添加遠程訪問機器的IP地址，以下圖所示，容許192.168.10.100經過http方式訪問cgi文件

 

如下爲全部接口的清單，你也能夠訪問這個地方來查看相關的API http://rtx.tencent.com/sdk/

 

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

 

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