growing hard days.

docomo Developer supportの雑談対話APIから自然対話APIへ移行しました

2018/08/03 2019/03/23

LINEやSlackのbotで重宝していた、雑談対話APIが終了する、とのことですので、後継の自然対話APIへ移行しました。
(2018年8月時点の情報です。2019年6月に自然対話APIサービスは終了します。)

目次

API利用申請

docomo Developer support のマイページにログインして、新たにAPI利用申請を行いました。
「自然対話：雑談対話」を選択しました。

ユーザー登録

API経由でユーザー登録をして、アプリケーションIDを取得しなければなりません。

初回のみですので、PostmanからPOSTして取得しました。

リクエスト情報

リクエストURL

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

リクエストヘッダ

Content-Type : application/json;charset=UTF-8

パラメータ

APIKEY : (API利用申請により発行されたAPI key)

リクエストボディ

{
    "botId": "Chatting",
    "appKind": "Smart Phone"
}

1

2

3

4

5

{

"botId": "Chatting",

"appKind": "Smart Phone"

}

botIdのChattingは固定。
appKindは任意ですが、サンプルのままにしました。

レスポンス

{
    "appId": (アプリケーションID)
}

1

2

3

4

{

"appId": (アプリケーションID)

}

実装例

Pythonで実装して、API Gateway + Lambdaで動かす想定の実装例です。

import requests, json

docom_app_id = '(アプリケーションID)'
docomo_api_key = '(API key)'
docomo_endpoint = 'https://api.apigw.smt.docomo.ne.jp/naturalChatting/v1/dialogue?APIKEY={api_key}'.format(
    api_key=docomo_api_key
)

headers = {
    'Content-type': 'application/json;charset=UTF-8'
}

payload = {
    "language": "ja-JP",
    "botId": "Chatting",
    "appId": docom_app_id,
    "voiceText": (発信するテキスト),
    "appRecvTime": "2018-08-02 22:44:22",
    "appSendTime": datetime.now().strftime("%Y-%m-%d %H:%M:%S")
}

response = requests.post(
　　　　docomo_endpoint, 
　　　　data=json.dumps(payload), 
　　　　headers=headers
)

data = response.json()
return data['systemText']['expression']

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

import requests, json

docom_app_id = '(アプリケーションID)'

docomo_api_key = '(API key)'

docomo_endpoint = 'https://api.apigw.smt.docomo.ne.jp/naturalChatting/v1/dialogue?APIKEY={api_key}'.format(

api_key=docomo_api_key

)

headers = {

'Content-type': 'application/json;charset=UTF-8'

}

payload = {

"language": "ja-JP",

"botId": "Chatting",

"appId": docom_app_id,

"voiceText": (発信するテキスト),

"appRecvTime": "2018-08-02 22:44:22",

"appSendTime": datetime.now().strftime("%Y-%m-%d %H:%M:%S")

}

response = requests.post(

　　　　docomo_endpoint,

　　　　data=json.dumps(payload),

　　　　headers=headers

)

data = response.json()

return data['systemText']['expression']

無事、動きました。

雑談対話以外にも、FAQ、意図解釈、知識検索、キャラクタ変換？などなどあるみたいなので、今後試してみようと思います。
docomoさん、いつもありがとう。

最後までお読みいただきましてありがとうございました！

「AWS認定資格試験テキスト＆問題集　AWS認定ソリューションアーキテクト - プロフェッショナル改訂第2版」という本を書きました。

「AWS認定資格試験テキスト AWS認定クラウドプラクティショナー改訂第3版」という本を書きました。

「AWS認定資格試験テキスト　AWS認定AIプラクティショナー」という本を書きました。

「ポケットスタディ AWS認定デベロッパーアソシエイト［DVA-C02対応］」という本を書きました。

「要点整理から攻略するAWS認定ソリューションアーキテクト-アソシエイト」という本を書きました。

「AWSではじめるLinux入門ガイド」という本を書きました。

開発ベンダー5年、ユーザ企業システム部門通算9年、ITインストラクター5年目でプロトタイプビルダーもやりだしたSoftware Engineerです。
質問はコメントかSNSなどからお気軽にどうぞ。
出来る限りなるべく答えます。

このブログの内容/発言の一切は個人の見解であり、所属する組織とは関係ありません。
このブログは経験したことなどの共有を目的としており、手順や結果などを保証するものではありません。
ご参考にされる際は、読者様自身のご判断にてご対応をお願いいたします。

また、勉強会やイベントのレポートは自分が気になったことをメモしたり、聞いて思ったことを書いていますので、登壇者の意見や発表内容ではありません。

- API, Python api, docomo, python

Tweet

関連記事

: A3RTのTalk APIエンドポイントが変更していたので修正しました

チャットボットのAPIでA3RTのTalk APIを使った LINEやTeams …

: PythonでHTMLエスケープされた全角ハイフンをアンエスケープする

PythonでHTMLエスケープとアンエスケープについて調べていると、 xml. …

: SendGrid(Python)で添付ファイル付きのメールを送信する

SendGridを使って添付ファイル付きのメールを送信するサンプルをPython …

: 「大阪Pythonユーザの集まり」に行ってきました

「大阪Pythonユーザの集まり」に行ってきました。あんまりメモ取れてません …

: Slackでチームを作成してbotから投稿出来るようにする

Slackで新しいチームを作成して、botが投稿出来るように設定します。 ※20 …

: Rocket.ChatのAPIでユーザーを一括登録する

Rocket.Chatの管理画面にインポートのメニューはあって、どうやらuser …

: SendGrid(sendgrid_python)でメール送信してイベントの情報からメール本文をたどれるようにしておく

動的に生成するメールで実際にどんな本文が送信されたかを記録しておきたいときもある …

: Python SQLAlchemy MySQLでcase文を使う

PythohのORMライブラリSQLAlchemyでMySQLのテーブルSele …

: Feedly APIのタグストリームとカテゴリストリームの取得

以前からタグのストリームだけ取得していて、タグ付けをする前のカテゴリからストリー …

: チャットボットのAPIでA3RTのTalk APIを使った

Microsoft TeamsのOutgoing Webhooksを使ってAWS …

PREV: 2,999円の体重・体組成計を買ってみたら意外に良かった
NEXT: 再会の日 ~re:Union 2018 Osaka by JAWS-UG~