渠道活码创建接口

请求参数

Header 参数

appId

string

应用 appId

必需

默认值:

timestamp

string

请求时间戳

必需

默认值:

sign

string

请求消息签名值

必需

默认值:

appKey

string

应用 appKey

可选

默认值:

Body 参数application/json

state

string

渠道名

必需

渠道名称，作为渠道唯一ID，创建后不可更改，不超过30字

description

string

渠道描述

可选

渠道的备注信息，用于助记，不超过100字

assignType

integer

分配规则

必需

0 : 随机分配 1：定量分配 2：顺序分配 3：普通分配

qrCodeLogo

string

活码头像地址url

可选

图片大小不能超过2M(需要先进行图片上传的前置操作，根据返回的文件id作为参数传入，且上传图片时效只有一个小时) 文件上传接口：/api/v3/file/upload

backupUserIds

array[integer]

备用员工

必需

探马员工id，最多可选择100个

users

array [object {6}]

使用员工

必需

探马员工id，当分配规则为普通分配时最多可选择100个，当分配规则为随机分配或定量分配或顺序分配时不限制员工数量员工需开通探马账号和企微互通账号

salesId

integer

销售id

必需

销售Id不能为空

index

integer

顺序

必需

人员添加顺序

weight

integer

权重

可选

传入1-100的数字，数字越大，分配的概率越高，当分配规则为随机分配时有效且必填

singleRoundLimit

integer

单轮添加好友上限

可选

传入1-99999的数字，当分配规则为定量分配时有效且必填

perDayLimit

integer

每日添加好友总上限

可选

传入1-99999的数字当分配规则为随机分配或定量分配或顺序分配时有效且必填；当分配规则为普通分配时且员工添加上限为true时有效且必填；当分配规则为普通分配时且员工添加上限为false时不传入该值；

workPeriods

array [object {2}]

工作周期

可选

默认为false，仅在分配规则为随机分配或定量分配或顺序分配时有效

welcomeMsgRule

object

欢迎语规则

可选

textTemplate

string

文本消息模板

可选

msgs

array [object {11}]

欢迎语信息

可选

assignMode

integer

分配模式

必需

0 高效模式; 1 智能模式

groupId

string

所属分组

必需

活码分组id、子级活码分组id

allowOffline

integer

是否允许员工上下线

可选

是否允许员工自己上下线 1允许 0 不允许

avoidMultiFollow

boolean

是否开启避免客户重复添加员工

可选

仅在分配模式为智能模式时有效，默认为false

autoTag

boolean

自动渠道标签

必需

verificationSales

array [object {2}]

去重-员工

可选

开启重复范围后，需去重员工信息员工需存在于系统中

string

必需

name

string

员工名

可选

verificationDepartments

array [object {2}]

去重-部门

可选

开启重复范围后，需去重部门信息

string

必需

name

string

部门名

可选

creatorId

integer

创建人

可选

默认为空，为空时创建人显示为“API”，可传入探马员工id为创建人

isCustomComment

boolean

是否开启自定义备注

可选

是否开启自动备注名

customComment

object

自动备注

可选

comment

string

自定义内容

可选

最多8个字符

commentConfig

array[integer]

自动备注配置

可选

1-自定义内容， 2-添加日期， 3-添加昵称规则：长度不超过3，数组元素为1,2,3 不重复且只为1,2,3

commentSort

array[integer]

自动备注排序

可选

1-自定义内容， 2-添加日期， 3-添加昵称规则：长度为3，数组元素为1,2,3 不重复且只为1,2,3

customerTagIds

array[integer]

客户标签id

可选

输入的标签id 需存在于系统中

verifyType

integer

好友通过方式

必需

0：全天自动通过 1：时间段自动通过 2：手动通过

verifyStart

string

自动通过好友开始时间

可选

HH:mm GMT+8

verifyEnd

string

自动通过好友结束时间

可选

HH:mm GMT+8

allowMaxPerday

integer

允许设置好友上限开关只能是0/1

可选

avoidMultiFollowLimitTimeUnit

integer

是否开启最近一次添加员工几天后可添加

可选

0为开启不开启可以不传

avoidMultiFollowLimitTime

string

具体天数

可选

开启时，为必填最大9999

示例

{
    "state": "tszz69",
    "assignType": 1,
    "verifyType": 1,//好友通过方式
    "backupUserIds": [
        528806338250944
    ],
    "users": [
        {
            "salesId": 484287843737792,
            "salesName": "小瓜瓜",
            "index": 4,
            "weight": 1,
            "singleRoundLimit": 1,
            "perDayLimit": 1,
            "workPeriods": [            
                {
                    "dayOfWeek": "7",
                    "ranges":[
                        {
                            "start": "00:00",
                            "end": "08:00"
                        },
                        {
                            "start": "08:00",
                            "end": "12:00"
                        },
                        {
                            "start": "14:00",
                            "end": "19:00"
                        }
                    ]
                },
                {
                    "dayOfWeek": "1",
                    "ranges":[
                        {
                            "start": "00:00",
                            "end": "08:00"
                        },
                        {
                            "start": "08:00",
                            "end": "12:00"
                        },
                        {
                            "start": "14:00",
                            "end": "19:00"
                        }
                    ]
                }
            ]
        },
        {
            "salesId": 528806338250944,
            "index": 2,
            "weight": 100,
            "singleRoundLimit": 11,
            "perDayLimit": 11
        }
    ],
    "groupId": "548680171319488",
    "autoTag": false,//自动渠道标签
    "allowMaxPerday":1,//是否开启员工添加上限
    "assignMode":1,//分配模式
    "description":"一二三四五12345abcde12345",//渠道描述
    "avoidMultiFollow":true,//避免重复添加员工
    "verificationSales":[
        {"id":484287843737792},
        {"id":435434900011200},
        {"id":361976193431617}
    ],//重复范围-员工
    "verificationDepartments":[
        {"id":65124},
        {"id":108371},
        
    ],//重复范围-部门
    "avoidMultiFollowLimitTime":1,//距离最近一次添加好友天数
    "avoidMultiFollowLimitTimeUnit":1,//
    "creatorId":528806338250944,//创建人
    "allowOffline":1,//是否允许员工上下线
    "customerTagIds":[8540205,8523919,8523917],//自动打标签
    "verifyStart":"00:00",//自动通过好友开始时间
    "verifyEnd":"23:00",//自动通过好友结束时间
    "isCustomComment":true,//是否开启自定义备注
    "customComment":{
        "comment":"aaaaaaaa",//自定义内容,最多8个字符
        "commentConfig":[1],//自动备注配置
        "commentSort":[3,2,1]//自动备注排序
    },
    "qrCodeLogo":"https://betafile.tanmarket.cn/fdfsServer/group1/M00/01/69/rBF5vWSJMFKAUNaqAABCB2fq9Nw755.jpg",//活码头像地址
    "welcomeMsgRule":{
        "textTemplate":"欢迎语",
        "msgs":[
            {
              "msgType":"image",
              "fileUrl":"https://betafile.tanmarket.cn/fdfsServer/group1/M00/01/74/rBF5vWScI6OARZxWABZCYG0q75g335.jpg",
              "index":"6",
              "fileId":"90043",
              "mediaId":"32HzQXi05znyphYQ4dT5bSpuKgK1IS0Z-nXNZ9DcLL09cMDpcYjss5BVbNwkGhgMG",
              "fileName":"cae65154786243b47835583b21213f1c.jpeg",
              "type":null,
              "title":null,
              "desc":null,
              "appId":null,
              "page":null
            },
            {
              "msgType":"file",
              "fileUrl":"https://betafile.tanmarket.cn/fdfsServer/group1/M00/01/74/rBF5vWScI8GAK9e9AAFpWGMyOLs902.tif",
              "index":"5",
              "fileId":"90045",
              "mediaId":"3Y47wlcvsjqtgSXl7T9nbNy5w-zz8YTWJa_TvcXInyUaAZZea3MIAGotReyU_xIza",
              "fileName":"d1b680cc92d637daf2fc2cc178cb70f9.jpeg",
              "type":null,
              "title":null,
              "desc":null,
              "appId":null,
              "page":null
            },
            {
              "msgType":"video",
              "fileUrl":"https://betafile.tanmarket.cn/fdfsServer/group1/M00/01/74/rBF5vWScI7CAK0dUABIgtwt_jlE611.mp4",
              "index":"4",
              "fileId":"90044",
              "mediaId":"3jslcCjQ3XAZ4tt-0iM9zIfqv815CXP1NtYtph0xCtxeO0TVyCYkrMPohcSRCSl_z",
              "fileName":"rBIAY2KPa0aAG1pBABIgtxHuR2Y758.mp4",
              "type":null,
              "title":null,
              "desc":null,
              "appId":null,
              "page":null
            },
            {
              "msgType":"link",
              "fileUrl":"https://betafile.tanmarket.cn/fdfsServer/group1/M00/01/74/rBF5vWScI_yAcKSYAADwUjwaWz041.jpeg",
              "index":"3",
              "fileId":"90047",
              "mediaId":"3YExoZlIsNEMe-zkUCTNLvpSfcARXTb3Avr28ATOOsl5j4VGffjkA58txcRnHWtQ8",
              "fileName":"94779bbe38a8b75c68c19fb66fda66c8.jpeg",
              "type":null,
              "title":"百度",
              "desc":"百度一下，你就知道",
              "appId":null,
              "page":null,
              "url":"https://www.baidu.com/"
            },
            {
              "msgType":"mccontent",
              "fileUrl":"https://beta.tanmarket.cn/fdfsServer/group1/M00/00/A1/rBF5vWMO0baATftxAAvD4w4qA6Y83.jpeg",
              "index":"2",
              "fileId":null,
              "mediaId":null,
              "fileName":null,
              "type":null,
              "title":"预发布回归宣传册预发布回归宣传册预发布回归宣传册预发布回归宣传册预发布回归宣传册",
              "desc":"123123",
              "appId":null,
              "page":null,
              "url":"https://betah5.tanmarket.cn/#/brochure?hjType=1&content_title=%E9%A2%84%E5%8F%91%E5%B8%83%E5%9B%9E%E5%BD%92%E5%AE%A3%E4%BC%A0%E5%86%8C%E9%A2%84%E5%8F%91%E5%B8%83%E5%9B%9E%E5%BD%92%E5%AE%A3%E4%BC%A0%E5%86%8C%E9%A2%84%E5%8F%91%E5%B8%83%E5%9B%9E%E5%BD%92%E5%AE%A3%E4%BC%A0%E5%86%8C%E9%A2%84%E5%8F%91%E5%B8%83%E5%9B%9E%E5%BD%92%E5%AE%A3%E4%BC%A0%E5%86%8C%E9%A2%84%E5%8F%91%E5%B8%83%E5%9B%9E%E5%BD%92%E5%AE%A3%E4%BC%A0%E5%86%8C&trace_deep=0&trace_id=1931e7a3-fae0-4f14-bb85-5b8aac1e277d&content_id=5d3e8d9028dc11edba1067d342d0c574&snapshot_id=5d3e8d9028dc11edba1067d342d0c574&content_type=6&source_title=&source_type=1&showType=1,2,3,4&corp_id=ww03d0b79073a82f04&sales_id="
            },
            {
              "msgType":"miniprogram",
              "fileUrl":"https://betafile.tanmarket.cn/fdfsServer/group1/M00/01/74/rBF5vWScI92Abo1SAAErYijfijA34.jpeg",
              "index":"1",
              "fileId":"90046",
              "mediaId":"3BJ_Ejo7gL-YFQ5TsYQ7gwR4vAXNT8e4oUNOGi_nKMPYQWRgnhbnE7TZEUeK1VjXi",
              "fileName":"92b212b45669e59ad51fce5945f78db5.jpeg",
              "type":null,
              "title":"江小程序",
              "desc":null,
              "appId":"wxbbfa85e7cda25a54",
              "page":"//pages/flash/flash.html gh_ac8cf33be4b3"
            },          
                      
        ]
    }


}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

渠道活码创建接口

请求参数

示例代码

返回响应