-
Notifications
You must be signed in to change notification settings - Fork 31
/
Copy pathwebhook.yml
1044 lines (999 loc) · 35.3 KB
/
webhook.yml
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
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
---
openapi: 3.0.3
info:
title: Webhook Type Definition
description: "Webhook event definition of the LINE Messaging API"
version: 1.0.0
servers:
# DUMMY
- url: "https://example.com"
tags:
- name: dummy
# openapi-generator doesn't support OpenAPI 3's webhook.
# https://github.com/OpenAPITools/openapi-generator/issues/6689
# https://github.com/OpenAPITools/openapi-generator/issues/9083
paths:
"/callback":
post:
operationId: callback
tags:
- dummy
description: "This is the dummy endpoint to generate the model classes"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/CallbackRequest"
responses:
"200":
description: "OK"
content:
application/json:
schema:
description: "dummy response"
type: string
example: OK
components:
schemas:
CallbackRequest:
externalDocs:
url: https://developers.line.biz/en/reference/messaging-api/#request-body
description: |+
The request body contains a JSON object with the user ID of a bot that should receive webhook events and an array of webhook event objects.
type: object
required:
- destination
- events
properties:
destination:
type: string
description: |+
User ID of a bot that should receive webhook events.
The user ID value is a string that matches the regular expression, `U[0-9a-f]{32}`.
pattern: "^U[0-9a-f]{32}$"
maxLength: 33
minLength: 33
events:
description: |+
Array of webhook event objects.
The LINE Platform may send an empty array that doesn't include a webhook event object to confirm communication.
type: array
items:
$ref: "#/components/schemas/Event"
Event:
description: "Webhook event"
required:
- type
- timestamp
- mode
- webhookEventId
- deliveryContext
type: object
properties:
type:
type: string
description: "Type of the event"
source:
$ref: "#/components/schemas/Source"
timestamp:
type: integer
format: int64
description: "Time of the event in milliseconds."
mode:
$ref: "#/components/schemas/EventMode"
webhookEventId:
type: string
description: "Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format."
deliveryContext:
$ref: "#/components/schemas/DeliveryContext"
discriminator:
propertyName: type
mapping:
message: "#/components/schemas/MessageEvent"
unsend: "#/components/schemas/UnsendEvent"
follow: "#/components/schemas/FollowEvent"
unfollow: "#/components/schemas/UnfollowEvent"
join: "#/components/schemas/JoinEvent"
leave: "#/components/schemas/LeaveEvent"
memberJoined: "#/components/schemas/MemberJoinedEvent"
memberLeft: "#/components/schemas/MemberLeftEvent"
postback: "#/components/schemas/PostbackEvent"
videoPlayComplete: "#/components/schemas/VideoPlayCompleteEvent"
beacon: "#/components/schemas/BeaconEvent"
accountLink: "#/components/schemas/AccountLinkEvent"
things: "#/components/schemas/ThingsEvent"
membership: "#/components/schemas/MembershipEvent"
module: "#/components/schemas/ModuleEvent"
activated: "#/components/schemas/ActivatedEvent"
deactivated: "#/components/schemas/DeactivatedEvent"
botSuspended: "#/components/schemas/BotSuspendedEvent"
botResumed: "#/components/schemas/BotResumedEvent"
delivery: "#/components/schemas/PnpDeliveryCompletionEvent"
EventMode:
type: string
description: "Channel state."
enum: [active, standby]
DeliveryContext:
type: object
description: "webhook's delivery context information"
required:
- isRedelivery
properties:
isRedelivery:
type: boolean
description: "Whether the webhook event is a redelivered one or not."
Source:
externalDocs:
url: https://developers.line.biz/en/reference/messaging-api/#source-user
description: "the source of the event."
type: object
properties:
type:
type: string
description: "source type"
discriminator:
propertyName: type
mapping:
user: "#/components/schemas/UserSource"
group: "#/components/schemas/GroupSource"
room: "#/components/schemas/RoomSource"
UserSource:
allOf:
- $ref: "#/components/schemas/Source"
- type: object
required:
- type
properties:
userId:
type: string
description: "ID of the source user"
GroupSource:
allOf:
- $ref: "#/components/schemas/Source"
- type: object
required:
- type
- groupId
properties:
groupId:
type: string
description: "Group ID of the source group chat"
userId:
type: string
description: "ID of the source user. Only included in message events. Only users of LINE for iOS and LINE for Android are included in userId."
RoomSource:
allOf:
- $ref: "#/components/schemas/Source"
- type: object
required:
- type
- roomId
description: "Source multi-person chat"
properties:
userId:
type: string
description: "ID of the source user. Only included in message events. Only users of LINE for iOS and LINE for Android are included in userId."
roomId:
type: string
description: "Room ID of the source multi-person chat"
# https://developers.line.biz/en/reference/messaging-api/#message-event
MessageEvent:
description: "Webhook event object which contains the sent message."
type: object
allOf:
- $ref: "#/components/schemas/Event"
- type: object
required:
- type
- message
properties:
replyToken:
type: string
message:
$ref: "#/components/schemas/MessageContent"
MessageContent:
externalDocs:
url: https://developers.line.biz/en/reference/messaging-api/#message-event
type: object
required:
- type
- id
properties:
type:
type: string
description: "Type"
id:
type: string
description: "Message ID"
discriminator:
propertyName: type
mapping:
text: "#/components/schemas/TextMessageContent"
image: "#/components/schemas/ImageMessageContent"
video: "#/components/schemas/VideoMessageContent"
audio: "#/components/schemas/AudioMessageContent"
file: "#/components/schemas/FileMessageContent"
location: "#/components/schemas/LocationMessageContent"
sticker: "#/components/schemas/StickerMessageContent"
ContentProvider:
description: "Provider of the media file."
required:
- type
type: object
properties:
type:
type: string
description: "Provider of the image file."
enum:
- line
- external
originalContentUrl:
type: string
format: uri
description: "URL of the image file. Only included when contentProvider.type is external."
previewImageUrl:
format: uri
type: string
description: "URL of the preview image. Only included when contentProvider.type is external."
TextMessageContent:
allOf:
- $ref: "#/components/schemas/MessageContent"
- type: object
required:
- text
- quoteToken
properties:
text:
type: string
description: "Message text."
emojis:
description: "Array of one or more LINE emoji objects. Only included in the message event when the text property contains a LINE emoji."
type: array
items:
$ref: "#/components/schemas/Emoji"
mention:
$ref: "#/components/schemas/Mention"
quoteToken:
type: string
description: |+
Quote token to quote this message.
quotedMessageId:
type: string
description: "Message ID of a quoted message. Only included when the received message quotes a past message."
Emoji:
required:
- index
- length
- productId
- emojiId
type: object
properties:
index:
type: integer
description: "Index position for a character in text, with the first character being at position 0."
length:
type: integer
description: "The length of the LINE emoji string. For LINE emoji (hello), 7 is the length."
productId:
type: string
description: "Product ID for a LINE emoji set."
emojiId:
type: string
description: "ID for a LINE emoji inside a set."
Mention:
required:
- mentionees
type: object
properties:
mentionees:
description: "Array of one or more mention objects. Max: 20 mentions"
type: array
items:
$ref: "#/components/schemas/Mentionee"
Mentionee:
externalDocs:
url: https://developers.line.biz/en/reference/messaging-api/#wh-text
required:
- type
- index
- length
type: object
properties:
type:
type: string
description: "Mentioned target."
index:
type: integer
format: int32
description: "Index position of the user mention for a character in text, with the first character being at position 0."
length:
type: integer
format: int32
description: "The length of the text of the mentioned user. For a mention @example, 8 is the length."
discriminator:
propertyName: type
mapping:
user: "#/components/schemas/UserMentionee"
all: "#/components/schemas/AllMentionee"
UserMentionee:
description: "Mentioned target is user"
allOf:
- $ref: "#/components/schemas/Mentionee"
- type: object
properties:
userId:
type: string
description: "User ID of the mentioned user. Only included if mention.mentions[].type is user and the user consents to the LINE Official Account obtaining their user profile information."
isSelf:
type: boolean
description: "Whether the mentioned user is the bot that receives the webhook."
AllMentionee:
description: "Mentioned target is entire group"
allOf:
- $ref: "#/components/schemas/Mentionee"
- type: object
ImageMessageContent:
allOf:
- $ref: "#/components/schemas/MessageContent"
- type: object
required:
- contentProvider
- quoteToken
properties:
contentProvider:
$ref: "#/components/schemas/ContentProvider"
imageSet:
$ref: "#/components/schemas/ImageSet"
quoteToken:
type: string
description: |+
Quote token to quote this message.
ImageSet:
type: object
required:
- id
properties:
id:
type: string
description: "Image set ID. Only included when multiple images are sent simultaneously."
index:
type: integer
description: "An index starting from 1, indicating the image number in a set of images sent simultaneously. Only included when multiple images are sent simultaneously. However, it won't be included if the sender is using LINE 11.15 or earlier for Android."
total:
type: integer
description: "The total number of images sent simultaneously."
VideoMessageContent:
allOf:
- $ref: "#/components/schemas/MessageContent"
- type: object
required:
- contentProvider
- quoteToken
description: "Message object which contains the video content sent from the source. The preview image is displayed in the chat and the video is played when the image is tapped."
properties:
duration:
type: integer
format: int64
description: "Length of video file (milliseconds)"
contentProvider:
$ref: "#/components/schemas/ContentProvider"
quoteToken:
type: string
description: |+
Quote token to quote this message.
AudioMessageContent:
allOf:
- $ref: "#/components/schemas/MessageContent"
- type: object
required:
- contentProvider
description: "Message object which contains the audio content sent from the source."
properties:
contentProvider:
$ref: "#/components/schemas/ContentProvider"
duration:
type: integer
format: int64
description: "Length of audio file (milliseconds)"
FileMessageContent:
allOf:
- $ref: "#/components/schemas/MessageContent"
- type: object
required:
- fileName
- fileSize
description: "Message object which contains the file sent from the source."
properties:
fileName:
type: string
description: "File name"
fileSize:
type: integer
description: "File size in bytes"
LocationMessageContent:
allOf:
- $ref: "#/components/schemas/MessageContent"
- type: object
required:
- latitude
- longitude
description: "Message object which contains the location data sent from the source."
properties:
title:
type: string
description: "Title"
address:
type: string
description: "Address"
latitude:
type: number
format: double
description: "Latitude"
longitude:
type: number
format: double
description: "Longitude"
StickerMessageContent:
externalDocs:
url: https://developers.line.biz/en/reference/messaging-api/#wh-sticker
allOf:
- $ref: "#/components/schemas/MessageContent"
- type: object
required:
- packageId
- stickerId
- stickerResourceType
- quoteToken
description: "Message object which contains the sticker data sent from the source."
properties:
packageId:
type: string
description: "Package ID"
stickerId:
type: string
description: "Sticker ID"
stickerResourceType:
type: string
enum:
- STATIC
- ANIMATION
- SOUND
- ANIMATION_SOUND
- POPUP
- POPUP_SOUND
- CUSTOM
- MESSAGE
- NAME_TEXT
- PER_STICKER_TEXT
keywords:
# This field is experimental.
type: array
maxItems: 15
items:
type: string
description: |+
Array of up to 15 keywords describing the sticker.
If a sticker has 16 or more keywords, a random selection of 15 keywords will be returned.
The keyword selection is random for each event, so different keywords may be returned for the same sticker.
text:
type: string
description: |+
Any text entered by the user. This property is only included for message stickers.
Max character limit: 100
maxLength: 100
quoteToken:
type: string
description: |+
Quote token to quote this message.
quotedMessageId:
type: string
description: |+
Message ID of a quoted message. Only included when the received message quotes a past message.
# https://developers.line.biz/en/reference/messaging-api/#unsend-event
UnsendEvent:
description: "Event object for when the user unsends a message."
allOf:
- $ref: "#/components/schemas/Event"
- type: object
required:
- unsend
properties:
unsend:
"$ref": "#/components/schemas/UnsendDetail"
UnsendDetail:
required:
- messageId
type: object
properties:
messageId:
type: string
description: "The message ID of the unsent message"
# https://developers.line.biz/en/reference/messaging-api/#follow-event
FollowEvent:
description: "Event object for when your LINE Official Account is added as a friend (or unblocked). You can reply to follow events."
allOf:
- $ref: "#/components/schemas/Event"
- type: object
required:
- replyToken
- follow
properties:
replyToken:
type: string
description: "Reply token used to send reply message to this event"
follow:
"$ref": "#/components/schemas/FollowDetail"
FollowDetail:
type: object
required:
- isUnblocked
properties:
isUnblocked:
type: boolean
description: "Whether a user has added your LINE Official Account as a friend or unblocked."
# https://developers.line.biz/en/reference/messaging-api/#unfollow-event
UnfollowEvent:
description: "Event object for when your LINE Official Account is blocked."
allOf:
- $ref: "#/components/schemas/Event"
- type: object
# https://developers.line.biz/en/reference/messaging-api/#join-event
JoinEvent:
description: "Event object for when your LINE Official Account joins a group chat or multi-person chat. You can reply to join events."
allOf:
- $ref: "#/components/schemas/Event"
- type: object
required:
- replyToken
properties:
replyToken:
type: string
description: "Reply token used to send reply message to this event"
# https://developers.line.biz/en/reference/messaging-api/#leave-event
LeaveEvent:
description: "Event object for when a user removes your LINE Official Account from a group chat or when your LINE Official Account leaves a group chat or multi-person chat."
allOf:
- $ref: "#/components/schemas/Event"
- type: object
# https://developers.line.biz/en/reference/messaging-api/#member-joined-event
MemberJoinedEvent:
description: "Event object for when a user joins a group chat or multi-person chat that the LINE Official Account is in."
allOf:
- $ref: "#/components/schemas/Event"
- type: object
required:
- replyToken
- joined
properties:
replyToken:
type: string
description: "Reply token used to send reply message to this event"
joined:
$ref: "#/components/schemas/JoinedMembers"
JoinedMembers:
required:
- members
type: object
properties:
members:
description: "Users who joined. Array of source user objects."
type: array
items:
$ref: "#/components/schemas/UserSource"
# https://developers.line.biz/en/reference/messaging-api/#member-left-event
MemberLeftEvent:
description: "Event object for when a user leaves a group chat or multi-person chat that the LINE Official Account is in."
allOf:
- $ref: "#/components/schemas/Event"
- type: object
required:
- left
properties:
left:
$ref: "#/components/schemas/LeftMembers"
LeftMembers:
required:
- members
type: object
properties:
members:
description: "Users who left. Array of source user objects."
type: array
items:
$ref: "#/components/schemas/UserSource"
# https://developers.line.biz/en/reference/messaging-api/#postback-event
PostbackEvent:
description: "Event object for when a user performs a postback action which initiates a postback. You can reply to postback events."
allOf:
- $ref: "#/components/schemas/Event"
- type: object
required:
- postback
properties:
replyToken:
type: string
description: "Reply token used to send reply message to this event"
postback:
$ref: "#/components/schemas/PostbackContent"
PostbackContent:
type: object
required:
- data
properties:
data:
type: string
description: "Postback data"
params:
type: object
additionalProperties:
type: string
# https://developers.line.biz/en/reference/messaging-api/#video-viewing-complete
VideoPlayCompleteEvent:
description: "Event for when a user finishes viewing a video at least once with the specified trackingId sent by the LINE Official Account."
allOf:
- $ref: "#/components/schemas/Event"
- type: object
required:
- replyToken
- videoPlayComplete
properties:
replyToken:
type: string
description: "Reply token used to send reply message to this event"
videoPlayComplete:
$ref: "#/components/schemas/VideoPlayComplete"
VideoPlayComplete:
required:
- trackingId
type: object
properties:
trackingId:
type: string
description: "ID used to identify a video. Returns the same value as the trackingId assigned to the video message."
# https://developers.line.biz/en/reference/messaging-api/#beacon-event
BeaconEvent:
description: "Event object for when a user enters the range of a LINE Beacon. You can reply to beacon events."
allOf:
- $ref: "#/components/schemas/Event"
- type: object
required:
- replyToken
- beacon
properties:
replyToken:
type: string
description: "Reply token used to send reply message to this event"
beacon:
$ref: "#/components/schemas/BeaconContent"
BeaconContent:
required:
- hwid
- type
type: object
properties:
hwid:
type: string
description: "Hardware ID of the beacon that was detected"
type:
type: string
description: "Type of beacon event."
enum: [enter, banner, stay]
dm:
type: string
description: "Device message of beacon that was detected."
# https://developers.line.biz/en/reference/messaging-api/#account-link-event
AccountLinkEvent:
description: "Event object for when a user has linked their LINE account with a provider's service account. You can reply to account link events."
allOf:
- $ref: "#/components/schemas/Event"
- type: object
required:
- link
properties:
replyToken:
type: string
description: "Reply token used to send reply message to this event. This property won't be included if linking the account has failed."
link:
$ref: "#/components/schemas/LinkContent"
LinkContent:
description: "Content of the account link event."
required:
- result
- nonce
type: object
properties:
result:
type: string
enum: [ok, failed]
description: "One of the following values to indicate whether linking the account was successful or not"
nonce:
type: string
description: "Specified nonce (number used once) when verifying the user ID."
# https://developers.line.biz/en/reference/messaging-api/#scenario-result-event
ThingsEvent:
description: "Indicates that a user linked a device with LINE."
allOf:
- $ref: "#/components/schemas/Event"
- type: object
required:
- replyToken
- things
properties:
replyToken:
type: string
description: "Reply token used to send reply message to this event"
things:
$ref: "#/components/schemas/ThingsContent"
ThingsContent:
type: object
required:
- type
properties:
type:
type: string
description: "Type"
discriminator:
propertyName: type
mapping:
link: "#/components/schemas/LinkThingsContent"
unlink: "#/components/schemas/UnlinkThingsContent"
scenarioResult: "#/components/schemas/ScenarioResultThingsContent"
LinkThingsContent:
allOf:
- $ref: "#/components/schemas/ThingsContent"
- type: object
required:
- deviceId
description: "Indicates that a user linked a device with LINE."
properties:
deviceId:
type: string
description: "Device ID of the device that has been linked with LINE."
UnlinkThingsContent:
allOf:
- $ref: "#/components/schemas/ThingsContent"
- type: object
required:
- deviceId
description: "Indicates that the user unlinked a device from LINE."
properties:
deviceId:
type: string
description: "Device ID of the device that has been linked with LINE."
ScenarioResultThingsContent:
allOf:
- $ref: "#/components/schemas/ThingsContent"
- type: object
required:
- deviceId
- result
description: "This event indicates that an automatic communication scenario has been executed."
properties:
deviceId:
type: string
description: "Device ID of the device that has been linked with LINE."
result:
$ref: "#/components/schemas/ScenarioResult"
ScenarioResult:
externalDocs:
url: https://developers.line.biz/en/reference/messaging-api/#scenario-result-event
required:
- startTime
- endTime
- resultCode
type: object
properties:
scenarioId:
type: string
description: "Scenario ID executed"
revision:
type: integer
description: "Revision number of the scenario set containing the executed scenario"
startTime:
type: integer
format: int64
description: "Timestamp for when execution of scenario action started (milliseconds, LINE app time)"
endTime:
type: integer
format: int64
description: "Timestamp for when execution of scenario was completed (milliseconds, LINE app time)"
resultCode:
type: string
description: "Scenario execution completion status"
actionResults:
description: "Execution result of individual operations specified in action. Only included when things.result.resultCode is success."
type: array
items:
$ref: "#/components/schemas/ActionResult"
bleNotificationPayload:
description: "Data contained in notification."
type: string
errorReason:
description: "Error reason."
type: string
ActionResult:
required:
- type
type: object
properties:
type:
type: string
enum: [ void, binary ]
data:
description: "Base64-encoded binary data"
type: string
# https://developers.line.biz/en/reference/messaging-api/#membership-event
MembershipEvent:
description: "This event indicates that a user has subscribed (joined), unsubscribed (left), or renewed the bot's membership."
allOf:
- $ref: "#/components/schemas/Event"
- type: object
required:
- replyToken
- membership
properties:
replyToken:
type: string
description: "Reply token used to send reply message to this event"
membership:
$ref: "#/components/schemas/MembershipContent"
MembershipContent:
description: "Content of the membership event."
required:
- type
- membershipId
type: object
properties:
type:
type: string
description: "Type of membership event."
discriminator:
propertyName: type
mapping:
joined: "#/components/schemas/JoinedMembershipContent"
left: "#/components/schemas/LeftMembershipContent"
renewed: "#/components/schemas/RenewedMembershipContent"
JoinedMembershipContent:
allOf:
- $ref: "#/components/schemas/MembershipContent"
- type: object
required:
- membershipId
properties:
membershipId:
type: integer
description: "The ID of the membership that the user joined. This is defined for each membership."
LeftMembershipContent:
allOf:
- $ref: "#/components/schemas/MembershipContent"
- type: object
required:
- membershipId
properties:
membershipId:
type: integer
description: "The ID of the membership that the user left. This is defined for each membership."
RenewedMembershipContent:
allOf:
- $ref: "#/components/schemas/MembershipContent"
- type: object
required:
- membershipId
properties:
membershipId:
type: integer
description: "The ID of the membership that the user renewed. This is defined for each membership."
# https://developers.line.biz/en/reference/partner-docs/#module-webhook-event-object
ModuleEvent:
description: "This event indicates that the module channel has been attached to the LINE Official Account. Sent to the webhook URL server of the module channel."
allOf:
- $ref: "#/components/schemas/Event"
- type: object
required:
- module
properties:
module:
$ref: "#/components/schemas/ModuleContent"
ModuleContent:
type: object
required:
- type
properties:
type:
type: string
description: "Type"
discriminator:
propertyName: type
mapping:
attached: "#/components/schemas/AttachedModuleContent"
detached: "#/components/schemas/DetachedModuleContent"
AttachedModuleContent:
allOf:
- $ref: "#/components/schemas/ModuleContent"
- type: object
required:
- botId
- scopes
properties:
botId:
description: "User ID of the bot on the attached LINE Official Account"
type: string
scopes:
description: "An array of strings indicating the scope permitted by the admin of the LINE Official Account."
type: array
items:
type: string
DetachedModuleContent:
allOf:
- $ref: "#/components/schemas/ModuleContent"
- type: object
required:
- botId
- reason
properties:
botId:
description: "Detached LINE Official Account bot user ID"
type: string
reason:
description: "Reason for detaching"
type: string
enum:
- bot_deleted
# https://developers.line.biz/en/reference/partner-docs/#activated-event
ActivatedEvent:
description: "This event indicates that the module channel has been switched to Active Channel by calling the Acquire Control API. Sent to the webhook URL server of the module channel."
allOf:
- $ref: "#/components/schemas/Event"
- type: object
required:
- chatControl
properties:
chatControl:
$ref: "#/components/schemas/ChatControl"
ChatControl:
required:
- expireAt
type: object
properties:
expireAt:
type: integer