API Introduction
Used to push messages to specified consumers.
API Restrictions
None.
URl
POST https://[endpoint]/v2/message/push
Request Parameters
Request Parameters | Required or Not | Position | Parameter Type | Description |
prodInstId | Yes | url | String | Instance ID |
msgId | Yes | url | String | Message ID |
groupName | Yes | url | String | Subscription Group Name |
clientId | Yes | url | String | Client ID |
Response Parameter
Response Parameter | Parameter Type | Description |
statusCode | String | The status code of the interface on the system layer. Success: 800; failure: 900. |
message | String | Status Description |
returnObj | String | Return the object. The parameters included in this parameter are described in the comments in Response Examples. |
Sample Request
POST https://[endpoint]/v2/message/push
{
"prodInstId":"mq_test",
"msgId":"C0A847BC000020E60000000000003FEE",
"groupName":"group",
"clientId":"5.5.148.141@test_instance"
}
Examples of a Successful Response
{
"returnObj":{
},
"message":"success",
"statusCode":800
}
Example of a Failed Response
{
"returnObj": {},
"message": "...",
"statusCode": "900"
}