未読メール数照会
未読メール数を照会します。
環境設定 > 通知 > メール > メールフォルダ設定にて選択されているメールフォルダの未読メール数を照会します。既定値はすべてのメールフォルダの未読メール数です。
API の種類
サービス API
Request URL
https://apis.worksmobile.com/r/{API ID}/mail/v2/getMailCount
HTTP Method
GET (Content-Type: application/x-www-form-urlencoded; charset=UTF-8)
Request
パラメータなし
Request Example
https://apis.worksmobile.com/r/{API ID}/mail/v2/getMailCount
Response
API 呼び出しに成功すると HTTP Status コード 200 を返し、応答内容は JSON 形式で返します。
プロパティ | タイプ | 必須 | 説明 |
---|---|---|---|
count | Long | Y | 未読メール数。 値が 0 以上の場合は正常です。 |
Response Example
{"count":1376}
Error
呼び出しに失敗すると HTTP Status と以下のエラー情報を返します。
プロパティ | タイプ | 説明 |
---|---|---|
code | String | Error Code |
message | String | Error Message |
HTTP ステータス | エラーコード | 説明 |
---|---|---|
500 | SYSTEM_ERROR | 内部サーバーエラー |
Error Example
{
"code": "SYSTEM_ERROR",
"message": "internal error",
"domain": "mail"
}