CXトーク API は、CXトークの問い合わせや連絡先の管理をすることができます。
CXトーク API の利用には、LINE WORKS CXトーク オプションが必要です。
管理者による User Account 認証、または Service Account 認証 (JWT) で取得した Access Token で利用できます。
Scopes: cxtalk, cxtalk.read
CXトークの連絡先には、外部相談チャンネルを通して問い合わせがあった相談者の連絡先が保存されます。社内の相談経路を通した相談者の連絡は保存されません。
CXトークの連絡先は、以下の API で管理します。
API による連絡先の作成はできません。
| HTTP Request | Description |
|---|---|
| GET /cxtalk/contacts | CXトーク - 連絡先リストの取得 |
| GET /cxtalk/contacts/search | CXトーク - 連絡先の検索 |
| GET /cxtalk/contacts/{contactId} | CXトーク - 連絡先の取得 |
| PUT /cxtalk/contacts/{contactId} | CXトーク - 連絡先の更新 |
| PATCH /cxtalk/contacts/{contactId} | CXトーク - 連絡先の部分更新 |
| DELETE /cxtalk/contacts/{contactId} | CXトーク - 連絡先の削除 |
| DELETE /cxtalk/contacts/{contactId}/force-delete | CXトーク - 連絡先の即時削除 |
CXトークの連絡先タグは、以下の API で管理します。
| HTTP Request | Description |
|---|---|
| GET /cxtalk/contact-tags | CXトーク - 連絡先タグリストの取得 |
| POST /cxtalk/contact-tags | CXトーク - 連絡先タグの登録 |
| GET /cxtalk/contact-tags/{contactTagId} | CXトーク - 連絡先タグの取得 |
| PATCH /cxtalk/contact-tags/{contactTagId} | CXトーク - 連絡先タグの部分更新 |
| DELETE /cxtalk/contact-tags/{contactTagId} | CXトーク - 連絡先タグの削除 |
以下の API を利用して、対応履歴と、対応履歴内の会話を確認できます。
| HTTP Request | Description |
|---|---|
| GET /cxtalk/conversations | CXトーク - 対応履歴リストの取得 |
| GET /cxtalk/conversations/{conversationId}/messages | CXトーク - 対応履歴内のメッセージリストの取得 |
| GET /cxtalk/conversations/{conversationId}/attachments/{fileId} | CXトーク - 対応履歴内の添付ファイルのダウンロード |