Use ChatappSyncPhoneNumber to synchronize phone numbers - Chat App Message Service - Alibaba Cloud - Chat App Message Service

Synchronizes phone number information.

Operation description

The China-specific QPS limit for this API is 10 calls per second. If this limit is exceeded, the API calls are throttled, which may affect your business. Call this operation at a reasonable frequency.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
CustSpaceId	string	Yes	The SpaceId of the ISV sub-customer.	293483938849493****

Response elements

Element	Type	Description	Example
	object	The response parameters.
AccessDeniedDetail	string	The details about the access denial.	无
PhoneNumbers	array<object>	The list of phone numbers.
	array<object>	The object.
VerifiedName	string	The verified name of the phone number.	Alibaba
Status	string	The status of the phone number. 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
UpQueue	string	The upstream MSMQ.	alicom-0939****-queue
NameStatus	string	The name review status.	Approval
MessagingLimitTier	string	The messaging limit tier of the phone number. 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 for status reports.	https://www.alibaba.com/status
QualityRating	string	The quality rating of the phone number. Valid values: RED : RED YELLOW : YELLOW GREEN : GREEN	GREEN
CodeVerificationStatus	string	The verification status. Valid values: REVOKED: The verification request is revoked. MORE_INFORMATION_REQUESTED: More information is required. VERIFIED: The verification is passed. REJECTED: The verification is rejected. Valid values: REVOKED : The verification request is revoked. MORE_INFORMATION_REQUESTED : More information is required. VERIFIED : The verification is passed. REJECTED : The verification is rejected.	VERIFIED
NewNameStatus	string	The review status of the new name.	Approval
CallingConfigure	object
Calling	object
Status	string		ENABLED
CallHours	object
Status	string		ENABLED
HolidaySchedule	array<object>
	object
EndTime	string		2359
StartTime	string		0000
Date	string		2026-01-01
TimezoneId	string		Asia/Shanghai
WeeklyOperatingHours	array<object>
	object
OpenTime	string		0000
DayOfWeek	string		MONDAY
CloseTime	string		2359
CallbackPermissionStatus	string		示例值示例值示例值
CallIconVisibility	string		DEFAULT
MaxTalkTime	integer		100
CallingCallbackUrl	string		http://aliyun.com
PhoneNumber	string	The phone number.	861380000****
StatusQueue	string	The status report queue.	alicom-0939****-queue
IsOfficial	string	Indicates whether the phone number is OBA-certified.	N
UpCallbackUrl	string	The callback URL for upstream messages.	https://www.alibaba.com/inbound
Message	string	The error message.	无
RequestId	string	The request ID.	90E63D28-E31D-1EB2-8939-A94866411B2O
Code	string	The response code. A value of OK indicates that the request is successful. For other error codes, see Error codes.	OK
Success	boolean	Indicates whether the call is successful. Valid values: true: The call is successful. false: The call failed.	true

Examples

Success response

JSON format

{
  "AccessDeniedDetail": "无",
  "PhoneNumbers": [
    {
      "VerifiedName": "Alibaba",
      "Status": "PENDING",
      "UpQueue": "alicom-0939****-queue",
      "NameStatus": "Approval",
      "MessagingLimitTier": "TIER_10K",
      "StatusCallbackUrl": "https://www.alibaba.com/status",
      "QualityRating": "GREEN",
      "CodeVerificationStatus": "VERIFIED",
      "NewNameStatus": "Approval",
      "CallingConfigure": {
        "Calling": {
          "Status": "ENABLED",
          "CallHours": {
            "Status": "ENABLED",
            "HolidaySchedule": [
              {
                "EndTime": "2359",
                "StartTime": "0000",
                "Date": "2026-01-01"
              }
            ],
            "TimezoneId": "Asia/Shanghai",
            "WeeklyOperatingHours": [
              {
                "OpenTime": "0000",
                "DayOfWeek": "MONDAY",
                "CloseTime": "2359"
              }
            ]
          },
          "CallbackPermissionStatus": "示例值示例值示例值",
          "CallIconVisibility": "DEFAULT"
        },
        "MaxTalkTime": 100,
        "CallingCallbackUrl": "http://aliyun.com"
      },
      "PhoneNumber": "861380000****",
      "StatusQueue": "alicom-0939****-queue",
      "IsOfficial": "N",
      "UpCallbackUrl": "https://www.alibaba.com/inbound\n"
    }
  ],
  "Message": "无",
  "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.