通用规则

最新更新:2023-04-10

API的请求格式

https://sms.api.engagelab.cc/v1/ <模块>

模块: 功能模块名称。比如: send (发送模块), templates (模板) 等。

API返回码

API 返回的结果是 JSON 格式, 示例如下:

# 认证失败 { "code": 30000, "message": "authentication failed", } # 请求成功 { "result": [ { "label_id": 598802, "label_name": "xjm226", "create_time": "2022-11-10T15:47:05+0800", "update_time": "2022-11-10T15:47:05+0800" } ], "count":1, "total" : 28 }
          # 认证失败
{
  "code": 30000,
  "message": "authentication failed",
}
# 请求成功
 {
   "result": [
            {
                "label_id": 598802,
                "label_name": "xjm226",
                "create_time": "2022-11-10T15:47:05+0800",
                "update_time": "2022-11-10T15:47:05+0800"
            }
        ],
   "count":1,
   "total" : 28
    
}

        
此代码块在浮窗中显示
  • httpStatus: 200 请求是否成功
  • result: 数据信息

HTTP 状态码

Status Description Meaning
200 Success 响应成功
400 Bad Request 用户请求错误
401 Unauthorized 认证失败
404 Not Found 请求资源不存在
500 Internal Server Error 服务发生错误,通常是服务器无法正确处理用户的传参(此时无法判断发出的请求是否成功响应)。

时区字典

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)
在文档中心打开