跳轉到主要內容
GET
cURL

授權

Authorization
string
header
必填

Use a private-beta server credential in the Authorization header.

標頭

Brightalk-Version
string
預設值:2026-07-16

選擇以日期為基礎的 API 版本。省略時會使用組織鎖定的私人測試版預設值。

Allowed value: "2026-07-16"
X-Request-Id
string

由呼叫端產生且符合 [A-Za-z0-9._:-]{1,64} 的關聯值。無效值會被取代。

Maximum string length: 64
Pattern: ^[A-Za-z0-9._:-]{1,64}$

路徑參數

contact_id
string
必填

不透明的 Contact 識別碼。 不透明的資源識別碼。

Required string length: 1 - 255
範例:

"con_demo_001"

回應

已傳回聯絡人。

id
string
必填

不透明的資源識別碼。

Required string length: 1 - 255
範例:

"con_demo_001"

external_id
string | null
必填

由呼叫端管理的外部身分。

範例:

"customer-8421"

source
string | null
必填

外部身分命名空間。

範例:

"public_api"

name
string
必填
範例:

"Example Customer"

phone_number
string
必填
Pattern: ^\+[1-9]\d{7,14}$
範例:

"+12025550123"

email
string | null
必填

聯絡人的電子郵件地址。

範例:

"customer@example.com"

company
string | null
必填

聯絡人的公司。

範例:

"Example Co."

role
string | null
必填

聯絡人的職務。

範例:

"Operations Manager"

city
string | null
必填

聯絡人的城市。

範例:

"Taipei"

country
string | null
必填

聯絡人的國家或地區。

範例:

"TW"

created_at
string<date-time>
必填

聯絡人的建立時間。

範例:

"2026-07-20T01:00:00Z"

updated_at
string<date-time>
必填

聯絡人上次更新的時間。

範例:

"2026-07-20T01:00:00Z"