Contacts

ブロックリスト取得

ブロック済み連絡先識別子の全リストを返します。dhash はリストのフィンガープリントで、キャッシュして次回呼び出し時に比較すれば、配列全体を diff せずに変更を検知できます。

GEThttps://api.unifyport.ai/v1/accounts/{account_id}/contacts/blocklist

呼び出す前に

対象ワークスペースの X-Api-Key をサーバー側で使用します。実行前にすべてのプレースホルダーを置き換えます。

パラメーターの取得元

account_id: アカウント作成・取得応答の data.id を使います。識別子は X-Api-Key のワークスペースに属します。アカウント取得

リクエストパラメータ

ヘッダー

X-Api-Key

string必須

ワークスペース API キー。このヘッダーからワークスペースを特定します。

パスパラメータ

account_id

string必須

contacts ルートで使用される識別子。

リクエストボディ

このエンドポイントは JSON ボディを必要としません。

結果の確認

記載された応答項目と HTTP 状態を確認します。204 成功には本文がありません。診断には X-Request-Id を使い、次は関連操作を参照します。

レスポンス 200 OK

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "blocklist": [
      "user_example",
      "user_other"
    ],
    "dhash": "2:abcdef123456"
  }
}

レスポンスボディ

blocklist[]

string[]

ブロックされた連絡先識別子の配列。

dhash

string

ブロックリストのフィンガープリント。キャッシュして次回の呼び出しと比較すれば、配列を差分計算せずに変更を検出できます。

レスポンス

200

200 OK

リクエスト成功。レスポンスボディの例を参照してください。

401

Unauthorized

X-Api-Key ヘッダが欠落しているか無効です。

409

Conflict

要求された操作が、既存のプロバイダアカウントまたはリソースと競合しています。

500

Internal Server Error

サービスで予期しないエラーが発生しました。

501

Not Implemented

選択したプロバイダはこの操作を実装していません。

502

Bad Gateway

プロバイダアダプタまたは上流サービスが操作を完了できませんでした。

失敗時の対応

HTTP 状態と error.code/numeric_code を確認し、request_id を保存します。原因に応じてパラメーター修正・認証・状態確認を行い、送信や書き込みの再試行前に前回の結果を確認します。エラーリファレンス

invalid_request · 10000 · 400: 必須項目、形式、チャネルの条件を確認して修正します。
invalid_api_key · 11001 · 401: X-Api-Key とワークスペースの有効性を確認します。