创建组-GB28181
最近更新时间：2025-02-21 02:50:54
1. 接口描述
接口请求域名: vssapi.ctyun.cn
默认接口请求频率限制：500次/秒。
创建视频监控业务组，是用来管理设备的逻辑集合。
2. 请求参数
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | CreateVSSGroup | 操作接口名，系统规定参数。 |
| GroupName | String | 是 | openapi-group | 组名称，长度 4-64位，可包含大小写字母、数字、中文、中划线、下划线、小括号、空格，不能以空格作为名称的首尾。 |
| Description | String | 否 | create+openapi+group | 组描述，长度不超过255个字符。 |
| AppName | String | 否 | live | 组使用的应用名称，默认vss。 |
| Region | String | 是 | 0851002 | 组所属区域 。 取值: 0851002: 表示贵州贵阳2 0523001: 表示江苏泰州1 0523002: 表示江苏泰州2 0553001: 表示安徽芜湖1 0200001: 表示广东广州1 0591001: 表示福建福州1 0931001: 表示甘肃兰州1 0936001: 表示甘肃张掖1 默认值:0851002 详见6.附录 |
| InProtocol | String | 是 | gb28181 | 组使用的接入协议。 取值: gb28181 |
| OutProtocol | String | 是 | webrtc | 组使用的播放协议，多值用逗号分隔。 取值: rtmp, hls, flv, ws-flv, webrtc |
| SipTransProtocol | String | 否 | tcp | 组使用的sip传输协议。 仅gb28181组支持该字段。 取值：tcp, udp |
| StreamTransProtocol | String | 否 | tcp | 组使用的流媒体传输协议。 仅gb28181组支持该字段。 取值：tcp, udp |
| PullType | Long | 否 | 1 | 是否启用自动拉流，默认1。 取值：1, 2 取值为1，自动拉流，平台自动启动拉流； 取值为2，按需拉流，需要通过触发的方式启动拉流。 |
| PushType | Long | 否 | 1 | 是否启用自动激活推流地址，默认1。 可选项，仅rtmp, rtsp组支持该字段，非rtmp, rtsp组忽略该字段。 取值：1, 2 取值为1，自动激活推流地址，设备创建完成后，平台立刻自动生成推流地址； 取值为2，按需推流，需要通过触发的方式生成推流地址。 |
| InNetworkType | String | 否 | public | 组使用的接入网络类型，默认public。 取值：public, private 取值为public, 设备使用互联网接入； 取值为private, 设备使用专线网络接入。 |
| OutNetworkType | String | 否 | public | 组使用的播放网络类型，默认public。 取值：public, private 取值为public, 客户使用互联网观看直播和点播； 取值为private, 客户使用专线网络观看直播和点播。 |
| GbRegion | String | 是 | 51030300 | 业务组区域编码，编码长度为8位。 取值按照用户或设备所归属的监控中心所在地的行政区划代码确定 。 |
| GbRegionLevel | Long | 否 | 3 | 业务组区域级别，编码长度为1位。 |
| IndustryCode | String | 是 | 04 | 业务组行业编码，编码长度为2位。 行业编码是指用户或设备所归属的行业。 |
| NetworkCode | String | 否 | 7 | 业务组网络标识。取值如下： 0、1、2、3、4 为监控报警专网，5 为公安信息网，6 为政务网，7 为 Internet 网，8为社会资源接入网，9 预留 |
3. 返回参数
| 参数 | 类型 | 描述 |
|---|---|---|
| GroupId | String | 组ID。 |
| SipId | String | 组提供的国标SIP服务器ID。 可选项，非gb28181组忽略该字段。 |
| SipIp | String | 组提供的国标SIP服务器地址。 可选项，非gb28181组忽略该字段。 |
| SipTcpPort | Long | 组提供的国标SIP服务器TCP端口，如5060。 可选项，非gb28181组忽略该字段。 |
| SipUdpPort | Long | 组提供的国标SIP服务器UDP端口，如6060。 可选项，非gb28181组忽略该字段。 |
| CreatedTime | String | 组创建时间。 |
| UpdatedTime | String | 组更新时间。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
4.1 请求示例
https://vssapi.ctyun.cn/
?Action=CreateVSSGroup
&GroupName=${}__RandomString(6,qwertyuiopasdfghjklmnbvc)
&Region=0851001
&InProtocol=gb28181
&OutProtocol=webrtc
&GbRegion=51030300
&IndustryCode=04
&Version=2020-06-12
&AccessKeyId=WOSRUSPHCVMTCUVT****
&Signature=qac%2FRdFMzjxBBdSZS4hm290s0HQ%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=1631705396650719300
&SignatureVersion=1.0
Timestamp=1631705396
4.2 返回示例
{
"GroupId":"577571284835762176",
"SipId":"52010000012008581001",
"SipIp":"127.0.0.1",
"SipTcpPort":15062,
"SipUdpPort":15062,
"CreatedTime":"2022-10-19 16:02:42",
"UpdatedTime":"2022-10-19 16:02:42",
"RequestId":"f1aae02841aa41458405248b8e33d5d9"
}
5. 错误码
| ErrorCode | ErrorMessage |
|---|---|
6.附录
| region_code | region_name | province | city |
|---|---|---|---|
| 851002 | 贵阳2 | 贵州 | 贵阳 |
| 200001 | 广州1 | 广东 | 广州 |
| 591001 | 福州1 | 福建 | 福州 |
| 523002 | 泰州2 | 江苏 | 泰州 |
| 851003 | 贵阳3 | 贵州 | 贵阳 |
| 936001 | 张掖1 | 甘肃 | 张掖 |
| 200002 | 广州2 | 广东 | 广州 |
| 553001 | 芜湖1 | 安徽 | 芜湖 |
| 931001 | 兰州1 | 甘肃 | 兰州 |
| 971001 | 西宁1 | 青海 | 西宁 |
| 230001 | 重庆1 | 重庆 | 重庆 |
| 731001 | 长沙1 | 湖南 | 长沙 |
| 511001 | 镇江1 | 江苏 | 镇江 |
| 270001 | 武汉1 | 湖北 | 武汉 |
| 937001 | 酒泉1 | 甘肃 | 酒泉 |
| 932001 | 定西1 | 甘肃 | 定西 |
| 934001 | 庆阳1 | 甘肃 | 庆阳 |
| 937002 | 嘉峪关1 | 甘肃 | 嘉峪关 |
| 943001 | 白银1 | 甘肃 | 白银 |
| 933001 | 平凉1 | 甘肃 | 平凉 |
| 898001 | 海口1 | 海南 | 海口 |
| 431001 | 长春1 | 吉林 | 长春 |
| 971002 | 西宁2 | 青海 | 西宁 |
| 955001 | 中卫1 | 宁夏 | 中卫 |
| 954001 | 固原1 | 宁夏 | 固原 |
| 953001 | 吴忠1 | 宁夏 | 吴忠 |
本页目录：