创建邀请码

  • 接口说明： 管理员创建一码一用邀请码
  • 接口地址： /api/invite
  • 请求方式： POST

请求参数

参数名称类型是否必须描述
group_idint是用户组 id

请求示例

  1. {
  2.   "data": {
  3.     "type": "invite",
  4.     "attributes": {
  5.       "group_id": 1
  6.     }
  7.   }
  8. }

返回说明

  • 成功，http 状态码 201
  • 失败，http 状态码 500

返回结果

参数名称类型出现要求描述
dataobject基础数据
typestring数据类型
idint数据 id
attributesobject数据属性
attributes.idintid
attributes.group_idint用户组 id
attributes.codestring邀请码
attributes.datelineint生效时间
attributes.endtimedatetime失效时间
attributes.to_user_idint被邀请用户 id
attributes.statustinyint状态
0 失效
1 未使用
2 已使用
3 已过期

返回示例

  1. {
  2.   "data": {
  3.     "type": "invite",
  4.     "id": "15",
  5.     "attributes": {
  6.       "id": 15,
  7.       "group_id": 1,
  8.       "code": "LSO4md492aD5DOB4vzaKYa9kehaahQDr",
  9.       "dateline": 1574330396,
  10.       "endtime": 1574935196,
  11.       "user_id": 0,
  12.       "to_user_id": 0,
  13.       "status": 0
  14.     }
  15.   }
  16. }