Proxer API/v1/Messenger

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

Der Proxer Messenger ist ein Nachrichtensystem, welches es ermöglichen soll, über verschiedene Plattformen hinweg, mit anderen Proxer-Nutzern Nachrichten auszutauschen. Die aktuelle Schnittstelle basiert auf polling. Es ist eine zusätzliche Schnittstelle, die auf push-Nachrichten und Sockets basiert, geplant.



Get Constants

FunktionsnameGet Constants
BeschreibungLiefert Messengerkonstanten. Bitte höchstens beim erstmaligen Start einer Anwendung durchführen. Diese Werte werden sich höchstens alle paar Monate mal ändern.
Anfragelinkhttps://proxer.me/api/v1/messenger/constants
ZugriffslevelLevel 0
Eingabeparameter-
Ausgabeparameter
  • error: 0
  • message: Statusmitteilung.
  • data: Array mit Konsten. Folgende Konstanten werden zurückgegeben:
    • textCount: Maximalanzahl an Zeichen pro Nachricht.
    • conferenceLimit: Anzahl der Elemente, die "Get Conferences" maximal pro Aufruf/pro Seite liefert.
    • messagesLimit: Anzahl der Elemente, die "Get Messages" maximal pro Aufruf/pro Seite liefert.
    • userLimit: Maximalanzahl an Benutzern pro Gruppenkonferenz.
    • topicCount: Maximalanzahl an Zeichen für Konferenzthema.
Codes



Get Conferences

FunktionsnameGet Conferences
BeschreibungLiefert eine Liste der aktuellen Konferenzen.
Anfragelinkhttps://proxer.me/api/v1/messenger/conferences
ZugriffslevelLevel 0
EingabeparameterParameter (GET oder POST):
  • type (optional): Gibt Konferenzen an, die eine bestimmte Markierung oder einen bestimmten Typ haben. Mögliche Werte:
    • favour: Favorisierte Konferenzen.
    • block: Blockierte Konferenzen.
    • group: Listet ausschließlich Gruppenkonferenzen auf.
    • default: Listet unblockierte Konferenzen.
  • p (optional): Die Seite der Konferenzen. Default ist 0.
Ausgabeparameter
  • error: 0 oder 1. 0 wenn die Abfrage erfolgreich war, ansonsten 1.
  • message: Statusmitteilung vom Server.
  • data (optional): Ein Array mit den letzten X Konferenzen (siehe Konstante conferenceLimit). Die Objekte eines Arrayelements enthält folgende Felder:
    • id: Die Konferenz-ID
    • topic: Der Titel einer Konferenz. Dies ist entweder der Benutzername des Gesprächspartners, oder das Thema einer Gruppenkonferenz.
    • topic_custom: Der Titel, der vom Benutzer festgelegt wurde.
    • count: Anzahl der Konferenzteilnehmer.
    • group: true oder false. true Falls es sich um eine Gruppenkonferenz handelt. Ansonsten false.
    • timestamp_end: Zeitstempel der letzten Nachricht.
    • read: true oder false: true falls Benutzer letzte Nachricht dieser Konferenz gelesen hat.
    • read_count: Anzahl der ungelesenen Nachrichten.
    • read_mid: Die Message-ID der letzten gelesenen Nachricht.
    • image: Bild der Konferenz. Format: "Bild-Typ:Bild-ID". Typ ist meistens "avatar" und ID beispielsweise "62_yF5zd7.jpg". Avatare haben den folgenden Link: http://cdn.proxer.me/avatar/tn/[Bild-ID]
Codes
  • 3023: User nicht eingeloggt.



Get Conference Info

FunktionsnameGet Conference Info
BeschreibungInformationen zu einer bestimmten Konferenz.
Anfragelinkhttps://proxer.me/api/v1/messenger/conferenceinfo
ZugriffslevelLevel 0
EingabeparameterParameter (GET oder POST):
  • conference_id: Die ID der Konferenz.
Ausgabeparameter
  • error: 0 oder 1.
  • message: Statusmitteilung vom Server.
  • data (optional):
    • conference: Allgemeine Infos zur Konferenz. Objekt enthält folgende Spalten:
      • topic: Thema der Konferenz.
      • count: Anzahl der Konferenzteilnehmer.
      • timestamp_end: Zeitstempel der letzten Konferenz-Nachricht.
      • leader: Die Benutzer-ID des Konferenzleiters.
    • users: Informationen zu Konferenzteilnehmern. Array enthält folgende Spalten:
      • uid: User-ID
      • avatar: Bild-ID des Avatars. Falls kein Avatar gesetzt ist, ist dieses Feld leer. Beispiel für Bild-ID: "62_yF5zd7.jpg"
      • username: Benutzername.
      • status: Statusmitteilung des Benutzers.
  • code (optional): Zur besseren maschinellen Verarbeitung ein Fehler-Code.
Codes
  • 3023: User nicht eingeloggt.
  • 3024: Ungültige Konferenz.




Get User Info

FunktionsnameGet User Info
BeschreibungInformationen zu einem bestimmten Benutzer.
Anfragelinkhttps://proxer.me/api/v1/messenger/userinfo
ZugriffslevelLevel 0
EingabeparameterParameter (GET oder POST):
  • user_id: Die ID des betroffenen Benutzers.
Ausgabeparameter
  • error: 0 oder 1.
  • message: Statusmitteilung vom Server.
  • data (optional): Informationen über den Benutzer
    • avatar: Bild-ID des Avatars. Falls kein Avatar gesetzt ist, ist dieses Feld leer. Beispiel für Bild-ID: "62_yF5zd7.jpg". Avatare haben den folgenden Link: http://cdn.proxer.me/avatar/tn/[Bild-ID]
    • username: Benutzername des Benutzers
    • status: Status des Benutzers
  • code (optional): Zur besseren maschinellen Verarbeitung ein Fehler-Code.
Codes
  • 3023: User nicht eingeloggt.
  • 3027: Ungültiger Benutzer.



Get Messages

FunktionsnameGet Messages
BeschreibungGibt die letzten Nachrichten einer Konferenz/eines Benutzers zurück.
Anfragelinkhttps://proxer.me/api/v1/messenger/messages
ZugriffslevelLevel 0
EingabeparameterParameter (GET oder POST):
  • conference_id (optional): Die Konferenz-ID.
  • message_id (optional): Die Nachrichten-ID.
  • read (optional): Ob eine Konferenz als gelesen markiert werden soll. Mögliche String-Werte: "true" (default) oder "false".
Ausgabeparameter
  • error: 0 oder 1.
  • message: Statusmitteilung vom Server.
  • code (optional): Zur besseren maschinellen Verarbeitung ein Fehler-Code.
  • data (optional): Ein Array mit den letzten Nachrichten. Die Anzahl der maximalen Elemente pro Seite werden durch die Konstante messagesLimit festgelegt. Es existieren vier Fälle:
    • conference_id=0 und message_id=0: Gibt die letzten Nachrichten des Benutzers zurück. Die letzte Nachricht dieser Ausgabe kann verwendet werden. Empfohlen für den ersten Programmstart um die ID der letzten Nachricht zu erhalten.
    • conference_id=0 und message_id!=0: Gibt die letzten Nachrichten ab einer bestimmten Nachrichten-ID zurück. Dieser Fall kann für die Abfrage der Benachrichtigungen verwendet werden.
    • conference_id!=0 und message_id=0: Gibt die letzten Nachrichten einer bestimmten Konferenz zurück. Kann für den Fall verwendet werden, wenn ein Benutzer zum ersten Mal eine Konferenz öffnet. Falls read=true: Konferenz wird als gelesen markiert (read=true, read_count=0, read_mid=letzte Nachrichten-ID).
    • conference_id!=0 und message_id!=0: Gibt die letzten Nachrichten einer bestimmten Konferenz bis zu einer bestimmten Nachricht zurück. Kann verwendet werden, falls ein Benutzer beispielsweise weitere Nachrichten einer Konferenz anzeigen möchte. Falls read=true: Konferenz wird als gelesen markiert (read=true, read_count=0, read_mid=letzte Nachrichten-ID).
  • Das Array-Element enthalten die folgenden Spalten:
    • message_id: Die Nachrichten-ID.
    • conference_id: Die Konferenz-ID.
    • user_id: Die User-ID des Verfassers.
    • username: Der Username des Verfassers.
    • message: Die Nachricht.
    • action: Falls es sich um ein Befehl handelt, ist hier der Befehl angegeben.
    • timestamp: Zeitstempel des Absendezeitpunktes.
    • device: Das Gerät/die Anwendung aus der eine Nachricht gesendet wurde.
Codes
  • 3023: User nicht eingeloggt.
  • 3024: Ungültige Konferenz.




New Conference

FunktionsnameNew Conference
BeschreibungErstellt eine neue Unterhaltung, oder fügt eine Nachricht einer vorhandenen Unterhaltung hinzu (zwei Benutzer).
Anfragelinkhttps://proxer.me/api/v1/messenger/newconference
ZugriffslevelLevel 1
EingabeparameterParameter (POST):
  • text: Eine Eingabenachricht. Beim Erstellen von Konferenzen werden Befehlseingaben ignoriert.
  • username: Der Benutzername eines Proxer-Nutzers, an die eine Nachricht gesendet werden soll.
Ausgabeparameter
  • error: 0 oder 1.
  • message: Statusmitteilung vom Server.
  • code (optional): Zur besseren maschinellen Verarbeitung ein Fehler-Code.
  • data (optional): Im Falle einer erfolgreichen Abfrage, wird die Konferenz-ID zurückgegeben.
Codes
  • 3023: User nicht eingeloggt.
  • 3026: Ungültige Nachricht (Parameter text).
  • 3027: Ungültiger Empfänger (Parameter username).



New Conference Group

FunktionsnameNew Conference Group
BeschreibungErstellt eine neue Gruppen-Unterhaltung.
Anfragelinkhttps://proxer.me/api/v1/messenger/newconferencegroup
ZugriffslevelLevel 1
EingabeparameterParameter (POST):
  • users: Ein Array aus Benutzernamen. Benutzer, die einer Konferenz hinzugefügt werden sollen. Eingeschränkt durch die Konstante userLimit.
  • topic: Das Thema/der Name der Konferenz. Eingeschränkt durch die Konstante topicCount.
  • text (optional): Die erste Nachricht der neu erstellten Konferenz. Eingeschränkt durch die Konstante textCount. Beim Erstellen von Konferenzen werden Befehlseingaben ignoriert.
Ausgabeparameter
  • error: 0 oder 1.
  • message: Statusmitteilung vom Server.
  • code (optional): Zur besseren maschinellen Verarbeitung ein Fehler-Code.
  • data (optional): Falls erfolgreich, wird hier die Konferenz-ID der neu erstellten Konferenz ausgegeben.
Codes
  • 3023: User nicht eingeloggt.
  • 3028: Maximalanzahl an Benutzern erreicht (Konstante userLimit).
  • 3029: Ungültiges Thema (Parameter topic).
  • 3030: Es muss mindestens ein Benutzer einer Konferenz hinzugefügt werden (Parameter users).



Set Report

FunktionsnameSet Report
BeschreibungFunktionalität zum Melden einer Konferenz bei der Proxer-Administration.
Anfragelinkhttps://proxer.me/api/v1/messenger/report
ZugriffslevelLevel 0
EingabeparameterParameter (POST):
  • text: Ein kurzer Grund, weshalb die Konferenz gemeldet wird.

Parameter (GET oder POST):

  • conference_id: ID der Konferenz, die gemeldet werden soll.
Ausgabeparameter
  • error: 0 oder 1.
  • message: Statusmitteilung vom Server.
  • code (optional): Zur besseren maschinellen Verarbeitung ein Fehler-Code.
Codes
  • 3023: User nicht eingeloggt.
  • 3024: Ungültige Konferenz.
  • 3025: Gebe einen längeren Grund ein.



Set Message

FunktionsnameSet Message
BeschreibungSendet eine Nachricht an eine bestimmte Konferenz.
Anfragelinkhttps://proxer.me/api/v1/messenger/setmessage
ZugriffslevelLevel 1
EingabeparameterParameter (GET oder POST):
  • conference_id: Die Konferenz-ID.

Parameter (POST):

  • text: Eine Eingabenachricht. Die Nachricht ist eingeschränkt durch die Konstante textCount. Es gibt zwei Arten von Nachrichten:
    • Normale Nachricht: Eine vom Benutzer abgesendete Nachricht.
    • Eine Befehl: Ein Befehl fängt mit einem Schrägstrich an. Ein Beispiel für ein Befehl ist wie folgt: /addUser ProxerBot. Dieser Befehl würde den Benutzer ProxerBot zu der aktuellen Konferenz hinzufügen.
Ausgabeparameter
  • error: 0 oder 1.
  • message: Statusmitteilung vom Server.
  • code (optional): Zur besseren maschinellen Verarbeitung ein Fehler-Code.
  • data (optional): Falls beispielsweise der Benutzer bei einem /addUser-Befehl nicht gefunden wird, ist die Ausgabe Benutzer konnte nicht gefunden werden.. Beachte bitte: Bei Befehl-Fehlern ist error=0 und es wird kein Code ausgegeben. Im Falle falls error=0 und data gesetzt ist ist, sollte die Ausgabe in einem Dialog beim Benutzer angezeigt werden.
  • code (optional): Zur besseren maschinellen Verarbeitung ein Fehler-Code.
Codes
  • 3023: User nicht eingeloggt.
  • 3024: Ungültige Konferenz.
  • 3026: Ungültige Nachricht (Parameter text).



Set Read

FunktionsnameSet Read
BeschreibungMarkiert eine Konferenz als gelesen (read=true, read_count=0). Beachte bitte: Funktion Get Messages.
Anfragelinkhttps://proxer.me/api/v1/messenger/setread
ZugriffslevelLevel 1
EingabeparameterParameter (GET oder POST):
  • conference_id: Die Konferenz-ID.
Ausgabeparameter
  • error: 0 oder 1. Beachte bitte: Es wird bei dieser Funktion vorausgesetzt, dass der Benutzer Teilnehmer einer Konferenz ist.
  • message: Statusmitteilung vom Server.
  • code (optional): Zur besseren maschinellen Verarbeitung ein Fehler-Code.
Codes
  • 3023: User nicht eingeloggt.



Set Unread

FunktionsnameSet Unread
BeschreibungMarkiert eine Konferenz als ungelesen. Beachte bitte: Funktion Get Messages.
Anfragelinkhttps://proxer.me/api/v1/messenger/setunread
ZugriffslevelLevel 1
EingabeparameterParameter (GET oder POST):
  • conference_id: Die Konferenz-ID.
Ausgabeparameter
  • error: 0 oder 1. Beachte bitte: Es wird bei dieser Funktion vorausgesetzt, dass der Benutzer Teilnehmer einer Konferenz ist.
  • message: Statusmitteilung vom Server.
  • code (optional): Zur besseren maschinellen Verarbeitung ein Fehler-Code.
Codes
  • 3023: User nicht eingeloggt.



Set Block

FunktionsnameSet Block
BeschreibungMarkiert eine Konferenz als blockiert.
Anfragelinkhttps://proxer.me/api/v1/messenger/setblock
ZugriffslevelLevel 1
EingabeparameterParameter (GET oder POST):
  • conference_id: Die Konferenz-ID.
Ausgabeparameter
  • error: 0 oder 1. Beachte bitte: Es wird bei dieser Funktion vorausgesetzt, dass der Benutzer Teilnehmer einer Konferenz ist.
  • message: Statusmitteilung vom Server.
  • code (optional): Zur besseren maschinellen Verarbeitung ein Fehler-Code.
Codes
  • 3023: User nicht eingeloggt.



Set Unblock

FunktionsnameSet Unblock
BeschreibungHebt eine Blockierung einer Konferenz auf.
Anfragelinkhttps://proxer.me/api/v1/messenger/setunblock
ZugriffslevelLevel 1
EingabeparameterParameter (GET oder POST):
  • conference_id: Die Konferenz-ID.
Ausgabeparameter
  • error: 0 oder 1. Beachte bitte: Es wird bei dieser Funktion vorausgesetzt, dass der Benutzer Teilnehmer einer Konferenz ist.
  • message: Statusmitteilung vom Server.
  • code (optional): Zur besseren maschinellen Verarbeitung ein Fehler-Code.
Codes
  • 3023: User nicht eingeloggt.



Set Favour

FunktionsnameSet Favour
BeschreibungMarkiert eine Konferenz als favorit.
Anfragelinkhttps://proxer.me/api/v1/messenger/setfavour
ZugriffslevelLevel 1
EingabeparameterParameter (GET oder POST):
  • conference_id: Die Konferenz-ID.
Ausgabeparameter
  • error: 0 oder 1. Beachte bitte: Es wird bei dieser Funktion vorausgesetzt, dass der Benutzer Teilnehmer einer Konferenz ist.
  • message: Statusmitteilung vom Server.
  • code (optional): Zur besseren maschinellen Verarbeitung ein Fehler-Code.
Codes
  • 3023: User nicht eingeloggt.



Set Unfavour

FunktionsnameSet Unfavour
BeschreibungHebt eine Favorisierung einer Konferenz auf.
Anfragelinkhttps://proxer.me/api/v1/messenger/setunfavour
ZugriffslevelLevel 1
EingabeparameterParameter (GET oder POST):
  • conference_id: Die Konferenz-ID.
Ausgabeparameter
  • error: 0 oder 1. Beachte bitte: Es wird bei dieser Funktion vorausgesetzt, dass der Benutzer Teilnehmer einer Konferenz ist.
  • message: Statusmitteilung vom Server.
  • code (optional): Zur besseren maschinellen Verarbeitung ein Fehler-Code.
Codes
  • 3023: User nicht eingeloggt.