Deskripsi panggilan API
- API ini dirancang untuk notifikasi kerja OA dan memperbarui status persetujuan secara real-time.
- API ini hanya dapat memperbarui status bar notifikasi kerja yang dikirim dalam 7 hari terakhir.
Permintaan
| Informasi dasar | |
|---|---|
| URL HTTP | https://api.dingtalk.io/topapi/message/corpconversation/status_bar/update |
| Metode HTTP | POST |
| Tipe aplikasi yang didukung | appType-Aplikasi internalappType-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 | 123 | AgentId 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 | 11 | ID tugas notifikasi kerja. Dapatkan nilai task_id dengan memanggil API Kirim notifikasi kerja. |
| status_value | String | Ya | Accepted | Nilai status bar. |
| status_bg | String | Tidak | 0xFF78C06E | Warna latar belakang status bar. Kami menyarankan format 0xFF diikuti dengan nilai warna enam digit. |
Contoh permintaan
curl -X POST "https://api.dingtalk.io/topapi/message/corpconversation/status_bar/update" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=e4bbxxxxe7683' \
-d 'agent_id=123' \
-d 'status_bg=0xFFF65E5E' \
-d 'status_value=Completed' \
-d 'task_id=1111'
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/message/corpconversation/status_bar/update");
OapiMessageCorpconversationStatusBarUpdateRequest req = new OapiMessageCorpconversationStatusBarUpdateRequest();
req.setAgentId(123L);
req.setTaskId(1111L);
req.setStatusValue("Completed");
req.setStatusBg("0xFFF65E5E");
OapiMessageCorpconversationStatusBarUpdateResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
import dingtalk.api
req=dingtalk.api.OapiMessageCorpconversationStatusBarUpdateRequest("https://api.dingtalk.io/topapi/message/corpconversation/status_bar/update")
req.agent_id=123
req.task_id=1111
req.status_value="Completed"
req.status_bg="0xFFF65E5E"
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 OapiMessageCorpconversationStatusBarUpdateRequest;
$req->setAgentId("123");
$req->setTaskId("1111");
$req->setStatusValue("Completed");
$req->setStatusBg("0xFFF65E5E");
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/message/corpconversation/status_bar/update");
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/message/corpconversation/status_bar/update");
OapiMessageCorpconversationStatusBarUpdateRequest req = new OapiMessageCorpconversationStatusBarUpdateRequest();
req.AgentId = 123L;
req.TaskId = 1111L;
req.StatusValue = "Completed";
req.StatusBg = "0xFFF65E5E";
OapiMessageCorpconversationStatusBarUpdateResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
Respons
Isi respons
| Nama | Tipe | Contoh | Deskripsi |
|---|---|---|---|
| request_id | String | 4jzllmte0wau | ID permintaan. |
| errmsg | String | ok | Deskripsi kode pengembalian. |
| errcode | Number | 0 | Kode pengembalian. |
Contoh isi respons
{
"request_id":"4jzllmte0wau"
"errcode":0,
"errmsg":"ok",
}
Kode error
Jika terjadi error saat Anda memanggil API ini, cari pesan error pada dokumen Kode error global untuk menemukan solusinya.| Kode error (errorcode) | Pesan error (errmsg) | Solusi |
|---|---|---|
| 40056 | Invalid agentid | Pastikan agentId sudah benar. |
| 40035 | Invalid parameter | Pastikan taskId sudah benar. |
| 41052 | Too many recipients in this delivery; sending results will no longer be returned. | - Kurangi jumlah penerima notifikasi kerja. - Periksa apakah notifikasi kerja telah selesai dikirim. Error ini terjadi jika pengiriman masih berlangsung. |
| 500 | System error | Terjadi error sistem yang tidak diketahui. |