ListMarketingFlow - Chat App Message Service - Alibaba Cloud Documentation Center

Queries a list of campaigns.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cams:ListMarketingFlow

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ActivityStatus	string	No	The campaign status.	sucess
RelatedGroupId	integer	No	The ID of the associated group.	68
RelatedFlowCode	string	No	The ID of the associated flow.	asdfsdfdsfs
ActivityName	string	No	The name of the node task instance.	werewew
ActivityCode	string	No	The campaign code. You can use the system-generated code or modify it to use a custom code.	rewrwerw
PageIndex	string	No	The current page number.	1
PageSize	string	No	The number of entries per page.	1
BizCode	string	No	The business tenant code. Default value: ALICOM_OPAAS.	ALICOM_OPAAS
BizExtend	object	No	The business extension information. Default value: "{}".	{}

Response elements

Element	Type	Description	Example
	object
AccessDeniedDetail	string	The details about the access denial.	{}
TotalCount	integer	The total number of entries in the list.	15
Message	string	The message returned for the request.	NULL
RequestId	string	The request ID. Alibaba Cloud generates a unique ID for each request. You can use the ID to troubleshoot issues.	CB6122C9-09B5-5926-**476A96CB0
Data	array<object>	The returned data object.
	array<object>	The returned data object.
RelatedFlowName	string	The name of the associated flow.	aaa
ActivityStatus	string	The campaign status.	active
ActivityName	string	The campaign name.	aaa
ActivityCode	string	The campaign code.	3243243***
ExecutionType	string	The execution method.	1(default cron)
RelatedGroupId	string	The ID of the associated group.	54354**
SpecificTime	string	The specific time. This parameter is valid when ExecutionType is set to 2.	Specific time (when ExecutionType is 2)
Params	object	The custom user parameters.	{\"CustomerLimit\":false}
BizExtend	object	The business extension information. Default value: "{}".	{}
RelatedGroupName	string	The name of the associated group.	AAA
EndDate	string	The end time in the YYYY-MM-DD HH:mm:ss format.	2025-01-01 XX1:11:11
StartDate	string	The start time in the YYYY-MM-DD HH:mm:ss format.	2025-01-XX 11:11:11
GmtCreate	string	The creation time in the YYYY-MM-DD HH:mm:ss format.	2025-XX-01 11:11:11
TenantCode	string	The tenant.	1111
ActivityDesc	string	The campaign description.	aaa
RelatedFlowCode	string	The associated flow code.	dsafdsf***
GmtModifier	string	[Deprecated] The modification time.	N/A
Id	integer	The operational activity ID.	99
CronExpression	string	The upgrade start time. The upgrade start time is specified as a cron expression. For example, `0 0 4 1/1 * ?` indicates that the upgrade starts at 4:00 on the first day of each month and runs at 4:00 every day.	0 0 4 1/1 * ?
ParamFlag	string	Indicates whether custom parameters are enabled.	Y
BizCode	string	The business tenant code. Default value: ALICOM_OPAAS.	{}
Code	string	The request status code. OK indicates that the request was successful. For other error codes, see Error codes.	OK
Success	boolean	Indicates whether the call was successful. Valid values: true: The call was successful. false: The call failed.	true

Examples

Success response

JSON format

{
  "AccessDeniedDetail": "{}",
  "TotalCount": 15,
  "Message": "NULL",
  "RequestId": "CB6122C9-09B5-5926-**476A96CB0",
  "Data": [
    {
      "RelatedFlowName": "aaa",
      "ActivityStatus": "active",
      "ActivityName": "aaa",
      "ActivityCode": "3243243***",
      "ExecutionType": "1(default cron)",
      "RelatedGroupId": "54354**",
      "SpecificTime": "Specific time (when ExecutionType is 2)",
      "Params": {
        "test": "test",
        "test2": 1
      },
      "BizExtend": {},
      "RelatedGroupName": "AAA",
      "EndDate": "2025-01-01 XX1:11:11",
      "StartDate": "2025-01-XX 11:11:11",
      "GmtCreate": "2025-XX-01 11:11:11",
      "TenantCode": "1111",
      "ActivityDesc": "aaa",
      "RelatedFlowCode": "dsafdsf***",
      "GmtModifier": "N/A",
      "Id": 99,
      "CronExpression": "0 0 4 1/1 * ?",
      "ParamFlag": "Y",
      "BizCode": "{}"
    }
  ],
  "Code": "OK",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.