はじめに
このページはニコ生アラート(本家)が行っている処理の2009/8/27現在における仕様についてまとめたものです。
このページの目的はユーザーが開発するニコニコ生放送の番組通知ソフトウェア/Webサービスにニコ生アラート(本家)と同様の処理を組み込んで頂き、ニコニコ生放送の負荷低減を目指すことです。
このページの内容及び公開しているAPIの仕様は予告なく変更される可能性があります。また仕様変更時にこのページの内容は修正されない可能性があります。
ツールおよびサービスでこれらのAPIにアクセスする時、そのツール名/サービス名とバージョン情報が含まれているユーザーエージェントでアクセスすることを推奨します。
ログインAPIその1
- URL
https://secure.nicovideo.jp/secure/login?site=nicolive_antenna
- ・パラメータ(POSTのみ)
mail=[メールアドレス:example@example.com]
password=[パスワード:example] - レスポンス
<?xml version="1.0" encoding="utf-8" ?>
<nicovideo_user_response status="ok">
<ticket>[認証用チケット:1234512345678901234567890]</ticket>
</nicovideo_user_response>
認証APIその2
- URL
http://live.nicovideo.jp/api/getalertstatus
- パラメータ
ticket=[認証APIその1]で取得した認証用チケット - レスポンス
<getalertstatus status="ok" time="[アクセスタイム]">
<user_id>[ユーザーID:0000]</user_id>
<user_hash>[認証用ハッシュ:XXXXXXXXXXXXXXXXXXXXXXXXXXX]</user_hash>
<user_name>[ユーザー名]</user_name>
<user_prefecture>[都道府県名:xx]]</user_prefecture>
<user_age>[年齢]</user_age>
<user_sex>[性別]</user_sex>
<is_premium>[一般かプレミアムか:0 or 1]</is_premium>
<communities>
<community_id>[加入コミュニティID:coXXXX]</community_id>
<community_id>[加入チャンネルID:chXXXX]</community_id>
</communities>
<ms>
<addr>[コメントサーバーのアドレス]</addr>
<port>[コメントサーバーのポート]</port>
<thread>[スレッドID]</thread>
</ms>
</getalertstatus>
ユーザー認証を行わないAPI
- URL
http://live.nicovideo.jp/api/getalertinfo - レスポンス
<getalertstatus status="ok" time="[アクセスタイム]">
<user_id>[ユーザーID]</user_id>
<user_hash>[認証用ハッシュ]</user_hash>
<ms>
<addr>[コメントサーバーのアドレス]</addr>
<port>[コメントサーバーのポート]</port>
<thread>[スレッドID]</thread>
</ms>
</getalertstatus>
コメントサーバー
認証APIで取得したコメントサーバーのアドレスとポートにXMLSocketで接続を行います。接続しただけではデータを受信することはできません。以下のデータを送信することで対象スレッドを取得して継続的にPUSHされる状態となります。
<thread thread="[スレッドID]" version="20061206" res_from="-1"/>
- PUSHされるデータのサンプル
番組情報取得API
- URL
- http://live.nicovideo.jp/api/getstreaminfo/lv[放送ID]
- レスポンス
<getstreaminfo status="ok">
<request_id>[放送ID]</request_id>
<streaminfo>
<title>[番組タイトル]</title>
<description>[番組説明文]</description>
<provider_type>[コミュニティなら"community"、チャンネルなら"channel"]</provider_type>
<default_community>[チャンネル＆コミュニティID]</default_community>
</streaminfo>
<communityinfo>
<name>[チャンネル＆コミュニティの名前]</name>
<thumbnail>[チャンネル＆コミュニティのサムネイルURL]</thumbnail>
</communityinfo>
</getstreaminfo>
関連項目
携帯版URL:
http://dic.nicomoba.jp/k/a/%E3%83%8B%E3%82%B3%E7%94%9F%E3%82%A2%E3%83%A9%E3%83%BC%E3%83%88%28%E6%9C%AC%E5%AE%B6%29%E3%81%AE%E4%BB%95%E6%A7%98
http://dic.nicomoba.jp/k/a/%E3%83%8B%E3%82%B3%E7%94%9F%E3%82%A2%E3%83%A9%E3%83%BC%E3%83%88%28%E6%9C%AC%E5%AE%B6%29%E3%81%AE%E4%BB%95%E6%A7%98
ページ番号: 4147874
リビジョン番号: 859315
読み：ニコナマアラートホンケノシヨウ
初版作成日: 09/08/27 10:56 ◆ 最終更新日: 10/08/11 16:31
編集内容についての説明/コメント: 取得できるレスポンスの追記
記事編集 / 編集履歴を閲覧 / Twitterで紹介
JASRAC許諾番号: 9011622001Y31015
