# 获取指定平台号列表
请求方式:POST
请求地址:https://$basehost/gateway/qopen/GetPlatformRobotByIds
body参数:
{
"robot_id_list": ["accFNDxF42fxCwwWVWUhBOD", "acc7UirX5VYOmTUu0Dy2wEi"]
}
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| robot_id_list | array | 是 | 平台号id列表,最小长度为1,最大长度为100 |
返回值:
{
"data": {
"robot_list": [
{
"robot_id": "平台号id",
"user_id": "企业微信id",
"name": "姓名",
"real_name": "真实姓名",
"avatar_url": "头像url",
"alias": "别名",
"sex": 0,
"email": "邮箱",
"qrcode": "名片url"
}
]
},
"errcode": 0,
"errmsg": "",
"hint": ""
}
返回说明
| 字段 | 类型 | 说明 |
|---|---|---|
| data | json | json返回值 |
| robot_list | array | 获取到的平台号列表 |
| errcode | int | 状态码,0为正常,非0代表错误 |
| errmsg | string | 错误信息 |
| hint | string | 请求日志ID |
robot_list说明
| 字段 | 类型 | 说明 |
|---|---|---|
| robot_id | string | 平台号id |
| user_id | string | 企业微信id |
| name | string | 姓名 |
| real_name | string | 真实姓名 |
| avatar_url | string | 头像url |
| alias | string | 别名 |
| sex | int | 性别:0=未知,1=男,2=女 |
| string | 邮箱 | |
| qrcode | string | 名片url |
完整请求示例:
curl -X POST \
https://$basehost/gateway/qopen/GetPlatformRobotByIds \
-H 'Content-Type: application/json; charset=UTF-8' \
-H 'Token: c2NdxDHKXIJ5j1zrhJeq2eJEHjh9xxx' \
-d '{
"robot_id_list": ["id1", "id2"],
}'