调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Id | string | 否 | schema id | profile |
Description | string | 否 | 信息描述 | - |
Properties | array<object> | 否 | 字段列表 | |
Propertie | object | 否 | 字段列表 | |
DisplayName | string | 否 | 坐席展示名。 | 显示名称 |
Description | string | 否 | 版本描述。 | - |
Name | string | 是 | 名称。 | name |
DataType | string | 是 | 数据类型 | string |
Pattern | string | 否 | 正则表达式校验规则 | * |
PatternErrorMessage | string | 否 | 正则表达式校验错误提示信息 | 错误的格式 |
MinLength | integer | 否 | 最小长度 | 1 |
MaxLength | integer | 否 | 最大长度 | 100 |
Minimum | double | 否 | 数字最小值 | 1 |
Maximum | double | 否 | 数字最大值 | 1 |
Required | boolean | 否 | 是否必填 | false |
Disabled | boolean | 否 | 是否被禁用 | false |
Array | boolean | 否 | 是否是数组 | false |
ReadOnly | boolean | 否 | 是否只读 | true |
EditorType | string | 否 | 编辑器类型 | textbox |
Attributes | string | 否 | 扩展属性 | {'Clusters': {'Description': 'The list of clusters.'}, 'ClusterIds': {'Description': 'The list of cluster IDs.'}} |
DisplayOrder | integer | 否 | 列表展示顺序 | 2 |
RequestId | string | 否 | 请求 ID。 | 7BEEA660-A45A-45E3-98CC-AFC65E715C23 |
InstanceId | string | 是 | 实例 ID。 | b0eb2742-f37e-4c67-82d4-25c651c1c450 |
返回参数
示例
正常返回示例
JSON
格式
{
"Data": "1ca2b084-6f0a-454b-9851-29768a9a5832",
"RequestId": "9F766284-F103-4298-8EC5-19F9F9BE5522",
"HttpStatusCode": 200,
"Code": "OK",
"Message": "无",
"Params": [
"无"
]
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
404 | NotExists.InstanceId | The specified instance %s does not exist. | 指定的呼叫中心实例不存在。 |
访问错误中心查看更多错误码。