建立或接管聯絡人

cURL

curl --request POST 'https://api.brightalk.ai/contacts' \
  --header "Authorization: Bearer $BRIGHTALK_API_KEY" \
  --header "Brightalk-Version: 2026-07-16" \
  --header "Content-Type: application/json" \
  --data '{"external_id":"customer-8421","name":"Example Customer","phone_number":"+12025550123"}'

const response = await fetch("https://api.brightalk.ai/contacts", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGHTALK_API_KEY}`,
    "Brightalk-Version": "2026-07-16",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"external_id":"customer-8421","name":"Example Customer","phone_number":"+12025550123"}),
});
console.log(response.status, await response.json());

import os
import requests

response = requests.request(
    "POST",
    "https://api.brightalk.ai/contacts",
    headers={
    "Authorization": f"Bearer {os.environ['BRIGHTALK_API_KEY']}",
    "Brightalk-Version": "2026-07-16",
    "Content-Type": "application/json",
    },
    json={"external_id":"customer-8421","name":"Example Customer","phone_number":"+12025550123"},
)
print(response.status_code, response.json())

{
  "id": "con_demo_001",
  "external_id": "customer-8421",
  "source": "public_api",
  "name": "Example Customer",
  "phone_number": "+12025550123",
  "email": "customer@example.com",
  "company": "Example Co.",
  "role": "Operations Manager",
  "city": "Taipei",
  "country": "TW",
  "created_at": "2026-07-20T01:00:00Z",
  "updated_at": "2026-07-20T01:00:00Z"
}

POST

contacts

cURL

curl --request POST 'https://api.brightalk.ai/contacts' \
  --header "Authorization: Bearer $BRIGHTALK_API_KEY" \
  --header "Brightalk-Version: 2026-07-16" \
  --header "Content-Type: application/json" \
  --data '{"external_id":"customer-8421","name":"Example Customer","phone_number":"+12025550123"}'

const response = await fetch("https://api.brightalk.ai/contacts", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGHTALK_API_KEY}`,
    "Brightalk-Version": "2026-07-16",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"external_id":"customer-8421","name":"Example Customer","phone_number":"+12025550123"}),
});
console.log(response.status, await response.json());

import os
import requests

response = requests.request(
    "POST",
    "https://api.brightalk.ai/contacts",
    headers={
    "Authorization": f"Bearer {os.environ['BRIGHTALK_API_KEY']}",
    "Brightalk-Version": "2026-07-16",
    "Content-Type": "application/json",
    },
    json={"external_id":"customer-8421","name":"Example Customer","phone_number":"+12025550123"},
)
print(response.status_code, response.json())

{
  "id": "con_demo_001",
  "external_id": "customer-8421",
  "source": "public_api",
  "name": "Example Customer",
  "phone_number": "+12025550123",
  "email": "customer@example.com",
  "company": "Example Co.",
  "role": "Operations Manager",
  "city": "Taipei",
  "country": "TW",
  "created_at": "2026-07-20T01:00:00Z",
  "updated_at": "2026-07-20T01:00:00Z"
}

授權

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}$

主體

application/json

JSON request body. The raw encoded body is limited to 1 MiB and unknown fields are rejected.

external_id

string

必填

會移除前後空白；剩餘值必須包含 1–255 個字元。

Pattern: ^\s*\S(?:[\s\S]{0,253}\S)?\s*$

範例:

"customer-8421"

name

string

必填

會移除前後空白；剩餘值必須包含 1–255 個字元。

Pattern: ^\s*\S(?:[\s\S]{0,253}\S)?\s*$

範例:

"Example Customer"

phone_number

string

必填

嚴格的 E.164 電話號碼。

Pattern: ^\+[1-9]\d{7,14}$

範例:

"+12025550123"

source

string

預設值:public_api

允許清單中的身分命名空間。省略時使用 public_api。

Pattern: ^[a-z][a-z0-9_-]{0,63}$

範例:

"public_api"

string<email> | null

Maximum string length: 320

範例:

"customer@example.com"

company

string | null

會移除前後空白；剩餘值最多可包含 255 個字元。

Pattern: ^\s*(?:\S(?:[\s\S]{0,253}\S)?)?\s*$

範例:

"Example Co."

role

string | null

會移除前後空白；剩餘值最多可包含 255 個字元。

Pattern: ^\s*(?:\S(?:[\s\S]{0,253}\S)?)?\s*$

範例:

"Operations Manager"

city

string | null

會移除前後空白；剩餘值最多可包含 255 個字元。

Pattern: ^\s*(?:\S(?:[\s\S]{0,253}\S)?)?\s*$

範例:

"Taipei"

country

string | null

會移除前後空白；剩餘值最多可包含 255 個字元。

Pattern: ^\s*(?:\S(?:[\s\S]{0,253}\S)?)?\s*$

範例:

"TW"

回應

已更新或接管既有聯絡人。

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"

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"

列出聯絡人取得聯絡人

⌘I

開始使用

API 基礎

核心概念

操作指南

發布資訊

API 參考

授權

標頭

主體

回應