All Products
Search
Document Center

ChatApp Message Service:QueryPhoneBusinessProfile

Last Updated:Dec 07, 2023

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.

debugging

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
CustSpaceIdstringYes

The space ID of the user under the independent software vendor (ISV) account.

2934839388494***
PhoneNumberstringYes

The phone number.

8613800001234

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

90E63D28-E31D-1EB2-8939-A94866411B2O
Codestring

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
Messagestring

The error message returned.

None
Dataobject

The data returned.

Addressstring

The address.

Changsha
Descriptionstring

The description.

Description
Verticalstring

The industry.

Retail
Emailstring

The email address.

aa@aliyun.com
ProfilePictureUrlstring

The URL of the profile picture.

https://....img
Websitesarray

The websites.

string

The URL of the website.

https://alibaba.com

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError message
400Product.UnsubscriptYou have not subscribed to the specified product.
400Ram.PermissionDenyYou are not authorized to perform the operation.
400System.LimitControlThe system is under flow control.
400Unknown.ResourceOwnerIdThe resource does not belong to the current user.

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

Change history

Change timeSummary of changesOperation
2023-07-04The error codes of the API operation change.,The response structure of the API operation changes.see changesets
Change itemChange content
Error CodesThe error codes of the API operation change.
    delete Error Codes: 400
Output ParametersThe response structure of the API operation changes.