All Products
Search
Document Center

Chat App Message Service:GetWhatsappUserNameSuggestions

Last Updated:Jul 14, 2026

Retrieves the suggested user name for a WhatsApp business phone number.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

CustSpaceId

string

Yes

The space ID of the ISV sub-customer or the instance ID of the direct customer. You can view the Space ID on the Channel Management page.

cams-dk**

PhoneNumber

string

Yes

The business phone number.

8613800**

Response elements

Element

Type

Description

Example

object

AccessDeniedDetail

string

The details about the access denial.

None

Message

string

The error message.

None

RequestId

string

The request ID. It is a unique identifier generated by Alibaba Cloud for the request and can be used to troubleshoot issues.

90E63D28-E31D-1EB2-8939-A94866411B2O

Data

array

The returned data.

string

The returned data.

alibaba

Code

string

The response code.

  • OK indicates that the request was successful.

  • For other error codes, see Error codes.

OK

Success

boolean

Indicates whether the call was successful. Valid values:

  • true: The call was successful.

  • false: The call failed.

false

Examples

Success response

JSON format

{
  "AccessDeniedDetail": "None",
  "Message": "None",
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2O",
  "Data": [
    "alibaba"
  ],
  "Code": "OK",
  "Success": false
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.