一覧取得¶
GET /api/v1/notification_schedule/list
概要¶
現在のワークスペースの通知スケジュールを照会する、または日付別に通知先カレンダーを表示します。
呼び出し前の確認と使用手順¶
通常のリストでは content.data を読み取り、トップレベルの pageInfo を使用してページングします。カレンダー照会では scheduleCalendar=true と scDateRange を必ず指定します。ページングは行われず、ページ番号パラメータは無視されます。現在、夏時間(DST)の切り替えをまたぐ複数日範囲では終了日が欠落する可能性があります。対象タイムゾーンで単日ごとに分割して照会し、結果をマージすることで日付の網羅性を確保できます。UTC に直接変更して業務上の日付基準を変えないでください。スケジュールは最終更新日時または作成日時の降順です。通知先一覧とワークスペースメンバー一覧を使用して、対象の絞り込みを準備できます。関連ポリシーによる絞り込みでは、どのスケジュールにも関連がない場合に他のスケジュールが返される制限があります。呼び出し後は issueNotificationPolicyInfos を確認し、絞り込み条件を関連が存在する証拠と見なさないでください。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Query リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| issueNotificationPolicyUUIDs | commaArray | 関連する通知ポリシーで絞り込みます。選択したポリシーのいずれにもスケジュールの関連がない場合、有効にならない可能性があるため、各関連結果を確認する必要があります。 null 許可: False 例: inpy_example取得または入力方法: 通知ポリシー一覧の uuid から取得し、複数指定する場合は半角カンマで区切ります。 |
|
| mySchedule | string | 文字列 true/false。デフォルトは false。API Key は wsak の識別情報に対応し、特定の自然人を表すことはできません。特定のメンバーを照会する場合は notifyTargets を使用します。 null 許可: True 選択可能な値: ['true', 'false'] 例: false取得または入力方法: 現在の呼び出し元識別情報に関連するスケジュールを表示する場合は true、すべてを照会する場合は false を指定します。 |
|
| notificationScheduleUUIDs | commaArray | カンマ区切りのスケジュール UUID 文字列。対象ワークスペース内のスケジュールを絞り込みます。 null 許可: False 例: nsche_example取得または入力方法: スケジュール一覧の content.data[].uuid から取得し、複数指定する場合は半角カンマで区切ります。 |
|
| notifyTargets | commaArray | カンマ区切りの文字列。いずれかの通知先が一致すれば対象になります。JSON 配列は指定できません。 null 許可: False 例: notify_example取得または入力方法: メンバーはワークスペースメンバー一覧のアカウント UUID から取得し、通知先は通知先一覧の uuid から取得するか、有効なメールアドレスを入力します。すべて文字列である必要があります。複数指定する場合は半角カンマで区切ります。 |
|
| pageIndex | integer | 通常リストのページ番号。デフォルトは 1、最小値は 1。カレンダーモードでは無視されます。 null 許可: False $minValue: 1 例: 1取得または入力方法: 先頭ページは 1、以降は 1 ずつ加算します。 |
|
| pageSize | integer | 通常リストの 1 ページあたりの件数。デフォルトは 10。カレンダーモードでは無視されます。 null 許可: False $maxValue: 100 $minValue: 1 例: 10取得または入力方法: 読み取り要件に応じて 1 から 100 の範囲で入力します。 |
|
| scDateRange | string | カレンダーモードでは実際に必須です。YYYY/MM/DD~YYYY/MM/DD 形式で、最大 50 日付です。自動的に当日がデフォルトになることはありません。カレンダー日付として両端を含むことを想定していますが、現在、夏時間(DST)の切り替えをまたぐ場合は終了日が欠落する可能性があるため、単日ごとに分割して照会し、結果をマージすることを推奨します。 空文字列の許可: False null 許可: False 最大長: 48 例: 2026/11/18~2026/11/19取得または入力方法: 選択したタイムゾーンのカレンダー日付で入力し、開始日と終了日の両方を含むことを想定します。夏時間(DST)の切り替えをまたぐ場合は、単日ごとに照会して網羅性を確保してください。 |
|
| scTimezone | string | カレンダーモードでのみ使用します。デフォルトは Asia/Shanghai です。 null 許可: False 最大長: 48 例: Asia/Shanghai取得または入力方法: カレンダー日付の表示に使用する IANA タイムゾーンを入力します。 |
|
| scheduleCalendar | string | 文字列 true/false。デフォルトは false。カレンダーモードでは scDateRange も同時に指定する必要があり、ページングは行われません。 null 許可: True 選択可能な値: ['true', 'false'] 例: false取得または入力方法: 通常リストでは false、カレンダー表示では true を指定します。 |
|
| search | string | 名前によるあいまい検索。省略または空文字列の場合は絞り込みません。 null 許可: True 例: 生产取得または入力方法: スケジュール名のキーワードを入力します。 |
パラメータ補足説明¶
mySchedule=true は現在の API 呼び出し元識別情報を対象とします。人単位で検索する場合は、メンバーのアカウント UUID を notifyTargets に指定してください。カレンダーは日付単位で計算されるため、現在の HH:MM 時点でオンコール中かどうかの判断には使用できません。
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/notification_schedule/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode pageIndex=1 \
--data-urlencode pageSize=10
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content | object | 通常のページング結果またはカレンダー結果のオブジェクト。scheduleCalendar に応じて構造が選択されます。 |
| content.data | array<object> |
通常モードの現在ページのスケジュール。空のリストは [] です。 |
| content.data[].id | integer | データベースのレコード番号。スケジュールの操作には uuid を使用します。 |
| content.data[].uuid | string | スケジュール UUID。照会、変更、削除、および通知ポリシーからの参照に使用します。 |
| content.data[].workspaceUUID | string | 所属ワークスペースの UUID。 |
| content.data[].name | string | スケジュール名。 |
| content.data[].timezone | string | このスケジュールが当日の時間帯と有効日を解釈するために使用する IANA タイムゾーン。 |
| content.data[].start | string | 当日の開始時刻 HH:MM。 |
| content.data[].end | string | 当日の終了時刻 HH:MM。終了分の最後の秒まで有効です。 |
| content.data[].notifyTargets | array<string> |
順序どおりに保存されたメンバー、通知先 UUID、またはメールアドレス。 |
| content.data[].notifyTargets[] | string | acnt_ アカウント、notify_ 通知先、またはメールアドレスの文字列。 |
| content.data[].extend | object | 拡張設定。未設定の場合は {} になることがあります。 |
| content.data[].extend.enableRotateNotification | boolean | ローテーションを有効にするか。省略時は false として扱います。 |
| content.data[].extend.rotationCycle | string | ローテーション有効時の周期。day は日単位、week は週単位(月曜始まり)、month は暦月単位、workDay は平日のみを日単位で、weekend は週末のみを日単位で扱います。祝日は認識しません。未設定の場合は省略できます。 |
| content.data[].extend.effectiveTime | object | 全体の有効期間。未設定の場合は省略できます。 |
| content.data[].extend.effectiveTime.start | integer | 有効期間の開始 Unix 秒。0 または省略時は制限なし。 |
| content.data[].extend.effectiveTime.end | integer | 有効期間の終了 Unix 秒。0 または省略時は制限なし。 |
| content.data[].rotationUpdateAt | integer | ローテーション計算の開始時間(Unix 秒)。ローテーション関連設定を変更するとリセットされます。 |
| content.data[].status | integer | レコード状態。有効なレコードは 0 です。 |
| content.data[].creator | string | 作成した呼び出し元識別情報。 |
| content.data[].updator | string | 最終更新した識別情報。未更新の場合は空文字列。 |
| content.data[].createAt | integer | 作成日時(Unix 秒)。 |
| content.data[].updateAt | integer | 更新日時(Unix 秒)。未更新の場合は -1。 |
| content.data[].deleteAt | integer | 削除日時(Unix 秒)。未削除の場合は -1。 |
| content.data[].effectiveTimeInfos | object | 全体の有効期間の表示情報。一覧、作成、変更時のみ返されます。 |
| content.data[].effectiveTimeInfos.timeStr | string | スケジュールのタイムゾーンで YYYY/MM/DD HH:MM:SS~YYYY/MM/DD HH:MM:SS 形式にフォーマットされます。片側のみ未設定の場合は空、両側とも未設定の場合は全体が空文字列になります。 |
| content.data[].effectiveTimeInfos.expired | boolean | 現在時刻が有効期間の終了を超えているか。終了制限がない場合は false。 |
| content.data[].notifyTargetsInfos | array<object> |
解決済みの通知先情報。無効または存在しなくなった通知先は返されない場合があります。フィールドはアカウント、通知先、メールアドレスの 3 種類に応じて変化します。 |
| content.data[].notifyTargetsInfos[].uuid | string | アカウント/通知先 UUID。メールアドレス通知先の場合はメールアドレス自体を UUID として使用します。 |
| content.data[].notifyTargetsInfos[].name | string | 通知先の表示名。メールアドレス通知先の場合はメールアドレスです。 |
| content.data[].notifyTargetsInfos[].status | integer | アカウントまたは通知先のレコード状態。メールアドレス通知先にはこのフィールドは含まれません。 |
| content.data[].notifyTargetsInfos[].type | string | 通知先のみ提供される通知先タイプ。 |
| content.data[].notifyTargetsInfos[].wsAccountStatus | integer | アカウントのみ提供される、ワークスペース内でのアカウント状態。 |
| content.data[].notifyTargetsInfos[].username | string | アカウントのみ提供されるログインユーザー名。 |
| content.data[].notifyTargetsInfos[].iconUrl | string | アカウントのみ提供されるアバター URL。 |
| content.data[].notifyTargetsInfos[].email | string | アカウントのメールアドレスまたはメールアドレス通知先。通知先では提供されない場合があります。 |
| content.data[].notifyTargetsInfos[].mobile | string | アカウントのみ提供される携帯電話番号。空の場合があります。 |
| content.data[].notifyTargetsInfos[].countryCode | string | アカウントのみ提供される携帯電話番号の国/地域コード。 |
| content.data[].notifyTargetsInfos[].acntWsNickname | string | アカウントのみ提供されるワークスペース内のニックネーム。 |
| content.data[].issueNotificationPolicyInfos | array<object> |
関連する通知ポリシー、およびそのポリシーを参照するチャンネル。関連がない場合は空です。 |
| content.data[].issueNotificationPolicyInfos[].id | integer | ポリシーのレコード番号。 |
| content.data[].issueNotificationPolicyInfos[].uuid | string | 通知ポリシー UUID。 |
| content.data[].issueNotificationPolicyInfos[].workspaceUUID | string | ポリシーが所属するワークスペース。 |
| content.data[].issueNotificationPolicyInfos[].name | string | ポリシー名。 |
| content.data[].issueNotificationPolicyInfos[].extend | object | 通知範囲とエスカレーション設定。設定の完全な意味は通知ポリシー一覧を参照してください。 |
| content.data[].issueNotificationPolicyInfos[].extend.notifyTypes | array<string> |
通知をトリガーするイベントタイプの一覧。省略可能です。 |
| content.data[].issueNotificationPolicyInfos[].extend.notifyTypes[] | string | issue.add、issue.modify、issueReply.add、dailySummary など。 |
| content.data[].issueNotificationPolicyInfos[].extend.upgradeCfg | object | エスカレーションのトリガータイプ別に保存される設定。省略可能です。 |
| content.data[].issueNotificationPolicyInfos[].extend.upgradeCfg.动态键 | object | noManager、processTimeout、openProcessTimeout、eventStorm など、設定済みのエスカレーショントリガータイプ。 |
| content.data[].issueNotificationPolicyInfos[].extend.upgradeCfg.动态键.duration | integer | 待機または判定時間(秒)。実際のトリガータイプに応じて提供されます。 |
| content.data[].issueNotificationPolicyInfos[].extend.upgradeCfg.动态键.其他字段 | number、boolean、string、array または object | トリガータイプごとに異なる追加ルール。通知ポリシーの詳細およびそのパラメータ表を参照してください。 |
| content.data[].issueNotificationPolicyInfos[].status | integer | 有効状態は 0 です。 |
| content.data[].issueNotificationPolicyInfos[].creator | string | 作成した識別情報。 |
| content.data[].issueNotificationPolicyInfos[].updator | string | 更新した識別情報。 |
| content.data[].issueNotificationPolicyInfos[].createAt | integer | 作成日時(Unix 秒)。 |
| content.data[].issueNotificationPolicyInfos[].updateAt | integer | 更新日時(Unix 秒)。未更新の場合は -1。 |
| content.data[].issueNotificationPolicyInfos[].deleteAt | integer | 削除日時(Unix 秒)。未削除の場合は -1。 |
| content.data[].issueNotificationPolicyInfos[].channelInfos | array<object> |
この通知ポリシーを参照するチャンネルエンティティの一覧。 |
| content.data[].issueNotificationPolicyInfos[].channelInfos[].id | integer | データベースのレコード番号。チャンネルの操作には uuid を使用してください。 |
| content.data[].issueNotificationPolicyInfos[].channelInfos[].uuid | string | チャンネル UUID。変更、削除、または購読に使用します。 |
| content.data[].issueNotificationPolicyInfos[].channelInfos[].workspaceUUID | string | チャンネルが所属するワークスペース。 |
| content.data[].issueNotificationPolicyInfos[].channelInfos[].name | string | チャンネル名。default はデフォルトチャンネルを表します。 |
| content.data[].issueNotificationPolicyInfos[].channelInfos[].description | string | チャンネルの説明。 |
| content.data[].issueNotificationPolicyInfos[].channelInfos[].notifyTarget | array<string> |
このチャンネルに直接設定された通知先 UUID。 |
| content.data[].issueNotificationPolicyInfos[].channelInfos[].notifyTarget[] | string | 個々の通知先 UUID。 |
| content.data[].issueNotificationPolicyInfos[].channelInfos[].notifyUpgradeCfg | object | エスカレーション通知設定。未設定の場合は空オブジェクト。 |
| content.data[].issueNotificationPolicyInfos[].channelInfos[].notifyUpgradeCfg.triggerTime | integer | エスカレーション通知をトリガーするまでの待機時間(秒)。 |
| content.data[].issueNotificationPolicyInfos[].channelInfos[].notifyUpgradeCfg.notifyTarget | array<string> |
エスカレーション通知先 UUID の一覧。 |
| content.data[].issueNotificationPolicyInfos[].channelInfos[].notifyUpgradeCfg.notifyTarget[] | string | エスカレーション通知先 UUID。 |
| content.data[].issueNotificationPolicyInfos[].channelInfos[].status | integer | レコード状態。正常な場合は 0。 |
| content.data[].issueNotificationPolicyInfos[].channelInfos[].creator | string | 作成した呼び出し元識別情報。 |
| content.data[].issueNotificationPolicyInfos[].channelInfos[].updator | string | 最終更新した識別情報。未更新の場合は空文字列になることがあります。 |
| content.data[].issueNotificationPolicyInfos[].channelInfos[].createAt | integer | 作成日時(Unix 秒)。 |
| content.data[].issueNotificationPolicyInfos[].channelInfos[].updateAt | integer | 更新日時(Unix 秒)。未更新の場合は -1。 |
| content.data[].issueNotificationPolicyInfos[].channelInfos[].deleteAt | integer | 削除日時(Unix 秒)。未削除の場合は -1。 |
| content.data[].inEffectNotifyTargetsInfos | array<object> |
現在時刻、スケジュールのタイムゾーン、有効期間、ローテーションに基づいて計算された実際の有効通知先。有効でない場合は [] です。 |
| content.data[].inEffectNotifyTargetsInfos[].uuid | string | アカウント/通知先 UUID。メールアドレス通知先の場合はメールアドレス自体を UUID として使用します。 |
| content.data[].inEffectNotifyTargetsInfos[].name | string | 通知先の表示名。メールアドレス通知先の場合はメールアドレスです。 |
| content.data[].inEffectNotifyTargetsInfos[].status | integer | アカウントまたは通知先のレコード状態。メールアドレス通知先にはこのフィールドは含まれません。 |
| content.data[].inEffectNotifyTargetsInfos[].type | string | 通知先のみ提供される通知先タイプ。 |
| content.data[].inEffectNotifyTargetsInfos[].wsAccountStatus | integer | アカウントのみ提供される、ワークスペース内でのアカウント状態。 |
| content.data[].inEffectNotifyTargetsInfos[].username | string | アカウントのみ提供されるログインユーザー名。 |
| content.data[].inEffectNotifyTargetsInfos[].iconUrl | string | アカウントのみ提供されるアバター URL。 |
| content.data[].inEffectNotifyTargetsInfos[].email | string | アカウントのメールアドレスまたはメールアドレス通知先。通知先では提供されない場合があります。 |
| content.data[].inEffectNotifyTargetsInfos[].mobile | string | アカウントのみ提供される携帯電話番号。空の場合があります。 |
| content.data[].inEffectNotifyTargetsInfos[].countryCode | string | アカウントのみ提供される携帯電話番号の国/地域コード。 |
| content.data[].inEffectNotifyTargetsInfos[].acntWsNickname | string | アカウントのみ提供されるワークスペース内のニックネーム。 |
| content.myScheduleCount | integer | このワークスペースにおける現在の呼び出し元識別情報のスケジュール総数。今回の検索やその他の絞り込みの影響を受けません。 |
| content.totalScheduleCount | integer | このワークスペースの有効なスケジュール総数。今回の検索やその他の絞り込みの影響を受けません。 |
| content.declaration | object または null | ワークスペースの共通宣言。 |
| pageInfo | object | 通常モードでのみ返されるトップレベルのページング情報。 |
| pageInfo.pageIndex | integer | 現在のページ番号。 |
| pageInfo.pageSize | integer | 1 ページあたりの件数。 |
| pageInfo.count | integer | 現在ページで実際に返された件数。 |
| pageInfo.totalCount | integer | 今回の絞り込みに一致した総数。 |
| content.scheduleCalendarInfos | object | カレンダーモードでのみ返されます。キーは scTimezone における YYYY/MM/DD 形式の日付です。日付は省略されるか、空配列になる場合があります。 |
| content.scheduleCalendarInfos.日期 | array<object> |
そのカレンダー日付の通知先情報。日単位で集計されたものであり、現在時刻のリアルタイムなオンコール担当者を表すものではありません。 |
| content.scheduleCalendarInfos.日期[].uuid | string | アカウント/通知先 UUID。メールアドレス通知先の場合はメールアドレス自体を UUID として使用します。 |
| content.scheduleCalendarInfos.日期[].name | string | 通知先の表示名。メールアドレス通知先の場合はメールアドレスです。 |
| content.scheduleCalendarInfos.日期[].status | integer | アカウントまたは通知先のレコード状態。メールアドレス通知先にはこのフィールドは含まれません。 |
| content.scheduleCalendarInfos.日期[].type | string | 通知先のみ提供される通知先タイプ。 |
| content.scheduleCalendarInfos.日期[].wsAccountStatus | integer | アカウントのみ提供される、ワークスペース内でのアカウント状態。 |
| content.scheduleCalendarInfos.日期[].username | string | アカウントのみ提供されるログインユーザー名。 |
| content.scheduleCalendarInfos.日期[].iconUrl | string | アカウントのみ提供されるアバター URL。 |
| content.scheduleCalendarInfos.日期[].email | string | アカウントのメールアドレスまたはメールアドレス通知先。通知先では提供されない場合があります。 |
| content.scheduleCalendarInfos.日期[].mobile | string | アカウントのみ提供される携帯電話番号。空の場合があります。 |
| content.scheduleCalendarInfos.日期[].countryCode | string | アカウントのみ提供される携帯電話番号の国/地域コード。 |
| content.scheduleCalendarInfos.日期[].acntWsNickname | string | アカウントのみ提供されるワークスペース内のニックネーム。 |
| content.scheduleCalendarUpdateInfos | object | カレンダーモードでのみ返されます。スケジュールの設定更新が発生した日付を示します。 |
| content.scheduleCalendarUpdateInfos.日期 | array<object> |
その日付に更新されたスケジュールの現在のエンティティスナップショット。完全な履歴バージョンではありません。 |
| content.scheduleCalendarUpdateInfos.日期[].id | integer または null | データベース番号。作成時にはまだ割り当てられていない場合があります。リソースの操作には uuid を使用します。 |
| content.scheduleCalendarUpdateInfos.日期[].uuid | string | スケジュール UUID。照会、変更、削除、および通知ポリシーからの参照に使用します。 |
| content.scheduleCalendarUpdateInfos.日期[].workspaceUUID | string | 所属ワークスペースの UUID。 |
| content.scheduleCalendarUpdateInfos.日期[].name | string | スケジュール名。 |
| content.scheduleCalendarUpdateInfos.日期[].timezone | string | このスケジュールが当日の時間帯と有効日を解釈するために使用する IANA タイムゾーン。 |
| content.scheduleCalendarUpdateInfos.日期[].start | string | 当日の開始時刻 HH:MM。 |
| content.scheduleCalendarUpdateInfos.日期[].end | string | 当日の終了時刻 HH:MM。終了分の最後の秒まで有効です。 |
| content.scheduleCalendarUpdateInfos.日期[].notifyTargets | array<string> |
順序どおりに保存されたメンバー、通知先 UUID、またはメールアドレス。 |
| content.scheduleCalendarUpdateInfos.日期[].notifyTargets[] | string | acnt_ アカウント、notify_ 通知先、またはメールアドレスの文字列。 |
| content.scheduleCalendarUpdateInfos.日期[].extend | object | 拡張設定。未設定の場合は {} になることがあります。 |
| content.scheduleCalendarUpdateInfos.日期[].extend.enableRotateNotification | boolean | ローテーションを有効にするか。省略時は false として扱います。 |
| content.scheduleCalendarUpdateInfos.日期[].extend.rotationCycle | string | ローテーション有効時の周期。day は日単位、week は週単位(月曜始まり)、month は暦月単位、workDay は平日のみを日単位で、weekend は週末のみを日単位で扱います。祝日は認識しません。未設定の場合は省略できます。 |
| content.scheduleCalendarUpdateInfos.日期[].extend.effectiveTime | object | 全体の有効期間。未設定の場合は省略できます。 |
| content.scheduleCalendarUpdateInfos.日期[].extend.effectiveTime.start | integer | 有効期間の開始 Unix 秒。0 または省略時は制限なし。 |
| content.scheduleCalendarUpdateInfos.日期[].extend.effectiveTime.end | integer | 有効期間の終了 Unix 秒。0 または省略時は制限なし。 |
| content.scheduleCalendarUpdateInfos.日期[].rotationUpdateAt | integer | ローテーション計算の開始時間(Unix 秒)。ローテーション関連設定を変更するとリセットされます。 |
| content.scheduleCalendarUpdateInfos.日期[].status | integer | レコード状態。有効なレコードは 0 です。 |
| content.scheduleCalendarUpdateInfos.日期[].creator | string | 作成した呼び出し元識別情報。 |
| content.scheduleCalendarUpdateInfos.日期[].updator | string | 最終更新した識別情報。未更新の場合は空文字列。 |
| content.scheduleCalendarUpdateInfos.日期[].createAt | integer | 作成日時(Unix 秒)。 |
| content.scheduleCalendarUpdateInfos.日期[].updateAt | integer | 更新日時(Unix 秒)。未更新の場合は -1。 |
| content.scheduleCalendarUpdateInfos.日期[].deleteAt | integer | 削除日時(Unix 秒)。未削除の場合は -1。 |
| content.totalCount | integer | カレンダーモードのみ: 一致したスケジュール数。日付数や通知先数ではありません。 |
{
"code": 200,
"content": {
"data": [
{
"id": 42,
"uuid": "nsche_example",
"workspaceUUID": "wksp_example",
"name": "生产值班",
"timezone": "Asia/Shanghai",
"start": "09:00",
"end": "18:00",
"notifyTargets": [
"notify_example"
],
"extend": {
"enableRotateNotification": false
},
"rotationUpdateAt": 1785427200,
"status": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785427200,
"updateAt": -1,
"deleteAt": -1,
"notifyTargetsInfos": [
{
"uuid": "notify_example",
"name": "生产值班群",
"status": 0,
"type": "dingtalk"
}
],
"issueNotificationPolicyInfos": [],
"inEffectNotifyTargetsInfos": [],
"effectiveTimeInfos": {
"timeStr": "",
"expired": false
}
}
],
"myScheduleCount": 0,
"totalScheduleCount": 1,
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE",
"pageInfo": {
"pageIndex": 1,
"pageSize": 10,
"count": 1,
"totalCount": 1
}
}
カレンダーモードの呼び出し
curl --get '<Endpoint>/api/v1/notification_schedule/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode scheduleCalendar=true \
--data-urlencode scTimezone=Asia/Shanghai \
--data-urlencode 'scDateRange=2026/11/18~2026/11/19'
カレンダーモードのレスポンス
{
"code": 200,
"content": {
"scheduleCalendarInfos": {
"2026/11/18": [
{
"uuid": "notify_example",
"name": "生产值班群",
"status": 0,
"type": "dingtalk"
}
]
},
"scheduleCalendarUpdateInfos": {},
"totalCount": 1,
"myScheduleCount": 0,
"totalScheduleCount": 1,
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、および共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 宣言されていない Query パラメータを使用した、またはパラメータがルールに違反している | パラメータの解析に失敗しました | Query パラメータ表と例を確認してください。 |
| 400 | ft.InvalidDateRange | カレンダーモードで scDateRange が未指定、形式が一致しない、または日付が逆転している | 無効な日付範囲 | 有効な日付範囲を明示的に指定し、両端を含めます。 |
| 400 | ft.ExceedMaximumQueryDateRange | カレンダー範囲に 50 を超える日付が含まれている | 照会日付範囲が大きすぎます。50 日間の範囲照会のみサポートしています | 最大 50 日ごとのリクエストに分割します。 |
| 500 | ft.InternalServerError | 不明な IANA タイムゾーン、実在しない日付、文字列以外の通知先、解析不能な時刻などによる内部失敗 | 内部エラー | 呼び出し前にパラメータ表に従ってタイムゾーン、実在する日付、HH:MM、文字列配列を検証してください。書き込み操作が失敗した場合は、まず詳細を照会して保存済みかどうかを確認してから再試行を判断し、traceId を保持してください。 |