tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

Updating Speech Recognition Queue

Last updated: 2024-02-18 15:49:31

    Feature Description

    This API (UpdateSpeechQueue) is used to update a speech recognition queue.

    Request

    Sample request

    PUT /asrqueue/p8eb46b8cc1a94bc09512d16c5c4f4d3a 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: Auth String (for more information, see Request Signature).
    When this feature is used by a sub-account, relevant permissions must be granted. For more information, see Authorization Granularity.

    Request headers

    This API only uses common request headers. For more information, see Common Request Headers.

    Request body

    This request requires the following request body:
    <Request>
        <Name>Queue Name</Name>
        <QueueID></QueueID>
        <State></State>
        <NotifyConfig>
            <Type></Type>
            <Url></Url>
            <Event></Event>
        </NotifyConfig>
    </Request>
    The nodes are described as follows:
    Node Name (Keyword)
    Parent Node
    Description
    Type
    Required
    Request
    None
    Request container
    Container
    Yes
    
    Request has the following sub-nodes:
    Node Name (Keyword)
    Parent Node
    Description
    Type
    Required
    Constraints
    Name
    Request
    Template name
    String
    Yes
    Length limit: 100 characters
    QueueID
    Request
    Channel ID
    String
    Yes
    -
    State
    Request
    Channel status
    String
    Yes
    1. Active: Jobs in the channel will be scheduled and executed by the speech recognition service.
    Paused: The channel is paused, and jobs in it will no longer be scheduled and executed. All jobs in the channel will remain in the `Submitted` status, while jobs being executed will continue without being affected.
    NotifyConfig
    Request
    Notification channel
    Container
    Yes
    Third-party callback URL
    
    NotifyConfig has the following sub-nodes:
    Node Name (Keyword)
    Parent Node
    Description
    Type
    Required
    Constraints
    Url
    Request.NotifyConfig
    Callback configuration
    String
    No
    Length limit: 100 characters
    Type
    Request.NotifyConfig
    Callback type. General callback: Url
    String
    No
    Length limit: 100 characters
    Event
    Request.NotifyConfig
    Callback event
    String
    No
    Length limit: 100 characters
    State
    Request.NotifyConfig
    Callback switch: `Off` or `On`
    String
    No
    Length limit: 100 characters
    

    Response

    Response headers

    This API only returns common response headers. For more information, see Common Response Headers.

    Response body

    The response body returns application/xml data. The following contains all the nodes:
    <Response>
        <RequestId>NTk0MjdmODlfMjQ4OGY3XzYzYzhf****</RequestId>
        <Queue>
            <QueueId></QueueId>
            <Name></Name>
            <State>Active</State>
            <NotifyConfig>
                <Url>mts-topic-1</Url>
                <Type></Type>
                <Event></Event>
            </NotifyConfig>
            <CreateTime></CreateTime>
            <UpdateTime></UpdateTime>
        </Queue>
    </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
    Queue
    Response
    Queue information. Same as Response.QueueList in [DescribeSpeechQueues].
    Container

    Error codes

    There are no special error messages for this request. For common error messages, see Error Codes.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy