ChatappSyncPhoneNumber - Chat App Message Service - Alibaba Cloud Documentation Center

Synchronizes phone numbers.

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:
- For mandatory resource types, indicate with a prefix of * .
- 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:ChatappSyncPhoneNumber	update	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
CustSpaceId	string	Yes	The space ID of the user under the independent software vendor (ISV) account.	293483938849493****

Response parameters

Parameter	Type	Description	Example
	object	The results returned.
AccessDeniedDetail	string	The details about the access denial.	None
PhoneNumbers	array<object>	The phone numbers.
phoneNumbers	object	The object.
VerifiedName	string	The display name of the business to which the phone number belongs.	Alibaba
Status	string	The state of the phone number. Valid values: MIGRATED FLAGGED DISCONNECTED UNVERIFIED BANNED RATE_LIMITED PENDING CONNECTED UNKNOWN DELETED RESTRICTED	PENDING
UpQueue	string	The mobile originated (MO) message queue.	alicom-09399200-queue
NameStatus	string	The review status of the business display name.	Approval
MessagingLimitTier	string	The number of phone numbers to which messages can be sent in a day. Enumeration Value: TIER_100K: 100000. TIER_UNLIMITED: unlimited. TIER_250: 250. TIER_1K: 1000. TIER_50: 50. TIER_10K: 10000.	TIER_10
StatusCallbackUrl	string	The callback URL to which status reports are sent by using HTTP callbacks.	https://www.alibaba.com/status
QualityRating	string	The quality rating of the phone number. Valid values: RED YELLOW GREEN	GREEN
CodeVerificationStatus	string	The verification state of the phone number. Valid values: REVOKED: The review application is revoked. MORE_INFORMATION_REQUESTED: More information needs to be provided. VERIFIED: The phone number passes the verification. REJECTED: The phone number fails to pass the verification.	VERIFIED
NewNameStatus	string	The review status of the new business display name.	Approval
PhoneNumber	string	The phone number.	8613800001234
StatusQueue	string	The status report queue.	alicom-09399200-queue
IsOfficial	string	Indicates whether it is a WhatsApp Official Business Account (OBA).	N
UpCallbackUrl	string	The URL that receives the MO messages.	https://www.alibaba.com/inbound
Message	string	The error message returned.	None.
RequestId	string	The ID of the request.	90E63D28-E31D-1EB2-8939-A94866411B2O
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 call was successful. Valid values: true: The call was successful. false: The call failed.	true

Examples

Sample success responses

JSONformat

{
  "AccessDeniedDetail": "None",
  "PhoneNumbers": [
    {
      "VerifiedName": "Alibaba",
      "Status": "PENDING",
      "UpQueue": "alicom-09399200-queue",
      "NameStatus": "Approval",
      "MessagingLimitTier": "TIER_10",
      "StatusCallbackUrl": "https://www.alibaba.com/status",
      "QualityRating": "GREEN",
      "CodeVerificationStatus": "VERIFIED",
      "NewNameStatus": "Approval",
      "PhoneNumber": 8613800001234,
      "StatusQueue": "alicom-09399200-queue",
      "IsOfficial": "N",
      "UpCallbackUrl": "https://www.alibaba.com/inbound\n"
    }
  ],
  "Message": "None.\n",
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2O",
  "Code": "OK",
  "Success": true
}

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.

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

Change history

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