API开放平台

TIP

# 企业群发相关接口

# 企业群发查询接口

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/weCom/v1/queryTenantMassSend/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
	"page":"1",
	"rows":"1000",
    "startSendTime": "2023-02-08",
    "endSendTime": "2023-05-08",
    "sendContent": "f",
    "queryCreatorIds": "7528419080657746879,8853881663134006579"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
page VARCHAR(10) 否 数据页码，默认为1
rows VARCHAR(10) 否 分页大小，每页默认1000条
startSendTime VARCHAR(100) 否 群发时间开始时间 非必填，格式为yyyy-mm-dd，表示查询此时间之后创建的群发，取当日0点
endSendTime VARCHAR(100) 否 群发时间结束时间 非必填，格式为yyyy-mm-dd，表示查询此时间之前创建的群发，取当日23：59：59
sendContent VARCHAR(100) 否 群发名称
queryCreatorIds VARCHAR(100) 否 创建人

响应示例：

{
    "return_code": "0", 
    "return_msg": "响应信息",
    "msg_id": "{ msg_id }",  
    "response_data": "<<DATA>>"
}

数据DATA示例:

[
	{
        "actSendNum": "0",
        "cmNum": "2",
        "creator": "高杨",
        "id": "7961112986193082134",
        "maxMessageNum": "0",
        "messageName": "咕咕咕咕咕咕过",
        "noFriend": "0",
        "noSenderNum": "1",
        "sendCmNum": "0",
        "sendContent": "咕咕咕咕咕咕过过过过过过过过过过",
        "sendTime": "2023-04-21 13:22:00",
        "senderNum": "1",
        "unSendCmNum": "2"
    },
    {
        "actSendNum": "2",
        "cmNum": "38",
        "creator": "乔延安",
        "id": "5410173148997698901",
        "maxMessageNum": "0",
        "messageName": "测试群发",
        "noFriend": "0",
        "noSenderNum": "21",
        "sendCmNum": "4",
        "sendContent": "勤策测试消息推送",
        "sendTime": "2023-03-24 11:29:03",
        "senderNum": "23",
        "unSendCmNum": "44"
    }
]

参数说明：

参数 类型 必填 说明
sendTime VARCHAR(100) 发送时间 表示群发创建的时间
id VARCHAR(100) 群发ID
messageName VARCHAR(100) 群发名称
sendContent VARCHAR(100) 发送内容
senderNum VARCHAR(100) 发送成员 发送成员数量
cmNum VARCHAR(100) 预计送达客户 预计送达客户数量
creator VARCHAR(100) 创建人
actSendNum VARCHAR(100) 已发送成员
sendCmNum VARCHAR(100) 已发送企微客户
noSenderNum VARCHAR(100) 未发送成员
unSendCmNum VARCHAR(100) 未发送企微客户
maxMessageNum VARCHAR(100) 接受已达上限
noFriend VARCHAR(100) 已不是好友

# 企微客户详情查询接口

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/weCom/v1/queryWeComCusDetail/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
	"page":"1",
	"rows":"1000",
    "id": "5410173148997698901"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
page VARCHAR(10) 否 数据页码，默认为1
rows VARCHAR(10) 否 分页大小，每页默认1000条
id VARCHAR(100) 是 群发ID

响应示例：

{
    "return_code": "0", 
    "return_msg": "响应信息",
    "msg_id": "{ msg_id }",  
    "response_data": "<<DATA>>"
}

数据DATA示例:

[
	{
        "cmCode": "",
        "cmName": "",
        "corpName": "微信",
        "empCorpName": "",
        "hasSend": "0",
        "isView": "0",
        "messageId": "5410173148997698901",
        "picUrl": "http://wx.qlogo.cn/mmhead/RAZ45HHlmicYbXCHCdNcibOkIYkcGf27kFKdupWZDB8Cc/0",
        "senderCode": "huangwanting",
        "senderId": "8589479511034243919",
        "senderName": "黄婉婷",
        "wxName": "🐬"
    },
    {
        "cmCode": "CUS000034,CUS070859,CUS071826",
        "cmName": "苏果果便利店,美景超市,易达超市",
        "corpName": "微信",
        "empCorpName": "",
        "hasSend": "0",
        "isView": "0",
        "messageId": "5410173148997698901",
        "picUrl": "http://wx.qlogo.cn/mmhead/Tjnia6K0WAwzKxZwxvibqM6LWM9a7vPZaglHOexFjsF44cAN58hoIyJA/0",
        "senderCode": "7095",
        "senderId": "8043720992838766939",
        "senderName": "陈朝旭1",
        "wxName": "gapi"
    }
]

参数说明：

参数 类型 必填 说明
messageId VARCHAR(100) 消息ID
senderId VARCHAR(100) 客户ID
picUrl VARCHAR(5000) 微信昵称-头像
wxName VARCHAR(100) 微信昵称-昵称
corpName VARCHAR(100) 微信昵称-来源
cmName VARCHAR(100) 客户名称
cmCode VARCHAR(100) 客户编码
hasSend VARCHAR(100) 是否发送 0/1 否/是
isView VARCHAR(100) 是否查看 0/1 否/是
senderName VARCHAR(100) 发送成员
senderCode VARCHAR(100) 发送成员账号
empCorpName VARCHAR(100) 成员归属企微

# 成员详情查询接口

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/weCom/v1/queryMemberDetail/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
	"page":"1",
	"rows":"1000",
    "id": "5410173148997698901"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
page VARCHAR(10) 否 数据页码，默认为1
rows VARCHAR(10) 否 分页大小，每页默认1000条
id VARCHAR(100) 是 群发ID

响应示例：

{
    "return_code": "0", 
    "return_msg": "响应信息",
    "msg_id": "{ msg_id }",  
    "response_data": "<<DATA>>"
}

数据DATA示例:

[
	{
		"cmNum": "2",
		"empCorpName": "708回归企业",
		"hasRemind": "1",
		"hasSend": "0",
		"messageId": "5410173148997698901",
        "senderCode": "708hg",
        "senderId": "4930208167281892683",
		"senderName": "708回归测试账号",
		"viewCmCount": "0"
	},
	{
		"cmNum": "1",
		"empCorpName": "",
		"hasRemind": "1",
		"hasSend": "0",
		"messageId": "5410173148997698901",
        "senderCode": "wo9ilfCgAA4ugQqLWdsFoljTAyUuLGOw",
        "senderId": "6292391102849922102",
		"senderName": "wangtao",
		"viewCmCount": "0"
	}
]

参数说明：

参数 类型 必填 说明
messageId VARCHAR(100) 消息ID
senderId VARCHAR(100) 客户ID
senderName VARCHAR(100) 姓名
senderCode VARCHAR(100) 账号
empCorpName VARCHAR(100) 成员归属企微
cmNum VARCHAR(100) 预计发送客户数量
hasSend VARCHAR(100) 是否发送 0/1 否/是
viewCmCount VARCHAR(100) 已查看客户数
hasRemind VARCHAR(100) 发送提醒 0/1 否/是

← 错误码说明 →