Rules
Reglas
Formato de solicitud de la API
https://sms.api.engagelab.cc/v1/<module>
Módulo: nombre del módulo de funcionalidad, p. ej., módulo de envío, módulo de plantillas.
Código de retorno de la API
La API devuelve la respuesta en formato JSON. Un ejemplo es el siguiente:
# la solicitud se realizó correctamente
{
"result": {}
}
# error de autenticación
{
"code": 30000,
"message": "authentication failed",
}
# adquisición de datos correcta
{
"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"
}
]
}
# la solicitud se realizó correctamente
{
"result": {}
}
# error de autenticación
{
"code": 30000,
"message": "authentication failed",
}
# adquisición de datos correcta
{
"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"
}
]
}
Este bloque de código se muestra en una ventana flotante
- httpStatus: 200
- result: información de datos
Código de estado HTTP
| Estado | Descripción | Significado |
|---|---|---|
| 200 | Correcto | La solicitud se ha realizado correctamente. |
| 400 | Solicitud incorrecta | El servidor no ha podido interpretar la solicitud debido a una sintaxis incorrecta. |
| 401 | No autorizado | La solicitud requiere autenticación de usuario. |
| 404 | No encontrado | El servidor no ha encontrado nada que coincida con la URI de la solicitud |
| 500 | Error interno del servidor | El servidor ha encontrado una condición inesperada que le ha impedido completar la solicitud. |
Diccionario de zonas horarias
| Zona | Descripción |
|---|---|
| -12 | Línea internacional de cambio de fecha (oeste) |
| -11 | UTC-11 |
| -10 | Islas Aleutianas (Hawái) |
| -9 | Alaska (UTC-09) |
| -8 | Baja California (UTC-08, Hora del Pacífico [EE. UU. y Canadá]) |
| -7 | Arizona (Chihuahua, La Paz, Mazatlán, Hora de las Montañas [EE. UU. y Canadá], Yukón) |
| -6 | Centroamérica (Hora Central [EE. UU. y Canadá], Isla de Pascua, Guadalajara, Ciudad de México, Monterrey, Saskatchewan) |
| -5 | Bogotá, Lima, Quito, Rio Branco (Chetumal, Hora del Este [EE. UU. y Canadá], Haití, La Habana, Indiana [Este], Islas Turcas y Caicos) |
| -4 | Asunción (Hora del Atlántico [Canadá], Caracas, Cuiabá, Georgetown, La Paz, Manaos, San Juan, Santiago) |
| -3 | Araguaína (Brasilia, Cayena, Fortaleza, Ciudad de Buenos Aires, Groenlandia, Montevideo, Punta Arenas, San Pedro y Miquelón, Salvador) |
| -2 | UTC-02 |
| -1 | Azores (Islas de Cabo Verde) |
| 0 | Dublín, Edimburgo, Lisboa, Londres (Monrovia, Reikiavik, Santo Tomé) |
| 1 | Casablanca (Ámsterdam, Berlín, Berna, Roma, Estocolmo, Viena, Belgrado, Bratislava, Budapest, Liubliana, Praga, Bruselas, Copenhague, Madrid, París, Sarajevo, Skopie, Varsovia, Zagreb, África occidental y central) |
| 2 | Ammán (Atenas, Bucarest, Beirut, El Cairo, Chisináu, Damasco, Gaza, Hebrón, Harare, Pretoria, Helsinki, Kiev, Riga, Sofía, Tallin, Vilna, Jerusalén, Kaliningrado, Jartum, Trípoli, Windhoek) |
| 3 | Bagdad (Estambul, Kuwait, Riad, Minsk, Moscú, San Petersburgo, Nairobi) |
| 4 | Abu Dabi, Mascate (Astracán, Uliánovsk, Bakú, Izhevsk, Samara, Port Louis, Sarátov, Tiflis, Volgogrado, Ereván) |
| 5 | Asjabad, Taskent (Ekaterimburgo, Islamabad, Karachi, Qyzylorda) |
| 6 | Astaná (Daca, Omsk) |
| 7 | Bangkok, Hanói, Yakarta (Barnaúl, Gorno-Altáisk, Hovd, Krasnoyarsk, Novosibirsk, Tomsk) |
| 8 | Pekín, Chongqing, Hong Kong, Urumqi (Irkutsk, Kuala Lumpur, Singapur, Perth, Taipéi, Ulán Bator) |
| 9 | Chitá (Osaka, Sapporo, Tokio, Pionyang, Seúl, Yakutsk) |
| 10 | Brisbane (Canberra, Melbourne, Sídney, Guam, Port Moresby, Hobart, Vladivostok) |
| 11 | Isla Bougainville (Chokurdakh, Magadán, Isla Norfolk, Sajalín, Islas Salomón, Nueva Caledonia) |
| 12 | Anadyr, Petropávlovsk-Kamchatski (Auckland, Wellington, UTC+12, Fiyi) |
