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

シナリオ対話

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

    API
    基本情報

    シナリオ対話

    提供 : REST

    利用条件 : あり ※1

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

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

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

    ユーザーID取得

    シナリオ対話を利用するためのユーザー情報を登録するためのエンドポイントです。

    テクニカルガイドライン

    • シナリオ対話 エンドポイントを利用するためには、本エンドポイントでアクセスに必要なIDを取得する必要があります。
    • 対話時のステータスは本エンドポイントで取得するIDを基に制御されます。
    • IDはAPIサーバー側に保存されるので、本エンドポイントへのリクエストが必要なのは初回の1回のみです。以降は取得したIDをご利用ください。

    リクエストURL

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

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

    リクエストヘッダ

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

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

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

    リクエストパラメータ

    キー 必須 説明
    botId "APIBot"を指定する。

    レスポンスヘッダ

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

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

    キー 必須 説明
    appUserId 対話ステータスを管理するID
    ※近日中にパラメータ名を変更する予定です。

    リクエストサンプル

    POST https://api.apigw.smt.docomo.ne.jp/scenarioDialogue/v1/registration?APIKEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    Content-Type: application/json;charset=UTF-8
    { 
      "botId": "APIBot"
    }

    レスポンスサンプル

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