You need to enable JavaScript to run this app.
导航
PCGroupCandidate
最近更新时间:2024.06.18 17:13:08首次发布时间:2022.11.15 20:38:47

调用PCGroupCandidate接口获取推荐接收人或接收组。

请求说明

  • 请求方式: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

参数类型是否必选示例值描述
ActionStringPCGroupCandidate接口名称。当前 API 的名称为 PCGroupCandidate
VersionString2022-10-28接口版本。当前 API 的版本为 2022-10-28

Body

参数类型是否必选示例值描述
osStringpc服务类型。
keywordStringgroup搜索关键词。

返回参数

参数类型示例值描述
dataArray of Candidate-推荐列表。
error_msgString""错误信息。
error_noLong200错误码。

Candidate

参数类型示例值描述
emailStringzhangshan@example.com邮箱名。
group_idInteger123接收组ID。
is_groupBooleantrue是否为接受组。
user_nameStringzhangshan单个用户用户名。
group_nameStringbug修复群组接收组名称。

请求示例

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
}

错误码

本接口无特有的错误码。更多信息请参见错误码