文档

OperateAxgGroup - 修改G号码组

更新时间:

修改G号码组中的号码,可以对号码进行添加、删除、全量替换操作。

接口说明

  • 创建 G 号码组之后,可以通过此接口修改 G 号码组中的号码,例如向 G 号码组中增加号码、删除号码、全量替换号码。

  • 您可以使用此接口修改 G 号码组中的号码,也可以登录控制台,在号码池管理页面筛选出 AXG 隐私号类型的号码池,单击G 号码组管理>G 组号码管理进行修改。

  • 在使用此接口前,建议您先明确需要修改的 G 号码组及该号码组归属的号码池。

QPS 限制

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

调试

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

授权信息

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

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

请求参数

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

号码池 Key。

在号码隐私保护控制台,号码池管理页面获取号码池 Key

FC10000012345****
GroupIdlong

AXG 中的 G 组 ID,即 GID。

可以通过以下方式查看 GID:

  • 登录号码隐私保护控制台,在号码池管理页面筛选出 AXG 隐私号,单击G 号码组管理即可查看所有 G 号码组的 GID。
  • 如果 G 号码组是通过接口 CreateAxgGroup 创建的,则接口的返回参数 GroupID 就是此处的请求参数 GroupID
说明 G 号码组中必须有一个及以上的电话号码。
200001234****
OperateTypestring

对 G 号码组的操作类型,取值:

  • addNumbers:添加号码。
  • deleteNumbers:删除号码。
  • overwriteNumbers:全量替换号码。会将 G 号码组中原有的电话号码全部删除,并重新添加号码。
说明
  • 每次添加号码时,最多添加 200 个号码。
  • 全量替换号码时,G 号码组中原有的号码不能超过 200 个。
  • addNumbers
    Numbersstring

    受到操作的电话号码。

    多个号码之间用英文逗号(,)分隔,每次最多操作 200 个号码。

    说明
  • OperateType 参数指定为 addNumbers 时,将 Numbers 参数填写的电话号码添加到 G 号码组中。
  • OperateType 参数指定为 deleteNumbers 时,将 Numbers 参数填写的电话号码从 G 号码组中删除
  • OperateType 参数指定为 overwriteNumbers 时,使用 Numbers 参数填写的电话号码全量替换G 号码组中原有的电话号码。
  • 1390000****,1380000****

    返回参数

    名称类型描述示例值
    object

    返回数据。

    Codestring

    请求状态码。

    • 返回 OK 代表请求成功。
    • 其他错误码,请参见错误码列表
    OK
    Messagestring

    状态码的描述。

    OK
    RequestIdstring

    请求 ID。

    986BCB6D-C9BF-42F9-91CE-3A9901233D36

    示例

    正常返回示例

    JSON格式

    {
      "Code": "OK",
      "Message": "OK",
      "RequestId": "986BCB6D-C9BF-42F9-91CE-3A9901233D36"
    }

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2023-03-16API 内部配置变更,不影响调用看变更集
    变更项变更内容
    API 内部配置变更,不影响调用