tencent cloud

Feedback

Querying Speech Recognition Queue

Last updated: 2022-08-18 15:05:05

    Feature Description

    This API (DescribeSpeechQueues) is used to query speech recognition queues.

    Request

    Sample request

    GET /asrqueue 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. For more information, see Authorization Granularity.

    Request headers

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

    Request body

    The request body of this request is empty.

    Request parameters

    Name Type Description Required
    queueIds string Queue ID. If you enter multiple IDs, separate them by comma. No
    state string 1. Active: Jobs in the queue will be scheduled and executed by the speech recognition service.
    2. Paused: The queue is paused, and jobs in it will no longer be scheduled and executed. All jobs in the queue will remain in the `Paused` status, while jobs being executed will continue without being affected.
    No
    pageNumber string Page number No
    pageSize string Number of entries per page No

    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 when pageNumber and pageSize are specified:

    <Response>
      <RequestId>NTk0MjdmODlfMjQ4OGY3XzYzYzhf****</RequestId>
      <TotalCount>1</TotalCount>
      <PageNumber>1</PageNumber>
      <PageSize>10</PageSize>
      <QueueList>
          <QueueId>A</QueueId>
          <Name></Name>
          <State>Active</State>
          <MaxSize>10000</MaxSize>
          <MaxConcurrent>10</MaxConcurrent>
          <UpdateTime></UpdateTime>
          <CreateTime></CreateTime>
          <NotifyConfig>
              <Url></Url>
              <Type></Type>
              <State></State>
              <Event></Event>
          </NotifyConfig>
      </QueueList>
    </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 queues Int
    PageNumber Response Current page number. Same as pageNumber in the request. Int
    PageSize Response Number of entries per page. Same as pageSize in the request. Int
    QueueList Response Queue array Container

    QueueList has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type
    QueueId Response.QueueList Queue ID String
    Name Response.QueueList Queue name String
    State Response.QueueList Current status: Active or Paused String
    NotifyConfig Response.QueueList Callback configuration Container
    MaxSize Response.QueueList Maximum length of the queue Int
    MaxConcurrent Response.QueueList Maximum number of concurrent jobs in the current queue Int
    UpdateTime Response.QueueList Update time String
    CreateTime Response.QueueList Creation time String

    NotifyConfig has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type
    Url Response.QueueList.NotifyConfig Callback address String
    State Response.QueueList.NotifyConfig Switch status: On or Off String
    Type Response.QueueList.NotifyConfig Callback type: Url String
    Event Response.QueueList.NotifyConfig The event that triggered the callback String

    The response body returns application/xml data. The following contains all the nodes when queueIds is specified:

    <Response>
      <RequestId>NTk0MjdmODlfMjQ4OGY3XzYzYzhf****</RequestId>
      <QueueList>
          <QueueId>A</QueueId>
          <Name></Name>
          <State>Active</State>
          <NotifyConfig>
              <Url></Url>
          </NotifyConfig>
      </QueueList>
      <NonExistPIDs>
          <QueueID>B</QueueID>
          <QueueID>C</QueueID>
      </NonExistPIDs>
    </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
    QueueList Response Queue array. Same as QueueList described above. Container
    NonExistPIDs Response List of non-existing queue IDs Container

    NonExistPIDs has the following sub-nodes:

    Node Name (Keyword) Parent Node Description Type
    QueueID Response.NonExistPIDs Queue ID String

    Error codes

    There are no special error messages for this request. For common error messages, see Error Codes.

    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support