AXG分组创建接口(CreateAxgGroup)

通过本文您可以了解AXG分组创建接口的操作流程。

背景信息

CreateAxgGroup用以创建AXG关系中的G组,创建时支持初始化组内号码,单次操作不得添加超过200个号码,每个号池最大支持创建2000个分组。创建分组成功后系统会返回GID给用户,用户在绑定接口创建绑定关系时需要传入GID。

前提条件

  1. 注册阿里云账号并完成企业实名认证。具体操作请参见注册阿里云账号企业实名认证

  2. 获取阿里云访问密钥。具体操作,请参见获取AccessKey

下载对应的SDK和DEMO样例程序编写代码

请到SDK&DEMO下载页面获取相应的SDK和DEMO程序,参照代码样例进行接口开发和调试。

参数

入参列表

参数名称

参数类型

必填与否

样例取值

参数说明

PoolKey

String

必须

FC123456

号池Key。

Name

String

可选

测试分组

分组名称。

Remark

String

可选

测试分组备注信息

备注信息。

Numbers

String

可选

15800000000,15900000000

创建分组时,需要添加的默认号码,以英文逗号(,)分隔,单次最多添加200个。

出参列表

出参名称

出参类型

样例取值

参数说明

RequestId

String

8906582E-6722

请求ID。

Code

String

OK

状态码。返回OK代表请求成功,其他错误码详见错误码列表。

Message

String

请求成功

状态码的描述。

GroupId

Long

1234

分组ID。

技术对接步骤

  1. 下载SDK工具包。

    • SDK工具包中一共包含了2个类库,一个aliyun-java-sdk-core包,另外一个是alicom-dypls-api包,将这两个包执行mvn package命令或者mvn deploy命令打包出相应的jar包,添加到工程类库中依赖使用。

    • SDK&DEMO下载地址,请参见SDK&DEMO下载

  2. 编写样例程序。

    //设置超时时间-可自行调整
    System.setProperty("sun.net.client.defaultConnectTimeout", "10000");
    System.setProperty("sun.net.client.defaultReadTimeout", "10000");
    //初始化ascClient需要的几个参数
    final String product = "Dyplsapi";//隐私号码产品名称(隐私保护产品名固定,无需修改)
    final String domain = "dyplsapi.aliyuncs.com";//隐私号码产品域名(接口地址固定,无需修改)
    //替换成你的AK
    final String accessKeyId = "yourAccessKeyId";//你的accessKeyId,参考本文档步骤2
    final String accessKeySecret = "yourAccessKeySecret";//你的accessKeySecret,参考本文档步骤2
    //初始化ascClient,暂时不支持多region
    IClientProfile profile = DefaultProfile.getProfile("cn-hangzhou", accessKeyId,
    accessKeySecret);
    DefaultProfile.addEndpoint("cn-hangzhou", "cn-hangzhou", product, domain);
    IAcsClient acsClient = new DefaultAcsClient(profile);
     //AXG绑定请求结构体-参数说明详见参数说明
     CreateAxgGroupRequest request = new CreateAxgGroupRequest();
     //必填:号池Key-详见概览页面的号池管理功能
     request.setPoolKey("FC123456");
     //可选:分组名称
     request.setName("测试分组");
     //可选:分组备注
     request.setRemark("测试分组备注信息");
     //可选:AXG中的G组中的号码
     request.setNumbers("15800000000,15900000000");
     //每个号池最多可以创建2000个分组
    CreateAxgGroupResponse response = acsClient.getAcsResponse(request);
     if(response.getCode() != null && response.getCode().equals("OK")) {
              //请求成功
      }
                            

错误码列表

Code

描述

OK

请求成功。

isp.RAM_PERMISSION_DENY

RAM权限DENY。

isv.OUT_OF_SERVICE

业务停机。

isv.PRODUCT_UN_SUBSCRIPT

未开通云通信产品的阿里云客户。

isv.PRODUCT_UNSUBSCRIBE

产品未开通。

isv.ACCOUNT_NOT_EXISTS

账户不存在。

isv.ACCOUNT_ABNORMAL

账户异常。

isp.SYSTEM_ERROR

系统错误。

isp.UNKNOWN_ERR_CODE

运营商未知错误。

isv.PARTNER_NOT_EXIST

未知合作伙伴。

isv.NO_NOT_EXIST

号码不存在。

isv.ILLEGAL_ARGUMENT

参数非法。

isp.DAO_EXCEPTION

数据库异常。

isv.NO_AVAILABLE_NUMBER

无可用号码。

isp.VENDOR_UNAVAILABLE

运营商降级。

isv.FLOW_LIMIT

业务流控。

isv.PARTNER_IS_CLOSED

partner被关停。

isv.FORBIDDEN_ACTION

无权操作。

isv.NO_USED_BY_OTHERS

码被其他业务方占用。

isv.VENDOR_BIND_FAILED

运营商绑定失败。

isv.EXPIRE_DATE_ILLEGAL

过期时间非法。

isv.MOBILE_NUMBER_ILLEGAL

号码格式非法。

isv.BIND_CONFLICT

绑定冲突。