Guia de integração

1. Autenticação

Chame do seu servidor com api-key e Content-Type: application/json headers.

2. Compreender parâmetros e espaços reservados

${code} reserva um lugar no seu modelo. params.code fornece o valor para esta mensagem:

Seu código é ${code}, válido por 5 minutos.

{ "params": { "code": "008848" } }

Use code como chave, não ${code}, e combine a caixa do espaço reservado. Os valores devem ser strings somente de dígitos, como "008848". Omita parâmetros se não houver espaços reservados.

3. Envie um SMS

Copie e personalize este exemplo

Este exemplo usa o código de chamada da França, 33. Substitua a chave API, o ID do modelo aprovado e o destinatário pelo seu próprio número de teste e confirme se o destino está disponível.

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" }
  }'

Envie um objeto JSON diretamente: sem wrapper de corpo ou /v1. Este exemplo usa um modelo contendo ${code}.

4. Confira o resultado

Verifique o sucesso primeiro. Guardar messageId (ID da mensagem do canal) e resultId (enviar ID do registo) em caso de sucesso; inspecionar errorCode/errorMsg em caso de falha. O envio com sucesso não confirma o recebimento pelo telefone.

{
  "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"
}

Erros comuns e próximos passos

Países e regiões suportados

Verifique a disponibilidade do destino antes de enviar. Destinos que exigem registo SID estarão disponíveis em breve. Insira o código de chamada abaixo em countryCode sem + e insira o número de telefone separadamente em phone.