GetPhoneEncryptionPublicKey-阿里云帮助中心

Retrieves the public key for a phone number.

Operation description

Before calling this API, make sure that you have added a verified phone number to your WhatsApp Business Account (WABA).
If no phone number is added to your WABA, call the GetChatappVerifyCode and ChatappVerifyAndRegister APIs to get a verification code to register and verify the phone number.

QPS limit

This API is limited to 5 queries per second (QPS) for each user. If you exceed this limit, API calls are throttled, which can affect your business. Call this API within the specified limit.

Try it now

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PhoneNumber	string	Yes	The phone number. You can view the phone numbers on the Channel Management > Manage > WABA Management > Phone Number Management page.	86189********
CustSpaceId	string	No	The Space ID of an Independent Software Vendor (ISV) sub-customer or the instance ID of a direct customer. You can view the Space ID on the Channel Management page.	cams-kei****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	DAC72B08-3327-33EF-BEDC-8EC3E83A6575
Code	string	The error code. For more information, see Error codes.	OK
Message	string	The error message.	None
Data	object	The returned data.
PhoneNumber	string	The phone number.	861526377****
EncryptionPublicKey	string	The public key.	-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAt+PMrYw4zUDEk+VeTrp0\n8LZaoVpiVFErX7iuoDjUs4F9vkxMQuIABjcXw\/swzTMEopLORQV28uqN\/2\/x9hjU\****\/Zwa\/Vk5Svp4\niVY4e22FsJCCWUEMvayO8Q+3UGq0eXXQ+8SlUWEMq1VaJ4pwCLsMnmgybA+VmJxi\nkwIDAQAB\n-----END PUBLIC KEY-----"
EncryptionPublicKeyStatus	string	The status of the public key. Valid values: MISMATCH: The public key is invalid. VALID: The public key is valid.	VALID

Examples

Success response

JSON format

{
  "RequestId": "DAC72B08-3327-33EF-BEDC-8EC3E83A6575",
  "Code": "OK",
  "Message": "None",
  "Data": {
    "PhoneNumber": "861526377****",
    "EncryptionPublicKey": "-----BEGIN PUBLIC KEY-----\\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAt+PMrYw4zUDEk+VeTrp0\\n8LZaoVpiVFErX7iuoDjUs4F9vkxMQuIABjcXw\\/swzTMEopLORQV28uqN\\/2\\/x9hjU\\****\\/Zwa\\/Vk5Svp4\\niVY4e22FsJCCWUEMvayO8Q+3UGq0eXXQ+8SlUWEMq1VaJ4pwCLsMnmgybA+VmJxi\\nkwIDAQAB\\n-----END PUBLIC KEY-----\"",
    "EncryptionPublicKeyStatus": "VALID"
  }
}

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 for a complete list.

Release notes

See 变更详情 for a complete list.