获取推荐接收人或接收组。
请求说明
- 请求方式：POST
- 请求地址：https://open.volcengineapi.com?Action=PCGroupCandidate&Version=2022-10-28
ServiceName : apmplus_openapi
Region : cn-beijing
X-App-Ids : xxx
Content-Type : application/json
请求参数
Query
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| Action | String | 是 | PCGroupCandidate | 接口名称。当前 API 的名称为 PCGroupCandidate。 |
| Version | String | 是 | 2022-10-28 | 接口版本。当前 API 的版本为 2022-10-28。 |
Body
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| os | String | 否 | pc | 服务类型。 |
| keyword | String | 否 | group | 搜索关键词。 |
返回参数
| 参数 | 类型 | 示例值 | 描述 |
|---|
| data | Array of Candidate | - | 推荐列表。 |
| error_msg | String | "" | 错误信息。 |
| error_no | Long | 200 | 错误码。 |
Candidate
| 参数 | 类型 | 示例值 | 描述 |
|---|
| email | String | zhangshan@example.com | 邮箱名。 |
| group_id | Integer | 123 | 接收组ID。 |
| is_group | Boolean | true | 是否为接受组。 |
| user_name | String | zhangshan | 单个用户用户名。 |
| group_name | String | bug修复 | 群组接收组名称。 |
请求示例
POST https://open.volcengineapi.com?Action=PCGroupCandidate&Version=2022-10-28
{
"keyword": "group",
"os": "pc"
}
返回示例
{
"data": [
{
"email": "zhangshan@example.com",
"group_id": 123,
"is_group": true,
"user_name": "zhangshan",
"group_name": "group123"
}
],
"error_msg": "",
"error_no": 200
}
错误码
本接口无特有的错误码。更多信息请参见错误码。