LiveAgent では、皆様の業務によりよく活用していただけるよう API をご用意しています。多くの開発者にご利用いただけるよう、各種 API のドキュメントおよびサンプルコードについて、少しずつですがご紹介していきたいと思います。
LiveAgent で利用可能な API
目次
-
【フォーマット】
-
【API 利用サンプル】
-
【REST API v.1】
- エージェント
- アプリケーション
- 会話（スマートチケット）
- 顧客情報（コンタクト）
- 顧客グループ
- エージェントのチーム
- ナレッジベース
- スマートチケットのタグ
データフィールドのフォーマット
| 変数 | 内容 |
|---|---|
| datetime | 日付の表示は、次の書式が適用されます: YYYY-MM-DD HH:MM:SS. 注: 日付の表示はデフォルトで「太平洋標準時（UTC-8）」が適用されます |
| text | 任意の文字列または空欄 |
| constlist | 有限集合の中のただ1つのインスタンスです。可用値は、特定フィールドの定義で指定されています。 |
| int | 0以上の整数値 |
| list | エンティティのリスト。すべてのエンティティは、その特定の列の定義を持っています。 |
| opdatetime | 演算子の日付。このフィールドの書式は、以下のような演算子を用いない場合 'datetime' と共通となります。 利用可能な演算子：
|
出力データの形式
LiveAgent API から出力されるデータは JSON 形式がデフォルトとなっています。XML 形式で出力する場合は、API の呼び出し URL の末尾に ".xml" を付け加えることで対応します。
例 1） 次の URL から呼び出す際は、JSON 形式のデータを出力します。GET
http://example.com/api/agents/john@agent.com例 2） 上記 URL の末尾に .xml を加えることで、XML 形式のデータ出力に対応します。
GET
http://example.com/api/agents/john@agent.com.xml注: お使いの PHP で PHP YAML 拡張が有効な場合、URL の末尾に".yaml" を加えることで YAML 形式の出力にも対応します。
エラーメッセージの形式
- 400 - Bad request
-
アプリケーション内の API キーの問題による、API キーの認証エラー時に表示されます。
- 401 - Forbidden
-
誤った API キー利用による認証エラー時に表示されます。
- 404 - Not found
-
「入力したメールアドレスに該当するエージェントが見つからない」場合に表示されます。
- 500 - Common porcessing error
-
これは最も多いエラー形式です。「パラメータのメッセージが見つからない」場合や「会話の読み込みができない」場合に表示されます。
- 503 - Service Unavailable
-
プロセス要求（アップデートやインストールなど）に対しアプリケーションが無効である場合に表示されます。
| Error response example | |
|---|---|
|
XML
|
<?xml version="1.0" encoding="utf-8"?> <response> <status>ERROR</status> <statuscode>500</statuscode> <errormessage>Example error message</errormessage> <debugmessage>debug info</debugmessage> </response> |
|
JSON
|
{
"response":{
"status":"ERROR",
"statuscode":500,
"errormessage":"Example error message",
"debugmessage":"debug info"
}
}
|
現在利用可能な API のリファレンスはこちら（英語ページ）をご参照ください
