View Source WeChat.Work.KF.Message (wechat v0.16.0)
客服消息
Summary
Types
事件响应消息对应的code。
消息ID。如果请求参数指定了msgid,则原样返回,否则系统自动生成并返回。 不多于32字节 字符串取值范围(正则表达式):[0-9a-zA-Z_-]*
消息类型
事件响应消息类型
Types
@type code() :: String.t()
事件响应消息对应的code。
通过事件回调下发,仅可使用一次。
@type content() :: String.t()
@type msg() :: map()
@type msg_id() :: String.t()
消息ID。如果请求参数指定了msgid,则原样返回,否则系统自动生成并返回。 不多于32字节 字符串取值范围(正则表达式):[0-9a-zA-Z_-]*
@type msg_type() :: String.t()
消息类型
text
: 文本消息image
: 图片消息voice
: 语音消息video
: 视频消息file
: 文件消息link
: 图文链接消息miniprogram
: 小程序消息msgmenu
: 菜单消息location
: 地理位置消息
@type on_event_msg_type() :: String.t()
事件响应消息类型
目前支持文本与菜单消息
text
: 文本消息msgmenu
: 菜单消息
@type opts() :: Enumerable.t()
Functions
Link to this function
send_file(client, agent, to_openid, open_kfid, media_id, opts \\ [])
View Source@spec send_file( WeChat.Work.client(), WeChat.Work.agent(), WeChat.openid(), WeChat.Work.KF.Account.open_kfid(), Material.media_id(), opts() ) :: WeChat.response()
发送文件消息 - 官方文档
Link to this function
send_image(client, agent, to_openid, open_kfid, media_id, opts \\ [])
View Source@spec send_image( WeChat.Work.client(), WeChat.Work.agent(), WeChat.openid(), WeChat.Work.KF.Account.open_kfid(), Material.media_id(), opts() ) :: WeChat.response()
发送图片消息 - 官方文档
@spec send_link( WeChat.Work.client(), WeChat.Work.agent(), WeChat.openid(), WeChat.Work.KF.Account.open_kfid(), msg(), opts() ) :: WeChat.response()
图文链接消息 - 官方文档
Link to this function
send_location(client, agent, to_openid, open_kfid, msg, opts \\ [])
View Source@spec send_location( WeChat.Work.client(), WeChat.Work.agent(), WeChat.openid(), WeChat.Work.KF.Account.open_kfid(), msg(), opts() ) :: WeChat.response()
地理位置消息 - 官方文档
@spec send_message(WeChat.Work.client(), WeChat.Work.agent(), body :: map()) :: WeChat.response()
发送消息 - 官方文档
当用户在主动发送消息给微信客服时,企业可在48小时内调用该接口发送消息给用户,最多可发送5条消息给客户;若用户继续发送消息,企业可再次下发消息。 支持发送消息类型:文本、图片、语音、视频、文件、图文、小程序、菜单消息、地理位置。 目前该接口允许下发消息条数和下发时限如下:
用户动作 | 允许下发条数限制 | 下发时限 |
---|---|---|
用户发送消息 | 5条 | 48 小时 |
Link to this function
send_message(client, agent, to_openid, open_kfid, msg_type, msg, opts \\ [])
View Source@spec send_message( WeChat.Work.client(), WeChat.Work.agent(), WeChat.openid(), WeChat.Work.KF.Account.open_kfid(), WeChat.Work.Message.msg_type(), WeChat.Work.Message.msg(), opts() ) :: WeChat.response()
Link to this function
send_mini_program(client, agent, to_openid, open_kfid, msg, opts \\ [])
View Source@spec send_mini_program( WeChat.Work.client(), WeChat.Work.agent(), WeChat.openid(), WeChat.Work.KF.Account.open_kfid(), msg(), opts() ) :: WeChat.response()
小程序消息 - 官方文档
Link to this function
send_msg_on_event(client, agent, code, on_event_msg_type, msg, msg_id \\ nil)
View Source@spec send_msg_on_event( WeChat.Work.client(), WeChat.Work.agent(), code(), on_event_msg_type(), msg(), msg_id() ) :: WeChat.response()
发送事件响应消息 - 官方文档
当特定的事件回调消息包含code字段,可以此code为凭证,调用该接口给用户发送相应事件场景下的消息,如客服欢迎语。
支持发送消息类型:文本、菜单消息。
Link to this function
send_text(client, agent, to_openid, open_kfid, content, opts \\ [])
View Source@spec send_text( WeChat.Work.client(), WeChat.Work.agent(), WeChat.openid(), WeChat.Work.KF.Account.open_kfid(), content(), opts() ) :: WeChat.response()
发送文本消息 - 官方文档
@spec send_text_on_event( WeChat.Work.client(), WeChat.Work.agent(), code(), content(), msg_id() ) :: WeChat.response()
发送事件响应消息[文本消息] - 官方文档
Link to this function
send_video(client, agent, to_openid, open_kfid, media_id, title, description, opts \\ [])
View Source@spec send_video( WeChat.Work.client(), WeChat.Work.agent(), WeChat.openid(), WeChat.Work.KF.Account.open_kfid(), Material.media_id(), title :: String.t(), description :: String.t(), opts() ) :: WeChat.response()
发送视频消息 - 官方文档
Link to this function
send_voice(client, agent, to_openid, open_kfid, media_id, opts \\ [])
View Source@spec send_voice( WeChat.Work.client(), WeChat.Work.agent(), WeChat.openid(), WeChat.Work.KF.Account.open_kfid(), Material.media_id(), opts() ) :: WeChat.response()
发送语音消息 - 官方文档
@spec sync_msg(WeChat.Work.client(), WeChat.Work.agent(), opts :: Enumerable.t()) :: WeChat.response()
获取消息 - 官方文档
客户主动发给微信客服的消息、发送消息接口发送失败事件(如被用户拒收)、客户点击菜单消息的回复消息,可以通过该接口获取具体的消息内容和事件。不支持获取通过接口发送的消息。
支持的消息类型:文本、图片、语音、视频、文件、位置、事件。