Help Center/ ROMA Connect/ API Reference/ Message Integration APIs/ Message Management/ Retransmitting a Message
Updated on 2025-03-26 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Retransmitting a Message

Function

This API is used to retransmit a message.

URI

POST /v2/{project_id}/mqs/instances/{instance_id}/messages/action

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain a project ID, see "Appendix" > "Obtaining a Project ID" in this document.

instance_id

Yes

String

Instance ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

action_id

Yes

String

Retransmission type. Currently, only resend is supported.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header).
Table 4 Request body parameters

Parameter

Mandatory

Type

Description

topic

Yes

String

Topic name.

partition

Yes

Integer

Partition.

message_offset

Yes

Number

Message offset.

consumer_key

No

String

Application key. Add consumer_key to the message header.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

topic

String

Topic name.

partition

Integer

Partition.

message_offset

Integer

Message offset.

consumer_key

String

Application key. Add consumer_key to the message header.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

Retransmit the message whose offset is 4 and add a specified header to it.

POST https://{endpoint}/v2/{project_id}/mqs/instances/{instance_id}/messages/action?action_id=resend

{
  "topic" : "topic-test",
  "partition" : 0,
  "message_offset" : 4,
  "consumer_key" : "keyA"
}

Example Responses

Status code: 200

OK

{
  "topic" : "topic-test",
  "partition" : 0,
  "message_offset" : 4,
  "consumer_key" : "keyA"
}

Status code: 400

Bad Request

{
  "error_code" : 400,
  "error_msg" : "Bad Request"
}

Status code: 403

Forbidden

{
  "error_code" : 403,
  "error_msg" : "Forbidden"
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

403

Forbidden

Error Codes

See Error Codes.

Parent topic: Message Management