配信待ちになっているメールの配信日時を変更するAPIです。
※配信日時に指定できる範囲は現在から翌年末までです。
https://●●●●●/■■■■■/api/index.php?ac=EditMailSendSchedule
●●●●●/■■■■■ は、弊社からお知らせしたログインURLに置き換えてください。
例)お客様のログインURLが https://m.crmf.jp/api_sample/index.php の場合、
●●●●● は、m.crmf.jp
■■■■■ は、api_sample に置き換えてください。
パラメータ名 | 項目名 | 属性 | 必須 | 設定内容 |
---|---|---|---|---|
transport_password | 接続用パスワード | 文字列 | ★ | API連携接続用パスワード |
charset | 文字コード | 整数 | ★ | CSVファイルの文字コード・通信文字コード。 1 : UTF-8 2 : Shift-JIS 3 : EUC-JP |
return_format | 取得形式 | 整数 | 取得する形式を指定。 "csv" :CSV形式 "xml" :XML形式 ※省略すると、csv形式。 |
|
mail_id | メールID | 整数 | ★ | 対象メールのメールID ※変更できるメール状態 ・配信待ち |
schedule_type | 予約種別 | 整数 | ★ | メールの予約種別 1 : 即時配信 2 : 予約配信 |
schedule_date | 配信日時 | 日時 | メールの配信を行う日時(yyyy/mm/dd hh24:mi) ※過去日時は指定できない。 |
なし
レスポンスのボディ部に書かれたエラーコードから、エラーの理由を判別することが可能です。
CODE | STATUS | メッセージ |
---|---|---|
81401 | unauthorized | 接続情報が正しくありません。 |
81402 | access denied | 許可されていないIPアドレスからのアクセスです。 |
81404 | too many calls | APIの実行回数が制限を超えました。 |
81423 | no password | transport_password が入力されていません。 |
81461 | bad charset | charsetには、1~3 の整数を指定してください。 |
81462 | bad return_format | return_formatには、「csv」もしくは「xml」を指定してください。 |
81466 | no mail_id | mail_idを指定してください。 |
81467 | bad mail_id | mail_idが整数ではない、または存在しないmail_idです。 |
82464 | bad schedule_type | schedule_typeには、1~2 の整数を指定してください。 |
82465 | bad schedule_date | schedule_dateが正しく指定されていません。 |
82466 | too old schedule_date | schedule_dateに過去の日付は使用できません。 |
82471 | schedule_date out of range | schedule_dateに指定できる日付は翌年末までです。 |
82470 | unable to edit schedule | 対象のメールは、配信日時を変更することができません。 |
99500 | internal error | 処理に失敗しました。 |