QueryChatappPhoneNumbers查询Chat App号码列表及状态-Chat App 消息服务-阿里云

查询客户下的所有发送号码及号码状态。

接口说明

本接口的单用户 QPS 限制为 10 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

cams:QueryChatappPhoneNumbers

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
IsvCode	string	否	Isv 校验码，用于校验子账号是否由 ISV 授权。	aksik93kdkkxmwol9****
CustSpaceId	string	否	ISV 子客户的 SpaceId。	29348393884****
Status	string	否	号码状态。	VERIFIED

返回参数

名称	类型	描述	示例值
	object	返回结果。
RequestId	string	请求 ID。	90E63D28-E31D-1EB2-8939-A94866411B2O
Code	string	请求状态码。返回 OK 代表请求成功。其他错误码，请参见错误码列表。	OK
Message	string	信息。	SUCCESS
PhoneNumbers	array<object>	号码列表。
	object	结构体。
UpQueue	string	上行消息通知 Queue。	Alicom-Queue-****-ChatAppInbound
PhoneNumber	string	号码。	861380000****
StatusQueue	string	状态报告通知 Queue。	Alicom-Queue-****-ChatAppStatus
VerifiedName	string	申请名称。	Alibaba
StatusCallbackUrl	string	状态报告通知 URL。	https://ali.com/status
UpCallbackUrl	string	上行消息通知 URL。	https://ali.com/inbound
QualityRating	string	号码质量。枚举值： RED : 低质量 YELLOW : 中质量 UNKNOWN : 未知 GREEN : 高质量	GREEN
Status	string	号码状态。枚举值： MIGRATED : 已迁移 FLAGGED : 被标记 DISCONNECTED : 已断开 UNVERIFIED : 未验证 BANNED : 已封禁 RATE_LIMITED : 限制发送 PENDING : 待定 CONNECTED : 已连接 UNKNOWN : 未知 DELETED : 已删除 RESTRICTED : 已受限	CONNECTED
CodeVerificationStatus	string	号码校验状态。枚举值： REVOKED : 已撤销 MORE_INFORMATION_REQUESTED : 需要提供更多信息 VERIFIED : 校验通过 REJECTED : 校验被拒绝	VERIFIED
NameStatus	string	名称状态。	Approval
MessagingLimitTier	string	号码发送量。枚举值： TIER_100K : 100000 TIER_UNLIMITED : unlimited TIER_250 : 250 TIER_1K : 1000 TIER_50 : 50 TIER_10K : 10000	TIER_10K
NewNameStatus	string	新名称审核状态。	Approval
AccessDeniedDetail	string	访问被拒绝详细信息。	None

示例

正常返回示例

JSON格式

{
  "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"
}

错误码

HTTP status code	错误码	错误信息	描述
400	Product.Unsubscript	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.	系统处于流控制之下。
400	Unknown.ResourceOwnerId	The resource does not belong to the current user.	资源不属于当前用户。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。