連絡先を追加
チャネルアカウントに連絡先を追加します。phone_number または username の少なくとも一方を指定します。whatsapp_options は WhatsApp のみで使用でき、未対応チャネルは 501 unsupported_by_provider を返します。
https://api.unifyport.ai/v1/accounts/{account_id}/contacts/addヘッダー
X-Api-Keyワークスペース API キー。このヘッダーからワークスペースを特定します。
Content-TypeJSON のリクエストボディを送る場合は application/json を使用します。
パスパラメータ
account_idcontacts ルートで使用される識別子。
リクエストボディ
phone_number国または地域コードを含む数字のみの電話番号。プラス記号、空白、区切り文字は含めません。phone_number または username を指定します。
usernameチャネルのユーザー名。username または phone_number を指定し、形式は対象チャネルに従います。
whatsapp_optionsobjectWhatsApp 専用の任意連絡先設定。first_name、full_name、sync_to_device_contacts は whatsapp_options 内にのみネストし、他のチャネルではこのオブジェクトを省略します。
whatsapp_optionsWhatsApp 専用の任意連絡先設定。first_name、full_name、sync_to_device_contacts は whatsapp_options 内にのみネストし、他のチャネルではこのオブジェクトを省略します。
first_nameWhatsApp 連絡先の任意の名。
full_nameWhatsApp 連絡先の任意の氏名。
sync_to_device_contacts現在の WhatsApp アカウントに関連付けられた端末のシステム連絡先にも保存するか。デフォルトは false。
レスポンスボディ
id連絡先識別子。
conversation_idこの連絡先の会話識別子。メッセージ送信やチャットの特定に使用します。
display_name連絡先の表示名。ない場合は空文字列。
avatar_url連絡先のアバター URL。ない場合は空文字列。
provider_user_id連絡先のプロバイダ側ユーザー識別子。
is_blocked接続アカウントがこの連絡先をブロックしているかどうか。
extraphone などプロバイダ固有の追加フィールド。
レスポンス
200リクエスト成功。レスポンスボディの例を参照してください。
400リクエストボディ、パス、またはパラメータが不正です。
401X-Api-Key ヘッダが欠落しているか無効です。
409要求された操作が、既存のプロバイダアカウントまたはリソースと競合しています。
500サービスで予期しないエラーが発生しました。
501選択したプロバイダはこの操作を実装していません。
502プロバイダアダプタまたは上流サービスが操作を完了できませんでした。
リクエスト
curl -X POST https://api.unifyport.ai/v1/accounts/{account_id}/contacts/add \
-H "X-Api-Key: <YOUR_API_KEY>" \
-H "Content-Type: application/json" \
-d '{
"phone_number": "8600000000000",
"username": "alice_user",
"whatsapp_options": {
"first_name": "Alice",
"full_name": "Alice Example",
"sync_to_device_contacts": false
}
}'レスポンス
{
"data": {
"id": "8600000000000@s.whatsapp.net",
"conversation_id": "123456789012345@lid",
"display_name": "Alice Example",
"avatar_url": "",
"provider_user_id": "8600000000000@s.whatsapp.net",
"extra": { "phone": "8600000000000" }
}
}