获取企业已配置的「联系我」方式

POST

/cgi-bin/externalcontact/get_contact_way

获取企业配置的「联系我」二维码和「联系我」小程序按钮。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get_contact_way?access_token=ACCESS_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
   "config_id":"42b34949e138eb6e027c123cba77fad7"
}'

响应示例

{
    "errcode": 0,
    "errmsg": "ok",
    "contact_way": {
        "config_id": "42b34949e138eb6e027c123cba77fAAA",
        "type": 1,
        "scene": 1,
        "style": 2,
        "remark": "test remark",
        "skip_verify": true,
        "state": "teststate",
        "qr_code": "http://p.qpic.cn/wwhead/duc2TvpEgSdicZ9RrdUtBkv2UiaA/0",
        "user": [
            "zhangsan",
            "lisi",
            "wangwu"
        ],
        "party": [
            2,
            3
        ],
        "is_temp": true,
        "expires_in": 86400,
        "chat_expires_in": 86400,
        "unionid": "oxTWIuGaIt6gTKsQRLau2M0AAAA",
        "conclusions": {
            "text": {
                "content": "文本消息内容"
            },
            "image": {
                "pic_url": "http://p.qpic.cn/pic_wework/XXXXX"
            },
            "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"
            }
        }
    }
}

请求参数

Query 参数

access_token

调用接口凭证

必需

示例值:

ACCESS_TOKEN

Body 参数application/json

config_id

string

联系方式的配置id

必需

示例

返回响应

🟢200成功

application/json

Body

errcode

integer

返回码

必需

errmsg

string

必需

对返回码的文本描述内容

contact_way

object

必需

config_id

string

必需

新增联系方式的配置id

type

integer

必需

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

scene

integer

必需

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

style

integer

必需

小程序中联系按钮的样式，仅在scene为1时返回，详见附录

remark

string

必需

联系方式的备注信息，用于助记

skip_verify

boolean

必需

外部客户添加时是否无需验证

state

string

必需

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

qr_code

string

必需

联系二维码的URL，仅在scene为2时返回

user

array[string]

必需

使用该联系方式的用户userID列表

party

array[integer]

必需

使用该联系方式的部门id列表

is_temp

boolean

必需

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

expires_in

integer

必需

临时会话二维码有效期，以秒为单位

chat_expires_in

integer

必需

临时会话有效期，以秒为单位

unionid

string

必需

可进行临时会话的客户unionid

conclusions

object

必需

结束语，可参考“结束语定义”

修改于 2022-01-14 04:25:42

配置客户联系「联系我」方式

获取企业已配置的「联系我」列表