# 自定义用户参数管理接口

此接口支持推客为单个微信开放平台账号(主体需与推客账号一致)下的特定unionid绑定自定义用户参数,被绑定的用户通过联盟推广素材下单后,通过查询订单明细接口即可查询到该用户对应的自定义用户参数。

接口名称 说明
绑定开放平台账号 支持推客绑定开放平台的账号
获取开放平台账号 支持推客获取已绑定的开放平台账号
绑定/换绑自定义用户参数 支持推客为特定unionid绑定自定义参数
删除自定义用户参数 支持推客删除特定unionid的自定义参数
获取自定义用户参数 支持推客查询特定unionid的自定义参数

# 一、绑定开放平台账号

# 接口说明

支持推客绑定开放平台的账号 注意:所绑定的开放平台账号与推客账号需同主体,每年开放平台账号可换绑2次

# 请求地址

POST https://api.weixin.qq.com/union/promoter/open_account/bind?access_token=ACCESS_TOKEN

# 请求参数

属性 类型 默认值 必填 说明
access_token string 接口调用凭证
openAccount string 开放平台账号

# POST 数据示例

{
  "openAccount": "APPID"
}

# 返回值

# Object

属性 类型 说明
errcode number 错误码
errmsg string 错误信息
{
    "errcode": 0,
    "errmsg": "ok",
}

# 错误码

说明
200002/25510 参数错误
25503 获取主体信息失败
25504 主体验证失败
25505 open 账号不存在
25506 open 账号异常
25507 open 账号异常
25508 验证失败
25509 绑定的自定义参数超过数量限制

# 二、获取开放平台账号

# 接口说明

支持推客获取绑定的开放平台账号

# 请求地址

GET https://api.weixin.qq.com/union/promoter/open_account/get?access_token=ACCESS_TOKEN

# 请求参数

属性 类型 默认值 必填 说明
access_token string 接口调用凭证

# 返回值

# Object

属性 类型 说明
errcode number 错误码
errmsg string 错误信息
openAccount string 开放平台账号
{
    "errcode": 0,
    "errmsg": "ok",
    "openAccount": "APPID"
}

# 三、绑定/换绑自定义参数

# 接口说明

支持推客为特定unionid绑定自定义参数 注意:一个unionid同时仅可绑定一个自定义参数,重复绑定则取最新值

# 请求地址

POST https://api.weixin.qq.com/union/promoter/open_account/add_customize_info?access_token=ACCESS_TOKEN

# 请求参数

属性 类型 默认值 必填 说明
access_token string 接口调用凭证
unionid string 开放平台 unionid
customizeInfo string 自定义参数

# POST 数据示例

{
  "unionid": "UNIONID",
  "customizeInfo": "customizeInfo"
}

# 返回值

# Object

属性 类型 说明
errcode number 错误码
errmsg string 错误信息
{
    "errcode": 0,
    "errmsg": "ok",
}

# 错误码

说明
200002/25510 参数错误
25503 获取主体信息失败
25504 主体验证失败
25505 open 账号不存在
25506 open 账号异常
25507 open 账号异常
25508 验证失败
25509 绑定的自定义参数超过数量限制

# 四、删除自定义参数

# 接口说明

支持推客删除特定unionid已绑定的自定义参数

# 请求地址

POST https://api.weixin.qq.com/union/promoter/open_account/del_customize_info?access_token=ACCESS_TOKEN

# 请求参数

属性 类型 默认值 必填 说明
access_token string 接口调用凭证
unionid string 开放平台 unionid

# POST 数据示例

{
  "unionid": "UNIONID"
}

# 返回值

# Object

属性 类型 说明
errcode number 错误码
errmsg string 错误信息
{
    "errcode": 0,
    "errmsg": "ok",
}

# 错误码

说明
200002/25510 参数错误
25503 获取主体信息失败
25504 主体验证失败
25505 open 账号不存在
25506 open 账号异常
25507 open 账号异常
25508 验证失败
25509 绑定的自定义参数超过数量限制

# 五、获取自定义参数

# 接口说明

支持推客获取特定unionid已绑定的自定义参数

# 请求地址

GET https://api.weixin.qq.com/union/promoter/open_account/get_customize_info?access_token=ACCESS_TOKEN

# 请求参数

属性 类型 默认值 必填 说明
access_token string 接口调用凭证
unionid string 开放平台 unionid

# 返回值

# Object

属性 类型 说明
errcode number 错误码
errmsg string 错误信息
customizeInfo string 自定义参数
{
    "errcode": 0,
    "errmsg": "ok",
    "customizeInfo": "customizeInfo"
}

# 错误码

说明
200002/25510 参数错误
25503 获取主体信息失败
25504 主体验证失败
25505 open 账号不存在
25506 open 账号异常
25507 open 账号异常
25508 验证失败
25509 绑定的自定义参数超过数量限制