連絡先を作成 | LiveDesk API 日本語

開発者は、API を通じて連絡先を作成できます。

リクエストメソッド

POST

リクエスト URL

https://livedesk-api.engagelab.com/api/v2/accounts/contacts

認証

詳細については、API Overview の認証手順を参照してください。

リクエスト

リクエスト例

curl -X POST 'https://livedesk-api.engagelab.com/api/v2/accounts/contacts' \ -H 'Content-Type: application/json' \ -H 'Authorization: Basic base64(api_key:api_secret)' \ -d '{ "inbox_id": 407, "name": "Test", "email": "alice@acme.inc", "phone_number": "+123456789", "avatar_url": "https://example.com/avatar.png", "identifier": "1234567890" }'

              
              curl -X POST 'https://livedesk-api.engagelab.com/api/v2/accounts/contacts' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Basic base64(api_key:api_secret)' \
  -d '{
    "inbox_id": 407,
    "name": "Test",
    "email": "alice@acme.inc",
    "phone_number": "+123456789",
    "avatar_url": "https://example.com/avatar.png",
    "identifier": "1234567890"
  }'

このコードブロックはフローティングウィンドウ内に表示されます

リクエストヘッダー

Field	Type	Description
Authorization	string	`Authorization: Basic base64(API Key:API Secret)` を使用して認証します。API Keys ページで API Key と API Secret を取得し、コロン（`:`）で連結したうえで、結果を Base64 エンコードしてください。
Content-Type	application/json	データ形式。通常のテキストメッセージには `application/json` を使用します。

リクエストボディパラメータ

Field	Type	Required	Description
inbox_id	String	Yes	チャネル ID。Project Settings > Channels > Specific Channel > Settings の Channel ID に対応します。
name	String	No	連絡先名。
email	String	No	メールアドレス。
phone_number	String	No	電話番号。
avatar_url	String	No	アバター画像の URL。
identifier	String	No	ユーザー識別子。

レスポンス

レスポンス例

{ "payload": { "contact": { "additional_attributes": {}, "availability_status": "offline", "email": null, "id": 2219259, "name": "Test", "phone_number": null, "blocked": false, "identifier": null, "thumbnail": "", "custom_attributes": {}, "created_at": 1766571703, "contact_inboxes": [] }, "contact_inbox": { "inbox": null, "source_id": null } } }

              
              {
  "payload": {
    "contact": {
      "additional_attributes": {},
      "availability_status": "offline",
      "email": null,
      "id": 2219259,
      "name": "Test",
      "phone_number": null,
      "blocked": false,
      "identifier": null,
      "thumbnail": "",
      "custom_attributes": {},
      "created_at": 1766571703,
      "contact_inboxes": []
    },
    "contact_inbox": {
      "inbox": null,
      "source_id": null
    }
  }
}

このコードブロックはフローティングウィンドウ内に表示されます

レスポンスパラメータ

Field	Type	Required	Description
additional_attributes	Object	No	追加属性。
availability_status	String	No	オンラインステータス。デフォルト値は `offline` です。
email	String	No	メールアドレス。
id	String	No	連絡先 ID。
name	String	No	名前。
phone_number	String	No	電話番号。
blocked	String	No	連絡先がブロックされているかどうかを示します。デフォルト値は `false` です。
identifier	String	No	ユーザー識別子。
thumbnail	String	No	サムネイル画像の URL。
custom_attributes	String	No	顧客属性。
created_at	String	No	作成タイムスタンプ。
contact_inboxes	Array	No	連絡先に関連付けられた受信箱情報の一覧。
inbox	String	No	チャネル。
source_id	String	No	ソース ID。