FlowBindPhone - Chat App Message Service - Alibaba Cloud Documentation Center

Operation description

You can call this operation to bind a phone number or merchant account ID to a flow, or manually bind them in the Flow Builder > Settings page.
Before calling this operation, make sure that you have a successfully created flow and a successfully created message channel that corresponds to the flow type.
For the WhatsApp channel type, you must have completed WABA registration and bindng and adding a phone number.
For the Messenger channel type, you must have completed connecting a public page account.
For the Instagram channel type, you must have completed connecting a professional account.
For the Viber channel type, you must have completed applying for a service ID.

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

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
FlowCode	string	Yes	The flow code. You can view the flow code in the Flow Builder page.	9ccc41**************************
ChannelCode	string	Yes	The message channel code, which is the channel ID. You can view the channel ID in the Channel Management page.	cams-8c8*********
ChannelType	string	Yes	The message channel type. Valid values: INSTAGRAM WHATSAPP MESSENGER VIBER	WHATSAPP
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, specify the merchant phone number under the WhatsApp channel instance. You can view the merchant phone number in Channel Management > Manage > WABA Management > Number Management. If the ChannelType parameter is set to MESSENGER, specify the PageId (public page ID) under the Messenger channel instance. You can view the page ID in Channel Management > Manage > Public Pages. If the ChannelType parameter is set to INSTAGRAM, specify the AccountId (professional account ID) under the Instagram channel instance. You can view the account ID in Channel Management > Manage > Professional Accounts. If the ChannelType parameter is set to VIBER, specify the ServiceId (service ID) under the Viber channel instance. You can view the service ID in Channel Management > Manage > Service ID Management.	86188********
WabaId	string	Yes	The WABA account ID, PageId, or AccountId, or ServiceId. If the ChannelType parameter is set to WHATSAPP, specify the WABA account ID. You can view the WABA account ID in Channel Management > Manage > WABA Management. If the ChannelType parameter is not set to WHATSAPP, specify the PageId for MESSENGER, the AccountId for INSTAGRAM, or the ServiceId for VIBER.	1952************
FlowVersion	string	No	The flow version. You can view the flow version by clicking the flow name in the Flow Builder page to enter the flow builder canvas.	1

Response elements

Element	Type	Description	Example
	object
AccessDeniedDetail	string	The details about the access denial.	None
Message	string	The error message.	None
RequestId	string	The request ID.	90E63D28-E31D-1EB2-8939-A94866411B2O
Model	boolean	Indicates whether the operation is successful. Valid values: true: successful. false: failed.	false
Code	string	The status code.	OK
Success	boolean	Indicates whether the operation is successful. Valid values: true: successful. false: failed.	true

Examples

Success response

JSON format

{
  "AccessDeniedDetail": "None",
  "Message": "None",
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2O",
  "Model": false,
  "Code": "OK",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.