首页 Chat App 消息服务 开发参考 API参考 API目录 嵌入式相关 GetMigrationVerifyCode - 获取迁移号码的验证码

GetMigrationVerifyCode - 获取迁移号码的验证码

更新时间: 2024-11-18 10:11:50

获取迁移号码的验证码。

接口说明

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

调试

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

授权信息

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

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

请求参数

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

ISV 子客户的 SpaceId。

29348393884****
PhoneNumberstring

手机号码。

861380000****
Localestring

语言。

zh_CN
Methodstring

验证码方式。

枚举值:
  • voice通过电话接收
  • sms通过短信接收
sms

返回参数

名称类型描述示例值
object

返回数据。

RequestIdstring

请求 ID。

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

请求状态码。

  • 返回 OK 代表请求成功。

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

OK
Messagestring

错误提示信息。

None
Dataobject

返回数据。

PhoneNumberstring

手机号码。

861380000****
Idstring

号码 ID。

8282889****
AccessDeniedDetailstring

访问被拒绝详细信息。

示例

正常返回示例

JSON格式

{
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2O",
  "Code": "OK",
  "Message": "None",
  "Data": {
    "PhoneNumber": "861380000****",
    "Id": "8282889****"
  },
  "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.

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

变更历史

变更时间变更内容概要操作
2024-11-06OpenAPI 错误码发生变更查看变更详情
2023-07-04OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
上一篇: CreateChatappMigrationInitiate - 创建需要迁移号码 下一篇: ChatappMigrationVerified - 迁移号码校验