# Alibaba Cloud ChatApp Message Service API

> Alibaba Cloud ChatApp Message Service API on Apizie: 174 endpoints (Submits a request to change the destination, resume, or pause, Registers a Viber account and creates an account, Creates an IM group, Adds an invite link for an IM group, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:aliyun-cams/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-cams`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/cams
- Page: https://zieapi.vercel.app/api/cloud/aliyun-cams
- OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-cams/openapi.json

Alibaba Cloud OpenAPI for ChatApp Message Service (cams, version 2020-06-06). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Submits a request to change the destination, resume, or pause
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/add-address-recover-suspend` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| RequestType | string | no | The request type |
| CustSpaceId | string | no | The customer space ID |
| AuditRecord | string | no | The audit record (JSON-encoded) |

### Registers a Viber account and creates an account
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/add-audit-viber-open` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| AuditResult | string | no | The audit result |
| CustSpaceId | string | yes | The SpaceId of the ISV sub-customer |
| AuditRecord | string | no | The audit record (JSON-encoded) |

### Creates an IM group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/add-chat-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| BusinessNumber | string | yes | The phone number associated with the business account |
| Description | string | no | The group description |
| Subject | string | no | The group title |
| CustSpaceId | string | yes | The SpaceId or instance ID of the ISV sub-customer, which is the channel ID. Find it on the Channel Management… |
| ChannelType | string | no | The channel type. Valid value: WHATSAPP Currently, only the WhatsApp channel type is supported |
| GroupLink | string | no | The link to the WhatsApp group |

### Adds an invite link for an IM group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/add-chat-group-invite-link` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| BusinessNumber | string | yes | The business phone number. You can view the business phone number by calling the https://help.aliyun.com/document_detail/2932629.html… |
| ChannelType | string | no | The channel type. Valid values: WHATSAPP Only the WhatsApp channel type is supported |
| GroupId | string | yes | The group ID. You can view the group ID by calling the https://help.aliyun.com/document_detail/2932629.html operation |
| CustSpaceId | string | yes | The space ID or instance ID of the ISV sub-customer. This is the channel ID, which can be viewed on the Channel Management… |

### Adds a phone number to a WABA
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/add-chatapp-phone-number` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| PhoneNumber | string | yes | The phone number |
| CustSpaceId | string | yes | The space ID of the ISV sub-customer |
| Cc | string | yes | The country code |
| PreValidateId | string | no | The pre-validated phone number. This parameter is deprecated |
| VerifiedName | string | yes | The display name of the phone number |

### Edits a contact - add contact
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/add-contacts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| ContactName | string | no | The name of the contact |
| ContactDetails | string | no | The description of the contact |
| Country | string | no | The country |
| NeedUpdate | string | yes | Indicates whether the back-to-origin IP address whitelist needs to be updated. This parameter returns true when the current back-to-origin… |
| Groups | string | yes | The user group information |
| FilePath | string | no | The file path |
| BizCode | string | no | The business code |
| BizExtend | string | no | The business extension information. Default value: an empty collection (JSON-encoded) |
| Email | string | no | The email address |
| Remark | string | no | The remarks |

### Adds users to a custom audience
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/add-custom-audience-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| CustSpaceId | string | yes | The space ID of the Independent Software Vendor (ISV) sub-customer or the instance ID of a direct customer |
| PageId | string | yes | The Page ID for Messenger |
| AdAccountId | string | yes | The ID of the Meta ad account |
| CustomAudienceId | string | yes | The ID of the custom audience |
| Users | string | yes | A list of users (JSON-encoded) |
| EstimatedNumTotal | integer | no | The estimated total number of users |
| BatchLastFlag | string | no | Indicates whether this is the last batch of data |

### Adds a group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/add-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| GroupName | string | yes | The group name |
| ContactName | string | no | The contact name |
| ContactDetails | string | no | The contact description |
| Country | string | no | The country |
| FilePath | string | no | The file path |
| BizCode | string | no | The business tenant code |
| Email | string | no | The email address |
| BizExtend | string | no | The business extension information (JSON-encoded) |
| Remark | string | no | The remarks |

### Creates a campaign
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/add-marketing-flow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| ActivityName | string | yes | The name of the node task instance |
| StartDate | string | no | The start time in the YYYY-MM-DD HH:mm:ss format |
| ActivityDesc | string | no | The description of the campaign |
| EndDate | string | no | The end time in the YYYY-MM-DD HH:mm:ss format |
| ExecutionType | string | yes | The trigger method of the baseline scan. Valid values: Schedule: Triggered by a periodic configuration task. Manual: Manually triggered |
| CronExpression | string | no | The cron expression |
| RelatedGroupId | integer | no | The ID of the related group |
| RelatedFlowCode | string | no | The code of the associated flow |
| RelatedFlowName | string | no | The name of the associated flow |
| Params | string | no | The API parameters (JSON-encoded) |
| ParamFlag | string | no | The parameter flag |
| BizCode | string | no | The business code |
| BizExtend | string | no | The business extension information. Default value: an empty collection (JSON-encoded) |

### Archives a Chat App Message Service template. Currently, only WhatsApp templates support archiving
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/archive-chatapp-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| TemplateList | string | yes | The template list (JSON-encoded) |
| ArchiveType | string | yes | The archive type |
| CustSpaceId | string | yes | The space ID of the ISV sub-customer or the instance ID of the direct customer. You can view the Space ID on the Channel Management… |
| ChannelType | string | yes | The channel type. Valid values: WHATSAPP. Only the WhatsApp channel type is supported |

### Associates a DM account
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/bind-dm-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| CustSpaceId | string | yes | The SpaceId of the ISV sub-customer |
| AccountCode | string | yes | The account code |
| ExtendAttr | string | yes | The extended attributes (JSON-encoded) |

### Associates a page with an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/bind-instagram-page` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| PageId | string | yes | The page ID of the instance |
| InstanceId | string | yes | The instance ID |
| RegionId | string | no | The region of the instance |

### Binds the selected pageId
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/bind-messenger-page` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| PageId | string | yes | The PageId of the Messenger |
| InstanceId | string | yes | The instance ID |
| RegionId | string | no | The region ID |

### Moves a resource to a different resource group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/change-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| ResourceType | string | no | The resource type |
| ResourceId | string | yes | The resource ID |
| ResourceGroupId | string | yes | The target resource group |

### Binds a WhatsApp Business Account (WABA) through the northbound interface
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/chatapp-bind-waba` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| WabaId | string | yes | waba Id |

### Migrates a phone number registration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/chatapp-migration-register` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| CustSpaceId | string | yes | The space ID of the ISV sub-customer |
| PhoneNumber | string | yes | The phone number |

### Verifies a phone number for migration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/chatapp-migration-verified` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| CustSpaceId | string | yes | The space ID of the ISV sub-customer |
| PhoneNumber | string | yes | The phone number |
| VerifyCode | string | yes | The verification code |

### Deregisters a phone number from WABA
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/chatapp-phone-number-deregister` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| PhoneNumber | string | yes | The phone number |
| CustSpaceId | string | yes | The space ID of the ISV sub-customer |

### Registers a phone number through the northbound interface
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/chatapp-phone-number-register` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| PhoneNumber | string | yes | The phone number |
| CustSpaceId | string | yes | The space ID of the ISV sub-customer |

### Synchronizes phone number information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/chatapp-sync-phone-number` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| CustSpaceId | string | yes | The SpaceId of the ISV sub-customer |

### Verifies a verification code and registers through the northbound interface
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/chatapp-verify-and-register` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| CustSpaceId | string | yes | The SpaceId of the ISV sub-customer |
| PhoneNumber | string | yes | The phone number |
| VerifyCode | string | yes | The verification code |

### Validates the content of a WhatsApp direct-send template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/check-direct-send-message-sample` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| Type | string | yes | The direct-send content type. Valid values: interactive text |
| Interactive | string | no | The message body of the interactive type (JSON-encoded) |
| Text | string | no | The message body of the text content (JSON-encoded) |
| CustSpaceId | string | yes | The space ID of the ISV sub-customer or the instance ID of the direct customer |

### Copies a template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/copy-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| SceneTemplateCode | string | yes | The template code |
| SceneTemplateName | string | yes | The template name |
| CustSpaceId | string | no | The space ID of the ISV sub-customer |
| Language | string | no | The language |

### Creates a flow
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/create-chat-flow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| Title | string | no | The flow title |
| Remark | string | no | The flow remarks |
| FlowTriggerType | string | no | The flow trigger type. Valid values: TriggeredManually TriggeredByWhatsApp TriggeredByMessenger TriggeredByInstagram TriggeredByViber |
| BizCode | string | no | The business tenant code. Default value: ALICOM_OPAAS |
| BizExtend | string | no | The business extension information. Default value: an empty collection (JSON-encoded) |
| CreateFromFlowVersion | string | no | The source flowVersion for creation |
| CreateFromFlowCode | string | no | The source flowCode for creation |
| LifeCycleExtendData | string | no | The lifecycle extension input parameters (JSON-encoded) |

### Creates and imports a flow
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/create-chat-flow-by-import` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| Title | string | no | The flow title |
| Remark | string | no | The flow remarks |
| FlowViewModel | string | no | The imported flow DSL data, which is a JSON-formatted string. You can arrange flow components on the canvas in the flow orchestration… |
| BizCode | string | no | The business tenant code. Default value: ALICOM_OPAAS |
| BizExtend | string | no | The business extension information. Default value: an empty collection (JSON-encoded) |

### Creates a flow log setting
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/create-chat-flow-log-setting` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| FlowCode | string | no | The flow code. You can view the flow code in the Flow Editor (https://chatapp.console.aliyun.com/ChatFlowBuilder) page |

### Initiates the migration of a phone number
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/create-chatapp-migration-initiate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| CustSpaceId | string | yes | The Space ID of the Independent Software Vendor (ISV) sub-customer |
| MobileNumber | string | yes | The phone number. Do not include the country code |
| CountryCode | string | yes | The country code |

### Creates a message template. After the template is approved, you can use it to send messages
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/create-chatapp-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| Category | string | yes | WhatsApp template category. Valid values: UTILITY: transaction-related. MARKETING: marketing. AUTHENTICATION: identity verification. Viber… |
| Components | string | yes | The list of message template components. When Category=AUTHENTICATION, Components cannot contain nodes with Type=HEADER. When Type=BODY or… |
| Name | string | yes | The template name |
| Language | string | yes | The template language. For detailed language codes, see https://help.aliyun.com/document_detail/463420.html |
| Example | string | no | The example for creating the template (JSON-encoded) |
| TemplateType | string | yes | The templatetype. Valid values: WHATSAPP VIBER |
| CustWabaId | string | no | The ISV customer WabaId. Deprecated parameter. Use CustSpaceId instead |
| IsvCode | string | no | The ISV verification code, used to verify whether the sub-account is authorized by the ISV |
| CustSpaceId | string | no | The SpaceId of the ISV sub-customer or the direct customer instance ID |
| AllowCategoryChange | string | no | Specifies whether to allow Facebook to automatically change the template category (to improve the template approval rate). This property… |
| MessageSendTtlSeconds | integer | no | The time-to-live (TTL) for template messages in WhatsApp. AUTHENTICATION: valid values range from 30 to 900. UTILITY: valid values range… |
| CategoryChangePaused | string | no | Specifies whether to pause template sending when a Utility template is changed to Marketing type. This property is valid only for WhatsApp… |
| ProductSetId | string | no | productSetId |

### Creates a custom audience
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/create-custom-audience` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| CustSpaceId | string | yes | The Space ID of the ISV sub-customer, or the instance ID of the direct customer. View the Space ID on the Channel Management… |
| PageId | string | yes | The Page ID for Messenger |
| AdAccountId | string | yes | The Meta ad account ID |
| Name | string | yes | The name of the custom audience |
| Description | string | no | The description |
| UploadType | string | yes | The upload method |
| FilePath | string | no | The file path |

### Creates a Flow
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/create-flow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| FlowName | string | yes | The name of the Flow |
| Categories | string | yes | The categories (JSON-encoded) |
| CustSpaceId | string | no | The space ID of the ISV sub-customer |
| EndpointUri | string | no | The URL of the WA Flow Endpoint |

### Creates a new flow version by copying an existing flow version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/create-flow-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| FlowCode | string | no | The flow code. You can view the flow code on the flow editor (https://chatapp.console.aliyun.com/ChatFlowBuilder) page |
| FlowVersionCopyFrom | string | no | The flow version to copy. Click a flow name on the flow editor (https://chatapp.console.aliyun.com/ChatFlowBuilder) page to enter the… |
| Remark | string | no | The version remarks |
| BizCode | string | no | The business tenant code. Default value: ALICOM_OPAAS |
| BizExtend | string | no | The business extension information. Default value: an empty collection (JSON-encoded) |

### Creates an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/create-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| ChannelType | string | yes | The channel type. The Singapore site supports all channels, and the Germany site currently supports only WhatsApp. |
| InstanceName | string | yes | The instance name |
| InstanceDescription | string | no | The instance description |
| ResourceGroupId | string | no | The ID of the resource group to which the instance belongs |
| OfficeAddress | string | no | The enterprise address |
| ContactMail | string | no | The contact email address |
| CountryId | string | no | The country code |
| FacebookBmId | string | no | FacebookBmId |
| IsvTerms | string | no | The name of the ISV/client agreement file |
| IsConfirmAudit | string | no | Specifies whether the audit is confirmed |

### Creates a budget
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/create-message-campaign` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| CustSpaceId | string | yes | The space ID of an Independent Software Vendor (ISV) sub-customer or the instance ID of a direct customer |
| PageId | string | yes | The Messenger Page ID |
| AdAccountId | string | yes | The Meta ad account ID |
| BudgetType | string | yes | The budget type |
| Budget | integer | yes | The budget, in cents |
| Name | string | yes | The budget name |

### Authorizes an embedded messenger
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/create-messenger-page` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| PageId | string | yes | The PageId of the messenger |
| AuthenticationCode | string | yes | The authorization code obtained after the embedded authorization is completed |
| AdAccountIds | string | yes | The IDs of the authorized ad accounts (JSON-encoded) |
| CustSpaceId | string | yes | The SpaceId of the ISV sub-customer or the instance ID of the direct customer |
| BusinessId | string | yes | The Business platform ID |

### Creates a message QR code
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/create-phone-message-qrdl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| PhoneNumber | string | yes | The phone number. You can view it on the Channel Management (https://chatapp.console.aliyun.com/ChannelsManagement) Channel Management… |
| GenerateQrImage | string | yes | The type of image to generate. Valid values: PNG SVG |
| PrefilledMessage | string | yes | The message content |
| CustSpaceId | string | no | The space ID of the ISV sub-customer or the instance ID of the direct customer. You can view the Space ID on the Channel Management… |

### Retrieves and stores the pageId based on the embedded code
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/create-whatsapp-conversion-api` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| InstanceId | string | no | The instance ID |
| Code | string | no | The embedded code |
| Permissions | string | no | The list of embedded permissions (JSON-encoded) |

### Deletes a flow
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/delete-chat-flow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| FlowCode | string | no | The flow code. You can view the flow code in the flow editor (https://chatapp.console.aliyun.com/ChatFlowBuilder) |
| BizCode | string | no | The business tenant code. Default value: ALICOM_OPAAS |
| BizExtend | string | no | The business extension information. Default value: an empty collection (JSON-encoded) |

### Deletes a successfully created IM group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/delete-chat-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| BusinessNumber | string | yes | The business phone number |
| ChannelType | string | no | The channel type. Valid values: WHATSAPP Only the WhatsApp channel type is supported |
| GroupId | string | yes | The group ID |
| CustSpaceId | string | yes | The space ID or instance ID of the ISV sub-customer, which is the channel ID. You can view it on the Channel Management… |

### Deletes an IM group invitation link
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/delete-chat-group-invite-link` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| BusinessNumber | string | yes | The business phone number. You can view the business phone number by calling the https://help.aliyun.com/document_detail/2932629.html… |
| ChannelType | string | no | The channel type. Valid values: WHATSAPP Only WhatsApp channel type messages are supported |
| GroupId | string | yes | The group ID. You can view the group ID by calling the https://help.aliyun.com/document_detail/2932629.html operation |
| CustSpaceId | string | yes | The SpaceId or instance ID of the ISV sub-customer. This is the channel ID, which can be viewed on the Channel Management… |

### Removes members from an IM group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/delete-chat-group-participants` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| BusinessNumber | string | yes | The business number. You can obtain the business number by calling the https://help.aliyun.com/document_detail/2932629.html operation |
| ChannelType | string | no | The channel type. Valid value: WHATSAPP Currently, only the WhatsApp channel is supported |
| GroupId | string | yes | The group ID. You can obtain the group ID by calling the https://help.aliyun.com/document_detail/2932629.html operation |
| CustSpaceId | string | yes | The space ID of the ISV sub-customer or the instance ID. This ID is also the channel ID. You can find the channel ID on the Channel… |
| List | string | no | A list of group members to remove (JSON-encoded) |

### Deletes a message template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/delete-chatapp-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| TemplateCode | string | no | The code of the template |
| CustWabaId | string | no | The WhatsApp Business Account (WABA) ID of the Independent Software Vendor (ISV) customer. This parameter is deprecated. Use CustSpaceId… |
| IsvCode | string | no | The ISV verification code, which is used to verify whether the user is authorized by the ISV |
| CustSpaceId | string | no | The Space ID of the ISV sub-customer or the instance ID of the direct customer |
| TemplateName | string | no | The name of the template |
| Language | string | no | The language |
| TemplateType | string | no | The type of the template. This parameter is required when you delete a template for a specific language |

### Deletes a contact from the contact list
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/delete-contacts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| FilePath | string | no | The file path |
| ContactDetails | string | no | The contact details |
| ContactName | string | no | The contact name |
| Country | string | no | The country |
| BizCode | string | no | The business code |
| BizExtend | string | no | The business extension information. Default value: an empty collection (JSON-encoded) |

### Deletes contacts by selecting and removing them
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/delete-contacts-by-ids` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| Contacts | string | yes | The list of contact codes, separated by commas (,) |

### Deletes a Flow (only Flows in DRAFT status can be deleted)
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/delete-flow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| FlowId | string | yes | The workflow ID |
| CustSpaceId | string | no | The SpaceId of the ISV sub-customer |

### Deletes a flow version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/delete-flow-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| FlowCode | string | no | The flow code. You can view the flow code in the flow editor (https://chatapp.console.aliyun.com/ChatFlowBuilder) |
| FlowVersion | string | no | The flow version. Click a flow name in the flow editor (https://chatapp.console.aliyun.com/ChatFlowBuilder) to go to the canvas page and… |
| BizCode | string | no | The business tenant code. Default value: ALICOM_OPAAS |
| BizExtend | string | no | The business extension information. Default value: an empty collection (JSON-encoded) |

### Deletes a group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/delete-group-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| GroupId | string | yes | The group ID |

### Deletes a page from an Instagram instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/delete-instagram-page` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| PageId | string | yes | The PageId of the Messenger page |
| InstanceId | string | yes | The instance ID |

### Deletes the specified instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/delete-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The ID of the instance |

### Deletes a marketing campaign
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/delete-marketing-flow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| ActivityCode | string | no | The activity code. You can use the system-generated code or modify it to use a custom code |
| ActivityId | string | no | The activity ID (deprecated) |

### Deletes the budget for a marketing campaign
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/delete-message-campaign` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| CustSpaceId | string | yes | The space ID of an Independent Software Vendor (ISV) sub-customer or the instance ID of a direct customer |
| PageId | string | yes | The Page ID of Messenger |
| AdAccountId | string | yes | The Meta ad account ID |
| CampaignId | string | yes | The campaign ID |

### Deletes a Messenger page
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/delete-messenger-page` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| PageId | string | yes | The PageId of the Messenger page |
| InstanceId | string | yes | The instance ID |

### Deletes a message QR code
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/delete-phone-message-qrdl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| PhoneNumber | string | yes | The phone number. You can view the phone number on the Channel Management (https://chatapp.console.aliyun.com/ChannelsManagement) Channel… |
| QrdlCode | string | yes | The QR code identifier. This is the QrdlCode returned by the https://help.aliyun.com/document_detail/2638749.html operation when you… |
| CustSpaceId | string | no | The space ID of the ISV sub-customer or the instance ID of the direct customer. You can view the Space ID on the Channel Management… |

### Deletes the WhatsApp user name for a business phone number
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/delete-whatsapp-user-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| PhoneNumber | string | yes | The business phone number |
| CustSpaceId | string | yes | The space ID of the ISV sub-customer or the instance ID of the direct customer. You can view the Space ID on the Channel Management… |

### Deprecates a Flow
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/deprecate-flow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| FlowId | string | yes | The Flow ID |
| CustSpaceId | string | no | The space ID of the ISV sub-customer |

### Enables WhatsApp-related metric collection
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/enable-whatsapp-roimetric` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| IsvCode | string | no | The ISV verification code, which is used to verify that the RAM user is authorized by the ISV |
| CustSpaceId | string | no | The space ID or instance ID of the ISV sub-customer. This is the channel ID, which can be viewed on the Channel Management… |

### Binds a phone number or merchant account ID to a flow
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/flow-bind-phone` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| FlowCode | string | yes | The flow code. View the flow code in the Flow Builder (https://chatapp.console.aliyun.com/ChatFlowBuilder) page |
| ChannelCode | string | no | The message channel code, which is the channel ID. View the channel ID in the Channel Management… |
| ChannelType | string | yes | The message channel type. Valid values: INSTAGRAM WHATSAPP MESSENGER - VIBER |
| PhoneNumbers | string | no | The list of phone numbers, PageIds, or AccountIds , or ServiceIds under the channel instance (JSON-encoded) |
| WabaId | string | no | The WABA account ID, PageId, or AccountId , or ServiceId . If the ChannelType parameter is set to WHATSAPP, specify the WABA account ID.… |
| FlowVersion | string | no | The flow version. Click the flow name in the Flow Builder (https://chatapp.console.aliyun.com/ChatFlowBuilder) page to enter the flow… |
| MultiWabaPhoneNumbers | string | no | The multi-WABA binding configuration (JSON-encoded) |

### Rebinds a phone number or merchant account ID to a flow
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/flow-rebind-phone` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| FlowCode | string | yes | The flow code. You can view this in the Flow Builder (https://chatapp.console.aliyun.com/ChatFlowBuilder) console |
| ChannelCode | string | no | The message channel code, which is the channel ID. You can view the channel ID in the Channel Management… |
| ChannelType | string | yes | The message channel type. Valid values: INSTAGRAM WHATSAPP MESSENGER - VIBER |
| PhoneNumbers | string | no | The list of phone numbers, PageIds, or AccountIds , or ServiceIds under the channel instance (JSON-encoded) |
| WabaId | string | no | The WABA account ID, PageId, or AccountId , or ServiceId . If ChannelType is set to WHATSAPP, specify the WABA account ID. You can view… |
| FlowVersion | string | no | The flow version. In the Flow Builder (https://chatapp.console.aliyun.com/ChatFlowBuilder) console, click the flow name to open the flow… |
| MultiWabaPhoneNumbers | string | no | The multi-WABA binding configurations (JSON-encoded) |

### Unbinds a phone number or merchant account ID from a flow
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/flow-unbind-phone` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| FlowCode | string | yes | The flow code. View the flow code in the flow orchestration (https://chatapp.console.aliyun.com/ChatFlowBuilder) editor |
| PhoneNumbers | string | no | The list of phone numbers, PageIds, or AccountIds , or ServiceIds under the channel instance (JSON-encoded) |
| FlowVersion | string | no | The flow version. Click the flow name in the flow orchestration (https://chatapp.console.aliyun.com/ChatFlowBuilder) editor to go to the… |
| ChannelType | string | no | The message channel type. Valid values: INSTAGRAM WHATSAPP MESSENGER - VIBER |

### Retrieves a temporary URL
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/generate-presigned-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| FilePath | string | yes | The OSS path |

### Queries pending review orders for an individual by type
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/get-audit-request-by-type-un-audit` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| RequestType | string | yes | The request type |
| CustSpaceId | string | yes | The space ID of the ISV sub-customer or the instance ID of the direct customer. You can view the Space ID on the China Channel Management… |

### Retrieves auto-generated templates
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/get-auto-generated-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| MaxResults | integer | no | The number of entries per page |
| NextToken | string | no | The pagination token that is used in the next request to retrieve a new page of results |
| CustSpaceId | string | yes | The Space ID of an ISV sub-customer or the instance ID of a direct customer |

### Retrieves ChatFlow runtime data
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/get-chat-flow-metric` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| BizCode | string | no | The business tenant code. Default value: ALICOM_OPAAS |
| BizExtend | string | no | The business extension information. Default value: an empty collection (JSON-encoded) |
| From | integer | no | The start time. This value is a UNIX timestamp. Unit: seconds |
| To | integer | no | The end time. This value is a UNIX timestamp. Unit: seconds |
| FlowCode | string | no | The flow code. You can view the flow code on the Flow Editor (https://chatapp.console.aliyun.com/ChatFlowBuilder) page |
| FlowVersion | string | no | The flow version. On the Flow Editor (https://chatapp.console.aliyun.com/ChatFlowBuilder) page, click the flow name to enter the flow… |
| MetricName | string | yes | The metric name. Valid values: nodeUsageStatistics: node usage statistics. nodeErrorDetails: node error details |
| MetricParam | string | no | The extended parameter for the metric query. When MetricName is set to nodeErrorDetails, pass in a JSON string. Valid JSON fields: pageNo:… |

### Queries the details of a flow template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/get-chat-flow-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| Id | integer | no | The template ID. You can obtain the template ID by calling the https://help.aliyun.com/document_detail/2937208.html operation |
| BizCode | string | yes | The business tenant code. Default value: ALICOM_OPAAS |

### Queries the activation status of ChatApp
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/get-chatapp-open-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |

### Queries the message sending volume metrics for a WhatsApp channel phone number
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/get-chatapp-phone-number-metric` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| IsvCode | string | no | The ISV verification code, which is used to verify whether the RAM user is authorized by the ISV |
| CustSpaceId | string | no | The SpaceId or instance ID of the ISV sub-customer. This is the channel ID, which can be viewed on the Channels Management… |
| Granularity | string | no | The metric granularity. Valid values: DAILY: collects metrics on a daily basis. HALF_HOUR: collects metrics every half hour |
| Start | integer | yes | The query start time. This value is a timestamp in milliseconds |
| End | integer | yes | The query end time. This value is a timestamp in milliseconds |
| PhoneNumber | string | no | The business phone number. This is the number used to send messages, which can be viewed on the Channels Management… |

### Retrieves other controls for a ChatApp phone number
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/get-chatapp-phone-number-setting` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| CustSpaceId | string | no | The space ID of the ISV sub-customer or the instance ID of the direct customer |
| PhoneNumber | string | yes | The phone number |

### Retrieves the details of a Chat App Message Service message template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/get-chatapp-template-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| TemplateCode | string | no | The template code |
| Language | string | yes | The template language. For language codes, see https://help.aliyun.com/document_detail/463420.html |
| CustWabaId | string | no | The ISV customer WABA ID. This parameter is deprecated. Use CustSpaceId instead |
| IsvCode | string | no | The ISV verification code used to verify whether a sub-account is authorized by the ISV |
| CustSpaceId | string | no | The space ID of the ISV sub-customer or the instance ID of the direct customer |
| TemplateType | string | no | The templatetype. Valid values: WHATSAPP VIBER |
| TemplateName | string | no | The template name |

### Retrieves metrics related to marketing-type templates
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/get-chatapp-template-metric` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| TemplateCode | string | yes | The template code. You can view the template code on the Channel Management (https://chatapp.console.aliyun.com/ChannelsManagement)… |
| Language | string | no | The template language. For more languages, see https://help.aliyun.com/document_detail/463420.html |
| IsvCode | string | no | The ISV verification code, which is used to verify whether the RAM user is authorized by the ISV |
| CustSpaceId | string | no | The space ID or instance ID of the ISV sub-customer, which is also the channel ID. You can view it on the Channel Management… |
| TemplateType | string | no | The templatetype. Valid values: WHATSAPP If this parameter is not specified, the default value is WHATSAPP |
| Granularity | string | no | The metric granularity. Valid values: DAILY: collects metrics on a daily basis. HALF_HOUR: collects metrics every half hour |
| Start | integer | yes | The start time of the query. This value is a timestamp in milliseconds |
| End | integer | yes | The end time of the query. This value is a timestamp in milliseconds |

### Obtains the authentication information that is used to upload a file
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/get-chatapp-upload-authorization` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| CustSpaceId | string | yes | The space ID of ISV sub-customer |

### Requests a verification code to be sent to the specified phone number
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/get-chatapp-verify-code` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| PhoneNumber | string | yes | The phone number |
| CustSpaceId | string | yes | The Space ID of the Independent Software Vendor (ISV) sub-customer |
| Method | string | yes | The method to receive the verification code |
| Locale | string | yes | The language. For values, see https://help.aliyun.com/document_detail/463420.html |

### Queries the business settings of a phone number
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/get-commerce-setting` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| CustSpaceId | string | yes | The space ID of the user within the independent software vendor (ISV) account |
| PhoneNumber | string | yes | The phone number |

### Queries the conversational automation settings for a phone number
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/get-conversational-automation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| CustSpaceId | string | yes | The space ID of the ISV sub-customer or the instance ID |
| PhoneNumber | string | yes | The phone number of the enterprise |

### Queries the source site of a customer
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/get-customer-site` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |

### Downloads Excel data
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/get-download-excel-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| Condition | string | no | The query condition |
| BizCode | string | no | The business tenant code. Default value: ALICOM_OPAAS |
| GroupId | string | no | The group ID |
| StartDate | string | no | The start date. Format: YYYY-MM-DD |
| EndDate | string | no | The end date. Format: YYYY-MM-DD |
| GroupIds | string | no | The contact group ID (JSON-encoded) |
| CountryNames | string | no | The country name (JSON-encoded) |
| BizExtend | string | no | The business extension information. Default value: "{}" (JSON-encoded) |

### Retrieves the list of Instagram pages for an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/get-fb-instagram-pages` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| AccessToken | string | yes | The personal access token. This field is not required if you use Alibaba Cloud AccessKey pair (AK+SK) or STS temporary authorization |
| InstanceId | string | yes | The instance ID. The unique identifier of the instance |

### Retrieves the list of Facebook page IDs
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/get-fb-messenger-pages` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| AccessToken | string | yes | The token of the Meta public page |
| InstanceId | string | yes | The instance ID |

### Retrieves the details of a Flow
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/get-flow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| FlowId | string | yes | The flow ID, which is the FlowId returned by the https://help.aliyun.com/document_detail/2638742.html operation when you create a WhatsApp… |
| CustSpaceId | string | no | The space ID of the ISV sub-customer or the instance ID of the direct customer. You can view the Space ID on the Channel Management… |

### Retrieves the JSON-formatted content of a Flow
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/get-flow-jsonassest` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| FlowId | string | no | The Flow ID returned when you created the Flow by calling the https://help.aliyun.com/document_detail/2638742.html operation |
| CustSpaceId | string | no | The Space ID of the ISV sub-customer or the instance ID of the direct customer. You can view the Space ID on the Channel Management… |

### Retrieves the preview URL of a Flow
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/get-flow-preview-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| FlowId | string | yes | The Flow ID returned by the https://help.aliyun.com/document_detail/2638742.html operation when the WhatsApp Flow was created |
| CustSpaceId | string | no | The Space ID of the ISV sub-customer or the instance ID of the direct customer. You can view the Space ID on the Channel Management… |

### Queries whether a group name already exists
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/get-group-exist` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| GroupName | string | yes | The group name |
| BizCode | string | no | The business tenant code. Default value: ALICOM_OPAAS |
| BizExtend | string | no | The business extension information. Default value: "{}" (JSON-encoded) |

### Queries budget metrics
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/get-message-campaign-insights` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| CustSpaceId | string | yes | The space ID or instance ID of the ISV sub-customer. This is the channel ID, which can be viewed on the Channel Management… |
| PageId | string | yes | The page number to query |
| AdAccountId | string | yes | The Meta ad account ID |
| CampaignId | string | yes | The budget ID |

### Retrieves the verification code for a migration phone number
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/get-migration-verify-code` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| CustSpaceId | string | yes | The space ID of the ISV sub-customer |
| PhoneNumber | string | yes | The phone number |
| Locale | string | yes | The language |
| Method | string | yes | The verification code delivery method |

### Obtains authorization permissions by using the code obtained from the embedded integration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/get-permission-by-code` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| Code | string | yes | The authorization code |
| CustSpaceId | string | no | The space ID of the ISV sub-customer |
| Permissions | string | no | The permissions (JSON-encoded) |

### Retrieves the encryption public key of a phone number
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/get-phone-encryption-public-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| PhoneNumber | string | yes | The phone number. You can view it on the Channel Management (https://chatapp.console.aliyun.com/ChannelsManagement) Channel Management… |
| CustSpaceId | string | no | The space ID of the ISV sub-customer or the instance ID of the direct customer. You can view the Space ID on the Channel Management… |

### Retrieves the verification status of a phone number
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/get-phone-number-verification-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| PhoneNumber | string | yes | The phone number. You can view it in the Channel Management (https://chatapp.console.aliyun.com/ChannelsManagement) Channel Management… |
| CustSpaceId | string | yes | The space ID of the ISV sub-customer or the instance ID of the direct customer. You can view the Space ID in the Channel Management… |

### Retrieves the download URL for the letter of guarantee template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/get-pledge-template-address` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| IndustryType | string | no | The industry type |
| CustSpaceId | string | no | The space ID or instance ID of the ISV sub-customer. This is the channel ID, which can be viewed on the Channel Management… |

### Gets the ID for a pre-validated phone number. Use this ID to select the number in the Embedded Signup flow…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/get-pre-validate-phone-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| PhoneNumber | string | yes | The phone number |
| VerifyCode | string | yes | The verification code provided when you purchased the pre-validated phone number |

### Queries an application form by request number
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/get-viber-by-request-no` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| RequestNo | string | yes | The request number of the application form |
| CustSpaceId | string | no | The space ID of an ISV sub-customer or the instance ID of a direct customer |

### Queries the number of times that a pause can be requested
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/get-viber-pause-times` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| CustSpaceId | string | yes | The space ID of the ISV sub-customer or the instance ID of the direct customer |

### Queries the product catalogs that are associated with a WhatsApp Business account (WABA)
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/get-whatsapp-connection-catalog` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| WabaId | string | yes | The WABA ID |
| CustSpaceId | string | no | The space ID of the user within the ISV account |

### Retrieves the embedded authorization page
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/get-whatsapp-conversion-api` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| InstanceId | string | no | The instance ID |

### Queries the messaging health status of different types of nodes
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/get-whatsapp-health-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| NodeType | string | yes | The node type. Valid values: template: message template phone: phone number waba: WhatsApp Business Account (WABA) |
| PhoneNumber | string | no | The phone number of the enterprise |
| TemplateCode | string | no | The template code |
| Language | string | no | The template language |
| WabaId | string | no | WabaId |
| CustSpaceId | string | yes | The space ID of the RAM user within the independent software vendor (ISV) account or the instance ID of the customer of Alibaba Cloud |

### Retrieves the WhatsApp username for a business phone number
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/get-whatsapp-user-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| CustSpaceId | string | yes | The space ID of the ISV sub-customer or the instance ID of the direct customer. You can view the Space ID on the Channel Management… |
| PhoneNumber | string | yes | The business phone number |

### Retrieves the suggested user name for a WhatsApp business phone number
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/get-whatsapp-user-name-suggestions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| CustSpaceId | string | yes | The space ID of the ISV sub-customer or the instance ID of the direct customer. You can view the Space ID on the Channel Management… |
| PhoneNumber | string | yes | The business phone number |

### Retrieves the App ID for an ISV
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/isv-get-app-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| Type | string | yes | The channel type. Valid values: whatsapp: WhatsApp |
| IntlVersion | string | no | The version |
| Permissions | string | no | The permissions |

### Queries the list of groups
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/list-all-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| BizCode | string | no | The business tenant code. Default value: ALICOM_OPAAS |
| BizExtend | string | no | The business extension information. Default value: an empty collection (JSON-encoded) |

### Queries the bound DM account
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/list-bind-dm-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| CustSpaceId | string | yes | The SpaceId of the ISV sub-customer or the instance ID of the direct customer |

### Queries the list of phone numbers or business account IDs bound to a flow based on the flow code
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/list-binding-relations-for-flow-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| FlowCode | string | yes | The flow code. View the flow code in the Flow Builder (https://chatapp.console.aliyun.com/ChatFlowBuilder) console |
| ChannelType | string | yes | The channel type. Valid values: INSTAGRAM WHATSAPP MESSENGER - VIBER |

### Lists flows
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/list-chat-flow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| Status | string | no | The flow status. Default value: NORMAL |
| PageNo | integer | no | The page number |
| PageSize | integer | no | The number of entries per page |
| FlowTriggerType | string | no | The flow trigger type. Valid values: TriggeredManually TriggeredByWhatsApp TriggeredByInstagram TriggeredByViber TriggeredByMessenger |
| ReturnWithOnlineVersion | string | no | Specifies whether to return the online status. Valid values: true: Yes. false: No |
| Keyword | string | no | The search keyword. This parameter is used for fuzzy match of flow names |
| BizCode | string | no | The business tenant code. Default value: ALICOM_OPAAS |
| BizExtend | string | no | The business extension information. Default value: an empty collection (JSON-encoded) |
| FlowCode | string | no | flowCode |
| Title | string | no | The title |
| FlowStatus | string | no | The flow status |
| PhoneNumber | string | no | The phone number |

### Lists flow templates
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/list-chat-flow-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| TriggerType | string | no | The flow trigger type. Valid values: TriggeredManually TriggeredByWhatsApp TriggeredByInstagram TriggeredByViber TriggeredByMessenger |
| Keyword | string | no | The search keyword. Used for fuzzy match of template names |
| PageNo | integer | no | The page number |
| PageSize | integer | no | The number of records per page |
| BizCode | string | yes | The business tenant code. Default value: ALICOM_OPAAS |

### Retrieves the list of IM groups
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/list-chat-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| BusinessNumber | string | yes | The business phone number |
| ChannelType | string | no | The channel type. Valid values: WHATSAPP. Only the WhatsApp channel type is supported |
| CustSpaceId | string | yes | The SpaceId or instance ID of the ISV sub-customer. This is the channel ID, which can be viewed on the Channel Management… |
| GroupStatus | string | no | The group status. Valid values: ACTIVE: In use. INACTIVE: Not activated. SUSPENDED: Suspended. CREATING: Being created. DELETING: Being… |
| Subject | string | no | The group subject |
| GroupType | string | no | The Telegram group type |
| GroupLink | string | no | The Telegram group link |
| Page | string | yes | The pagination information (JSON-encoded) |

### Retrieves the member list of an IM group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/list-chat-group-participants` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| BusinessNumber | string | yes | The business phone number. You can view the business phone number by calling the https://help.aliyun.com/document_detail/2932629.html… |
| ChannelType | string | no | The channel type. Valid values: WHATSAPP Only the WhatsApp channel type is supported |
| GroupId | string | yes | The group ID. You can view the group ID by calling the https://help.aliyun.com/document_detail/2932629.html operation |
| CustSpaceId | string | yes | The space ID of the ISV sub-customer, which is also the instance ID. This is the channel ID, which can be viewed on the Channel Management… |
| Page | string | no | The pagination information (JSON-encoded) |

### Queries the message list
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/list-chatapp-message` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| BusinessNumber | string | yes | The business phone number. For WhatsApp channels, view the business phone number in the Channel Management… |
| StartTimeStr | string | no | The start time in the format of YYYY-MM-DD HH:mm:ss |
| EndTimeStr | string | no | The end time in the format of YYYY-MM-DD HH:mm:ss |
| StartTime | integer | no | The start time. This value is a UNIX timestamp. Unit: milliseconds |
| EndTime | integer | no | The end time. This value is a UNIX timestamp. Unit: milliseconds |
| EventAction | string | no | The message type. Valid values: DOWN: downstream message. UP: upstream message |
| UserNumber | string | no | The user phone number. This is the user phone number that you imported when sending messages in the Channel Management… |
| ChannelType | string | yes | The channel type. Valid values: whatsapp. viber |
| ClientAcceptStatus | string | no | The message acceptance status of the user |
| TemplateCode | string | no | The template code. View the template code in the Channel Management (https://chatapp.console.aliyun.com/CustomerList) > Management >… |
| GroupMessageId | string | no | The batch message ID. View the batch message ID in the Channel Management (https://chatapp.console.alibabacloud.com/CustomerList) >… |
| MessageStatus | string | no | The message status |
| CustSpaceId | string | yes | The space ID of the ISV sub-customer or the instance ID of the direct customer. View the Space ID in the Channel Management… |
| Page | string | yes | The pagination object (JSON-encoded) |

### Retrieves a list of message templates
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/list-chatapp-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| Name | string | no | The template name |
| Language | string | no | The template language. For language codes, see https://help.aliyun.com/document_detail/463420.html |
| AuditStatus | string | no | The audit status. Valid values: pass: Approved. fail: Rejected. auditing: Under review. unaudit: Review suspended |
| Page | string | no | The pagination settings (JSON-encoded) |
| CustWabaId | string | no | The WabaId of the ISV customer. This parameter is deprecated. Use CustSpaceId instead |
| CustSpaceId | string | no | The SpaceId of the ISV sub-customer or the instance ID of the direct customer |
| TemplateType | string | no | The templatetype. Valid values: WHATSAPP VIBER |
| Code | string | no | The template code |
| Category | string | no | The template category |
| IsvCode | string | no | The ISV verification code, used to verify whether a sub-account is authorized by the ISV |

### Queries a custom audience list
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/list-custom-audience` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| CustSpaceId | string | yes | The space ID or instance ID of the ISV sub-customer. This is the channel ID. You can view it on the Channel Management… |
| PageId | string | yes | The page ID of Messenger |
| AdAccountId | string | no | The Meta ad account ID |
| TokenType | string | no | The token type |
| CustomAudienceName | string | no | The custom audience name |
| Page | string | yes | The pagination information (JSON-encoded) |
| CustomAudienceId | string | no | The custom audience ID |

### Queries the DirectMail accounts under your account
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/list-dm-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| PageIndex | integer | no | The page number |
| PageSize | integer | no | The number of entries per page |
| SendType | string | no | The sending type |
| Keyword | string | no | The search keyword |

### Queries the tags of DirectMail
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/list-dm-tag` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| PageSize | integer | no | The number of entries to return on each page |
| PageIndex | integer | no | The page number |
| Keyword | string | no | The search keyword |

### Queries the list of Facebook posts
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/list-facebook-posts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| CustSpaceId | string | yes | The space ID of the ISV sub-customer |

### Queries the list of Flows
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/list-flow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| FlowName | string | no | The Flow name |
| Page | string | no | The pagination information (JSON-encoded) |
| CustSpaceId | string | no | The SpaceId of the ISV sub-customer |

### Lists flow component groups
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/list-flow-node-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| PageSize | integer | yes | The number of records per page |
| PageNo | integer | yes | The page number |

### Lists flow component prototypes
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/list-flow-node-prototype-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| PageNo | integer | yes | The current page number |
| PageSize | integer | yes | The number of entries per page |
| GroupCode | string | no | The component group code. Valid values: Messaging: messaging components. Core: core components. Intelligence: intelligent components.… |
| BizCode | string | yes | The business tenant code. Default value: ALICOM_OPAAS |
| Keyword | string | no | The search keyword. This parameter is used for fuzzy match based on the flow component name |

### Lists flow versions
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/list-flow-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| FlowCode | string | no | The flow code. You can query the flow code on the flow editor (https://chatapp.console.aliyun.com/ChatFlowBuilder) page |
| PageNo | integer | no | The current page number |
| PageSize | integer | no | The number of records per page |
| Status | string | no | The flow version status. Valid values: DRAFT: draft. DELETED: deleted. ONLINE: online. OFFLINE: offline |
| BizCode | string | no | The business tenant code. Default value: ALICOM_OPAAS |
| BizExtend | string | no | The business extension information. Default value: an empty collection (JSON-encoded) |

### Retrieves the Instagram pages associated with an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/list-instagram-page` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| InstanceId | string | yes | The instance ID. Only non-Alibaba Cloud hosts are supported |

### Queries the list of Instagram posts
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/list-instagram-posts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| CustSpaceId | string | yes | The space ID or instance ID of the ISV sub-customer. This is the channel ID, which you can view on the channel management… |

### Queries a list of instances
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/list-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| ChannelType | string | no | The channel type. Valid values: whatsapp messenger instagram - viber |
| InstanceName | string | no | The instance name |
| SubmitTime | string | no | The submit time in the YYYY-MM-DD HH:mm:ss format |
| PageSize | integer | no | The number of records per page |
| PageIndex | integer | no | The page number |
| ResourceGroupId | string | no | The ID of the enterprise resource group to which the instance belongs |
| InstanceId | string | no | The instance ID. Only non-Alibaba Cloud hosts are supported |
| FilterStr | string | no | The filter condition |
| IsBind | string | no | Indicates whether the instance is bound |
| BindId | string | no | The binding ID |

### Queries a list of campaigns
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/list-marketing-flow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| ActivityStatus | string | no | The campaign status |
| RelatedGroupId | integer | no | The ID of the associated group |
| RelatedFlowCode | string | no | The ID of the associated flow |
| ActivityName | string | no | The name of the node task instance |
| ActivityCode | string | no | The campaign code. You can use the system-generated code or modify it to use a custom code |
| PageIndex | string | no | The current page number |
| PageSize | string | no | The number of entries per page |
| BizCode | string | no | The business tenant code. Default value: ALICOM_OPAAS |
| BizExtend | string | no | The business extension information. Default value: "{}" (JSON-encoded) |

### Retrieves a list of budgets
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/list-message-campaign` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| CustSpaceId | string | yes | The Space ID of the ISV sub-customer or the instance ID of the direct customer. You can view this ID on the Channel Management… |
| PageId | string | yes | The Page ID for Messenger |
| AdAccountId | string | no | The ID of the Meta ad account |
| Status | string | no | The status of the budget |
| CampaignName | string | no | The name of the campaign |
| Page | string | yes | The pagination parameters (JSON-encoded) |
| CampaignId | string | no | The ID of the budget |

### Queries custom audiences and subscription tokens
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/list-messenger-subscription-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| CustSpaceId | string | yes | The space ID of the ISV sub-customer or the instance ID. View the ID on the Channel Management… |
| PageId | string | yes | The page ID for Messenger |
| TokenType | string | yes | The token type |
| CustomAudienceId | string | no | The custom audience ID |
| PageKey | string | no | The pagination key |
| Limit | integer | no | The number of entries to return. Valid values: 1 to 1000 |

### Queries the list of ad accounts bound to a page
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/list-page-ad-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| CustSpaceId | string | yes | The space ID of the ISV sub-customer or the instance ID of the direct customer |
| PageId | string | yes | The PageId of Messenger |

### Queries the list of message QR codes
`POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/list-phone-message-qrdl` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://cams.ap-southeast-1.aliyuncs.com |
| PhoneNumber | string | yes | The phone number |
| CustSpaceId | string | no | The space ID of the ISV sub-customer or the instance ID of the direct customer |

…and 54 more. See the OpenAPI spec.

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-cams/add-address-recover-suspend" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud ChatApp Message Service API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-cams/add-address-recover-suspend with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud ChatApp Message Service API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud ChatApp Message Service itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud ChatApp Message Service API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-cams.

### What is the status of the Alibaba Cloud ChatApp Message Service API?
Needs your own provider key (bring your own key)