連絡先を作成

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

リクエストメソッド

POST

リクエスト URL

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

認証

認証方式の詳細については、API 概要を参照してください。

リクエスト

リクエスト例

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)' \ { "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)' \
{
    "inbox_id": 407,
    "name": "Test",                   // 任意
    "email": "alice@acme.inc",
    "phone_number": "+123456789", 
    "avatar_url": "https://example.com/avatar.png",
    "identifier": "1234567890",
}

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

リクエストヘッダー

フィールド	型	説明
Authorization	string	認証には `Authorization: Basic base64(API Key:API Secret)` を使用します。API Key ページで API Key と API Secret を取得し、コロンで連結した後に Base64 エンコードしてください。
Content-Type	application/json	リクエストのデータ形式です。`application/json` を使用します。

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

フィールド	型	必須	説明
inbox_id	String	はい	チャネル ID。「プロジェクト設定 - チャネル - 対象チャネル - 設定」の Channel ID に対応します。
name	String	いいえ	連絡先名。
email	String	いいえ	メールアドレス。
phone_number	String	いいえ	連絡先の電話番号。
avatar_url	String	いいえ	アバター画像のリンク。
identifier	String	いいえ	ユーザー識別子。

レスポンス

レスポンス例

{ "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
        }
    }
}

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

レスポンスパラメータ

フィールド	型	必須	説明
additional_attributes	Object	いいえ	追加属性。
availability_status	String	いいえ	オンライン状態。デフォルトは `offline` です。
email	String	いいえ	メールアドレス。
id	String	いいえ	連絡先 ID。
name	String	いいえ	名前。
phone_number	String	いいえ	電話番号。
blocked	String	いいえ	ブロックされているかどうか。デフォルトは `false` です。
identifier	String	いいえ	ユーザー識別子。
thumbnail	String	いいえ	サムネイル。
custom_attributes	String	いいえ	カスタム属性。
created_at	String	いいえ	作成タイムスタンプ。
contact_inboxes	Array	いいえ	連絡先に紐づく受信箱一覧。
inbox	String	いいえ	チャネル。
source_id	String	いいえ	ソース ID。