ユーザー情報を取得・編集する方法(API一覧)
1.訪問者取得
REST APIから連携し、ユーザの情報を取得することができます。
※管理画面上で、外部連携>API入力>訪問者一覧取得( https://app.chatplus.jp/admin/cp/api/user-list )から詳細をご覧いただけます。
■リクエストURL
http://app.chatplus.jp/api/v1/get_lead?[parameter]=[value]……
[parameter]には、『入力パラメーター』の「パラメーター」を入れます。
[value]には、『入力パラメーター』の「値」を入れます。
■入力パラメーター一覧
■出力パラメーター一覧
訪問者取得API 出力パラメーター
例)登録日を指定して、指定した日以降に登録したユーザ情報を取得する場合
http://app.chatplus.jp/api/v1/get_lead?created_date_start=20170223
訪問者一覧(leads)パラメーター(※)は拡張
2.訪問者編集
REST APIまたは、タグ方式から連携し、ユーザの情報を更新することができます。
※管理画面上で、外部連携>API入力>訪問者編集( https://app.chatplus.jp/admin/cp/api/user-update)から、REST APIとタグ形式について詳細をご覧いただけます。
2-1.REST API
■リクエストURL
http://app.chatplus.jp/api/v1/update_user?[parameter]=[value]……
[parameter]には、『入力パラメーター』の「パラメーター」を入れます。
[value]には、『入力パラメーター』の「値」(対象のメールアドレス等)を入れます。
■入力パラメーター一覧
■出力パラメーター一覧
例)
http://app.chatplus.jp/api/v1/update_user?email=aa@×××.jp&name=山田太郎
※[value]部分は、UTF-8でURLエンコードしてください。
2-2.タグ方式
チャットウインドウのコードに、以下のコードを追加することで連携できます。
ユーザ登録している訪問者の情報を編集することができます。
"name":"名前"
, "companyName":"会社名"
, "tel":"電話番号"
, "email":"メールアドレス"
, "score":"スコア"
, "scoreType":"" //指定なし:scoreの値で書換、「+」:scoreの値で加算、「-」:scoreの値で減算
};
d["__cp_f"]={
"自由項目1":"値1"
, "自由項目2":"値2"
, .…
};
※チャットウインドウのコードは、管理画面左「チャット設置」>「タグ形式」をクリックすることで確認できます。