メッセージ通知

メッセージ通知の作成

POST /v1/notify

このインターフェースは、メッセージ通知の作成に使用されます。添付ファイルの付与が可能で、一度に複数のファイルをアップロードすることができます。詳細はリクエスト例を参照してください。

リクエストパラメータ

パラメータ	タイプ	必須	説明
subject	文字列	はい	通知のタイトル、長さ20
content	文字列	はい	通知の内容、リッチテキスト対応、長さ500.
userEmails	文字列	いいえ	受信者 - メールアドレス（受信者は1つ以上必須）、複数ある場合は英語のカンマで区切り、最大1000.
userGroupIds	文字列	いいえ	受信者 - ユーザーグループID（受信者は1つ以上必須）、複数ある場合は英語のカンマで区切り、最大1000.

レスポンスデータ

属性名	タイプ	説明
code	整数型	レスポンスコード.
message	文字列	レスポンスメッセージ.
visible	ブール型	可視性. true / false .
data	整数型	通知番号.

リクエストボディ

{
    "subject": "メッセージタイトル",
    "content": "<p>メッセージ内容</p>",
    "userEmails": "ab@shh.cn,cd@shh.cn",
    "userGroupIds": "41,235"
}

リクエスト例

curl --location -g --request POST 'https://servicego.udesk.cn/api/v1/notify?email=1@test.cn&timestamp=1662108548&sign=bc2e966cf693478b522ed5659907c761b3877845' \
--form 'files=@"/C:/Users/admin/Desktop/______.txt"' \
--form 'files=@"/C:/Users/admin/Desktop/batch.txt"' \
--form 'notifyRequest="{
    \"subject\": \"メッセージタイトルpostman\",
    \"content\": \"<p>メッセージ内容、添付ファイルなしjhjhjsssss</p>\",
    \"userEmails\": \"1@shh.cn,1@test.cn\",
    \"userGroupIds\":\"1,2\"
}";type=application/json'

リクエスト例（Java）

public static void main(String[] args) throws IOException {
    CloseableHttpClient httpClient = HttpClients.createSystem();

    MultipartEntityBuilder multipartEntityBuilder = MultipartEntityBuilder.create().setMode(HttpMultipartMode.RFC6532);
    multipartEntityBuilder.addBinaryBody("files", new FileInputStream("C:\\Users\\admin\\Desktop\\right.txt"), ContentType.MULTIPART_FORM_DATA, "right.txt");
    multipartEntityBuilder.addBinaryBody("files", new FileInputStream("C:\\Users\\admin\\Desktop\\sql.txt"), ContentType.MULTIPART_FORM_DATA, "sql.txt");
    multipartEntityBuilder.addTextBody("notifyRequest", "{\"subject\":\"メッセージタイトル\",\"content\":\"<p>メッセージ内容</p>\",\"userEmails\":\"1@1.cn,2@q.cn\",\"userGroupIds\":\"1,2\"}", ContentType.APPLICATION_JSON);

    HttpEntity httpEntity = multipartEntityBuilder.build();
    HttpPost httpPost = new HttpPost(URI.create("https://servicego.udesk.cn/api/v1/notify?email=1@shh.cn&timestamp=1661306744&sign=f11983aaea9a597f5c45bde9393ad151d79c88c37e9fa2b13c2e6a8706bfeabf"));
    httpPost.setEntity(httpEntity);

    CloseableHttpResponse execute = httpClient.execute(httpPost);
    System.out.println("レスポンスステータス：" + execute.getStatusLine().getStatusCode());
    System.out.println("レスポンスデータ：" + StreamUtils.copyToString(execute.getEntity().getContent(), StandardCharsets.UTF_8));

}

レスポンス例

{
  "code" : 200,
  "message" : "OK",
  "visible" : false,
  "data" : 12
}