表示モード
チャットボットAPIの概要
チャットボットAPIは、チャットボットが所属するルームの一覧を取得や
チャットボットとしてメッセージを取得・送信できるAPIです。
チャットボットAPIには、以下のAPIが存在します。
| カテゴリ | API名 |
|---|---|
| 一覧取得系API | チャットボット所属ルーム一覧取得API |
| チャットボット所属コンタクト一覧取得API | |
| チャットボット所属ルームのメッセージ一覧取得API | |
| チャットボット所属コンタクトのメッセージ一覧取得API | |
| メッセージ投稿系API | チャットボットマイルームメッセージ投稿API |
| チャットボット所属ルームメッセージ投稿API | |
| チャットボット所属コンタクトメッセージ投稿API |
リクエスト先のURL
お客様の環境によって異なりますので、環境に合わせたURLをご利用ください。
| ご利用パッケージ | リクエスト先のURL |
|---|---|
| Linux版 | http://(your.domain)/cgi-bin/chatlk/chatBot.cgi または https://(your.domain)/cgi-bin/chatlk/chatBot.cgi |
| Windows版 | http://(your.domain)/scripts/chatlk/chatBot.exe または https://(your.domain)/scripts/chatlk/chatBot.exe |
※ 「(your.domain)」は、お客様の環境に読み替えてください。
※ 本URLは標準インストールした場合です。インストール先が異なる場合は読み替えてください。
APIを利用するための準備
チャットボットの作成方法
チャットボットAPIを利用するには、チャットボットの作成が必要です。
- システム管理者権限のユーザーでログインして、システム管理者設定画面を表示します。
- 左側のメニューから「外部サービス連携設定」の「チャットボット管理」を選択して、
チャットボット一覧画面を表示します。 - 「チャットボットの作成」ボタンをクリックして、チャットボットの作成画面を表示します。
- 「APIアクセスキー」の項目を「発行する」に変更します。
- チャットボットを作成します。
- 作成したチャットボットが一覧に追加されていますので、
「APIアクセスキー」の「コピー」を行うことでAPIアクセスキーを取得します。