UpdateWhatsappUserName - Chat App Message Service - Alibaba Cloud Documentation Center

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-kskd****
PhoneNumber	string	Yes	The business phone number.	8613800***
Username	string	Yes	Whatsapp user name	alibaba
TransferAction	string	No	The transfer action that controls what happens when the requested username is currently used by another business phone number in the same business asset portfolio. For example, use this parameter when you want to move an existing username to another phone number. Valid values: none (default): does not transfer the account. If another business phone number in the same business asset portfolio already uses this username, the request fails with error code 147005. force_transfer: transfers the account from the other business phone number to this business phone number. The account is removed from the other phone number and assigned to this phone number. Valid values: none : none force_transfer : force_transfer	none

Response elements

Element	Type	Description	Example
	object
AccessDeniedDetail	string	The access denial details. This field is returned only when RAM authentication fails.	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	object	The result details of the monitoring task.
Status	string	The current status of the username update. Valid values: approved : approved reserved : reserved	approved
Code	string	The response code. A value of 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.	true

Examples

Success response

JSON format

{
  "AccessDeniedDetail": "None",
  "Message": "None",
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2O",
  "Data": {
    "Status": "approved"
  },
  "Code": "OK",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.