conversations
listlengths 2
2
| source
stringclasses 1
value | score
float64 1
1
|
|---|---|---|
[
{
"from": "human",
"value": "如何处理七牛云的视频监控查询录制记录"
},
{
"from": "gpt",
"value": "[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 录制管理相关接口 >查询录制记录\n\n# 查询录制记录\n\n最近更新时间: 2022-09-22 13:57:22\n\n# **描述**\n\n本接口用于查询视频流的录制记录\n\n * 接口请求域名：`qvs.qiniuapi.com`\n * 请求方式：GET\n * 接口路径：`/v1/namespaces/{namespaceId}/streams/{streamId}/recordhistories?start=<start>&end=<end>&marker=<marker>&line=<line>`\n * Get请求，通过`非SDK`方式调用的客户，http头部Content-Type`要么置空, 要么不要携带,要么设置为application/x-www-form-urlencoded`,否则鉴权会失败; [公共http header说明 __](https://developer.qiniu.com/qvs/6709/qvs-http-headers)\n * `如果需要https的视频回放地址，需请求https://qvs.qiniuapi.com`\n\n# **请求参数**\n\n**路径参数**\n\n参数名称 | 必填 | 字段类型 | 说明 \n---|---|---|--- \nnamespaceId | 是 | string | 空间ID \nstreamId | 是 | string | [流id规则 __](https://developer.qiniu.com/qvs/11878/use-the-stream-interface-is-required) \nmarker | 否 | string | 如果查询的记录过多，本接口可能需要循环多次调用来获取全部记录。marker值表示当前的查询位置，第一次查询置空，后面可通过该接口返回参数获取，从而保证可以不间断获取全部记录。例如：总共要查200条记录，第一次查询了100条，第二次传入第一次返回的marker值继续查，又查询100条，第二次返回的marker为空，表示查询结束 \nline | 否 | integer | 一次返回多少条, 最大值为`100`; 当超过100时，需要通过上面的`marker`循环读取，直到取出全部记录 \nstart | 是 | integer | 查询开始时间(unix时间戳，单位为秒) \nend | 是 | integer | 查询结束时间(unix时间戳，单位为秒) \nformat | 否 | string | 录制视频格式 \n \n# **响应参数**\n\n参数名称 | 类型 | 说明 \n---|---|--- \nitems | 流数组 | 流数组 \nitems.url | string | 播放地址 \nitems.type | string | 类型参数，实时流录制/历史流录制 \nitems.start | integer | 录制开始时间(unix时间戳，单位为秒) \nitems.end | integer | 录制结束时间(unix时间戳，单位为秒) \nitems.duration | integer | 录制时长单位为秒 \nitems.snap | string | 录制封面图片地址 \nitems.format | int | 1表示m3u8文件，2表示flv文件，4表示mp4文件 \nitems.file | string | 对应云存储中的文件名 \nmarker | string | 下次查询的marker，如果为空说明记录查询完毕，如果不为空说明记录没有查完，需要重复调用此接口再次查询 \n \n# **示例**\n\n**请求示例**\n\n \n \n curl --request GET \\\n --url 'qvs.qiniuapi.com/v1/namespaces/2akrarrzns76w/streams/t0/recordhistories?start=1587899020&end=1587968104' \\\n --header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='\n \n\n**响应示例**\n\n \n \n {\n \"items\": [\n {\n \"url\": \"http://prlghu509.test.bkt.clouddn.com/record/2akrarrzns76w/t0/1587898457113-1587899058364-601408.m3u8?pm3u8/0/expire/7200&e=1587975245&token=Ves3WTXC8XnEHT0I_vacEQQz-9jrJZxNExcmarzQ:RrS5TIARP3aBREpQJIKC0Rf3FAE\",\n \"start\": 1587898457,\n \"end\": 1587899058,\n \"duration\": 601,\n \"format\": 1,\n \"snap\": \"http://prlghu509.test.bkt.clouddn.com/record/2akrarrzns76w/t0/1587898457113-1587899058364-601408.m3u8?pm3u8/0/expire/7200&vframe/jpg/offset/0&e=1587975245&token=Ves3WTXC8XnEHT0I_vacEQQz-9jrJZxNExcmarzQ:DW9iifbZWTCJkRSdRr_cXzWmGg8\",\n \"file\":\"record/2akrarrzns76w/t0/1587898457113-1587899058364-601408.m3u8\"\n },\n {\n \"url\": \"http://prlghu509.test.bkt.clouddn.com/record/2akrarrzns76w/t0/1587899050326-1587899651641-601127.m3u8?pm3u8/0/expire/7200&e=1587975245&token=Ves3WTXC8XnEHT0I_vacEQQz-9jrJZxNExcmarzQ:WGLFd8CCLDfStQvGagkI9wahMLk\",\n \"start\": 1587899050,\n \"end\": 1587899651,\n \"duration\": 601,\n \"format\": 1,\n \"snap\": \"http://prlghu509.test.bkt.clouddn.com/record/2akrarrzns76w/t0/1587899050326-1587899651641-601127.m3u8?pm3u8/0/expire/7200&vframe/jpg/offset/0&e=1587975245&token=Ves3WTXC8XnEHT0I_vacEQQz-9jrJZxNExcmarzQ:D5hg2KmUrM6DP1Mp14tNtBAhK_w\",\n \"file\":\"record/2akrarrzns76w/t0/1587899050326-1587899651641-601127.m3u8\",\n \"type\":\"realTime\"\n },\n ],\n \"marker\": \"eyJjIjowLCJrIjoicmVjb3JkLzJha3JhcnJ6bnM3NncvdDAvMTU4NzkxNjUxNTYyMC0xNTg3OTE3MTE3MTI1LTYwNDYzMS5tM3U4In0=\"\n }\n \n\n在不使用[golang sdk __](https://developer.qiniu.com/qvs/6924/qvs-go-\nsdk)的情况下，自行golang 发出http请求触发API代码示；其他接口可模仿此示例\n\n \n \n package main\n \n import (\n \t\"encoding/json\"\n \t\"fmt\"\n \t\"io/ioutil\"\n \t\"net/http\"\n \n \t\"github.com/qiniu/go-sdk/v7/auth\"\n )\n \n type Record struct {\n \tUrl string `json:\"url\"`\n \tStart int `json:\"start\"`\n \tEnd int `json:\"end\"`\n \tDuration int `json:\"duration\"`\n \tFormat int `json:\"format\"`\n \tSnap string `json:\"snap\"`\n \tFile string `json:\"file\"`\n \tType string `json:\"type\"`\n }\n \n type Records struct {\n \tItems []Record `json:\"items\"`\n \tMarker string `json:\"marker\"`\n }\n \n func test_record_histories2() {\n \t// 1.以下含有\"xxxx\"的6个参数，需要客户替换成实际的值\n \tvar (\n \t\tYTFAccessKey = \"xxxx\" // 替换成自己 Qiniu 账号的 AccessKey.\n \t\tYTFSecretKey = \"xxxx\" // 替换成自己 Qiniu 账号的 SecretKey.\n \t)\n \tmac := auth.New(YTFAccessKey, YTFSecretKey)\n \n \tvar namespaceId = \"xxxx\" // 替换成自己的空间ID\n \tvar streamId = \"xxxx\" // 替换成自己想要测试的流ID\n \n \turlStr := fmt.Sprintf(\"%s\", \"http://qvs.qiniuapi.com/v1/namespaces/\"+namespaceId+\"/streams/\"+streamId+\"/recordhistories?start=xxxx&end=xxxx\") // 替换start 和 end 时间戳，代表期望获取的时间区间范围\n \t\n \treq, reqErr := http.NewRequest(\"GET\", urlStr, nil)\n \tif reqErr != nil {\n \t\tfmt.Println(reqErr.Error())\n \t\treturn\n \t}\n \taccessToken, signErr := mac.SignRequestV2(req)\n \tif signErr != nil {\n \t\tfmt.Println(signErr.Error())\n \t\treturn\n \t}\n \n \treq.Header.Set(\"Authorization\", \"Qiniu \"+accessToken)\n \tclient := &http.Client{}\n \tresp, respErr := client.Do(req)\n \n \tif respErr != nil {\n \t\tsignErr = respErr\n \t\treturn\n \t}\n \tdefer resp.Body.Close()\n \n \tresData, ioErr := ioutil.ReadAll(resp.Body)\n \tif ioErr != nil {\n \t\tsignErr = ioErr\n \t\treturn\n \t}\n \tsvc1 := Records{}\n \tif decodeErr := json.Unmarshal(resData, &svc1); decodeErr != nil {\n \t\tsignErr = fmt.Errorf(\"get response error, %s\", decodeErr)\n \t\treturn\n \t}\n \tfor _, v := range svc1.Items {\n \t\tfmt.Println(\"recordVideoUrl:\", v.Url)\n \t}\n }\n \n \n func main() {\n \ttest_record_histories2()\n }\n \n \n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的视频监控删除录制片段"
},
{
"from": "gpt",
"value": "[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 录制管理相关接口 >删除录制片段\n\n# 删除录制片段\n\n最近更新时间: 2022-07-05 16:22:21\n\n# **描述**\n\n本接口用于删除录制视频文件\n\n * 接口请求域名：`qvs.qiniuapi.com`\n * 请求方式：DELETE\n * 接口路径：`/v1/namespaces/{namespaceId}/streams/{streamId}/recordhistories`\n * 如果删除的是m3u8文件,\n\n# **请求参数**\n\n**路径参数**\n\n参数名称 | 必填 | 字段类型 | 说明 \n---|---|---|--- \nnamespaceId | 是 | string | 空间ID \nstreamId | 是 | string | 流ID \n \n**请求 body参数**\n\n参数名称 | 必填 | 字段类型 | 说明 \n---|---|---|--- \nfiles | 是 | string数组 | 需要删除的文件列表(从[查询录制记录 __](https://developer.qiniu.com/qvs/api/6745/query-recordhistories)file 字段获取文件名) \nsaveCover | 否 | bool | 是否保留视频封面,默认false, 即`不`保留 \nsaveTs | 否 | bool | 如果删除m3u8文件，是否保留对应的ts文件,默认false, 即`不`保留 \n \n**注意** : \n一次最多可以删除1000条记录\n\n# **响应参数**\n\n200 OK\n\n# **示例**\n\n**请求示例**\n\n \n \n curl --request DELETE \\\n --url http://qvs.qiniuapi.com/v1/namespaces/3nm4x0u6poax8/streams/31011500991320000007/recordhistories \\\n --header 'authorization: QiniuStub j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \\\n --header 'content-type: application/json' \\\n --data '{\n \t\"files\":[\"record/2akrarrzns76w/t0/1587898457113-1587899058364-601408.m3u8\",\"record/2akrarrzns76w/t0/1587899050326-1587899651641-601127.m3u8\"]\n }'\n \n\n**响应示例**\n\n \n \n 200 OK\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的视频监控录制视频片段合并"
},
{
"from": "gpt",
"value": "[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 录制管理相关接口 >录制视频片段合并\n\n# 录制视频片段合并\n\n最近更新时间: 2022-08-10 11:17:10\n\n# **描述**\n\n用于将任意时间段内的视频，剪裁或拼接合并成新的文件,格式支持m3u8(适合在线点播回放), mp4(适合下载), flv(适合下载)。\n\n * 接口请求域名：`qvs.qiniuapi.com`\n * 请求方式：POST\n * 接口路径：`/v1/namespaces/{namespaceId}/streams/{streamId}/saveas`\n * 如果生成的格式为flv或者mp4, 这是异步过程，可通过[`接收录制状态回调` __](https://developer.qiniu.com/qvs/10240/the-message-callback)来获取视频转换完成的通知， 也可以通过本接口返回的persistentID，主动查询视频处理状态。\n\n# **请求参数**\n\n**路径参数**\n\n参数名称 | 必填 | 字段类型 | 说明 \n---|---|---|--- \nnamespaceId | 是 | string | 空间ID \nstreamId | 是 | string | 流ID \n \n**请求Body**\n\n参数名称 | 必填 | 字段类型 | 说明 \n---|---|---|--- \nstart | 是 | integer | 查询开始时间(unix时间戳,单位为秒) \nend | 是 | integer | 查询结束时间(unix时间戳,单位为秒) \nformat | 是 | string | 保存的文件格式,可以为m3u8, mp4或者flv \nfname | 否 | string | 保存的文件名，不指定系统会随机生成 \npipeline | 否 | string | 数据处理的私有队列，不指定则使用公共队列 \nnotifyUrl | 否 | string | 保存成功回调通知地址，不指定则不通知 [通知的详细信息查考这里](https://developer.qiniu.com/dora/manual/1291/persistent-data-processing-pfop) \ndeleteAfterDays | 否 | integer | 文件过期时间,默认和录制模版中的设置保持一致, `-2 表示永不过期` \ndeleteTs | 否 | bool | 在不生成m3u8格式文件时是否删除对应的ts文件, 默认不删除 \n \n# **响应参数**\n\n参数名称 | 类型 | 说明 \n---|---|--- \nbucket | string | 文件存储的bucket \nfname | string | 表示保存后在存储空间里的文件名。使用存储空间的下载域名可以访问这文件，形如: `http://<DownloadDomainOfStorageBucket>/<Fname>` \nduration | int | 合并后文件的时长(单位为秒) \npersistentID | string | 持久化异步处理任务ID，异步模式才会返回该字段，可以通过该字段查询转码进度，[持久化处理状态查询 __](https://developer.qiniu.com/dora/manual/1294/persistent-processing-status-query-prefop) \n \n# 示例\n\n请求包:\n\n \n \n curl --request POST \\\n --url http://qvs.qiniuapi.com/v1/namespaces/3nm4x0vyz7xlu/streams/31011500991320000129/saveas \\\n \t--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \\\n --header 'content-type: application/json' \\\n --data '{\n \t\"start\":1601346558,\n \t\"end\":1601347915,\n \t\"format\":\"mp4\"\n }'\n \n\n返回包:\n\n \n \n 200 OK {\n \"fname\": \"record/3nm4x0vyz7xlu/31011500991320000129/1601346558445-1601347917100-1301394.mp4\",\n \"persistentId\": \"z0.01z002c5zj4qq9rouo00muj6so00012w\",\n \"bucket\": \"linking_ipc_test\",\n \"duration\": 1301\n }\n \n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的视频监控录制回放"
},
{
"from": "gpt",
"value": "[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 录制管理相关接口 >录制回放\n\n# 录制回放\n\n最近更新时间: 2022-08-10 11:51:27\n\n# **描述**\n\n本接口用于查询指定时间段的录像记录进行录像回放。\n\n请求\n\n * 接口请求域名：`qvs.qiniuapi.com`\n * 请求方式：GET\n * 接口路径：`/v1/namespaces/{namespaceid}/streams/{streamId}/records/playback.m3u8?start=<start>&end=<end>`\n * Tips1:回放地址，优先使用七牛存储(kodo)中的自定义域名；如果没有该域名，则使用kodo默认域名；kodo默认域名过期，则无法使用。\n * Tips2:如果需要https的回放地址，需请求`https://qvs.qiniuapi.com`\n * Tips3:Get请求，通过`非SDK`方式调用的客户，http头部Content-Type, `要么设置为application/x-www-form-urlencoded`, `要么置空`, `要么不要携带`; [公共http header说明 __](https://developer.qiniu.com/qvs/6709/qvs-http-headers)\n\n# **请求参数**\n\n**路径参数**\n\n参数名称 | 必填 | 字段类型 | 说明 \n---|---|---|--- \nnamespaceId | 是 | string | 空间ID \nstreamId | 是 | string | 流ID \nstart | 是 | integer | 查询开始时间(unix时间戳，单位为秒) \nend | 是 | integer | 查询结束时间(unix时间戳，单位为秒） \n \n# **响应参数**\n\n参数名称 | 字段类型 | 说明 \n---|---|--- \nurl | string | m3u8播放链接 \n \n# **示例**\n\n**请求示例**\n\n \n \n curl --request GET \\\n --url 'http://qvs.qiniuapi.com/v1/namespaces/2akrarxtmpned/streams/31011500991320000137/records/playback.m3u8?start=1604028714&end=1604028934' \\\n --header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='\n \n\n**响应示例**\n\n \n \n {\n \"url\": \"http://prlghu509.test.bkt.clouddn.com/record/playback/2akrarxtmpned/31011500991320000137/1604028714-1604028934.m3u8?pm3u8/0/expire/7200&e=1604313929&token=Ves3WTXC8XnEHT0I_vacEQQz-9jrJZxNExcmarzQ:gQdnnGXGivC4-z1rtnNIF20oQns\"\n }\n \n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的视频监控按需截图"
},
{
"from": "gpt",
"value": "[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 录制管理相关接口 >按需截图\n\n# 按需截图\n\n最近更新时间: 2023-08-21 15:30:53\n\n# **描述**\n\n本接口用于对指定流立即截图一次。对于不在线的流，会启动设备拉流，不需要调用启动设备拉流API。\n\n * 接口请求域名：`qvs.qiniuapi.com`\n * 请求方式：POST\n * 接口路径：`/v1/namespaces/{namespaceId}/streams/{streamId}/snap`\n * 本接口要求截图模板类型为`按需截图`，如用户想在某时刻进行流截图操作，可在对应时间点通过调用本接口即可。\n * 本接口是异步过程，截图后的地址，可以通过两种方式获取 \n 1. 我们会回调,主动通知客户截图完成后的地址，客户需要解析我们的[截图状态回调 __](https://developer.qiniu.com/qvs/10240/the-message-callback)\n 2. 客户也可以通过主动查询[截图列表 __](https://developer.qiniu.com/qvs/6749/list-stream-snapshots)获取\n * 本接口会先启动设备拉流，等待3s，流在线了之后，会请求截图。如果3s内，设备没有推流到平台，截图会失败。\n\n# **请求参数**\n\n**路径参数**\n\n参数名称 | 必填 | 字段类型 | 说明 \n---|---|---|--- \nnamespaceId | 是 | string | 空间ID \nstreamId | 是 | string | 流Id \n \n# **响应参数**\n\n200\n\n# **示例**\n\n**请求示例**\n\n \n \n curl --request POST \\\n --url http://qvs.qiniuapi.com/v1/namespaces/2akrarvzvyijd/streams/31011500991320000028/snap \\\n --header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='\n \n\n**响应示例**\n\n \n \n {\n \"code\": 200\n }\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的视频监控删除截图"
},
{
"from": "gpt",
"value": "[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 录制管理相关接口 >删除截图\n\n# 删除截图\n\n最近更新时间: 2022-05-20 12:30:41\n\n# **描述**\n\n本接口用于删除录制截图\n\n * 接口请求域名：`qvs.qiniuapi.com`\n * 请求方式：DELETE\n * 接口路径：`/v1/namespaces/{namespaceId}/streams/{streamId}/snapshots`\n\n# **请求参数**\n\n**路径参数**\n\n参数名称 | 必填 | 字段类型 | 说明 \n---|---|---|--- \nnamespaceId | 是 | string | 空间ID \nstreamId | 是 | string | 流ID \n \n**请求 body参数**\n\n参数名称 | 必填 | 字段类型 | 说明 \n---|---|---|--- \nfiles | 是 | string数组 | 需要删除的文件列表(从[获取截图列表 __](https://developer.qiniu.com/qvs/api/6749/list-stream-snapshots)file字段获取文件名) \n \n**注意** : \n一次最多可以删除1000条记录\n\n# **响应参数**\n\n200 OK\n\n# **示例**\n\n**请求示例**\n\n \n \n curl --request DELETE \\\n --url http://qvs.qiniuapi.com/v1/namespaces/3nm4x0u6poax8/streams/31011500991320000007/snapshots \\\n --header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \\\n --header 'content-type: application/json' \\\n --data '{\n \t\"files\":[\"snapshot/jpg/d102sni9zryu/device005/1586828065507.jpg\",\"snapshot/jpg/d102sni9zryu/device005/1586828070507.jpg\"]\n }'\n \n\n**响应示例**\n\n \n \n 200 OK\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的视频监控获取截图列表"
},
{
"from": "gpt",
"value": "[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 录制管理相关接口 >获取截图列表\n\n# 获取截图列表\n\n最近更新时间: 2022-08-10 11:18:24\n\n# **描述**\n\n本接口用于查询流截图记录\n\n * 接口请求域名：`qvs.qiniuapi.com`\n * 请求方式：GET\n * 接口路径：`/v1/namespaces/{namespaceId}/streams/{streamId}/snapshots?type=<type>&start=<start>&end=<end>&marker=<marker>&line=<line>`\n * Get请求，通过`非SDK`方式调用的客户，http头部Content-Type,`要么设置为application/x-www-form-urlencoded`,`要么置空`, `要么不要携带`; [公共http header说明 __](https://developer.qiniu.com/qvs/6709/qvs-http-headers)\n\n# **请求参数**\n\n**路径参数**\n\n参数名称 | 必填 | 字段类型 | 说明 \n---|---|---|--- \nnamespaceId | 是 | string | 空间ID \nstreamId | 是 | string | 流ID \ntype | 是 | integer | 1:实时截图对应的图片列表 2: 按需截图对应的图片列表 3:覆盖式截图对应的图片 \nline | 否 | integer | 限定返回截图的个数，只能输入1-100的整数，不指定默认返回30个，type为3可忽略 \nmarker | 否 | string | 上一次查询返回的标记，用于提示服务端从上一次查到的位置继续查询，不指定表示从头查询，type为3可忽略 \nstart | 否 | integer | 查询开始时间(unix时间戳,单位为秒)，type为3可忽略 \nend | 否 | integer | 查询结束时间(unix时间戳,单位秒)，type为3可忽略 \n \n# **响应参数**\n\n参数名称 | 类型 | 说明 \n---|---|--- \nitems | 截图数组 | 截图数组 \nitems.snap | string | 截图url \nitems.file | string | 对应云存储中的文件名 \nitems.time | integer | 截图时间点(unix时间戳 单位为秒)，覆盖式截图不返回 \nmarker | string | 返回的列举位置标记，作为下次列举的起点信息,为空表示全部返回完毕，覆盖式截图不返回 \n \n# **示例**\n\n**请求示例**\n\n \n \n curl --request GET \\\n --url http://qvs.qiniuapi.com/v1/namespaces/d102sni9zryu/streams/device005/snapshots?type=1&start=1586828065&end=1586828456 \\\n --header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='\n \n\n**响应示例**\n\n \n \n {\n \"items\": [\n {\n \"snap\": \"http://prlghu509.test.bkt.clouddn.com/snapshot/jpg/d102sni9zryu/device005/1586828085507.jpg?e=1586829199&token=Ves3WTXC8XnEHT0I_vacEQQz-9jrJZxNExcmarzQ:atGE_HnerdP2TF1fDSlv2HRurcw\",\n \"file\":\"snapshot/jpg/d102sni9zryu/device005/1586828085507.jpg\",\n \"time\": 1586828085\n }, \n {\n \"snap\": \"http://prlghu509.test.bkt.clouddn.com/snapshot/jpg/d102sni9zryu/device005/1586828461726.jpg?e=1586829199&token=Ves3WTXC8XnEHT0I_vacEQQz-9jrJZxNExcmarzQ:AcRKnwvxxDc4kgg22RwbaiiAJYM\",\n \"file\":\"snapshot/jpg/d102sni9zryu/device005/1586828461726.jpg\",\n \"time\": 1586828461\n }\n ],\n \"marker\": \"\"\n }\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的视频监控获取直播封面截图"
},
{
"from": "gpt",
"value": "[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 录制管理相关接口 >获取直播封面截图\n\n# 获取直播封面截图\n\n最近更新时间: 2022-09-13 16:26:06\n\n# **描述**\n\n本接口用于查询流封面\n\n * 接口请求域名：`qvs.qiniuapi.com`\n * 请求方式：GET\n * 接口路径：`/v1/namespaces/{namespaceId}/streams/{streamId}/cover`\n * 前提:流或者流附属的空间绑定了`截图模板`, 并且截图模板的`截图方式`包含`覆盖式截图`\n\n# **请求参数**\n\n**路径参数**\n\n参数名称 | 必填 | 字段类型 | 说明 \n---|---|---|--- \nnamespaceId | 是 | string | 空间ID \nstreamId | 是 | string | 空间为`gb28181`:设备类型为摄像头,流ID就是`设备国标ID`;设备类型是NVR(平台类型),流ID为`设备国标ID_通道国标ID` \n空间类型为`rtmp`或者`主动拉流`:流ID就是`流名称` \n \n# **响应参数**\n\n参数名称 | 类型 | 说明 \n---|---|--- \nurl | string | 封面下载地址 \n \n# **示例**\n\n**请求示例**\n\n \n \n curl --request GET \\\n --url http://qvs.qiniuapi.com/v1/namespaces/2akrarrzns76w/streams/t0/cover \\\n --header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='\n \n\n**响应示例**\n\n \n \n {\n \"url\": \"http://prlghu509.test.bkt.clouddn.com/snapshot/jpg/2akrarrzns76w/t0.jpg?e=1588124787&token=Ves3WTXC8XnEHT0I_vacEQQz-9jrJZxNExcmarzQ:bH8s5m5N5Ugp2wo6ACRUVeIK280\"\n }\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的视频监控本地录像回放控制"
},
{
"from": "gpt",
"value": "[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 本地录像回放相关接口 >本地录像回放控制\n\n# 本地录像回放控制\n\n最近更新时间: 2022-05-16 10:58:47\n\n# **描述**\n\n本接口用于本地录像回放的控制，比如快进,快退,慢放,拖动播放,暂停。\n\n * 接口请求域名：`qvs.qiniuapi.com`\n * 请求方式：POST\n * 接口路径：`/v1/namespaces/{namespaceId}/streams/{streamId}/playback/control`\n * 流ID处于`推流状态`时, `才能`使用本接口,[如何触发本地录像推流?__](https://developer.qiniu.com/qvs/6907/start-device)\n\n# **请求参数**\n\n**路径参数**\n\n参数名称 | 必填 | 字段类型 | 说明 \n---|---|---|--- \nnamespaceId | 是 | string | 空间ID \nstreamId | 是 | string | 流ID, 流ID可以从`查询本地录像列表`接口获取 \n \n**Body**\n\n参数名称 | 必填 | 字段类型 | 说明 \n---|---|---|--- \ncommand | 是 | string | 对历史流进行控制，包括“play”播放、“pause”暂停、“scale”倍速，暂停后需要“play”继续播放 \nrange | 否 | string | 当command为“play”时指定跳转的时间，单位是s，时间大小是指距离历史流开始播放后的多长时间，默认为“now”，例如：“100”，“200”等，跳转后会以1倍速继续播放 \nscale | 否 | float | 当command为“scale”时指定播放倍速，支持x0.5、x1、x2、x4、x8 \n \n# **响应参数**\n\n200\n\n# **示例**\n\n**请求示例**\n\n \n \n curl --location --request POST 'http://localhost:7275/v1/namespaces/2akras1vdttwy/streams/31011500991320000006_history_1628730000_1628740800/playback/control' \\\n --header 'Content-Type: application/json' \\\n --data-raw '{\n \"command\":\"pause\"\n }'\n \n\n**响应示例**\n\n \n \n {\n \"code\": 200\n }\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的视频监控查询本地录像列表"
},
{
"from": "gpt",
"value": "[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 本地录像回放相关接口 >查询本地录像列表\n\n# 查询本地录像列表\n\n最近更新时间: 2022-08-10 11:18:29\n\n# **描述**\n\n本接口用于查询设备本地录像列表\n\n * 接口请求域名：`qvs.qiniuapi.com`\n * 请求方式：GET\n * 接口路径：`/v1/namespaces/{namespaceId}/devices/{deviceId}/recordhistories?start=<start>&end=<end>&chId=<chId>`\n * Get请求，通过`非SDK`方式调用的客户，http头部Content-Type,`要么设置为application/x-www-form-urlencoded`,`要么置空`, `要么不要携带`,否则query字段无效; [公共http header说明 __](https://developer.qiniu.com/qvs/6709/qvs-http-headers)\n\n# **请求参数**\n\n**路径参数**\n\n参数名称 | 必填 | 字段类型 | 说明 \n---|---|---|--- \nnamespaceId | 是 | string | 空间ID \ndeviceId | 是 | string | 国标ID \nstart | 是 | integer | 查询开始时间(unix时间戳,单位为秒) \nend | 是 | integer | 查询结束时间(unix时间戳,单位为秒), `[start,end]时间跨度不能超过1天` \nchId | 否 | string | 设备类型为\"平台\"时,chId就是通道国标Id; 否则忽略改字段 \n \n# **响应参数**\n\n参数名称 | 类型 | 说明 \n---|---|--- \nitems | 录制数组 | 录制数组 \nitems.streamId | string | 流id \nitems.start | integer | 录制开始时间(unix时间戳,单位为秒) \nitems.end | integer | 录制结束时间(unix时间戳,单位为秒) \nitems.playUrls | RoutePlayUrls结构体 | 播放地址 \nitems.playUrls.rtmp | string | rtmp播放地址 \nitems.playUrls.hls | string | hls播放地址 \nitems.playUrls.flv | string | flv播放地址 \nitems.playUrls.webrtc | string | webrtc播放地址 \n \n# **示例**\n\n**请求示例**\n\n \n \n curl --request GET \\\n --url 'qvs.qiniuapi.com/v1/namespaces/2akrarrzns76w/devices/31011500991180000083/recordhistories?start=1587899020&end=1587968104&chId=34020000001310000034' \\\n --header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='\n \n\n**响应示例**\n\n \n \n {\n \"items\": [\n {\n \"playUrls\": {\n \"rtmp\": \"rtmp://110.242.48.47:2045/2akrarxjr6tzn/31011500991180000083_34020000001310000034_history_1603953722_1603954811?e=1698648132&token=test123%3A2RHFgPUo9TFhnlQLjLGMFQTA3h8\",\n \"flv\":\"http://110.242.48.47:1360/2akrarxjr6tzn/31011500991180000083_34020000001310000034_history_1603953722_1603954811.flv?e=1698648132&token=test123%3Al92J0DMtgo8kOvMJ9pZygqC-cvw\",\n \"hls\": \"http://110.242.48.47:1370/2akrarxjr6tzn/31011500991180000083_34020000001310000034_history_1603953722_1603954811.m3u8?e=1698648132&token=test123%3AdCsTKlht7sDmedNLZOZ28kHUFbU\",\n \"webrtc\": \"webrtc://110.242.48.47:1985/2akrarxjr6tzn/31011500991180000083_34020000001310000034_history_1603953722_1603954811?e=1698648132&token=test123%PUo9PUo9TFhZygqlQLjLGDmedNLv2\"\n },\n \"start\": 1603953722,\n \"end\": 1603954811,\n \"streamId\": \"31011500991180000083_34020000001310000034_history_1603953722_1603954811\",\n \"type\": \"time\"\n },\n {\n \"playUrls\": {\n \"rtmp\": \"rtmp://110.242.48.47:2045/2akrarxjr6tzn/31011500991180000083_34020000001310000034_history_1604037616_1604040122?e=1698648132&token=test123%3AJEGIjT0zX63uwfRrUSDgoeiyQjA\",\n \"flv\":\"http://110.242.48.47:1360/2akrarxjr6tzn/31011500991180000083_34020000001310000034_history_1604037616_1604040122.flv?e=1698648132&token=test123%3AhUmsW6op6lBtFc5RuniTr4MQuKA\",\n \"hls\": \"http://110.242.48.47:1370/2akrarxjr6tzn/31011500991180000083_34020000001310000034_history_1604037616_1604040122.m3u8?e=1698648132&token=test123%3AG5z9b1D8vf6enPgR8OakWdwGfZo\",\n \"webrtc\": \"webrtc://110.242.48.47:1985/2akrarxjr6tzn/31011500991180000083_34020000001310000034_history_1604037616_1604040122?e=1698648132&token=test123%PUo9PUo9TFhZygqlQLjLGDmedNLv2\"\n },\n \"start\": 1604037616,\n \"end\": 1604040122,\n \"streamId\": \"31011500991180000083_34020000001310000034_history_1604037616_1604040122\",\n \"type\": \"time\"\n }\n ]\n }\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的视频监控本地录像上传云端"
},
{
"from": "gpt",
"value": "[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 本地录像回放相关接口 >本地录像上传云端\n\n# 本地录像上传云端\n\n最近更新时间: 2022-04-02 17:16:45\n\n# **描述**\n\n本接口可将设备`SD卡本地录像文件`上传到云端。具体可参考[设备本地录像上传云端存储最佳实践\n__](https://developer.qiniu.com/qvs/8425/local-video-upload-the-cloud)\n\n * 接口请求域名：`qvs.qiniuapi.com`\n * 请求方式：POST\n * 接口路径：`/v1/namespaces/{namespaceId}/devices/{gbId}/sdcardsave/start`\n\n# **请求参数**\n\n**路径参数**\n\n参数名称 | 必填 | 字段类型 | 说明 \n---|---|---|--- \nnamespaceId | 是 | string | 空间ID \ngbId | 是 | string | 设备国标Id \n \n**Body**\n\n参数名称 | 必填 | 字段类型 | 说明 \n---|---|---|--- \nchannelId | 否 | string | 平台设备指定需要启动的通道国标ID \nstart | 是 | integer | 开始时间(unix时间戳,单位为秒) \nend | 是 | integer | 结束时间(unix时间戳,单位为秒) \nprocessId | 否 | string | 客户自定义ID，在视频录制到云端后，七牛平台会把该ID回调给客户.[录制回调格式 __](https://developer.qiniu.com/qvs/10240/the-message-callback) \n \n**注意** : \n用户使用该接口将摄像头本地的录像通过国标推流到云端并进行录制, 首先需要保证摄像头本地是有录制文件的,可以通过[查询本地录像列表 \n__](https://developer.qiniu.com/qvs/7112/query-local-video-list)获取本地录像列表\n\n# **响应参数**\n\n200\n\n# **示例**\n\n**请求示例**\n\n \n \n curl --request POST \\\n --url http://qvs.qiniuapi.com/v1/namespaces/2akrarvzvyijd/devices/31011500991320000028/sdcardsave/start \\\n --header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \\\n --header 'content-type: application/json'\n --data '{\n \t\"channelId\": \"34020000001310000003\",\n \t\"start\":1612191900,\n \t\"end\":1612191960\n }'\n \n\n**响应示例**\n\n \n \n {\n \"code\": 200\n }\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的视频监控终止本地录像上传云端"
},
{
"from": "gpt",
"value": "[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 本地录像回放相关接口 >终止本地录像上传云端\n\n# 终止本地录像上传云端\n\n最近更新时间: 2021-02-02 16:13:52\n\n# **描述**\n\n本接口用于终止本地录制文件上传云端录制的操作。\n\n * 接口请求域名：`qvs.qiniuapi.com`\n * 请求方式：POST\n * 接口路径：`/v1/namespaces/{namespaceId}/devices/{gbId}/sdcardsave/stop`\n\n# **请求参数**\n\n**路径参数**\n\n参数名称 | 必填 | 字段类型 | 说明 \n---|---|---|--- \nnamespaceId | 是 | string | 空间ID \ngbId | 是 | string | 设备国标Id \n \n**Body**\n\n参数名称 | 必填 | 字段类型 | 说明 \n---|---|---|--- \nchannelId | 否 | string | 平台设备指定需要启动的通道国标ID \nstart | 是 | integer | 开始时间(unix时间戳,单位为秒) \nend | 是 | integer | 结束时间(unix时间戳,单位为秒) \n \n**注意** : 该接口应与[本地录像上传云端 __](https://developer.qiniu.com/qvs/7765/uploaded-to-\nthe-cloud)配合使用\n\n# **响应参数**\n\n200\n\n# **示例**\n\n**请求示例**\n\n \n \n curl --request POST \\\n --url http://qvs.qiniuapi.com/v1/namespaces/2akrarvzvyijd/devices/31011500991320000028/sdcardsave/stop \\\n --header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \\\n --header 'content-type: application/json'\n --data '{\n \t\"channelId\": \"34020000001310000003\",\n \t\"start\":1612191900,\n \t\"end\":1612191960\n }'\n \n\n**响应示例**\n\n \n \n {\n \"code\": 200\n }\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的视频监控PTZ相关接口"
},
{
"from": "gpt",
"value": "[视频监控](https://developer.qiniu.com/qvs) > API 文档 > PTZ相关接口\n\n# PTZ相关接口\n\n最近更新时间: 2022-11-28 11:14:53\n\n通过国标接入的监控设备可以使用PTZ相关功能\n\n名词解释：\n\n名称 | 解释 \n---|--- \nPTZ | 在安防监控应用中是 Pan/Tilt/Zoom 的简写，代表云台全方位（左右/上下）移动及镜头变倍、变焦控制。对于下面的操作仅要求设备在线既可，与流是否在线无关 \n步长 | 步长主要是用于控制云台转动方向的速度的调节， 调节范围1~10。 \n变倍（ZOOM） | 用户可以通过控制变倍参数，调整焦距的远近，得到所需的全景画面，或是近景视图。 \n光圈（Irish） | 光圈是用来调节摄像机画面的亮度的。 \n变焦（Focus） | 聚焦是调节摄像机画面中的一个物体或场景的清晰程度的过程 \n预置位 | 摄像机能将当前状态下云台的水平角度、倾斜角度和摄像机镜头焦距等位置参数存储到存储器中，需要时可以选择该预置位，迅速调用这些参数并将云台和摄像头调整至该位置。 \n \n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的视频监控云台控制"
},
{
"from": "gpt",
"value": "[视频监控](https://developer.qiniu.com/qvs) > API 文档 >\n[PTZ相关接口](https://developer.qiniu.com/qvs/api/7289/ptz-related-interface) >\n云台控制\n\n# 云台控制\n\n最近更新时间: 2022-11-28 16:22:18\n\n本接口用于对摄像头进行 转动镜头，如水平、垂直、缩放等操作\n\n * 接口请求域名：`qvs.qiniuapi.com`\n * 请求方式：POST\n * 接口路径：`/v1/namespaces/{namespaceId}/devices/{deviceId}/ptz`\n * Tips: 请求参数中的cmd字段设置为`stop`时, 设备才会停止；否则会永不停歇\n\n# **请求参数**\n\n**路径参数**\n\n参数名称 | 必填 | 字段类型 | 说明 \n---|---|---|--- \nnamespaceId | 是 | string | 空间ID \ndeviceId | 是 | string | 设备国标Id \n \n**Body**\n\n参数名称 | 必填 | 字段类型 | 说明 \n---|---|---|--- \ncmd | 是 | string | left(向左), right(向右), up(向上), down(向下), leftup(左上), rightup(右上), leftdown(左下), rightdown(右下), zoomin(放大), zoomout(缩小),stop(停止PTZ操作) \nspeed | 是 | int | 调节速度(1~10, 默认位5) \nchId | 否 | string | 如果设备是普通摄像头，该字段置空字符串即可，如果设备是平台类型，该字段为子设备国标ID \n \n# **响应参数**\n\n200\n\n**请求示例**\n\n \n \n curl --request POST \\\n --url http://qvs.qiniuapi.com/v1/namespaces/2akrarxtmpned/devices/31011500991320000137/ptz \\\n --header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \\\n --header 'content-type: application/json' \\\n --data '{\n \t\"cmd\":\"left\",\n \t\"speed\":1\n }'\n \n\n**响应示例**\n\n \n \n {\n \"code\": 200\n }\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的视频监控变焦控制"
},
{
"from": "gpt",
"value": "[视频监控](https://developer.qiniu.com/qvs) > API 文档 >\n[PTZ相关接口](https://developer.qiniu.com/qvs/api/7289/ptz-related-interface) >\n变焦控制\n\n# 变焦控制\n\n最近更新时间: 2022-11-28 16:22:26\n\n本接口用于摄像头的变焦控制\n\n * 接口请求域名：`qvs.qiniuapi.com`\n * 请求方式：POST\n * 接口路径：`/v1/namespaces/{namespaceId}/devices/{deviceId}/focus`\n\n# **请求参数**\n\n**路径参数**\n\n参数名称 | 必填 | 字段类型 | 说明 \n---|---|---|--- \nnamespaceId | 是 | string | 空间ID \ndeviceId | 是 | string | 设备ID \n \n**Body**\n\n参数名称 | 必填 | 字段类型 | 说明 \n---|---|---|--- \ncmd | 是 | string | focusnear(焦距变近), focusfar(焦距变远),stop(停止) \nspeed | 是 | int | 调节速度(1~10, 默认位5) \nchId | 否 | string | 如果设备是普通摄像头，该字段置空字符串即可，如果设备是平台类型，该字段为子设备国标ID \n \n# **响应参数**\n\n200 \n**请求示例**\n\n \n \n curl --request POST \\\n --url http://qvs.qiniuapi.com/v1/namespaces/2akrarxtmpned/devices/31011500991320000137/focus \\\n --header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \\\n --header 'content-type: application/json' \\\n --data '{\n \t\"cmd\":\"focusfar\",\n \t\"speed\":1\n }'\n \n\n**响应示例**\n\n \n \n {\n \"code\": 200\n }\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的视频监控光圈控制"
},
{
"from": "gpt",
"value": "[视频监控](https://developer.qiniu.com/qvs) > API 文档 >\n[PTZ相关接口](https://developer.qiniu.com/qvs/api/7289/ptz-related-interface) >\n光圈控制\n\n# 光圈控制\n\n最近更新时间: 2022-11-28 16:22:32\n\n本接口用于摄像头的光圈控制\n\n * 接口请求域名：`qvs.qiniuapi.com`\n * 请求方式：POST\n * 接口路径：`/v1/namespaces/{namespaceId}/devices/{deviceId}/iris`\n\n# **请求参数**\n\n**路径参数**\n\n参数名称 | 必填 | 字段类型 | 说明 \n---|---|---|--- \nnamespaceId | 是 | string | 空间ID \ndeviceId | 是 | string | 如果设备是普通摄像头，该字段置空字符串即可，如果设备是平台类型，该字段为子设备国标ID \n \n**Body**\n\n参数名称 | 必填 | 字段类型 | 说明 \n---|---|---|--- \ncmd | 是 | string | irisin(光圈变小), irisout(光圈变大),stop(停止) \nspeed | 是 | int | 调节速度(1~10, 默认位5) \nchId | 否 | string | 子设备国标ID \n \n# **响应参数**\n\n200 \n**请求示例**\n\n \n \n curl --request POST \\\n --url http://qvs.qiniuapi.com/v1/namespaces/2akrarxtmpned/devices/31011500991320000137/iris \\\n --header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \\\n --header 'content-type: application/json' \\\n --data '{\n \t\"cmd\":\"irisin\",\n \t\"speed\":1\n }'\n \n\n**响应示例**\n\n \n \n {\n \"code\": 200\n }\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的视频监控预置位控制"
},
{
"from": "gpt",
"value": "[视频监控](https://developer.qiniu.com/qvs) > API 文档 >\n[PTZ相关接口](https://developer.qiniu.com/qvs/api/7289/ptz-related-interface) >\n预置位控制\n\n# 预置位控制\n\n最近更新时间: 2022-11-28 16:22:41\n\n本接口用于预置位的管理\n\n * 接口请求域名：`qvs.qiniuapi.com`\n * 请求方式：POST\n * 接口路径：`/v1/namespaces/{namespaceId}/devices/{deviceId}/presets`\n\n# **请求参数**\n\n**路径参数**\n\n参数名称 | 必填 | 字段类型 | 说明 \n---|---|---|--- \nnamespaceId | 是 | string | 空间ID \ndeviceId | 是 | string | 设备ID \n \n**Body**\n\n参数名称 | 必填 | 字段类型 | 说明 \n---|---|---|--- \ncmd | 是 | string | set(新增预置位), goto(设置),remove(删除) \nname | 否 | string | 预置位名称(cmd为set时有效,支持中文) \npresetId | cmd为goto,remove 时必须指定 | int | 预置位ID \nchId | 否 | string | 如果设备是普通摄像头，该字段置空字符串即可，如果设备是平台类型，该字段为子设备国标ID \npresetToken | 设备类型为ONVIF是必须指定 | string | 预置位令牌 \n \n# **响应参数**\n\n200\n\n**请求示例**\n\n \n \n curl --request POST \\\n --url http://qvs.qiniuapi.com/v1/namespaces/2akrarxtmpned/devices/31011500991320000137/presets \\\n --header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \\\n --header 'content-type: application/json' \\\n --data '{\n \t\"cmd\":\"set\",\n \t\"name\":\"test001\"\n }'\n \n\n**响应示例**\n\n \n \n {\n \"name\":\"test001\",\n \"id\":1\n }\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的视频监控获取预置位列表"
},
{
"from": "gpt",
"value": "[视频监控](https://developer.qiniu.com/qvs) > API 文档 >\n[PTZ相关接口](https://developer.qiniu.com/qvs/api/7289/ptz-related-interface) >\n获取预置位列表\n\n# 获取预置位列表\n\n最近更新时间: 2022-11-28 16:22:48\n\n本接口用于获取预置位列表\n\n * 接口请求域名：`qvs.qiniuapi.com`\n * 请求方式：GET\n * 接口路径：`/v1/namespaces/{namespaceId}/devices/{gbId}/presets?chId=<chId>&fetch=<fetch>`\n * Get请求，通过`非SDK`方式调用的客户，http头部Content-Type,`要么设置为application/x-www-form-urlencoded`,`要么置空`, `要么不要携带`; [公共http header说明 __](https://developer.qiniu.com/qvs/6709/qvs-http-headers)\n\n# **请求参数**\n\n**路径参数**\n\n参数名称 | 必填 | 字段类型 | 说明 \n---|---|---|--- \nnamespaceId | 是 | string | 空间ID \ngbId | 是 | string | 设备国标ID \nchId | 否 | string | 如果设备是普通摄像头，该字段置空字符串即可，如果设备是平台类型，该字段为子设备国标ID \nfetch | 否 | bool | 是否强制从设备获取预置位 \n \n# **响应参数**\n\n参数名称 | 必填 | 类型 | 说明 \n---|---|---|--- \nitems | 是 | 预置位数组 | 预置位数组 \nitems.id | gb28181设备需指定 | int | 预置位ID \nitems.name | 是 | string | 预置位名称 \nitems.token | onvif设备需指定 | string | 预置位token \n \n \n curl --request GET \\\n --url http://qvs.qiniuapi.com/v1/namespaces/2akrarxtmpned/devices/31011500991320000137/presets \\\n --header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='\n \n\n**响应示例**\n\n \n \n {\n \"items\": [\n {\n \"id\": 1,\n \"name\": \"东南方向2点\"\n },\n {\n \"id\": 2,\n \"name\": \"预置点2\"\n }\n ]\n }\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的视频监控获取国标报警事件列表"
},
{
"from": "gpt",
"value": "[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 国标报警相关接口 >获取国标报警事件列表\n\n# 获取国标报警事件列表\n\n最近更新时间: 2022-08-10 11:18:47\n\n# **描述**\n\n本接口用于获取设备国标报警事件列表\n\n * 接口请求域名：`qvs.qiniuapi.com`\n * 请求方式：GET\n * 接口路径：`/v1/namespaces/{namespaceId}/devices/{deviceId}/alarms?start=<start>&end=<end>&chId=<chId>&alarmMethod=<alarmMethod>&alarmType=<alarmType>&offset=<offset>&line=<line>&sortBy=<sortBy>`\n * http body为空时, 例如Get请求, 通过`非SDK`方式调用的客户，http头部Content-Type,`要么设置为application/x-www-form-urlencoded`,`要么置空`, `要么不要携带`; [公共http header说明 __](https://developer.qiniu.com/qvs/6709/qvs-http-headers)\n * 告警事件默认`保存1天`，如果需要延长，请提工单\n\n# **请求参数**\n\n**路径参数**\n\n参数名称 | 必填 | 字段类型 | 说明 \n---|---|---|--- \nnamespaceId | 是 | string | 空间ID \ndeviceId | 是 | string | 国标ID \nstart | 是 | integer | 查询开始时间(unix时间戳,单位为秒) \nend | 是 | integer | 查询结束时间(unix时间戳,单位为秒) \nchId | 否 | string | 网关设备时为通道ID(普通设备可以忽略) \nalarmMethod | 否 | integer | 报警方式：1为电话报警， 2为设备报警， 3为短信报警， 4为GPS报警， 5为视频报警， 6为设备故障报警， 7其他报警 \nalarmType | 否 | integer | 报警类型，详见`报警类型说明` \noffset | 否 | integer | 在全部报警事件中的偏移量 \nline | 否 | integer | 一次返回多少条 \nsortBy | 否 | string | 排序方式， asc: 按报警时间升序 desc: 按报警时间降序 \n \n## **报警类型说明**\n\n * 报警方式（alarmMethod）为2时， \n不携带alarmType为默认的报警设备报警； \n携带alarmType取值及对应报警类型：1-视频丢失报警； 2-设备防拆报警； 3-存储设备磁盘满报警； 4-设备高温报警； 5-设备低温报警。\n\n * 报警方式（alarmMethod）为5时， \n取值如下：1-人工视频报警； 2-运动目标检测报警； 3-遗留物检测报警； 4-物体移除检测报警； 5-绊线检测报警；6-入侵检测报警； 7-逆行检测报警；\n8-徘徊检测报警； 9-流量统计报警； 10-密度检测报警； 11-视频异常检测报警； 12-快速移动报警。\n\n * 报警方式（alarmMethod）为6时， \n取值如下： 1-存储设备磁盘故障报警； 2-存储设备风扇故障报警。\n\n# **响应参数**\n\n参数名称 | 类型 | 说明 \n---|---|--- \ntotal | integer | 报警条数 \nitems | 事件数组 | 事件数组 \nitems.chId | string | 通道id \nitems.chName | string | 通道名称 \nitems.deviceState | string | 设备状态 “online”/“offline” \nitems.alarmTime | integer | 报警时间，Unix时间戳,单位秒 \nitems.alarmMethod | integer | 报警方式：1为电话报警， 2为设备报警， 3为短信报警， 4为GPS报警， 5为视频报警， 6为设备故障报警， 7其他报警 \nitems.alarmType | integer | 报警类型,详见`报警类型说明` \nitems.alarmPriority | integer | 报警级别。 取值：1(一级警情),2(二级警情),3(三级警情),4(四级警情) \n \n# **示例**\n\n**请求示例**\n\n \n \n curl --request GET \\\n --url 'qvs.qiniuapi.com/v1/namespaces/2akrarrzns76w/devices/31011500991180000083/alarms?start=1587899020&end=1587968104&chId=34020000001310000034&alarmMethod=5&alarmType=2&' \\\n --header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='\n \n\n**响应示例**\n\n \n \n {\n \"items\": [\n {\n \"chId\": \"34020000001310000034\",\n \"chName\": \"ipc1\",\n \"deviceState: \"online\",\n \"alarmTime\": \"1607311045\",\n \"alarmMethod\": 5,\n \"alarmType\":2,\n \"alarmPriority\":3\n },\n {\n \"chId\": \"34020000001310000035\",\n \"chName\": \"ipc2\",\n \"deviceState: \"offline\",\n \"alarmTime\": \"1607311045\",\n \"alarmMethod\": 2,\n \"alarmType\":3,\n \"alarmPriority\":4\n }\n ],\n \"total\": 2\n }\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的视频监控布防撤防"
},
{
"from": "gpt",
"value": "[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 国标报警相关接口 >布防撤防\n\n# 布防撤防\n\n最近更新时间: 2023-02-21 11:38:36\n\n# **描述**\n\n本接口用于控制设备的布防与撤防，如果要开启或关闭GB28181报警，需要请求此接口。\n\n * 接口请求域名：`qvs.qiniuapi.com`\n * 请求方式：POST\n * 接口路径：`/v1/namespaces/{namespaceId}/devices/{deviceId}/guard`\n\n# **请求参数**\n\n**路径参数**\n\n参数名称 | 必填 | 字段类型 | 说明 \n---|---|---|--- \nnamespaceId | 是 | string | 空间ID \ndeviceId | 是 | string | 设备Id \n \n**Body**\n\n参数名称 | 必填 | 字段类型 | 说明 \n---|---|---|--- \ncmd | string | 是 | 命令类型，布防:“SetGuard”,撤防:“ResetGuard” \nchId | 否 | string | 设备为`平台`类型：指定需要启动的通道ID, 设备为`摄像头`类型，无需指定 \n \n# **响应参数**\n\n200\n\n# **示例**\n\n**请求示例**\n\n \n \n curl --request POST \\\n --url http://qvs.qiniuapi.com/v1/namespaces/2akrarvzvyijd/devices/31011500991320000028/guard \\\n --header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \\\n --header 'content-type: application/json'\n --data '{\n \t\"cmd\":\"SetGuard\"\n }'\n \n\n**响应示例**\n\n \n \n {\n \"code\": 200\n }\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的视频监控查询流量数据"
},
{
"from": "gpt",
"value": "[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 数据统计相关接口 >查询流量数据\n\n# 查询流量数据\n\n最近更新时间: 2022-08-05 11:16:08\n\n# **描述**\n\n本接口用于查询用户或者空间下的流量数据\n\n * 接口请求域名：`qvs.qiniuapi.com`\n * 请求方式：GET\n * 接口路径：`/v1/stats/flow?nsId=<nsId>&streamId=<streamId>&start=<start>&end=<end>&tu=<Tu>`\n * Get请求，通过`非SDK`方式调用的客户，http头部Content-Type`要么置空`, `要么不要携带`,否则鉴权会失败; [公共http header说明 __](https://developer.qiniu.com/qvs/6709/qvs-http-headers)\n\n# **请求参数**\n\n**路径参数**\n\n参数名称 | 必填 | 字段类型 | 说明 \n---|---|---|--- \nnsId | 是 | string | 空间ID \nstreamId | 否 | string | 流ID，可以输入多个 \nstart | 是 | integer | 年月日模式(20191001)或者年月日时分秒模式(20201012204005) \nend | 是 | integer | 年月日模式(20191002)或者年月日时分秒模式(20201012204005) \ntu | 是 | string | 时间粒度 可以是 5min, hour, day \n \n# **响应参数**\n\n参数名称 | 类型 | 说明 \n---|---|--- \ntime | integer 数组 | 时间点数组(unix timestamp) \ndata | object | 上下行数据 \ndata.up | integer 数组 | 上行流量数据，单位：bytes，换算单位为1024 \ndata.down | integer 数组 | 下线流量数据，单位：bytes，换算单位为1024 \n \n# **示例**\n\n**请求示例**\n\n * 查询空间下某几路流的流量数据\n\n \n \n curl --request GET \\\n --url 'http://qvs.qiniuapi.com/v1/stats/flow?tu=day&nsId=3nm4x0vyz7xlu&start=20201015&end=20201016&streamId=31011500991320000580&streamId=31011500991320001037' \\\n --header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='\n \n\n**响应示例**\n\n \n \n {\n \"time\": [\n 1602691200\n ],\n \"data\": {\n \"up\": [\n 250225168\n ],\n \"down\": [\n 169983762\n ]\n }\n }\n \n\n * 查询整个空间下总共流量数据\n\n \n \n curl --request GET \\\n --url 'http://qvs.qiniuapi.com/v1/stats/flow?tu=day&nsId=3nm4x0vyz7xlu&start=20201015&end=20201016' \\\n --header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='\n \n\n**响应示例**\n\n \n \n {\n \"time\": [\n 1602691200\n ],\n \"data\": {\n \"up\": [\n 250225168\n ],\n \"down\": [\n 169983762\n ]\n }\n }\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的视频监控查询带宽数据"
},
{
"from": "gpt",
"value": "[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 数据统计相关接口 >查询带宽数据\n\n# 查询带宽数据\n\n最近更新时间: 2022-08-05 11:16:18\n\n# **描述**\n\n本接口用于查询用户或者空间下的带宽数据\n\n * 接口请求域名：`qvs.qiniuapi.com`\n * 请求方式：GET\n * 接口路径：`/v1/stats/bandwidth?nsId=<nsId>&streamId=<streamId>&start=<start>&end=<end>&tu=<Tu>`\n * Get请求，通过`非SDK`方式调用的客户，http头部Content-Type`要么置空`, `要么不要携带`,否则鉴权会失败; [公共http header说明 __](https://developer.qiniu.com/qvs/6709/qvs-http-headers)\n\n# **请求参数**\n\n**路径参数**\n\n参数名称 | 必填 | 字段类型 | 说明 \n---|---|---|--- \nnsId | 是 | string | 空间ID \nstreamId | 否 | string | 流ID，可以输入多个 \nstart | 是 | integer | 年月日模式(20191001)或者年月日时分秒模式(20201012204005) \nend | 是 | integer | 年月日模式(20191002)或者年月日时分秒模式(20201012204005) \ntu | 是 | string | 时间粒度 可以是 5min, hour, day \n \n# **响应参数**\n\n参数名称 | 类型 | 说明 \n---|---|--- \ntime | integer 数组 | 时间数组(unix timestamp) \ndata | object | 上下行数据 \ndata.up | integer 数组 | 上行带宽数据(bps)，单位：bit/second。 \ndata.down | integer 数组 | 下线带宽数据(bps)，单位：bit/second。 \n \n# **示例**\n\n**请求示例**\n\n * 查询空间某几路流的带宽数据\n\n \n \n curl --request GET \\\n --url 'http://qvs.qiniuapi.com/v1/stats/bandwidth?tu=day&nsId=3nm4x0vyz7xlu&start=20201015&end=20201016&streamId=31011500991320000580&streamId=31011500991320001037' \\\n --header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='\n \n\n**响应示例**\n\n \n \n {\n \"time\": [\n 1602691200\n ],\n \"data\": {\n \"up\": [\n 1441429\n ],\n \"down\": [\n 1103964\n ]\n }\n }\n \n\n * 查询整个空间下的带宽数据\n\n \n \n curl --request GET \\\n --url 'http://qvs.qiniuapi.com/v1/stats/bandwidth?tu=day&nsId=3nm4x0vyz7xlu&start=20201015&end=20201016' \\\n --header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='\n \n\n**响应示例**\n\n \n \n {\n \"time\": [\n 1602691200\n ],\n \"data\": {\n \"up\": [\n 1441429\n ],\n \"down\": [\n 1103964\n ]\n }\n }\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的视频监控推流路数统计"
},
{
"from": "gpt",
"value": "[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 数据统计相关接口 >推流路数统计\n\n# 推流路数统计\n\n最近更新时间: 2023-06-21 09:01:13\n\n# **描述**\n\n本接口用于推流路数统计\n\n * 接口请求域名：`qvs.qiniuapi.com`\n * 请求方式：GET\n * 接口路径：`/v1/stats/streamcount?nsId=<nsId>&start=<start>&end=<end>&tu=<Tu>`\n * Get请求，通过`非SDK`方式调用的客户，http头部Content-Type`要么置空`, `要么不要携带`,否则鉴权会失败; [公共http header说明 __](https://developer.qiniu.com/qvs/6709/qvs-http-headers)\n\n# **请求参数**\n\n**路径参数**\n\n参数名称 | 必填 | 字段类型 | 说明 \n---|---|---|--- \nstart | 是 | integer | 年月日模式(20191001)或者年月日时分秒模式(20201012204005) \nend | 是 | integer | 年月日模式(20191002)或者年月日时分秒模式(20201012204005) \ntu | 是 | string | 时间粒度 可以是 5min, hour, day \n \n# **响应参数**\n\n参数名称 | 类型 | 说明 \n---|---|--- \ntime | integer 数组 | 时间数组(unix timestamp) \ncount | integer 数组 | 流数量 \n \n# **示例**\n\n**请求示例**\n\n \n \n curl --request GET \\\n --url 'http://qvs.qiniuapi.com/v1/stats/streamcount?tu=day&start=20210201&end=20210205' \\\n --header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='\n \n\n**响应示例**\n\n \n \n {\n \"time\": [\n 1612108800,\n 1612195200,\n 1612281600,\n 1612368000\n ],\n \"count\": [\n 0,\n 0,\n 1,\n 0\n ]\n }\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的视频监控查询国标接入设备数"
},
{
"from": "gpt",
"value": "[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 数据统计相关接口 >查询国标接入设备数\n\n# 查询国标接入设备数\n\n最近更新时间: 2022-08-05 11:16:34\n\n# **描述**\n\n本接口用于查询国标接入设备数量。最小粒度一天，数据延迟一天。\n\n * 接口请求域名：`qvs.qiniuapi.com`\n * 请求方式：GET\n * 接口路径：`/v1/stats/gbcount?nsId=<nsId>&start=<start>&end=<end>&tu=<Tu>`\n * Get请求，通过`非SDK`方式调用的客户，http头部Content-Type`要么置空`, `要么不要携带`,否则鉴权会失败; [公共http header说明 __](https://developer.qiniu.com/qvs/6709/qvs-http-headers)\n\n# **请求参数**\n\n**路径参数**\n\n参数名称 | 必填 | 字段类型 | 说明 \n---|---|---|--- \nnsId | 否 | string | 空间ID。如果不填，则查询名下所有的国标设备 \nstart | 是 | integer | 年月日模式(20191001)或者年月日时分秒模式(20201012204005) \nend | 是 | integer | 年月日模式(20191002)或者年月日时分秒模式(20201012204005) \ntu | 是 | string | 时间粒度 可以是day, month \n \n# **响应参数**\n\n参数名称 | 类型 | 说明 \n---|---|--- \ntime | integer 数组 | 时间数组(unix timestamp) \ncount | integer 数组 | 设备数量 \n \n# **示例**\n\n**请求示例**\n\n \n \n curl --request GET \\\n --url 'http://qvs.qiniuapi.com/v1/stats/gbcount?start=20210201&end=20210205&tu=day' \\\n --header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='\n \n\n**响应示例**\n\n \n \n {\n \"time\": [\n 1612108800,\n 1612195200,\n 1612281600,\n 1612368000\n ],\n \"count\": [\n 39,\n 41,\n 27,\n 25\n ]\n }\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的视频监控PHP SDK"
},
{
"from": "gpt",
"value": "[视频监控](https://developer.qiniu.com/qvs) > SDK 下载 > 服务端SDK >PHP SDK\n\n# PHP SDK\n\n最近更新时间: 2023-03-29 17:10:37\n\n# **简介**\n\n此SDK主要帮助您快速接入七牛云的视频监控平台\n\n此 SDK ( version: 7.x.x ) 适用于**PHP >= 5.3.0**。\n\n * [PHP SDK 下载地址 __](https://github.com/qiniu/php-sdk/releases)\n * [PHP SDK 源码地址 __](https://github.com/qiniu/php-sdk)\n\n此 SDK 包含了如下几个功能：\n\n * 创建空间示例。\n\n# 安装\n\n支持以下3种安装 SDK 的方法，推荐通过[Composer __](https://getcomposer.org/)安装 SDK。\n\n * 使用 Composer 安装\n\n[Composer __](http://getcomposer.org/)是 PHP\n依赖管理工具。你可以在自己的项目中声明所依赖的外部工具库，Composer 会自动帮你安装这些依赖的库文件。\n\n1\\. 安装 Composer\n\n \n \n curl -sS https://getcomposer.org/installer | php\n \n\n2\\. 运行 Composer 命令安装最新稳定版本的 SDK：\n\n \n \n php composer.phar require qiniu/php-sdk\n \n\n3\\. Require Composer 生成的 autoloader：\n\n \n \n <?php\n require 'vendor/autoload.php';\n \n\n如果需要更详细的关于 Composer 的使用说明，你可以访问[Composer官方网站\n__](http://getcomposer.org/)，或对应的[中文网站 __](http://www.phpcomposer.com/)。\n\n * 直接下载 Composer 安装包\n\n鉴于某些原因，国内的用户使用 Composer 下载依赖库比较慢，开发者也可以直接下载我们准备好的符合 Composer 规范的[vendor 压缩包\n__](http://qupfile.cloudvdn.com/vendor.zip)并在本地解压。解压后的内容和使用 Composer\n方式获取到的内容完全一致，之后的使用方式也一致。\n\n * 下载源代码包\n\n直接下载源代码压缩包并解压是另一种 SDK 的安装方法。不过因为有版本更新的维护问题，这种安装方法并不推荐，仅作为万一 Composer\n安装有问题的情况下的一种备选。并且，源码中也包含 SDK 的 [autoloader __](https://github.com/qiniu/php-\nsdk/blob/master/autoload.php)。\n\n下载[源代码包 __](https://github.com/qiniu/php-sdk/releases)后，解压到您的项目中。 然后在您的项目中引入\nautoloader：\n\n \n require 'path_to_sdk/autoload.php';\n \n\n# 基本使用方法\n\n安装好 SDK 后，接下来介绍如何使用 SDK。在使用 SDK 之前，\n\n 1. 点击[注册 __](https://portal.qiniu.com/signup)开通 七牛开发者帐号\n 2. 如果已有账号，直接登录七牛开发者后台，点击[这里 __](https://portal.qiniu.com/user/key)查看 Access Key 和 Secret Key\n\n## 引入SDK\n\n无论你是通过哪种方式安装的 SDK，只需要一句简单的 **require**\n语句将安装好的SDK包含到你的项目中。请参考如下表格，找到适合你的安装方式，将SDK引入到你的项目中。请用你项目中的实际路径替换\n**path_to_sdk** 。\n\n安装方式 | 引入SDK \n---|--- \nComposer 安装 | require ‘path_to_sdk/vendor/autoload.php’; \n下载Composer安装包 | require ‘path_to_sdk/vendor/autoload.php’; \n下载源码安装包 | require ‘path_to_sdk/autoload.php’; \n \n## SDK结构\n\n可以直接查看我们的[SDK目录 __](https://github.com/qiniu/php-\nsdk/tree/master/src/Qiniu)，即可大致了解我们 SDK 的结构。\n\n * 最外层包含：配置文件， 鉴权和一些公共的函数。\n * HTTP 目录主要包含了一些对 http 进行封装的类，这块你可以不用关心。\n * Storage 目录对应七牛kodo产品的相关API\n * Cdn 目录主要包含了七牛CDN产品的相关API\n * Qvs目前没有集成进来，`客户可在该目录下，自行新建Qvs`,放置Qvs产品的相关API。[对应的API文档 __](https://developer.qiniu.com/qvs/6706/summary-of-the-api)\n\n为了帮助您更好的了解和使用我们的sdk，我们还提供了各种[使用示例 __](https://github.com/qiniu/php-\nsdk/tree/master/examples)。 如果使用中遇到问题，可以通过[Github\n__](https://github.com/qiniu/php-sdk/issues/new)或者我们的[工单\n__](http://support.qiniu.com/)进行反馈。下面我们对一些关键点进行简单的介绍，方便您快速入门。\n\n## 鉴权类\n\n在使用SDK的过程中鉴权是很重要的一块，所有的API请求都需要鉴权，鉴权逻辑是通用的。 PHP SDK 中的 Auth 类封装了所有的鉴权方式。 \n所以在使用 PHP SDK 时基本都会先对鉴权类进行初始化：\n\n \n \n <?php\n require 'path_to_sdk/vendor/autoload.php';\n use Qiniu\\Auth;\n // 用于签名的公钥和私钥\n $accessKey = 'Access_Key';\n $secretKey = 'Secret_Key';\n \n // 初始化签权对象\n $auth = new Auth($accessKey, $secretKey);\n \n\n# 创建空间[API __](https://developer.qiniu.com/qvs/6726/create-namespace)\n\n### 示例\n\n \n \n <?php\n require_once __DIR__ . 'path_to_sdk/autoload.php';\n use \\Qiniu\\Auth;\n use Qiniu\\Http\\Client;\n \n $accessKey = '';\n $secretKey = '';\n \n $auth = new Auth($accessKey, $secretKey);\n \n $url = \"http://qvs.qiniuapi.com/v1/namespaces\";\n \n \n $host = \"qvs.qiniuapi.com\";\n \n $method = \"POST\";\n $contentType = \"application/json\"; \n // 重要的事情说3遍\n // 如果是Get请求(http body为空)，contentType请设置为application/x-www-form-urlencoded, 或者null\n // 如果是Get请求(http body为空)，contentType请设置为application/x-www-form-urlencoded, 或者null\n // 如果是Get请求(http body为空)，contentType请设置为application/x-www-form-urlencoded, 或者null\n \n $body = '{}';\n \n //Qiniu Token\n $headers = $auth->authorizationV2($url, $method, $body, $contentType);\n \n \n //QBox Token\n //$headers = $auth->authorization($url, $body, $contentType);\n \n $headers['Content-Type'] = $contentType;\n $headers['Host'] = $host;\n \n $response = Client::post($url, $body, $headers);\n \n var_dump($response);\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的视频监控Python SDK"
},
{
"from": "gpt",
"value": "[视频监控](https://developer.qiniu.com/qvs) > SDK 下载 > 服务端SDK >Python SDK\n\n# Python SDK\n\n最近更新时间: 2024-08-28 15:22:08\n\n# **简介**\n\n此SDK主要帮助您快速接入七牛云的视频监控平台。\n\n主要有如下功能：\n\n * 空间管理\n * 流管理\n * 设备管理\n * 模板管理\n * 录制管理\n\n此 Python SDK 适用于 2.7 和 3.3及以上版本。\n\n * [Python SDK 下载地址 __](https://github.com/qiniu/python-sdk/releases)\n * [Python SDK 源码地址 __](https://github.com/qiniu/python-sdk)\n\n# 安装\n\n * 直接安装:\n\n \n \n pip install qiniu\n 或\n easy_install qiniu\n \n\n * 源码安装：\n\n \n \n #从Python SDK 下载地址下载源码\n tar xvzf python-sdk-$VERSION.tar.gz\n cd python-sdk-$VERSION\n python setup.py install\n \n\n# **初始化鉴权**\n\n七牛 Java SDK 的所有的功能，都需要合法的授权。授权凭证的签算需要七牛账号下的一对有效的`Access Key`和`Secret\nKey`，这对密钥可以通过如下步骤获得：\n\n 1. 点击[注册 __](https://portal.qiniu.com/signup)开通七牛开发者帐号\n 2. 如果已有账号，直接登录七牛开发者后台，点击[这里🔗 __](https://portal.qiniu.com/user/key)查看 Access Key 和 Secret Key\n\n# **前置说明**\n\n 1. QVS更新接口使用的是patch请求，SDK中未添加该方法，客户可以在python SDK qiniu/http.py 文件中添加下面这个方法\n\n \n \n def _patch_with_qiniu_mac(url, data, auth):\n qn_auth = qiniu.auth.QiniuMacRequestsAuth(\n auth) if auth is not None else None\n timeout = config.get_default('connection_timeout')\n try:\n r = requests.patch(\n url,\n json=data,\n auth=qn_auth,\n timeout=timeout,\n headers=_headers)\n except Exception as e:\n return None, ResponseInfo(None, e)\n return __return_wrapper(r)\n \n\n 2. 客户可在python-sdk/qiniu/services目录下创建qvs的子目录，后续的接口函数全部放置在python-sdk/qiniu/services/qvs即可。\n\n# **空间管理**\n\n## **[创建空间 __](https://developer.qiniu.com/qvs/6726/create-namespace)**\n\n### 示例\n\n \n \n # -*- coding: utf-8 -*-\n from qiniu import QiniuMacAuth, http\n import json\n \n \n def createNamespaces(access_key, secret_key, body):\n \"\"\"\n 创建空间\n https://developer.qiniu.com/qvs/api/6726/create-namespace\n :param access_key: 公钥\n :param secret_key: 私钥\n :param body: 请求体\n {\n \"name\": 必填，空间名称(格式\"^[a-zA-Z0-9_-]{1,100}$\")\n \"desc\"：非必填，空间描述\n \"accessType\": 必填，接入类型(rtmp或者gb28181)\n \"rtmpUrlType\": accessType为“rtmp”时 必填，推拉流地址计算方式，1:static, 2:dynamic\n \"domains\": rtmpUrlType为1时必填，直播域名，列表格式\n \"callBack\"：非必填，回调地址，可用于获取空间内设备/流状态更新时的信息\n \"recordTemplateId\": 非必填，录制模版ID，需要录制功能时输入对应的模板ID，录制模板ID可以模板管理中获取\n \"snapshotTemplateId\"：非必填，截图模版ID，需要截图功能时输入对应的模板ID，截图模板ID可以模板管理中获取\n \"recordTemplateApplyAll\"：非必填，空间模版是否应用到全局\n \"snapshotTemplateApplyAll\"：非必填，截图模版是否应用到全局\n }\n \n :return:\n {\n \n }\n \"\"\"\n auth = QiniuMacAuth(access_key, secret_key)\n \n # 请求URL\n url = \"http://qvs.qiniuapi.com/v1/namespaces\"\n \n # \n # 发起POST请求\n ret, res = http._post_with_qiniu_mac(url, body, auth)\n headers = {\"code\": res.status_code, \"reqid\": res.req_id, \"xlog\": res.x_log, \"text_body\": res.text_body}\n \n # 格式化响应体\n Headers = json.dumps(headers, indent=4, ensure_ascii=False)\n result = json.dumps(ret, indent=4, ensure_ascii=False)\n return Headers, result\n \n \n if __name__ == '__main__':\n # 七牛账号 AK、SK\n access_key = '<access_key>'\n secret_key = '<secret_key>'\n # 请求体\n body = {\n \"name\": \"test00\",\n \"accessType\": \"rtmp\",\n \"rtmpUrlType\": 2,\n # \"domains\": [\"tests6.com\"],\n # \"recordTemplateId\": \"xxxxxxxxxxx\"\n }\n \n headers, result = createNamespaces(access_key, secret_key, body)\n print(f'{headers}\\n{result}')\n \n\n \n\n## **[查询空间 __](https://developer.qiniu.com/qvs/api/6729/query-namespace)**\n\n### 示例\n\n \n \n // 查询空间\n # -*- coding: utf-8 -*-\n from qiniu import QiniuMacAuth, http\n import json\n \n \n def listNamespacesInfo(access_key, secret_key, namespaceId):\n \"\"\"\n 查询空间信息\n https://developer.qiniu.com/qvs/api/6729/query-namespace\n :param access_key: 公钥\n :param secret_key: 私钥\n :param namespaceId: 空间ID\n \n :return:\n {\n \"code\": 200\n }\n \"\"\"\n auth = QiniuMacAuth(access_key, secret_key)\n \n # 请求URL\n url = f\"http://qvs.qiniuapi.com/v1/namespaces/{namespaceId}\"\n \n # 发起POST请求\n ret, res = http._get_with_qiniu_mac(url, params=None, auth=auth)\n headers = {\"code\": res.status_code, \"reqid\": res.req_id, \"xlog\": res.x_log, \"text_body\": res.text_body}\n \n # 格式化响应体\n Headers = json.dumps(headers, indent=4, ensure_ascii=False)\n result = json.dumps(ret, indent=4, ensure_ascii=False)\n return Headers, result\n \n \n if __name__ == '__main__':\n # 七牛账号 AK、SK\n access_key = '<access_key>'\n secret_key = '<secret_key>'\n \n # 需要查询的空间ID\n namespaceId = \"xxxxxxxxxxx\"\n \n headers, result = listNamespacesInfo(access_key, secret_key, namespaceId)\n print(f'{headers}\\n{result}')\n \n\n \n\n## **[更新空间 __](https://developer.qiniu.com/qvs/api/6728/update-namespace)**\n\n### 示例\n\n \n \n # -*- coding: utf-8 -*-\n from qiniu import QiniuMacAuth, http\n import json\n \n \n def updateNamespaces(access_key, secret_key, namespaceId, body):\n \"\"\"\n 更新空间\n https://developer.qiniu.com/qvs/api/6728/update-namespace\n :param access_key: 公钥\n :param secret_key: 私钥\n :param namespaceId: 空间ID\n :param body: 请求体\n {\n \"operations\":[\n {\"key\":\"recordTemplateApplyAll\", // 要修改的参数：name 空间名称;desc 空间描述;callBack 回调地址;recordTemplateId 录制模版ID;snapshotTemplateId 截图模版ID; recordTemplateApplyAll 空间模版是否应用到全局; snapshotTemplateApplyAll 截图模版是否应用到全局\n \"op\":\"replace\", // op操作(目前支持replace和delete)\n \"value\":true}， // 要修改的参数对应的value(当op为delete的时候可以忽略)\n { },\n .....\n ]\n }\n :return:\n {\n \"code\": 200\n }\n \"\"\"\n auth = QiniuMacAuth(access_key, secret_key)\n \n # 请求URL\n url = f\"http://qvs.qiniuapi.com/v1/namespaces/{namespaceId}\"\n \n # 发起PATCH请求\n ret, res = http._patch_with_qiniu_mac(url, body, auth)\n headers = {\"code\": res.status_code, \"reqid\": res.req_id, \"xlog\": res.x_log, \"text_body\": res.text_body}\n \n # 格式化响应体\n Headers = json.dumps(headers, indent=4, ensure_ascii=False)\n result = json.dumps(ret, indent=4, ensure_ascii=False)\n return Headers, result\n \n \n if __name__ == '__main__':\n # 七牛账号 AK、SK\n access_key = '<access_key>'\n secret_key = '<secret_key>'\n \n # 需要更新的空间ID\n namespaceId = \"xxxxxxxxxxx\"\n \n # 请求体\n body = {\n \"operations\": [\n {\"key\": \"name\", \"op\": \"replace\", \"value\": \"\"xxxxxxxxxxx\"\"}\n ]\n }\n \n headers, result = updateNamespaces(access_key, secret_key, namespaceId, body)\n print(f'{headers}\\n{result}')\n \n\n## **[获取空间列表 __](https://developer.qiniu.com/qvs/api/6730/list-namespace)**\n\n### 示例\n\n \n \n # -*- coding: utf-8 -*-\n from qiniu import QiniuMacAuth, http\n import json\n \n \n def listNamespaces(access_key, secret_key, offset=None, line=10, sortBy=\"desc:createdAt\"):\n \"\"\"\n 获取空间列表\n https://developer.qiniu.com/qvs/api/6730/list-namespace\n :param access_key: 公钥\n :param secret_key: 私钥\n :param offset: 在全部namespace中的偏移量，时间戳\n :param line: 一次返回多少条\n :param sortBy: asc 表示升序, desc 表示降序, 默认按创建时间降序排列(可参与排序的字段有createdAt, updatedAt).asc:updatedAt表示更新时间从小到大排序, desc:updatedAt表示更新时间从大到小排序\n \n :return:\n 200 { }\n \"\"\"\n auth = QiniuMacAuth(access_key, secret_key)\n if offset is None:\n # 请求URL\n url = f\"http://qvs.qiniuapi.com/v1/namespaces?line={line}&sortBy={sortBy}\"\n else:\n url = f\"http://qvs.qiniuapi.com/v1/namespaces?offset={offset}&line={line}&sortBy={sortBy}\"\n # 发起POST请求\n ret, res = http._get_with_qiniu_mac(url, params=None, auth=auth)\n headers = {\"code\": res.status_code, \"reqid\": res.req_id, \"xlog\": res.x_log, \"text_body\": res.text_body}\n \n # 格式化响应体\n Headers = json.dumps(headers, indent=4, ensure_ascii=False)\n result = json.dumps(ret, indent=4, ensure_ascii=False)\n return Headers, result\n \n if __name__ == '__main__':\n # 七牛账号 AK、SK\n access_key = '<access_key>'\n secret_key = '<secret_key>'\n \n headers, result = listNamespaces(access_key, secret_key)\n print(f'{headers}\\n{result}') \n \n\n## **[禁用空间 __](https://developer.qiniu.com/qvs/api/6759/disable-the-space)**\n\n### 示例\n\n \n \n # -*- coding: utf-8 -*-\n from qiniu import QiniuMacAuth, http\n import json\n \n \n def disableNamespaces(access_key, secret_key, namespaceId):\n \"\"\"\n 禁用空间\n https://developer.qiniu.com/qvs/api/6759/disable-the-space\n :param access_key: 公钥\n :param secret_key: 私钥\n :param namespaceId: 空间ID\n \n :return:\n {\n \"code\": 200\n }\n \"\"\"\n auth = QiniuMacAuth(access_key, secret_key)\n \n # 请求URL\n url = f\"http://qvs.qiniuapi.com/v1/namespaces/{namespaceId}/disabled\"\n \n # 发起POST请求\n ret, res = http._post_with_qiniu_mac(url, None, auth=auth)\n headers = {\"code\": res.status_code, \"reqid\": res.req_id, \"xlog\": res.x_log, \"text_body\": res.text_body}\n \n # 格式化响应体\n Headers = json.dumps(headers, indent=4, ensure_ascii=False)\n result = json.dumps(ret, indent=4, ensure_ascii=False)\n return Headers, result\n \n if __name__ == '__main__':\n # 七牛账号 AK、SK\n access_key = '<access_key>'\n secret_key = '<secret_key>'\n \n # 需要查询的空间ID\n namespaceId = \"xxxxxxxxxxx\"\n \n headers, result = disableNamespaces(access_key, secret_key, namespaceId)\n print(f'{headers}\\n{result}')\n \n \n\n## **[启用空间 __](https://developer.qiniu.com/qvs/api/6760/enable-the-space)**\n\n### 示例\n\n \n \n # -*- coding: utf-8 -*-\n from qiniu import QiniuMacAuth, http\n import json\n \n \n def disableNamespaces(access_key, secret_key, namespaceId):\n \"\"\"\n 启用空间\n https://developer.qiniu.com/qvs/api/6760/enable-the-space\n :param access_key: 公钥\n :param secret_key: 私钥\n :param namespaceId: 空间ID\n \n :return:\n {\n \"code\": 200\n }\n \"\"\"\n auth = QiniuMacAuth(access_key, secret_key)\n \n # 请求URL\n url = f\"http://qvs.qiniuapi.com/v1/namespaces/{namespaceId}/enabled\"\n \n # 发起POST请求\n ret, res = http._post_with_qiniu_mac(url, None, auth=auth)\n headers = {\"code\": res.status_code, \"reqid\": res.req_id, \"xlog\": res.x_log, \"text_body\": res.text_body}\n \n # 格式化响应体\n Headers = json.dumps(headers, indent=4, ensure_ascii=False)\n result = json.dumps(ret, indent=4, ensure_ascii=False)\n return Headers, result\n \n if __name__ == '__main__':\n # 七牛账号 AK、SK\n access_key = '<access_key>'\n secret_key = '<secret_key>'\n \n # 需要查询的空间ID\n namespaceId = \"xxxxxxxxxxx\"\n \n headers, result = disableNamespaces(access_key, secret_key, namespaceId)\n print(f'{headers}\\n{result}')\n \n\n## **[删除空间 __](https://developer.qiniu.com/qvs/api/6727/delete-namespace)**\n\n### 示例\n\n \n \n # -*- coding: utf-8 -*-\n from qiniu import QiniuMacAuth, http\n import json\n \n \n def deleteNamespaces(access_key, secret_key, namespaceId):\n \"\"\"\n 删除空间\n https://developer.qiniu.com/qvs/api/6727/delete-namespace\n :param access_key: 公钥\n :param secret_key: 私钥\n :param namespaceId: 空间ID\n \n :return:\n {\n \"code\": 200\n }\n \"\"\"\n auth = QiniuMacAuth(access_key, secret_key)\n \n # 请求URL\n url = f\"http://qvs.qiniuapi.com/v1/namespaces/{namespaceId}\"\n \n # 发起POST请求\n ret, res = http._delete_with_qiniu_mac(url, params=None, auth=auth)\n headers = {\"code\": res.status_code, \"reqid\": res.req_id, \"xlog\": res.x_log, \"text_body\": res.text_body}\n \n # 格式化响应体\n Headers = json.dumps(headers, indent=4, ensure_ascii=False)\n result = json.dumps(ret, indent=4, ensure_ascii=False)\n return Headers, result\n \n \n if __name__ == '__main__':\n # 七牛账号 AK、SK\n access_key = '<access_key>'\n secret_key = '<secret_key>'\n \n # 需要删除的空间ID\n namespaceId = \"xxxxxxxxxxx\"\n \n headers, result = deleteNamespaces(access_key, secret_key, namespaceId)\n print(f'{headers}\\n{result}')\n \n\n# **流管理**\n\n## **[创建流 __](https://developer.qiniu.com/qvs/api/6734/create-flow)**\n\n本接口仅用于接入类型为RTMP的空间\n\n### 示例\n\n \n \n # -*- coding: utf-8 -*-\n from qiniu import QiniuMacAuth, http\n import json\n \n \n def createStreams(access_key, secret_key, namespaceId, body):\n \"\"\"\n 创建流\n https://developer.qiniu.com/qvs/api/6734/create-flow\n :param access_key: 公钥\n :param secret_key: 私钥\n :param namespaceId: 空间ID\n :param body： 请求体\n {\n \"streamId\":\"device009\", // 必填，流名称, 流名称在空间中唯一，可包含 字母、数字、中划线、下划线；1 ~ 100 个字符长；创建后将不可修改\n \"desc\":\"流说明信息\", // 非必填，关于流的描述信息\n \"recordTemplateId\":\"d102sns2mwhd\", // 非必填，录制模版ID，配置流维度的录制模板\n \"snapshotTemplateId\":\"截图模板ID\" // 非必填，截图模版ID，配置流维度的截图模板\n }\n \n :return:\n 200 { }\n \"\"\"\n auth = QiniuMacAuth(access_key, secret_key)\n \n # 请求URL\n url = f\"http://qvs.qiniuapi.com/v1/namespaces/{namespaceId}/streams\"\n \n # 发起POST请求\n ret, res = http._post_with_qiniu_mac(url, body, auth=auth)\n headers = {\"code\": res.status_code, \"reqid\": res.req_id, \"xlog\": res.x_log, \"text_body\": res.text_body}\n \n # 格式化响应体\n Headers = json.dumps(headers, indent=4, ensure_ascii=False)\n result = json.dumps(ret, indent=4, ensure_ascii=False)\n return Headers, result\n \n \n if __name__ == '__main__':\n # 七牛账号 AK、SK\n access_key = '<access_key>'\n secret_key = '<secret_key>'\n \n # 需要查询的空间ID\n namespaceId = \"xxxxxxxxxxx\"\n \n # 请求体\n body = {\n \"streamId\": \"xxxxxxxxxxx\",\n \"desc\": \"创建流测试\",\n # \"recordTemplateId\": \"xxxxxxxxxxx\"\n }\n \n headers, result = createStreams(access_key, secret_key, namespaceId, body)\n print(f'{headers}\\n{result}')\n \n\n## **[查询流 __](https://developer.qiniu.com/qvs/api/6736/query-information-\nflow)**\n\n### 示例\n\n \n \n # -*- coding: utf-8 -*-\n from qiniu import QiniuMacAuth, http\n import json\n \n \n def streamsInfo(access_key, secret_key, namespaceId, streamId):\n \"\"\"\n 查询流信息\n https://developer.qiniu.com/qvs/api/6736/query-information-flow\n :param access_key: 公钥\n :param secret_key: 私钥\n :param namespaceId: 空间ID\n :param streamId: 流名ID\n \n :return:\n {\n \"code\": 200\n }\n \"\"\"\n auth = QiniuMacAuth(access_key, secret_key)\n \n # 请求URL\n url = f\"http://qvs.qiniuapi.com/v1/namespaces/{namespaceId}/streams/{streamId}\"\n \n # 发起GET请求\n ret, res = http._get_with_qiniu_mac(url, params=None, auth=auth)\n headers = {\"code\": res.status_code, \"reqid\": res.req_id, \"xlog\": res.x_log, \"text_body\": res.text_body}\n \n # 格式化响应体\n Headers = json.dumps(headers, indent=4, ensure_ascii=False)\n result = json.dumps(ret, indent=4, ensure_ascii=False)\n return Headers, result\n \n \n if __name__ == '__main__':\n # 七牛账号 AK、SK\n access_key = '<access_key>'\n secret_key = '<secret_key>'\n \n # 需要查询的空间ID\n namespaceId = \"xxxxxxxxxxx\"\n \n # 流名ID\n streamId = \"xxxxxxxxxxx\"\n \n headers, result = streamsInfo(access_key, secret_key, namespaceId, streamId)\n print(f'{headers}\\n{result}')\n \n\n## **[更新流 __](https://developer.qiniu.com/qvs/api/6758/update-the-flow)**\n\n### 示例\n\n \n \n # -*- coding: utf-8 -*-\n from qiniu import QiniuMacAuth, http\n import json\n \n \n def updateStreams(access_key, secret_key, namespaceId, streamId, body):\n \"\"\"\n 更新流\n https://developer.qiniu.com/qvs/api/6758/update-the-flow\n :param access_key: 公钥\n :param secret_key: 私钥\n :param namespaceId: 空间ID\n :param streamId: 流名ID\n :param body: 请求体\n {\n \"operations\":[\n {\"key\":\"desc\", // 必填，要修改的参数：desc 流描述;recordTemplateId 录制模版ID;snapshotTemplateId 截图模版ID; disabled 流是否被禁用\n \"op\":\"replace\", // 必填，op操作(目前支持replace和delete)\n \"value\":true}， // 必填，要修改的参数对应的value(当op为delete的时候可以忽略)\n { },\n .....\n ]\n }\n \n :return:\n {\n \"code\": 200\n }\n \"\"\"\n auth = QiniuMacAuth(access_key, secret_key)\n \n # 请求URL\n url = f\"http://qvs.qiniuapi.com/v1/namespaces/{namespaceId}/streams/{streamId}\"\n \n # 发起PATCH请求\n ret, res = http._patch_with_qiniu_mac(url, body, auth)\n headers = {\"code\": res.status_code, \"reqid\": res.req_id, \"xlog\": res.x_log, \"text_body\": res.text_body}\n \n # 格式化响应体\n Headers = json.dumps(headers, indent=4, ensure_ascii=False)\n result = json.dumps(ret, indent=4, ensure_ascii=False)\n return Headers, result\n \n if __name__ == '__main__':\n # 七牛账号 AK、SK\n access_key = '<access_key>'\n secret_key = '<secret_key>'\n \n # 需要查询的空间ID\n namespaceId = \"xxxxxxxxxxx\"\n \n # 流名ID\n streamId = \"xxxxxxxxxxx\"\n \n # 请求体\n body = {\n \"operations\": [\n {\"key\": \"desc\", \"op\": \"replace\", \"value\": \"ceshi121212\"}\n ]\n }\n \n headers, result = updateStreams(access_key, secret_key, namespaceId, streamId, body)\n print(f'{headers}\\n{result}')\n \n\n## **[获取流列表 __](https://developer.qiniu.com/qvs/api/6737/query-list-flow)**\n\n### 示例\n\n \n \n # -*- coding: utf-8 -*-\n from qiniu import QiniuMacAuth, http\n import json\n \n \n def listStreams(access_key, secret_key, namespaceid, offset=None, line=10, qtype=0, prefix=None,\n sortBy=\"desc:createdAt\"):\n \"\"\"\n 获取流列表\n https://developer.qiniu.com/qvs/api/6737/query-list-flow\n :param access_key: 公钥\n :param secret_key: 私钥\n :param namespaceid: 空间名称ID\n :param offset: 在全部namespace中的偏移量，时间戳\n :param line: 一次返回多少条\n :param qtype: 查询流类型， 0:全部,1:在线流,2:离线流\n :param prefix: 流ID 前缀，可以流ID 前缀进行检索查询\n :param sortBy: asc 表示升序, desc 表示降序, 默认按创建时间降序排列(可参与排序的字段有createdAt, updatedAt).asc:updatedAt表示更新时间从小到大排序, desc:updatedAt表示更新时间从大到小排序\n \n :return:\n 200 { }\n \"\"\"\n auth = QiniuMacAuth(access_key, secret_key)\n if offset is None and prefix is None:\n # 请求URL\n url = f\"http://qvs.qiniuapi.com/v1/namespaces/{namespaceid}/streams?line={line}&sortBy={sortBy}&qtype={qtype}\"\n else:\n url = f\"http://qvs.qiniuapi.com/v1/namespaces/{namespaceid}/streams?offset={offset}&line={line}&qtype={qtype}&prefix={prefix}&sortBy={sortBy}\"\n # 发起GET请求\n ret, res = http._get_with_qiniu_mac(url, params=None, auth=auth)\n headers = {\"code\": res.status_code, \"reqid\": res.req_id, \"xlog\": res.x_log, \"text_body\": res.text_body}\n \n # 格式化响应体\n Headers = json.dumps(headers, indent=4, ensure_ascii=False)\n result = json.dumps(ret, indent=4, ensure_ascii=False)\n return Headers, result\n \n \n if __name__ == '__main__':\n # 七牛账号 AK、SK\n access_key = '<access_key>'\n secret_key = '<secret_key>'\n \n # 空间ID\n namespaceid = \"xxxxxxxxxxx\"\n \n headers, result = listStreams(access_key, secret_key, namespaceid, )\n print(f'{headers}\\n{result}')\n \n\n## **[获取流地址 __](https://developer.qiniu.com/qvs/api/6740/obtain-flow-\naddress)**\n\n### 示例\n\n \n \n # -*- coding: utf-8 -*-\n from qiniu import QiniuMacAuth, http\n import json\n \n \n def staticStreamDomain(access_key, secret_key, namespaceid, streamid, body):\n \"\"\"\n 静态模式流地址\n https://developer.qiniu.com/qvs/api/6800/static-model\n :param access_key: 公钥\n :param secret_key: 私钥\n :param namespaceid: 空间名称ID\n :param streamid: 流ID\n :param body: 请求体\n {\n \"domain\": \"qvs-live-hdl.qiniu.com\", // 必填，域名\n \"domainType\": \"liveHdl\", // 必填，域名类型,取值：\"publishRtmp\":rtmp推流, \"liveRtmp\": rtmp播放, \"liveHls\": hls播放, \"liveHdl\": flv播放\n \"urlExpireSec\": // 非必填，推流地址过期时间(单位为秒)\n }\n :return:\n 200 { }\n \"\"\"\n auth = QiniuMacAuth(access_key, secret_key)\n \n url = f\"http://qvs.qiniuapi.com/v1/namespaces/{namespaceid}/streams/{streamid}/domain\"\n \n # 请求header\n h = {\n \"content-type\": \"application/json\"\n }\n \n # 发起POST请求\n ret, res = http._post_with_qiniu_mac_and_headers(url, json.dumps(body), auth, headers=h)\n \n headers = {\"code\": res.status_code, \"reqid\": res.req_id, \"xlog\": res.x_log, \"text_body\": res.text_body}\n \n # 格式化响应体\n Headers = json.dumps(headers, indent=4, ensure_ascii=False)\n result = json.dumps(ret, indent=4, ensure_ascii=False)\n return Headers, result\n \n \n def dynamicStreamDomain(access_key, secret_key, namespaceid, streamid, body):\n \"\"\"\n 动态模式流地址\n https://developer.qiniu.com/qvs/api/6801/dynamic-model\n :param access_key: 公钥\n :param secret_key: 私钥\n :param namespaceid: 空间名称ID\n :param streamid: 流ID\n :param body: 请求体\n {\n \"publishIp\": \"\", // 非必填，推流端对外IP地址\n \"playIp\": \"\", // 非必填，拉流端对外IP地址\n \"urlExpireSec\": // 非必填，推流地址过期时间(单位为秒)\n }\n :return:\n 200 { }\n \"\"\"\n auth = QiniuMacAuth(access_key, secret_key)\n \n url = f\"http://qvs.qiniuapi.com/v1/namespaces/{namespaceid}/streams/{streamid}/urls\"\n \n # 请求header\n h = {\n \"content-type\": \"application/json\"\n }\n \n # 发起POST请求\n ret, res = http._post_with_qiniu_mac_and_headers(url, json.dumps(body), auth, headers=h) \n \n headers = {\"code\": res.status_code, \"reqid\": res.req_id, \"xlog\": res.x_log, \"text_body\": res.text_body}\n \n # 格式化响应体\n Headers = json.dumps(headers, indent=4, ensure_ascii=False)\n result = json.dumps(ret, indent=4, ensure_ascii=False)\n return Headers, result\n \n \n if __name__ == '__main__':\n # 七牛账号 AK、SK\n access_key = '<access_key>'\n secret_key = '<secret_key>'\n \n # 空间ID\n namespaceid = \"xxxxxxxxxxx\"\n \n # 流ID\n streamid = \"xxxxxxxxxxx\"\n \n \"\"\"静态模式请求体\"\"\"\n # # 请求体\n # body = {\n # \"domain\": \"\"xxxxxxxxxxx\"\",\n # \"domainType\": \"publishRtmp\"\n # }\n #\n # headers, result = staticStreamDomain(access_key, secret_key, namespaceid, streamid, body)\n # print(f'{headers}\\n{result}')\n \n \"\"\"动态模式请求体\"\"\"\n # 请求体\n body = {\n \"publishIp\": \"\"xxxxxxxxxxx\"\",\n \"playIp\": \"publishRtmp\"\n }\n \n headers, result = dynamicStreamDomain(access_key, secret_key, namespaceid, streamid, body)\n print(f'{headers}\\n{result}')\n \n\n## **[查询推流历史记录 __](https://developer.qiniu.com/qvs/api/6742/query-flow-\nrecords)**\n\n### 示例\n\n \n \n # -*- coding: utf-8 -*-\n from qiniu import QiniuMacAuth, http\n import json, time\n \n \n # 日期转时间戳\n def time2timestamp(datetime):\n # 转为时间数组\n timeArray = time.strptime(datetime, \"%Y-%m-%d %H:%M:%S\")\n timeStamp = int(time.mktime(timeArray))\n return timeStamp\n \n \n def listNamespaces(access_key, secret_key, namespaceId, streamId, startDate, endDate, offset=None, line=10):\n \"\"\"\n 获取推流记录\n https://developer.qiniu.com/qvs/api/6742/query-flow-records\n :param access_key: 公钥\n :param secret_key: 私钥\n :param offset: 非必填，在全部namespace中的偏移量，时间戳\n :param line: 非必填，一次返回多少条\n :param start: 必填，推流开始时间(unix timestamp in second)\n :param end: 必填，推流结束时间(unix timestamp in second)\n \n :return:\n 200 { }\n \"\"\"\n auth = QiniuMacAuth(access_key, secret_key)\n \n start = time2timestamp(startDate)\n \n end = time2timestamp(endDate)\n \n if offset is None:\n # 请求URL\n url = f\"http://qvs.qiniuapi.com/v1/namespaces/{namespaceId}/streams/{streamId}/pubhistories?start={start}&end={end}&line={line}\"\n else:\n url = f\"http://qvs.qiniuapi.com/v1/namespaces?start={start}&end={end}&line={line}&offset={offset}\"\n # 发起POST请求\n ret, res = http._get_with_qiniu_mac(url, params=None, auth=auth)\n headers = {\"code\": res.status_code, \"reqid\": res.req_id, \"xlog\": res.x_log, \"text_body\": res.text_body}\n \n # 格式化响应体\n Headers = json.dumps(headers, indent=4, ensure_ascii=False)\n result = json.dumps(ret, indent=4, ensure_ascii=False)\n return Headers, result\n \n if __name__ == '__main__':\n # 七牛账号 AK、SK\n access_key = '<access_key>'\n secret_key = '<secret_key>'\n \n # 空间ID\n namespaceId = \"xxxxxxxxxxx\"\n \n # 流ID\n streamId = \"xxxxxxxxxxx\"\n \n # 推流开始时间（Unix 时间戳）\n startDate = \"2020-06-08 00:00:00\"\n \n # 推流结束时间（Unix 时间戳）\n endDate = \"2020-06-09 00:00:00\"\n \n headers, result = listNamespaces(access_key, secret_key, namespaceId, streamId, startDate, endDate)\n print(f'{headers}\\n{result}')\n \n\n## **[禁用流 __](https://developer.qiniu.com/qvs/api/6738/disable-the-flow)**\n\n### 示例\n\n \n \n # -*- coding: utf-8 -*-\n from qiniu import QiniuMacAuth, http\n import json\n \n \n def disableStreams(access_key, secret_key, namespaceId, streamId):\n \"\"\"\n 禁用流\n https://developer.qiniu.com/qvs/api/6738/disable-the-flow\n :param access_key: 公钥\n :param secret_key: 私钥\n :param namespaceId: 空间ID\n :param streamId: 流ID\n \n :return:\n {\n \"code\": 200\n }\n \"\"\"\n auth = QiniuMacAuth(access_key, secret_key)\n \n # 请求URL\n url = f\"http://qvs.qiniuapi.com/v1/namespaces/{namespaceId}/streams/{streamId}/disabled\"\n \n # 发起POST请求\n ret, res = http._post_with_qiniu_mac(url, None, auth=auth)\n headers = {\"code\": res.status_code, \"reqid\": res.req_id, \"xlog\": res.x_log, \"text_body\": res.text_body}\n \n # 格式化响应体\n Headers = json.dumps(headers, indent=4, ensure_ascii=False)\n result = json.dumps(ret, indent=4, ensure_ascii=False)\n return Headers, result\n \n if __name__ == '__main__':\n # 七牛账号 AK、SK\n access_key = '<access_key>'\n secret_key = '<secret_key>'\n \n # 空间ID\n namespaceId = \"xxxxxxxxxxx\"\n \n # 流ID\n streamId = \"xxxxxxxxxxx\"\n \n headers, result = disableStreams(access_key, secret_key, namespaceId, streamId)\n print(f'{headers}\\n{result}')\n \n\n## **[启用流 __](https://developer.qiniu.com/qvs/api/6739/enable-the-flow)**\n\n### 示例\n\n \n \n // 启用流\n # -*- coding: utf-8 -*-\n from qiniu import QiniuMacAuth, http\n import json\n \n \n def enableStreams(access_key, secret_key, namespaceId, streamId):\n \"\"\"\n 启用流\n https://developer.qiniu.com/qvs/api/6739/enable-the-flow\n :param access_key: 公钥\n :param secret_key: 私钥\n :param namespaceId: 空间ID\n :param streamId: 流ID\n \n :return:\n {\n \"code\": 200\n }\n \"\"\"\n auth = QiniuMacAuth(access_key, secret_key)\n \n # 请求URL\n url = f\"http://qvs.qiniuapi.com/v1/namespaces/{namespaceId}/streams/{streamId}/enabled\"\n \n # 发起POST请求\n ret, res = http._post_with_qiniu_mac(url, None, auth=auth)\n headers = {\"code\": res.status_code, \"reqid\": res.req_id, \"xlog\": res.x_log, \"text_body\": res.text_body}\n \n # 格式化响应体\n Headers = json.dumps(headers, indent=4, ensure_ascii=False)\n result = json.dumps(ret, indent=4, ensure_ascii=False)\n return Headers, result\n \n if __name__ == '__main__':\n # 七牛账号 AK、SK\n access_key = '<access_key>'\n secret_key = '<secret_key>'\n \n # 空间ID\n namespaceId = \"xxxxxxxxxxx\"\n \n # 流ID\n streamId = \"xxxxxxxxxxx\"\n \n headers, result = enableStreams(access_key, secret_key, namespaceId, streamId)\n print(f'{headers}\\n{result}')\n \n\n## **[删除流 __](https://developer.qiniu.com/qvs/api/6735/delete-flow)**\n\n### 示例\n\n \n \n # -*- coding: utf-8 -*-\n from qiniu import QiniuMacAuth, http\n import json\n \n \n def deleteStreams(access_key, secret_key, namespaceId, streamId):\n \"\"\"\n 删除流\n https://developer.qiniu.com/qvs/api/6735/delete-flow\n :param access_key: 公钥\n :param secret_key: 私钥\n :param namespaceId: 空间ID\n :param streamId: 流名ID\n \n :return:\n 200 { }\n \"\"\"\n auth = QiniuMacAuth(access_key, secret_key)\n \n # 请求URL\n url = f\"http://qvs.qiniuapi.com/v1/namespaces/{namespaceId}/streams/{streamId}\"\n \n # 发起POST请求\n ret, res = http._delete_with_qiniu_mac(url, params=None, auth=auth)\n headers = {\"code\": res.status_code, \"reqid\": res.req_id, \"xlog\": res.x_log, \"text_body\": res.text_body}\n \n # 格式化响应体\n Headers = json.dumps(headers, indent=4, ensure_ascii=False)\n result = json.dumps(ret, indent=4, ensure_ascii=False)\n return Headers, result\n \n if __name__ == '__main__':\n # 七牛账号 AK、SK\n access_key = '<access_key>'\n secret_key = '<secret_key>'\n \n # 需要查询的空间ID\n namespaceId = \"xxxxxxxxxxx\"\n \n # 流名ID\n streamId = \"xxxxxxxxxxx\"\n \n headers, result = deleteStreams(access_key, secret_key, namespaceId, streamId)\n print(f'{headers}\\n{result}')\n \n\n## **[停用流 __](https://developer.qiniu.com/qvs/api/6849/stop-using-flow)**\n\n仅适用于`rtmp`类型的空间，用户主动断开推流。\n\n### 示例\n\n \n \n # -*- coding: utf-8 -*-\n from qiniu import QiniuMacAuth, http\n import json\n \n \n def stopStreams(access_key, secret_key, namespaceId, streamId):\n \"\"\"\n 停止推流\n https://developer.qiniu.com/qvs/api/6849/stop-using-flow\n :param access_key: 公钥\n :param secret_key: 私钥\n :param namespaceId: 空间ID\n :param streamId: 流ID\n \n :return:\n {\n \"code\": 200\n }\n \"\"\"\n auth = QiniuMacAuth(access_key, secret_key)\n \n # 请求URL\n url = f\"http://qvs.qiniuapi.com/v1/namespaces/{namespaceId}/streams/{streamId}/stop\"\n \n # 发起POST请求\n ret, res = http._post_with_qiniu_mac(url, None, auth=auth)\n headers = {\"code\": res.status_code, \"reqid\": res.req_id, \"xlog\": res.x_log, \"text_body\": res.text_body}\n \n # 格式化响应体\n Headers = json.dumps(headers, indent=4, ensure_ascii=False)\n result = json.dumps(ret, indent=4, ensure_ascii=False)\n return Headers, result\n \n if __name__ == '__main__':\n # 七牛账号 AK、SK\n access_key = '<access_key>'\n secret_key = '<secret_key>'\n \n # 空间ID\n namespaceId = \"xxxxxxxxxxx\"\n \n # 流ID\n streamId = \"xxxxxxxxxxx\"\n \n headers, result = stopStreams(access_key, secret_key, namespaceId, streamId)\n print(f'{headers}\\n{result}')\n \n \n\n# **设备管理**\n\n## **[创建设备 __](https://developer.qiniu.com/qvs/api/6896/create-device)**\n\n### 示例\n\n \n \n # -*- coding: utf-8 -*-\n from qiniu import QiniuMacAuth, http, urlsafe_base64_encode\n import json\n \n \n def createNamespaces(access_key, secret_key, namespaceId, body):\n \"\"\"\n 创建设备\n https://developer.qiniu.com/qvs/api/6896/create-device\n :param access_key: 公钥\n :param secret_key: 私钥\n :param namespaceId: 空间ID\n :param body: 请求体\n {\n \"name\": 非必填，设备名称（可包含 字母、数字、中划线、下划线；1 ~ 100 个字符长）\n \"gbId\"：非必填，设备国标ID 要求全局唯一, 该字段为空时，会自动创建gbid\n \"username\": 非必填，用户名, 4~40位，可包含大写字母、小写字母、数字、中划线。当该字段为空时,默认值就是设备国标ID\n \"password\": 必填，密码, 4~40位，可包含大写字母、小写字母、数字、中划线\n \"pullIfRegister\": 非必填，注册成功后启动拉流, 默认关闭\n \"desc\"：非必填，关于设备的描述信息\n }\n \n :return:\n {\n \n }\n \"\"\"\n auth = QiniuMacAuth(access_key, secret_key)\n \n # 请求URL\n url = f\"http://qvs.qiniuapi.com/v1/namespaces/{namespaceId}/devices\"\n \n # 请求header\n h = {\n \"content-type\": \"application/json\"\n }\n \n # 发起POST请求\n ret, res = http._post_with_qiniu_mac_and_headers(url, json.dumps(body), auth, headers=h)\n \n headers = {\"code\": res.status_code, \"reqid\": res.req_id, \"xlog\": res.x_log, \"text_body\": res.text_body}\n \n # 格式化响应体\n Headers = json.dumps(headers, indent=4, ensure_ascii=False)\n result = json.dumps(ret, indent=4, ensure_ascii=False)\n return Headers, result\n \n \n if __name__ == '__main__':\n # 七牛账号 AK、SK\n access_key = '<access_key>'\n secret_key = '<secret_key>'\n \n # 空间ID\n namespaceId = \"xxxxxxxxxxx\"\n \n # 请求体\n body = {\n \"name\": \"device1\",\n \"desc\": \"test gb28181\",\n \"username\": \"username\",\n \"password\": \"password\"\n }\n \n headers, result = createNamespaces(access_key, secret_key, namespaceId, body)\n print(f'{headers}\\n{result}')\n \n \n\n## **[删除设备 __](https://developer.qiniu.com/qvs/api/6898/Delete-device)**\n\n### 示例\n\n \n \n # -*- coding: utf-8 -*-\n from qiniu import QiniuMacAuth, http\n import json\n \n \n def deleteNamespaces(access_key, secret_key, namespaceId, gbId):\n \"\"\"\n 删除设备\n https://developer.qiniu.com/qvs/api/6898/Delete-device\n :param access_key: 公钥\n :param secret_key: 私钥\n :param namespaceId: 空间ID\n :param gbId: 设备国标Id\n :return:\n {\n \"code\": 200\n }\n \"\"\"\n auth = QiniuMacAuth(access_key, secret_key)\n \n # 请求URL\n url = f\"http://qvs.qiniuapi.com/v1/namespaces/{namespaceId}/devices/{gbId}\"\n \n # 发起POST请求\n ret, res = http._delete_with_qiniu_mac(url, params=None, auth=auth)\n headers = {\"code\": res.status_code, \"reqid\": res.req_id, \"xlog\": res.x_log, \"text_body\": res.text_body}\n \n # 格式化响应体\n Headers = json.dumps(headers, indent=4, ensure_ascii=False)\n result = json.dumps(ret, indent=4, ensure_ascii=False)\n return Headers, result\n \n \n if __name__ == '__main__':\n # 七牛账号 AK、SK\n access_key = '<access_key>'\n secret_key = '<secret_key>'\n \n # 空间ID\n namespaceId = \"xxxxxxxxxxx\"\n \n # 设备国标Id\n gbId = \"xxxxxxxxxxx\"\n \n headers, result = deleteNamespaces(access_key, secret_key, namespaceId, gbId)\n print(f'{headers}\\n{result}')\n \n\n## **[查询设备 __](https://developer.qiniu.com/qvs/api/6901/Query-device-\ninformation)**\n\n### 示例\n\n \n \n # -*- coding: utf-8 -*-\n from qiniu import QiniuMacAuth, http\n import json\n \n \n def listNamespacesInfo(access_key, secret_key, namespaceId, gbId):\n \"\"\"\n 查询设备信息\n \thttps://developer.qiniu.com/qvs/api/6901/Query-device-information\n :param access_key: 公钥\n :param secret_key: 私钥\n :param namespaceId: 空间ID\n :param gbId: 设备国标Id\n :return:\n {\n \"code\": 200\n }\n \"\"\"\n auth = QiniuMacAuth(access_key, secret_key)\n \n # 请求URL\n url = f\"http://qvs.qiniuapi.com/v1/namespaces/{namespaceId}/devices/{gbId}\"\n \n # 发起POST请求\n ret, res = http._get_with_qiniu_mac(url, params=None, auth=auth)\n headers = {\"code\": res.status_code, \"reqid\": res.req_id, \"xlog\": res.x_log, \"text_body\": res.text_body}\n \n # 格式化响应体\n Headers = json.dumps(headers, indent=4, ensure_ascii=False)\n result = json.dumps(ret, indent=4, ensure_ascii=False)\n return Headers, result\n \n \n if __name__ == '__main__':\n # 七牛账号 AK、SK\n access_key = '<access_key>'\n secret_key = '<secret_key>'\n \n # 空间ID\n namespaceId = \"xxxxxxxxxxx\"\n \n # 设备国标Id\n gbId = \"xxxxxxxxxxx\"\n \n headers, result = listNamespacesInfo(access_key, secret_key, namespaceId, gbId)\n print(f'{headers}\\n{result}')\n \n\n## **更新设备[链接 __](https://developer.qiniu.com/qvs/api/6899/update-the-device)**\n\n### 示例\n\n \n \n # -*- coding: utf-8 -*-\n from qiniu import QiniuMacAuth, http\n import json\n \n \n def updateNamespaces(access_key, secret_key, namespaceId, gbId, body):\n \"\"\"\n 更新设备\n https://developer.qiniu.com/qvs/api/6899/update-the-device\n :param access_key: 公钥\n :param secret_key: 私钥\n :param namespaceId: 空间ID\n :param gbId: 设备国标Id\n :param body: 请求体\n {\n \"operations\":[\n {\"key\":\"desc\", // 要修改的参数：name 设备名称;desc 设备描述;gbId 设备国标ID;username 用户名;password 密码; pullIfRegister 注册成功后启动拉流\n \"op\":\"replace\", // op操作(目前支持replace和delete)\n \"value\":gb patch test}， // 要修改的参数对应的value(当op为delete的时候可以忽略)\n { },\n .....\n ]\n }\n :return:\n {\n \"code\": 200\n }\n \"\"\"\n auth = QiniuMacAuth(access_key, secret_key)\n \n # 请求URL\n url = f\"http://qvs.qiniuapi.com/v1/namespaces/{namespaceId}/devices/{gbId}\"\n \n # 发起PATCH请求\n ret, res = http._patch_with_qiniu_mac(url, body, auth)\n headers = {\"code\": res.status_code, \"reqid\": res.req_id, \"xlog\": res.x_log, \"text_body\": res.text_body}\n \n # 格式化响应体\n Headers = json.dumps(headers, indent=4, ensure_ascii=False)\n result = json.dumps(ret, indent=4, ensure_ascii=False)\n return Headers, result\n \n \n if __name__ == '__main__':\n # 七牛账号 AK、SK\n access_key = '<access_key>'\n secret_key = '<secret_key>'\n \n # 空间ID\n namespaceId = \"xxxxxxxxxxx\"\n \n # 设备国标Id\n gbId = \"xxxxxxxxxxx\"\n \n # 请求体\n body = {\n \"operations\": [\n {\"key\": \"desc\",\n \"op\": \"replace\",\n \"value\": \"gb patch test\"}\n ]\n }\n \n headers, result = updateNamespaces(access_key, secret_key, namespaceId, gbId, body)\n print(f'{headers}\\n{result}')\n \n\n \n\n## **[获取设备列表 __](https://developer.qiniu.com/qvs/api/6902/Query-device-list)**\n\n### 示例\n\n \n \n # -*- coding: utf-8 -*-\n from qiniu import QiniuMacAuth, http\n import json\n \n \n def listNamespaces(access_key, secret_key, namespaceId, offset=0, line=10, prefix=None, state=\"notReg\",\n qtype=0):\n \"\"\"\n 获取设备列表\n https://developer.qiniu.com/qvs/api/6902/Query-device-list\n :param access_key: 公钥\n :param secret_key: 私钥\n :param namespaceId: 空间ID\n :param offset: 在全部namespace中的偏移量，integer\n :param line: 一次返回多少条\n :param prefix: 可以通过gbid前缀进行检索查询\n :param state: 按设备状态查询，offline: 离线, online: 在线, notReg: 未注册, locked: 锁定\n :param qtype: 按设备类型查询，0:全部, 1:摄像头, 2:平台\n \n :return:\n 200 { }\n \"\"\"\n auth = QiniuMacAuth(access_key, secret_key)\n url = f\"http://qvs.qiniuapi.com/v1/namespaces/{namespaceId}/devices?offset={offset}&line={line}&prefix={prefix}&state={state}&qtype={qtype}\"\n # 发起POST请求\n ret, res = http._get_with_qiniu_mac(url, params=None, auth=auth)\n headers = {\"code\": res.status_code, \"reqid\": res.req_id, \"xlog\": res.x_log, \"text_body\": res.text_body}\n \n # 格式化响应体\n Headers = json.dumps(headers, indent=4, ensure_ascii=False)\n result = json.dumps(ret, indent=4, ensure_ascii=False)\n return Headers, result\n \n \n if __name__ == '__main__':\n # 七牛账号 AK、SK\n access_key = '<access_key>'\n secret_key = '<secret_key>'\n \n # 空间ID\n namespaceId = \"xxxxxxxxxxx\"\n \n headers, result = listNamespaces(access_key, secret_key, namespaceId)\n print(f'{headers}\\n{result}')\n \n\n## **[获取通道列表 __](https://developer.qiniu.com/qvs/api/6906/query-channel-\nlist)**\n\n### 示例\n\n \n \n # -*- coding: utf-8 -*-\n from qiniu import QiniuMacAuth, http\n import json\n \n \n def listNamespaces(access_key, secret_key, namespaceId, gbId, prefix=None):\n \"\"\"\n 获取通道列表\n https://developer.qiniu.com/qvs/api/6906/query-channel-list\n :param access_key: 公钥\n :param secret_key: 私钥\n :param namespaceId: 空间ID\n :param gbId: 设备国标Id\n :param prefix: 通道国标ID前缀\n \n :return:\n 200 { }\n \"\"\"\n auth = QiniuMacAuth(access_key, secret_key)\n \n url = f\"http://qvs.qiniuapi.com/v1/namespaces/{namespaceId}/devices/{gbId}/channels?prefix={prefix}\"\n # 发起POST请求\n ret, res = http._get_with_qiniu_mac(url, params=None, auth=auth)\n headers = {\"code\": res.status_code, \"reqid\": res.req_id, \"xlog\": res.x_log, \"text_body\": res.text_body}\n \n # 格式化响应体\n Headers = json.dumps(headers, indent=4, ensure_ascii=False)\n result = json.dumps(ret, indent=4, ensure_ascii=False)\n return Headers, result\n \n \n if __name__ == '__main__':\n # 七牛账号 AK、SK\n access_key = '<access_key>'\n secret_key = '<secret_key>'\n \n # 空间ID\n namespaceId = \"xxxxxxxxxxx\"\n \n # 设备国标Id\n gbId = \"xxxxxxxxxxx\"\n \n headers, result = listNamespaces(access_key, secret_key, namespaceId, gbId)\n print(f'{headers}\\n{result}')\n \n\n \n\n## **[启动设备拉流 __](https://developer.qiniu.com/qvs/api/6907/start-device)**\n\n### 示例\n\n \n \n # -*- coding: utf-8 -*-\n from qiniu import QiniuMacAuth, http\n import json\n \n \n def startDevice(access_key, secret_key, namespaceId, gbId):\n \"\"\"\n 启动设备拉流\n https://developer.qiniu.com/qvs/api/6907/start-device\n :param access_key: 公钥\n :param secret_key: 私钥\n :param namespaceId: 空间ID\n :param gbId: 设备国标Id\n \n :return:\n {\n \"code\": 200\n }\n \"\"\"\n auth = QiniuMacAuth(access_key, secret_key)\n \n # 请求URL\n url = f\"http://qvs.qiniuapi.com/v1/namespaces/{namespaceId}/devices/{gbId}/start\"\n \n # 发起POST请求\n ret, res = http._post_with_qiniu_mac(url, None, auth=auth)\n headers = {\"code\": res.status_code, \"reqid\": res.req_id, \"xlog\": res.x_log, \"text_body\": res.text_body}\n \n # 格式化响应体\n Headers = json.dumps(headers, indent=4, ensure_ascii=False)\n result = json.dumps(ret, indent=4, ensure_ascii=False)\n return Headers, result\n \n \n if __name__ == '__main__':\n # 七牛账号 AK、SK\n access_key = '<access_key>'\n secret_key = '<secret_key>'\n \n # 空间ID\n namespaceId = \"xxxxxxxxxxx\"\n \n # 设备国标Id\n gbId = \"xxxxxxxxxxx\"\n \n headers, result = startDevice(access_key, secret_key, namespaceId, gbId)\n print(f'{headers}\\n{result}')\n \n\n## **[停止设备拉流 __](https://developer.qiniu.com/qvs/api/6908/stop-device)**\n\n### 示例\n\n \n \n # -*- coding: utf-8 -*-\n from qiniu import QiniuMacAuth, http\n import json\n \n \n def stopDevice(access_key, secret_key, namespaceId, gbId):\n \"\"\"\n 停止设备拉流\n https://developer.qiniu.com/qvs/api/6908/stop-device\n :param access_key: 公钥\n :param secret_key: 私钥\n :param namespaceId: 空间ID\n :param gbId: 设备国标Id\n \n :return:\n {\n \"code\": 200\n }\n \"\"\"\n auth = QiniuMacAuth(access_key, secret_key)\n \n # 请求URL\n url = f\"http://qvs.qiniuapi.com/v1/namespaces/{namespaceId}/devices/{gbId}/stop\"\n \n # 发起POST请求\n ret, res = http._post_with_qiniu_mac(url, None, auth=auth)\n headers = {\"code\": res.status_code, \"reqid\": res.req_id, \"xlog\": res.x_log, \"text_body\": res.text_body}\n \n # 格式化响应体\n Headers = json.dumps(headers, indent=4, ensure_ascii=False)\n result = json.dumps(ret, indent=4, ensure_ascii=False)\n return Headers, result\n \n \n if __name__ == '__main__':\n \t# 七牛账号 AK、SK\n access_key = '<access_key>'\n secret_key = '<secret_key>'\n \n # 空间ID\n namespaceId = \"xxxxxxxxxxx\"\n \n # 设备国标Id\n gbId = \"xxxxxxxxxxx\"\n \n headers, result = stopDevice(access_key, secret_key, namespaceId, gbId)\n print(f'{headers}\\n{result}')\n \n \n\n# **模板管理**\n\n## **[创建模板 __](https://developer.qiniu.com/qvs/api/6721/create-template)**\n\n### 示例\n\n \n \n # -*- coding: utf-8 -*-\n from qiniu import QiniuMacAuth, http, urlsafe_base64_encode\n import json\n \n \n def createTemplate(access_key, secret_key, body):\n \"\"\"\n 创建模板\n https://developer.qiniu.com/qvs/api/6721/create-template\n :param access_key: 公钥\n :param secret_key: 私钥\n :param body: 请求体\n {\n \"name\": 必填，模版名称，格式为 1 ~ 100个字符，可包含小写字母、数字、中划线\n \"desc\"：非必填，模板描述\n \"bucket\": 必填，模版对应的对象存储的bucket\n \"deleteAfterDays\": 必填，存储过期时间,默认永久不过期\n \"fileType\": 必填，文件存储类型,取值：0（普通存储）,1（低频存储）\n \"recordFileFormat\": 非必填，录制文件存储格式,取值：0（m3u8格式存储）\n \"templateType\": 必填，模板类型,取值：0（录制模版）, 1（截图模版）\n \"recordType\"：templateType为0时须指定，录制模式, 0（不录制）,1（实时录制）2 (按需录制)\n \"jpgOverwriteStatus\": templateType为1时须指定，开启覆盖式截图(一般用于流封面)\n \"jpgSequenceStatus\"：templateType为1时须指定，开启序列式截图\n \"jpgOnDemandStatus\"：templateType为1时须指定，开启按需截图\n \"recordInterval\"：非必填，录制文件时长 单位为秒,600~3600\n \"snapInterval\": 非必填，截图间隔, 单位为秒, 10~600\n }\n \n :return:\n {\n \n }\n \"\"\"\n auth = QiniuMacAuth(access_key, secret_key)\n \n # 请求URL\n url = \"http://qvs.qiniuapi.com/v1/templates\"\n \n # 请求header\n h = {\n \"content-type\": \"application/json\"\n }\n \n # 发起POST请求\n ret, res = http._post_with_qiniu_mac_and_headers(url, json.dumps(body), auth, headers=h)\n \n headers = {\"code\": res.status_code, \"reqid\": res.req_id, \"xlog\": res.x_log, \"text_body\": res.text_body}\n \n # 格式化响应体\n Headers = json.dumps(headers, indent=4, ensure_ascii=False)\n result = json.dumps(ret, indent=4, ensure_ascii=False)\n return Headers, result\n \n if __name__ == '__main__':\n # 七牛账号 AK、SK\n access_key = '<access_key>'\n secret_key = '<secret_key>'\n \n # 请求体\n body = {\n \"name\": \"test0013\",\n \"desc\": \"this is a test\",\n \"delateAfterDays\": 7,\n \"interval\": 5,\n \"templateType\": 1,\n \"bucket\": \"xxxxxxxxxxx\",\n \"jpgOverwriteStatus\": True,\n \"jpgSequenceStatus\": True,\n \"jpgOnDemandStatus\": True\n }\n \n headers, result = createTemplate(access_key, secret_key, body)\n print(f'{headers}\\n{result}')\n \n\n \n\n## **[查询模板 __](https://developer.qiniu.com/qvs/api/6724/template-\ninformation)**\n\n### 示例\n\n \n \n # -*- coding: utf-8 -*-\n from qiniu import QiniuMacAuth, http\n import json\n \n \n def listNamespacesInfo(access_key, secret_key, templateId):\n \"\"\"\n 查询模板信息\n https://developer.qiniu.com/qvs/api/6724/template-information\n :param access_key: 公钥\n :param secret_key: 私钥\n :param templateId: 模板ID\n \n :return:\n {\n \"code\": 200\n }\n \"\"\"\n auth = QiniuMacAuth(access_key, secret_key)\n \n # 请求URL\n url = f\"http://qvs.qiniuapi.com/v1/templates/{templateId}\"\n \n # 发起POST请求\n ret, res = http._get_with_qiniu_mac(url, params=None, auth=auth)\n headers = {\"code\": res.status_code, \"reqid\": res.req_id, \"xlog\": res.x_log, \"text_body\": res.text_body}\n \n # 格式化响应体\n Headers = json.dumps(headers, indent=4, ensure_ascii=False)\n result = json.dumps(ret, indent=4, ensure_ascii=False)\n return Headers, result\n \n if __name__ == '__main__':\n # 七牛账号 AK、SK\n access_key = '<access_key>'\n secret_key = '<secret_key>'\n \n # 模板ID\n templateId = \"xxxxxxxxxxx\"\n \n headers, result = listNamespacesInfo(access_key, secret_key, templateId)\n print(f'{headers}\\n{result}')\n \n\n## **[更新模板 __](https://developer.qiniu.com/qvs/api/6723/modify-the-template)**\n\n### 示例\n\n \n \n # -*- coding: utf-8 -*-\n from qiniu import QiniuMacAuth, http\n import json\n \n \n def updateTemplate(access_key, secret_key, templateId, body):\n \"\"\"\n 更新模板\n https://developer.qiniu.com/qvs/api/6723/modify-the-template\n :param access_key: 公钥\n :param secret_key: 私钥\n :param templateId: 模板ID\n :param body: 请求体\n {\n \"operations\":[\n {\"key\":\"recordTemplateApplyAll\", // 要修改的参数：name 模板名称;desc 模板描述;bucket 模版对应的对象存储的bucket;deleteAfterDays 存储过期时间,默认永久不过期;fileType 文件存储类型,取值：0（普通存储）,1（低频存储）; recordType 录制模式, 0（不录制）,1（实时录制）; jpgOverwriteStatus 开启覆盖式截图(一般用于流封面); recordInterval 录制文件时长 单位为秒, 600~3600; snapInterval 截图间隔, 单位为秒, 10~600; jpgSequenceStatus 开启序列式截图\n \"op\":\"replace\", // op操作(目前支持replace和delete)\n \"value\":true}， // 要修改的参数对应的value(当op为delete的时候可以忽略)\n { },\n .....\n ]\n }\n :return:\n {\n \"code\": 200\n }\n \"\"\"\n auth = QiniuMacAuth(access_key, secret_key)\n \n # 请求URL\n url = f\"http://qvs.qiniuapi.com/v1/templates/{templateId}\"\n \n # 发起PATCH请求\n ret, res = http._patch_with_qiniu_mac(url, body, auth)\n headers = {\"code\": res.status_code, \"reqid\": res.req_id, \"xlog\": res.x_log, \"text_body\": res.text_body}\n \n # 格式化响应体\n Headers = json.dumps(headers, indent=4, ensure_ascii=False)\n result = json.dumps(ret, indent=4, ensure_ascii=False)\n return Headers, result\n \n if __name__ == '__main__':\n # 七牛账号 AK、SK\n access_key = '<access_key>'\n secret_key = '<secret_key>'\n \n # 模板ID\n templateId = \"xxxxxxxxxxx\"\n \n # 请求体\n body = {\n \"operations\": [\n {\"key\": \"deleteAfterDays\", \"op\": \"replace\", \"value\": 0}\n ]\n }\n \n headers, result = updateTemplate(access_key, secret_key, templateId, body)\n print(f'{headers}\\n{result}')\n \n\n## **[获取模板列表 __](https://developer.qiniu.com/qvs/api/6725/list-template)**\n\n### 示例\n\n \n \n # -*- coding: utf-8 -*-\n from qiniu import QiniuMacAuth, http\n import json\n \n \n def listTemplates(access_key, secret_key, offset=None, templateType=None, match=None, line=10,\n sortBy=\"desc:createdAt\"):\n \"\"\"\n 获取模板列表\n https://developer.qiniu.com/qvs/api/6725/list-template\n :param access_key: 公钥\n :param secret_key: 私钥\n :param offset: 非必填，在全部namespace中的偏移量，时间戳\n :param line: 非必填，一次返回多少条\n :param sortBy: 非必填，asc 表示升序, desc 表示降序, 默认按创建时间降序排列(可参与排序的字段有createdAt, updatedAt).asc:updatedAt表示更新时间从小到大排序, desc:updatedAt表示更新时间从大到小排序\n :param templateType: 非必填，模板类型，取值：0（录制模版）, 1（截图模版）\n :param match: 非必填，模糊匹配查询(模版名称包含match串时返回)\n \n :return:\n 200 { }\n \"\"\"\n auth = QiniuMacAuth(access_key, secret_key)\n if offset is None and match is None and templateType is None:\n # 请求URL\n url = f\"http://qvs.qiniuapi.com/v1/templates?line={line}&sortBy={sortBy}\"\n else:\n url = f\"http://qvs.qiniuapi.com/v1/templates?offset={offset}&line={line}&sortBy={sortBy}&templateType={templateType}&match={match}\"\n # 发起POST请求\n ret, res = http._get_with_qiniu_mac(url, params=None, auth=auth)\n headers = {\"code\": res.status_code, \"reqid\": res.req_id, \"xlog\": res.x_log, \"text_body\": res.text_body}\n \n # 格式化响应体\n Headers = json.dumps(headers, indent=4, ensure_ascii=False)\n result = json.dumps(ret, indent=4, ensure_ascii=False)\n return Headers, result\n \n if __name__ == '__main__':\n # 七牛账号 AK、SK\n access_key = '<access_key>'\n secret_key = '<secret_key>'\n \n headers, result = listTemplates(access_key, secret_key)\n print(f'{headers}\\n{result}')\n \n\n \n\n## **[删除模板 __](https://developer.qiniu.com/qvs/api/6722/delete-template)**\n\n### 示例\n\n \n \n # -*- coding: utf-8 -*-\n from qiniu import QiniuMacAuth, http\n import json\n \n \n def deleteTemplate(access_key, secret_key, templateId):\n \"\"\"\n 删除模板\n https://developer.qiniu.com/qvs/api/6722/delete-template\n :param access_key: 公钥\n :param secret_key: 私钥\n :param templateId: 模板ID\n \n :return:\n {\n \"code\": 200\n }\n \"\"\"\n auth = QiniuMacAuth(access_key, secret_key)\n \n # 请求URL\n url = f\"http://qvs.qiniuapi.com/v1/templates/{templateId}\"\n \n # 发起POST请求\n ret, res = http._delete_with_qiniu_mac(url, params=None, auth=auth)\n headers = {\"code\": res.status_code, \"reqid\": res.req_id, \"xlog\": res.x_log, \"text_body\": res.text_body}\n \n # 格式化响应体\n Headers = json.dumps(headers, indent=4, ensure_ascii=False)\n result = json.dumps(ret, indent=4, ensure_ascii=False)\n return Headers, result\n \n \n if __name__ == '__main__':\n # 七牛账号 AK、SK\n access_key = '<access_key>'\n secret_key = '<secret_key>'\n \n # 模板ID\n templateId = \"xxxxxxxxxxx\"\n \n headers, result = deleteTemplate(access_key, secret_key, templateId)\n print(f'{headers}\\n{result}')\n \n\n# **录制管理**\n\n## **[查询云端录制记录 __](https://developer.qiniu.com/qvs/api/6745/query-\nrecordhistories)**\n\n### 示例\n\n \n \n # -*- coding: utf-8 -*-\n from qiniu import QiniuMacAuth, http\n import json, time\n \n \n # 日期转时间戳\n def time2timestamp(datetime):\n # 转为时间数组\n timeArray = time.strptime(datetime, \"%Y-%m-%d %H:%M:%S\")\n timeStamp = int(time.mktime(timeArray))\n return timeStamp\n \n \n def recordHistories(access_key, secret_key, namespaceId, streamId, start, end, line=10, marker=None):\n \"\"\"\n 查询录制记录\n https://developer.qiniu.com/qvs/api/6745/query-recordhistories\n :param access_key: 公钥\n :param secret_key: 私钥\n :param offset: 非必填，在全部namespace中的偏移量，时间戳\n :param line: 非必填，一次返回多少条\n :param sortBy: 非必填，asc 表示升序, desc 表示降序, 默认按创建时间降序排列(可参与排序的字段有createdAt, updatedAt).asc:updatedAt表示更新时间从小到大排序, desc:updatedAt表示更新时间从大到小排序\n :param templateType: 非必填，模板类型，取值：0（录制模版）, 1（截图模版）\n :param match: 非必填，模糊匹配查询(模版名称包含match串时返回)\n \n :return:\n 200 { }\n \"\"\"\n auth = QiniuMacAuth(access_key, secret_key)\n \n start = time2timestamp(startDate)\n \n end = time2timestamp(endDate)\n \n if marker is None:\n # 请求URL\n url = f\"http://qvs.qiniuapi.com/v1/namespaces/{namespaceId}/streams/{streamId}/recordhistories?start={start}&end={end}&line={line}\"\n else:\n url = f\"http://qvs.qiniuapi.com/v1/namespaces/{namespaceId}/streams/{streamId}/recordhistories?start={start}&end={end}&marker={marker}&line={line}\"\n # 发起POST请求\n ret, res = http._get_with_qiniu_mac(url, params=None, auth=auth)\n headers = {\"code\": res.status_code, \"reqid\": res.req_id, \"xlog\": res.x_log, \"text_body\": res.text_body}\n \n # 格式化响应体\n Headers = json.dumps(headers, indent=4, ensure_ascii=False)\n result = json.dumps(ret, indent=4, ensure_ascii=False)\n return Headers, result\n \n if __name__ == '__main__':\n # 七牛账号 AK、SK\n access_key = '<access_key>'\n secret_key = '<secret_key>'\n \n # 空间ID\n namespaceId = \"xxxxxxxxxxx\"\n \n # 流ID\n streamId = \"xxxxxxxxxxx\"\n \n # 推流开始时间（Unix 时间戳）\n startDate = \"2020-06-08 00:00:00\"\n \n # 推流结束时间（Unix 时间戳）\n endDate = \"2020-06-09 00:00:00\"\n \n headers, result = recordHistories(access_key, secret_key, namespaceId, streamId, startDate, endDate)\n print(f'{headers}\\n{result}')\n \n\n \n\n## **[查询流封面 __](https://developer.qiniu.com/qvs/api/6814/the-cover-for-\nscreenshots)**\n\n### 示例\n\n \n \n # -*- coding: utf-8 -*-\n from qiniu import QiniuMacAuth, http\n import json, time\n \n \n # 日期转时间戳\n def time2timestamp(datetime):\n # 转为时间数组\n timeArray = time.strptime(datetime, \"%Y-%m-%d %H:%M:%S\")\n timeStamp = int(time.mktime(timeArray))\n return timeStamp\n \n \n def streamSnapshotss(access_key, secret_key, namespaceId, streamId):\n \"\"\"\n 获取直播封面截图\n https://developer.qiniu.com/qvs/api/6814/the-cover-for-screenshots\n :param access_key: 公钥\n :param secret_key: 私钥\n :param namespaceId: 必填项，空间ID\n :param streamId: 必填项，流ID\n \n :return:\n 200\n {\n \"url\": \"http://prlghu509.test.bkt.clouddn.com/snapshot/jpg/2akrarrzns76w/t0.jpg?e=1588124787&token=Ves3WTXC8XnEHT0I_vacEQQz-9jrJZxNExcmarzQ:bH8s5m5N5Ugp2wo6ACRUVeIK280\"\n }\n \"\"\"\n auth = QiniuMacAuth(access_key, secret_key)\n \n # 请求URL\n url = f\"http://qvs.qiniuapi.com/v1/namespaces/{namespaceId}/streams/{streamId}/cover\"\n \n # 发起GET请求\n ret, res = http._get_with_qiniu_mac(url, params=None, auth=auth)\n result = json.loads(res.text_body)\n if res.status_code == 401:\n headers = {\"code\": res.status_code, \"reqid\": res.req_id, \"error\": result[\"error\"]}\n elif res.status_code != 401 and res.text_body:\n headers = {\"code\": result[\"code\"], \"reqid\": res.req_id, \"xlog\": result[\"error\"]}\n else:\n headers = {\"code\": res.text_body, \"reqid\": res.req_id, \"xlog\": res.x_log, \"text_body\": res.text_body}\n \n # 格式化响应体\n Headers = json.dumps(headers, indent=4, ensure_ascii=False)\n result = json.dumps(ret, indent=4, ensure_ascii=False)\n return Headers, result\n \n if __name__ == '__main__':\n # 七牛账号 AK、SK\n access_key = '<access_key>'\n secret_key = '<secret_key>'\n \n # 空间ID\n namespaceId = \"xxxxxxxxxxx\"\n \n # 流ID\n streamId = \"xxxxxxxxxxx\"\n \n headers, result = streamSnapshotss(access_key, secret_key, namespaceId, streamId)\n print(f'{headers}\\n{result}')\n \n\n## **[获取截图列表 __](https://developer.qiniu.com/qvs/api/6749/list-stream-\nsnapshots)**\n\n### 示例\n\n \n \n # -*- coding: utf-8 -*-\n from qiniu import QiniuMacAuth, http\n import json, time\n \n \n # 日期转时间戳\n def time2timestamp(datetime):\n # 转为时间数组\n timeArray = time.strptime(datetime, \"%Y-%m-%d %H:%M:%S\")\n timeStamp = int(time.mktime(timeArray))\n return timeStamp\n \n \n def streamSnapshots(access_key, secret_key, namespaceId, streamId, startDate, endDate, type, line=30, marker=None):\n \"\"\"\n 获取截图列表\n https://developer.qiniu.com/qvs/api/6749/list-stream-snapshots\n :param access_key: 公钥\n :param secret_key: 私钥\n :param namespaceId: 必填项，空间ID\n :param streamId: 必填项，流ID\n :param type: 必填项，1:实时截图对应的图片列表\n :param line: 非必填，限定返回截图的个数，只能输入1-100的整数，不指定默认返回30个\n :param startDate: 必填项，查询开始时间(unix时间戳,单位为秒)\n :param endDate: 必填项，查询结束时间(unix时间戳,单位为秒)\n :param marker: 非必填，上一次查询返回的标记，用于提示服务端从上一次查到的位置继续查询，不指定表示从头查询\n \n :return:\n 200 { }\n \"\"\"\n auth = QiniuMacAuth(access_key, secret_key)\n \n start = time2timestamp(startDate)\n \n end = time2timestamp(endDate)\n \n if marker is None:\n # 请求URL\n url = f\"http://qvs.qiniuapi.com/v1/namespaces/{namespaceId}/streams/{streamId}/snapshots?type={type}&start={start}&end={end}&line={line}\"\n else:\n url = f\"http://qvs.qiniuapi.com/v1/namespaces/{namespaceId}/streams/{streamId}/snapshots?type={type}&start={end}&end={end}&line={line}&marker={marker}\"\n # 发起POST请求\n ret, res = http._get_with_qiniu_mac(url, params=None, auth=auth)\n if res.text_body:\n result = json.loads(res.text_body)\n headers = {\"code\": result[\"code\"], \"reqid\": res.req_id, \"xlog\": result[\"error\"]}\n else:\n headers = {\"code\": res.text_body, \"reqid\": res.req_id, \"xlog\": res.x_log, \"text_body\": res.text_body}\n \n # 格式化响应体\n Headers = json.dumps(headers, indent=4, ensure_ascii=False)\n result = json.dumps(ret, indent=4, ensure_ascii=False)\n return Headers, result\n \n if __name__ == '__main__':\n # 七牛账号 AK、SK\n access_key = '<access_key>'\n secret_key = '<secret_key>'\n \n # 空间ID\n namespaceId = \"xxxxxxxxxxx\"\n \n # 流ID\n streamId = \"xxxxxxxxxxx\"\n \n # 1:实时截图对应的图片列表\n type = 1\n \n # 推流开始时间（Unix 时间戳）\n startDate = \"2020-06-08 00:00:00\"\n \n # 推流结束时间（Unix 时间戳）\n endDate = \"2020-06-09 00:00:00\"\n \n headers, result = streamSnapshots(access_key, secret_key, namespaceId, streamId, startDate, endDate, type)\n print(f'{headers}\\n{result}')\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的视频监控C# SDK"
},
{
"from": "gpt",
"value": "[视频监控](https://developer.qiniu.com/qvs) > SDK 下载 > 服务端SDK >C# SDK\n\n# C# SDK\n\n最近更新时间: 2022-08-15 12:03:13\n\n[NuGet release __](https://www.nuget.org/packages/Qiniu/7.3.0)\n\n此 C# SDK 适用于.NET Framework 2.0+, 基于七牛云API参考手册构建。\n\n## SDK结构\n\n可以直接查看我们的[SDK目录 __](https://github.com/qiniu/csharp-\nsdk/tree/master/src/Qiniu)，即可大致了解我们 SDK 的结构。\n\n * 最外层包含：配置文件， 鉴权和一些公共的函数。\n * HTTP 目录主要包含了一些对 http 进行封装的类。\n * Storage 目录对应七牛云存储产品(kodo)的相关API\n * Cdn 目录主要包含了七牛CDN产品的相关API\n * Qvs目前没有集成进来，`客户可在该目录下，新建Qvs`,放置Qvs产品的相关API。[对应的API文档 __](https://developer.qiniu.com/qvs/6706/summary-of-the-api)\n\n# 开源\n\n * [c# SDK 项目地址 __](https://github.com/qiniu/csharp-sdk)\n * [c# SDK 发布地址 __](https://github.com/qiniu/csharp-sdk/releases)\n * [c# SDK 历史文档 __](https://developer.qiniu.io/kodo/sdk/1237/csharp)\n\n# 安装\n\n * 直接添加DLL引用\n * 包管理器(NuGet)方式安装\n * 从源码编译\n\n \n**直接添加DLL引用**\n\n您可以在[这里 __](https://github.com/qiniu/csharp-\nsdk/releases)找到所有的Release，选择您需要的版本下载，解压后将*.dll文件添加至项目引用。需要注意的是，此SDK依赖[Json.NET\n__](http://www.newtonsoft.com/json)，可以添加对应版本Newtonsoft.Json.dll引用或者使用NuGet来安装它：\n\n \n \n Install-Package Newtonsoft.Json\n \n\n**包管理器(NuGet)方式安装**\n\n或者从NuGet来安装，以Visual Studio 2013/2015为例(如果您的Visual Studio没有安装NuGet，请先[安装\n__](http://docs.nuget.org/docs/start-here/installing-\nnuget))。打开NuGet程序包管理器搜索Qiniu.Shared或者在控制台中键入以下命令：\n\n \n \n Install-Package Qiniu\n \n\n \n**从源码编译**\n\n当然，您也可以直接从源码编译\n\n \n \n git clone https://github.com/qiniu/csharp-sdk\n \n\n# 鉴权\n\n七牛 c# SDK 的所有的功能，都需要合法的授权。授权凭证的签算需要七牛账号下的一对有效的`Access Key`和`Secret\nKey`，这对密钥可以通过如下步骤获得：\n\n 1. 点击[注册🔗 __](https://portal.qiniu.com/signup)开通七牛开发者帐号\n 2. 如果已有账号，直接登录七牛开发者后台，点击[这里🔗 __](https://portal.qiniu.com/user/key)查看 Access Key 和 Secret Key\n\n# 示例\n\n \n \n using System;\n using Qiniu.Util;\n using Qiniu.Http;\n using System.Text;\n using System.Security.Cryptography;\n \n \n \n \n namespace QvsDemo.Business.Admin\n {\n public class QvsBiz\n \n {\n public static void Main()\n {\n \n string ak = \"xxxxxxxx\"; // 替换成实际的ak\n string sk = \"xxxxxxxxx\"; // 替换成实际的sk\n Mac mac = new Mac(ak, sk);\n string body = \"{\\\"data\\\":{ \\\"name\\\":\\\"test\\\"},\\\"params\\\":{ \\\"groups\\\":[\\\"ylxue_face_group_id2020\\\"]}}\"; // 根据实际的API, 替换成实际的http body\n HttpManager http = new HttpManager(); \n string url = \"http://qvs.qiniuapi.com/v1/namespaces/xxxxxxx/streams\"; // 替换成实际的url,此处以[API创建流](https://developer.qiniu.com/qvs/6734/create-flow)为例\n Uri uri = new Uri(url);\n string contentType = \"application/json\"; \n // 如果http body为空时(例如Get请求), contentType设为application/x-www-form-urlencoded或者为空\n // 如果http body为空时(例如Get请求), contentType设为application/x-www-form-urlencoded或者为空\n // 如果http body为空时(例如Get请求), contentType设为application/x-www-form-urlencoded或者为空\n \n string token = qiniutoken(mac, uri, body, contentType, \"POST\"); // 最后一个参数，根据实际请求替换\n HttpResult ret = http.PostJson(url, body, token);\n Console.WriteLine(ret.Text);\n \n }\n public static string qiniutoken(Mac mac, Uri url, String body, String contentType, String method)\n {\n \n // input path and host and rawquery\n string path = url.AbsolutePath;\n string host = url.Host;\n string rawquery = url.Query;\n var data = new System.Text.StringBuilder();\n data.AppendFormat(\"{0} {1}\", method, path);\n if (rawquery != String.Empty)\n data.AppendFormat(\"{0}\", rawquery);\n data.AppendFormat(\"\\nHost: {0}\", host);\n if (contentType != String.Empty)\n data.AppendFormat(\"\\nContent-Type: {0}\", contentType);\n data.Append(\"\\n\\n\");\n \n if (contentType != String.Empty && contentType != \"application/octet-stream\")\n data.Append(body);\n String sdata = data.ToString();\n Console.WriteLine(sdata);\n HMACSHA1 hmac = new HMACSHA1(Encoding.UTF8.GetBytes(mac.SecretKey));\n byte[] digest = hmac.ComputeHash(Encoding.UTF8.GetBytes(sdata));\n string qiniuToken = String.Format(\"Qiniu {0}:{1}\", mac.AccessKey, Base64.UrlSafeBase64Encode(digest));\n //string qiniuToken = String.Format(\"Qiniu {0}:{1}\", mac.AccessKey, System.Convert.ToBase64String(digest).Replace(\"/\", \"+\").Replace(\"+\", \"-\"));\n Console.WriteLine(qiniuToken);\n return qiniuToken;\n }\n \n }\n }\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的视频监控Java SDK"
},
{
"from": "gpt",
"value": "[视频监控](https://developer.qiniu.com/qvs) > SDK 下载 > 服务端SDK >Java SDK\n\n# Java SDK\n\n最近更新时间: 2023-04-27 18:52:26\n\n# **简介**\n\n此SDK主要帮助您快速接入七牛云的视频监控平台。\n\n主要有如下功能：\n\n * 空间管理\n * 流管理\n * 设备管理\n * 模板管理\n * 录制管理\n * 数据统计管理\n * PTZ管理\n\n# **开源**\n\n * [Java SDK项目地址 __](https://github.com/qiniu/java-sdk)\n * [Java SDK发布地址 __](https://github.com/qiniu/java-sdk/releases)\n * [Java SDK使用示例 __](https://github.com/qiniu/java-sdk/tree/master/src/test/java/test/com/qiniu/qvs)\n\n# **安装**\n\n[官方SDK __](https://github.com/qiniu/java-sdk#%E5%AE%89%E8%A3%85)\n\n# **鉴权**\n\n七牛 Java SDK 的所有的功能，都需要合法的授权。授权凭证的签算需要七牛账号下的一对有效的`Access Key`和`Secret\nKey`，这对密钥可以通过如下步骤获得：\n\n 1. 点击[注册 __](https://portal.qiniu.com/signup)开通七牛开发者帐号\n 2. 如果已有账号，直接登录七牛开发者后台，点击[这里🔗 __](https://portal.qiniu.com/user/key)查看 Access Key 和 Secret Key\n\n# **空间管理**\n\n空间管理的所有接口需要先通过`ak`、`sk`创建空间管理对象\n\n \n \n String accessKey = \"<QINIU ACCESS KEY>\"; // 替换成自己 Qiniu 账号的 AccessKey.\n String secretKey = \"<QINIU SECRET KEY>\"; // 替换成自己 Qiniu 账号的 SecretKey.\n Auth auth = Auth.create(accessKey, secretKey);\n NameSpaceManager nameSpaceManager = new NameSpaceManager(auth);\n \n\n \n\n## **创建空间**\n\n### 说明\n\n创建空间需要先构造NameSpace对象，NameSpace类方法说明:\n\n方法名 | 是否必须 | 说明 \n---|---|--- \nsetName | 是 | 空间名称(格式\"^[a-zA-Z0-9_-]{1,100}$\") \nsetDesc | 否 | 空间描述 \nsetAccessType | 是 | 接入类型(rtmp或者gb28181) \nsetUrlMode | 是 | 推拉流地址计算方式，1:static, 2:dynamic \nsetDomains | urlMode为1时必填 | 直播域名 \nsetZone | 否 | zone为服务区域, 可根据流媒体实时处理、视频录制、截图的存储需求选择对应的区域, 可选项为z0, z1, z2, 默认为z0. z0表示华东, z1表示华北、z2表示华南 \nsetCallback | 否 | 回调地址，可用于获取空间内设备/流状态更新时的信息 \nsetHlsLowLatency | 否 | hls低延迟开关 \nsetRecordTemplateId | 否 | 录制模版ID，需要录制功能时输入对应的模板ID，录制模板ID可以模板管理中获取 \nsetSnapShotTemplateId | 否 | 截图模版ID，需要截图功能时输入对应的模板ID，截图模板ID可以模板管理中获取 \nsetRecordTemplateApplyAll | 否 | 录制模版是否应用到全局 \nsetSnapTemplateApplyAll | 否 | 截图模版是否应用到全局 \nonDemandPull | 否 | 按需拉流开关，默认关闭 \n \n### 示例\n\n \n \n // 创建空间\n NameSpace nameSpace = new NameSpace();\n nameSpace.setName(\"hugo\");// 设置空间类型\n nameSpace.setAccessType(\"rtmp\");// 接入类型\"gb28181\"或者“rtmp”\n nameSpace.setUrlMode(1);\n nameSpace.setDomains(new String[]{\"qtest.com\"});\n \n nameSpaceManager.createNameSpace(nameSpace);\n \n\n \n\n## **查询空间**\n\n### 说明\n\n \n \n Response queryNameSpace(String namespaceId) throws QiniuException\n \n\nnamespaceId可通过`nameSpace.getId`获取\n\n### 示例\n\n \n \n // 查询空间\n String namespaceId = \"2akrarsj8zp0w\";\n res = nameSpaceManager.queryNameSpace(namespaceId);\n \n\n \n\n## **更新空间**\n\n \n \n Response updateNameSpace(String namespaceId, PatchOperation[] patchOperation) throws QiniuException\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnamespaceId | 空间id，可通过`nameSpace.getId`获取 \npatchOperation | 操作集，详见`PatchOperation类方法说明` \n \n### PatchOperation类方法说明\n\n方法名 | 说明 \n---|--- \nPatchOperation(String op, String key, Object value) | 构造方法，用于创建操作对象。 \nop: 更该或删除某个属性，replace：更改，delete：删除 \nkey: 要修改或删除的属性 \nvalue: 要修改或删除属性的值 \nString getOp() | 获取操作类型 \nvoid setOp(String op) | 设置操作类型 \nString getKey() | 获取要操作的属性 \nvoid setKey(String key) | 设置要操作的属性 \nObject getValue() | 获取属性的值 \nvoid setValue(Object value) | 设置属性的值 \n \n### 示例\n\n \n \n // 更新空间\n PatchOperation[] patchOperation = {new PatchOperation(\"replace\", \"recordTemplateApplyAll\", true)};\n nameSpaceManager.updateNameSpace(namespaceId, patchOperation);\n \n\n \n\n## **获取空间列表**\n\n \n \n Response listNameSpace(int offset, int line, String sortBy) throws QiniuException \n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \noffset | 在全部namespace中的偏移量 \nline | 一次返回多少条 \nsortBy | asc 表示升序 \ndesc 表示降序 \n默认按创建时间降序排列(可参与排序的字段有createdAt, updatedAt). \nasc:updatedAt表示更新时间从小到大排序, \ndesc:updatedAt表示更新时间从大到小排序 \n \n### 示例\n\n \n \n // 获取空间列表\n int offset = 0;\n int line = 1;\n String sortBy = \"asc:updatedAt\";\n \n nameSpaceManager.listNameSpace(offset, line, sortBy);\n \n\n \n\n## **禁用空间**\n\n \n \n Response disableNameSpace(String namespaceId) throws QiniuException \n \n\n### 示例\n\n \n \n // 禁用空间\n String namespaceId = \"2akrarsj8zp0w\";\n nameSpaceManager.disableNameSpace(namespaceId);\n \n\n \n\n## **启用空间**\n\n \n \n Response enableNameSpace(String namespaceId) throws QiniuException\n \n\n### 示例\n\n \n \n // 启用空间\n String namespaceId = \"2akrarsj8zp0w\";\n nameSpaceManager.enableNameSpace(namespaceId);\n \n\n \n\n## **删除空间**\n\n \n \n Response deleteNameSpace(String namespaceId) throws QiniuException\n \n\n### 示例\n\n \n \n // 删除空间\n String namespaceId = \"2akrarsj8zp0w\";\n nameSpaceManager.deleteNameSpace(namespaceId);\n \n\n# **流管理**\n\n流管理的所有接口需要通过`ak`、`sk`创建流管理对象\n\n \n \n String accessKey = \"<QINIU ACCESS KEY>\"; // 替换成自己 Qiniu 账号的 AccessKey.\n String secretKey = \"<QINIU SECRET KEY>\"; // 替换成自己 Qiniu 账号的 SecretKey.\n Auth auth = Auth.create(accessKey, secretKey);\n StreamManager streamManager = new StreamManager(auth);\n \n\n \n\n## **创建流**\n\n本接口仅用于接入类型为RTMP的空间\n\n \n \n Response createStream(String namespaceId, Stream stream) throws QiniuException\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnamespaceId | 空间id \nstream | 流相关参数，详见`Stream类方法说明` \n \n### Stream类方法说明\n\n * 构造方法\n\n \n \n Stream(String streamID)\n Stream(String streamID, String desc, String recordTemplateId, String snapShotTemplateId)\n \n\n * 参数说明：\n\n参数 | 说明 \n---|--- \nstreamID | 流名称, 流名称在空间中唯一，可包含 字母、数字、中划线、下划线；1 ~ 100 个字符长；创建后将不可修改 \ndesc | 关于流的描述信息 \nrecordTemplateId | 录制模版ID，配置流维度的录制模板 \nsnapShotTemplateId | 截图模版ID，配置流维度的截图模板 \n \n * 设置流名称\n\n \n \n void setStreamID(String streamID)\n \n\n * 获取流名称\n\n \n \n String getStreamID()\n \n\n * 获取流描述信息\n\n \n \n String getDesc()\n \n\n * 设置流描述信息\n\n \n \n void setDesc(String desc)\n \n\n * 获取所属空间id\n\n \n \n String getNamespaceId()\n \n\n * 设置所属空间id\n\n \n \n void setNamespaceId(String namespaceId)\n \n\n * 获取所属空间名称\n\n \n \n String getNamespace()\n \n\n * 设置所属空间名称\n\n \n \n void setNamespace(String namespace)\n \n\n * 获取录制模板id\n\n \n \n String getRecordTemplateId()\n \n\n * 设置录制模板id\n\n \n \n void setRecordTemplateId(String recordTemplateId)\n \n\n * 获取截图模板id\n\n \n \n String getSnapShotTemplateId()\n \n\n * 设置截图模板id\n\n \n \n void setSnapShotTemplateId(String snapShotTemplateId)\n \n\n * 设备是否在线\n\n \n \n boolean isStatus()\n \n\n * 设置设备在线状态\n\n \n \n void setStatus(boolean status)\n \n\n * 流是否被禁用\n\n \n \n boolean isDisabled()\n \n\n * 设置流禁用状态\n\n \n \n void setDisabled(boolean disabled)\n \n\n * 获取最后一次推流时间\n\n \n \n int getLastPushedAt()\n \n\n * 设置最后一次推流时间\n\n \n \n void setLastPushedAt(int lastPushedAt) \n \n\n * 获取流创建时间\n\n \n \n int getCreatedAt()\n \n\n * 设置流创建时间\n\n \n \n void setCreatedAt(int createdAt) \n \n\n * 获取流更新时间\n\n \n \n int getUpdatedAt()\n \n\n * 设置流更新时间\n\n \n \n void setUpdatedAt(int updatedAt) \n \n\n * 获取在线观看人数\n\n \n \n int getUserCount()\n \n\n * 设置在线观看人数\n\n \n \n void setUserCount(int userCount)\n \n\n * 获取推流端ip\n\n \n \n String getClientIp() \n \n\n * 设置推流端ip\n\n \n \n void setClientIp(String clientIp)\n \n\n * 获取直播流的实时音频帧率\n\n \n \n int getAudioFrameRate()\n \n\n * 设置直播流的实时音频帧率\n\n \n \n void setAudioFrameRate(int audioFrameRate)\n \n\n * 获取直播流的实时码率\n\n \n \n int getBitrate()\n \n\n * 设置直播流的实时码率\n\n \n \n void setBitrate(int bitrate)\n \n\n * 获取直播流的实时视频帧率\n\n \n \n int getVideoFrameRate()\n \n\n * 设置直播流的实时视频帧率\n\n \n \n void setVideoFrameRate(int videoFrameRate)\n \n\n### 示例\n\n \n \n // 创建流\n Stream stream = new Stream(\"teststream004\");\n String namespaceId = \"2akrarsj8zp0w\";\n \n streamManager.createStream(namespaceId, stream);\n \n\n \n\n## **查询流**\n\n \n \n Response queryStream(String namespaceId, String streamId) throws QiniuException\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnamespaceId | 空间id \nstreamId | 流id \n \n### 示例\n\n \n \n // 查询流\n String namespaceId = \"2akrarsj8zp0w\";\n Stream stream = new Stream(\"teststream004\");\n streamManager.queryStream(namespaceId, stream.getStreamID());\n \n\n \n\n## **更新流**\n\n \n \n Response updateStream(String namespaceId, String streamId, PatchOperation[] patchOperation)\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnamespaceId | 空间id \nstreamId | 流id \npatchOperation | 操作集，详见`PatchOperation类方法说明` \n \n### 示例\n\n \n \n // 更新流\n String namespaceId = \"2akrarsj8zp0w\";\n Stream stream = new Stream(\"teststream004\");\n PatchOperation[] patchOperation = {new PatchOperation(\"replace\", \"desc\", \"test\")};\n streamManager.updateStream(namespaceId, stream.getStreamID(), patchOperation);\n \n\n \n\n## **获取流列表**\n\n \n \n Response listStream(String namespaceId, int offset, int line, int qtype, String prefix, String sortBy) throws QiniuException\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnamespaceId | 空间id \noffset | 在全部流中的偏移量 \nline | 一次返回多少条 \nqtype | 查询流类型， 0:全部,1:在线流,2:离线流 \nprefix | 流ID 前缀，可以流ID 前缀进行检索查询 \nsortBy | asc 表示升序 \ndesc 表示降序 \n默认按创建时间降序排列(可参与排序的字段有createdAt, updatedAt, lastPushedAt). \nasc:updatedAt表示更新时间从小到大排序 \ndesc:updatedAt表示更新时间从大到小排序 \n \n### 示例\n\n \n \n // 获取流列表\n int offset = 0;\n int line = 1;\n int qtype = 0;\n String prefix = \"test\";\n String sortBy = \"desc:updatedAt\";\n String namespaceId = \"2akrarsj8zp0w\";\n \n streamManager.listStream(namespaceId, offset, line, qtype, prefix, sortBy);\n \n\n \n\n## **静态模式获取流地址**\n\n \n \n Response staticPublishPlayURL(String namespaceId, String streamId, StaticLiveRoute staticLiveRoute) throws QiniuException\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnamespaceId | 空间id \nstreamId | 流id \nstaticLiveRoute | StaticLiveRoute类静态域名对象 \n \n### StaticLiveRoute类方法说明\n\n方法名 | 说明 \n---|--- \nStaticLiveRoute(String domain, String domainType) | 构造方法，用于创建静态域名对象。 \ndomain:域名 \ndomainType:域名类型,取值：“publishRtmp”:rtmp推流, “liveRtmp”: rtmp播放, “liveHls”: hls播放,\n“liveHdl”: flv播放;“liveWebrtc”: webrtc播放 \nStaticLiveRoute(String domain, String domainType, int urlExpireSec) | 构造方法，用于创建静态域名对象。 \ndomain:域名 \ndomainType:域名类型,取值：“publishRtmp”:rtmp推流, “liveRtmp”: rtmp播放, “liveHls”: hls播放,\n“liveHdl”: flv播放;“liveWebrtc”: webrtc播放; \nurlExpireSec:流地址过期时间(单位为秒) \nString getDomain() | 获取域名 \nvoid setDomain(String domain) | 设置域名 \nString getDomainType() | 获取域名类型 \nvoid setDomainType(String domainType) | 设置域名类型 \nint getUrlExpireSec() | 获取过期时间 \nvoid setUrlExpireSec(int urlExpireSec) | 设置过期时间 \n \n### 示例\n\n \n \n // 静态模式获取流地址\n StaticLiveRoute staticLiveRoute = new StaticLiveRoute(\"qvs-publish.qtest.com\", \"publishRtmp\", 3600);\n String namespaceId = \"2akrarsj8zp0w\";\n Stream stream = new Stream(\"teststream004\");\n \n streamManager.staticPublishPlayURL(namespaceId, stream.getStreamID(), staticLiveRoute);\n \n\n \n\n## **动态模式获取流地址**\n\n \n \n Response dynamicPublishPlayURL(String namespaceId, String streamId, DynamicLiveRoute dynamicLiveRoute) throws QiniuException\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnamespaceId | 空间id \nstreamId | 流id \ndynamicLiveRoute | DynamicLiveRoute类动态域名对象 \n \n### DynamicLiveRoute类方法说明\n\n方法名 | 说明 \n---|--- \nDynamicLiveRoute(String publishIP, String playIP) | 构造方法，用于创建动态域名对象。 \npublishIp:推流端对外IP地址 \nplayIp:拉流端对外IP地址 \nDynamicLiveRoute(String publishIP, String playIP, int urlExpireSec) | 构造方法，用于创建动态域名对象。 \npublishIp:推流端对外IP地址 \nplayIp:拉流端对外IP地址 \nurlExpireSec:流地址过期时间(单位为秒) \nString getPublishIP() | 获取推流端对外IP地址 \nvoid setPublishIP(String publishIP) | 设置推流端对外IP地址 \nString getPlayIP() | 获取拉流端对外IP地址 \nvoid setPlayIP(String playIP) | 设置拉流端对外IP地址 \nint getUrlExpireSec() | 获取过期时间 \nvoid setUrlExpireSec(int urlExpireSec) | 设置过期时间 \n \n### 示例\n\n \n \n // 动态模式获取流地址\n DynamicLiveRoute dynamicLiveRoute = new DynamicLiveRoute(\"116.236.177.50\", \"116.236.177.50\", 3600);\n String namespaceId = \"2akrarsj8zp0w\";\n Stream stream = new Stream(\"teststream004\");\n \n streamManager.dynamicPublishPlayURL(namespaceId, stream.getStreamID(), dynamicLiveRoute);\n \n\n \n\n## **查询推流历史记录**\n\n \n \n Response queryStreamPubHistories(String namespaceId, String streamId, int start, int end, int offset, int line) throws QiniuException\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnamespaceId | 空间id \nstreamId | 流id \nstart | 推流开始时间(unix timestamp in second) \nend | 推流结束时间(unix timestamp in second) \noffset | 在全部流中的偏移量 \nline | 一次返回多少条 \n \n### 示例\n\n \n \n // 查询推流历史记录\n String namespaceId = \"2akrarsj8zp0w\";\n Stream stream = new Stream(\"teststream004\");\n int start = 1587975463;\n int end = 1587976463;\n int offset = 0;\n int ine = 1;\n streamManager.queryStreamPubHistories(namespaceId, stream.getStreamID(), start, end, offset, line);\n \n\n \n\n## **禁用流**\n\n \n \n Response disableStream(String namespaceId, String streamId) throws QiniuException\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnamespaceId | 空间id \nstreamId | 流id \n \n### 示例\n\n \n \n String namespaceId = \"2akrarsj8zp0w\";\n Stream stream = new Stream(\"teststream004\");\n streamManager.disableStream(namespaceId, stream.getStreamID());\n \n\n \n\n## **启用流**\n\n \n \n Response enableStream(String namespaceId, String streamId) throws QiniuException\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnamespaceId | 空间id \nstreamId | 流id \n \n### 示例\n\n \n \n // 启用流\n String namespaceId = \"2akrarsj8zp0w\";\n Stream stream = new Stream(\"teststream004\");\n streamManager.enableStream(namespaceId, stream.getStreamID());\n \n\n \n## **删除流**\n\n \n \n Response deleteStream(String namespaceId, String streamId) throws QiniuException \n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnamespaceId | 空间id \nstreamId | 流id \n \n### 示例\n\n \n \n // 删除流\n String namespaceId = \"2akrarsj8zp0w\";\n Stream stream = new Stream(\"teststream004\");\n streamManager.deleteStream(namespaceId, stream.getStreamID());\n \n\n \n\n## **停用流**\n\n \n \n Response stopStream(String namespaceId, String streamId) throws QiniuException\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnamespaceId | 空间id \nstreamId | 流id \n \n### 示例\n\n \n \n // 停用流\n String namespaceId = \"2akrarsj8zp0w\";\n Stream stream = new Stream(\"teststream004\");\n streamManager.stopStream(namespaceId, stream.getStreamID());\n \n\n# **设备管理**\n\n## **创建设备**\n\n \n \n Response createDevice(String namespaceId, Device device) throws QiniuException\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnamespaceId | 空间id \ndevice | 设备配置参数，Device相关说明详见`Device类方法说明` \n \n### Device类方法说明\n\n * 获取设备名称\n \n String getName()\n \n\n * 设置设备名称\n \n void setName(String name)\n \n\n参数说明：设备名称 (可包含 字母、数字、中划线、下划线；1 ~ 100 个字符长)\n\n * 获取国标ID\n \n String getGbId()\n \n\n * 设置国标ID\n \n void setGbId(String gbId)\n \n\n * 获取用户名\n \n String getUsername()\n \n\n参数说明：用户名, 4~40位，可包含大写字母、小写字母、数字、中划线，建议与设备国标ID一致\n\n * 设置用户名\n \n void setUsername(String username)\n \n\n * 获取密码\n \n String getPassword()\n \n\n * 设置密码\n \n void setPassword(String password)\n \n\n参数说明：密码, 4~40位，可包含大写字母、小写字母、数字、中划线\n\n * 是否注册成功后启动拉流\n \n boolean isPullIfRegister()\n \n\n * 设置是否注册成功后启动拉流\n \n void setPullIfRegister(boolean pullIfRegister)\n \n\n * 获取描述信息\n \n String getDesc() \n \n\n * 设置描述信息\n \n void setDesc(String desc)\n \n\n### 示例\n\n \n \n // 创建设备\n DeviceManager deviceManager = new DeviceManager(auth);\n Device device = new Device();\n device.setUsername(\"admin\");\n device.setPassword(\"123456\");\n \n String namespaceId = \"3nm4x0v0h6vjr\";\n deviceManager.createDevice(namespaceId, device);\n \n\n \n\n## **删除设备**\n\n \n \n Response deleteDevice(String namespaceId, String gbId) throws QiniuException \n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnamespaceId | 空间id \ngbId | 国标id \n \n### 示例\n\n \n \n // 删除设备\n String namespaceId = \"3nm4x0v0h6vjr\";\n device.setGbId(\"31011500991320000056\");\n deviceManager.deleteDevice(namespaceId, device.getGbId());\n \n\n \n\n## **查询设备**\n\n \n \n Response queryDevice(String namespaceId, String gbId) throws QiniuException\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnamespaceId | 空间id \ngbId | 国标id \n \n### 示例\n\n \n \n // 查询设备\n String namespaceId = \"3nm4x0v0h6vjr\";\n device.setGbId(\"31011500991320000056\");\n deviceManager.queryDevice(namespaceId, device.getGbId());\n \n\n \n\n## **更新设备**\n\n \n \n Response updateDevice(String namespaceId, String gbId, PatchOperation[] patchOperation) throws QiniuException\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnamespaceId | 空间id \ngbId | 国标id \npatchOperation | 操作集，详见`PatchOperation类方法说明` \n \n### 示例\n\n \n \n // 更新设备\n PatchOperation[] patchOperation = {new PatchOperation(\"replace\", \"name\", \"GBTEST\")};\n String namespaceId = \"3nm4x0v0h6vjr\";\n device.setGbId(\"31011500991320000056\");\n deviceManager.updateDevice(namespaceId, device.getGbId(), patchOperation);\n \n\n \n\n## **获取设备列表**\n\n \n \n Response listDevice(String namespaceId, int offset, int line, String prefix, String state, int qtype)\n throws QiniuException\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnamespaceId | 空间id \noffset | 在全部流中的偏移量 \nline | 一次返回多少条 \nprefix | 可以通过gbid前缀进行检索查询 \nstate | 按设备状态查询，offline: 离线, online: 在线, notReg: 未注册, locked: 锁定 \nqtype | 按设备类型查询，0:全部, 1:摄像头, 2:平台 \n \n### 示例\n\n \n \n / 获取设备列表\n int offset = 0;\n int line = 3;\n int qtype = 0;\n String prefix = \"310\";\n String state = \"notReg\";\n String namespaceId = \"3nm4x0v0h6vjr\";\n \n deviceManager.listDevice(namespaceId, offset, line, prefix, state, qtype);\n \n\n \n\n## **获取通道列表**\n\n \n \n Response listChannels(String namespaceId, String gbId, String prefix) throws QiniuException\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnamespaceId | 空间id \ngbId | 国标id \nprefix | 通道国标ID前缀 \n \n### 示例\n\n \n \n // 获取通道列表\n String namespaceId = \"3nm4x0v0h6vjr\";\n String prefix = \"320\";\n device.setGbId(\"31011500991320000056\");\n deviceManager.listChannels(namespaceId, device.getGbId(), prefix);\n \n\n \n\n## **启动设备拉流**\n\n \n \n Response startDevice(String namespaceId, String gbId, String[] channels) throws QiniuException\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnamespaceId | 空间id \ngbId | 国标id \nchannels | 通道列表 \n \n### 示例\n\n \n \n // 启动设备拉流\n String namespaceId = \"3nm4x0v0h6vjr\";\n device.setGbId(\"31011500991320000056\");\n deviceManager.startDevice(namespaceId, device.getGbId(), new String[]{\"31011500991320000056\"});\n \n\n \n\n## **停止设备拉流**\n\n \n \n Response stopDevice(String namespaceId, String gbId, String[] channels) throws QiniuException \n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnamespaceId | 空间id \ngbId | 国标id \nchannels | 通道列表 \n \n### 示例\n\n \n \n // 停止设备拉流\n String namespaceId = \"3nm4x0v0h6vjr\";\n device.setGbId(\"31011500991320000056\");\n deviceManager.stopDevice(namespaceId, device.getGbId(), new String[]{\"31011500991320000056\"});\n \n\n \n\n## **同步设备通道**\n\n \n \n Response fetchCatalog(String namespaceId, String gbId) throws QiniuException\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnamespaceId | 空间id \ngbId | 国标id \n \n### 示例\n\n \n \n // 同步设备通道\n String namespaceId = \"2xenzw5o81ods\";\n device.setGbId(\"31011500991320000356\");\n deviceManager.fetchCatalog(namespaceId, device.getGbId());\n \n\n \n\n## **查询通道详情**\n\n \n \n Response queryChannel(String namespaceId, String gbId, String channelId) throws QiniuException\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnamespaceId | 空间id \ngbId | 国标id \nchannelId | 通道id \n \n### 示例\n\n \n \n // 查询通道详情\n deviceManager.queryChannel(\"3nm4x0vyz7xlu\", \"31011500991180000270\", \"34020000001310000020\");\n \n\n \n\n## **删除通道**\n\n \n \n Response deleteChannel(String namespaceId, String gbId, String channelId) throws QiniuException\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnamespaceId | 空间id \ngbId | 国标id \nchannelId | 通道id \n \n### 示例\n\n \n \n // 删除通道\n deviceManager.deleteChannel(\"3nm4x0vyz7xlu\", \"31011500991180000270\", \"34020000001310000020\");\n \n\n \n\n## **查询本地录像列表**\n\n \n \n Response queryGBRecordHistories(String namespaceId, String gbId, String channelId, int start, int end) throws QiniuException\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnamespaceId | 空间id \ngbId | 国标id \nchannelId | 网关设备时为通道ID(普通设备可以忽略) \nstart | 查询开始时间(unix时间戳,单位为秒) \nend | 查询结束时间(unix时间戳,单位为秒) \n \n### 示例\n\n \n \n // 查询本地录像列表\n deviceManager.queryGBRecordHistories(\"3nm4x0vyz7xlu\", \"31011500991180000270\", \"34020000001310000020\", 1604817540, 1604903940);\n \n\n# **模板管理**\n\n## **创建模板**\n\n \n \n Response createTemplate(Template template) throws QiniuException\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \ntemplate | 模板参数，详见`Template类方法说明` \n \n### Template类方法说明\n\n * 获取模板id\n \n String getId() \n \n\n * 设置模板id\n \n void setId(String id) \n \n\n * 获取模板名称\n \n String getName() \n \n\n * 设置模板名称\n \n void setName(String name) \n \n\n参数说明：模版名称，格式为 4 ~ 100个字符，可包含小写字母、数字、中划线、汉字)\n\n * 获取模板描述信息\n \n String getDesc() \n \n\n * 设置模板描述信息\n \n void setDesc(String desc) \n \n\n * 获取模版对应的对象存储的bucket\n \n String getBucket() \n \n\n * 设置模版对应的对象存储的bucket\n \n void setBucket(String bucket) \n \n\n * 获取存储过期时间\n \n int getDeleteAfterDays() \n \n\n * 设置存储过期时间,默认永久不过期\n \n void setDeleteAfterDays(int deleteAfterDays) \n \n\n * 获取模板类型\n \n int getTemplateType() \n \n\n * 设置模板类型\n \n void setTemplateType(int templateType) \n \n\n参数说明: 模板类型,取值：0（录制模版）, 1（截图模版）\n\n * 获取文件存储类型\n \n int getFileType() \n \n\n * 设置文件存储类型\n \n void setFileType(int fileType) \n \n\n参数说明: 文件存储类型,取值：0（普通存储）,1（低频存储）\n\n * 获取录制模式\n \n int getRecordType() \n \n\n * 设置录制模式\n \n void setRecordType(int recordType) \n \n\n参数说明: 录制模式, 0（不录制）,1（实时录制）, 2（按需录制）\n\n * 获取录制文件存储格式\n \n int getRecordFileFormat() \n \n\n * 设置录制文件存储格式\n \n void setRecordFileFormat(int recordFileFormat) \n \n\n参数说明: 录制文件存储格式(多选), 范围：1(001)～7(111), 从左往右的三位二进制数分别代表MP4, FLV, M3U8;\n0代表不选择该格式,\n1代表选择;例如：2(010)代表选择FLV格式，6(110)代表选择MP4和FLV格式，1(001)代表选择M3U8格式，7(111)代表三种格式均选择\n\n * 获取ts文件名字模板\n \n String getTsFilenametemplate() \n \n\n * 设置ts文件名字模板\n \n // record/ts/${namespaceId}/${streamId}/${startMs}-${endMs}.ts \n void setTsFilenametemplate(String tsFilenametemplate) \n \n\n * 获取录制封面名字模板\n \n String getRecordSnapFileNameFmt() \n \n\n * 设置录制封面名字模板\n \n // record/snap/${namespaceId}/${streamId}/${startMs}.jpg \n void setRecordSnapFileNameFmt(String recordSnapFileNameFmt) \n \n\n * 获取是否开启覆盖式截图\n \n boolean isJpgOverwriteStatus() \n \n\n * 设置是否开启覆盖式截图\n \n void setJpgOverwriteStatus(boolean jpgOverwriteStatus) \n \n\n * 获取是否开启序列式截图\n \n boolean isJpgSequenceStatus() \n \n\n * 设置是否开启序列式截图\n \n void setJpgSequenceStatus(boolean jpgSequenceStatus) \n \n\n * 获取是否开启按需截图\n \n boolean isJpgOnDemandStatus() \n \n\n * 设置是否开启按需截图\n \n void setJpgOnDemandStatus(boolean jpgOnDemandStatus) \n \n\n * 获取覆盖式截图文件命名格式\n \n String getJpgOverwriteFileNameTemplate() \n \n\n * 设置覆盖式截图文件命名格式\n \n void setJpgOverwriteFileNameTemplate(String jpgOverwriteFileNameTemplate) \n \n\n * 获取序列式截图文件命名格式\n \n String getJpgSequenceFileNameTemplate() \n \n\n * 设置序列式截图文件命名格式\n \n void setJpgSequenceFileNameTemplate(String jpgSequenceFileNameTemplate) \n \n\n * 获取按需式截图文件命名格式\n \n String getJpgOnDemandFileNameTemplate() \n \n\n * 设置按需式截图文件命名格式\n \n void setJpgOnDemandFileNameTemplate(String jpgOnDemandFileNameTemplate) \n \n\n * 获取模板创建时间\n \n int getCreatedAt() \n \n\n * 设置模板创建时间\n \n void setCreatedAt(int createdAt) \n \n\n * 获取模板更新时间\n \n int getUpdatedAt() \n \n\n * 设置模板更新时间\n \n void setUpdatedAt(int updatedAt) \n \n\n * 获取录制文件时长\n \n int getRecordInterval() \n \n\n * 设置录制文件时长\n \n void setRecordInterval(int recordInterval) \n \n\n参数说明: 单位为秒\n\n * 获取截图间隔\n \n int getSnapInterval() \n \n\n * 设置截图间隔\n \n void setSnapInterval(int snapInterval) \n \n\n参数说明：单位为秒\n\n * 获取m3u8文件命名格式\n \n String getM3u8FileNameTemplate() \n \n\n * 设置m3u8文件命名格式\n \n void setM3u8FileNameTemplate(String m3u8FileNameTemplate) \n \n\n * 获取flv文件命名格式\n \n String getFLVFileNameTemplate() \n \n\n * 设置flv文件命名格式\n \n void setFLVFileNameTemplate(String flvFileNameTemplate) \n \n\n * 获取mp4文件命名格式\n \n String getMp4FileNameTemplate() \n \n\n * 设置mp4文件命名格式\n \n void setMp4FileNameTemplate(String mp4FileNameTemplate) \n \n\n### 示例\n\n \n \n // 创建模板\n Template template = new Template();\n template.setName(\"testtemplate001\");\n template.setBucket(\"Testforhugo\");\n template.setTemplateType(1);\n template.setJpgOverwriteStatus(true);\n template.setRecordType(2);\n \n templateManager.createTemplate(template);\n \n\n \n\n## **查询模板**\n\n \n \n Response queryTemplate(String templateId) throws QiniuException\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \ntemplateId | 模板id \n \n### 示例\n\n \n \n // 查询模板\n String templateId = \"2akrarsl22iil\";\n templateManager.queryTemplate(templateId);\n \n\n \n\n## **更新模板**\n\n \n \n Response updateTemplate(String templateId, PatchOperation[] patchOperation) throws QiniuException\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \ntemplateId | 模板id \npatchOperation | 操作集，详见`PatchOperation类方法说明` \n \n### 示例\n\n \n \n // 更新模板\n String templateId = \"2akrarsl22iil\";\n PatchOperation[] patchOperation = {new PatchOperation(\"replace\", \"name\",\"testtemplate002\")};\n templateManager.updateTemplate(templateId, patchOperation);\n \n\n \n\n## **获取模板列表**\n\n \n \n Response listTemplate(int offset, int line, int templateType, String match) throws QiniuException\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \noffset | 在全部templates中的偏移量 \nline | 一次返回多少条 \ntemplateType | 模板类型，取值：0（录制模版）, 1（截图模版) \nmatch | 模糊匹配查询(模版名称包含match串时返回) \n \n### 示例\n\n \n \n // 获取模板列表\n int offset = 0;\n int line = 1;\n int templateType = 1;\n String match = \"test\";\n \n templateManager.listTemplate(offset, line, templateType, match);\n \n\n \n\n## **删除模板**\n\n \n \n Response deleteTemplate(String templateId)\n \n\n### 示例\n\n \n \n // 删除模板\n String templateId = \"2akrarsl22iil\";\n templateManager.deleteTemplate(templateId);\n \n\n# **录制管理**\n\n## **查询录制记录**\n\n \n \n Response queryStreamRecordHistories(String namespaceId, String streamId, int start, int end, int line, String marker) throws QiniuException\n Response queryStreamRecordHistories(String namespaceId, String streamId, int start, int end, int line, String marker, String format) throws QiniuException\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnamespaceId | 空间id \nstreamId | 流ID \nstart | 查询开始时间(unix时间戳,单位为秒) \nend | 查询结束时间(unix时间戳,单位为秒) \nline | 一次返回多少条 \nmarker | 上次返回的marker值 \nformat | 查询的文件类型 \n \n### 示例\n\n \n \n // 查询录制记录\n int start = 1587975463;\n int end = 1587976463;\n String maker = \"\";\n String namespaceId = \"3nm4x0v0h6vjr\";\n Stream stream = new Stream(\"teststream004\");\n \n streamManager.queryStreamRecordHistories(namespaceId, stream.getStreamID(), start, end, line, maker);\n \n\n \n\n## **查询流封面**\n\n \n \n Response queryStreamCover(String namespaceId, String streamId) throws QiniuException\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnamespaceId | 空间id \nstreamId | 流ID \n \n### 示例\n\n \n \n // 查询流封面 \n String namespaceId = \"3nm4x0v0h6vjr\";\n Stream stream = new Stream(\"teststream004\");\n streamManager.queryStreamCover(namespaceId, stream.getStreamID());\n \n\n \n\n## **获取截图列表**\n\n \n \n Response streamsSnapshots(String namespaceId, String streamId, int start, int end, int type, int line, String marker) throws QiniuException\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnamespaceId | 空间id \nstreamId | 流ID \nstart | 查询开始时间(unix时间戳,单位为秒) \nend | 查询结束时间(unix时间戳,单位为秒) \nline | 一次返回多少条 \nmarker | 上次返回的marker值 \ntype | 1:实时截图对应的图片列表 \n \n### 示例\n\n \n \n String namespaceId = \"3nm4x0v0h6vjr\";\n Stream stream = new Stream(\"teststream004\");\n int start = 1587975463;\n int end = 1587976463;\n int line = 1;\n streamManager.streamsSnapshots(namespaceId, stream.getStreamID(), start, end, 0, line, \"\");\n \n\n \n\n## **按需截图**\n\n \n \n Response ondemandSnap(String namespaceId, String streamId) throws QiniuException\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnamespaceId | 空间id \nstreamId | 流ID \n \n### 示例\n\n \n \n res = streamManager.ondemandSnap(\"2xenzw5o81ods\", \"31011500991320000356\");\n \n\n \n\n## **删除截图**\n\n \n \n Response deleteSnapshots(String namespaceId, String streamId, String[] files) throws QiniuException\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnamespaceId | 空间id \nstreamId | 流ID \nfiles | 删除的截图文件名称数组 \n \n \n\n## **启动按需录制**\n\n \n \n Response startRecord(String namespaceId, String streamId) throws QiniuException\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnamespaceId | 空间id \nstreamId | 流ID \n \n### 示例\n\n \n \n res = recordManager.startRecord(\"2xenzw5o81ods\", \"31011500991320000356\");\n \n\n \n\n## **停止按需录制**\n\n \n \n Response stopRecord(String namespaceId, String streamId) throws QiniuException\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnamespaceId | 空间id \nstreamId | 流ID \n \n### 示例\n\n \n \n res = recordManager.stopRecord(\"2xenzw5o81ods\", \"31011500991320000356\");\n \n\n \n\n## **删除录制片段**\n\n \n \n Response deleteStreamRecordHistories(String namespaceId, String streamId, String[] files) throws QiniuException\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnamespaceId | 空间id \nstreamId | 流ID \nfiles | 删除的录制文件名称数组 \n \n \n\n## **录制视频片段合并**\n\n \n \n Response recordClipsSaveas(String namespaceId, String streamId, String fname, String format, int start, int end, boolean deleteTs, String pipeline, String notifyUrl, int deleteAfterDays) throws QiniuException\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnamespaceId | 空间id \nstreamId | 流ID \nfname | 保存的文件名(需要带上文件格式后缀),不指定系统会随机生成 \nformat | 保存的文件格式,可以为m3u8, mp4或者flv \nstart | 查询开始时间(unix时间戳,单位为秒) \nend | 查询结束时间(unix时间戳,单位为秒) \ndeleteTs | 在不生成m3u8格式文件时是否删除对应的ts文件 \npipeline | 数据处理的私有队列，不指定则使用公共队列 \nnotifyUrl | 保存成功回调通知地址，不指定则不通知 \ndeleteAfterDays | 文件过期时间,默认和录制模版中的设置保持一致 \n \n### 示例\n\n \n \n res = recordManager.recordClipsSaveas(\"2xenzw5o81ods\", \"31011500991320000356\", \"\", \"m3u8\", 1605254612, 1605255300, false, \"\", \"\", 0);\n \n\n \n\n## **录制回放**\n\n \n \n Response recordsPlayback(String namespaceId, String streamId, int start, int end) throws QiniuException\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnamespaceId | 空间id \nstreamId | 流ID \nstart | 查询开始时间(unix时间戳,单位为秒) \nend | 查询结束时间(unix时间戳,单位为秒） \n \n### 示例\n\n \n \n res = recordManager.recordsPlayback(\"2xenzw5o81ods\", \"31011500991320000356\", 1605254612, 1605255300);\n \n\n# **数据统计管理**\n\n## **查询带宽数据**\n\n \n \n Response queryBandwidth(String namespaceId, String streamId, String tu, int start, int end) throws QiniuException\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnamespaceId | 空间id \nstreamId | 流ID \nstart | 年月日模式(20191001)或者年月日时分秒模式(20201012204005) \nend | 年月日模式(20191002)或者年月日时分秒模式(20201012204005) \ntu | 时间粒度 可以是 5min, hour, day \n \n### 示例\n\n \n \n res = statsManager.queryBandwidth(\"\", \"\", \"5min\", 20200901, 20200902);\n \n\n \n\n## **查询流量数据**\n\n \n \n Response queryFlow(String namespaceId, String streamId, String tu, int start, int end) throws QiniuException\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnamespaceId | 空间id \nstreamId | 流ID \nstart | 年月日模式(20191001)或者年月日时分秒模式(20201012204005) \nend | 年月日模式(20191002)或者年月日时分秒模式(20201012204005) \ntu | 时间粒度 可以是 5min, hour, day \n \n### 示例\n\n \n \n res = statsManager.queryFlow(\"\", \"\", \"5min\", 20200901, 20200902);\n \n\n# **PTZ管理**\n\n## **云台控制**\n\n \n \n Response ptzControl(String namespaceId, String gbId, String cmd, int speed, String chId) throws QiniuException\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnamespaceId | 空间id \ngbId | 设备国标Id \ncmd | left(向左), right(向右), up(向上), down(向下), leftup(左上), rightup(右上), leftdown(左下), rightdown(右下), zoomin(缩小), zoomout(放大),stop(停止PTZ操作) \nspeed | 调节速度(1~10, 默认位5) \nchId | 子设备国标ID \n \n### 示例\n\n \n \n res = ptzManager.ptzControl(\"2xenzw5o81ods\", \"31011500991320000382\", \"up\", 5, \"\");\n \n\n \n\n## **变焦控制**\n\n \n \n Response focusControl(String namespaceId, String gbId, String cmd, int speed, String chId) throws QiniuException\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnamespaceId | 空间id \ngbId | 设备国标Id \ncmd | focusnear(焦距变近), focusfar(焦距变远),stop(停止) \nspeed | 调节速度(1~10, 默认位5) \nchId | 子设备国标ID \n \n### 示例\n\n \n \n res = ptzManager.focusControl(\"2xenzw5o81ods\", \"31011500991320000382\", \"focusfar\", 5, \"\");\n \n\n \n\n## **光圈控制**\n\n \n \n Response irisControl(String namespaceId, String gbId, String cmd, int speed, String chId) throws QiniuException\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnamespaceId | 空间id \ngbId | 设备国标Id \ncmd | irisin(光圈变小), irisout(光圈变大),stop(停止) \nspeed | 调节速度(1~10, 默认位5) \nchId | 子设备国标ID \n \n### 示例\n\n \n \n res = ptzManager.irisControl(\"2xenzw5o81ods\", \"31011500991320000382\", \"irisin\", 5, \"\");\n \n\n \n\n## **预置位控制**\n\n \n \n Response presetsControl(String namespaceId, String gbId, String cmd, String name, int presetId, String chId) throws QiniuException\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnamespaceId | 空间id \ngbId | 设备国标Id \ncmd | set(新增预置位), goto(设置),remove(删除) \nname | 预置位名称(cmd为set时有效,支持中文) \npresetId | 预置位ID \nchId | 子设备国标ID \n \n### 示例\n\n \n \n res = ptzManager.presetsControl(\"2xenzw5o81ods\", \"31011500991320000382\", \"set\", \"test\", 0, \"\");\n \n\n \n\n## **获取预置位列表**\n\n \n \n Response listPresets(String namespaceId, String gbId, String chId) throws QiniuException\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnamespaceId | 空间id \ngbId | 设备国标Id \nchId | 子设备国标ID \n \n### 示例\n\n \n \n res = ptzManager.listPresets(\"2xenzw5o81ods\", \"31011500991320000382\", \"\");\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的视频监控Go SDK"
},
{
"from": "gpt",
"value": "[视频监控](https://developer.qiniu.com/qvs) > SDK 下载 > 服务端SDK >Go SDK\n\n# Go SDK\n\n最近更新时间: 2021-11-26 11:50:52\n\n# **简介**\n\n此SDK主要帮助您快速接入七牛云的视频监控平台。\n\n主要有如下功能：\n\n * 空间管理\n * 流管理\n * 设备管理\n * 模板管理\n * 录制管理\n * 数据统计管理\n\n# **开源**\n\n * [Go SDK 项目地址 __](https://github.com/qiniu/go-sdk)\n * [Go SDK 发布地址 __](https://github.com/qiniu/go-sdk/releases)\n\n# **安装**\n\n推荐使用 go mod ， `github.com/qiniu/go-sdk/v7` ，如 `require github.com/qiniu/go-\nsdk/v7 v7.9.6`\n\n# **鉴权**\n\n七牛 Go SDK 的所有的功能，都需要合法的授权。授权凭证的签算需要七牛账号下的一对有效的`Access Key`和`Secret\nKey`，这对密钥可以通过如下步骤获得：\n\n 1. 点击[注册 __](https://portal.qiniu.com/signup)开通七牛开发者帐号\n 2. 如果已有账号，直接登录七牛开发者后台，点击[这里🔗 __](https://portal.qiniu.com/user/key)查看 Access Key 和 Secret Key\n\n# **快速接入**\n\n下面以`rtmp`接入方式举例，讲述接入流程，sdk接口详细说明见后面的章节\n\n * 1. 创建qvs manager\n \n ak := \"your access key\"\n sk := \"your secret key\"\n mac := auth.New(ak, sk)\n manager := qvs.NewManager(mac, nil)\n \n\n * 2. 创建空间\n\n构造好`NameSpace`结构体之后，调用`AddNamespace`创建空间\n\n \n ns := &NameSpace{\n \tName: \"testNamespace\",\n \tAccessType: \"rtmp\",// 接入类型\"gb28181\"或者“rtmp”\n \tRTMPURLType: 1, // accessType为“rtmp”时，推拉流地址计算方式，1:static, 2:dynamic\n \tDomains: []string{\"qiniu1.com\"}, // 直播域名\n }\n ns1, err := manager.AddNamespace(ns)\n \n\n * 3. 创建流\n\n构造好`Stream`结构体之后，调用`AddStream`创建流\n\n \n stream := &Stream{\n \tStreamID: \"test001\",\n }\n _, err = manager.AddStream(ns1.ID, stream)\n \n\n * 4. 生成推拉流地址\n \n ret, err := manager.DynamicPublishPlayURL(\"2akrarwwhi0ff\", \"test1\", &qvs.DynamicLiveRoute{PublishIP: \"127.0.0.1\", PlayIP: \"127.0.0.1\", UrlExpireSec: 0})\n if err != nil {\n \tfmt.Printf(\"err=%s\\n\", err.Error())\n }\n publishUrl := ret.PublishUrl\n playUrl := ret.PlayUrls.Rtmp\n \n\n * 5. 在推流端(一般是摄像头)使用`publishUrl`推流\n * 6. 可以使用`ffplay`或者`vlc`播放`playUrl`的流\n\n# **空间管理**\n\n空间管理的所有接口需要先通过`ak`、`sk`创建qvs manager\n\n \n \n ak := \"your access key\"\n sk := \"your secret key\"\n mac := auth.New(ak, sk)\n manager := qvs.NewManager(mac, nil)\n \n\n \n\n## **创建空间**\n\n \n \n func (manager *Manager) AddNamespace(ns *NameSpace) (*NameSpace, error)\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nns | 空间相关参数，详见NameSpace结构体说明 \n \n### NameSpace结构体说明\n\n成员 | 类型 | 是否必须 | 说明 \n---|---|---|--- \nID | string | 否 | 空间id \nName | string | 是 | 空间名称(格式\"^[a-zA-Z0-9_-]{1,100}$\") \nDesc | string | 否 | 空间描述 \nAccessType | string | 是 | 接入类型\"gb28181\"或者“rtmp” \nRTMPURLType | int | 当accessType为\"rtmp\"时必填 | accessType为“rtmp”时，推拉流地址计算方式，1:static, 2:dynamic \nZone | string | 否 | zone为服务区域配置项，可选项为z0、z1、z2，默认为z0。z0表示华东、z1表示华北、z2表示华南 \nDomains | []string | 当rtmpUrlType为1时必填 | 直播域名 \nCallback | string | 否 | 后台服务器回调URL \nDisabled | bool | 否 | 流是否被启用，false:启用，true:禁用 \nRecordTemplateId | string | 否 | 录制模版id \nSnapShotTemplateId | string | 否 | 截图模版id \nRecordTemplateApplyAll | bool | 否 | 空间模版是否应用到全局 \nSnapTemplateApplyAll | bool | 否 | 截图模版是否应用到全局 \nHLSLowLatency | bool | 否 | HLS低延时开关 \nCreatedAt | int64 | 否 | 空间创建时间 \nUpdatedAt | int64 | 否 | 空间更新时间 \nDevicesCount | int64 | 否 | 设备数量 \nStreamCount | int64 | 否 | 流数量 \nOnlineStreamCount | int64 | 否 | 在线流数量 \nDisabledStreamCount | int64 | 否 | 禁用流数量 \nOnDemandPull | bool | 否 | 按需拉流开关，默认关闭 \n \n### 示例\n\n \n \n ns := &NameSpace{\n \tName: \"testNamespace\",\n \tAccessType: \"rtmp\",// 接入类型\"gb28181\"或者“rtmp”\n \tRTMPURLType: 1, // accessType为“rtmp”时，推拉流地址计算方式，1:static，2:dynamic\n \tDomains: []string{\"qiniu1.com\"}, // 直播域名\n }\n ns1, err := manager.AddNamespace(ns)\n \n\n \n\n## **删除空间**\n\n \n \n func (manager *Manager) DeleteNamespace(nsId string)\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnsId | 空间id \n \n### 示例\n\n \n \n // 删除空间\n nsId := \"2akrarsj8zp0w\"\n manager.DeleteNamespace(nsId)\n \n\n \n\n## **更新空间**\n\n \n \n func (manager *Manager) UpdateNamespace(nsId string, ops []PatchOperation) (*NameSpace, error) \n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnsId | 空间id \nops | 操作集，详见PatchOperation结构体说明 \n \n### PatchOperation结构体说明\n\n成员 | 类型 | 说明 \n---|---|--- \nOp | string | 更该或删除某个属性，replace：更改，delete：删除 \nKey | string | 要修改或删除的属性 \nValue | interface | 要修改或删除属性的值 \n \n### 示例\n\n \n \n // 更新空间\n nsId := \"2akrarsj8zp0w\"\n ops := []PatchOperation{\n \t\t{\n \t\t\tOp: \"replace\",\n \t\t\tKey: \"name\",\n \t\t\tValue: \"testNamespace2\",\n \t\t},\n \t\t{\n \t\t\tOp: \"replace\",\n \t\t\tKey: \"zone\",\n \t\t\tValue: \"z1\",\n \t\t},\n }\n ns3, err := manager.UpdateNamespace(nsId, ops)\n \n\n \n\n## **查询空间信息**\n\n \n \n func (manager *Manager) QueryNamespace(nsId string) (*NameSpace, error) \n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnsId | 空间id \n \n### 示例\n\n \n \n // 查询空间信息\n nsId := \"2akrarsj8zp0w\"\n manager.DeleteNamespace(nsId)\n \n\n \n\n## **获取空间列表**\n\n \n \n func (manager *Manager) ListNamespace(offset, line int, sortBy string) ([]NameSpace, int64, error)\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \noffset | 在全部namespace中的偏移量 \nline | 一次返回多少条 \nsortBy | asc 表示升序, desc 表示降序, 默认按创建时间降序排列(可参与排序的字段有createdAt, updatedAt).asc:updatedAt表示更新时间从小到大排序, desc:updatedAt表示更新时间从大到小排序 \n \n### 示例\n\n \n \n // 获取空间列表\n offset := 0\n line := 100\n sortBy := \"asc\"\n \n nss, total, err := manager.ListNamespace(offset, line, sortBy)\n \n\n \n\n## **禁用空间**\n\n \n \n func (manager *Manager) DisableNamespace(nsId string) error\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnsId | 空间id \n \n### 示例\n\n \n \n // 禁用空间\n nsId := \"2akrarsj8zp0w\"\n err := manager.DisableNamespace(nsId)\n \n\n \n\n## **启用空间**\n\n \n \n func (manager *Manager) EnableNamespace(nsId string) error\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnsId | 空间id \n \n### 示例\n\n \n \n // 启用空间\n nsId := \"2akrarsj8zp0w\"\n err := manager.EnableNamespace(nsId)\n \n\n# **流管理**\n\n## **创建流**\n\n本接口仅用于接入类型为RTMP的空间\n\n \n \n func (manager *Manager) AddStream(nsId string, stream *Stream) (*Stream, error)\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnsId | 空间id \nStream | 流相关参数结构体，详见Stream结构体说明 \n \n### Stream结构体说明\n\nStreamID | 类型 | 说明 \n---|---|--- \nStreamID | string | 流名称, 流名称在空间中唯一，可包含 字母、数字、中划线、下划线；1 ~ 100 个字符长；创建后将不可修改 \nDesc | string | 关于流的描述信息 \nNamespaceId | string | 所属的空间ID \nNamespace | string | 所属的空间名称 \nRecordTemplateId | string | 录制模版ID，配置流维度的录制模板 \nSnapShotTemplateId | string | 截图模版ID，配置流维度的截图模板 \nStatus | bool | 设备是否在线 \nDisabled | bool | 流是否被禁用 \nLastPushedAt | int64 | 最后一次推流时间，0:表示没有推流 \nCreatedAt | int64 | 流创建时间 \nUpdatedAt | int64 | 流更新时间 \nUserCount | int | 在线观看人数 \nClientIp | string | 推流端ip \nAudioFrameRate | int64 | 直播流的实时音频帧率 \nBitRate | int64 | 直播流的实时码率 \nVideoFrameRate | int64 | 直播流的实时视频帧率 \n \n### 示例\n\n \n \n // 创建流\n stream := &Stream{\n \t\tStreamID: \"test003\",\n }\n _, err = manager.AddStream(ns1.ID, stream)\n \n\n \n\n## **删除流**\n\n \n \n func (manager *Manager) DeleteStream(nsId string, streamId string) error\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnsId | 空间id \nstreamId | 流id \n \n### 示例\n\n \n \n // 删除流\n manager.DeleteStream(ns1.ID, \"test001\")\n \n\n \n\n## **查询流信息**\n\n \n \n func (manager *Manager) QueryStream(nsId string, streamId string) (*Stream, error) \n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnsId | 空间id \nstreamId | 流id \n \n### 示例\n\n \n \n // 查询流信息\n manager.QueryStream(ns1.ID, \"test001\")\n \n\n \n\n## **更新流**\n\n \n \n func (manager *Manager) UpdateStream(nsId string, streamId string, ops []PatchOperation) (*Stream, error)\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnsId | 空间id \nops | 操作集，详见PatchOperation结构体说明 \n \n### 示例\n\n \n \n // 更新流\n stream := &Stream{\n \t\tStreamID: \"test003\",\n }\n ops := []PatchOperation{\n \t\t{\n \t\t\tOp: \"replace\",\n \t\t\tKey: \"desc\",\n \t\t\tValue: \"test\",\n \t\t},\n }\n stream1, err := manager.UpdateStream(ns1.ID, stream.StreamID, ops)\n \n\n \n\n## **获取流列表**\n\n \n \n func (manager *Manager) ListStream(nsId string, offset, line int, prefix, sortBy string, qType int) ([]Stream, int64, error)\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnsId | 空间id \noffset | 在全部流中的偏移量 \nline | 一次返回多少条 \nprefix | 流ID 前缀，可以流ID 前缀进行检索查询 \nsortBy | asc 表示升序，desc 表示降序。默认按创建时间降序排列(可参与排序的字段有createdAt, updatedAt, lastPushedAt). asc:updatedAt表示更新时间从小到大排序, desc:updatedAt表示更新时间从大到小排序 \nqType | 查询流类型， 0:全部，1:在线流，2:离线流 \n \n### 示例\n\n \n \n // **获取流列表**\n streams, total, err := manager.ListStream(ns1.ID, 0, 2, \"test\", \"desc:updatedAt\", 0)\n \n\n \n\n## **获取动态推拉流地址**\n\n \n \n func (manager *Manager) DynamicPublishPlayURL(nsId string, streamId string, route *DynamicLiveRoute) (*RouteRet, error)\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnsId | 空间id \nstreamId | 流id \nroute | 动态模式的推拉流域名相关参数，详见DynamicLiveRoute结构体说明 \n \n### DynamicLiveRoute结构体说明\n\n成员 | 类型 | 说明 \n---|---|--- \nPublishIP | string | 推流端对外IP地址 \nPlayIP | string | 拉流端对外IP地址 \nUrlExpireSec | int64 | 地址过期时间，urlExpireSec:100代表100秒后过期；默认urlExpireSec:0,永不过期 \n \n### RouteRet结构体说明\n\n成员 | 类型 | 说明 \n---|---|--- \nPublishUrl | string | rtmp推流地址 \nPlayUrls | RoutePlayUrls,详见RoutePlayUrls结构体说明 | 拉流URLs \nPublishUrlExpired | int64 | 推拉流地址过期时间点(unix时间戳,单位second) \n \n### RoutePlayUrls结构体说明\n\n成员 | 类型 | 说明 \n---|---|--- \nRtmp | string | rtmp播放地址 \nFlv | string | flv播放地址 \nHls | string | hls播放地址 \n \n### 示例\n\n \n \n // 获取动态推拉流地址\n ret, err := manager.DynamicPublishPlayURL(\"2akrarwwhi0ff\", \"test1\", &qvs.DynamicLiveRoute{PublishIP: \"127.0.0.1\", PlayIP: \"127.0.0.1\", UrlExpireSec: 0})\n \n\n \n\n## **获取静态推拉流地址**\n\n \n \n func (manager *Manager) StaticPublishPlayURL(nsId, streamId string, route *StaticLiveRoute) (string, error)\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnsId | 空间id \nstreamId | 流id \nroute | 静态模式的推拉流域名相关参数，详见StaticLiveRoute结构体说明 \n \n### StaticLiveRoute结构体说明\n\n成员 | 类型 | 说明 \n---|---|--- \nDomain | string | 域名 \nDomainType | string | 域名类型 \nUrlExpireSec | int64 | 地址过期时间，urlExpireSec:100代表100秒后过期；默认urlExpireSec:0,永不过期 \n \n## 示例\n\n \n \n // 获取静态推拉流地址\n ret, err := manager.StaticPublishPlayURL(ns1.ID, \"1\", &StaticLiveRoute{Domain: \"qvs-publish.qiniu1.com\", DomainType: DomainPublishRTMP})\n \n\n \n\n## **禁用流**\n\n \n \n func (manager *Manager) DisableStream(nsId string, streamId string) error\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnsId | 空间id \nstreamId | 流id \n \n### 示例\n\n \n \n // 禁用流\n manager.DeleteStream(ns1.ID, \"test001\")\n \n\n \n\n## **启用流**\n\n \n \n func (manager *Manager) EnableStream(nsId string, streamId string) error\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnsId | 空间id \nstreamId | 流id \n \n### 示例\n\n \n \n // 启用流\n manager.DeleteStream(ns1.ID, \"test001\")\n \n\n \n\n## **停用流**\n\n \n \n func (manager *Manager) StopStream(nsId string, streamId string) error\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnsId | 空间id \nstreamId | 流id \n \n### 示例\n\n \n \n // 停用流\n manager.StopStream(ns1.ID, \"test001\"）\n \n\n \n\n## **查询推流记录**\n\n \n \n func (manager *Manager) QueryStreamPubhistories(nsId string, streamId string, start, end int, line, offset int) ([]StreamPublishHistory, int64, error)\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnsId | 空间id \nstreamId | 流id \nstart | 推流开始时间(unix timestamp in second) \nend | 推流结束时间(unix timestamp in second) \nline | 一次返回多少条 \noffset | 在全部流中的偏移量 \n \n### 示例\n\n \n \n // 查询推流记录\n start := 1587975463\n end := 1587976463\n offset := 0\n line := 1\n manager.DeleteStream(ns1.ID, \"test001\", start, end, line, offset)\n \n\n# **设备管理**\n\n## **创建设备**\n\n \n \n func (manager *Manager) AddDevice(device *Device) (*Device, error)\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nDevice | 设备相关参数，详见Device结构体说明 \n \n### Device结构体说明\n\n成员 | 类型 | 说明 \n---|---|--- \nNamespaceId | string | 所属的空间ID \nName | string | 设备名称 \nGBId | string | 设备国标ID \nType | int | 设备类型，取值1（摄像头）, 2（平台） \nUsername | string | 用户名 \nPassword | string | 密码 \nPullIfRegister | bool | 注册成功后启动拉流, 默认关闭 \nDesc | string | 设备描述 \nNamespaceName | string | 所属的空间名称 \nState | string | 状态（offline: 离线, online: 在线, notReg: 未注册, locked: 锁定） \nChannels | int | 设备通道数 \nVendor | string | 厂商 \nCreatedAt | int64 | 创建时间，Unix时间戳，秒 \nUpdatedAt | int64 | 更新时间，Unix时间戳，秒 \nLastRegisterAt | int64 | 上一次注册时间，Unix时间戳，秒 \nLastKeepaliveAt | int64 | 上一次心跳时间，Unix时间戳，秒 \n \n### 示例\n\n \n \n // 创建设备\n device := &Device {\n \tName: \"device1\",\n \tDesc: \"test gb28181\",\n \tUsername: \"username\",\n \tPassword: \"password\"\n }\n dev, err := manager.AddDevice(device)\n \n\n## **删除设备**\n\n \n \n DeleteDevice(nsId string, gbId string) error\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnsId | 空间id \ngbId | 国标id \n \n### 示例\n\n \n \n // 删除设备\n dev, err := manager.DeleteDevice(ns1.ID, \"device1\")\n \n\n## **更新设备**\n\n \n \n func (manager *Manager) UpdateDevice(nsId string, gbId string, ops []PatchOperation) (*Device, error) \n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnsId | 空间id \ngbId | 国标Id \nops | 操作集，详见PatchOperation结构体说明 \n \n### 示例\n\n \n \n // 更新设备\n ops := []PatchOperation{\n \t{\n \t\tOp: \"replace\",\n \t\tKey: \"desc\",\n \t\tValue: \"test\",\n \t},\n }\n dev, err := manager.UpdateDevice(ns1.ID, dev.gbId, ops)\n \n\n## **查询设备信息**\n\n \n \n func (manager *Manager) QueryDevice(nsId string, gbId string) (*Device, error)\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnsId | 空间id \ngbId | 国标id \n \n### 示例\n\n \n \n // 删除设备\n nsId := \"testNsId\"\n gbId := \"testGbId\"\n dev, err := manager.QueryDevice(nsId, gbId)\n \n\n## **查询设备列表**\n\n \n \n func (manager *Manager) ListDevice(nsId string, offset, line int, prefix, state string, qType int) ([]Device, int64, error)\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnsId | 空间id \noffset | 在全部Device中的偏移量 \nline | 一次返回多少条 \nprefix | 可以通过gbid前缀进行检索查询 \nstate | 按设备状态查询，offline: 离线，online: 在线，notReg: 未注册，locked: 锁定 \nqtype | 按设备类型查询，0:全部，1:摄像头，2:平台 \n \n### 示例\n\n \n \n // 查询设备列表\n nsId := \"testNsId\"\n gbId := \"testGbId\"\n dev, err := manager.ListDevice(ns1.ID, 0, 2, \"302\", \"\", 0)\n \n\n## **查询通道列表**\n\n \n \n func (manager *Manager) ListChannels(nsId string, gbId string, prefix string) (*DeviceChannels, error)\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnsId | 空间id \ngbId | 国标id \nprefix | 通道国标ID前缀 \n \n### 示例\n\n \n \n // 删除设备\n nsId := \"testNsId\"\n gbId := \"testGbId\"\n prefix := \"320\"\n dev, err := manager.ListChannels(nsId, gbId, prefix)\n \n\n## **启动设备拉流**\n\n \n \n func (manager *Manager) StartDevice(nsId string, gbId string, channels []string) error\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnsId | 空间id \ngbId | 国标id \nchannels | 平台设备指定需要启动的通道国标ID(为空表示启动平台下的所有设备) \n \n### 示例\n\n \n \n // 启动设备拉流\n nsId := \"testNsId\"\n gbId := \"testGbId\"\n channels := []string{\"31011500991320000028\"}\n dev, err := manager.StartDevice(nsId, gbId, channels)\n \n\n## **停止设备拉流**\n\n \n \n func (manager *Manager) StopDevice(nsId string, gbId string, channels []string) error\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnsId | 空间id \ngbId | 国标id \nchannels | 平台设备指定需要结束的通道国标ID(为空表示停止平台下的所有设备) \n \n### 示例\n\n \n \n // 停止设备拉流\n nsId := \"testNsId\"\n gbId := \"testGbId\"\n channels := []string{\"31011500991320000028\"}\n dev, err := manager.StartDevice(nsId, gbId, channels)\n \n\n \n\n## **同步设备通道**\n\n \n \n func (manager *Manager) FetchCatalog(nsId, gbId string) error \n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnsId | 空间id \ngbId | 国标id \n \n### 示例\n\n \n \n err = c.FetchCatalog(\"3nm4x0vyz7xlu\", \"31011500991180000270\")\n \n\n \n\n## **查询通道详情**\n\n \n \n func (manager *Manager) QueryChannel(nsId, gbId, channelId string) (*Channel, error)\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnsId | 空间id \ngbId | 国标id \nchannelId | 通道id \n \n### 示例\n\n \n \n channel, err := c.QueryChannel(\"3nm4x0vyz7xlu\", \"31011500991180000270\", \"31011500991180000135\")\n \n\n \n\n## **删除通道**\n\n \n \n func (manager *Manager) DeleteChannel(nsId, gbId, channelId string) error\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnsId | 空间id \ngbId | 国标id \nchannelId | 通道id \n \n### 示例\n\n \n \n err = c.DeleteChannel(\"3nm4x0vyz7xlu\", \"31011500991180000270\", \"31011500991180000135\")\n \n\n \n\n## **查询本地录像列表**\n\n \n \n func (manager *Manager) QueryGBRecordHistories(nsId, gbId, chId string, start, end int) (*DeviceVideoItems, error)\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnsId | 空间id \ngbId | 国标id \nchannelId | 网关设备时为通道ID(普通设备可以忽略) \nstart | 查询开始时间(unix时间戳,单位为秒) \nend | 查询结束时间(unix时间戳,单位为秒) \n \n### 示例\n\n \n \n ret, err := c.QueryGBRecordHistories(\"3nm4x0vyz7xlu\", \"31011500991180000270\", \"34020000001310000020\", 1604817540, 1604903940)\n \n\n# **模板管理**\n\n## **创建模板**\n\n \n \n func (manager *Manager) AddTemplate(tmpl *Template) (*Template, error) \n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nTmpl | 模板相关参数，详见Template结构体说明 \n \n### Template结构体说明\n\n成员 | 类型 | 说明 \n---|---|--- \nID | string | 模板id \nName | string | 模版名称，格式为 4 ~ 100个字符，可包含小写字母、数字、中划线、汉字 \nDesc | string | 模版描述 \nBucket | string | 模版对应的对象存储的bucket \nDeleteAfterDays | int | 储过期时间，默认永久不过期 \nTemplateType | int | 板类型，取值：0（录制模版），1（截图模版） \nFileType | int | 件存储类型，取值：0（普通存储），1（低频存储） \nRecordType | int | 录制模式，0（不录制），1（实时录制），2（按需录制） \nRecordFileFormat | int | 录制文件存储格式(多选)，范围：1(001)～7(111)，从左往右的三位二进制数分别代表MP4、FLV、M3U8；0代表不选择该格式，1代表选择；例如：2(010)代表选择FLV格式，6(110)代表选择MP4和FLV格式，1(001)代表选择M3U8格式，7(111)代表三种格式均选择 \nTSFileNameTemplate | string | ts文件名模板，例如：record/ts/${namespaceId}/${streamId}/${startMs}-${endMs}.ts \nRecordSnapFileNameFmt | string | 截图文件名格式，例如：/record/snap/${namespaceId}/${streamId}/${startMs}.jpg \nRecordInterval | int | 录制文件长度 \nM3u8FileNameTemplate | string | m3u8文件命名格式 \nFLVFileNameTemplate | string | flv文件命名格式 \nMP4FileNameTemplate | string | mp4文件命名格式 \nJpgOverwriteStatus | bool | 开启覆盖式截图(一般用于流封面) \nJpgSequenceStatus | bool | 开启序列式截图 \nJpgOnDemandStatus | bool | 开启按需截图 \nJpgOverwriteFileNameTemplate | string | 覆盖式截图文件命名格式:snapshot/jpg/${namespaceId}/${streamId}/${streamId}.jpg \nJpgSequenceFileNameTemplate | string | 序列式截图文件命名格式:snapshot/jpg/${namespaceId}/${streamId}/${startMs}.jpg \nJpgOnDemandFileNameTemplate | string | 按需式截图文件命名格式:snapshot/jpg/${namespaceId}/${streamId}/ondemand-${startMs}.jpg \nSnapInterval | int | 序列式截图时间间隔 \nCreatedAt | int64 | 模板创建时间 \nUpdatedAt | int64 | 模板更新时间 \nZone | string | one为服务区域配置项，可选项为z0、z1、z2，默认为z0。z0表示华东、z1表示华北、z2表示华南 \n \n### 示例\n\n \n \n // 创建模板\n tmpl := &Template{\n \t\tName: \"test001\",\n \t\tBucket: \"xxxx\",\n \t\tTemplateType: 1,\n \t\tJpgOverwriteStatus: true,\n \t\tRecordType: 2,\n \t\tZone: \"z0\",\n \t\tRecordFileFormat: 1,\n }\n tmpl1, err := c.AddTemplate(tmpl)\n \n\n \n\n## **删除模板**\n\n \n \n func (manager *Manager) DeleteTemplate(templId string) error\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \ntemplId | 模板id \n \n### 示例\n\n \n \n // 删除模板\n manager.DeleteTemplate(tmpl1.ID)\n \n\n \n\n## **更新模板**\n\n \n \n func (manager *Manager) UpdateTemplate(templId string, ops []PatchOperation) (*Template, error)\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \ntemplId | 模板id \nops | 操作集，详见#PatchOperation结构体说明 \n \n### 示例\n\n \n \n // 更新模板\n ps := []PatchOperation{\n \t\t{\n \t\t\tOp: \"replace\",\n \t\t\tKey: \"name\",\n \t\t\tValue: \"test002\",\n \t\t},\n \t\t{\n \t\t\tOp: \"replace\",\n \t\t\tKey: \"zone\",\n \t\t\tValue: \"z1\",\n \t\t},\n }\n tmpl2, err := manager.UpdateTemplate(tmpl1.ID, ops)\n \n\n \n\n## **查询模板信息**\n\n \n \n func (manager *Manager) QueryTemplate(templId string) (*Template, error)\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \ntemplId | 模板id \n \n### 示例\n\n \n \n // 查询模板信息\n tmpl2, err := manager.QueryTemplate(\"2akrarsl22iil\")\n \n\n \n\n## **获取模板列表**\n\n \n \n func (manager *Manager) ListTemplate(offset, line int, sortBy string, templateType int, match string) ([]Template, int64, error) \n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \noffset | 在全部templates中的偏移量 \nline | 一次返回多少条 \nsortBy | 默认按创建时间降序排列，sortBy由\"asc/desc\"和可参与排序的字段组成，其中 asc 表示升序，desc 表示降序，可参与排序的字段有createdAt，updatedAt。asc:updatedAt表示更新时间从小到大排序，desc:updatedAt表示更新时间从大到小排序 \ntemplateType | 模板类型，取值：0（录制模版），1（截图模版） \nmatch | 模糊匹配查询(模版名称包含match串时返回) \n \n### 示例\n\n \n \n // 获取模板列表\n nss, total, err := c.ListTemplate(0, 2, \"asc:updatedA\", 1, \"\")\n \n\n# **录制管理**\n\n## **查询录制记录**\n\n \n \n func (manager *Manager) QueryStreamRecordHistories(nsId string, streamId string, start, end int, marker string, line int, format string) ([]RecordHistory, string, error)\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnsId | 空间id \nstreamId | 流id \nstart | 查询开始时间(unix时间戳，单位为秒) \nend | 查询结束时间(unix时间戳，单位为秒) \nmarker | 上次返回的marker值 \nline | 一次返回多少条 \nformat | 查询录制格式，\"\"为查询所有格式视频 \n \n### 示例\n\n \n \n // 查询录制记录\n nsId := \"2akrarsj8zp0w\"\n streamId := \"test01\"\n start := 1587975463\n end := 1587976463\n marker := \"\"\n line := 10\n format := \"\"\n recordHistory, err := manager.QueryStreamRecordHistories(nsId, streamId, start, end, marker, line, format)\n \n\n \n\n## **获取截图列表**\n\n \n \n func (manager *Manager) StreamsSnapshots(nsId string, streamId string, start, end int, qtype int, line int, marker string) ([]byte, error)\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnsId | 空间id \nstreamId | 流id \nstart | 查询开始时间(unix时间戳,单位为秒) \nend | 查询结束时间(unix时间戳,单位为秒) \nqtype | 1:实时截图对应的图片列表 \nline | 限定返回截图的个数，只能输入1-100的整数，不指定默认返回30个 \n \n### 示例\n\n \n \n // 查询录制记录\n nsId := \"2akrarsj8zp0w\"\n streamId := \"test01\"\n start := 1587975463\n end := 1587976463\n marker := \"\"\n line := 10\n qtype := 1\n recordHistory, err := manager.StreamsSnapshots(nsId, streamId, start, end, qtype, line)\n \n\n \n\n## **获取直播封面截图**\n\n \n \n func (manager *Manager) QueryStreamCover(nsId string, streamId string) (string, error)\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnsId | 空间id \nstreamId | 流id \n \n### 示例\n\n \n \n // 获取直播封面截图\n nsId := \"2akrarsj8zp0w\"\n streamId := \"test01\"\n cover, err := manager.QueryStreamCover(nsId, streamId)\n \n\n \n\n## **按需截图**\n\n \n \n func (manager *Manager) OndemandSnap(nsId, streamId string) error\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnsId | 空间id \nstreamId | 流id \n \n### 示例\n\n \n \n err := c.OndemandSnap(\"2xenzw5o81ods\", \"31011500991320000356\")\n \n\n \n\n## **删除截图**\n\n \n \n func (manager *Manager) DeleteSnapshots(nsId, streamId string, files []string) error\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnsId | 空间id \nstreamId | 流id \nfiles | 需要删除的文件列表 \n \n### 示例\n\n \n \n err = c.DeleteSnapshots(\"2xenzw5o81ods\", \"31011500991320000356\", []string{\"test.jpg\"})\n \n\n \n\n## **启动按需录制**\n\n \n \n func (manager *Manager) StartRecord(nsId, streamId string) error\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnsId | 空间id \nstreamId | 流id \n \n### 示例\n\n \n \n err = c.StartRecord(\"2xenzw5o81ods\", \"31011500991320000356\")\n \n\n \n\n## **停止按需录制**\n\n \n \n func (manager *Manager) StopRecord(nsId, streamId string) error\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnsId | 空间id \nstreamId | 流id \n \n### 示例\n\n \n \n err = c.StopRecord(\"2xenzw5o81ods\", \"31011500991320000356\")\n \n\n \n\n## **删除录制片段**\n\n \n \n func (manager *Manager) DeleteStreamRecordHistories(nsId, streamId string, files []string) error\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnsId | 空间id \nstreamId | 流id \nfiles | 需要删除的文件列表(从查询录制记录file 字段获取文件名) \n \n### 示例\n\n \n \n err = c.DeleteStreamRecordHistories(\"2xenzw5o81ods\", \"31011500991320000356\", []string{\"record/2xenzw5o81ods/31011500991320000356/1604989846152-1604990735281-852640.m3u8\"})\n \n\n \n\n## **录制视频片段合并**\n\n \n \n func (manager *Manager) RecordClipsSaveas(nsId, streamId string, arg *saveasArgs) (*saveasReply, error)\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnsId | 空间id \nstreamId | 流id \narg | 详见saveasArgs结构体说明 \n \n### saveasArgs结构体说明\n\n成员 | 类型 | 说明 \n---|---|--- \nfname | string | 保存的文件名(需要带上文件格式后缀)，不指定系统会随机生成 \nformat | string | 保存的文件格式，可以为m3u8、mp4、flv \nstart | int | 查询开始时间(unix时间戳，单位为秒) \nend | int | 查询结束时间(unix时间戳，单位为秒) \ndeleteTs | bool | 在不生成m3u8格式文件时是否删除对应的ts文件 \npipeline | string | 数据处理的私有队列，不指定则使用公共队列 \nnotifyUrl | string | 保存成功回调通知地址，不指定则不通知 \ndeleteAfterDays | int | 文件过期时间，默认和录制模版中的设置保持一致 \n \n### saveasReply结构体说明\n\n成员 | 类型 | 说明 \n---|---|--- \nfname | string | 表示保存后在存储空间里的文件名。使用存储空间的下载域名可以访问这文件 \npersistentId | string | 持久化异步处理任务ID，异步模式才会返回该字段，可以通过该字段查询转码进度 \nbucket | string | 文件存储的bucket \nduration | int | 合并后文件的时长(单位为秒) \n \n### 示例\n\n \n \n ret, err := c.RecordClipsSaveas(\"2xenzw5o81ods\", \"31011500991320000356\", &saveasArgs{\n \t\tFormat: \"m3u8\",\n \t\tStart: 1604989846,\n \t\tEnd: 1604990735,\n \t})\n \n\n \n\n## **录制回放**\n\n \n \n func (manager *Manager) RecordsPlayback(nsId, streamId string, start, end int) (string, error)\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnsId | 空间id \nstreamId | 流ID \nstart | 查询开始时间(unix时间戳,单位为秒) \nend | 查询结束时间(unix时间戳,单位为秒） \n \n# **数据统计管理**\n\n## **查询带宽数据**\n\n \n \n func (manager *Manager) QueryBandwidth(nsId, streamId, tu string, start, end int) (*FlowBadwidthData, error)\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnsId | 空间id \nstreamId | 流ID \nstart | 年月日模式(20191001)或者年月日时分秒模式(20201012204005) \nend | 年月日模式(20191002)或者年月日时分秒模式(20201012204005) \ntu | 时间粒度 可以是 5min、hour、day \n \n### 示例\n\n \n \n ret, err = c.QueryBandwidth(\"\", \"\", \"hour\", 20200901, 20200902)\n \n\n \n\n## **查询流量数据**\n\n \n \n func (manager *Manager) QueryFlow(nsId, streamId, tu string, start, end int) (*FlowBadwidthData, error)\n \n\n### 参数说明\n\n参数 | 说明 \n---|--- \nnsId | 空间id \nstreamId | 流ID \nstart | 年月日模式(20191001)或者年月日时分秒模式(20201012204005) \nend | 年月日模式(20191002)或者年月日时分秒模式(20201012204005) \ntu | 时间粒度 可以是 5min、hour、day \n \n### 示例\n\n \n \n ret, err := c.QueryFlow(\"\", \"\", \"5min\", 20200901, 20200902)\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的视频监控播放端SDK"
},
{
"from": "gpt",
"value": "[视频监控](https://developer.qiniu.com/qvs) > SDK 下载 > 播放端SDK\n\n# 播放端SDK\n\n最近更新时间: 2023-12-13 16:01:31\n\n# 产品简介\n\n七牛云播放器 SDK 是一款全自研内核的跨平台 多媒体播放器，该播放器内核由有着18年播放器经验的音视频专家团队研发。目前支持 Android 和 iOS\n平台。七牛云播放器 SDK 具有包体小、首开快、播放流畅、使用简单等明显优势可支持直播、点播 场景下的多种视频格式及流媒体协议。\n\n播放器完全免费，不强制绑定任何其他产品，下载地址如下： \n[Android 播放器 SDK __](https://developer.qiniu.com/pili/sdk/1210/the-android-\nclient-sdk) \nAndroid Github 地址：https://github.com/pili-\nengineering/PLDroidPlayer`除支持h264外，也支持rtmp和http-flv的h265播放`\n\n[iOS 播放器 SDK __](https://developer.qiniu.com/pili/sdk/1211/ios-playback-end-\nthe-sdk) \niOS Github 地址：https://github.com/pili-\nengineering/PLPlayerKit`除支持h264外，也支持rtmp和http-flv的h265播放`\n\n[小程序播放器] \n[推荐小程序原生播放器\n__](https://developers.weixin.qq.com/miniprogram/dev/component/live-\nplayer.html#%E7%A4%BA%E4%BE%8B%E4%BB%A3%E7%A0%81)`仅支持视频编码h264`\n\n[web播放器] \n推荐西瓜播放器 \n[web http播放器\n__](http://v3.h5player.bytedance.com/generate/)适用于http地址`限定hls和flv,支持视频编码h264和h265\n` \n[web https 播放器\n__](https://v3.h5player.bytedance.com/generate/)适用于https地址`限定hls和flv,支持视频编码h264和h265`\n\n**webrtc 快直播低延迟专用播放器SDK：** `仅支持视频编码格式h264` \n以下3种播放器SDK仅仅支持webrtc协议，如果是非webrtc协议请参考上面的SDK \n[低延时 Web SDK __](https://developer.qiniu.com/pili/7730/geek-web-sdk) \n[低延时 Android SDK __](https://developer.qiniu.com/pili/7731/geek-android-sdk) \n[低延时 iOS SDK __](https://developer.qiniu.com/pili/7732/geek-ios-sdk) \n[webrtc接入最佳实践 __](https://developer.qiniu.com/qvs/7812/low-latency-will-\nbroadcast-live-webrtc-access-process)\n\n**七牛QVS控制台播放器展示** \n其中播放器1，是采用hls播放拉流地址，延迟8s左右；播放器2，采用的是webrtc\n低延迟播放拉流地址，延迟在500ms；客户可以根据自身场景选择不同的播放拉流协议。 \n\n\n**注意：各端 Gihub 地址下的 repo 中，有相应的 demo 文件，用户可以体验并参考使用。**\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的视频监控设备本地录像上传云端存储"
},
{
"from": "gpt",
"value": "[视频监控](https://developer.qiniu.com/qvs) > 最佳实践 > 设备本地录像上传云端存储\n\n# 设备本地录像上传云端存储\n\n最近更新时间: 2023-11-08 14:52:13\n\n本文讲述如何将设备本地录像上传到云端进行存储。本地录像上传需要提前在设备上开启开关，并配置独立的录制模板。平台通过国标协议拉取本地录像文件到云端后，并根据设备上设置的录制模板录制存放到云端。\n\n# 前期准备\n\n## **设备注册**\n\n设备已成功注册到七牛云视频监控平台，并且设备本地已存在录像文件。\n\n## **设置录制模板**\n\n1.登录[七牛开发者平台\n__](https://sso.qiniu.com/?client_id=PIapUKqa3u6S24H868BelwrG0OFu8dS7AxVQ8oz8HznLXhgrl2BnjaO9cs9LzxK2&redirect_url=https:%2F%2Fportal.qiniu.com%2Fapi%2Fgaea%2Fsso%2Fsignin%3Fredirect%3D%252Fcreate) \n2.选择**视频监控** 产品，进入产品控制台，选择**设备管理** ，进入设备管理页面，检索对应的设备，点击**查看**\n，进入设备详情页面选择**编辑** ，开启本地录像开关并绑定对应的录制模板。如未创建录制模板请先创建录制模板在进行绑定录制模板操作。[【如何创建录制模板】\n__](https://developer.qiniu.com/qvs/6789/recording-the-template) \n_注：_ \n_1\\. 需要做两件事，1. 空间上绑定按需录制的模版, 2. 设备上绑定实时录制的模版_ \n_2.在空间中绑定的模版，录制方式选项选择`按需录制`_ \n_3.在设备本地录像开关里配置的录制模板中，录制方式选项只能是`实时录制`的模板。_ \n \n\n\n# 本地录像上传\n\n做完以上准备工作后可以开始本地录像上传操作。\n\n## **1.开始本地录像上传**\n\n调用[【本地录像上传云端API】 __](https://developer.qiniu.com/qvs/7765/uploaded-to-the-\ncloud) \n**请求示例**\n\n \n \n curl --request POST \\\n --url http://qvs.qiniuapi.com/v1/namespaces/2akrarvzvyijd/devices/31011500991320000028/sdcardsave/start \\\n --header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \\\n --header 'content-type: application/json'\n --data '{\n \t\"channelId\": \"34020000001310000003\",\n \t\"start\":1612191900,\n \t\"end\":1612191960\n }'\n \n\n**请求参数说明** \n路径参数：\n\n参数名称 | 必填 | 字段类型 | 说明 \n---|---|---|--- \nnamespaceId | 是 | string | 空间ID \ngbId | 是 | string | 设备国标ID \n \nBody：\n\n参数名称 | 必填 | 字段类型 | 说明 \n---|---|---|--- \nchannelId | 否 | string | 平台设备指定需要启动的通道国标ID \nstart | 是 | integer | 开始时间(unix时间戳,单位为秒) \nend | 是 | integer | 结束时间(unix时间戳,单位为秒) \n \n## 注意事项：\n\n## **1.新建两个模板，模板A(按需)和模板B(实时),模板A和模板B设置的bucket保持一致即可;分别在空间上绑定A，在设备上绑定B；\n就可以`只录制本地视频，不录制实时视频`, 如果需要同时录制本地和实时视频, 则把模板A和模板B都设置为“实时录制”**\n\n## **2.上述中的API操作，会触发设备上传本地视频，若收到流状态回调，代表本地视频成功推流；也可以在流管理页面，查询到对应的流状态在线。**\n\n## **3.在`需要提前终止录像上传`时，触发[终止本地录像上传\n__](https://developer.qiniu.com/qvs/7766/stop-uploaded-to-the-\ncloud/)接口即可终止本地录像上传；否则等待视频上传结束即可**\n\n##\n**4.本地录像上传时生成的流id为`31011500991320005819_history_1677744290_1677747005`类似形式，上传成功后只需要去QVS控制台打开id为`31011500991320005819`的流管理页面，然后选择对应日期检索(如上面1677744290_1677747005时间戳对应的日期)即可找到上传成功的录像**\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的视频监控配置域名的CNAME"
},
{
"from": "gpt",
"value": "[视频监控](https://developer.qiniu.com/qvs) > 最佳实践 > 配置域名的CNAME\n\n# 配置域名的CNAME\n\n最近更新时间: 2021-08-30 19:28:52\n\n本文主要讲述使用静态方式接入时，如何配置域名的CNAME。\n\n# CNAME 概述\n\nCNAME 即指别名记录，也被称为规范名字。一般用来把域名解析到别的域名上，当需要将域名指向另一个域名，再由另一个域名提供 ip 地址，就需要添加\nCNAME 记录。\n\n# CNAME 配置\n\n如果需要对域名进行 CNAME 配置，您可以在配置完域名后，通过以下方式为您的域名添加解析。\n\n## 一. 获取CNAME值\n\n在 **七牛开发者平台** 页面选择 [**视频监控**\n__](https://portal.qiniu.com/qvs/overview)，选择[**空间管理**\n__](https://portal.qiniu.com/qvs/namespace)，然后选择对应的空间并进入，选择**域名管理** 模块，如下图所示： \n_注：域名管理只支持静态接入的空间。_ \n\n\n## 二. 添加CNAME记录\n\n添加CNAME记录需要在您的**域名厂商** 处配置，比如您在 阿里云 / 腾讯云 / 新网 等处购买的域名，您需要前往**购买域名的厂商**\n相应管理控制台，添加域名解析。 \n1.打开您购买域名的厂商官网，登陆后在页面右上角找到 **`控制台`** 或 相关管理后台入口。 \n如果您不清楚域名解析的入口，建议查看您域名厂商的产品文档，或者寻求域名厂商的售后支持。 \n2\\. 在域名厂商的控制台中，找到您的域名解析添加页面，例如： \na. 阿里云：在控制台页面的左侧，产品与服务栏中选择 **域名** 。 \nb. 腾讯云：在控制台的云产品中，搜索并选择 **云解析** 。 \nc. DNSPOD：在控制台页面左侧，选择 **域名** 。 \n其他域名厂商请参考产品文档说明或咨询产品售后。 \n3\\. 在域名产品的列表中找到您域名对应的`主域名`，点击域名后面的 **`解析设置`** 或 `解析`，进入解析设置页。 \n4\\. 选择 `添加记录` ，依次填写 **主机记录** ，**记录类型** 以及 **记录值** ，其他可设为默认值。 \n如果您不清楚如何填写主机记录，请参考下文第5步提供的示例。\n\n\n\n参数 | 填写说明 | 注意事项 \n---|---|--- \n主机记录 | 填写域名对应的主机前缀 | 该参数唯一，请勿自定义 \n记录类型 | 选择 CNAME 类型 | 该参数唯一，请勿自定义 \n线路类型 | 保持默认 | 该参数可以根据需求自行调整 \n记录值 | 域名创建后，七牛提供的CNAME | 该参数唯一，请勿自定义 \nTTL | 保持默认 | 该参数可以根据需求自行调整 \n \n \n5.解析示例：\n\n假设您购买的一级域名为 qiniu.com \n您需要先在七牛视频监控控制台创建域名，比如您创建了 cdn.qiniu.com 或 img.qiniu.com 之类的自定义二级域名。 \n创建完成后，在域名厂商后台添加解析记录时，您需要填写主机记录为域名对应的前缀，如 cdn 或 img 即可。\n\n常见的普通域名主机记录填写方式举例：\n\n创建的域名 | 域名类型 | 主机记录 \n---|---|--- \nqiniu.com | 普通域名 | @ \nwww.qiniu.com | 普通域名 | www \ncdn.qiniu.com | 普通域名 | cdn \nvideo.cdn.qiniu.com | 普通域名 | video.cdn \n \n# 如何判断 CNAME 是否正确配置？\n\n * linux/mac系统您可以通过如图所示的命令 `dig 您的域名` 查看，第一条是否解析到您配置的CNAME值。 \n\n\n * windows系统可以通过Win+R 或 点击左下角的“开始”按钮打开“开始”菜单，打开“运行”，输入cmd回车。 \n在命令行模式下输入`nslookup 您的域名`，例如 nslookup qn.vinchi.club,在结果中可以看到您复制的cname值即可。\n\n\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的视频监控利用国标告警大幅减少云存储成本"
},
{
"from": "gpt",
"value": "[视频监控](https://developer.qiniu.com/qvs) > 最佳实践 > 利用国标告警大幅减少云存储成本\n\n# 利用国标告警大幅减少云存储成本\n\n最近更新时间: 2022-07-13 11:50:03\n\n# **前置准备**\n\n * 设备必须通过gb28181接入，并具备告警能力(登录到设备的web配置界面，能看到告警配置，代表有告警能力)\n * 打开设备的告警事件通知(qvs控制台“设备管理”->查看或编辑“设备信息”,以控制告警开关),[控制台告警配置详细步骤 __](https://developer.qiniu.com/qvs/7999/alarm-event-notification)\n * 设置回调地址(控制台“空间管理”->选择某个空间点击“配置”->`基本信息`界面中点击`编辑`，可配置回调地址)。平台会把设备上的告警回调给客户\n * 空间绑定录制模板。(控制台“空间管理”->选择某个空间点击“配置”->“模版配置”)，录制模板`录制方式务必为“按需录制”`\n\n# **使用流程**\n\n * 当客户收到qvs的回调通知时，解析回调[回调数据示例 __](https://developer.qiniu.com/qvs/10240/the-message-callback)\n * 回调数据 “type”: “alarm”，代表是来自设备的告警消息；客户可根据具体的告警类型，[触发云端录制 __](https://developer.qiniu.com/qvs/6743/start-record-stream)，一段时间后(例如录制6s的视频后)或者一段时间内，无新的告警时，[终止云端录制 __](https://developer.qiniu.com/qvs/6744/stop-record-stream)\n * 通过以上功能组合，客户可以只保存告警发生时的视频，例如摄像头有画面移动时触发的`移动侦测，入侵检测等`，而不必7 * 24小时录制，从而消减存储成本\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的视频监控摄像头ONVIF接入流程"
},
{
"from": "gpt",
"value": "[视频监控](https://developer.qiniu.com/qvs) > 最佳实践 > 摄像头ONVIF接入流程\n\n# 摄像头ONVIF接入流程\n\n最近更新时间: 2022-12-13 10:49:56\n\n**本文简述了使用ONVIF协议接入时配置流程** 。\n\n# 1\\. 添加ONVIF用户名和密码\n\n## **大华设备添加ONVIF用户名和密码示例**\n\n（1） 登录摄像头web页面 \n（2） 依次点击\"系统管理\"→\"用户管理\"→\"ONVIF用户\" \n（3）点击\"增加用户\" \n \n（4） 输入用户名和密码 \n\n\n# 2\\. 七牛控制台创建ONVIF空间\n\n创建空间时接入类型选择`ONVIF` \n\n\n# 3\\. 创建ONVIF设备\n\n在第2步创建好的`ONVIF`空间，创建一个设备\n\n（1）设备ip地址，填入设备的`公网IP`（内网设备可以使用内映射工具，比如花生壳）。 \n（2）填入设备ONVIF的端口，一般是80。如果设备没有公网ip，也可以将80端口映射到公网的某个端口，比如`8080`,则这里需要填入映射后的端口`8080`。 \n（3）填入流端口号，如果设备有`公网IP`，一般这个端口默认是`554`；如果设备没有公网IP，需要将该设备的`554`端口映射到公网的某个端口，例如映射到`8554`端口，则这里的流端口号填入`8554`。 \n（4）填入第1步在摄像头添加的ONVIF用户名和密码。 \n\n\n# 4\\. 实时预览\n\n（1） 在设备列表页面，选择添加好的设备，点`实时预览`，进入到实时预览页面。 \n \n（2）点`启动拉流`，观看摄像头的实时流。 \n\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的视频监控任意时间段的本地录像回放"
},
{
"from": "gpt",
"value": "[视频监控](https://developer.qiniu.com/qvs) > 最佳实践 > 任意时间段的本地录像回放\n\n# 任意时间段的本地录像回放\n\n最近更新时间: 2022-12-13 10:50:23\n\n 1. 拼接流ID。 \n对于本地录像回放，如果希望播放任意时间段内的录像，需要手动构造流ID。当设备类型为摄像头时，流ID格式为设备国标ID_history_开始时间戳_结束时间戳；当设备类型为平台时，流ID格式为设备国标ID_通道ID_history_开始时间戳_结束时间戳。 \n**示例** ： \n假设目前有一个NVR国标ID为`31011500991320020874`，通道ID为`34020000001310000001`，希望观看`2022-12-22\n00:00:00`到`2022-12-22 23:59:59`时间段内的录像。 \n开始时间`2022-12-22 00:00:00`转换的`uninx时间戳`为`1671638400`。 \n结束时间`2022-12-22 23:59:59`转换的`unix时间戳`为`167172479` \n则流ID为:\n`31011500991320020874_34020000001310000001_history_1671638400_1671724799`。\n\n 2. 获取播放地址。\n\n * 如果空间已经配置了域名，则请求[静态模式获取流地址 __](https://developer.qiniu.com/qvs/6800/static-model)接口获取流地址。\n * 如果空间没有配置域名， 则请求[动态模式获取流地址 __](https://developer.qiniu.com/qvs/6801/dynamic-model)接口获取流地址。\n\n请求示例\n\n \n \n curl --request POST \\\n --url http://qvs.qiniuapi.com/v1/namespaces/d102sni9zryu/streams/31011500991320020874_34020000001310000001_history_1671638400_1671724799/urls \\\n --header 'authorization: QiniuStub j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \\\n --header 'content-type: application/json' \\\n --data '{\n \"publishIp\":\"116.236.177.50\",\n \"playIp\":\"116.236.177.50\"\n }'\n \n\n响应示例\n\n \n \n {\n \"playUrls\": {\n \"rtmp\":\"rtmp://180.101.136.82:2045/qiniu/31011500991180013390_34020000001310000006_history_1670799600_1670835600?e=1670851888\\u0026token=52fdfc072182654d%3A1uPRRnu6M6aWZ_IVVHahdCjgFDk\",\n \"flv\":\"http://180.101.136.82:1360/qiniu/31011500991180013390_34020000001310000006_history_1670799600_1670835600.flv?e=1670851888\\u0026token=52fdfc072182654d%3AQAghBKuIO35EJVlT0uYI9iEr_Ms\",\t\t \n \"hls\":\"http://180.101.136.82:1370/qiniu/31011500991180013390_34020000001310000006_history_1670799600_1670835600.m3u8?e=1670851888\\u0026token=52fdfc072182654d%3A7ZmDc6X5bsZIuig7cRA6-HXInJU\", \n \"webrtc\":\"webrtc://180.101.136.82:1240/qiniu/31011500991180013390_34020000001310000006_history_1670799600_1670835600?e=1670851888\\u0026token=52fdfc072182654d%3AYPD6HRoJFayO1iCMUiMlOrXsueg\"\n },\n \"onlineState\":false,\n \"disabled\":false,\n \"publishUrlExpired\":1670851888\n }\n \n\n 3. 在播放器中播放播放获取到的流地址。\n\n \n \n fflay http://180.101.136.82:1370/qiniu/31011500991180013390_34020000001310000006_history_1670799600_1670835600.m3u8?e=1670851888\\u0026token=52fdfc072182654d%3A7ZmDc6X5bsZIuig7cRA6-HXInJU\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的视频监控报警联动(收到报警触发录制截图)"
},
{
"from": "gpt",
"value": "[视频监控](https://developer.qiniu.com/qvs) > 最佳实践 > 报警联动(收到报警触发录制截图)\n\n# 报警联动(收到报警触发录制截图)\n\n最近更新时间: 2023-08-02 11:23:57\n\n# **使用流程**\n\n 1. 设备必须通过gb28181接入，并具备告警能力(登录到设备的web配置界面，能看到告警配置，代表有告警能力)\n 2. 如果是`海康`的设备，需要先请求[布防撤防 __](https://developer.qiniu.io/qvs/12416/their-removal)API，命令为`SetGuard`，才会开启设备报警。\n 3. 打开设备的告警事件通知(qvs控制台“设备管理”->查看或编辑“设备信息”,以控制告警开关),[控制台告警配置详细步骤 __](https://developer.qiniu.com/qvs/7999/alarm-event-notification)。其中`视频报警`必须开启。通过API配置设备的`alarmTypesForRecord`、`alarmTypesForSnap `参数，配置感兴趣的报警类型。如果配置了`alarmTypesForRecord`，还需要配置`recordTime `参数配置收到报警后录像的时长。详细参考[创建设备 __](https://developer.qiniu.com/qvs/6896/create-device)和[更新设备 __](https://developer.qiniu.com/qvs/6899/update-the-device)。\n 4. 创建`按需`录制或者截图模板。关于录制模板的使用方法参考[录制模板 __](https://developer.qiniu.com/qvs/6789/recording-the-template)。关于截图模板的使用方法参考[截图模板 __](https://developer.qiniu.com/qvs/6790/screenshot-of-the-template)。\n 5. 设备对应的流绑定`按需`录制或者截图模板。关于设备的国标ID和流ID的对应关系参考[使用流接口必读 __](https://developer.qiniu.com/qvs/11878/use-the-stream-interface-is-required)。\n 6. 当设备收到配置的报警列表中的某一个报警时，会触发录制或者截图。\n 7. 录制或者截图结束之后，可以在视频流管理的[云端录制回放 __](https://developer.qiniu.io/qvs/6785/video-streaming-management#3)和[视频截图 __](https://developer.qiniu.io/qvs/6785/video-streaming-management#4)页面查看云端录像或者截图。\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的视频监控RTMP接入流程"
},
{
"from": "gpt",
"value": "[视频监控](https://developer.qiniu.com/qvs) > 最佳实践 > RTMP接入流程\n\n# RTMP接入流程\n\n最近更新时间: 2022-08-25 10:12:38\n\n本文主要简述使用摄像头或OBS进行RTMP接入测试的配置说明。\n\n# **摄像头推流**\n\n## **操作步骤：**\n\n1.首先需要在七牛云视频监控产品portal上查询已经添加好的对应的配置信息，获取对应的推流地址，如尚未创建请参考[快速入门\n__](https://developer.qiniu.io/qvs/manual/6763/qvs-quick-start)进行配置。 \n2.登录到摄像头的配置页面，找到RTMP配置页面。 \n3.请确保视频编码格式为h264，音频编码格式为aac。 \n4.平台`支持`h265接入和转发,但浏览器大都无法直接播放h265, 因此客户要自行集成[浏览器h265插件\n__](https://github.com/numberwolf/h265web.js),`非浏览器`的h265播放，可以参考我们的[播放器sdk\n__](https://developer.qiniu.com/qvs/7924/play-the-sdk) \n5.将获取到的推流地址分别填入。 \n（1）无鉴权 \n \n（2）有鉴权 \n \n5.配置完成后选择启用，点击保存即可。 \n**注：** \n如需使用推流SDK，可以下载直播云中提供的推流SDK。 \n[Android 推流 SDK\n__](https://developer.qiniu.com/pili/3715/PLDroidMediaStreaming-overview) \n[IOS 推流 SDK __](https://developer.qiniu.com/pili/3778/PLMediaStreamingKit-\noverview)\n\n# **OBS推流**\n\n## **操作步骤：**\n\n1.打开 OBS 推流软件，点击设置进入配置页面，选择流这项进行流配置。 \n \n2.将获取到的推流地址分别填入 URL 和 流密钥。 \n（1）无鉴权 \n \n（2）有鉴权 \n \n3.配置完成后，点击开始推流，进行推流。 \n \n4\\. obs推流可选优化项，obs推流延迟较大，可以通过以下参数设置，降低端到端的播放延迟。 \n \n5\\. 播放器低延迟设置。\n\n * ffmpeg自带的ffplay播放器，命令行参数ffplay ‘播放地址’ -fflags nobuffer\n * vlc播放器，Preference=>Input/Codecs=>Default Caching Level下拉菜单选择\"Lowest Latency\"\n * 其他播放器，可以自行参考文档，在播放器的设置选项里，选择对应的低延迟参数\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的视频监控摄像头国标接入流程"
},
{
"from": "gpt",
"value": "[视频监控](https://developer.qiniu.com/qvs) > 最佳实践 > 摄像头国标接入流程\n\n# 摄像头国标接入流程\n\n最近更新时间: 2022-08-25 10:12:31\n\n**本文简述了使用国标协议接入时配置流程，以及接入流程演示视频** 。\n\n# **国标接入配置示范**\n\n## **操作步骤：**\n\n1.首先需要在七牛云视频监控产品portal上查询已经添加好的对应的配置信息，如尚未创建请参考[快速入门\n__](https://developer.qiniu.com/qvs/6763/qvs-quick-start)。 \n2.登录到摄像头的配置页面，找到国标接入配置页面。 \n3.将对应信息配置到设备端配置、启用国标保存后，该设备将进行注册接入。 \n4.请确保视频编码格式为h264,码流控制/码率类型选择“可变码率”;音频编码格式为g711-alaw或者aac, 采样率 8000 。 \n5.平台`支持`h265接入和转发,但浏览器大都无法直接播放h265, 因此客户要自行集成[浏览器h265插件\n__](https://github.com/numberwolf/h265web.js),`非浏览器`的h265播放，可以参考我们的[播放器sdk\n__](https://developer.qiniu.com/qvs/7924/play-the-sdk) \n \n\n## **海康设备国标接入配置示范**\n\n \n_配置参数说明：_\n\n参数 | 说明 \n---|--- \n平台接入方式 | 选择28181 \n本地SIP端口 | 由于设备默认的本地Sip端口号5060,可能会被局域网屏蔽，建议修改为5061、5062等其他端口号 \n传输协议 | 选择UDP \n协议版本 | 选择“GB/T28181-2011 或 GB/T28181-2016” \nSIP服务器ID | 填入视频监控平台（QVS）提供的SIP服务器ID \nSIP服务器域 | SIP服务器ID的前10位 \nSIP服务地址 | 填入视频监控平台（QVS）提供的SIP服务器IP \nSIP服务器端口 | 填入视频监控平台（QVS）提供的SIP服务器端口号 \nSIP用户名 | 填入视频监控平台（QVS）中创建对应的设备时输入的用户名 \nSIP用户认证ID | 填入视频监控平台（QVS）中创建对应的设备时输入或自动生成的设备国标ID，网络摄像头的国标ID，11-13位为132 \n密码 | 填入视频监控平台（QVS）中创建对应的设备时输入的密码 \n视频通道编码ID | 填入视频监控平台（QVS）中创建对应的设备时输入的设备国标ID \n \n \n\n## **大华设备国标接入配置示范**\n\n \n_配置参数说明：_\n\n参数 | 说明 \n---|--- \nSIP服务器编号 | 填入视频监控平台（QVS）提供的SIP服务器ID \nSIP域 | SIP服务器ID的前10位 \nSIP服务IP | 填入视频监控平台（QVS）提供的SIP服务器IP \nSIP服务器端口 | 填入视频监控平台（QVS）提供的SIP服务器端口号 \n设备编号 | 填入视频监控平台（QVS）中创建对应的设备时输入或自动生成的设备国标ID，网络摄像头的国标ID，11-13位为132 \n密码 | 填入视频监控平台（QVS）中创建对应的设备时输入的密码 \n本地SIP端口 | 由于设备默认的本地Sip端口号5060,可能会被局域网屏蔽，建议修改为5061、5062等其他端口号 \n通道编号 | 填入视频监控平台（QVS）中创建对应的设备时输入的设备国标ID \n \n \n\n## **视频卡顿或拉流失败时，建议的参数配置**\n\n当同一个网络内接入的设备过多时或者摄像头所处的网络环境波动较大时，会由于网络带宽的限制导致视频卡顿，以海康设备为例，建议的参数配置 \n \n \n\n\n# **接入流程演示**\n\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的视频监控NVR设备国标接入流程"
},
{
"from": "gpt",
"value": "[视频监控](https://developer.qiniu.com/qvs) > 最佳实践 > NVR设备国标接入流程\n\n# NVR设备国标接入流程\n\n最近更新时间: 2022-08-25 10:12:44\n\n**本文简述了使用国标协议接入NVR设备的配置流程，以及接入流程演示视频** 。 \nNVR（网络视频存储）设备接入QVS过程与摄像头接入流程基本类似，都先要在QVS平台下已经创建好的国标类型的空间下先添加设备，此时设备类型需要选择为**平台**\n。然后在设备端进行国标注册操作，注册成功后，在QVS控制台中可以查看接入的NVR设备状态。\n\n# **NVR设备接入配置示范**\n\n## **操作步骤：**\n\n1.首先需要在七牛云视频监控产品portal上查询已经添加好的对应的配置信息，如尚未创建请参考[快速入门\n__](https://developer.qiniu.io/qvs/manual/6763/qvs-quick-start)。 \n2.登录到NVR设备的配置页面中，找到国标接入配置页面。 \n3.将对应信息配置到NVR设备上、启用国标保存后，该设备将进行注册接入。 \n4.请确保nvr各个通道下,视频编码格式为h264,码流控制/码率类型选择“可变码率”;音频编码格式为g711-alaw或者aac, 采样率 8000。 \n5.平台`支持`h265接入和转发,但浏览器大都无法直接播放h265, 因此客户要自行集成[浏览器h265插件\n__](https://github.com/numberwolf/h265web.js),`非浏览器`的h265播放，可以参考我们的[播放器sdk\n__](https://developer.qiniu.com/qvs/7924/play-the-sdk)\n\n## **海康设备国标接入配置示范**\n\n \n_配置参数说明：_\n\n参数 | 说明 \n---|--- \n平台接入方式 | 选择28181 \n本地SIP端口 | 由于设备默认的本地Sip端口号5060,可能会被局域网屏蔽，建议修改为5061、5062等其他端口号 \nSIP服务器ID | 填入视频监控平台（QVS）提供的SIP服务器ID \nSIP服务器域 | SIP服务器ID的前10位 \nSIP服务地址 | 填入视频监控平台（QVS）提供的SIP服务器IP \nSIP服务器端口 | 填入视频监控平台（QVS）提供的SIP服务器端口号 \nSIP用户认证ID | 填入视频监控平台（QVS）中创建对应的设备时输入或自动生成的设备国标ID，NVR设备的国标ID，11-13位为118 \n密码 | 填入视频监控平台（QVS）中创建对应的设备时输入的密码 \n \n**海康NVR设备需要为该设备下，接入的摄像头对应通道分配视频通道编码ID（摄像头设备的国标ID）** \nNVR设备下的视频通道编码，可自行分配，不重复即可，11-13位可填132；可参照下面的示例进行配置，示例如下： \nD1:31011500991320000001 \nD2:31011500991320000002 \nD3:31011500991320000003 \n…按顺序排列填写即可（NVR接入了多少个摄像头填写多少个通道即可） \n\n\n## **大华设备国标接入配置示范**\n\n \n_配置参数说明：_\n\n参数 | 说明 \n---|--- \nSIP服务器编号 | 填入视频监控平台（QVS）提供的SIP服务器ID \nSIP域 | SIP服务器ID的前10位 \nSIP服务IP | 填入视频监控平台（QVS）提供的SIP服务器IP \nSIP服务器端口 | 填入视频监控平台（QVS）提供的SIP服务器端口号 \n设备编号 | 填入视频监控平台（QVS）中创建对应的设备时输入或自动生成的设备国标ID，NVR设备的国标ID，11-13位为118 \n密码 | 填入视频监控平台（QVS）中创建对应的设备时输入的密码 \n本地SIP端口 | 由于设备默认的本地SIP端口号5060,可能会被局域网屏蔽，建议修改为5061、5062等其他端口号 \n \n## **视频卡顿/拉流失败时，建议的参数配置**\n\n当同一个网络内接入的设备过多时或者摄像头所处的网络环境波动较大时，会由于网络带宽的限制导致视频卡顿或者拉流失败，以海康nvr(录像机)为例，建议的参数配置 \n \n \n\n\n# **接入流程演示**\n\n以下演示的是海康NVR接入\n\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的视频监控按需拉流使用介绍"
},
{
"from": "gpt",
"value": "[视频监控](https://developer.qiniu.com/qvs) > 最佳实践 > 按需拉流使用介绍\n\n# 按需拉流使用介绍\n\n最近更新时间: 2022-12-13 11:58:04\n\n**本文简述了按需拉流的使用方式** 。 \n适用的空间类型为`gb28181`或者`主动拉流`或者`ONVIF`三种。\n\n# **功能介绍**\n\n视频的播放都是需要消耗带宽及流量的，为了节省用户流量和带宽，QVS平台支持“按需拉流”。当开启按需拉流后，只有在进行播放的情况下才会有视频流的产生，播放结束后,\nQVS会自动停止设备推流。\n\n## 按需拉流的2层含义\n\n * 有播放请求时自动推流。\n * 无人观看时自动断流。\n * 同时也可以调用API触发推流，[启动设备推流 __](https://developer.qiniu.com/qvs/6907/start-device)等同于点击该按钮。 \n \n调用API终止上行推流，[终止设备推流 __](https://developer.qiniu.com/qvs/6908/stop-\ndevice)等同于点击该按钮 \n\n\n# **使用流程**\n\n## **1.如何开启按需拉流**\n\n**未创建空间** \n（1）在七牛云视频监控产品portal上空间管理中点击【创建空间】。 \n（2）输入空间配置必填项后，开启按需拉流开关即可。 \n \n**已创建空间** \n（1）在七牛云视频监控产品portal上查询已经创建的业务空间。 \n（2）打开对应业务空间的配置并进行编辑操作。 \n（3）开启按需拉流开关。 \n\n\n## **2.开启按需拉流后如何触发摄像头推流**\n\n（1）portal上实时预览页面中点击“启动拉流” 操作。 \n（2）通过[启动设备拉流 __](https://developer.qiniu.com/qvs/6907/start-device)api。 \n（3）播放器进行播放请求。 \n以上3种都会触发摄像头推流，并且在无人观看持续60s左右，会自动终止摄像头推流。\n\n# **额外提示**\n\n 1. 按需拉流, 适用的空间类型为`gb28181`或者`主动拉流`或者`ONVIF`三种; 如果是rtmp类型, 则需要客户先提交工单, 等后台开启后,可体验该功能。\n 2. 按需拉流和按需录制是无关的，两者之间没有关联。\n 3. 普通模板和按需模板区别:如果绑定了普通的录制/截图模板,设备只要开始推流, qvs就会自动开始录制/截图。 如果绑定了“按需”类型的模板，则需要通过api触发录制的[开始 __](https://developer.qiniu.com/qvs/6743/start-record-stream)或者[结束 __](https://developer.qiniu.com/qvs/6744/stop-record-stream)。\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的视频监控低延时实时直播-webrtc接入流程"
},
{
"from": "gpt",
"value": "[视频监控](https://developer.qiniu.com/qvs) > 最佳实践 > 低延时实时直播-webrtc接入流程\n\n# 低延时实时直播-webrtc接入流程\n\n最近更新时间: 2022-09-15 18:11:06\n\n# webrtc拉流协议介绍\n\n七牛云视频监控产品(qvs)在现有的3种播放协议(hls, http-flv,\nrtmp)基础上，拓展了第4种播放协议webrtc。该协议实时延迟可达到500毫秒左右，可以满足客户对低延迟场景的需求\n\n# webrtc拉流播放实现架构\n\n\n\n# 核心优势\n\n * 95%情况下, 实时监控延迟在300-500毫秒区间内\n\n# 快速体验\n\n * `http`环境: [http环境webrtc播放器测试](http://pili-player-demo.qiniu.com)\n\n * `https`环境:`当切仅当`为域名[配置ssl证书 __](https://developer.qiniu.com/qvs/6925/qvs-https-configuration)后,方能体验[https环境webrtc播放器测试](https://pili-player-demo.qiniu.com)\n\n * webrtc地址如何获取\n\n * 方式1 通过qvs控制台，点击实时预览页面，会返回webrtc播放地址。\n * 方式2 [ 通过API获取webrtc播放地址 ](https://developer.qiniu.com/qvs/6740/obtain-flow-address)\n * 最终的地址形式 \n * 1> 如果是动态接入的空间\n * http环境：webrtc://ip:1240/空间id/流id \nhttps环境：无法使用ip的形式进行播放 。\n\n * 2>如果是静态接入的空间 \nhttp环境：webrtc://域名:1240/空间id/流id \nhttps环境：webrtc://域名:447/空间id/流id, 前提要[配置https ssl证书\n__](https://developer.qiniu.com/qvs/6925/qvs-https-configuration)\n\n# 前提限制\n\n * 需要使用七牛的播放器进行webrtc拉流播放\n * rtmp推流时, 不能含有B帧(webrtc播放不支持B帧)，具体情况请参考以下tips \n * 1. 使用ffmpeg进行rtmp推流时,务必要携带 -bf 0参数, 例如ffmpeg -re -i xxx.mp4 -c copy -c:v libx264 `-bf 0` -f flv ‘rtmp推流地址’\n * 2. 使用obs推流时, 如下图所示 \n\n\n * 3. 小程序rtmp推流不包含B帧，可以跳过该条\n * 4. 使用七牛安卓/ios推流sdk，可以通过函数设置BaseProfile, 也可以去除B帧\n * 5. 其他第三方rtmp推流工具/sdk， 可以自行查看文档\n * 6. 安防行业的摄像头(ipc)或者录像机(nvr)，自带的rtmp推流，默认都不包含B帧，可以跳过该条\n * 采用gb28181接入的摄像头(ipc)或者录像机(nvr)注意的情况 \n * 1.建议在摄像头的视频参数配置界面。1>设置可变码率 2> I帧间隔 = 帧率 * 2，3>如果需要开启音频， 设置为 g711-alaw, 采样率8K \n\n\n# 正式接入流程\n\n体验了以上流程之后，正式接入步骤参考如下\n\n * 七牛webrtc快直播-低延时播放器SDK 下载\n\n * Android SDK 下载：[QNRTPlayer-Android __](https://github.com/pili-engineering/QNRTPlayer-Android)、\n * [<低延迟Android SDK使用说明>__](https://developer.qiniu.com/pili/7731/geek-android-sdk)\n * iOS SDK 下载：[QNRTPlayer-iOS __](https://github.com/pili-engineering/QNRTPlayer-iOS)\n * [<低延迟iOS SDK使用说明>__](https://developer.qiniu.com/pili/7732/geek-ios-sdk)\n * Web SDK 下载：[QNRTPlayer-Web __](https://github.com/pili-engineering/QNRTPlayer-Web)\n * [<低延时 Web SDK使用说明>__](https://developer.qiniu.io/pili/7730/geek-web-sdk)低延迟web sdk需要浏览器支持 RTC 和 H264 解码，目前部分 Android 手机自带浏览器并未支持 RTC。在这种情况下，我们建议更换浏览器或直接使用移动端的 SDK, ios端:[<低延时 iOS SDK>__](https://developer.qiniu.com/pili/7732/geek-ios-sdk);安卓端:[<低延时 Android SDK>__](https://developer.qiniu.com/pili/7731/geek-android-sdk).\n * Demo 体验 \nAndroid Demo: <http://fir.qnsdk.com/dun3>[__](http://fir.qnsdk.com/dun3) \n \niOS Demo: <http://fir.qnsdk.com/reb4>[__](http://fir.qnsdk.com/reb4) \n\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的视频监控国标接入问题排查"
},
{
"from": "gpt",
"value": "[视频监控](https://developer.qiniu.com/qvs) > 故障排查 > 国标接入问题排查\n\n# 国标接入问题排查\n\n最近更新时间: 2023-02-22 14:35:44\n\n# 设备注册失败/离线, 通道数量为0等问题\n\n 1. 本条建议`很很很很很`关键,设备网络设置成`自动获取IP`。以海康为例,登入设备的配置界面, 在`网络->基本设置->Tcp/Ip->勾选自动获取`。\n 2. `路由器`问题，某社区1500个摄像头，每天固定时间集体离线后并无法恢复；排查后是路由器定时重启造成的, 路由器重启后, 设备的gb28181 udp数据报被路由器莫名丢弃了，无法与外部通信；解决办法，1. `关闭`路由器定时重启 2. 重启摄像头或者NVR。\n 3. 设备网络如果是定向流量卡, 发出的网络数据都被运营商屏蔽,需要联系运营商添加IP白名单。\n 4. 检查摄像头/NVR所处的网络，是否能够连通SIP服务器的IP跟端口。\n 5. 检查摄像头/NVR的置国标配置页面，查看SIP服务器ID、SIP服务器IP和端口是否正确，是否为七牛云QVS提供的SIP服务器ID、IP和端口。\n 6. 是否配置了SIP域，如果配置了请确保SIP域为SIP服务器ID的前10位数字。\n 7. 检查是否正确配置,七牛云QVS设备管理中的设备国标ID。`宇视设备在“国标本地设置”选项卡中，SIP服务器编码是设备国标ID，而非SIP服务器ID。`\n 8. 设备的名称或者通道编号，含有特殊字符，`空格`等，会导致无法解析，而导致异常。\n 9. `视频通道ID`是空的，或者配置错误,NVR请参考[NVR接入最佳实践 __](https://developer.qiniu.io/qvs/7451/nvr-gb-access-process), 普通摄像头请参考[摄像头接入最佳实践 __](https://developer.qiniu.com/qvs/7448/gb-access-process)。\n 10. 个别摄像头或者NVR,设备固件存在bug, Catalog信令返回数量为0或没有应答Catalog, 如果确认配置正确的情况下,请反馈给设备厂商,升级国标固件。\n 11. 假如以上无果，`重启设备`，观察能否成功在线。\n\n# 为什么设备是在线的，流是离线的？\n\n * **先来了解，什么是设备状态，什么是流状态** \n \n \n\n * 如上图所述，当设备和“qvs信令服务”之间通过信令通道，存在周期性的保活心跳，设备就处于在线状态。 \n\n * 信令通道传递的是文本字符，流量很小，qvs不收取流量费用。 \n\n * 只有流媒体通道打开时，既设备开始推流时，才会产生上行的推流费用。 \n\n * 设备状态和流状态是独立的2种状态。设备在线时，流离线有以下几种可能。 \n1.开启了按需拉流 \n开启了按需拉流后，当视频流无人观看持续60s左右，会自动终止推流，此时流就显示离线。 \n开启按需拉流时，启动流的三种方式： \n（1）portal上，“设备管理”界面下，实时预览中点击“启动拉流” 操作。 \n（2）通过[api触发 __](https://developer.qiniu.com/qvs/6907/start-device)摄像头推流。 \n（3）播放器触发播放请求。 \n（4）如果想保持视频流永远在线，可以关闭“按需拉流”。 操作如下,控制台界面中，“空间管理”-> 点击“配置”-> 空间信息，点击\"编辑\"->\n置灰\"按需拉流\"->点击 “确定”。则在此操作之后，视频流在下次重新推流时生效。\n\n 2. 如果以上都是正常的，依然无法拉流播放，请参考下面的片段视频流卡顿，黑屏，无法观看等问题定位。\n\n# 视频流卡顿，画面异常，中断，首开慢等问题定位\n\n如果是通过摄像头接入qvs的情况下，登录到摄像头的视音频参数配置界面；如果是通过NVR接入，或者摄像头被挂载到一个NVR下面时，则需要登录至NVR中修改相应参数。\n\n 1. 由于暂不支持H.265视频在web中预览，设备接入后,可在视频参数配置页面，修改成H.264。\n 2. 视频分辨率和帧率根据自身需求选择，若在同一网络下接入设备较多的情况下，可选择低分辨率，从1080p降低为720p，甚至更低的分辨率。\n 3. `最最重要的选项，码流控制/码率类型，选择 “可变码率”，等同于英文简写VBR。`\n 4. 在视频配置界面里，帧率设置有些设备默认是全帧率，帧率需调整为15，I帧间隔 = “视频帧率” * 2，即30。\n 5. 码流上限，分辨率720P时选择1024；分辨率为1080p时选择2048；也可以根据实际视频效果在调整。\n 6. 如果不需要在web浏览器中预览，也可以选择h265，此时需要使用[七牛的播放器SDK __](https://developer.qiniu.com/qvs/7924/play-the-sdk)或者自行去第三方播放器(例如vlc，ffplay等)进行实时播放。综上视频异常建配置如下图： \n分辨率720p的建议配置 \n \n分辨率1080p的建议配置 \n \n \n\n 7. 有些设备对gb28181存在兼容性问题.最典型的是设备通过gb28181推流时, 实际携带的ssrc(视频流的身份证)，与平台告诉设备的ssrc不一致，此时平台会拦截非法的视频流，导致无法观看。解决办法，尝试升级固件，如果还是解决不了，可提交工单，等待七牛进一步确认，如果确认是设备bug，我们会提供设备bug证据，客户可携带证据联系硬件设备厂商，修复设备上的bug。\n 8. 确认设备所在网络是否有防火墙，防火墙是否开启了入口的限制。\n 9. 有的设备只支持`tcp`或者`udp`拉流，在设备的`基本信息`页面，切换流传输模式，如果当前为`tcp`,则切换为`udp`;如果当前为`udp`, 则切换为`tcp`。一般可拉流成功。\n 10. 如果以上都尝试过，仍无法解决，请提[工单 __](https://support.qiniu.com/tickets/new/?space=%E8%A7%86%E9%A2%91%E7%9B%91%E6%8E%A7)或者在技术支持群里提问。\n\n# 预览界面声音异常或无声\n\n 1. 首先确保设备有音频输入。 \n**说明：** \n1.通过国标gb28181传输的音频，音频编码优先配置`g711alaw`, 采样率优先选择`8000`, 没有g711alaw的情况下, 选择aac +\n8000采样率。 \n\n\n 2. gb28181接入的设备，在存在音频输入的条件下，标准规范是：视频和音频 （h264 + g711或者aac）要封装到ps包里发出(主流的海康，大华，宇视等都是这种标准音频打包方式。个别硬件厂商，会单独把音频包通过RTP包发出，这种格式不符合gb28181规范)，如果不是这种方式，则无法播放音频，如果不确定，可以跟摄像头供应商确认。\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的视频监控QVS Q&A"
},
{
"from": "gpt",
"value": "[视频监控](https://developer.qiniu.com/qvs) > 故障排查 > QVS Q&A\n\n# QVS Q&A\n\n最近更新时间: 2022-09-19 14:50:47\n\n# 空间为何看不到域名配置\n\n一.创建空间时，模式选择了`动态地址`，所以看不到域名配置；怎么才能看到`域名配置`界面? 1.新建空间，模式选择“静态地址” 2. 不想新建空间?\n请提工单，后台为您转换。 \n二. 空间转换为`静态地址`后，需要客户做 \n1> 在域名管理界面新增域名，并[配置cname __](https://developer.qiniu.com/qvs/8746/configure-\ncname) \n2 > 可选项，如果需要https的环境播放实时视频流，则需要进一步为域名[配置https证书\n__](https://developer.qiniu.com/qvs/6925/qvs-https-configuration)\n\n# 为什么配置了录制模板，却无法回看历史视频\n\n一.\n用户可在qvs的控制台，视频流管理板块，找到对应的视频流，当点击“云端录制回放时”，qvs会从存储空间(buceket)里读取文件；读取文件依赖有效的回放域名，此域名需要客户自行在七牛对象存储系统里配置(此域名与qvs自身的直播域名是独立的)。(存储空间会赠送有效期1个月的默认域名，1个月后该域名会被回收，客户需要提供自己的有效域名)[添加录制回看的CDN域名\n__](https://portal.qiniu.com/cdn/domain/create)。 \n\n\n# 推流或者播放地址如何提高安全性\n\n * 建议打开时间戳防盗链，打开方法如下\n * 如果空间类型是`动态地址`类型（IP形式的播放地址）, 点击 “空间管理”-> 选择某个空间, 点击\"配置\" ->在空间信息里，点击\"编辑\"->设置\"URL 鉴权\"即可。\n * 如果如果空间类型是静态地址类型（域名形式的播放地址）。在域名管理里设置。点击 “空间管理”-> 选择某个空间, 点击\"配置\"->选择\"域名管理\"->找到想开启时间戳防盗链的域名,点击’配置’。 \n\n\n# 调试web播放时，浏览器为何出现跨域错误\n\n一. 因为使用姿势错误，在http的环境里，使用了https的播放地址; 或者在https的环境中使用了http的播放地址。 \n二. 解决办法，先阅读入门文档，了解一下[基本概念 __](https://developer.qiniu.com/qvs/6763/qvs-quick-\nstart#2) \n三. 静态接入的情况下，在域名管理里，开启`https`开关后，刷新实时预览，看到的地址就是https环境专用地址；反之看到的就是http环境专用地址\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的云短信产品简介"
},
{
"from": "gpt",
"value": "[云短信](https://developer.qiniu.com/sms) > 使用文档 > 产品简介\n\n# 产品简介\n\n最近更新时间: 2020-06-17 14:59:03\n\n云短信服务SMS（Short Message Service，SMS）是七牛云为用户提供的一种通信服务，支持向国内快速发送验证码、短信通知和营销推广短信。\n\n七牛云短信服务国内短信支持三网合一专属通道，移动、联通、电信网全覆盖，充分满足跨网发送的需求，实时监控自动切换，到达率高达99%。 \n \n\n# **产品功能**\n\n云短信服务当前支持的功能如下表所示：\n\n功能 | 介绍 \n---|--- \n验证码短信 | 支持发送验证码类短信，满足用户登入、信息变更、用户注册、身份验证、找回密码、异常登入等常见的业务场景。 \n通知类短信 | 支持发送提醒类通知短信，如物流快递、旅游航空、餐饮、电子商务、招聘信息、售后服务状态更新等场景。 \n营销推广类短信 | 可发送营销推广类短信，支持高并发批量发送，可以满足会员生日、客户关怀、节日祝福、线上线下打折促销、业务推广、新品上线、客户维系等场景。 \n语音短信 | 提供语音短信功能, 是文本短信的强力补充。 \n智能调度 | 七牛短信服务平台融合多家专属运营商，多通道智能调度，轻松应对业务高峰。 \nAPI 接入 | 提供详尽短信接入文档，支持 GO, Ruby, Python, Java 等语言的 SDK 和 API 接入。 \n数据统计 | 丰富的数据统计，包含但不限于请求量、发送成功量、失败量等统计数据。 \n批量发送 | 通过控制台即可批量发送短信，无需研发投入。 \n \n \n\n# **产品优势**\n\n特性 | 介绍 \n---|--- \n三网合一 \n全球覆盖 | \n* 国内移动、联通、电信网全覆盖，充分满足跨网发送的需求。 \n快速稳定 | \n* 国内短信三网合一专属通道，快速直达，链接用户仅需 3-5 秒到达。\n* 专线机房，支持大容量、高并发，99% 超高到达率。\n* 电信级运维保障，实时监控自动切换。 \n高并发处理 | \n* 支持多个生产者和消费者并发访问同一个队列，无需特殊设置即可自由调整并发度。\n* 确保某条消息在取出之后的特定时间段内，无法被其他消费者获得。\n* 在保证号码及终端质量的前提下，多通道智能调度保障发送，3-5 秒到达率 99% 以上。 \n智能监控调度 | 七牛短信服务平台融合多家专属运营商，多通道智能调度，轻松应对业务高峰。\n* 电信级运维保障，实时监控自动切换 电信级运维保障，实时监控自动切换。\n* 支持大容量，高并发处理，高效的调度算法解决高峰时段的业务压力。\n* 海量数据多通道智能分流，到达率可靠 \n满足个性化定制 | 支持自定义签名，支持为不同的客户提供独享通道、专用通道、大客户通道。 \n接入便捷 | 提供详尽、完善的短信接入文档，简单易懂，快速上线。\n* 接入便捷：提供 API/SDK 方式简易接入，登陆即可一键开通。\n* 使用便捷：无需自行搭建短信服务，免运维提供多种语言 SDK，包括 GO, Ruby, Python, Java 等任您选择。 \n \n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的云短信应用场景"
},
{
"from": "gpt",
"value": "[云短信](https://developer.qiniu.com/sms) > 使用文档 > 应用场景\n\n# 应用场景\n\n最近更新时间: 2019-05-15 17:07:58\n\n# **验证码下发**\n\n * 网站，APP 账号注册，向手机下发验证码； \n * 登录账户、异地登录时的安全提醒； \n * 找回密码时的安全验证； \n * 支付认证、身份校验、手机绑定等。\n\n# **系统通知推送**\n\n向注册用户或会员发送系统相关信息，包括：升级或维护、服务开通、价格调整、订单动态、订单确认、物流动态、消费确认、支付通知、账户余额等普通通知短信。\n\n# **营销活动推广**\n\n向注册用户、会员和潜在客户发送通知和营销推广信息，包括促销活动通知、业务推广、新产品宣讲、会员关怀等商品与活动的推广信息。增加企业产品曝光率、提高产品和企业的知名度，支持高并发批量发送，可以满足会员生日、客户关怀、节日祝福、线上线下打折促销、业务推广、新品上线、客户维系等场景。\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的云短信限制说明"
},
{
"from": "gpt",
"value": "[云短信](https://developer.qiniu.com/sms) > 使用文档 > 限制说明\n\n# 限制说明\n\n最近更新时间: 2020-03-09 15:05:06\n\n# **短信发送频率限制**\n\n在实际业务场景中，例如网站或 APP\n登录时，可能会有用户频繁获取短信验证码、或者通过短信方式找回密码时，为了限制平台短信被恶意调用、在短时间内大量发起短信发送请求，七牛云对短信发送行为进行以下限制：\n\n服务类别 | 所属通道 | 限制说明 \n---|---|--- \n通用限制 | 所有通道 | 同 1 个号码发相同内容，30 秒内最多发送 1 次，5 分钟内最多发送 3 次 \n短信验证码 | 普通通道 | 同一号码同一签名，验证码、通知和推广均为普通通道，每天发送 `验证码` \\+ `通知` \\+ `推广` 短信，累积最多 `50` 条 / 天 \n短信通知 | 普通通道 | 同一号码同一签名，验证码、通知和推广均为普通通道，每天发送 `验证码` \\+ `通知` \\+ `推广` 短信，累积最多 `50` 条 / 天 \n推广短信 | 普通通道 | 同一号码同一签名，验证码、通知和推广均为普通通道，每天发送 `验证码` \\+ `通知` \\+ `推广` 短信，累积最多 `50` 条 / 天 \n验证码短信 | 专用通道 | 验证码短信没有限制 \n通知短信 | 专用通道 | 通知短信没有限制 \n \n**提示** ：\n\n * 若在发送验证码时提示业务限流，建议根据以上业务调整接口调用时间。\n\n**注意** ：\n\n * 所有发送的短信都需要提交审核，审核通过后方可进行短信发送。\n * 天的计算方式是是当前时间往前推 24 小时，例如 2019 年 5 月 15 日：18:00 发送一条验证码短信，计算限流方式是 2019 年 5 月 14 日：18:00 点到 2019 年 5 月 15 日：18:00 点，这段时间内是否满 40 条。\n * 推广短信在 20:00 到次日 08:00 不允许发送\n\n# **短信封禁规则**\n\n * 短信服务会针对用户发送的短信模版和短信签名进行审核，同时配合系统监控，防范在短信内容中出现的违反国家法律法规要求的相关内容。\n * 发现违反规则的短信内容，会对相关用户进行账号冻结，并视情况严重程度追究其责任。\n * 冻结账号无法继续使用短信服务，如该账号中包含短信服务的资源包、优惠券等，也无法继续使用。账号冻结后，后续不可申请开通使用。\n\n# **短信内容长度计算规则**\n\n * 短信字数 ＝ 短信模版内容字数（如包含变量，则是包含实际变量字符的长度） + 签名字数（签名包含 【】 或 []）\n * 短信字数 ≤ 70 个字数，按照 70 个字数一条短信计算\n * 短信字数 > 70 个字数，即为长短信，按照 67 个字数记为一条短信计算\n\n**注意** ：在统计短信字数时，小数点、字母、汉字以及其他符号均按照一个字符统计，并最终按照实际发送成功的短信条数计费。\n\n# **短信内容长度限制**\n\n实际发送的短信内容总长度 600 个字符，包含小数点、字母、汉字以及其他符号。\n\n# **短信签名和模板数量限制**\n\n暂时无限制，但是要证明签名和与自己账号都有相关证明。\n\n# **链接格式**\n\n如您的内容中带有链接，请参考“<http://www.qiniu.com/order/${code}”> 格式。暂不支持全变量链接，如${URL}。\n\n# **API 接口调用频率限制**\n\n**默认 500次/分钟** \n如果您需要更高的调用频次，请联系提交工单申请调整\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的云短信快速入门"
},
{
"from": "gpt",
"value": "[云短信](https://developer.qiniu.com/sms) > 使用文档 > 快速入门\n\n# 快速入门\n\n最近更新时间: 2020-05-28 11:17:46\n\n本文旨在介绍七牛云短信如何快速接入服务。\n\n# **基本概念**\n\n**短信格式** ：短信由签名和正文内容组成，发送短信前必须申请审核至少一个短信签名和一个短信正文模板，审核通过方可使用。 \n以验证码短信为例，短信格式如下：\n\n \n \n 【七牛云服务】您正在申请绑定手机，验证码为：${code}，5分钟内有效！\n \n\n其中：\n\n * 短信签名：【七牛云服务】\n * 短信模板：您正在申请绑定手机，验证码为：${code}，5分钟内有效！\n * 模板变量：${code}\n\n**短信签名：** 发送短信必备，是附加在短信内容前面的标识，用于标识公司或业务；申请时企业用户需要上传资质证明。 \n**短信模板：** 即具体发送的短信正文内容；支持验证码、短信通知、推广短信三种模式，短信内容可以通过模板参数实现个性化定制。\n\n# **使用流程**\n\n \n \n \n云短信的基本使用流程，包含以下几个步骤：\n\n * 01 开通短信服务\n * 02 申请短信签名\n * 03 申请短信模板\n * 04 购买短信资源包\n * 05 发送短信\n * 06 查看发送状态\n\n# 01 开通短信服务\n\n您需要一个七牛云账号才能使用云短信服务：\n\n 1. 如果还没有账号[注册七牛云账号](https://portal.qiniu.com/signup/choice)，并按照要求完成[实名认证]。(<https://developer.qiniu.com/af/manual/4057/the-identity-authentication)。>\n 2. 如果您已有实名认证的七牛云账号，请直接进行下一步操作。\n\n访问[云短信控制台](https://portal.qiniu.com/sms)，如果是首次使用云短信服务，需要进行服务开通操作，开通好后即可进入云短信\ndashboard 界面。 \n\n\n备注：\n\n 1. 实名认证后可享受共 300 条的免费测试短信（验证码短信 100 条、通知短信 100 条和推广短信 100 条）。激活当月的1号生效，12月内有效。\n\n# 02 申请短信签名\n\n短信服务发送的短信中包括短信签名和短信模板，所以您需要至少申请一个短信签名并通过审核方可正常发送短信。 \n短信签名可直接在[云短信控制台](https://portal.qiniu.com/sms/signature)申请，选择【签名】->【新建】。 \n \n在新建签名时，您可根据实际情况填写以下参数：\n\n 1. 短信签名：填写全称或者简称，无须添加【】、()、[]符号，签名发送会自带【】符号。\n 2. 用途：企业、网站、App、公众号或小程序、电商店铺名、商标名或者其他。\n 3. 签名归属：自用或者代理他人，如选择“代理他人”，即签名归属与七牛账号归属主体不一致时需[上传授权委托书](https://developer.qiniu.com/sms/manual/5916/power-of-attorney)。\n 4. 上传证明：根据实际用途上传相关证明文件。\n 5. 申请说明：根据实际情况填写相关说明。\n\n备注：\n\n 1. 海外短信签名需符合[该地区语言支持](https://developer.qiniu.com/sms/kb/6295/the-international-message-template)，如七牛海外短信签名为[Qiniu]，只需要提交签名内容“Qiniu”。\n 2. 审核时间为工作日2小时以内，如需加急请[提交工单](https://support.qiniu.com/tickets/new)或者联系对应商务经理。\n\n# 03 申请短信模板\n\n短信模板是具体发送的短信正文内容；国内短信模板可直接在[云短信控制台](https://portal.qiniu.com/sms/template)申请，选择【模板】->【新建】。 \n \n在新建模板时，您可根据实际情况填写以下参数：\n\n 1. 名称：自定义模板名，用于标识。\n 2. 类型：验证码、通知、推广和语音类，根据实际需要选择。\n 3. 短信签名：短信模板必须关联对应短信签名。\n 4. 内容：参考[短信模板审核标准](https://developer.qiniu.com/sms/manual/5814/template-specification)。\n 5. 申请说明：根据实际情况填写相关说明。\n\n备注：\n\n 1. 海外短信模板需符合[该地区语言支持](https://developer.qiniu.com/sms/kb/6295/the-international-message-template)，并提交[提交工单](https://support.qiniu.com/tickets/new)或者联系对应商务经理加急。\n\n# 04 购买短信资源包\n\n完成申请短信签名和短信模板后，可在[资源包](https://portal.qiniu.com/sms/resource)界面购买套餐包。\n\n# 05 发送短信\n\n确认短信签名和短信正文模板均已通过审核后，您可通过云短信[控制台批量发送](https://developer.qiniu.com/sms/manual/5823/the-\nconsole-send-sms)或 [API\n方式](https://developer.qiniu.com/sms/manual/5824/through-the-api-send-text-\nmessages)发送短信，本文以使用控制台为例，选择【发送群发】->【批量发送】。 \n \n新建群发短信任务时，您可根据实际情况填写以下参数：\n\n 1. 任务名称:自定义群发短信任务名，用于标识。\n 2. 短信模板：批量发送只支持推广、通知短信模板，其他类型请提交[提交工单](https://support.qiniu.com/tickets/new)或者联系对应商务经理。\n 3. 定时发送（可选）：选择群发短信任务发送时间。\n 4. 号码输入：支持文件导入和文本框填写，文本框输入时号码间以英文逗号“,”分隔。\n\n备注：\n\n 1. 群发功能需要企业用户认证，且保证您的账号有10万条资源包余量或5000元余额。\n 2. 用户发送短信可利用[API方式](https://developer.qiniu.com/sms/manual/5824/through-the-api-send-text-messages)。\n\n# 06 查看发送状态\n\n无论是通过控制台或API方式发送短信，都会在控制台显示。 \n七牛云提供“发送量统计”和“发送记录查询”功能，待发送短信步骤完成后，可直接在云短信控制台左侧导航栏打开。 \n \n若短信发送失败，请参考[错误定义](https://developer.qiniu.com/sms/api/5849/sms-error-\ncode)排除故障，再重新发送短信。\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的云短信产品定价"
},
{
"from": "gpt",
"value": "[云短信](https://developer.qiniu.com/sms) > 使用文档 > 产品定价\n\n# 产品定价\n\n最近更新时间: 2020-05-28 11:17:07\n\n# **国内短信套餐包**\n\n * 短信套餐包分为固定规格套餐包和自定义套餐包，**套餐包可用于验证码、短信通知和推广短信。**\n * 个人认证用户无法使用短信服务，请您升级为企业用户。\n * 从2019年12月10日起，完成实名认证后，您可享受共 300 条的免费测试短信（验证码短信 100 条、通知短信 100 条和推广短信 100 条）。激活当月的1号生效，12月内有效。\n * 目前禁止发送金融、游戏类相关的短信，请谨慎购买。\n * 短信套餐(资源)包为特别优惠价，一旦购后买不支持退订/退款。\n\n## **定价**\n\n0.043元/条，以成功发送的条数计费 \n按1000的倍数售卖\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的云短信使用须知"
},
{
"from": "gpt",
"value": "[云短信](https://developer.qiniu.com/sms) > 使用文档 > 审核规范 >使用须知\n\n# 使用须知\n\n最近更新时间: 2020-06-01 10:26:50\n\n# **认证模式**\n\n七牛云实名认证分为个人实名认证和企业实名认证。**使用短信服务需将账户类型认证为企业**\n。详情查看[认证说明。](https://developer.qiniu.com/af/manual/4057/the-identity-\nauthentication)\n\n类型 | 适用对象 | 操作指引 \n---|---|--- \n企业实名认证 | 企业、政府、事业单位、学校、组织等 | [如何进行企业认证？](https://developer.qiniu.com/af/manual/4063/enterprise-certification-started-quickly) \n \n更多信息请查看 [七牛实名认证细则须知。](https://developer.qiniu.com/af/kb/1465/seven-cattle-\nreal-name-authentication-details-information)\n\n# **短信权益**\n\n功能服务 | 企业认证 \n---|--- \n免费额度 | 首次开通赠送 300 条测试短信 \n（验证码 100 条；通知 100条； 营销 100 条） \n国内验证码 | 支持 \n国内通知类短信 | 支持 \n国内营销类短信 | 支持 \n \n注意: 19年12月10日之后注册的企业用户，获得免费赠送的300条短信生效时间是账户激活的当月1日，有效期为12个月。\n\n# **审核流程**\n\n 1. 申请短信签名或内容模版后，正常情况下，2个小时左右会反馈审核结果（审核时间：周一至周日 10:00 - 20:00，法定节日顺延）。\n 2. 如果您急需使用短信功能或者审核超时，请[提交工单](https://support.qiniu.com/tickets/new/)，我们会加速审核进度；如果审核未通过，也可咨询联系技术支持详细沟通。\n 3. 对于审核通过的内容模版，不表示一定会下发成功（运营商侧也会有抽查审核机制），如遇到短信发送失败，可咨询技术支持详细沟通。\n\n# **审核状态说明**\n\n状态 | 说明 \n---|--- \n审核中 | 已经提交的签名或者模板，正在审核中，审核周期为2小时内。 \n审核通过 | 已通过了审核，短信签名和短信正文模版都通过审核时，便可以开始发送短信。 \n审核未通过 | 提交的签名或者模板未通过审核，可登陆[短信控制台](https://portal.qiniu.com/sms)查看签名或者模板的“未通过原因”，并根据原因修改后再次提交审核。 \n \n# **特别说明**\n\n如您有违反[《服务协议》](https://developer.qiniu.com/sms/manual/5887/sms-service-\nagreement)的任何行为时，七牛云有权依照《服务协议》随时单方采取限制、中止或终止向您提供服务，或者采取冻结账户等措施；已订购的套餐包，无论是否已经使用，一律不允许退订/退款；造成严重影响或后果的，七牛云将有权追究您的相关法律责任。\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的云短信签名审核标准"
},
{
"from": "gpt",
"value": "[云短信](https://developer.qiniu.com/sms) > 使用文档 > 审核规范 >签名审核标准\n\n# 签名审核标准\n\n最近更新时间: 2021-12-29 15:37:03\n\n# **签名用途和要求说明**\n\n创建签名时必须选择签名用途，上传相关证明，并按照说明填写相关信息。签名内容需与在七牛认证账号的营业执照名称相同。\n\n# **签名内容规范**\n\n * 签名内容不能含有黄赌毒，宗教，党政等信息；\n * 签名不支持中性化签名，需能辨别所属公司；\n * **国内短信签名** 由【】及签名内容组成，签名内容要求2~8个字（由中英文，数字组成，不能包含其他特殊字符，如 “+，@，|” 等，国内短信签名内容尽量使用中文），在控制台申请短信签名时只需要提交签名内容。例如七牛云的短信签名为“【七牛云】”，申请短信签名时只需要提交签名内容“七牛云”；\n\n> 说明：暂时不支持国际/港澳台短信\n\n# **第三方权益**\n\n * 如果用户 A 创建自用签名，签名归属主体属于用户 A ，则不涉及第三方权益。\n * 当申请的签名与公司主体或账号主体信息不一致时，则涉及第三方权益。\n\n# **证明文件规范和清单**\n\n## **证明文件规范**\n\n * 所有证明文件必须为原件扫描件，即图片中公章必须为红色。\n * 执照未过期、未涂改。\n * 证明文件必须为jpg、png或jpeg格式的图片，每张图片不大于2MB。\n * 涉及第三方权益时需要使用的授权委托书必须使用短信服务提供的标准涉及第三方权益时需要使用的授权委托书必须使用短信服务提供的[标准授权书模板 __](https://developer.qiniu.com/sms/manual/5916/power-of-attorney)。\n\n \n\n## **企事业单位归属证明文件清单**\n\n创建归属主体为企事业单位的签名时，需要上传的证明材料清单如下表所示。\n\n签名类型 | 证明文件 \n---|--- \n公司 | 需上传签名所属主体的企事业单位证明文件，择一即可：\n* 三证合一\n* 企业营业执照\n* 组织机构代码证书\n* 社会信用代码证书 \n若涉及第三方权益，还需**上传授权委托书。** \n政府/机关事业单位/其他机构 | 需上传签名所属主体的企事业单位证明文件，择一即可：\n* 组织机构代码证书\n* 社会信用代码证书 \n若涉及第三方权益，还需**上传授权委托书** 。 \n \n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的云短信模板审核标准"
},
{
"from": "gpt",
"value": "[云短信](https://developer.qiniu.com/sms) > 使用文档 > 审核规范 >模板审核标准\n\n# 模板审核标准\n\n最近更新时间: 2021-10-28 18:02:58\n\n添加短信模板并提交审核时，需要保证模板内容符合以下公共规范和模板规范。\n\n# **公共规范**\n\n## **内容规范**\n\n类别 | 规范 \n---|--- \n格式规范 | \n\n 1. 500字以内。字符串类型，支持中英文、大小写、字符。\n 2. 不支持【】，可能会与签名混淆。\n 3. 暂不支持如★、 ※、 →、 ●等特殊符号，可能会导致短信出现乱码。\n\n \n内容规范 | 模板必须明确表述实际业务，除变量以外的文本内容必须可判读短信含义和使用场景。\n\n 1. 禁止发送违法违规相关内容；\n 2. 禁止在关键字或关键信息中出现错别字、变体字、异体字、各类干扰符号等；禁止出现各类非正常混合字以及非常用的表达法；\n 3. 未经许可的邀请、问卷调查不允许发送，主要指邀请注册、邀请成为会员、收集用户信息等行为；\n 4. 不允许发送 App 应用推广、微信公众号推广短信；\n 5. 不允许发送视频直播、贺卡等内容、链接\n 6. 链接只能是已 ICP 备案的网址，且必须为常量（固定不变），不可重定向跳转；\n 7. 禁止包含以下运营商限制关键词如电信、移动、联通、流量等；\n 8. 禁止发送股票、移民、房地产、教育、培训、面试招聘、彩票、网赚、返利、返现、提现、现金补贴、货到付款、贷款、催款、投资理财、POS 机、赌博、中奖、一元夺宝、一元秒杀、A 货、医疗、整形、美容、会所、烟酒、酒吧、足浴、暴力、恐吓、色情、皮草、助考，商标注册、加群、加 QQ 或者加微信、贩卖个人信息、宣传短信通道、装修（含建材,家私）、游戏推广、会展推广、网站推广、应用下载及推广、优惠券类推广、卡类推广、保险推广、酒类、婚恋、社交、(异性)交友、用户拉新、用户召回等类型的短信。\n\n \n \n \n\n## **变量规范**\n\n短信模板可以包含变量，用户可通过变量实现自定义短信内容。\n\n类别 | \n---|--- \n变量格式 | ${code}、${name}、${content} 等，中间字母应代表变量属性。 \n其他规范 | \n\n* 不支持全变量模板；\n* 不允许设置变量链接（包含短链接），例如 www.${qiniu}.com。 \n \n# **特定规范**\n\n除公共规范外，不同短信类型的文本短信模板还有相应的特定规范，详情如下表所示。\n\n类别 | 内容规范 \n---|--- \n验证码类 | \n\n* 国内模板内容中必须包含关键词**验证码，注册码，校验码或动态码** 这4个词其中之一，国外模板内容中必须包含英文单词 **code** 。\n* 验证码短信模板变量的实际内容仅支持0 - 6位（包括6位）纯数字。\n* 除公共规范类，不支持带营销推广的内容； \n通知类 | \n\n* 除公共规范类，不支持带营销推广的内容； \n推广类 | \n\n* 短信模板末尾需要添加 “回TD退订” 或 “回T退订”；\n* 不能给非会员用户发送营销短信；\n* 营销短信发送时间：每日 8:00 - 20:00，尽量避免夜间发送，减少用户投诉。 \n \n注意：\n\n 1. 模板规范可能随运营商规则变化实时调整，最终以模板审核结果为准。\n 2. 如遇到违反规范并造成恶劣影响的，将严肃处理并进行封号！请严格遵守规范要求，加强自身业务安全，健康发送短信。\n 3. 对于审核通过的内容模版，不表示一定会下发成功（运营商侧规则变化调整），如遇到短信发送失败，可咨询技术支持详细沟通。\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的云短信短信模板示例"
},
{
"from": "gpt",
"value": "[云短信](https://developer.qiniu.com/sms) > 使用文档 > 审核规范 >短信模板示例\n\n# 短信模板示例\n\n最近更新时间: 2021-01-25 14:41:13\n\n您可根据实际业务需求、短信模板示例和[短信模板审核标准\n__](https://developer.qiniu.com/sms/manual/6648/sample-text-\ntemplate)创建符合规范的短信模板，若不做任何修改，可以极大提高审核效率及成功率。\n\n# **模板示例**\n\n类型| 应用场景| 模板示例 \n---|---|--- \n验证码类| 注册| 您正在申请手机注册，验证码为：${code}，5分钟内有效！ \n尊敬的用户，您的注册会员动态密码为：${code}，请勿泄漏于他人！ \n登陆/验证| 您的验证码为：${code}，该验证码5分钟内有效，请勿泄漏于他人！ \n您的验证码：${code}，您正进行身份验证，打死不告诉别人！ \n您的验证码为：${code}，请尽快完成验证。祝您生活愉快！ \n验证码为：${code}，您正在登录，若非本人操作，请勿泄露。 \n重置密码| 您的动态验证码为：${code}，您正在进行密码重置操作，如非本人操作，请忽略本短信！ \n找回密码| 您正在进行密码找回，验证码为：${code}，5分钟有效，请勿向任何人提供此验证码。 \n变更信息| 验证码为：${code}，您正在尝试变更重要信息，请妥善保管账户信息。 \n通知类| 修改密码| 您好，您的密码已经重置为${password}，请及时登录并修改密码。 \n审核| 您的${mtname}申请已于${submittime}审批通过，特此通知。 \n快递| 尊敬的${name}用户，您的提货码是：${code}，请不要把提货码泄露给其他人。 \n您好，请凭取件码：${code}，至${address}取件，若有问题请咨询${phone}。 \n您的快递${code}正在配送中，请注意查收。 \n排队| 您的排队号${code}，您前面还有${number}人等待，请在现场等候叫号。 \n订单| 您有新的订单待处理，当前状态：${status}，订单摘要:${remark}，请及时处理。 \n \n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的云短信国内短信"
},
{
"from": "gpt",
"value": "[云短信](https://developer.qiniu.com/sms) > 使用文档 > 用户指南 >国内短信\n\n# 国内短信\n\n最近更新时间: 2021-12-29 21:49:20\n\n七牛云提供云短信服务SMS（Short Message Service，SMS）支持向国内快速发送验证码、短信通知和营销推广短信。\n\n# 国内短信发送步骤\n\n发送国内短信，请遵循以下步骤：\n\n 1. 添加签名。 \n短信签名必须遵循[短信签名审核标准 __](https://developer.qiniu.com/sms/manual/5816/signature-\nspecification)，且经过审核。\n\n 2. 添加模板。 \n短信模板必须遵循[短信模板审核标准 __](https://developer.qiniu.io/sms/manual/5814/template-\nspecification)，且经过审核。\n\n 3. 发送短信。 \n通过[短信服务API __](https://developer.qiniu.com/sms/manual/5824/through-the-api-\nsend-text-messages)发送短信。 \n通过[控制台批量发送 __](https://developer.qiniu.com/sms/manual/5823/the-console-send-\nsms)短信。\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的云短信国际/港澳台短信"
},
{
"from": "gpt",
"value": "[云短信](https://developer.qiniu.com/sms) > 使用文档 > 用户指南 >国际/港澳台短信\n\n# 国际/港澳台短信\n\n最近更新时间: 2021-12-30 10:28:49\n\n七牛云提供云短信服务SMS（Short Message Service，SMS）支持向国际/港澳台快速发送验证码、短信通知和营销推广短信。\n\n# 国际/港澳台短信发送步骤\n\n发送国内短信，请遵循以下步骤：\n\n 1. 添加签名。 \n短信签名必须遵循[短信签名审核标准 __](https://developer.qiniu.com/sms/manual/5816/signature-\nspecification)，且经过审核。\n\n 2. 添加模板。 \n短信模板必须遵循[短信模板审核标准 __](https://developer.qiniu.io/sms/manual/5814/template-\nspecification)，且经过审核。\n\n 3. 发送短信。 \n通过[短信服务API __](https://developer.qiniu.com/sms/manual/5824/through-the-api-\nsend-text-messages)发送短信。 \n通过[控制台批量发送 __](https://developer.qiniu.com/sms/manual/5823/the-console-send-\nsms)短信。\n\n# 国际/港澳台短信模板说明\n\n如您需要发送国际/港澳台短信，请注意国际短信语言支持说明：\n\n发送目的国家与地区 | 支持模板语言 \n---|--- \n中国港澳台 | 简体中文、繁体中文、英文 \n日本 | 日文、英文 \n韩国 | 韩文、繁体中文、英文 \n \n其它国家只支持英文\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的云短信签名管理"
},
{
"from": "gpt",
"value": "[云短信](https://developer.qiniu.com/sms) > 使用文档 > 用户指南 >签名管理\n\n# 签名管理\n\n最近更新时间: 2020-03-02 15:48:54\n\n简单的列举了短信签名控制台和API的功能。\n\n# **控制台介绍**\n\n功能 | 描述 \n---|--- \n新建签名 | 控制台[创建签名](https://portal.qiniu.com/sms/signature)，创建时可参考签名审核标准。 \n查询签名 | 根据签名审核状态和签名内容定位签名 \n \n# **API介绍**\n\n功能 | 描述 \n---|--- \n创建签名 | [API方式创建签名](https://developer.qiniu.io/sms/api/5844/sms-api-create-signature) \n列出签名 | [API方式列举签名](https://developer.qiniu.io/sms/api/5889/sms-api-query-signature) \n查询单个签名 | [API方式查询单个签名](https://developer.qiniu.io/sms/api/5970/query-a-single-signature) \n编辑签名 | [API方式编辑签名](https://developer.qiniu.io/sms/api/5890/sms-api-edit-signature) \n删除签名 | [API方式删除签名](https://developer.qiniu.io/sms/api/5891/sms-api-delete-signature) \n \n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的云短信模板管理"
},
{
"from": "gpt",
"value": "[云短信](https://developer.qiniu.com/sms) > 使用文档 > 用户指南 >模板管理\n\n# 模板管理\n\n最近更新时间: 2020-03-02 17:15:32\n\n简单的列举了短信模板控制台和API的功能。\n\n# **控制台介绍**\n\n功能 | 描述 \n---|--- \n新建模板 | 控制台[创建模板](https://portal.qiniu.com/sms/template)，创建时可参考签名审核标准。 \n查询模板 | 可根据关联签名、模板审核状态和模板内容定位模板 \n \n# **API介绍**\n\n功能 | 描述 \n---|--- \n创建模板 | [API方式创建签名](https://developer.qiniu.io/sms/api/5844/sms-api-create-template) \n列出模板 | [API方式列举签名](https://developer.qiniu.io/sms/api/5889/sms-api-query-template) \n查询单个模板 | [API方式查询单个签名](https://developer.qiniu.io/sms/api/5970/query-a-single-template) \n编辑模板 | [API方式编辑签名](https://developer.qiniu.io/sms/api/5890/sms-api-edit-template) \n删除模板 | [API方式删除签名](https://developer.qiniu.io/sms/api/5891/sms-api-delete-template) \n \n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的云短信通过API发送短信"
},
{
"from": "gpt",
"value": "[云短信](https://developer.qiniu.com/sms) > 使用文档 > 用户指南 >发送短信 >通过API发送短信\n\n# 通过API发送短信\n\n最近更新时间: 2021-09-16 11:53:21\n\n# **前提条件**\n\n 1. 已开通短信服务。\n 2. 已添加短信签名和短信模板并通过审核\n\n# **API发送接口**\n\n接口 | 描述 \n---|--- \n发送短信 | 发送单条或者群发短信：[/v1/message（POST方式） __](https://developer.qiniu.com/sms/api/5897/sms-api-send-message#1) \n发送单条短信 | [/v1/message/single __](https://developer.qiniu.com/sms/api/5897/sms-api-send-message#2) \n发送国际短信 | [/v1/message/oversea __](https://developer.qiniu.com/sms/api/5897/sms-api-send-message#3) \n发送全文本短信(不需要传模版 ID) | [/v1/message/fulltext __](https://developer.qiniu.com/sms/api/5897/sms-api-send-message#4) \n \n# **查询发送记录**\n\n * [/v1/messages（GET 方式） __](https://developer.qiniu.com/sms/api/5852/query-send-sms)\n\n# **回调消息**\n\n分为状态回调和上行回调。\n\n详情请参考[消息推送 __](https://developer.qiniu.com/sms/api/5910/message-push#1)。\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的云短信通过控制台批量发送短信"
},
{
"from": "gpt",
"value": "[云短信](https://developer.qiniu.com/sms) > 使用文档 > 用户指南 >发送短信 >通过控制台批量发送短信\n\n# 通过控制台批量发送短信\n\n最近更新时间: 2020-03-02 17:05:12\n\n# **前提条件**\n\n 1. 已开通短信服务。\n 2. 已添加短信签名和短信模板并通过审核\n 3. 控制台批量发送**需审核开通** ，可[提交工单](https://support.qiniu.com/tickets/new)或者联系对应商务经理。\n 4. 只支持**推广、通知短信模板** ，如有其他需求也可以提交工单。\n\n# **操作步骤**\n\n 1. 进入[短信控制台](https://portal.qiniu.com/sms/send)，选择“发送任务> 批量发送”。\n 2. 填写任务名称。\n 3. 选择短信模板，如果没有模板，可添加先添加短信签名。\n 4. 设置接收号码。可选择**导入接收号码文件** 或**手动输入接收号码。**\n 5. 定时发送（可选）：选择群发短信任务发送时间。\n\n\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的云短信配置管理"
},
{
"from": "gpt",
"value": "[云短信](https://developer.qiniu.com/sms) > 使用文档 > 用户指南 >短信设置 >配置管理\n\n# 配置管理\n\n最近更新时间: 2020-03-03 14:43:30\n\n在配置管理中，您可以通过填写回调地址的方式来接收短信的发送状态回调和上行短信内容回调。\n\n# **设置消息推送**\n\n\n\n 1. 打开[云短信控制台 ](https://portal.qiniu.com/sms/settings)-> 配置管理\n 2. 填写业务回调地址\n\n说明：\n\n 1. 业务回调地址仅支持带 http、https 协议的 URL 格式。\n 2. 回调方法都是HTTP POST，且返回 HTTP 状态码 200，如果返回不是 200，会在10分钟内自动重试。\n\n# **发送状态回调**\n\n短信发送给用户后，将会通过回调下列 URL 的方式，通知业务方用户发送短信的状态。\n\n**回调内容**\n\n \n \n {\n \"items\":[{\n \"mobile\": <string>,\n \"message_id\": <string>, // \n \"status\": <string>, // DELIVRD 送达， FAILED 发送失败\n \"delivrd_at\": <timestamp>,\n \"error\": <string>, \n \"job_id\": <string> \n }]\n }\n \n\n**参数解析：**\n\n参数 | 说明 \n---|--- \nmobile | 手机号码 \nmessage_id | 单条发送的时候返回的 message_id \nstatus | DELIVRD 送达， FAILED 发送失败 \ndelivrd_at | 到达时间 \nerror | 当 status 为 FAILED 的时候，会有这个字段 \njob_id | 批量发送的时候返回的 job_id \n \n# **上行状态回调**\n\n用户回复短信，将会通过回调下列 URL 的方式，通知业务方用户回复了短信。\n\n \n \n {\n \"items\": [{\n \"mobile\": \"<string>\",\n \"content\": \"<string>\",\n \"time\": <timestamp>\n }]\n }\n \n\n**参数解析：**\n\n参数 | 说明 \n---|--- \nmobile | 手机号码 \ncontent | 回复的具体内容 \ntime | 回复时间 \n \n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的云短信余量提醒和阈值设置"
},
{
"from": "gpt",
"value": "[云短信](https://developer.qiniu.com/sms) > 使用文档 > 用户指南 >短信设置 >余量提醒和阈值设置\n\n# 余量提醒和阈值设置\n\n最近更新时间: 2021-07-27 16:10:42\n\n系统设置包含余额提醒和发送阈值两个子功能。\n\n说明：\n\n 1. 配置好预警提示后需到[联系人设置控制台 __](https://portal.qiniu.com/sms/contacts)添加**主账户以外** 的余额提醒和发送阈值联系人，可参考说明文档[联系人设置。 __](https://developer.qiniu.com/sms/manual/5832/contacts)\n\n# **余量提醒**\n\n在系统设置的余量提醒中，您可以对已购买的资源包分别针对系统短信资源包（验证码和通知类）或者推广短信资源包分别设置提醒下限。 \n\n\n开启该功能后，我们会在您的短信资源包条数低于您设置的条数时，免费向您发送短信或邮件提醒。 \n为避免因资源包不足对您的业务造成不良影响，建议您开启资源包余量提醒功能。\n\n**开启方式**\n\n 1. 打开[短信控制台 __](https://portal.qiniu.com/sms/system)-> 系统设置 -> 余额提醒\n 2. 在当前状态栏点击开启按钮后，根据业务需求填写提醒条数，建议设置为资源包的30%。\n\n# **发送阈值**\n\n在系统设置的发送阈值中，支持对每日和每月的**短信发送总量和模板发送总量** 设置预警值及限额值。\n\n * 达到预警值时，预设的联系人会收到系统发送的短信提醒；\n * 达到限额值，系统暂停短信发送。\n\n该功能是您根据日常情况进行的发送上限设置，设置后可避免网站被人恶意利用，导致短信量突增，而产生高额费用。 \n \n\n\n说明：\n\n 1. 达到预警值及限额值，系统会发送短信提醒到手机号。达到限额值时，系统暂停短信发送，需要您手动更改。\n 2. 模板阈值高于账户总量阈值，请优先设置模板发送总量阈值。\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的云短信联系人设置"
},
{
"from": "gpt",
"value": "[云短信](https://developer.qiniu.com/sms) > 使用文档 > 用户指南 >短信设置 >联系人设置\n\n# 联系人设置\n\n最近更新时间: 2020-03-03 11:36:00\n\n# **联系人设置**\n\n余额提醒和发送阈值的通知提醒会以短信和邮件的方式通知，根据业务需要添加多个联系人，可确保重要信息的及时查阅。\n\n# **操作步骤**\n\n 1. 打开短信控制台，在左侧导航栏中单击**联系人管理** 。\n 2. 点击新建联系人。\n\n\n\n配置 | 说明 \n---|--- \n姓名 | 联系人的姓名 \n手机号 | 联系人的手机号码，11位数字 \n邮箱 | 联系人的邮箱 \n用户资源包余额提醒 | 该联系人是否接收套资源余量预警短信和邮件 \n账户发送总量阈值 | 该联系人是否接收账户发送总量阈值预警短信和邮件 \n模板发送总量阈值 | 该联系人是否接收模板发送总量阈值预警短信和邮件 \n \n说明：\n\n 1. 默认情况下，联系人中只有主账号联系人，主账号联系人默认接收余额提醒和发送阈值提醒，且不可变更。**账号管理** 中可更换主账号联系人。\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的云短信防短信轰炸"
},
{
"from": "gpt",
"value": "[云短信](https://developer.qiniu.com/sms) > 使用文档 > 用户指南 >防短信轰炸\n\n# 防短信轰炸\n\n最近更新时间: 2020-03-02 18:53:47\n\n# **背景信息**\n\n短信轰炸主要是利用验证码攻击，通过⽤户产品验证码获取的接⼝，通过**自动化脚本⽅式**\n批量对单个或者多个号码进⾏验证码重复请求提交，⽤户验证码被刷后直接带来的是经济损失，同时对被攻击的号码带来了巨⼤的骚扰。\n\n# **解决措施**\n\n措施描述 | 具体方式 | 解决的问题 \n---|---|--- \n使用安全图片验证码 | 点击获取验证码之前做一个校验，比如需要正确输入图形验证码、拖动验证等 | 防止通过自动化工具进行攻击请求 \n单IP的请求次数限定 | 在服务器端增加对单ip请求的验证码数量进行限制，一般情况下建议不超过 200 个/分钟。 | 防止攻击者对服务器进行大量无效请求 \n单用户动态短信请求间隔时长限制 | 客户在服务器端对单手机号请求的验证码时长和数量进行限制，一般是60 秒后，超出60秒没有输入的验证码作废，重新获取。 | 防止图片验证码失效后对用户形成大量攻击 \n \n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的云短信七牛云短信服务协议"
},
{
"from": "gpt",
"value": "[云短信](https://developer.qiniu.com/sms) > 使用文档 > 七牛云短信服务协议\n\n# 七牛云短信服务协议\n\n最近更新时间: 2024-08-23 17:30:47\n\n为使用七牛云短信服务，您应当阅读并遵守《七牛云短信服务协议》（以下简称“本协议”）。\n在接受本协议之前，请您务必仔细阅读本协议的全部内容，特别是免除或者限制责任的条款以及管辖法院的选择条款等。\n\n您实际使用七牛云平台服务， 均表示您与七牛云已就本协议达成一致并同意接受本协议的全部约定内容。\n如果您不同意本协议的任意内容，或者无法准确理解七牛云对条款的解释， 请不要同意本协议或使用本协议项下的服务。\n否则，表示您已接受了以下所述的条款和条件，同意受本协议约束。\n\n如您有违反本协议的任何行为时，七牛云有权依照本协议随时单方采取限制、中止或终止向您提供服务，或者采取冻结账户等措施；已订购的套餐包，无论是否已经使用，一律不允许退订/退款；造成严重影响或后果的，七牛云将有权追究您的相关法律责任。\n\n# 服务功能\n\n七牛云提供的短信服务，具体包括短信验证码、语音验证码、国际短信等功能，向您提供发送短信的 API 接口、通道、以及专属通道的运营支撑等服务。\n\n# 服务费用\n\n 1. 本协议内所及短信，按实际提交成功的短信数量计费。\n 2. 短信计费规则及详细价格，以官网公布的规则及价格为准。\n 3. 短信资源包为特别优惠价，一旦购后买不支持退订/退款。\n 4. 若因运营商计费规则变化导致七牛云短信服务调整计费标准，或合同赖以成立的基础运营商产品价格体系发生变化导致继续维持合同的原有效力失衡，七牛云短信服务会提前7天以书面形式通知用户。若您继续使用七牛云短信服务则需按七牛云短信服务公布的收费标准支付费用。\n\n# 服务使用规范\n\n 1. 您使用七牛云短信服务的通道只能向您的会员或注册客户（以下统称为“用户”）发送短信，您应当事先获得用户明确同意，方可向用户发送短信。\n 2. 七牛云有权对您发送短信进行监督、审核和监测，短信发送前七牛云将进行短信签名和模板审核，对于未审核通过的短信文案内容，七牛云将限制发送，且七牛云有权单方判断和决定您发送短信是否违反本协议，并有权拒绝发送违反法律规定或本协议约定的短信内容，一经发现您发送违反法律规定或本协议约定的信息，有权立即停止传输，并有权视情节轻重要求您限期整改、暂停业务直至单方面解除合作协议，一旦发现您使用本服务的行为违反法律规定或本协议约定行为，有权停止服务或解除协议。如果因您的原因导致用户投诉使七牛云短信服务所使用的短信通道存在被运营商停用风险，七牛云有权要求停止服务并要求您对七牛云所受一切损失承担赔偿责任。\n 3. 您保证向用户所发送的短信的内容真实、准确、合法，您不得利用七牛云短信服务提供的通道从事下列行为(包括不限于)： \n3.1 违反国家法律、法规和行业政策开展业务。 \n3.2 向用户发送违反国家法律、法规、国家政策和公序良俗的信息。 \n3.3 向用户发送政治类信息、违法犯罪信息、涉黄信息、SP诱骗定制信息或第三方广告或其它违法违规信息。 \n3.4 未经客户允许向其发送商业广告或其他信息：如房地产广告、发票、移民信息等。 \n3.5 发布可能产生重大负面社会影响的短信。 \n3.6 违反《互联网信息服务管理办法》第十五条的规定，发送含有以下内容的信息（“九不准”）： \n（1）反对宪法所确定的基本原则的； \n（2）危害国家安全，泄露国家秘密，颠覆国家政权，破坏国家统一的； \n（3）损害国家荣誉和利益的； \n（4）煽动民族仇恨、民族歧视，破坏民族团结的； \n（5）破坏国家宗教政策，宣扬邪教和封建迷信的； \n（6）散布谣言，扰乱社会秩序，破坏社会稳定的； \n（7）散布淫秽、色情、赌博、暴力、凶杀、恐怖或者教唆犯罪的； \n（8）侮辱或者诽谤他人，侵害他人合法权益的； \n（9）含有法律、行政法规禁止的其他内容的。 \n3.7 违反中华人民共和国公安部发出的《关于依法开展治理手机违法短信息有关工作的通知》（公通字【2005】77号），发送含有以下内容的信息： \n（1）假冒银行或银联名义进行诈骗或者敲诈勒索公私财物的信息； \n（2）散布淫秽、色情、赌博、暴力、凶杀、恐怖内容或者教唆犯罪、传授犯罪方法的信息； \n（3）非法销售枪支、弹药、爆炸物、走私车、毒品、迷魂药、淫秽物品、假钞假发票或者明知是犯罪所得赃物的信息； \n（4）发布假中奖、假婚介、假招聘，或者引诱、介绍他人卖淫嫖娼的信息； \n（5）多次发送干扰他人正常生活的，以及含有其他违反宪法、法律、行政法规禁止性规定内容的信息。 \n3.8 其他违反国家法律、法规和行业政策的行为。\n\n# 七牛云公司权利义务\n\n 1. 七牛云短信服务有权监督您在其通道内，短信发送的范围及内容，对于您违反法律、法规或《[短信审核标准 __](https://developer.qiniu.com/sms/manual/6647/sms-auditing-standard)》的规定，利用七牛云短信服务通道向不适当的用户发送短信，或发送内容不当的短信的，七牛云短信服务有权追究您的违约责任。\n 2. 七牛云短信服务向您提供短信通道运营维护服务，七牛云短信服务应指定专人负责技术支持、客户服务和数据核对工作。\n 3. 七牛云短信服务应对您存留在其通道中的客户信息（包括但不限于客户姓名、手机号码等信息）进行保密，并不得利用七牛云短信服务信息技术和设备便利提取各项信息或用将上述信息用于本协议约定以外的任何用途。否则，您有权追究七牛云短信服务的违约责任。但按照工信部等监管部门的要求，将您的客户信息提供给相关通道方的情形除外。\n\n# 服务可审查性\n\n七牛云在依据现有法律法规体系下，出于配合政府监管部门的监管或安全取证调查等原因的需要，在符合流程和手续完备的情况下，可以提供客户所使用的服务的相关信息，包括关键组件的运行日志、运维人员的操作记录、客户操作记录等信息。\n\n# 故障恢复能力\n\n七牛云提供专业团队7x24小时全面维护，并以工单和电话保障等方式提供技术支持，具备完善的故障监控、告警、定位及故障恢复能力。\n\n# 免责条款\n\n 1. 您应了解，使用七牛云的短信服务通道涉及到电信运营商和因特网的网络服务，可能会受到各个环节不稳定因素的影响，因此您同意，对因停电、计费系统故障、计算机错误或病毒、黑客攻击、被盗刷、数据丢失或其它在七牛云合理控制范围之外的原因所造成的中断、延迟或停顿等服务问题，七牛云不承担责任。\n 2. 七牛云有权定期或不定期地对提供网络服务的网站或相关的设备进行检修或者维护，如因此类情况而造成网络服务在合理时间内的中断或暂停，七牛云无需为此承担任何责任。\n 3. 如发生下述任一情况而导致服务中断及您损失的，七牛云不承担责任： \n3.1 发生不可抗力情形的； \n3.2 黑客攻击、计算机病毒侵入或发作的； \n3.3 计算机系统遭到破坏、瘫痪或无法正常使用的； \n3.4 因政府管制而造成中止或终止服务的； \n3.5 其它非因七牛云的过错而引起的。\n\n 4. 对于您违反法律、法规或《短信审核标准》的规定，利用七牛云短信服务通道向不适当的用户发送短信，或发送内容不当的短信的，造成的法律责任一概由您承担。\n 5. 在任何情况下，七牛云对本协议项下提供的服务所承担的违约赔偿责任总额不超过违约服务对应之服务费总额。\n 6. 在任何情况下，七牛云均不就因使用七牛云提供的服务所发生的任何间接性、后果性、惩戒性、偶然性、特殊性的损害，包括您使用七牛云服务而遭受的利润损失承担责任（即使您已事先被告知该等损害发生的可能性）。\n\n# 协议变更\n\n七牛云短信服务有权不定期对本协议进行变更，并将变更的结果在生效前的至少7天内发布在本网站平上。您应当定期查阅本协议。如果您拒绝接受前述变更，您必须在前述7天内放弃使用本网站提供的本协议项下的相关服务；如您在前述7天期满后继续使用本协议项下的相关服务，则视为您同意七牛云短信服务对本协议的前述变更。\n\n# 保密条款\n\n本协议及本协议任何一方因协议的履行而获得或知悉的对方的任何资料和信息均视为保密信息，双方相互负有保密义务。任何一方未经对方书面同意，不可将上述保密信息以任何方式向第三方披露或用于本协议以外的其他事项，但法律、法规另有规定或监管部门另有要求的除外。 \n本保密条款将持续有效。本协议或其中任何条款的终止、中止、失效、无效均不影响本保密条款的效力。\n\n# 其他\n\n七牛云有权根据变化对该协议的部分服务条款进行改变。涉及到客户使用的变更会以邮件形式进行推送。\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的云短信短信业务授权书"
},
{
"from": "gpt",
"value": "[云短信](https://developer.qiniu.com/sms) > 使用文档 > 短信业务授权书\n\n# 短信业务授权书\n\n最近更新时间: 2024-08-23 17:32:23\n\n# **背景**\n\n如果用户 A 创建自用签名，签名归属主体属于用户 A ，则不涉及第三方权益。 \n当申请的签名与公司主体或账号主体信息不一致时，需要额外提交短信业务授权书。比如用户 A 替用户 B 创建签名，签名归属主体属于用户 B\n，则涉及第三方权益，需要 B 给予 A 的授权委托书。B 为授权方，A 为被授权方，并需要加盖 B 的公章。您可在这里下载授权书模板，进行填写盖章。 \n\n# **授权书下载**\n\n[点击下载授权书](https://dn-\nodum9helk.qbox.me/%E6%8E%88%E6%9D%83%E5%A7%94%E6%89%98%E4%B9%A620240822.docx) \n\n\n\n**注意：蓝色字体为提示，需去除后再填写相关内容**\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的云短信查询发送计费条数"
},
{
"from": "gpt",
"value": "[云短信](https://developer.qiniu.com/sms) > API 文档 > 查询发送计费条数\n\n# 查询发送计费条数\n\n最近更新时间: 2021-03-09 17:00:59\n\n# 接口介绍\n\n短信字数 ≤ 70 个字数，按照 70 个字数一条短信计算，短信字数 > 70 个字数，即为长短信，按照 67\n个字数记为一条短信计算，接口统计的为实际计费条数。\n\n# 请求定义\n\n \n \n GET /v1/user/statistics HTTP 1.1\n Host: sms.qiniuapi.com\n Authorization: \\<QiniuToken\\>\n Content-Type: application/x-www-form-urlencoded\n \n\n# 请求头\n\n> 请参考 [请求认证 __](https://developer.qiniu.com/sms/5842/sms-api-authentication)\n\n# 参数\n\n名称 | 必填 | 描述 \n---|---|--- \n`start` | 是 | 查询开始时间。格式：2006-01-02 \n`end` | 是 | 查询结束时间。格式：2006-01-02 \n`g` | 是 | 计量数据聚合粒度，支持： day, 5min \n`status` | 是 | 短信的状态，支持：“success”(发送成功), “failed”(发送失败), “sending”(发送中) \n \n# 请求示例\n\n> GET\n> https://sms.qiniuapi.com/v1/user/statistics?start=2021-01-01&end=2021-01-02&g=day&status=success\n\n# 响应定义\n\n该接口正确处理请求时返回如下 JSON 数据\n\n \n \n {\n \"data\": {\n \"marketing\": { // 营销短信统计\n \"times\": [\n 1609430400,\n ],\n \"values\": [\n 0,\n ]\n },\n \"notification\": { // 通知短信统计\n \"times\": [\n 1609430400,\n ],\n \"values\": [\n 0,\n ]\n },\n \"verification\": {// 验证码短信统计\n \"times\": [\n 1609430400,\n ],\n \"values\": [\n 0,\n ]\n },\n \"voice\": { // 语音短信统计\n \"times\": [\n 1609430400,\n ],\n \"values\": [\n 0,\n ]\n }\n }\n }\n \n\n说明： 通知短信和验证码短信会统一到 系统短信 计量计费\n\n出错是响应如下 JSON 数据：\n\n \n \n {\n \"error\": \"{error_type}\",\n \"message\": \"{error_message}\",\n \"request_id\": \"{request_id}\"\n }\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的云短信API简介"
},
{
"from": "gpt",
"value": "[云短信](https://developer.qiniu.com/sms) > API 文档 > API简介\n\n# API简介\n\n最近更新时间: 2019-05-14 15:29:25\n\n本文档为您展示短信服务所有可调用的 API 接口，详细接口信息请参考对应接口文档。\n\n服务域名： <https://sms.qiniuapi.com> \n接口鉴权：[请求认证](https://developer.qiniu.com/sms/api/5842/sms-api-authentication)\n\n接口 | 请求类型 | 说明 \n---|---|--- \n[v1/signature](https://developer.qiniu.com/sms/api/5844/sms-api-create-signature) | POST | 创建签名 \n[v1/signature](https://developer.qiniu.com/sms/api/5889/sms-api-query-signature) | GET | 查询签名 \n[v1/signature/:id](https://developer.qiniu.com/sms/api/5890/sms-api-edit-signature) | PUT | 编辑签名 \n[v1/signature/:id](https://developer.qiniu.com/sms/api/5891/sms-api-delete-signature) | DELETE | 删除签名 \n[v1/template](https://developer.qiniu.com/sms/api/5893/sms-api-create-template) | POST | 创建模板 \n[v1/template](https://developer.qiniu.com/sms/api/5894/sms-api-query-template) | GET | 查询模板 \n[v1/template](https://developer.qiniu.com/sms/api/5895/sms-api-edit-template) | UPDATE | 编辑模板 \n[v1/template](https://developer.qiniu.com/sms/api/5896/sms-api-delete-template) | DELETE | 删除模板 \n[v1/message](https://developer.qiniu.com/sms/api/5897/sms-api-send-message) | POST | 发送消息 \n \n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的云短信服务鉴权"
},
{
"from": "gpt",
"value": "[云短信](https://developer.qiniu.com/sms) > API 文档 > 服务鉴权\n\n# 服务鉴权\n\n最近更新时间: 2019-06-27 18:05:46\n\n# 请求认证 (Authentication)\n\n## API 服务域名：\n\n \n \n https://sms.qiniuapi.com\n \n\n每一个请求均需在 HTTP 请求头部增加一个 Authorization 字段，其值为符合管理凭证的字符串，形式如下：\n\n \n \n Authorization: <QiniuToken>\n \n\n`<QiniuToken>`: 管理凭证，用于鉴权。\n\n# 生成管理凭证：\n\n \n \n // golang\n \n // 构造待签名的 Data\n // 1. 添加 Path\n data = \"<Method> <Path>\"\n \n // 2. 添加 Query，前提: Query 存在且不为空\n if \"<RawQuery>\" != \"\" {\n data += \"?<RawQuery>\"\n }\n \n // 3. 添加 Host\n data += \"\\nHost: <Host>\"\n \n // 4. 添加 Content-Type，前提: Content-Type 存在且不为空\n if \"<Content-Type>\" != \"\" {\n data += \"\\nContent-Type: <Content-Type>\"\n }\n \n // 5. 添加回车\n data += \"\\n\\n\"\n \n // 6. 添加 Body，前提: Content-Length 存在且 Body 不为空，同时 Content-Type 存在且不为空或 \"application/octet-stream\"\n bodyOK := \"<Content-Length>\" != \"\" && \"<Body>\" != \"\"\n contentTypeOK := \"<Content-Type>\" != \"\" && \"<Content-Type>\" != \"application/octet-stream\"\n if bodyOK && contentTypeOK {\n data += \"<Body>\"\n }\n \n // 计算 HMAC-SHA1 签名，并对签名结果做 URL 安全的 Base64 编码\n sign = hmac_sha1(data, \"Your_Secret_Key\")\n encodedSign = urlsafe_base64_encode(sign)\n \n // 将 Qiniu 标识与 AccessKey、encodedSign 拼接得到管理凭证\n <QiniuToken> = \"Qiniu \" + \"Your_Access_Key\" + \":\" + encodedSign\n \n\n## 示例：\n\n \n \n GET /v1/message HTTP/1.1\n Host: sms.qiniuapi.com\n Authorization: Qiniu 7O7hf7Ld1RrC_fpZdFvU8aCgOPuhw2K4eapYOdII:PGTUV-oRxWAIl6mdneJPSJieyyQ=\n Content-Type: application/x-www-form-urlencoded\n Accept-Encoding: gzip\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的云短信创建签名"
},
{
"from": "gpt",
"value": "[云短信](https://developer.qiniu.com/sms) > API 文档 > 签名管理 >创建签名\n\n# 创建签名\n\n最近更新时间: 2019-07-18 10:41:08\n\n# 创建签名 (POST Signature)\n\n## 请求定义\n\n \n \n POST /v1/signature HTTP/1.1\n Host: sms.qiniuapi.com\n Authorization: <QiniuToken>\n Content-Type: application/json\n \n\n### 请求头\n\n> 请参考 [请求认证](https://developer.qiniu.com/sms/api/5842/sms-api-authentication)\n\n### 请求包\n\n \n \n {\n \"signature\": string,\n \"source\": string,\n \"pics\": []string\n }\n \n\n参数名称 | 类型 | 必填 | 说明 \n---|---|---|--- \nsignature | string | 是 | 签名 \nsource | string | 是 | 签名来源，申请签名时必须指定签名来源。取值范围为： \n\n * `enterprises_and_institutions` 企事业单位的全称或简称\n * `website` 工信部备案网站的全称或简称\n * `app` APP应用的全称或简称\n * `public_number_or_small_program` 公众号或小程序的全称或简称\n * `store_name` 电商平台店铺名的全称或简称\n * `trade_name` 商标名的全称或简称\n\n \npics | []string | 否 | 签名对应的资质证明图片进行 base64 编码格式转换后的字符串 \n \n## 响应定义\n\n### 该接口正确处理请求时返回如下 JSON 数据\n\n \n \n {\n \"signature_id\": <signature_id>\n }\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的云短信列出签名"
},
{
"from": "gpt",
"value": "[云短信](https://developer.qiniu.com/sms) > API 文档 > 签名管理 >列出签名\n\n# 列出签名\n\n最近更新时间: 2019-07-18 10:44:13\n\n# 查询签名 (GET Signature)\n\n## 请求定义\n\n \n \n GET /v1/signature HTTP/1.1\n Host: sms.qiniuapi.com\n Authorization: <QiniuToken>\n Content-Type: application/x-www-form-urlencoded\n \n\n### 请求头\n\n> 请参考 [请求认证](https://developer.qiniu.com/sms/api/5842/sms-api-authentication)\n\n### 请求参数\n\n该接口定义以下请求参数:\n\n名称 | 必填 | 描述 \n---|---|--- \naudit_status | 否 | 审核状态, 取值范围为: \"passed\"(通过), \"rejected\"(未通过), \"reviewing\"(审核中) \npage | 否 | 页码。默认为 1 \npage_size | 否 | 分页大小。默认为 20 \n \n## 响应定义\n\n### 该接口正确处理请求时返回如下 JSON 数据\n\n \n \n {\n \"items\": [{\n \"id\": string,\n \"signature\": string,\n \"source\": string,\n \"audit_status\": string,\n \"reject_reason\": string,\n \"created_at\": int64,\n \"updated_at\": int64\n }...],\n \"total\": int,\n \"page\": int,\n \"page_size\": int,\n }\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的云短信查询单个签名"
},
{
"from": "gpt",
"value": "[云短信](https://developer.qiniu.com/sms) > API 文档 > 签名管理 >查询单个签名\n\n# 查询单个签名\n\n最近更新时间: 2019-07-18 10:37:54\n\n# 查询单个签名信息\n\n## 请求定义\n\n \n \n GET /v1/signature/{id} HTTP/1.1\n Host: sms.qiniuapi.com\n Authorization: <QiniuToken>\n Content-Type: application/x-www-form-urlencoded\n \n\n### 请求头\n\n> 请参考 [请求认证](https://developer.qiniu.com/sms/api/5842/sms-api-authentication)\n\n### 请求参数\n\n该接口定义以下请求参数:\n\n参数名称 | 必填 | 描述 \n---|---|--- \nid | 是 | 签名ID信息 \n \n## 响应定义\n\n### 该接口正确处理请求时返回如下 JSON 数据\n\n \n \n {\n \"id\": string,\n \"signature\": string,\n \"source\": string,\n \"audit_status\": string,\n \"reject_reason\": string,\n \"created_at\": int64,\n \"updated_at\": int64\n }\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的云短信编辑签名"
},
{
"from": "gpt",
"value": "[云短信](https://developer.qiniu.com/sms) > API 文档 > 签名管理 >编辑签名\n\n# 编辑签名\n\n最近更新时间: 2019-07-18 10:44:34\n\n# 编辑签名 (PUT Signature)\n\n审核不通过的情况下才可以重新编辑签名，已经审核通过的签名无法重新编辑。\n\n## 请求定义\n\n \n \n PUT /v1/signature/:id HTTP/1.1\n Host: sms.qiniuapi.com\n Authorization: <QiniuToken>\n Content-Type: application/json\n \n\n### 请求头\n\n> 请参考 [请求认证](https://developer.qiniu.com/sms/api/5842/sms-api-authentication)\n\n### 请求数据\n\n该接口定义以下请求数据:\n\n \n \n {\n \"signature\": string\n }\n \n\n## 响应定义\n\n### 该接口正确处理请求时返回 HTTP 状态码\n\n * 服务器端正确处理请求时响应 HTTP 状态码 200\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的云短信删除签名"
},
{
"from": "gpt",
"value": "[云短信](https://developer.qiniu.com/sms) > API 文档 > 签名管理 >删除签名\n\n# 删除签名\n\n最近更新时间: 2019-07-18 10:45:14\n\n# 删除签名 (DELETE Signature)\n\n## 请求定义\n\n \n \n DELETE /v1/signature/:id HTTP/1.1\n Host: sms.qiniuapi.com\n Authorization: <QiniuToken>\n \n\n### 请求头\n\n> 请参考 [请求认证](https://developer.qiniu.com/sms/api/5842/sms-api-authentication)\n\n## 响应定义\n\n### 该接口正确处理请求时返回 HTTP 状态码\n\n * 服务器端正确处理请求时响应 HTTP 状态码为 200\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的云短信创建模板"
},
{
"from": "gpt",
"value": "[云短信](https://developer.qiniu.com/sms) > API 文档 > 模板管理 >创建模板\n\n# 创建模板\n\n最近更新时间: 2022-12-06 17:36:52\n\n# 创建模板 (POST Template)\n\n## 请求定义\n\n \n \n POST /v1/template HTTP/1.1\n Host: sms.qiniuapi.com\n Authorization: <QiniuToken>\n Content-Type: application/json\n \n\n### 请求头\n\n> 请参考 [请求认证](https://developer.qiniu.com/sms/api/5842/sms-api-authentication)\n\n### 请求数据\n\n \n \n {\n \"name\": string,\n \"template\": string,\n \"type\": string,\n \"description\": string,\n \"signature_id\": string,\n \"is_oversea\": bool\n }\n \n\n参数名称 | 类型 | 必填 | 说明 \n---|---|---|--- \nname | string | 是 | 模板名称 \ntemplate | string | 是 | 模板内容 可设置自定义变量，发送短信时候使用，参考:${code} \ntype | string | 是 | 模板类型，取值范围为: `notification` (通知类短信), `verification` (验证码短信), `marketing` (营销类短信), `voice`(语音类短信) \ndescription | string | 是 | 申请理由简述 \nsignature_id | string | 是 | 已经审核通过的签名 \nis_oversea | bool | 否 | 是否是 国际/港澳台 模版 \n \n### 模板示例\n\n类型 | 示例 \n---|--- \n验证码短信 | 1\\. 您的验证码是 ${code} （5分钟内有效） \n通知短信 | 1\\. 库存告急通知，商品：${title}，库存不足，当前库存数：${quantity} \n2\\. 主机告警，${ip} 当前磁盘剩余 ${ratio}，已使用 ${usage} GB，共计 ${total} GB \n营销短信 | 1\\. 没赶上618？七牛云年中大促，狂欢到月底！存储秒杀低至0.001元/G，云主机0元抢，另有多款产品5折起，每日限量购，手慢无！https://dwz.cn/VjNhsExH \n2\\. 汽油会员最高优惠1元，会员日汽油最高优惠1.2元！每周四周日会员日享更多优惠，详情请到站咨询! \n \n## 响应定义\n\n### 该接口正确处理请求时返回如下 JSON 数据\n\n \n \n {\n \t\t\"template_id\": string\n }\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的云短信列出模板"
},
{
"from": "gpt",
"value": "[云短信](https://developer.qiniu.com/sms) > API 文档 > 模板管理 >列出模板\n\n# 列出模板\n\n最近更新时间: 2019-07-18 10:46:11\n\n# 查询模板 (GET Template)\n\n## 请求定义\n\n \n \n GET /v1/template HTTP/1.1\n Host: sms.qiniuapi.com\n Authorization: <QiniuToken>\n Content-Type: application/x-www-form-urlencoded\n \n\n### 请求头\n\n> 请参考 [请求认证](https://developer.qiniu.com/sms/api/5842/sms-api-authentication)\n\n### 请求参数\n\n该接口定义以下请求参数:\n\n参数名称 | 必填 | 描述 \n---|---|--- \naudit_status | 否 | 审核状态, 取值范围为: `passed` (通过), `rejected` (未通过), `reviewing` (审核中) \npage | 否 | 页码。默认为 1 \npage_size | 否 | 分页大小。默认为 20 \n \n## 响应定义\n\n### 该接口正确处理请求时返回如下 JSON 数据\n\n \n \n {\n \"items\": [{\n \"id\": string,\n \"name\": string,\n \"template\": string,\n \"audit_status\": string,\n \"reject_reason\": string,\n \"type\": string,\n \"signature_id\": string, // 模版绑定的签名ID\n \"signature_text\": string, // 模版绑定的签名内容\n \"created_at\": int64,\n \"updated_at\": int64\n }...],\n \"total\": int,\n \"page\": int,\n \"page_size\": int\n \n }\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的云短信查询单个模版"
},
{
"from": "gpt",
"value": "[云短信](https://developer.qiniu.com/sms) > API 文档 > 模板管理 >查询单个模版\n\n# 查询单个模版\n\n最近更新时间: 2019-07-16 20:20:29\n\n# 查询单个模版信息\n\n## 请求定义\n\n \n \n GET /v1/template/{id} HTTP/1.1\n Host: sms.qiniuapi.com\n Authorization: <QiniuToken>\n Content-Type: application/x-www-form-urlencoded\n \n\n### 请求头\n\n> 请参考 [请求认证](https://developer.qiniu.com/sms/api/5842/sms-api-authentication)\n\n### 请求参数\n\n该接口定义以下请求参数:\n\n参数名称 | 必填 | 描述 \n---|---|--- \nid | 是 | 模版ID信息 \n \n## 响应定义\n\n### 该接口正确处理请求时返回如下 JSON 数据\n\n \n \n {\n \"id\": string,\n \"name\": string,\n \"template\": string,\n \"audit_status\": string,\n \"reject_reason\": string,\n \"type\": string,\n \"signature_id\": string, // 模版绑定的签名ID\n \"signature_text\": string, // 模版绑定的签名内容\n \"created_at\": int64,\n \"updated_at\": int64 \n }\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的云短信编辑模板"
},
{
"from": "gpt",
"value": "[云短信](https://developer.qiniu.com/sms) > API 文档 > 模板管理 >编辑模板\n\n# 编辑模板\n\n最近更新时间: 2019-07-18 10:52:37\n\n# 编辑模板 (PUT Template)\n\n审核不通过的情况下才可以重新编辑模板，已经审核通过的模板无法重新编辑。\n\n## 请求定义\n\n \n \n PUT /v1/template/:id HTTP/1.1\n Host: sms.qiniuapi.com\n Authorization: <QiniuToken>\n Content-Type: application/json\n \n\n### 请求头\n\n> 请参考 [请求认证](https://developer.qiniu.com/sms/api/5842/sms-api-authentication)\n\n### 请求数据\n\n该接口定义以下请求数据:\n\n \n \n {\n \"name\": string,\n \"template\": string,\n \"description\": string,\n \"signature_id\": string\n }\n \n\n参数名称 | 类型 | 必填 | 说明 \n---|---|---|--- \nname | string | 是 | 模板名称 \ntemplate | string | 是 | 模板内容 \ndescription | string | 是 | 申请理由简述 \nsignature_id | string | 是 | 已经审核通过的签名 \n \n## 响应定义\n\n### 该接口正确处理请求时返回 HTTP 状态码\n\n * 服务器端正确处理请求时响应 HTTP 状态码 200\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的云短信删除模板"
},
{
"from": "gpt",
"value": "[云短信](https://developer.qiniu.com/sms) > API 文档 > 模板管理 >删除模板\n\n# 删除模板\n\n最近更新时间: 2019-07-18 10:52:50\n\n# 删除模板 (DELETE Template)\n\n## 请求定义\n\n \n \n DELETE /v1/template/:id HTTP/1.1\n Host: sms.qiniuapi.com\n Authorization: <QiniuToken>\n \n\n### 请求头\n\n> 请参考 [请求认证](https://developer.qiniu.com/sms/api/5842/sms-api-authentication)\n\n## 响应定义\n\n### 该接口正确处理请求时返回 HTTP 状态码\n\n * 服务端正确处理请求时响应 HTTP 状态码 200\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的云短信发送短信"
},
{
"from": "gpt",
"value": "[云短信](https://developer.qiniu.com/sms) > API 文档 > 发送短信\n\n# 发送短信\n\n最近更新时间: 2023-06-26 10:16:44\n\n# 发送短信 (POST Message)\n\n## 请求定义\n\n \n \n POST /v1/message HTTP/1.1\n Host: sms.qiniuapi.com\n Authorization: <QiniuToken>\n Content-Type: application/json\n \n\n### 请求头\n\n> 请参考 [请求认证](https://developer.qiniu.com/sms/api/5842/sms-api-authentication)\n\n### 请求数据\n\n> 该接口定义以下请求数据:\n \n \n {\n \"signature_id\": string,\n \"template_id\": string,\n \"mobiles\": []string,\n \"parameters\": map[string]string|number,\n \"seq\": string\n \n }\n \n\n参数名称 | 类型 | 必填 | 说明 \n---|---|---|--- \nsignature_id | string | 否 | 签名ID，如果模板是未绑定签名的，可以发送时指定签名ID。 \ntemplate_id | string | 是 | 模板 ID \nmobiles | []string | 是 | 手机号 \nparameters | map[string]string | 否 | 自定义模板变量，变量设置在创建模板时，参数template指定 \nseq | string | 否 | 业务方提供的消息序列号，状态回调时携带回来 \n \n注意：传递的变量参数不支持中文，请使用英语或数字。\n\n## 响应定义\n\n### 该接口正确处理请求时返回如下 JSON 数据\n\n \n \n {\n \"job_id\": string\n }\n \n\n# 发送单条短信 (POST Single Message)\n\n## 请求定义\n\n \n \n POST /v1/message/single HTTP/1.1\n Host: sms.qiniuapi.com\n Authorization: <QiniuToken>\n Content-Type: application/json\n \n\n### 请求头\n\n> 请参考 [请求认证](https://developer.qiniu.com/sms/api/5842/sms-api-authentication)\n\n### 请求数据\n\n> 该接口定义以下请求数据:\n \n \n {\n \"signature_id\": string,\n \"template_id\": string,\n \"mobile\": string,\n \"parameters\": map[string]string|number,\n \"seq\": string\n }\n \n\n参数名称 | 类型 | 必填 | 说明 \n---|---|---|--- \nsignature_id | string | 否 | 签名ID，如果模板是未绑定签名的，可以发送时指定签名ID。 \ntemplate_id | string | 是 | 模板 ID \nmobile | string | 是 | 手机号 \nparameters | map[string]string | 否 | 自定义魔法变量，变量设置在创建模板时，参数template指定 \nseq | string | 否 | 业务方提供的消息序列号，状态回调时携带回来 \n \n## 响应定义\n\n### 该接口正确处理请求时返回如下 JSON 数据\n\n \n \n {\n \"message_id\": string\n }\n \n\n# 发送国际/港澳台短信 (POST Oversea Message)\n\n## 请求定义\n\n \n \n POST /v1/message/oversea HTTP/1.1\n Host: sms.qiniuapi.com\n Authorization: <QiniuToken>\n Content-Type: application/json\n \n\n### 请求头\n\n> 请参考 [请求认证](https://developer.qiniu.com/sms/api/5842/sms-api-authentication)\n\n### 请求数据\n\n> 该接口定义以下请求数据:\n \n \n {\n \"signature_id\": string,\n \"template_id\": string,\n \"mobile\": string,\n \"parameters\": map[string]string|number\n }\n \n\n参数名称 | 类型 | 必填 | 说明 \n---|---|---|--- \nsignature_id | string | 否 | 签名ID，如果模板是未绑定签名的，可以发送时指定签名ID。 \ntemplate_id | string | 是 | 模板 ID \nmobile | string | 是 | 手机号，例如：+17245678901 \nparameters | map[string]string | 否 | 自定义魔法变量，变量设置在创建模板时，参数template指定 \n \n## 响应定义\n\n### 该接口正确处理请求时返回如下 JSON 数据\n\n \n \n {\n \"message_id\": string\n }\n \n\n# 发送全文本短信(不需要传模版 ID) (POST Fulltext Message)\n\n## 请求定义\n\n \n \n POST /v1/message/fulltext HTTP/1.1\n Host: sms.qiniuapi.com\n Authorization: <QiniuToken>\n Content-Type: application/json\n \n\n### 请求头\n\n> 请参考 [请求认证](https://developer.qiniu.com/sms/api/5842/sms-api-authentication)\n\n### 请求数据\n\n> 该接口定义以下请求数据:\n \n \n {\n \"mobiles\": []string,\n \"content\": string,\n \"template_type\": string,\n \"seq\": string\n }\n \n\n参数名称 | 类型 | 必填 | 说明 \n---|---|---|--- \nmobiles | []string | 是 | 手机号 \ncontent | string | 是 | 短信内容，必须是已经审核通过的签名和模版。例如：`【七牛云】您的验证码是 287712，5分钟内有效` \ntemplate_type | string | 是 | 短信类型，支持的值：`notification`(通知类)、`verification`(验证码类)、`marketing`(营销推广类)、`voice`(语音类)、`logistics`(物流类) \nseq | string | 否 | 业务方提供的消息序列号，状态回调时携带回来 \n \n## 响应定义\n\n### 该接口正确处理请求时返回如下 JSON 数据\n\n \n \n {\n \"job_id\": string\n }\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的云短信发送国际/港澳台短信"
},
{
"from": "gpt",
"value": "[云短信](https://developer.qiniu.com/sms) > API 文档 > 发送国际/港澳台短信\n\n# 发送国际/港澳台短信\n\n最近更新时间: 2022-10-10 11:18:33\n\n# 发送国际/港澳台短信 (POST Oversea Message)\n\n## 请求定义\n\n \n \n POST /v1/message/oversea HTTP/1.1\n Host: sms.qiniuapi.com\n Authorization: <QiniuToken>\n Content-Type: application/json\n \n\n### 请求头\n\n> 请参考 [请求认证](https://developer.qiniu.com/sms/api/5842/sms-api-authentication)\n\n### 请求数据\n\n> 该接口定义以下请求数据:\n \n \n {\n \"template_id\": string,\n \"mobiles\": []string,\n \"parameters\": map[string]string|number,\n \"sender_id\": string\n }\n \n\n参数名称 | 类型 | 必填 | 说明 \n---|---|---|--- \ntemplate_id | string | 是 | 模板 ID \nmobiles | []string | 是 | 手机号列表，例如：[\"+17245678901\", “+17245678902”] \nparameters | map[string]string | 否 | 自定义魔法变量，变量设置在创建模板时，参数template指定 \nsender_id | string | 否 | SenderID，用于在国际短信中标识发送者 \n \n## 响应定义\n\n### 该接口正确处理请求时返回如下 JSON 数据\n\n \n \n {\n \"message_id\": string\n }\n \n\n# 全文发送国际/港澳台短信 (POST Oversea Fulltext Message)\n\n## 请求定义\n\n \n \n POST /v1/message/oversea_fulltext HTTP/1.1\n Host: sms.qiniuapi.com\n Authorization: <QiniuToken>\n Content-Type: application/json\n \n\n### 请求头\n\n> 请参考 [请求认证](https://developer.qiniu.com/sms/api/5842/sms-api-authentication)\n\n### 请求数据\n\n> 该接口定义以下请求数据:\n \n \n {\n \"content\": string,\n \"mobiles\": []string,\n \"template_type\": string,\n \"sender_id\": string\n }\n \n\n参数名称 | 类型 | 必填 | 说明 \n---|---|---|--- \ncontent | string | 是 | 消息内容 \nmobiles | []string | 是 | 手机号列表，例如：[\"+17245678901\", “+17245678901”] \ntemplate_type | string | 否 | 短信类型，支持的值：notification(通知类)、verification(验证码类)、marketing(营销推广类)、voice(语音类) \nsender_id | string | 否 | SenderID，用于在国际短信中标识发送者 \n \n## 响应定义\n\n### 该接口正确处理请求时返回如下 JSON 数据\n\n \n \n {\n \"message_id\": string\n }\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的云短信查询发送记录"
},
{
"from": "gpt",
"value": "[云短信](https://developer.qiniu.com/sms) > API 文档 > 查询发送记录\n\n# 查询发送记录\n\n最近更新时间: 2020-08-25 10:35:28\n\n# 查询短信发送记录\n\n## 请求定义\n\n \n \n GET /v1/messages HTTP/1.1\n Host: sms.qiniuapi.com\n Authorization: <QiniuToken>\n Content-Type: application/x-www-form-urlencoded\n \n\n### 请求头\n\n> 请参考 [请求认证](https://developer.qiniu.com/sms/api/5842/sms-api-authentication)\n\n### 请求参数\n\n该接口定义以下请求参数:\n\n名称 | 必填 | 描述 \n---|---|--- \njob_id | 否 | 发送任务返回的 id \nmessage_id | 否 | 单条短信发送接口返回的 id \nmobile | 否 | 接收短信的手机号码 \nstatus | 否 | 短信的状态，sending: 发送中，success: 发送成功，failed: 发送失败，waiting: 等待发送 \ntemplate_id | 否 | 模版 id \ntype | 否 | 短信类型，marketing: 营销短信，notification: 通知短信，verification: 验证码类短信，voice: 语音短信 \nstart | 否 | 开始时间，timestamp，例如: 1563280448 \nend | 否 | 结束时间，timestamp，例如: 1563280471 \npage | 否 | 页码，默认为 1 \npage_size | 否 | 每页返回的数据条数，默认20，最大200 \n \n## 响应定义\n\n### 该接口正确处理请求时返回如下 JSON 数据\n\n \n \n {\n \"page\": int,\n \"page_size\": int,\n \"items\":[{\n \"message_id\": string,\n \"job_id\": string,\n \"mobile\": string,\n \"content\": string,\n \"status\": string,\n \"type\": string,\n \"error\": string, // 短信发送失败详细状态信息\n \"count\": int, // 发送的短信条数\n \"created_at\": timestamp, // 短信发送时间\n \"delivrd_at\": timestamp // 如果短信发送失败，那么不会返回这个字段\n }...]\n }\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的云短信错误定义"
},
{
"from": "gpt",
"value": "[云短信](https://developer.qiniu.com/sms) > API 文档 > 错误定义\n\n# 错误定义\n\n最近更新时间: 2020-09-23 10:54:08\n\n# API 错误码\n\n### 数据格式\n\n当错误发生时，Qiniu SMS Service 服务返回如下 JSON 数据:\n\n \n \n {\n \"error\": \"NoSuchObject\",\n \"message\": \"The specified object does not exist.\",\n \"request_id\": \"uZyOLgh5jN-_DJ8V\"\n }\n \n\n * HTTP Status Code: 3xx, 4xx or 5xx\n * Content-Type: application/json\n\n### JSON 数据字段定义如下\n\n名称 | 类型 | 描述 \n---|---|--- \nerror | string | 错误码 \nmessage | string | 错误信息 \nrequest_id | string | 错误对应的请求唯一 ID，在您提交工单时，请提供 `request_id` \n \n### 错误列表\n\n错误码 | 错误信息描述 \n---|--- \nServerInternalError | 发生了内部错误。重试您的请求，但如果问题仍然存在，请[提交工单](https://support.qiniu.com/tickets/new/)。 \nInvalidQueryValue | 无效查询。 \nMalformedJSON | JSON 格式不正确。 \nNotFoundError | 未找到. \nFreezedUserError | 您的账户被冻结了。请联系您的销售。 \nInactivatedUseError | 您的帐户没有开通短信服务，请[提交工单](https://support.qiniu.com/tickets/new/)或者联系您的销售。 \nAccountNeedCertified | 您的帐户需要认证。 \nAccountBalanceNotEnough | 您的账户余额不足。 \n \n# 短信发送状态回执错误码\n\n调用接口成功后，运营商会异步返回短信发送状态码。 \n短信发送状态回执错误码如下：\n\n错误码 | 错误信息 \n---|--- \n1 | 空号 \n5 | 号码问题，停机状态 \n8, 9, 22 | 同一手机号在限定时间内重复提交相同的内容超过限定次数 \n10 | 手机号防骚扰名单过滤 \n12 | 空号、停机 \n17, 43 | 24小时内同一手机号发送次数超过限制 \n20 | 不支持的国家地区 \n28 | 运营商错误 \n11 | 发送失败，请提交工单查询详细错误信息 \n13 | 发送失败，号码问题 \n45 | 网关黑名单失败 \n48 | 参数长度超过限制 \n61 | 超流量 \n86 | 运营商黑名单 客户投诉可能 \n601 | 黑名单 \n640 | 一般空号停机的 \n908 | 超过每日限制，单号码 24 小时内只能发送 1 条推广短信 \n998 | 可提交工单 \n1028 | 模板类型错误、或提交号码未达产品数量/无对应产品 \n1052 | 虚拟号码，无效计费条数,号码不规则 \n9403 | 黑名单 \n9419 | 超频 \n9441 | 超频 \n300040 | 超单号码日峰值 \nXA:0001 | 驳回失败 \nXA:0002 | 触发黑签名 \nXA:0003 | 签名未报备 \nXA:0004 | 触发自动屏蔽词 \nXA:0005 | 触发 SMG 自动屏蔽词 \nXA:0100 | 24 小时内的重号过滤 \nXA:0101 | 白名单重号过滤 \nXA:0107 | 重号过滤 7 天 \nXA:0130 | 重号过滤 30 天 \nXA:0138 | 触发大黑名单 \nXA:0139 | 触发系统黑名单 \nXA:0140 | 触发系统屏蔽地区 \nXA:2001 | 非用户白名单 \nXA:2002 | 非用户短信模板 \nXA:2003 | 内容没签名 \nXA:2004 | 签名位置不正确 \nXA:2006 | 用户余额不足 \nXA:2139 | 触发用户黑名单 \nXA:2112 | 用户通道地区屏蔽 \nXA:2138 | 触发全量用户黑名单 \nXA:2140 | 触发用户屏蔽地区 \nXA:2007 | 触发用户自动屏蔽词 \nXREJECT | 网关不支持 \nXA:2040 | 触发屏蔽地区 \nXA:2042 | 没有产品 \nXA:2043 | 没有有效通道 \nDELIVRD | 消息发送成功 \nEXPIRED | 因为用户长时间关机或者不在服务区等导致的短消息超时没有递交到用户手机上 \nREJECTD | 消息因为某些原因被拒绝 \nUNDELIV | 全球通用户因为状态不正确如处于停机、挂起等状态而导致用户无法接收到短信 \nUNKNOWN | Message is in invalid state \nNOROUTE | 空号 \nCA:0051 | 尚未建立连接 \nCA:0052 | 尚未成功登录 \nCA:0054 | 超时未接收到响应消息 \nCA:0111 | SCP厂家自定义的错误码 \nCB:0001 | 非神州行预付费用户,号码无效或者空号 \nCB:0005 | PPS用户状态异常（包括未头次使用、储值卡被封锁、储值卡进入保留期、储值卡挂失）,移动用户帐户数据异常 \nCB:0007 | 用户余额不足,不能扣费，影响包月话单,连续两个月扣费不成功 \nCB:0016 | 参数错误 \nCB:0018 | 重复发送消息序列号 msgid 相同的计费请求消息 \nCB:0022 | SCP 互联失败 \nCB:0047 | 过期用户或者用户不支持梦网业务 \nCB:0053 | 梦网用户不存在,号码无效或者空号 \nCE:0211 | 网关拦截词 \nDA:0054 | 超时未接收到响应消息 \nDB:0101 | 手机号码错误,号码无效或者空号,清除订购关系 \nDB:0102 | 用户停机,用户已经停机,若连续两个月停机，清除订购关系 \nDB:0103 | 用户欠费 \nDB:0104 | 用户没有使用该业务的权限 \nDB:0105 | 业务代码错误 \nDB:0106 | 服务代码错误 \nDB:0107 | 业务不存在,多用于点播业务鉴权,程序检查 LinkID，业务代码是否正确 \nDB:0108 | 该业务暂停服务 \nDB:0109 | 该服务种类不存在 \nDB:0110 | 该服务种类尚未开通 \nDB:0111 | 该业务尚未开通 \nDB:0112 | SP 代码错误 \nDB:0113 | SP 不存在 \nDB:0114 | SP 暂停服务 \nDB:0115 | 用户没有订购该业务 \nDB:0116 | 用户暂停订购该业务 \nDB:0117 | 该业务不能对该用户开放 \nDB:0118 | 用户已经订购了该业务 \nDB:0119 | 用户不能取消该业务 \nDB:0120 | 话单格式错误 \nDB:0121 | 没有该类业务 \nDB:0122 | 接收异常 \nDB:0123 | 业务价格为负 \nDB:0124 | 业务价格格式错误 \nDB:0125 | 业务价格超出范围 \nDB:0126 | 该用户不是神州行用户 \nDB:0127 | 该用户没有足够的余额 \nDB:0128 | 补款,冲正失败 \nDB:0129 | 用户已经是梦网用户 \nDB:0130 | 用户在 BOSS 中没有相关用户数据 \nDB:0131 | BOSS 系统数据同步出错 \nDB:0132 | 相关信息不存在 \nDB:0133 | 用户数据同步出错 \nDB:0134 | SP 数据同步出错 \nDB:0135 | 业务数据同步出错 \nDB:0136 | 用户密码错误 \nDB:0137 | 伪码信息错误 \nDB:0138 | 用户相关信息不存在 \nDB:0139 | 黑名单 \nDB:0140 | 用户未点播该业务 \nDB:0141 | 因投诉被移动屏蔽 \nDB:1150 | 空号 \nDB:9001 | 网络异常 \nDB:9007 | 业务网关超过限制的流量 \nDB00140 | 网关黑名单 \nF2013 | 号码异常 \nIB:0008 | 流量控制错 \nIB:0009 | 前转判断错误 \nIB:0070 | 网络断连或者目的设备关闭端口 \nIB:0079 | 业务代码错误 \nID:0020 | SPACE 用户鉴权模块鉴权用户停机或欠费错误 \nID:0021 | SPACE 用户鉴权模块：用户销户错误 \nID:0076 | 网关拦截词 \nMA:0006 | 网关拦截可提交工单调整后重试 \nMA:0002 | 网关 黑名单，请提交工单处理 \nMA:0051 | 尚未建立连接 \nMA:0054 | 超时未接收到响应消息 \nMA:0036 | 手机终端问题，可尝试重启 \nMA:0191 | SMSC 厂家自定义的错误码 \nMB:0020 | 无效的 SYSTEMID \nMB:0065 | 目的地址错误 \nMB:0066 | 无效的定时时间 \nMB:0145 | SMSC 厂家自定义的错误码 \nMB:0147 | SMSC 厂家自定义的错误码 \nMB:0192 | SMSC 厂家自定义的错误码 \nMB:0193 | SMSC 厂家自定义的错误码 \nMB:0241 | SMSC 厂家自定义的错误码 \nMB:0244 | SMSC 厂家自定义的错误码 \nMI:0010 | 关机、停机 \nMI:0013 | 停机 \nMI:0024 | 关机、停机 \nMI:0029 | 关机、不在服务区 \nMI:0075 | 关机、不在服务区 \nMK:0000 | 空号、停机 \nMK:0001 | 空号、停机 \nMK:0002 | 关机、无法接通 \nMK:0004 | 暂停使用 \nMK:0005 | 停机、号码失效 \nMK:0006 | 停机、号码失效 \nMK:0008 | 用户不在服务区 \nMK:0009 | 用户不在服务区 \nMK:0010 | 停机 \nMK:0011 | 关机 \nMK:0013 | 停机 \nMK:0014 | 停机 \nMK:0017 | 收件箱信息满 \nMK:0023 | 无法接通 \nMK:0024 | 空号、关机 \nMK:0029 | 无法接通 \nMK:0057 | 关机 \nMK:0063 | 无法接通、空号 \nMK:0075 | 空号、无法接通 \nMN:0001 | 空号、携号转网 \nMN:0011 | 停机 \nMN:0013 | 无法接通 \nMX:0013 | 网关黑名单 \nMN:0029 | 关机 \nMN:0053 | 关机 \nIB:0011 | 外省网关数据不同步 \nMK:0012 | 空号、关机 \nMN:0000 | 空号、关机 \nMK:0036 | 空号、关机 \nID:1241 | SMMC 校验失败 \nDA:0051 | 尚未建立连接 \nDA:0052 | 尚未成功登录 \nDA:0053 | 发送消息失败 \nDA:0054 | 超时未接收到响应消息 \nDB:0000 | 正确 \nDB:0001 | 消息结构错 \nDB:0002 | 非法源地址 \nDB:0003 | 认证错 \nDB:0004 | 版本太高 \nDB:0005 | 命令字错 \nDB:0006 | 消息序号重复 \nDB:0007 | 消息长度错 \nDB:0008 | 资费代码错 \nDB:0009 | 超过最大信息长 \nDB:0010 | 流量控制错 \nDB:0100 | 手机号码不存在 \nDB:0101 | 手机号码错误 \nDB:0102 | 用户停机 用户停机用户冲值后，要主动上行一条信息到SP，才能激活用户的短信接收服务 \nDB:0103 | 用户欠费 \nDB:0104 | 用户没有使用该业务的权限 \nDB:0105 | 业务代码错误 \nDB:0106 | 服务代码错误 \nDB:0107 | 业务不存在 \nDB:0108 | 该业务暂停服务 \nDB:0109 | 该服务种类不存在 \nDB:0110 | 该服务种类尚未开通 \nDB:0111 | 该业务尚未开通 \nDB:0112 | EC/SI代码错误 \nDB:0113 | EC/SI不存在 \nDB:0114 | EC/SI暂停服务 \nDB:0115 | 用户没有签约该业务 \nDB:0116 | 用户暂停签约该业务 \nDB:0117 | 该业务不能对该用户开放 \nDB:0118 | 用户已经签约了该业务 \nDB:0119 | 用户不能取消该业务 \nDB:0120 | 话单格式错误 \nDB:0121 | 没有该类业务 \nDB:0122 | 接收异常 \nDB:0123 | 业务价格为负 \nDB:0124 | 业务价格格式错误 \nDB:0125 | 业务价格超出范围 \nDB:0126 | 该用户不是神州行用户 \nDB:0127 | 该用户没有足够的余额 \nDB:0128:补款 | 冲正失败 \nDB:0129 | 用户已经是梦网用户 \nDB:0131 | BOSS系统数据同步出错 \nDB:0132 | 相关信息不存在 \nDB:0133 | 用户数据同步出错 \nDB:0134 | SP数据同步出错 \nDB:0135 | 业务数据同步出错 \nDB:0136 | 用户密码错误 \nDB:0137 | 伪码信息错误 \nDB:0138 | 用户相关信息不存在 \nDB:0139 | 下发时间段违法 \nDB:0140 | 用户不在白名单中 用户未点播该业务 \nDB:0141 | 用户处在黑名单中 \nDB:0142 | 超过日最大发送MT数量 \nDB:0143 | 超过月最大发送MT数量 \nDB:0144 | 用户在全局黑名单中 \nDB:0145 | 用户在EC黑名单中 \nDB:0146 | 用户在SI黑名单中 \nDB:0147 | 用户未点播该业务 \nDB:0150 | 等M模块应答消息超时 \nDB:0151 | 正文签名失败 \nDB:0152 | BOSS同步鉴权错误 \nDB:0153 | 信用度错误 \nDB:0154 | MServer是断开状态 \nDB:0155 | 不支持的承载模式 \nDB:0156 | WAPPush消息格式检查错误 \nDB:0500 | 磁盘读写错误 \nDB:0501 | 网络链接异常 \nDB:0502 | 网络故障 \nDB:0503 | LICENSE不合法 \nDB:0504 | 已超过LICENSE限定数量 \nDB:0505 | 系统内部错误 \nDB:0506 | 数据库错误 \nDB:9001 | 网络异常 \nDB:9007 | 业务网关超过限制的流量 \nIA:0051 | 尚未建立连接 \nIA:0052 | 尚未成功登录 \nIA:0053 | 发送消息失败 \nIA:0054 | 超时未接收到响应消息 \nIC:0001 | SMSC没有给本网关回状态报告 \nIC:0151 | SMSC没有给本网关回状态报告 \nID:0000 | 正确 \nID:0001 | 消息结构错误。 \nID:0002 | 命令字错误，或非法源地址 \nID:0003 | 消息序列号重复。或认证错 \nID:0004 | 消息长度错误。或版本太高 \nID:0005 | 资费代码错误。 \nID:0006 | 超过最大信息长度。 \nID:0007 | 业务代码错误。 \nID:0008 | 流量控制错误。 \nID:0009 | infoX-SMS GW不负责此计费号码。 \nID:0010 | Src_ID错误。 \nID:0011 | Msg_src错误。 \nID:0012 | 计费地址错误。 \nID:0013 | 目的地址错误。 \nID:0014 | 禁止发送WAP PUSH消息。 \nID:0020 | MDSP用户鉴权模块，鉴权用户停机或欠费错误。 \nID:0021 | MDSP用户鉴权模块，用户销户错误。 \nID:0043 | 禁止向异网发送消息。 \nID:0044 | 消息发送不在有效时间段内。 \nID:0045 | 超出每月最大发送量。 \nID:0046 | 超出每日最大发送量 \nID:0047 | 超出每月最大群发次数 \nID:0048 | 超出每日最大群发次数 \nID:0049 | 超出单次最大群发量 \nID:0051 | 尚未建立连接。 \nID:0052 | 尚未成功登录。 \nID:0053 | 发送消息失败。 \nID:0054 | 超时，未接收到响应消息。 \nID:0055 | 等待状态报告超时。 \nID:0056 | 用户鉴权时，用户状态不正常。 \nID:0061 | 有效时间已经过期。 \nID:0062 | 定时发送时间已经过期。 \nID:0063 | 不能识别的FeeType。 \nID:0064 | 发送服务源地址鉴权失败。 \nID:0065 | 发送服务目的地址鉴权失败。 \nID:0066 | 接收服务源地址鉴权失败。 \nID:0067 | 接收服务目的地址鉴权失败。 \nID:0068 | 用户鉴权失败。 \nID:0069 | 此用户为黑名单用户。 \nID:0070 | 网络断连或目的设备关闭接口。 \nID:0071 | 超过最大节点数。 \nID:0072 | 找不到路由。 \nID:0073 | 等待应答超时。 \nID:0074 | 送SCP失败。 \nID:0075 | 送SCP鉴权等待应答超时。 \nID:0076 | 信息安全鉴权失败。 \nID:0077 | 超过最大Submit提交数。 \nID:0078 | SPID为空。 \nID:0079 | 业务类型为空。 \nID:0080 | CPCode错误。 \nID:0081 | 发送接收接口重复。 \nID:0082 | 循环路由。 \nID:0083 | 短消息内容超过了接收侧的最大长度。 \nID:0084 | 网关向MDSP重发鉴权消息失败。 \nID:0085 | 因MDSP系统忙，网关重发鉴权消息。 \nID:0086 | 因MDSP系统忙，且缓存满，网关重发鉴权消息。 \nID:0087 | 因MDSP流控，网关重发鉴权消息。 \nID:0088 | 等MDSP应答超时，网关重发鉴权消息。 \nID:0089 | 到MDSP鉴权时，网关构造等待应答实体失败。 \nID:0096 | 此用户为发送者黑名单用户。 \nID:0097 | 此用户为接收者黑名单用户。 \nID:0100 | 手机号码不存在 \nID:0101 | 手机号码错误 \nID:0102 | 用户停机 \nID:0103 | 用户欠费 \nID:0104 | 用户没有使用该业务的权限 \nID:0105 | 业务代码错误 \nID:0106 | 服务代码错误 \nID:0107 | 业务不存在 \nID:0108 | 该业务暂停服务 \nID:0109 | 该服务种类不存在 \nID:0110 | 该服务种类尚未开通 \nID:0111 | 增加企业实名签名，消息内容超长。 \nID:0112 | EC/SI代码错误 \nID:0113 | EC/SI不存在 \nID:0114 | EC/SI暂停服务 \nID:0115 | 用户没有签约该业务 \nID:0116 | 用户暂停签约该业务 \nID:0117 | 该业务不能对该用户开放 \nID:0118 | 用户已经签约了该业务 \nID:0119 | 用户不能取消该业务 \nID:0120 | 话单格式错误 \nID:0121 | 没有该类业务 \nID:0122 | 接收异常 \nID:0123 | 业务价格为负 \nID:0124 | 业务价格格式错误 \nID:0125 | 业务价格超出范围 \nID:0126 | 该用户不是神州行用户 \nID:0127 | 该用户没有足够的余额 \nID:0128: | 补款，冲正失败 \nID:0129 | 用户已经是梦网用户 \nID:0131 | BOSS系统数据同步出错 \nID:0132 | 相关信息不存在 \nID:0133 | 用户数据同步出错 \nID:0134 | EC/SI数据同步出错 \nID:0135 | 业务数据同步出错 \nID:0136 | 用户密码错误 \nID:0137 | 伪码信息错误 \nID:0138 | 用户相关信息不存在 \nID:0139 | 下发时间段违法 \nID:0140 | 用户不在白名单中 \nID:0141 | 用户处在黑名单中 \nID:0142 | 超过日最大发送MT数量 \nID:0143 | 超过月最大发送MT数量 \nID:0310 | 消息过期 \nID:0311 | 流量控制错 \nID:0312 | 优先级设置错 \nID:0313 | 业务验证错 \nID:0314 | 实名替换错 \nID:0315 | 费率设置错 \nID:0317 | 操作/验证失败 \nID:0318 | 关键字过滤失败 \nID:1240 | SMMC校验失败 \nID:1241 | SMMC校验失败 \nID:1242 | SMMC校验失败 \nID:1243 | SMWC 校验失败 \nID:1244 | SMWC 校验失败 \nID:1245 | SMWC 校验失败 \nID:1246 | SMWC 校验失败 \nID:1247 | SMWC 校验失败 \nID:1248 | SMWC 校验失败 \nID:1249 | SMWC 校验失败 \nID:1250 | SMWC 校验失败 \nID:1251 | SMWC 校验失败 \nID:6150 | 在发送队列中过期 \nID:6151 | 等待应答过期 \nID:6152 | 发送失败 \nID:6153 | 发送无应答失败 \nMA:0051 | 尚未建立连接 \nMA:0052 | 尚未成功登录 \nMA:0053 | 发送消息失败 \nMA:0054 | 超时未接收到响应消息 \nMB:0000 | 成功。 \nMB:0001 | 消息长度错误。 \nMB:0002 | 命令长度错误。 \nMB:0003 | Command ID非法。 \nMB:0004 | 命令与bind状态不一致。 \nMB:0005 | ESME已经绑定。 \nMB:0006 | 无效的优先标识。 \nMB:0007 | SMC系统错误。 \nMB:0008 | 系统错误。 \nMB:0010 | 短消息的源地址错误。 \nMB:0011 | 短消息的目的地址错误。 \nMB:0012 | 短消息ID错误。 \nMB:0013 | 绑定失败。 \nMB:0014 | 密码错误。 \nMB:0015 | 系统ID错误。 \nMB:0017 | Cancel短消息失败。 \nMB:0018 | Replace短消息失败。 \nMB:0019 | 短消息队列已满。 \nMB:0020 | 短消息的服务类型非法。 \nMB:0051 | 目标地址个数错误。 \nMB:0052 | 分配列表名错误。 \nMB:0064 | 无效的目的地址列表。 \nMB:0066 | 无效的替换请求。短信中心回的，超作最大发送次数 可能是手机满了。 \nMB:0067 | ESM_CLASS的值无效。 \nMB:0068 | 无法提交到分配表。 \nMB:0069 | submit_sm或者submit_multi失败。 \nMB:0072 | 无效的源地址TON。 \nMB:0073 | 无效的源地址NPI。 \nMB:0080 | 无效的目的地址TON。 \nMB:0081 | 无效的目的地址NPI。 \nMB:0083 | System_type字段无效。 \nMB:0084 | replace_if_present_flag字段无效。 \nMB:0085 | 消息序号无效。 \nMB:0088 | 短消息数超过了短消息中心的消息队列的最大限定。 \nMB:0097 | 短消息中指定的定时时间无效。 \nMB:0098 | 短消息中指定的超时时间无效。 \nMB:0099 | 预定义短消息无效或不存在。 \nMB:0100 | 接收端暂时错误。 \nMB:0101 | 接收端永久性错误。 \nMB:0102 | ESME接收端拒绝消息出错。 \nMB:0103 | query_sm操作失败。 \nMB:0192 | PDU报文体中的可选部分出错。 \nMB:0193 | 命令字中含有被禁止的可选参数。 \nMB:0194 | 可选参数的长度错。 \nMB:0195 | 必需的可选参数丢失。 \nMB:0196 | 无效的可选参数。 \nMB:0254 | 下发失败。 \nMB:0255 | 不明错误。 \nMB:1024 | 为此条短消息分配内存或其它资源失败。 \nMB:1025 | 无效的短消息中心。 \nMB:1026 | License受限错误。SMC的相关运行参数（如MO速度、MT速度、短消息数、短消息实体数）已经达到了License的最大限制。 \nMB:1034 | PPS鉴权失败。 \nMB:1035 | 主叫用户状态不正确。 \nMB:1036 | 被叫用户状态不正确。 \nMB:1037 | 主叫用户不支持增值业务。 \nMB:1038 | 被叫用户不支持增值业务。 \nMB:1039 | 主叫用户金额不足。 \nMB:1040 | 被叫用户金额不足。 \nMB:1041 | 主叫用户提交的短消息数超过此用户的最大提交数。最大提交数指的是每个号码作为主叫号码时，能够缓存在SMC内存中的短消息的最大数目。 \nMB:1042 | SMC内存中缓存的、要下发给被叫用户的短消息数超过了该用户的最大下发数。最大下发数指的是每个号码作为被叫号码时，能够缓存在SMC内存中的短消息的最大数。 \nMB:1043 | 用户不存在或无效的用户。 \nMB:1044 | 自定义的找不到路由错误。 \nMB:1045 | 计费用户状态不正确。 \nMB:1046 | 计费用户金额不足。 \nMB:1047 | 计费用户不支持增值业务。 \nMB:1048 | 主叫用户为NP_OUT用户。 \nMB:1049 | 被叫用户为NP_OUT用户。 \nMB:1050 | 计费用户为NP_OUT用户。 \nMB:1051 | 计费用户不存在。 \nMB:1052 | PPS错误，暂未使用。 \nMB:1056 | 无效的数据格式（UD数据内容错误）。 \nMB:1057 | SMSC不支持的DCS或错误的DCS。 \nMB:1058 | 分包消息不能再次分包。 \nMB:1060 | 提交的消息携带的三个sars的值不满足约束 \nMB:1061 | 端口IE（Application Port Addressing）不能与两个ports共存。 \nMB:1062 | 某个或者两个ports都非法（长度或值错误）。 \nMB:1063 | message_payload可选参数的值太长。 \nMB:1064 | message_payload存在时UDL（User Data Length）必需为0，否则错误。 \nMB:1065 | UDH（User Data Header）错误，比如长度太长超过140字节（最大分包长度）。 \nMB:1069 | 接口版本不匹配。 \nMB:1070 | 流控错误，短消息中心拥塞。 \nMB:1072 | 对短消息的主叫号码进行帐号鉴权失败。 \nMB:1073 | 对短消息的被叫号码进行帐号鉴权失败。 \nMB:1074 | 对短消息的主叫用户进行虚拟短消息中心鉴权失败。 \nMB:1075 | 对短消息的被叫用户进行虚拟短消息中心鉴权失败。 \nMB:1076 | 主叫是注册用户黑名单。 \nMB:1077 | 被叫是注册用户黑名单。 \nMB:1078 | 所提交的消息无下发路由。 \nMB:1079 | SMC对短消息进行反漫游欺诈处理，发现该短消息为漫游欺诈短消息。SMC拒绝该短消息。 \nMB:1080 | 接口错误。 \nMB:1081 | 取SRI路由失败。 \nMB:1082 | 查询CCM失败。 \nMB:1083 | 反欺诈拒绝。 \nMC:0001 | SMSC没有给本网关回状态报告（关机） \nMC:0151 | SMSC没有给本网关回状态报告 \nMC:xxxx | 系统未从短信中心接收到状态报告 没有从SMSC处接收到状态报告时的状态报告 \nMI:xxxx | 同“EXPIRED” \nEXPIRED | 表示因为用户长时间关机或者不在服务区等导致的短信息超时没有递交到用户手机上 \nREJECTD | 消息因为某些原因被拒绝 \nUNDELIV | 表示全球通用户因为状态不正确如处于停机、挂起等状态而导致的用户无法享受服务 \nMN:xxxx | 同“REJECTD” \nMK:0000 | 正常。(停机） \nMK:0001 | 未知用户。 \nMK:0002 | 未定义用户。 \nMK:0003 | 非法用户。 \nMK:0004 | 电信业务不支持。 \nMK:0005 | 停机、关机、无法接通、暂停服务。 \nMK:0006 | 闭合用户群拒绝。主叫用户没有呼叫群外用户的权限，却呼叫群外用户。在维测台中的错误值为6。在ETSI GSM 0902协议中定义为15。 \nMK:0007 | 设备不支持。 \nMK:0008 | 用户不在服务区。用户当前所在地区信号不好，无法接收短消息。 \nMK:0009 | 用户不在服务区MWDSET。 \nMK:0010 | SM发送失败。 \nMK:0011 | 消息等待队列满。 \nMK:0013 | 短消息中心下发短消息给网络侧时，有必选字段缺失。(停机） \nMK:0014 | 意料外的数据。 \nMK:0015 | MS（Mobile Station）端错误。下发短消息时，手机在接收过程出现软件问题。例如，手机重启后，处理短消息部分软件没有初始化完成，此时无法正常处理短消息。可能是手机满了。 \nMK:0016 | MS未装备。在维测台中的错误值为16。在ETSI GSM 0902协议中定义为32。 \nMK:0017 | 手机内存满。 \nMK:0018 | SC拥塞。 \nMK:0019 | MS非SC用户。 \nMK:0020 | 不正确SME地址。 \nMK:0021 | 未知SC。 \nMK:0022 | 非法手机。该手机的国际移动台标识（IMEI）非法。 \nMK:0023 | 用户忙。 \nMK:0024 | 用户关机。 \nMK:0025 | 过滤业务专用错误码。 \nMK:0030 | HLR消息解码错误。HLR消息包中某一个数据的值超过协议规定的范围。 \nMK:0031 | MSC消息解码错误。 \nMK:0032 | INFORM_SC消息解码错误。 \nMK:0033 | SMC没有取到足够的路由信息。 \nMK:0034 | 来自HLR的意外数据。 \nMK:0035 | 来自MSC的意外数据。 \nMK:0036 | 来自MSC的未知错误。 \nMK:0037 | 来自HLR的未知错误。 \nMK:0040 | SMC发路由查询请求后，HLR无应答。 \nMK:0041 | SMC发置位消息后，HLR无应答。 \nMK:0045 | MAP协议版本错误。 \nMK:0046 | HLR版本协商错误。 \nMK:0048 | MSC无应答。 \nMK:0049 | HLR无应答。 \nMK:0050 | GIW模块（信令网关）无应答。 \nMK:0051 | MSC拒绝。 \nMK:0052 | HLR拒绝。 \nMK:0053 | GIW模块拒绝。 \nMK:0054 | SGSN（Serving GPRS Support Node）无应答。 \nMK:0055 | SGSN拒绝。一般是由于SGSN的TCAP层负荷过大。 \nMK:0056 | HLR系统错误。一般是由于HLR的MAP层负荷过大，发生流控后返回的消息。 \nMK:0057 | MSC系统错误。 \nMK:0058 | SGSN系统错误。 \nMK:0061 | MAPServer因为流控下发短消息失败。 \nMK:0062 | MTIServer因为流控下发短消息失败。 \nMK:0063 | 目的信令点或信令转接点SCCP（Signaling Connection Control Part）无法传送该消息。 \nMK:0064 | 接口无下发短消息的权限。 \nMK:0065 | GIW超时无应答。 \nMK:0066 | 因接口临时错误（已注销或未登录）导致短消息下发失败。 \nMK:0067 | 无效接口。 \nMK:0068 | SMC下发短消息给业务模块后，业务模块超时没有返回应答。 \nMK:0069 | 短消息只能从FCC（Flow Control Center）接口下发，但FCC接口不可用。 \nMK:0077 | SMC下发短消息时，接口缓冲区满。 \nMK:0078 | 保护模式下删除消息。 \nMK:0079 | 短消息超过主叫方的最大提交数，该短消息下发失败后，被删除。 \nMK:100 | 黑名单。 \nMK:0128 | 电信业务设备交互未被支持。 \nMK:0129 | 短消息类型未被支持。 \nMK:0130 | 不能替换短消息。 \nMK:0143 | 未指定的TP-PID错误。 \nMK:0144 | 字母表数据编码方案DCS未被支持。 \nMK:0145 | 短消息类型未被支持。 \nMK:0159 | 未指定的TP-DCS错误。 \nMK:0160 | 操作不能被执行。 \nMK:0175 | 未指定的TP-Command错误。 \nMK:0176 | TPDU未被支持。 \nMK:0192 | SMC忙。 \nMK:0193 | 没有SMC指定（签约）。 \nMK:0194 | SMC系统错误。 \nMK:0195 | 扩展短消息实体地址无效。 \nMK:0196 | 短消息实体被禁止使用。 \nMK:0208 | SIM（Subscriber Identity Module）中存储短消息的空间满。 \nMK:0209 | SIM中没有存储短消息的能力。 \nMK:0210 | MS错误。 \nMK:0255 | 未确定的错误原因。 \nMK00013 | 欠费 停机 \nMOBFAIL | 黑名单 \nCA:0054 | 发送消息失败 \nCB:0001 | 非神州行预付费用户（用户已经被销号）(空号) \nCB:0002 | 数据库操作失败 \nCB:0007 | 用户余额不足 \nCB:0053 | 梦网用户不存在 \nNP:1241 | 用户转电信 \nNP:1243 | 用户转联通 \nLT:0010 | 停机 \nLT:0-37 | 关机 \nLT:0-74 | 停机 \nLT:0001 | 号码空号 \nLT:0024 | 关机 \nLT:0005 | 停机 \nLT:0012 | 空号 \nLT:0008 | 空号 \nLT:0003 | 停机 \nLT:0011 | 停机 \nLT:0004 | 停机 \nLT:0029 | 关机 \nAUDIT X | 审核失败 \nCHANNEL C | 未知通道\" \nGATEWAY G | 未知网关 \nBLACKLIST B | 黑名单 \nPROHIBIT P | 违禁词 \nCHANNEL_NOT_VALID V | 通道不可用 \nCHANNEL_NOT_WRITE W | 通道不可写 \nEXCEED_TRAFFIC T | 超流控 \nSIGNERR N | 签名错误 \nFAILED F | 发送失败 \nEXCEPTION E | 系统异常 \nACCEPTED A | 已接收 \nGB:0010 | 运营商拦截 \nGB:0011 | 黑名单 \nGB:0024 | 运营商拦截 \nGB:0025 | 单个号码超日限制 \nGL:0013 | 黑名单 \nREPEATD | 1分钟重复提交 \nJL:0030 | 1分钟重复提交 \nLT:4 | 用户停机 \nLT:24 | 用户关机 \nE:BLACK | 手机号防骚扰名单过滤 \nJL:0013 | 黑名单 \nU2:1 | 空号 \nDB:0140 | 黑白名单因素造成 \nMK:0000 | 是由于用户停机造成的。一般会发生在月初账务扣费导致该用户余额不足，BOSS对该用户停机。 \nMK:0001 | 被叫用户是空号 \nMK:0004 | 被叫用户无短信功能，一般为欠费停机导致 \nMK:0005 | 被叫用户无短信功能，一般为欠费停机导致停机 \nMK:0010 | 被叫用户因关机、内存满，暂时无法接收短信 \nMI:0012 | 被叫用户因关机、内存满，暂时无法接收短信 \nMK:0015 | 被叫手机终端故障导致接收短信失败 \nMK:0017 | 被叫手机内存满 \nMI:0017 | 被叫手机内存满 \nMI:0024 | 被叫手机关机 \nMK:0024 | 被叫手机关机 \nMB:1042 | 被叫用户因关机、内存满，暂时无法接收短信 \nDB:0100 | 手机号码不存在 \nDB:0101 | 手机号码错误 \nDB:0102 | 用户停机用户冲值后，要主动上行一条信息到SP，才能激活用户的短信接收服务 \nDB:0103 | 用户欠费 \nF1122 | 营销防骚扰 \n2:10 | 一般是关机或者地市网关拦截（72小时返回） \n2:11 | 客户短信功能异常，咨询10010 \n2:12 | 空号或者停机或者暂停服务 \n2:15 | 返回15 手机接收端的问题，让客户手机清理一下，或者咨询一下联通10010短信功能是否正常的 \n2:13 | 已停机 \n2:24 | （联通网关返回） 可能是暂停服务 \n2:33 | 空号 \n2:37 | 停机 \n2:39 | 外部网关超时响应失败，产生报告 重新提交即可 \n2:45 | 黑名单 \n2:51 | 客户投诉可能是 \n2:54 | 关机 \n2:59 | 信号问题 \n2:67 | 空号 当地网关黑名单 \n2:73 | 等待应答超时 \n2:79 | 正忙 \n2：-74 | 暂停服务 \n2:89 | 地方网关故障 \n2:90 | 地方网关故障 \n2:99 | 用户主动拒绝此端口下发的短信 \nRFLIMIT | 超频 \n9911 | 屏蔽区 \nYF:01 | 手机号无效 \nYF:02 | 手机号未知运营商类型 \nYF:03X | 手机号黑名单 \nYF:04 | 手机号超频 \nYF:041 | 账户内每小时超频 \nYF:042 | 账户内每天超频 \nYF:046 | 金融类短信每天超频 \nYF:11 | 非法短信签名 \nYF:12 | 短信内容待审核 \nYF:13 | 短信内容审核失败 \nYF:14 | 人工驳回 \nYF:21 | 短信通道未分配 \nYF:22 | 部分省份屏蔽或通道屏蔽 \nYP:10 | 黑名单 \nUNDELIV(045) | 黑名单 \nUNDELIV:036 | 关键字拦截 \nCONLIM | 短信内容次数超限 \nMD:9415 | 人工驳回 \nDB:0141 | 黑名单 需要用户回复5个1到10690007解黑 \nWL:9911 | 屏蔽 \nEXPIRED(660) | 关机 \nEXPIRED(702) | 关机 \nEXPIRED(602) | 关机 \n-13 | 全平台黑名单 \n-14 | 用户黑名单 \n-106 | 黑内容 \n-144 | 黑名单 \n-502 | 运营商拦截，涉及到关注公众号和小程序 \n-1012 | 黑名单 \n-1005 | 违禁词 \n-9102 | 网关波动，请提交工单 \nNoPass | 运营商关键词拦截 \nCONLIM | 相同短信内容次数超限 \nSINPER | 相同短信内容次数超限 \nODSL:60 | 发送频率过快 \nE200022 | 携号转网异常 \nERR:005 | 停机 \nSC:0003 | 用户黑名单 \nSC:0010 | 发送频率过快 \nWBList | 用户黑名单 \n \n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的云短信消息推送"
},
{
"from": "gpt",
"value": "[云短信](https://developer.qiniu.com/sms) > API 文档 > 消息推送\n\n# 消息推送\n\n最近更新时间: 2023-05-24 17:28:36\n\n# 状态回调\n\n### 功能描述\n\n短信发送给用户后，将会通过回调业务 URL 的方式，通知业务方用户发送短信的状态。\n\n### 回调方法\n\nHTTP POST\n\n### 回调的内容\n\n \n \n {\n \"items\":[{\n \"mobile\": \"<string>\",\n \"message_id\": \"<string>\", // 单条发送的时候返回的 message_id\n \"status\": \"<string>\", // DELIVRD 送达， FAILED 发送失败\n \"delivrd_at\": <timestamp>,\n \"error\": \"<string>\", // 当 status 为 FAILED 的时候，会有这个字段，\n \"job_id\": \"<string>\", // 批量发送的时候返回的 job_id\n \"seq\": \"<string>\" // 发送时携带的 seq\n }]\n }\n \n\n#### 状态回调内容示例\n\n \n \n POST https://example.com/sms/status/callback\n Content-Type: application/json\n \n {\"items\":[{\"mobile\":\"13812345678\",\"message_id\":\"34114035\",\"status\":\"DELIVRD\",\"delivrd_at\":1558692400,\"seq\":\"qiniuseq\"}]}\n \n\n### 返回\n\n业务返回 HTTP 状态码 200\n\n如果返回不是 200，会在10分钟内自动重试\n\n# 上行回调\n\n### 功能描述\n\n用户收到短信后，回复短信，七牛云短信服务可以通过回调业务 url 的方式，通知业务方用户回复了短信。\n\n### 回调方法\n\nHTTP POST\n\n### 回调内容\n\n \n \n {\n \t\"items\": [{\n \"dest_code\":\"<string>\", //用户发送短信的目的号码\n \t\t\"mobile\": \"<string>\", //用户手机号码\n \t\t\"content\": \"<string>\", //短信内容\n \t\t\"time\": <timestamp> //用户发送短信时间\n \t}]\n }\n \n\n#### 上行回调内容示例\n\n \n \n POST https://example.com/sms/reply/callback\n Content-Type: application/json\n \n {\"items\":[{\"mobile\":\"13812345678\",\"content\":\"TD\",\"time\":1558692400, \"dest_code\":\"10692012345678\"}]}\n \n\n### 返回\n\n业务返回 HTTP 状态码 200\n\n如果返回不是 200，会在10分钟内自动重试\n\n# 如何设置\n\n打开 Portal 控制台：https://portal.qiniu.com/sms/settings 即可设置\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的云短信SDK"
},
{
"from": "gpt",
"value": "[云短信](https://developer.qiniu.com/sms) > SDK 下载 > SDK\n\n# SDK\n\n最近更新时间: 2024-03-08 16:48:04\n\n> 说明： \n> SDK名称：云短信SDK \n> 开发者：上海七牛信息技术有限公司 \n> 云短信 SDK 合规使用说明请参考[七牛 SDK 合规使用说明\n> __](https://developer.qiniu.com/pili/12616/sdk-compliance-\n> instructions)；隐私政策说明请参考[七牛 SDK 隐私策略\n> __](https://developer.qiniu.com/pili/8027/sdk-privacy-policy)\n\n开发语言 | 下载地址 | 导入路径 \n---|---|--- \nJava | [java-sdk-v7.15.0 __](https://github.com/qiniu/java-sdk/releases/tag/v7.15.0)| src/main/java/com/qiniu/sms \nGolang | [go-sdk-v7.19.0 __](https://github.com/qiniu/go-sdk/releases/tag/v7.19.0)| sms \nPHP | [php-sdk-v7.12.0 __](https://github.com/qiniu/php-sdk/releases/tag/v7.12.0)| src/Qiniu/Sms \nPython | [python-sdk-v7.13.0 __](https://github.com/qiniu/python-sdk/releases/tag/v7.13.0)| qiniu/services/sms \nnodejs | [nodejs-sdk-v7.11.0 __](https://github.com/qiniu/nodejs-sdk/releases/tag/v7.11.0)| qiniu/sms \nRuby | [ruby-sdk-v1.0.0 __](https://developer.qiniu.com/sms/sdk/5994/ruby-sdk)| \n \n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的云短信Ruby SDK"
},
{
"from": "gpt",
"value": "[云短信](https://developer.qiniu.com/sms) > SDK 下载 > Ruby SDK\n\n# Ruby SDK\n\n最近更新时间: 2024-03-08 16:48:16\n\n> 说明： \n> SDK名称：云短信SDK \n> 开发者：上海七牛信息技术有限公司 \n> 云短信 SDK 合规使用说明请参考[七牛 SDK 合规使用说明\n> __](https://developer.qiniu.com/pili/12616/sdk-compliance-\n> instructions)；隐私政策说明请参考[七牛 SDK 隐私策略\n> __](https://developer.qiniu.com/pili/8027/sdk-privacy-policy)\n\n * 版本：v1.0.0\n\n## 鉴权和请求客户端封装\n\n \n \n # coding: utf-8\n require 'openssl'\n require 'base64'\n require 'uri'\n require 'net/http'\n require 'net/https'\n require 'json'\n \n module SMS\n class Credentials\n \n attr_reader :access_key, :secret_key\n \n def initialize(access_key, secret_key)\n @access_key = access_key\n @secret_key = secret_key\n end\n \n \n class << self\n \n def base64_url_encode(string)\n Base64.encode64(string).tr(\"+/\", \"-_\").gsub(/[\\n\\r]?/, \"\")\n end\n \n def digest(secret, bytes)\n OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha1'), secret, bytes)\n end\n \n def sign(secret, bytes)\n base64_url_encode(digest(secret, bytes))\n end\n \n def generate_signature(options = {})\n method = options[:method]\n url = options[:url]\n content_type = options[:content_type]\n body = options[:body]\n \n uri = URI.parse(url)\n \n signature = \"#{method} #{uri.path}\"\n \n query_string = uri.query\n \n if !query_string.nil? && !query_string.empty?\n signature += '?' + query_string\n end\n \n signature += \"\\nHost: #{uri.host}\"\n \n if !content_type.nil? && !content_type.empty? && content_type != \"application/octet-stream\"\n signature += \"\\nContent-Type: #{content_type}\"\n end\n \n signature += \"\\n\\n\"\n \n if body.is_a?(Hash)\n signature += body.to_json\n end\n \n return signature\n end\n \n end\n end\n \n class RPC\n API_BASE_URL = \"https://sms.qiniuapi.com/v1\"\n \n class << self\n \n def post(credentials, url, body)\n url = API_BASE_URL + url\n \n signature_options = {\n :url => url,\n :content_type => \"application/json\",\n :method => \"POST\",\n :body => body\n }\n \n encoded_sign = Credentials.sign(credentials.secret_key, Credentials.generate_signature(signature_options))\n \n uri = URI.parse(url)\n https = Net::HTTP.new(uri.host,uri.port)\n https.use_ssl = true\n req = Net::HTTP::Post.new(uri.path)\n \n req[\"Authorization\"] = \"Qiniu #{credentials.access_key}:#{encoded_sign}\"\n req[\"Content-Type\"] = \"application/json\"\n \n req.body = body.to_json\n \n res = https.request(req)\n end\n end\n end\n end\n \n\n### 调用示例\n\n \n \n mac = SMS::Credentials.new(\"access_key\", \"secret_key\")\n \n body = {\n :template_id => \"template_id\",\n :mobile => \"mobile\",\n :parameters => {\n :code => \"code\"\n }\n }\n \n SMS::RPC.post(mac, \"/message/single\", body)\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的边缘加速产品概述"
},
{
"from": "gpt",
"value": "[边缘加速](https://developer.qiniu.com/PCDN) > 使用文档 > 产品简介 >产品概述\n\n# 产品概述\n\n最近更新时间: 2022-01-12 18:43:40\n\n# 产品简介\n\n边缘加速是基于 P2P 技术的内容分发网络产品。相比 CDN 而言，边缘加速单价较低，更适用于大流量内容分发。边缘加速产品是与传统 CDN\n互补协作的关系，以 P2P 技术为核心的分布式边缘加速系统可与传统 CDN 集成，形成互补协作，边缘加速相对于 CDN 进行了相应的扩容、提速、降费。\n\n# 产品架构\n\n \n\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的边缘加速功能特性"
},
{
"from": "gpt",
"value": "[边缘加速](https://developer.qiniu.com/PCDN) > 使用文档 > 产品简介 >功能特性\n\n# 功能特性\n\n最近更新时间: 2022-01-12 18:42:28\n\n# 降低带宽成本\n\n与普通 CDN 相比，使用 P2P 协议可使热点内容分发成本优化 50%，显著降低综合带宽成本。\n\n# 提升服务体验\n\n全网卡顿率降低 25%、卡顿时长降低 50%；有网播放失败率降低 80%；全网平均下载速度提升 50%。\n\n# 百万级在线设备稳定可靠\n\n500 万潜在供给设备提升内容分发系统的可靠性，消除性能瓶颈和单点故障，服务失败率为传统 CDN 的 10%。\n\n# 多种接入方式快速集成\n\n提供 SDK、Cname 多种接入方式，满足多种使用场景。非侵入式对接，不改变客户现有技术体系。\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的边缘加速服务保障协议 (SLA)"
},
{
"from": "gpt",
"value": "[边缘加速](https://developer.qiniu.com/PCDN) > 使用文档 > 产品简介 >服务保障协议 (SLA)\n\n# 服务保障协议 (SLA)\n\n最近更新时间: 2022-01-12 18:42:45\n\n# 服务内容\n\n七牛边缘加速将 P2P 协议融入传统 CDN\n服务，通过挖掘海量闲置资源的上行带宽，将节点进一步下沉至边缘。使用边缘加速可以极大地降低热点内容的分发成本，同时消除了来自于服务器的性能瓶颈和单点故障问题，提升终端用户的使用体验。\n\n本服务等级协议（Service Level Agreement，简称 “SLA”）规定了七牛云向客户提供的边缘加速的服务可用性等级指标及赔偿方案。\n\n# 定义\n\n * 服务：指七牛云边缘加速根据本协议向开发者提供的付费服务。\n * 下载内容：指用户使用七牛云边缘加速服务的域名下所有供用户下载的文件。\n * 点播流媒体内容：指目前互联网常用的流媒体格式文件\n * 服务周期：一个服务周期为一个自然月。若客户使用七牛云边缘加速服务不满一个月，则不计算为一个服务周期。\n * 月度服务费用：一个自然月中，客户所支付的边缘加速服务费用总额。\n * 单位时间内请求本地地址次数：单位时间内，对通过边缘加速 SDK 地址转换函数得到的本地地址（127.0.0.1）的请求次数。\n * 单位时间内请求本地地址返回5xx错误次数：单位时间内，对通过边缘加速 SDK地址转换函数得到的本地地址（127.0.0.1）发起请求，并返回5xx错误的次数。\n * 不可用率计算公式：不可用率 = (单位时间内请求本地地址返回5xx错误次数 / 单位时间内请求本地地址次数) * 100% 。\n * SDK崩溃率计算公式：SDK崩溃率 = (单位时间内发生SDK崩溃的客户端数量 / 单位时间内活跃的客户端数量) * 100% 。\n * 不可用时间：单位时间内（以5分钟为一个统计粒度）不可用率大于0.1%，或SDK崩溃率大于0.1%，若两者中满足任意一项，则视为边缘加速服务在该单位时间内不可用；边缘加速所提供的服务在连续的10分钟或更长时间不可使用（也即至少有连续两个不可用点）则计为不可用时间。\n\n以下情况不在统计范围内：\n\n * 直接访问原CDN地址而非本地地址（127.0.0.1）的请求。\n * 由于源站问题而导致的5xx错误。\n * 与CDN拆分售卖情况下，由CDN导致的5xx错误。\n * 内容违规或其它原因而导致域名被封禁而产生的错误。\n * 单位时间（每5分钟）内活跃客户端数量不足10000。\n * 单位时间（每5分钟）内总请求数不足10000。\n\n# 服务可用性\n\n * 服务可用性计算公式：[（服务周期内应服务总时间 – 服务周期内不可用时间）/ 服务周期内应服务总时间 ] * 100% 。\n * 服务可用性承诺：边缘加速服务可用性不低于99.9% 。如未达到此可用性承诺，客户可以根据本协议中赔偿方案的约定获得赔偿。赔偿范围不包括以下原因所导致的服务不可用时间： \n 1. 七牛云预先通知客户后进行系统维护所引起的，包括割接、维修、升级和模拟故障演练；\n 2. 任何七牛云所控制或所属设备以外的网络、设备故障或配置调整引起的；\n 3. 客户的应用程序受到黑客攻击而引起的；\n 4. 客户维护不当或保密不当致使数据、口令、密码等丢失或泄漏所引起的；\n 5. 客户的疏忽或由客户授权的操作所引起的；\n 6. 客户未遵循七牛云产品使用文档或使用建议引起的；\n 7. 不可抗力引起的；\n 8. 其他非七牛云原因所造成的不可用，包括但不限于第三方CDN或源站问题导致的不可用。\n\n# 赔偿方案\n\n## 赔偿标准\n\n七牛云对用户存在故障的每个域名按不可用时间进行 10 倍赔偿，赔付金额 = 发生故障的域名故障前 24 小时平均每分钟费用 × 故障不可用时间 × 10\n倍。\n\n * 赔偿只针对使用边缘加速服务已产生费用的用户，以代金券的形式赔偿，不折算现金返还。\n * 故障不可用时间 = 故障解决时间 - 故障开始时间，不可用时间按分钟计算。\n * 如果用户没有使用到 24 小时，按实际使用时长计算平均每分钟费用。\n * 赔付金额不超过客户对该故障域名所消费的费用平均值（故障当月前12个月费用折算平均值）或故障当月客户消费的月度服务费用的25%（服务不满12个月，不包含本月）。\n\n## 赔偿申请时限\n\n客户可以在每月第 5 个工作日后对上个月没有达到可用性的边缘加速服务提出赔偿申请。赔偿申请必须限于在边缘加速没有达到可用性的相关月份结束后 2\n个月内提出。超出申请时限的赔偿申请将不被受理。\n\n# 其他\n\n七牛云有权对本SLA条款作出修改。如本SLA条款有任何修改，七牛云将提前30天以网站公示或发送邮件的方式通知您。如您不同意七牛云对SLA所做的修改，您有权停止使用边缘加速服务，如您继续使用边缘加速服务，则视为您接受修改后的SLA。\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的边缘加速产品服务公告-增加合规性校验的通知"
},
{
"from": "gpt",
"value": "[边缘加速](https://developer.qiniu.com/PCDN) > 产品动态 > 产品服务公告-增加合规性校验的通知\n\n# 产品服务公告-增加合规性校验的通知\n\n最近更新时间: 2023-04-19 16:52:36\n\n尊敬的客户： \n您好！边缘加速产品服务将于本周进行产品升级——增加合规性校验。服务时将会验证访问域名与请求Token是否关联，以及验证域名是否具备ICP备案。不符合以上规则的域名将不再提供服务调度。Portal将于近期上线添加域名的能力，并支持绑定Token。Token暂不支持自助生成，我方会在后台提前帮您进行录入，并绑定历史域名。 \n如您在使用过程中有任何问题，请随时与我们 [联系 __](https://www.qiniu.com/contact)。谢谢。\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的边缘加速边缘加速流量带宽"
},
{
"from": "gpt",
"value": "[边缘加速](https://developer.qiniu.com/PCDN) > API 文档 > 边缘加速流量带宽\n\n# 边缘加速流量带宽\n\n最近更新时间: 2022-01-12 18:43:06\n\n# 访问域名\n\n \n \n Host: fusion.qiniuapi.com\n \n\n# 认证授权\n\n \n \n Authorization: QBox <access_token>\n \n\naccess_token 详细描述请查阅[这里](https://developer.qiniu.com/kodo/manual/access-\ntoken)。\n\n# 批量查询边缘加速带宽\n\n## 接口地址\n\n \n \n /v2/tune/bandwidth\n \n\n### 说明\n\n * 返回的数据包含开始日期和结束日期\n * 带宽的单位为 bps\n * data 只包含有流量的域名\n\n## 请求语法\n\n \n \n POST /v2/tune/bandwidth HTTP/1.1\n Content-Type: application/json\n \n {\n \"startDate\": <StartDate>,\n \"endDate\": <EndDate>,\n \"granularity\": <Granularity>,\n \"domains\": <Domains>,\n \"type\": <Type>\n }\n \n\n## 请求内容\n\n参数 | 类型 | 必要性 | 说明 \n---|---|---|--- \nStartDate | string | 必须 | 开始日期，例如：2016-07-01 \nEndDate | string | 必须 | 结束日期，例如：2016-07-03 \nGranularity | string | 必须 | 粒度，取值：5min ／ hour ／day \nDomains | string | 必须 | 域名列表，以 ；分割 \nType | string | 必须 | `\"pdnbandwidth\"`查询边缘加速加速产生的带宽数据 \n \n## 响应状态码\n\nHTTP状态码 | 含义 | 说明 \n---|---|--- \n200 | success | 成功 \n400031 | invalid params | 请求参数非法。 e.g. `\"Type\"`参数指定了除`\"\"`(空)/`\"bandwidth\"`/`\"dynbandwidth\"`以外的值 \n400032 | invalid host | 请求中存在无效的域名，请确保域名格式正确 \n400080 | invalid start time | 开始时间格式错误 \n400081 | invalid end time | 截止时间格式错误 \n400082 | invalid time range | 时间范围错误，请确保开始时间早于结束时间，且时间范围不超过 31 天 \n500000 | internal error | 服务端内部错误，请联系技术支持 \n \n## 响应内容\n\n \n \n 200 OK HTTP/1.1\n \n {\n \"code\": <Code>,\n \"error\": <Error>,\n \"time\": <Time>,\n \"data\": {\n ...\n <Domain_i>: {\n \"china\": <Domain_i_China>,\n \"oversea\": <Domain_i_Oversea>,\n },\n ...\n }\n }\n \n\n参数 | 类型 | 说明 \n---|---|--- \nCode | int | HTTP 状态码，整型，见响应状态码 \nError | string | 自定义错误码描述，字符串 \nTime | []string | 时间点数组 \ndata | map | 带宽数据 \nDomain_i | string | 域名 \nDomain_i_China | []int | Domain_i 国内带宽数据，与 Time 一一对应 \nDomain_i_Oversea | []int | Domain_i 海外带宽数据，与 Time 一一对应 \n \n## 示例\n\n \n \n 200 OK HTTP/1.1\n \n {\n \"code\": 200,\n \"error\": \"\",\n \"time\": [\"2016-07-01 00:00:00\",\"2016-07-01 00:05:00\", ...],\n \"data\": {\n \"a.com\": {\n \"china\": [8888, 9999, 10000, ...],\n \"oversea\": [3333, 4444, 5000, ...],\n },\n \"b.com\": {\n \"china\": [8888, 9999, 10000, ...],\n \"oversea\": [3333, 4444, 5000, ...],\n }\n }\n }\n \n\n# 批量查询边缘加速流量\n\n## 接口地址\n\n \n \n /v2/tune/flux\n \n\n### 说明\n\n * 返回的数据包含开始日期和结束日期\n * 流量的单位为 byte\n * data 只包含有流量的域名\n\n## 请求语法\n\n \n \n POST /v2/tune/flux HTTP/1.1\n Content-Type: application/json\n \n {\n \"startDate\": <StartDate>,\n \"endDate\": <EndDate>,\n \"granularity\": <Granularity>,\n \"domains\": <Domains>,\n \"type\": <Type>\n }\n \n\n## 请求内容\n\n参数 | 类型 | 必要性 | 说明 \n---|---|---|--- \nStartDate | string | 必须 | 开始日期，例如：2016-07-01 \nEndDate | string | 必须 | 结束日期，例如：2016-07-03 \nGranularity | string | 必须 | 粒度，取值：5min ／ hour ／day \nDomains | string | 必须 | 域名列表，以 ；分割 \nType | string | 必须 | `\"pdnflux\"`查询边缘加速加速产生的流量数据 \n \n## 响应状态码\n\nHTTP状态码 | 含义 | 说明 \n---|---|--- \n200 | success | 成功 \n400031 | invalid params | 请求参数非法。 e.g. `\"Type\"`参数指定了除`\"\"`(空)/`\"bandwidth\"`/`\"dynbandwidth\"`以外的值 \n400032 | invalid host | 请求中存在无效的域名，请确保域名格式正确 \n400080 | invalid start time | 开始时间格式错误 \n400081 | invalid end time | 截止时间格式错误 \n400082 | invalid time range | 时间范围错误，请确保开始时间早于结束时间，且时间范围不超过 30 天 \n500000 | internal error | 服务端内部错误，请联系技术支持 \n \n## 响应内容\n\n \n \n 200 OK HTTP/1.1\n \n {\n \"code\": <Code>,\n \"error\": <Error>,\n \"time\": <Time>,\n \"data\": {\n ...\n <Domain_i>: {\n \"china\": <Domain_i_China>,\n \"oversea\": <Domain_i_Oversea>,\n },\n ...\n }\n }\n \n\n参数 | 类型 | 说明 \n---|---|--- \nCode | int | HTTP 状态码，整型，见响应状态码 \nError | string | 自定义错误码描述，字符串 \nTime | []string | 时间点数组 \ndata | map | 流量数据 \nDomain_i | string | 域名 \nDomain_i_China | []int | Domain_i 国内流量数据，与 Time 一一对应 \nDomain_i_Oversea | []int | Domain_i 海外流量数据，与 Time 一一对应 \n \n## 示例\n\n \n \n 200 OK HTTP/1.1\n \n {\n \"code\": 200,\n \"error\": \"\",\n \"time\": [\"2016-07-01 00:00:00\",\"2016-07-01 00:05:00\", ...],\n \"data\": {\n \"a.com\": {\n \"china\": [8888, 9999, 10000, ...],\n \"oversea\": [3333, 4444, 5000, ...],\n },\n \"b.com\": {\n \"china\": [8888, 9999, 10000, ...],\n \"oversea\": [3333, 4444, 5000, ...],\n }\n }\n }\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的边缘加速边缘加速日志下载"
},
{
"from": "gpt",
"value": "[边缘加速](https://developer.qiniu.com/PCDN) > API 文档 > 边缘加速日志下载\n\n# 边缘加速日志下载\n\n最近更新时间: 2022-01-12 18:43:22\n\n日志下载接口可以查询域名日志列表，获取日志的下载外链，只提供 30 个自然日内的日志下载，例如当前日期为 2016-08-31，则只提供\n2016-08-01 ~ 2016-08-30 的日志。\n\n日志文件默认按小时下载，如果单小时内日志过大会进行切分(分片大小128MB)，日志文件采用gzip压缩。 \n日志大概延迟6小时，举例：1月18日0点-1点的日志，会在1月18日8点-10点左右可下载。\n\n# 访问域名\n\n \n \n Host: fusion.qiniuapi.com\n \n\n# 接口地址\n\n \n \n /v2/tune/pcdnlog/list\n \n\n# 认证授权\n\n \n \n Authorization: <access_token>\n \n\naccess_token 详细描述请查阅[这里](https://developer.qiniu.com/kodo/manual/access-\ntoken)。\n\n# 请求报文\n\n## 请求语法\n\n \n \n POST /v2/tune/pcdnlog/list HTTP/1.1\n Content-Type: application/json\n \n {\n \"day\":<Day>,\n \"domains\": <Domains>\n }\n \n\n## 请求内容\n\n参数 | 类型 | 必须 | 描述 \n---|---|---|--- \n`Day` | string | 是 | 日期，例如 2016-07-01 \n`Domains` | string | 是 | 域名列表，以英文分号 ; 分割 \n \n# 响应报文\n\n## 响应状态码\n\nHTTP状态码 | 含义 | 说明 \n---|---|--- \n200 | success | 成功 \n400 | invalid params | 请求参数格式错误 \n401 | bad token | 认证授权失败（包括密钥信息不正确；数字签名错误；授权已超时） \n400032 | invalid host | 请求中存在无效的域名，请确保域名格式正确 \n500000 | internal error | 服务器内部错误 \n \n## 响应内容\n\n \n \n HTTP/1.1 200 OK\n Content-Type: application/json\n \n {\n \"code\":<Code>,\n \"error\": <Error>,\n \"data\": {\n ...\n <Domain_i>:[\n ...\n { \n \"name\":<Name>,\n \"size\":<Size>,\n \"mtime\":<Mtime>,\n \"url\":<Url>,\n },\n ...\n ],\n ...\n }\n }\n \n\n参数 | 类型 | 说明 \n---|---|--- \nCode | int | HTTP 状态码，整型，见响应状态码 \nError | string | 自定义错误码描述，字符串 \ndata | map | 日志数据 \nDomain_i | string | 域名，字符串 \nDomain_i_Name | string | 文件名，字符串 \nDomain_i_Size | int64 | 文件大小，单位为 Byte \nDomain_i_Mtime | int64 | 文件修改时间，Unix 时间戳 \nDomain_i_Url | string | 下载链接，字符串 \n \n# 示例\n\n## 请求示例\n\n \n \n POST http://fusion.qiniuapi.com/v2/tune/pcdnlog/list HTTP/1.1\n Content-Type: application/json\n \n {\n \"day\":\"2016-07-01\",\n \"domains\": \"log-test1.qiniu.com;log-test2.qiniu.com\"\n }\n \n\n## 响应示例\n\n \n \n HTTP/1.1 200 OK\n Content-Type: application/json\n \n {\n \"data\": {\n \"log-test1.qiniu.com\": [\n {\n \"name\":\"log-test1.qiniu.com_2016-07-01-00_00.gz\",\n \"size\": 88490306,\n \"mtime\": 1466274440,\n \"url\": \"http://fusionlog.qiniu.com/log-test1.qiniu.com_2016-07-01-00_00.gz?e=1561008052&token=557TpseUM8ovpfUhaw8gfa2DQ0104ZScM-BTIcBx:8AUwyRCO6nwb8vTH_LNKg4016Ec\"\n }\n ],\n \"log-test2.qiniu.com\": [\n {\n \"name\":\"log-test2.qiniu.com_2016-07-01-00_00.gz\",\n \"size\": 73280873,\n \"mtime\": 1466273259,\n \"url\": \"http://fusionlog.qiniu.com/log-test2.qiniu.com_2016-07-01-00_00.gz?e=1561008052&token=336DepseUM8ovpfUhaw8gfa2DQ0104ZScM-BTIcBx:8AUwyRCO6nwb8vTH_LNKg3879Wd\"\n }\n ]\n }\n }\n \n\n# 日志格式\n\n \n \n 访问时间 访问类型 URL 持续时长边缘加速流量 CDN流量\n [09/May/2020:15:22:04 +0800] vod \"http://vod.qiniu.com/niuxiaoqi.ts\" 60000 18358142 0\n \n\n描述 | 说明 | 示例 \n---|---|--- \n访问时间 | 记录客户端开始访问URL的时间 | [09/May/2020:15:22:04 +0800] \n访问类型 | vod：点播类型；download：下载类型 | vod \nURL | 记录客户发起访问的URL | “http://vod.qiniu.com/niuxiaoqi.ts” \n持续时长 | 访问从发起时到结束所持续的时长，单位毫秒 | 60000 \n边缘加速流量 | 记录该条URL访问时所使用的p2p流量，单位字节 | 18358142 \nCDN流量 | 记录该条URL访问时所使用的CDN流量，单位字节(参考数值，不作为CDN计费依据) | 0 \n \n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的即时通讯IM服务接入指南"
},
{
"from": "gpt",
"value": "[即时通讯](https://developer.qiniu.com/IM) > 使用指南 > IM服务接入指南\n\n# IM服务接入指南\n\n最近更新时间: 2021-10-14 17:06:15\n\n# 一、接入流程\n\n> 即时通讯IM产品，目前暂时只支持中国大陆区域使用。支持iOS、Android、Web平台互通。\n\n**1、注册账号** \n七牛云官网，前往[注册页面 __](https://portal.qiniu.com/signup)\n\n**2、实名认证** \n前往七牛实名认证页面，进行[实名认证 __](https://portal.qiniu.com/identity/choice)\n\n**3、创建RTC应用** \n在实时音视频业务板块中[创建应用 __](https://portal.qiniu.com/rtn/app/create) \n\n\n**4、开通IM服务** \n创建RTC应用完成，查看应用详情页面，找到即时通讯服务模块，点击开启，如下图所示 \n\n\n**5、升级到商业版**\n\n注意： \n（1）免费版仅用于开发测试阶段，正式使用请升级到商业版。 \n（2）商业版开通当天会立即开始计费，最低为 30 元/日。 \n（3）商业版支持某些高级功能和增值服务，详见下文免费版与商业版的区别\n\n为保证服务质量，避免误操作，开通商业版需通过工单进行申请。\n\n# 二、免费版与商业版\n\n**1、免费版只有100个注册用户，所以只用于测试阶段。正式使用请开通商业版。**\n\n**2、商业版一旦开通，每天都会计费，最低为30元/天。若不再使用IM服务，请将商业版降级到免费版。**\n\n**3、商业版允许使用高级功能，且允许进一步购买增值功能**\n\n**4、免费版和商业版的功能区域对比如下表，商业版才会有高级功能区域**\n\n功能区 | 免费版 | 商业版 \n---|---|--- \n基础设置 | 有 | 有 \n套餐设置 | 有 | 有 \n高级功能 | 没有 | 有 \n管理员Token | 有 | 有 \n \n**5、免费版和商业版的 基础设置 及 管理员Token 没有区别，套餐设置对比如下表**\n\n项 | 免费版 | 商业版 \n---|---|--- \n注册用户限制 | 100 | 不限 \n群规模 | 200 人群 | 2000 人群 \n群数量 | 500 个群/用户 | 1000 个群/用户 \n离线消息数 | 500 条（单群上限100条） | 1000 条（单群上限200条） \n每日下行消息数 | 2 万条 | 1000 万条 \n历史消息云存储 | 7 天 | 30 天 \n接口限流QPS | 10 次/秒 | 30 次/秒 \n每用户支持设备数 | 3 | 5个 \n \n> 注意：聊天室 和 群\n> 的区别是：聊天室在用户退出聊天后，用户就退出了聊天室成员列表。但群里面的用户退出聊天后，用户还是在群成员列表中的。群有群规模限制，而聊天室是不限制人数规模的。所以聊天室较多用于大型直播间场景。\n\n# 三、增值服务\n\n开通商业版后，在**高级功能** 和**套餐设置** 中，共有9个增值服务项目。 \n每一项增值服务单独计费，增值服务在开通当日就会立即收费，且开通后每日都会产生费用。 \n所以若不继续使用，请将其恢复到商业版初始设置（将套餐设置为最小值、将高级功能的开关关闭）。 \n增值服务计费项如下表\n\n序号 | 9个计费项名称 | 日单价（元） \n---|---|--- \n1 | IM-高级API | 50 \n2 | IM-信息订阅定制 | 100 \n3 | IM-内容安全加强 | 50 \n4 | IM-群人数上限5000人 | 50 \n5 | IM-每日下行消息数1500万条 | 500 \n6 | IM-每日下行消息数2000万条 | 1000 \n7 | IM-历史消息云存储90天 | 50 \n8 | IM-历史消息云存储180天 | 100 \n9 | IM-支持设备数10个 | 100 \n \n> 注意：高级功能中的**用户消息回调地址** 和**默认服务** ，可在开通商业版后直接设置使用。\n\n# 四、管理员Token\n\nToken 主要用于服务端 API 鉴权，只在生成时显示一次。 \n\n\n# 五、获取支持\n\n商务支持：若有商务或价格方面的问题，可联系 400-808-9176 转 1 获取商务支持。 \n技术支持：若在集成开发过程中，需要技术支持，可通过工单系统提交工单。\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的即时通讯iOS快速集成指南"
},
{
"from": "gpt",
"value": "[即时通讯](https://developer.qiniu.com/IM) > 使用指南 > iOS快速集成指南\n\n# iOS快速集成指南\n\n最近更新时间: 2022-07-25 11:05:35\n\n# 七牛即时通讯IM\n\n## 前期准备\n\n在demo中下载 QNIMSDK.framework , 然后将文件引用到您的项目中，并配置target->genaral-> embed and\nsign。\n\n### 初始化\n\n \n \n 在您需要使用QNIMSDK功能的类中，import 相关头文件。\n 您在使用QNIMSDK所有功能之前，您必须先调用此方法初始化 SDK。 在 App 的整个生命周期中，您只需要将 SDK 初始化一次。\n \n \n \n // 设置存储路径\n \n NSString* dataDir = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES).firstObject stringByAppendingPathComponent:@“ChatData”];\n \n NSString* cacheDir = [NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES).firstObject stringByAppendingString:@“UserCache”];\n \n // 初始化\n \n QNSDKConfig *config = [[QNSDKConfig alloc] initConfigWithDataDir:dataDir cacheDir:cacheDir pushCertName:@“Your APNS Certification” userAgent:@“userAgent”];\n \n config.appID = @“Your AppID”;\n \n [[QNIMClient sharedClient] registerWithSDKConfig:config];\n \n \n\n### 登录链接服务器\n\n通过 QNIMClient的单例,用UserId登录IM，即可建立与服务器的连接。\n\n \n \n [[QNIMClient sharedClient] signInByName:im_username password:im_password completion:^(QNIMError * _Nonnull error) {\n }];\n \n\n### 聊天室\n\n##### 加入聊天室\n\n \n \n // groupID：聊天室ID message：加入聊天室验证消息（可不传）\n - (void)joinGroupWithGroupId:(NSString *)groupId\n message:(NSString *)message\n completion:(void(^)(QNIMError *error))aCompletionBlock;\n \n\n##### 获取聊天室信息\n\n \n \n //forceRefresh 如果设置了forceRefresh则从服务器拉取\n - (void)getGroupInfoByGroupId:(long long)groupId\n forceRefresh:(BOOL)forceRefresh\n completion:(void(^)(QNIMGroup *group,\n QNIMError *error))aCompletionBlock;\n \n\n##### 退出聊天室\n\n \n \n [[QNIMGroupOption sharedOption] leaveGroupWithGroupId:self.groupId completion:^(QNIMError * _Nonnull error) {\n \n }];\n \n\n##### 群监听\n\n \n \n [[QNIMGroupOption sharedOption] addDelegate:self];\n \n\n##### 代理方法\n\n \n \n /**\n 退出了某群\n */\n - (void)groupLeft:(QNIMGroup *)group reason:(NSString *)reason{\n \n }\n \n \n \n /**\n * 加入新成员\n **/\n - (void)groupMemberJoined:(QNIMGroup *)group\n memberId:(NSInteger)memberId\n inviter:(NSInteger)inviter{\n \n }\n \n \n \n /**\n * 群成员退出\n **/\n - (void)groupMemberLeft:(QNIMGroup *)group\n memberId:(NSInteger)memberId\n reason:(NSString *)reason{\n \n }\n \n\n### 构建消息实体\n\n \n \n /**\n 创建文本消息\n \n @param content 内容\n @param fromId 发送id\n @param toId 接收id\n @param mtype 消息类型\n @param conversationId 会话id\n @return QNIMMessageObject\n */\n - (instancetype)initWithQNIMMessageText:(NSString *)content\n fromId:(long long )fromId\n toId:(long long)toId\n type:(QNIMMessageType)mtype\n conversationId:(long long )conversationId;\n \n\n### 消息操作\n\n消息实体构建完成后，通过 QNIMChatOption的单例，调用 -sendMessage: 方法，将构建好的消息实体传入，即可实现消息发送。\n\n \n \n QNIMMessageObject *messageModel = [[QNIMMessageObject alloc]initWithQNIMMessageText:@\"加入了房间\" fromId:imUserId.longLongValue toId:self.groupId.longLongValue type:QNIMMessageTypeGroup conversationId:self.groupId.longLongValue];\n [[QNIMChatOption sharedOption] sendMessage:messageModel];\n \n\n### 消息收发监听\n\n \n \n //添加监听者\n [[QNIMChatOption sharedOption] addDelegate:self];\n \n\n##### 代理方法\n\n \n \n //收到消息\n - (void)receivedMessages:(NSArray<QNIMMessageObject *> *)messages {\n \n }\n \n \n \n // 消息状态发生变化\n - (void)messageStatusChanged:(QNIMMessageObject *)message error:(QNIMError *)error {\n \n }\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的即时通讯安卓快速集成指南"
},
{
"from": "gpt",
"value": "[即时通讯](https://developer.qiniu.com/IM) > 使用指南 > 安卓快速集成指南\n\n# 安卓快速集成指南\n\n最近更新时间: 2022-07-22 22:34:06\n\n# Android SDK 集成说明\n\n## SDK 架构\n\n七牛IM SDK 底层使用 C++ 实现，各平台（Android、iOS、Linux等）在此基础上再行封装，\n完成本地库的开发，以达到多平台复用的目的，并保持跨平台协议实现的一致性。 floo-android 作为供安卓使用的本地应用库，有两种 API\n可供开发者使用，即低级 API 和高级 API，也即同步接口和异步接口。 低级 API (low-level)\n\n同步调用接口，类名以Service结尾，为方便理解，下文说明中用 L/S 表示，其中 L 表示 Low-level, S 表示 Sync。\n如前所述，floo-android 主体由 SWIG 框架自动生成。用 SWIG 生成的 Java 代码，通过 JNI 方式调用底层 C++\n类库，因此大部分接口均为同步，即调用接口后，完成后返回结果。\n代码生成和转换的过程中，相关数据结构得以直接映射到底层类库，减少了内存拷贝，因此其性能接近于直接调用底层库。 同步方式的服务类如下：\n\n * QNIMClient: SDK功能聚合类，包含了所有的service类、实现了网络事件监听接口\n * BMXChatRoomService: 聊天室管理 加入、退出、销毁、成员\n * BMXChatService: 消息发送、消息历史获取、会话列表\n * BMXUserService: 注册账号、登入、登出、我的设置\n * BMXRosterService: 好友列表、黑名单\n * BMXGroupService: 群管理（创建、解散、查找、设置、成员管理、邀请、申请、接受、拒绝）\n\n### 高级 API (high-level)\n\n异步调用接口，类名以Manager结尾，为方便理解，下文用 H/A 表示，其中 H 表示 High-level, A 表示 Async。\n考虑到开发者集成方便，我们也基于此类重新封装了高级 API，使用了更为友好的数据结构，并完成了异步封装。\n简单来讲，相关调用会在子线程执行具体操作（例如：搜索好友），当前线程会直接返回不会阻塞。具体操作的结果则通过回调函数通知调用方，后者可以在其中处理 UI\n刷新等业务逻辑。 异步方式的服务类如下：\n\n * BaseManeger:Manger管理基础类\n * ChatManager:消息发送、消息历史获取、会话列表\n * chatRoomManager: 聊天室管理 加入、退出、销毁、成员\n * UserManager:注册账号、登入、登出、我的设置\n * RosterManager:好友列表、黑名单\n * BMXCallBack:无类型接口回调\n * BMXDataCallBack: 泛型类型带数据回调\n\n### 其他工具类\n\n * BMXGroupServiceListener:群事件监听\n * BMXUserServiceListener:用户事件监听\n * BMXRosterServiceListener:好友事件监听\n * BMXNetworkListener:网络事件监听接口，由QNIMClient实现\n * BMXConversation:会话\n * BMXMessage:消息\n * BMXGroup:群\n * BMXRosterItem花名册项（好友、陌生人、黑名单、前好友）\n * BMXUserProfile:用户信息\n\n### 类库示意图如下\n\n \n \n +---> BMXChatRoomService\n |\n +---> BMXUserService\n |\n +---------------+ +---> BMXChatService\n | | |\n +---+ 低级 API: L/S +------> BMXRosterService\n | | | |\n | +---------------+ +---> BMXGroupService\n |\n |\n |\n |\n | +---> BMXChatRoomManager\n | |\n | +---> BMXUserManager\n | +---------------+ |\n +----------------------+ | | | +---> BMXChatManager\n | | +---+ 高级 API: H/A +-----+\n | 七牛 IM SDK: Floo +--+ | | +---> BMXRosterManager\n | | | +---------------+ |\n +----------------------+ | +---> BMXGroupManager\n |\n | +---> QNIMClient\n | +----------------+ |\n | | | +---> BMXSDKConfig\n +---+ Utility：工具类 +--+\n | | +---> BMXMessage\n +----------------+ |\n +---> BMXConversation\n |\n +---> BMXUserProfile\n |\n +---> BMXGroup\n |\n +---> BMXDevice\n \n\n### 申请imAppId\n\n创建七牛账号，并创建七牛[IMAppId](https://portal.qiniu.com/rtn/app)\n\n### 导入SDK\n\nSDK导入可以选择aar格式或者jar+so格式 aar格式\n\n下载aar文件到项目的libs目录 在build.gradle文件dependencies块中增加依赖，参照im-android源码使用最新版。\nimplementation (name:'qndroid-imsdk-1.0.0',ext:\"aar\") jar+so格式\n\n下载jar包和so库到项目的libs目录 在build.gradle文件中增加：implementation fileTree(dir: ‘libs’,\ninclude: [’*.jar’]) 权限配置\n\n \n \n 在AndroidManifest.xml 里增加加以下权限：\n <uses-permission android:name=\"android.permission.ACCESS_NETWORK_STATE\" />\n <uses-permission android:name=\"android.permission.INTERNET\" />\n <uses-permission android:name=\"android.permission.ACCESS_FINE_LOCATION\" />\n <uses-permission android:name=\"android.permission.ACCESS_COARSE_LOCATION\" />\n <uses-permission android:name=\"android.permission.ACCESS_LOCATION_EXTRA_COMMANDS\" />\n <uses-permission android:name=\"android.permission.WRITE_EXTERNAL_STORAGE\" />\n <uses-permission android:name=\"android.permission.READ_EXTERNAL_STORAGE\" />\n <uses-permission android:name=\"android.permission.WRITE_CONTACTS\" />\n <uses-permission android:name=\"android.permission.CAMERA\" />\n <uses-permission android:name=\"android.permission.READ_PHONE_STATE\" />\n <uses-permission android:name=\"android.permission.ACCESS_WIFI_STATE\" />\n <uses-permission android:name=\"android.permission.CHANGE_WIFI_STATE\" />\n <uses-permission android:name=\"android.permission.RECORD_AUDIO\" />\n <uses-permission android:name=\"android.permission.VIBRATE\" />\n <uses-permission android:name=\"android.permission.CALL_PHONE\" />\n <uses-permission android:name=\"android.permission.READ_CONTACTS\" />\n <uses-permission android:name=\"android.permission.WAKE_LOCK\" />\n \n\n## 快速集成\n\n### QNIMClient初始化\n\n### 第一步 导入so库文件\n\n在 app 入口类中增加导入\n\n \n \n static {\n System.loadLibrary(\"floo\");\n }\n \n\n### 第二步 初始化QNIMClient\n\n \n \n // 设置存储路径\n String appPath = AppContextUtils.getAppContext().getFilesDir().getPath();\n File dataPath = new File(appPath + \"/data_dir\");\n File cachePath = new File(appPath + \"/cache_dir\");\n dataPath.mkdirs();\n cachePath.mkdirs();\n \n // 设置推送平台对应的ID,如果不需要推送传“MaxIM”\n String pushId = getPushId();\n \n // 配置sdk config\n BMXSDKConfig config = new BMXSDKConfig(BMXClientType.Android, \"1\", dataPath.getAbsolutePath(),\n cachePath.getAbsolutePath(), TextUtils.isEmpty(pushId) ? \"MaxIM\" : pushId);\n config.setConsoleOutput(true);\n config.setLogLevel(BMXLogLevel.Debug);\n \n // 初始化QNIMClient\n QNIMClient.init(conf);\n \n\n注意： 如果使用高级API（异步调用方式），需要通过以下方法获取到服务类API的实体：\n\n * ChatManager: 通过QNIMClient.getChatManager()获取到消息的manager对象。\n * UserManager: 通过QNIMClient.getUserManager()获取到用户的manager对象。\n * GroupManager: 通过QNIMClient.getGroupManager()获取到群相关的manager对象。\n * RosterManager: 通过QNIMClient.getRosterManager()获取到roster的manager对象。\n\n### 注册用户\n\n \n \n L/S: 同步调用传入BMXUserProfile对象引用，调用之后即可获取profile信息。\n QNIMClient.signUpNewUser(\"zhangsan\", \"sFo!slk1x\", new BMXUserProfile());\n H/A: 异步调用在BMXDataCallBack回调中返回profile实例。\n QNIMClient.getUserManager().signUpNewUser(\"zhangsan\", \"sFo!slk1x\", new BMXDataCallBack<BMXUserProfile>(){\n @Override\n public void onResult(BMXErrorCode bmxErrorCode, BMXUserProfile bmxUserProfile) {\n //返回profile\n }\n });\n \n\n### 登录\n\n两种登录模式：一种是普通手动登录，另一种是快速登录模式，手动登录包含了获取token和建立tcp连接的两个步骤，快速登录则将token缓存至本地。\n\n \n \n L/S: 通过返回值BMXErrorCode判断是否成功。\n // 参数：username(用户名) password(密码)\n QNIMClient.signInByName(\"zhangsan\", \"sFo!slk1x\");\n QNIMClient.fastSignInByName(\"zhangsan\", \"sFo!slk1x\");\n H/A: 在BMXCallBack回调中返回BMXErrorCode 判断是否成功。\n QNIMClient.getUserManager().signInByName(\"zhangsan\", \"sFo!slk1x\", new BMXCallBack(){\n @Override\n public void onResult(BMXErrorCode bmxErrorCode) {\n \n }\n });\n QNIMClient.getUserManager().signInByName(\"zhangsan\", \"sFo!slk1x\", new BMXCallBack(){\n @Override\n public void onResult(BMXErrorCode bmxErrorCode) {\n \n }\n });\n 获取会话列表\n \n L/S: 通过传入BMXConversationList对象引用,调用成功后即可获取会话列表。\n BMXConversationList cl = QNIMClient.getChatService().getAllConversations();\n for (int i=0; i<cl.size(); i++){\n BMXConversation c = cl.get(i);\n Log.e(\"conversation id:\",\"\"+c.conversationId());\n }\n H/A: 在BMXDataCallBack回调中获取到会话列表。\n QNIMClient.getChatManager().getAllConversations(new BMXDataCallBack<BMXConversationList>() {\n @Override\n public void onResult(BMXErrorCode bmxErrorCode, BMXConversationList list) {\n //返回BMXConversation实例\n for (int i=0; i<cl.size(); i++){\n BMXConversation c = cl.get(i);\n Log.e(\"conversation id:\",\"\"+c.conversationId());\n }\n }\n });\n 断开连接\n \n L/S: 通过返回值获取到BMXErrorCode判断是否成功。\n QNIMClient.getUserService().signOut();\n H/A: 在BMXCallBack回调中根据BMXErrorCode判断。\n QNIMClient.getUserManager().signOut(new BMXCallBack(){\n @Override\n public void onResult(BMXErrorCode bmxErrorCode) {\n //返回BMXErrorCode\n }\n });\n \n\n### 用户体系\n\n### 添加好友\n\n \n \n L/S: 通过返回值获取到BMXErrorCode判断是否成功。 参数说明: rosterId reason(申请添加原因)\n QNIMClient.getRosterService().apply(22342342, \"Hi, I'm Lisi\");\n H/A: 在BMXCallBack回调中获取到BMXErrorCode判断是否成功。\n QNIMClient.getRosterManager().apply(22342342, \"Hi, I'm Lisi\", new BMXCallBack(){\n @Override\n public void onResult(BMXErrorCode bmxErrorCode) {\n //返回BMXErrorCode\n }\n });\n \n\n### 删除好友\n\n \n \n L/S: 通过返回值获取到BMXErrorCode判断是否成功。\n QNIMClient.getRosterService().remove(22342342);\n H/A: 在BMXCallBack回调中获取到BMXErrorCode判断是否成功。\n QNIMClient.getRosterManager().remove(22342342, new BMXCallBack(){\n @Override\n public void onResult(BMXErrorCode bmxErrorCode) {\n //返回BMXErrorCode\n }\n });\n \n\n### 同意添加好友\n\n \n \n L/S: 通过返回值获取到BMXErrorCode判断是否成功。\n //参数说明: rosterId\n QNIMClient.getRosterService().accept(333453112);\n H/A: 在BMXCallBack回调中获取到BMXErrorCode判断是否成功。\n QNIMClient.getRosterManager().accept(333453112, new BMXCallBack(){\n @Override\n public void onResult(BMXErrorCode bmxErrorCode) {\n //返回BMXErrorCode\n }\n });\n \n\n### 拒绝添加好友\n\n \n \n L/S: 通过返回值获取到BMXErrorCode判断是否成功。\n //参数说明: rosterId reason(拒绝原因)\n \n QNIMClient.getRosterService().decline(333453112,\"I'm not Lisi\");\n H/A: 在BMXCallBack回调中获取到BMXErrorCode判断是否成功。\n QNIMClient.getRosterManager().decline(333453112,\"I'm not Lisi\", new BMXCallBack(){\n @Override\n public void onResult(BMXErrorCode bmxErrorCode) {\n //返回BMXErrorCode\n }\n });\n \n\n### 获取花名册\n\n \n \n L/S: 通过传入ListOfLongLong对象引用, 调用成功后可获取rosterId的列表。\n ListOfLongLong roster = new ListOfLongLong();\n QNIMClient.getRosterService().get(roster, true);\n for (int i=0; i<roster.size(); i++){\n long roster_id = roster.get(i);\n Log.e(\"roster id:\",\"\"+roster_id);\n }\n H/A: 在BMXDataCallBack回调中获取rosterId列表。\n QNIMClient.getRosterManager().get(roster, true, new BMXDataCallBack<ListOfLongLong>(){\n @Override\n public void onResult(BMXErrorCode bmxErrorCode, ListOfLongLong list) {\n //返回ListOfLongLong实例\n for (int i=0; i<list.size(); i++){\n long roster_id = list.get(i);\n Log.e(\"roster id:\",\"\"+roster_id);\n }\n }\n });\n \n \n\n### 基础功能\n\n### 单聊\n\n单聊是指一对一的聊天功能，单聊的 BMXConversationType 是 BMXConversationSingle，toId 是单聊对象的\nuserId。\n\n### 聊天室\n\n聊天室是指附带角色和权限的用户集合内进行的内部广播方式的聊天功能，相比群聊，聊天室加入房间没有验证BMXConversationType 是\nBMXConversationGroup，toId 是群组 Id。\n\n### 创建聊天室\n\n \n \n L/S: 通过传入BMXGroup对象引用, 调用成功后可获取群信息。\n //参数说明: name（聊天室名字） group(群信息)\n \n \n \n BMXGroup group = new BMXGroup();\n QNIMClient.getChatRoomService().create(\"name\", group);\n H/A: 在BMXDataCallBack回调中获取群信息。\n QNIMClient.getChatRoomManager().create(\"name\", new BMXDataCallBack<BMXGroup>(){\n @Override\n public void onResult(BMXErrorCode bmxErrorCode, BMXGroup group) {\n //返回BMXGroup实例\n //取到groupid\n }\n });\n \n\n### 加入聊天室\n\n \n \n L/S: 通过返回值获取到BMXErrorCode判断是否成功。\n //参数说明: groupId(群id)\n \n \n QNIMClient.getChatRoomService().join(groupId);\n H/A: 在BMXCallBack回调中获取到BMXErrorCode判断是否成功。\n QNIMClient.getChatRoomManager().join(groupId, new BMXCallBack(){\n @Override\n public void onResult(BMXErrorCode bmxErrorCode) {\n //返回BMXErrorCode实例\n }\n });\n \n\n### 退出聊天室\n\n \n \n L/S: 通过返回值获取到BMXErrorCode判断是否成功。\n //参数说明: groupId(群id)\n \n QNIMClient.getChatRoomService().leave(groupId);\n H/A: 在BMXCallBack回调中获取到BMXErrorCode判断是否成功。\n QNIMClient.getChatRoomManager().leave(groupId, new BMXCallBack(){\n @Override\n public void onResult(BMXErrorCode bmxErrorCode) {\n //返回BMXErrorCode实例\n }\n });\n \n\n### 解散聊天室\n\n \n \n L/S: 通过返回值获取到BMXErrorCode判断是否成功。\n //参数说明: groupId(群id)\n QNIMClient.getChatRoomService().destroy(groupId);\n H/A: 在BMXCallBack回调中获取到BMXErrorCode判断是否成功。\n QNIMClient.getChatRoomManager().destroy(groupId, new BMXCallBack(){\n @Override\n public void onResult(BMXErrorCode bmxErrorCode) {\n //返回BMXErrorCode实例\n }\n });\n \n\n### 获取聊天室成员列表\n\n \n \n L/S: 通过传入BMXGroupMemberList对象引用, 调用成功后可获取群成员列表信息。\n //参数说明: groupId(群id) forceRefresh(是否从server获取)\n boolean forceRefresh = true;\n \n BMXGroupMemberList memberList = new BMXGroupMemberList();\n QNIMClient.getChatRoomService().getMembers(groupId, memberList, forceRefresh);\n H/A: 在BMXDataCallBack回调中获取群成员列表信息。\n QNIMClient.getChatRoomManager().getMembers(groupId, forceRefresh, new BMXDataCallBack<BMXGroupMemberList>(){\n @Override\n public void onResult(BMXErrorCode bmxErrorCode, BMXGroupMemberList list) {\n //返回BMXGroupMemberList实例\n }\n });\n \n\n### 群聊\n\n群聊是指附带角色和权限的用户集合内进行的内部广播方式的聊天功能， BMXConversationType 是\nBMXConversationGroup，toId 是群组 Id。 群组管理\n\n### 创建群组\n\n \n \n L/S: 通过传入BMXGroup对象引用, 调用成功后可获取群信息。\n //参数说明: option(群配置信息) group(群信息)\n \n BMXGroupService.CreateGroupOptions options = new BMXGroupService.CreateGroupOptions(name, desc, publicCheckStatus);\n options.setMMembers(members);\n \n BMXGroup group = new BMXGroup();\n QNIMClient.getGroupService().create(options, group);\n H/A: 在BMXDataCallBack回调中获取群信息。\n QNIMClient.getGroupManager().create(option, new BMXDataCallBack<BMXGroup>(){\n @Override\n public void onResult(BMXErrorCode bmxErrorCode, BMXGroup group) {\n //返回BMXGroup实例\n }\n });\n \n\n### 加入群组\n\n \n \n L/S: 通过返回值获取到BMXErrorCode判断是否成功。\n //参数说明: group(群信息) message(申请入群原因)\n QNIMClient.getGroupService().join(group, message);\n H/A: 在BMXCallBack回调中获取到BMXErrorCode判断是否成功。\n QNIMClient.getGroupManager().join(group, message, new BMXCallBack(){\n @Override\n public void onResult(BMXErrorCode bmxErrorCode) {\n //返回BMXErrorCode实例\n }\n });\n \n\n### 退出群组 参数说明: group(群信息)\n\n \n \n L/S: 通过返回值获取到BMXErrorCode判断是否成功。\n QNIMClient.getGroupService().leave(group);\n H/A: 在BMXCallBack回调中获取到BMXErrorCode判断是否成功。\n QNIMClient.getGroupManager().leave(group, new BMXCallBack(){\n @Override\n public void onResult(BMXErrorCode bmxErrorCode) {\n //返回BMXErrorCode实例\n }\n });\n \n\n### 解散群组\n\n \n \n L/S: 通过返回值获取到BMXErrorCode判断是否成功。\n //参数说明: group(群信息)\n QNIMClient.getGroupService().destroy(group);\n H/A: 在BMXCallBack回调中获取到BMXErrorCode判断是否成功。\n QNIMClient.getGroupManager().destroy(group, new BMXCallBack(){\n @Override\n public void onResult(BMXErrorCode bmxErrorCode) {\n //返回BMXErrorCode实例\n }\n });\n \n\n### 获取群成员列表\n\n \n \n L/S: 通过传入BMXGroupMemberList对象引用, 调用成功后可获取群成员列表信息。\n //参数说明: group(群信息) forceRefresh(是否从server获取)\n boolean forceRefresh = true;\n \n BMXGroupMemberList memberList = new BMXGroupMemberList();\n QNIMClient.getGroupService().getMembers(group, memberList, forceRefresh);\n H/A: 在BMXDataCallBack回调中获取群成员列表信息。\n QNIMClient.getGroupManager().getMembers(group, forceRefresh, new BMXDataCallBack<BMXGroupMemberList>(){\n @Override\n public void onResult(BMXErrorCode bmxErrorCode, BMXGroupMemberList list) {\n //返回BMXGroupMemberList实例\n }\n });\n \n\n### 获取群组列表\n\n \n \n L/S: 通过传入BMXGroupList对象引用, 调用成功后可获取群列表信息。\n //参数说明: forceRefresh(是否从server获取)\n BMXGroupList list = new BMXGroupList();\n QNIMClient.getGroupService().search(list, true);\n H/A: 在BMXDataCallBack回调中获取群列表信息。\n QNIMClient.getGroupManager().getGroupList(true, new BMXDataCallBack<BMXGroupList>(){\n @Override\n public void onResult(BMXErrorCode bmxErrorCode, BMXGroupList list) {\n //返回BMXGroupList实例\n }\n });\n \n\n### 获取群组信息\n\n \n \n L/S: 通过传入BMXGroup对象引用, 调用成功后可获取群信息。\n //参数说明: groupId forceRefresh(是否从server获取)\n BMXGroup bmxGroup = new BMXGroup();\n QNIMClient.getGroupService().search(mGroupId, bmxGroup, true);\n H/A: 在BMXDataCallBack回调中获取群信息。\n QNIMClient.getGroupManager().getGroupList(mGroupId, true, new BMXDataCallBack<BMXGroup>(){\n @Override\n public void onResult(BMXErrorCode bmxErrorCode, BMXGroup group) {\n //返回BMXGroup实例\n }\n });\n \n\n### 消息发送\n\n登录成功之后才能进行聊天操作。发消息时，单聊和群聊调用的是统一接口，区别只是要设置下 BMXConversationType 消息的远程推送\n\n开发者配置好远程推送的证书，且在代码中申请好权限，并将 deviceToken\n传给MaxIM服务器，当接收者不在线的时候，MaxIM服务器会自动通过远程推送将消息发过去。 注： 推送的内容由发送消息接口的 pushContent\n字段决定，内置消息发送的时候如果该字段没有值，将使用默认内容推送；自定义消息必须设置该字段，否则将不会推送。 deviceToken传给MaxIM接口\n\n \n \n L/S: 通过返回值获取到BMXErrorCode判断是否成功。\n //参数说明: pushToken(推送token)\n QNIMClient.getUserService().bindDevice(pushToken);\n H/A: 在BMXCallBack回调中获取到BMXErrorCode判断是否成功。\n QNIMClient.getUserManager().bindDevice(pushToken, new BMXCallBack(){\n @Override\n public void onResult(BMXErrorCode bmxErrorCode) {\n //返回BMXErroeCode实例\n }\n });\n \n \n\n### 消息内容格式\n\n### 文本消息\n\n \n \n //参数说明: from(发送者id) to(接收者id) type(单群聊类型) text(文本内容)\n BMXMessage msg = BMXMessage.createMessage(from, to, type, to, text);\n 图片消息\n \n //参数说明: from(发送者id) to(接收者id) type(单群聊类型) w(图片宽) h(图片高) path(图片本地路径) size(图片大小)\n \n BMXImageAttachment.Size size = new BMXMessageAttachment.Size(w, h);\n BMXImageAttachment imageAttachment = new BMXImageAttachment(path, size);\n BMXMessage msg = BMXMessage.createMessage(from, to, type, to, imageAttachment);\n 文件消息\n \n 参数说明: from(发送者id) to(接收者id) type(单群聊类型) path(文件本地路径) name(文件名称)\n BMXFileAttachment fileAttachment = new BMXFileAttachment(path, name);\n BMXMessage msg = BMXMessage.createMessage(from, to, type, to, fileAttachment);\n 位置消息\n \n 参数说明: from(发送者id) to(接收者id) type(单群聊类型) latitude(纬度) longitude(经度) address(地址)\n BMXLocationAttachment locationAttachment = new BMXLocationAttachment(latitude, longitude, address);\n BMXMessage msg = BMXMessage.createMessage(from, to, type, to, locationAttachment);\n 语音消息\n \n 参数说明: from(发送者id) to(接收者id) type(单群聊类型) path(语音本地路径) time(语音时长)\n BMXVoiceAttachment voiceAttachment = new BMXVoiceAttachment(path, time);\n BMXMessage msg = BMXMessage.createMessage(from, to, type, to, voiceAttachment);\n 消息操作\n \n 发送\n L/S:\n //参数说明: BMXMessage(消息实体)\n QNIMClient.getChatService().sendMessage(msg);\n H/A:\n //发送消息状态，需要注册消息接收监听\n QNIMClient.getChatManager().sendMessage(msg);\n 转发\n L/S:\n //参数说明: BMXMessage(消息实体)\n QNIMClient.getChatService().forwardMessage(msg);\n H/A:\n //发送消息状态，需要注册消息接收监听\n //参数说明: BMXMessage(消息实体)\n QNIMClient.getChatManager().forwardMessage(msg);\n 重发\n L/S:\n //参数说明: BMXMessage(消息实体)\n QNIMClient.getChatService().resendMessage(msg);\n H/A:\n //发送消息状态，需要注册消息接收监听\n QNIMClient.getChatManager().resendMessage(msg);\n 撤回\n L/S:\n //参数说明: BMXMessage(消息实体)\n QNIMClient.getChatService().recallMessage(msg);\n H/A:\n //发送消息状态，需要注册消息接收监听\n QNIMClient.getChatManager().recallMessage(msg);\n 下载消息附件\n 调用说明: 在FileCallBack中传入下载url,onProgress获取下载进度,onFail返回下载失败,onFinish返回成功的路径。\n QNIMClient.getChatManager().downloadAttachment(message, new FileCallback(body.url()) {\n @Override\n protected void onProgress(long percent, String path, boolean isThumbnail) {\n }\n \n @Override\n protected void onFinish(String url, boolean isThumbnail) {\n BMImageLoader.getInstance().display(mImageView, \"file://\" + body.path(), mImageConfig);\n }\n \n @Override\n protected void onFail(String path, boolean isThumbnail) {\n }\n });\n \n\n### 消息接收监听\n\n### 注册消息回调\n\n \n \n private BMXChatServiceListener mChatListener = new BMXChatServiceListener() {\n \n @Override\n public void onStatusChanged(BMXMessage msg, BMXErrorCode error) {\n //消息状态更新\n }\n \n @Override\n public void onAttachmentStatusChanged(BMXMessage msg, BMXErrorCode error, int percent) {\n //附件状态更新\n }\n \n @Override\n public void onRecallStatusChanged(BMXMessage msg, BMXErrorCode error) {\n //撤回状态更新\n }\n \n @Override\n public void onReceive(BMXMessageList list) {\n //收到消息\n }\n \n @Override\n public void onReceiveSystemMessages(BMXMessageList list) {\n //收到系统通知\n }\n \n @Override\n public void onReceiveReadAcks(BMXMessageList list) {\n //收到已读回执\n }\n \n @Override\n public void onReceiveDeliverAcks(BMXMessageList list) {\n //收到消息到达回执\n }\n \n @Override\n public void onReceiveRecallMessages(BMXMessageList list) {\n //收到撤回消息通知\n }\n \n @Override\n public void onAttachmentUploadProgressChanged(BMXMessage msg, int percent) {\n //附件上传进度更新\n }\n \n };\n \n \n\n### 混淆\n\n \n \n 在 ProGuard 文件中加入：-keep class im.floo.floolib.**{*;}\n \n\n### 功能进阶\n\nBMXMessageObject实体中，提供可扩展属性(extensionJson 和 configJson) extensionJson\n为开发使用的扩展字段，例如编辑状态。 configJson 为SDK自用的扩展字段，例如mention功能，push功能 群组@功能 群组中支持 @\n功能，满足您 @ 指定用户或 @所有人的需求，开发者在BMXMessage中通过设置config字段来实现群主@功能，已经@成员后的会下发推送通知\n\n \n \n // 文本功能添加@对象\n if (atMap != null && !atMap.isEmpty()) {\n MentionBean mentionBean = new MentionBean();\n mentionBean.setSenderNickname(senderName);\n mentionBean.setPushMessage(pushText);\n // @对象的存储信息 包括全部成员或者部分成员\n if (atMap.containsKey(\"-1\")) {\n // @全部\n String atTitle = atMap.get(\"-1\");\n if (!TextUtils.isEmpty(atTitle) && text.contains(atTitle)) {\n // 如果包含全部直接走全部 还需要判断文本消息是否包含完成的@名称 如果没有就不触发@\n mentionBean.setMentionAll(true);\n }\n } else {\n // @部分成员 需要遍历添加@信息\n List<Long> atIds = new ArrayList<>();\n mentionBean.setMentionAll(false);\n for (Map.Entry<String, String> entry : atMap.entrySet()) {\n // 发送文字包含@对象的名称时再加入 防止输入框@对象名称被修改\n if (entry.getValue() != null && !TextUtils.isEmpty(entry.getValue())\n && text.contains(entry.getValue())) {\n // @部分成员 feed信息只需要feedId和userId 所以需要去除无用的信息\n atIds.add(Long.valueOf(entry.getKey()));\n }\n }\n mentionBean.setMentionList(atIds);\n }\n msg.setConfig(new Gson().toJson(mentionBean));\n }\n 消息正在输入状态\n String INPUT_STATUS = \"input_status\";\n \n interface InputStatus {\n // 空\n String NOTHING_STATUS = \"nothing\";\n \n // 键盘弹起\n String TYING_STATUS = \"typing\";\n }\n \n String extension = \"\";\n try {\n JSONObject object = new JSONObject();\n object.put(INPUT_STATUS,\n tag == MessageInputBar.OnInputPanelListener.TAG_OPEN\n ? InputStatus.TYING_STATUS\n : InputStatus.NOTHING_STATUS);\n extension = object.toString();\n } catch (JSONException e) {\n e.printStackTrace();\n }\n \n BMXMessage msg = BMXMessage.createMessage(from, to, type, to, \"\");\n if (msg == null) {\n return null;\n }\n msg.setDeliveryQos(BMXMessage.DeliveryQos.AtMostOnce);\n msg.setExtension(extension);\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的即时通讯im安卓消息推送集成指南"
},
{
"from": "gpt",
"value": "[即时通讯](https://developer.qiniu.com/IM) > 使用指南 >\n[安卓快速集成指南](https://developer.qiniu.com/IM/development_guidelines/8168/android-\nrapid-integration-guide) > im安卓消息推送集成指南\n\n# im安卓消息推送集成指南\n\n最近更新时间: 2022-07-22 22:34:16\n\n# 推送开发指南（PUSH）\n\n### 推送 SDK 集成说明\n\n七牛IM推送是基于七牛IM技术基础上研发，只需要一次集成，就可以同时拥有推送和IM两大服务，提高研发效率的同时，也会极大降低企业的 IT 支出。\n\n使用七牛IM推送没有额外费用。\n\n由于默认即支持各主流厂商通道，为了进一步减低集成难度，七牛IM推送实现时也内置了证书设置与更新机制。简单来说，就是开发者集成七牛IM推送之后，只需要在控制台设置好各厂商推送的证书，前端将厂商推送\nSDK 打包，即可自动完成系统厂商的适配。不再需要针对性调整各种推送令牌的申请和设置。\n\n注意：与其他推送厂商不同的是，七牛IM推送 SDK 专注于推送通道的建设和服务，并不会收集终端信息，如果你有类似广告业务，需要单独集成广告\nSDK，或者将业务数据标签通过接口设置后才能使用。\n\n如前所述，由于七牛IM推送 SDK 与 IM SDK 是同一个 SDK，推送功能只是在原有 IM SDK 基础上增加了推送接口。因此集成方式均与 IM\nSDK 相同，快速集成文档亦可参见七牛IM安卓端快速集成，七牛IM iOS 端快速集成。\n\n### SDK 架构\n\n推送功主要涉及以下三个类：\n\n \n \n BMXClient\n |----BMXPushService\n |----BMXPushServiceListener\n |----BMXPushManager\n \n\n其中 BMXPushService、BMXPushManager 均为推送设置类，前者是同步调用类，后者异步调用类，实现时根据需要在两者中二选一即可。\n\n其他功能类分别是：\n\n * BMXCallBack : 无类型接口回调\n * BMXDataCallBack : 泛型类型带数据回调\n * BMXPushServiceListener : 推送事件监听\n * BMXMessage : 推送消息\n * BMXUserProfile : 推送用户信息\n\n下文以安卓 SDK 为例介绍推送 API。\n\n### 权限配置\n\n在AndroidManifest.xml 里增加加以下权限：\n\n \n \n <uses-permission android:name=\"android.permission.ACCESS_NETWORK_STATE\" />\n <uses-permission android:name=\"android.permission.INTERNET\" />\n <uses-permission android:name=\"android.permission.ACCESS_FINE_LOCATION\" />\n <uses-permission android:name=\"android.permission.ACCESS_COARSE_LOCATION\" />\n <uses-permission android:name=\"android.permission.ACCESS_LOCATION_EXTRA_COMMANDS\" />\n <uses-permission android:name=\"android.permission.WRITE_EXTERNAL_STORAGE\" />\n <uses-permission android:name=\"android.permission.READ_EXTERNAL_STORAGE\" />\n <uses-permission android:name=\"android.permission.WRITE_CONTACTS\" />\n <uses-permission android:name=\"android.permission.CAMERA\" />\n <uses-permission android:name=\"android.permission.READ_PHONE_STATE\" />\n <uses-permission android:name=\"android.permission.ACCESS_WIFI_STATE\" />\n <uses-permission android:name=\"android.permission.CHANGE_WIFI_STATE\" />\n <uses-permission android:name=\"android.permission.RECORD_AUDIO\" />\n <uses-permission android:name=\"android.permission.VIBRATE\" />\n <uses-permission android:name=\"android.permission.CALL_PHONE\" />\n <uses-permission android:name=\"android.permission.READ_CONTACTS\" />\n <uses-permission android:name=\"android.permission.WAKE_LOCK\" />\n \n\n### 快速集成\n\n#### BMXClient初始化\n\n * 在app入口类中导入so库文件：\n\n \n \n static {\n System.loadLibrary(\"floo\");\n }\n \n\n * 初始化BMXClient\n\n \n \n public static void initClient(int index) {\n \n String appPath = AppContextUtils.getAppContext().getFilesDir().getPath();\n File dataPath = new File(appPath + \"/data_dir\");\n File cachePath = new File(appPath + \"/cache_dir\");\n dataPath.mkdirs();\n cachePath.mkdirs();\n \n String pushId = getPushId();//设置推送平台对应的ID\n BMXSDKConfig conf = new BMXSDKConfig(BMXClientType.Android, \"1\", dataPath.getAbsolutePath(),\n cachePath.getAbsolutePath(), TextUtils.isEmpty(pushId) ? \"MaxIM\" : pushId);\n conf.setConsoleOutput(true);\n conf.setLogLevel(BMXLogLevel.Debug);\n //设置推送appId\n conf.setAppID(\"appId\");\n //设置推送secret\n conf.setAppSecret(\"appSecret\");\n //设置设备的唯一设备id\n conf.setDeviceUuid(deviceId);\n //设置生产环境\n conf.setEnvironmentType(BMXPushEnvironmentType.Production);\n //根据设备机型设置pushProviderType\n conf.setPushProviderType(getProviderType(context));\n BMXSDKConfig.HostConfig hostConfig = new BMXSDKConfig.HostConfig(\"sync.maxim.top\", 443, \"https://api.maxim.top\");\n conf.setHostConfig(hostConfig);\n //初始化QNIMClient实例\n \n QNIMClient.init(conf)\n }\n \n \n //根据机型获取type\n private static BMXPushProviderType getProvideType(Context context){\n if (isHuawei(context)) {\n return BMXPushProviderType.HuaWei;\n }\n if (isXiaomi(context)) {\n return BMXPushProviderType.XiaoMi;\n }\n if (isMeizu(context)) {\n return BMXPushProviderType.MeiZu;\n }\n if (isOppo(context)) {\n return BMXPushProviderType.OPPS;\n }\n if (isVivo(context)) {\n return BMXPushProviderType.VIVO;\n }\n return BMXPushProviderType.Unknown;\n }\n \n\n#### 高级调用形式\n\n * BMXPushManager: 通过QNIMClient.getPushManager()获取到推送的manager对象。\n\n#### 开启推送\n\n参数说明: alias(push别名), bmxToken(推送token) callBack\n\n \n \n 如果不传入alias SDK会自动生成\n 如果不传入token SDK会自动生成并通过BMXPushServiceListener回调\n \n \n \n 同步调用形式\n 调用说明: 通过返回值BMXErrorCode判断是否成功。\n \n QNIMClient.getPushService().start();//不传入参数\n QNIMClient.getPushService().start(\"zhangsan\");//传入alias\n QNIMClient.getPushService().start(\"zhangsan\", token);//传入alias token\n 异步调用形式\n 调用说明: 通过QNIMClient.getPushManager()获取manager对象,在BMXCallBack回调中返回BMXErrorCode 判断是否成功。\n \n //不传入参数\n QNIMClient.getPushManager().start(new BMXCallBack<>(){\n @Override\n public void onResult(BMXErrorCode bmxErrorCode) {\n \n }\n \t});\n //传入alias\n QNIMClient.getPushManager().start(\"zhangsan\",new BMXCallBack<>(){\n @Override\n public void onResult(BMXErrorCode bmxErrorCode) {\n \n }\n });\n //传入alias token\n QNIMClient.getPushManager().start(\"zhangsan\", token, new BMXCallBack<>(){\n @Override\n public void onResult(BMXErrorCode bmxErrorCode) {\n \n }\n });\n \n\n#### 停止推送\n\n参数说明: callBack\n\n \n \n 同步调用\n 调用说明: 通过返回值BMXErrorCode判断是否成功。\n \n QNIMClient.getPushService().stop();\n 异步调用\n 调用说明: 通过QNIMClient.getPushManager()获取manager对象,在BMXCallBack回调中返回BMXErrorCode 判断是否成功。\n \n QNIMClient.getPushManager().stop(new BMXCallBack(){\n \t @Override\n public void onResult(BMXErrorCode bmxErrorCode) {\n \n }\n \t});\n \n\n#### 唤起推送\n\n \n \n 同步调用\n 调用说明: 通过返回值BMXErrorCode判断是否成功。\n \n QNIMClient.getPushService().resume();\n \n 异步调用\n 调用说明: 通过QNIMClient.getPushManager()获取manager兑现, 在BMXCallBack回调中返回BMXErrorCode 判断是否成功。\n \n QNIMClient.getPushManager().remuse(new BMXCallBack<>() {\n @Override\n public void onResult(BMXErrorCode bmxErrorCode) {\n }\n });\n \n\n#### 获取推送的状态\n\n返回值说明: public static enum PushSdkStatus { Starting(1), Started, Stoped,\nOffline; }\n\n \n \n 同步调用:\n \n BMXPushService.PushSdkStatus status = QNIMClient.getPushService().status();\n \n 异步调用:\n \n BMXPushService.PushSdkStatus status = QNIMClient.getPushManager().status();\n \n\n#### 解绑别名\n\n参数说明: alias(push别名)\n\n \n \n 同步调用\n 调用说明: 通过返回值BMXErrorCode判断是否成功。\n \n QNIMClient.getPushService().unbindAlias(alias);\n 异步调用\n 调用说明: 通过QNIMClient.getPushManager()获取manager对象,在BMXCallBack回调中返回BMXErrorCode 判断是否成功。\n \n QNIMClient.getPushManager().unbindAlias(alias, new BMXCallBack(){\n @Override\n public void onResult(BMXErrorCode bmxErrorCode) {\n \n }\n });\n \n\n#### 获取token\n\n \n \n 需要在start成功之后调用才有值\n \n 同步调用:\n \n String token = QNIMClient.getPushService().getToken();\n \n 异步调用:\n \n String token = QNIMClient.getPushManager().getToken();\n \n\n#### 获取cert\n\n \n \n 需要在start成功之后调用才有值, 同时需要在对应厂商注册证书并且设置对应的provideType才可获取到\n 目前支持 华为 小米 魅族 oppo vivo\n \n 同步调用:\n \n String cert = QNIMClient.getPushService().getCert();\n \n 异步调用:\n \n String cert = QNIMClient.getPushManager().getCert();\n \n\n#### 绑定厂商token\n\n参数说明: token(注册厂商推送返回的token)\n\n \n \n 同步调用\n 调用说明: 通过返回值BMXErrorCode判断是否成功。\n \n QNIMClient.getPushService().bindDeviceToken(token);\n 异步调用\n 调用说明: 通过QNIMClient.getPushManager()获取manager对象,在BMXCallBack回调中返回BMXErrorCode 判断是否成功。\n \n QNIMClient.getPushManager().bindDeviceToken(token, new BMXCallBack(){\n @Override\n public void onResult(BMXErrorCode bmxErrorCode) {\n \n }\n });\n \n\n#### 获取推送用户信息\n\n参数说明: forceRefresh(是否从server拉取)\n\n \n \n 同步调用\n 调用说明: 通过传入BMXPushUserProfile对象引用, 调用成功后可获取推送用户信息。\n \n BMXPushUserProfile profile = new BMXPushUserProfile();\n QNIMClient.getPushService().getPushProfile(profile, forceRefresh);\n 异步调用\n 调用说明: 通过QNIMClient.getPushManager()获取到manager对象, 在BMXDataCallBack<BMXPushUserProfile>回调中获取推送用户信息。\n \n QNIMClient.getPushManager().getPushProfile(forceRefresh, new BMXDataCallBack<BMXPushUserProfile>(){\n @Override\n public void onResult(BMXErrorCode bmxErrorCode, BMXPushUserProfile profile) {\n //返回BMXPushUserProfile实例\n }\n });\n \n\n### 高级接口\n\n#### 设置推送标签（tag）\n\n参数说明: tags(tag列表) operationId(此次操作的唯一id 手动生成唯一标识)\n\n \n \n TagList tags = new TagList();\n tags.add(\"tag内容\");\n \n 同步调用\n 调用说明: 通过返回值BMXErrorCode判断是否成功。\n \n QNIMClient.getPushService().setTags(tags, operationId);\n 异步调用\n 调用说明: 通过QNIMClient.getPushManager()获取manager对象,在BMXCallBack回调中返回BMXErrorCode 判断是否成功。\n \n QNIMClient.getPushManager().setTags(tags, operationId, new BMXCallBack(){\n @Override\n public void onResult(BMXErrorCode bmxErrorCode) {\n \n }\n });\n \n\n#### 获取推送标签（tag）列表\n\n参数说明: operationId(此次操作的唯一id 手动生成唯一标识)\n\n调用说明: 通过传入TagList对象引用, 调用成功后可获取tag列表信息。\n\n \n \n 同步调用\n \n TagList tags = new TagList();\n QNIMClient.getPushService().getTags(tags, operationId);\n \n 异步调用\n 调用说明: 通过QNIMClient.getPushManager()获取到manager对象, 在BMXCallBack回调中返回BMXErrorCode 判断是否成功。\n \n TagList tags = new TagList();\n QNIMClient.getPushManager().getTags(tags, operationId, new BMXCallBack<>(){\n @Override\n public void onResult(BMXErrorCode bmxErrorCode) {\n \n }\n });\n \n\n#### 删除推送标签（tag）\n\n参数说明: operationId(此次操作的唯一id 手动生成唯一标识)\n\n \n \n TagList tags = new TagList();\n tags.add(\"tag内容\");\n \n 同步调用\n \n QNIMClient.getPushService().deleteTags(tags, operationId);\n \n 异步调用\n 调用说明: 通过QNIMClient.getPushManager()获取到manager对象, 在BMXCallBack回调中返回BMXErrorCode 判断是否成功。\n \n QNIMClient.getPushManager().deleteTags(tags, operationId, new BMXCallBack<>(){\n @Override\n public void onResult(BMXErrorCode bmxErrorCode) {\n \n }\n });\n \n\n#### 清除所有标签（tag）\n\n参数说明: operationId(此次操作的唯一id 手动生成唯一标识)\n\n \n \n 同步调用\n \n QNIMClient.getPushService().clearTags(operationId);\n \n 异步调用\n 调用说明: 通过QNIMClient.getPushManager()获取到manager对象, 在BMXCallBack回调中返回BMXErrorCode 判断是否成功。\n \n QNIMClient.getPushManager().clearTags(operationId, new BMXCallBack<>(){\n @Override\n public void onResult(BMXErrorCode bmxErrorCode) {\n \n }\n });\n \n\n#### 设置推送开关\n\n参数说明: enable(boolean 推送开关)\n\n \n \n 同步调用\n \n QNIMClient.getPushService().setPushMode(enable);\n \n 异步调用\n 调用说明: 通过QNIMClient.getPushManager()获取到manager对象, 在BMXCallBack回调中返回BMXErrorCode 判断是否成功。\n \n QNIMClient.getPushManager().setPushMode(enable, new BMXCallBack<>(){\n @Override\n public void onResult(BMXErrorCode bmxErrorCode) {\n \n }\n });\n \n\n#### 设置推送时间\n\n参数说明: startHour(推送开启时间) endHour(推送结束时间) 24小时制 设置每天的推送时间区间\n\n \n \n 同步调用\n \n QNIMClient.getPushService().setPushTime(startHour, endHour);\n \n 异步调用\n 调用说明: 通过QNIMClient.getPushManager()获取到manager对象, 在BMXCallBack回调中返回BMXErrorCode 判断是否成功。\n \n QNIMClient.getPushManager().setPushTime(startHour, endHour, new BMXCallBack<>(){\n @Override\n public void onResult(BMXErrorCode bmxErrorCode) {\n \n }\n });\n \n\n#### 设置推送静默时间\n\n参数说明: startHour(推送开启时间) endHour(推送结束时间) 24小时制 设置每天的不推送时间区间\n\n \n \n 同步调用\n \n QNIMClient.getPushService().setSilenceTime(startHour, endHour);\n \n 异步调用\n 调用说明: 通过QNIMClient.getPushManager()获取到manager对象, 在BMXCallBack回调中返回BMXErrorCode 判断是否成功。\n \n QNIMClient.getPushManager().setSilenceTime(startHour, endHour, new BMXCallBack<>(){\n @Override\n public void onResult(BMXErrorCode bmxErrorCode) {\n \n }\n });\n \n\n#### 发送推送消息\n\n参数说明: content(推送内容)\n\n \n \n 同步调用\n \n QNIMClient.getPushService().sendMessage(content);\n \n 异步调用\n \n QNIMClient.getPushManager().sendMessage(content);\n \n\n#### 获取推送的消息列表\n\n参数说明: refMsgId(起始消息id 第一次传0) size(获取的消息数量)\n\n \n \n 同步调用\n 调用说明: 通过传入BMXMessageList对象引用, 调用成功后可获取推送消息列表。\n \n BMXMessageList messageList = new BMXMessageList();\n QNIMClient.getPushService().loadLocalPushMessages(refMsgId, size, messageList);\n 异步调用\n 调用说明: 通过QNIMClient.getPushManager()获取到manager对象, 在BMXCallBack回调中返回BMXErrorCode 判断是否成功。\n \n BMXMessageList messageList = new BMXMessageList();\n QNIMClient.getPushManager().loadLocalPushMessages(refMsgId, size, messageList, new BMXCallBack<>(){\n @Override\n public void onResult(BMXErrorCode bmxErrorCode) {\n }\n });\n \n\n### 设置监听\n\n * 注册推送回调\n\n \n \n 同步调用:\n QNIMClient.getPushService().addPushListener(mListener);\n \n 异步调用:\n QNIMClient.getPushManager().addPushListener(mListener);\n \n\n * 移除推送回调\n\n \n \n 同步调用:\n QNIMClient.getPushService().removePushListener(mListener);\n \n 异步调用:\n QNIMClient.getPushManager().removePushListener(mListener);\n \n\n * 回调示例\n\n \n \n private BMXPushServiceListener mListener = new BMXPushServiceListener() {\n \n @Override\n public void onPushStart(String bmxToken) {\n super.onPushStart(bmxToken);\n //推送开启返回token\n Log.d(TAG, \"onPushStart\" + bmxToken);\n }\n \n @Override\n public void onPushStop() {\n super.onPushStop();\n Log.d(TAG, \"onPushStop\");\n }\n \n @Override\n public void onGetTags(String operationId) {\n super.onGetTags(operationId);\n Log.d(TAG, \"onGetTags\" + operationId);\n }\n \n @Override\n public void onSetTags(String operationId) {\n super.onSetTags(operationId);\n Log.d(TAG, \"onSetTags\" + operationId);\n }\n \n @Override\n public void onDeleteTags(String operationId) {\n super.onDeleteTags(operationId);\n Log.d(TAG, \"onDeleteTags\" + operationId);\n }\n \n @Override\n public void onClearTags(String operationId) {\n super.onClearTags(operationId);\n Log.d(TAG, \"onClearTags\" + operationId);\n }\n \n @Override\n public void onStatusChanged(BMXMessage msg, BMXErrorCode error) {\n super.onStatusChanged(msg, error);\n Log.d(TAG, \"onStatusChanged\" + msg.content());\n }\n \n @Override\n public void onReceivePush(BMXMessageList list) {\n super.onReceivePush(list);\n Log.d(TAG, \"onReceivePush\");\n }\n \n @Override\n public void onCertRetrieved(String cert) {\n super.onCertRetrieved(cert);\n Log.d(TAG, \"onCertRetrieved\" + cert);\n //返回厂商注册的证书 获取到证书之后可以对厂商的push通道进行注册\n }\n };\n \n\n### 厂商推送集成\n\n各平台集成只需要按照平台推送文档将集成SDK放入应用中, 对应的配置按照平台要求配置即可（华为除外）。\n\n#### 华为\n\n需要按照华为推送平台设置\n[华为推送](https://developer.huawei.com/consumer/cn/doc/development/HMSCore-\nGuides/android-app-quickstart-0000001071490422)\n\n 1. project级别的build.gradle文件增加\n\n \n \n repositories {\n google()\n jcenter()\n maven {\n url 'https://developer.huawei.com/repo/'\n }\n }\n \n allprojects {\n repositories {\n google()\n jcenter()\n maven {\n url 'https://developer.huawei.com/repo/'\n }\n }\n }\n \n\n 1. app级别build.gradle\n\n \n \n apply plugin: 'com.huawei.agconnect'\n dependencies{\n implementation \"com.huawei.hms:push:5.0.4.302\"\n }\n \n\n 1. 最后从推送平台下载 agconnect-services.json，放入app目录下。\n\n#### 小米\n\n按照小米推送平台集成 [小米推送](https://dev.mi.com/console/doc/detail?pId=230)\n\n#### Oppo\n\n按照OPPO推送平台集成 [oppo推送](https://open.oppomobile.com/wiki/doc#id=10195)\n\n#### 魅族\n\n按照魅族推送平台集合 [魅族推送](http://open-wiki.flyme.cn/doc-wiki/index)\n\n#### 谷歌推送（FCM）\n\nGoogle推送指南 [FCM](https://firebase.google.cn/docs/cloud-\nmessaging/android/client?hl=zh-cn)\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的即时通讯IM Web SDK 快速集成指南"
},
{
"from": "gpt",
"value": "[即时通讯](https://developer.qiniu.com/IM) > 使用指南 > IM Web SDK 快速集成指南\n\n# IM Web SDK 快速集成指南\n\n最近更新时间: 2022-06-17 10:47:11\n\n## 前期准备\n\nDEMO 地址：https://github.com/pili-engineering/QNWebIMSDK\n\nSDK 文件下载地址：https://github.com/pili-engineering/QNWebIMSDK/tree/main/src/sdk\n\n## 引入 SDK\n\n我们提供了两种方式引入方式，您可以直接下载 JS 文件，也可以通过 npm 完成引入\n\n### NPM 安装\n\n运行下方的命令即可通过 npm 引入我们的 SDK\n\n \n \n $ npm install qnweb-im\n \n\n如果想要更新到最新版本或者指定版本，运行下列命令\n\n \n \n $ npm install qnweb-im@latest\n $ npm install [email protected] # 指定版本\n \n\n> 我们更加推荐您使用 yarn 来管理 npm 模块\n>\n> 通过 yarn add qnweb-im 引入 SDK，通过 yarn add qnweb-im@latest 来更新版本\n\n安装好后，运行以下代码访问 SDK 的入口\n\n \n \n import * as QNIM from \"qnweb-im\";\n console.log(\"current version is\", QNIM.version);\n \n\n运行时看到打印的 current version 表示引入成功\n\n### 直接导入 JS 文件\n\n每次发布版本，我们都会将最新的 SDK JS 文件放在我们的 [Github __](https://github.com/pili-\nengineering/QNWebIMSDK)上，点击链接即可获取当前最新的 SDK JS 文件。 所以，每次想要升级版本时，只需要访问我们的[Github\n__](https://github.com/pili-engineering/QNWebIMSDK)页面，然后替换一下自己的 js 文件即可。\n\nSDK 的 JS 文件在导入页面后，会自动创建一个全局对象 QNIM，这个对象的成员包括了 SDK 所导出的所有模块和对象。\n\n \n \n // 当页面资源加载完成后\n window.onload = () => {\n console.log(\"current version is\", QNIM.version);\n }\n \n\n运行时看到打印的 current version 表示引入成功。\n\n## 快速集成\n\n### 一、初始化\n\n首先设置 AppID\n\n \n \n const config = {\n appid: \"YOUR_APP_ID\",\n ws: false,\n autoLogin: true\n };\n \n\n然后创建im对象，供全局调用。\n\n \n \n const im = QNIM.init(config);\n \n\n### 二、注册用户\n\n通过 im 的 rosterManage asyncRegester 来注册用户\n\n \n \n im.rosterManage.asyncRegester(this.user).then((response) => {\n console.log(\"注册成功\", response);\n }).catch(ex => {\n console.log(ex.message);\n });\n \n\n### 三、登录链接服务器\n\n如果SDK设置了autoLogin为true，那么在第一次登录之后再次打开或刷新页面，将不用再登录。 第一次登录，调用im.login\n\n \n \n im.login({\n user,\n password,\n });\n \n\n可监听登录信息或进度：\n\n \n \n im.on({\n 'loginMessage': message => {console.log(message)}\n });\n \n\n### 四、获取会话列表\n\n直接调用userManage的getConversationList，返回包括name、id、类型、未读等列表\n\n \n \n const list = im.userManage.getConversationList();\n console.log(list);\n \n\n### 五、断开连接\n\nim的登录信息存储在localstorage，只要删除刷新即可，可自己实现\n\n \n \n window.localStorage.clear();\n window.location.reload();\n \n\n## 用户好友\n\n### 添加好友\n\n调用 im.rosterManage 的 asyncApply 方法：\n\n \n \n im.rosterManage.asyncApply({ user_id, alias })\n .then(() => {\n console.log(\"请求已发送成功!\");\n });\n \n\n### 删除好友\n\n调用 rosterManage 的 asyncDeleteRoster 方法删除好友\n\n \n \n im.rosterManage.asyncDeleteRoster({ user_id })\n .then(() => {\n console.log(\"好友已删除\");\n });\n \n\n### 同意添加好友\n\n调用 rosterManage 的 asyncAccept 方法来同意好友申请\n\n \n \n im.rosterManage.asyncAccept({ user_id }).then(() => {\n console.log(\"您已通过该好友的申请\");\n });\n \n\n### 拒绝添加好友\n\n调用 rosterManage 的 asyncDecline 方法来拒绝好友申请\n\n \n \n im.rosterManage.asyncDecline({ user_id }).then(() => {\n console.log(\"您已拒绝该好友的申请\");\n });\n \n\n### 获取好友列表\n\n调用 rosterManage 的 getAllRosterDetail 方法来获取好友列表\n\n \n \n const list = im.rosterManage.getAllRosterDetail();\n \n\n监听 onRosterListUpdate 可即时的得知用户列表的改变\n\n \n \n im.on({\n onRosterListUpdate: function() {\n const list = im.rosterManage.getAllRosterDetail();\n }\n })\n \n\n## 基础功能\n\n### 单聊\n\n单聊是最基本的聊天界面，提供文字、表情、图片等多种输入内容。\n\n### 群聊\n\n群组的聊天，是多人一起参与的聊天。\n\n 1. 创建群组\n\n调用 groupManage 的 asyncCreate 方法来创建一个群组\n\n \n \n im.groupManage\n .asyncCreate({\n name,\n type, // 是否 pulbic， 0， 1\n avatar,\n description,\n user_list, // user ids\n })\n .then(() => {\n console.log(\"群创建成功\");\n });\n \n\n 1. 加入群组\n\n调用 groupManage 的 asyncApply 方法来申请加入一个群组\n\n \n \n im.groupManage\n .asyncApply({ group_id, reason })\n .then(() => {\n console.log(\"请求已发送成功!\");\n });\n \n\n 1. 退出群组\n\n调用 groupManage 的 asyncLeave 方法来退出群组\n\n \n \n im.groupManage\n . asyncLeave({ group_id })\n .then(() => {\n console.log(\"已退出群组\");\n });\n \n\n 1. 解散群组\n\n调用 groupManage 的 asyncDestroy 方法来申请加入一个群组\n\n \n \n im.groupManage\n .asyncDestroy({ group_id })\n .then(() => {\n console.log(\"群组已解散\");\n });\n \n\n 1. 获取群成员列表\n\n调用 groupManage 的 getGroupMembers 方法来获取所有成员列表\n\n \n \n const members = im.groupManage.getGroupMembers(state.sid);\n console.log(members);\n \n\n 1. 获取群组列表 调用 groupManage 的 asyncGetJoinedGroups 方法来获取所有用户加入的群组\n\n \n \n im.groupManage.asyncGetJoinedGroups().then(res => {\n console.log(res);\n });\n \n\n 1. 获取群组信息 调用 groupManage 的 asyncGetGroupInfo 方法来获取群组的详细信息\n\n \n \n groupManage.asyncGetGroupInfo(group_id).then(res => {\n console.log(res);\n });\n \n\n## 消息发送\n\n登录成功之后才能进行聊天操作。发消息时，单聊和群聊是分开发消息的。 由于操作方便，目前只支持文本、图片与文件的发送。\n\n### 构建消息实体\n\n### 文本消息\n\n \n \n const message = {\n uid, // 用户id，只有单聊时使用\n gid, // 群id，只有群聊时使用\n content, // 消息文本内容\n priority， // 设置消息的扩散优先级，取值范围0-10。普通人在聊天室发送的消息级别默认为5，可以丢弃，管理员默认为0不会丢弃。其它值可以根据业务自行设置。\n }\n \n\n### 图片消息\n\n \n \n const fileInfo = {\n dName, // file name\n fLen, // file size\n width, // image width\n height, // image height\n url, // image url\n };\n const message = {\n type: 'image',\n uid,\n git, // uid, gid 分别为发送的用户或群\n content: \"\",\n attachment: fileInfo,\n priority, //设置消息的扩散优先级\n });\n \n\n### 文件消息\n\n \n \n const fileInfo = {\n dName, // file name\n fLen, // file size\n width, // image width\n height, // image height\n url, // image url\n };\n const message = {\n type: 'file',\n uid,\n git, // uid, gid 分别为发送的用户或群\n content: \"\",\n attachment: fileInfo,\n priority, //设置消息的扩散优先级\n });\n \n\n### 消息操作\n\n消息实体构建完成后，通过 BMXClient的单例，ChatService类，调用 -sendMessage:\n方法，将构建好的消息实体传入，即可实现消息发送\n\n#### 发送\n\n \n \n im.sysManage.sendRosterMessage(message);\n //or\n im.sysManage.sendGroupMessage(message);\n \n\n#### 转发\n\n \n \n const fmessage = {\n mid, // 消息id\n uid,\n gid, // uid 或 gid 选其一\n }\n im.sysManage.forwardMessage(message);\n \n\n#### 撤回\n\n \n \n const fmessage = {\n mid, // 消息id\n uid,\n gid, // uid 或 gid 选其一\n }\n im.sysManage.recallMessage(message);\n \n\n## 消息接收监听\n\n### 接收到消息通知\n\n \n \n im.on({\n onRosterMessage: function(message) {\n console.log(message);\n }\n });\n \n im.on({\n onGroupMessage: function(message) {\n console.log(message);\n }\n });\n \n\n### 消息发送后状态回调通知\n\n \n \n im.on({ // 状态发生改变\n onMessageStatusChanged: function(mStatus) {\n console.log(mStatus.mid, mStatus.status);\n }\n });\n \n im.on({ //消息撤回\n onMessageRecalled: function(mid) {\n console.log(mid);\n }\n });\n \n im.on({ //消息删除\n onMessageDeleted: function(mid) {\n console.log(mid);\n }\n });\n \n im.on({ //消息撤回\n onMessageRecalled: function(mid) {\n console.log(mid);\n }\n });\n \n im.on({ //消息设置未读\n onMessageCanceled: function(mid) {\n console.log(mid);\n }\n });\n \n\n## 功能进阶\n\n### 群组@功能\n\n \n \n im.sysManage.sendMentionMessage({\n gid,\n txt, // 文本消息\n mentionAll, // 是否@所有人\n mentionList, // [id,id ...]\n mentionedMessage, // mention内容\n pushMessage, // 推送\n senderNickname // 发送者昵称\n });\n \n\n### 消息正在输入状态\n\n \n \n im.sysManage.sendInputStatusMessage({\n uid,\n status, // nothing or typing\n });\n \n\n### 消息搜索\n\n根据关键字搜索指定消息内容\n\n \n \n const ret = im.sysManage.makeSearch(keyword);\n let { groupArr = [], rosterArr = [] } = ret;\n if(groupArr.lenght) {\n console.dir(groupArr[0]);\n // group_id/user_id, name/username, content, avatar\n }\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的即时通讯服务端快速集成指南"
},
{
"from": "gpt",
"value": "[即时通讯](https://developer.qiniu.com/IM) > 使用指南 > 服务端快速集成指南\n\n# 服务端快速集成指南\n\n最近更新时间: 2021-08-02 11:22:22\n\n本页面供快速集成使用，了解更多请访问 [详细文档 __](https://developer.qiniu.com/IM/8094/im-server-\napi-reference)\n\n# 入门\n\n## 术语介绍\n\n * app_id\n\n`app_id`是创建IM App时，为App生成的唯一标识，是字符串类型。可从console“应用信息”页面获取。\n\n * api_endpoint\n\n`api_endpoint`是App所在API服务的地址。可从console“应用信息”页面获取。\n\n * access-token\n\n`access-token`用作权限校验。可在console“Token管理”页面为App生成access-token或选用已有access-token。\n\n以上信息的获取，请参考 [IM服务开通流程 __](https://developer.qiniu.com/IM/8332/startim)\n\n## API概述\n\nAPI服务基于HTTPS安全协议，保证了调用时数据传输的安全性。同时API服务提供访问控制，调用前先需要获取 特有的`access-\ntoken`，才有权限操作App下用户、群组等数据。涉及的`access-token`请妥善保存。\n\n调用所有API前，要获取参数`api_endpoint`、`app_id`、`access-token`。 参数`app_id`，`access-\ntoken`在请求的Header中使用，未特殊说明的请求Content-Type类型为`application/json`。\n\n调用 API的请求的通用示例（请根据具体值替换用`{}`表示的变量）：\n\n \n \n curl -X {METHOD} '{api_endpoint}/{URI}' \\\n -H \"Content-Type: application/json\" \\\n -H 'access-token: {access-token}' \\\n -H 'app_id: {app_id}' \\\n \n\n## API分类\n\nAPI主要分为用户API、好友API、群组API、消息API。\n\n * 用户API\n\n用户隶属于单个App，是即时通讯的基础。有了用户才能实现好友、群组功能。用户数据分为基本信息和设置信息。 \n基本信息包括邮箱、手机号、用户名、密码。设置信息包括是否自动下载缩略图和文件、邀请入群是否需要确认等。 \n总体上讲，用户API主要涉及到其基本信息的更新和用户的设置，相关API以`/user`开头，后面接具体的资源，如获取用户设置API为“GET \n/user/settings”。\n\n * 好友API\n\n好友是用户之间的关系，好友设计中用户可为好友设置备注、设置好友消息的通知方式、可申请加好友、拉黑好用等。 \n好友API提供了好友信息、好友申请、好友列表、好友黑名单列表等相关操作，其API以`/roster`开头。\n\n * 群组API\n\n群组可以实现多用户通讯。设计中群成员角色分为群主、群管理员、普通群成员，权限等级依次降低，群主拥有群的所有权限，管理员有操作 \n群成员和修改群信息群设置的权限，根据群设置能普通群成员是否具有修改群信息以及邀请用户加入群组的权限。群成员功能设计有入群邀请、入群申请、 \n群黑名单、群禁言列表。 主要API包括群组数据操作和群成员操作，群数据操作主要有创建群、解散群、转让群以及群信息、群设置的更新、 \n群公告操作、群共享文件操作，群成员操作主要有邀请用户入群、管理员处理邀请、用户申请入群、用户处理申请、设置群黑名单、设置群禁言列表、 \n用户退出群、将用户踢出群等，API以`/group`开头。\n\n * 消息API\n\n消息相关API是对IM服务的封装，旨在为使用者提供简便方法以实现通讯功能。消息API以`/message`开头。\n\n一般情况下，请求到服务的API如遇业务错误，则返回的http code为200，在response body会返回自定义错误码。 \n具体错误码的含义见错误码页面。\n\n下面以以下值为例介绍部分关键API，实际请求中请予以替换。\n\n * `app_id`: `welovemaxim`\n * `api_endpoint`: `https://api.maximtop.com`\n * `access-token`: `eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJhcHAiOiJkcGJkdmVrZmVjYm8iLCJzdWIiOiIyMCIsImNsdXN0ZXIiOjAsInJvbGUiOjIsImlhdCI6MTU2Nzk5NzQwOH0.U-iFpEwprrkf-mFkhHN_CWmF5nkBbRQLTjttN4Qlkzw3ET1Zke9OZdjutm90KSyDs9jjYvUSAGGsWVjLmDZlkg`\n\n# 用户API\n\n## 注册用户\n\n * API描述\n\n为指定App注册IM用户。\n\n * 请求说明\n\nHttp方法: `POST` 资源路径: `/user/register/v2`\n\n * 参数说明\n\n * * Header参数\n\n参数 | 描述 | 备注 \n---|---|--- \napp_id | App id | 必填 \n \n * * Request Body参数\n\n参数 | 描述 | 备注 \n---|---|--- \nusername | 用户名 | 必填，用户名仅支持字母数字下划线组合，且不能是纯数字，不能以maxim、mta开头 \npassword | 密码 | 必填 \n \n * cURL请求示例\n\n \n \n curl -X POST 'https://api.maximtop.com/user/register/v2' \\\n -H \"Content-Type: application/json\" \\\n -H 'app_id: welovemaxim' \\\n -d '{ \"username\": \"test_user\", \"password\": \"asd\"}'\n \n\n * 返回结果示例\n\n \n \n {\n \"code\": 200,\n \"data\": {\n \"user_id\": 2302128618880,\n \"auto_download\": false,\n \"group_confirm\": false,\n \"no_sounds\": false,\n \"no_push\": false,\n \"vibratory\": false,\n \"no_push_detail\": false,\n \"auth_mode\": 0,\n \"no_push_start_hour\": 0,\n \"no_push_end_hour\": 0\n }\n }\n \n\n# 好友API\n\n## 添加好友\n\n * API描述\n\n为指定用户添加好友。\n\n * 请求说明\n\nHttp方法: `POST` 资源路径: `/user/add_roster`\n\n * 参数说明\n\n * * Header参数\n\n参数 | 描述 | 备注 \n---|---|--- \napp_id | APP ID | 必填 \naccess-token | token | 必填 \nuser_id | 添加方user_id | 必填 \n \n * * Request Body参数\n\n参数 | 描述 | 备注 \n---|---|--- \nlist | 被添加方user_id列表 | 必填 \n \n * cURL请求示例\n\n \n \n curl -X POST 'https://api.maximtop.com/user/add_roster' \\\n -H \"Content-Type: application/json\" \\\n -H 'access-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJhcHAiOiJkcGJkdmVrZmVjYm8iLCJzdWIiOiIyMCIsImNsdXN0ZXIiOjAsInJvbGUiOjIsImlhdCI6MTU2Nzk5NzQwOH0.U-iFpEwprrkf-mFkhHN_CWmF5nkBbRQLTjttN4Qlkzw3ET1Zke9OZdjutm90KSyDs9jjYvUSAGGsWVjLmDZlkg' \\\n -H 'app_id: welovemaxim' \\\n -H 'user_id: 2302128618880' \\\n -d '{ \"list\": [2199040544848, 2199040544992]}'\n \n\n * 返回结果示例\n\n \n \n {\n \"code\": 200,\n \"data\": true\n }\n \n\n## 获取好友列表\n\n * API描述\n\n获取指定用户的好友列表。\n\n * 请求说明\n\nHttp方法: `GET` 资源路径: `/user/rosters`\n\n * 参数说明\n * * Header参数\n\n参数 | 描述 | 备注 \n---|---|--- \napp_id | APP ID | 必填 \naccess-token | token | 必填 \nuser_id | 当前用户user_id | 必填 \n \n * * Request Body参数\n\n无\n\n * cURL请求示例\n\n \n \n curl -X GET 'https://api.maximtop.com/user/rosters' \\\n -H \"Content-Type: application/json\" \\\n -H 'access-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJhcHAiOiJkcGJkdmVrZmVjYm8iLCJzdWIiOiIyMCIsImNsdXN0ZXIiOjAsInJvbGUiOjIsImlhdCI6MTU2Nzk5NzQwOH0.U-iFpEwprrkf-mFkhHN_CWmF5nkBbRQLTjttN4Qlkzw3ET1Zke9OZdjutm90KSyDs9jjYvUSAGGsWVjLmDZlkg' \\\n -H 'app_id: welovemaxim' \\\n -H 'user_id: 2302128618880'\n \n\n * 返回结果示例\n\n \n \n {\n \"code\": 200,\n \"data\": [{\n \"user_id\": 2199040544848,\n \"name\": \"a\"\n }, {\n \"user_id\": 2199040544992,\n \"name\": \"b\"\n }]\n }\n \n\n# 群组API\n\n## 创建群\n\n * API描述\n\n以指定用户为群主创建群组。\n\n * 请求说明\n\nHttp方法: `POST` 资源路径: `/group/create`\n\n * 参数说明\n\n * * Header参数\n\n参数 | 描述 | 备注 \n---|---|--- \napp_id | APP ID | 必填 \naccess-token | token | 必填 \nuser_id | 群主user_id | 必填 \n \n * * Request Body参数\n\n参数 | 描述 | 备注 \n---|---|--- \nname | 群名称 | 必填 \ndescription | 群描述 | 可选 \n \n * * cURL请求示例\n\n \n \n curl -X POST 'https://api.maximtop.com/group/create' \\\n -H \"Content-Type: application/json\" \\\n -H 'access-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJhcHAiOiJkcGJkdmVrZmVjYm8iLCJzdWIiOiIyMCIsImNsdXN0ZXIiOjAsInJvbGUiOjIsImlhdCI6MTU2Nzk5NzQwOH0.U-iFpEwprrkf-mFkhHN_CWmF5nkBbRQLTjttN4Qlkzw3ET1Zke9OZdjutm90KSyDs9jjYvUSAGGsWVjLmDZlkg' \\\n -H 'app_id: welovemaxim' \\\n -H 'user_id: 2302128618880' \\\n -d '{ \"name\": \"g001\", \"description\": \"test-group\"}'\n \n\n * 返回结果示例\n\n \n \n {\n \"code\": 200,\n \"data\": {\n \"name\": \"g001\",\n \"status\": 0,\n \"description\": \"test-group\",\n \"type\": 0,\n \"group_id\": 2306414607729,\n \"owner_id\": 2302128618880,\n \"created_at\": 1569615417000,\n \"updated_at\": 1569615417000,\n \"member_invite\": true,\n \"apply_approval\": 1,\n \"read_ack\": false,\n \"history_visible\": false,\n \"member_modify\": false\n }\n }\n \n\n## 邀请用户加群\n\n * API描述\n\n以指定用户为群主邀请用户加入群组。\n\n * 请求说明\n\nHttp方法: `POST` 资源路径: `/group/invite`\n\n * 参数说明\n\n * * Header参数\n\n参数 | 描述 | 备注 \n---|---|--- \napp_id | APP ID | 必填 \naccess-token | token | 必填 \nuser_id | 群主user_id | 必填 \n \n * * Request Body参数\n\n参数 | 描述 | 备注 \n---|---|--- \ngroup_id | 群id | 必填 \nuser_list | 用户id列表 | 必填 \n \n * cURL请求示例\n\n \n \n curl -X POST 'https://api.maximtop.com/group/invite' \\\n -H \"Content-Type: application/json\" \\\n -H 'access-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJhcHAiOiJkcGJkdmVrZmVjYm8iLCJzdWIiOiIyMCIsImNsdXN0ZXIiOjAsInJvbGUiOjIsImlhdCI6MTU2Nzk5NzQwOH0.U-iFpEwprrkf-mFkhHN_CWmF5nkBbRQLTjttN4Qlkzw3ET1Zke9OZdjutm90KSyDs9jjYvUSAGGsWVjLmDZlkg' \\\n -H 'app_id: welovemaxim' \\\n -H 'user_id: 2302128618880' \\\n -d '{ \"group_id\": 2306414607729, \"user_list\": [2199040544848, 2199040544992]}'\n \n\n * 返回结果示例\n\n \n \n {\n \"code\": 200,\n \"data\": [{\n \"result\": \"success\",\n \"user_id\": 2199040544848\n }, {\n \"result\": \"success\",\n \"user_id\": 2199040544992\n }]\n }\n \n\n## 获取群成员列表\n\n * API描述\n\n获取群成员列表，支持分页。 分页由limit和cursor字段控制，limit是每页的大小，cursor是游标。 **cursor**\n：取第某页数据后若还有成员数据，会返回cursor字段，传cursor字段会取游标的下一页数据。\n\n * 请求说明\n\nHttp方法: `GET` 资源路径: `/group/member_list`\n\n * 参数说明\n\n * * Header参数\n\n参数 | 描述 | 备注 \n---|---|--- \napp_id | APP ID | 必填 \naccess-token | token | 必填 \nuser_id | 群主user_id | 必填 \n \n * * 查询参数参数\n\n参数 | 描述 | 备注 \n---|---|--- \ngroup_id | 群id | 必填 \ncursor | 分页游标 | 可选，默认取第一页 \nlimit | 单次获取成员数量 | 可选，默认1000 \n \n * cURL请求示例\n\n \n \n curl -X GET 'https://api.maximtop.com/group/member_list?group_class=\"anchor\" id=2306414607729&limit=50' \\\n -H 'access-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJhcHAiOiJkcGJkdmVrZmVjYm8iLCJzdWIiOiIyMCIsImNsdXN0ZXIiOjAsInJvbGUiOjIsImlhdCI6MTU2Nzk5NzQwOH0.U-iFpEwprrkf-mFkhHN_CWmF5nkBbRQLTjttN4Qlkzw3ET1Zke9OZdjutm90KSyDs9jjYvUSAGGsWVjLmDZlkg' \\\n -H 'app_id: welovemaxim' \\\n -H 'user_id: 2302128618880'\n \n\n * 返回结果示例\n\n \n \n {\n \"code\": 200,\n \"data\": [{\n \"user_id\": 2302128618880,\n \"join_time\": 1569615417000\n }, {\n \"user_id\": 2199040544848,\n \"join_time\": 1569615490000\n }, {\n \"user_id\": 2199040544992,\n \"join_time\": 1569615490000\n }],\n \"version\": 1569586735861\n }\n \n\n## 解散群\n\n * API描述\n\n解散群组。\n\n * 请求说明\n\nHttp方法: `DELETE` 资源路径: `/group/destroy`\n\n * 参数说明\n\n * * Header参数\n\n参数 | 描述 | 备注 \n---|---|--- \napp_id | APP ID | 必填 \naccess-token | token | 必填 \nuser_id | 群主user_id | 必填 \n \n * cURL请求示例\n\n \n \n curl -X DELETE 'https://api.maximtop.com/group/destroy?group_class=\"anchor\" id=2306414607729' \\\n -H 'access-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJhcHAiOiJkcGJkdmVrZmVjYm8iLCJzdWIiOiIyMCIsImNsdXN0ZXIiOjAsInJvbGUiOjIsImlhdCI6MTU2Nzk5NzQwOH0.U-iFpEwprrkf-mFkhHN_CWmF5nkBbRQLTjttN4Qlkzw3ET1Zke9OZdjutm90KSyDs9jjYvUSAGGsWVjLmDZlkg' \\\n -H 'app_id: welovemaxim' \\\n -H 'user_id: 2302128618880'\n \n\n * 返回结果示例\n\n \n \n {\n \"code\": 200,\n \"data\": true\n }\n \n\n# 发送消息API\n\n## 管理员发送单聊文本消息\n\n * API描述\n\n给指定目标发送消息，可以批量发给群或用户。 指定目标用targets字段表示，列表类型，列表中id只能为用户id或群id的一种，两者不能混合发送。\n\n * 请求说明\n\nHttp方法: `POST` 资源路径: `/message/send`\n\n * 参数说明\n\n * * Header参数\n\n参数 | 描述 | 备注 \n---|---|--- \napp_id | APP ID | 必填 \naccess-token | token | 必填 \n \n * * Request Body参数\n\n参数 | 描述 | 备注 \n---|---|--- \ntargets | 目标id列表 | 必填 \ntype | 目标类型,1:单聊2:群聊 | 必填 \ncontent_type | 消息内容类型,0:文本消息 | 必填 \next | 扩展字段 | 可选 \n \n * cURL请求示例\n\n \n \n curl -X POST 'https://api.maximtop.com/message/send' \\\n -H \"Content-Type: application/json\" \\\n -H 'access-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJhcHAiOiJkcGJkdmVrZmVjYm8iLCJzdWIiOiIyMCIsImNsdXN0ZXIiOjAsInJvbGUiOjIsImlhdCI6MTU2Nzk5NzQwOH0.U-iFpEwprrkf-mFkhHN_CWmF5nkBbRQLTjttN4Qlkzw3ET1Zke9OZdjutm90KSyDs9jjYvUSAGGsWVjLmDZlkg' \\\n -H 'app_id: welovemaxim' \\\n -d '{\"targets\":[2302128618880],\"type\":1,\"content\":\"hello\",\"content_type\":0}'\n \n\n * 返回结果示例\n\n \n \n {\n \"code\": 200,\n \"data\": true\n }\n \n\n# 附录\n\n## 错误码说明\n\n * 1xxxx表示用户/好友体系问题\n * 2xxxx表示群组体系问题\n * 3xxxx表示license问题\n\n错误码 | 描述 \n---|--- \n10000 | 用户不存在 \n10001 | 验证码不正确 \n10002 | 请求参数不正确 \n10003 | header中缺少access-token参数 \n10004 | 用户已存在 \n10005 | 用户已在好友列表 \n10006 | 用户在黑名单列表 \n10007 | 好友申请不存在或已过期 \n10008 | header中access-token无效 \n10009 | oss异常 \n10010 | 用户无权限 \n10011 | user_id已绑定 \n10012 | 用户拒绝好友申请 \n20000 | 服务器数据库异常 \n20001 | 群组不存在 \n20002 | 用户不是群成员 \n20003 | msg_push_mode值不合法 \n20004 | 群主不能直接离开群 \n20005 | 转让群异常：被转让人非群成员 \n20006 | 群组处于修复模式 \n20007 | App群数量超限 \n20008 | 用户创建的群数量超限 \n20009 | 用户加入的群数量超限 \n20010 | 群人数超限 \n20011 | 操作需要群成员权限 \n20012 | 操作需要群管理员权限 \n20013 | 操作需要群主权限 \n20014 | 入群申请已过期或已处理 \n20015 | 入群邀请已过期或已处理 \n20016 | 用户被踢出群次数超限，不能再加入群 \n20017 | 用户已经是群成员 \n20018 | 用户在群黑名单列表 \n20020 | 群公告不存在 \n20021 | 群公告被管理员禁用 \n20022 | 群共享文件不存在 \n20023 | 无权限操作群共享文件 \n20024 | 群邀请二维码不合法 \n20025 | 群邀请二维码已过期 \n30021 | License无效 \n30022 | License已过期 \n30023 | 超出 License限制 \n40000 | app_id不存在 \n \n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的即时通讯即时通讯服务隐私协议"
},
{
"from": "gpt",
"value": "[即时通讯](https://developer.qiniu.com/IM) > 使用指南 > 即时通讯服务隐私协议\n\n# 即时通讯服务隐私协议\n\n最近更新时间: 2021-07-23 16:12:00\n\n即时通讯服务隐私协议\n\n引言 \n七牛严格遵守法律法规，按照业界成熟的安全与隐私标准，保护第三方开发者和其终端用户的个人信息。 \n《即时通讯隐私政策》主要向第三方开发者和其终端用户说明我们如何处理个人信息（处理包括“收集、存储、使用、加工、传输、提供、公开等”）。\n\n在注册、接入、使用七牛\n即时通讯产品和/或服务前，请第三方开发者和终端用户务必仔细阅读本声明。同时，请第三方开发者将本声明提供给第三方的终端用户，以便最终用户了解本声明相关内容并获得用户同意。如果第三方开发者或终端用户不同意本声明，应立即停止接入及使用即时通讯产品和/或服务。 \n我们对个人敏感信息采用“加粗”的书写方式进行特别提醒。如对本声明内容有任何疑问、意见或建议，可随时通过本声明第十条提供的方式与我们联系。\n\n本文将按如下顺序进行说明：\n\n1、如何收集和使用第三方开发者和/或终端用户的个人信息\n\n2、第三方终端用户的授权同意\n\n3、如何使用 Cookie 等同类技术\n\n4、如何共享、转让、公开披露第三方开发者和/或终端用户的个人信息\n\n5、如何存储第三方开发者和/或终端用户的个人信息\n\n6、如何保护第三方开发者和/或终端用户的个人信息安全\n\n7、第三方开发者和/或终端用户如何管理其个人信息\n\n8、如何处理儿童个人信息\n\n9、如何变更与更新本声明\n\n10、如何联系我们\n\n本政策仅适用于七牛直接处理的个人信息。七牛主要为企业客户提供服务。若我们企业客户在他们的产品内嵌入了我们的服务（如我们的实时音视频服务、鉴黄服务、直播服务、点播服务、短视频服务、存储服务等），而您作为该企业客户的终端用户在与我们的产品互动过程中提供了您的个人信息。在这种场景下，我们作为信息处理方，遵照我们与企业客户的协议以及企业客户的指令处理您的个人信息，企业客户作为信息控制方对处理您的个人信息承担责任，并负有义务向您披露如何处理、保护您的个人信息。若您希望了解企业客户如何处理、分享、保护您的个人信息，请参阅该企业客户的隐私政策。若您对此有任何问题，请直接联系该企业客户。\n\n一、如何收集和使用第三方开发者和/或终端用户的个人信息 \n我们遵循正当、合法、必要的原则，基于本声明所述的以下目的，收集和使用：\n\n1.第三方开发者和/或终端用户主动提供或我们直接收集的个人信息；\n\n2.第三方终端用户在使用即时通讯产品和/或服务过程中产生的个人信息；\n\n3.从第三方开发者或者其他第三方获取的第三方开发者和/或终端用户的个人信息。\n\n我们通常会在征得第三方开发者和/或终端用户同意后收集个人信息。我们会在本声明中载明收集的个人信息用途，如果我们要将收集个人信息用于本声明未载明的其它用途，我们会以合理的方式向第三方开发者和/或终端用户告知，并在使用前再次征得第三方开发者和/或终端用户的同意。\n\n 1. 第三方开发者和/或终端用户主动提供或我们直接收集的个人信息 \n为实现即时通讯的推送功能，我们可能需要向第三方开发者和/或终端用户收集相关个人信息。以下将详细列出即时通讯的各项业务功能及为实现该功能所需收集的个人信息情况，请点击下述列表中的链接了解七牛\n即时通讯针对的具体功能、收集个人信息的类型，实现的功能目的。\n\n即时通讯除自身提供相关服务并需收集相关信息外，第三方开发者还有可能集成其他辅助业务的第三方 SDK，此部分第三方\n即时通讯所收集的个人信息请开发者和终端用户查看第三方 SDK的隐私政策。\n\n关于即时通讯服务的信息如下\n\n * 手机号：用途为在即时通讯服务供应商美信拓扑处，注册开通即时通讯服务\n\n 2. 我们从第三方获得的第三方开发者和/或终端用户的个人信息 \n我们可能从第三方开发者授权同意的第三方（我们的合作方）处间接获取第三方开发者和/或终端用户的个人信息，获取的个人信息是为实现七牛即时通讯产品和/或服务必要功能所必需的最少数量。如我们收集的信息无法单独或结合其他信息识别到第三方开发者和/或终端用户的个人身份，其不属于法律意义上的个人信息。\n\n我们会在收集前要求第三方对个人信息来源的合法性作出承诺，并向第三方开发者和/或终端用户告知共享的目的、信息等内容，在依法取得第三方开发者和/或终端用户同意后收集个人信息，确保在已获得的个人信息处理的授权同意范围内进行共享。\n\n如第三方有违反法律法规要求或约定的行为，我们会立即停止从该方收集信息、停止合作并采取相应的补救措施将损失减少到最小；同时，我们会使用不低于对自身用户个人信息同等的保护水平对间接获取的个人信息进行保护，在间接获取个人敏感信息时，我们会采用更加严格的（如传输加密等）安全保障措施。\n\n 3. 以下情形中，我们收集、使用个人信息无需征得第三方开发者和/或终端用户的授权同意 \n3.1 与个人信息控制者履行法律法规规定的义务相关的； \n3.2 与国家安全、国防安全直接相关的； \n3.3 与公共安全、公共卫生、重大公共利益直接相关的； \n3.4 与刑事侦查、起诉、审判和判决执行等直接相关的； \n3.5 出于维护个人信息主体或其他个人的生命、财产等重大合法权益但又很难得到本人同意的； \n3.6 所涉及的个人信息是个人信息主体自行向社会公众公开的； \n3.7 根据个人信息主体要求签订和履行合同所必需的； \n3.8 从合法公开披露的信息中收集的第三方开发者和/或终端用户的个人信息的，如合法的新闻报道、政府信息公开等渠道； \n3.9 维护所提供产品或服务的安全稳定运行所必需的，例如发现、处置产品或服务的故障。\n\n 4. 个人信息的使用规则 \n我们会根据本声明和/或与第三方开发者的合同约定，并仅为实现即时通讯产品和/或服务功能，对所收集的个人信息进行处理。若需要将收集的个人信息用于其他目的，我们会以合理方式告知第三方开发者和/或终端用户，并在第三方开发者获得终端用户同意后和/或单独获得终端用户同意后进行使用。 \n我们向第三方开发者提供的\n即时通讯产品和/或服务停止运营后，或者第三方开发者和/或终端用户撤回个人信息的授权后，或者在第三方开发者和/或终端用户注销账号后，我们将会于合理的时间内销毁或匿名化处理从第三方开发者和/或终端用户处接收的所有个人信息，除非法律另有规定。\n\n二、第三方终端用户的授权同意 \n第三方开发者将即时通讯产品和/或服务集成到其第三方中，为向终端用户提供即时通讯产品和/或服务，我们会以合法合规的方式收集、存储、加工来自于第三方开发者和/或终端用户的个人信息。\n\n请第三方开发者知悉并同意：\n\n第三方开发者已经遵守并将持续遵守适用的法律、法规和监管要求收集、使用和处理第三方终端用户的个人信息，包括但不限于制定和公布有关个人信息保护声明或隐私政策等；\n\n第三方开发者已经告知第三方终端用户并且已经获得终端用户充分、必要且明确的授权、同意和许可（包括获取了儿童监护人对提供终端用户是儿童的个人信息的授权同意）、为提供即时通讯产品和/或服务以及与第三方功能对应的目的，我们会收集和共享以及如何使用（包括允许我们根据本声明的规定收集和处理）第三方终端用户的个人信息；\n\n除非适用法律另有规定，第三方开发者已经告知终端用户并且获得终端用户充分必要的授权、同意和许可，允许我们对已经收集的个人信息进行去标识化处理，并且在符合相关法律法规的前提下，可以将收集、处理的信息用于本声明第一条列明的用途；\n\n第三方开发者已经向终端用户提供了易于操作的用户权利实现机制，并说明了终端用户可以如何以及何时行使选择权、如何访问、更正其个人信息，以及行使删除权、更改其授权同意的范围等操作。\n\n三、如何使用 Cookie 等同类技术 \n当第三方开发者访问、登录、使用即时通讯时，为确保网站正常运转，我们可能会在第三方开发者的计算机或移动设备上通过 Cookie\n缓存功能使用相关信息。Cookie 通常包含当前登录帐号、站点地址、浏览次数。运用 Cookie\n技术，我们能够为第三方开发者提供更加周到的个性化服务，并允许第三方开发者设定第三方开发者特定的服务选项。\n\n1.什么是Cookie？ \nCookie 是一种可让网站服务器将数据存储于客户端或从客户端中读取数据的中立技术。\n\nCookie 文件是存储了一些与用户访问网站有关信息的文件，格式为.txt。\n\nCookie 内容通常均经过加密。\n\n安全的Cookie技术会为用户在上网时提供更为便捷的服务。\n\n2.七牛使用Cookie的目的 \nCookie 对提升用户的网络使用体验十分重要，七牛使用Cookie一般出于以下目的：\n\n2.1 身份验证\n\nCookie可在您接入我们的服务时通知我们，以使我们可验证您的身份信息，以确保您的账号安全。\n\n例如，Cookie技术可在您登入七牛服务时通知我们，因此，我们能够在您访问所有七牛服务的站点时，识别是否您本人安全登录，向您显示与您相关的信息。\n\n2.1 偏好设置\n\nCookie可帮助我们按照您所希望的服务样式、外观的个性化设置为您提供服务。\n\n例如，\nCookie技术可记录您是否已经阅读过一些提示性的展现，防止重复提示对您造成骚扰；一些阅读展现(如字体大小等)方面您本人偏好的设定，我们也会存放于Cookie中，在您访问时自动为您调整到您上次设定的值。\n\n2.3 安全\n\nCookie可帮助我们保障数据和服务的安全性，排查针对我们的产品和服务的作弊、黑客、欺诈行为。\n\n例如，Cookie可以存放票据信息，能够由服务器验证是否是您自主在本站点的正常登录，通过票据中的加密信息，阻止多种类型的攻击，防止跨站信息窃取访问，防止身份冒充访问。\n\n2.4 功能与服务\n\nCookie可帮助我们为用户提供更好的产品和服务。\n\n例如，Cookie可以在您进行登录时，通过存储的信息，帮您填入您最后一次登入的账户名称，提高您的操作效率。\n\n2.5 效率\n\nCookie可以避免不必要的服务器负载，提高服务效率，节省资源、能源。\n\n例如，Cookie可帮助我们优化在服务器之间路由流量，并且了解不同用户加载我们服务时的速度，有时，我们或会利用Cookie让您正在使用时加载及响应得更快。\n\n2.6 分析与研究\n\n我们使用这些Cookie来了解、改善我们的产品和服务，为新产品或功能的研发提供参考数据。\n\n例如，我们会使用Cookie来了解您使用我们服务的方式，以求改善用户体验。\n\n例如您在接入我们服务时，在各个步骤所耗费的时间，我们会收集此信息用以分析研究能够进一步优化和改善的方面。\n\n2.7 如何管理Cookie\n\n大多数浏览器均为用户提供了管理Cookie 的功能。\n\n当用户在进行浏览器的Cookie设置时，可以允许自己信任的网站启用 Cookie功能，禁止其他网站使用Cookie功能。\n\n但请注意，如果停用Cookie，您可能无法享受最佳的服务体验，某些服务也可能无法正常使用。\n\n四、如何共享、转让、公开披露第三方开发者和/或终端用户的个人信息\n\n 1. 共享 \n一般情况下，我们不会与我们的关联公司、合作伙伴及第三方共享第三方开发者和/或终端用户的必要的个人信息，除非为实现本声明第一条中所提及目的的需要。\n\n如存在分享的行为，我们会要求关联公司、合作伙伴及第三方提供数据安全能力和信息安全资质（如等级保护测评、信息安全管理体系等）证明。在个人敏感信息的处理上，我们会要求第三方采用数据脱敏加密技术，从而更好地保护个人信息。如果第三方开发者和/或终端用户对第三方处理个人信息有异议或发现这些第三方存在风险时，请按照本声明第十条所述方式联系我们。\n\n我们的关联公司、合作伙伴及第三方如要改变个人信息的处理目的，我们会再次征求第三方开发者和/或终端用户的同意。\n\n 2. 转让 \n我们不会将第三方开发者和/或终端用户的个人信息转让给任何公司、组织和个人，但以下情况除外： \n2.1 事先获得第三方开发者和/或终端用户明确的同意或授权； \n2.2\n在涉及合并、收购、资产转让或类似的交易时，如涉及到个人信息转让，我们会要求新的持有第三方开发者和/或终端用户个人信息的公司、组织继续受本隐私声明的约束，否则，我们将要求该公司、组织重新向第三方开发者和/或终端用户征求授权同意。\n\n 3. 公开披露 \n我们不会公开披露第三方开发者和/或终端用户的个人信息，除非：\n\n3.1 获得第三方开发者和/或终端用户的明确同意后；\n\n3.2 在法律法规、法律程序、诉讼或政府主管部门强制要求的情况下。\n\n 4. 共享、转让、公开披露个人信息时事先征得授权同意的例外 \n请理解，在以下情形中，根据法律法规及国家标准，我们共享、转让、公开披露第三方开发者和/或终端用户的个人信息，无需事先征得第三方开发者和/或终端用户的授权同意： \n4.1 与个人信息控制者履行法律法规规定的义务相关的； \n4.2 与国家安全、国防安全有关的； \n4.3 与公共安全、公共卫生、重大公共利益直接相关的； \n4.4 与刑事侦查、起诉、审判和判决执行等直接相关的； \n4.5 出于维护第三方开发者和/或终端用户或其他个人的生命、财产等重大合法权益但又很难得到本人同意的； \n4.6 第三方开发者和/或终端用户自行向社会公众公开的个人信息； \n4.7 从合法公开披露的信息中收集个人信息的，如合法的新闻报道、政府信息公开等渠道。\n\n请知悉，如我们收集的信息无法单独或结合其他信息识别到第三方开发者和/或终端用户的个人身份，其不属于法律意义上的个人信息，此类处理后数据的共享、转让、公开披露，无需另行向第三方开发者和/或终端用户通知并征得同意。\n\n五、如何存储第三方开发者和/或终端用户的个人信息\n\n 1. 存储方式和期限 \n我们会通过安全的方式存储第三方开发者和/或终端用户的信息，包括本地存储、数据库和服务器日志。 \n一般情况下，我们只会在为实现本声明所述目的所必需的最短时间内或法律法规规定或个人信息主体另行授权同意的条件/范围内存储第三方开发者和/或终端用户的个人信息。但在下列情况下，且仅出于下列情况相关的目的，我们有可能需要较长时间保留第三方开发者和/或终端用户的个人信息： \n（1）遵守适用的法律法规等有关规定； \n（2）遵守法院判决、裁定或其他法律程序的要求； \n（3）遵守相关政府机关或其他有权机关的要求； \n（4）为执行相关服务协议或本声明、维护社会公共利益、处理投诉/纠纷，保护我们的客户、我们或我们的关联公司、其他用户或雇员的人身和财产安全或合法权益所合理必需的用途。\n\n 2. 存储地域 \n我们会按照法律法规规定，将境内收集的个人信息存储于中国境内。 \n如需跨境传输或存储的，我们会向第三方开发者和/或终端用户告知个人信息出境的目的、接收方、安全保证措施和安全风险，并征得第三方开发者和/或终端用户的同意。\n\n六、如何保护第三方开发者和/或终端用户的个人信息安全\n\n 1. 安全保护措施 \n我们已使用符合业界标准的安全防护措施保护第三方开发者和/或终端用户提供的个人信息，防止数据遭到未经授权访问、公开披露、使用、修改、损毁、泄漏或丢失。 \n我们采用业界领先的技术保护措施。我们使用的技术手段包括但不限于防火墙、加密（例如 SSL）、去标识化或匿名化处理、访问控制措施等。此外，我们还会不断加强将\n即时通讯集成到第三方上的安全能力。 \n我们建立了专门保障个人信息安全的管理制度、流程和组织。我们也会审查该管理制度、流程和组织，以防未经授权的人员擅自访问、使用或披露用户的信息。\n\n 2. 安全事件处置措施 \n若发生个人信息泄露、损毁、丢失等安全事件，我们会启动应急预案，阻止安全事件扩大。安全事件发生后，我们会及时以推送通知、邮件等形式向第三方开发者和/或终端用户告知安全事件的基本情况、我们即将或已经采取的处置措施和补救措施，以及我们对第三方开发者和/或终端用户的应对建议。\n\n七、第三方开发者和/或终端用户如何管理其个人信息 \n我们非常重视第三方开发者和/或终端用户对个人信息的管理，并尽全力提供对个人信息的查询、访问、修改、删除、投诉举报以及设置隐私功能等的相关权利，以使第三方开发者和/或终端用户有能力保障自身的隐私和信息安全。\n\n 1. 针对第三方开发者 \n第三方开发者访问、修改和删除个人信息的范围和方式将取决于第三方开发者使用的开发者平台的功能设置，也可以按照本声明第十条所述方式与我们联系。\n\n 2. 针对第三方终端用户 \n由于第三方终端用户不是我们的直接用户，我们建议： \n2.1\n当终端用户所使用的第三方中某项功能由七牛即时通讯产品和/或服务提供，终端用户可以在使用我们服务的过程中，访问、修改和删除第三方开发者提供的注册信息和其他个人信息，也可按照本声明第十条所述方式与我们联系； \n2.2\n当终端用户直接向我们主张个人信息主体权利时，应提供必要的证明文件，我们还会对终端用户进行身份验证。我们会向第三方开发者核实终端用户身份以保障终端用户第三方账号安全的情况下，响应终端用户的相关请求； \n2.3\n当终端用户直接向我们主张个人信息主体权利时，根据第三方开发者的隐私政策或个人信息保护声明，我们还可能将与终端用户个人信息相关的请求直接发送给该第三方开发者，要求其处理和/或寻求帮助。\n\n 3. 响应第三方开发者和/或终端用户的合理请求 \n我们会响应第三方开发者和/或终端用户上述的合理请求，如无端重复、需要过多技术手段（例如，需要开发新系统或从根本上改变现行惯例）、给他人合法权益带来风险或者非常不切实际（例如，涉及备份磁盘上存放的信息）的请求，我们可能会予以拒绝。 \n在以下情形中，我们将无法响应第三方开发者和/或终端用户的请求： \n3.1 与我们履行法律法规规定的义务相关的； \n3.2 与国家安全、国防安全直接相关的； \n3.3 与公共安公共卫生、重大公共利益直接相关的； \n3.4 与犯罪侦查、起诉、审判和执行判决等直接相关的； \n3.5 我们有充分证据表明第三方开发者和/或终端用户存在主观恶意或滥用权利的； \n3.6 出于维护第三方开发者和/或终端用户或其他个人的生命、财产等重大合法权益但又很难得到本人同意的； \n3.7 响应第三方开发者和/或终端用户的请求将导致第三方开发者或其他个人、组织的合法权益受到严重损害的； \n3.8 涉及商业秘密的。 \n如第三方开发者和/或终端用户的对上述权利实现存在疑问，可以根据本声明第十条所述方式与我们联系。\n\n八、如何处理儿童个人信息 \n请第三方开发者确保是18周岁（含）以上人士。请第三方开发者理解并知悉，如果第三方是针对儿童用户的，请第三方开发者务必确保第三方终端用户（儿童）的监护人已经阅读并同意了第三方的隐私政策以及本文，并且经其同意后提供儿童个人信息给我们，以实现第三方在隐私政策中所述的相关功能。\n\n如果第三方开发者的第三方是针对儿童并为儿童用户设计和开发的，请务必确保该第三方终端用户（儿童）的监护人已经阅读并同意了第三方的隐私政策/个人信息保护声明以及本文，并且授权同意提供儿童个人信息给我们以实现第三方的相关功能。\n\n如果我们在不知情的情况下收集了儿童的个人信息，我们将及时对其进行删除，除非法律法规要求我们保留此类资料。如果第三方开发者和/或终端用户认为我们错误或意外地向儿童收集了信息，请按本声明第十条所述方式及时联系我们。如果经我们发现第三方开发者未获得儿童的监护人同意向我们提供儿童个人信息的，我们将尽快删除该儿童的个人信息并确保不对其进一步处理。\n\n九、如何变更与更新本声明 \n为给第三方开发者提供更好的服务以及随着本平台产品和/或服务的不断发展与变化，我们可能会适时对本声明进行修订。\n\n当本声明的条款发生变更时，我们会在版本更新时以弹窗、红点提示、网站公告等方式进行提示，并说明生效日期。此外，如果更新后的本声明对第三方终端用户的权利有所影响，还需要请第三方开发者适时更新第三方的隐私政策。\n\n对于重大变更，我们还会提供更为显著的通知（包括对于某些服务，我们会通过电子邮件或站内信形式或公告形式发送通知，说明本声明的具体变更内容）。因此，请随时查看和了解本声明内容。如果第三方开发者和/或终端用户不同意接受本声明，请停止接入和使用我们的服务。 \n本声明所指的重大变更包括但不限于：\n\n我们的服务模式发生重大变化。如处理个人信息的目的、类型、个人信息的使用方式等；\n\n我们在所有权结构、组织架构等方面发生重大变化。如业务调整、破产、并购等引起的所有者变更等；\n\n个人信息共享、转让或公开披露的主要对象发生变化；\n\n个人信息处理方面的权利及其行使方式发生重大变化；\n\n负责处理个人信息安全的责任部门、联络方式及投诉渠道发生变化；\n\n个人信息安全影响评估报告表明存在高风险。\n\n本声明是七牛各 即时通讯开发者平台服务协议的重要组成部分。我们还会将本声明的旧版本存档，供第三方开发者和/或终端用户查阅。\n\n十、如何联系我们 \n如第三方开发者和/或终端用户对本声明或个人信息相关事宜有疑问，可以通过以下方式与我们取得联系：\n\n通过七牛客服电话 400-808-9176 与我们联系进行在线咨询；\n\n邮寄信件至：中国上海市浦东新区浦东软件园Q座七牛云法务部（收）邮编：201203。\n\n我们将及时验证请求人身份并尽快审核所涉问题，并于十五个工作日内予以回复。\n\n十一、其它 \n《七牛隐私政策》是七牛统一适用的一般性隐私条款，其中所规定的用户权利及信息安全保障措施均适用于第三方开发者和/或终端用户。如《七牛隐私政策》与本声明存在不一致或矛盾之处，请以本声明为准。\n\n我们请第三方开发者特别注意：当第三方开发者进行个人信息的处理活动，如果符合以下任何一项条件，请第三方开发者注意同时遵守《欧盟通用数据保护条例》（General\nData Protection Regulation，以下简称 “GDPR”）： \n（1） 第三方开发者在欧盟经济区域（“EEA”），无论该处理活动是否在欧盟进行； \n（2）向在 EEA 的个人提供商品或服务（不论是否有偿），或者监视其在 EEA 内的行为； \n（3）不在 EEA 内，但根据国际公法适用欧盟成员国法律（例如 EEA 成员国的使馆或领事馆）。\n\n如果第三方开发者和/或终端用户来自EEA，我们收集和使用上述个人信息的法律依据将取决于相关个人信息以及我们收集信息的具体背景。 \n对于 EEA 中的第三方开发者和/或终端用户，有权根据适用的数据保护法律向主管数据保护机构投诉或向具有管辖权的法院提起诉讼。 \n如果第三方开发者和/或终端用户对我们收集和使用个人信息的法律依据有疑问或需要进一步信息的，请根据本声明第十条所述方式与我们联系。\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的即时通讯服务端API"
},
{
"from": "gpt",
"value": "[即时通讯](https://developer.qiniu.com/IM) > API 文档 > 服务端API\n\n# 服务端API\n\n最近更新时间: 2021-06-28 11:05:15\n\n调用IM服务端API前，请先从控制台获取参数api_endpoint、app_id、access-token。 \napi_endpoint是服务地址，app_id，access-token在请求Header中使用。未特殊说明的请求Content-\nType类型为application/json。\n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的即时通讯token接口"
},
{
"from": "gpt",
"value": "[即时通讯](https://developer.qiniu.com/IM) > API 文档 >\n[服务端API](https://developer.qiniu.com/IM/api/8094/im-server-api-reference) >\ntoken接口\n\n# token接口\n\n最近更新时间: 2021-06-29 09:47:45\n\n# token 接口\n\n## 通过用户ID和密码取普通用户token\n\n### 基本信息\n\n**Path：** /token/id\n\n**Method：** POST\n\n**接口描述：**\n\n### 请求参数\n\n**Headers**\n\n参数名称 | 参数值 | 是否必须 | 示例 | 备注 \n---|---|---|---|--- \nContent-Type | application/json | 是 | | \naccess-token | | 否 | | 令牌 \napp_id | | 是 | | 应用ID \ngroup_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 \nuser_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 \n \n**Body**\n\n名称| 类型| 是否必须| 默认值| 备注| 其他信息 \n---|---|---|---|---|--- \ndevice_guid| string| 非必须| | 设备ID, 如果设置，则返回PushToken| \npassword| string| 必须| | | \nuser_id| integer| 必须| | 用户ID，仅用于用户ID登录| format: int64 \n \n### 返回数据\n\n名称| 类型| 是否必须| 默认值| 备注| 其他信息 \n---|---|---|---|---|--- \ncode| integer| 非必须| | 返回码，200是成功| format: int32 \ndata| object| 非必须| | Token 信息| \n├─ access_key_secret| string| 非必须| | 文件密钥| \n├─ encrypt_type| integer| 非必须| | 是否启用加密连接| format: int32 \n├─ expire| integer| 非必须| | 过期时间戳| format: int64 \n├─ public_key| string| 非必须| | 公钥| \n├─ push_token| string| 非必须| | 推送Token| \n├─ store_token| string| 非必须| | 文件token| \n├─ token| string| 非必须| | 访问token| \n├─ user_id| integer| 非必须| | 用户ID| format: int64 \nmessage| string| 非必须| | 错误信息，如果成功，该项为null| \n \n## 通过用户名/手机号/邮箱取普通用户token\n\n### 基本信息\n\n**Path：** /token/login\n\n**Method：** POST\n\n**接口描述：**\n\n### 请求参数\n\n**Headers**\n\n参数名称 | 参数值 | 是否必须 | 示例 | 备注 \n---|---|---|---|--- \nContent-Type | application/json | 是 | | \naccess-token | | 否 | | 令牌 \napp_id | | 是 | | 应用ID \ngroup_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 \nuser_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 \n \n**Body**\n\n名称| 类型| 是否必须| 默认值| 备注| 其他信息 \n---|---|---|---|---|--- \ndevice_guid| string| 非必须| | 设备ID, 如果设置，则返回PushToken| \nlogin_name| string| 必须| | 登录名，可以是手机号，邮箱，用户名| \npassword| string| 必须| | | \n \n### 返回数据\n\n名称| 类型| 是否必须| 默认值| 备注| 其他信息 \n---|---|---|---|---|--- \ncode| integer| 非必须| | 返回码，200是成功| format: int32 \ndata| object| 非必须| | Token 信息| \n├─ access_key_secret| string| 非必须| | 文件密钥| \n├─ encrypt_type| integer| 非必须| | 是否启用加密连接| format: int32 \n├─ expire| integer| 非必须| | 过期时间戳| format: int64 \n├─ public_key| string| 非必须| | 公钥| \n├─ push_token| string| 非必须| | 推送Token| \n├─ store_token| string| 非必须| | 文件token| \n├─ token| string| 非必须| | 访问token| \n├─ user_id| integer| 非必须| | 用户ID| format: int64 \nmessage| string| 非必须| | 错误信息，如果成功，该项为null| \n \n## 通过用户名和密码取普通用户token\n\n### 基本信息\n\n**Path：** /token/user\n\n**Method：** POST\n\n**接口描述：**\n\n### 请求参数\n\n**Headers**\n\n参数名称 | 参数值 | 是否必须 | 示例 | 备注 \n---|---|---|---|--- \nContent-Type | application/json | 是 | | \naccess-token | | 否 | | 令牌 \napp_id | | 是 | | 应用ID \ngroup_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 \nuser_id | | 否 | | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 \n \n**Body**\n\n名称| 类型| 是否必须| 默认值| 备注| 其他信息 \n---|---|---|---|---|--- \ndevice_guid| string| 非必须| | 设备ID, 如果设置，则返回PushToken| \nname| string| 必须| | 用户名，仅用于用户名登录| \npassword| string| 必须| | | \n \n### 返回数据\n\n名称| 类型| 是否必须| 默认值| 备注| 其他信息 \n---|---|---|---|---|--- \ncode| integer| 非必须| | 返回码，200是成功| format: int32 \ndata| object| 非必须| | Token 信息| \n├─ access_key_secret| string| 非必须| | 文件密钥| \n├─ encrypt_type| integer| 非必须| | 是否启用加密连接| format: int32 \n├─ expire| integer| 非必须| | 过期时间戳| format: int64 \n├─ public_key| string| 非必须| | 公钥| \n├─ push_token| string| 非必须| | 推送Token| \n├─ store_token| string| 非必须| | 文件token| \n├─ token| string| 非必须| | 访问token| \n├─ user_id| integer| 非必须| | 用户ID| format: int64 \nmessage| string| 非必须| | 错误信息，如果成功，该项为null| \n \n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
[
{
"from": "human",
"value": "如何处理七牛云的即时通讯用户操作"
},
{
"from": "gpt",
"value": "[即时通讯](https://developer.qiniu.com/IM) > API 文档 >\n[服务端API](https://developer.qiniu.com/IM/api/8094/im-server-api-reference) >\n用户操作\n\n# 用户操作\n\n最近更新时间: 2023-01-31 14:23:17\n\n# 注册用户\n\n## 基本信息\n\n \n \n POST /user/register/v2\n Host: <api-endpoint>\n Content-Type: application/json\n \n\n### 接口描述\n\n注册用户。\n\n## 请求参数\n\n### Headers\n\n参数名称 | 参数类型 | 必填 | 备注 \n---|---|---|--- \naccess-token | string | 否 | 令牌 \napp_id | int64 | 是 | 应用ID \ngroup_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 \nuser_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 \n \n### Body\n\n \n \n {\n \"username\":\"<user name>\", //用户名\n \"password\":\"<password>\" //密码\n }\n \n\n## 返回数据\n\n \n \n {\n \"code\": 200, //返回码，200 表示成功\n \"message\": \"<error message>\", //错误信息。如果成功，该字段为空。\n \"data\": {\n \"id\":<id>,\n \"user_id\":<user_id>, //用户ID\n \"auth_mode\":0, //验证方式, 0 - 无需验证，任何人可以加为好友, 1 - 需要同意方可加为好友, 2 - 需要回答问题正确方可加为好友, 3 - 拒绝所有加好友申请\n \"auth_question\":\"<auth question>\", //验证问题\n \"auth_answer\":\"<auth answer>\", //验证问题答案\n \"auto_download\":true, //是否自动下载\n \"group_confirm\":true, //邀请入群时是否需要用户确认: true - 需要用户同意才可加入， false - 自动同意邀请\n \"no_push\":false, //是否关闭推送消息\t\n \"no_push_detail\":false, //是否关闭推送详情\n \"no_push_start_hour\":20, //推送免打扰开始时间\n \"no_push_end_hour\":23, //推送免打扰结束时间\n \"no_sounds\":false, //收到消息时是否静音\t\n \"push_nick_name\":\"<nick>\", //推送昵称\n \"push_token\":\"<token>\", //推送token\n \"silence_start_time\":20, //推送不提醒开始时间\n \"silence_end_time\":8, //推送不提醒结束时间\n \"vibratory\":false, //收到消息时否振动\n }\n }\n \n\n# 批量注册用户\n\n## 基本信息\n\n \n \n POST /user/register/batch\n Host: <api-endpoint>\n Content-Type: application/json\n \n\n### 接口描述\n\n批量注册用户。\n\n## 请求参数\n\n### Headers\n\n参数名称 | 参数类型 | 必填 | 备注 \n---|---|---|--- \naccess-token | string | 否 | 令牌 \napp_id | int64 | 是 | 应用ID \ngroup_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 \nuser_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 \n \n### Body\n\n \n \n {\n \"list\": [\n {\n \"username\":\"<username>\", //用户名\n \"password\":\"<password>\" //密码\n }\n ]\n }\n \n\n## 返回数据\n\n \n \n {\n \"code\": 200, //返回码，200 表示成功\n \"message\": \"<error message>\", //错误信息。如果成功，该字段为空。\n \"data\": [\n {\n \"user_id\":<user_id>, //用户ID\n \"username\":\"<username>\", //用户名\n \"success\":true, //是否成功\n \"reason\":\"<reason>\" //失败原因\n }\n ]\n }\n \n\n# 删除用户\n\n## 基本信息\n\n \n \n POST /user/delete\n DELETE /user/delete\n Host: <api-endpoint>\n Content-Type: application/json\n \n\n### 接口描述\n\n删除用户。\n\n## 请求参数\n\n### Headers\n\n参数名称 | 参数类型 | 必填 | 备注 \n---|---|---|--- \naccess-token | string | 否 | 令牌 \napp_id | int64 | 是 | 应用ID \ngroup_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 \nuser_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 \n \n### Body\n\n无。\n\n## 返回数据\n\n \n \n {\n \"code\": 200, //返回码，200 表示成功\n \"message\": \"<error message>\", //错误信息。如果成功，该字段为空。\n \"data\": true //true 成功\n }\n \n\n# 修改用户名\n\n## 基本信息\n\n \n \n POST /user/username\n PUT /user/username\n Host: <api-endpoint>\n Content-Type: application/json\n \n\n### 接口描述\n\n修改用户的用户名。\n\n## 请求参数\n\n### Headers\n\n参数名称 | 参数类型 | 必填 | 备注 \n---|---|---|--- \naccess-token | string | 否 | 令牌 \napp_id | int64 | 是 | 应用ID \ngroup_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 \nuser_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 \n \n### Query\n\n参数名称 | 类型 | 必须 | 备注 \n---|---|---|--- \nusername | string | 是 | 用户名 \n \n## 返回数据\n\n \n \n {\n \"code\": 200, //返回码，200 表示成功\n \"message\": \"<error message>\", //错误信息。如果成功，该字段为空。\n \"data\": true //返回结果，true 成功\n }\n \n\n# 修改密码\n\n## 基本信息\n\n \n \n POST /user/change_password\n Host: <api-endpoint>\n Content-Type: application/json\n \n\n### 接口描述\n\n修改用户密码。\n\n## 请求参数\n\n### Headers\n\n参数名称 | 参数类型 | 必填 | 备注 \n---|---|---|--- \naccess-token | string | 否 | 令牌 \napp_id | int64 | 是 | 应用ID \ngroup_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 \nuser_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 \n \n### body\n\n \n \n {\n \"old_password\":\"<old password>\", //旧密码\n \"new_password\":\"<new password>\" //新密码\n }\n \n\n## 返回数据\n\n \n \n {\n \"code\": 200, //返回码，200 表示成功\n \"message\": \"<error message>\", //错误信息。如果成功，该字段为空。\n \"data\": true //返回结果，true 成功\n }\n \n\n# 设置头像\n\n## 基本信息\n\n \n \n POST /user/avatar\n PUT /user/avatar\n Host: <api-endpoint>\n Content-Type: application/json\n \n\n### 接口描述\n\n设置用户头像。\n\n## 请求参数\n\n### Headers\n\n参数名称 | 参数类型 | 必填 | 备注 \n---|---|---|--- \naccess-token | string | 否 | 令牌 \napp_id | int64 | 是 | 应用ID \ngroup_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 \nuser_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 \n \n### Body\n\n \n \n {\n \"avatar\": \"<avatar url>\" //头像URL\n }\n \n\n## 返回数据\n\n \n \n {\n \"code\": 200, //返回码，200 表示成功\n \"message\": \"<error message>\", //错误信息。如果成功，该字段为空。\n \"data\": true //返回结果，true 成功\n }\n \n\n# 批量设置头像\n\n## 基本信息\n\n \n \n POST /user/avatar/batch\n PUT /user/avatar/batch\n Host: <api-endpoint>\n Content-Type: application/json\n \n\n### 接口描述\n\n批量设置用户头像。\n\n## 请求参数\n\n### Headers\n\n参数名称 | 参数类型 | 必填 | 备注 \n---|---|---|--- \naccess-token | string | 否 | 令牌 \napp_id | int64 | 是 | 应用ID \ngroup_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 \nuser_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 \n \n### Body\n\n \n \n {\n \"list\":[\n {\n \"user_id\":<user_id>, //用户ID\n \"avatar\":\"<avatar url>\" //头像的URL\n }\n ]\n }\n \n\n## 返回数据\n\n \n \n {\n \"code\": 200, //返回码，200 表示成功\n \"message\": \"<error message>\", //错误信息。如果成功，该字段为空。\n \"data\": [\n {\n \"user_id\":<user_id>, //用户ID\n \"success\":true, //是否成功\n \"reason\":\"<reason>\" //失败原因\n }\n ]\n }\n \n\n# 设置昵称\n\n## 基本信息\n\n \n \n POST /user/nickname\n PUT /user/nickname\n Host: <api-endpoint>\n Content-Type: application/json\n \n\n### 接口描述\n\n设置用户昵称。\n\n## 请求参数\n\n### Headers\n\n参数名称 | 参数类型 | 必填 | 备注 \n---|---|---|--- \naccess-token | string | 否 | 令牌 \napp_id | int64 | 是 | 应用ID \ngroup_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 \nuser_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 \n \n### Query\n\n参数名称 | 类型 | 必须 | 备注 \n---|---|---|--- \nnick_name | string | 是 | 用户昵称 \n \n## 返回数据\n\n \n \n {\n \"code\": 200, //返回码，200 表示成功\n \"message\": \"<error message>\", //错误信息。如果成功，该字段为空。\n \"data\": true //返回结果，true 成功\n }\n \n\n# 设置手机号码\n\n## 基本信息\n\n \n \n POST /user/mobile\n PUT /user/mobile\n Host: <api-endpoint>\n Content-Type: application/json\n \n\n### 接口描述\n\n设置用户手机号码。\n\n## 请求参数\n\n### Headers\n\n参数名称 | 参数类型 | 必填 | 备注 \n---|---|---|--- \naccess-token | string | 否 | 令牌 \napp_id | int64 | 是 | 应用ID \ngroup_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 \nuser_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 \n \n### Query\n\n参数名称 | 类型 | 必须 | 备注 \n---|---|---|--- \nmobile | string | 是 | 手机号码 \n \n## 返回数据\n\n \n \n {\n \"code\": 200, //返回码，200 表示成功\n \"message\": \"<error message>\", //错误信息。如果成功，该字段为空。\n \"data\": true //返回结果，true 成功\n }\n \n\n# 设置公开扩展信息\n\n## 基本信息\n\n \n \n POST /user/public\n PUT /user/public\n Host: <api-endpoint>\n Content-Type: application/json\n \n\n### 接口描述\n\n设置用户公开的扩展信息。\n\n## 请求参数\n\n### Headers\n\n参数名称 | 参数类型 | 必填 | 备注 \n---|---|---|--- \naccess-token | string | 否 | 令牌 \napp_id | int64 | 是 | 应用ID \ngroup_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 \nuser_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 \n \n### Body\n\n参数名称 | 类型 | 必须 | 备注 \n---|---|---|--- \n| string | 是 | 公开扩展信息 \n \n**注意** ：body 直接传递字符串，非json 格式。\n\n## 返回数据\n\n \n \n {\n \"code\": 200, //返回码，200 表示成功\n \"message\": \"<error message>\", //错误信息。如果成功，该字段为空。\n \"data\": true //返回结果，true 成功\n }\n \n\n# 设置私有扩展信息\n\n## 基本信息\n\n \n \n POST /user/private\n PUT /user/private\n Host: <api-endpoint>\n Content-Type: application/json\n \n\n### 接口描述\n\n设置用户私有扩展信息。\n\n## 请求参数\n\n### Headers\n\n参数名称 | 参数类型 | 必填 | 备注 \n---|---|---|--- \naccess-token | string | 否 | 令牌 \napp_id | int64 | 是 | 应用ID \ngroup_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 \nuser_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 \n \n### Body\n\n参数名称 | 类型 | 必须 | 备注 \n---|---|---|--- \n| string | 是 | 私有扩展信息 \n \n**注意** ：body 直接传递字符串，非json 格式。\n\n## 返回数据\n\n \n \n {\n \"code\": 200, //返回码，200 表示成功\n \"message\": \"<error message>\", //错误信息。如果成功，该字段为空。\n \"data\": true //返回结果，true 成功\n }\n \n\n# 设置是否自动下载缩略图和文件\n\n## 基本信息\n\n \n \n POST /user/download\n PUT /user/download\n Host: <api-endpoint>\n Content-Type: application/json\n \n\n### 接口描述\n\n设置用户是否自动下载缩略图和文件。\n\n## 请求参数\n\n### Headers\n\n参数名称 | 参数类型 | 必填 | 备注 \n---|---|---|--- \naccess-token | string | 否 | 令牌 \napp_id | int64 | 是 | 应用ID \ngroup_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 \nuser_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 \n \n### Query\n\n参数名称 | 类型. | 必须 | 备注 \n---|---|---|--- \nvalue | boolean | 是 | true 自动下载 \n \n## 返回数据\n\n \n \n {\n \"code\": 200, //返回码，200 表示成功\n \"message\": \"<error message>\", //错误信息。如果成功，该字段为空。\n \"data\": true //返回结果，true 成功\n }\n \n\n# 设置加好友验证方式\n\n## 基本信息\n\n \n \n POST /user/authmode\n PUT /user/authmode\n Host: <api-endpoint>\n Content-Type: application/json\n \n\n### 接口描述\n\n设置用户，加好友的验证方式。\n\n## 请求参数\n\n### Headers\n\n参数名称 | 参数类型 | 必填 | 备注 \n---|---|---|--- \naccess-token | string | 否 | 令牌 \napp_id | int64 | 是 | 应用ID \ngroup_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 \nuser_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 \n \n### Query\n\n参数名称 | 类型 | 必须 | 备注 \n---|---|---|--- \nvalue | integer | 是 | 验证方式, 0 - 无需验证，任何人可以加为好友, 1 - 需要同意方可加为好友, 2 - 需要回答问题正确方可加为好友, 3 - 拒绝所有加好友申请 \n \n## 返回数据\n\n \n \n {\n \"code\": 200, //返回码，200 表示成功\n \"message\": \"<error message>\", //错误信息。如果成功，该字段为空。\n \"data\": true //返回结果，true 成功\n }\n \n\n# 更新用户信息\n\n## 基本信息\n\n \n \n POST /user/profile\n PUT /user/profile\n Host: <api-endpoint>\n Content-Type: application/json\n \n\n### 接口描述\n\n更新用户的Profile\n\n## 请求参数\n\n### Headers\n\n参数名称 | 参数类型 | 必填 | 备注 \n---|---|---|--- \naccess-token | string | 否 | 令牌 \napp_id | int64 | 是 | 应用ID \ngroup_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 \nuser_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 \n \n### Body\n\n \n \n {\n \"nick_name\":\"<nick>\", //用户昵称\n \"description\":\"<desc>\", //描述信息\n \"public_info\":\"<public info>\", //公开信息，好友和陌生人可见\t\n \"private_info\":\"<private info>\" //私有信息，仅自己可见\t\n }\n \n\n## 返回数据\n\n \n \n {\n \"code\": 200, //返回码，200 表示成功\n \"message\": \"<error message>\", //错误信息。如果成功，该字段为空。\n \"data\": true //返回结果，true 成功\n }\n \n\n# 批量更新用户信息\n\n## 基本信息\n\n \n \n POST /user/profile/batch\n PUT /user/profile/batch\n Host: <api-endpoint>\n Content-Type: application/json\n \n\n### 接口描述\n\n批量更新用户信息\n\n## 请求参数\n\n### headers\n\n参数名称 | 参数类型 | 必填 | 备注 \n---|---|---|--- \naccess-token | string | 否 | 令牌 \napp_id | int64 | 是 | 应用ID \ngroup_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 \nuser_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 \n \n### Body\n\n \n \n {\n \"list\":[\n {\n \"user_id\":<user_id>, //用户ID\n \"nick_name\":\"<nick>\", //昵称\n \"description\":\"<desc>\", //描述信息\n \"public_info\":\"<public info>\", //公开信息，好友和陌生人可见\n \"private_info\":\"<private info>\", //私有信息，仅自己可见\n }\n ]\n }\n \n\n## 返回数据\n\n \n \n {\n \"code\": 200, //返回码，200 表示成功\n \"message\": \"<error message>\", //错误信息。如果成功，该字段为空。\n \"data\": [\n {\n \"user_id\":<user_id>, //用户ID\n \"success\":true, //是否成功\n \"reason\":\"<reason>\" //失败原因\n }\n ]\n }\n \n\n# 获取用户信息\n\n## 基本信息\n\n \n \n GET /user/profile\n Host: <api-endpoint>\n Content-Type: application/json\n \n\n### 接口描述\n\n查询用户信息。\n\n## 请求参数\n\n### Headers\n\n参数名称 | 参数类型 | 必填 | 备注 \n---|---|---|--- \naccess-token | string | 否 | 令牌 \napp_id | int64 | 是 | 应用ID \ngroup_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 \nuser_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 \n \n## 返回数据\n\n \n \n {\n \"code\": 200, //返回码，200 表示成功\n \"message\": \"<error message>\", //错误信息。如果成功，该字段为空。\n \"data\": {\n \"user_id\":<user_id>, //用户ID\n \"username\":\"<username>\", //用户名\n \"avatar\":\"<avatar url>\", //用户头像URL\n \"description\":\"<description>\", //描述信息\n \"mobile\":\"<mobile>\", //手机号码\n \"email\":\"<email>\", //邮箱\n \"nick_name\":\"<nick>\", //昵称\n \"public_info\":\"<public info>\", //公开信息，好友和陌生人可见\t\n \"private_info\":\"<private info>\" //私有信息，仅自己可见\n }\n }\n \n\n# 修改用户设置\n\n## 基本信息\n\n \n \n POST /user/settings\n PUT /user/settings\n Host: <api-endpoint>\n Content-Type: application/json\n \n\n### 接口描述\n\n修改用户的配置信息。\n\n## 请求参数\n\n### headers\n\n参数名称 | 参数类型 | 必填 | 备注 \n---|---|---|--- \naccess-token | string | 否 | 令牌 \napp_id | int64 | 是 | 应用ID \ngroup_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 \nuser_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 \n \n### body\n\n \n \n {\n \"id\":<id>,\n \"user_id\":<user_id>, //用户ID\n \"auth_mode\":0, //验证方式, 0 - 无需验证，任何人可以加为好友, 1 - 需要同意方可加为好友, 2 - 需要回答问题正确方可加为好友, 3 - 拒绝所有加好友申请\n \"auth_question\":\"<auth question>\", //验证问题\n \"auth_answer\":\"<auth answer>\", //验证问题答案\n \"auto_download\":true, //是否自动下载\n \"group_confirm\":true, //邀请入群时是否需要用户确认: true - 需要用户同意才可加入， false - 自动同意邀请\n \"no_push\":false, //是否关闭推送消息\t\n \"no_push_detail\":false, //是否关闭推送详情\n \"no_push_start_hour\":20, //推送免打扰开始时间\n \"no_push_end_hour\":23, //推送免打扰结束时间\n \"no_sounds\":false, //收到消息时是否静音\t\n \"push_nick_name\":\"<nick>\", //推送昵称\n \"push_token\":\"<token>\", //推送token\n \"silence_start_time\":20, //推送不提醒开始时间\n \"silence_end_time\":8, //推送不提醒结束时间\n \"vibratory\":false, //收到消息时否振动\n }\n \n\n## 返回数据\n\n \n \n {\n \"code\": 200, //返回码，200 表示成功\n \"message\": \"<error message>\", //错误信息。如果成功，该字段为空。\n \"data\": true //返回结果，true 成功\n }\n \n\n# 获取用户设置\n\n## 基本信息\n\n \n \n GET /user/settings\n Host: <api-endpoint>\n Content-Type: application/json\n \n\n### 接口描述\n\n获取用户的设置信息。\n\n## 请求参数\n\n### Headers\n\n参数名称 | 参数类型 | 必填 | 备注 \n---|---|---|--- \naccess-token | string | 否 | 令牌 \napp_id | int64 | 是 | 应用ID \ngroup_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 \nuser_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 \n \n## 返回数据\n\n \n \n {\n \"code\": 200, //返回码，200 表示成功\n \"message\": \"<error message>\", //错误信息。如果成功，该字段为空。\n \"data\": {\n \"id\":<id>,\n \"user_id\":<user_id>, //用户ID\n \"auth_mode\":0, //验证方式, 0 - 无需验证，任何人可以加为好友, 1 - 需要同意方可加为好友, 2 - 需要回答问题正确方可加为好友, 3 - 拒绝所有加好友申请\n \"auth_question\":\"<auth question>\", //验证问题\n \"auth_answer\":\"<auth answer>\", //验证问题答案\n \"auto_download\":true, //是否自动下载\n \"group_confirm\":true, //邀请入群时是否需要用户确认: true - 需要用户同意才可加入， false - 自动同意邀请\n \"no_push\":false, //是否关闭推送消息\t\n \"no_push_detail\":false, //是否关闭推送详情\n \"no_push_start_hour\":20, //推送免打扰开始时间\n \"no_push_end_hour\":23, //推送免打扰结束时间\n \"no_sounds\":false, //收到消息时是否静音\t\n \"push_nick_name\":\"<nick>\", //推送昵称\n \"push_token\":\"<token>\", //推送token\n \"silence_start_time\":20, //推送不提醒开始时间\n \"silence_end_time\":8, //推送不提醒结束时间\n \"vibratory\":false, //收到消息时否振动\n }\n }\n \n\n# 封禁用户\n\n## 基本信息\n\n \n \n PUT /user/disable\n Host: <api-endpoint>\n Content-Type: application/json\n \n\n### 接口描述\n\n封禁用户，被封禁的用户无法登录IM。\n\n## 请求参数\n\n### Headers\n\n参数名称 | 参数类型 | 必填 | 备注 \n---|---|---|--- \naccess-token | string | 否 | 令牌 \napp_id | int64 | 是 | 应用ID \ngroup_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 \nuser_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 \n \n### Body\n\n \n \n {\n \"list\": [ //用户ID 列表\n 0\n ]\n }\n \n\n## 返回数据\n\n \n \n {\n \"code\": 200, //返回码，200 表示成功\n \"message\": \"<error message>\", //错误信息。如果成功，该字段为空。\n \"data\": true //返回结果，true 成功\n }\n \n\n# 解禁用户\n\n## 基本信息\n\n \n \n PUT /user/enable\n Host: <api-endpoint>\n Content-Type: application/json\n \n\n### 接口描述：\n\n解除封禁用户，被解禁的用户恢复可以使用IM。\n\n## 请求参数\n\n### Headers\n\n参数名称 | 参数类型 | 必填 | 备注 \n---|---|---|--- \naccess-token | string | 否 | 令牌 \napp_id | int64 | 是 | 应用ID \ngroup_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 \nuser_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 \n \n### Body\n\n \n \n {\n \"list\": [ //用户ID 列表\n 0\n ]\n }\n \n\n## 返回数据\n\n \n \n {\n \"code\": 200, //返回码，200 表示成功\n \"message\": \"<error message>\", //错误信息。如果成功，该字段为空。\n \"data\": true //返回结果，true 成功\n }\n \n\n# 设备列表\n\n## 基本信息\n\n \n \n GET /user/device/list\n Host: <api-endpoint>\n Content-Type: application/json\n \n\n### 接口描述\n\n查询用户登录的设备列表。\n\n## 请求参数\n\n### Headers\n\n参数名称 | 参数类型 | 必填 | 备注 \n---|---|---|--- \naccess-token | string | 否 | 令牌 \napp_id | int64 | 是 | 应用ID \ngroup_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 \nuser_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 \n \n## 返回数据\n\n \n \n {\n \"code\": 200, //返回码，200 表示成功\n \"version\":<version>, //版本\n \"message\": \"<error message>\", //错误信息。如果成功，该字段为空。\n \t \"cursor\": \"<cursor>\", //游标，返回结果中缺失 cursor，表示已经返回最后一页\n \t \"data\":[\n \t {\n \"device_sn\": 1, //整数，设备序列号\n \"platform\": 2, //平台，1:ios, 2:android, 3:windows, 4:mac, 5:linux, 6:web\n \"user_agent\": \"\", //\n \"user_id\": <user_id> //用户ID\n \t }\n \t ]\n }\n \n\n# 删除device\n\n## 基本信息\n\n \n \n POST /user/device/remove\n DELETE /user/device/remove\n Host: <api-endpoint>\n Content-Type: application/json\n \n\n### 接口描述\n\n删除用户登录设备。\n\n## 请求参数\n\n### headers\n\n参数名称 | 参数类型 | 必填 | 备注 \n---|---|---|--- \naccess-token | string | 否 | 令牌 \napp_id | int64 | 是 | 应用ID \ngroup_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 \nuser_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 \n \n### Query\n\n参数名称 | 类型 | 必须 | 备注 \n---|---|---|--- \ndevice_sn | integer | 是 | device_sn \n \n## 返回数据\n\n \n \n {\n \"code\": 200, //返回码，200 表示成功\n \"message\": \"<error message>\", //错误信息。如果成功，该字段为空。\n \"data\": true //返回结果，true 成功\n }\n \n\n# 踢指定设备下线\n\n## 基本信息\n\n \n \n POST /user/kick\n PUT /user/kick\n Host: <api-endpoint>\n Content-Type: application/json\n \n\n### 接口描述\n\n踢出指定用户设备，使下线。\n\n## 请求参数\n\n### Headers\n\n参数名称 | 参数类型 | 必填 | 备注 \n---|---|---|--- \naccess-token | string | 否 | 令牌 \napp_id | int64 | 是 | 应用ID \ngroup_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 \nuser_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 \n \n### Query\n\n参数名称 | 类型 | 必须 | 备注 \n---|---|---|--- \ndevice_sn | integer | 是 | 不传device_sn表示踢所有设备 \n \n## 返回数据\n\n \n \n {\n \"code\": 200, //返回码，200 表示成功\n \"message\": \"<error message>\", //错误信息。如果成功，该字段为空。\n \"data\": true //返回结果，true 成功\n }\n \n\n# 注册推送用户\n\n## 基本信息\n\n \n \n POST /user/register/push\n Host: <api-endpoint>\n Content-Type: application/json\n \n\n### 接口描述\n\n注册推送用户。\n\n## 请求参数\n\n### Headers\n\n参数名称 | 参数类型 | 必填 | 备注 \n---|---|---|--- \naccess-token | string | 否 | 令牌 \napp_id | int64 | 是 | 应用ID \ngroup_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 \nuser_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 \n \n### Body\n\n \n \n {\n \"username\":\"<user name>\", //用户名\n \"password\":\"<password>\", //密码，必填\n \"device_guid\":\"<device guid>\", //设备ID\n \"alias\":\"<alias>\", //别名\n \"push_token\":\"<push token>\", //推送token\n \"sign\":\"<sign>\" //签名\n }\n \n\n## 返回数据\n\n \n \n {\n \"code\": 200, //返回码，200 表示成功\n \"message\": \"<error message>\", //错误信息。如果成功，该字段为空。\n \"data\": {\n \"id\":<id>,\n \"user_id\":<user_id>, //用户ID\n \"auth_mode\":0, //验证方式, 0 - 无需验证，任何人可以加为好友, 1 - 需要同意方可加为好友, 2 - 需要回答问题正确方可加为好友, 3 - 拒绝所有加好友申请\n \"auth_question\":\"<auth question>\", //验证问题\n \"auth_answer\":\"<auth answer>\", //验证问题答案\n \"auto_download\":true, //是否自动下载\n \"group_confirm\":true, //邀请入群时是否需要用户确认: true - 需要用户同意才可加入， false - 自动同意邀请\n \"no_push\":false, //是否关闭推送消息\t\n \"no_push_detail\":false, //是否关闭推送详情\n \"no_push_start_hour\":20, //推送免打扰开始时间\n \"no_push_end_hour\":23, //推送免打扰结束时间\n \"no_sounds\":false, //收到消息时是否静音\t\n \"push_nick_name\":\"<nick>\", //推送昵称\n \"push_token\":\"<token>\", //推送token\n \"silence_start_time\":20, //推送不提醒开始时间\n \"silence_end_time\":8, //推送不提醒结束时间\n \"vibratory\":false, //收到消息时否振动\n }\n }\n \n\n# 绑定token\n\n## 基本信息\n\n \n \n POST /user/token/bind\n PUT /user/token/bind\n Host: <api-endpoint>\n Content-Type: application/json\n \n\n### 接口描述\n\n绑定设备推送的token。\n\n## 请求参数\n\n### Headers\n\n参数名称 | 参数类型 | 必填 | 备注 \n---|---|---|--- \naccess-token | string | 否 | 令牌 \napp_id | int64 | 是 | 应用ID \ngroup_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 \nuser_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 \n \n### Body\n\n \n \n {\n \"device_sn\":1, //设备SN\n \"device_token\":\"<token>\", //设备的token\n \"notifier_name\":\"<notifier name>\" //证书名称\n }\n \n\n## 返回数据\n\n \n \n {\n \"code\": 200, //返回码，200 表示成功\n \"message\": \"<error message>\", //错误信息。如果成功，该字段为空。\n \"data\": true //返回结果，true 成功\n }\n \n\n# 解绑token\n\n## 基本信息\n\n \n \n POST /user/token/unbind\n DELETE /user/token/unbind\n Host: <api-endpoint>\n Content-Type: application/json\n \n\n### 接口描述\n\n解绑推送token。\n\n## 请求参数\n\n### Headers\n\n参数名称 | 参数类型 | 必填 | 备注 \n---|---|---|--- \naccess-token | string | 否 | 令牌 \napp_id | int64 | 是 | 应用ID \ngroup_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 \nuser_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 \n \n### Query\n\n参数名称 | 类型 | 必须 | 备注 \n---|---|---|--- \ndeviceSn | integer | 是 | 设备序号 \n \n## 返回数据\n\n \n \n {\n \"code\": 200, //返回码，200 表示成功\n \"message\": \"<error message>\", //错误信息。如果成功，该字段为空。\n \"data\": true //返回结果，true 成功\n }\n \n\n# 绑定别名\n\n## 基本信息\n\n \n \n POST /user/push/alias\n Host: <api-endpoint>\n Content-Type: application/json\n \n\n### 接口描述\n\n绑定用户的推送别名。\n\n## 请求参数\n\n### Headers\n\n参数名称 | 参数类型 | 必填 | 备注 \n---|---|---|--- \naccess-token | string | 否 | 令牌 \napp_id | int64 | 是 | 应用ID \ngroup_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 \nuser_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 \n \n### Body\n\n \n \n {\n \"alias\":\"<alias>\", //别名\n \"push_token\":\"<token>\" //推送token\n }\n \n\n## 返回数据\n\n \n \n {\n \"code\": 200, //返回码，200 表示成功\n \"message\": \"<error message>\", //错误信息。如果成功，该字段为空。\n \"data\": true //返回结果，true 成功\n }\n \n\n# 绑定标签\n\n## 基本信息\n\n \n \n POST /user/push/tag\n Host: <api-endpoint>\n Content-Type: application/json\n \n\n### 接口描述\n\n绑定用户的标签。\n\n## 请求参数\n\n### Headers\n\n参数名称 | 参数类型 | 必填 | 备注 \n---|---|---|--- \naccess-token | string | 否 | 令牌 \napp_id | int64 | 是 | 应用ID \ngroup_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 \nuser_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 \n \n### Body\n\n \n \n {\n \"tags\":[\"<tag1>\", \"<tag2>\"] //标签列表，每个标签就是一个字符串。\n }\n \n\n## 返回数据\n\n \n \n {\n \"code\": 200, //返回码，200 表示成功\n \"message\": \"<error message>\", //错误信息。如果成功，该字段为空。\n \"data\": true //返回结果，true 成功\n }\n \n\n# 解绑标签\n\n## 基本信息\n\n \n \n DELETE /user/push/tag\n Host: <api-endpoint>\n Content-Type: application/json\n \n\n### 接口描述\n\n删除用户的推送标签。\n\n## 请求参数\n\n### Headers\n\n参数名称 | 参数类型 | 必填 | 备注 \n---|---|---|--- \naccess-token | string | 否 | 令牌 \napp_id | int64 | 是 | 应用ID \ngroup_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 \nuser_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 \n \n### Body\n\n \n \n {\n \"tags\":[\"<tag1>\", \"<tag2>\"]\n }\n \n\n## 返回数据\n\n \n \n {\n \"code\": 200, //返回码，200 表示成功\n \"message\": \"<error message>\", //错误信息。如果成功，该字段为空。\n \"data\": true //返回结果，true 成功\n }\n \n\n# 删除所有标签\n\n## 基本信息\n\n \n \n DELETE /user/push/tag/all\n Host: <api-endpoint>\n Content-Type: application/json\n \n\n### 接口描述\n\n删除所有标签。\n\n## 请求参数\n\n### headers\n\n参数名称 | 参数类型 | 必填 | 备注 \n---|---|---|--- \naccess-token | string | 否 | 令牌 \napp_id | int64 | 是 | 应用ID \ngroup_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 \nuser_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 \n \n## 返回数据\n\n \n \n {\n \"code\": 200, //返回码，200 表示成功\n \"message\": \"<error message>\", //错误信息。如果成功，该字段为空。\n \"data\": true //返回结果，true 成功\n }\n \n\n# 获取标签\n\n## 基本信息\n\n \n \n GET /user/push/tag\n Host: <api-endpoint>\n Content-Type: application/json\n \n\n### 接口描述\n\n查询用户的推送标签。\n\n## 请求参数\n\n### Headers\n\n参数名称 | 参数类型 | 必填 | 备注 \n---|---|---|--- \naccess-token | string | 否 | 令牌 \napp_id | int64 | 是 | 应用ID \ngroup_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 \nuser_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 \n \n## 返回数据\n\n \n \n {\n \"code\": 200, //返回码，200 表示成功\n \"message\": \"<error message>\", //错误信息。如果成功，该字段为空。\n \"data\": [\"<tag1>\", \"<tag2>\"]\n }\n \n\n# 设置badge\n\n## 基本信息\n\n \n \n POST /user/push/badge\n Host: <api-endpoint>\n Content-Type: application/json\n \n\n### 接口描述\n\n设置用户的推送角标。\n\n## 请求参数\n\n### Headers\n\n参数名称 | 参数类型 | 必填 | 备注 \n---|---|---|--- \naccess-token | string | 否 | 令牌 \napp_id | int64 | 是 | 应用ID \ngroup_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 \nuser_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 \n \n### Body\n\n \n \n {\n \"badge\":3, //角标数值\n }\n \n\n## 返回数据\n\n \n \n {\n \"code\": 200, //返回码，200 表示成功\n \"message\": \"<error message>\", //错误信息。如果成功，该字段为空。\n \"data\": true //返回结果，true 成功\n }\n \n\n# 设置推送免打扰时间\n\n## 基本信息\n\n \n \n POST /user/push/limit\n PUT /user/push/limit\n Host: <api-endpoint>\n Content-Type: application/json\n \n\n### 接口描述\n\n设置用户推送的免打扰时间。\n\n## 请求参数\n\n### Headers\n\n参数名称 | 参数类型 | 必填 | 备注 \n---|---|---|--- \naccess-token | string | 否 | 令牌 \napp_id | int64 | 是 | 应用ID \ngroup_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 \nuser_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 \n \n### Query\n\n参数名称 | 类型 | 必须 | 备注 \n---|---|---|--- \nno_push_end_hour | integer | 是 | 不推送结束时间（小时），0~23 \nno_push_start_hour | integer | 是 | 不推送开始时间（小时），0~23 \n \n## 返回数据\n\n \n \n {\n \"code\": 200, //返回码，200 表示成功\n \"message\": \"<error message>\", //错误信息。如果成功，该字段为空。\n \"data\": true //返回结果，true 成功\n }\n \n\n# 设置推送昵称\n\n## 基本信息\n\n \n \n POST /user/push/nickname\n PUT /user/push/nickname\n Host: <api-endpoint>\n Content-Type: application/json\n \n\n### 接口描述\n\n设置用户的推送昵称。\n\n## 请求参数\n\n### Headers\n\n参数名称 | 参数类型 | 必填 | 备注 \n---|---|---|--- \naccess-token | string | 否 | 令牌 \napp_id | int64 | 是 | 应用ID \ngroup_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 \nuser_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 \n \n### Query\n\n参数名称 | 类型 | 必须 | 备注 \n---|---|---|--- \nnick_name | string | 是 | 用户推送昵称 \n \n## 返回数据\n\n \n \n {\n \"code\": 200, //返回码，200 表示成功\n \"message\": \"<error message>\", //错误信息。如果成功，该字段为空。\n \"data\": true //返回结果，true 成功\n }\n \n\n# 设置新消息是否关闭声音提醒\n\n## 基本信息\n\n \n \n POST /user/sounds\n PUT /user/sounds\n Host: <api-endpoint>\n Content-Type: application/json\n \n\n### 接口描述\n\n设置用户的新消息提醒，是否关闭声音提醒。\n\n## 请求参数\n\n### Headers\n\n参数名称 | 参数类型 | 必填 | 备注 \n---|---|---|--- \naccess-token | string | 否 | 令牌 \napp_id | int64 | 是 | 应用ID \ngroup_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 \nuser_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 \n \n### Query\n\n参数名称 | 类型 | 必须 | 备注 \n---|---|---|--- \nvalue | boolean | 是 | true 关闭 \n \n## 返回数据\n\n \n \n {\n \"code\": 200, //返回码，200 表示成功\n \"message\": \"<error message>\", //错误信息。如果成功，该字段为空。\n \"data\": true //返回结果，true 成功\n }\n \n\n# 设置新消息是否振动\n\n## 基本信息\n\n \n \n POST /user/vibratory\n PUT /user/vibratory\n Host: <api-endpoint>\n Content-Type: application/json\n \n\n### 接口描述\n\n设置用户收到新消息，是否震动提醒。\n\n## 请求参数\n\n### Headers\n\n参数名称 | 参数类型 | 必填 | 备注 \n---|---|---|--- \naccess-token | string | 否 | 令牌 \napp_id | int64 | 是 | 应用ID \ngroup_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 \nuser_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 \n \n### Query\n\n参数名称 | 类型. | 必须 | 备注 \n---|---|---|--- \nvalue | boolean | 是 | true 震动 \n \n## 返回数据\n\n \n \n {\n \"code\": 200, //返回码，200 表示成功\n \"message\": \"<error message>\", //错误信息。如果成功，该字段为空。\n \"data\": true //返回结果，true 成功\n }\n \n\n# 设置是否关闭推送\n\n## 基本信息\n\n \n \n POST /user/push\n PUT /user/push\n Host: <api-endpoint>\n Content-Type: application/json\n \n\n### 接口描述\n\n设置用户是否关闭推送。\n\n## 请求参数\n\n### Headers\n\n参数名称 | 参数类型 | 必填 | 备注 \n---|---|---|--- \naccess-token | string | 否 | 令牌 \napp_id | int64 | 是 | 应用ID \ngroup_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 \nuser_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 \n \n### Query\n\n参数名称 | 类型. | 必须 | 备注 \n---|---|---|--- \nvalue | boolean | 是 | true 关闭推送 \n \n## 返回数据\n\n \n \n {\n \"code\": 200, //返回码，200 表示成功\n \"message\": \"<error message>\", //错误信息。如果成功，该字段为空。\n \"data\": true //返回结果，true 成功\n }\n \n\n# 设置是否关闭推送详情\n\n## 基本信息\n\n \n \n POST /user/push/detail\n PUT /user/push/detail\n Host: <api-endpoint>\n Content-Type: application/json\n \n\n### 接口描述\n\n设置用户是否关闭推送详情。\n\n## 请求参数\n\n### Headers\n\n参数名称 | 参数类型 | 必填 | 备注 \n---|---|---|--- \naccess-token | string | 否 | 令牌 \napp_id | int64 | 是 | 应用ID \ngroup_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 \nuser_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 \n \n### Query\n\n参数名称 | 类型. | 必须 | 备注 \n---|---|---|--- \nvalue | boolean | 是 | true 关闭推送 \n \n## 返回数据\n\n \n \n {\n \"code\": 200, //返回码，200 表示成功\n \"message\": \"<error message>\", //错误信息。如果成功，该字段为空。\n \"data\": true //返回结果，true 成功\n }\n \n\n# 列出APP下所有用户\n\n## 基本信息\n\n \n \n GET /user/list\n Host: <api-endpoint>\n Content-Type: application/json\n \n\n### 接口描述\n\n列出APP 下所有用户。\n\n## 请求参数\n\n### Headers\n\n参数名称 | 参数类型 | 必填 | 备注 \n---|---|---|--- \naccess-token | string | 否 | 令牌 \napp_id | int64 | 是 | 应用ID \ngroup_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口 \nuser_id | int64 | 否 | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口 \n \n### Query\n\n参数名称 | 类型. | 必须 | 备注 \n---|---|---|--- \npage_num | int32 | 否 | 页数：必须大于0，默认为1 \npage_size | int32 | 否 | 每页大小：默认每页50条 \n \n## 返回数据\n\n \n \n {\n \"code\": 200, //返回码，200 表示成功\n \"message\": \"<error message>\", //错误信息。如果成功，该字段为空。\n \"data\": [{\n \"user_id\": 12345, // 用户ID\n \"username\":\"zhangsan\", // 用户名\n \"status\": 0 // 状态：0-正常，1-封禁\n }]\n }\n \n\n以上内容是否对您有帮助？\n\n"
}
] | qiniu developer | 1 |
Subsets and Splits
No saved queries yet
Save your SQL queries to embed, download, and access them later. Queries will appear here once saved.