发送新客户欢迎语

POST

http://127.0.0.1/cgi-bin/externalcontact/send_welcome_msg

第三方应用开发/客户联系/消息推送

最后修改时间：2022-08-30 03:03:36

责任人：未设置

企业微信在向企业推送添加外部联系人事件时，会额外返回一个welcome_code，企业以此为凭据调用接口，即可通过成员向新添加的客户发送个性化的欢迎语。
为了保证用户体验以及避免滥用，企业仅可在收到相关事件后20秒内调用，且只可调用一次。
如果企业已经在管理端为相关成员配置了可用的欢迎语，则推送添加外部联系人事件时不会返回welcome_code。
每次添加新客户时可能有多个企业自建应用/第三方应用收到带有welcome_code的回调事件，但仅有最先调用的可以发送成功。后续调用将返回41051（externaluser has started chatting）错误，请用户根据实际使用需求，合理设置应用可见范围，避免冲突。
旧接口发送新客户欢迎语已经废弃，接口升级后支持发送视频文件，并且最多支持同时发送9个附件

text和attachments不能同时为空；
text与附件信息可以同时发送，此时将会以多条消息的形式触达客户
attachments中每个附件信息必须与msgtype一致，例如，msgtype指定为image，则需要填写image.pic_url或者image.media_id，否则会报错。
media_id和pic_url只需填写一个，两者同时填写时使用media_id，二者不可同时为空。
权限说明:

企业需要使用“客户联系”secret或配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用（accesstoken如何获取？）。
第三方应用需要拥有“企业客户权限->客户联系->给客户发送欢迎语”权限
企业成员需在应用的可见范围内

文档ID: 16489
原文档地址：
https://open.work.weixin.qq.com/api/doc/90000/90135/92137
https://open.work.weixin.qq.com/api/doc/90001/90143/92599

请求参数

Query 参数

access_token

string

调用接口凭证

必需

示例值:

Body 参数application/json

welcome_code

string

必需

通过添加外部联系人事件推送给企业的发送欢迎语的凭证，有效期为20秒

text

object

可选

content

string

必需

消息文本内容,最长为4000字节

attachments

array [object {6}]

必需

附件，最多可添加9个附件

msgtype

string

必需

附件类型，可选image、link、miniprogram或者video

image

object

可选

link

object

可选

miniprogram

object

可选

video

object

可选

file

object

可选

示例

{
  "welcome_code": "CALLBACK_CODE",
  "text": {
    "content": "文本消息内容"
  },
  "attachments": [
    {
      "msgtype": "image",
      "image": {
        "media_id": "MEDIA_ID",
        "pic_url": "http://p.qpic.cn/pic_wework/3474110808/7a6344sdadfwehe42060/0"
      }
    },
    {
      "msgtype": "link",
      "link": {
        "title": "消息标题",
        "picurl": "https://example.pic.com/path",
        "desc": "消息描述",
        "url": "https://example.link.com/path"
      }
    },
    {
      "msgtype": "miniprogram",
      "miniprogram": {
        "title": "消息标题",
        "pic_media_id": "MEDIA_ID",
        "appid": "wx8bd80126147dfAAA",
        "page": "/path/index.html"
      }
    },
    {
      "msgtype": "video",
      "video": {
        "media_id": "MEDIA_ID"
      }
    },
    {
      "msgtype": "file",
      "file": {
        "media_id": "MEDIA_ID"
      }
    }
  ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST 'http://127.0.0.1/cgi-bin/externalcontact/send_welcome_msg?access_token={{accesstoken}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "welcome_code": "CALLBACK_CODE",
    "text": {
        "content": "文本消息内容"
    },
    "attachments": [
        {
            "msgtype": "image",
            "image": {
                "media_id": "MEDIA_ID",
                "pic_url": "http://p.qpic.cn/pic_wework/3474110808/7a6344sdadfwehe42060/0"
            }
        },
        {
            "msgtype": "link",
            "link": {
                "title": "消息标题",
                "picurl": "https://example.pic.com/path",
                "desc": "消息描述",
                "url": "https://example.link.com/path"
            }
        },
        {
            "msgtype": "miniprogram",
            "miniprogram": {
                "title": "消息标题",
                "pic_media_id": "MEDIA_ID",
                "appid": "wx8bd80126147dfAAA",
                "page": "/path/index.html"
            }
        },
        {
            "msgtype": "video",
            "video": {
                "media_id": "MEDIA_ID"
            }
        },
        {
            "msgtype": "file",
            "file": {
                "media_id": "MEDIA_ID"
            }
        }
    ]
}'

返回响应

🟢200成功

application/json

Body

errcode

integer <int32>

返回码

可选

errmsg

string

可选

对返回码的文本描述内容

示例

{
  "errcode": 0,
  "errmsg": "string"
}

修改于 2022-08-30 03:03:36

创建企业群发

入群欢迎语素材管理-添加