More than 5 years have passed since last update.

@quottoin

運営者ギルド

TwitterでつぶやくAlexaスキルを作る

Last updated at 2018-01-25Posted at 2018-01-18

初めて投稿します。

ようやくAmazon Echoを手に入れたのでTwitterAPIを使ったAlexaスキル開発をしてみました。

本記事はプログラミングというよりも、Alexaスキル開発の流れを説明する形になっています。

#作成したスキル
今回作成したスキルは、

Alexaに「行ってきます」「ただいま」と声をかけるとツイッターにその時間を投稿する

というシンプルなものです。

スキル名は「ツイッター」＋「ログ」で**『ツイログ』**としました。

「アレクサ、ツイログで行ってきます」
「アレクサ、ツイログでただいま」

と、~~不自然な~~発話をすることでツイートします。

ツイートが成功するとAlexaが「つぶやきました」と喋ります。

##注意
作成するスキルはTwitterAPIに必要なACCESS_TOKEN、ACCESS_TOKEN_SECRETをプログラム中に埋め込むため、アカウントリンクを行わない特定のTwitterアカウント専用スキルです。

##参考資料
Amazon公式のAlexaスキル開発トレーニングで最低限必要な知識は身につきます。

スキル開発してみようと思ったら、まずはこれを全て実施しましょう。1日あれば終わります。

##全体イメージ
Alexaスキル『ツイログ』のイメージはこんな感じです。

#Alexaスキルの開発
##TwitterApplicationManagementの登録
まず初めに外部からTwitterAPIを叩くための各種キーを取得します。（画像は過去の使い回しなので入力内容はあまり気にしないでください）

Twitter Application Managementへアクセスし、自分のTwitterアカウントでログインします。

次に右上の**「Create New App」**をクリックします。

登録するアプリケーションの入力フォームが出ます。「Name」「Description」「Website」は必須入力項目です。適当な内容で入力します。

Name：アプリケーションの登録名
Description：アプリケーションの説明文
Website：アプリケーションの問い合わせ先が分かるようなURLを入力します。
CallbackURL：今回は設定不要です。

入力したらページ最下部の**「Create your application」**をクリックします。

これでアプリケーションの登録が完了しました。

続いてAPIの利用に必要となるAccess Tokenを発行します。表示されたページのタブ**「Keys And Access Tokens」から「Create my access token」**をクリックします。

これでTwitterAPIの準備は完了です。ページに表示されているConsumer Key、Consumer Secret、Access Token、Access Token Secretをプログラム内で利用します。

##Amazon開発者コンソール
いよいよAlexaスキルを作成していきます。まずAmazon開発者コンソールにログインします。

上段メニュー**「ALEXA」を選択して「Alexa Skills Kit」**へ進みます。

右上の**「新しいスキルを追加する」**をクリックします。

スキルの基本情報として言語``スキル名``呼び出し名を入力して保存、次へ進みます。

言語：スキルの対応言語。
スキル名：このスキルの名前。ユーザーにはスキル名が表示される。
呼び出し名：スキルを呼び出す時のフレーズ。「アレクサ、◯◯を開いて」の「◯◯」の部分。

続いて対話モデルを設定します。ここがAlexaスキル開発のポイントです。**「インテントスキーマ」と「サンプル発話」**を設定します。

###インテントスキーマ
インテントスキーマは**「Alexaスキルで実行するアクションの種類」**です。JSON形式で以下のように入力します。

{
  "intents": [
    {
      "intent": "GoOutTweet"
    },
    {
      "intent": "ComeHomeTweet"
    },
    {
      "intent": "AMAZON.HelpIntent"
    },
    {
      "intent": "AMAZON.StopIntent"
    },
    {
      "intent": "AMAZON.CancelIntent"
    }
  ]
}

GoOutTweet：「行ってきます」に対応するアクション。
ComeHomeTweet：「ただいま」に対応するアクション。
AMAZON.HelpIntent：「使い方」や「説明」に対応するアクション。
AMAZON.StopIntent：「中止」「停止」に対応するアクション。
AMAZON.Cancelntent：「キャンセル」に対応するアクション。

AMAZON.と付いているインテントは**「標準インテント」**とよばれ、インテントスキーマに定義するだけでデフォルトのキーフレーズで使えるようになります。

一方でGoOutTweet、ComeHomeTweetは今回作成するAlexaスキルのオリジナルアクションである**「カスタムインテント」です。カスタムインテントは次に説明するサンプル発話でキーフレーズを設定する必要があります。**

###サンプル発話
サンプル発話ではカスタムインテントに対して**「そのインテントがアクションを起こすためのキーフレーズ」**を定義します。例えば「行ってきます」っぽいことを言えばGoOutTweetが、「ただいま」っぽいことを言えばComeHomeTweetが起動するイメージです。

今回はGoOutTweet、ComeHomeTweetに対して以下のように発話フレーズを設定します。

GoOutTweet 行く
GoOutTweet 行って
GoOutTweet 行きます
GoOutTweet 出かける
ComeHomeTweet ただいま
ComeHomeTweet 帰った
ComeHomeTweet 帰って
ComeHomeTweet 戻った

入力が完了したら次に進みます。

##AWS Lambda
ここで一度Amazon開発者コンソールを離れ、AWSにログインします。

ログインしたらAWSサービスからLambdaを選択します。

右上の**「関数の作成」**を実行します。

作成フォームで**「一から作成」を選択します。名前は任意の名前を入力し、ランタイムは「Node.js 6.10」**を選択します。

続いてロールの項目から**「カスタムロールの作成」**を選択します。

ロールの作成画面が表示されます。全てそのままで「許可」をクリックします。

ここまでできたら右下の「関数の作成」をクリック。

実際に動かすプログラムを直接コーディングすることもできますが、今回はzipファイルをアップロードする形式を取ります。zipファイルとコードはgithub上にアップロードしています。 https://github.com/quotto/TweetByAlexa

画面の中頃に「関数コード」という項目があるので、ここでコードエントリータイプ**「.ZIPファイルをアップロード」**を選択して、ファイルskill.zipをアップロードします。

###一応プログラムの説明
index.jsがメインの実行プログラムです。Amazon開発者コンソールで定義したインテントごとにAlexaの振る舞いを実装します。

index.js

'use strict';

const Alexa = require('alexa-sdk');

const Twitter = require('twitter');

const APP_ID = undefined;  // TODO replace with your app ID (OPTIONAL).

const JSTOffset = 60 * 9 * 60 * 1000; // JST時間を求めるためのオフセット

const ErrorMessage = '<say-as interpret-as="interjection">ごめんなさい、</say-as>つぶやけませんでした。';

function calculateJSTTime() {
    var localdt = new Date(); // 実行サーバのローカル時間
    var jsttime = localdt.getTime() + (localdt.getTimezoneOffset() * 60 * 1000) + JSTOffset;
    var dt = new Date(jsttime);
    return dt;
}

const handlers = {
    'LaunchRequest': function () {
        this.emit('AMAZON.HelpIntent');
    },
    'GoOutTweet' : function() {
        var dt = calculateJSTTime();
        var stringTime = dt.getFullYear() + "年" + (dt.getMonth()+1) + "月" + dt.getDate() + "日 " + dt.getHours() + "時" + dt.getMinutes() + "分" + dt.getSeconds() + "秒 ";
        var message = stringTime + "に出かけました。（Alexaスキルでつぶやいています）";
        Twitter.postTweet(message).then(()=>{
            this.emit(':tell','つぶやきました。<say-as interpret-as="interjection">いってらっしゃい。</say-as>');
        },(error)=>{
            console.log(error);
            this.emit(':tell',ErrorMessage);
        })
    },
    'ComeHomeTweet' : function() {
        var dt = calculateJSTTime();
        var stringTime = dt.getFullYear() + "年" + (dt.getMonth()+1) + "月" + dt.getDate() + "日 " + dt.getHours() + "時" + dt.getMinutes() + "分" + dt.getSeconds() + "秒 ";
        var message = stringTime + "に帰ってきました。（Alexaスキルでつぶやいています）";
        Twitter.postTweet(message).then(()=>{
            this.emit(':tell','つぶやきました。<say-as interpret-as="interjection">おかえりなさい。</say-as>');
        },(error)=>{
            console.log(error);
            this.emit(':tell',ErrorMessage);
        })
    },
    'AMAZON.HelpIntent': function () {
        const speechOutput = '<say-as interpret-as="interjection">「いってきます」「ただいま」</say-as>、とつぶやくと、その時間をツイートします。';
        const reprompt = speechOutput;
        this.emit(':ask', speechOutput, reprompt);
    },
    'AMAZON.CancelIntent': function () {
        this.emit(':tell', this.t('STOP_MESSAGE'));
    },
    'AMAZON.StopIntent': function () {
        this.emit(':tell', this.t('STOP_MESSAGE'));
    },
};

exports.handler = function (event, context) {
    const alexa = Alexa.handler(event, context);
    alexa.APP_ID = APP_ID;
    // To enable string internationalization (i18n) features, set a resources object.
    alexa.registerHandlers(handlers);
    alexa.execute();
};

Alexa.handlerのthis.emitを実行することでAlexaが喋ります。

ツイッターに投稿するTwitter.postTweetの部分は同梱のtwitter.jsに自作のOAuthプログラムを実装しています。

twitter.js

"use strict";

const AWS = require('aws-sdk');

const https = require('https');
const request = require('request');
const crypto = require('crypto');

const url='https://api.twitter.com/1.1/statuses/update.json';

function postTweet(message) {
    return new Promise((resolve,reject) => {
        const include_entities = {
            status: message,
            // include_entities: true
        };
        const params = {
            oauth_consumer_key: process.env.CONSUMER_KEY,
            oauth_token: process.env.ACCESS_TOKEN,
            oauth_signature_method: 'HMAC-SHA1',
            oauth_timestamp: (() => {
                const date = new Date();
                return Math.floor(date.getTime() / 1000);
            })(),
            oauth_nonce: (() => {
                const date = new Date();
                return date.getTime();
            })(),
            oauth_version: '1.0'
        };

        let auth_params = Object.assign(include_entities,params);

        let encoded_auth_params = Object.keys(auth_params).map(function(key){
            return `${encodeURIComponent(key)}=${encodeURIComponent(this[key])}`;
        },auth_params);
        encoded_auth_params.sort((a,b) => {
            if(a < b) return -1;
            if(a > b) return 1;
            return 0;
        });

        const sigunature_base = `${encodeURIComponent('POST')}&${encodeURIComponent(url)}&${encodeURIComponent(encoded_auth_params.join('&'))}`;

        const keyOfSign = `${encodeURIComponent(process.env.CONSUMER_SECRET)}&${encodeURIComponent(process.env.ACCESS_TOKEN_SECRET)}`;
        const signature = crypto.createHmac('sha1',keyOfSign).update(sigunature_base).digest('base64');
        params.oauth_signature = signature;

        let authorization = Object.keys(params).map(function(key) {
            return `${encodeURIComponent(key)}="${encodeURIComponent(this[key])}"`;
        },params);
        authorization.sort((a,b) => {
            if(a < b) return -1;
            if(a > b) return 1;
            return 0;
        });


        const headers = {
            Authorization: `OAuth ${authorization.join(', ')}`
        };

        const options = {
            url: url+"?status="+encodeURIComponent(message),
            headers: headers
        };

        request.post(options ,(error,response,body) => {
            if(error) {
                reject("reject:"+error);
            } else if(response.statusCode!=200) {
                reject("reject:statusCode="+response.statusCode);
            } else {
                resolve();
            }
        });
    });
};

module.exports.postTweet=postTweet;