获取签到活动详情
更新时间 2025/02/22 07:19:43
英飞画布服务端支持基于 REST API 获取一场签到活动的详情信息。
前提条件
- 已经完成英飞画布应用的创建动作,详见新人指引文档,并开启了辅助 SDK 功能。
- 了解 REST API 请求的认证方式,详见获取 Access Token 文档。
- 持有有效的签到活动
signInId
。
请求路径
https://developer.infi.cn/infi/api/v1/signIns/{signInId}/records?pageSize={pageSize}&pageIndex={pageIndex}
注:您需要将路径中的
{signInId}
、{pageSize}
、{pageIndex}
替换为有效值。
请求 curl 示例
curl --location --request GET \
--header 'token: YOUR_ACCESS_TOKEN' \
--header 'Content-Type: application/json' \
https://developer.infi.cn/infi/api/v1/signIns/{signInId}/records?pageSize={pageSize}&pageIndex={pageIndex}
注:您需要将路径中的
{signInId}
、{pageSize}
、{pageIndex}
替换为有效值。
请求成功情况
响应的 Http 状态码为 200
时表示请求成功,并会带有被终止的签到记录数据。
请求成功返回数据示例如下:
{
"total": 1,
"list": [
{
"id": "SAMPLE_RECORD_ID",
"loginName": "SAMPLE_LOGIN_NAME",
"signInId": "SAMPLE_SIGNIN_ID",
"signInTime": 1731649609333,
"signInMsg": "SAMPLE_MESSAGE",
"createdAt": 1731649609336
}
]
}
成功返回的字段说明如下:
字段
类型
描述
total
number
签到计数
list
ArraySignInDataType
签到记录数组,数组元素结构请参考下方说明
SignInDataType
结构体说明如下:
字段
类型
描述
id
string
签到记录 ID
loginName
string
签到用户 ID
signInId
string
签到活动 ID
signInTime
number
系统受理签到行为时间戳
signInMsg
string
用户签到时发送的自定义消息
createdAt
string
签到记录生成时间
请求失败情况
响应的 Http 状态码不为 200
时表示请求失败,如需更多信息请参考请求错误说明文档。