Deskripsi panggilan API
API ini hanya mengembalikan progres pengiriman notifikasi kerja yang dikirim dalam 7 hari terakhir.Permintaan
| Informasi dasar | |
|---|---|
| URL HTTP | https://api.dingtalk.io/topapi/message/corpconversation/getsendprogress |
| Metode HTTP | POST |
| Tipe aplikasi yang didukung | appType-Aplikasi internal, appType-Aplikasi perusahaan pihak ketiga |
| Izin yang diperlukan | permission-qyapi_base-Izin dasar yang diperlukan untuk memanggil API perusahaan |
Parameter kueri
| Nama | Tipe | Wajib | Contoh | Deskripsi |
|---|---|---|---|---|
| access_token | String | Ya | bE74xxxx | Kredensial aplikasi yang digunakan untuk memanggil API ini. - Untuk aplikasi internal, dapatkan dengan memanggil API untuk mendapatkan access_token aplikasi internal. - Untuk aplikasi perusahaan pihak ketiga, dapatkan dengan memanggil API untuk mendapatkan access_token perusahaan pihak ketiga. |
Isi permintaan
| Nama | Tipe | Wajib | Contoh | Deskripsi |
|---|---|---|---|---|
| agent_id | Number | Ya | 836390886 | Agent ID dari aplikasi mikro yang digunakan untuk mengirim pesan. - Untuk aplikasi internal, lihat pada halaman detail aplikasi di Developer Backend. - Untuk aplikasi perusahaan pihak ketiga, dapatkan dengan memanggil API untuk mendapatkan informasi otorisasi perusahaan. |
| task_id | Number | Ya | 256271667526 | ID tugas yang dikembalikan oleh DingTalk saat pesan dikirim. Panggil API Kirim notifikasi kerja untuk mendapatkan nilai task_id. Catatan Hanya tugas yang dibuat dalam 24 jam terakhir yang dapat dikueri. |
Contoh permintaan
curl -X POST "https://api.dingtalk.io/topapi/message/corpconversation/getsendprogress" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=a0a25xxxxed3ff' \
-d 'agent_id=123' \
-d 'task_id=456'
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/message/corpconversation/getsendprogress");
OapiMessageCorpconversationGetsendprogressRequest req = new OapiMessageCorpconversationGetsendprogressRequest();
req.setAgentId(123L);
req.setTaskId(456L);
OapiMessageCorpconversationGetsendprogressResponse rsp = client.execute(req, accessToken);
System.out.println(rsp.getBody());
import dingtalk.api
req=dingtalk.api.OapiMessageCorpconversationGetsendprogressRequest("https://api.dingtalk.io/topapi/message/corpconversation/getsendprogress")
req.agent_id=123
req.task_id=456
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 OapiMessageCorpconversationGetsendprogressRequest;
$req->setAgentId("123");
$req->setTaskId("456");
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/message/corpconversation/getsendprogress");
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/message/corpconversation/getsendprogress");
OapiMessageCorpconversationGetsendprogressRequest req = new OapiMessageCorpconversationGetsendprogressRequest();
req.AgentId = 123L;
req.TaskId = 456L;
OapiMessageCorpconversationGetsendprogressResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
Respons
Isi respons
| Nama | Tipe | Contoh | Deskripsi |
|---|---|---|---|
| request_id | String | 5y2znla8tw3d | ID permintaan. |
| errcode | Number | 0 | Kode pengembalian. |
| errmsg | String | ok | Deskripsi kode pengembalian. |
| progress | AsyncSendProgress | Hasil yang dikembalikan. | |
| progress_in_percent | Number | 100 | Persentase pemrosesan. Rentang nilai: 0 hingga 100. |
| status | Number | 2 | Status eksekusi tugas: - 0: Belum dimulai - 1: Sedang berlangsung - 2: Selesai |
Contoh respons
{
"errcode": 0,
"errmsg":"ok",
"progress": {
"progress_in_percent": 100,
"status": 2
},
"request_id": "5y2znla8tw3d"
}
Kode error
Jika terjadi error saat Anda memanggil API ini, lihat dokumen Kode error global untuk solusi berdasarkan pesan error.| Kode error (errorcode) | Pesan error (errmsg) | Solusi |
|---|---|---|
| 40035 | Invalid parameter | Verifikasi bahwa task_id atau agent_id sudah benar. |
| 500 | System error | Terjadi error sistem yang tidak diketahui. |