Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 | /**
* This file was auto-generated by openapi-typescript.
* Do not make direct changes to the file.
*/
export interface paths {
"/api/line/v2/bot/message/push": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* LINEにプッシュメッセージを送信
* @description LINEにプッシュメッセージを送信する。
* LINEのMessaging APIを利用しているため詳細はLINEのドキュメントを参照。
* - [Messaging API | チャンネルアクセストークンv2.1を発行する](https://developers.line.biz/ja/reference/messaging-api/#issue-channel-access-token-v2-1)
* - [Messaging API | プッシュメッセージを送る](https://developers.line.biz/ja/reference/messaging-api/#send-push-message)
*
*/
post: {
parameters: {
query?: never;
header: {
/** @description LINEチャンネルID。 */
"X-MessagingGateway-Line-Channel-Id": string;
};
path?: never;
cookie?: never;
};
/** @description 送信するメッセージ内容。
* Messaging API準拠。
* - [Messaging API | プッシュメッセージを送る | リクエストボディ](https://developers.line.biz/ja/reference/messaging-api/#send-push-message-request-body)
* */
requestBody: {
content: {
"application/json": {
/** @description 送信先のID。
* Webhookイベントオブジェクトで返される `userId` `groupId` `roomId` のいずれかの値。
* */
to: string;
/** @description 送信するメッセージ。
* 最大5件。
* */
messages: components["schemas"]["MessageObject"][];
/** @description メッセージ送信時のユーザー通知有無。デフォルトは`false`。
* */
notificationDisabled?: boolean;
/** @description 任意の集計単位のユニット名。
* */
customAggregationUnits?: string[];
};
};
};
responses: {
/** @description メッセージ送信成功。Messaging APIのレスポンスをそのまま返却します。
* - [Messaging API | プッシュメッセージを送る | レスポンス](https://developers.line.biz/ja/reference/messaging-api/#send-push-message-response)
* */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": {
/** @description 送信したメッセージの配列。 */
sentMessages?: components["schemas"]["SentMessageObject"][];
};
};
};
/** @description メッセージ送信に失敗。
* - LINEチャンネルIDが存在しない。
* - LINE Messaging API が 400 を返した。
* */
400: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ErrorObject"];
};
};
/** @description リクエスト数が上限を超過した。
* */
429: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ErrorObject"];
};
};
/** @description 内部エラー */
500: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ErrorObject"];
};
};
};
};
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/line/webhook/{channelId}/messages/{messageId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/**
* Webhookメッセージを削除
* @description Webhookメッセージを削除する。
*/
delete: {
parameters: {
query?: never;
header?: never;
path: {
/** @description チャンネルID */
channelId: string;
/** @description メッセージID */
messageId: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description 削除成功 */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": Record<string, never>;
};
};
/** @description 指定されたWebhookメッセージが見つからない */
404: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ErrorObject"];
};
};
/** @description 内部エラー */
500: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ErrorObject"];
};
};
};
};
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/line/webhook/{channelId}/messages/new": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* 新たに処理すべきWebhookメッセージを取得
* @description Webhookメッセージのうち指定コンシューマで新たに処理すべきものを取得する。
* 取得対象メッセージは以下のもので、最大件数になるまで上から順に取得する。
* - 他コンシューマに配信済みメッセージのうちアイドル時間が最大アイドル時間を超えたもの
* - 未配信メッセージ
*
* |配信済み？|コンシューマ|アイドル時間|配信回数|取得対象？|備考|
* |---|---|---|---|---|---|
* |未|-|-|-|◯|処理するため取得する。配信数は1となる。|
* |済|指定|-|-|✕|自身で処理中のため取得しない。|
* |済|他|最大以下|-|✕|他コンシューマに任せるため取得しない。|
* |済|他|最大超過|最大以下|◯|リトライするため取得する。配信数は+1。|
* |済|他|最大超過|最大超過|✕|リトライしても回復の見込みが無いためエラー扱い。|
*
*/
get: {
parameters: {
query: {
/** @description コンシューマ名。 */
consumer: string;
/** @description 取得件数の上限。省略時は上限なし扱い。 */
max_count?: number;
/** @description アイドル時間（ms）の上限。省略時は1分扱い。 */
max_idle_time_ms?: number;
/** @description 配信回数の上限。省略時は3回扱い。 */
max_delivery_count?: number;
};
header?: never;
path: {
/** @description チャンネルID */
channelId: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description 取得成功 */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": {
/** @description Webhookメッセージのリスト。 */
messages?: components["schemas"]["WebhookMessageObject"][];
};
};
};
/** @description 必須パラメータの不足 */
400: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ErrorObject"];
};
};
/** @description 内部エラー */
500: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ErrorObject"];
};
};
};
};
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/line/webhook/{channelId}/events": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Webhookメッセージを追加（LINE Webhookの受け口）
* @description LINEのWebhookからのPOSTリクエストを受信し、未読のWebhookメッセージとして保持する。
* POSTリクエストの仕様詳細はLINEのドキュメントを参照。
* - [Messaging API | Webhook](https://developers.line.biz/ja/reference/messaging-api/#webhooks)
*
*/
post: {
parameters: {
query?: never;
header: {
/** @description 署名の検証に使う署名
* - [Messaging API | 署名を検証する](https://developers.line.biz/ja/reference/messaging-api/#signature-validation)
* */
"x-line-signature": string;
};
path: {
/** @description チャンネルID */
channelId: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": {
/** @description Webhookイベントを受信すべきボットのユーザーID。 */
destination: string;
/** @description Webhookイベントオブジェクトの配列。 */
events: components["schemas"]["WebhookEventObject"][];
};
};
};
responses: {
/** @description POSTリクエストの受信成功。
* */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": Record<string, never>;
};
};
/** @description 必須パラメータの不足
* */
400: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ErrorObject"];
};
};
/** @description 内部エラー
* */
500: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ErrorObject"];
};
};
};
};
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
}
export type webhooks = Record<string, never>;
export interface components {
schemas: {
/** @description メッセージ情報。LINE Messaging API に準拠。
* - [Messaging API | メッセージオブジェクト](https://developers.line.biz/ja/reference/messaging-api/#message-objects)
* */
MessageObject: unknown;
/** @description 送信したメッセージ情報。 */
SentMessageObject: {
/** @description 送信したメッセージのID。 */
id: string;
/** @description メッセージの引用トークン。 */
quoteToken?: string;
};
/** @description LINEのWebhookイベントオブジェクト。
* - [Messaging API | Webhookイベントオブジェクト](https://developers.line.biz/ja/reference/messaging-api/#webhook-event-objects)
* */
WebhookEventObject: unknown;
/** @description LINEのWebhookで受信したメッセージ。 */
WebhookMessageObject: {
/** @description メッセージID。 */
messageId?: string;
/** @description アイドル時間（ms）。配信されてからの経過時間のこと。 */
idleTimeMs?: number;
/** @description 配信回数。 */
deliveryCount?: number;
/** @description WebhookのPOSTリクエスト受信時にmessaging-gatewayで発行したリクエストID。 */
requestId: string;
/** @description WebhookのPOSTリクエストで受信した署名。 */
signature: string;
/** @description Webhookイベントを受信すべきボットのユーザーID。 */
destination: string;
/** @description 受信したWebhookイベントオブジェクトの配列。 */
events: components["schemas"]["WebhookEventObject"][];
};
/** @description エラー情報。 */
ErrorObject: {
message: string;
};
};
responses: never;
parameters: never;
requestBodies: never;
headers: never;
pathItems: never;
}
export type $defs = Record<string, never>;
export type operations = Record<string, never>;
|