# 获取达人详情信息
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:getpromoter
可通过该接口获取达人详细信息
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/channels/ec/league/promoter/get?access_token=ACCESS_TOKEN
# 云调用
调用方法:channels.ec.league.promoter.get
出入参和 HTTPS 调用相同,调用方式可查看 云调用 说明文档
# 第三方调用
本接口支持第三方平台代微信小店商家调用。第三方服务商调用模式介绍
该接口所属的权限集 id 为:141
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代微信小店商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String parameters
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token(微信小店商家)、authorizer_access_token(服务商代调用) |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| finder_id | string | 否 | sph1234 | 视频号finder_id,待废除后续以promoter_id为准(和promoter_id二选一) |
| promoter_id | string | 否 | 达人带货id(和finder_id二选一) |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 示例 | 说明 |
|---|---|---|---|
| errcode | number | 0 | 错误码 |
| errmsg | string | ok | 错误信息 |
| promoter | object | 达人合作信息 |
# Res.promoter Object Payload
达人合作信息
| 参数名 | 类型 | 说明 | 枚举 |
|---|---|---|---|
| finder_id | string | 视频号finder_id,待废除后续以promoter_id为准 | - |
| status | number | 合作状态 | 枚举值 |
| invite_time | number | 达人邀请秒级时间戳 | - |
| sale_product_number | number | 累计合作商品数 | - |
| sale_gmv | number | 合作动销GMV | - |
| promoter_id | string | 达人带货id | - |
# 4. 枚举信息
# Res.promoter.status Enum
合作状态
| 枚举值 | 描述 |
|---|---|
| 0 | 初始值 |
| 1 | 邀请中 |
| 2 | 达人已接受邀请 |
| 3 | 达人已拒绝邀请 |
| 4 | 已取消邀请 |
| 5 | 已取消合作 |
| 10 | 已删除 |
# 5. 注意事项
本接口无特殊注意事项
# 6. 代码示例
请求示例
{
"finder_id": "sph1234"
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"promoter" : {
"finder_id": "sph1234",
"status": 1,
"invite_time": 0,
"sale_product_number": 0,
"sale_gmv": 0
}
}
# 7. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 |
|---|---|
| 10023000 | 参数错误 |
| 10023001 | 不合法的finder_id |
| 10023007 | 请先开通优选联盟 |
# 8. 适用范围
本接口支持「微信小店(需申请)」账号类型调用。其他账号类型如无特殊说明,均不可调用。