createMailRequest
- 印刷する
- PDF
createMailRequest
- 印刷する
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Email送信をリクエストします。
送信作業は非同期で処理され、送信が完了するかエラーが発生するとコンソールの右上にあるNotificationでご案内いたします。
POST https://{endpoint}/mails
注意
- 一回に最大100,000人にメールを送信することができ、通常送信の場合は30件ずつ分けて送信します。(受信者グループの組み合わせ送信条件[recipientGroupFilter]を入力すれば100,000人を超えて送信できる)
- 写し受信者または秘密受信者はそれぞれ最大30人まで指定できます。
- 本文は500KBを超えることができません。
- 基本送信限度は月1,000,000件です。基本送信限度以上の送信が必要な場合、サポートセンターを通じて送信限度の引上げリクエストを行えます。
- 送信リクエストの限度はメールの受信者数に基づいて計算されます。100人の受信者に対する送信をリクエストすると、100件の送信リクエストと見なします。
リクエスト
リクエストパラメータ
| パラメータ名 | 必須 | タイプ | 制約事項 | 説明 |
|---|---|---|---|---|
| senderAddress | Conditional | String | templateSidが伝わらないと必須、ドメインにnaver.com、navercorp.comなどが使えない | 送信者のEmailアドレス、任意のドメインアドレスを使っても構いませんが、できれば送信者が所有しているドメインのEmailアカウントを利用することをおすすめします。DMARCが適用された「id@naver.com」といったポータルサイトのウェブメールアカウントを使うと、DMARC検査で失敗し、受信側のポリシーに従って迷惑メールに処理される可能性が高まります。 |
| senderName | No | String | Max:69 | 送信者名 |
| templateSid | No | Integer | テンプレートID | |
| title | Conditional | String | templateSidが伝わらないと必須、Min:0、Max:500 | Mailタイトル |
| body | Conditional | String | templateSidが伝わらないと必須、Max:500KB (広告メールの場合、受信拒否メッセージを含んで計算されます。) | Email本文 |
| individual | No | Boolean | Default:true | 個人別発送または一般発送の有無 * 個人別発送の場合、受信者リスト(recipients)に受信者(R)のみ入力可能で、多数の受信者を入力する場合は個人別に分けて発送される * 個人別発送の場合は参照者(C)、隠れた参照(B)は使用不可 |
| confirmAndSend | No | Boolean | 確認してからの送信可否 | |
| advertising | No | Boolean | 広告メールの可否 | |
| parameters | No | Object | 置換パラメータ(全体受信者に適用)、「置換ID」を keyとして「置換IDにマッピングされる値」をvalueにもつMapタイプのObject | |
| referencesHeader | No | String | Max:100、次の形になる必要がある：<<unique_id@domain.com>> | 特定メールをまとめて確認するためにNAVERメールがサポートする機能、該当するフィールドに同じ値を入力したメールをまとめて確認することができる。 |
| reservationUtc | No | Long | 予約送信日時(1970年1月1日00:00:00協定世界時(UTC)からの経過時間を1/1000秒に換算した定数)、 reservationDateTimeの値よりこの値が優先的に適用される。 | |
| reservationDateTime | No | String | 「yyyy-MM-dd HH:mm」 UTC+09:00 | 予約送信日時、reservationUtcの値を優先とする。 |
| attachFileIds | No | List<String> | createFile API によりアップロードしたファイルのID | 添付ファイルのIDリスト |
| recipients | Conditional | List<RecipientForRequest> | recipientGroupFilter値が入力されなければ必須 | 受信者リスト |
| recipientGroupFilter | No | RecipientGroupFilter | 受信者グループ組み合わせの送信条件 | |
| useBasicUnsubscribeMsg | No | Boolean | Default:true, basic unsubscribe message size: 約900byte | 広告メールの場合、デフォルトの受信拒否フレーズの使用可否 |
| unsubscribeMessage | Conditional | String | useBasicUnsubscribeMsgの値がFalseであれば必須、Max:bodyと合算して500KB | ユーザが定義する受信拒否のフレーズ、受信拒否のフレーズは基本、bodyの最後に追加され、本文の希望する位置に#{UNSUBSCRIBE_MESSAGE}を追加すれば、該当するタグの位置に受信拒否のフレーズが入ります。 |
レスポンス
| HTTPステータスコード | 説明 |
|---|---|
| 201 | 送信リクエストの成功 |
| 400 | 認証失敗、間違ったリクエスト |
| 500 | サーバエラー |
例示
リクエスト
curl -i -s -X POST \
-H "Content-Type:application/json" \
-H "x-ncp-apigw-timestamp:1521787414578" \
-H "x-ncp-iam-access-key:6uxz1nKkcYwUjWRG5Q1V7NsW0i5jErlu2NjBXXgy" \
-H "x-ncp-apigw-signature-v2:iJFK773KH0WwQ79PasqJ+ZGixtpDQ/abS57WGQdld2M=" \
"https://mail.apigw.ntruss.com/api/v1/mails"\
-d ''{"senderAddress":"no_reply@company.com","title":"${customer_name}様、ようこそ。","body":"貴下の等級が${BEFORE_GRADE}から${AFTER_GRADE}に変更されました。","recipients":[{"address":"hongildong@naver_.com","name":"ホン・ギルトン","type":"R","parameters":{"customer_name":"ホン・ギルトン","BEFORE_GRADE":"SILVER","AFTER_GRADE":"GOLD"}},{"address":"chulsoo@daum_.net","name":null,"type":"R","parameters":{"customer_name":"철수","BEFORE_GRADE":"BRONZE","AFTER_GRADE":"SILVER"}}],"individual":true,"advertising":false}''
リクエスト (テンプレート使用)
curl -i -s -X POST \
-H "Content-Type:application/json" \
-H "x-ncp-apigw-timestamp:1521787414578" \
-H "x-ncp-iam-access-key:6uxz1nKkcYwUjWRG5Q1V7NsW0i5jErlu2NjBXXgy" \
-H "x-ncp-apigw-signature-v2:iJFK773KH0WwQ79PasqJ+ZGixtpDQ/abS57WGQdld2M=" \
"https://mail.apigw.ntruss.com/api/v1/mails"\
-d ''{"templateSid" : 1,"recipients":[{"address":"hongildong@naver_.com","name":"홍길동","type":"R","parameters":{"customer_name":"홍길동","BEFORE_GRADE":"SILVER","AFTER_GRADE":"GOLD"}},{"address":"chulsoo@daum_.net","name":null,"type":"R","parameters":{"customer_name":"철수","BEFORE_GRADE":"BRONZE","AFTER_GRADE":"SILVER"}}],"individual":true,"advertising":false}''
レスポンス
{
"requestId":"20181203000000000201",
"count":10000
}
属性
| 項目 | 必須 | タイプ | 制約事項 | 説明 |
|---|---|---|---|---|
| requestId | Yes | String | Email送信リクエストのID(それぞれのリクエストを区別するID、一気に複数件のメール送信を要請する場合はrequestIdが複数のmailIdを含むことがある。 | |
| count | Yes | Integer | メールのリクエス件数 |
エラーコード
| HTTP Status Code | リターンコード | レスポンスメッセージ |
|---|---|---|
| 400 | 77101 | ログイン情報エラー |
| 400 | 77102 | BAD_REQUEST |
| 400 | 77103 | リソースが存在しない |
| 403 | 77201 | 権限なし |
| 403 | 77202 | Email商品の利用申込をしていない |
| 405 | 77001 | METHOD_NOT_ALLOWED |
| 415 | 77002 | UNSUPPORTED_MEDIA_TYPE |
| 500 | 77301 | 基本プロジェクトが存在しない |
| 500 | 77302 | 外部システムAPIの連動エラー |
| 500 | 77303 | その他のINTERNAL_SERVER_ERROR |
この記事は役に立ちましたか?