Chat App Message Service:QueryChatappBindWaba - Chat App Message Service - Alibaba Cloud - Chat App Message Service

Queries the WhatsApp Business Account (WABA) that is bound to a customer account.

Operation description

This API has a per-user QPS limit of 10. Calls that exceed this limit are subject to flow control, which may impact your business. Make API calls at a reasonable rate.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
CustSpaceId	string	No	The space ID of the ISV sub-customer.	293483****49493
IsvCode	string	No	The ISV verification code, used to verify that the sub-account is authorized.	aksik93kdkkxmwol9****

Response elements

Element	Type	Description	Example
	object	The response object.
AccessDeniedDetail	string	The access denial details.	None
Message	string	The error message.	SUCCESS
RequestId	string	The request ID.	90E63D28-E31D-1EB2-8939-A9486641****
Data	object	The response data.
AuthInternationalRateEligibility	object	Details about the WABA account.
MarketingMessageLiteStatus	string	The MML status.	Y
BusinessName	string	The Business platform name.	Alibaba
Currency	string	The currency.	USD
Id	string	The WABA account ID.	20393988393993***
AccountReviewStatus	string	The account review status. Valid values: `PENDING`: The account is under review. `APPROVED`: The account is approved. `REJECTED`: The account is rejected. `DISABLED`: The account is disabled.	APPROVED
MessageTemplateNamespace	string	The template namespace.	93e6b26e_8a67_4163_a093_ebfe645a66b0
BusinessId	string	The Business platform ID.	19293988***
Name	string	The WABA account name.	Alibaba
PrimaryBusinessLocation	string	The international rate capability qualification.	"start_time":1721952000
IsOnBizApp	string		N
Code	string	The request status code. A value of `OK` indicates the request was successful. For other error codes, see Error codes.	OK
Success	boolean	Indicates whether the request was successful: `true`: The request was successful. `false`: The request failed.	true

Examples

Success response

JSON format

{
  "AccessDeniedDetail": "None",
  "Message": "SUCCESS",
  "RequestId": "90E63D28-E31D-1EB2-8939-A9486641****",
  "Data": {
    "AuthInternationalRateEligibility": {
      "test": "test",
      "test2": 1
    },
    "MarketingMessageLiteStatus": "Y",
    "BusinessName": "Alibaba",
    "Currency": "USD",
    "Id": "20393988393993***",
    "AccountReviewStatus": "APPROVED",
    "MessageTemplateNamespace": "93e6b26e_8a67_4163_a093_ebfe645a66b0",
    "BusinessId": "19293988***",
    "Name": "Alibaba",
    "PrimaryBusinessLocation": "\"start_time\":1721952000",
    "IsOnBizApp": "N"
  },
  "Code": "OK",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	Product.Unsubscript	You have not subscribed to the specified product.	You have not subscribed to the specified product.
400	Ram.PermissionDeny	You are not authorized to perform the operation.
400	System.LimitControl	The system is under flow control.	The system is under flow control.
400	Unknown.ResourceOwnerId	The resource does not belong to the current user.	The resource does not belong to the current user.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.