cn.felord.api

Interface GroupMessageApi

public interface GroupMessageApi

企业群发

Since:

2021 /8/19 14:45

Author:

dax

Method Summary

Modifier and Type	Method and Description
MsgTemplateResponse	addMsgTemplate(MsgTemplateRequest request) 创建企业群发
GenericResponse<String>	addWelcomeTemplate(WelcomeTemplateAddRequest request) 添加入群欢迎语素材
WeComResponse	cancelGroupmsgSend(MsgId msgId) 停止企业群发
WeComResponse	delWelcomeTemplate(DelWelcomeTmpRequest request) 删除入群欢迎语素材（仅适用于旧的第三方多应用套件）
WeComResponse	delWelcomeTemplate(TemplateId templateId) 删除入群欢迎语素材
WeComResponse	editWelcomeTemplate(WelcomeTemplateEditRequest request) 编辑入群欢迎语素材
GroupMsgListResponse	getGroupMsgListV2(GroupMsgListRequest request) 获取群发记录列表
GroupMsgSendResultResponse	getGroupMsgSendResult(GroupMsgSendResultRequest request) 获取企业群发成员执行结果
GroupMsgTaskResponse	getGroupMsgTask(GroupMsgTaskRequest request) 获取群发成员发送任务列表
WelcomeTemplateResponse	getWelcomeTemplate(TemplateId templateId) 获取入群欢迎语素材
WeComResponse	remindGroupmsgSend(MsgId msgId) 提醒成员群发
WeComResponse	sendWelcomeGroupMsg(WelcomeCodeRequest request) 发送新客户欢迎语

Method Detail

addMsgTemplate

@POST(value="externalcontact/add_msg_template")
MsgTemplateResponse addMsgTemplate(@Body
                                                                                   MsgTemplateRequest request)

创建企业群发

当前创建企业群发是没有办法指定群聊的，服务人员接收到群发消息推送时，是下发给所有的客户

Parameters:

request - the request

Returns:

the moment list

remindGroupmsgSend

@POST(value="externalcontact/remind_groupmsg_send")
WeComResponse remindGroupmsgSend(@Body
                                                                                     MsgId msgId)

提醒成员群发

企业和第三方应用可调用此接口，重新触发群发通知，提醒成员完成群发任务，24小时内每个群发最多触发三次提醒。

Parameters:

msgId - the msg id

Returns:

the msg template response

cancelGroupmsgSend

@POST(value="externalcontact/cancel_groupmsg_send")
WeComResponse cancelGroupmsgSend(@Body
                                                                                     MsgId msgId)

停止企业群发

Parameters:

msgId - the msg id

Returns:

the we com response

getGroupMsgListV2

@POST(value="externalcontact/get_groupmsg_list_v2")
GroupMsgListResponse getGroupMsgListV2(@Body
                                                                                           GroupMsgListRequest request)

获取群发记录列表

Parameters:

request - the request

Returns:

the groupmsg list v 2

getGroupMsgTask

@POST(value="externalcontact/get_groupmsg_task")
GroupMsgTaskResponse getGroupMsgTask(@Body
                                                                                      GroupMsgTaskRequest request)

获取群发成员发送任务列表

Parameters:

request - the request

Returns:

the group msg task

getGroupMsgSendResult

@POST(value="externalcontact/get_groupmsg_send_result")
GroupMsgSendResultResponse getGroupMsgSendResult(@Body
                                                                                                         GroupMsgSendResultRequest request)

获取企业群发成员执行结果

Parameters:

request - the request

Returns:

the group msg send result

sendWelcomeGroupMsg

@POST(value="externalcontact/send_welcome_msg")
WeComResponse sendWelcomeGroupMsg(@Body
                                                                                  WelcomeCodeRequest request)

发送新客户欢迎语

Parameters:

request - the request

Returns:

group msg send result response

addWelcomeTemplate

@POST(value="externalcontact/group_welcome_template/add")
GenericResponse<String> addWelcomeTemplate(@Body
                                                                                                     WelcomeTemplateAddRequest request)

添加入群欢迎语素材

Parameters:

request - the request

Returns:

the generic response

editWelcomeTemplate

@POST(value="externalcontact/group_welcome_template/edit")
WeComResponse editWelcomeTemplate(@Body
                                                                                             WelcomeTemplateEditRequest request)

编辑入群欢迎语素材

Parameters:

request - the request

Returns:

the we com response

getWelcomeTemplate

@POST(value="externalcontact/group_welcome_template/get")
WelcomeTemplateResponse getWelcomeTemplate(@Body
                                                                                                     TemplateId templateId)

获取入群欢迎语素材

Parameters:

templateId - the template id

Returns:

the welcome template

delWelcomeTemplate

@POST(value="externalcontact/group_welcome_template/del")
WeComResponse delWelcomeTemplate(@Body
                                                                                           TemplateId templateId)

删除入群欢迎语素材

Parameters:

templateId - the template id

Returns:

the welcome template response

delWelcomeTemplate

@POST(value="externalcontact/group_welcome_template/del")
WeComResponse delWelcomeTemplate(@Body
                                                                                           DelWelcomeTmpRequest request)

删除入群欢迎语素材（仅适用于旧的第三方多应用套件）

Parameters:

request - the request

Returns:

the we com response