mixiアプリ » 技術仕様(新方式) » モバイル » mixiボイスの投稿について
mixiボイスの投稿について
mixiボイスAPIを利用することで、mixiアプリ内からユーザにmixiボイスのつぶやきを投稿させることができます。これにより、ユーザはmixiアプリ上での様々な体験を手軽につぶやくことができ、その発言から友人とのコミュニケーションが生まれます。
ボイス実装時の注意
本APIを利用する際には、以下の事項を遵守してください。
- ユーザーが投稿する内容を入力・編集するためのテキストボックスを必ず用意してください。
- ユーザーが投稿する時にmixiボイスに投稿されることがはっきりわかるようにしてください。
- テキストボックスに入力されている内容をそのままボイス投稿するようにしてください。勝手に文言を加えたりすることはしないでください。 また、投稿可能な文字数は、URLを指定した場合は107文字まで、URLを指定しなかった場合は130文字までとなります。
ユーザ認可の取得
mixiボイスの投稿機能を利用するためには、mixi_apps2スコープのユーザ認可を取得する必要があります。
詳しくは ユーザ認可について を参照ください。
mixiボイスの投稿
発言の投稿をmixiアプリ内から行うためには、formタグにてupdate:statusという記述を使用します。formタグを設置するページの文字コードはShift_JISとUTF-8(※auはShift_JISのみ対応)、メソッドはPOSTのみがサポートされます。HTMLのformタグが持つaction属性には、以下のように記述します。
update:status?callback=[エスケープ済みURL]
また、以下の内容をinputタグを使用して記述します。
| パラメータ名 | 意味 |
|---|---|
| body | 発言の内容をユーザが入力するためのテキストフィールド |
| url | PC向けアプリの起動URL |
| mobileUrl | モバイル向けアプリの起動URL |
| touchUrl | スマートフォン向けアプリの起動URL |
ユーザがアクセスしている端末のキャリアがドコモの場合には、”guid=ON”パラメータも付加してください。以下に、投稿するためのタグセットの例を記述します。
<form action="update:status?callback=http%3A%2F%2Fserver.name%2Fcallback&guid=ON" method="POST">
<input type="text" name="body" value=" http://ma.mixi.net/[アプリID]/" />
<input type="hidden" name="url" value="http://mixi.jp/run_appli.pl?id=[アプリID]&appParams=..." />
<input type="hidden" name="mobileUrl" value="http://ma.mixi.net/[アプリID]/?url=..." />
<input type="hidden" name="touchUrl" value=" http://mixi.jp/run_appli.pl?id=[アプリID]&appParams=..." />
<input type="submit" value="つぶやく" />
</form>
url, mobileUrl, そしてtouchUrlパラメータの指定により、投稿されたつぶやきには自動的にこれらを表す短縮URLが付与されます。
ユーザが上記のフォームをサブミットした際には、発言を投稿してよいかどうかを問い合わせるページに遷移します。そこでユーザが投稿することを選択した場合は、mixiサーバ内でつぶやき投稿処理が行われます。その後、callbackパラメータにて指定したURLのページに遷移します。その際、 resultパラメータとして、処理結果を表すコードが返却されます。問題なく投稿できた場合は”success”、何らかの理由で失敗した場合は”failed”がresultパラメータ値となります。もし”failed”の場合は、errorパラメータにその理由が記載されます。
errorパラメータに渡される値の意味は以下となります。
| エラーコード | 発生する状況 |
|---|---|
| 401 | mixi_apps2スコープの認可を保持していないとき |
| 403 | ボイスの投稿が禁止されているとき、またはユーザが投稿をキャンセルしたとき |
| 500 | mixi側の内部エラー |