号码组管理
如何认证
示例
- 获取Token
- 在Header里添加 Authorization: Bearer {ACCESS_TOKEN}
获取所有号码接口
获取所有号码接口
接口地址
POST https://openapi.icsoc.net/v3/portal/api/v3/phone/all
接口参数
传参方式: Content-Type: application/json
参数 | 类型 | 说明 | 必填 |
---|---|---|---|
phone_group_used | int | 是否被号码组使用 0 全部 1 被使用 2 未使用 | 否 |
结果编码说明
code | 说明 |
---|---|
0 | ok |
其它 | 具体看message返回信息 |
示例
请求
curl --location --request POST 'https://openapi.icsoc.net/v3/portal/api/v3/phone/all' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YP6iqELNsyhXcVNJfl07ebDiOfDwqENcdlbD2vYP' \
--data-raw '{
"phone_group_used":0
}'
响应
{
"code": 0,
"message": "ok",
"data": [
{
"phone_id": 91425,
"phone": "030088880009",
"phone400": "",
"phone_group_used": false
},
{
"phone_id": 76430,
"phone": "01088881695",
"phone400": "",
"phone_group_used": true
}
]
}
响应字段说明
参数 | 类型 | 描述 |
---|---|---|
phone_id | int | 号码 id |
phone | string | 号码 |
phone400 | string | 对应400号码 |
phone_group_used | bool | 是否被号码组使用 true:是 false:否 |
号码组列表接口
号码组列表接口查询
接口地址
POST https://openapi.icsoc.net/v3/portal/api/phone/group/list
接口参数
传参方式: Content-Type: application/json
参数 | 类型 | 说明 | 必填 |
---|---|---|---|
page | int | 当前页 | 否 |
rows | int | 当前页大小, 默认100,最大500 | 否 |
group_name | string | 号码组名称 模糊查询 | 否 |
phone_num | string | 号码 精确查询 | 否 |
结果编码说明
code | 说明 |
---|---|
0 | ok |
其它 | 具体看message返回信息 |
示例
请求
curl --location --request POST 'https://openapi.icsoc.net/v3/portal/api/phone/group/list' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YP6iqELNsyhXcVNJfl07ebDiOfDwqENcdlbD2vYP' \
--data-raw '{
"page":1,
"rows":100,
"group_name":"测试"
}'
响应
{
"code": 0,
"message": "ok",
"data": {
"current_page": 1,
"data": [
{
"id": 264,
"group_name": "号码组测试",
"phones": "75503,75305,70863",
"vcc_id": 782,
"remark": "",
"phone_nums": [
{
"phone_id": 75503,
"phone": "012102101210",
"is_del": false
},
{
"phone_id": 75305,
"phone": "0270000999999",
"is_del": false
},
{
"phone_id": 70863,
"phone": "02788880515",
"is_del": false
}
]
}
],
"first_page_url": "https://openapi.icsoc.net/v3/portal/api/phone/group/list?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "https://openapi.icsoc.net/v3/portal/api/phone/group/list?page=1",
"next_page_url": null,
"path": "https://openapi.icsoc.net/v3/portal/api/phone/group/list",
"per_page": 10,
"prev_page_url": null,
"to": 1,
"total": 1
}
}
响应字段说明
参数 | 类型 | 描述 |
---|---|---|
id | int | 号码组 id |
vcc_id | int | 企业id |
group_name | string | 号码组名称 |
phones | string | 号码组中的号码ID多个逗号隔开 |
remark | string | 备注 |
phone_nums | array | 号码组号码详细信息 |
phone_nums字段说明
参数 | 类型 | 描述 |
---|---|---|
phone_id | int | 号码 id |
phone | string | 号码 |
is_del | bool | 号码是否下线 true 下线, false 未下线 |
号码组新增
号码组新增接口
接口地址
POST https:///openapi.icsoc.net/v3/portal/api/phone/group/store
接口参数
传参方式: Content-Type: application/json
参数 | 类型 | 说明 | 必填 |
---|---|---|---|
group_name | string | 号码组名称 不能重复 | 是 |
phones | array | 号码 一个号码只能属于一个号码组,如果传入的号码已经被占用会被过滤,号码可以通过上面 得获取所有号码接口得到 | 是 |
remark | string | 备注 | 否 |
结果编码说明
code | 说明 |
---|---|
0 | ok |
其它 | 具体看message返回信息 |
示例
请求
curl --location --request POST 'https://openapi.icsoc.net/v3/portal/api/phone/group/store' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer 1S3PezP7HM34xJpN9JITugfdCbI4XnygridosnIu' \
--data-raw '{
"group_name": "测试",
"phones": [
"18810512005",
"01088881695"
],
"remark": "cd备注"
}'
响应
{
"code": 0,
"message": "ok",
"data": {
"group_name": "测试",
"phones": "75502,76430",
"remark": "cd备注",
"vcc_id": 782,
"id": 1029
}
}
号码组编辑
号码组编辑接口
接口地址
POST https:///openapi.icsoc.net/v3/portal/api/phone/group/update
接口参数
传参方式: Content-Type: application/json
参数 | 类型 | 说明 | 必填 |
---|---|---|---|
id | int | 号码组 id (列表接口返回得id) | 是 |
group_name | string | 号码组名称 不能重复 | 是 |
phones | array | 号码 一个号码只能属于一个号码组,如果传入的号码已经被占用会被过滤,号码可以通过上面 得获取所有号码接口得到 | 是 |
remark | string | 备注 | 否 |
结果编码说明
code | 说明 |
---|---|
0 | ok |
其它 | 具体看message返回信息 |
示例
请求
curl --location --request POST 'https:///openapi.icsoc.net/v3/portal/api/phone/group/update' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer 1S3PezP7HM34xJpN9JITugfdCbI4XnygridosnIu' \
--data-raw '{
"group_name": "测试更新",
"phones": [
"012102101210",
"02788880515"
],
"id": 1029,
"remark": "fugiat"
}'
响应
{
"code": 0,
"message": "ok",
"data": {
"id": 1029,
"group_name": "测试更新",
"phones": "75503,70863",
"vcc_id": 782,
"remark": "fugiat"
}
}
号码组删除
号码组删除接口
接口地址
POST https:///openapi.icsoc.net/v3/portal/api/phone/group/delete
接口参数
传参方式: Content-Type: application/json
参数 | 类型 | 说明 | 必填 |
---|---|---|---|
ids | string | 号码组ID(列表接口返回得id) 多个逗号隔开 | 是 |
结果编码说明
code | 说明 |
---|---|
0 | ok |
其它 | 具体看message返回信息 |
示例
请求
curl --location --request POST 'https:///openapi.icsoc.net/v3/portal/api/phone/group/delete' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YP6iqELNsyhXcVNJfl07ebDiOfDwqENcdlbD2vYP' \
--data-raw '{
"ids": "1029"
}'
响应
{
"code": 0,
"message": "success",
"request_id": "QPjlLiIQy8uDC5mnDulB81WLnrrDbVoX",
"data": []
}