获取 Channel
curl --request GET \
--url https://agent-api.bigmodel.cn/api/agent/forward/v0/channels/{channelId} \
--header 'Authorization: Bearer <token>' \
--header 'zai-beta: <zai-beta>' \
--header 'zai-version: <zai-version>'import requests
url = "https://agent-api.bigmodel.cn/api/agent/forward/v0/channels/{channelId}"
headers = {
"zai-version": "<zai-version>",
"zai-beta": "<zai-beta>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {
'zai-version': '<zai-version>',
'zai-beta': '<zai-beta>',
Authorization: 'Bearer <token>'
}
};
fetch('https://agent-api.bigmodel.cn/api/agent/forward/v0/channels/{channelId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.get("https://agent-api.bigmodel.cn/api/agent/forward/v0/channels/{channelId}")
.header("zai-version", "<zai-version>")
.header("zai-beta", "<zai-beta>")
.header("Authorization", "Bearer <token>")
.asString();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://agent-api.bigmodel.cn/api/agent/forward/v0/channels/{channelId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("zai-version", "<zai-version>")
req.Header.Add("zai-beta", "<zai-beta>")
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://agent-api.bigmodel.cn/api/agent/forward/v0/channels/{channelId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"zai-beta: <zai-beta>",
"zai-version: <zai-version>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"id": "channel_xxx",
"type": "channel",
"channel_type": "feishu",
"name": "Support Feishu channel",
"template": {
"agent": {
"type": "agent",
"id": "agent_xxx",
"version": 3
},
"environment_id": "env_xxx",
"vault_ids": [
"vault_xxx"
],
"file_ids": [
"file_xxx"
],
"memory_stores": []
},
"enabled": true,
"binding_status": "bound",
"connection_status": "connected",
"channel_config": {
"response_options": {
"include_tool_calls": false,
"include_process": false,
"card_output": true
},
"group_prompt_template": null,
"private_memory_store_enabled": false
},
"last_error": null,
"created_at": "2026-09-01T00:00:00.000Z",
"updated_at": "2026-09-01T00:00:00.000Z"
}{
"type": "error",
"error": {
"type": "authentication_error",
"message": "<string>",
"details": {}
},
"request_id": "req_xxx"
}{
"type": "error",
"error": {
"type": "authentication_error",
"message": "<string>",
"details": {}
},
"request_id": "req_xxx"
}Channel
获取 Channel
获取 Channel 的配置、连接状态与最近错误,不回显凭据。
使用说明
使用说明
读取 Channel 的安全结构,包含固定 Agent 版本、共享记忆配置、connection_status、last_error、response_options、private_memory_store_enabled 和 group_prompt_template。凭据不回显;不存在、已删除或属于其他 customer 均返回 404。
GET
/
agent
/
forward
/
v0
/
channels
/
{channelId}
获取 Channel
curl --request GET \
--url https://agent-api.bigmodel.cn/api/agent/forward/v0/channels/{channelId} \
--header 'Authorization: Bearer <token>' \
--header 'zai-beta: <zai-beta>' \
--header 'zai-version: <zai-version>'import requests
url = "https://agent-api.bigmodel.cn/api/agent/forward/v0/channels/{channelId}"
headers = {
"zai-version": "<zai-version>",
"zai-beta": "<zai-beta>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {
'zai-version': '<zai-version>',
'zai-beta': '<zai-beta>',
Authorization: 'Bearer <token>'
}
};
fetch('https://agent-api.bigmodel.cn/api/agent/forward/v0/channels/{channelId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.get("https://agent-api.bigmodel.cn/api/agent/forward/v0/channels/{channelId}")
.header("zai-version", "<zai-version>")
.header("zai-beta", "<zai-beta>")
.header("Authorization", "Bearer <token>")
.asString();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://agent-api.bigmodel.cn/api/agent/forward/v0/channels/{channelId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("zai-version", "<zai-version>")
req.Header.Add("zai-beta", "<zai-beta>")
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://agent-api.bigmodel.cn/api/agent/forward/v0/channels/{channelId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"zai-beta: <zai-beta>",
"zai-version: <zai-version>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"id": "channel_xxx",
"type": "channel",
"channel_type": "feishu",
"name": "Support Feishu channel",
"template": {
"agent": {
"type": "agent",
"id": "agent_xxx",
"version": 3
},
"environment_id": "env_xxx",
"vault_ids": [
"vault_xxx"
],
"file_ids": [
"file_xxx"
],
"memory_stores": []
},
"enabled": true,
"binding_status": "bound",
"connection_status": "connected",
"channel_config": {
"response_options": {
"include_tool_calls": false,
"include_process": false,
"card_output": true
},
"group_prompt_template": null,
"private_memory_store_enabled": false
},
"last_error": null,
"created_at": "2026-09-01T00:00:00.000Z",
"updated_at": "2026-09-01T00:00:00.000Z"
}{
"type": "error",
"error": {
"type": "authentication_error",
"message": "<string>",
"details": {}
},
"request_id": "req_xxx"
}{
"type": "error",
"error": {
"type": "authentication_error",
"message": "<string>",
"details": {}
},
"request_id": "req_xxx"
}Headers
Forward Channel v0 基础协议标识,当前固定为 2026-05-26。
Available options:
2026-05-26 Example:
"2026-05-26"
Channel v0 必须包含 managed-agents-2026-05-26;不要直接替换成 Managed API 推荐的新 Beta 值。多个值用逗号分隔。
Example:
"managed-agents-2026-05-26"
Path Parameters
channelId 资源标识。
Response
请求成功。
Example:
"channel_xxx"
Available options:
channel 当前对外文档开放飞书;微信、企微等渠道近期支持。
Available options:
feishu Example:
"Support Feishu channel"
Show child attributes
Show child attributes
新建 Channel 固定为 true。
Example:
true
Channel 绑定状态。
Example:
"bound"
由取得 listener lease 的 Channel worker 异步推进。
Example:
"connected"
Show child attributes
Show child attributes
Example:
null
创建时间。
更新时间。
Was this page helpful?