Rules

API request format

https://sms.api.engagelab.cc/v1/<module>

Module: name of function module, e.g. send module, templates module.

API return code

API is returned in the format of JSON.Sample is as below:

# request was successful { "result": {} } # Authentication failed { "code": 30000, "message": "authentication failed", } # Data acquisition success { "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" } ] }

              
              # request was successful
{
 
  "result": {}
}
# Authentication failed
{
  "code": 30000,
  "message": "authentication failed",
}
# Data acquisition success
{
    
   "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"
            }
        ]
    
}

This code block in the floating window

httpStatus: 200
result: Data information

HTTP status code

Status	Description	Meaning
200	Success	The request has succeeded.
400	Bad Request	The request could not be understood by the server due to malformed syntax.
401	Unauthorized	The request requires user authentication.
404	Not Found	The server has not found anything matching the Request-URI
500	Internal Server Error	The server encountered an unexpected condition which prevented it from fulfilling the request.

Time zone dictionary

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）