Revoke messages

Revoke messages sent through simple or template push by message ID, or messages sent through batch or group push by task ID. Only messages sent within the past 7 days can be revoked.

Revoke by message ID

Revokes messages sent through simple or template push.

Request parameters

Parameter name	Type	Required	Example	Description
messageId	String	Yes	1578807462788	The custom message ID that uniquely identifies the message in your system.
targetId	String	Yes	user1024	The target ID. If the original message was sent to a device, this is the device ID. If the message was sent to a user, this is the user ID.

Response parameters

Parameter name	Type	Example	Description
RequestId	String	B589F4F4-CD68-3CE5-BDA0-6597F33E23916512	The request ID.
ResultCode	String	OK	The request result code.
ResultMessage	String	param is invalid	The error description.
PushResult	JSON		The request result.
Success	boolean	true	The request status. The value of the Success parameter is in the PushResult JSON string.
ResultMsg	String	param is invalid	The error message. The value of the ResultMsg parameter is in the PushResult JSON string.

Example

import com.alibaba.fastjson.JSON;
import com.aliyun.mpaas20201028.Client;
import com.aliyun.mpaas20201028.models.RevokePushMessageRequest;
import com.aliyun.mpaas20201028.models.RevokePushMessageResponse;
import com.aliyun.teaopenapi.models.Config;

public static void main(String[] args) throws Exception {
    // An Alibaba Cloud account AccessKey has access permissions to all APIs. Use a Resource Access Management (RAM) user for API access or daily O&M.
    // Do not save your AccessKey ID and AccessKey secret in your project code. This can cause an AccessKey leak and compromise the security of all resources in your account.
    // This example saves the AccessKey ID and AccessKey secret in environment variables. You can also save them in a configuration file as needed.
    // Configure the environment variables first.
    Config config = new Config();
    // Required. Your AccessKey ID.
    config.setAccessKeyId(System.getenv("MPAAS_AK_ENV"));
    // Required. Your AccessKey secret.
    config.setAccessKeySecret(System.getenv("MPAAS_SK_ENV"));
    // The mPaaS REGION_ID and Endpoint. This example uses the Hangzhou region.
    config.setRegionId("cn-hangzhou");
    config.setEndpoint("mpaas.cn-hangzhou.aliyuncs.com");
    Client client = new Client(config);

    RevokePushMessageRequest request = new RevokePushMessageRequest();
    request.setAppId("ONEX570DA89211721");
    request.setWorkspaceId("test");
    request.setTenantId("xxx");
    request.setMessageId("console_1765175220865");
    request.setTargetId("push_test");
    RevokePushMessageResponse revokePushMessageResponse = client.revokePushMessage(request);
    System.out.println("response==>"+JSON.toJSONString(revokePushMessageResponse));
}

Revoke by task ID

Revokes messages sent through batch push and broadcast push.

Request parameters

Parameter Name	Type	Required	Example	Description
taskId	String	Yes	20842863	The push task ID. You can find this ID in the push task list in the console.

Response parameters

Parameter name	Type	Example	Description
RequestId	String	B589F4F4-CD68-3CE5-BDA0-6597F33E23916512	The request ID.
ResultCode	String	OK	The request result code.
ResultMessage	String	param is invalid	The error description.
PushResult	JSON		The request result.
Success	boolean	true	The request status. The value of the Success parameter is in the PushResult JSON string.
ResultMsg	String	param is invalid	The error message. The value of the ResultMsg parameter is in the PushResult JSON string.

Example

import com.alibaba.fastjson.JSON;
import com.aliyun.mpaas20201028.Client;
import com.aliyun.mpaas20201028.models.RevokePushTaskRequest;
import com.aliyun.mpaas20201028.models.RevokePushTaskResponse;
import com.aliyun.teaopenapi.models.Config;

public static void main(String[] args) throws Exception {
    // An Alibaba Cloud account AccessKey has access permissions to all APIs. Use a Resource Access Management (RAM) user for API access or daily O&M.
    // Do not save your AccessKey ID and AccessKey secret in your project code. This can cause an AccessKey leak and compromise the security of all resources in your account.
    // This example saves the AccessKey ID and AccessKey secret in environment variables. You can also save them in a configuration file as needed.
    // Configure the environment variables first.
    Config config = new Config();
    // Required. Your AccessKey ID.
    config.setAccessKeyId(System.getenv("MPAAS_AK_ENV"));
    // Required. Your AccessKey secret.
    config.setAccessKeySecret(System.getenv("MPAAS_SK_ENV"));
    // The mPaaS REGION_ID and Endpoint. This example uses the Hangzhou region.
    config.setRegionId("cn-hangzhou");
    config.setEndpoint("mpaas.cn-hangzhou.aliyuncs.com");
    Client client = new Client(config);

    RevokePushTaskRequest request = new RevokePushTaskRequest();
    request.setAppId("ONEX570DA89211721");
    request.setWorkspaceId("test");
    request.setTenantId("xxx");
    request.setTaskId("21589533");
    RevokePushTaskResponse revokePushTaskResponse = client.revokePushTask(request);
    System.out.println("response==>"+ JSON.toJSONString(revokePushTaskResponse));
}