# 获取优惠券领券用户 |拥有此API的权限集| |:----- | | 营销码券管理-查询码券信息 | **请求方式及url** - 请求方式：`POST` - 请求头：`Content-Type:application/json` - 接口地址：`https://api.xiaoe-tech.com/xe.coupon.user_list/1.0.0` - 频率限制: `1秒20次` {% api method="POST", data= { "access_token": "xe_xxxxx", "cou_id": "cou_61c57f24e7f20-YMPS9r", "page_size":1 }, url="https://api-doc.xiaoe-tech.com/_agent/forward?url=https://api.xiaoe-tech.com/xe.coupon.user_list/1.0.0" %} {% endapi %} **请求参数** |参数名|必选|类型|说明| |:---- |:---|:----- |----- | |access_token |是 |string |[专属token](./../get_access_token.md) | |cou_id |是 |string | 优惠券id| |get_type |否 |int|领取方式 | |is_use |否 |int| 优惠券使用状态 | |wx_nickname |否 |string |微信昵称搜索 | |page |否 |int | 页码 | |page_size |否 |int | 页面size，默认10，最大100 | | start_update_time | 否 | string | 查询update_time范围的开始时间，如2022-09-06 00:00:00 | | end_update_time | 否 | string | 查询update_time范围的结束时间，如2022-09-07 00:00:00 | **请求示例** ``` { "access_token": "xe_xxxxx", "cou_id": "cou_61c57f24e7f20-YMPS9r", "page_size":1 } ``` **返回参数** |参数名|类型|说明| |:----- |:-----|----- | |code|int |返回码 | |msg |string | 返回信息 | |data |object| 返回值 | |data.total |int| 总数 | |data.list |object| 返回列表 | `data.list` 返回列表 |参数名|类型|说明| |:----- |:-----|----- | |id|string |用户领取的优惠券ID | |app_id |string | app_id | |cou_id |string| 优惠券批次ID | |user_id |string| 用户ID | |get_type |int| 领取类型 | |receive_at |string| 领取时间 | |valid_at |string| 有效时间 | |invalid_at |string| 过期时间 | |is_use |int|是否已经使用 0未使用，1:已经使用 | |use_at |string| 使用时间，如果is_user=1则有值 | |has_prompt |int|是否已提醒用户 0-不需要提醒、1-需要提醒、2-已提醒 | |created_at |string| 领券时间 | |updated_at |string| 记录更新时间 | |resource_id |string| 使用的资源ID | |resource_type |int| 使用的资源类型 | |order_id |string| 订单号 | |wx_nickname |string| 微信昵称 | |phone |string| 用户电话号码 | |wx_avatar |string|微信头像 | **返回示例** ``` { "code": 0, "msg": "OK", "data": { "list": [ { "app_id": "appxxx", "cou_id": "cou_61cbc538734f1-e2C6os", "created_at": "2021-12-29 10:18:31", "get_type": 0, "has_prompt": 0, "id": "cu_61cbc577a17c2_a99DJ08K", "invalid_at": "2021-12-29 23:59:59", "is_use": 0, "order_id": "", "phone": "", "receive_at": "2021-12-29 10:18:31", "resource_id": "", "resource_type": 0, "updated_at": "2021-12-29 10:18:31", "use_at": "", "user_id": "u_5fcef61290a42_BxFz5nHJFZ", "valid_at": "2021-12-29 10:18:31", "wx_avatar": "http://wechatavator-1252524126.file.myqcloud.com/appAKLWLitn7978/image/compress/u_5fcef61290a42_BxFz5nHJFZ.png", "wx_nickname": "双叶幼稚园-豆蔻SKIN Care.美肤18963805567" } ], "total": 1 } } ```