message_records.api 3.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113
  1. import "../base.api"
  2. type (
  3. // The response data of message records information | MessageRecords信息
  4. MessageRecordsInfo {
  5. BaseIDInfo
  6. // Status 1: normal 2: ban | 状态 1 正常 2 禁用
  7. Status *uint8 `json:"status,optional"`
  8. // 机器人微信 id
  9. BotWxid *string `json:"botWxid,optional"`
  10. // 联系人 id
  11. ContactId *uint64 `json:"contactId,optional"`
  12. // 类型:1好友,2群组,3企业微信联系人
  13. ContactType *int `json:"contactType,optional"`
  14. // 接收方微信 id
  15. ContactWxid *string `json:"contactWxid,optional"`
  16. // 内容类型 1 文本 2 文件
  17. ContentType *int `json:"contentType,optional"`
  18. // 发送内容
  19. Content *string `json:"content,optional"`
  20. // 元数据
  21. Meta *Meta `json:"meta,optional"`
  22. // 异常原因
  23. ErrorDetail *string `json:"errorDetail,optional"`
  24. // 发送时间
  25. SendTime *int64 `json:"sendTime,optional"`
  26. // 源类型 1 点发 2 群发 3 SOP
  27. SourceType *int `json:"sourceType,optional"`
  28. // 源 ID
  29. SourceId *uint64 `json:"sourceId,optional"`
  30. // 次源 ID
  31. SubSourceId *uint64 `json:"subSourceId,optional"`
  32. }
  33. // The response data of message records list | MessageRecords列表数据
  34. MessageRecordsListResp {
  35. BaseDataInfo
  36. // MessageRecords list data | MessageRecords列表数据
  37. Data MessageRecordsListInfo `json:"data"`
  38. }
  39. // MessageRecords list data | MessageRecords列表数据
  40. MessageRecordsListInfo {
  41. BaseListInfo
  42. // The API list data | MessageRecords列表数据
  43. Data []MessageRecordsInfo `json:"data"`
  44. }
  45. // Get message records list request params | MessageRecords列表请求参数
  46. MessageRecordsListReq {
  47. PageInfo
  48. // 机器人微信 id
  49. BotWxid *string `json:"botWxid,optional"`
  50. // 接收方微信 id
  51. ContactWxid *string `json:"contactWxid,optional"`
  52. // 发送内容
  53. Content *string `json:"content,optional"`
  54. }
  55. // MessageRecords information response | MessageRecords信息返回体
  56. MessageRecordsInfoResp {
  57. BaseDataInfo
  58. // MessageRecords information | MessageRecords数据
  59. Data MessageRecordsInfo `json:"data"`
  60. }
  61. )
  62. @server(
  63. jwt: Auth
  64. group: message_records
  65. middleware: Authority
  66. )
  67. service Wechat {
  68. // Create message records information | 创建MessageRecords
  69. @handler createMessageRecords
  70. post /message_records/create (MessageRecordsInfo) returns (BaseMsgResp)
  71. // Update message records information | 更新MessageRecords
  72. @handler updateMessageRecords
  73. post /message_records/update (MessageRecordsInfo) returns (BaseMsgResp)
  74. // Delete message records information | 删除MessageRecords信息
  75. @handler deleteMessageRecords
  76. post /message_records/delete (IDsReq) returns (BaseMsgResp)
  77. // Get message records list | 获取MessageRecords列表
  78. @handler getMessageRecordsList
  79. post /message_records/list (MessageRecordsListReq) returns (MessageRecordsListResp)
  80. // Get message records by ID | 通过ID获取MessageRecords
  81. @handler getMessageRecordsById
  82. post /message_records (IDReq) returns (MessageRecordsInfoResp)
  83. }