logo资料库

社交接口设计文档, 适合小白参考.docx

发布时间：2022-06-16 发布人：admin 分类：说明书 资料大小：0.06M 资料格式：docx 举报 版权申诉
第1页 / 共18页
第2页 / 共18页
第3页 / 共18页
第4页 / 共18页
第5页 / 共18页
第6页 / 共18页
第7页 / 共18页
第8页 / 共18页
资料共18页，剩余部分请下载后查看
    1.获取IM Key
    2.加入交流圈
    3.检索查询交流圈
    4.获取交流圈详细信息
    5.退出交流圈
    6.设置禁言交流圈成员/取消禁言交流圈成员
    7.举报帖子/举报用户/举报评论
    8.话题组详细信息接口
    9.加入话题组
    10.发布帖子
    11.删除帖子
    12.检索查询话题组
    13.查询帖子列表
    14.查询帖子详情
    15.收藏帖子
    16.查询收藏列表
    17.删除收藏帖子
    18.帖子点赞
    19.新增评论
    20.删除帖子评论
    21.新增回复
    22.删除回复
    23.发送消息
    24.查询聊天记录
    25.删除聊天记录
    26.消息回执
    27.删除好友
    28.查询好友列表
    29.修改好友备注
    1. 获取 IM Key 获取 IMKEY 请求方式 请求地址 post app_im/init_data 接口请求参数列表 参数名称 参数类型 参数说明 示例 是否必输 userId userType String String test yf 用户 ID 用户类型(用 户：yf, 医生： ys) Y Y 失败 返回类型 JSON 说明 {"data":0,"msg":0,"msgbox":"请求参数错误"} 异常情况 状态 msg 字段 为 0，查看 msg 返回信息 成功 返回类型 JSON 说明 { "msg":1, "msgbox":"操作成功!", "data":{ "accountType":"1400017059", "userid":"yf_123", "sig":"eJxNjlFvgjAUhf9LX11cKRabvRlTFhdnYDoUX5oKBeoUSCkIMfvvFiK J9*2ec8937h3s1ttpFf8xXpYyBh*AQOyAt0EWbSmVYDzRQhnHwhgjCOHTHQKMa2arPjfKWl5FfzybE 0yIoT11GYtcy0QOqC5hFrJHUBQVda6Z7krxAqpkarZvGi5X-lJ7FNoXavvQTR0voHtc-yL6rkiwPbm ZrrN28jPDmwlK0lW2WKfFufX44Rptvg7HunHn2aK97c7hpfvUyK8aHu5jGSCHjGWNUJUsclOIoIXNb 7Af8P8AL3lWMg__", "sdkappid":"8056" } } 正常情况 状态 msg 字段 为 1，查看 msg 返回信息
    2. 加入交流圈 加入交流圈 请求方式 请求地址 post app_im/add_group 接口请求参数列表 参数名称 参数类型 参数说明 示例 是否必输 groupId userId 失败 String String 交流圈号 21493777491491 用户帐号(IM) test Y Y 返回类型 JSON 说明 { "msg":1, "msgbox":"加入交流圈失败", "data":[] } 异常情况 状态 msg 字段 为 0，查看 msg 返回信息 成功 返回类型 JSON { "msg":1, "msgbox":"加入交流圈成功", "data":[] } 说明 成功情况 状态 msg 字段 为 1，查看 msg 返回信息 返回参数说明 字段说明 msg 字段说明 请求状态 1：成功，0：失败 msgbox data 请求提示 返回数据 3. 检索查询交流圈 检索查询交流圈 请求方式 请求地址 post app_im/search_group 接口请求参数列表 参数名称 参数类型 参数说明 示例 是否必输
    groupName String 交流圈名称 Test Y 失败 返回类型 JSON "msg":1, "msgbox":"检索失败", "data":[] 说明 { } 异常情况 状态 msg 字段 为 0，查看 msg 返回信息 成功 返回类型 JSON { "msg":1, "msgbox":"检索查询交流圈信息", "data":[ { "id":48, "groupId":"21493777491491", "groupName":"交流圈 Test", "groupBriefIntr":"交流圈 Test001", "groupImgUrl":"http://192.168.2.67:8888/group1/M00/03/ DE/wKgCQ1gTKueAecVaAAAKKF1Kw0M.147765", "peopleNumber":2, "overhead":null, "dataStatus":1, "createUserId":"test", "createUserTime":1477650785300, "allowAdd":0 } ] } 说明 成功情况 状态 msg 字段 为 1，查看 msg 返回信息 返回参数说明 字段说明 groupId 字段说明 交流圈 ID groupName groupBriefIntr groupImgUrl peopleNumber overhead dataStatus 交流圈名称 交流圈简介 交流圈二维码 URL 交流圈人数 是否顶置（1：设置顶置，2：取消顶置） 数据状态 0：正常 1：禁用
    createUserId createUserTime allowAdd 创建人 ID 创建时间 设为非公开圈子，勾选则 APP 端不能搜到，只能扫码加 入。1：是 0：否 4. 获取交流圈详细信息 获取交流圈详细信息 请求方式 请求地址 Post /app_im/sel_group 接口请求参数列表 参数名称 参数类型 参数说明 示例 是否必输 groupId 失败 返回类型 说明 { String 交流圈号 Y JSON "msg":1, "msgbox":"请选择交流圈！", "data":{} } 异常情况 状态 msg 字段 为 0，查看 msg 返回信息 成功 返回类型 说明 { JSON "msg":1, "msgbox":"查询交流圈信息成功！", "data":{ "id":42, "groupId":"09389795021683", "groupName":"1123123", "groupBriefIntr":"123123123", "groupImgUrl":"http://192.168.2.67:8888/group1/M00/03/DE/wKgCQ 1gTJWqAbT-fAAAKJ1jWDC4.147764", "peopleNumber":0, "overhead":null, "dataStatus":1, "createUserId":"", "createUserTime":1477649389677,
    "allowAdd":1 } } 异常情况 状态 msg 字段 为 1，查看 msg 返回信息 返回参数说明 字段名 字段说明 id groupId groupName groupBriefIntr groupImgUrl peopleNumber overhead dataStatus createUserId createUserTime 5. 退出交流圈 退出交流圈 请求方式 请求地址 数据 ID 交流圈 ID 交流圈名称 交流圈简介 交流圈二维码 URL 交流圈人数 是否顶置（1：设置顶置，2：取消顶置） 数据状态 0：正常 1：禁用 创建人 ID 创建时间 Post /app_im/exit_group 接口请求参数列表 参数名称 参数类型 参数说明 示例 是否必输 groupId userId 失败 String String 交流圈号 用户 IM 帐号 Y Y 返回类型 JSON 说明 { "msg":1, "msgbox":"退出交流圈失败", "data":[] } 异常情况 状态 msg 字段 为 0，查看 msg 返回信息 成功 返回类型 JSON 说明 { "msg":1, "msgbox":"退出交流圈成功", "data":[]
    } 异常情况 状态 msg 字段 为 1，查看 msg 返回信息 6. 设置禁言交流圈成员/取消禁言交流圈成员 禁言/取消禁言交流圈成员 请求方式 请求地址 Post /app_im/gag 接口请求参数列表 参数名称 参数类型 参数说明 示例 是否必输 groupId userId 失败 String String 交流圈号 用户 IM 帐号 Y Y 返回类型 JSON 说明 { "msg":1, "msgbox":"操作失败!", "data":[] } 异常情况 状态 msg 字段 为 0，查看 msg 返回信息 成功 返回类型 JSON 说明 { "msg":1, "msgbox":"操作成功!", "data":[] } 异常情况 状态 msg 字段 为 1，查看 msg 返回信息 7. 举报帖子/举报用户/举报评论 举报帖子/举报用户/举报评论 请求方式 请求地址 POST app_im/insert_report 接口请求参数列表 参数名称 参数类型 参数说明 示例 是否必输 busId 举报的帖子 ID/ 评论 ID/用户 ID
    reportContent 举报原因 业 务 类 型 (1: 帖 子 2 ： 评 论 3：用户) 业 务 类 型 (1: 帖 子 2 ： 评 论 3：用户) reportUserId dataType 失败 返回类型 JSON 说明 { "msg":1, "msgbox":"添加举报数据失败!", "data":[ } ] 成功 返回类型 JSON 说明 { "msg":1, "msgbox":"添加举报数据成功!", "data":[ ] } 成功情况 状态 msg 字段 为 1，查看 msg 返回信息 8. 话题组详细信息接口 话题组详细信息接口 请求方式 请求地址 post /topic/queryTopic.do 参数名称 参数类型 topicId Int 失败 返回类型 JSON 接口请求参数列表 参数说明 话题组编号 示例 是否必输
    说明 {"data":0,"msg":0,"msgbox":"请求参数错误"} 成功 返回类型 JSON 说明 {"data":1,"msg":1,"msgbox":"请求成功"} 说明：成功情况 状态 msg 字段 为 1，查看 msg 返回信息 9. 加入话题组 加入话题组 请求方式 请求地址 post /topic/addTopic.do 接口请求参数列表 参数名称 参数类型 参数说明 示例 是否必输 userId topicId 失败 Int String 用户 ID 话题组 ID 返回类型 JSON 说明 {"data":0,"msg":0,"msgbox":"请求参数错误"} 成功 返回类型 JSON 说明 {"data":1,"msg":1,"msgbox":"请求成功"} 说明：成功情况 状态 msg 字段 为 1，查看 msg 返回信息 10. 发布帖子 发布帖子 请求方式 请求地址 post /debatepost/publishArticles.do 接口请求参数列表 参数名称 参数类型 参数说明 示例 是否必输 topicId Int debatepostTitle String debatepostContent String 话题组编号 帖子主题 帖子内容
    分享到：
    赞 收藏

    相关推荐

    资料库

    行业

    共收录7266份资料，累计15个分类，关注成员有19位，主要包括：物流,旅游,餐饮零售,网络游戏,咨询,金融,电子政务,外包,教育,制造,医疗,嵌入式,互联网,交通,电信

    热门标签

    物流 旅游 餐饮零售 网络游戏 咨询 金融 电子政务 外包 教育 制造 医疗 嵌入式 互联网 交通 电信

    最新资料