一般規則
APIリクエスト形式
https://email.api.engagelab.cc/v1/<module>/<action>
モジュール: 機能モジュールの名前。例: mail（メールモジュール）、address_list（アドレスリスト）など。
Action: 各モジュールの操作、例えば送信や追加。
APIレスポンスコード
APIから返される結果はJSON形式で、以下のように表示されます:
# リクエスト成功
{
"result": {}
}
# 認証失敗
{
"code": 30000,
"message": "Authentication failed",
}
# データ取得成功
{
"total": 28,
"count": 28,
"result": [
{
"label_id": 598802,
"label_name": "xjm226",
"create_time": "2022-11-10T15:47:05+0800",
"update_time": "2022-11-10T15:47:05+0800"
}
]
}
# リクエスト成功
{
"result": {}
}
# 認証失敗
{
"code": 30000,
"message": "Authentication failed",
}
# データ取得成功
{
"total": 28,
"count": 28,
"result": [
{
"label_id": 598802,
"label_name": "xjm226",
"create_time": "2022-11-10T15:47:05+0800",
"update_time": "2022-11-10T15:47:05+0800"
}
]
}
このコードブロックはフローティングウィンドウ内に表示されます
- httpStatus: 200
- result: Data information
HTTPステータスコード
| ステータス | 説明 | 意味 |
|---|---|---|
| 200 | 成功 | レスポンス成功 |
| 400 | 不正リクエスト | ユーザーリクエストエラー |
| 401 | 認証失敗 | 認証に失敗しました |
| 404 | 見つかりません | リクエストされたリソースが存在しません |
| 500 | サーバーエラー | サーバーエラー、通常はサーバーがユーザーパラメータを正しく処理できない場合に発生します（この場合、リクエストが成功したかどうかを判断できません）。 |
メール形式の説明
メールアドレス形式: local_part@domain_part、local_part、@、およびdomain_partで構成されます。有効なメールアドレスは以下のルールを満たす必要があります:
- local_part@domain_partは最小6文字、最大128文字である必要があります;
- local_part文字列の最大長は96文字で、@文字を含むことはできません;
- domain_partはa-zA-Z0-9-.のみを含むことができ、-で始まったり終わったりすることはできません。全体の長さは255文字を超えず、各セグメントは63文字を超えず、トップレベルドメインは2〜20文字の大文字または小文字の英字で構成される必要があります;
タイムゾーン辞書
| ゾーン | 説明 |
|---|---|
| -12 | 国際日付変更線西 |
| -11 | 協定世界時-11 |
| -10 | アリューシャン列島（ハワイ） |
| -9 | アラスカ（協定世界時-09） |
| -8 | バハ・カリフォルニア（協定世界時-08、太平洋時間[米国＆カナダ]） |
| -7 | アリゾナ（チワワ、ラパス、マサトラン、山岳時間[米国＆カナダ]、ユーコン） |
| -6 | 中央アメリカ（中部時間[米国＆カナダ]、イースター島、グアダラハラ、メキシコシティ、モンテレー、サスカチュワン） |
| -5 | ボゴタ、リマ、キト、リオブランコ（チェトゥマル、東部時間[米国＆カナダ]、ハイチ、ハバナ、インディアナ[東部]、タークス・カイコス） |
| -4 | アスンシオン（大西洋時間[カナダ]、カラカス、クイアバ、ジョージタウン、ラパス、マナウス、サンファン、サンティアゴ） |
| -3 | アラグアイナ（ブラジリア、カイエンヌ、フォルタレザ、ブエノスアイレス市、グリーンランド、モンテビデオ、プンタアレナス、サンピエール・ミクロン、サルバドール） |
| -2 | 協定世界時-02 |
| -1 | アゾレス（カーボベルデ諸島） |
| 0 | ダブリン、エディンバラ、リスボン、ロンドン（モンロビア、レイキャビク、サントメ） |
| 1 | カサブランカ（アムステルダム、ベルリン、ベルン、ローマ、ストックホルム、ウィーン、ベオグラード、ブラチスラバ、ブダペスト、リュブリャナ、プラハ、ブリュッセル、コペンハーゲン、マドリード、パリ、サラエボ、スコピエ、ワルシャワ、ザグレブ、西中央アフリカ） |
| 2 | アンマン（アテネ、ブカレスト、ベイルート、カイロ、キシナウ、ダマスカス、ガザ、ヘブロン、ハラレ、プレトリア、ヘルシンキ、キエフ、リガ、ソフィア、タリン、ビリニュス、エルサレム、カリーニングラード、ハルツーム、トリポリ、ウィントフック） |
| 3 | バグダッド（イスタンブール、クウェート、リヤド、ミンスク、モスクワ、サンクトペテルブルク、ナイロビ） |
| 4 | アブダビ、マスカット（アストラハン、ウリヤノフスク、バクー、イジェフスク、サマラ、ポートルイス、サラトフ、トビリシ、ヴォルゴグラード、エレバン） |
| 5 | アシガバート、タシケント（エカテリンブルク、イスラマバード、カラチ、クズロルダ） |
| 6 | アスタナ（ダッカ、オムスク） |
| 7 | バンコク、ハノイ、ジャカルタ（バルナウル、ゴルノアルタイスク、ホブド、クラスノヤルスク、ノヴォシビルスク、トムスク） |
| 8 | 北京、重慶、香港、ウルムチ（イルクーツク、クアラルンプール、シンガポール、パース、台北、ウランバートル） |
| 9 | チタ（大阪、札幌、東京、平壌、ソウル、ヤクーツク） |
| 10 | ブリスベン（キャンベラ、メルボルン、シドニー、グアム、ポートモレスビー、ホバート、ウラジオストク） |
| 11 | ブーゲンビル島（チョクルダフ、マガダン、ノーフォーク島、サハリン、ソロモン諸島、ニューカレドニア） |
| 12 | アナディリ、ペトロパブロフスク・カムチャツキー（オークランド、ウェリントン、協定世界時+12、フィジー） |
カレンダータイムゾーン辞書
| time_zone_id | タイムゾーン |
|---|---|
| Africa/Abidjan | +0000 |
| Africa/Algiers | +0100 |
| Africa/Bissau | +0000 |
| Africa/Cairo | +0200 |
| Africa/Casablanca | +0000 |
| Africa/Ceuta | +0100 |
| Africa/El_Aaiun | +0000 |
| Africa/Johannesburg | +0200 |
| Africa/Juba | +0200 |
| Africa/Khartoum | +0200 |
| Africa/Lagos | +0100 |
| Africa/Maputo | +0200 |
| Africa/Monrovia | +0000 |
| Africa/Nairobi | +0300 |
| Africa/Ndjamena | +0100 |
| Africa/Sao_Tome | +0000 |
| Africa/Tripoli | +0200 |
| Africa/Tunis | +0100 |
| Africa/Windhoek | +0200 |
| America/Adak | -1000,-0900 |
| America/Anchorage | -0900,-0800 |
| America/Araguaina | -0300 |
| America/Asuncion | -0400,-0300 |
| America/Bahia | -0300 |
| America/Bahia_Banderas | -0600 |
| America/Barbados | -0400 |
| America/Belem | -0300 |
| America/Belize | -0600 |
| America/Boa_Vista | -0400 |
| America/Bogota | -0500 |
| America/Boise | -0700,-0600 |
| America/Cambridge_Bay | -0700,-0600 |
| America/Campo_Grande | -0400 |
| America/Cancun | -0500 |
| America/Caracas | -0400 |
| America/Cayenne | -0300 |
| America/Chicago | -0600,-0500 |
| America/Chihuahua | -0600 |
| America/Costa_Rica | -0600 |
| America/Cuiaba | -0400 |
| America/Danmarkshavn | +0000 |
| America/Dawson | -0700 |
| America/Dawson_Creek | -0700 |
| America/Denver | -0700,-0600 |
| America/Detroit | -0500,-0400 |
| America/Edmonton | -0700,-0600 |
| America/Eirunepe | -0500 |
| America/El_Salvador | -0600 |
| America/Fort_Nelson | -0700 |
| America/Fortaleza | -0300 |
| America/Glace_Bay | -0400,-0300 |
| America/Goose_Bay | -0300,-0400 |
| America/Grand_Turk | -0400,-0500 |
| America/Guatemala | -0600 |
| America/Guayaquil | -0500 |
| America/Guyana | -0400 |
| America/Halifax | -0400 |
| America/Havana | -0400,-0500 |
| America/Hermosillo | -0700,-0700 |
| America/Inuvik | -0700,-0600 |
| America/Iqaluit | -0500,-0400 |
| America/Jamaica | -0500 |
| America/Juneau | -0900,-0800 |
| America/La_Paz | -0400 |
| America/Lima | -0500 |
| America/Los_Angeles | -0800,-0700 |
| America/Maceio | -0300 |
| America/Managua | -0600 |
| America/Manaus | -0400 |
| America/Martinique | -0400 |
| America/Matamoros | -0600,-0500 |
| America/Mazatlan | -0700 |
| America/Menominee | -0600 |
| America/Merida | -0600 |
| America/Metlakatla | -0900,-0800 |
| America/Mexico_City | -0600 |
| America/Miquelon | -0300,-0200 |
| America/Moncton | -0400,-0300 |
| America/Monterrey | -0600 |
| America/Montevideo | -0300 |
| America/New_York | -0500,-0400 |
| America/Nome | -0900,-0800 |
| America/Noronha | -0200 |
| America/Nuuk | -0300,-0200 |
| America/Ojinaga | -0600 |
| America/Panama | -0500 |
| America/Pangnirtung | -0500,-0400 |
| America/Paramaribo | -0300 |
| America/Phoenix | -0700 |
| America/Port-au-Prince | -0500,-0400 |
| America/Porto_Velho | -0400 |
| America/Puerto_Rico | -0400 |
| America/Punta_Arenas | -0300 |
| America/Rankin_Inlet | -0600,-0500 |
| America/Recife | -0300 |
| America/Regina | -0600 |
| America/Resolute | -0500,-0600 |
| America/Rio_Branco | -0500 |
| America/Santarem | -0300 |
| America/Santiago | -0300,-0400 |
| America/Santo_Domingo | -0400 |
| America/Sao_Paulo | -0300 |
| America/Scoresbysund | -0100,+0000 |
| America/Sitka | -0900,-0800 |
| America/St_Johns | -0230,-0330 |
| America/Swift_Current | -0600 |
| America/Tegucigalpa | -0600 |
| America/Thule | -0400,-0300 |
| America/Tijuana | -0800,-0700 |
| America/Toronto | -0500,-0400 |
| America/Vancouver | -0800,-0700 |
| America/Whitehorse | -0700 |
| America/Winnipeg | -0600,-0500 |
| America/Yakutat | -0900,-0800 |
| America/Yellowknife | -0700,-0600 |
| America/Argentina/Buenos_Aires | -0300 |
| America/Argentina/Catamarca | -0300 |
| America/Argentina/Cordoba | -0300 |
| America/Argentina/Jujuy | -0300 |
| America/Argentina/La_Rioja | -0300 |
| America/Argentina/Mendoza | -0300 |
| America/Argentina/Rio_Gallegos | -0300 |
| America/Argentina/Salta | -0300 |
| America/Argentina/San_Juan | -0300 |
| America/Argentina/San_Luis | -0300 |
| America/Argentina/Tucuman | -0300 |
| America/Argentina/Ushuaia | -0300 |
| America/Indiana/Indianapolis | -0500,-0400 |
| America/Indiana/Knox | -0600,-0500 |
| America/Indiana/Marengo | -0500,-0400 |
| America/Indiana/Petersburg | -0500,-0400 |
| America/Indiana/Tell_City | -0600,-0500 |
| America/Indiana/Vevay | -0500,-0400 |
| America/Indiana/Vincennes | -0500,-0400 |
| America/Indiana/Winamac | -0400,-0500 |
| America/Kentucky/Louisville | -0500,-0400 |
| America/Kentucky/Monticello | -0500,-0400 |
| America/North_Dakota/Beulah | -0600,-0500 |
| America/North_Dakota/Center | -0600,-0500 |
| America/North_Dakota/New_Salem | -0600,-0500 |
| Antarctica/Casey | +1100 |
| Antarctica/Davis | +0700 |
| Antarctica/Macquarie | +1100 |
| Antarctica/Mawson | +0500 |
| Antarctica/Palmer | -0300 |
| Antarctica/Rothera | -0300 |
| Antarctica/Troll | +0000,+0200 |
| Asia/Almaty | +0600 |
| Asia/Amman | +0300 |
| Asia/Anadyr | +1200 |
| Asia/Aqtau | +0500 |
| Asia/Aqtobe | +0500 |
| Asia/Ashgabat | +0500 |
| Asia/Atyrau | +0500 |
| Asia/Baghdad | +0300 |
| Asia/Baku | +0400 |
| Asia/Bangkok | +0700 |
| Asia/Barnaul | +0700 |
| Asia/Beirut | +0200,+0300 |
| Asia/Bishkek | +0600 |
| Asia/Chita | +0900 |
| Asia/Choibalsan | +0800 |
| Asia/Colombo | +0530 |
| Asia/Damascus | +0300 |
| Asia/Dhaka | +0600 |
| Asia/Dili | +0900 |
| Asia/Dubai | +0400 |
| Asia/Dushanbe | +0500 |
| Asia/Famagusta | +0200,+0300 |
| Asia/Gaza | +0300,+0200 |
| Asia/Hebron | +0300,+0200 |
| Asia/Ho_Chi_Minh | +0700 |
| Asia/Hong_Kong | +0800 |
| Asia/Hovd | +0700 |
| Asia/Irkutsk | +0800 |
| Asia/Jakarta | +0700 |
| Asia/Jayapura | +0900 |
| Asia/Jerusalem | +0200,+0300 |
| Asia/Kabul | +0430 |
| Asia/Kamchatka | +1200 |
| Asia/Karachi | +0500 |
| Asia/Kathmandu | +0545 |
| Asia/Khandyga | +0900 |
| Asia/Kolkata | +0530 |
| Asia/Krasnoyarsk | +0700 |
| Asia/Kuching | +0800 |
| Asia/Macau | +0800 |
| Asia/Magadan | +1100 |
| Asia/Makassar | +0800 |
| Asia/Manila | +0800 |
| Asia/Nicosia | +0300,+0200 |
| Asia/Novokuznetsk | +0700 |
| Asia/Novosibirsk | +0700 |
| Asia/Omsk | +0600 |
| Asia/Oral | +0500 |
| Asia/Pontianak | +0700 |
| Asia/Pyongyang | +0900 |
| Asia/Qatar | +0300 |
| Asia/Qostanay | +0600 |
| Asia/Qyzylorda | +0500 |
| Asia/Riyadh | +0300 |
| Asia/Sakhalin | +1100 |
| Asia/Samarkand | +0500 |
| Asia/Seoul | +0900 |
| Asia/Shanghai | +0800 |
| Asia/Singapore | +0800 |
| Asia/Srednekolymsk | +1100 |
| Asia/Taipei | +0800 |
| Asia/Tashkent | +0500 |
| Asia/Tbilisi | +0400 |
| Asia/Tehran | +0330 |
| Asia/Thimphu | +0600 |
| Asia/Tokyo | +0900 |
| Asia/Tomsk | +0700 |
| Asia/Ulaanbaatar | +0800 |
| Asia/Urumqi | +0600 |
| Asia/Ust-Nera | +1000 |
| Asia/Vladivostok | +1000 |
| Asia/Yakutsk | +0900 |
| Asia/Yangon | +0630 |
| Asia/Yekaterinburg | +0500 |
| Asia/Yerevan | +0400 |
| Atlantic/Azores | -0100,+0000 |
| Atlantic/Bermuda | -0400,-0300 |
| Atlantic/Canary | +0000,+0100 |
| Atlantic/Cape_Verde | -0100,-0100 |
| Atlantic/Faroe | +0000,+0100 |
| Atlantic/Madeira | +0000,+0100 |
| Atlantic/South_Georgia | -0200 |
| Atlantic/Stanley | -0300 |
| Europe/Andorra | +0100,+0200 |
| Europe/Astrakhan | +0400 |
| Europe/Athens | +0200,+0300 |
| Europe/Belgrade | +0100,+0200 |
| Europe/Berlin | +0100,+0200 |
| Europe/Brussels | +0100,+0200 |
| Europe/Bucharest | +0200,+0300 |
| Europe/Budapest | +0100,+0200 |
| Europe/Chisinau | +0200,+0300 |
| Europe/Dublin | +0000,+0100 |
| Europe/Gibraltar | +0100,+0200 |
| Europe/Helsinki | +0200,+0300 |
| Europe/Istanbul | +0300,+0300 |
| Europe/Kaliningrad | +0200 |
| Europe/Kirov | +0300 |
| Europe/Kyiv | +0300,+0200 |
| Europe/Lisbon | +0100,+0000 |
| Europe/London | +0000,+0100 |
| Europe/Madrid | +0100,+0200 |
| Europe/Malta | +0100,+0200 |
| Europe/Minsk | +0300 |
| Europe/Moscow | +0300 |
| Europe/Paris | +0100,+0200 |
| Europe/Prague | +0100,+0200 |
| Europe/Riga | +0200,+0300 |
| Europe/Rome | +0100,+0200 |
| Europe/Samara | +0400 |
| Europe/Saratov | +0400 |
| Europe/Simferopol | +0300 |
| Europe/Sofia | +0200,+0300 |
| Europe/Tallinn | +0200,+0300 |
| Europe/Tirane | +0100,+0200 |
| Europe/Ulyanovsk | +0400 |
| Europe/Vienna | +0100,+0200 |
| Europe/Vilnius | +0200,+0300 |
| Europe/Volgograd | +0300 |
| Europe/Warsaw | +0100,+0200 |
| Europe/Zurich | +0100,+0200 |
| Indian/Chagos | +0600 |
| Indian/Maldives | +0500 |
| Indian/Mauritius | +0400 |
| Pacific/Auckland | +1200,+1300 |
| Pacific/Bougainville | +1100 |
| Pacific/Chatham | +1245,+1345 |
| Pacific/Easter | -0500,-0600 |
| Pacific/Efate | +1100 |
| Pacific/Fakaofo | +1300 |
| Pacific/Fiji | +1200 |
| Pacific/Galapagos | -0600 |
| Pacific/Gambier | -0900 |
| Pacific/Guadalcanal | +1100 |
| Pacific/Guam | +1000 |
| Pacific/Honolulu | -1000 |
| Pacific/Kanton | +1300 |
| Pacific/Kiritimati | +1400 |
| Pacific/Kosrae | +1100 |
| Pacific/Kwajalein | +1200 |
| Pacific/Marquesas | -0930 |
| Pacific/Nauru | +1200 |
| Pacific/Niue | -1100 |
| Pacific/Norfolk | +1100,+1200 |
| Pacific/Noumea | +1100 |
| Pacific/Pago_Pago | -1100 |
| Pacific/Palau | +0900 |
| Pacific/Pitcairn | -0800 |
| Pacific/Port_Moresby | +1000 |
| Pacific/Rarotonga | -1000 |
| Pacific/Tahiti | -1000 |
| Pacific/Tarawa | +1200 |
| Pacific/Tongatapu | +1300 |
レート辞書
| Step | Description |
|---|---|
| -1 | Free |
| 1 | 100 hourly, 1k daily |
| 2 | 250 hourly, 2.5k daily |
| 3 | 250 hourly, 5k daily |
| 4 | 650 hourly, 6.5k daily |
| 5 | 800 hourly, 8k daily |
| 6 | 1k hourly, 10k daily |
| 7 | 1.4k hourly, 14k daily |
| 8 | 2k hourly, 20k daily |
| 9 | 2.5k hourly, 25k daily |
| 10 | 3.5k hourly, 35k daily |
| 11 | 5k hourly, 50k daily |
| 12 | 8k hourly, 80k daily |
| 13 | 12k hourly, 120k daily |
| 14 | 17.5k hourly, 175k daily |
| 15 | 25k hourly, 250k daily |
フィルター条件
フィルター条件の構造
{
"condition": {
"relation": "or",
"items": [
{
"field_name": "createTime",
"op": ">=",
"value": "2021-10-11"
},
{
"field_name": "Name",
"op": "contain",
"value": "left"
}
]
}
}
フィルター条件: createTime >= '2021-10-11' または Name に 'Left' を含む
{
"condition": {
"relation": "or",
"items": [
{
"field_name": "createTime",
"op": ">=",
"value": "2021-10-11"
},
{
"field_name": "Name",
"op": "contain",
"value": "left"
}
]
}
}
フィルター条件: createTime >= '2021-10-11' または Name に 'Left' を含む
このコードブロックはフローティングウィンドウ内に表示されます
フィルター条件の説明
| パラメータ | 説明 |
|---|---|
| condition | フィルター条件グループ |
| relation | 条件の関係 (and または or) |
| items | フィルター条件、以下の表を参照 |
| fieldName | fieldType | op | 説明 | ||
| フィルター条件 | タグでフィルター | tag | なし | ( == , != , contain , does not contain ) | タグでフィルターする前にタグを作成する必要があります |
| 属性でフィルター | システム属性名 (Email, Name, Phone) |
テキスト | ( contain , does not contain ) | それぞれメール、ニックネーム、電話番号を表します | |
| システム属性名 (createTime, updateTime, unsubscribeTime) |
日付 | ( == , != , <, >, <=, >= ) | それぞれ作成日、更新日、退会日を表し、フォーマットは DD/MM/YYYY です。例: 02/04/2022 (2/4/2022 ではありません) | ||
| 一般的なカスタム属性名 (例: SendTime) |
日付 | ( == , != , <, >, <=, >= ) | フォーマットは MM/DD/YYYY または DD/MM/YYYY | ||
| 一般的なカスタム属性名 (例: Birthday) |
誕生日 | ( == , != , <, >, <=, >= ) | フォーマットは MM/DD または DD/MM | ||
| 一般的なカスタム属性名 (例: Age) |
数値 | ( == , != , <, >, <=, >= ) | フォーマット: 0 または .0 または .00 | ||
| 一般的なカスタム属性名 (例: Gender) |
ドロップダウン | ( == , != ) | この属性を作成する際にオプションを設定する必要があり、最大10個のオプションが可能 | ||
| カスタム属性名 | テキスト、日付、誕生日、数値、ドロップダウンのいずれか | fieldType によって決定 | 他のカスタム属性の値 | ||
