Hướng dẫn tích hợp

1. Xác thực

Gọi từ máy chủ của bạn với tiêu đề api-key và Content-Type: application/json.

2. Hiểu thông số và phần giữ chỗ

${code} dành một chỗ trong mẫu của bạn. params.code cung cấp giá trị cho thông báo này:

Mã của bạn là ${code}, có giá trị trong 5 phút.

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

Sử dụng mã làm khóa, không phải ${code} và khớp với kiểu dáng của phần giữ chỗ. Giá trị phải là chuỗi chỉ có chữ số, chẳng hạn như "008848". Bỏ qua các thông số nếu không có phần giữ chỗ.

3. Gửi tin nhắn SMS

Sao chép và tùy chỉnh ví dụ này

Ví dụ này sử dụng mã gọi điện của Pháp, 33. Thay thế khóa API, ID mẫu đã được phê duyệt và người nhận bằng số kiểm tra của riêng bạn và xác nhận rằng điểm đến có sẵn.

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

Gửi trực tiếp một đối tượng JSON: không có phần bao bọc nội dung hoặc phần bổ sung /v1. Ví dụ này sử dụng mẫu có chứa ${code}.

4. Kiểm tra kết quả

Kiểm tra thành công trước. Lưu messageId (ID tin nhắn kênh) và resultId (gửi ID bản ghi) khi thành công; kiểm tra errorCode/errorMsg khi bị lỗi. Gửi thành công không xác nhận đã nhận trên điện thoại.

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

Các lỗi thường gặp và các bước tiếp theo

Các quốc gia và khu vực được hỗ trợ

Kiểm tra tính khả dụng của đích đến trước khi gửi. Các điểm đến yêu cầu đăng ký SID sắp ra mắt. Nhập mã gọi bên dưới vào CountryCode không có + và nhập riêng số điện thoại vào phone.