创建WarRoom
功能介绍
创建warroom,必传参数包括warroom名称、应用id、事件单号、排班信息、warroom管理员及企业项目id,企业项目id默认传递0即可。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v1/external/warrooms
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
war_room_name |
是 |
String |
warroom标题。 最小长度:1 最大长度:255 |
description |
否 |
String |
waroom描述信息。 最小长度:0 最大长度:255 |
region_code_list |
否 |
Array of strings |
区域ID。 最小长度:1 最大长度:255 数组长度:0 - 1000 |
application_id_list |
是 |
Array of strings |
影响应用ID 最小长度:1 最大长度:255 数组长度:1 - 1000 |
incident_number |
是 |
String |
事件单号。 最小长度:1 最大长度:255 |
schedule_group |
是 |
Array of ScheduleGroupInfo objects |
排班分组信息。 数组长度:0 - 1000 |
participant |
否 |
Array of strings |
参与者,值为用户ID。 最小长度:0 最大长度:255 数组长度:0 - 1000 |
war_room_admin |
是 |
String |
warroom管理员,值为用户ID。 最小长度:1 最大长度:255 |
application_names |
否 |
Array of strings |
应用名称列表。 最小长度:0 最大长度:1000 数组长度:0 - 1000 |
region_names |
否 |
Array of strings |
region名称列表。 最小长度:0 最大长度:1000 数组长度:0 - 1000 |
enterprise_project_id |
是 |
String |
企业项目id。 缺省值:0 最小长度:1 最大长度:64 |
notification_type |
否 |
String |
创建群组方式,微信对应的值为WECHAT、钉钉对应的值为DING_TALK、飞书对应的值为LARK,如不通知到群组,传值为NULL_GROUP。 最小长度:0 最大长度:64 枚举值: |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
provider_code |
String |
服务标识。 缺省值:4 最小长度:3 最大长度:3 |
error_code |
String |
请求响应代码,为8位数字组成,前四位标记当前服务为warroom服务,后四位标记错误类型。 最小长度:8 最大长度:8 |
error_msg |
String |
请求响应描述。 最小长度:0 最大长度:10240 |
data |
String |
warroom Id 最小长度:0 最大长度:255 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
provider_code |
String |
服务标识。 缺省值:049 最小长度:3 最大长度:3 |
error_code |
String |
请求响应代码,为8位数字组成,前四位标记当前服务为warroom服务,后四位标记错误类型。 最小长度:8 最大长度:8 |
error_msg |
String |
请求响应异常时报错信息。 最小长度:0 最大长度:10240 |
data |
Object |
响应数据。 |
请求示例
POST https://{endpoint}/v1/external/warrooms { "war_room_name" : "测试001", "description" : "描述001", "region_code_list" : [ "region_code1", "region_code2" ], "application_id_list" : [ "CS10004308" ], "incident_number" : "IM202504101040150000000000", "participant" : "user_id", "war_room_admin" : "user_id", "schedule_group" : [ { "role_id" : "role_id1", "scene_id" : "scene_id1" } ], "application_names" : [ "COC" ], "region_names" : [ "华北-北京四" ], "enterprise_project_id" : 0, "notification_type" : "WECHAT" }
响应示例
状态码:200
成功响应
{ "error_code" : "COC.00080000", "error_msg" : "success", "data" : "WR202504110000000000000000", "provider_code" : "049" }
状态码:400
创建失败
{ "error_code" : "common.01010001", "error_msg" : "Token missing or invalid.", "data" : null, "provider_code" : "049" }
错误码
请参见错误码。