ChatappSyncPhoneNumber - 同步号码信息

同步号码信息。

接口说明

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cams:ChatappSyncPhoneNumberupdate
  • 全部资源
    *

请求参数

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

ISV 子客户的 SpaceId。

293483938849493****

返回参数

名称类型描述示例值
object

返回结果。

AccessDeniedDetailstring

访问被拒绝详细信息。

PhoneNumbersarray<object>

号码列表。

contentobject

对象。

VerifiedNamestring

号码名称。

Alibaba
Statusstring

号码状态。

枚举值:
  • MIGRATEDMIGRATED
  • FLAGGEDFLAGGED
  • DISCONNECTEDDISCONNECTED
  • UNVERIFIEDUNVERIFIED
  • BANNEDBANNED
  • RATE_LIMITEDRATE_LIMITED
  • PENDINGPENDING
  • CONNECTEDCONNECTED
  • UNKNOWNUNKNOWN
  • DELETEDDELETED
  • RESTRICTEDRESTRICTED
PENDING
QualityRatingstring

号码质量。

枚举值:
  • REDRED
  • YELLOWYELLOW
  • GREENGREEN
GREEN
CodeVerificationStatusstring

校验状态。

枚举值:
  • REVOKED撤销审核申请
  • MORE_INFORMATION_REQUESTED需要提供更多信息
  • VERIFIED校验通过
  • REJECTED校验被拒绝
VERIFIED
NewNameStatusstring

新名称审核状态。

Approval
PhoneNumberstring

手机号码。

861380000****
StatusQueuestring

状态报告队列。

alicom-0939****-queue
UpQueuestring

上行消息队列。

alicom-0939****-queue
NameStatusstring

名称审核状态。

Approval
UpCallbackUrlstring

上行消息通知 URL。

https://www.alibaba.com/inbound
MessagingLimitTierstring

号码发送量。

枚举值:
  • TIER_100K100000
  • TIER_UNLIMITEDunlimited
  • TIER_250250
  • TIER_1K1000
  • TIER_5050
  • TIER_10K10000
TIER_10K
StatusCallbackUrlstring

状态报告通知 URL。

https://www.alibaba.com/status
Messagestring

错误提示信息。

RequestIdstring

请求 ID。

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

请求状态码。

  • 返回 OK 代表请求成功。

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

OK
Successboolean

是否调用成功。

  • true:调用成功。
  • false:调用失败。
true

示例

正常返回示例

JSON格式

{
  "AccessDeniedDetail": "无",
  "PhoneNumbers": [
    {
      "VerifiedName": "Alibaba",
      "Status": "PENDING",
      "QualityRating": "GREEN",
      "CodeVerificationStatus": "VERIFIED",
      "NewNameStatus": "Approval",
      "PhoneNumber": "861380000****",
      "StatusQueue": "alicom-0939****-queue",
      "UpQueue": "alicom-0939****-queue",
      "NameStatus": "Approval",
      "UpCallbackUrl": "https://www.alibaba.com/inbound\n",
      "MessagingLimitTier": "TIER_10K",
      "StatusCallbackUrl": "https://www.alibaba.com/status"
    }
  ],
  "Message": "无",
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2O",
  "Code": "OK",
  "Success": true
}

错误码

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 返回结构发生变更查看变更详情