閲覧状況を確認状態にする
メッセージ ID をリクエストのパラメーターとして受け取り、指定されたメッセージの閲覧状況を確認状態にし、メッセージの情報を返す API です。API を実行するユーザーが宛先/差出人に含まれているメッセージの閲覧状況のみ確認状態にできます。
API名
MessageConfirmThreads
使用可能なGaroonのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon 3.0 以降
リクエスト
パラメーター名 |
型 |
パラメーター数 |
説明 |
thread_id/text() |
xsd:string |
1 ~ 無制限 |
確認するメッセージのID |
例
1
2
3
|
<parameters>
<thread_id >3</thread_id>
</parameters>
|
レスポンス
例
1
2
3
4
5
6
7
8
9
10
|
<returns>
<thread id="3" version="1278641943" confirm="true" subject="標題" is_draft="false">
<addressee user_id="1" name="Administrator" deleted="false" confirmed="true" />
<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_MSSG_15003 |
指定したメッセージIDが存在しない場合 |