访问路径:/api/audience/identityTypeManage

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

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

URL结构

https://open.rabbitpre.com/api/audience/identityTypeManage

接口协议:HTTPS

HTTP请求方式:POST

请求参数

参数

必填

类型

说明

opfid

true

long

开放平台id

uid

false

integer

企业的账号id,若开放平台的集成对象是企业,则传该企业的账号id;若集成对象是平台,且要批量修改其存量第三方企业的用户身份,则不传uid;若集成对象是平台,且只修改其下某个第三方企业的用户身份,则传该第三方企业的账号id(若该账号id绑定了多个第三方企业,则还需传入companyId指定修改的企业,否则会批量修改多个绑定第三方企业的用户身份)

companyId
false
string
第三方企业id;若开放平台的集成对象是企业,则不传;若开放平台的集成对象是平台,传则只修改该第三方企业的用户身份,不传则批量修改该平台下所有第三方企业的用户身份。
optTypetrue
string

操作类型,枚举值——add(新增)、delete(删除)、change(修改);

  • 注意

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

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

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

identitytrue
json
用户身份

identity用户身份参数

参数必填类型说明
identityNametrue
string
用户身份的id,比如openid、unionid等,不可重复。
identityTypetrue
string
用户身份的名称,比如手机号、微信openid等,不可重复
platformtrue
string
用户身份的适用平台,枚举值——all(全平台通用)、gzh(微信公众号)、contentminiapp(微信小程序)、workwechat(企业微信-第三方应用)、selfbuilt(企业微信-自建应用)、YOUZAN(有赞)、EZR(驿客)、RP_LSY(零售云)、EXTERNAL(自建应用)
distinctAppfalse
boolean
是否区分应用,当且仅当用户身份的适用平台不是全平台通用时才需填写,默认不区分。
prioritytrueint用户身份匹配的优先级,按从小到大排序,若填入的优先级已存在,则以当前填入的为准,其他身份优先级依次顺延
isUniqueflaseboolean每个用户在该身份下最多只有一个值,默认否
isOutputfalseboolean是否在导出用户相关数据时,带上当前用户身份,默认否;若optType=change,不传isOutput则保持原取值不变。

请求示例

换行和缩进只是为了更好的展示:

https://open.rabbitpre.com/api/audience/identityTypeManage

返回参数

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

data

array

失败详情,成功为null

返回成功示例

                  
  • 无标签