Contacts

連絡先リスト所属を確認

連絡先がチャネルアカウントの連絡先リストに存在するか確認します。WhatsApp では連絡先 API が conversation_id として返す LID を使います。is_in_contacts=false は正常な 200 の否定結果です。

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

呼び出す前に

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

パラメーターの取得元

account_id: アカウント作成・取得応答の data.id を使います。識別子は X-Api-Key のワークスペースに属します。アカウント取得
contact_id: 連絡先所属の確認対象。WhatsApp では連絡先 API が conversation_id として返す LID を使い、クエリ文字列の @ を URL エンコードします。

リクエストパラメータ

ヘッダー

X-Api-Key

string必須

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

パスパラメータ

account_id

string必須

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

クエリパラメータ

contact_id

string必須

連絡先所属の確認対象。WhatsApp では連絡先 API が conversation_id として返す LID を使い、クエリ文字列の @ を URL エンコードします。

リクエストボディ

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

結果の確認

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

レスポンス 200 OK

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "contact_id": "123456789012345@lid",
    "is_in_contacts": true
  }
}

レスポンスボディ

contact_id

string

連絡先所属の確認に使用した識別子。

is_in_contacts

boolean

連絡先が対象アカウントのチャネル連絡先リストに存在するか。false は正常な否定結果です。

レスポンス

200

200 OK

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

400

Bad Request

リクエストボディ、パス、またはパラメータが不正です。

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 とワークスペースの有効性を確認します。