请求
| 基本信息 | |
|---|---|
| HTTP URL | https://api.dingtalk.io/topapi/chat/updategroupnick |
| HTTP Method | POST |
| 支持的应用类型 | appType-企业内部应用 |
| 权限要求 | permission-qyapi_chat_manage-钉钉群基础信息管理权限 |
查询参数
| 名称 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| access_token | String | 是 | beE3xxxx | 调用该接口的应用凭证,通过获取企业内部应用的access_token接口获取。 |
请求体
| 名称 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
| userid | String | 是 | user123 | 要更改群昵称的群成员userId,可通过查询群信息接口获取群成员userId。 |
| chatid | String | 是 | chate3929fxxxx | 群会话ID,可通过创建群接口获取chatid参数值。 |
| group_nick | String | 是 | 钉钉小二 | 该成员在群中的昵称。 |
请求示例
curl -X POST "https://api.dingtalk.io/topapi/chat/updategroupnick" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=61a72xxxx8d62' \
-d 'chatid=0' \
-d 'group_nick=nick' \
-d 'userid=0'
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/chat/updategroupnick");
OapiChatUpdategroupnickRequest req = new OapiChatUpdategroupnickRequest();
req.setUserid("user123");
req.setChatid("chate39f540d572b71cf97a556d95929fxxxx");
req.setGroupNick("钉钉小二");
OapiChatUpdategroupnickResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
import dingtalk.api
req=dingtalk.api.OapiChatUpdategroupnickRequest("https://api.dingtalk.io/topapi/chat/updategroupnick")
req.userid="0"
req.chatid="0"
req.group_nick="nick"
try:
resp= req.getResponse(access_token)
print(resp)
except Exception,e:
print(e)
include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');
$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_OAPI, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new OapiChatUpdategroupnickRequest;
$req->setUserid("0");
$req->setChatid("0");
$req->setGroupNick("nick");
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/chat/updategroupnick");
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/chat/updategroupnick");
OapiChatUpdategroupnickRequest req = new OapiChatUpdategroupnickRequest();
req.Userid = "0";
req.Chatid = "0";
req.GroupNick = "nick";
OapiChatUpdategroupnickResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
响应
响应体
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| errcode | Number | 0 | 返回码。 |
| errmsg | String | ok | 返回码描述。 |
| success | Boolean | true | 操作是否成功。 - true:成功 - false:失败 |
| request_id | String | id1aatxt9mco | 请求ID。 |
响应体示例
{
"errcode": 0,
"errmsg": "ok",
"success": true,
"request_id": "id1aatxt9mco"
}
错误码
若调用该接口报错,可根据错误信息在全局错误码文档中查找解决方案。| 错误码(errorcode) | 错误码描述(errmsg) | 解决方案 |
|---|---|---|
| 40003 | 无效的userid | 请确认userid是否填写正确 |
| 34001 | 无效的chatid | 请确认chatid是否正确 |
| 41049 | 包含违禁内容 | 请修改输入的昵称 |
| 60124 | 用户不在对应的群内 | 请更新群内的用户 |
| 400002 | 参数错误 | 请检查参数是否按上述入参要求填写 |
| 400001 | 系统错误 | 请稍后再试 |