API連携
予約状況の確認
配信待ち一覧データを検索・削除します。対象が無い場合には空データが返ります。
削除は、新規作成メールの登録時に返りますユニークな識別IDを条件に行い、
削除に成功、あるいは失敗しても識別IDリストが返ります。
XML-RPC
https://api.bme.jp/xmlrpc/1.0/予約状況の検索
array message.reservationSearch(string accessToken)パラメータ
| string accessToken | API利用許可トークン |
|---|
戻り値
| array | int messageID: 識別ID dateTime.iso8601 date: 登録日時 string subject: 件名 string group: 宛先 string sender: 送信者 int total: 配信数 string status: 状況(編集中・編集中(公開)・配信待ち・配信待ち(公開)・配信中・配信中(公開) |
|---|
予約状況の検索(識別ID)
array message.reservationSearchByMessageIDs(string accessToken, array messageIDs)パラメータ
| string accessToken | API利用許可トークン |
|---|---|
| array messageIDs | 識別IDリスト(int) |
戻り値
| array | int messageID: 識別ID dateTime.iso8601 date: 登録日時 string subject: 件名 string group: 宛先 string sender: 送信者 int total: 配信数 string status: 状況(編集中・編集中(公開)・配信待ち・配信待ち(公開)・配信中・配信中(公開)) |
|---|
予約状況の検索(メッセージデータ)
struct message.detailSearch(string accessToken, int messageID)パラメータ
| string accessToken | API利用許可トークン |
|---|---|
| int messageID | 識別ID(int) |
戻り値
| struct | int messageID: 識別ID int senderID: 送信者 int groupID: 宛先 string subject: 件名 string textPart: 本文 string htmlPart: HTMLメール用データ dateTime.iso8601 scheduleDate: 配信時刻 boolean public: バックナンバー(true: 公開する、false: 公開しない) |
|---|
予約の削除
struct message.listDelete(string accessToken, array messageIDs)パラメータ
| string accessToken | API利用許可トークン |
|---|---|
| array messageIDs | 識別IDリスト |
戻り値
| struct | array success: 処理成功(int) array failure: 処理失敗(int) |
|---|