連絡先リスト
連絡先リストを作成、検索し、自分のシステムで収集した登録者や顧客を追加して、Oblic のキャンペーンや自動化で連絡できるようにします。これらのルートには contacts:manage を持つキーが必要で、組織の既定のワークスペースで動作します。
リストに連絡先を追加する
リクエスト本文は連絡先の配列です。各連絡先には名前と、メールアドレス、電話番号、WhatsApp 番号のうち少なくとも一つが必要です。
- 名前
name- タイプ
- string
- 説明
必須:連絡先の名前。英字、数字、スペース、
'、,、-を使用できます。éなど、A〜Z 以外の文字は拒否されます。
- 名前
email- タイプ
- string
- 説明
連絡先のメールアドレス。
- 名前
phone- タイプ
- string
- 説明
国番号を含み、
+を付けない、10 桁以上の電話番号。例:919812345678。
- 名前
whatsApp- タイプ
- string
- 説明
国番号を含み、
+を付けない、10〜15 桁の WhatsApp 番号。
- 名前
source- タイプ
- string
- 説明
連絡先の取得元。例:
Website。最初の連絡先の値がリクエスト内の全連絡先に適用され、省略するとCustomになります。
この呼び出しでリストに追加される各連絡先について、このリストの「オーディエンスグループに参加」をトリガーとする自動化とジャーニーを開始するには、?startJourneys=true を追加します。指定しなければ source にかかわらず何も開始しません。システムから送られた連絡先は、新規登録とは見なされません。すでにリストにある連絡先は何も開始せず、一度退出してから再追加された連絡先は再び開始します。
二つの連絡先を追加する
curl -X POST https://api.oblic.app/external/contact-list/v1/CLT000R7ZM4Q2VXH00/add \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '[
{ "name": "Asha Rao", "email": "asha@example.org", "source": "Website" },
{ "name": "Ravi Kumar", "phone": "919812345678", "whatsApp": "919812345678" }
]'
応答は 200 で、data は null です。メールアドレスは小文字で保存されます。
| 拒否 | cd | 条件 |
|---|---|---|
| 400 | BAD_REQUEST またはフィールド名 | 配列が空、ページ分割が無効、または連絡先の検証に失敗しました。メッセージはリクエストの言語によって変わります。 |
| 400 | INVALID_CONTACT_LIST | ワークスペースにその ID のリストがありません |
拒否を分類する際は、メッセージの文言ではなく cd を使います。応答形式についてはエラーを参照してください。
連絡先リストを取得する
ワークスペースのリストを新しい順で、limit 件ずつ取得します。開始位置は nextIndex で、初期値は 0 です。search は、大文字と小文字を区別せず、指定した文字列を名前に含むリストに絞り込みます。limit は 1 以上でなければなりません。
最初の 50 件のリスト
curl -G https://api.oblic.app/external/contact-list/v1/0/50 \
-H 'Authorization: Bearer YOUR_API_KEY' \
-d search=newsletter
応答
{
"status": "success",
"data": {
"contacts": [
{ "id": "CLT000R7ZM4Q2VXH00", "name": "Newsletter", "count": 1284 }
],
"moreIndicator": "N",
"nextIndex": ""
},
"errors": null
}
contactsにはリストが入り、それぞれの連絡先数がcountに含まれます。- さらにリストがある間、
moreIndicatorはYとなり、nextIndexが次のページの開始位置を示します。
連絡先リストを作成する
リストを作成する
curl -X POST https://api.oblic.app/external/contact-list/v1/add \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{ "name": "Website sign-ups" }'
応答には新しいリスト {"id": …, "name": "Website sign-ups", "count": 0} が含まれます。最初のルートで連絡先を追加してください。複数のリストに同じ名前を付けられます。