linkdood-web-sdk 1.0.5 → 1.0.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (125) hide show
  1. package/docs/thrift/ap.thrift +600 -882
  2. package/docs/thrift/aphead.thrift +283 -1550
  3. package/docs/thrift/apnotify.thrift +75 -83
  4. package/lib/cache/BuddyCache.js +26 -0
  5. package/lib/cache/ChatCache.js +42 -0
  6. package/lib/cache/EnterpriseCache.js +22 -0
  7. package/lib/cache/GroupCache.js +31 -0
  8. package/lib/cache/GroupMemberCache.js +40 -0
  9. package/lib/cache/GroupMessageCache.js +33 -0
  10. package/lib/cache/HelpCache.js +3 -0
  11. package/lib/cache/MessageCache.js +44 -0
  12. package/lib/cache/MessageTimeStampCache.js +13 -0
  13. package/lib/cache/MyselfCache.js +14 -0
  14. package/lib/cache/SystemDictionaryCache.js +41 -0
  15. package/lib/cache/SystemMessageCache.js +19 -0
  16. package/lib/cache/TimeStampCache.js +3 -0
  17. package/lib/cache/db/IMDB.js +21 -0
  18. package/lib/cache/db/bean/Buddy.js +32 -0
  19. package/lib/cache/db/bean/Chat.js +20 -0
  20. package/lib/cache/db/bean/GroupMessage.js +5 -0
  21. package/lib/cache/db/bean/Message.js +30 -0
  22. package/lib/cache/db/bean/SystemDictionarie.js +9 -0
  23. package/lib/cache/db/bean/SystemMessage.js +13 -0
  24. package/lib/cache/db/bean/Timestamp.js +29 -0
  25. package/lib/config/thriftConfig.js +6 -0
  26. package/lib/constant/dictionaryConstant.js +10 -0
  27. package/lib/constant/storageConstant.js +16 -0
  28. package/lib/core/LinkdoodWebSDK.js +9 -0
  29. package/lib/core/action/ApplicationAction.js +19 -0
  30. package/lib/core/action/AuthAction.js +41 -0
  31. package/lib/core/action/BuddyAction.js +51 -0
  32. package/lib/core/action/ChatAction.js +33 -0
  33. package/lib/core/action/ConfigAction.js +16 -0
  34. package/lib/core/action/EnterpriseAction.js +9 -0
  35. package/lib/core/action/FeedBackAction.js +12 -0
  36. package/lib/core/action/FileAction.js +11 -0
  37. package/lib/core/action/GroupAction.js +121 -0
  38. package/lib/core/action/HelpAction.js +6 -0
  39. package/lib/core/action/MessageAction.js +38 -0
  40. package/lib/core/action/OrgAction.js +11 -0
  41. package/lib/core/action/SearchAction.js +11 -0
  42. package/lib/core/action/SubscribeAction.js +10 -0
  43. package/lib/core/action/SystemAction.js +11 -0
  44. package/lib/core/action/SystemMessageAction.js +10 -0
  45. package/lib/core/action/UserAction.js +43 -0
  46. package/lib/core/action/index.js +1 -0
  47. package/lib/decorator/ErrorORCompletionDecorator.js +5 -0
  48. package/lib/error/JSDKError.js +5 -0
  49. package/lib/index.js +1 -0
  50. package/lib/model/loginModel.js +5 -0
  51. package/lib/model/thriftConnectionModel.js +5 -0
  52. package/lib/model/userModel.js +5 -0
  53. package/lib/notify/NotifyAnalysis.js +5 -0
  54. package/lib/notify/NotifyHeartBeat.js +13 -0
  55. package/lib/notify/emitter/notifyEmitter.js +99 -0
  56. package/lib/notify/send/NotifyFactory.js +5 -0
  57. package/lib/notify/send/children/noticeReply.js +7 -0
  58. package/lib/notify/send/children/notifyCreateFaceGroupSuccess.js +5 -0
  59. package/lib/notify/send/children/notifyError.js +6 -0
  60. package/lib/notify/send/children/notifyExitFaceAddBuddy.js +5 -0
  61. package/lib/notify/send/children/notifyExitFaceJoinGroup.js +5 -0
  62. package/lib/notify/send/children/notifyFaceAddBuddy.js +5 -0
  63. package/lib/notify/send/children/notifyFaceAddBuddyConfirm.js +5 -0
  64. package/lib/notify/send/children/notifyFaceJoinGroup.js +5 -0
  65. package/lib/notify/send/children/notifyGroupMemberInfoRefresh.js +5 -0
  66. package/lib/notify/send/children/notifyGroupMembersRefresh.js +14 -0
  67. package/lib/notify/send/children/notifyGroupRefresh.js +5 -0
  68. package/lib/notify/send/children/notifyMessageCursor.js +5 -0
  69. package/lib/notify/send/children/notifyMessageJson.js +5 -0
  70. package/lib/notify/send/children/notifyMessageStatusStatsInfo.js +5 -0
  71. package/lib/notify/send/children/notifyOperateBuddy.js +5 -0
  72. package/lib/notify/send/children/notifyOperateUser.js +5 -0
  73. package/lib/notify/send/children/notifyPresent.js +5 -0
  74. package/lib/notify/send/children/notifySendMessage.js +27 -0
  75. package/lib/notify/send/children/notifyTransferGroup.js +7 -0
  76. package/lib/notify/send/children/notifyTransferMessage.js +5 -0
  77. package/lib/offline/OfflineBuddy.js +5 -0
  78. package/lib/offline/OfflineEnterprise.js +5 -0
  79. package/lib/offline/OfflineGroup.js +16 -0
  80. package/lib/offline/OfflineHelp.js +5 -0
  81. package/lib/offline/OfflineMessage.js +8 -0
  82. package/lib/offline/OfflineMyself.js +5 -0
  83. package/lib/service/ApplicationService.js +14 -0
  84. package/lib/service/BuddyService.js +64 -0
  85. package/lib/service/ChatService.js +98 -0
  86. package/lib/service/CommonService.js +17 -0
  87. package/lib/service/EnterpriseService.js +32 -0
  88. package/lib/service/GroupMemberService.js +82 -0
  89. package/lib/service/GroupMessageService.js +21 -0
  90. package/lib/service/GroupService.js +58 -0
  91. package/lib/service/HelpService.js +11 -0
  92. package/lib/service/LoginService.js +16 -0
  93. package/lib/service/MessageService.js +92 -0
  94. package/lib/service/MessageTimeStampService.js +14 -0
  95. package/lib/service/MyselfService.js +19 -0
  96. package/lib/service/SubscribeService.js +15 -0
  97. package/lib/service/SystemDictionaryService.js +27 -0
  98. package/lib/service/SystemMessageService.js +4 -0
  99. package/lib/service/TimeStampService.js +9 -0
  100. package/lib/thrift/client/ThriftBase.js +1 -0
  101. package/lib/thrift/client/ThriftHoldClient.js +1 -0
  102. package/lib/thrift/client/ThriftNotifyClient.js +1 -0
  103. package/lib/thrift/client/ThriftServiceClient.js +1 -0
  104. package/lib/thrift/lib/ap/APHold.js +7 -0
  105. package/lib/thrift/lib/ap/APNotify.js +7 -0
  106. package/lib/thrift/lib/ap/APService.js +7 -0
  107. package/lib/thrift/lib/ap/ap_types.js +6 -0
  108. package/lib/thrift/lib/ap/aphead_types.js +6 -0
  109. package/lib/thrift/lib/ap/aphold_types.js +6 -0
  110. package/lib/thrift/lib/ap/apnotify_types.js +6 -0
  111. package/lib/thrift/lib/thrift.js +397 -0
  112. package/lib/thrift/merge/thrift-merge.js +77852 -0
  113. package/lib/thrift/thriftClient.js +16 -0
  114. package/lib/utils/Logger.js +1 -0
  115. package/lib/utils/_decorators.js +11 -0
  116. package/lib/utils/browserUtil.js +7 -0
  117. package/lib/utils/commonUtil.js +40 -0
  118. package/lib/utils/filesUtil.js +50 -0
  119. package/lib/utils/groupJudgeUtil.js +58 -0
  120. package/lib/utils/md5Util.js +1 -0
  121. package/lib/utils/navi.js +11 -0
  122. package/lib/utils/proptypeExtend.js +13 -0
  123. package/lib/utils/request.js +8 -0
  124. package/package.json +3 -3
  125. package/dist/linkdoodWebSDK.js +0 -13
@@ -17,7 +17,7 @@ struct VerifyInfo {
17
17
  一旦票不正确,应该改为密码登陆
18
18
  */
19
19
  struct LoginParam {
20
- 1: byte userType // 帐号类型 1:手机号 2:第三方关联,3:邮箱 4:用户ID,6:豆豆号,7:使用自定义拓展字段来进行登陆 -1:传用户ID但票验证 100:湖北公安第三方认证
20
+ 1: byte userType // 帐号类型 1:手机号 2:第三方关联,3:邮箱 4:用户ID,6:豆豆号,7:使用自定义拓展字段来进行登陆, 8:emm的sso登录,95:验证码注册加登录,96:验证码登录, 97:更换设备时短信验证登录 99:SAML认证用户 -1:传用户ID但票验证
21
21
  2: string user
22
22
  3: string pwd
23
23
  4: string macAddr // 必填不能为空
@@ -25,6 +25,7 @@ struct LoginParam {
25
25
 
26
26
  16: optional byte tick // 踢人策略 1: 强制踢(登录) 2: 不踢人(重连)
27
27
  17: optional string deviceInfo
28
+ //TODO可能已经不用
28
29
  18: optional byte status /*TODO(H.) 该字段将会替换 PluginParam, reportPluginStatus 将会被缺消 */
29
30
 
30
31
  20: optional byte status_flag // -1:离线,1:在线;2:隐身,3:忙碌,4:离开,5:请勿打扰,6:想聊天, 默认在线
@@ -33,12 +34,12 @@ struct LoginParam {
33
34
  23: optional i64 sdkid // SDKID 默认为0,注意:开放平台应用请忽略该字段
34
35
  24: optional string markSign // 注意:对于连豆豆的正常应用忽略该字段,如果是开放平台应用则填入标识
35
36
  25: optional string redirectUri //auth回调地址
36
- 26: optional i64 inviteCodeID
37
- 28: optional string sdkVersion //客户端sdk版本号
37
+ 26: optional i64 inviteCodeID //邀请注册时请携带GetVerifyCodeResult中的inviteCodeID
38
+ 27: optional string thirdAuthParamJson //第三方认证透传参数
38
39
  200: optional string ip // 客户端不要使用该字段
39
- 201: optional string versionEx //版本号兼容
40
40
  }
41
41
 
42
+ //TODO可能要删除
42
43
  struct PluginParam {
43
44
  1: byte deviceType;
44
45
  2: byte status; // 1 充电 2 非充电
@@ -80,7 +81,8 @@ struct Timestamp {
80
81
  21: optional i64 whiteListTS; /* 人员白名单如果有变化, 这里会有值 */
81
82
  23: optional i64 dataDictID; /* 数据字典时间戳 */
82
83
  24: optional i64 entBroadcastID; /* 企业号时间戳 */
83
-
84
+ 25: optional i64 permissionID; /*权限策略时间戳,设置级别关系时会更新时间戳*/
85
+
84
86
  50: i64 pushMessageID; /* 推送消息(投票及公告) */
85
87
  51: optional string serverTS /* 服务端字典时间戳,json形式提供,包含的内容会后续说明16-4-15 */
86
88
 
@@ -88,15 +90,12 @@ struct Timestamp {
88
90
  122: optional list<i64> webEmotionID; /* 表情时间戳,分页 */
89
91
  202: i32 code;
90
92
  203: optional string what;
91
-
93
+ //TODO需要删除
92
94
  204: optional map<i64, EnterpriseTimestamp> enterprisesTs; /* key 企业id */ /// 将来会被删除, 用205 enTs替换
93
95
  205: optional EnterpriseTimestamp enTs; //其中 企业组织时间戳 须通过getEntOrgsTimestamp单独获取
96
+
97
+
94
98
  206: optional i64 badWordsTs // 服务器存储的敏感词的时间戳(游标)
95
- 207: optional i64 secWordsTs // 服务器存储的涉密关键字的时间戳
96
- 254: optional i64 clientMenus // 客户端动态菜单的时间戳
97
- 255: optional i64 appConfigTs //公共号设置的时间戳29
98
- 256: optional i64 emoticonTs // 表情包时间戳
99
- 257: optional i64 emoticonServerTs // 服务器表情包时间戳
100
99
  }
101
100
 
102
101
  struct VerifyParam {
@@ -106,8 +105,8 @@ struct VerifyParam {
106
105
  }
107
106
 
108
107
  struct LoginResult {
109
- 1:i32 code //100001575表示更换设备登录
110
- 2: optional string what // 可能保存了image信息
108
+ 1:i32 code // 换设备错误码:100001575;第三方认证失败错误码:100001576
109
+ 2: optional string what // 可能保存了image信息;第三方认证失败时保存了json透传信息
111
110
 
112
111
  3: optional i32 sessionTimeout // session失效时间(秒),请在这段时间内关闭连接重新发送空请求
113
112
 
@@ -116,35 +115,12 @@ struct LoginResult {
116
115
  6: optional i64 serverTime // 服务器当前时间
117
116
 
118
117
  7: optional string privateKey
119
- 8: optional string ticket // 对于pc端跳转网页可以直接使用此票
118
+ 8: optional string ticket // 对于pc端跳转网页可以直接使用此票,当返回错误码为100001575时,即更换设备登录的时候,该字段用于保存用户注册手机号
120
119
  9: optional string area // 返回区域码
121
120
  //10: optional string captcha //验证码,当需要验证码登录时会填充该字段
122
121
  11: optional i64 remainLockTime; //剩余锁定时长 ,毫秒
123
122
  12: optional i64 inviteUserID
124
123
  13: optional i64 registerTime //用户注册时间
125
- 14: optional string exinfo; //拓展字典:{
126
- // "customerService":["key1","key2"], //我的客服 key1为parentId=20001的拓展字典的key
127
- // "crtInfo": {
128
- // "url":"vrv.linkdood.cn",//证书续费地址,只有绑定管理员的账户才会返回该字段
129
- // "serverTime":1213454435000, //服务期当前时间(时间戳,毫秒)
130
- // "crtBTime":1213454435000, //证书有效期开始时间(时间戳,毫秒)
131
- // "crtETime":1213454435000, //证书有效期到期时间(时间戳,毫秒)
132
- // }
133
- // "MHInfo":{
134
- // "adminUrl":"/mbox" //魔盒管理中心
135
- // }
136
- // }
137
- //
138
- // "verifiedInfo":{
139
- // "region":"CN", // COM海外 , 其他中国
140
- // "personSize":10 // int 国内用户数/10
141
- // },
142
- //
143
- // "commInfo":{
144
- // "authority":1 // int,权限相关字段(按位与,按位或); 1 管理员; 2 待定; 4 待定
145
- // }
146
- // }
147
- 15: optional byte value_byte;//即buddySwitch,用户注册后是否加好友;0:加好友,1:不加好友
148
124
  }
149
125
 
150
126
  struct SessionTicket {
@@ -328,9 +304,6 @@ struct OperateBuddyBean {
328
304
  8: optional string backgroundURL // 聊天背景地址
329
305
  /*key设置类型 1:个人设置,value设置值 1为接收提醒 2表示不提醒仅显示数字 3:为免打扰*/
330
306
  9:optional map<i32,i32> buddySetting
331
- /*邀请码ID*/
332
- 10:optional string inviteCode
333
-
334
307
  }
335
308
 
336
309
  struct AllMessageCursorResult {
@@ -539,46 +512,53 @@ struct EnURet {
539
512
  3: optional list<aphead.EnterpriseUserBean> us
540
513
  }
541
514
 
515
+
542
516
  struct OnlineBean {
543
517
  1: i64 userID // 用户ID
544
518
  2: i64 connectID // 连接ID
545
519
 
546
520
  3: byte deviceType // 1:PC;2:手机;3:pad;4:网页
547
- 4: byte flag // -1:离线,1:在线;2:隐身,3:忙碌,4:离开,5:请勿打扰, 6:想聊天
548
- 5: optional i64 operateDate; //操作时间
549
- 6: byte onlineStatus //在线状态 1:在线;2:会议中,3:忙碌,4:飞机上,5:请勿打扰,6:自定义
550
- 7: optional string explain //状态说明
551
- 8: string deviceInfo;
552
- 9: i64 loginTime;
521
+ 4: byte flag //-1:离线,1:在线;2:隐身,3:忙碌,4:离开,5:请勿打扰,6:想聊天,7:强制下线,8:暂时离线,9:未激活
522
+ /*操作时间*/
523
+ 5: optional i64 operateDate;
553
524
  }
554
525
 
555
526
  /////////////////////////////////////////////////
556
527
  /*
557
528
  1. type 类型
558
529
  0, 设置token和appleID (默认值,客户端可以不用设置该值);
559
- 需要参数appleID,token,value_str_1;返回code
530
+ 需要参数appleID,token;返回code
560
531
  1. 设置云后台在线状态 . 需要字段vb1设置云后台在线(true 在线, false 不在线),vb2设置应用在线(true在线), 返回code
561
- 3.设置token
562
- 传入参数:
563
- mapParams
564
- key:"appleID", value:"Google" 不能为空,必填,小米可填写"Google"
565
- key: "token", value:token值
566
- "connectID" ,connectID
567
- "deviceType2" , deviceType2 0苹果 2 google
568
- 返回:
569
- code 0 成功
570
- 7.根据传入的用户列表,查询用户的状态,包括在线(隐身算离线),离线和未激活
571
- 请求参数: listI64 用户userID列表
572
- 返回参数: onlineBeans 用户在线状态信息
532
+ 2. 设置当前人的会话对象ID(中电科)
533
+ 需要参数value64:聊天对象,用户ID 或 群ID
534
+ 3.设置token
535
+ 传入参数:
536
+ mapParams
537
+ key:"appleID", value:"XiaoMi" 不能为空,必填,小米可填写"XiaoMi"
538
+ key: "token", value:token值
539
+ "connectID" ,connectID
540
+ "deviceType2" , deviceType2 0苹果 1 华为 2 google 3 中电科EMM 4 小米
541
+ 返回:
542
+ code :0 成功
543
+ 4. 新增或修改onlineExt
544
+ 请求参数: value_str_1
545
+ 返回参数: result
546
+ 5. 删除onlineExt
547
+ 请求参数: value_str_1
548
+ 返回参数: result
549
+ 6.查询onlineExt
550
+ 请求参数: value_str_1
551
+ 返回参数: params
552
+ 7.根据传入的用户列表,查询用户的状态,包括在线(隐身算离线),离线和未激活
553
+ 请求参数: listI64 用户userID列表
554
+ 返回参数: onlineBeans 用户在线状态信息
573
555
  8.根据群ID查询在线和离线的群成员数量
574
- 请求参数: value64 群ID
575
- 返回参数: mapStrI64 keyonlineNum 在线成员数 key:offlineNum 离线成员数
576
- 9.单聊时,获取对方状态并保存会话记录到缓存,此人状态变化时会推送(包括陌生人)
577
- 请求参数: value64 目标userID
578
- 返回参数: olBean 目标在线状态
579
- 10.根据传入的用户列表,获取同一账号不同设备类型的在线信息,包括在线(隐身算离线),离线和未激活
580
- 请求参数: listI64 用户userID列表
581
- 返回参数: onlines 同一账号所有类型登录设备的在线信息
556
+ 请求参数: value64 群ID
557
+ 返回参数: mapStrI64 key:onlineNum 在线成员数 key:offlineNum 离线成员数
558
+ 9.单聊时,获取对方状态并保存会话记录到缓存,此人状态变化时会推送(包括陌生人)
559
+ 请求参数: value64 目标userID
560
+ 返回参数: olBean 目标在线状态
561
+
582
562
  */
583
563
  struct OnlineParam {
584
564
  1: optional byte type
@@ -586,20 +566,20 @@ struct OnlineParam {
586
566
  3: optional string token // ios tokena
587
567
  4: optional bool vb1;
588
568
  5: optional bool vb2;
589
- 6: optional i64 value64;
590
- 7: optional map<string,string> mapParams;
591
- /* 此处兼容主线版,从8开始,方便中间添加,表示voip推送token */
592
- 8: optional string value_str_1;
569
+ 6: optional i64 value64
570
+ 7: optional map<string,string> mapParams
571
+ 8: optional string value_str_1
593
572
  9: optional list<i64> listI64
594
573
  }
595
574
 
596
575
  struct OnlineRet {
597
576
  1: i32 code
598
577
  2: optional string what
578
+ 3: optional aphead.Result result
579
+ 4: optional map<string,string> params
599
580
  5: optional list<OnlineBean> onlineBeans
600
581
  6: optional OnlineBean olBean
601
582
  7: optional map<string,i64> mapStrI64
602
- 8: optional map<i64,list<OnlineBean>> onlines
603
583
  }
604
584
 
605
585
  //////////////////////////
@@ -702,8 +682,6 @@ struct GetBuddyOnlineResult {
702
682
 
703
683
  struct OnlineState {
704
684
  1: byte flag; // 1:在线,2:隐身,3:忙碌,4:离开,5:请勿打扰
705
- 2: optional byte onlineStatus; //1:在线;2:会议中,3:忙碌,4:飞机上,5:请勿打扰,6:自定义
706
- 3: optional string explain; /*状态说明*/
707
685
  }
708
686
 
709
687
  struct IosNoticeInfo {
@@ -915,7 +893,7 @@ struct GetPersonDefinitionResult {
915
893
 
916
894
  struct SettingList {
917
895
  1: byte addType // 1 黑名单 2 白名单
918
- 2: optional i64 id // 当addType==2的时候设置, 表示企业ID
896
+ 2: optional i64 id // 当addType==2的时候设置, 表示企业ID,addType传1时设置该值,targetID传自己,可以查询自己是否在对方黑名单中
919
897
  }
920
898
 
921
899
  struct QueryEnUserListResult {
@@ -1014,118 +992,15 @@ struct RegURet {
1014
992
  }
1015
993
  */
1016
994
  /////////////////////////////////////////////////
1017
- /*
1018
- type 类型
1019
- 1, 批量查询多个用的设置项
1020
-
1021
- *
1022
- * 返回结果请参数NewPersonalDataSwitch
1023
-
1024
- 参数:userIdList 用户id列表
1025
- value32 用户可见项(详情见内容)
1026
- 使用时非特殊情况请勿将value32 设置为0,
1027
- * 最新查询个人设置项调用方法,value32 = 0 表示查询个人所有设置项
1028
- * 目前value32为1的时候, 表示设置是否显示在线信息 ,value=1表示显示,value=2表示不显示,默认1显示
1029
- * 目前value32为2的时候, 表示设置表示生日可见性 ,value:1:所有人可见 2:仅好友可见 3:仅自己可见,默认1
1030
- * 目前value32为3的时候, 表示设置豆豆号查找 ,value=1表示可以通过此号查找我,value=2表示不允许,默认1可以查找
1031
- * 目前value32为4的时候, 表示设置手机号查找 ,value=1表示可以通过此号查找我,value=2表示不允许,默认1可以查找
1032
- * 目前value32为5的时候, 表示设置邮箱号查找 ,value=1表示可以通过此号查找我,value=2表示不允许,默认1可以查找
1033
- * 目前value32为6的时候, 表示设置分享更新 ,value=1表示提示更新,value=2不提示更新,默认1表示提示更新
1034
- * 目前value32为7的时候, 表示设置新消息通知是否提醒 ,value=1表示提醒,value=2不提醒,默认1提醒
1035
- * 目前value32为8的时候, 表示设置全局勿扰模式 ,value=1表示关闭 value=2表示打开,默认1,时间段在扩展字段内存储,json格式
1036
- * 目前value32为9的时候, 表示设置推送通知提示音 ,value表示定义的声音名,默认default
1037
- * 目前value32为10的时候,表示设置用户的扩展信息 ,value表示用户扩展json字段
1038
- * 目前value32为11的时候,表示设置电话可见性 ,value: 1:所有人可见 2:仅好友可见 3:仅自己可见,默认1
1039
- * 目前value32为12的时候,表示设置多服务新消息通知是否提醒 ,value=1表示始终提醒,value=2不始终提醒,默认2不始终提醒
1040
- * 目前value32为13的时候,表示设置多服务V标好友始终提醒 ,value=1表示始终提醒,value=2不始终提醒,默认1始终提醒
1041
- * 目前value32为14的时候,表示设置多服务@相关人始终提醒 ,value=1表示始终提醒,value=2不始终提醒,默认1始终提醒
1042
- * 目前value32为15的时候,表示设置邮箱可见性设置 ,value: 1:所有人可见 2:仅好友可见 3:仅自己可见,默认1
1043
- * 目前value32为16的时候,表示设置好友验证方式 ,value: 1:需要验证信息,2:不允许任何人添加,3:允许任何人添加,默认1
1044
- * 目前value32为17的时候,表示设置V标(好友,群)提醒模式 ,value: 1:表示始终有声音提醒,2:表示始终无声音提醒 3:不始终提醒,默认1
1045
- * 目前value32为18的时候,表示设置@相关人提醒模式 ,value: 1:表示始终有声音提醒,2:表示始终无声音提醒 3:不始终提醒,默认1
1046
- * 目前value32为19的时候,表示设置全局通知消息内容模式 ,value: 1:通知详情,2:通知源,隐藏内容 3:完全隐藏,默认2
1047
- * 目前value32为21的时候,个人设置里的群验证方式
1048
- 返回:code 透传错误码
1049
- userDataSwitchMap: map<i64,list<aphead.NewPersonalDataSwitch>> 对应用户的配置详情
1050
-
1051
- 2, 设置个人信息(new) 提供对个人的所有设置,包含(个人开关设置,全局勿扰设置,自定义声音,自定义用户扩展信息以及setting)等
1052
- * 目前switchType为1的时候, 表示设置是否显示在线信息 ,value=1表示显示,value=2表示不显示,默认1显示
1053
- * 目前switchType为2的时候, 表示设置表示生日可见性 ,value:1:所有人可见 2:仅好友可见 3:仅自己可见,默认1
1054
- * 目前switchType为3的时候, 表示设置豆豆号查找 ,value=1表示可以通过此号查找我,value=2表示不允许,默认1可以查找
1055
- * 目前switchType为4的时候, 表示设置手机号查找 ,value=1表示可以通过此号查找我,value=2表示不允许,默认1可以查找
1056
- * 目前switchType为5的时候, 表示设置邮箱号查找 ,value=1表示可以通过此号查找我,value=2表示不允许,默认1可以查找
1057
- * 目前switchType为6的时候, 表示设置分享更新 ,value=1表示提示更新,value=2不提示更新,默认1表示提示更新
1058
- * 目前switchType为7的时候, 表示设置新消息通知是否提醒 ,value=1表示提醒,value=2不提醒,默认1提醒
1059
- * 目前switchType为8的时候, 表示设置全局勿扰模式 ,value=1表示关闭 value=2表示打开,默认1,时间段在扩展字段内存储,json格式
1060
- * 目前switchType为9的时候, 表示设置推送通知提示音 ,value表示定义的声音名,默认default
1061
- * 目前switchType为10的时候,表示设置用户的扩展信息 ,value表示用户扩展json字段
1062
- * 目前switchType为11的时候,表示设置电话可见性 ,value: 1:所有人可见 2:仅好友可见 3:仅自己可见,默认1
1063
- * 目前switchType为12的时候,表示设置多服务新消息通知是否提醒 ,value=1表示始终提醒,value=2不始终提醒,默认2不始终提醒
1064
- * 目前switchType为13的时候,表示设置多服务V标好友始终提醒 ,value=1表示始终提醒,value=2不始终提醒,默认1始终提醒
1065
- * 目前switchType为14的时候,表示设置多服务@相关人始终提醒 ,value=1表示始终提醒,value=2不始终提醒,默认1始终提醒
1066
- * 目前switchType为15的时候,表示设置邮箱可见性设置 ,value: 1:所有人可见 2:仅好友可见 3:仅自己可见,默认1
1067
- * 目前switchType为16的时候,表示设置好友验证方式 ,value: 1:需要验证信息,2:不允许任何人添加,3:允许任何人添加,默认1
1068
- * 目前switchType为17的时候,表示设置V标(好友,群)提醒模式 ,value: 1:表示始终有声音提醒,2:表示始终无声音提醒 3:不始终提醒,默认1
1069
- * 目前switchType为18的时候,表示设置@相关人提醒模式 ,value: 1:表示始终有声音提醒,2:表示始终无声音提醒 3:不始终提醒,默认1
1070
- * 目前switchType为19的时候,表示设置全局通知消息内容模式 ,value: 1:通知详情,2:通知源,隐藏内容 3:完全隐藏,默认2
1071
- * 目前switchType为25的时候,表示设置服务器别名
1072
- setNewPersonDataSwitch(1:aphead.NewPersonalDataSwitch personalDataSwitch);
1073
-
1074
-
1075
- 参数:value32 用户可见项(switchType), 类型详情内容为上述所列
1076
- value_str 服务器别名 , switchType = 25
1077
-
1078
- 返回: code 错误码
1079
- 100005000 成功
1080
- 100005001 参数不全
1081
- 100 参数错误,未知type
1082
- 11100 服务器内部错误
1083
- what 结果信息
1084
- */
1085
-
1086
- /*
1087
- 3, 获取用户搜索可配置开关 (getClientSearchSetting)
1088
- 参数: 无
1089
-
1090
- 返回: code 错误码
1091
- 0 成功
1092
- 100 参数错误,未知type
1093
- 11100 服务器内部错误
1094
- xxxxx 获取数据开关项失败
1095
-
1096
- what 结果信息
1097
-
1098
- 4, 修改用户搜索可配置开关
1099
- 参数: value_str ===> searchKey 开关的key
1100
- value_type ===> value 开关的值: 1开2关
1101
-
1102
- 返回: code 错误码
1103
- 0 成功
1104
- 100 参数错误,未知type
1105
- 11100 服务器内部错误
1106
- xxxxx 修改数据开关项失败
1107
-
1108
- what 结果信息
1109
-
1110
- pSearSwitchList: list<aphead.PersonalSearchDataSwitch> 搜索字段详情list
1111
- */
1112
995
  struct SettingSParam {
1113
996
  1: optional byte type
1114
997
  2: optional i64 value64
1115
- 3: optional list<i64> userIdList
1116
- 4: optional i32 value32
1117
- 5: optional string value_str
1118
- 6: optional byte value_type
1119
- 7: optional aphead.CombinationOrder cmd
1120
998
  }
1121
999
 
1122
1000
  struct SettingRet {
1123
1001
  1: i32 code
1124
1002
  2: optional string what
1125
- 3: optional map<string, string> mapKsVs
1126
- 4: optional map<i64,list<aphead.NewPersonalDataSwitch>> userDataSwitchMap
1127
- 5: optional list<aphead.PersonalSearchDataSwitch> pSearSwitchList
1128
- 6: optional list<aphead.CombinationOrder> cmdList
1003
+ 3: optional map<string, string> mapKsVs;
1129
1004
  }
1130
1005
 
1131
1006
  /////////////////////////////////////
@@ -1152,23 +1027,17 @@ struct SettingRet {
1152
1027
  返回:
1153
1028
  code: 0 成功; 100:参数错误;11100:服务器内部错误
1154
1029
  wbbPage 工作台轮播图分页返回结果
1155
- 4,根据parentId集合查询数据字典
1030
+ 4,根据parentId集合查询数据字典
1156
1031
  传入参数:
1157
1032
  1:list<i32> listids //父id的集合
1158
1033
  返回:
1159
1034
  list<aphead.EnterpriseDictionary>
1160
- 6.客户端查询菜单配置 (queryClientMenus)
1161
- 参数:
1162
- value_1: elogo(服务器标识)
1163
- 返回:
1164
- aphead.ClientMenuResult clientMenuResult
1165
1035
 
1166
1036
  */
1167
1037
  struct EnDParam{
1168
1038
  1: optional byte type
1169
1039
  2: optional map<string,string> wheremap
1170
- 3: optional list<i32> listids
1171
- 4: optional string value_1
1040
+ 3: optional list<i32> listids
1172
1041
  }
1173
1042
 
1174
1043
  struct EnDRet{
@@ -1176,7 +1045,6 @@ struct EnDRet{
1176
1045
  2: optional string what
1177
1046
  3: optional list<aphead.EnterpriseDictionary> listEnDic
1178
1047
  4: optional aphead.WorkBenchBannerPage wbbPage
1179
- 5: optional aphead.ClientMenuResult clientMenuResult
1180
1048
  }
1181
1049
  //////////////////////////////////////////
1182
1050
  /*
@@ -1336,7 +1204,7 @@ struct MultiOpSTRet {
1336
1204
  /*
1337
1205
  type 类型
1338
1206
  1, 分页查询应用市场应用信息。
1339
- 传入参数:query
1207
+ 传入参数:query (里面userid必须写入)
1340
1208
  返回:
1341
1209
  code: 0:成功,100:参数错误,11100:内部错误
1342
1210
  page: aphead.SmallMarketAppPage
@@ -1481,67 +1349,11 @@ type 类型
1481
1349
  19.删除待提醒消息
1482
1350
  参数:value64_1 ==>id, 消息提醒id
1483
1351
  返回:code: 100013002:成功,100013003:失败,100:参数错误,11100:内部错误
1484
-
1485
- 21.根据用户ID获取用户待办事项列表信息
1486
- 返回:
1487
- code: 0:成功,100:参数错误,11100:内部错误
1488
- list<aphead.AgencyBean> listAgencyBean
1489
-
1490
-
1491
- 22.客户端应用浏览器 应用服务开关总值
1492
- 参数: value64_1 appId应用Id
1493
- 返回:
1494
- code: 0:成功,100:参数错误,11100:内部错误
1495
- value32_1 开关总值
1496
- 23.客户端应用浏览器 帮助获取帮助列表
1497
- 参数: aphead.SmallAppHelpParam smallAppHelpParam 应用帮助查询结构体
1498
- 返回:
1499
- code: 0:成功,100:参数错误,11100:内部错误
1500
- list<aphead.SmallAppHelp> listSmallAppHelp
1501
- */
1502
- /*
1503
- 25.验证签名,接口鉴权 (authenticate)
1504
- 参数:authenticateBean 验证签名接口鉴权bean
1505
- 返回:
1506
- code: 100013102:成功,100:参数错误,11100:内部错误,
1507
- 100013103:Account_token无效ACCESS_TOKEN过期,
1508
- 100013104:url域名无效域名验证错误code
1509
- 100013105:签名验证失败验证签名,验证不通过验证签名失败
1510
- 100013106:jsApiList接口验证错误
1511
- what:描述
1512
- value_str_1: 结果数据
1513
- 28.用户设置公共号配置项(setUserToAppConfig)
1514
- 参数:userToAppConfig.appId公共号id
1515
- userToAppConfig.type类型
1516
- userToAppConfig.value
1517
- 返回:
1518
- code: 0:成功
1519
- 100:参数错误
1520
- 11100:内部错误
1521
- 100013006:失败
1522
- 29.获取用户设置的公共号配置项列表(getUserToAppConfigList)
1523
- 参数:userToAppConfig.timestamp时间戳
1524
- userToAppConfig.type类型(非必须)
1525
- 返回:
1526
- list<aphead.UserToAppConfig> listUserToAppConfig
1527
- code: 0:成功
1528
- 100:参数错误
1529
- 11100:内部错误
1530
- 32.忽略/隐藏app(ignoreSmallMarketAppInfo)
1531
- 参数:aphead.IgnoreMarketAppBean ignoreMarketAppBean
1532
- 返回:
1533
- code: 0:成功
1534
- 100:参数错误
1535
- 11100:内部错误
1536
- 100013077:操作类型及数据关系不匹配
1537
- 100013078:群应用无操作权限
1538
- 100013079:应用号不存在
1539
- what:错误码说明
1540
- 33.获取群应用接口/客户端工作台安装的应用(queryAllSmallMarketAppInfo)
1541
- 参数:aphead.SmallMarketAppQueryParam query
1542
- 返回:
1543
- code: 0:成功,100:参数错误,11100:内部错误
1544
- list<aphead.SmallMarketAppInfo> listSMAppInfo
1352
+
1353
+ 20.客户端直接发送消息给公众号的第三方服务器
1354
+ * 消息类型(messageType):38 上报位置消息 暂时只支持38号消息,后续添加请添加者补充说明
1355
+ * messageType=38,用户无感知上报位置消息,即便返回了错误码,也不能呈献给用户,所以对于38号消息只返回成功码
1356
+ 返回: code=0 成功
1545
1357
  */
1546
1358
 
1547
1359
  struct PltFParam {
@@ -1558,10 +1370,6 @@ struct PltFParam {
1558
1370
  11: optional byte value8_2
1559
1371
  12: optional i32 value32_2
1560
1372
  13: optional aphead.ReminderMsg reminderMsg
1561
- 14: optional aphead.SmallAppHelpParam smallAppHelpParam
1562
- 15: optional aphead.AuthenticateBean authenticateBean
1563
- 16: optional aphead.UserToAppConfig userToAppConfig
1564
- 17: optional aphead.IgnoreMarketAppBean ignoreMarketAppBean
1565
1373
  }
1566
1374
 
1567
1375
  struct PltFRet {
@@ -1575,22 +1383,80 @@ struct PltFRet {
1575
1383
  8: optional list<aphead.SmallEntAppInfo> listEntAppInfo
1576
1384
  9: optional string value_str_1
1577
1385
  10: optional aphead.ReminderMsgPage reminderMsgPage
1578
- 11: optional list<aphead.AgencyBean> listAgencyBean
1579
- 12: optional list<aphead.SmallAppHelp> listSmallAppHelp
1580
- 13: optional i32 value32_1
1581
- 15: optional list<aphead.UserToAppConfig> listUserToAppConfig
1386
+ }
1387
+
1388
+ /////////////////////////////////////////////
1389
+ /*
1390
+ type 类型
1391
+ 1, 单个查询表情
1392
+ 传入参数:value_str_1 # 表情文件的md5Code
1393
+ 返回:
1394
+ code: 0:成功,100:参数错误,11100:内部错误
1395
+ listEmotion: list<aphead.Emoticon> listEmotion
1396
+ 2,单个查询表情包
1397
+ 传入参数:value_str_1 # 表情包文件的md5Code
1398
+ 返回:
1399
+ code: 0:成功,100:参数错误,11100:内部错误
1400
+ emotPkg: aphead.EmoticonPackage
1401
+
1402
+ 3,分页查询表情包
1403
+ 传入参数:page #填入 pageNum,pageSize
1404
+ 返回:
1405
+ code: 0:成功,100:参数错误,11100:内部错误
1406
+ page: aphead.EmoticonPackagePage
1407
+ 4,添加自定义表情
1408
+ 传入参数:emoticon
1409
+ 返回:
1410
+ code: 0:成功,100:参数错误,801:md5Code不正确,802:md5Code文件已存在,11100:内部错误
1411
+ result: aphead.EmoticonOPResult
1412
+ 5,删除自定义表情
1413
+ 传入参数:emoticon
1414
+ 返回:
1415
+ code: 0:成功,100:参数错误,801:md5Code不正确,11100:内部错误
1416
+ result: aphead.EmoticonOPResult
1417
+ 6,根据表情包标识查询所有表情
1418
+ 传入参数:value_str_1 #表情文件的md5Code
1419
+ 返回:
1420
+ code: 0:成功,100:参数错误,11100:内部错误
1421
+ listEmotion: list<aphead.Emoticon>
1422
+ 7,查询用户所有自定义表情
1423
+ 返回:
1424
+ code: 0:成功,100:参数错误,11100:内部错误
1425
+ listEmotion: list<aphead.Emoticon>
1426
+ 8,根据表情包标签查询相关表情包集合
1427
+ 传入参数: value_str_1 #表情包标签
1428
+ 返回:
1429
+ code: 0:成功,100:参数错误,11100:内部错误
1430
+ listEmotPkg: list<aphead.EmoticonPackage>
1431
+ */
1432
+
1433
+ struct EmotParam {
1434
+ 1: optional byte type
1435
+ 2: optional string value_str_1
1436
+ 3: optional aphead.EmoticonPackagePage page
1437
+ 4: optional aphead.Emoticon emoticon
1438
+ }
1439
+
1440
+ struct EmotRet {
1441
+ 1: i32 code
1442
+ 2: optional string what
1443
+ 3: optional aphead.EmoticonOPResult result
1444
+ 4: optional aphead.EmoticonPackage emotPkg
1445
+ 5: optional aphead.EmoticonPackagePage page
1446
+ 6: optional list<aphead.Emoticon> listEmotion
1447
+ 7: optional list<aphead.EmoticonPackage> listEmotPkg
1582
1448
  }
1583
1449
  //////////////////////////////////////////
1584
1450
  /*
1585
1451
  type 类型
1586
1452
  1, 查询公共配置单个时间戳
1587
- 参数:value64_1:(查询员工级别时间戳传企业id,查询机器人时间戳传机器人appID);
1588
- value64_2 时间戳类型(查询员工级别时间戳传238,查询机器人时间戳传22)
1453
+ 参数:value64_1:(查询员工级别时间戳或查询工作台轮播图时间戳或查询帮助系统时间戳或数据字典时间戳传企业id,查询机器人时间戳传机器人appID);
1454
+ value64_2 时间戳类型(查询员工级别时间戳传238,查询机器人时间戳传22,查询工作台轮播图时间戳传26,查询帮助系统时间戳传27,查询数据字典时间戳传23
1589
1455
  为了兼容老版本,value64_2不传认为是查询机器人时间戳
1590
1456
  返回:
1591
1457
  code: 0:成功,100:参数错误,11100:内部错误
1592
1458
  value64_1:对应配置项的时间戳
1593
- 2, 查询数据字典时间戳
1459
+ 2, 查询数据字典时间戳--此功能废弃,使用上面的接口获取数据字典时间戳
1594
1460
  返回:
1595
1461
  code: 0:成功,100:参数错误,11100:内部错误
1596
1462
  value64_1: 数据字典的时间戳
@@ -1637,22 +1503,132 @@ struct RegURet {
1637
1503
  /*
1638
1504
  type 类型
1639
1505
  1.调用声网服务
1640
- 1)用户聊天过程中,动态SubKey失效,重新获取SubKey
1641
- 参数value_str: {"function" : "getSubKey", "param1" : "用户ID", "param2" : "企业ID", "param3" : "视频频道ID"}
1642
- 返回value_str: {"code" : "0", "msg" : "SUCCESS", "result" : {"SubKey" : "XXXXXXXXXXX", "channelID" : "XXX"}}
1643
- 如果result当中没有值,会设置result为空
1644
- 2)用户同意视频邀请---加入单聊
1645
- 参数value_str: {"function" : "joinSingle", "param1" : "邀请者ID", "param2" : "被邀请者ID", "param3" : "企业ID", "param4" : "视频频道ID"}
1646
- 返回value_str: {"code" : "0", "msg" : "SUCCESS", "result" : {"SubKey" : "XXXXXXXXXXX", "channelID" : "XXX"}}
1647
- 如果result当中没有值,会设置result为空
1648
- 3)用户同意视频邀请---加入群聊
1649
- 参数value_str: {"function" : "joinGroup", "param1" : "邀请者ID", "param2" : "被邀请者ID", "param3" : "企业ID", "param4" : "视频频道ID"}
1650
- 返回value_str: {"code" : "0", "msg" : "SUCCESS", "result" : {"SubKey" : "XXXXXXXXXXX", "channelID" : "XXX"}}
1651
- 如果result当中没有值,会设置result为空
1652
- 4)用户退出视频聊天
1653
- 参数value_str: {"function" : "outChat", "param1" : "退出用户ID", "param2" : "企业ID", "param3" : "视频频道ID", "param4" : "聊天时长"}
1654
- 返回value_str: {"code" : "0", "msg" : "SUCCESS"}
1506
+ 方法1: 获取许可(声网)
1507
+ 参数:{"function":"getPermit","parame1":"企业ID"}
1508
+ 成功返回(字符串):{"code":100,"msg":"SUCCESS","result":{"VendorKey":"XXXXXXXXXX"}}
1509
+
1510
+ 方法2: 加入聊天
1511
+ 参数:{"function":"joinChat","parame1":"用户ID","parame2":"企业ID","parame3","视频频道ID","parame4":"呼叫类型","parame5","SDK类型"}
1512
+ 成功返回(字符串):{"code":100,"msg":"SUCCESS","result":{"SubKey":"XXXXXXXXXXX","channelID":"XXXX","userID":"XXXX","VendorKey":""}}
1513
+
1514
+ 方法3: 退出聊天/同步聊天
1515
+ 参数:{"function":"outChat","parame1":"用户ID","parame2":"企业ID","parame3","视频频道ID","parame4":"聊天时长","parame5":"退出类型","parame6","SDK类型"}
1516
+ 成功返回(字符串):{"code":100,"msg":"SUCCESS"}
1517
+
1518
+ 方法4: 用户聊天过程中,动态SubKey失效,重新获取SubKey(声网)
1519
+ 参数:{"function":"getSubKey","parame1":"用户ID","parame2":"企业ID","parame3","视频频道ID"}
1520
+ 成功返回(字符串):{"code":100,"msg":"SUCCESS","result":{"SubKey":"XXXXXXXXXXX","channelID":"XXXX","userID":"XXXX"}}
1521
+
1522
+ 方法5: 获取打洞服务信息(西安)
1523
+ 参数:{"function":"getServerInfo","parame1":"SDK类型"}
1524
+ 成功返回(字符串):{"code":100,"msg":"SUCCESS","result":{"stunServerAddr":"","turnAddr":"","account":"","password":""}}
1525
+ 统一对外接口错误码:
1526
+ code:100->成功,110->执行异常,111->function名称错误
1527
+ 2.原生朋友圈
1528
+ 3.云盘
1529
+ 注释见下面
1530
+ */
1531
+
1532
+ /*
1533
+ * folder
1534
+ * 入参 {"function":"folder","pid":1,"userId":12415239841,"timestamp":12415239841}
1535
+ * 出参 {"result":[{"createdAt":1500365555239,"encryptFileSize":41008,"fileCode":"100110011002","fileId":1500365555239001599,"fileName":"云盘改造","filePath":"http://172.16.8.95:9999/group1/M00/00/00/rBAIX1ltwvOEX2OCAAAAACZqgWs44.docx","fileReMark":"个人区-云盘改造","fileSize":41007,"fileSuffix":"docx","fileType":1,"image":false,"md5Hash":"3e8f81017e245637abdac56171979fdb","ownerId":12415239841,"pid":1,"secretKey":"suf98ij2i9hmj3l6","updatedAt":1500365555239,"uploaderId":12415239841,"uploaderName":"曹李强"},{"createdAt":1500365677522,"encryptFileSize":10560,"fileCode":"100110011003","fileId":1500365677522002862,"fileName":"学习","filePath":"http://172.16.8.95:9999/group1/M00/00/00/rBAIX1ltw22Efz7_AAAAAALW7xk73.xlsx","fileReMark":"个人区-学习","fileSize":10550,"fileSuffix":"xlsx","fileType":1,"image":false,"md5Hash":"d5182ffea3fbe40ffb01468367477c19","ownerId":12415239841,"pid":1,"secretKey":"f2osoul8ceuzd6s5","updatedAt":1500365677522,"uploaderId":12415239841,"uploaderName":"曹李强"}],"code":0,"msg":"SUCCESSS"}
1536
+ *
1537
+ *
1538
+ *addFile
1539
+ *
1540
+ * 入参 {"function":"addFile","file":{"encryptFileSize":288,"fileCode":"10011001","fileName":"desktop","filePath":"e0855.ini","fileReMark":"a-b-c","fileSize":288,"fileSuffix":"ini","fileType":1,"md5Hash":"abc","ownerId":111,"pid":1496892622384001700,"secretKey":"2a3atz1hcvlbx4u4","uploaderId":10385196713,"uploaderName":"aaaa","fileClass":"chat"}}
1541
+ * 出参 {"result":{"createdAt":1500534363284,"encryptFileSize":288,"fileClass":"chat","fileCode":"100110011003","fileId":1500534363284001973,"fileName":"desktop(2)","filePath":"e0855.ini","fileReMark":"desktop(2)","fileSize":288,"fileSuffix":"ini","fileType":1,"image":false,"md5Hash":"abc","ownerId":111,"pid":1496892622384001700,"secretKey":"2a3atz1hcvlbx4u4","updatedAt":1500534363284,"uploaderId":10385196713,"uploaderName":"aaaa","validity":90},"code":0,"msg":"SUCCESSS"}
1542
+ *
1543
+ *deleteFile
1544
+ *
1545
+ * 入参 {"function":"deleteFile","fileId":111}
1546
+ * 出参 {"code":0,"msg":"SUCCESSS"}
1547
+ *
1548
+ *updateFile
1549
+ *
1550
+ * 入参 {"function":"updateFile","file":{"fileName":"desktop","fileId":"1500365555239001599"}}
1551
+ * 出参 {"code":0,"msg":"SUCCESSS"}
1552
+ *
1553
+ *getFileById
1554
+ *
1555
+ * 入参 {"function":"getFileById","fileId":111}
1556
+ * 出参 {"result":{"createdAt":1500365555239,"encryptFileSize":41008,"fileCode":"100110011002","fileId":1500365555239001599,"fileName":"desktop","filePath":"http://172.16.8.95:9999/group1/M00/00/00/rBAIX1ltwvOEX2OCAAAAACZqgWs44.docx","fileReMark":"个人区-云盘改造","fileSize":41007,"fileSuffix":"docx","fileType":1,"image":false,"md5Hash":"3e8f81017e245637abdac56171979fdb","ownerId":12415239841,"pid":1,"secretKey":"suf98ij2i9hmj3l6","updatedAt":1500536403503,"uploaderId":12415239841,"uploaderName":"曹李强"},"code":0,"msg":"SUCCESSS"}
1557
+ *
1558
+ *getFilesByHash
1559
+ *
1560
+ * 入参 {"function":"getFilesByHash","hash":"3e8f81017e245637abdac56171979fdb"}
1561
+ * 出参 {"result":[{"createdAt":1500365555239,"encryptFileSize":41008,"fileCode":"100110011002","fileId":1500365555239001599,"fileName":"desktop","filePath":"http://172.16.8.95:9999/group1/M00/00/00/rBAIX1ltwvOEX2OCAAAAACZqgWs44.docx","fileReMark":"个人区-云盘改造","fileSize":41007,"fileSuffix":"docx","fileType":1,"image":false,"md5Hash":"3e8f81017e245637abdac56171979fdb","ownerId":12415239841,"pid":1,"secretKey":"suf98ij2i9hmj3l6","updatedAt":1500536403503,"uploaderId":12415239841,"uploaderName":"曹李强"}],"code":0,"msg":"SUCCESSS"}
1562
+ *
1563
+ *searchFile
1564
+ *
1565
+ * 入参 {"function":"searchFile","searchText":"desk","userId":12415239841}
1566
+ * 出参 {"result":[{"createdAt":1500365555239,"encryptFileSize":41008,"fileCode":"100110011002","fileId":1500365555239001599,"fileName":"desktop","filePath":"http://172.16.8.95:9999/group1/M00/00/00/rBAIX1ltwvOEX2OCAAAAACZqgWs44.docx","fileReMark":"个人区-云盘改造","fileSize":41007,"fileSuffix":"docx","fileType":1,"image":false,"md5Hash":"3e8f81017e245637abdac56171979fdb","ownerId":12415239841,"pid":1,"secretKey":"suf98ij2i9hmj3l6","updatedAt":1500536403503,"uploaderId":12415239841,"uploaderName":"曹李强"}],"code":0,"msg":"SUCCESSS"}
1567
+ *
1568
+ *createTeam
1569
+ *
1570
+ * 入参 {"function":"createTeam","file":{"fileCode":"10011001","fileName":"desktop","fileReMark":"a-b-c","fileType":2,"ownerId":111,"pid":1496892622384001700,"uploaderId":10385196713,"uploaderName":"aaaa"}}
1571
+ * 出参 {"result":{"createdAt":1500537584023,"fileCode":"100110011005","fileId":1500537584023001446,"fileName":"desktop(1)","fileReMark":"desktop(1)","fileType":2,"image":false,"ownerId":111,"pid":1496892622384001700,"updatedAt":1500537584023,"uploaderId":10385196713,"uploaderName":"aaaa"},"code":0,"msg":"SUCCESSS"}
1572
+ */
1573
+
1574
+ /*
1575
+ *
1576
+ *teamAddMember
1577
+ *
1578
+ * 入参 {"function":"teamAddMember","members":[{"fileId":111,"headImg":"","suserId":"111","createdAt":1500537824755,"userId":111,"sfileId":"111","userName":"张三","roleId":1}]}
1579
+ * 出参 {"code":0,"msg":"SUCCESSS"}
1580
+ *
1581
+ *teamRemoveMember
1582
+ *
1583
+ * 入参 {"function":"teamRemoveMember","members":[{"fileId":111,"headImg":"","suserId":"111","createdAt":1500537824755,"userId":111,"sfileId":"111","userName":"张三","roleId":1}]}
1584
+ * 出参 {"code":0,"msg":"SUCCESSS"}
1585
+ *
1586
+ *teamResetMember
1587
+ *
1588
+ * 入参 {"function":"teamResetMember","members":[{"fileId":111,"headImg":"","suserId":"111","createdAt":1500537824755,"userId":111,"sfileId":"111","userName":"张三","roleId":1}]}
1589
+ * 出参 {"code":0,"msg":"SUCCESSS"}
1590
+ *
1591
+ *teams
1592
+ *
1593
+ * 入参 {"function":"teams","userId":111}
1594
+ * 出参 {"result":[{"createdAt":1500275014598,"encryptFileSize":0,"fileCode":"100110011001","fileId":1500275014598001902,"fileName":"2222","fileReMark":"个人区-2222","fileSize":0,"fileType":3,"image":false,"members":1,"ownerId":111,"pid":1,"roleId":1,"updatedAt":1500275014598,"uploaderId":111}],"code":0,"msg":"SUCCESSS"}
1595
+ *
1596
+ *teamMembers
1597
+ *
1598
+ * 入参 {"function":"teamMembers","fileId":1500275014598001902}
1599
+ * 出参 {"result":[{"createdAt":1500275014928,"fileId":1500275014598001902,"headImg":"","roleId":1,"roleName":"管理员","sfileId":"1500275014598001902","suserId":"111","updatedAt":1500275014928,"userId":111,"userName":"null"}],"code":0,"msg":"SUCCESSS"}
1600
+ *
1601
+ *roles
1602
+ *
1603
+ * 入参 {"function":"roles","isShow":1}
1604
+ * 出参 {"result":[{"createdAt":1495099097131,"isShow":1,"name":"管理员","orderNum":1,"permission":"上传,下载,创建团队,删除,重命名","roleID":1,"roleType":1,"status":1,"totalSize":-1,"updatedAt":0,"uploadSize":-1},{"createdAt":1495099097131,"isShow":1,"name":"普通成员","orderNum":2,"permission":"上传,下载,重命名","roleID":2,"roleType":2,"status":1,"totalSize":-1,"updatedAt":1496892694229,"uploadSize":-1}],"code":0,"msg":"SUCCESSS"}
1605
+ *
1606
+ *getRoleByID
1607
+ *
1608
+ * 入参 {"function":"getRoleByID","roleId":1}
1609
+ * 出参 {"result":{"createdAt":1495099097131,"isShow":1,"name":"管理员","orderNum":1,"permission":"11111","roleID":1,"roleType":1,"status":1,"totalSize":-1,"updatedAt":0,"uploadSize":-1},"code":0,"msg":"SUCCESSS"}
1610
+ *
1611
+ *addRole
1612
+ *
1613
+ * 入参 {"function":"addRole","role":{"isShow":1,"name":"管理员2","orderNum":1,"permission":"11111","totalSize":-1,"uploadSize":-1}}
1614
+ * 出参 {"code":0,"msg":"SUCCESSS"}
1615
+ *
1616
+ *editRole
1617
+ *
1618
+ * 入参 {"function":"editRole","role":{"isShow":1,"roleID":5,"name":"管理员2","orderNum":1,"permission":"11111","totalSize":-1,"uploadSize":-1}}
1619
+ * 出参 {"code":0,"msg":"SUCCESSS"}
1620
+ *
1621
+ *removerRole
1622
+ *
1623
+ * 入参 {"function":"removerRole","roleId":"5"}
1624
+ * 出参 {"code":0,"msg":"SUCCESSS"}
1625
+ *
1626
+ *getPermission
1627
+ *
1628
+ * 入参 {"function":"getPermission","roleId":5,"fileId":1500537350811001112,"userId":12415239841}
1629
+ * 出参 {"result":{"isCreateTeam":1,"isDelete":1,"isDownLoad":1,"isManager":0,"isReName":1,"isRead":1,"isUpLoad":1,"roleID":5,"totalSize":-1,"uploadSize":-1},"code":0,"msg":"SUCCESSS"}
1655
1630
  */
1631
+
1656
1632
  struct JSONParam {
1657
1633
  1: optional byte type
1658
1634
  2: optional string value_str
@@ -1795,8 +1771,6 @@ struct EnORet {
1795
1771
  3: optional OrgUserAndChildNodes nodes
1796
1772
  4: optional list<OrgSearchUserRet> orgSearchUsers;
1797
1773
  5: optional aphead.OrganizationBean bean;
1798
- // type 4,5新增了EnORet的6,7 type6,7新增了EnORet的6,7,8 但互不影响
1799
- 12: optional list<aphead.OrganizationBean> orgBeans
1800
1774
  }
1801
1775
 
1802
1776
 
@@ -1852,7 +1826,7 @@ type 类型
1852
1826
  参数:aphead.SignalProtocolAddress oneDevAddr
1853
1827
  返回: code: 0:成功,100:参数错误,11100:内部错误
1854
1828
  value32_1:密钥数量
1855
- //////////////////////////////////端对端加密end/////////////////////////
1829
+ //////////////////////////////////端对端加密end/////////////////////////
1856
1830
 
1857
1831
  10.获取潜水者名单
1858
1832
  参数:value64 ==>groupID 群id
@@ -1899,98 +1873,13 @@ type 类型
1899
1873
  3.校验本人是否有生成邀请码的权限
1900
1874
  参数:无
1901
1875
  返回:code为0表示有权限,100001717表示此人没有权限生成邀请码
1902
- value_str: 新服务器标志-用于区分新老服务器 ==>versionFlag(V5.19.0)
1903
1876
  4.校验邀请码是否有效
1904
1877
  参数:value_str:邀请码 uc:被邀请用户
1905
1878
  返回:code:0邀请码有效;code:100参数错误,100001715邀请码已失效
1906
- 5.根据邀请码获取邀请码信息
1879
+ 5.根据邀请码获取邀请人的userID
1907
1880
  参数:value_str:邀请码
1908
1881
  返回:code:0成功 code:100参数错误 11100:服务器内部错误 100001715:邀请码已失效
1909
- value64:邀请码创建者/绑定人的userId
1910
- value_byte //即buddySwitch,用户注册后是否加好友;0:加好友,1:不加好友
1911
- createUserID:邀请码创建者的userId
1912
- bindUserID:邀请码绑定人的userId
1913
- createPattern:创建模式(1-自己创建;2-为他人创建)
1914
- 6.根据群邀请码获处理入群逻辑
1915
- 参数:value_str 群邀请码
1916
- 返回:
1917
- code:
1918
- 0 成功
1919
- 100 未知错误类型
1920
- 108 邀请码无效
1921
- 307 该群不存在
1922
- 11100 服务异常
1923
- 100011503 该群不允许群主/管理员邀请其他人进群
1924
- 100015001 扫码人已经在群里,示例:InviteCodeResult(code:100015001, message:{"groupId":21265121800})
1925
- 7. 发送新的朋友短信
1926
-   参数:type 6
1927
-    userIDs 接收者的userid,放入一个
1928
-     langType 发送短信的语言
1929
-   返回值
1930
-    code:0成功 code:100参数错误 11100:服务器内部错误
1931
1882
  value64:邀请人的userID
1932
-
1933
- 8. 查询服务器允许注册人数 (getLimitRegisterCount)
1934
- 参数:无
1935
- 返回值
1936
- code:
1937
- 0:成功
1938
- 100:参数错误
1939
- 11100:服务器内部错误
1940
- 100015004:没有该操作类型
1941
- 100015005:没有设置邀请码权限
1942
- 100015006:修改邀请码失败
1943
- 100015007:查询分享列表失败
1944
- value_str: 允许注册人数相关信息
1945
-
1946
- 9. 设置邀请码接口 (setInviteCode)
1947
- 参数:
1948
- setParam ==> InviteSetParam
1949
- 返回值
1950
- code:
1951
- 0:成功
1952
- 100:参数错误
1953
- 11100:服务器内部错误
1954
- 100015004:没有该操作类型
1955
- 100015005:没有设置邀请码权限
1956
- 100015006:修改邀请码失败
1957
- 100015007:查询分享列表失败
1958
- what: 服务器当前时间 时间戳毫秒
1959
- 10. 用户邀请码分享列表查询接口 (getShareInviteCodeInfo)
1960
- 参数:
1961
- shareParam 用户邀请码参数 ==> aphead.InviteCodeShareParam
1962
- 返回值
1963
- code:
1964
- 0:成功
1965
- 100:参数错误
1966
- 11100:服务器内部错误
1967
- 100015004:没有该操作类型
1968
- 100015005:没有设置邀请码权限
1969
- 100015006:修改邀请码失败
1970
- 100015007:查询分享列表失败
1971
- shareInfo 邀请码列表 ==> list<aphead.InviteCodeShare>
1972
- 11. 保存邀请码图片 (saveInviteCodePic)
1973
- 参数:
1974
- value_str 邀请码
1975
- value_str2 邀请码图片
1976
- 返回值
1977
- code:
1978
- 0:成功
1979
- 100:参数错误
1980
- 11100:服务器内部错误
1981
- 12. 添加邀请码记录 addInviteCodeRecord
1982
- 参数:
1983
- value64 userID
1984
- value_str 邀请码
1985
- value8 操作类型 operationFlag
1986
- 13. 保存邀请码绑定人 saveInviteCodeBindUserID
1987
- 参数:
1988
- inviteCodeBindUserParam 保存邀请码绑定人入参
1989
- 返回值
1990
- code:
1991
- 0:成功
1992
- 100:参数错误
1993
- 11100:服务器内部错误
1994
1883
  */
1995
1884
  struct VerifyCodeParam {
1996
1885
  1: optional byte type
@@ -1999,13 +1888,6 @@ struct VerifyCodeParam {
1999
1888
  4: optional aphead.InviteCodeParam inviteCodeParam
2000
1889
  5: optional string value_str
2001
1890
  6: optional aphead.UserContact uc
2002
- 7: optional aphead.InviteSetParam setParam
2003
- 8: optional i64 value64
2004
- 9: optional aphead.InviteCodeShareParam shareParam
2005
- 10: optional string value_str2
2006
- 11: optional i64 value64_2
2007
- 12: optional byte value8
2008
- 13: optional aphead.InviteCodeBindUserParam inviteCodeBindUserParam
2009
1891
  }
2010
1892
 
2011
1893
  struct VerifyCodeRet {
@@ -2013,54 +1895,11 @@ struct VerifyCodeRet {
2013
1895
  2: optional string what
2014
1896
  3: optional map<i64,string> failRet
2015
1897
  4: optional i64 value64
2016
- 5: optional byte value_byte //即buddySwitch,用户注册后是否加好友;0:加好友,1:不加好友
2017
- 6: optional string extData // 验证码拓展字段
2018
- 7: optional list<aphead.InviteCodeShare> shareInfo
2019
- 8: optional string value_str
2020
- 9: optional i64 createUserID // 邀请码创建者的userId
2021
- 10: optional i64 bindUserID // 邀请码绑定人的userId
2022
- 11: optional byte createPattern // 创建模式(1-自己创建;2-为他人创建)
2023
- }
2024
- ////
2025
- /*
2026
- type:类型
2027
- 1.清除缓存,
2028
- 参数:value_str1 缓存key
2029
- 返回:code
2030
- 2.设置缓存
2031
- 参数:
2032
- value_str1 缓存key
2033
- value_str2 缓存value
2034
- value_str3 session
2035
- 返回:code
2036
- 3.获取缓存
2037
- 参数:value_str1  缓存key
2038
- 返回:code
2039
- value 缓存value
2040
- 4.根据 roomId获取token
2041
- 参数:value_str1 表示roomId
2042
- 返回值code 0 表示成功
2043
- value 表示返回的token
2044
- */
2045
-
2046
- struct CacheParam {
2047
- 1: optional byte type
2048
- 2: optional string value_str1
2049
- 3: optional binary value_str2
2050
- 4: optional string value_str3
2051
1898
  }
2052
1899
 
2053
- struct CacheRet {
2054
- 1: i32 code
2055
- 2: optional string what
2056
- 3: optional binary value
2057
- }
2058
-
2059
-
2060
-
2061
1900
  /*
2062
1901
  type 类型
2063
- 1.
1902
+ 1.查询用户的群时间戳
2064
1903
  参数:value64_1==>groupID 上一次查询结果集中最大的群ID(第一次为0)
2065
1904
  value64_2==>timestamp 客户端传过来用作比对的时间戳(第一次为0)
2066
1905
  value16==>size 每次拉取群的个数
@@ -2074,10 +1913,6 @@ type 类型
2074
1913
  参数:value64_1==>groupID
2075
1914
  返回:code: 100011018:成功,11100:内部错误,100011013:服务异常,100011019:未查询到结果
2076
1915
  groupSetting 客户端对该群的设置信息
2077
- 4.根据群名片规则修改全部群成员群名片 (updateAllGroupMemberName)
2078
- 场景:修改/设置 群名片规则,群成员更新群名片规则显示
2079
- 传入参数: value64_1 ==> groupID
2080
- 返回:code: 0:成功 100:未知错误; 100011504:群名片规则未开启或未配置
2081
1916
  */
2082
1917
 
2083
1918
  struct GroupMemParam {
@@ -2095,6 +1930,63 @@ struct GroupMemRet {
2095
1930
  4: optional aphead.UserGroupSettingsExtend groupSetting
2096
1931
  }
2097
1932
 
1933
+ /*
1934
+ type 类型
1935
+ 其他错误码
1936
+ 100022001;//参数错误
1937
+ 100022002;//收藏用户id不能为空
1938
+ 100022003;//保存文件到云盘失败
1939
+ 100022004;//保存数据失败
1940
+ 100022005;//删除数据失败
1941
+ 100022006;//该收藏信息不存在
1942
+ 100022007;//收藏id不能为空
1943
+
1944
+ 1.新增收藏信息
1945
+ 参数:aphead.CollectionBean bean 收藏信息
1946
+ 返回:code: 0:成功,100:参数错误,11100:内部错误,其他:见上面
1947
+ 2.删除收藏信息
1948
+ 参数:value64_1 用户uid; value64_2 收藏ID;
1949
+ 返回:code: 0:成功,100:参数错误,11100:内部错误,其他:见上面
1950
+ 3.获取收藏信息
1951
+ 参数:value64_1 用户uid; value64_2 收藏ID;
1952
+ 返回:code: 0:成功,100:参数错误,11100:内部错误,其他:见上面
1953
+ bean: 收藏信息
1954
+ 4.分页查询收藏列表信息
1955
+ 参数:params:
1956
+ key=messageType,根据消息类型查询
1957
+ key=message,根据消息内容查询
1958
+ key=fileName,根据文件名称查询
1959
+ key=startTime,创建开始时间
1960
+ key=endTime,创建结束时间
1961
+ value16_1:每页的条数
1962
+ value16_2:当前页码
1963
+ 返回:code: 0:成功,100:参数错误,11100:内部错误,其他:见上面
1964
+ aphead.CollectionBeanStruct beans 收藏列表信息
1965
+ 5.批量删除收藏信息
1966
+ 参数:value64_1 用户uid; list_i64 收藏ID集合
1967
+ 返回:code: 0:成功,100:参数错误,11100:内部错误,其他:见上面
1968
+ 6.编辑文本类型收藏内容
1969
+ 参数:aphead.CollectionBean bean,必填collectionID,collectUserId,messageType和message
1970
+ 返回:code: 0:成功,100:参数错误,11100:内部错误,其他:见上面
1971
+ */
1972
+ struct CollectionParam {
1973
+ 1: optional byte type
1974
+ 2: optional i16 value16_1
1975
+ 3: optional i16 value16_2
1976
+ 4: optional i64 value64_1
1977
+ 5: optional i64 value64_2
1978
+ 6: optional map<string,string> params
1979
+ 7: optional aphead.CollectionBean bean;
1980
+ 8: optional list<i64> list_i64;
1981
+ }
1982
+
1983
+ struct CollectionRet {
1984
+ 1: i32 code
1985
+ 2: optional string what
1986
+ 3: optional aphead.OperateCollectionResult bean
1987
+ 4: optional aphead.CollectionBeanStruct beans
1988
+ }
1989
+
2098
1990
  /*
2099
1991
  type 类型
2100
1992
  1.提交意见反馈
@@ -2124,7 +2016,7 @@ type 类型
2124
2016
  struct FeedBackParam {
2125
2017
  1: optional byte type
2126
2018
  2: optional aphead.Feedback fb
2127
- 3: optional map<string ,string> map_strstr
2019
+ 3: optional map<string ,string> map_strstr
2128
2020
  }
2129
2021
 
2130
2022
  struct FeedBackRet {
@@ -2133,6 +2025,36 @@ struct FeedBackRet {
2133
2025
  3: optional list<aphead.SystemHelp> helpRlt
2134
2026
  }
2135
2027
 
2028
+ /*
2029
+ type:类型
2030
+ 1.清除缓存,
2031
+ 参数:value_str1 缓存key
2032
+ 返回:code
2033
+ 2.设置缓存
2034
+ 参数:
2035
+ value_str1 缓存key
2036
+ value_str2 缓存value
2037
+ value_str3 session
2038
+ 返回:code
2039
+ 3.获取缓存
2040
+ 参数:value_str1  缓存key
2041
+ 返回:code
2042
+ value 缓存value
2043
+ */
2044
+
2045
+ struct CacheParam {
2046
+ 1: optional byte type
2047
+ 2: optional string value_str1
2048
+ 3: optional string value_str2
2049
+ 4: optional string value_str3
2050
+ }
2051
+
2052
+ struct CacheRet {
2053
+ 1: i32 code
2054
+ 2: optional string what
2055
+ 3: optional string value
2056
+ }
2057
+
2136
2058
  /*
2137
2059
  type 类型
2138
2060
  1.好友申请请求
@@ -2204,19 +2126,26 @@ struct VerifyMessageParam {
2204
2126
  }
2205
2127
 
2206
2128
  struct VerifyMessageRet {
2207
- 1: i32 code
2208
- 2: optional string what
2129
+ 1: i32 code
2130
+ 2: optional string what
2209
2131
  3: optional i64 value64
2210
2132
  4: optional i16 value16
2211
2133
  5: optional map<i16,i64> groupPageTimestampMap
2212
- 6: optional list<aphead.TinyUserBean> inviteVerifyUserList;
2213
- 7: optional list<aphead.TinyUserBean> inviteNotAllowUserList;
2214
- 8: optional list<aphead.TinyUserBean> inviteAddUserList;
2215
- 9: optional list<aphead.TinyUserBean> inviteAdminVerifyUserList;
2216
2134
  }
2135
+
2136
+ // 如果服务器的游标与客户端的游标相同, 则 3/4 不返回值
2137
+ // ts 主要是分页返回敏感词, 比如客户端 游标为100 服务器游标为10000,
2138
+ // 服务器有可能需要分 99 次给客户端返回
2139
+ struct BadWordRet {
2140
+ 1: i32 code
2141
+ 2: optional string what
2142
+ 3: optional i64 ts // 当前返回给客户端的敏感词列表中最大的 游标(时间戳)
2143
+ 4: optional list<aphead.Words> words // 敏感词
2144
+ }
2145
+
2217
2146
  //登录和注册获取验证码
2218
2147
  struct GetVerifyCodeParam {
2219
- 1: byte operType; //1.注册,2.登录
2148
+ 1: byte operType; //1.注册,2.登录 3.更换设备获取验证码
2220
2149
  2: string user; //手机号
2221
2150
  3: optional i64 sdkid; // 默认为0
2222
2151
  4: optional i32 tzone // 时区
@@ -2234,199 +2163,25 @@ struct GetVerifyCodeResult {
2234
2163
  4: optional i64 inviteCodeID
2235
2164
  }
2236
2165
 
2237
- // 如果服务器的游标与客户端的游标相同, 则 3/4 不返回值
2238
- // ts 主要是分页返回敏感词, 比如客户端 游标为100 服务器游标为10000,
2239
- // 服务器有可能需要分 99 次给客户端返回
2240
- struct BadWordRet {
2166
+ /*
2167
+ type 类型
2168
+ 1.根据账户类型替换账户
2169
+ 参数:userContact
2170
+ 返回:code: 0表示替换成功,否则替换失败
2171
+ 2.判定用户是否在SDK白名单中
2172
+ 参数:无
2173
+ 返回:code
2174
+ 100004501 是sdk白名单用户
2175
+ 100004502 不是sdk白名单用户
2176
+ */
2177
+ struct UserServiceParam {
2178
+ 1: optional byte type
2179
+ 2: optional aphead.UserContact userContact
2180
+ }
2181
+
2182
+ struct UserServiceRet {
2241
2183
  1: i32 code
2242
2184
  2: optional string what
2243
- 3: optional i64 ts // 当前返回给客户端的敏感词列表中最大的 游标(时间戳)
2244
- 4: optional list<aphead.Words> words // 敏感词
2245
- }
2246
-
2247
- /*
2248
- type 类型
2249
- 其他错误码
2250
- 100022001;//参数错误
2251
- 100022002;//收藏用户id不能为空
2252
- 100022003;//保存文件到云盘失败
2253
- 100022004;//保存数据失败
2254
- 100022005;//删除数据失败
2255
- 100022006;//该收藏信息不存在
2256
- 100022007;//收藏id不能为空
2257
-
2258
- 1.新增收藏信息
2259
- 参数:aphead.CollectionBean bean 收藏信息
2260
- 返回:code: 0:成功,100:参数错误,11100:内部错误,其他:见上面
2261
- 2.删除收藏信息
2262
- 参数:value64_1 用户uid; value64_2 收藏ID;
2263
- 返回:code: 0:成功,100:参数错误,11100:内部错误,其他:见上面
2264
- 3.获取收藏信息
2265
- 参数:value64_1 用户uid; value64_2 收藏ID;
2266
- 返回:code: 0:成功,100:参数错误,11100:内部错误,其他:见上面
2267
- bean: 收藏信息
2268
- 4.分页查询收藏列表信息
2269
- 参数:params:
2270
- key=messageType,根据消息类型查询
2271
- key=message,根据消息内容查询
2272
- key=fileName,根据文件名称查询
2273
- key=startTime,创建开始时间
2274
- key=endTime,创建结束时间
2275
- value16_1:每页的条数
2276
- value16_2:当前页码
2277
- 返回:code: 0:成功,100:参数错误,11100:内部错误,其他:见上面
2278
- aphead.CollectionBeanStruct beans 收藏列表信息
2279
- 5.批量删除收藏信息
2280
- 参数:value64_1 用户uid; list_i64 收藏ID集合
2281
- 返回:code: 0:成功,100:参数错误,11100:内部错误,其他:见上面
2282
- 6.编辑文本类型收藏内容
2283
- 参数:aphead.CollectionBean bean,必填collectionID,collectUserId,messageType和message
2284
- 返回:code: 0:成功,100:参数错误,11100:内部错误,其他:见上面
2285
- */
2286
- struct CollectionParam {
2287
- 1: optional byte type
2288
- 2: optional i16 value16_1
2289
- 3: optional i16 value16_2
2290
- 4: optional i64 value64_1
2291
- 5: optional i64 value64_2
2292
- 6: optional map<string,string> params
2293
- 7: optional aphead.CollectionBean bean;
2294
- 8: optional list<i64> list_i64;
2295
- }
2296
-
2297
- struct CollectionRet {
2298
- 1: i32 code
2299
- 2: optional string what
2300
- 3: optional aphead.OperateCollectionResult bean
2301
- 4: optional aphead.CollectionBeanStruct beans
2302
- }
2303
-
2304
-
2305
- /*
2306
- type 类型
2307
- 1.添加群公告
2308
- 场景:客户端群管理员/群主添加群公告
2309
- 传入参数:aphead.GroupAnnouncement groupAnnounce
2310
- 返回:code:
2311
- 100011011:成功 100011012:失败 100011013:服务异常 100011014:非群管理员、群主无权操作
2312
- 2.删除单个群公告
2313
- 场景:客户端群管理员/群主删除群公告
2314
- 传入参数:value64_1 群公告ID
2315
- value64_2 群ID
2316
- 返回:code:
2317
- 100011011:成功 100011012:失败 100011013:服务异常 100011014:非群管理员、群主无权操作
2318
- 3.校验群公告是否存在
2319
- 场景:客户端群成员查看群公告消息判断公告是否还存在
2320
- 传入参数:value64_1 群公告ID
2321
- value64_2 群ID
2322
- 返回:code:
2323
- 100011013:服务异常 100011015:非群成员 100011016:公告存在 100011017:公告不存在
2324
- 4.分页获取群公告列表
2325
- 场景:客户端群成员查看群公告列表信息
2326
- 传入参数:aphead.GroupAnnouncementParam announceQueryParam
2327
- 返回:code:
2328
- 100011011:成功 100011013:服务异常 100011015:非群成员
2329
- list<aphead.GroupAnnouncement> announceList 群公告列表
2330
- 5.设置群禁言
2331
- 场景:客户端群管理员/群主设置群禁言
2332
- 传入参数:aphead.GroupForbid groupForbid
2333
- 返回:code:
2334
- 0: 成功 100011022:没有权限禁言群/群成员 100011023:禁言对象不是群成员
2335
- */
2336
- struct GroupParam {
2337
- 1: optional byte type
2338
- 2: optional i64 value64_1
2339
- 3: optional i64 value64_2
2340
- 4: optional aphead.GroupAnnouncement groupAnnounce
2341
- 5: optional aphead.GroupAnnouncementParam announceQueryParam
2342
- 6: optional aphead.GroupForbid groupForbid
2343
- }
2344
-
2345
- struct GroupRet {
2346
- 1: i32 code
2347
- 2: optional string what
2348
- 3: optional list<aphead.GroupAnnouncement> announceList
2349
- }
2350
-
2351
- /*
2352
- type 类型
2353
- 1.根据账户类型替换账户
2354
- 参数:userContact
2355
- 返回:code: 0表示替换成功,否则替换失败
2356
- 2.判定用户是否在SDK白名单中
2357
- 参数:无
2358
- 返回:code
2359
- 100004501 是sdk白名单用户
2360
- 100004502 不是sdk白名单用户
2361
- 3.根据userID和策略类型获取该用户的策略 (getUserTagStrategy)
2362
- 参数:
2363
- value64_1 要查询的用户id
2364
- type_2 策略类型
2365
- 返回:userTagStrategy 类型 aphead.UserTagStrategy
2366
- 4.用户账号注销校验/密码校验
2367
- 参数:
2368
- authenticationBean 类型:aphead.UserAuthenticationBean
2369
- 返回:
2370
- code 结果码
2371
- 100004500 成功,通过
2372
- 100004520 接口异常、失败
2373
- 100004521 用户不存在
2374
- 100004522 密码错误
2375
- 100004523 类型不合法
2376
- 100004527 禁止注销/禁止申请注销
2377
- 100004528 注销(type=1)/申请注销(type=2)对应注销配置项不匹配
2378
- 100004530 用户被锁定
2379
- message 结果码说明
2380
- value_str1 验证成功返回验证码,原先为authenticationCode(密码校验不返回)
2381
- 5.用户账号注销
2382
- 参数:
2383
- value_str1 注销用户认证码,原先为authenticationCode
2384
- 返回:
2385
- code 结果码
2386
- 100004500 成功,通过
2387
- 100004520 接口异常、失败
2388
- 100004521 用户不存在
2389
- 100004524 注销验证码验证失败
2390
- message 结果信息
2391
- 6.查询注销状态
2392
- 参数:无
2393
- 返回:
2394
- code结果码
2395
- 100004525 不存在待审核注销申请
2396
- 100004526 存在待审核注销申请
2397
- 7.取消注销申请
2398
- 参数:无
2399
- 返回:
2400
- code结果码
2401
- 100004500 成功,通过
2402
- 100004525 不存在待审核注销申请
2403
- 8.根据用户id查询管理员身份信息接口
2404
- 参数:
2405
-
2406
- 返回:
2407
- code 结果码 100004500成功 100004521 失败
2408
- message ,原先为msg
2409
- value_str1 即result:Json字符串格式返回结果{“adminName”:”陈鹏”,”adminAccount”:”chenpeng”,”superAdmin”:false}
2410
- adminName管理员名称
2411
- adminAccount管理员账号
2412
- superAdmin超管标识
2413
-
2414
- */
2415
- struct UserServiceParam {
2416
- 1: optional byte type
2417
- 2: optional aphead.UserContact userContact
2418
- 3: optional i64 value64_1
2419
- 4: optional byte type_2
2420
- 5: optional aphead.UserAuthenticationBean authenticationBean
2421
- 6: optional string value_str1
2422
- }
2423
-
2424
- struct UserServiceRet {
2425
- 1: i32 code
2426
- 2: optional string what
2427
- 3: optional aphead.UserTagStrategy userTagStrategy
2428
- 4: optional string message
2429
- 5: optional string value_str1
2430
2185
  }
2431
2186
 
2432
2187
  /////////////////////////////////////////
@@ -2483,6 +2238,28 @@ struct OauthRet {
2483
2238
  4: optional string value_str
2484
2239
  }
2485
2240
 
2241
+
2242
+ /*
2243
+ type 类型
2244
+ 1,保存群文件
2245
+ 传入参数:groupFile
2246
+ 返回:code:
2247
+ 0:成功
2248
+ 343:用户ID无效/用户不存在
2249
+ 307:该群不存在
2250
+ 309:该用户不是群成员
2251
+
2252
+ */
2253
+ struct GroupFileParam {
2254
+ 1: optional byte type
2255
+ 2: optional aphead.GroupFile groupFile
2256
+ }
2257
+
2258
+ struct GroupFileRet {
2259
+ 1: i32 code
2260
+ 2: optional string what
2261
+ }
2262
+
2486
2263
  /**
2487
2264
  * 二维码扫描结果集
2488
2265
  * 0 扫码/登录成功
@@ -2500,48 +2277,153 @@ struct QrCodeRet {
2500
2277
  }
2501
2278
 
2502
2279
  /*
2503
- type 类型 (type 2~5 被双因子项目占用,6以后的参数都需要markSign 来获取sdkId)
2504
- 1.第三方登录的前置步骤 (doLoginPre)
2280
+ type 类型
2281
+ 1.添加群公告
2282
+ 场景:客户端群管理员/群主添加群公告
2283
+ 传入参数:aphead.GroupAnnouncement groupAnnounce
2284
+ 返回:code:
2285
+ 100011011:成功 100011012:失败 100011013:服务异常 100011014:非群管理员、群主无权操作
2286
+ 2.删除单个群公告
2287
+ 场景:客户端群管理员/群主删除群公告
2288
+ 传入参数:value64_1 群公告ID
2289
+ value64_2 群ID
2290
+ 返回:code:
2291
+ 100011011:成功 100011012:失败 100011013:服务异常 100011014:非群管理员、群主无权操作
2292
+ 3.校验群公告是否存在
2293
+ 场景:客户端群成员查看群公告消息判断公告是否还存在
2294
+ 传入参数:value64_1 群公告ID
2295
+ value64_2 群ID
2296
+ 返回:code:
2297
+ 100011013:服务异常 100011015:非群成员 100011016:公告存在 100011017:公告不存在
2298
+ 4.分页获取群公告列表
2299
+ 场景:客户端群成员查看群公告列表信息
2300
+ 传入参数:aphead.GroupAnnouncementParam announceQueryParam
2301
+ 返回:code:
2302
+ 100011011:成功 100011013:服务异常 100011015:非群成员
2303
+ list<aphead.GroupAnnouncement> announceList 群公告列表
2304
+ 5.设置群禁言
2305
+ 场景:客户端群管理员/群主设置群禁言
2306
+ 传入参数:aphead.GroupForbid groupForbid
2307
+ 返回:code:
2308
+ 0: 成功 100011022:没有权限禁言群/群成员 100011023:禁言对象不是群成员
2309
+ */
2310
+ struct GroupParam {
2311
+ 1: optional byte type
2312
+ 2: optional i64 value64_1
2313
+ 3: optional i64 value64_2
2314
+ 4: optional aphead.GroupAnnouncement groupAnnounce
2315
+ 5: optional aphead.GroupAnnouncementParam announceQueryParam
2316
+ 6: optional aphead.GroupForbid groupForbid
2317
+ }
2318
+
2319
+ struct GroupRet {
2320
+ 1: i32 code
2321
+ 2: optional string what
2322
+ 3: optional list<aphead.GroupAnnouncement> announceList
2323
+ }
2324
+
2325
+ /*
2326
+ type 类型
2327
+ 1.判断当前用户是否为客服(isCustomer)
2328
+ 场景:客户端登录时触发
2329
+ 传入参数:无
2330
+ 返回:code:
2331
+ 100023002:成功 11100:服务异常 100:参数错误
2332
+ value_bool:
2333
+ true为是,false为否
2334
+ 2.获取客服正在服务的用户列表(getUserByAppIdAndCustomId)
2335
+ 场景:客户端点击公众号时触发
2336
+ 传入参数:value64_1 公众号appID
2337
+ 返回:code:
2338
+ 100023002:成功 11100:服务异常 100:参数错误
2339
+ smallUserBeans:
2340
+ 用户列表
2341
+ 3.获取客户池列表(getCustomerPoolByAppID)
2342
+ 场景:客户端点击客户池时触发
2343
+ 传入参数:value64_1 公众号appID
2344
+ 返回:code:
2345
+ 100023002:成功 11100:服务异常 100:参数错误
2346
+ customerPoolBeans:
2347
+ 等待客户的集合
2348
+ 4.关闭会话(closeConversation)
2349
+ 场景:客户端点击关闭会话时触发
2350
+ 传入参数:value64_1:客服ID(非客服用户的userID) value64_2:客户的userID
2351
+ 返回:code:
2352
+ 100023002操作成功 100023008当前客服未接待该用户 100023009客服不存在 100023001服务异常 11100:java服务异常 100:参数错误
2353
+ 5.接入客户(accessCustom)
2354
+ 场景:客户端点击客户池接入客户时触发
2355
+ 传入参数:value64_1:客服ID(非客服用户的userID) value64_2:客户的userID
2356
+ 返回:code:
2357
+ 100023002:成功 100023003:操作失败 11100:服务异常 100:参数错误 100023010:客服与客户是同一人,不能接入
2358
+ 6.获取最后一条消息(getLastMessage)
2359
+ 场景:客户端点击新接入的客户时触发
2360
+ 传入参数:value64_1:客服ID(非客服用户的userID) value64_2:客户的userID
2361
+ 返回:code:
2362
+ 100023002:成功 11100:服务异常 100:参数错误
2363
+ messageBean:
2364
+ 最后一条消息
2365
+ 7.获取客户池大小(getCustomPoolCount)
2366
+ 传入参数:value64_1 公众号appID
2367
+ 返回:code:
2368
+ 100023002:成功 11100:服务异常 100:参数错误
2369
+ value64:
2370
+ 客户池数量
2371
+ 8.修改客服信息(updateCustomerService)
2372
+ 场景: 用于修改客服信息
2373
+ 传入参数:value64_1 公众号appID
2374
+ value64_2 客服id(SmallEntAppInfo中的CSID字段)
2375
+ value8 客服接待状态 1:客服在线(可接待用户),2:客服离线(不可接待用户)
2376
+ value32 当前最大可接待数
2377
+ 返回:code:
2378
+ 100023002:成功 100023003:操作失败 11100:服务异常 100:参数错误
2379
+ 9.获取客服公众号信息集合(getAppListByUserID)
2380
+ 场景: 客户端 客服展示列表
2381
+ 传入参数:无
2382
+ 返回:code:
2383
+ 100023002:成功 11100:服务异常 100:参数错误
2384
+ smallApps:
2385
+ 客服公众号信息集合
2386
+ 10.查询单个客服信息(getCustomerServiceById)
2387
+ 场景: 公众服务平台客服管理
2388
+ 传入参数:value64_1 客服id(CSID)
2389
+ 返回:code:
2390
+ 100023002:成功 11100:服务异常 100:参数错误
2391
+ AppCustomerInfo:
2392
+ 客服信息
2393
+ */
2394
+ struct CustomerParam {
2395
+ 1: optional byte type
2396
+ 2: optional i64 value64_1
2397
+ 3: optional i64 value64_2
2398
+ 4: optional byte value8
2399
+ 5: optional i32 value32
2400
+ }
2401
+
2402
+ struct CustomerRet {
2403
+ 1: i32 code
2404
+ 2: optional string what
2405
+ 3: optional bool value_bool
2406
+ 4: optional i64 value64
2407
+ 5: optional list<aphead.SmallUserBean> smallUserBeans
2408
+ 6: optional list<aphead.CustomerPoolBean> customerPoolBeans
2409
+ 7: optional aphead.MessageBean messageBean
2410
+ 8: optional list<aphead.SmallEntAppInfo> smallApps
2411
+ 9: optional aphead.AppCustomerServiceInfo AppCustomerInfo
2412
+ }
2413
+
2414
+ /*
2415
+ type 类型
2416
+ 1.第三方登录的前置步骤
2505
2417
  参数: value_str_1 方法名
2506
2418
  value_str_2 透传的json参数
2507
2419
  返回: code:透传的错误码
2508
2420
  what:错误信息
2509
2421
  value_str: 返回的json结果
2510
- 6.获取二维码信息 (getPCLoginQrCode)
2511
- 参数: value_str_1 服务器elogo
2512
- value_str_2 PC端登录信息
2513
- markSign markSign
2514
- 返回: code:透传的错误码
2515
- what:错误信息
2516
- value_str: 二维码数据(JSON)
2517
- 7.获取二维码登录结果 (getPCLoginQrCodeStatus)
2518
- 参数: value_str_1 二维码唯一id
2519
- value_str_2 二维码唯一id加密值
2520
- markSign markSign
2521
- 返回: code:透传的错误码
2522
- what:错误信息
2523
- value_str: 二维码数据(JSON)
2524
- 8.校验最后一次PC扫码登录设备接口 (checkRecentQcLoginDevice)
2525
- 参数: value64_1 用户id
2526
- value_str_1 macCode
2527
- markSign markSign
2528
- 返回: code:透传的错误码
2529
- what:错误信息
2530
- 9.PC端快速登录接口 (pcQuickLogin)
2531
- 参数: value64_1 用户id
2532
- value_str_1 PC端登录信息
2533
- markSign markSign
2534
- 返回: code:透传的错误码
2535
- what:错误信息
2536
- value_str: 用户信息数据(JSON)
2537
-
2538
2422
  */
2539
2423
  struct BeforeLoginParam {
2540
2424
  1: optional byte type
2541
2425
  2: optional string value_str_1
2542
2426
  3: optional string value_str_2
2543
- 4: optional string markSign
2544
- 5: optional i64 value64_1
2545
2427
  }
2546
2428
 
2547
2429
  struct BeforeLoginRet {
@@ -2555,9 +2437,9 @@ type 类型
2555
2437
  1.设备下线
2556
2438
  参数:value8 要下线的设备类型 1:PC;2:手机;3:pad;4:网页
2557
2439
  返回:code:
2558
- 0 成功
2559
- 100 参数错误
2560
- 100008003 失败
2440
+ 0 成功
2441
+ 100 参数错误
2442
+ 100008003 失败
2561
2443
  what:错误信息
2562
2444
  2.用户信息字段验证
2563
2445
  参数:accountType 用户账号信息
@@ -2575,27 +2457,6 @@ type 类型
2575
2457
  返回:code:
2576
2458
  100008007 删除登录设备列表失败
2577
2459
  100008008 删除登录设备列表成功
2578
- 5.移动端扫PC端登录二维码接口 (scanPCLoginQrCode)
2579
- 参数: value_str 服务器elogo
2580
- value_str2 二维码唯一id
2581
- 返回:code: 透传的错误码
2582
- what:错误信息
2583
- value_str: 二维码数据(JSON)
2584
- 6.移动端扫PC端登录二维码确认接口 (scanPCLoginQrCodeConfirm)
2585
- 参数: value_str 二维码唯一id
2586
- value8 是否确认登录(1: 确认登录 2:取消登录)
2587
- 返回:code: 透传的错误码
2588
- what:错误信息
2589
- value_str: 二维码数据(JSON)
2590
- 7.根据用户ID集合查询用户的设备信息,豆豆版本
2591
- 参数:userIDs 用户的userID集合
2592
- 返回:code:错误码
2593
- 100008023 成功
2594
- 100008024 查询人数超过500人
2595
- 100008025 查询异常
2596
- 100008026 用户ID集合为空
2597
- what:结果信息
2598
- resultLoginRecord:返回结果集
2599
2460
  */
2600
2461
  struct LoginSParam {
2601
2462
  1: optional byte type
@@ -2603,17 +2464,14 @@ struct LoginSParam {
2603
2464
  3: optional aphead.AccountType accountType
2604
2465
  4: optional string value_str
2605
2466
  5: optional list<string> macAddrs
2606
- 6: optional string value_str2
2607
- 7: optional list<i64> userIDs
2608
2467
  }
2609
2468
 
2610
2469
  struct LoginSRet {
2611
- 1: i32 code
2612
- 2: string what
2613
- 3: optional list<aphead.LoginRecord> loginRecordList
2614
- 4: optional string value_str
2615
- 5: optional map<i64, list<aphead.LoginClientRecord> > resultLoginRecord
2470
+ 1: i32 code
2471
+ 2: string what
2472
+ 3: optional list<aphead.LoginRecord> loginRecordList
2616
2473
  }
2474
+
2617
2475
  /*
2618
2476
  type 类型
2619
2477
  1 添加/编辑会话设置接口
@@ -2625,15 +2483,16 @@ type 类型
2625
2483
  100009502 操作失败
2626
2484
  what:错误信息
2627
2485
  2 获取会话设置
2628
- 参数:
2486
+ 参数:value64_1:userID
2629
2487
  返回:sessionList 会话列表
2630
2488
  code:
2631
2489
  100 参数错误
2632
2490
  11100 服务异常
2633
2491
  100009501 操作成功
2634
2492
 
2493
+
2635
2494
  3 获取用户的会话列表
2636
- 参数:
2495
+ 参数:value64_1:userID
2637
2496
  返回:sessionList 会话列表
2638
2497
  code:
2639
2498
  100 参数错误
@@ -2653,155 +2512,12 @@ struct ChatRet {
2653
2512
  3: optional list<aphead.SessionInfo> sessionList
2654
2513
  }
2655
2514
 
2656
- struct SecRet {
2657
- 1: i32 code // 错误码 0:成功 11100 服务异常
2658
- 2: string what // 错误描述
2659
- 3: optional i64 ts // 当前返回给客户端的密级中的涉密关键字列表中最大的 游标(时间戳)
2660
- 4: optional list<aphead.SecKeyWord> secList// 涉密关键字列表
2661
- 5: optional i64 maxTs // 最大涉密关键字id
2662
- }
2663
-
2664
- /////////////////////////////////////////////
2665
- /*
2666
- type 类型
2667
- 1, 单个查询表情
2668
- 传入参数:value_str_1 # 表情文件的md5Code
2669
- 返回:
2670
- code: 0:成功,100:参数错误,11100:内部错误
2671
- listEmotion: list<aphead.Emoticon> listEmotion
2672
- 2,单个查询表情包
2673
- 传入参数:value_str_1 # 表情包文件的md5Code
2674
- 返回:
2675
- code: 0:成功,100:参数错误,11100:内部错误
2676
- emotPkg: aphead.EmoticonPackage
2677
-
2678
- 3,分页查询表情包
2679
- 传入参数:page #填入 pageNum,pageSize
2680
- 返回:
2681
- code: 0:成功,100:参数错误,11100:内部错误
2682
- page: aphead.EmoticonPackagePage
2683
- 4,添加自定义表情
2684
- 传入参数 emoticon, currenttimestamp
2685
- 返回:
2686
- code: 0:成功,100:参数错误,801:md5Code不正确,802:md5Code文件已存在,11100:内部错误
2687
- result: aphead.EmoticonOPResult
2688
- 5,删除自定义表情
2689
- 传入参数 emoticon, currenttimestamp
2690
- 返回:
2691
- code: 0:成功,100:参数错误,801:md5Code不正确,11100:内部错误
2692
- result: aphead.EmoticonOPResult
2693
- 6,根据表情包标识查询所有表情
2694
- 传入参数:value_str_1 #表情文件的md5Code
2695
- 返回:
2696
- code: 0:成功,100:参数错误,11100:内部错误
2697
- listEmotion: list<aphead.Emoticon>
2698
- 7,查询用户所有自定义表情
2699
- 返回:
2700
- code: 0:成功,100:参数错误,11100:内部错误
2701
- listEmotion: list<aphead.Emoticon>
2702
- 8,根据表情包标签查询相关表情包集合
2703
- 传入参数: value_str_1 #表情包标签
2704
- 返回:
2705
- code: 0:成功,100:参数错误,11100:内部错误
2706
- listEmotPkg: list<aphead.EmoticonPackage>
2707
- 9. 根据sha256Hash查询表情
2708
- 传入参数 value_str_1 表示大图和小图的sha256hash
2709
- 返回:code 0 成功
2710
-    listEmotion 返回的表情
2711
- 10. 根据userid和本地表情时间戳,获取表情包的增量信息进行同步
2712
- type 10 currenttimestamp
2713
- 返回
2714
- result: aphead.EmoticonOPResult
2715
- 11. 排序表情包
2716
- 传入参数 emoticonList, currenttimestamp
2717
- aphead.EmoticonOPResult
2718
- code 0 成功 其他失败
2719
- 12. 批量导入自定义表情
2720
- 传入参数 emoticonList, currenttimestamp
2721
- aphead.EmoticonOPResult
2722
- code 0 成功 其他失败
2723
- 13. 批量删除用户收藏的表情包
2724
- 传入参数 emoticonList, currenttimestamp
2725
- 返回:
2726
- code: 0:成功,100:参数错误,11100:内部错误
2727
- result: aphead.EmoticonOPResult
2728
-
2729
- */
2730
-
2731
- struct EmotParam {
2732
- 1: optional byte type
2733
- 2: optional string value_str_1
2734
- 3: optional aphead.EmoticonPackagePage page
2735
- 4: optional aphead.Emoticon emoticon
2736
- 5: optional list<aphead.Emoticon> emoticonList
2737
- 6: optional i64 currenttimestamp
2738
- }
2739
-
2740
- struct EmotRet {
2741
- 1: i32 code
2742
- 2: optional string what
2743
- 3: optional aphead.EmoticonOPResult result
2744
- 4: optional aphead.EmoticonPackage emotPkg
2745
- 5: optional aphead.EmoticonPackagePage page
2746
- 6: optional list<aphead.Emoticon> listEmotion
2747
- 7: optional list<aphead.EmoticonPackage> listEmotPkg
2748
- }
2749
-
2750
- struct LoginBean {
2751
- /*账号、邮箱、手机号、QQ号、(湖北公安code)*/
2752
- 1: string loginAccount;
2753
- /*1:PC;2:手机;3:pad;4:网页*/
2754
- 2: byte deviceType;
2755
- /*接入点IP*/
2756
- 3: string ip;
2757
- /*接入点端口*/
2758
- 4: i32 port;
2759
- /*用户类型:1:手机号 2:第三方关联,3:邮箱,4:用户ID,99: SAML认证用户,6:豆豆号,7:使用自定义拓展字段来进行登陆, 8: 第三方授权登录 -1:传用户ID但票验证 100湖北公安auth登录*/
2760
- 5: byte userType;
2761
- /*mac地址*/
2762
- 6: string macCode;
2763
- /*设备信息*/
2764
- 7: string deviceInfo;
2765
- /*-1:离线,1:在线;2:隐身,3:忙碌,4:离开,5:请勿打扰,6:想聊天*/
2766
- 8: byte flag;
2767
- /* 客户端IP */
2768
- 9: optional string clientIP;
2769
- /* 是否已验证,true已验证(针对resSign=8|9的时候用) */
2770
- 10: optional bool verified;
2771
- 11: i64 SDKID;
2772
- /*auth回掉地址*/
2773
- 12:optional string redirectUri;
2774
- /*设备类型 品牌主要是推送用 0苹果 1 华为 2 google 3 中电科*/
2775
- 13:optional i32 deviceType2;
2776
- /*密码(华数传媒)*/
2777
- 14:optional string pwd;
2778
- /*客户端版本号*/
2779
- 15:optional string clientVersion;
2780
- /*用于传递三方认证所需参数(JSON格式)*/
2781
- 16:optional string thirdAuthParamJson;
2782
- }
2783
-
2784
- /**
2785
- * 用于getUserOnlineByLogin的结果
2786
- */
2787
- struct UserOnlineResult{
2788
- /*返回码*/
2789
- 1: i32 resultCode;
2790
- /*返回数据*/
2791
- 2: list<aphead.OnLineUserBean> onlineBeans;
2792
- }
2793
-
2794
-
2795
2515
  /* interface */
2796
2516
  service APService {
2797
2517
  /// 登陆接口
2798
2518
  /// macAddr,version字段必填
2799
2519
  LoginResult login_im(1: LoginParam param)
2800
2520
 
2801
- //校验用户/返回用户在线信息
2802
- UserOnlineResult getUserOnlineByLogin(1: LoginBean lb, 2: string pwd)
2803
-
2804
-
2805
2521
  /// 登陆验证,用于验证码的确认
2806
2522
  /// macaddr 字段必填,切应与login_im保持一致
2807
2523
  GetVerifyResult verifyImageForLogin_im(1: string user, 2: VerifyParam param)
@@ -2844,7 +2560,7 @@ service APService {
2844
2560
 
2845
2561
  /// 获取单个人的信息
2846
2562
  GetUserResult getUser(1: SessionTicket st, 2: i64 userID)
2847
-
2563
+
2848
2564
  ///根据客户端使用场景获取相应用户资料
2849
2565
  GetUserResult getUserInfo(1: SessionTicket st, 2: UserSence user)
2850
2566
 
@@ -3040,12 +2756,13 @@ service APService {
3040
2756
 
3041
2757
  // 只有code有值
3042
2758
  CommonDataResult viewBurnMessage(1:SessionTicket st, 2:i64 targetID, 3:i64 messageID)
3043
-
2759
+ //TODO删除
3044
2760
  //CommonDataResult reportPluginStatus(1: SessionTicket st, 2: PluginParam param)
3045
2761
 
3046
2762
  /// ios 通知使用
3047
2763
  // 需要设置 token 以及 reveiveType
3048
2764
  // 1 设置成功, 2 设置失败
2765
+ //TODO需要确认
3049
2766
  //CommonDataResult setupReceiveNotice(1: SessionTicket st, 2: IosNoticeInfo info)
3050
2767
 
3051
2768
  // 紧紧需要设置token
@@ -3059,7 +2776,7 @@ service APService {
3059
2776
 
3060
2777
  // 设置IOS token
3061
2778
  // code 有值
3062
- // 不再使用(2015-12-29),参考qOnlineS
2779
+ // TODO不再使用(2015-12-29),参考qOnlineS
3063
2780
  //CommonDataResult setIosDeviceToken(1:SessionTicket st, 2:string token)
3064
2781
 
3065
2782
  //设置token及appleID,zxq add @2015.12.30
@@ -3093,21 +2810,6 @@ service APService {
3093
2810
  // i64 字段可能有值
3094
2811
  CommonDataResult resetHiddenPWD(1:SessionTicket st, 2:string oldpwd, 3:string newpwd)
3095
2812
 
3096
- /*
3097
- 延时消息取消/立即发送接口
3098
- 参数:
3099
- messageID 消息ID
3100
- type 操作类型1 取消发送 2立即发送
3101
- 返回:
3102
- code 结果码
3103
- 0 成功
3104
- 100010054 入参不正确
3105
- 100010055 该延时消息不存在
3106
- 100010056 立即发送延时消息失败
3107
- message 结果码说明
3108
- */
3109
- CommonDataResult handleDelayMsgByType(1:SessionTicket st, 2:i64 messageID, 3:byte type);
3110
-
3111
2813
  /// 延迟消息
3112
2814
  // 删除延迟消息
3113
2815
  // code 有值
@@ -3129,18 +2831,18 @@ service APService {
3129
2831
  /// 绑定解绑账号
3130
2832
  // 如果需要短信或者邮箱验证的 请调用这个函数
3131
2833
  // 目前 仅仅 用来绑定 手机跟邮箱会用到
3132
- // 2016.5.6 废弃!不再使用!绑定接口改为 MultiOperateWithST
2834
+ // TODO 2016.5.6 废弃!不再使用!绑定接口改为 MultiOperateWithST
3133
2835
  //AuthenticationResult authenticationUserInfo(1: SessionTicket st, 2: AuthenticationParam param)
3134
2836
 
3135
2837
  // 如果获取到了验证码请调用下边的
3136
2838
  // code 有值
3137
- // 2016.5.6 废弃!不再使用!绑定接口改为 MultiOperateWithST
2839
+ // TODO2016.5.6 废弃!不再使用!绑定接口改为 MultiOperateWithST
3138
2840
  //CommonDataResult authenticationVerifyMessage(1: SessionTicket st, 2: AuthenticationServerCode aCode)
3139
2841
 
3140
2842
  // 下面这个函数目前用于
3141
2843
  // 1. 绑定账号 2. 解绑账号
3142
2844
  // i64 可能有值
3143
- // 2016.5.6 废弃!不再使用!绑定接口改为 MultiOperateWithST
2845
+ // TODO2016.5.6 废弃!不再使用!绑定接口改为 MultiOperateWithST
3144
2846
  //CommonDataResult userAccountOperation(1: SessionTicket st, 2: UserAccountOperate op)
3145
2847
 
3146
2848
 
@@ -3222,10 +2924,11 @@ service APService {
3222
2924
  // 清空黑名单
3223
2925
  CommonDataResult clearBlacklist(1:SessionTicket st);
3224
2926
 
3225
- /// TODO(2016-3-5) 该接口尚有疑问,暂时继续使用
2927
+ /// TODO需要确认 (2016-3-5) 该接口尚有疑问,暂时继续使用
3226
2928
  // 获取黑名单
3227
2929
  // i64 获取ID列表
3228
2930
  // 2015-8-25 该接口将来会被删除,请使用新的接口 get_list
2931
+ // 2018-6-19 get_list未开发,暂时保留
3229
2932
  CommonListResult getBlacklist(1:SessionTicket st);
3230
2933
 
3231
2934
 
@@ -3251,12 +2954,15 @@ service APService {
3251
2954
  CommonSettingServerResult getUserToTargetSwitch(1:SessionTicket st,2:i64 targetUserId,3:byte modeType );
3252
2955
 
3253
2956
  // 个人资料是否公开设置
3254
- //switchType: 开关类型
3255
- //1:生日 2:电话 3:邮件, value: 1:所有人可见 2:仅好友可见 3:仅自己可见,默认1
3256
- //4:好友验证方式, value: 1:需要验证信息,2:不允许任何人添加,3:允许任何人添加,默认1
3257
- //5:V标(好友,群)提醒模式, value: 1:表示始终有声音提醒,2:表示始终无声音提醒 3:不始终提醒,默认1
3258
- //6:@相关人提醒模式, value: 1:表示始终有声音提醒,2:表示始终无声音提醒 3:不始终提醒,默认1
3259
- //7:全局通知消息内容模式, value: 1:通知详情,2:通知源,隐藏内容 3:完全隐藏,默认2
2957
+ // 参数:switchType:开关类型 1:生日 2:电话 3:邮件, value:1:所有人可见 2:仅好友可见 3:仅自己可见
2958
+ //switchType:开关类型 4:好友验证方式,value:1:不允许任何人添加,2:需要验证信息,3:允许任何人添加
2959
+ /// 2016-1-28
2960
+ ///switchType: 开关类型
2961
+ ///1:生日 2:电话 3:邮件, value: 1:所有人可见 2:仅好友可见 3:仅自己可见,默认1
2962
+ ///4:好友验证方式, value: 1:需要验证信息,2:不允许任何人添加,3:允许任何人添加,默认1
2963
+ ///5:V标(好友,群)提醒模式, value: 1:表示始终有声音提醒,2:表示始终无声音提醒 3:不始终提醒,默认1
2964
+ ///6:@相关人提醒模式, value: 1:表示始终有声音提醒,2:表示始终无声音提醒 3:不始终提醒,默认1
2965
+ ///7:全局通知消息内容模式, value: 1:通知详情,2:通知源,隐藏内容 3:完全隐藏,默认2
3260
2966
 
3261
2967
  CommonDataResult setPersonDataSwitch(1:SessionTicket st, 2:aphead.PersonalDataSwitch personalDataSwitch);
3262
2968
 
@@ -3293,12 +2999,13 @@ service APService {
3293
2999
  //设置外部群通知已读
3294
3000
  // 通知ID列表
3295
3001
  CommonDataResult setOutsideGroupNoticeForRead(1: SessionTicket st, 2: list<i64> noticeIDs)
3296
- // 获取外部企业的文件服务器地址
3297
- //EnterpriseImagelResult getEnterpriseImages(1: SessionTicket st, 2: list<i64> orgids)
3002
+ // TODO需要删除,获取外部企业的文件服务器地址
3003
+ //TODO 2018-5-26标注删除,兼容SDK暂留
3004
+ EnterpriseImagelResult getEnterpriseImages(1: SessionTicket st, 2: list<i64> orgids)
3298
3005
 
3299
3006
  /// IOS 专用接口
3300
3007
  /// 设置未读消息数量
3301
- ///@2016.10.28 接口将废弃!!! 使用qIosNS 代替
3008
+ ///TODO@2016.10.28 接口将废弃!!! 使用qIosNS 代替
3302
3009
  //CommonDataResult setIosNotReadMsgCount(1: SessionTicket st, 2: i32 count)
3303
3010
 
3304
3011
  // 获取组织公开配置 根据时间戳同步数据
@@ -3313,8 +3020,7 @@ service APService {
3313
3020
  // 获取某个用户所在组织下可见的子组织和用户
3314
3021
  // 组织是直接子节点,用户是当前组织下用户
3315
3022
  // 参数:enterpriseID 企业ID orgID 用户所在组织ID
3316
- //get_visible_org_users对应的java接口是getVisibleOrgsUsers,这个接口增加了一个时间戳的参数
3317
- // 本接口准备废弃,但为了兼容老的客户端,该接口被调用时,在调用java接口时,时间戳传-1000,以告知java服务端是老版本客户端调用
3023
+ //TODO接口将废弃!!标注于20161201。使用qEnOS代替
3318
3024
  //OrgUserAndChildNodes get_visible_org_users(1: SessionTicket st, 2:i64 enterpriseID, 3:i64 orgID);
3319
3025
 
3320
3026
  // 添加黑名单或者白名单
@@ -3323,6 +3029,7 @@ service APService {
3323
3029
  // 从名单中移除
3324
3030
  CommonDataResult batch_remove_list(1:SessionTicket st, 2: SettingList settingList 3: list<i64> targetUserIDList)
3325
3031
  // 获取设置名单
3032
+ //这是未开发的接口,@2018-6-19 by zxq
3326
3033
  //CommonListResult get_list(1:SessionTicket st 2: SettingList settingList);
3327
3034
 
3328
3035
  // 根据条件查询企业用户列表
@@ -3389,7 +3096,7 @@ FuSRet qFuSS(1: SessionTicket st, 2: FuSSParam param)
3389
3096
  // query setting server
3390
3097
  // 1. 获取某个人的所有设置
3391
3098
 
3392
- SettingRet qSettingS(1: SessionTicket st, 2: SettingSParam param)
3099
+ ///SettingRet qSettingS(1: SessionTicket st, 2: SettingSParam param)
3393
3100
 
3394
3101
  //////////////////////////
3395
3102
  //1.根据查询条件查询出所有的拓展字段信息.
@@ -3441,6 +3148,8 @@ RegURet qRegUS(1:RegUParam param)
3441
3148
 
3442
3149
  ////////////////////////////////
3443
3150
  //1.调用声网服务
3151
+ //2.原生朋友圈
3152
+ //3.云盘
3444
3153
  JSONRet qJSONS(1: SessionTicket st, 2: JSONParam param)
3445
3154
 
3446
3155
  ////////////////////////////////
@@ -3457,6 +3166,7 @@ RecommendRet qRecommendS(1: SessionTicket st, 2: RecommendParam param)
3457
3166
 
3458
3167
  ////////////////////////////////
3459
3168
  //1.上传消息记数
3169
+ //TODO 可能删除
3460
3170
  //MdmRet qMdmS(1: SessionTicket st, 2:MdmParam param)
3461
3171
 
3462
3172
  ////////////////////////////////
@@ -3467,7 +3177,7 @@ EnORet qEnOS(1: SessionTicket st, 2:EnOParam param)
3467
3177
 
3468
3178
  //******************************linkdood内部跳转应用获取授权码****************************
3469
3179
  //返回创建临时Code,调用platform接口存储Code和UserID关系
3470
- //返回临时Code
3180
+ //TODO删除返回临时Code
3471
3181
  CommonDataResult getLoginAuthCode(1: SessionTicket st, 2: aphead.LoginAuthParam loginAuthParam)
3472
3182
 
3473
3183
  MsgStoreRet qMsgStoreS(1: SessionTicket st, 2: MsgStoreParam param)
@@ -3478,6 +3188,15 @@ VerifyCodeRet qVerifyCodeS(1: SessionTicket st, 2: VerifyCodeParam param)
3478
3188
  //1.查询有时间戳更新的群聊表信息
3479
3189
  GroupMemRet qGroupMemS(1: SessionTicket st, 2: GroupMemParam param)
3480
3190
 
3191
+ //1.新增收藏信息
3192
+ //2.删除收藏信息
3193
+ //3.获取收藏信息
3194
+ //4.分页查询收藏列表信息
3195
+ CollectionRet qCollectionS(1: SessionTicket st, 2: CollectionParam param);
3196
+
3197
+ //1.提交意见反馈
3198
+ FeedBackRet qFeedBackS(1: SessionTicket st, 2: FeedBackParam param);
3199
+
3481
3200
  //1.清除缓存
3482
3201
  //2.设置缓存
3483
3202
  //3.获取缓存
@@ -3485,34 +3204,20 @@ CacheRet qCacheS(1: SessionTicket st, 2: CacheParam param)
3485
3204
  //消息盒子改造后的接口
3486
3205
  VerifyMessageRet qVerifyMessageS(1: SessionTicket st, 2: VerifyMessageParam param);
3487
3206
 
3488
- //注册和登录获取验证码
3489
- GetVerifyCodeResult getVerifyCode(1: GetVerifyCodeParam param);
3490
3207
 
3491
3208
  // 增量返回敏感词
3492
3209
  BadWordRet getBadWords(1: SessionTicket st, 2: i64 ct);
3493
3210
 
3494
- //1.提交意见反馈
3495
- FeedBackRet qFeedBackS(1: SessionTicket st, 2: FeedBackParam param);
3496
-
3497
- //收藏服务接口
3498
- CollectionRet qCollectionS(1: SessionTicket st, 2: CollectionParam param);
3499
-
3500
- //群公告相关接口
3501
- GroupRet qGroupS(1: SessionTicket st, 2: GroupParam param)
3211
+ //注册和登录获取验证码
3212
+ GetVerifyCodeResult getVerifyCode(1: GetVerifyCodeParam param);
3502
3213
 
3503
3214
  //1.根据账户类型替换账户
3215
+ //2.判定用户是否在SDK白名单中
3504
3216
  UserServiceRet qUserS(1: SessionTicket st, 2: UserServiceParam param);
3505
3217
 
3506
3218
  OauthRet qOauthS(1: SessionTicket st, 2: OauthParam param);
3507
3219
 
3508
- //以后所有不需要参数SessionTicket的接口都走这个
3509
- BeforeLoginRet qBeforeLoginS(1: BeforeLoginParam param);
3510
-
3511
- //1.设备下线
3512
- LoginSRet qLoginS(1: SessionTicket st, 2: LoginSParam param);
3513
-
3514
- //会话列表同步
3515
- ChatRet qChatS(1: SessionTicket st, 2:ChatParam param);
3220
+ GroupFileRet qGroupFileS(1: SessionTicket st, 2: GroupFileParam param);
3516
3221
 
3517
3222
  //客户端扫码成功接口
3518
3223
  //@param qId 二维码唯一标识ID userId 用户唯一标识ID serverUrl 服务器地址
@@ -3522,6 +3227,19 @@ QrCodeRet scanSuccess (1: SessionTicket st, 2:i64 qId,3:i64 userId, 4:string ser
3522
3227
  //@param qId 二维码唯一标识ID userId 用户唯一标识ID serverUrl 服务器地址
3523
3228
  QrCodeRet qCodeLogin (1: SessionTicket st, 2:i64 qId,3:i64 userId, 4:string serverUrl);
3524
3229
 
3525
- // 获取密信版本的涉密关键字
3526
- SecRet getSecurityKeyWord(1: SessionTicket st, 2: i64 ct)
3230
+ //群公告相关接口
3231
+ GroupRet qGroupS(1: SessionTicket st, 2: GroupParam param)
3232
+
3233
+ //客户服务相关接口
3234
+ CustomerRet qCustomerS(1: SessionTicket st, 2: CustomerParam param)
3235
+
3236
+ //以后所有不需要参数SessionTicket的接口都走这个
3237
+ BeforeLoginRet qBeforeLoginS(1: BeforeLoginParam param)
3238
+
3239
+ //1.设备下线
3240
+ LoginSRet qLoginS(1: SessionTicket st, 2: LoginSParam param);
3241
+
3242
+ //会话列表同步
3243
+ ChatRet qChatS(1: SessionTicket st, 2:ChatParam param);
3244
+
3527
3245
  }