跳转到主要内容
1签 (OneSign)

DistributionSettingsUpdated

本页内容

下载页设置保存成功后的结果。读取 settings 取得新修订号,并区分本次保存与幂等重放。

如何阅读本模型

先从下方相关接口确认该模型用于请求还是响应,再按字段层级读取。请求模型由调用方填写,响应模型由平台返回;同名字段在不同模型中可能含义不同。

应用、版本、任务和回执的区别见基本概念。需要一份可跟做的示例时,从相关接口进入对应产品指南。

字段定义

“必需”指字段所在的对象出现时,该字段是否必须存在。类型中含 null 表示值允许为空;未返回、null、空字符串和零分别处理。

字段必需说明
settings 是

保存成功时的分发设置及新修订号。

类型:object

settings.app_id 是

业务应用的完整 ID,来自列出应用或预留新应用的响应。

类型:string

查看取值约束
  • 格式 ^A[a-f0-9]{32}$
settings.revision 是

当前内容或配置的修订标识,更新时传回最近读取的原值。

类型:string

查看取值约束
  • 格式 ^R[a-f0-9]{64}$
settings.template_id 是

下载页模板编号,从 available_template_ids 选择。

类型:integer

查看取值约束
  • 最小值 1
  • 最大值 8
settings.language 是

下载页语言,从 available_languages 选择。

类型:string

查看取值约束
  • 可选值 auto / zh / en / zh-tw / vi / ru / th / ja / ko / es / pt / fr / de / it / id / ms / ar / hi / tr
settings.introduction 是

下载页的纯文本应用介绍。

类型:string

查看取值约束
  • 最多字符 255
settings.available_template_ids 是

当前允许设置的模板编号。

类型:integer[]

settings.available_template_ids[] 是

数组中每个元素的取值要求。

类型:integer

查看取值约束
  • 最小值 1
  • 最大值 8
settings.available_languages 是

当前允许设置的语言值。

类型:string[]

settings.available_languages[] 是

数组中每个元素的取值要求。

类型:string

查看取值约束
  • 可选值 auto / zh / en / zh-tw / vi / ru / th / ja / ko / es / pt / fr / de / it / id / ms / ar / hi / tr
replayed 是

为 true 时返回的是以前已成功的同一业务请求的回执。

类型:boolean

相关接口

下面根据接口定义列出使用本模型的操作,包括嵌套在其他对象中的情况。接口示例展示完整请求和响应;模型本身不会增加任何权限。

作为成功响应