C端接口

$BASE_URL需要替换为请求地址

1.发送验证码

请求方式： POST

请求地址： $BASE_URL/open/verificationCode?phone=PHONE

请求参数说明

参数	类型	是否必填	最大长度	描述	示例值
phone	String	是	20	手机号	13688888888

返回值说明

参数	类型	是否必填	最大长度	描述	示例值
success	Boolean	是	11	是否成功	false
code	Int	是	11	错误码	0
msg	Text	是	255	错误信息	发送失败

---

2.登录

请求方式： POST

请求地址： $BASE_URL/open/validationcode/login

请求参数说明

参数	类型	是否必填	最大长度	描述	示例值
mchId	String	是	20	门店编号	100001(解密后内容)
identity	String	是	20	手机号	13688888888
code	String	是	20	验证码	8034

返回值说明

参数	类型	是否必填	最大长度	描述	示例值
success	Boolean	是	11	是否成功	false
code	Int	是	11	错误码	0
msg	Text	是	255	错误信息	发送失败
data.accessToken	String	是	1255	凭证	eyJhbGciOiJSUz...
data.expiresIn	Int	是	11	凭证有效期(秒)	7200

---

3.领取新客有礼

请求方式： POST

请求地址： $BASE_URL/capp/newguestactivity/receive

请求参数说明

参数	类型	是否必填	最大长度	描述	示例值
newGuestActivityId	String	是	36	活动id	2de05313-0bdf-467b-8b6b-a8ae8e77f808

返回值说明

参数	类型	是否必填	最大长度	描述	示例值
success	Boolean	是	11	是否成功	false
code	Int	是	11	错误码	0
msg	Text	是	255	错误信息	发送失败
data.isReceived	Boolean	是	1	是否已领取过	true
data. id	String	是	36	活动id(仅当isReceived为true时有值)	2de05313-0bdf-467b-8b6b-a8ae8e77f808
data.activityName	String	是	36	活动名称(仅当isReceived为true时有值)	新客大礼包
data.rewardSetMealName	String	是	36	奖励套餐名(仅当isReceived为true时有值)	新客大礼包
data.joinCount	Int	是	11	总参与次数(仅当isReceived为true时有值)	3
data.todayJoinCount	Int	是	11	今日参与次数(仅当isReceived为true时有值)	3
data.isEnabled	Boolean	是	1	是否启用(仅当isReceived为true时有值)	true

---

4.领取红包

请求方式： POST

请求地址： $BASE_URL/capp/coinredpackactivity/receive

请求参数说明

参数	类型	是否必填	最大长度	描述	示例值
coinRedPackId	String	是	36	红包id	2de05313-0bdf-467b-8b6b-a8ae8e77f808

返回值说明

参数	类型	是否必填	最大长度	描述	示例值
success	Boolean	是	11	是否成功	false
code	Int	是	11	错误码	0
msg	Text	是	255	错误信息	发送失败
data.isReceived	Boolean	是	1	是否已领取过	true
data. id	String	是	36	红包id(仅当isReceived为true时有值)	2de05313-0bdf-467b-8b6b-a8ae8e77f808
data.redPacketType	Int	是	36	红包类型: 0-未知 1-普通红包 2-拼手气红包(仅当isReceived为true时有值)	1
data.message	Text	是	36	留言(仅当isReceived为true时有值)	测试你的手气~
data.totalCoins	Int	是	11	红包总发放币数(仅当isReceived为true时有值)	1000
data.packetCount	Int	是	11	红包总发放个数(仅当isReceived为true时有值)	100
data.singlePacketCoins	Int	是	11	单个红包币数(仅当isReceived为true时有值)	红包类型为1时返回
data.receivedPacketCount	Int	是	11	已领取红包数(仅当isReceived为true时有值)	5
data.receivedCoins	Int	是	11	已领取币数(仅当isReceived为true时有值)	50
data.isEnabled	Boolean	是	1	是否启用(仅当isReceived为true时有值)	true

---

5.获取红包领取记录列表

请求方式： POST

请求地址： $BASE_URL/capp/coinredpackactivitylog/list

请求参数说明

参数	类型	是否必填	最大长度	描述	示例值
packId	String	是	36	红包id	2de05313-0bdf-467b-8b6b-a8ae8e77f808
page	Int	否	11	分页索引(默认为1)	1
limit	Int	否	11	单页记录数(默认为20)	20

返回值说明

参数	类型	是否必填	最大长度	描述	示例值
success	Boolean	是	11	是否成功	false
code	Int	是	11	错误码	0
msg	Text	是	255	错误信息	发送失败
data. id	String	是	36	红包id	2de05313-0bdf-467b-8b6b-a8ae8e77f808
data.createTime	DateTime	是	36	领取时间	2021-10-25 17:00:00
data.memberName	String	是	36	会员名称	张三
data.phone	String	是	36	手机号	13688888888
data.receivedCoins	Int	是	11	领取币数	100
data.issueState	Int	是	11	发放状态: 0-发放成功 1-发放失败	0

---

6.获取当前会员新客有礼领取详情

请求方式： GET

请求地址： $BASE_URL/capp/newguestactivitylog/get

请求参数说明

参数	类型	是否必填	最大长度	描述	示例值

返回值说明

参数	类型	是否必填	最大长度	描述	示例值
success	Boolean	是	11	是否成功	false
code	Int	是	11	错误码	0
msg	Text	是	255	错误信息	发送失败
data.isReceived	Boolean	是	1	是否已领取过	true
data. id	String	是	36	活动id(仅当isReceived为true时有值)	2de05313-0bdf-467b-8b6b-a8ae8e77f808
data.activityName	String	是	36	活动名称(仅当isReceived为true时有值)	新客大礼包
data.rewardSetMealName	String	是	36	奖励套餐名(仅当isReceived为true时有值)	新客大礼包
data.joinCount	Int	是	11	总参与次数(仅当isReceived为true时有值)	3
data.todayJoinCount	Int	是	11	今日参与次数(仅当isReceived为true时有值)	3
data.isEnabled	Boolean	是	1	是否启用(仅当isReceived为true时有值)	true

---

7.获取当前会员红包领取详情

请求方式： GET

请求地址： $BASE_URL/capp/coinredpackactivitylog/get

请求参数说明

参数	类型	是否必填	最大长度	描述	示例值
coinRedPackId	String	是	36	红包Id	2de05313-0bdf-467b-8b6b-a8ae8e77f808

返回值说明

参数	类型	是否必填	最大长度	描述	示例值
success	Boolean	是	11	是否成功	false
code	Int	是	11	错误码	0
msg	Text	是	255	错误信息	发送失败
data.isReceived	Boolean	是	1	是否已领取过	true
data. id	String	是	36	活动id(仅当isReceived为true时有值)	2de05313-0bdf-467b-8b6b-a8ae8e77f808
data.activityName	String	是	36	活动名称(仅当isReceived为true时有值)	新客大礼包
data.rewardSetMealName	String	是	36	奖励套餐名(仅当isReceived为true时有值)	新客大礼包
data.joinCount	Int	是	11	总参与次数(仅当isReceived为true时有值)	3
data.todayJoinCount	Int	是	11	今日参与次数(仅当isReceived为true时有值)	3
data.isEnabled	Boolean	是	1	是否启用(仅当isReceived为true时有值)	true