个人微信开发API协议
一、基础消息类型
1、客户端发送的心跳包HeartBeatReq=1001;
2、消息接收确认回复(接收或拒绝接收)MsgReceivedAck =1002;
3、错误单独提升为一种消息类型 Error = 1003;
4、通用任务执行结果通知TaskResultNotice=1025;
二、设备客户端授权类消息
1、设备(手机客户端、客服客户端)获取通信token请求与响应
DeviceAuthReq=1010;
设备(手机客户端、客服客户端)获取通信 token 响应 DeviceAuthRsp =1011;
2、设备授权后退出(仅用于服务端内部)DeviceExitNotice = 1012;
3、账号强制下线通知AccountForceOfflineNotice =1013;
三、手机客户端上传的通知类消息
1、手机客户端微信上线通知WeChatOnlineNotice = 1020;
2、手机客户端微信下线通知WeChatOfflineNotice =1021;
3、微信个人号新增好友通知FriendAddNotice =1022;
4、微信个人号移除好友通知FriendDelNotice =1023;
5、微信好友发来聊天消息通知FriendTalkNotice =1024;
6、手机上回复好友的聊天消息通知WeChatTalkToFriendNotice =1026;
7、有好友请求添加好友的通知FriendAddReqeustNotice = 1027;
8、手机上发送了朋友圈通知 CircleNewPublishNotice=1031;
9、手机上删除朋友圈返回通知CircleDelNotice =1032;
举例
发送文本消息
请求URL:
http://域名地址/sendText
请求方式:
- POST
请求头Headers:
- Content-Type:application/json
- Authorization:login接口返回
参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
wId | 是 | string | 登录实例标识 |
wcId | 是 | string | 接收人微信id/群id |
content | 是 | string | 文本内容消息 |
返回数据:
参数名 | 类型 | 说明 |
---|---|---|
code | string | 1000成功,1001失败 |
msg | string | 反馈信息 |
data | ||
data.type | int | 类型 |
data.msgId | long | 消息msgId |
data.newMsgId | long | 消息newMsgId |
data.createTime | long | 消息发送时间戳 |
data.wcId | string | 消息接收方id |
请求参数示例
------------------------ 好友消息 ------------------------------
{
"wId": "0000016e-63eb-f319-0001-ed01076abf1f",
"wcId": "azhichao",
"content": "天行健,君子以自强不息"
}
成功返回示例
{
"code": "1000",
"message": "处理成功",
"data": {
"type": 1,
"msgId": 2562652205,
"newMsgId": 4482117376572170921,
"createTime": 1641457769,
"wcId": "azhichao"
}
}
错误返回示例
{
"message": "失败",
"code": "1001",
"data": null
}