QueryChatappPhoneNumbers - Chat App Message Service - Alibaba Cloud Documentation Center

Queries all phone numbers used for sending messages and their statuses for a customer.

Operation description

This API is limited to 10 queries per second (QPS) for each user. If you exceed this limit, API calls are throttled, which can affect your business. Call this API 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:QueryChatappPhoneNumbers

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
IsvCode	string	No	The verification code of the Independent Software Vendor (ISV). This code is used to verify if the user is authorized by the ISV.	aksik93kdkkxmwol9****
CustSpaceId	string	No	The Space ID of the ISV sub-customer.	29348393884****
Status	string	No	The status of the phone number.	VERIFIED

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	90E63D28-E31D-1EB2-8939-A94866411B2O
Code	string	The request status code. A value of OK indicates that the request was successful. For other error codes, see Error codes.	OK
Message	string	The returned message.	SUCCESS
PhoneNumbers	array<object>	The list of phone numbers.
	object	The data structure.
UpQueue	string	The queue for mobile originated messages.	Alicom-Queue-****-ChatAppInbound
PhoneNumber	string	The phone number.	861380000****
StatusQueue	string	The queue for delivery receipts of mobile terminated messages.	Alicom-Queue-****-ChatAppStatus
VerifiedName	string	The name used for the request.	Alibaba
StatusCallbackUrl	string	The callback URL for delivery receipts.	https://ali.com/status
UpCallbackUrl	string	The callback URL for mobile originated messages.	https://ali.com/inbound
QualityRating	string	The quality rating of the phone number. Valid values: RED : Low quality YELLOW : Medium quality UNKNOWN : Unknown GREEN : High quality	GREEN
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	CONNECTED
CodeVerificationStatus	string	The verification status of the phone number. Valid values: REVOKED : Revoked MORE_INFORMATION_REQUESTED : More information is requested VERIFIED : Verified REJECTED : Rejected	VERIFIED
NameStatus	string	The status of the name.	Approval
MessagingLimitTier	string	The messaging limit tier of the phone number. Valid values: TIER_100K : 100,000 TIER_UNLIMITED : Unlimited TIER_250 : 250 TIER_1K : 1,000 TIER_50 : 50 TIER_10K : 10,000	TIER_10K
NewNameStatus	string	The review status of the new name.	Approval
AccessDeniedDetail	string	Details about the access denial.	None

Examples

Success response

JSON format

{
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2O",
  "Code": "OK",
  "Message": "SUCCESS",
  "PhoneNumbers": [
    {
      "UpQueue": "Alicom-Queue-****-ChatAppInbound",
      "PhoneNumber": "861380000****",
      "StatusQueue": "Alicom-Queue-****-ChatAppStatus",
      "VerifiedName": "Alibaba",
      "StatusCallbackUrl": "https://ali.com/status",
      "UpCallbackUrl": "https://ali.com/inbound",
      "QualityRating": "GREEN",
      "Status": "CONNECTED",
      "CodeVerificationStatus": "VERIFIED",
      "NameStatus": "Approval",
      "MessagingLimitTier": "TIER_10K",
      "NewNameStatus": "Approval"
    }
  ],
  "AccessDeniedDetail": "None"
}

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.