获取企微任务宝对应的客户数据列表

获取参与企微任务宝裂变的客户详细数据列表。

错误码	说明
21401	main_misson_id错误，对应裂变活动不存在
21402	任务宝对应的活动id和af_type不匹配
调用此接口需购买营销席位。

请求参数

Query 参数

main_mission_id

string

活动ID

必需

示例值:

af_type

string

可选

企微任务宝活动类型，qywx为企业微信，mp为企微+公众号，默认值为qywx

示例值:

qywx

cheating_sort

string

可选

排序按照客户邀请好友数升序或降序增加排序参数 order，可选值是 asc(升序) 和 desc(降序)，默认值是 asc

示例值:

asc

limit

string

可选

列表返回长度。默认值为20，最大值为100

示例值:

offset

string

可选

列表偏移。用于同limit参数搭配迭代获取所有数据，默认值为0

示例值:

access_token

string

调用接口凭证

必需

默认值:

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

errcode

integer

必需

状态码，0为正常，非0代表错误。

errmsg

string

必需

错误信息，成功时为'ok'，错误时会以中文方式显示错误原因

sub_mission_list

array[object (SubMissionQywx) {14}]

参与活动客户列表

必需

cheating_count

integer

助力成功数

必需

created_at

integer

必需

此客户参与活动时间，格式是Unix时间戳

external_user_id

string

客户id

必需

invite_source_id

string | null

必需

邀请人id，为""或者null说明没有邀请人

invited_count

integer

邀请好友数

必需

is_old_user

boolean

是否为老用户

必需

main_mission_id

integer

必需

企微任务宝的活动id

mission_id

integer

子任务的id

必需

mission_status

boolean

任务是否完成

必需

new_user_count

integer

新客户数

必需

outflow

boolean | null

流失状态

必需

prize_level

integer | null

达成任务阶段

必需

staff_id

string

员工id

必需

valid_count

integer

必需

有效的完成任务邀请成功数

total

integer

必需

参与活动客户总数目

示例

{
    "errcode": 0,
    "errmsg": "ok",
    "sub_mission_list": [
        {
            "cheating_count": 0,
            "created_at": 1594729969,
            "external_user_id": "wm8xjUCAAAbUQVhVzSbhGQmK1Y-2-X1g",
            "invite_source_id": null,
            "invited_count": 0,
            "main_mission_id": 63,
            "mission_id": 124,
            "mission_status": false,
            "new_user_count": 0,
            "outflow": null,
            "prize_level": 0,
            "staff_id": "YangGuang",
            "valid_count": 0
        }
    ],
    "total": 1
}

🟢200正常返回