Query phone numbers and status with QueryChatappPhoneNumbers - Chat App Message Service - Alibaba Cloud - Chat App Message Service

Queries all sending phone numbers and their statuses under a customer account.

Operation description

The throttling limit for this operation is 10 calls per second per user. If the limit is exceeded, API calls are throttled, which may affect your business. Call this operation at a reasonable rate.

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:QueryChatappPhoneNumbers

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
IsvCode	string	No	The ISV verification code, used to verify whether a sub-account is authorized by an ISV.	aksik93kdkkxmwol9****
CustSpaceId	string	No	The space ID of the ISV sub-customer.	29348393884****
Status	string	No	The phone number status.	VERIFIED

Response elements

Element	Type	Description	Example
	object	The response result.
PhoneNumbers	array<object>	The list of phone numbers.
	array<object>	The struct.
VerifiedName	string	The application name.	Alibaba
Status	string	The phone number status. Valid values: MIGRATED : Migrated. DISCONNECTED : Disconnected. FLAGGED : Flagged. UNVERIFIED : Unverified. BANNED : Banned. RATE_LIMITED : Rate limited. CONNECTED : Connected. PENDING : Pending. UNKNOWN : Unknown. DELETED : Deleted. RESTRICTED : Restricted.	CONNECTED
UpQueue	string	The queue for inbound message notifications.	Alicom-Queue-****-ChatAppInbound
NameStatus	string	The name status.	Approval
MessagingLimitTier	string	The messaging volume limit tier of the phone number. Valid values: TIER_100K : 100000 TIER_UNLIMITED : unlimited TIER_1K : 1000 TIER_250 : 250 TIER_10K : 10000 TIER_50 : 50	TIER_10K
StatusCallbackUrl	string	The URL for status report notifications.	https://ali.com/status
QualityRating	string	The quality rating of the phone number. Valid values: RED : Low quality. UNKNOWN : Unknown. YELLOW : Medium quality. GREEN : High quality.	GREEN
CodeVerificationStatus	string	The verification status of the phone number. Valid values: REVOKED : Revoked. MORE_INFORMATION_REQUESTED : More information requested. VERIFIED : Verified. REJECTED : Rejected.	VERIFIED
NewNameStatus	string	The review status of the new name.	Approval
CallingConfigure	object	The calling configuration.
Calling	object	The calling feature configuration.
Status	string	The status of the calling feature.	ENABLED
CallHours	object	The call hours configuration.
Status	string	The status of the call hours configuration.	ENABLED
CallbackPermissionStatus	string	The callback permission status.	ENABLED
HolidaySchedule	array<object>	The holiday call hours schedule.
	object
EndTime	string	The end time in HHmm format.	2359
StartTime	string	The start time in HHmm format.	0000
Date	string	The date in YYYY-MM-DD format.	2026-01-01
CallIconVisibility	string	The visibility of the call icon.	DEFAULT
TimezoneId	string	The time zone ID, such as Asia/Shanghai.	Asia/Shanghai
WeeklyOperatingHours	array<object>	The weekly operating hours schedule.
	object
OpenTime	string	The opening time in HHmm format.	0000
DayOfWeek	string	The day of the week.	示例值示例值示例值
CloseTime	string	The closing time in HHmm format.	2359
MaxTalkTime	integer	The maximum call duration.	1000
CallingCallbackUrl	string	The callback URL for calls.	https://aliyun.com
PhoneNumber	string	The phone number.	861380000****
StatusQueue	string	The queue for status report notifications.	Alicom-Queue-****-ChatAppStatus
IsOfficial	string	Indicates whether the phone number is verified.	N
UpCallbackUrl	string	The URL for inbound message notifications.	https://ali.com/inbound
AccessDeniedDetail	string	The details of the access denial.	None
Message	string	The message.	SUCCESS
RequestId	string	The request ID.	90E63D28-E31D-1EB2-8939-A94866411B2O
Data	string	The returned data.	示例值
Code	string	The request status code. OK indicates that the request was successful. For other error codes, see Error codes.	OK
Success	boolean	Indicates whether the call was successful: true: The call was successful. false: The call failed.	true

Examples

Success response

JSON format

{
  "PhoneNumbers": [
    {
      "VerifiedName": "Alibaba",
      "Status": "CONNECTED",
      "UpQueue": "Alicom-Queue-****-ChatAppInbound",
      "NameStatus": "Approval",
      "MessagingLimitTier": "TIER_10K",
      "StatusCallbackUrl": "https://ali.com/status",
      "QualityRating": "GREEN",
      "CodeVerificationStatus": "VERIFIED",
      "NewNameStatus": "Approval",
      "CallingConfigure": {
        "Calling": {
          "Status": "ENABLED",
          "CallHours": {
            "Status": "ENABLED",
            "CallbackPermissionStatus": "ENABLED",
            "HolidaySchedule": [
              {
                "EndTime": "2359",
                "StartTime": "0000",
                "Date": "2026-01-01"
              }
            ],
            "CallIconVisibility": "DEFAULT",
            "TimezoneId": "Asia/Shanghai",
            "WeeklyOperatingHours": [
              {
                "OpenTime": "0000",
                "DayOfWeek": "示例值示例值示例值",
                "CloseTime": "2359"
              }
            ]
          }
        },
        "MaxTalkTime": 1000,
        "CallingCallbackUrl": "https://aliyun.com"
      },
      "PhoneNumber": "861380000****",
      "StatusQueue": "Alicom-Queue-****-ChatAppStatus",
      "IsOfficial": "N",
      "UpCallbackUrl": "https://ali.com/inbound"
    }
  ],
  "AccessDeniedDetail": "None",
  "Message": "SUCCESS",
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2O",
  "Data": "示例值",
  "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.