测试 GitHub 消息渠道¶
接口用途¶
测试 GitHub 消息渠道连接是否可用。
请求方式¶
POST
接口地址¶
https://moi.matrixorigin.cn/newmoi/workspaces/<workspace_id>/channels/github/instances/<instance_id>/test
身份认证¶
使用工作区 API Key,在请求头中携带 X-API-Key: <WORKSPACE_API_KEY>,并设置 Content-Type: application/json。
路径参数¶
名称 |
说明 |
|---|---|
|
消息渠道实例标识。 |
查询参数¶
无。
请求体¶
无请求体或空 JSON 对象。
请求示例¶
curl -X POST 'https://moi.matrixorigin.cn/newmoi/workspaces/<workspace_id>/channels/github/instances/<instance_id>/test' \
-H 'X-API-Key: <WORKSPACE_API_KEY>' \
-H 'Content-Type: application/json' \
-d '{}'
响应说明¶
除 A2A JSON-RPC 外,多数工作区接口成功响应形如 {"code":0,"data":...};下列字段描述 data(或 HTTP 202 时的 data)。
测试结果:
字段 |
类型 |
必填 |
说明 |
|---|---|---|---|
|
boolean |
是否成功 |
|
|
string |
状态 |
|
|
object |
实例快照 |
|
|
string |
最近测试状态 |
|
|
string |
错误信息 |
|
|
string |
错误码 |
|
|
string |
修复建议 |
|
|
string |
测试时间 |
使用限制¶
用于确认渠道可用,不代替业务消息发送验证。