Feature Description
This API is used to update the intelligent voice queue.
Authorization Description
When using a sub-account, you need to add the ci:UpdateAsrQueue permission to the authorization policy action. For all supported Cloud Infinite (CI) API operations, please refer to CI action. Service Activation
To use this feature, you need to bind bucket in advance and enable Cloud Infinite service. To use this feature, you need to enable Smart Audio Service in advance via console or API. Note:
Note: After binding Cloud Infinite (CI), if you manually perform bucket unbind, you will not be able to continue using this function.
Use Limits
When using this API, please confirm the relevant restrictions. For details, see Use Limits. Request
Request sample
PUT /asrqueue/<queueId> HTTP/1.1
Host: <BucketName-APPID>.ci.<Region>.myqcloud.com
Date: <GMT Date>
Authorization: <Auth String>
Content-Length: <length>
Content-Type: application/xml
<body>
Note:
Authorization: A request header that carries authentication information to verify the legitimacy of the request. For details, see the Request Signature document. queueId: The queue ID for file processing, which can be queried via the console or API. Request header
Request body
The implementation of this request operation requires the following request body.
<Request>
<Name>My-Queue-asr</Name>
<State>Active</State>
<NotifyConfig>
<State>On</State>
<Url>http://callback.demo.com</Url>
<Type>Url</Type>
<Event>TaskFinish,WorkflowFinish</Event>
<ResultFormat>JSON</ResultFormat>
</NotifyConfig>
</Request>
The data are as follows:
|
Request | None. | Container for saving results | Container | Yes | None. | None. |
Container node Request content:
|
Name | Request | Queue name: Only Chinese, English, digits, _, -, and * are allowed, with a length not exceeding 128. | String | None. | Yes |
State | Request | Active: Indicates that jobs in the queue will be scheduled for execution. Paused: Indicates the queue is suspended, jobs will no longer be scheduled for execution, all jobs in the queue remain in paused state, and executing tasks are not affected. | String | None. | Yes |
NotifyConfig | Request | callback configuration | Container | None. | Yes |
Content of the NotifyConfig in the Container node
|
State | Request.NotifyConfig | callback switch Off On | String | Off | No |
Event | Request.NotifyConfig | callback event TaskFinish: Task complete WorkflowFinish: Workflow completion | String | None. | When State=On, required |
ResultFormat | Request.NotifyConfig | callback format XML JSON | String | XML | No |
Type | Request.NotifyConfig | callback type Url TDMQ | String | None. | When State=On, required |
Url | Request.NotifyConfig | The callback URL cannot be a private network address. | String | None. | When State=On and Type=Url, required |
MqMode | Request.NotifyConfig | TDMQ usage mode Topic: Topic subscription Queue: Queue service | String | None. | When State=On and Type=TDMQ, required |
MqRegion | Request.NotifyConfig | TDMQ belonging to park, currently supports parks sh (Shanghai), bj (Beijing), gz (Guangzhou), cd (Chengdu), hk (Hong Kong (China)) | String | None. | When State=On and Type=TDMQ, required |
MqName | Request.NotifyConfig | TDMQ topic name | String | None. | When State=On and Type=TDMQ, required |
Response
Response Headers
Response Body
The response body is returned as application/xml. An example including the complete node data is shown below:
<Response>
<RequestId>NjJmNDczY2RfOTBmYTUwNjRfNTA4ZV85</RequestId>
<Queue>
<QueueId>p4a17eeea29334bf499b7e20e2fbfd99d</QueueId>
<Name>My-Queue-asr</Name>
<State>Active</State>
<NotifyConfig>
<Url>http://callback.demo.com</Url>
<Event>TaskFinish,WorkflowFinish</Event>
<Type>Url</Type>
<State>On</State>
<ResultFormat>JSON</ResultFormat>
<MqMode/>
<MqName/>
<MqRegion/>
</NotifyConfig>
<MaxSize>10000</MaxSize>
<MaxConcurrent>10</MaxConcurrent>
<BucketId>test007-1251704708</BucketId>
<Category>Speeching</Category>
<UpdateTime>2022-08-09T16:23:11+0800</UpdateTime>
<CreateTime>2022-08-09T16:13:05+0800</CreateTime>
</Queue>
</Response>
The data are as follows:
|
Response | None. | Container for saving results | Container |
Container node Response content:
|
RequestId | Response | unique request ID | String |
Queue | Response | queue information | Container |
Container node Queue content:
|
QueueId | Response.Queue | Queue ID | String |
Name | Response.Queue | queue name | String |
State | Response.Queue | Current status, Active or Paused | String |
NotifyConfig | Response.Queue | Callback configuration | Container |
MaxSize | Response.Queue | queue maximum length | Int |
MaxConcurrent | Response.Queue | Maximum number of tasks executed in parallel in the current queue | Int |
Category | Response.Queue | queue type | String |
UpdateTime | Response.Queue | Update time | String |
CreateTime | Response.Queue | Creation time | String |
BucketId | Response.Queue | Queue ID of the associated bucket | String |
Error Code
This request returns common error responses and error codes. For more information, see Error Codes. Practical Case
Request
PUT /asrqueue/p4a17eeea29334bf499b7e20e2fbfd99d HTTP/1.1
Authorization: q-sign-algorithm=sha1&q-ak=************************************&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=****************************************
Host: test-1234567890.ci.ap-chongqing.myqcloud.com
Content-Length: 162
Content-Type: application/xml
<Request>
<Name>My-Queue-asr</Name>
<State>Active</State>
<NotifyConfig>
<State>On</State>
<Url>http://callback.demo.com</Url>
<Type>Url</Type>
<Event>TaskFinish,WorkflowFinish</Event>
<ResultFormat>JSON</ResultFormat>
</NotifyConfig>
</Request>
Response
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 100
Connection: keep-alive
Date: Thu, 09 Aug 2022 16:23:12 GMT
Server: tencent-ci
x-ci-request-id: NjJmNDczY2RfOTBmYTUwNjRfNTA4ZV85
<Response>
<RequestId>NjJmNDczY2RfOTBmYTUwNjRfNTA4ZV85</RequestId>
<Queue>
<QueueId>p4a17eeea29334bf499b7e20e2fbfd99d</QueueId>
<Name>My-Queue-asr</Name>
<State>Active</State>
<NotifyConfig>
<Url>http://callback.demo.com</Url>
<Event>TaskFinish,WorkflowFinish</Event>
<Type>Url</Type>
<State>On</State>
<ResultFormat>JSON</ResultFormat>
<MqMode/>
<MqName/>
<MqRegion/>
</NotifyConfig>
<MaxSize>10000</MaxSize>
<MaxConcurrent>10</MaxConcurrent>
<BucketId>test-1234567890</BucketId>
<Category>Speeching</Category>
<UpdateTime>2022-08-09T16:23:11+0800</UpdateTime>
<CreateTime>2022-08-09T16:13:05+0800</CreateTime>
</Queue>
</Response>