ホーム API/ツール API 雑談対話

雑談対話

    雑談対話APIは、ユーザの発話テキストを受け付け、その入力に対して自然な会話となる雑談を提供します。
    本APIでは、dアカウントによるユーザ認証・認可を行うことで、さらに便利な機能をご利用いただくことができます。なお、dアカウントはドコモユーザ以外のお客様でも取得できます。詳細に関してはこちらを参照ください。

    API
    基本情報
    提供 : REST, SDK(Android™,iOS,Server side JAVA)
    利用条件 : あり※1

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

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

    • 雑談対話APIはユーザの自然な発話に対して幅広い会話や「しりとり」を提供するAPIです。

    リクエストURL

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

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

    リクエストヘッダ

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

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

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

    リクエストボディ(JSON形式)

    キー 必須 説明
    utt ユーザの発話を指定(255文字以下)
    サンプル値) こんにちは
    context - コンテキストIDを指定(255文字以下)
    サンプル値) aaabbbccc111222333
    ※会話(しりとり)を継続する場合は、レスポンスボディのcontextの値を指定する
    nickname - ユーザのニックネームを指定(全角10文字(半角10文字)以下)
    サンプル値) 光
    nickname_y - ユーザのニックネームの読みを指定(全角20文字以下(カタカナのみ))
    サンプル値) ヒカリ
    sex - ユーザの性別は、下記のいずれかを指定
    男、女
    bloodtype - ユーザの血液型は、下記のいずれかを指定
    A、B、AB、O
    birthdateY - ユーザの誕生日(年)を指定(1~現在までのいずれかの整数(半角4文字以下))
    サンプル値) 1997
    birthdateM - ユーザの誕生日(月)を指定(1~12までのいずれかの整数)
    サンプル値) 5
    birthdateD - ユーザの誕生日(日)を指定(1~31までのいずれかの整数)
    サンプル値) 30
    age - ユーザの年齢を指定(正の整数(半角3文字以下))
    サンプル値) 16
    constellations - ユーザの星座は、下記のいずれかを指定
    牡羊座、牡牛座、双子座、蟹座、獅子座、乙女座、天秤座、蠍座、射手座、山羊座、水瓶座、魚座
    place - ユーザの地域情報は、「場所リスト」に含まれるもののいずれかを指定
    サンプル値) 東京
    mode - 対話のモードは、下記のいずれかを指定
    dialog (省略時)
    srtr
    ※会話(しりとり)を継続する場合は、レスポンスボディのmodeの値を指定する
    t - キャラクタは、下記のいずれかを指定
    20 : 関西弁キャラ
    30 : 赤ちゃんキャラ
    指定なし : デフォルトキャラ

    レスポンスヘッダ

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

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

    キー 必須 説明
    utt - システムからの返答
    サンプル値) こんにちは光さん
    yomi - 音読を間違えそうな漢字をカタカナにして返却
    一般的な語についてはuttと同じ内容となる
    サンプル値) こんにちはヒカリさん
    mode - 対話のモードは、下記のいずれかを返却
    dialog
    srtr
    ※会話(しりとり)を継続する場合は、この値をリクエストボディのmodeに指定する
    da - ユーザとシステムの対話に対してサーバが付与した番号を返却
    サンプル値) 0
    context - 自動的にシステムより出力されるIDを返却
    サンプル値) aaabbbccc111222333
    ※会話(しりとり)を継続する場合は、この値をリクエストボディのcontextに指定する

    リクエストサンプル

    POST https://api.apigw.smt.docomo.ne.jp/dialogue/v1/dialogue?APIKEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    
    Content-Type: application/json
    
    {
     "utt":"こんにちは",
     "context":"10001",
     "user":"99999",
     "nickname":"光",
     "nickname_y":"ヒカリ",
     "sex":"女",
     "bloodtype":"B",
     "birthdateY":"1997",
     "birthdateM":"5",
     "birthdateD":"30",
     "age":"16",
     "constellations":"双子座",
     "place":"東京",
     "mode":"dialog",
     "t":"20"
    }
    

    レスポンスサンプル

    Content-Type: application/json
    
    {
     "utt":"こんにちは光さん",
     "yomi":"こんにちはヒカリさん",
     "mode":"dialog",
     "da":"0",
     "context":"aaabbbccc111222333 ",
    }
    

    場所リスト

    北海道

    稚内 旭川 留萌 網走 北見 紋別 根室 釧路 帯広 室蘭
    浦河 札幌 岩見沢 倶知安 函館 江差

    東北

    青森 弘前 深浦 むつ 八戸 秋田 横手 鷹巣 盛岡 二戸
    一関 宮古 大船渡 山形 米沢 酒田 新庄 仙台 古川 石巻
    白石 福島 郡山 白河 小名浜 相馬 若松 田島

    関東甲信越

    宇都宮 大田原 水戸 土浦 前橋 みなかみ さいたま 熊谷 秩父 東京
    大島 八丈島 父島 千葉 銚子 館山 横浜 小田原 甲府 河口湖
    長野 松本 諏訪 軽井沢 飯田 新潟 津川 長岡 湯沢 高田
    相川

    中部

    静岡 網代 石廊崎 三島 浜松 御前崎 富山 伏木 岐阜 高山
    名古屋 豊橋 福井 大野 敦賀 金沢 輪島

    関西

    大津 彦根 上野 四日市 尾鷲 京都 舞鶴 奈良 風屋
    和歌山 潮岬 大阪 神戸 姫路 洲本 豊岡

    中国・四国

    鳥取 米子 岡山 津山 松江 浜田 西郷 広島 福山
    庄原 下関 山口 柳井 高松 徳島 池田 日和佐 松山
    新居浜 宇和島 高知 室戸岬 清水

    九州・沖縄

    福岡 八幡 飯塚 久留米 佐賀 伊万里 長崎 佐世保 厳原 福江
    大分 中津 日田 佐伯 熊本 阿蘇乙姫 牛深 人吉 宮崎 油津
    延岡 都城 高千穂 鹿児島 阿久根 枕崎 鹿屋 種子島 名瀬 沖永良部
    那覇 名護 久米島 南大東島 宮古島 石垣島 与那国島

    その他

    海外

    HTTP ステータスコード一覧

    ステータスコード 内容
    200正常に応答を返却した場合
    400要求パラメータ不良の場合
    500サーバ内で予期せぬエラーが発生した場合
    よくあるご質問
    APIなどの各サービスに関するよくある質問を掲載します。
    お問い合わせ
    「docomo Developer support」及び「作ろうスマートフォン/iモードコンテンツ」に関するお問い合わせです。よくあるご質問や技術ブログで解決しない場合は、お問い合わせください。