跳到主要内容

创建签到活动

更新时间 2025/02/22 07:19:43

英飞画布服务端支持基于 REST API 向指定的业务频道内创建预定一场签到活动，并反馈签到活动的 ID。

英飞辅助 SDK 业务下，签到 ID 统一会使用 signInId 进行标记。

前提条件​

请求路径​

https://developer.infi.cn/infi/api/v1/signIns

请求参数说明​

字段
类型
描述
必填
channelId
string
业务频道 ID
是
loginName
string
对象数据结构，详情见下方会议信息结构说明
是
title
string
签到标题
是
duration
number
签到持续时间，单位为秒
是
customizedValue
string
自定义字段，用于携带用户自定义信息，该字段会广播给业务频道里的用户
否

请求参数示例​

{
  "channelId": "SAMPLE_CHANNEL_ID",
  "loginName": "SAMPLE_LOGIN_NAME",
  "title": "SAMPLE_SIGNIN_TITLE",
  "duration": 600,
  "customizedValue": null
}

请求 curl 示例​

curl --location --request POST \
      --header 'token: YOUR_ACCESS_TOKEN' \
      --header 'Content-Type: application/json' \
      --data '{ PAYLOADS_HERE }' \
      https://developer.infi.cn/infi/api/v1/signIns

注意：请确保将 PAYLOADS_HERE 替换为请求参数中列举的数据。

请求成功情况​

响应的 Http 状态码为 200 时表示请求成功，并会带有新的签到活动数据。 请求成功返回数据示例如下:

{
  "signInId": "673d45e4ea2cf0000183ee5c",
  "title": "SAMPLE_SIGNIN_TITLE",
  "customizedValue": "",
  "duration": 600,
  "count": 0,
  "host": "SAMPLE_LOGIN_NAME",
  "startTime": 1732068836035,
  "endTime": 1732069436035,
  "realEndTime": null
}

数据体字段说明如下：

字段名
类型
说明
signInId
string
签到 ID
title
string
签到标题
duration
number
签到持续时间
customizedValue
string
签到自定义数据
count
number
签到数
host
string
签到创建者用户 ID
startTime
number
签到开始时间戳
endTime
number
签到计划结束时间戳
realEndTime
number
签到实际结束时间戳，未结束时为 null

请求失败情况​

响应的 Http 状态码不为 200 时表示请求失败，如需更多信息请参考请求错误说明文档。

注：同一业务频道（channelId）内，同时间内仅能存在一个签到活动。若您在创建签到时，业务频道内已存在了一个签到活动，则服务端会反馈如下错误提示

{
  "code": "Bad Request",
  "message": "there is a signIn is running",
  "status": 400,
  "type": "error"
}