tencent cloud

1. API Description

Domain name for API request: tdmq.tencentcloudapi.com.

Currently, the ReceiveMessage API only supports partitioned topics. It is used to receive messages sent to a specified partitioned topic. If it is called when there are no messages in the partitioned topic, the ReceiveTimeout exception will be reported.

Instructions on how to use BatchReceivePolicy:

BatchReceive has three parameters:

● MaxNumMessages: The maximum number of messages returned by Receive when BatchReceive is used.
● MaxNumBytes: The maximum size (in bytes) of the message returned by Receive when BatchReceive is used.
● Timeout: The maximum timeout period (in milliseconds) of calling Receive when BatchReceive is used.

By default, if you don’t specify any of the three parameters, the BatchReceive feature is disabled; if one of the three parameter values is above zero, BatchReceive is enabled. BatchReceive will be disabled when any of the three parameter values reaches the threshold you specify.

Note: The values of both MaxNumMessages and MaxNumBytes are subject to the value of ReceiveQueueSize. If the values of ReceiveQueueSize and MaxNumMessages are 5 and 10, respectively, you can receive up to five rather than 10 messages when BatchReceive is used.

The API configured with BatchReceivePolicy returns multiple messages at a time.

1. These messages are separated by “###”. After receiving them, you can separate them with split tools in different languages.
2. MessageIDs are separated by “###”. After receiving the messages, you can separate the MessageIDs with split tools in different languages, so that you can obtain the MessageID field information required for calling the AcknowledgeMessage API.

A maximum of 1000 requests can be initiated per second for this API.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

3. Output Parameters

4. Example

Example1 Receiving messages

Input Example

POST / HTTP/1.1
Host: tdmq.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ReceiveMessage
<Common request parameters>

{
    "Topic": "tenant/namespace/topic",
    "SubscriptionName": "\"test-sub\""
}

Output Example

{
    "Response": {
        "RequestId": "36713f94-d07d-4b96-babf-42d139276f23",
        "MessageID": "71:12:0:0",
        "MessageIDList": "",
        "MessagesPayload": "",
        "MessagePayload": "hello TDMQ",
        "SubName": "xx",
        "AckTopic": "persistent://tenant/namespace/topic",
        "ErrorMsg": "xx"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

• Tencent Cloud SDK 3.0 for Python
• Tencent Cloud SDK 3.0 for Java
• Tencent Cloud SDK 3.0 for PHP
• Tencent Cloud SDK 3.0 for Go
• Tencent Cloud SDK 3.0 for NodeJS
• Tencent Cloud SDK 3.0 for .NET
• Tencent Cloud SDK 3.0 for C++

Command Line Interface

• Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.