QueryPhoneBusinessProfile - Chat App Message Service - Alibaba Cloud Documentation Center

Queries the business information of the account to which a specified phone number is bound.

Operation description

You can call this operation up to 10 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
cams:QueryPhoneBusinessProfile	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
CustSpaceId	string	Yes	The space ID of the user within the independent software vendor (ISV) account.	2934839388494***
PhoneNumber	string	Yes	The phone number.	8613800001234

Response parameters

Parameter	Type	Description	Example
	object
AccessDeniedDetail	string	The details about the access denial.	None
Message	string	The error message returned.	None
RequestId	string	The ID of the request.	90E63D28-E31D-1EB2-8939-A94866411B2O
Data	object	The returned data.
Vertical	string	The industry.	Retail
Description	string	The description.	Description
Email	string	The email address.	aa@aliyun.com
Address	string	The address.	Changsha
ProfilePictureUrl	string	The profile picture.	https://....img
Websites	array	The website.
websites	string	The website URL.	https://alibaba.com
About	string	Regarding.	business profile
Code	string	The HTTP status code returned. A value of OK indicates that the call is successful. Other values indicate that the call fails. For more information, see Error codes.	OK
Success	boolean	Indicates whether the request was successful. Valid values: true false	true

Examples

Sample success responses

JSONformat

{
  "AccessDeniedDetail": "None",
  "Message": "None",
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2O",
  "Data": {
    "Vertical": "Retail\n",
    "Description": "Description\n",
    "Email": "aa@aliyun.com",
    "Address": "Changsha\n",
    "ProfilePictureUrl": "https://....img",
    "Websites": [
      "https://alibaba.com"
    ],
    "About": "business profile"
  },
  "Code": "OK",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message
400	Product.Unsubscript	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.
400	Unknown.ResourceOwnerId	The resource does not belong to the current user.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-04-10	The Error code has changed. The response structure of the API has changed	View Change Details
2023-07-04	The Error code has changed. The response structure of the API has changed	View Change Details