メッセージを送信する
固定リンクがコピーされました
メッセージの情報をリクエストのパラメーターとして受け取り、メッセージの送信処理を実行後、送信したメッセージの情報をレスポンスとして返すAPIです。 このAPIは、書式編集を利用したメッセージ本文の送信に対応していません。
MessageCreateThreads
利用できるバージョン
固定リンクがコピーされました
- クラウド版Garoon
- パッケージ版Garoon 3.0以降
パラメーター名 |
型 |
パラメーター数 |
説明 |
create_thread |
配列 |
1~ 無制限 |
送信するメッセージ |
create_thread/thread |
message:ThreadType |
1 |
送信するメッセージの情報 |
create_thread/file |
配列 |
0~ 無制限 |
送信するメッセージに添付するファイル |
create_thread/file/content |
xsd:base64Binary |
1 |
添付ファイルデータ |
create_thread/file/@id |
xsd:string |
1 |
添付ファイルのID |
例
1
2
3
4
5
6
7
8
9
|
<parameters>
<create_thread>
<thread id="dummy" version="dummy" subject="標題" confirm="false">
<addressee user_id="1" name="dummy" deleted="false"></addressee>
<content body="本文"></content>
<folder id="dummy"></folder>
</thread>
</create_thread>
</parameters>
|
例
1
2
3
4
5
6
7
8
9
10
|
<returns>
<thread id="58" version="1278641943" confirm="false" subject="標題" is_draft="false">
<addressee user_id="1" name="Administrator" deleted="false" confirmed="false" />
<content body="本文"></content>
<folder id="2" />
<folder id="3" />
<creator user_id="1" name="Administrator" date="2010-07-09T02:19:03Z" />
<modifier user_id="1" name="Administrator" date="2010-07-09T02:19:03Z" />
</thread>
</returns>
|
エラー番号 |
説明 |
GRN_UTIL_API_65009 |
アップロードするファイルのサイズが、Base64エンコード後で300MBより大きい場合 |
メッセージを更新する
固定リンクがコピーされました
メッセージの情報をリクエストのパラメーターとして受け取り、メッセージの更新処理を実行後、更新したメッセージの情報をレスポンスとして返すAPIです。APIを実行するユーザーが宛先/差出人に含まれているメッセージのみ更新されます。メッセージ本文の書式は変更できません。
MessageModifyThreads
利用できるバージョン
固定リンクがコピーされました
- クラウド版Garoon
- パッケージ版Garoon 3.0以降
パラメーター名 |
型 |
パラメーター数 |
説明 |
modify_thread |
配列 |
1~ 無制限 |
変更するメッセージ |
modify_thread/thread |
message:ThreadType |
1 |
変更するメッセージの情報 |
modify_thread/file |
配列 |
0~ 無制限 |
変更するメッセージに添付するファイル |
modify_thread/file/content |
xsd:base64Binary |
1 |
添付ファイルデータ |
modify_thread/file/@id |
xsd:string |
1 |
添付ファイルのID |
例
1
2
3
4
5
6
7
8
9
10
|
<parameters>
<modify_thread>
<thread id="58" version="dummy" subject="標題(変更)" confirm="false">
<addressee user_id="1" name="dummy" deleted="false"></addressee>
<addressee user_id="2" name="dummy" deleted="false"></addressee>
<content body="本文(変更)"></content>
<folder id="dummy"></folder>
</thread>
</modify_thread>
</parameters>
|
例
1
2
3
4
5
6
7
8
9
10
11
|
<returns>
<thread id="58" version="1278643054" confirm="false" subject="標題(変更)" is_draft="false">
<addressee user_id="1" name="Administrator" deleted="false" confirmed="false" />
<addressee user_id="2" name="user1" deleted="false" confirmed="false" />
<content body="本文(変更)"></content>
<folder id="2" />
<folder id="3" />
<creator user_id="1" name="Administrator" date="2010-07-09T02:19:03Z" />
<modifier user_id="1" name="Administrator" date="2010-07-09T02:37:34Z" />
</thread>
</returns>
|
エラー番号 |
説明 |
GRN_MSSG_15003 |
指定したメッセージIDが存在しない場合 |
GRN_UTIL_API_65009 |
アップロードするファイルのサイズが、Base64エンコード後で300MBより大きい場合 |
メッセージを下書き保存する
固定リンクがコピーされました
メッセージの情報をリクエストのパラメーターとして受け取り、メッセージの下書き保存処理を実行後、保存したメッセージの情報をレスポンスとして返すAPIです。このAPIは、書式編集を利用した下書き保存に対応していません。
MessageSaveDraftThreads
利用できるバージョン
固定リンクがコピーされました
- クラウド版Garoon
- パッケージ版Garoon 3.0以降
パラメーター名 |
型 |
パラメーター数 |
説明 |
save_draft_thread |
配列 |
1~ 無制限 |
下書き保存するメッセージ |
save_draft_thread/thread |
message:ThreadType |
1 |
下書き保存するメッセージの情報 |
save_draft_thread/file |
配列 |
0~ 無制限 |
下書き保存するメッセージに添付するファイル |
save_draft_thread/file/content |
xsd:base64Binary |
1 |
添付ファイルデータ |
save_draft_thread/file/@id |
xsd:string |
1 |
添付ファイルのID |
例
1
2
3
4
5
6
7
8
9
|
<parameters>
<save_draft_thread>
<thread id="dummy" version="dummy" subject="標題" confirm="false">
<addressee user_id="1" name="dummy" deleted="false"></addressee>
<content body="本文"></content>
<folder id="dummy"></folder>
</thread>
</save_draft_thread>
</parameters>
|
例
1
2
3
4
5
6
7
8
9
|
<returns>
<thread id="58" version="1278641943" confirm="false" subject="標題" is_draft="true">
<addressee user_id="1" name="Administrator" deleted="false" confirmed="false" />
<content body="本文"></content>
<folder id="4" />
<creator user_id="1" name="Administrator" date="2010-07-09T02:19:03Z" />
<modifier user_id="1" name="Administrator" date="2010-07-09T02:19:03Z" />
</thread>
</returns>
|
エラー番号 |
説明 |
GRN_UTIL_API_65009 |
アップロードするファイルのサイズが、Base64エンコード後で300MBより大きい場合 |
メッセージを削除する
固定リンクがコピーされました
メッセージIDをリクエストのパラメーターとして受け取り、指定されたメッセージを削除するAPIです。APIを実行するユーザーが宛先/差出人に含まれているメッセージのみ削除されます。
MessageRemoveThreads
利用できるバージョン
固定リンクがコピーされました
- クラウド版Garoon
- パッケージ版Garoon 3.0以降
クラウド版Garoon、パッケージ版3.1以降
パラメーター名 |
型 |
パラメーター数 |
説明 |
param |
message:MessageRemoveThreadType |
1~ 無制限 |
削除するメッセージの情報 |
@delete_all_inbox |
xsd:boolean |
0~1 |
すべての受信者の受信箱から削除- true:削除する
- false:送信者の受信箱からのみ削除する
|
パッケージ版Garoon 3.0
パラメーター名 |
型 |
パラメーター数 |
説明 |
thread_id/text() |
base:IDType |
1~ 無制限 |
削除するメッセージのID |
例
クラウド版Garoon、パッケージ版Garoon 3.1以降
1
2
3
|
<parameters delete_all_inbox="false">
<param xmlns="" folder_id="7" thread_id="6"></param>
</parameters>
|
パッケージ版Garoon 3.0
1
2
3
|
<parameters>
<thread_id>3</thread_id>
</parameters>
|
なし
クラウド版Garoon、パッケージ版Garoon 3.1以降
エラー番号 |
説明 |
GRN_MSSG_15016 |
指定したフォルダーIDが存在しない場合 |
GRN_MSSG_15019 |
指定したメッセージIDが存在しない場合 |
パッケージ版Garoon 3.0
エラー番号 |
説明 |
GRN_MSSG_15019 |
指定したメッセージIDが存在しない場合 |