ホーム API/ツール API シナリオ対話

シナリオ対話

    シナリオ対話APIは、ユーザーの発話テキストを受け付け、その入力に対してあらかじめ設定したシナリオに沿った自然な対話を提供します。

    API
    基本情報

    シナリオ対話

    提供 : REST

    利用条件 : あり ※1

    ※1「ガイドライン(必読)」に記載の利用条件に予め同意していただく必要がございます。

    ご利用いただくためには「アカウント登録(無料)」が必要です。

    リファレンスを参照するAPI機能名を選択してください

    シナリオ対話

    リクエストで送られた発話に対してを、あらかじめ決められてシナリオに沿った回答を返却します。

    テクニカルガイドライン

    • 本エンドポイントを利用するためには、 ユーザー情報取得 を利用して、本エンドポイントで利用するIDを取得する必要があります。
    • 現在稼働しているシナリオに関しては、解説・事例に掲載しておりますので、そちらをご参照ください。

    リクエストURL

    https://api.apigw.smt.docomo.ne.jp/scenarioDialogue/v1/dialogue

    メソッド : POST
    文字コード : UTF-8

    リクエストヘッダ

    キー 必須 説明
    Content-Type 送信データのMIMEタイプは、下記を指定。
    application/json;charset=UTF-8

    リクエストクエリパラメータ

    キー 必須 説明
    APIKEY APIにアクセスするアプリの認証に利用する

    リクエストパラメータ

    キー 必須 説明
    appUserId ユーザー情報取得 にて登録したappUserIdを指定。
    botId "APIBot"を指定
    voiceText 発話テキストを指定
    initTalkingFlagがtrueの際は"init"を指定する。
    initTalkingFlag 初回の発話時: true
    初回以外: false
    initTopicId - "APITOPIC"を指定
    initTalkingFlagがtrueの際は必須
    appRecvTime クライアントが最後に取得パラメータを受信した時刻。初回の場合は現在時刻を指定。
    フォーマット:YYYY-MM-DD hh:mm:ss
    appSendTime クライアントが送信パラメータを送信した時刻。
    フォーマット:YYYY-MM-DD hh:mm:ss

    レスポンスヘッダ

    キー 必須 説明
    Content-Type 受信データのMIMEタイプは、下記を返却。
    application/json;charset=UTF-8

    レスポンスボディ(JSON形式)

    キー 必須 説明
    systemText システムからの返答一覧
    expression システムからの返答
    utterance 音声合成用テキスト
    serverSendTime サーバーが取得パラメータを送信した時刻

    リクエストサンプル

    POST https://api.apigw.smt.docomo.ne.jp/scenarioDialogue/v1/dialogue?APIKEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    Content-Type: application/json;charset=UTF-8
    { 
      "appUserId": "nd6x8jcsnYskGhZ5mpP5tZPUr-uDibc4",  
      "botId": "APIBot",
      "voiceText": "init", 
      "initTalkingFlag": true,  
      "initTopicId":"APITOPIC"
    } 
    

    レスポンスサンプル

    Content-Type: application/json;charset=UTF-8
    { 
      "systemText": { 
          "expression": "あなたのお名前は?", 
          "utterance": "あなたのお名前は?" 
      },  
      "serverSendTime": "2015-10-29 12:54:30",  
    } 
    
    よくあるご質問
    APIなどの各サービスに関するよくある質問を掲載します。
    お問い合わせ
    「docomo Developer support」及び「作ろうスマートフォン/iモードコンテンツ」に関するお問い合わせです。よくあるご質問や技術ブログで解決しない場合は、お問い合わせください。