リクエスト
| ベーシック情報 | |
|---|---|
| HTTP URL | https://oapi.dingtalk.io/chat/get |
| HTTP Method | GET |
| 対応アプリタイプ | appType-社内アプリ |
| 必要な権限 | permission-qyapi_chat_read-DingTalk グループベーシック情報の読み取り権限 |
クエリパラメータ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| access_token | String | はい | 6d1bxxxx | 本インターフェースを呼び出すアプリ認証情報。社内アプリの access_token を取得するインターフェース経由で取得します。 |
| chatid | String | はい | chate39f540dxxxx | グループチャットの ID。 - サーバーサイドのグループチャット作成インターフェースを呼び出して取得した chatid パラメータ値のみサポートします。 - フロントエンド JSAPI 経由で取得した chatid はサポートしません。 |
リクエスト例
curl -X GET "https://oapi.dingtalk.io/chat/get" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=0d7e495xxxxa3f694fd6e' \
-d 'chatid=chatid'
DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.io/chat/get");
OapiChatGetRequest req = new OapiChatGetRequest();
req.setChatid("chate39f540dxxxx");
req.setHttpMethod("GET");
OapiChatGetResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
import dingtalk.api
req=dingtalk.api.OapiChatGetRequest("https://oapi.dingtalk.io/chat/get")
req.chatid="chatid"
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_GET , DingTalkConstant::$FORMAT_JSON);
$req = new OapiChatGetRequest;
$req->setChatid("chatid");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.io/chat/get");
IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.io/chat/get");
OapiChatGetRequest req = new OapiChatGetRequest();
req.Chatid = "chatid";
req.SetHttpMethod("GET");
OapiChatGetResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
レスポンス
レスポンスボディ
| 名前 | タイプ | 例 | 説明 |
|---|---|---|---|
| errcode | Number | 0 | リターンコード。 |
| errmsg | String | ok | リターンコードの説明。 |
| chat_info | ChatInfo | グループチャット情報。 | |
| name | String | 全員グループ | グループ名。 |
| owner | String | manager4220 | グループ作成者の userId。 |
| useridlist | String[] | [“user123”,“manager4220”] | グループメンバーの userId リスト。 |
| conversationTag | Number | 2 | 会話タイプ: - 2: 企業グループ。 |
| chatBannedType | Number | 0 | グループ発言禁止のオン/オフ: - 0 (デフォルト): 発言禁止しない - 1: 全員ミュート |
| searchable | Number | 0 | グループを検索可能にするか: - 0 (デフォルト): 検索不可 - 1: 検索可能 |
| validationType | Number | 0 | グループ参加時に認証が必要か - 0 (デフォルト): 認証なし - 1: 入室認証あり |
| mentionAllAuthority | Number | 0 | @all の使用範囲: - 0 (デフォルト): 全員使用可能 - 1: グループ作成者のみ @all 可能 |
| managementType | Number | 0 | グループ管理タイプ: - 0 (デフォルト): 全員が管理可能 - 1: グループ作成者のみ管理可能 |
| showHistoryType | Number | 0 | 新規メンバーが過去 100 件の履歴チャットを閲覧できるか: - 1: 閲覧可能 - 0: 閲覧不可 値を渡さない場合は、閲覧不可を意味します。 |
| icon | String | @lADPDfJ6Q7LLejDNAljNAlg | グループプロフィール写真の mediaID。 |
| status | Number | 1 | ステータス。 - 1: 正常 - 2: 解散済み |
レスポンスボディ例
{
"errcode":0,
"errmsg":"ok",
"chat_info":{
"owner":"manager4220",
"mentionAllAuthority":0,
"showHistoryType":0,
"chatid":"chate39f540dxxxx",
"conversationTag":2,
"validationType":0,
"useridlist":[
"user123",
"manager4220"
],
"icon":"@lADPDfJ6Q7LLejDNAljNAlg",
"name":"全員グループ",
"searchable":0,
"chatBannedType":0,
"managementType":0
}
}
エラーコード
本インターフェースを呼び出した際にエラーが発生した場合は、エラーメッセージをもとにグローバルエラーコードドキュメントから解決方法を確認してください。| エラーコード (errorcode) | エラーコードの説明 (errmsg) | 解決方法 |
|---|---|---|
| 43007 | 呼び出し権限がありません | 現在のアプリで生成された access_token か確認してください。 |
| 49000 | パラメータ chatid が必要です | chatid を入力してください。 |
| 40001 | 無効な token | access_token が正しいか確認してください。 |
| 70001 | 企業が存在しません | パラメータが正しいか確認してください。 |
| 40016 | 無効な chatid | access_token と chatid が同一の企業のものか確認してください。 |
| -1 | システムビジー | 後で再試行してください。 |