...
响应数据类型
[ "application/json" ]
使用场景:
...
请求头参数
属性 | 类型 | 必填 | 说明 |
---|---|---|---|
X-Token | string | 是 | 自建应用访问token |
请求体参数
属性 | 类型 | 必填 | 说明 |
---|---|---|---|
属性 | 类型 | 必填 | 说明 |
publicParams | Object | 是 | 用户标签导入配置 |
└─isMatching | boolean | 是 | 是否进行用户匹配(true, false) |
└─matchingType | int32 | 否 | 匹配方式(1: 精准匹配, 2: 模糊匹配) |
└─identifyWay | int32 | 否 | 模糊匹配 必传->身份识别方式(1: 开放平台unionid>公众号openid>手机号>用户ID, 2: 用户ID>手机号>公众号openid>开放平台unionid) |
└─accurateMatchType | string | 否 | 精确匹配的应用类型(gzh: 公众号, workwechat: 企业微信, YOUZAN: 有赞, EZR: 驿客, contentminiapp: 小程序, contenthome: 小程序首页) |
└─accurateMatchValue | string | 否 | 精确匹配的应用ID |
└─optType | string | 是 | 导入方式(add: 新增, delete: 删除) |
data | Array | 是 | 用户标签。导入数据,每次最大500条 |
└─identityType | string | 否 | 精确匹配 必填,身份识别类型(phone: 手机号码, id: 用户ID, openid: 公众号openid, unionid: 开放平台unionid) |
└─thirdId | string | 否 | 用户ID |
└─openid | string | 否 | 公众号openid |
└─unionid | string | 否 | 开放平台unionid |
└─phone | string | 否 | 手机 |
└─tags | string | 否 | 用户标签,多个用,号隔开 |
返回参数
属性 | 类型 | 说明 |
---|---|---|
code | string | 响应状态码。200-请求成功, 100100-appid、secret错误, 100200-token错误 ,100300-授权code错误 |
data | long | 导入批次ID,用来查询导入结果,查询数据导入结果 |
errorCode | string | 错误码 |
msg | string | 消息提示 |
调用示例
示例说明: HTTPS调用
请求数据示例
{
"publicParams"
:{
"isMatching"
:
true
,
"matchingType"
:
2
,
"identifyWay"
:
1
,
"optType"
:
"add"
},
"data"
:[{
"thirdId"
:
"1"
,
"groups"
:
"group1,group2"
}]
}
返回数据示例
{
"code"
:
"200"
,
"errorCode"
:
"SUCCESS"
,
"msg"
:
"ok"
,
"data"
:
15314513451345123
}
Markdown |
---|
**接口地址** `/api/integrate/audience/group/rel/batchAdd` **请求方式** `POST` **consumes** `["application/json"]` **produces** `["application/json"]` **接口描述** `企业级接口,hearer必须携带X-Token` **应用权限** `用户->用户分组` #请求参数 *** ###请求头参数 | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------ | ------ | ------ | ------ | ------ | ------ | | X-Token | 自建应用访问token | header | true | string | | ###公共参数 | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------ | ------ | ------ | ------ | ------ | ------ | | publicParams | 导入配置 | body | true | object | [用户分组导入配置](#用户分组导入配置) | | data | 导入数据,每次最大500条 | body | true | array | [用户分组](#用户分组) | ###用户分组导入配置 | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------ | ------ | ------ | ------ | ------ | ------ | | isMatching | 是否进行用户匹配(true, false) | body | true | boolean | | | matchingType | 匹配方式(1: 精准匹配, 2: 模糊匹配) | body | false | int | | | identifyWay | 模糊匹配 必传->身份识别方式(1: 开放平台unionid>公众号openid>手机号>用户ID, 2: 用户ID>手机号>公众号openid>开放平台unionid) | body | false | int | | | accurateMatchType | 精确匹配的应用类型(gzh: 公众号, workwechat: 企业微信, YOUZAN: 有赞, EZR: 驿客, contentminiapp: 小程序, contenthome: 小程序首页) | body | false | String | | | accurateMatchValue | 精确匹配的应用ID | body | false | String | | | optType | 导入方式(add: 新增, delete: 删除) | body | true | String | | ###用户分组 | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------ | ------ | ------ | ------ | ------ | ------ | | identityType | 精确匹配 必填,身份识别类型(phone: 手机号码, id: 用户ID, openid: 公众号openid, unionid: 开放平台unionid) | body | false | string | | | thirdId | 第三方用户ID | body | false | string | | | openid | 公众号openid | body | false | string | | | unionid | 开放平台unionid | body | false | string | | | phone | 手机 | body | false | string | | | groups | 用户分组,多个用,号隔开 | body | false | string | | ###请求示例 ```json { "publicParams":{ "isMatching":true, "matchingType":2, "identifyWay":1, "optType":"add" }, "data":[{ "thirdId":"1", "groups":"group1,group2" }] } ``` #响应参数 *** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------ | ------ | ------ | ------ | ------ | ------ | | code | 状态码 | body | true | string | | | errorCode | 异常码 | body | true | string | | | msg | 描述 | body | true | string | | | data | 导入批次ID,用来查询导入结果,[查询数据导入结果](http://docs.tuzhanai.com/pages/viewpage.action?pageId=1935628) | body | true | long | | ###响应状态 | 状态码 | 说明 | schema | | ------ | ------ | ------ | | 200 | OK | | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ###响应示例 ```json { "code": "200", "errorCode": "SUCCESS", "msg": "ok", "data": 15314513451345123 } ``` |
...