接口说明：用户身份管理。新增、修改、删除。需要鉴权

限制说明：允许1分钟内连续请求100次，否则返回：操作频繁,请稍后重试

访问路径：/api/audience/identityTypeManage

应用权限:   用户→用户资料

Type: POST

Author: zhuyanpeng

Content-Type: application/json; charset=utf-8

Description: 用户身份管理

Body-parameters:

ParameterTypeRequiredDescription

uid

string

false

企业的账号id；若只修改数据集成下面某个第三方企业的用户身份，则传该第三方企业的账号id（若该账号id绑定了多个第三方企业，则还需传入companyId指定修改的企业，否则会批量修改多个绑定第三方企业的用户身份）

companyId

string

false

第三方企业id；传了则只修改该第三方企业的用户身份，传uid不传companyId则批量修改该平台下所有第三方企业的用户身份。

optType

string

true

操作类型，枚举值——add（新增）、delete（删除）、change（修改）；

  • 注意：

1、用户身份id和用户身份名称不可重复；

2、若当前用户身份已有数据，则无法删除；系统预设的用身份不可删除（包括微信openid、微信unionid、企业微信客户id和手机号）；

3、删除和修改用户身份时，先匹配用户身份id，再根据传入的参数修改或删除用户身份，若当前用户身份已有数据，则只支持修改”身份名称“、”优先级“和“是否导出”。系统预设的用身份只允许修改”优先级“和“是否导出”。

identity

object

true

用户身份

└─identityType

string

true

用户身份的id，比如openid、unionid等，不可重复。

└─identityName

string

true

用户身份的名称，比如手机号、微信openid等，不可重复

└─platform

array

true

用户身份的适用平台，枚举值——all（全平台通用）、gzh（微信公众号）、contentminiapp（微信小程序）、workwechat（企业微信-第三方应用）、selfbuilt（企业微信-自建应用）、YOUZAN（有赞）、EZR（驿客）、RP_LSY（零售云）、EXTERNAL（自建应用）

└─distinctApp

boolean

false

是否区分应用，当且仅当用户身份的适用平台不是全平台通用时才需填写，默认不区分。

└─priority

int32

true

用户身份匹配的优先级，按从小到大排序，若填入的优先级已存在，则以当前填入的为准，其他身份优先级依次顺延

└─unique

boolean

false

每个用户在该身份下最多只有一个值，默认否

└─output

boolean

false

是否在导出用户相关数据时，带上当前用户身份，默认否；若optType=change，不传isOutput则保持原取值不变。

companyId和uid都不传时，会通过token信息拿到数据集成信息，如果数据集成下面没有第三方企业相关联，则会修改当前数据集成对应企业下的用户身份。

返回参数

参数类型说明
code
string状态码
errorCodestring错误状态码
msgstring响应信息

data

array

失败详情，成功为null

请求示例

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'X-Token: r9i6T6VXdAV0vjiMBxODFRddRVY' -d '{ \ 
   "companyId": "test", \ 
   "identity": { \ 
     "distinctApp": true, \ 
     "identityName": "手机号", \ 
     "identityType": "phone", \ 
     "output": true, \ 
     "platform": [ \ 
       "all" \ 
     ], \ 
     "priority": 0, \ 
     "unique": true \ 
   }, \ 
   "optType": "change", \ 
   "uid": "test123" \ 
 }' 'https://integrate.rabbitpre.com/api/open/api/audience/identityTypeManage'


返回成功示例


{
    "code":"200",
    "errorCode":"SUCCESS",
    "msg":"ok",
    "data":null
}