API接口的核心
对于小白而言,初看API文档可能是一头雾水的——从哪里看,怎么看,看什么是摆在面前的问题。
其实对于产品经理而言,我们应该更关注这个公司可以提供什么样的API接口服务,比如我知道高德可以提供地图API,规划路线的API,这样的话在我们设计功能和工作中就可以想到调用他们的服务或者参考。
所以产品小白们看不懂也不用过于担心,未来工作中你也会更深入了解清楚,因为看懂并不复杂,以下是API接口的核心点,所有的说明文档离不开这5个核心点。
以下说明均以微信开放平台为例说明,文末有各开放平台的地址,大家有空可以去学习。
1. 接口地址
2. 请求参数(报文)
3. 返回结果
(1)成功
(2)失败
四、API接口的应用
获取群成员
简要描述:
- 获取群成员
请求URL:
http://域名地址/getChatRoomMember
请求方式:
- POST
请求头Headers:
- Content-Type:application/json
- Authorization:login接口返回
参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
wId | 是 | String | 登录实例标识 |
chatRoomId | 是 | String | 群号 |
请求参数示例
<span style="color:#333333"><span style="background-color:#ffffff"><span style="background-color:#f7f8f9"><span style="color:black"><code><span style="color:#999999">{</span>
<span style="color:#990055">"wId"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#669900">"349be9b5-8734-45ce-811d-4e10ca568c67"</span><span style="color:#999999">,</span>
<span style="color:#990055">"chatRoomId"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#669900">"24343869723@chatroom"</span>
<span style="color:#999999">}</span></code></span></span></span></span>
成功返回示例
<span style="color:#333333"><span style="background-color:#ffffff"><span style="background-color:#f7f8f9"><span style="color:black"><code><span style="color:#999999">{</span>
<span style="color:#990055">"message"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#669900">"成功"</span><span style="color:#999999">,</span>
<span style="color:#990055">"code"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#669900">"1000"</span><span style="color:#999999">,</span>
<span style="color:#990055">"data"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#999999">[</span>
<span style="color:#999999">{</span>
<span style="color:#990055">"chatRoomId"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#669900">"23282491030@chatroom"</span><span style="color:#999999">,</span>
<span style="color:#990055">"userName"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#669900">"wxid_wl9qchkanp9u22"</span><span style="color:#999999">,</span>
<span style="color:#990055">"nickName"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#669900">"E云通知小助手(机器人)"</span><span style="color:#999999">,</span>
<span style="color:#990055">"chatRoomOwner"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#0077aa">null</span><span style="color:#999999">,</span>
<span style="color:#990055">"bigHeadImgUrl"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#669900">"http://wx.qlogo.cn/mmhead/ver_1/DEjvrt3YDnqggwzHj2LQTwY3K1y6TWVC615azPYb3RSWgeMvE5ny1kYQSBoNLgCicRMGa9LRp9dQJy2HHurNSYqqZNf5NTxicDMTNdjL3SrAI/0"</span><span style="color:#999999">,</span>
<span style="color:#990055">"smallHeadImgUrl"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#669900">"http://wx.qlogo.cn/mmhead/ver_1/DEjvrt3YDnqggwzHj2LQTwY3K1y6TWVC615azPYb3RSWgeMvE5ny1kYQSBoNLgCicRMGa9LRp9dQJy2HHurNSYqqZNf5NTxicDMTNdjL3SrAI/132"</span><span style="color:#999999">,</span>
<span style="color:#990055">"v1"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#0077aa">null</span><span style="color:#999999">,</span>
<span style="color:#990055">"memberCount"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#990055">0</span><span style="color:#999999">,</span>
<span style="color:#990055">"displayName"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#669900">""</span><span style="color:#999999">,</span>
<span style="color:#990055">"chatRoomMembers"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#0077aa">null</span>
<span style="color:#999999">}</span><span style="color:#999999">,</span>
<span style="color:#999999">{</span>
<span style="color:#990055">"chatRoomId"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#669900">"23282491030@chatroom"</span><span style="color:#999999">,</span>
<span style="color:#990055">"userName"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#669900">"wxid_i6qsbbjenjuj22"</span><span style="color:#999999">,</span>
<span style="color:#990055">"nickName"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#669900">"E云Team_Mr Li"</span><span style="color:#999999">,</span>
<span style="color:#990055">"chatRoomOwner"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#0077aa">null</span><span style="color:#999999">,</span>
<span style="color:#990055">"bigHeadImgUrl"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#669900">"http://wx.qlogo.cn/mmhead/ver_1/licI98sKzmtB0BWmDGvVaqcvCmDMMbLsGku18zHpxoxYibXH2QhZibTIjOPhzlpAkQic8Tlhdk4lCAIlE0twxQnqng4M4CKcV3ps52wOfcMHemo/0"</span><span style="color:#999999">,</span>
<span style="color:#990055">"smallHeadImgUrl"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#669900">"http://wx.qlogo.cn/mmhead/ver_1/licI98sKzmtB0BWmDGvVaqcvCmDMMbLsGku18zHpxoxYibXH2QhZibTIjOPhzlpAkQic8Tlhdk4lCAIlE0twxQnqng4M4CKcV3ps52wOfcMHemo/132"</span><span style="color:#999999">,</span>
<span style="color:#990055">"v1"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#0077aa">null</span><span style="color:#999999">,</span>
<span style="color:#990055">"memberCount"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#990055">0</span><span style="color:#999999">,</span>
<span style="color:#990055">"displayName"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#669900">""</span><span style="color:#999999">,</span>
<span style="color:#990055">"chatRoomMembers"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#0077aa">null</span>
<span style="color:#999999">}</span><span style="color:#999999">,</span>
<span style="color:#999999">{</span>
<span style="color:#990055">"chatRoomId"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#669900">"23282491030@chatroom"</span><span style="color:#999999">,</span>
<span style="color:#990055">"userName"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#669900">"wxid_ew6i9qdxlinu12"</span><span style="color:#999999">,</span>
<span style="color:#990055">"nickName"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#669900">"E云客服-可可(工作日09:00-18:00)"</span><span style="color:#999999">,</span>
<span style="color:#990055">"chatRoomOwner"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#0077aa">null</span><span style="color:#999999">,</span>
<span style="color:#990055">"bigHeadImgUrl"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#669900">"http://wx.qlogo.cn/mmhead/ver_1/avZnWvIiaulTibWZDqvjic9zNsW9F5n5GN5AoNIian9U1w86TAwicqjMa3esFLOzFfUNI4icCeziauRhOEOxicadyarDmQqf679VsUiaxhawibia9wficSE/0"</span><span style="color:#999999">,</span>
<span style="color:#990055">"smallHeadImgUrl"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#669900">"http://wx.qlogo.cn/mmhead/ver_1/avZnWvIiaulTibWZDqvjic9zNsW9F5n5GN5AoNIian9U1w86TAwicqjMa3esFLOzFfUNI4icCeziauRhOEOxicadyarDmQqf679VsUiaxhawibia9wficSE/132"</span><span style="color:#999999">,</span>
<span style="color:#990055">"v1"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#0077aa">null</span><span style="color:#999999">,</span>
<span style="color:#990055">"memberCount"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#990055">0</span><span style="color:#999999">,</span>
<span style="color:#990055">"displayName"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#669900">""</span><span style="color:#999999">,</span>
<span style="color:#990055">"chatRoomMembers"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#0077aa">null</span>
<span style="color:#999999">}</span><span style="color:#999999">,</span>
<span style="color:#999999">{</span>
<span style="color:#990055">"chatRoomId"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#669900">"23282491030@chatroom"</span><span style="color:#999999">,</span>
<span style="color:#990055">"userName"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#669900">"wxid_ylxtflcg0p8b22"</span><span style="color:#999999">,</span>
<span style="color:#990055">"nickName"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#669900">"售前客服-小诺 (工作日9:00-18:00)"</span><span style="color:#999999">,</span>
<span style="color:#990055">"chatRoomOwner"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#0077aa">null</span><span style="color:#999999">,</span>
<span style="color:#990055">"bigHeadImgUrl"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#669900">"http://wx.qlogo.cn/mmhead/ver_1/5Aiaticzwasiac9drMyibhHrDRIsadlS4sKWp4ia3QdaKfAe6RcOhHjTtk0qzJTEQagNTM1R4WZVvAvqVMn02DGrIOEj2ZQwDD0HzHyq95Nc5zlw/0"</span><span style="color:#999999">,</span>
<span style="color:#990055">"smallHeadImgUrl"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#669900">"http://wx.qlogo.cn/mmhead/ver_1/5Aiaticzwasiac9drMyibhHrDRIsadlS4sKWp4ia3QdaKfAe6RcOhHjTtk0qzJTEQagNTM1R4WZVvAvqVMn02DGrIOEj2ZQwDD0HzHyq95Nc5zlw/132"</span><span style="color:#999999">,</span>
<span style="color:#990055">"v1"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#0077aa">null</span><span style="color:#999999">,</span>
<span style="color:#990055">"memberCount"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#990055">0</span><span style="color:#999999">,</span>
<span style="color:#990055">"displayName"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#669900">"啦啦啦"</span><span style="color:#999999">,</span>
<span style="color:#990055">"chatRoomMembers"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#0077aa">null</span>
<span style="color:#999999">}</span><span style="color:#999999">,</span>
<span style="color:#999999">{</span>
<span style="color:#990055">"chatRoomId"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#669900">"23282491030@chatroom"</span><span style="color:#999999">,</span>
<span style="color:#990055">"userName"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#669900">"wxid_nqo37ves8w5t22"</span><span style="color:#999999">,</span>
<span style="color:#990055">"nickName"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#669900">"追风少年666"</span><span style="color:#999999">,</span>
<span style="color:#990055">"chatRoomOwner"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#0077aa">null</span><span style="color:#999999">,</span>
<span style="color:#990055">"bigHeadImgUrl"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#669900">"http://wx.qlogo.cn/mmhead/ver_1/G9GD3GENzHvn9hEiaw0JJzwGYD2jIiczflo0DHcVTXuqIiavsB9W51Z3GTv3RqkdOY3xyhMicAicOZDSqBDOAelfD4AjaKo4Q5EsMa7MIgGbj8IY/0"</span><span style="color:#999999">,</span>
<span style="color:#990055">"smallHeadImgUrl"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#669900">"http://wx.qlogo.cn/mmhead/ver_1/G9GD3GENzHvn9hEiaw0JJzwGYD2jIiczflo0DHcVTXuqIiavsB9W51Z3GTv3RqkdOY3xyhMicAicOZDSqBDOAelfD4AjaKo4Q5EsMa7MIgGbj8IY/132"</span><span style="color:#999999">,</span>
<span style="color:#990055">"v1"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#0077aa">null</span><span style="color:#999999">,</span>
<span style="color:#990055">"memberCount"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#990055">0</span><span style="color:#999999">,</span>
<span style="color:#990055">"displayName"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#669900">""</span><span style="color:#999999">,</span>
<span style="color:#990055">"chatRoomMembers"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#0077aa">null</span>
<span style="color:#999999">}</span>
<span style="color:#999999">]</span>
<span style="color:#999999">}</span></code></span></span></span></span>
错误返回示例
<span style="color:#333333"><span style="background-color:#ffffff"><span style="background-color:#f7f8f9"><span style="color:black"><code><span style="color:#999999">{</span>
<span style="color:#990055">"message"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#669900">"失败"</span><span style="color:#999999">,</span>
<span style="color:#990055">"code"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#669900">"1001"</span><span style="color:#999999">,</span>
<span style="color:#990055">"data"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#9a6e3a">:</span></span> <span style="color:#0077aa">null</span>
<span style="color:#999999">}</span></code></span></span></span></span>
返回数据:
参数名 | 类型 | 说明 |
---|---|---|
code | String | 1000成功 1001失败 |
msg | String | 反馈信息 |
data | JSONObject | |
chatRoomId | String | 群号 |
userName | String | 群成员微信号 (假如需要手机上显示的微信号或更详细的信息,则需要再调用获取群成员详情接口获取) |
nickName | String | 群成员默认昵称 |
displayName | String | 群成员修改后的昵称 |
bigHeadImgUrl | String | 大头像 |
smallHeadImgUrl | String | 小头像 |
chatRoomMemberFlag | int | |
inviterUserName | String | 邀请人微信号(仅有群主和管理可以看到) |