リクエスト
| ベーシック情報 | |
|---|---|
| HTTP URL | https://api.dingtalk.io/topapi/chat/updategroupnick |
| HTTP Method | POST |
| 対応アプリタイプ | appType-社内アプリ |
| 必要な権限 | permission-qyapi_chat_manage-DingTalk グループのベーシック情報管理権限 |
クエリパラメータ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| access_token | String | はい | beE3xxxx | この API を呼び出すためのアプリ認証情報。社内アプリの access_token 取得 API から取得します。 |
リクエストボディ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| userid | String | はい | user123 | グループ名を変更するグループメンバーの userId。グループ情報の取得 API でグループメンバーの userId を取得できます。 |
| chatid | String | はい | chate3929fxxxx | グループチャット ID。グループ作成 API から chatid パラメータの値を取得できます。 |
| group_nick | String | はい | DingTalk 太郎 | 当該メンバーのグループ内での名前。 |
リクエスト例
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("DingTalk 太郎");
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"
}
エラーコード
この API の呼び出しでエラーが発生した場合は、エラーメッセージをもとに グローバルエラーコード ドキュメントから解決方法を検索してください。| エラーコード(errorcode) | エラーコードの説明(errmsg) | 解決方法 |
|---|---|---|
| 40003 | 無効な userid | userid が正しく入力されているか確認してください |
| 34001 | 無効な chatid | chatid が正しいか確認してください |
| 41049 | 禁止コンテンツを含んでいます | 入力した名前を修正してください |
| 60124 | ユーザーが該当グループに所属していません | グループ内のユーザーを更新してください |
| 400002 | パラメータエラー | 上記の入力パラメータの要件に従って入力されているか確認してください |
| 400001 | システムエラー | 後で再試行してください |