接口开发文档

最新推荐文章于 2024-07-10 08:41:53 发布
最新推荐文章于 2024-07-10 08:41:53 发布
阅读量1.7k 收藏 2
点赞数 1
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_29124379/article/details/106918046
版权

 

目录

1、场景列表、分组列表（所属分组、全部分组、全部场景、收藏等）

2、用户列表

3、获取分组、场景下面所有用户

4、获取通话记录列表  [v1.4]

5、联系人收藏\取消收藏

6、分组管理

7、视频通讯-新建房间【已废弃】

8、视频通讯-房间操作【v1.5新增】【已废弃】

9、通话记录[已废弃]

10、查询单个用户详细信息[v1.7新增]

 

11、删除通话记录[v1.3新增]

12、GPS坐标上传

13、视频信息-查询视频列表

14、人员在线离线自定义消息【v1.6新增】

1、场景列表、分组列表（所属分组、全部分组、全部场景、收藏等）

接口地址：interface/linkMan/allScene

请求参数：

type

查询的目标数据

1001=查询所有场景列表

2001=查询某个场景下面分组列表（场景下面有多少分组）

sceneId场景id如果type=2001,sceneId表示场景的id，否则不理会

返回数据：

{
    "code":"0",
    "msg":"操作成功!",
    "data":[
        {
            "name":"所属分组2",
            "id":"92D1A0D5035820B9E0530100007F8765",
            "url":"http://1.png",
            "permission":"操作权限"
        },
        {
            "name":"所属分组2",
            "id":"92D1A0D5035820B9E0530100007F8765",
            "url":"http://1.png",
            "permission":"操作权限"
        }
    ]
}

参数说明

name场景名称"所属分组", "全部分组", "全部场景", "临时分组", "常用联系人", "全部用户", "收藏"
id分组id，数据库字段

用于操作场景/分组

 

如果是场景id则为

 10001;//所属分组
 10002;//全部分组
 10003;//全部场景
 10004;//临时分组
 10005;//常用联系人
 10006;//全部用户
 10007;//收藏
url场景的图标 
permission操作权限可能有解散分组、增加成员、发起群呼等权限，后面再考虑

 

 

 

2、用户列表

接口地址：a/interface/linkMan/userAll

请求参数：

返回数据：

{
    "data":[
        {
            "name":"张三",
            "userId":"1234",
            "userIconUrl":"https://isux.tencent.com/articles/71.html",
            "isOnline":"0 不在线  1 在线",
            "onlineTime":"在线时长",
            "callnum":"呼叫次数",
            "lat":"",
            "lng":"",
            "address":"合肥市、恒兴广场",
            "spid":"xbksh001",
            "dept":"部门",
            "deptId":"部门id",
             "linkphone":"18010971111",
            "calledNum":"被呼叫次数"
        }
    ],
    "code":"0",
    "msg":"操作成功!"
}

参数说明

name姓名 
userId用户id 

userIconUrl

用户图标 

isOnline

在线离线情况0 不在线  1 在线
onlineTime在线时长 
callnum呼叫次数 
lat 当前经纬度坐标和位置信息
lng 
address 
spid视频调度的id可用户腾讯和清新互联视频id
linkphone    联系方式 
calledNum  被呼叫次数 

 

 

 

 

 

 

 

 

3、获取分组、场景下面所有用户

接口地址：a/interface/linkMan/senceUsers

请求参数：

type

查询目标数据

1001=表示只查询senceId下面所有人员信息（单个或多个场景下面所有的人）

2001=表示只查询ids下面所有人员信息（单个或多个分组下面所有的人）

ids分组id

可以为多个逗号分隔，若空，表示查询当前场景（senceId）所有分组的好友列表

senceId场景id如全部场景、全部分组、所属分组的id，若空，表示查询当前用户所有场景的好友列表

返回数据：

{
    "data":[
        {
            "name":"张三",
            "userId":"1234",
            "senceId":"92D1A0D5035820B9E0530100007F8765",
            "spid":"",
            "isOnline":"0"
        },
        {
            "name":"李四",
            "userId":"2233",
            "senceId":"92D1A0D5035820B9E0530100007F8765"
        }
    ],
    "code":"0",
    "msg":"操作成功!"
}

参数说明

name姓名 
userId用户id 

senceId

当前用户所属的场景id\分组id

type=1001，就是场景id

type=2001，就是分组id

spid视频id 
isOnline在线状态 

 

 

 

4、获取通话记录列表  [v1.4]

接口地址:a/interface/videoTalk/findTalkRecord

请求参数:

type记录类型 
wj 未接
yb 已拨
qb 全部
yj 已接
timeStart 【暂时废弃】查询时间范围不传表示查询所有的(或者是近三个月的)
timeEnd   【暂时废弃】查询时间范围不传表示查询所有的
targetUserId【v1.4新增】查询目标用户查询当前登录用户跟targetUserId的通话记录，若空表示所有的数据
pageSize【v1.4新增】10每页大小
pageNo【v1.4新增】1第几页从1开始

返回数据:

{
    "data":[
        {
            "name":"张三",
            "userId":"1234",
            "phoneStatu":"0",
            "phoneStartTime":"2020-06-23 16:52:31",
            "phoneEndTime":"2020-06-23 16:52:31",
            "flag":"1",
            "recordId":"11223355544sdad"
        }
    ],
    "count":"1000",
    "code":"0",
    "msg":"操作成功!"
}

参数说明

phoneStatu通话状态

-1 = 未接

1 = 已接

2 = 已拨

phoneStartTime通话开始时间以创建房间开始
phoneEndTime通话结束时间挂断结束
flag     通话类型

1=多人通话

0(其他)=单人通话

userId    多人通话时userid逗号分隔
userName    多人通话时不传userName
recordId      【v1.3】通话记录id 
count     【v1.4】数据总数分页使用

 

5、联系人收藏\取消收藏

接口地址：a/interface/videoTalk/operateContact

请求参数：

type操作类型

1 = 新增联系人收藏

2 = 取消联系人收藏 

userJson要收藏获取取消收藏人员的数据[
    {
        "userId":"123"
    },
    {
        "userId":"223"
    }
]

返回参数

{
    "code":"0",
    "msg":"操作成功!"
}

6、分组管理

接口地址：a/interface/videoTalk/operateGroup

请求参数：

type操作类型

1=新增分组（先不搞）

2=删除分组

3=分组重命名

4=分组新增人员

5=分组移除人员

6=临时分组升级为场景（这个场景就是分组）

groupId分组id 
senceId场景id 
groupName分组名称新增，重命名、升级为场景时用到（升级场景时可不重命名）
userJson人员操作的数据[
    {
        "userId":"123"
    },
    {
        "userId":"223"
    }
]

返回参数

{
    "code":"0",
    "msg":"操作成功!"
}

7、视频通讯-新建房间【已废弃】

接口地址：a/interface/videoTalk/createRoom

请求参数：

userId发起人userId 
spid

发起人视频id

 
meetingName会议场景，如综合执法 
meetingThemeName会议主题，如，关于xx违章停车 
calledUserJson被呼叫人信息[
    {
        "userId":"123",
        "spid":"xb001"
    },
    {
        "userId":"223",
        "spid":"xb001"
    }
]

返回数据

{
    "data":{
        "roomId":"20200624",
        "roomUsers":[
            {
                "userId":"404",
                "spid":"xb001"
            }
        ]
    },
    "code":"0",
    "msg":"操作成功!"
}

参数说明

roomId房间id 
roomUsers成功进房屋里面人员防止有人失败或者没权限等特殊情况

8、视频通讯-房间操作【v1.5新增】【已废弃】

接口地址：a/interface/videoTalk/operateRoom

请求参数:

type操作类型

1=房间新增人员（转交）

2=人员退出

3=踢人（待完善）

4=通话结束（正常情况下是没问题的，服务器端还是要走可靠的路子）

5=开启群组视频录制【v1.5】

userJson操作的人员[
    {
        "userId":"123",
        "spid":"xb001"
    },
    {
        "userId":"223",
        "spid":"xb001"
    }
]
roomId房间号 

返回数据

{
    "code":"0",
    "msg":"操作成功!"
}

 

 

9、通话记录[已废弃]

接口地址：a/interface/videoTalk/savetalkInfo

参数

type

9001= 发起通话

9002= 整体挂断通话

9003 = 中途退出

9004 = 中途加入

 
userJson    {
        "userId":"123",
        "spid":"xb001"
    },
    {
        "userId":"223",
        "spid":"xb001"
    }
]		 
meetingId当前聊天群组id [以后也可能会有房间id] 
remark备注 
{
    "data":{
      
        "userJson":[
            {
                "userId":"404",
                "spid":"xb001"
            }
        ]
    },
    "code":"0",
    "msg":"操作成功!"
}
meetingId此次通话id 
userJson用户数据 
   

10、查询单个用户详细信息[v1.7新增]

接口地址：a/interface/linkMan/userinfoDetail

请求参数：

userId目标用户 
   
   

返回数据：

{
    "data": {
            "name":"张三",
            "userId":"1234",
            "userIconUrl":"https://isux.tencent.com/articles/71.html",
            "isOnline":"0 不在线  1 在线",
            "onlineTime":"在线时长",
            "callnum":"呼叫次数",
            "lat":"",
            "lng":"",
            "address":"合肥市、恒兴广场",
            "spid":"xbksh001",
            "dept":"部门",
            "deptId":"部门id",
             "linkphone":"18010971111",
            "calledNum":"被呼叫次数",
            "senceId"："所属场景(逗号分隔)",
            "groupId":"所属分组(逗号分隔)",
             "isCollected":"1 = 已收藏  0 未"
        }
    ,
    "code":"0",
    "msg":"操作成功!"
}

参数说明

name姓名 
userId用户id 

userIconUrl

用户图标 

isOnline

在线离线情况0 不在线  1 在线
onlineTime在线时长 
callnum呼叫次数 
lat 当前经纬度坐标和位置信息
lng 
address 
spid视频调度的id可用户腾讯和清新互联视频id
linkphone    联系方式 
calledNum  被呼叫次数 

 

 

 

 

 

 

 

 

11、删除通话记录[v1.3新增]

接口地址：a/interface/videoTalk/operateRecord

请求参数：

type

操作类型

8001= 删除所有通话记录(当前登录用户与目标用户的通话记录)

8002=删除单个或多个通话记录(当前登录用户与目标用户的通话记录)

recordIds通话记录id逗号分隔
targetUserId目标用户 

返回数据

{
    "code":"0",
    "msg":"操作成功!"
}

 

12、GPS坐标上传

接口地址：a/interface/link/insertGPS

提交参数:

userId用户id 
userName姓名 
gpsInfosgps信息[
    {
        "lat":"31.1111",
        "lng":"117.2222",
        "location":"安徽省合肥市",
        "locationTime":"2020-05-07 17:22:33"
    },
    {
        "lat":"31.1111",
        "lng":"117.2222",
        "location":"安徽省合肥市",
        "locationTime":"2020-05-07 18:22:33"
    }
]
uploadRemark提交备注【username+时间格式】保存成功或者失败把这个数据返回给我

返回数据

{
    "code":"0",
    "data":"张三 2020-05-06 17:00:55"
    "msg":"操作成功!"
}

参数说明

updateTime本次提交gps的时间不管保存成功失败，在返回数据时把这个数据放在data里面返回出来
uploadRemark提交备注表示在这个时间用户所在位置
data直接赋值uploadRemark值就行 

13、视频信息-查询视频列表

接口地址：a/interface/videoTalk/videoInfos

提交参数:

search查询关键字 
pageNo页码 
pageSize页面大小 

 

返回数据

{
    "code":"0",
    "count":1000,
    "data":[
        {
            "senceName":"会议场景名称，如综合执法",
            "themeName":"参与主题，如关于违章停车",
            "userIds":"参与人员，多人用逗号分隔",
            "meetingTime":"12:22",
            "meetingDate":"会议日期，2020-07-22",
            "videoUrl":"https://www.json.cn/1.mp4",
            "videoKeyFrame":"https://www.json.cn/1.jpg"
        }
    ],
    "msg":"操作成功!"
}

参数说明

videoUrl视频播放地址 
videoKeyFrame视频关键帧 

 

 

14、人员在线离线自定义消息【v1.6新增】

接口地址：https://console.tim.qq.com/v4/openim/batchsendmsg?usersig=eJwtzM0KwjAQBOB3yVUp221CbMGbRRB-Duoh3lKShkVaYxpqQXx3S9vjfDPMl92O16S3gRUME2DrKZOxbaSaJtamoZa6GHR8hWXQmaf2ngwrUg6Q5SAlnxs7eAp2dCEEAsCskZrJci4lIsrlhdz43ytVDpXLvCrTaFHtPyd38W--qFapE4dOVOcN392txnLLfn9kmzS5&identifier=administrator&sdkappid=你的appid&contenttype=json

提交参数:

{
    "SyncOtherMachine":2,
    "To_Account":[
        "user0",
        "user1"
    ],
    "MsgRandom":19901224,
    "MsgBody":[
        {
            "MsgType":"TIMCustomElem",
            "MsgContent":{
                "Data":"1,user0,1",
                "Desc":"notification",
                "Ext":"userOnline",
                "Sound":"dingdong.aiff"
            }
        }
    ]
}		 

MsgRandom:随机数

MsgType:固定值，表示自定义消息

Data:       1,user0,1

      第一个1表示类型，人员在线离线类型

      第二个表示spid

      第三个表示在线离线状态

Ext    userOnline表示人员在线离线类型

   

 

返回数据

{
	"ErrorInfo": "",
	"ActionStatus": "OK",
	"ErrorCode": 0,
	"MsgKey": "1669867091_19901224_1594773792"
}

 

 

 

旧城古人
关注
接口测试一 接口概念
雪国的花儿’s Blog
10-24 414
接口测试分类： 1. 用户界面UI、图形用户界面GUI，一般是手工操作 2. 消息交互接口 diameter、radius 比如电信鉴权 - socket tcp 基于soap的web server - HTTP REST API - HTTP （Web API 测试） ------------ 应用最多的接口 3. 编程接口，各种语言的开发包 Web UI测试是否需要测试...
接口开发文档说明
赵吉平的专栏
06-21 930
接口开发文档说明 3. 带分页的数据列表格式, 如lists接口, 需要传递p:页码(默认1), page_size:一页多少条(默认后台定义10条) 山东艾思软件科技有限公司，是专业的App定制开发, 网站制作企业；为企业提供从软件开发整合运营的一整套方案。App定制开发包括: 办公ERP, OA, CMS, CRM类定制开发, 聊天类APP开发, 电商商城类, 各种制度......
接口文档示例.docx
08-13
开发文档模版，便于后台技术开发人员与前端开发人员的交流
全网最全的接口文档速成
最新发布
weixin_69912448的博客
07-10 1317
当前项目中，前端代码和后端代码混合在一起，是存在问题的，存在什么问题呢？主要存在以下几点问题：1). 开发人员同时负责前端和后端代码开发，分工不明确2). 开发效率低3). 前后端代码混合在一个工程中，不便于管理4). 对开发人员要求高(既会前端，又会后端)，人员招聘困难为了解决上述提到的问题，现在比较主流的开发方式，就是前后端分离开发，前端人员开发前端的代码，后端开发人员开发服务端的业务功能，分工明确，各司其职。我们本章节，就是需要将之前的项目进行优化改造，变成前后端分离开发的项目。
接口开发文档及注意事项
04-27 545
接口标准化：在设计接口时，需要考虑接口的标准化程度、互操作性和可维护性等方面，以确保接口的正确性和可靠性。接口测试：在测试接口时，需要确保接口的正确性、可靠性和性能等方面都符合要求，以确保接口的稳定性和可用性。接口安全：在设计接口安全性时，需要考虑接口的保密性、完整性和可用性等方面，以确保接口的安全性和可靠性。接口文档：在设计接口时，需要考虑接口的文档化程度、可读性和可维护性等方面，以确保接口的正确性和可靠性。接口实现：在实现接口时，需要考虑接口的安全性、性能、可靠性等因素，以确保接口的正确性和稳定性。
软件开发 接口文档
Heroes
07-19 2291
接口文档没有固定的样式，只要把相关的信息显示出来就可以 例如： 接口名称 接口说明 接口地址 请求参数 返回参数 错误码（一般大批量的接口都使用统一的错误码来返回） 下面是本人使用过的接口文档样式 这是腾讯官方的接口文档 ...
BarTender ActiveX接口开发文档
03-27
全球领先的条码打印软件 BarTender 适用于 BarTender 企业版 7.0以上版本 适用于 Visual Basic 6.0, VB.NET, C#,
网联接口开发文档规范
04-25
《网联接口开发文档规范》是为第三方支付机构进行web服务开发提供的重要指南，它旨在确保支付系统的稳定、安全和高效运行。网联，全称为“网上支付跨行清算系统”，是中国银行业的基础设施，旨在统一处理银行与第三...
泛微OA E9统一待办中心相关配置方法以及接口开发文档
03-01
4. **接口开发文档** - **接口规范**：“统一待办中心集成数据接口说明文档_客户V4.1.docx”详细列出了用于与其他系统交互的API接口，包括请求格式、参数说明、响应数据结构等。 - **开发流程**：接口开发涉及注册...
MTScaleKey托利多最新开发接口及文档
04-19
4. **接口开发文档**（MTScaleKey接口开发文档（对外发布）.doc）：这是开发者的核心参考资料，它详细阐述了MTScaleKey接口的全部功能和用法，包括API函数列表、参数解释、错误代码说明等。开发者应仔细阅读此文档以...
http接口开发文档(国内接口，含接口提交模板).doc
11-21
curl socket 调用接口发送短信的文档， 短信模板说明。
移动开发接口文档规范
11-25
移动互联网开发接口文档的规范，只有规范的接口文档，才能保证服务器和客户端双方的同时开发而又互不影响，也能保证最终的顺利对接
接口文档实例
12-03
移动端接口文档开发实例，webservice接口说明文档，点检仪
接口说明书
08-23
2.1 基本约定 i. 通讯约定：使用WebService方式进行通讯，传输协议：HTTPS，参数不做encode(URL转码)。特殊字符：&$% ii. 参数大小写约定：没有强制要求的地方，统一使用小写。 iii. 编码约定：如GBK或UTF-8等，默认为UTF-8。 iv. 参数约定： XML。 v. 安全约定：1、加密算法暂定为RSA，对报文进行加密，有宇通生成公钥及数字签名文件发给第三方系统，第三方系统使用公钥对报文进行加密和解密，使用数字签名文件对报文进行签名和校验。2、只对敏感数据加密 vi. 消息数量约定：默认一个消息一个订单，单据生成和下发并行，生成多少下发多少。当涉及批量处理时，默认最多处理500个。 vii. 时间约定：时间格式使用 YYYY-MM-DD HH:mm:ss 的格式，精确到秒。
接口开发-集成接口文档（swagger）
weixin_30532987的博客
01-07 570
在正式进入主题之前，先说说实际工作中遇到的问题。不算是传统的原生APP开发，还是眼下的H5混合开发，只要是需要前后端通过接口配合的，往往都存在几个普遍的问题 （1）接口文档谁来写，尤其是跨部门，并且，前后端开发人员忙闲不一致时，很难安排； （2）开发中，接口数据变动了，而接口文档更新不及时，后面项目交接时，那就会一塌糊涂（如果基于看代码的话，那就要看相关人员有没有空了）； （3）用什么写也是...
接口文档开发apiDoc
weixin_46015333的博客
11-22 380
文章目录一、apiDoc是什么？二、使用步骤1.下载apiDoc模块2.在项目根目录创建apidoc.json文件3. 接口注释4. 生成接口文档 一、apiDoc是什么？ 是Nodejs中的一个模块，能够根据代码中的注释快速生成接口文档。 二、使用步骤 1.下载apiDoc模块 全局安装 npm install apidoc -g //或者npm i apidoc -g npm下载是国外的资源，可以换成阿里源，这是全局安装 cnpm install apidoc -g 2.在项目根目录创建apid
一份完整的接口文档
热门推荐
weixin_42575367的博客
11-22 1万+
https://www.jianshu.com/p/c5b1828d0dc6
接口文档编写规范(前后端分离项目接口api)
伟庭的博客
09-23 7446
接口文档编写规范(前后端分离项目接口api)
api接口开发文档模版下载
06-19
### 回答1： API接口开发文档模板通常包括以下内容： 1.概述：介绍API的作用、优势、范围和目标用户。 2.API接口描述：API参数及其含义、请求方式、返回值格式和含义，以及错误码及其含义。 3.调用示例：提供可用的调用示例，有效地引导用户进行接口调用。 4.接口签名：API接口调用参数签名算法的详细规则描述。 5.接口授权：接口调用授权方式说明，包括基于API keys或OAuth2.0的授权方式。 6.安全保障：提供API数据加密、泄露风险和异常处理措施，确保接口安全可靠。 7.版本管理：描述API接口版本管理规则和策略，确保稳定性和兼容性。 8.服务说明：提供接口服务相关的SLA、支付方式和技术支持等信息。 9.常见问题：列出一些常见的调用问题及其解决方案，方便用户快速解决问题。 10.附录：API接口相关资源的链接和参考资料，方便用户获取更多信息。 用户通过下载API接口开发文档模板可以得到以上描述的详细信息，有效帮助他们利用API接口实现程序功能。 ### 回答2： 如果你需要制作一个API接口开发文档，可以通过在互联网上搜索API接口开发文档模板来获取一些灵感。这些模板通常包括以下内容： 1. 概述：API接口的功能和实现。在概述部分，可以解释API接口的用途、目标用户和如何访问。 2. 认证：API接口的安全认证措施。在认证部分应该明确哪些请求需要认证，什么类型的认证可以接受，还有如何获得和使用密钥。 3. 端点：API接口所提供的各个端点。在端点部分中，应详细描述每个端点的URL、HTTP方法、请求参数和响应格式。 4. 错误处理：API接口的错误响应。在错误处理部分中，应该给出API接口可能遇到的错误代码、错误消息和如何处理错误响应。 5. 示例代码：使用API接口的演示代码。在示例代码部分中，应该提供具体的代码示例，以便用户更好地理解和使用API接口。 总之，制作一份API接口开发文档需要认真考虑到用户的需求和技术水平。只有在提供详尽、准确、易于理解的文档的情况下，开发人员才能充分利用API接口来完成项目。 ### 回答3： API接口开发文档模板是为了方便开发人员在开发过程中遵循规范，从而提高开发效率和质量的文件。一般包括以下几个部分： 1. 标题：说明文档的名称以及版本号，方便开发人员快速找到所需的文档。 2. 简介：简要介绍API接口的目的、使用场景、调用方法和注意事项等。 3. 数据结构：列出需要传输的数据格式，包括请求数据和返回数据，具体包括数据类型、字段名、字段类型、长度、是否必填、默认值等。 4. 接口列表：列出所有可用的接口及其用途，提供接口的名称、调用方式、传入参数、返回结果等详细信息。 5. 接口样例：通过一个具体的实例对接口的使用进行说明，方便开发者快速上手。 6. 参数说明：对接口调用时可能遇到的参数进行详细说明，包括参数名、参数类型、是否必填、默认值、长度、数据格式等。 7. 接口异常说明：对接口调用时可能出现的异常进行详细说明，包括异常类型、异常原因、解决方法等。 通过下载API接口开发文档模板，可以帮助开发人员掌握API接口的调用方法，减少出错的概率，提高开发效率和开发质量。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值