mixiアプリ » 技術仕様（RESTful API方式） » PC » mixiボイスを投稿してみよう
mixiボイスを投稿してみよう
mixiボイスAPIを利用することで、mixiアプリ内からユーザにmixiボイスのつぶやきを投稿させることができます。これにより、ユーザはmixiアプリ上での様々な体験を手軽に投稿することができ、その発言から友人とのコミュニケーションが生まれます。
ボイス実装時の注意
本APIを利用する際には、以下の事項を遵守してください。
- ボイス投稿処理を呼び出すきっかけは、弊社が指定する画像(こちらからダウンロード)をボタンとして必ず使用し、それがクリックされた際にrequestUpdateStatus()関数を呼び出すように実装してください。
mixiボイスの投稿
mixiアプリから投稿するためには、まず投稿機能の利用宣言をGadget XMLファイルに記載します。
<?xml version="1.0"?>
<Module>
<ModulePrefs ...>
<Require feature="mixi-voice" />
...
</ModulePrefs ...>
</Module>
実際の投稿処理は、以下のコードを記載します。この処理は、弊社が指定する画像(こちらからダウンロード)をボタンとして必ず使用し、それがクリックされた際に呼び出すように実装してください。なお、この画像はmixiアプリにおけるボイス以外での利用を禁止します。
mixiボイス投稿ボタン
var params = {};
params[mixi.Status.Field.URL] =
"http://mixi.jp/run_appli.pl?id=[アプリID]&appParams=...";
params[mixi.Status.Field.TOUCH_URL] =
"http://mixi.jp/run_appli.pl?id=[アプリID]&appParams=...";
mixi.requestUpdateStatus("こんなに育ちました！", function(response) {
if (response.hadError()) {
var code = response.getErrorCode();
var msg = response.getErrorMessage();
// エラー時の処理
} else {
// 成功時の処理
}
}, params);
requestUpdateStatus()関数を呼び出すことで、ユーザに発言の内容の入力を促すためのポップアップ画面が表示されます。そこで「つぶやく」ボタンを押下する、あるいは閉じるボタンなどの押下によりポップアップ画面が閉じられた際には、引数で渡したコールバック関数が呼び出されます。
第1引数には文字列を指定することで、発言の内容の初期値を設定することが可能です。ユーザーからの発言となる文字列を指定してください。第1引数で指定可能な文字数は、URLを指定した場合は107文字まで、URLを指定しなかった場合は130文字までとなります。
コールバック関数に渡される引数のhadError()関数を呼び出すことで、投稿が正常に行われたかどうかを確認することが可能です。もしtrueが返却された際には、適切なエラー処理（ユーザに投稿できなかったことを表示するなど）を行ってください。getErrorCode()関数あるいは getErrorMessage()関数を呼び出すことで、その原因を得ることができます。
第3引数には、ボイスのつぶやきに含めたいURLを指定します。指定可能なURLは以下の通りです。この第3引数は、省略することも可能です。
- URL: PC向けアプリの起動URL
- TOUCH_URL: スマートフォン向けアプリの起動URL
各URLは、そのアプリを起動するためのURLのみが指定可能です。例えばPC向けアプリであれば「http://mixi.jp/run_appli.pl?id=12345」といったURLのみが記述可能となります。但し、そのURLの末尾は自由となりますので、appParamパラメータなどのクエリパラメータを記述することで、アプリ起動時にパラメータを渡すことができるようになります。これらのURLの指定により、投稿されたつぶやきには自動的にこれらを表す短縮URLが付与されます。
エラーコードおよびエラーメッセージは以下となります。
| エラーコード | エラーメッセージ | 発生する状況 |
|---|---|---|
| 403 | Forbidden | ボイスの投稿が禁止されているとき |
| 403 | User canceled | ユーザが投稿をキャンセルしたとき |
| 500 | Internal server error | mixi側の内部エラー |