GetWhatsappConversionApi - Chat App Message Service - Alibaba Cloud ドキュメントセンター

Retrieves the embedded authorization page.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	No	The instance ID.	chatbot-cn-VBe6QXXX

Response elements

Element	Type	Description	Example
	object
AccessDeniedDetail	string	The details about the access denial.	{}
Message	string	The returned message.	success
RequestId	string	The request ID. Alibaba Cloud generates a unique identifier for each API request. You can use this ID to troubleshoot issues.	90E63D28-E31D-1EB2-8939-A9486641****
Data	array<object>	The returned data.
	object	The returned data.
PageId	string	The PageId of Messenger.	7832312
PageName	string	The page name.	aaa
DatasetId	string	The dataset ID.	111
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 operation was successful. Valid values: true: Successful. false: Failed.	false

Examples

Success response

JSON format

{
  "AccessDeniedDetail": "{}",
  "Message": "success",
  "RequestId": "90E63D28-E31D-1EB2-8939-A9486641****",
  "Data": [
    {
      "PageId": "7832312",
      "PageName": "aaa",
      "DatasetId": "111"
    }
  ],
  "Code": "OK",
  "Success": false
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.