2.6 黑名单管理
2.6.1 呼入黑名单-批量创建
基本信息
Path: /api/v1/config/openapi/black/in/batchCreate/v2
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
Content-Type | application/json | 是 | ||
token | ImixBz8ebhRDCmBKaq70jHMjU3xt1Pkai9SAsOFjN2z6RpX8cTPr1/gEFkssjRFY | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
abbreviate | string | 必须 | 企业缩写 | ||
blacknums | string [] | 必须 | 黑名单列表 | item 类型: string | |
├─ | |||||
companyId | integer | 非必须 | 企业id | ||
endtime | integer | 必须 | 生效结束时间(秒级别) | ||
remarks | string | 非必须 | |||
starttime | integer | 必须 | 生效开始时间(秒级别) |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
code | integer | 必须 | 返回码 | ||
msg | string | 必须 | 返回说明 |
2.6.2 呼入黑名单-批量删除
基本信息
Path: /api/v1/config/openapi/black/in/batchDel/v2
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
Content-Type | application/json | 是 | ||
token | ImixBz8ebhRDCmBKaq70jHMjU3xt1Pkai9SAsOFjN2z6RpX8cTPr1/gEFkssjRFY | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
abbreviate | string | 必须 | 企业缩写 | ||
blacknums | string [] | 必须 | 黑名单号码 | item 类型: string | |
├─ | 非必须 | ||||
companyId | integer | 非必须 | 企业id |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
code | integer | 必须 | 返回码 | ||
msg | string | 必须 | 返回说明 |
2.6.3 呼入黑名单-修改
基本信息
Path: /api/v1/config/openapi/black/in/edit/v2
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
Content-Type | application/json | 是 | ||
token | ImixBz8ebhRDCmBKaq70jHMjU3xt1Pkai9SAsOFjN2z6RpX8cTPr1/gEFkssjRFY | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
abbreviate | string | 必须 | 企业缩写 | ||
blacknum | string | 必须 | 黑名单号码 | ||
companyId | integer | 非必须 | 企业id | ||
endtime | integer | 非必须 | 生效结束时间(秒级别) | ||
remarks | string | 非必须 | |||
starttime | integer | 非必须 | 生效开始时间(秒级别) |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
code | integer | 必须 | 返回码 | ||
msg | string | 必须 | 返回说明 |
2.6.4 呼入黑名单-详情
基本信息
Path: /api/v1/config/openapi/black/in/one/v2
Method: POST
接口描述:
查看呼入黑名单
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
Content-Type | application/json | 是 | ||
token | ImixBz8ebhRDCmBKaq70jHMjU3xt1Pkai9SAsOFjN2z6RpX8cTPr1/gEFkssjRFY | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
abbreviate | string | 必须 | 企业缩写 | ||
blacknum | string | 必须 | 黑名单号码 | ||
companyId | integer | 非必须 | 企业id |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
msg | string | 必须 | 返回消息 | ||
code | integer | 必须 | 返回码 | ||
data | object | 非必须 | 数据 | ||
├─ id | integer | 非必须 | 黑名单id | ||
├─ companyId | integer | 非必须 | 企业id | ||
├─ blacknum | string | 非必须 | 号码 | ||
├─ starttime | integer | 非必须 | 生效开始时间 | ||
├─ endtime | integer | 非必须 | 生效结束时间 | ||
├─ remarks | string | 非必须 | |||
├─ status | integer | 非必须 | 是否生效,1生效,0未生效 | ||
├─ types | integer | 非必须 | 类型:1永久,2当日,3时间段, | ||
├─ ctime | integer | 非必须 | 创建时间(秒级别) | ||
├─ utime | integer | 非必须 | 修改时间(秒级别) |
2.6.5 呼入黑名单-详情分页
基本信息
Path: /api/v1/config/openapi/black/in/findPage/v2
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
Content-Type | application/json | 是 | ||
token | ImixBz8ebhRDCmBKaq70jHMjU3xt1Pkai9SAsOFjN2z6RpX8cTPr1/gEFkssjRFY | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
abbreviate | string | 必须 | 企业缩写 | ||
companyId | integer | 非必须 | 企业id | ||
pageNumber | integer | 非必须 | 1 | 页数 | 最小值: 1 |
pageSize | integer | 非必须 | 10 | 页大小 | 最大值: 100 最小值: 10 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
msg | string | 必须 | 返回消息 | ||
code | integer | 必须 | 返回码 | ||
data | object | 非必须 | |||
├─ result | object [] | 非必须 | item 类型: object | ||
result├─ id | integer | 非必须 | 黑名单id | ||
result├─ companyId | integer | 非必须 | 企业id | ||
result├─ blacknum | string | 非必须 | 黑名单号码 | ||
result├─ starttime | integer | 非必须 | 生效开始时间(秒级别) | ||
result├─ endtime | integer | 非必须 | 生效结束时间(秒级别) | ||
result├─ remarks | string | 非必须 | 备注 | ||
result├─ status | integer | 非必须 | 是否生效,1生效,0未生效 | ||
result├─ types | integer | 非必须 | 类型:1永久,2当日,3时间段, | ||
result├─ ctime | integer | 非必须 | 开始时间(秒级别) | ||
result├─ utime | integer | 非必须 | 结束时间(秒级别) | ||
├─ pageSize | integer | 非必须 | 页大小 | ||
├─ total | integer | 非必须 | 总记录数 | ||
├─ pageNumber | integer | 非必须 | 页数 | ||
├─ pageTotal | integer | 非必须 | 总页数 |
2.6.6 呼出黑名单-批量创建
基本信息
Path: /api/v1/config/openapi/black/out/batchCreate/v2
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
Content-Type | application/json | 是 | ||
token | ImixBz8ebhRDCmBKaq70jHMjU3xt1Pkai9SAsOFjN2z6RpX8cTPr1/gEFkssjRFY | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
abbreviate | string | 必须 | 企业缩写 | ||
blacknums | string [] | 必须 | 黑名单列表 | item 类型: string | |
├─ | 非必须 | ||||
companyId | integer | 非必须 | 企业id | ||
endtime | integer | 必须 | 生效结束时间(秒级别) | ||
remarks | string | 非必须 | |||
starttime | integer | 必须 | 生效开始时间(秒级别) |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
code | integer | 必须 | 返回码 | ||
msg | string | 必须 | 返回说明 |
2.6.7 呼出黑名单-批量删除
基本信息
Path: /api/v1/config/openapi/black/out/batchDel/v2
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
Content-Type | application/json | 是 | ||
token | ImixBz8ebhRDCmBKaq70jHMjU3xt1Pkai9SAsOFjN2z6RpX8cTPr1/gEFkssjRFY | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
abbreviate | string | 必须 | 企业缩写 | ||
blacknums | string [] | 必须 | 黑名单号码 | item 类型: string | |
├─ | 非必须 | ||||
companyId | integer | 非必须 | 企业id |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
code | integer | 必须 | 返回码 | ||
msg | string | 必须 | 返回说明 |
2.6.8 呼出黑名单-修改
基本信息
Path: /api/v1/config/openapi/black/out/edit/v2
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
Content-Type | application/json | 是 | ||
token | ImixBz8ebhRDCmBKaq70jHMjU3xt1Pkai9SAsOFjN2z6RpX8cTPr1/gEFkssjRFY | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
abbreviate | string | 必须 | 企业缩写 | ||
blacknum | string | 必须 | 黑名单号码 | ||
companyId | integer | 非必须 | 企业id | ||
endtime | integer | 非必须 | 生效结束时间(秒级别) | ||
remarks | string | 非必须 | 备注 | ||
starttime | integer | 非必须 | 生效开始时间(秒级别) |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
code | integer | 必须 | 返回码 | ||
msg | string | 必须 | 返回说明 |
2.6.9 呼出黑名单-详情
基本信息
Path: /api/v1/config/openapi/black/out/one/v2
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
Content-Type | application/json | 是 | ||
token | ImixBz8ebhRDCmBKaq70jHMjU3xt1Pkai9SAsOFjN2z6RpX8cTPr1/gEFkssjRFY | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
abbreviate | string | 必须 | 企业缩写 | ||
blacknum | string | 必须 | 黑名单号码 | ||
companyId | integer | 非必须 | 企业id |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
msg | string | 必须 | 返回消息 | ||
code | integer | 必须 | 返回码 | ||
data | object | 非必须 | 数据 | ||
├─ id | integer | 非必须 | 黑名单id | ||
├─ companyId | integer | 非必须 | 企业id | ||
├─ blacknum | string | 非必须 | 号码 | ||
├─ starttime | integer | 非必须 | 生效开始时间(秒级别) | ||
├─ endtime | integer | 非必须 | 生效结束时间(秒级别) | ||
├─ remarks | string | 非必须 | |||
├─ status | integer | 非必须 | 是否生效,1生效,0未生效 | ||
├─ types | integer | 非必须 | 类型:1永久,2当日,3时间段, | ||
├─ ctime | integer | 非必须 | 创建时间(秒级别) | ||
├─ utime | integer | 非必须 | 修改时间(秒级别) |
2.6.10 呼出黑名单-详情分页
基本信息
Path: /api/v1/config/openapi/black/out/findPage/v2
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
Content-Type | application/json | 是 | ||
token | ImixBz8ebhRDCmBKaq70jHMjU3xt1Pkai9SAsOFjN2z6RpX8cTPr1/gEFkssjRFY | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
abbreviate | string | 必须 | 企业缩写 | ||
companyId | integer | 非必须 | 企业id | ||
pageNumber | integer | 非必须 | 1 | 页数 | 最小值: 1 |
pageSize | integer | 非必须 | 10 | 页大小 | 最大值: 100 最小值: 10 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
msg | string | 必须 | 返回消息 | ||
code | integer | 必须 | 返回码 | ||
data | object | 非必须 | |||
├─ result | object [] | 非必须 | item 类型: object | ||
result├─ id | integer | 非必须 | 黑名单id | ||
result├─ companyId | integer | 非必须 | 企业id | ||
result├─ blacknum | string | 非必须 | 黑名单号码 | ||
result├─ starttime | integer | 非必须 | 生效开始时间(秒级别) | ||
result├─ endtime | integer | 非必须 | 生效结束时间(秒级别) | ||
result├─ remarks | string | 非必须 | 备注 | ||
result├─ status | integer | 非必须 | 是否生效,1生效,0未生效 | ||
result├─ types | integer | 非必须 | 类型:1永久,2当日,3时间段, | ||
result├─ ctime | integer | 非必须 | 开始时间(秒级别) | ||
result├─ utime | integer | 非必须 | 结束时间(秒级别) | ||
├─ pageSize | integer | 非必须 | 页大小 | ||
├─ total | integer | 非必须 | 总记录数 | ||
├─ pageNumber | integer | 非必须 | 页数 | ||
├─ pageTotal | integer | 非必须 | 页大小 |
2.6.11 呼出黑名单-批量企业批量创建
基本信息
Path: /api/v1/config/openapi/black/out/batchCompanyCreate
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
Content-Type | application/json | 是 | ||
token | ImixBz8ebhRDCmBKaq70jHMjU3xt1Pkai9SAsOFjN2z6RpX8cTPr1/gEFkssjRFY | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
blacknums | string [] | 必须 | 黑名单号码 | item 类型: string | |
├─ | 非必须 | ||||
companyIds | integer [] | 必须 | 企业列表 | item 类型: integer | |
├─ | 非必须 | ||||
endtime | integer | 必须 | 生效结束时间(秒级别) | ||
remarks | string | 非必须 | |||
starttime | integer | 必须 | 生效开始时间(秒级别) |
ABCDEF
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
code | integer | 必须 | 返回码 | ||
msg | string | 必须 | 返回说明 |
2.6.12 呼出黑名单-批量企业批量删除
基本信息
Path: /api/v1/config/openapi/black/out/batchCompanyDel
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
Content-Type | application/json | 是 | ||
token | ImixBz8ebhRDCmBKaq70jHMjU3xt1Pkai9SAsOFjN2z6RpX8cTPr1/gEFkssjRFY | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
blacknums | string [] | 必须 | 黑名单号码 | item 类型: string | |
├─ | 非必须 | ||||
companyIds | integer [] | 必须 | 企业id列表 | item 类型: integer | |
├─ | 非必须 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
code | integer | 必须 | 返回码 | ||
msg | string | 必须 | 返回说明 |
2.6.13 任务呼出黑名单-批量创建
基本信息
Path: /api/v1/config/openapi/black/task/batchCreate/v2
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
Content-Type | application/json | 是 | ||
token | ImixBz8ebhRDCmBKaq70jHMjU3xt1Pkai9SAsOFjN2z6RpX8cTPr1/gEFkssjRFY | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
abbreviate | string | 必须 | 企业缩写 | ||
blacknums | string [] | 必须 | 黑名单号码 | item 类型: string | |
├─ | 非必须 | ||||
companyId | integer | 非必须 | 企业id | ||
taskId | integer | 必须 | 任务id | ||
time | integer | 必须 | 过期时间 60-86400秒 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
code | integer | 必须 | 返回码 | ||
msg | string | 必须 | 返回说明 |
2.6.14 任务呼出黑名单-批量删除
基本信息
Path: /api/v1/config/openapi/black/task/batchDel/v2
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
Content-Type | application/json | 是 | ||
token | ImixBz8ebhRDCmBKaq70jHMjU3xt1Pkai9SAsOFjN2z6RpX8cTPr1/gEFkssjRFY | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
abbreviate | string | 必须 | 企业缩写 | ||
blacknums | string [] | 必须 | 黑名单号码 | item 类型: string | |
├─ | 非必须 | ||||
companyId | integer | 非必须 | 企业id | ||
taskId | integer | 必须 | 任务id |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
code | integer | 必须 | 返回码 | ||
msg | string | 必须 | 返回说明 |