This API is used to query a template.
GET /template HTTP/1.1
Host: <BucketName-APPID>.ci.<Region>.myqcloud.com
Date: <GMT Date>
Authorization: <Auth String>
Content-Length: <length>
Content-Type: application/xml
Note:
- Authorization: Auth String (for more information, see Request Signature).
- When this feature is used by a sub-account, relevant permissions must be granted.
This API only uses common request headers. For more information, see Common Request Headers.
The request body of this request is empty.
The nodes are as described below:
Node Name (Keyword) | Parent Node | Description | Type | Required |
---|---|---|---|---|
tag | None | Template tag. Default value: All . |
String | No |
category | None | Valid values: Official (system preset template); Custom (custom template). Default value: Custom . |
String | No |
ids | None | Template ID. If you enter multiple IDs, separate them by comma. | String | No |
name | None | Template name prefix | String | No |
pageNumber | None | Page number. Default value: 1 . |
Integer | No |
pageSize | None | Number of entries per page. Default value: 10 . |
Integer | No |
Supported tag
types are as follows:
Template type | tag |
---|---|
Speech recognition | SpeechRecognition |
This API only returns common response headers. For more information, see Common Response Headers.
The response body returns application/xml data. The following contains all the nodes:
<Response>
<RequestId>NTk0MjdmODlfMjQ4OGY3XzYzYzhfMjc=</RequestId>
<TotalCount>1</TotalCount>
<PageNumber>1</PageNumber>
<PageSize>10</PageSize>
<TemplateList>
<TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
<Name>TemplateName</Name>
<Tag>SpeechRecognition</Tag>
<SpeechRecognition>
<EngineModelType>16k_zh</EngineModelType>
<ResTextFormat>1</ResTextFormat>
<FilterDirty>0</FilterDirty>
<FilterModal>1</FilterModal>
<ConvertNumMode>0</ConvertNumMode>
<SpeakerDiarization>1</SpeakerDiarization>
<SpeakerNumber>0</SpeakerNumber>
<FilterPunc>0</FilterPunc>
<OutputFileType>txt</OutputFileType>
</SpeechRecognition>
<CreateTime>2020-08-05T11:35:24+0800</CreateTime>
<UpdateTime>2020-08-31T16:15:20+0800</UpdateTime>
</TemplateList>
</Response>
The nodes are as described below:
Node Name (Keyword) | Parent Node | Description | Type |
---|---|---|---|
Response | None | Response container | Container |
Response
has the following sub-nodes:
Node Name (Keyword) | Parent Node | Description | Type |
---|---|---|---|
RequestId | Response | Unique ID of the request. | String |
TotalCount | Response | Total number of templates | Int |
PageNumber | Response | Current page number, which is the same as pageNumber in the request. |
Int |
PageSize | Response | Number of entries per page, which is the same as pageSize in the request. |
Int |
TemplateList | Response | Template array | Container array |
For different types of templates, the TemplateList
content is the same as the Response
of the corresponding template creation API. For more information, see:
There are no special error messages for this request. For common error messages, see Error Codes.
Sample 1. Querying by template ID
GET /template?ids=t1847cd4ca57f543e89f551dbe68169eb9,t1a30a323f55434a29b25bf2a16bdf5f59,C HTTP/1.1
Authorization: q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0a1ICvR****&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0e****
Host: test-1234567890.ci.ap-beijing.myqcloud.com
Content-Length: 0
Content-Type: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 100
Connection: keep-alive
Date: Thu, 14 Jul 2022 12:37:29 GMT
Server: tencent-ci
x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****
<Response>
<RequestId>NTk0MjdmODlfMjQ4OGY3XzYzYzhf****</RequestId>
<TemplateList>
<TemplateId>t1847cd4ca57f543e89f551dbe68169eb9</TemplateId>
<Name>TemplateName</Name>
<Tag>SpeechRecognition</Tag>
<SpeechRecognition>
<EngineModelType>16k_zh</EngineModelType>
<ResTextFormat>1</ResTextFormat>
<FilterDirty>0</FilterDirty>
<FilterModal>1</FilterModal>
<ConvertNumMode>0</ConvertNumMode>
<SpeakerDiarization>1</SpeakerDiarization>
<SpeakerNumber>0</SpeakerNumber>
<FilterPunc>0</FilterPunc>
<OutputFileType>txt</OutputFileType>
</SpeechRecognition>
<CreateTime>2020-08-05T11:35:24+0800</CreateTime>
<UpdateTime>2020-08-31T16:15:20+0800</UpdateTime>
</TemplateList>
<TemplateList>
<TemplateId>t1a30a323f55434a29b25bf2a16bdf5f59</TemplateId>
<Name>TemplateName</Name>
<Tag>SpeechRecognition</Tag>
<SpeechRecognition>
<EngineModelType>8k_zh_s</EngineModelType>
<ResTextFormat>1</ResTextFormat>
<FilterDirty>0</FilterDirty>
<FilterModal>1</FilterModal>
<ConvertNumMode>0</ConvertNumMode>
<SpeakerDiarization>1</SpeakerDiarization>
<SpeakerNumber>0</SpeakerNumber>
<FilterPunc>0</FilterPunc>
<OutputFileType>txt</OutputFileType>
</SpeechRecognition>
<CreateTime>2020-08-05T11:35:24+0800</CreateTime>
<UpdateTime>2020-08-31T16:15:20+0800</UpdateTime>
</TemplateList>
<NonExistTIDs>
<TemplateId>C</TemplateId>
</NonExistTIDs>
</Response>
Sample 2. Querying by paginated list
GET /template?pageSize=10&pageNumber=1 HTTP/1.1
Authorization: q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0a1ICvR****&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0e****
Host: test-1234567890.ci.ap-beijing.myqcloud.com
Content-Length: 0
Content-Type: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 100
Connection: keep-alive
Date: Thu, 14 Jul 2022 12:37:29 GMT
Server: tencent-ci
x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****
<Response>
<RequestId>NTk0MjdmODlfMjQ4OGY3XzYzYzhf****</RequestId>
<TotalCount>2</TotalCount>
<PageNumber>1</PageNumber>
<PageSize>10</PageSize>
<TemplateList>
<TemplateId>t1847cd4ca57f543e89f551dbe68169eb9</TemplateId>
<Name>TemplateName</Name>
<Tag>SpeechRecognition</Tag>
<SpeechRecognition>
<EngineModelType>16k_zh</EngineModelType>
<ResTextFormat>1</ResTextFormat>
<FilterDirty>0</FilterDirty>
<FilterModal>1</FilterModal>
<ConvertNumMode>0</ConvertNumMode>
<SpeakerDiarization>1</SpeakerDiarization>
<SpeakerNumber>0</SpeakerNumber>
<FilterPunc>0</FilterPunc>
<OutputFileType>txt</OutputFileType>
</SpeechRecognition>
<CreateTime>2020-08-05T11:35:24+0800</CreateTime>
<UpdateTime>2020-08-31T16:15:20+0800</UpdateTime>
</TemplateList>
<TemplateList>
<TemplateId>t1a30a323f55434a29b25bf2a16bdf5f59</TemplateId>
<Name>TemplateName</Name>
<Tag>SpeechRecognition</Tag>
<SpeechRecognition>
<EngineModelType>8k_zh_s</EngineModelType>
<ResTextFormat>1</ResTextFormat>
<FilterDirty>0</FilterDirty>
<FilterModal>1</FilterModal>
<ConvertNumMode>0</ConvertNumMode>
<SpeakerDiarization>1</SpeakerDiarization>
<SpeakerNumber>0</SpeakerNumber>
<FilterPunc>0</FilterPunc>
<OutputFileType>txt</OutputFileType>
</SpeechRecognition>
<CreateTime>2020-08-05T11:35:24+0800</CreateTime>
<UpdateTime>2020-08-31T16:15:20+0800</UpdateTime>
</TemplateList>
</Response>
Apakah halaman ini membantu?