测试微软Tearm连通性

POST/zstack/v1/sns/application-endpoints/microsoft-teams/test-connection

Request

cURL

curl --request POST \
  --url '/v1/sns/application-endpoints/microsoft-teams/test-connection' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "status": "ok",
  "method": "POST",
  "path": "/v1/sns/application-endpoints/microsoft-teams/test-connection"
}

Headers

Authorization: OAuth the-session-uuid

Body

{
  "params": {
    "url": "https://microsoft.com/cgi-bin/webhook/send?key=f8b9014a-207a-44d5-ae26-3501bf01dbc4",
    "testMsg": "hello",
    "endpointUuid": "1c201c27a81740ddadbc5d2f3f38a5e4"
  },
  "systemTags": [],
  "userTags": []
}

上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X POST -d '{"params":{"url":"https://microsoft.com/cgi-bin/webhook/send?key=f8b9014a-207a-44d5-ae26-3501bf01dbc4","testMsg":"hello","endpointUuid":"1c201c27a81740ddadbc5d2f3f38a5e4"}}' \
http://localhost:8080/zstack/v1/sns/application-endpoints/microsoft-teams/test-connection

参数列表

名字	类型	位置	描述	起始版本
url (可选)	String	body(包含在params结构中)	Microsoft Teams Webhook URL	4.2.0
testMsg	String	body(包含在params结构中)	测试消息	4.2.0
endpointUuid (可选)	String	body(包含在params结构中)	Microsoft Teams终端UUID	4.2.0
systemTags (可选)	List	body	系统标签	4.2.0
userTags (可选)	List	body	用户标签	4.2.0

API返回

返回示例

{
  "connected": true,
  "webhookResp": {}
}

名字	类型	描述	起始版本
success	boolean		4.2.0
connected	boolean	webhook url 是否联通	4.2.0
webhookResp	LinkedHashMap	webhook 返回数据	5.0.0
error	ErrorCode	错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error	4.2.0

error

名字	类型	描述	起始版本
code	String	错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001	5.0.0
description	String	错误的概要描述	5.0.0
details	String	错误的详细信息	5.0.0
elaboration	String	保留字段，默认为null	5.0.0
opaque	LinkedHashMap	保留字段，默认为null	5.0.0
cause	ErrorCode	根错误，引发当前错误的源错误，若无原错误，该字段为null	5.0.0

SDK示例

Java SDK

SNSMicrosoftTeamsTestConnectionAction action = new SNSMicrosoftTeamsTestConnectionAction();
action.url = "https://microsoft.com/cgi-bin/webhook/send?key=f8b9014a-207a-44d5-ae26-3501bf01dbc4";
action.testMsg = "hello";
action.endpointUuid = "1c201c27a81740ddadbc5d2f3f38a5e4";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
SNSMicrosoftTeamsTestConnectionAction.Result res = action.call();

Python SDK

SNSMicrosoftTeamsTestConnectionAction action = SNSMicrosoftTeamsTestConnectionAction()
action.url = "https://microsoft.com/cgi-bin/webhook/send?key=f8b9014a-207a-44d5-ae26-3501bf01dbc4"
action.testMsg = "hello"
action.endpointUuid = "1c201c27a81740ddadbc5d2f3f38a5e4"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
SNSMicrosoftTeamsTestConnectionAction.Result res = action.call()