送信関連
送信
SMSテンプレートを1人以上のユーザーに送信します。
URL
https://sms.api.engagelab.cc/v1/send
https://sms.api.engagelab.cc/v1/send
このコードブロックはフローティングウィンドウ内に表示されます
HTTPリクエストメソッド
POST
POST
このコードブロックはフローティングウィンドウ内に表示されます
Content-Type
Content-Type: application/json;charset=utf-8
Content-Type: application/json;charset=utf-8
このコードブロックはフローティングウィンドウ内に表示されます
リクエストヘッダー
| ヘッダー | タイプ | 必須 | 説明 |
|---|---|---|---|
| Authorization | String | true | Basic base64(sms_user:sms_key) |
パラメータ説明
| パラメータ | タイプ | 必須 | 説明 |
|---|---|---|---|
| from | string | No | 送信者名、3～11文字をサポートし、英数字のみ使用可能、デフォルトは空。実際の表示は異なる場合があります。 |
| to | array | Yes | 電話番号のリスト、最大1000件まで。 |
| body | object | Yes | SMSコンテンツ設定。 |
| template_id | int | Yes | テンプレートID。 |
| msg_type | int | No | ビジネスタイプ、2は国際SMSを表し、デフォルトは2。 |
| label_id | int | No | SMSラベル。 |
| vars | object | No | 変数。最大サイズは1MB。 |
| custom_args | object | No | ユーザー定義のオプションフィールド、最大サイズは1KB。 |
| request_id | string | No | この送信のリクエストID、最大128文字。 |
注意:
varsはSMSコンテンツ内の変数置換に使用され、JSONオブジェクト形式で記述します:{"varname":"value1"}。ここでvarnameはSMSコンテンツ内の変数です。- SMSコンテンツ例: "Welcome to %sp% SMS service." 対応する
vars値:{"sp":"engagelab"}。置換後: "Welcome to engagelab SMS service."vars内の各値はデフォルトで16文字を超えない必要があり、文字列である必要があり、HTTPリンクを含むことはできません（特別な要件についてはカスタマーサービスにお問い合わせください）。- システムはSMSテンプレート内の変数を
vars内のパラメータで置換し、すべての電話番号に同じ置換後のコンテンツが送信されます。customer_argsはユーザー定義のカスタムコンテンツで、後続のSMSHookデータでユーザーに返されます。request_idは重複送信を防ぐために使用され、1時間有効です。1時間以内に再送信された場合、前回のリクエスト結果が返されます。
リクエスト例
curl -X POST "https://sms.api.engagelab.cc/v1/send"
--header "Authorization: Basic <<YOUR_SMS_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"from": "xxxx",
"to": ["+12673800456", "+12673800455"],
"request_id":"123" ,
"body":{
"template_id": 2336,
"label_id": 231,
"vars": {
'week':"Tuesday"
}
}
}'
curl -X POST "https://sms.api.engagelab.cc/v1/send"
--header "Authorization: Basic <<YOUR_SMS_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"from": "xxxx",
"to": ["+12673800456", "+12673800455"],
"request_id":"123" ,
"body":{
"template_id": 2336,
"label_id": 231,
"vars": {
'week':"Tuesday"
}
}
}'
このコードブロックはフローティングウィンドウ内に表示されます
レスポンス説明
| パラメータ | 説明 |
|---|---|
| success_count | 成功した送信数。 |
| sms_ids | 成功送信されたSMSのIDリスト。 |
| failed_count | 失敗した送信数。 |
| failed_items | 失敗した電話番号と失敗理由のリスト。 |
| phone | 電話番号。 |
| message | 失敗理由。 |
| request_id | ユーザー定義のオプションフィールド。 |
| custom_args | この送信のリクエストID。 |
レスポンス例
レスポンス-成功
HTTPステータス: 200
//成功レスポンス例
{
"sms_ids": ["1458113381893_15_3_11_1ainnq$+12673800456", "1458113381893_15_3_11_1ainnq$+12673800456"]
"request_id":"123"
}
// 部分的に成功したレスポンス例
{
"code": 41031,
"message": "partial success"，
"success_count": 1,
"sms_ids": ["1458113381893_15_3_11_1ainnq$+12673800456"],
"request_id":"123" ,
"failed_count": 1,
"failed_items": [
{
"phone":"1233",
"message":"Invalid phone number format"
}
]
}
//成功レスポンス例
{
"sms_ids": ["1458113381893_15_3_11_1ainnq$+12673800456", "1458113381893_15_3_11_1ainnq$+12673800456"]
"request_id":"123"
}
// 部分的に成功したレスポンス例
{
"code": 41031,
"message": "partial success"，
"success_count": 1,
"sms_ids": ["1458113381893_15_3_11_1ainnq$+12673800456"],
"request_id":"123" ,
"failed_count": 1,
"failed_items": [
{
"phone":"1233",
"message":"Invalid phone number format"
}
]
}
このコードブロックはフローティングウィンドウ内に表示されます
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
このコードブロックはフローティングウィンドウ内に表示されます
Response-error
HTTP Status :400
// 失敗したレスポンス例
{
"code": 32002,
"message": "Invalid phone number format"
}
// 失敗したレスポンス例
{
"code": 32002,
"message": "Invalid phone number format"
}
このコードブロックはフローティングウィンドウ内に表示されます
