Beachte: Die Hilfe-Seiten durchlaufen gerade eine vollständige Überarbeitung. Es könnte ein paar Tage dauern, bis alles voll funktionsfähig ist (u.a. Bilder).

Proxer API/v1/Chat

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

__TOC__
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:
      • 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
    Beschreibung Gibt die Liste aller vorhandenen Chaträume zurück.
    Link https://proxer.me/api/v1/chat/rooms
    Level Level 0
    Eingabe -
    Ausgabe
    • 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
    Beschreibung Gibt die Nachrichten eines Raumes zurück.
    Link https://proxer.me/api/v1/chat/messages
    Level Level 0
    Eingabe
    • 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.
    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.
      • 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
    Beschreibung Schnittstelle zum Versenden einer neuen Nachricht in einen Raum.
    Link https://proxer.me/api/v1/chat/newmessage
    Level Level 0
    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.
    • 3033: Ungültige Nachricht.
    • 3034: Du bist nicht eingeloggt.

    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.

  • Ban User
    Beschreibung Verbannt einen Nutzer. Noch nicht implementiert.
    Link https://proxer.me/api/v1/chat/banuser
    Level Level 1
    Eingabe
    Ausgabe
    Codes

    Kategorie:Proxer API‎