FlowUnbindPhone - Chat App Message Service - Alibaba Cloud Documentation Center

Operation description

Before calling this operation, make sure your flow is in the offline state. If your flow is in the online state, click the flow name in the flow orchestration editor to go to the canvas and manually take it offline, or call the OfflineFlowVersion operation to take it offline.
You can call this operation to unbind a phone number or merchant account ID from a flow, or manually unbind it in the flow orchestration > Settings page.
Before calling this operation, make sure the flow you created has a phone number or merchant account ID bound to it.
If no phone number or merchant account ID is bound, manually bind one in the flow orchestration > Settings page, or call the FlowBindPhone operation to bind one.
After unbinding a phone number or merchant account ID from a flow, the flow cannot go online. You must bind a phone number or merchant account ID again before the flow can go online.

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:FlowUnbindPhone

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
FlowCode	string	Yes	The flow code. View the flow code in the flow orchestration editor.	9ccc41**************************
PhoneNumbers	array	No	The list of phone numbers, PageIds, or AccountIds, or ServiceIds under the channel instance.
	string	No	A single phone number, PageId, or AccountId, or ServiceId. If the ChannelType parameter is set to WHATSAPP, pass the merchant phone number under the WhatsApp channel instance. View the merchant phone number in Channel Management > Manage > WABA Management > Number Management. If the ChannelType parameter is set to MESSENGER, pass the PageId (public page ID) under the Messenger channel instance. View the page ID in Channel Management > Manage > Public Pages. If the ChannelType parameter is set to INSTAGRAM, pass the AccountId (professional account ID) under the Instagram channel instance. View the account ID in Channel Management > Manage > Professional Accounts. If the ChannelType parameter is set to VIBER, pass the ServiceId (service number ID) under the Viber channel instance. View the service number ID in Channel Management > Manage > Service Number Management.	86188********
FlowVersion	string	No	The flow version. Click the flow name in the flow orchestration editor to go to the canvas and view the flow version.	1
ChannelType	string	No	The message channel type. Valid values: INSTAGRAM WHATSAPP MESSENGER VIBER	WHATSAPP

Response elements

Element	Type	Description	Example
	object
AccessDeniedDetail	string	The details of the access denial.	None
Message	string	The error message.	None
RequestId	string	The request ID.
Model	boolean	Indicates whether the operation was successful. Valid values: true: The operation was successful. false: The operation failed.	true
Code	string	The request status code.	OK
Success	boolean	Indicates whether the operation was successful. Valid values: true: The operation was successful. false: The operation failed.	true

Examples

Success response

JSON format

{
  "AccessDeniedDetail": "None",
  "Message": "None",
  "RequestId": "",
  "Model": true,
  "Code": "OK",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.