Sending Messages

Last updated: 2019-07-05 12:23:31

1. API Description

This API (SendMessage) is used to send a message to the specified queue.

Domain for public network API request:cmq-queue-region.api.qcloud.com

Domain for private network API request:cmq-queue-region.api.tencentyun.com

At any time (including alpha test), any downstream traffic generated when using public network domain will incur traffic fee. It is strongly recommended that users on Tencent Cloud use private network domain, as it will not incur any traffic fee.

  • The "region" should be replaced by a specific region: gz (Guangzhou), sh (Shanghai), bj (Beijing). The "region" value in the common parameter should be kept consistent with that in the domain. In case of inconsistency, the one in the domain should prevail. The request should be sent to the region specified by the domain.
  • Requests for accessing via public network domain support both HTTP and HTTPS. Requests for accessing via private network only support HTTP.
  • Some of the input parameters are optional, so the default values are not required.
  • All output parameters will be returned to the user when the request is successful; otherwise, at least code, message, and requestId will be returned.

2. Input Parameters

The following request parameter list only provides API request parameters. For other parameters, refer to Common Request Parameters.

Parameter Name Required Type Description
queueName Yes String Queue name. This is unique under the same account in one region. The name of queue is a string with no more than 64 characters. It must start with letter, and the rest may contain letters, numbers and dashes (-).
msgBody Yes String Message body. At least 1 Byte. Maximum length depends on the maximum length attribute of queue messages you have configured.
delaySeconds No Int Time needed before the message becomes visible to user after it has been sent to the queue (in seconds).
## 3. Output Parameters
Parameter Name Type Description
code Int 0: Succeeded, others: Error. For detailed errors, please refer to the table below.
message String Error message.
requestId String ID of the request generated by the server. When there is an internal error on the server, users can submit this ID to backend to locate the problem.
msgId String Unique ID of the message generated by the server.
Error Code Module Error Code Error Message Description
4400 10230 exceed maximum message size There's at least one message that reached the maximum message length limit. You can use the GetQueueAttributes API to view the maximum message length for the queue.
4000 10120 message body can't be empty The message body of msgBody cannot be empty. It should be at least 1 Byte.
4410 10240 reach maximum retention number of message The maximum number of messages in a queue has been reached. You can use the GetQueueAttributes API to view the maximum number of messages for the queue.

Note: The error codes listed in the above table are specific to the API. If the error code you are looking for is not here, you may find it in the Common Error Codes.

4. Example

Input:

 https://domain/v2/index.php?Action=SendMessage
 &queueName=test-queue-123
 &msgBody=helloworld
 &<Common Request Parameters>

Output:

{
"code" : 0,
"message" : "",
"requestId":"14534664555",
"msgId":"123345346"
}