guía de integración
Autentíquese, complete los parámetros y envíe.
1. Autenticación
Llame desde su servidor con api-key y encabezados Content-Type: application/json.
2. Comprender los parámetros y los marcadores de posición
${code} reserva un lugar en tu plantilla. params.code proporciona el valor de este mensaje:
Su código es ${code}, válido por minutos 5.{ "params": { "code": "008848" } }Su código es 008848, válido por minutos 5.
Utilice el código como clave, no ${code}, y haga coincidir las mayúsculas y minúsculas del marcador de posición. Los valores deben ser cadenas de solo dígitos, como "008848". Omita los parámetros si no hay marcadores de posición.
3. Enviar un SMS
https://api.starsg.ai/api/product/sms/send| campo | Tipo | Requerido | que entrar |
|---|---|---|---|
| templateId | string | Sí | Su ID de plantilla aprobada, como SMS_0123456789. Conservar caso. |
| countryCode | string | Sí | Código de llamada de país o región, como "33" para Francia, sin + y separado del teléfono. Consulte la lista de destinos a continuación. |
| phone | string | Sí | Número de teléfono del destinatario sin el código de llamada del país. |
| params | object<string, string> | Por plantilla | Nombres de marcadores de posición asignados a valores reales, p. {"code":"008848"}. Los valores predeterminados son cadenas de solo dígitos. Omítalo si la plantilla no tiene marcadores de posición. |
Copie y personalice este ejemplo.
Este ejemplo utiliza el código de llamada de Francia, 33. Reemplace la clave API, el ID de la plantilla aprobada y el destinatario con su propio número de prueba y confirme que el destino esté disponible.
curl -X POST 'https://api.starsg.ai/api/product/sms/send' \
-H 'api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"templateId": "SMS_0123456789",
"countryCode": "33",
"phone": "612345678",
"params": { "code": "008848" }
}'Envíe un objeto JSON directamente: sin envoltura de cuerpo o /v1. adicional. Este ejemplo utiliza una plantilla que contiene ${code}.
4. Comprueba el resultado
Primero verifique el éxito. Guarde messageId (ID de mensaje de canal) y resultId (enviar ID de registro) en caso de éxito; Inspeccione el código de error/mensaje de error en caso de error. El envío exitoso no confirma la recepción por teléfono.
{
"success": true,
"data": {
"messageId": "channel-message-id",
"resultId": 9
},
"errorCode": null,
"errorMsg": null
}{
"success": false,
"data": null,
"errorCode": "END_USER_TEMPLATE_NOT_APPROVED",
"errorMsg": "Template is awaiting review"
}Errores comunes y próximos pasos
001 | Verifique los campos obligatorios, JSON, código de país, teléfono y valores de cadena de solo dígitos en los parámetros. |
END_USER_TEMPLATE_NOT_FOUND | Verifique el ID completo de la plantilla y la propiedad del usuario asociado con su clave API. |
END_USER_TEMPLATE_NOT_APPROVED | Espere la aprobación de la plantilla antes de enviarla. |
END_USER_TEMPLATE_REJECTED | Lea el motivo del rechazo y presente su solicitud con el contenido revisado. |
USER_SEND_TOO_MUCH / USER_REG_PHONE_SEND_TOO_MUCH | Límite de frecuencia alcanzado. Reducir la tasa de llamadas. |
ENV_LIMITER / TEMPLATE_LIMITER | Restricción de política de plantilla o entorno. Siga los detalles del error y comuníquese con el soporte. |
SEND_FAIL / SMS_SEND_FAIL / END_USER_SEND_FAILED / 999 | Guarde el error y solicite identificadores para obtener ayuda. No reenvíes ciegamente. |
MEDICIÓN_FALTANTE | Es posible que el SMS ya se haya enviado, pero faltan datos de medición. No lo vuelva a intentar automáticamente; guarde resultId y póngase en contacto con el soporte. |
Países y regiones admitidos
Consulta disponibilidad de destino antes de realizar el envío. Próximamente llegarán destinos que requerirán registro SID. Ingrese el código de llamada a continuación en countryCode sin + e ingrese el número de teléfono por separado en teléfono.
| País/región | código de llamada | Disponibilidad |
|---|---|---|
| United States | +1 | Muy pronto |
| Russia | +7 | Muy pronto |
| Egypt | +20 | Muy pronto |
| South Africa | +27 | Disponible |
| Greece | +30 | Disponible |
| Netherlands | +31 | Disponible |
| Belgium | +32 | Disponible |
| France | +33 | Disponible |
| Spain | +34 | Disponible |
| Hungary | +36 | Disponible |
| Italy | +39 | Disponible |
| Romania | +40 | Disponible |
| Switzerland | +41 | Disponible |
| Austria | +43 | Disponible |
| United Kingdom | +44 | Muy pronto |
| Denmark | +45 | Disponible |
| Norway | +47 | Disponible |
| Sweden | +46 | Disponible |
| Poland | +48 | Disponible |
| Germany | +49 | Disponible |
| Peru | +51 | Disponible |
| Mexico | +52 | Disponible |
| Argentina | +54 | Disponible |
| Brazil | +55 | Disponible |
| Chile | +56 | Disponible |
| Colombia | +57 | Disponible |
| Venezuela | +58 | Disponible |
| Malaysia | +60 | Disponible |
| Australia | +61 | Muy pronto |
| Indonesia | +62 | Muy pronto |
| Philippines | +63 | Muy pronto |
| New Zealand | +64 | Disponible |
| Singapore | +65 | Muy pronto |
| Thailand | +66 | Muy pronto |
| Japan | +81 | Disponible |
| South Korea | +82 | Disponible |
| Vietnam | +84 | Muy pronto |
| China | +86 | Muy pronto |
| Türkiye | +90 | Muy pronto |
| India | +91 | Disponible |
| Pakistan | +92 | Muy pronto |
| Afghanistan | +93 | Muy pronto |
| Sri Lanka | +94 | Muy pronto |
| Myanmar (Burma) | +95 | Muy pronto |
| South Sudan | +211 | Disponible |
| Morocco | +212 | Muy pronto |
| Algeria | +213 | Disponible |
| Tunisia | +216 | Disponible |
| Libya | +218 | Muy pronto |
| Gambia | +220 | Disponible |
| Senegal | +221 | Disponible |
| Mauritania | +222 | Muy pronto |
| Mali | +223 | Muy pronto |
| Guinea | +224 | Muy pronto |
| Côte d’Ivoire | +225 | Disponible |
| Burkina Faso | +226 | Disponible |
| Niger | +227 | Disponible |
| Togo | +228 | Disponible |
| Benin | +229 | Muy pronto |
| Mauritius | +230 | Muy pronto |
| Liberia | +231 | Muy pronto |
| Sierra Leone | +232 | Muy pronto |
| Ghana | +233 | Muy pronto |
| Nigeria | +234 | Muy pronto |
| Chad | +235 | Muy pronto |
| Central African Republic | +236 | Disponible |
| Cameroon | +237 | Muy pronto |
| Cape Verde | +238 | Disponible |
| São Tomé & Príncipe | +239 | Disponible |
| Equatorial Guinea | +240 | Disponible |
| Gabon | +241 | Disponible |
| Congo - Brazzaville | +242 | Disponible |
| Congo - Kinshasa | +243 | Disponible |
| Angola | +244 | Disponible |
| Guinea-Bissau | +245 | Muy pronto |
| British Indian Ocean Territory | +246 | Disponible |
| Ascension Island | +247 | Disponible |
| Seychelles | +248 | Disponible |
| Sudan | +249 | Muy pronto |
| Rwanda | +250 | Muy pronto |
| Ethiopia | +251 | Muy pronto |
| Somalia | +252 | Disponible |
| Djibouti | +253 | Disponible |
| Kenya | +254 | Muy pronto |
| Tanzania | +255 | Muy pronto |
| Uganda | +256 | Muy pronto |
| Burundi | +257 | Disponible |
| Mozambique | +258 | Disponible |
| Zambia | +260 | Muy pronto |
| Madagascar | +261 | Disponible |
| Réunion | +262 | Disponible |
| Zimbabwe | +263 | Disponible |
| Namibia | +264 | Disponible |
| Malawi | +265 | Muy pronto |
| Lesotho | +266 | Disponible |
| Botswana | +267 | Disponible |
| Eswatini | +268 | Disponible |
| Comoros | +269 | Disponible |
| St. Helena | +290 | Disponible |
| Eritrea | +291 | Disponible |
| Aruba | +297 | Disponible |
| Faroe Islands | +298 | Disponible |
| Greenland | +299 | Disponible |
| Gibraltar | +350 | Disponible |
| Portugal | +351 | Disponible |
| Luxembourg | +352 | Disponible |
| Ireland | +353 | Disponible |
| Iceland | +354 | Disponible |
| Albania | +355 | Disponible |
| Malta | +356 | Disponible |
| Cyprus | +357 | Disponible |
| Finland | +358 | Disponible |
| Bulgaria | +359 | Disponible |
| Lithuania | +370 | Disponible |
| Latvia | +371 | Disponible |
| Estonia | +372 | Disponible |
| Moldova | +373 | Disponible |
| Armenia | +374 | Muy pronto |
| Belarus | +375 | Muy pronto |
| Andorra | +376 | Disponible |
| Monaco | +377 | Disponible |
| San Marino | +378 | Disponible |
| Ukraine | +380 | Disponible |
| Serbia | +381 | Disponible |
| Montenegro | +382 | Disponible |
| Kosovo | +383 | Disponible |
| Croatia | +385 | Disponible |
| Slovenia | +386 | Disponible |
| Bosnia & Herzegovina | +387 | Disponible |
| North Macedonia | +389 | Disponible |
| Czechia | +420 | Muy pronto |
| Slovakia | +421 | Disponible |
| Liechtenstein | +423 | Disponible |
| Falkland Islands | +500 | Disponible |
| Belize | +501 | Disponible |
| Guatemala | +502 | Disponible |
| El Salvador | +503 | Disponible |
| Honduras | +504 | Disponible |
| Nicaragua | +505 | Disponible |
| Costa Rica | +506 | Disponible |
| Panama | +507 | Disponible |
| Saint Pierre and Miquelon | +508 | Disponible |
| Haiti | +509 | Disponible |
| Guadeloupe | +590 | Disponible |
| Bolivia | +591 | Disponible |
| Guyana | +592 | Disponible |
| Ecuador | +593 | Disponible |
| French Guiana | +594 | Disponible |
| Paraguay | +595 | Disponible |
| Martinique | +596 | Disponible |
| Suriname | +597 | Disponible |
| Uruguay | +598 | Disponible |
| Caribbean Netherlands (including Curaçao) | +599 | Disponible |
| Timor-Leste | +670 | Disponible |
| Norfolk Island | +672 | Disponible |
| Brunei | +673 | Disponible |
| Nauru | +674 | Disponible |
| Papua New Guinea | +675 | Disponible |
| Tonga | +676 | Disponible |
| Solomon Islands | +677 | Disponible |
| Vanuatu | +678 | Disponible |
| Fiji | +679 | Disponible |
| Palau | +680 | Disponible |
| Wallis & Futuna | +681 | Disponible |
| Cook Islands | +682 | Disponible |
| Niue | +683 | Disponible |
| Samoa | +685 | Disponible |
| Kiribati | +686 | Disponible |
| New Caledonia | +687 | Disponible |
| Tuvalu | +688 | Disponible |
| French Polynesia | +689 | Disponible |
| Tokelau | +690 | Disponible |
| Micronesia | +691 | Disponible |
| Marshall Islands | +692 | Disponible |
| Hong Kong, China | +852 | Muy pronto |
| Macao, China | +853 | Disponible |
| Cambodia | +855 | Muy pronto |
| Laos | +856 | Disponible |
| Bangladesh | +880 | Disponible |
| Taiwan, China | +886 | Disponible |
| Maldives | +960 | Disponible |
| Lebanon | +961 | Disponible |
| Jordan | +962 | Muy pronto |
| Iraq | +964 | Disponible |
| Kuwait | +965 | Muy pronto |
| Saudi Arabia | +966 | Muy pronto |
| Yemen | +967 | Muy pronto |
| Oman | +968 | Muy pronto |
| Palestine | +970 | Muy pronto |
| United Arab Emirates | +971 | Muy pronto |
| Israel | +972 | Disponible |
| Bahrain | +973 | Disponible |
| Qatar | +974 | Muy pronto |
| Bhutan | +975 | Disponible |
| Mongolia | +976 | Disponible |
| Nepal | +977 | Muy pronto |
| Tajikistan | +992 | Disponible |
| Turkmenistan | +993 | Disponible |
| Azerbaijan | +994 | Disponible |
| Georgia | +995 | Disponible |
| Kyrgyzstan | +996 | Disponible |
| Uzbekistan | +998 | Disponible |
| Bahamas | +1242 | Disponible |
| Barbados | +1246 | Disponible |
| Anguilla | +1264 | Disponible |
| Antigua & Barbuda | +1268 | Disponible |
| British Virgin Islands | +1284 | Disponible |
| U.S. Virgin Islands | +1340 | Disponible |
| Cayman Islands | +1345 | Disponible |
| Bermuda | +1441 | Disponible |
| Grenada | +1473 | Disponible |
| Turks & Caicos Islands | +1649 | Disponible |
| Montserrat | +1664 | Disponible |
| Northern Mariana Islands | +1670 | Disponible |
| Guam | +1671 | Disponible |
| American Samoa | +1684 | Disponible |
| Sint Maarten | +1721 | Disponible |
| St. Lucia | +1758 | Disponible |
| Dominica | +1767 | Disponible |
| Puerto Rico | +1787 | Disponible |
| Dominican Republic | +1809 | Disponible |
| Trinidad & Tobago | +1868 | Disponible |
| St. Kitts & Nevis | +1869 | Disponible |
| Jamaica | +1876 | Disponible |