統合ガイド

1。認証

API-key と Content-Type: application/json ヘッダーを使用してサーバーから呼び出します。

2。パラメータとプレースホルダを理解する

${code} はテンプレート内の場所を予約します。 params.code は、このメッセージの値を提供します。

コードは ${code} で、有効期限は 5 分間です。

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

${code} ではなくコードをキーとして使用し、プレースホルダーの大文字と小文字を一致させます。値は、「008848」などの数字のみの文字列である必要があります。プレースホルダーがない場合は、params を省略します。

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 に別途指定します。