[mitchatten]

Chaninfo

URL

Die URL für den Zugriff auf Chaninfo lautet:

https://api.relay-chat.de/2/chaninfo/:channel/:format/

Parameter

Die Parameter die dieser URL übergeben werden können sind channel und format.

Der Parameter channel enthält den Channel-Namen zu dem die Informationen abgefragt werden sollen. Die im Normalfall voranstehende # (Raute) muss entfernt werden. Wird der Parameter format weggelassen, antwortet das API per Default im Format json.

$ curl https://api.relay-chat.de/2/chaninfo/iZ-smart/json/ | jsonpretty
{
  "izsmart": {
    "ajax": false,
    "cache": false,
    "cache_hash": "4989f7-29eef6edbd97",
    "cache_online": true,
    "mobile": false,
    "request_uri": "/2/chaninfo/iZ-smart/json",
    "runtime": 0.03227,
    "time": 1413295432,
    "version": "tiberius/2.0.89@production"
  },
  "chaninfo": {
    "channel": "#iZ-smart",
    "registered": true,
    "stats_url": "http://insiderz.ircstuff.de/#iz-smart",
    "topic": "Willkommen im Netzwerk-Channel #iZ-smart -- Be smart - It's smart ]-[ Fragen bitte im Channel stellen! ]-[ Bitte daran denken, dass wir hier im Help-Channel sind! ]-[ News: Änderungen am API v2: http://j.mp/1eKDjWe ]-[ iZ-smart bei Facebook: http://on.fb.me/izsmart ]",
    "topic_html": "Willkommen im Netzwerk-Channel #iZ-smart -- Be smart - It's smart ]-[ Fragen bitte im Channel stellen! ]-[ Bitte daran denken, dass wir hier im Help-Channel sind! ]-[ News: Änderungen am API v2: http://j.mp/1eKDjWe ]-[ iZ-smart bei Facebook: http://on.fb.me/izsmart ]",
    "topicsetby": "hexa",
    "topictime": 1389371676,
    "user_count": 71,
    "user_list": [
      {
        "nickname": "Cat",
        "status": 5,
        "status_clear": "Founder",
        "status_prefix": "*"
      },
      {
        "nickname": "diskman",
        "status": 5,
        "status_clear": "Founder",
        "status_prefix": "*"
      },
      {
        "nickname": "aerolife",
        "status": 5,
        "status_clear": "Founder",
        "status_prefix": "*"
      },
      {
        "nickname": "hexa",
        "status": 5,
        "status_clear": "Founder",
        "status_prefix": "*"
      },
      {
        "nickname": "ChuckY",
        "status": 4,
        "status_clear": "Admin",
        "status_prefix": "!"
      },
      {
        "nickname": "Seelenjaegerin",
        "status": 4,
        "status_clear": "Admin",
        "status_prefix": "!"
      },
      {
        "nickname": "byteinterceptor",
        "status": 4,
        "status_clear": "Admin",
        "status_prefix": "!"
      },
      {
        "nickname": "HELPBot",
        "status": 4,
        "status_clear": "Admin",
        "status_prefix": "!"
      },
      {
        "nickname": "Ebisario",
        "status": 3,
        "status_clear": "Operator",
        "status_prefix": "@"
      },
      {
        "nickname": "JimBob",
        "status": 3,
        "status_clear": "Operator",
        "status_prefix": "@"
      },
      {
        "nickname": "Ent",
        "status": 1,
        "status_clear": "Voice",
        "status_prefix": "+"
      },
      {
        "nickname": "iZ-Service",
        "status": 1,
        "status_clear": "Voice",
        "status_prefix": "+"
      },
      {
        "nickname": "Gratulator",
        "status": 1,
        "status_clear": "Voice",
        "status_prefix": "+"
      },
      {
        "nickname": "iZ-Stats",
        "status": 1,
        "status_clear": "Voice",
        "status_prefix": "+"
      },
      {
        "nickname": "Leyla|off",
        "status": null,
        "status_clear": null,
        "status_prefix": null
      },
      {
        "nickname": "g00fy|BNC",
        "status": null,
        "status_clear": null,
        "status_prefix": null
      },
      {... bunch more ...}
    ]
  }
}

Payload

Der Status des Nutzers kann folgende Werte annehmen: