application.api 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240
  1. syntax = "v1"
  2. type (
  3. Reply {
  4. Error_code int64 `json:"error_code"`
  5. Error_msg string `json:"error_msg"`
  6. Data interface{} `json:"data"`
  7. }
  8. InfoReply {
  9. Error_code int64 `json:"error_code"`
  10. Error_msg string `json:"error_msg"`
  11. Data interface{} `json:"data"`
  12. BatchEmploy int64 `json:"batchEmploy"`
  13. }
  14. ClueAddReq {
  15. AppId string `header:"appId,default=10000"`
  16. BaseUserId int64 `header:"newUserId"`
  17. PositionId int64 `header:"positionId,optional"`
  18. EntUserId int64 `header:"entUserId,optional"`
  19. EntId int64 `header:"entId,optional"`
  20. AccountId int64 `header:"accountId,optional"`
  21. EntDeptId int64 `header:"entDeptId,optional"`
  22. CluesSource string `json:"cluesSource"` //线索来源
  23. ClueName string `json:"clueName"` //线索名称
  24. Summary string `json:"summary"` //概要信息
  25. FollowUpTime int64 `json:"followUpTime,optional"` //下次跟进时间(时间戳)
  26. Types int64 `json:"types"` //处理方式 1自办;2转办;3待处理
  27. User []int64 `json:"user,optional"` //企业用户id
  28. EmployInfoId int64 `json:"employInfoId,optional"` //资讯收录id
  29. CreateName string `json:"createName"` //创建人
  30. Channel string `json:"channel"` //渠道来源:网页、手动创建
  31. }
  32. SaleChanceReq {
  33. AppId string `header:"appId,default=10000"`
  34. BaseUserId int64 `header:"newUserId"`
  35. PositionId int64 `header:"positionId,optional"`
  36. EntUserId int64 `header:"entUserId,optional"`
  37. EntId int64 `header:"entId,optional"`
  38. AccountId int64 `header:"accountId,optional"`
  39. EntDeptId int64 `header:"entDeptId,optional"`
  40. ChanceName string `json:"chanceName"` //机会名称
  41. Summary string `json:"summary"` //概要信息
  42. ChanceClassify int64 `json:"chanceClassify"` //机会分类
  43. ExpectedOrderTime int64 `json:"expectedOrderTime,optional"` //最初预计落单段时间 时间戳
  44. ExpectedMoney float64 `json:"expectedMoney,optional"` //最初预计落单金额
  45. CustomName string `json:"customName"` //客户全称
  46. BusinessType int64 `json:"businessType"` //业务类型 1新客户需求 2老客户需求 3简易项目流程
  47. Remarks string `json:"remarks,optional"` //备注
  48. NextfollowUpTime int64 `json:"nextfollowUpTime,optional"` //下次跟进时间戳
  49. Types int64 `json:"types"` //处理方式 1自办;2转办;3待处理
  50. User []int64 `json:"user,optional"` //企业用户id
  51. EmployInfoId int64 `json:"employInfoId,optional"` //资讯收录id
  52. CustomId int64 `json:"customId,optional"` //客户id
  53. CreateName string `json:"createName"` //创建人
  54. ChanceSource int64 `json:"chanceSource"` //机会来源
  55. }
  56. EmployOperateReq {
  57. AppId string `header:"appId,default=10000"`
  58. BaseUserId int64 `header:"newUserId"`
  59. PositionId int64 `header:"positionId,optional"`
  60. EntUserId int64 `header:"entUserId,optional"`
  61. EntId int64 `header:"entId,optional"`
  62. IdArr string `json:"idArr"` //信息id多条信息
  63. IsEmploy bool `json:"isEmploy"` //是否收录true收录 false取消收录
  64. EmployType int64 `json:"employType"` //来源方式来源;1招标采购、2企业、3采购单位、4拟在建项目
  65. EntDeptId int64 `header:"entDeptId,optional"`
  66. From string `json:"from,optional"` //来源
  67. }
  68. TransferReq {
  69. AppId string `header:"appId,default=10000"`
  70. BaseUserId int64 `header:"newUserId"`
  71. PositionId int64 `header:"positionId,optional"`
  72. EntUserId int64 `header:"entUserId,optional"`
  73. EntId int64 `header:"entId,optional"`
  74. EmplouIdArr []string `json:"emplouIdArr"`
  75. PositionIdArr []string `json:"positionIdArr"`
  76. }
  77. IgnoreOperateReq {
  78. AppId string `header:"appId,default=10000"`
  79. BaseUserId int64 `header:"newUserId"`
  80. PositionId int64 `header:"positionId,optional"`
  81. EntUserId int64 `header:"entUserId,optional"`
  82. EntId int64 `header:"entId,optional"`
  83. IdArr string `json:"idArr"` //id集合
  84. IsIgnore bool `json:"isIgnore"` //是否忽略 true 忽略 false取消忽略
  85. EmployType int64 `json:"employType"` //来源方式来源;1招标采购、2企业、3采购单位、4拟在建项目
  86. }
  87. InfoEmployinfoReq {
  88. AppId string `header:"appId,default=10000"`
  89. BaseUserId int64 `header:"newUserId"`
  90. PositionId int64 `header:"positionId,optional"`
  91. EntUserId int64 `header:"entUserId,optional"`
  92. EntId int64 `header:"entId,optional"`
  93. EmployType int64 `json:"employType"` //1标采购、2企业、3采购单位、4拟在建项目
  94. IdArr string `json:"idArr"` //id
  95. EntNicheDis int64 `header:"entNicheDis,optional"`
  96. EntDeptId int64 `header:"entDeptId,optional"`
  97. PositionType int64 `header:"positionType,optional"` //职位类型 0个人 1企业
  98. AccountId int64 `header:"accountId,optional"` //账户id
  99. EntAccountId int64 `header:"entAccountId,optional"` //企业账户id
  100. From string `json:"from,optional"` //来源
  101. }
  102. CustomAddReq {
  103. AppId string `header:"appId,default=10000"`
  104. BaseUserId int64 `header:"newUserId"`
  105. PositionId int64 `header:"positionId,optional"`
  106. EntUserId int64 `header:"entUserId,optional"`
  107. EntId int64 `header:"entId,optional"`
  108. AccountId int64 `header:"accountId,optional"`
  109. EntDeptId int64 `header:"entDeptId,optional"`
  110. CustomType int64 `json:"customType"` //客户类型
  111. Summary string `json:"summary"` //概要信息
  112. CustomAllName string `json:"customAllName"` //客户全称
  113. CustomAbbreviation string `json:"customAbbreviation"` //客户简称
  114. CustomLevel int64 `json:"customLevel,optional"` //客户级别
  115. CustomIndustry int64 `json:"customIndustry"` //客户行业
  116. CustomDetailIndustry int64 `json:"customDetailIndustry"` //客户细分行业
  117. Province string `json:"province,optional"` //省份
  118. City string `json:"city,optional"` //城市
  119. District string `json:"district,optional"` //地区
  120. Address string `json:"address,optional"` //详细地址
  121. CompanyPhone string `json:"companyPhone,optional"` //公司电话
  122. NextfollowUpTime int64 `json:"nextfollowUpTime,optional"` //下次跟进时间戳
  123. Types int64 `json:"types"` //处理方式 1自办;2转办
  124. User []int64 `json:"user,optional"` //转办用户
  125. EmployCustomId int64 `json:"employCustomId,optional,optional"` //客户收录id
  126. EmployInfoId int64 `json:"employInfoId,optional,optional"` //资讯收录id
  127. Remarks string `json:"remarks,optional"` //备注
  128. CreateName string `json:"createName"` //创建人
  129. Source string `json:"source,optional"` //来源
  130. }
  131. FileUploadReq {
  132. AppId string `header:"appId,default=10000"`
  133. BaseUserId int64 `header:"newUserId"`
  134. PositionId int64 `header:"positionId,optional"`
  135. EntUserId int64 `header:"entUserId,optional"`
  136. EntId int64 `header:"entId,optional"`
  137. BusinessId int64 `form:"businessId"` //业务id
  138. Types int64 `form:"type"` //类型;1:跟进记录-线下 2:跟进记录-线上 3:跟进记录-备忘 4:销售机会-项目文档 5:客户-客户档案
  139. FileType int64 `form:"fileType"` //文件类型,产品介绍、项目方案、立项报告、报价文件、招标文件、投标文件、中标通知书、合同、发票、其他文件
  140. }
  141. EmployDistributeReq {
  142. AppId string `header:"appId,default=10000"`
  143. BaseUserId int64 `header:"newUserId"`
  144. PositionId int64 `header:"positionId,optional"`
  145. EntUserId int64 `header:"entUserId,optional"`
  146. EntId int64 `header:"entId,optional"`
  147. EmployIdArr string `json:"employIdArr"`
  148. Person []DistributePerson `json:"person"`
  149. EntNicheDis int64 `header:"entNicheDis,optional"`
  150. EntDeptId int64 `header:"entDeptId,optional"`
  151. }
  152. DistributePerson {
  153. PositionId int64 `json:"positionId"`
  154. EntUserId int64 `json:"entUserId"`
  155. EntDeptId int64 `json:"entDeptId"`
  156. }
  157. EntInfoReq {
  158. EntName string `json:"entName"`
  159. }
  160. PushMsgReq {
  161. AppId string `header:"appId,default=10000"`
  162. BaseUserId int64 `header:"newUserId"`
  163. PositionId int64 `header:"positionId,optional"`
  164. EntUserId int64 `header:"entUserId,optional"`
  165. EntId int64 `header:"entId,optional"`
  166. Title string `json:"title"` //标题
  167. Content string `json:"content"` //内容
  168. PcHref string `json:"pcHref"` //pc跳转地址
  169. MobileHref string `json:"mobileHref"` //移动端跳转地址
  170. User []int64 `json:"user,optional"` //企业用户id
  171. MsgType string `json:"msgType"` //消息类型 1-活动优惠 2-服务通知 3-订阅消息 4-项目动态 5-企业动态 6-分析报告 7-系统通知 11-待办
  172. }
  173. CanAddReq {
  174. AppId string `header:"appId,default=10000"`
  175. BaseUserId int64 `header:"newUserId"`
  176. PositionId int64 `header:"positionId,optional"`
  177. EntUserId int64 `header:"entUserId,optional"`
  178. EntId int64 `header:"entId,optional"`
  179. AccountId int64 `header:"accountId,optional"`
  180. EntDeptId int64 `header:"entDeptId,optional"`
  181. EmployInfoId int64 `json:"employInfoId"` //资讯收录id
  182. EmployCustomId int64 `json:"employCustomId,optional"` //客户收录id
  183. Key string `json:"key"` //创建线索:more_create_clue 创建机会:more_create_chance 创建客户:more_create_custom
  184. }
  185. )
  186. @server (
  187. // 定义一个请求体限制在 100MB 以内的请求,goctl >= 1.5.0 版本支持 (默认1mb)
  188. maxBytes: 104857600
  189. )
  190. service crmApplication {
  191. @doc "添加线索"
  192. @handler clueAdd
  193. post /crmApplication/clue/add (ClueAddReq) returns (Reply)
  194. @doc "创建销售机会"
  195. @handler saleChanceAdd
  196. post /crmApplication/saleChance/add (SaleChanceReq) returns (Reply)
  197. @doc "收录操作"
  198. @handler employOperate
  199. post /crmApplication/employ/operate (EmployOperateReq) returns (Reply)
  200. @doc "商业资讯的转办"
  201. @handler transfer
  202. post /crmApplication/information/transfer (TransferReq) returns (Reply)
  203. @doc "忽略操作"
  204. @handler ignoreOperate
  205. post /crmApplication/ignore/operate (IgnoreOperateReq) returns (Reply)
  206. @doc "收录情况"
  207. @handler employInfo
  208. post /crmApplication/employ/info (InfoEmployinfoReq) returns (InfoReply)
  209. @doc "创建客户"
  210. @handler customAdd
  211. post /crmApplication/custom/add (CustomAddReq) returns (Reply)
  212. @doc "文件上传"
  213. @handler fileUpload
  214. post /crmApplication/file/upload (FileUploadReq) returns (Reply)
  215. @doc "分发"
  216. @handler employDistribute
  217. post /crmApplication/employ/distribute (EmployDistributeReq) returns (Reply)
  218. @doc "企业详情"
  219. @handler entinfo
  220. post /crmApplication/ent/info (EntInfoReq) returns (Reply)
  221. @doc "消息推送"
  222. @handler pushMsg
  223. post /crmApplication/info/push (PushMsgReq) returns (Reply)
  224. @doc "是否可以创建"
  225. @handler canAddReq
  226. post /crmApplication/info/canAdd (CanAddReq) returns (Reply)
  227. }