查询客户下的所有发送号码及号码状态。
接口说明
本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
cams:QueryChatappPhoneNumbers |
list |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| IsvCode |
string |
否 |
Isv 校验码,用于校验子账号是否由 ISV 授权。 |
aksik93kdkkxmwol9**** |
| CustSpaceId |
string |
否 |
ISV 子客户的 SpaceId。 |
29348393884**** |
| Status |
string |
否 |
号码状态。 |
VERIFIED |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回结果。 |
||
| PhoneNumbers |
array<object> |
号码列表。 |
|
|
array<object> |
结构体。 |
||
| VerifiedName |
string |
申请名称。 |
Alibaba |
| Status |
string |
号码状态。 枚举值:
|
CONNECTED |
| UpQueue |
string |
上行消息通知 Queue。 |
Alicom-Queue-****-ChatAppInbound |
| NameStatus |
string |
名称状态。 |
Approval |
| MessagingLimitTier |
string |
号码发送量。 枚举值:
|
TIER_10K |
| StatusCallbackUrl |
string |
状态报告通知 URL。 |
https://ali.com/status |
| QualityRating |
string |
号码质量。 枚举值:
|
GREEN |
| CodeVerificationStatus |
string |
号码校验状态。 枚举值:
|
VERIFIED |
| NewNameStatus |
string |
新名称审核状态。 |
Approval |
| CallingConfigure |
object |
通话配置。 |
|
| Calling |
object |
通话功能配置。 |
|
| Status |
string |
通话功能状态。 |
ENABLED |
| CallHours |
object |
通话时间配置。 |
|
| Status |
string |
通话时间配置状态。 |
ENABLED |
| CallbackPermissionStatus |
string |
回拨权限状态。 |
ENABLED |
| HolidaySchedule |
array<object> |
节假日通话时间安排。 |
|
|
object |
|||
| EndTime |
string |
结束时间,格式为 HHmm。 |
2359 |
| StartTime |
string |
开始时间,格式为 HHmm。 |
0000 |
| Date |
string |
日期,格式为 YYYY-MM-DD。 |
2026-01-01 |
| CallIconVisibility |
string |
通话图标可见性。 |
DEFAULT |
| TimezoneId |
string |
时区 ID,例如 Asia/Shanghai。 |
Asia/Shanghai |
| WeeklyOperatingHours |
array<object> |
每周营业时间安排。 |
|
|
object |
|||
| OpenTime |
string |
开始营业时间,格式为 HHmm。 |
0000 |
| DayOfWeek |
string |
星期。 |
示例值示例值示例值 |
| CloseTime |
string |
结束营业时间,格式为 HHmm。 |
2359 |
| MaxTalkTime |
integer |
最长通话时长。 |
1000 |
| CallingCallbackUrl |
string |
通话回调地址。 |
https://aliyun.com |
| PhoneNumber |
string |
号码。 |
861380000**** |
| StatusQueue |
string |
状态报告通知 Queue。 |
Alicom-Queue-****-ChatAppStatus |
| IsOfficial |
string |
是否认证 |
N |
| UpCallbackUrl |
string |
上行消息通知 URL。 |
https://ali.com/inbound |
| AccessDeniedDetail |
string |
访问被拒绝详细信息。 |
None |
| Message |
string |
信息。 |
SUCCESS |
| RequestId |
string |
请求 ID。 |
90E63D28-E31D-1EB2-8939-A94866411B2O |
| Data |
string |
返回数据。 |
示例值 |
| Code |
string |
请求状态码。
|
OK |
| Success |
boolean |
是否调用成功:
|
true |
示例
正常返回示例
JSON格式
{
"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
}
错误码
|
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. | 资源不属于当前用户。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。