# 说明及数字字典
# 接口说明
- Token生成方式  为base64(api_user:api_key),文档请求示例中Token统一都以YXBpX3VzZXI6YXBpX2tleQ==为例
- 认证方式 为Bearer Token,需放在请求头Header中,每个接口都需要带此值,格式为:
| Parameter | Type | Required | Description | 
|---|---|---|---|
| Authorization | string | true | Bearer Token | 
- 请求URL: https://api2.sendcloud.net/marketing/
# 数据字典
# http状态码字典
| Status | Description | Meaning | 
|---|---|---|
| 200 | Success | 响应成功 | 
| 201 | Created Success | POST 创建成功 | 
| 204 | Delete Success | DELETE 删除成功 | 
| 400 | Bad Request | 用户请求错误 | 
| 401 | Unauthorized | 用户Token认证失败,通常是Token错误 | 
| 403 | Forbidden | 用户权限失败,禁止访问 | 
| 404 | Not Found | 用户请求的记录不存在,通常是 URL拼写或者path参数值错误 | 
| 429 | Too Many Requests | 请求频率过高 | 
| 430 | Ip Refused | 请求ip被拒绝 | 
| 500 | Internal Server Error | 服务发生错误,通常是服务器无法正确处理用户的传参(此时无法判断发出的请求是否成功响应) | 
| 503 | Service Unavailable | 服务升级 | 
# 时区字典
| Zone | Description | 
|---|---|
| -12 | International Date Line West | 
| -11 | Coordinated Universal Time-11 | 
| -10 | Aleutian Islands(Hawaii) | 
| -9 | Alaska(Coordinated Universal Time-09) | 
| -8 | Baja California(Coordinated Universal Time-08,Pacific Time [US & Canada]) | 
| -7 | Arizona(Chihuahua, La Paz, Mazatlan,Mountain Time [US & Canada],Yukon) | 
| -6 | Central America(Central Time [US & Canada],Easter Island,Guadalajara, Mexico City, Monterrey,Saskatchewan) | 
| -5 | Bogota, Lima, Quito, Rio Branco(Chetumal,Eastern Time [US & Canada],Haiti,Havana,Indiana [East],Turks and Caicos) | 
| -4 | Asuncion(Atlantic Time [Canada],Caracas,Cuiaba,Georgetown, La Paz, Manaus, San Juan,Santiago) | 
| -3 | Araguaina(Brasilia,Cayenne, Fortaleza,City of Buenos Aires,Greenland,Montevideo,Punta Arenas,Saint Pierre and Miquelon,Salvador) | 
| -2 | Coordinated Universal Time-02 | 
| -1 | Azores(Cabo Verde Is.) | 
| 0 | Dublin, Edinburgh, Lisbon, London(Monrovia, Reykjavik,Sao Tome) | 
| 1 | Casablanca(Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna,Belgrade, Bratislava, Budapest, Ljubljana, Prague,Brussels, Copenhagen, Madrid, Paris,Sarajevo, Skopje, Warsaw, Zagreb,Western Central Africa) | 
| 2 | Amman(Athens, Bucharest,Beirut,Cairo,Chisinau,Damascus ,Gaza, Hebron ,Harare, Pretoria,Helsinki, Kyiv, Riga, Sofia, Tallinn, Vilnius,Jerusalem,Kaliningrad,Khartoum,Tripoli,Windhoek) | 
| 3 | Baghdad(Istanbul,Kuwait, Riyadh,Minsk,Moscow, St. Petersburg,Nairobi) | 
| 4 | Abu Dhabi, Muscat(Astrakhan, Ulyanovsk,Baku,Izhevsk, Samara,Port Louis,Saratov,Tbilisi,Volgograd,Yerevan) | 
| 5 | Ashgabat, Tashkent(Ekaterinburg,Islamabad, Karachi,Qyzylorda) | 
| 6 | Astana(Dhaka,Omsk) | 
| 7 | Bangkok, Hanoi, Jakarta(Barnaul, Gorno-Altaysk,Hovd,Krasnoyarsk,Novosibirsk,Tomsk) | 
| 8 | Beijing, Chongqing, Hong Kong, Urumqi(Irkutsk,Kuala Lumpur, Singapore,Perth,Taipei,Ulaanbaatar) | 
| 9 | Chita(Osaka, Sapporo, Tokyo,Pyongyang,Seoul,Yakutsk) | 
| 10 | Brisbane(Canberra, Melbourne, Sydney,Guam, Port Moresby,Hobart,Vladivostok) | 
| 11 | Bougainville Island(Chokurdakh,Magadan,Norfolk Island,Sakhalin,Solomon Is., New Caledonia) | 
| 12 | Anadyr, Petropavlovsk-Kamchatsky(Auckland, Wellington,Coordinated Universal Time+12,Fiji) | 
# 速率字典
| 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,14 daily | 
| 8 | 2k hourly,20k daily | 
| 9 | 2.5 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": [
            {
                "fieldName": "createTime",
                "op": ">=",
                "value": "2021-10-11"
            },
            {
                "fieldName": "Name",
                "op": "contain",
                "value": "左"
            }
        ]
    }
}
# 筛选条件:createTime >= '2021-10-11' or Name 包含 '左'
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
筛选条件说明
| Parameter | Description | 
|---|---|
| condition | 筛选条件组 | 
| relation | 条件关系 (and 或 or) | 
| items | 筛选条件,见下文图表 | 
| fieldName | fieldType | op | 描述 | ||
| 筛选条件 | 按Tag筛选 | tag | 无 | ( == 、!= 、contain 、does not contain ) | 需先创建tag再进行筛选tag | 
| 按属性筛选 | 系统属性名 (Email、Name、Phone) | Text | ( contain 、does not contain ) | 分别表示为邮箱、昵称、电话号码 | |
| 系统属性名 (createTime、updateTime、unsubscribeTime ) | Date | ( == 、!= 、< 、> 、<= 、>= ) | 分别表示创建日期,更新日期,取消订阅日期,格式为DD/MM/YYYY,如 02/04/2022 ,不能为 2/4/2022 | ||
| 常用的自定义属性名 (比如SendTime) | Date | ( == 、!= 、< 、> 、<= 、>= ) | 格式为MM/DD/YYYY或DD/MM/YYYY | ||
| 常用的自定义属性名 (比如Birthday) | Birthday | ( == 、!= 、< 、> 、<= 、>= ) | 格式为MM/DD或DD/MM | ||
| 常用的自定义属性名 (比如Age) | Number | ( == 、!= 、< 、> 、<= 、>= ) | 格式为:0 或 .0 或 .00 | ||
| 常用的自定义属性名 (比如Gender) | Dropdown | ( == 、!= ) | 创建此属性时需要同时设置选项内容,最多10个选项 | ||
| 自定义的属性名 | Text、Date、Birthday、Number、Dropdown其中之一 | 根据fieldType决定 | 其他自定义属性的值 | ||
