Proxer API/v1/Chat

Aus Proxer.Me - Wiki
Wechseln zu: Navigation, Suche

Beachte bitte: Diese Klasse ist in Entwicklung. Die Schnittstellen könnten sich ändern.


Get Room Info

FunktionsnameGet Room Info
BeschreibungGibt Informationen zu einem bestimmten Chatraum zurück.
Anfragelinkhttps://proxer.me/api/v1/chat/roominfo
ZugriffslevelLevel 0
EingabeparameterParameter (GET oder POST):
  • room_id: Die ID des Chatraums.
Ausgabeparameter
  • error: 0 oder 1
  • message: Statusmitteilung.
  • data (optional):Informationen zum Chat. Das Objekt enthält folgende Spalten:
    • name: Name des Raumes.
    • users: Eine Liste mit den Benutzern, die gerade im Chat aktiv sind. Enthält folgende Spalten:
      • timestamp: Ein Zeitstempel, welches den Zeitpunkt des letzten Kontaktes angibt.
      • thankyou: Die Anzahl der "Danke", die ein bestimmter Nutzer erhalten hat.
      • username: Der Benutzername.
      • avatar: Der Avatar des Benutzers.
Codes
  • 3031: Ungültiger Raum.



Get Rooms

FunktionsnameGet Rooms
BeschreibungGibt die Liste aller vorhandenen Chaträume zurück.
Anfragelinkhttps://proxer.me/api/v1/chat/rooms
ZugriffslevelLevel 0
Eingabeparameter-
Ausgabeparameter
  • error: 0
  • message: Statusmitteilung.
  • data: Die Liste der Chaträume. Enthält folgende Spalten:
    • name: Name des Raumes.
    • count_online: Anzahl der aktiven Nutzer.
Codes



Get Messages

FunktionsnameGet Messages
BeschreibungGibt die Nachrichten eines Raumes zurück.
Anfragelinkhttps://proxer.me/api/v1/chat/messages
ZugriffslevelLevel 0
Eingabeparameter
  • room_id: Die ID des Raumes.
  • timestamp_start (optional): Eine Zeitstempel-Angabe, um startend von einem Zeitpunkt, die älteren Nachrichten anzuzeigen. Sollte verwendet werden, um die Chathistrie abzufragen.
  • timestamp_end (optional): Eine Zeitstempel-Angabe, um alle neuen Nachrichten ab einem Zeitpunkt anzuzeigen. Sollte verwendet werden, um neue Chatnachrichten abzufragen.
Ausgabeparameter
  • error: 0 oder 1.
  • message: Stautsmitteilung.
  • data (optional): Im Falle einer erfolgreichen Ausführung, wird eine Liste mit den gefundenen Nachrichten ausgegeben. Die Liste enthält folgende Spalten:
    • id: Die ID der Nachricht.
    • username: Der Benutzername des Nachrichten-Verfassers.
    • uid: Die ID des Nachrichten-Verfassers.
    • message: Die Nachricht.
    • timestamp: Der Zeitstempel einer Nachricht.
Codes
  • 3031: Ungültiger Raum.



New Message

FunktionsnameNew Message
BeschreibungSchnittstelle zum Versenden einer neuen Nachricht in einen Raum.
Anfragelinkhttps://proxer.me/api/v1/chat/newmessage
ZugriffslevelLevel 0
EingabeparameterParameter (GET oder POST):
  • room_id: Die ID des Raumes.
  • message: Die Nachricht, die versendet werden soll. Ein String.
Ausgabeparameter
  • error: 0 oder 1.
  • message: Eine Stautsmitteilung.
  • data (optional): Die ID der neu erstellten Nachricht.
Codes
  • 3031: Ungültiger Raum.
  • 3033: Ungültige Nachricht.
  • 3034: Du bist nicht eingeloggt.



Delete Message

FunktionsnameDelete Message
BeschreibungLöscht eine bestimmte Nachricht. Um diese Funktion nutzen zu können, müssen Teamrechte vorhanden sein.
Anfragelinkhttps://proxer.me/api/v1/chat/deletemessage
ZugriffslevelLevel 1
EingabeparameterParameter (GET oder POST):
  • message_id: Die ID der zu löschenden Nachricht. Die ID erhält man aus der "Get Message"-Schnittstelle.
Ausgabeparameter
  • error: 0 oder 1.
  • message: Statusmitteilung.
Codes
  • 3032: Keine Berechtigungen.



Ban User

FunktionsnameBan User
BeschreibungVerbannt einen Nutzer. Noch nicht implementiert.
Anfragelinkhttps://proxer.me/api/v1/chat/banuser
ZugriffslevelLevel 1
Eingabeparameter
Ausgabeparameter
Codes