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

目录

  • 创建发表任务
  • 获取任务创建结果
  • 创建发表任务

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

    请求方式:POST(HTTPS)
    请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/add_moment_task?access_token=ACCESS_TOKEN

    请求示例:

    {
    	"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"]
    		}
    	}
    }

    参数说明:

    参数必须说明
    access_token调用接口凭证
    visible_range指定的发表范围;若未指定,则表示执行者为应用可见范围内所有成员
    sender_list发表任务的执行者列表,详见下文的“可见范围说明”
    sender_list.user_list发表任务的执行者用户列表,最多支持10万个
    sender_list.department_list发表任务的执行者部门列表
    external_contact_list可见到该朋友圈的客户列表,详见下文的“可见范围说明”
    external_contact_list.tag_list可见到该朋友圈的客户标签列表
    text文本消息
    text.content消息文本内容,不能与附件同时为空,最多支持传入2000个字符,若超出长度报错'invalid text size'
    attachments附件,不能与text.content同时为空,最多支持9个图片类型,或者1个视频,或者1个链接。类型只能三选一,若传了不同类型,报错'invalid attachments msgtype'
    msgtype附件类型,可选image、link或者video
    image图片消息附件。普通图片:总像素不超过1555200。图片大小不超过10M。最多支持传入9个;超过9个报错'invalid attachments size'
    image.media_id图片的素材id。可通过上传附件资源接口获得
    link图文消息附件。只支持1个;若超过1个报错'invalid attachments size'
    link.title图文消息标题,最多64个字节
    link.url图文消息链接
    link.media_id图片链接封面,普通图片:总像素不超过1555200。可通过上传附件资源接口获得
    video视频消息附件。最长不超过30S,最大不超过10MB。只支持1个;若超过1个报错'invalid attachments size'
    video.media_id视频的素材id,未填写报错"invalid msg"。可通过上传附件资源接口获得

    可见范围说明

    visible_range,分以下几种情况:

    1. 若只指定sender_list,则可见的客户范围为该部分执行者的客户,目前执行者支持传userid与部门id列表,注意不在应用可见范围内的执行者会被忽略。
    2. 若只指定external_contact_list,即指定了可见该朋友圈的目标客户,此时会将该发表任务推给这些目标客户的应用可见范围内的跟进人。
    3. 若同时指定sender_list以及external_contact_list,会将该发表任务推送给sender_list指定的且在应用可见范围内的执行者,执行者发表后仅external_contact_list指定的客户可见。
    4. 若未指定visible_range,则可见客户的范围为该应用可见范围内执行者的客户,执行者为应用可见范围内所有成员。

    :若指定external_contact_list列表,则该条朋友圈为部分可见;否则为公开

    权限说明:

    • 企业需要使用“客户联系”secret或配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用(accesstoken如何获取?)。
    • 自建应用调用,只会返回应用可见范围内用户的发送情况。
    • 第三方应用或代开发自建应用调用需要企业授权客户朋友圈发表到成员客户的朋友圈的权限
    • 企业每分钟创建朋友圈的频率:10条/分钟

    返回结果:

    {
    	"errcode":0,
    	"errmsg":"ok",
    	"jobid":"xxxx"
    }

    参数说明:

    参数说明
    errcode返回码
    errmsg对返回码的文本描述内容
    jobid异步任务id,最大长度为64字节,24小时有效;可使用获取发表朋友圈任务结果查询任务状态

    获取任务创建结果

    由于发表任务的创建是异步执行的,应用需要再调用该接口以获取创建的结果。
    请求方式:GET(HTTPS
    请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get_moment_task_result?access_token=ACCESS_TOKEN&jobid=JOBID

     

    参数说明:

    参数必须说明
    access_token调用接口凭证
    jobid异步任务id,最大长度为64字节,由创建发表内容到客户朋友圈任务接口获取

    权限说明:

    只能查询已经提交过的历史任务。

    返回结果:

    {
        "errcode": 0,
        "errmsg": "ok",
        "status": 1,
        "type": "add_moment_task",
    	"result": {
    		"errcode":0,
    		"errmsg":"ok"
    		"moment_id":"xxxx",
    		"invalid_sender_list":{
    			"user_list":["zhangshan","lisi"],
    			"department_list":[2,3]
    		},
    		"invalid_external_contact_list":{
    			"tag_list":["xxx"]
    		}
    	}
    }
    
    

    参数说明:

    参数说明
    errcode返回码
    errmsg对返回码的文本描述内容
    status任务状态,整型,1表示开始创建任务,2表示正在创建任务中,3表示创建任务已完成
    type操作类型,字节串,此处固定为add_moment_task
    result详细的处理结果。当任务完成后此字段有效
    result.errcode返回码
    result.errmsg对返回码的文本描述内容
    result.moment_id朋友圈id,可通过获取客户朋友圈企业发表的列表接口获取朋友圈企业发表的列表
    result.invalid_sender_list不合法的执行者列表,包括不存在的id以及不在应用可见范围内的部门或者成员
    上一篇
    概述
    下一篇
    获取客户朋友圈全部的发表记录