发送文本消息

  • API名称: send_txt_msg
  • HTTP方法类型: GET
  • 所需HTTP头字段:
    • xvs-signature 签名字段
    • xvs-timestamp 签名时间戳
  • URL查询参数:
    • service_code 任务相关的服务码
    • dst_username 接收消息的用户名
    • from_username 发送消息的用户名
    • vs_id 服务器id 参考(获取任务列表和用户列表)[task]
    • message 发送的消息内容

以下是一次调用的抓包数据，以供参考

请求：

GET /api/20140928/send_txt_msg?service_code=TESTING&dst_username=001&message=hello%20world&from_username=admin HTTP/1.1
Host: c.zhiboyun.com
Connection: keep-alive
Accept: application/json, text/javascript, */*; q=0.01
xvs-timestamp: 1444274491822
User-Agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/45.0.2454.101 Safari/537.36
Origin: http://developer.zhiboyun.com
xvs-signature: a9f4ebd91f72bbcd1569665a913e2f4a3514c711780ff04e6d8a0da1501a13dd

调用发送的消息内容为 hello world 返回:

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Content-Type: text/plain
Date: Thu, 08 Oct 2015 03:21:31 GMT
transfer-encoding: chunked
Connection: keep-alive

a
{"ret": 0}
0

虽然这个api命名为发送文本消息，但实际上应用可以定义自己的消息格式，以此来发送一些命令。 假如应用需要实现一个远程打开某个指定拍摄端的闪光灯的功能，则应用可以将message字段做如下定义

{
  "action": "open_flash",
  "params": []
}

移动端sdk在收到此消息后会回调应用的接收文本消息的api, 原封不动地将上面这个文本传给应用，应用只要解析此json字串，获得到open_flash命令后调用相关sdk提供的打开闪光灯这一个api即可实现此功能。 而要在终端显示某一个文本时，可以将消息定义为

{
  "action": "show_message",
  "params": ["hello world"]
}

应用在收到消息后，解析并显示hello world在界面上即可。