Permintaan
| Informasi dasar | |
|---|---|
| URL HTTP | https://oapi.dingtalk.io/chat/get |
| Metode HTTP | GET |
| Tipe aplikasi yang didukung | appType-Aplikasi internal |
| Izin yang diperlukan | permission-qyapi_chat_read-Izin baca untuk informasi dasar grup DingTalk |
Parameter kueri
| Nama | Tipe | Wajib | Contoh | Deskripsi |
|---|---|---|---|---|
| access_token | String | Ya | 6d1bxxxx | Kredensial aplikasi yang digunakan untuk memanggil API ini. Dapatkan melalui API untuk memperoleh access_token dari aplikasi internal. |
| chatid | String | Ya | chate39f540dxxxx | ID obrolan grup. - Hanya mendukung chatid yang dikembalikan oleh API Buat obrolan grup Sisi server. - Tidak mendukung chatid yang diperoleh dengan memanggil JSAPI frontend. |
Contoh permintaan
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);
Respons
Isi respons
| Nama | Tipe | Contoh | Deskripsi |
|---|---|---|---|
| errcode | Number | 0 | Kode pengembalian. |
| errmsg | String | ok | Deskripsi kode pengembalian. |
| chat_info | ChatInfo | Informasi obrolan grup. | |
| name | String | Obrolan Seluruh Staf | Nama grup. |
| owner | String | manager4220 | userId pemilik grup. |
| useridlist | String[] | [“user123”,“manager4220”] | Daftar userId anggota grup. |
| conversationTag | Number | 2 | Tipe percakapan: - 2: Grup organisasi. |
| chatBannedType | Number | 0 | Apakah Bisukan anggota diaktifkan untuk grup: - 0 (default): Tidak dibisukan. - 1: Bisukan Semua. |
| searchable | Number | 0 | Apakah grup dapat dicari: - 0 (default): Tidak dapat dicari. - 1: Dapat dicari. |
| validationType | Number | 0 | Apakah verifikasi diperlukan untuk bergabung ke grup: - 0 (default): Tanpa verifikasi. - 1: Verifikasi diperlukan. |
| mentionAllAuthority | Number | 0 | Cakupan @all: - 0 (default): Tersedia untuk semua orang. - 1: Hanya pemilik grup yang dapat menggunakan @all. |
| managementType | Number | 0 | Tipe pengelolaan grup: - 0 (default): Semua orang dapat mengelola. - 1: Hanya pemilik grup yang dapat mengelola. |
| showHistoryType | Number | 0 | Apakah anggota baru dapat melihat 100 obrolan historis terakhir: - 1: Dapat melihat. - 0: Tidak dapat melihat. Jika tidak ada nilai yang diteruskan, anggota baru tidak dapat melihat. |
| icon | String | @lADPDfJ6Q7LLejDNAljNAlg | mediaID dari Foto Profil grup. |
| status | Number | 1 | Status. - 1: Normal. - 2: Dibubarkan. |
Contoh isi respons
{
"errcode":0,
"errmsg":"ok",
"chat_info":{
"owner":"manager4220",
"mentionAllAuthority":0,
"showHistoryType":0,
"chatid":"chate39f540dxxxx",
"conversationTag":2,
"validationType":0,
"useridlist":[
"user123",
"manager4220"
],
"icon":"@lADPDfJ6Q7LLejDNAljNAlg",
"name":"Obrolan Seluruh Staf",
"searchable":0,
"chatBannedType":0,
"managementType":0
}
}
Kode error
Jika terjadi error saat memanggil API ini, temukan solusinya di dokumen Kode error global berdasarkan pesan error.| Kode error (errorcode) | Pesan error (errmsg) | Solusi |
|---|---|---|
| 43007 | No permission to call this API. | Konfirmasi apakah access_token dihasilkan oleh Aplikasi saat ini. |
| 49000 | The chatid parameter is required. | Sediakan chatid. |
| 40001 | Invalid token. | Konfirmasi apakah access_token sudah benar. |
| 70001 | The organization does not exist. | Konfirmasi apakah parameter sudah benar. |
| 40016 | Invalid chatid. | Konfirmasi bahwa access_token dan chatid berada dalam Organisasi yang sama. |
| -1 | System busy. | Coba lagi nanti. |