钉钉设置¶
说明¶
- 管理渠道设置中默认的钉钉渠道,用于通知管理中通知渠道参数选择的默认值
1、钉钉列表、新增钉钉、批量删除钉钉 API¶
请求方式: GET(查询) POST(新增) DELETE(批量删除)
请求地址: /api/notification/dingtalk/
Content-Type:
新增数据的时候需要指定Content-Type,以下对Content-Type进行说明:
application/x-www-form-urlencoded —— 表示通过表单方式提交
application/json —— 表示传入数据为json格式字符串
查询参数:
参数 | 数据类型 | 是否必须 | 说明 |
offset | int | 否 | 数据起始位置 |
limit | int | 否 | 查询条数 |
name | string | 否 | 钉钉名称 |
输入参数(新增):
参数 | 数据类型 | 是否必须 | 说明 |
agent_id | string | 是 | AgentId |
corpid | string | 是 | CorpId |
corpsecret | string | 是 | CorpSecret |
输出参数:
参数 | 数据类型 | 是否必须 | 说明 |
id | int | 是 | 钉钉id |
agent_id | string | 是 | AgentId |
corpid | string | 是 | CorpId |
corpsecret | string | 是 | CorpSecret |
批量删除参数:
参数 | 数据类型 | 是否必须 | 说明 |
pk | string | 与pk[]不能都为空 | 主键,多个主键用半角逗号隔开。通过http body传入 |
pk[] | array | 与pk不能都为空 | 主键数组。通过http body传入 |
排序:
参数 | 数据类型 | 是否必须 | 说明 |
ordering | string | 否 |
|
GET返回数据例子:
{
"count": 2,
"next": null,
"previous": null,
"results": [
{
"id": 4,
"agent_id": "189191807",
"corpid": "dingaenuaiz5naursp3h",
"corpsecret": "Ys3yX5TkOFUgveiVYAMDYi33G5RbJmcGuh17HJ1RuaPuivYlEScXB-m3aoNru7",
"name": "Alex钉钉账号"
},
{
"id": 1,
"agent_id": "123456",
"corpid": "123",
"corpsecret": "123456",
"name": "test dingtalk"
}
]
}
新增钉钉返回数据例子:
{
"id": 1,
"agent_id": "123456",
"corpid": "123",
"corpsecret": "123456",
"name": "test dingtalk"
}
2、获取单个钉钉,修改钉钉、删除钉钉 API¶
请求方式: GET(查询) PUT(修改) PATCH(修改) DELETE(删除)
请求地址: /api/notification/dingtalk/1/
请求地址中1为钉钉的id
输入/输出参数: 见章节1中输入和输出参数说明,修改数据时输入参数均为非必须
返回数据例子:
{
"id": 1,
"agent_id": "123456",
"corpid": "123",
"corpsecret": "123456",
"name": "test dingtalk"
}