room.say

room.say

オリジナル: http://wiki.lingr.com/dev/show/RoomSay

翻訳日: 2007/05/21

原文リビジョン: 15


発言します。

HTTPメソッド

POST

パラメータ

session(必須)

session.createで得たセッションID

ticket(必須)

room.enterで得たチケット

message(必須)

発言内容

occupant_id(オプション)

この値を与えた場合、指定された参加者に対してプライベートメッセージが送信されます。省略した場合は公開メッセージとして全ての参加者に対して送信されます。

ログイン済みユーザのoccupant_idを指定した場合、このプライベートメッセージはそのルームに入室済みの同じユーザに属する全ての参加者に送信されます。*1

format(オプション)

希望の応答フォーマット。指定する場合はxmljsonを指定します。デフォルトxmlです。

callback(オプション)

応答フォーマットjsonを指定した場合、コールバック関数名を指定します。


認証

このメソッドは認証を必要としません。

応答の例

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>ok</status>
  <message>
    <id>236</id>
    <type>user</type>
    <occupant_id>3tUud4Upiev</occupant_id>
    <nickname>safari</nickname>
    <source>api</source>
    <client_type>human</client_type>
    <icon_url>http://images.lingr.com/user/0/26x26.gif</icon_url>
    <timestamp>2007-01-11T07:17:04-08:00</timestamp>
    <text>hello</text>
  </message>
  <counter>236</counter>
</response>

応答の詳細

成功したメソッド呼び出しの応答は以下のような要素を持ちます。

message

今発言された内容についての情報が返ります。構造は次のページを参照してください。→Message

counter

room.observeroom.getMessagesに渡すcounterの値

エラーコード

100: 不正HTTPメソッド

HTTPメソッドが間違っています。

102: 無効なセッション

渡されたセッションIDは無効です。

104: 不正な応答フォーマット

要求された応答フォーマットサポートされていません。

109: 無効なチケット

与えられたチケットは無効です。

110: ニックネームが設定されていない

与えられたチケットを使ってニックネームがまだ設定されていない。

111: メッセージがない

messageパラメータが与えられていない

112: 回数制限に達した

呼び出しの間隔が短すぎる。

113: 権限が足りない

現在セッションで使われたAPIキーには、このルームで発言する権限がない。

120: 不正文字コードエンコーディング

あなたが入力したデータUTF-8として不正エンコーディングを含んでいます。

詳細は「APIの基礎について学ぶ」を参照してください。


129: 不正なoccupant_id

指定されたoccupant_idを持つ参加者がこのルームには居ません。

*1訳者注: 多重ログインしている場合、その全てに届くと言うこと