聆客开放平台

# 模型定义

# ApiResultString

# 属性定义

属性名 数据类型 必填 只读 属性说明
code integer N N 结果码 200:成功
message string N N 当状态码不是200时,错误信息
data string N N 请求返回的数据
date string N N 请求时当前服务器时间

# BatchModifyBadgeRequest

批量修改颁发信息参数

# 属性定义

属性名 数据类型 必填 只读 属性说明
ids string[ ] N N 数据ID列表
validDate string N N 有效期(-1:长期有效, xxxx-xx-xx:具体日期)

# ApiResultPageBadgeUserResult

# 属性定义

属性名 数据类型 必填 只读 属性说明
code integer N N 结果码 200:成功
message string N N 当状态码不是200时,错误信息
data BadgeUserResult[ ] N N 请求返回的数据
date string N N 请求时当前服务器时间
count integer N N 请求返回的数据总数
total integer N N 数据总数

# BadgeUserResult

徽章颁发名单信息

# 属性定义

属性名 数据类型 必填 只读 属性说明
id string N N 数据ID
userId string N N 对象ID
userName string N N 颁发对象
validDate string N N 有效期(-1:长期有效, xxxx-xx-xx:具体日期)
status integer N N 状态(1:生效中,2:已失效)
lastUpdatedName string N N 操作人
lastUpdatedDate string N N 操作时间

# BoundSqlInterceptorBadgeUserResult

{"default":null,"name":null,"title":"BoundSqlInterceptorBadgeUserResult","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"type":"object","not":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"$ref":null,"nullable":null,"readOnly":null,"writeOnly":null,"example":null,"externalDocs":null,"deprecated":null,"xml":null,"extensions":{},"enum":null,"discriminator":null}

# ChainBadgeUserResult

{"default":null,"name":null,"title":"ChainBadgeUserResult","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"type":"object","not":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"$ref":null,"nullable":null,"readOnly":null,"writeOnly":null,"example":null,"externalDocs":null,"deprecated":null,"xml":null,"extensions":{},"enum":null,"discriminator":null}

# BadgeUserParam

颁发用户信息

# 属性定义

属性名 数据类型 必填 只读 属性说明
id string N N 用户id
idType integer N N id类型(1:用户id,2:账号id),默认为用户id
name string N N 用户名称

# BatchAwardBadgeRequest

批量颁发用户徽章参数

# 属性定义

属性名 数据类型 必填 只读 属性说明
badgeId string N N 徽章ID
validDate string N N 有效期(-1:长期有效, xxxx-xx-xx:具体日期)
awardUserList BadgeUserParam[ ] N N 用户列表
sendNotice boolean N N 服务号通知

# BatchWithdrawBadgeRequest

批量撤回用户徽章

# 属性定义

属性名 数据类型 必填 只读 属性说明
badgeId string N N 徽章ID
awardUserList BadgeUserParam[ ] N N 用户列表
sendNotice boolean N N 服务号通知

# ModifyBadgeRequest

修改用户会话标签请求参数

# 属性定义

属性名 数据类型 必填 只读 属性说明
name string N N 徽章名称
remark string N N 徽章描述
icon string N N 主图标
pendantIcon string N N 挂饰图标
image string N N 徽章带背景图(用于服务号通知封面)

# ApiResultBadgeResult

# 属性定义

属性名 数据类型 必填 只读 属性说明
code integer N N 结果码 200:成功
message string N N 当状态码不是200时,错误信息
data BadgeResult N N
date string N N 请求时当前服务器时间

# BadgeResult

单个会话行为数据

# 属性定义

属性名 数据类型 必填 只读 属性说明
id string N N 徽章ID
name string N N 徽章名称
remark string N N 徽章描述
icon string N N 主图标
pendantIcon string N N 挂饰图标
image string N N 封面图
createdByName string N N 创建人
createdDate string N N 创建时间
geteCode string N N 所属租户

# ApiResultPageBadgeResult

# 属性定义

属性名 数据类型 必填 只读 属性说明
code integer N N 结果码 200:成功
message string N N 当状态码不是200时,错误信息
data BadgeResult[ ] N N 请求返回的数据
date string N N 请求时当前服务器时间
count integer N N 请求返回的数据总数
total integer N N 数据总数

# BoundSqlInterceptorBadgeResult

{"default":null,"name":null,"title":"BoundSqlInterceptorBadgeResult","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"type":"object","not":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"$ref":null,"nullable":null,"readOnly":null,"writeOnly":null,"example":null,"externalDocs":null,"deprecated":null,"xml":null,"extensions":{},"enum":null,"discriminator":null}

# ChainBadgeResult

{"default":null,"name":null,"title":"ChainBadgeResult","multipleOf":null,"maximum":null,"exclusiveMaximum":null,"minimum":null,"exclusiveMinimum":null,"maxLength":null,"minLength":null,"pattern":null,"maxItems":null,"minItems":null,"uniqueItems":null,"maxProperties":null,"minProperties":null,"required":null,"type":"object","not":null,"properties":null,"additionalProperties":null,"description":null,"format":null,"$ref":null,"nullable":null,"readOnly":null,"writeOnly":null,"example":null,"externalDocs":null,"deprecated":null,"xml":null,"extensions":{},"enum":null,"discriminator":null}

# CreatedBadgeRequest

新建徽章请求参数

# 属性定义

属性名 数据类型 必填 只读 属性说明
name string N N 徽章名称
remark string N N 徽章描述
icon string N N 主图标
pendantIcon string N N 挂饰图标
image string N N 徽章带背景图(用于服务号通知封面)

# ApiResultCollectionUserBadgeResult

# 属性定义

属性名 数据类型 必填 只读 属性说明
code integer N N 结果码 200:成功
message string N N 当状态码不是200时,错误信息
data UserBadgeResult[ ] N N 请求返回的数据
date string N N 请求时当前服务器时间
total integer N N 数据总数
count integer N N 请求返回的数据总数

# UserBadgeResult

用户徽章信息

# 属性定义

属性名 数据类型 必填 只读 属性说明
badgeId string N N 徽章ID
name string N N 徽章名称
remark string N N 徽章描述
icon string N N 主图标
pendantIcon string N N 挂饰图标
wear boolean N N 是否佩戴

# ApiResultCollectionUserBadgeDetailResult

# 属性定义

属性名 数据类型 必填 只读 属性说明
code integer N N 结果码 200:成功
message string N N 当状态码不是200时,错误信息
data UserBadgeDetailResult[ ] N N 请求返回的数据
date string N N 请求时当前服务器时间
total integer N N 数据总数
count integer N N 请求返回的数据总数

# UserBadgeDetailResult

请求返回的数据

# 属性定义

属性名 数据类型 必填 只读 属性说明
badgeId string N N 徽章ID
name string N N 徽章名称
remark string N N 徽章描述
icon string N N 主图标
pendantIcon string N N 挂饰图标
wear boolean N N 是否佩戴
obtain boolean N N 是否已获得