# 发送消息

接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考接口调用指南

接口英文名：sendmsg

通过该接口，商家客服可以向指定用户发送客服消息，支持文本、图片、视频等多种消息类型。

# 1. 调用方式

# HTTPS 调用

POST https://api.weixin.qq.com/channels/ec/commkf/sendmsg?access_token=ACCESS_TOKEN

# 云调用

本接口不支持云调用

# 第三方调用

本接口不支持第三方平台调用。

# 2. 请求参数

# 查询参数 `Query String parameters`

参数名	类型	必填	示例	说明
access_token	string	是	ACCESS_TOKEN	接口调用凭证，可使用 access_token

# 请求体 `Request Payload`

参数名	类型	必填	示例	说明
request_id	string	否	63abd34b-656b-4082-b364-5f74226e1a20	唯一任务ID，如果填写则以该任务ID进行去重
open_id	string	是	o7eep4jVQelr2eyoDSmE1xxxxxx	用户的 open_id，用于标识上传资源的用户。
msg_type	string	是	file	文件类型， file（文件）、text（文本）、image（图片）、video（视频）、product_share (商品卡片)、order_share（订单卡片）
text	object	是	text	msg_type 为 text 时必填，包含消息内容。
image	object	是	image	msg_type 为 image 时必填，包含消息内容。
video	object	是	video	msg_type 为 video 时必填，包含消息内容。
product_share	object	是	product_share	msg_type 为 product_share 时必填，包含消息内容。
order_share	object	是	order_share	msg_type 为 order_share 时必填，包含消息内容。
file	object	是	file	msg_type 为 file 时必填，包含消息内容。

# Body.text `Object Payload`

msg_type 为 text 时必填，包含消息内容。

参数名	类型	必填	示例	说明
content	string	是	测试消息123	msg_type 为 text 时，必填写的消息

# Body.image `Object Payload`

msg_type 为 image 时必填，包含消息内容。

参数名	类型	必填	示例	说明
cos_url	string	是	上传多媒体cos_url	msg_type 为 image 时，必填写的消息

# Body.video `Object Payload`

msg_type 为 video 时必填，包含消息内容。

参数名	类型	必填	示例	说明
cos_url	string	是	上传多媒体cos_url	msg_type 为 video时，必填写的消息

# Body.product_share `Object Payload`

msg_type 为 product_share 时必填，包含消息内容。

参数名	类型	必填	示例	说明
product_id	string	是	当前店铺的商品Id	msg_type 为 product_share 时，必填写的消息

# Body.order_share `Object Payload`

msg_type 为 order_share 时必填，包含消息内容。

参数名	类型	必填	示例	说明
order_id	string	是	当前店铺的订单Id	msg_type 为 order_share 时，必填写的消息

# Body.file `Object Payload`

msg_type 为 file 时必填，包含消息内容。

参数名	类型	必填	示例	说明
cos_url	string	是	上传多媒体cos_url	msg_type 为 file 时，必填写的消息

# 3. 返回参数

# 返回体 `Response Payload`

参数名	类型	示例	说明
msg_id	string	3886839959369302016	消息的单调自增msg_id
errmsg	string	ok	错误信息
errcode	number	0	错误码

# 4. 注意事项

消息类型：支持 file（文件）、text（文本）、image（图片）、video（视频）、product_share (商品卡片)、order_share（订单卡片）等多种消息类型;
当用户发消息后，且在用户下一次发送消息之前，客服只可在48小时内回复用户，且最多可以回复5条消息。
确保用户的 open_id 是有效的，且用户已与商家有过互动。
消息发送会经过风控、数据反垃圾，请注意发送消息内容安全。
根据《中华人民共和国个人信息保护法》规定，使用自研客服工具进行客服接待时，聊天中涉及到用户联系方式、用户地址等内容将会自动加密处理。

# 5. 代码示例

# 5.1 请求参数示例（文件消息）

请求示例

文件消息 - Content Body，参数请使用Json格式传输

{
    "request_id": "63abd34b-656b-4082-b364-5f74226e1a20",
    "open_id": "o7eep4jVQelr2eyoDSmE1xxxxxx",
    "msg_type": "file",
    "file": {
        "cos_url": "https://channels.weixin.qq.com/shop/commkf/downloadmedia?encrypted_param=xxxx&timestamp=xxxx&openid=o7eep4jVQelr2eyoDSmE1xxxxxx&msg_type=8"
    }
}

返回示例

{
    "msg_id": "3886839959369302016",
    "errmsg": "ok",
    "errcode": 0
}

# 5.2 请求参数示例（文本消息）

请求示例

文本消息 - Content Body，参数请使用Json格式传输

{
    "request_id": "63abd34b-656b-4082-b364-5f74226e1a20",
    "open_id": "o7eep4jVQelr2eyoDSmE1xxxxxx",
    "msg_type": "text",
    "text": {
        "content": "测试消息123"
    }
}

返回示例

{
    "msg_id": "3886839959369302016",
    "errmsg": "ok",
    "errcode": 0
}

# 5.3 请求参数示例（图文消息）

请求示例

图文消息 - Content Body，参数请使用Json格式传输

{
    "request_id": "63abd34b-656b-4082-b364-5f74226e1a20",
    "open_id": "o7eep4jVQelr2eyoDSmE1xxxxxx",
    "msg_type": "image",
    "image": {
        "cos_url": "https://channels.weixin.qq.com/shop/commkf/downloadmedia?encrypted_param=xxxx&timestamp=xxxx&openid=o7eep4jVQelr2eyoDSmE1xxxxxx&msg_type=2"
    }
}

返回示例

{
    "msg_id": "3886839959369302016",
    "errmsg": "ok",
    "errcode": 0
}

# 5.4 请求参数示例（订单分享卡片消息）

请求示例

订单分享卡片消息 - Content Body，参数请使用Json格式传输

{
    "request_id": "63abd34b-656b-4082-b364-5f74226e1a20",
    "open_id": "o7eep4jVQelr2eyoDSmE1xxxxxx",
    "msg_type": "order_share",
    "order_share": {
        "order_id": "372647xxxxxxxxxxx"
    }
}

返回示例

{
    "msg_id": "3886839959369302016",
    "errmsg": "ok",
    "errcode": 0
}

# 5.5 请求参数示例（商品分享卡片消息）

请求示例

商品分享卡片消息 - Content Body，参数请使用Json格式传输

{
    "request_id": "63abd34b-656b-4082-b364-5f74226e1a20",
    "open_id": "o7eep4jVQelr2eyoDSmE1xxxxxx",
    "msg_type": "product_share",
    "product_share": {
        "product_id": "10000xxxxxxx"
    }
}

返回示例

{
    "msg_id": "3886839959369302016",
    "errmsg": "ok",
    "errcode": 0
}

# 6. 错误码

此接口没有特殊错误码，可参考通用错误码

# 7. 适用范围

本接口支持「微信小店（需申请）」账号类型调用。其他账号类型如无特殊说明，均不可调用。

# 发送消息

# 1. 调用方式

# HTTPS 调用

# 云调用

# 第三方调用

# 2. 请求参数

# 查询参数 Query String parameters

# 请求体 Request Payload

# Body.text Object Payload

# Body.image Object Payload

# Body.video Object Payload

# Body.product_share Object Payload

# Body.order_share Object Payload

# Body.file Object Payload

# 3. 返回参数

# 返回体 Response Payload

# 4. 注意事项

# 5. 代码示例

# 5.1 请求参数示例（文件消息）

# 5.2 请求参数示例（文本消息）

# 5.3 请求参数示例（图文消息）

# 5.4 请求参数示例（订单分享卡片消息）

# 5.5 请求参数示例（商品分享卡片消息）

# 6. 错误码

# 7. 适用范围

# 查询参数 `Query String parameters`

# 请求体 `Request Payload`

# Body.text `Object Payload`

# Body.image `Object Payload`

# Body.video `Object Payload`

# Body.product_share `Object Payload`

# Body.order_share `Object Payload`

# Body.file `Object Payload`

# 返回体 `Response Payload`