阿奇WebSockets公共服务文档 2022年1月29日 1951 代码厨子 WebSockets是web服务中经常想要使用但是又没有勇气使用的工具。 我们每次使用在后端都要搭建各种服务，如今我们开放了公共服务，本为内部使用，现可开放。 #前要说明 1. 接口地址：https://ws.aqifun.com 2. 关键参数（例如app_id），请联系我们商务。 3. 签名方式： 报文非空值的键名以及排除 sign 字段，按照 ASCII 码排序，然后 以：键名=键值 形式组合，中间用&符号连接。得到的字符串进行 MD5，此值即为签名，放入报文的 sign 键值。注意，MD5 值为小写。 4. 系统分为服务端和客户端两种使用方式，客户端只能发送消息，其他关键功能均通过服务端完成，详情见文档。 5. 心跳机制发送ping，服务器返回pong，表示活跃。 6. 数据通过异步通知进行投送，开设appid时设置异步通知地址。 # 服务端 ## 标识说明 标识|说明 --|-- POST|数据提交方式 /URL/|接口地址 required|必填项 ## 公共参数 字段|必填|说明 --|--|-- appid|required|APPID timestamp|required|当前时间戳 nonce_str|required|随机字符串 sign|required|签名 这四个公共参数，每次服务端请求均必须带上。 ## 用户相关 ###用户绑定 *访问方式* ```shell POST /api/user/create/ ``` *字段说明* 字段|必填|说明 --|--|-- end_date||有效时间，格式为2022-01-21 10:10:10，空为长期有效 ### 用户解绑 *访问方式* ```shell POST /api/user/delete/ ``` *字段说明* 字段|必填|说明 --|--|-- hash_id|required|要解绑的hash_id ## 群组相关 ###群组创建 *访问方式* ```shell POST /api/group/create/ ``` *字段说明* 字段|必填|说明 --|--|-- title|required|群组名称 master|required|群主的hash_id users|required|组员，群主默认增加，无需加入，ARRAY ###群信息维护 *访问方式* ```shell POST /api/group/update/master/ ``` *字段说明* 字段|必填|说明 --|--|-- hash_id|required|群组的hash_id title||群组名称，留空为不修改 master||新群主的hash_id，留空为不修改 ### 群用户维护 *访问方式* ```shell POST /api/group/update/user/ ``` *字段说明* 字段|必填|说明 --|--|-- hash_id|required|群组的hash_id users|required|需要增减的人员，群主不能被删除，有就删了，没有就加上，ARRAY格式 ###解散群 *访问方式* ```shell POST /api/group/delete/ ``` *字段说明* 字段|必填|说明 --|--|-- hash_id|required|群组的hash_id ## 消息相关 ###消息发送 *访问方式* ```shell POST /api/message/ ``` *字段说明* 字段|必填|说明 --|--|-- body|required|内容，JSON格式，具体格式同客户端格式 # 客户端 ## 消息相关 ### 客户端连接 创建连接方式为： wss://ws.aqifun.com/ws/?appid=xxxxxx&custom=xxxxxx×tamp=1234324&nonce_str=xxxx&sign=xxxxx 参数签名方式和后台相同 创建连接后，发送ping系统返回pong，说明活跃。 发送信息本体，请参考下面。 ### 信息发送 *发送格式* 发送内容为字符串类型！！！请务必将发送内容格式化为json字符串，类似： ```json { "from": "hash_id", "to": ["hash_id"], "method": "group/custom", "text": "hello world" } ``` *字段说明* 字段|类型|说明 --|--|-- from|字符串|发送人的hash_id to|数组|接收人的hash_id，客户端只支持一对一发送，服务端可多个同时发送 method|字符串|group/custom二选一，分别为组和客户端 text|字符串|要发送的实际内容 --------- ### 联系方式 代码厨子 微信手机同号 18961330033
