1.1 获取红黑名单列表
1.2 调用方式
POST
1.3 传入参数
非必填参数,调用接口时请传递参数名,参数值可为空
序号 | 名称 | 类型 | 是否必填 | 说明 |
---|---|---|---|---|
1 | page | int | 是 | 当前页 |
2 | size | int | 是 | 每页大小 |
3 | numType | int | 否 | 号码类型 :0呼入黑名单、1呼出黑名单、2红名单 |
1.4 回应参数
序号 | 名称 | 类型 | 是否必填 | 说明 |
---|---|---|---|---|
1 | errcode | int | 是 | 状态码:0成功,及其他非0错误码,详见错误码列表 |
2 | errmsg | String | 否 | 响应消息 |
3 | data | Object数组 | 是 | 结果集 |
3.1 | total | int | 是 | 总页数 |
3.2 | pages | int | 是 | 当前页 |
3.3 | size | int | 是 | 页大小 |
3.4 | records | array[] | 是 | 红黑名单列表 |
3.4.1 | id | String | 是 | 红黑名单记录编号 |
3.4.2 | numType | int | 是 | 号码类型 :0呼入黑名单、1呼出黑名单、2红名单 |
3.4.3 | number | String | 是 | 号码 |
3.4.4 | recDesc | String | 是 | 描述 |
3.4.5 | updatedAt | String | 是 | 修改时间,日期格式:yyyy-MM-dd HH:mm:ss。例如:2023-10-15 09:40:44 |
1.5 使用样例
调用:
url:https://ykf.uincall.com/openapi/sys/set/redblack/list?tenant_id=acf528a2-d0e2-4a7b-xxxx-74cb3995cfab&access_token=3da962c8d89c6271a3181abbd131d786
POST数据:
{
"page": 1,
"size": 10,
"numType": 0
}
响应:
{
"errcode": 0,
"errmsg": "success",
"data": {
"total": 17,
"pages": 2,
"size": 10,
"records": [
{
"id": "26ab42ff7d473866cec38513714e16af",
"numType": 0,
"number": "13700000000",
"recDesc": "13700000000",
"updatedAt": "2023-10-15 09:40:59"
},
{
"id": "b0c4aa06cc160c646542f045aede912f",
"numType": 0,
"number": "13700000001",
"recDesc": "13700000001",
"updatedAt": "2023-10-15 09:40:44"
}
]
}
}
文档更新时间: 2025-10-16 10:23 作者:admin