客户联系「联系我」管理-更新企业已配置的「联系我」方式

POST

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

第三方应用开发/客户联系/企业服务人员管理

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

责任人：未设置

更新企业配置的「联系我」二维码和「联系我」小程序按钮中的信息，如使用人员和备注等。

注意:
通过API添加的「联系我」不会在管理端进行展示，每个企业可通过API最多配置50万个「联系我」。
用户需要妥善存储返回的config_id，config_id丢失可能导致用户无法编辑或删除「联系我」。
临时会话模式不占用「联系我」数量，但每日最多添加10万个，并且仅支持单人。
临时会话模式的二维码，添加好友完成后该二维码即刻失效。

注意，每个联系方式最多配置100个使用成员（包含部门展开后的成员）
当设置为临时会话模式时（即is_temp为true），联系人仅支持配置为单人，暂不支持多人
使用unionid需要调用方（企业或服务商）的企业微信“客户联系”中已绑定微信开发者账户

文档ID: 15645
原文档地址：
https://open.work.weixin.qq.com/api/doc/92228
https://open.work.weixin.qq.com/api/doc/90000/90135/92572
https://open.work.weixin.qq.com/api/doc/90001/90143/92577

请求参数

Query 参数

access_token

string

调用接口凭证

必需

示例值:

Body 参数application/json

type

integer

必需

联系方式类型,1-单人, 2-多人

scene

integer

必需

场景，1-在小程序中联系，2-通过二维码联系

style

integer

可选

在小程序中联系时使用的控件样式，详见附表

remark

string

必需

联系方式的备注信息，用于助记，不超过30个字符

skip_verify

boolean

必需

外部客户添加时是否无需验证，默认为true

state

string

必需

企业自定义的state参数，用于区分不同的添加渠道，在调用“获取外部联系人详情”时会返回该参数值，不超过30个字符

user

array[string]

必需

使用该联系方式的用户userID列表，在type为1时为必填，且只能有一个

party

array[integer]

必需

使用该联系方式的部门id列表，只在type为2时有效

is_temp

boolean

必需

是否临时会话模式，true表示使用临时会话模式，默认为false

expires_in

integer

必需

临时会话二维码有效期，以秒为单位。该参数仅在is_temp为true时有效，默认7天，最多为14天

chat_expires_in

integer

必需

临时会话有效期，以秒为单位。该参数仅在is_temp为true时有效，默认为添加好友后24小时，最多为14天

unionid

string

必需

可进行临时会话的客户unionid，该参数仅在is_temp为true时有效，如不指定则不进行限制

conclusions

object

必需

结束语，会话结束时自动发送给客户，可参考“结束语定义”，仅在is_temp为true时有效

text

object

必需

image

object

必需

link

object

必需

miniprogram

object

必需

field1

string

必需

示例

{
  "type": 1,
  "scene": 1,
  "style": 1,
  "remark": "渠道客户",
  "skip_verify": true,
  "state": "teststate",
  "user": [
    "zhangsan",
    "lisi",
    "wangwu"
  ],
  "party": [
    2,
    3
  ],
  "is_temp": true,
  "expires_in": 86400,
  "chat_expires_in": 86400,
  "unionid": "oxTWIuGaIt6gTKsQRLau2M0AAAA",
  "conclusions": {
    "text": {
      "content": "文本消息内容"
    },
    "image": {
      "media_id": "MEDIA_ID"
    },
    "link": {
      "title": "消息标题",
      "picurl": "https://example.pic.com/path",
      "desc": "消息描述",
      "url": "https://example.link.com/path"
    },
    "miniprogram": {
      "title": "消息标题",
      "pic_media_id": "MEDIA_ID",
      "appid": "wx8bd80126147dfAAA",
      "page": "/path/index.html"
    }
  }
}

示例代码

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/add_contact_way?access_token={{accesstoken}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": 1,
    "scene": 1,
    "style": 1,
    "remark": "渠道客户",
    "skip_verify": true,
    "state": "teststate",
    "user": [
        "zhangsan",
        "lisi",
        "wangwu"
    ],
    "party": [
        2,
        3
    ],
    "is_temp": true,
    "expires_in": 86400,
    "chat_expires_in": 86400,
    "unionid": "oxTWIuGaIt6gTKsQRLau2M0AAAA",
    "conclusions": {
        "text": {
            "content": "文本消息内容"
        },
        "image": {
            "media_id": "MEDIA_ID"
        },
        "link": {
            "title": "消息标题",
            "picurl": "https://example.pic.com/path",
            "desc": "消息描述",
            "url": "https://example.link.com/path"
        },
        "miniprogram": {
            "title": "消息标题",
            "pic_media_id": "MEDIA_ID",
            "appid": "wx8bd80126147dfAAA",
            "page": "/path/index.html"
        }
    }
}'

返回响应

🟢200成功

application/json

Body

errcode

integer <int32>

返回码

可选

errmsg

string

可选

对返回码的文本描述内容

config_id

string

可选

新增联系方式的配置id

qr_code

string

可选

联系我二维码链接，仅在scene为2时返回

示例

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

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

获取配置了客户联系功能的成员列表

客户联系「联系我」管理-获取企业已配置的「联系我」方式