表示モード

チャットボット所属コンタクト一覧取得API ​

チャットボット所属コンタクト一覧取得APIは、チャットボットが結んでいるコンタクトの一覧を取得するAPIです。

リクエスト内容 ​

フィールド名フィールド値備考
actionlist_assign_contacts必須

「チャットボット所属コンタクト一覧取得API」であることを示します。
access_tokenAPIアクセスキー必須

チャットボットの作成方法はこちらを参照してください。
target日時｜unread任意
未指定時：絞り込みなし

サーバー時間(UTC)を基準に、指定した日時以降に結ばれたコンタクトで絞り込むことができます。
※ 日時は2026-01-23T09:00:00の形式で指定してください。
未読のあるコンタクトのみを取得したい場合は、unreadを指定してください。
limit1～100の数値任意
未指定時：100

最大取得件数を指定できます。
0以下の値や100より大きい値を指定した場合は100として扱われます。

リクエストの例 ​

sh
curl -X POST "https://your.domain/cgi-bin/chatlk/chatBot.cgi"
-F "action=list_assign_contacts"
-F "access_token=(APIアクセスキー)"
-F "target=2026-01-23T09:00:00"
-F "limit=10"

※ リクエスト先のURLは、お客様の環境に書き換えてください。
　 詳しくはリクエスト先のURLを参照してください。

レスポンス内容 ​

フィールド名フィールド値、意味
resultok=成功、ng=失敗
server_time成功した時のサーバー時間(UTC)
offset取得開始行数
all_count取得したコンタクト情報の件数
list.item取得したコンタクト情報の配列
※ コンタクト情報1件の内容は以下の表を参照してください。

コンタクト情報1件の内容 ​

フィールド名フィールド値、意味
user_idコンタクト相手のユーザーのシステムID
chat_idコンタクトのシステムID
user_nameコンタクト相手のユーザー名
user_typeコンタクト相手のユーザー種類。inner=組織内ユーザー、guest=ゲストユーザー
※ 組織の所属有無にかかわらず、ゲストユーザーを除くすべてのユーザーを「組織内ユーザー」として扱います。
unread_countコンタクトの未読数
company_nameコンタクト相手がゲストユーザーの場合の所属している組織
※ コンタクト相手がゲストユーザーではない場合は空になります。
main_groupコンタクト相手の代表組織のシステムID
assign_group.itemコンタクト相手が所属している組織情報の配列
※ 所属組織情報1件の内容は以下の表を参照してください。

所属組織情報1件の内容 ​

フィールド名フィールド値、意味
id所属組織のシステムID
value所属組織の名前

※ result以外の値はresult=okのときのみ含まれます。

※ result=ngのときのレスポンスについては共通仕様を参照してください。

レスポンス内容の例 ​

jsonc
// Content-Type: application/json
{
  "result": "ok",
  "server_time": "2026-04-10T09:00:00",
  "offset": "0",
  "all_count": "100",
  "list": {
    "item": [
      {
        "user_id": "1z68b0kdhr5z",
        "chat_id": "1z73v9fr20un",
        "user_name": "責任者",
        "user_type": "inner",
        "unread_count": "0",
        "company_name": "",
        "main_group": "000000000001",
        "assign_group": {
          "item": [
            {
              "id": "000000000001",
              "value": "情報システム室"
            },
            {
              "id": "1wkmq7ltrvo4",
              "value": "サンプル組織"
            }
          ]
        }
      },
      {
        "user_id": "1z73v9epocur",
        "chat_id": "1wmjhq9txsba",
        "user_name": "サンプルゲストユーザー",
        "user_type": "guest",
        "unread": "0",
        "company_name": "ゲスト組織",
        "main_group": "",
        "assign_group": {
          "item": []
        }
      },
      // 以降は省略
    ]
  }
}
Copyright © 2015-2026 NEOJAPAN Inc. All Rights Reserved.