文档

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

更新时间:

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

接口说明

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
IsvCodestring

Isv 校验码,用于校验子账号是否由 ISV 授权。

aksik93kdkkxmwol93939
CustSpaceIdstring

ISV 子客户的 SpaceId。

293483938849493

返回参数

名称类型描述示例值
object

返回结果对象

RequestIdstring

请求 ID。

90E63D28-E31D-1EB2-8939-A94866411B2O
Codestring

请求状态码。

  • 返回 OK 代表请求成功。

  • 其他错误码,请参见错误码列表

OK
Messagestring

信息。

SUCCESS
PhoneNumbersobject []

号码列表

UpQueuestring

上行消息通知 Queue。

Alicom-Queue-****-ChatAppInbound
PhoneNumberstring

号码

8613800000
StatusQueuestring

状态报告通知 Queue

Alicom-Queue-****-ChatAppStatus
VerifiedNamestring

申请名称。

Alibaba
StatusCallbackUrlstring

状态报告通知 URL。

https://ali.com/status
UpCallbackUrlstring

上行消息通知 URL。

https://ali.com/inbound
QualityRatingstring

号码质量。取值:

  • GREEN

  • YELLOW

  • RED

  • UNKNOWN

GREEN
Statusstring

号码状态。

  • PENDING

  • DELETED

  • MIGRATED

  • BANNED

  • RESTRICTED

  • RATE_LIMITED

  • FLAGGED

  • CONNECTED

  • DISCONNECTED

  • UNKNOWN

  • UNVERIFIED

CONNECTED
CodeVerificationStatusstring

号码校验状态。

VERIFIED
NameStatusstring

名称状态。

Approval
MessagingLimitTierstring

号码发送量。

TIER_10
NewNameStatusstring

新名称审核状态。

Approval
AccessDeniedDetailstring

访问被拒绝详细信息。

示例

正常返回示例

JSON格式

{
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2O",
  "Code": "OK",
  "Message": "SUCCESS",
  "PhoneNumbers": [
    {
      "UpQueue": "Alicom-Queue-****-ChatAppInbound",
      "PhoneNumber": "8613800000",
      "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_10",
      "NewNameStatus": "Approval"
    }
  ],
  "AccessDeniedDetail": "无"
}

错误码

HTTP status code错误码错误信息
400Product.UnsubscriptYou have not subscribed to the specified product.
400Ram.PermissionDenyYou are not authorized to perform the operation.
400System.LimitControlThe system is under flow control.
400Unknown.ResourceOwnerIdThe resource does not belong to the current user.

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

变更历史

变更时间变更内容概要操作
2023-07-04OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈