メール署名の照会
メールの署名を照会します。
APIの種類
サービスAPI
Request URL
https://apis.worksmobile.com/r/{API ID}/mail/v2/sign
HTTP Method
GET(Content-Type: application/x-www-form-urlencoded; charset=UTF-8)
Request
なし。
Response
API 呼び出しに成功すると HTTP Status コード 200 を返し、応答内容は JSON 形式で返します。
プロパティ | タイプ | 必須 | 説明 |
---|---|---|---|
signList | List | Y | 署名リスト |
signList[].useDefaultSign | Boolean | Y | 新規メール作成での署名の使用有無 |
signList[].defaultSign | String | Y | 新規メール作成で使用する署名の番号 |
signList[].useDefaultSignForRefw | Boolean | Y | 返信、転送での署名の使用有無 |
signList[].defaultSignForRefw | String | Y | 返信、転送で使用する署名の番号 |
signList[].signInfoList | List | Y | 署名情報 |
signList[].signInfoList[].keyNum | String | N | 署名の番号 |
signList[].signInfoList[].contents | String | N | 署名の内容 |
signList[].signInfoList[].name | String | N | 署名の名前 |
Response Example
{
"signList": [
{
"defaultSign": "1",
"useDefaultSign": "true",
"useDefaultSignForRefw": "false",
"defaultSignForRefw": "0",
"signInfoList": [
{
"keyNum": "1",
"contents": "<html><body>Sign</body></html>",
"name": "Sign"
},
{
"keyNum": "2",
"contents": "<html><body>Sign 1</body></html>",
"name": "Sign 1"
}
]
}
]
}
Error
呼び出しに失敗すると HTTP Status と以下のエラー情報を返します。
プロパティ | タイプ | 説明 |
---|---|---|
code | String | Error Code |
message | String | Error Message |
HTTP Status | Error Code | 説明 |
---|---|---|
500 | SYSTEM_ERROR | 内部サーバーエラー |
Error Example
{
"code": "SYSTEM_ERROR",
"message": "internal error",
"domain": "mail"
}