Beachte: Die Hilfe-Seiten durchlaufen gerade eine vollständige Überarbeitung.

Proxer API/v1/Chat

Beachte bitte: Diese Klasse ist in Entwicklung. Die Schnittstellen könnten sich ändern.
Get Room Info
Beschreibung Gibt Informationen zu einem bestimmten Chatraum zurück.
Link https://proxer.me/api/v1/chat/roominfo
Level Level 0
Eingabe Parameter (GET oder POST):
  • room_id: Die ID des Chatraums.
  • Ausgabe
    • error: 0 oder 1
    • message: Statusmitteilung.
    • data (optional):Informationen zum Chat. Das Objekt enthält folgende Spalten:
      • id: ID des Raumes
      • name: Name des Raumes.
      • topic: Thema des Raumes.
      • flag_readonly: 0 oder 1. Falls 1 ist dieser Raum ohne Schreibzugriff.
      • flag_disabled: 0 oder 1. Falls 1 wird dieser Raum nicht mehr in der Raumübersicht angezeigt.
    Codes
  • 3031: Ungültiger Raum.

  • Get Room Users
    Beschreibung Gibt eine Liste der aktiven Benutzer eines bestimmten Chatraumes zurück.
    Link https://proxer.me/api/v1/chat/roomusers
    Level Level 0
    Eingabe Parameter (GET oder POST):
  • room_id: Die ID des Chatraums.
  • Ausgabe
    • error: 0 oder 1
    • message: Statusmitteilung.
    • data: Ein Array. Enthält folgende Spalten:
      • uid: Benutzer-ID
      • username: Benutzername.
      • avatar: Avatar des Benutzers.
      • status: Statusmitteilung des Benutzers.
      • mod: 0 oder 1. Falls 1 ist dieser Benutzer ein Moderator und kann hervorgehoben werden.
    Codes
    Get Public Rooms
    Beschreibung Gibt die Liste aller öffentlicher Chaträume zurück.
    Link https://proxer.me/api/v1/chat/publicrooms
    Level Level 0
    Eingabe -
    Ausgabe
    • error: 0
    • message: Statusmitteilung.
    • data: Die Liste der Chaträume. Enthält folgende Spalten:
      • id: ID des Raumes.
      • name: Name des Raumes.
      • topic: Thema des Raumes.
      • flag_readonly: 0 oder 1. Falls 1 ist dieser Raum ohne Schreibzugriff.
      • flag_disabled: 0 oder 1. Falls 1 wird dieser Raum nicht mehr in der Raumübersicht angezeigt.
    Codes

    Get My Rooms
    Beschreibung Gibt die Liste aller Chaträume zurück, in der der aktuelle Benutzer aktiv war.
    Link https://proxer.me/api/v1/chat/myrooms
    Level Level 0
    Eingabe -
    Ausgabe
    • error: 0
    • message: Statusmitteilung.
    • data: Die Liste der Chaträume. Enthält folgende Spalten:
      • id: ID des Raumes.
      • name: Name des Raumes.
      • topic: Thema des Raumes.
      • flag_readonly: 0 oder 1. Falls 1 ist dieser Raum ohne Schreibzugriff.
      • flag_disabled: 0 oder 1. Falls 1 wird dieser Raum nicht mehr in der Raumübersicht angezeigt.
    Codes
  • 3034: Nicht eingeloggt.
  • Get Messages
    Beschreibung Gibt die historischen Nachrichten eines Raumes zurück.
    Link https://proxer.me/api/v1/chat/messages
    Level Level 0
    Eingabe
    • room_id: Die ID des Raumes.
    • message_id: Die ID der Nachricht, ab der zurückgegeben werden soll. Es werden pro Aufruf 50 Nachrichten zurückgegeben. Ist die ID 0, so werden einfach die letzten 50 Nachrichten zurückgegeben.
    Ausgabe
    • 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.
      • fromid: Benutzer-ID des Verfassers.
      • username: Der Benutzername des Verfassers.
      • avatar: Avatar des Verfassers
      • message: Die Nachricht.
      • action: Eine bestimmte Aktion. Eine Aktion kann folgendes sein:
        • removeMessage: In diesem Falle entspricht das Feld "message" der Nachrichten-ID, die aus dem Chat unmittelbar nach Empfang dieser Action gelöscht werden soll.
      • timestamp: Der Zeitstempel einer Nachricht.
    Codes
  • 3031: Ungültiger Raum.

  • Get New Messages
    Beschreibung Gibt die neuen Nachrichten eines Raumes zurück.
    Link https://proxer.me/api/v1/chat/newmessages
    Level Level 0
    Eingabe
    • room_id: Die ID des Raumes.
    • message_id: Die ID der letzten Nachricht des Raumes.
    Ausgabe
    • 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.
      • fromid: Benutzer-ID des Verfassers.
      • username: Der Benutzername des Verfassers.
      • avatar: Avatar des Verfassers
      • message: Die Nachricht.
      • action: Eine bestimmte Aktion. Eine Aktion kann folgendes sein:
        • removeMessage: In diesem Falle entspricht das Feld "message" der Nachrichten-ID, die aus dem Chat unmittelbar nach Empfang dieser Action gelöscht werden soll.
      • timestamp: Der Zeitstempel einer Nachricht.
    Codes
  • 3031: Ungültiger Raum.
  • New Message
    Beschreibung Schnittstelle zum Versenden einer neuen Nachricht in einen Raum.
    Link https://proxer.me/api/v1/chat/newmessage
    Level Level 1
    Eingabe Parameter (GET oder POST):
    • room_id: Die ID des Raumes.
    • message: Die Nachricht, die versendet werden soll. Ein String.
    Ausgabe
    • error: 0 oder 1.
    • message: Eine Stautsmitteilung.
    • data (optional): Die ID der neu erstellten Nachricht.
    Codes
    • 3031: Ungültiger Raum.
    • 3034: Du bist nicht eingeloggt.
    • 3055: Du musst mindestens 7 Tage angemeldet sein, damit du im Chat schreiben kannst.
    • 3056: Benutzer ist auf der Blacklist. Dieser wird aufgefordert, die Webseite zu besuchen um den Blacklist-Eintrag einzusehen.
    • 3057: Keine Berechtigung für diesen Raum (readonly).
    • 3059: Ungültige Texteingabe.
    Delete Message
    Beschreibung Löscht eine bestimmte Nachricht. Um diese Funktion nutzen zu können, müssen Teamrechte vorhanden sein.
    Link https://proxer.me/api/v1/chat/deletemessage
    Level Level 1
    Eingabe Parameter (GET oder POST):
  • message_id: Die ID der zu löschenden Nachricht. Die ID erhält man aus der "Get Message"-Schnittstelle.
  • Ausgabe
    • error: 0 oder 1.
    • message: Statusmitteilung.
    Codes
    • 3032: Keine Berechtigungen.
    • 3033: Ungültige message_id.

    Report Message
    Beschreibung Ermöglicht das Melden von Chat-Nachrichten.
    Link https://proxer.me/api/v1/chat/reportmessage
    Level Level 1
    Eingabe Parameter (GET oder POST):
    • message_id: Die ID der zu löschenden Nachricht. Die ID erhält man aus der "Get Message"-Schnittstelle.
    • message: Eine Nachricht als Text, um dem Moderator weitere Informationen mitzuteilen.
    Ausgabe
    • error: 0 oder 1.
    • message: Statusmitteilung.
    Codes
    • 3032: Keine Berechtigungen.
    • 3033: Ungültige Nachricht (message-id).
    • 3034: Nicht eingeloggt.
    • 3059: Ungültige Texteingabe.
    Thankyou Message
    Beschreibung Ermöglicht das Bedanken von Chat-Nachrichten.
    Link https://proxer.me/api/v1/chat/thankyoumessage
    Level Level 1
    Eingabe Parameter (GET oder POST):
    • message_id: Die ID der zu löschenden Nachricht. Die ID erhält man aus der "Get Message"-Schnittstelle.
    • message: Eine Nachricht als Text, um dem Moderator weitere Informationen mitzuteilen.
    Ausgabe
    • error: 0 oder 1.
    • message: Statusmitteilung.
    Codes
    • 3033: Ungültige Nachricht (message-id).
    • 3034: Nicht eingeloggt.
    • 3058: Es ist nicht möglich sich selbst zu danken.

    Kategorie:Proxer API‎