天翼云智能视图服务API

1.查询回调模板列表

接口功能介绍

本接口用于查询回调模板列表。

接口约束

无

URI

GET /callbackTemplate

路径参数
无

Query参数

参数	是否必填	参数类型	说明	示例
TemplateName	否	String	根据TemplateName查询。	回调模板
SortBy	否	String	选择按一个字段排序，默认为CreatedTime，按照创建时间排序。取值：TemplateName(模板名称)，CreatedTime(创建时间)。	CreatedTime
SortDirection	否	String	排序方式，默认升序。取值：asc(升序)，desc(降序)。	asc
PageNum	否	Integer	第几个分页，默认为1。	1
PageSize	否	Integer	分页大小，默认为20，取值范围为1～1000。	20

请求参数

请求头header参数

参数	是否必填	参数类型	说明	示例
Authorization	是	String	认证信息。	CT-HMAC-SHA256 Credential=FQ01GA2RR9IJFM1PWIPR/2023-07-18/vss, SignedHeaders=content-type;host;timestamp, Signature=c6e72dffcfb2d25d276e119781e1deb6656d966702191b2bd862d1691e39394f
Content-Type	是	String	互联网媒体类型。	application/json;charset=utf-8
Host	是	String	主机。	vssapi.ctyun.cn
Version	是	String	版本。	2021-11-25
Timestamp	是	String	时间戳。	1689643309

请求体body参数
无

响应参数

参数	参数类型	说明	示例	下级对象
statusCode	Integer	响应状态码。	200
error	String	错误码，执行成功时，不返回该字段。	VSS_0001
message	String	响应信息。	请求成功
requestId	String	请求ID。	362d4e78556b47129182d0881fade86b
returnObj	Object	响应数据，执行失败时，不返回该字段。		returnObj

表 returnObj

参数	参数类型	说明	示例	下级对象
PageNum	Integer	第几个分页。	1
PageSize	Integer	分页大小。	10
TotalPage	Integer	分页总数。	1
TotalNum	Integer	模板总数。	10
CallbackTemplates	Array of Objects	模板列表。		CallbackTemplate
RequestId	String	请求ID。	362d4e78556b47129182d0881fade86b

表 CallbackTemplate

参数	参数类型	说明	示例
TemplateId	String	模板ID。	739943519892963328
TemplateName	String	模板名称。	test
Description	String	模板描述。	描述
CallbackKey	String	回调KEY。	xxx
DeviceStatusNotifyUrl	String	设备状态回调URL。	http://example.ctyun.cn/example
StreamStatusNotifyUrl	String	流状态回调URL。	http://example.ctyun.cn/example
RecordNotifyUrl	String	录制回调URL。	http://example.ctyun.cn/example
AiEventNotifyUrl	String	AI回调URL。	http://example.ctyun.cn/example
CreatedTime	String	创建时间。	1691992586
UpdatedTime	String	更新时间。	1691992586

请求示例

请求url

GET '/callbackTemplate?PageNum=1&PageSize=20'

请求头header

{
    "Authorization": "CT-HMAC-SHA256 Credential=FQ01GA2RR9IJFM1PWIPR/2023-08-14/vss, SignedHeaders=content-type;host;timestamp, Signature=b5f5d8aee3bdb5a0f6b343f7d51945026e9e874277b395a61b0774974b97adac",
    "Content-Type": "application/json;charset=utf-8",
    "Host": "vssapi.ctyun.cn",
    "Version": "2021-11-25",
    "Timestamp": "1691993995"
}

请求体body
无

响应示例

{
  "statusCode": 200,
  "message": "请求成功",
  "requestId": "8f5de39981174c32b3a70f5c6302e22c",
  "returnObj": {
    "PageNum": 1,
    "PageSize": 20,
    "TotalPage": 1,
    "TotalNum": 1,
    "CallbackTemplates": [
      {
        "TemplateId": "739943519892963328",
        "TemplateName": "设备状态回调模板",
        "Description": "",
        "CallbackKey": "123",
        "DeviceStatusNotifyUrl": "http://example.ctyun.cn/example",
        "StreamStatusNotifyUrl": "",
        "RecordNotifyUrl": "",
        "AiEventNotifyUrl": "",
        "CreateTime": "1691992586",
        "UpdateTime": "1691992586"
      }
    ],
    "RequestId": "8f5de39981174c32b3a70f5c6302e22c"
  }
}

状态码

请参考状态码说明。

错误码

请参考错误码说明。

查询回调模板列表

最近更新时间：2026-03-19 18:16:28

天翼云智能视图服务API

1.查询回调模板列表

接口功能介绍

接口约束

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码