新建G号码组
更新时间:2021-03-19
接口描述
AXG模式可以解决招聘的场景中用户隐私保护的问题。在使用AXG场景时,首先需要调用该接口创建一个G号码组,有了G号码组才可以在该号码组中添加对应的号码。
请求结构
POST /cloud/api/v{version}/axg/group/set HTTP/1.1
Host: pns.baidubce.com
Content-Type: application/json; charset=utf-8
x-bce-date: 2019-10-30T10:55:26Z
Authorization: authorization string
{
"comType": "默认0",
"groupName": "G号码组名称",
"groupDesc": "G号码组描述",
"numberList": ["在创建G号码组时,至少需要一个号码"]
}
请求域名
参考API文档中的服务域名
请求头域
除公共头域外,无其它特殊头域。
请求参数
参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
---|---|---|---|---|
version | String | 是 | URL参数 | API版本号,参考通用说明中的API版本号 |
comType | String | 是 | RequestBody参数 | 默认0,表示提供语音服务 |
groupName | String | 是 | RequestBody参数 | G号码组名称,具有唯一性 |
groupDesc | String | 是 | RequestBody参数 | G号码组描述,可以为空 |
numberList | List | 是 | RequestBody参数 | G号码组中的号码,至少存在一个号码 |
响应头域
除了公共头域外,如果发生网关错误,可能头域中存在以下特殊头域:
参数名 | 类型 | 说明 |
---|---|---|
X-Bce-Error-Code | String | 表示异常情况下的错误码 |
X-Bce-Error-Message | String | 表示异常情况下的错误信息 |
响应参数
参数名称 | 类型 | 描述 |
---|---|---|
code | String | 平台返回的错误码,0表示成功 |
msg | String | 平台放回的错误消息 |
data | Json | 平台返回的响应数据 |
绑定操作成功后的响应数据data:
参数名称 | 类型 | 描述 |
---|---|---|
groupId | String | G号码组ID |
numberList | List | 该G号码组中存在的号码列表 |
错误码
请参照前文的网关错误码和平台错误码。
请求示例
POST /cloud/api/v{version}/axg/group/set HTTP/1.1
Host: pns.baidubce.com
Content-Type: application/json; charset=utf-8
x-bce-date: 2019-10-30T10:55:26Z
Authorization: bce-auth-v1/318857a8f08b11e9845ca7e54775a0c2/2019-10-17T03:07:21Z/1800/host/212eef8cfe1ac94be56c4afedb9360bba621ef646c3c8288971d36801d70501a
{
"comType": "0",
"groupName": "G号码组",
"groupDesc": "G号码组描述",
"numberList": ["13800001111"]
}
响应示例
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Date: Wed, 08 Jul 2019 03:28:11 GMT
x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
X-Bce-Gateway-Region: BJ
{
"code":"0",
"msg":"成功",
"data": {
"groupId":"1522440803563077643",
"numberList":["13800001111"]
}
}