メッセージを作成する
1件のメッセージを作成する
メッセージを作成します。
URL
クラウド版
https://sample.cybozu.com/g/api/v1/message/messages
HTTPメソッド
POST
利用できるバージョン
- クラウド版Garoon
リクエスト
パラメーター
パラメーター名 | 型 | 必須 | 説明 |
---|---|---|---|
title | 文字列 | 必須 | メッセージの標題 最大文字数は、100文字です。 |
recipients | 配列 | 必須 | 宛先のリスト |
recipients[].id | 文字列 | 必須 | 宛先のGaroonユーザーID |
recipients[].type | 文字列 | 必須 | 宛先のタイプUSER を指定します。 |
acknowledgment | 真偽値 | 省略可 | 閲覧状況を確認するかどうか
|
isDraft | 真偽値 | 省略可 | 下書きとして保存するかどうか
|
body | 文字列 | 省略可 | メッセージの本文 |
isHtmlBody | 真偽値 | 省略可 | 本文を書式編集(HTML形式)で保存するかどうか
|
operatorType | 文字列 | 省略可 | 変更/削除の許可
|
operators | 配列 | 省略可 | 変更/削除の許可で許可するユーザーのリストSELECT_USERS を指定した場合のみ必須です。 |
operators[].id | 文字列 | 省略可 | メッセージの変更/削除を許可されているGaroonユーザーID |
operators[].name | 文字列 | 省略可 | メッセージの変更/削除を許可されているユーザーの表示名 |
operators[].code | 文字列 | 省略可 | メッセージの変更/削除を許可されているユーザーのログイン名 |
operators[].type | 文字列 | 省略可 | メッセージの変更/削除を許可されているタイプ
|
リクエストの例
URL
https://sample.cybozu.com/g/api/v1/message/messages
ヘッダー
|
|
リクエストヘッダーの詳細は Garoon REST APIの共通仕様 を参照してください。
ボディ
|
|
レスポンス
プロパティ
プロパティ名 | 型 | 説明 |
---|---|---|
id | 文字列 | メッセージのID |
title | 文字列 | メッセージの標題 |
creator[].id | 文字列 | 作成者のGaroonユーザーID |
creator[].code | 文字列 | 作成者のログイン名 |
creator[].name | 文字列 | 作成者の表示名 |
createdAt | 文字列 | 作成日時 |
updater[].id | 文字列 | 更新者のGaroonユーザーID |
updater[].code | 文字列 | 更新者のログイン名 |
updater[].name | 文字列 | 更新者の表示名 |
recipients[].id | 文字列 | 宛先のGaroonユーザーID |
recipients[].name | 文字列 | 宛先の表示名 |
recipients[].code | 文字列 | 宛先のログイン名 |
recipients[].type | 文字列 | 宛先のタイプ
|
recipients[].isAcknowledged | 文字列 | 閲覧状況を確認するかどうか
|
acknowledgment | 真偽値 | 閲覧状況を確認するかどうか
|
isDraft | 真偽値 | 下書きどうか
|
body | 文字列 | メッセージの本文 |
isHtmlBody | 真偽値 | 本文を書式編集(HTML形式)で保存するかどうか
|
レスポンスの例
|
|
サンプルコード
curlを使ったリクエスト
ご利用の環境によって、curlのフォーマットは異なる場合があります。
詳細は、次のページを参照してください。
curlコマンドでkintone REST APIを実行してみよう/3.API実行
|
|
Garoon REST APIリクエストを送信するAPI を使ったリクエスト
|
|