企业发表内容到客户的朋友圈-创建发表任务

POST

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

第三方应用开发/客户联系/客户朋友圈/企业发表内容到客户的朋友圈

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

责任人：未设置

企业和第三方应用可通过该接口创建客户朋友圈的发表任务。

可见范围说明

visible_range，分以下几种情况：

若只指定sender_list，则可见的客户范围为该部分执行者的客户，目前执行者支持传userid与部门id列表，注意不在应用可见范围内的执行者会被忽略。

若只指定external_contact_list，即指定了可见该朋友圈的目标客户，此时会将该发表任务推给这些目标客户的应用可见范围内的跟进人。

若同时指定sender_list以及external_contact_list，会将该发表任务推送给sender_list指定的且在应用可见范围内的执行者，执行者发表后仅external_contact_list指定的客户可见。

若未指定visible_range，则可见客户的范围为该应用可见范围内执行者的客户，执行者为应用可见范围内所有成员。

注：若指定external_contact_list列表，则该条朋友圈为部分可见；否则为公开

权限说明：

企业需要使用“客户联系”secret或配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用（accesstoken如何获取？）。
自建应用调用，只会返回应用可见范围内用户的发送情况。
第三方应用或代开发自建应用调用需要企业授权客户朋友圈下发表到成员客户的朋友圈的权限

文档ID: 25254
原文档地址：
https://open.work.weixin.qq.com/api/doc/90001/90143/93443
https://open.work.weixin.qq.com/api/doc/90000/90135/93333

请求参数

Query 参数

access_token

string

调用接口凭证

必需

示例值:

Body 参数application/json

text

object

文本消息

可选

content

string

必需

消息文本内容，最多支持传入2000个字符，若超出长度报错’invalid text size’

attachments

array [object {4}]

可选

附件，最多支持9个图片类型，或者1个视频，或者1个链接。类型只能三选一，若传了不同类型，报错’invalid attachments msgtype’

msgtype

string

必需

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

image

object

可选

图片消息附件。普通图片：建议不超过 1440 x 1080，长图片：长边建议不超过 10800px。图片不超过10M。最多支持传入9个；超过9个报错’invalid attachments size’

video

object

可选

视频消息附件，建议不超过 1280 x 720，帧率 30 FPS，视频码率 1.67 Mbps，最长不超过30S，最大不超过10MB。只支持1个；若超过1个报错’invalid attachments size’

link

object

可选

图文消息附件。只支持1个；若超过1个报错’invalid attachments size’

visible_range

object

可选

指定的发表范围；若未指定，则表示执行者为应用可见范围内所有成员

sender_list

object

必需

发表任务的执行者列表，详见下文的“可见范围说明”

external_contact_list

object

必需

可见到该朋友圈的客户列表，详见下文的“可见范围说明”

示例

{
  "text": {
    "content": "文本消息内容"
  },
  "attachments": [
    {
      "msgtype": "image",
      "image": {
        "media_id": "MEDIA_ID"
      }
    },
    {
      "msgtype": "video",
      "video": {
        "media_id": "MEDIA_ID"
      }
    },
    {
      "msgtype": "link",
      "link": {
        "title": "消息标题",
        "url": "https://example.link.com/path",
        "media_id": "MEDIA_ID"
      }
    }
  ],
  "visible_range": {
    "sender_list": {
      "user_list": [
        "zhangshan",
        "lisi"
      ],
      "department_list": [
        2,
        3
      ]
    },
    "external_contact_list": {
      "tag_list": [
        "etXXXXXXXXXX",
        "etYYYYYYYYYY"
      ]
    }
  }
}

示例代码

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_moment_task?access_token={{accesstoken}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "text": {
        "content": "文本消息内容"
    },
    "attachments": [
        {
            "msgtype": "image",
            "image": {
                "media_id": "MEDIA_ID"
            }
        },
        {
            "msgtype": "video",
            "video": {
                "media_id": "MEDIA_ID"
            }
        },
        {
            "msgtype": "link",
            "link": {
                "title": "消息标题",
                "url": "https://example.link.com/path",
                "media_id": "MEDIA_ID"
            }
        }
    ],
    "visible_range": {
        "sender_list": {
            "user_list": [
                "zhangshan",
                "lisi"
            ],
            "department_list": [
                2,
                3
            ]
        },
        "external_contact_list": {
            "tag_list": [
                "etXXXXXXXXXX",
                "etYYYYYYYYYY"
            ]
        }
    }
}'

返回响应

🟢200成功

application/json

Body

errcode

integer

必需

errmsg

string

必需

jobid

string

必需

异步任务id，最大长度为64字节，24小时有效；可使用获取发表朋友圈任务结果查询任务状态

示例

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

客户群opengid转换

企业发表内容到客户的朋友圈-获取任务创建结果