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:

Plantilla · Reservar plaza
text
Su código es ${code}, válido por minutos 5.
Parámetros · Proporcionar un valor
json
{ "params": { "code": "008848" } }
El mensaje que ve su destinatario

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

POSThttps://api.starsg.ai/api/product/sms/send
campoTipoRequeridoque entrar
templateIdstringSíSu ID de plantilla aprobada, como SMS_0123456789. Conservar caso.
countryCodestringSí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.
phonestringSíNúmero de teléfono del destinatario sin el código de llamada del país.
paramsobject<string, string>Por plantillaNombres 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.

bash
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.

Respuesta exitosa
json
{
  "success": true,
  "data": {
    "messageId": "channel-message-id",
    "resultId": 9
  },
  "errorCode": null,
  "errorMsg": null
}
Respuesta de error
json
{
  "success": false,
  "data": null,
  "errorCode": "END_USER_TEMPLATE_NOT_APPROVED",
  "errorMsg": "Template is awaiting review"
}

Errores comunes y próximos pasos

001Verifique 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_FOUNDVerifique el ID completo de la plantilla y la propiedad del usuario asociado con su clave API.
END_USER_TEMPLATE_NOT_APPROVEDEspere la aprobación de la plantilla antes de enviarla.
END_USER_TEMPLATE_REJECTEDLea el motivo del rechazo y presente su solicitud con el contenido revisado.
USER_SEND_TOO_MUCH / USER_REG_PHONE_SEND_TOO_MUCHLímite de frecuencia alcanzado. Reducir la tasa de llamadas.
ENV_LIMITER / TEMPLATE_LIMITERRestricció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 / 999Guarde el error y solicite identificadores para obtener ayuda. No reenvíes ciegamente.
MEDICIÓN_FALTANTEEs 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óncódigo de llamadaDisponibilidad
United States+1Muy pronto
Russia+7Muy pronto
Egypt+20Muy pronto
South Africa+27Disponible
Greece+30Disponible
Netherlands+31Disponible
Belgium+32Disponible
France+33Disponible
Spain+34Disponible
Hungary+36Disponible
Italy+39Disponible
Romania+40Disponible
Switzerland+41Disponible
Austria+43Disponible
United Kingdom+44Muy pronto
Denmark+45Disponible
Norway+47Disponible
Sweden+46Disponible
Poland+48Disponible
Germany+49Disponible
Peru+51Disponible
Mexico+52Disponible
Argentina+54Disponible
Brazil+55Disponible
Chile+56Disponible
Colombia+57Disponible
Venezuela+58Disponible
Malaysia+60Disponible
Australia+61Muy pronto
Indonesia+62Muy pronto
Philippines+63Muy pronto
New Zealand+64Disponible
Singapore+65Muy pronto
Thailand+66Muy pronto
Japan+81Disponible
South Korea+82Disponible
Vietnam+84Muy pronto
China+86Muy pronto
Türkiye+90Muy pronto
India+91Disponible
Pakistan+92Muy pronto
Afghanistan+93Muy pronto
Sri Lanka+94Muy pronto
Myanmar (Burma)+95Muy pronto
South Sudan+211Disponible
Morocco+212Muy pronto
Algeria+213Disponible
Tunisia+216Disponible
Libya+218Muy pronto
Gambia+220Disponible
Senegal+221Disponible
Mauritania+222Muy pronto
Mali+223Muy pronto
Guinea+224Muy pronto
Côte d’Ivoire+225Disponible
Burkina Faso+226Disponible
Niger+227Disponible
Togo+228Disponible
Benin+229Muy pronto
Mauritius+230Muy pronto
Liberia+231Muy pronto
Sierra Leone+232Muy pronto
Ghana+233Muy pronto
Nigeria+234Muy pronto
Chad+235Muy pronto
Central African Republic+236Disponible
Cameroon+237Muy pronto
Cape Verde+238Disponible
São Tomé & Príncipe+239Disponible
Equatorial Guinea+240Disponible
Gabon+241Disponible
Congo - Brazzaville+242Disponible
Congo - Kinshasa+243Disponible
Angola+244Disponible
Guinea-Bissau+245Muy pronto
British Indian Ocean Territory+246Disponible
Ascension Island+247Disponible
Seychelles+248Disponible
Sudan+249Muy pronto
Rwanda+250Muy pronto
Ethiopia+251Muy pronto
Somalia+252Disponible
Djibouti+253Disponible
Kenya+254Muy pronto
Tanzania+255Muy pronto
Uganda+256Muy pronto
Burundi+257Disponible
Mozambique+258Disponible
Zambia+260Muy pronto
Madagascar+261Disponible
Réunion+262Disponible
Zimbabwe+263Disponible
Namibia+264Disponible
Malawi+265Muy pronto
Lesotho+266Disponible
Botswana+267Disponible
Eswatini+268Disponible
Comoros+269Disponible
St. Helena+290Disponible
Eritrea+291Disponible
Aruba+297Disponible
Faroe Islands+298Disponible
Greenland+299Disponible
Gibraltar+350Disponible
Portugal+351Disponible
Luxembourg+352Disponible
Ireland+353Disponible
Iceland+354Disponible
Albania+355Disponible
Malta+356Disponible
Cyprus+357Disponible
Finland+358Disponible
Bulgaria+359Disponible
Lithuania+370Disponible
Latvia+371Disponible
Estonia+372Disponible
Moldova+373Disponible
Armenia+374Muy pronto
Belarus+375Muy pronto
Andorra+376Disponible
Monaco+377Disponible
San Marino+378Disponible
Ukraine+380Disponible
Serbia+381Disponible
Montenegro+382Disponible
Kosovo+383Disponible
Croatia+385Disponible
Slovenia+386Disponible
Bosnia & Herzegovina+387Disponible
North Macedonia+389Disponible
Czechia+420Muy pronto
Slovakia+421Disponible
Liechtenstein+423Disponible
Falkland Islands+500Disponible
Belize+501Disponible
Guatemala+502Disponible
El Salvador+503Disponible
Honduras+504Disponible
Nicaragua+505Disponible
Costa Rica+506Disponible
Panama+507Disponible
Saint Pierre and Miquelon+508Disponible
Haiti+509Disponible
Guadeloupe+590Disponible
Bolivia+591Disponible
Guyana+592Disponible
Ecuador+593Disponible
French Guiana+594Disponible
Paraguay+595Disponible
Martinique+596Disponible
Suriname+597Disponible
Uruguay+598Disponible
Caribbean Netherlands (including Curaçao)+599Disponible
Timor-Leste+670Disponible
Norfolk Island+672Disponible
Brunei+673Disponible
Nauru+674Disponible
Papua New Guinea+675Disponible
Tonga+676Disponible
Solomon Islands+677Disponible
Vanuatu+678Disponible
Fiji+679Disponible
Palau+680Disponible
Wallis & Futuna+681Disponible
Cook Islands+682Disponible
Niue+683Disponible
Samoa+685Disponible
Kiribati+686Disponible
New Caledonia+687Disponible
Tuvalu+688Disponible
French Polynesia+689Disponible
Tokelau+690Disponible
Micronesia+691Disponible
Marshall Islands+692Disponible
Hong Kong, China+852Muy pronto
Macao, China+853Disponible
Cambodia+855Muy pronto
Laos+856Disponible
Bangladesh+880Disponible
Taiwan, China+886Disponible
Maldives+960Disponible
Lebanon+961Disponible
Jordan+962Muy pronto
Iraq+964Disponible
Kuwait+965Muy pronto
Saudi Arabia+966Muy pronto
Yemen+967Muy pronto
Oman+968Muy pronto
Palestine+970Muy pronto
United Arab Emirates+971Muy pronto
Israel+972Disponible
Bahrain+973Disponible
Qatar+974Muy pronto
Bhutan+975Disponible
Mongolia+976Disponible
Nepal+977Muy pronto
Tajikistan+992Disponible
Turkmenistan+993Disponible
Azerbaijan+994Disponible
Georgia+995Disponible
Kyrgyzstan+996Disponible
Uzbekistan+998Disponible
Bahamas+1242Disponible
Barbados+1246Disponible
Anguilla+1264Disponible
Antigua & Barbuda+1268Disponible
British Virgin Islands+1284Disponible
U.S. Virgin Islands+1340Disponible
Cayman Islands+1345Disponible
Bermuda+1441Disponible
Grenada+1473Disponible
Turks & Caicos Islands+1649Disponible
Montserrat+1664Disponible
Northern Mariana Islands+1670Disponible
Guam+1671Disponible
American Samoa+1684Disponible
Sint Maarten+1721Disponible
St. Lucia+1758Disponible
Dominica+1767Disponible
Puerto Rico+1787Disponible
Dominican Republic+1809Disponible
Trinidad & Tobago+1868Disponible
St. Kitts & Nevis+1869Disponible
Jamaica+1876Disponible