freechat/docs/content/endpoints/mesages.md
shockrah ba7b33ae62 Fixed broken links for messages endpoint description
 Should probably have a section for messages under structures
2021-03-04 13:21:09 -08:00

1.1 KiB

title anchor weight
Messages messages-ep 15

Messages

POST /message/send

  • Required permissions:

    • SEND_MESSAGES
  • Required query string parameters:

    • id: u64

    • jwt: String

    • channel_id: u64

    • type: String

      Valid values:

      • text
      • jpeg
      • png
      • webm
      • mp4
  • Required body:

    • Content itself should always go in the body
    • Empty bodies result in an HTTP 400 response
  • Returns:

    • None

GET /message/get_range

  • Required query string parameters:

    • id: u64

    • jwt: string

    • channel_id: u64

    • start_time: i64

      • Unix timestamp (seconds)
    • end_time: i64

      • Unix timestamp (seconds)
    • limit: Optional

      • Maximum = 1000
  • Returns

    • messages: Array

Example

	> GET /message/get_range?id=123&jwt=...

	< { "mesages": [...] }

GET /message/from_id

  • Required query string parameters:

    • id: u64

    • jwt: string

    • channel_id: u64

    • start: u64

    • limit: Optional

      • Maximum = 1000
  • Returns

    • messages: Array

Example

	> GET /message/from_id?id=123&jwt=...

	< { "mesages": [...] }