통합 가이드

1. 인증

api-key 및 Content-Type: application/json 헤더를 사용하여 서버에서 호출하세요.

2. 매개변수 및 자리 표시자 이해

${code}는 템플릿에 자리를 예약합니다. params.code는 이 메시지에 대한 값을 제공합니다.

귀하의 코드는 ${code}이며 5분 동안 유효합니다.

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

${code}가 아닌 코드를 키로 사용하고 자리 표시자의 대소문자를 일치시킵니다. 값은 "008848"와 같이 숫자로만 구성된 문자열이어야 합니다. 자리 표시자가 없으면 매개변수를 생략합니다.

3. SMS 보내기

이 예를 복사하고 사용자 정의하십시오.

이 예에서는 프랑스의 호출 코드 33를 사용합니다. API 키, 승인된 템플릿 ID 및 수신자를 자신의 테스트 번호로 바꾸고 대상이 사용 가능한지 확인하세요.

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

JSON 개체를 직접 보냅니다. 본문 래퍼나 추가 /v1가 없습니다. 이 예에서는 ${code}가 포함된 템플릿을 사용합니다.

4. 결과 확인

먼저 성공 여부를 확인하세요. 성공 시 messageId(채널 메시지 ID) 및 resultId(전송 레코드 ID)를 저장합니다. 실패 시 errorCode/errorMsg를 검사합니다. 전송이 성공해도 전화로 수신이 확인되지는 않습니다.

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

일반적인 오류 및 다음 단계

지원되는 국가 및 지역

전송 전에 대상 국가의 지원 여부를 확인하세요. SID 등록이 필요한 국가는 추후 지원 예정입니다. 아래 국가번호에서 +를 제외한 값을 countryCode에 입력하고, 전화번호는 phone에 별도로 입력하세요.