リクエスト
| ベーシック情報 | |
|---|---|
| HTTP URL | https://api.dingtalk.io/topapi/chat/member/friendswitch/update |
| HTTP Method | POST |
| 対応アプリタイプ | appType-社内アプリ |
| 必要な権限 | permission-qyapi_chat_manage-DingTalk グループのベーシック情報管理権限 |
クエリパラメータ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| access_token | String | はい | 6d1bxxxx | 本 API を呼び出すためのアプリ認証情報です。社内アプリの access_token 取得 API から取得します。 |
リクエストボディ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| chatid | String | はい | chatdafe234xxxx | 企業チャット ID。以下の方法で取得できます。 - サーバーサイドのグループ作成 API を呼び出して chatid パラメータの値を取得します。 - クライアントサイドの chooseChat を呼び出して chatId パラメータの値を取得します。 |
| is_prohibit | Boolean | はい | true | 禁止スイッチをオンにするかどうか。 - true:禁止スイッチをオン - false:禁止スイッチを閉じる |
リクエスト例
curl -X POST "https://api.dingtalk.io/topapi/chat/member/friendswitch/update" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=774fdexxxx4bdd68c' \
-d 'chatid=chatdafe234sdf3sdf' \
-d 'is_prohibit=true'
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/chat/member/friendswitch/update");
OapiChatMemberFriendswitchUpdateRequest req = new OapiChatMemberFriendswitchUpdateRequest();
req.setChatid("chatdafe234xxxx");
req.setIsProhibit(true);
OapiChatMemberFriendswitchUpdateResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
import dingtalk.api
req=dingtalk.api.OapiChatMemberFriendswitchUpdateRequest("https://api.dingtalk.io/topapi/chat/member/friendswitch/update")
req.chatid="chatdafe234sdf3sdf"
req.is_prohibit=true
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 OapiChatMemberFriendswitchUpdateRequest;
$req->setChatid("chatdafe234sdf3sdf");
$req->setIsProhibit("true");
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/chat/member/friendswitch/update");
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/chat/member/friendswitch/update");
OapiChatMemberFriendswitchUpdateRequest req = new OapiChatMemberFriendswitchUpdateRequest();
req.Chatid = "chatdafe234sdf3sdf";
req.IsProhibit = true;
OapiChatMemberFriendswitchUpdateResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
レスポンス
レスポンスボディ
| 名前 | タイプ | 例 | 説明 |
|---|---|---|---|
| success | Boolean | true | 設定が成功したかどうか。 - true:成功 - false:失敗 |
| errcode | Number | 0 | リターンコード。 |
| errmsg | String | ok | リターンコードの説明。 |
| request_id | String | 10c0wc48i6qzz | リクエスト ID。 |
レスポンスボディの例
{
"success":true,
"errcode":0,
"errmsg":"ok",
"request_id":"10c0wc48i6qzz"
}
エラーコード
本 API の呼び出しでエラーが発生した場合、エラーメッセージをもとに グローバルエラーコード ドキュメントで解決方法を検索してください。| エラーコード(errorcode) | エラーコードの説明(errmsg) | 解決方法 |
|---|---|---|
| 34001 | 無効な chatid | chatid が要件を満たしているか確認してください |
| 40036 | パラメータが空 | 必須パラメータがすべて入力されているか確認してください |
| 400001 | システムエラー | 後で再試行してください |