Use ChatappSyncPhoneNumber to synchronize phone numbers - Chat App Message Service

Synchronizes phone numbers.

Operation description

This operation allows a maximum of 10 requests per second (RPS) per account. Excess requests are throttled, which may affect your business. Stay within the specified limit.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cams:ChatappSyncPhoneNumber

update

*All Resource

*

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 elements

Element	Type	Description	Example
	object	The results returned.
AccessDeniedDetail	string	The details about the access denial.	None
PhoneNumbers	array<object>	The phone numbers.
	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 Valid values: MIGRATED : MIGRATED FLAGGED : FLAGGED DISCONNECTED : DISCONNECTED UNVERIFIED : UNVERIFIED BANNED : BANNED RATE_LIMITED : RATE_LIMITED PENDING : PENDING CONNECTED : CONNECTED UNKNOWN : UNKNOWN DELETED : DELETED RESTRICTED : RESTRICTED	PENDING
QualityRating	string	The quality rating of the phone number. Valid values: RED YELLOW GREEN Valid values: RED : RED YELLOW : YELLOW GREEN : 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. Valid values: REVOKED : MORE_INFORMATION_REQUESTED : VERIFIED : REJECTED :	VERIFIED
NewNameStatus	string	The review status of the new business display name.	Approval
PhoneNumber	string	The phone number.	861380000****
StatusQueue	string	The status report queue.	alicom-0939****-queue
UpQueue	string	The mobile originated (MO) message queue.	alicom-0939****-queue
NameStatus	string	The review status of the business display name.	Approval
UpCallbackUrl	string	The URL that receives the MO messages.	https://www.alibaba.com/inbound
MessagingLimitTier	string	The number of phone numbers to which messages can be sent in a day. Valid values: TIER_100K : 100000 TIER_UNLIMITED : unlimited TIER_250 : 250 TIER_1K : 1000 TIER_50 : 50 TIER_10K : 10000	TIER_10K
StatusCallbackUrl	string	The callback URL to which status reports are sent by using HTTP callbacks.	https://www.alibaba.com/status
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

Success response

JSON format

{
  "AccessDeniedDetail": "None",
  "PhoneNumbers": [
    {
      "VerifiedName": "Alibaba",
      "Status": "PENDING",
      "QualityRating": "GREEN",
      "CodeVerificationStatus": "VERIFIED",
      "NewNameStatus": "Approval",
      "PhoneNumber": "861380000****",
      "StatusQueue": "alicom-0939****-queue",
      "UpQueue": "alicom-0939****-queue",
      "NameStatus": "Approval",
      "UpCallbackUrl": "https://www.alibaba.com/inbound\n",
      "MessagingLimitTier": "TIER_10K",
      "StatusCallbackUrl": "https://www.alibaba.com/status"
    }
  ],
  "Message": "None",
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.