@wildix/stream-client 4.2.3 → 4.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/StreamService.js +10 -0
- package/dist-cjs/commands/CreateScheduledMessageCommand.js +20 -0
- package/dist-cjs/commands/DeleteScheduledMessageCommand.js +20 -0
- package/dist-cjs/commands/ListScheduledMessagesCommand.js +20 -0
- package/dist-cjs/commands/SendScheduledMessageNowCommand.js +20 -0
- package/dist-cjs/commands/UpdateScheduledMessageCommand.js +20 -0
- package/dist-cjs/commands/index.js +5 -0
- package/dist-cjs/models/enums.js +29 -1
- package/dist-cjs/models/errors.js +29 -1
- package/dist-cjs/schemas/schemas_0.js +174 -26
- package/dist-es/StreamService.js +10 -0
- package/dist-es/commands/CreateScheduledMessageCommand.js +16 -0
- package/dist-es/commands/DeleteScheduledMessageCommand.js +16 -0
- package/dist-es/commands/ListScheduledMessagesCommand.js +16 -0
- package/dist-es/commands/SendScheduledMessageNowCommand.js +16 -0
- package/dist-es/commands/UpdateScheduledMessageCommand.js +16 -0
- package/dist-es/commands/index.js +5 -0
- package/dist-es/models/enums.js +28 -0
- package/dist-es/models/errors.js +26 -0
- package/dist-es/schemas/schemas_0.js +169 -21
- package/dist-types/StreamService.d.ts +36 -0
- package/dist-types/StreamServiceClient.d.ts +7 -2
- package/dist-types/commands/CreateGroupChannelCommand.d.ts +2 -0
- package/dist-types/commands/CreateKiteChannelCommand.d.ts +45 -0
- package/dist-types/commands/CreateScheduledMessageCommand.d.ts +147 -0
- package/dist-types/commands/DeleteMessageReactionCommand.d.ts +22 -0
- package/dist-types/commands/DeleteScheduledMessageCommand.d.ts +89 -0
- package/dist-types/commands/GetChannelCommand.d.ts +1 -0
- package/dist-types/commands/GetInboxCommand.d.ts +1 -0
- package/dist-types/commands/GetMessageCommand.d.ts +22 -0
- package/dist-types/commands/GetOrCreateDirectChannelCommand.d.ts +1 -0
- package/dist-types/commands/GetOrCreateSmsChannelCommand.d.ts +1 -0
- package/dist-types/commands/GetOrCreateTelephonyChannelCommand.d.ts +1 -0
- package/dist-types/commands/GetOrCreateWhatsAppChannelCommand.d.ts +1 -0
- package/dist-types/commands/JoinChannelCommand.d.ts +1 -0
- package/dist-types/commands/ListChannelsCommand.d.ts +1 -0
- package/dist-types/commands/ListMentionsCommand.d.ts +22 -0
- package/dist-types/commands/ListMessagesCommand.d.ts +22 -0
- package/dist-types/commands/ListScheduledMessagesCommand.d.ts +124 -0
- package/dist-types/commands/PartialUpdateChannelCommand.d.ts +2 -0
- package/dist-types/commands/PartialUpdateMessageCommand.d.ts +44 -0
- package/dist-types/commands/PinMessageCommand.d.ts +22 -0
- package/dist-types/commands/QueryChannelsCommand.d.ts +1 -0
- package/dist-types/commands/SearchChannelsCommand.d.ts +1 -0
- package/dist-types/commands/SearchMessagesCommand.d.ts +22 -0
- package/dist-types/commands/SearchUsersCommand.d.ts +1 -1
- package/dist-types/commands/SendGiphyCommand.d.ts +22 -0
- package/dist-types/commands/SendMessageCommand.d.ts +44 -0
- package/dist-types/commands/SendMessageReactionCommand.d.ts +22 -0
- package/dist-types/commands/SendScheduledMessageNowCommand.d.ts +124 -0
- package/dist-types/commands/SendSystemMessageCommand.d.ts +22 -0
- package/dist-types/commands/UnpinMessageCommand.d.ts +22 -0
- package/dist-types/commands/UpdateChannelCommand.d.ts +2 -0
- package/dist-types/commands/UpdateMessageCommand.d.ts +44 -0
- package/dist-types/commands/UpdateScheduledMessageCommand.d.ts +146 -0
- package/dist-types/commands/index.d.ts +5 -0
- package/dist-types/models/enums.d.ts +77 -0
- package/dist-types/models/errors.d.ts +27 -0
- package/dist-types/models/models_0.d.ts +500 -95
- package/dist-types/runtimeConfig.browser.d.ts +3 -3
- package/dist-types/runtimeConfig.d.ts +3 -3
- package/dist-types/runtimeConfig.native.d.ts +2 -2
- package/dist-types/runtimeConfig.shared.d.ts +1 -1
- package/dist-types/schemas/schemas_0.d.ts +21 -0
- package/package.json +1 -1
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { AssignChannelVariant, AttachmentType, ButtonVariant, ChannelAccess, ChannelContextEventAttendeeStatus, ChannelContextSource, ChannelMemberRole, ChannelMessagingStatus, ChannelsFilter, ChannelType, ChannelWhatsAppStatus, DownloadStrategy, FileCategory, GroupChannelCreationEventType, GroupChannelUnsetOptions, MentionsFilter, MessageAnchor, MessageMessagingStatus, MessageSmsStatus, MessageType, MessageUnsetFields, MessageWhatsAppStatus, MessagingChannel, SearchSort, SearchUsersMode, SectionType, UserMatchedOn } from "./enums";
|
|
1
|
+
import type { AssignChannelVariant, AttachmentType, ButtonVariant, ChannelAccess, ChannelContextEventAttendeeStatus, ChannelContextSource, ChannelMemberRole, ChannelMessagingStatus, ChannelsFilter, ChannelType, ChannelWhatsAppStatus, ChatVerbosity, DownloadStrategy, FileCategory, GroupChannelCreationEventType, GroupChannelUnsetOptions, MentionsFilter, MessageAnchor, MessageMessagingStatus, MessageSmsStatus, MessageType, MessageUnsetFields, MessageWhatsAppStatus, MessagingChannel, ScheduledMessageErrorCode, ScheduledMessageStatus, SearchSort, SearchUsersKind, SearchUsersMode, SectionType, UserMatchedOn, WilmaChatTurnOutcome } from "./enums";
|
|
2
2
|
/**
|
|
3
3
|
* @public
|
|
4
4
|
*/
|
|
@@ -575,6 +575,11 @@ export interface Channel {
|
|
|
575
575
|
* @public
|
|
576
576
|
*/
|
|
577
577
|
autoRecord?: boolean | undefined;
|
|
578
|
+
/**
|
|
579
|
+
* Indicates if a conference in the channel starts transcription automatically. When absent, clients follow autoRecord, which used to start both recording and transcription.
|
|
580
|
+
* @public
|
|
581
|
+
*/
|
|
582
|
+
autoTranscribe?: boolean | undefined;
|
|
578
583
|
/**
|
|
579
584
|
* Transcription language.
|
|
580
585
|
* @public
|
|
@@ -591,7 +596,7 @@ export interface Channel {
|
|
|
591
596
|
*/
|
|
592
597
|
messagingStatus?: ChannelMessagingStatus | undefined;
|
|
593
598
|
/**
|
|
594
|
-
* The business side of the conversation: the Facebook Page ID on Messenger, the Instagram account ID on Instagram.
|
|
599
|
+
* The business side of the conversation: the Facebook Page ID on Messenger, the Instagram account ID on Instagram, the brand id on RCS. A reply has to name the sender it is sent from. On Messenger and Instagram kite writes it from the inbound event, because the channel id hashes the sender's linked service and not the sender; on RCS the channel id includes the brand, and it is written when the channel is created.
|
|
595
600
|
* @public
|
|
596
601
|
*/
|
|
597
602
|
messagingSenderId?: string | undefined;
|
|
@@ -706,6 +711,11 @@ export interface CreateGroupChannelInput {
|
|
|
706
711
|
* @public
|
|
707
712
|
*/
|
|
708
713
|
autoRecord?: boolean | undefined;
|
|
714
|
+
/**
|
|
715
|
+
* Indicates if a conference in the channel starts transcription automatically. When absent, clients follow autoRecord, which used to start both recording and transcription.
|
|
716
|
+
* @public
|
|
717
|
+
*/
|
|
718
|
+
autoTranscribe?: boolean | undefined;
|
|
709
719
|
/**
|
|
710
720
|
* Transcription language.
|
|
711
721
|
* @public
|
|
@@ -722,7 +732,7 @@ export interface CreateGroupChannelInput {
|
|
|
722
732
|
*/
|
|
723
733
|
messagingStatus?: ChannelMessagingStatus | undefined;
|
|
724
734
|
/**
|
|
725
|
-
* The business side of the conversation: the Facebook Page ID on Messenger, the Instagram account ID on Instagram.
|
|
735
|
+
* The business side of the conversation: the Facebook Page ID on Messenger, the Instagram account ID on Instagram, the brand id on RCS. A reply has to name the sender it is sent from. On Messenger and Instagram kite writes it from the inbound event, because the channel id hashes the sender's linked service and not the sender; on RCS the channel id includes the brand, and it is written when the channel is created.
|
|
726
736
|
* @public
|
|
727
737
|
*/
|
|
728
738
|
messagingSenderId?: string | undefined;
|
|
@@ -816,9 +826,79 @@ export interface MessageTemplateConfig {
|
|
|
816
826
|
whatsapp?: TemplateWithParameters | undefined;
|
|
817
827
|
}
|
|
818
828
|
/**
|
|
829
|
+
* An artifact the turn shared. The files stay in the artifacts store; `artifactId` opens it.
|
|
819
830
|
* @public
|
|
820
831
|
*/
|
|
821
|
-
export
|
|
832
|
+
export interface WilmaChatArtifact {
|
|
833
|
+
artifactId: string;
|
|
834
|
+
title: string;
|
|
835
|
+
kind: string;
|
|
836
|
+
size: number;
|
|
837
|
+
name?: string | undefined;
|
|
838
|
+
}
|
|
839
|
+
/**
|
|
840
|
+
* How the turn went. The calls themselves (input, output) are not stored here: they are the turn's events in the session log.
|
|
841
|
+
* @public
|
|
842
|
+
*/
|
|
843
|
+
export interface WilmaChatTurnSummary {
|
|
844
|
+
/**
|
|
845
|
+
* How the turn ended.
|
|
846
|
+
* @public
|
|
847
|
+
*/
|
|
848
|
+
outcome: WilmaChatTurnOutcome;
|
|
849
|
+
/**
|
|
850
|
+
* From the turn's start to its end. Absent when the turn had not ended.
|
|
851
|
+
* @public
|
|
852
|
+
*/
|
|
853
|
+
durationMs?: number | undefined;
|
|
854
|
+
/**
|
|
855
|
+
* Tool calls the turn made.
|
|
856
|
+
* @public
|
|
857
|
+
*/
|
|
858
|
+
toolCount: number;
|
|
859
|
+
/**
|
|
860
|
+
* Calls that failed, including those the stop or failure cut off.
|
|
861
|
+
* @public
|
|
862
|
+
*/
|
|
863
|
+
failedCount: number;
|
|
864
|
+
}
|
|
865
|
+
/**
|
|
866
|
+
* On every agent reply of a Wilma chat on the stream transport: the session and turn that produced it, how the turn went and what it shared. `verbosity` is the agent's setting when the session started; clients decide from it what to show. The turn's events are `startIndex`..`endIndex` of the session log: read them with GetSessionEvents(sessionId, startIndex).
|
|
867
|
+
* @public
|
|
868
|
+
*/
|
|
869
|
+
export interface WilmaChatElement {
|
|
870
|
+
sessionId: string;
|
|
871
|
+
/**
|
|
872
|
+
* How much of a chat turn x-bees shows while the agent works. SMS and WhatsApp always send one final text.
|
|
873
|
+
* @public
|
|
874
|
+
*/
|
|
875
|
+
verbosity: ChatVerbosity;
|
|
876
|
+
/**
|
|
877
|
+
* The turn of the session that produced this message. A steer that joins a running turn shares it.
|
|
878
|
+
* @public
|
|
879
|
+
*/
|
|
880
|
+
turn: number;
|
|
881
|
+
/**
|
|
882
|
+
* Index of the turn's first event (`turnStarted`) in the session log.
|
|
883
|
+
* @public
|
|
884
|
+
*/
|
|
885
|
+
startIndex: number;
|
|
886
|
+
/**
|
|
887
|
+
* Index of the turn's last event (completed, failed or stopped). Absent when the message was written before the turn ended.
|
|
888
|
+
* @public
|
|
889
|
+
*/
|
|
890
|
+
endIndex?: number | undefined;
|
|
891
|
+
/**
|
|
892
|
+
* How the turn went. The calls themselves (input, output) are not stored here: they are the turn's events in the session log.
|
|
893
|
+
* @public
|
|
894
|
+
*/
|
|
895
|
+
summary: WilmaChatTurnSummary;
|
|
896
|
+
artifacts?: WilmaChatArtifact[] | undefined;
|
|
897
|
+
}
|
|
898
|
+
/**
|
|
899
|
+
* @public
|
|
900
|
+
*/
|
|
901
|
+
export type Element = Element.ActionsMember | Element.TemplateMember | Element.WilmaMember | Element.$UnknownMember;
|
|
822
902
|
/**
|
|
823
903
|
* @public
|
|
824
904
|
*/
|
|
@@ -826,11 +906,23 @@ export declare namespace Element {
|
|
|
826
906
|
interface TemplateMember {
|
|
827
907
|
template: MessageTemplateConfig;
|
|
828
908
|
actions?: never;
|
|
909
|
+
wilma?: never;
|
|
829
910
|
$unknown?: never;
|
|
830
911
|
}
|
|
831
912
|
interface ActionsMember {
|
|
832
913
|
template?: never;
|
|
833
914
|
actions: ActionElement[];
|
|
915
|
+
wilma?: never;
|
|
916
|
+
$unknown?: never;
|
|
917
|
+
}
|
|
918
|
+
/**
|
|
919
|
+
* On every agent reply of a Wilma chat on the stream transport: the session and turn that produced it, how the turn went and what it shared. `verbosity` is the agent's setting when the session started; clients decide from it what to show. The turn's events are `startIndex`..`endIndex` of the session log: read them with GetSessionEvents(sessionId, startIndex).
|
|
920
|
+
* @public
|
|
921
|
+
*/
|
|
922
|
+
interface WilmaMember {
|
|
923
|
+
template?: never;
|
|
924
|
+
actions?: never;
|
|
925
|
+
wilma: WilmaChatElement;
|
|
834
926
|
$unknown?: never;
|
|
835
927
|
}
|
|
836
928
|
/**
|
|
@@ -839,6 +931,7 @@ export declare namespace Element {
|
|
|
839
931
|
interface $UnknownMember {
|
|
840
932
|
template?: never;
|
|
841
933
|
actions?: never;
|
|
934
|
+
wilma?: never;
|
|
842
935
|
$unknown: [string, any];
|
|
843
936
|
}
|
|
844
937
|
/**
|
|
@@ -848,6 +941,7 @@ export declare namespace Element {
|
|
|
848
941
|
interface Visitor<T> {
|
|
849
942
|
template: (value: MessageTemplateConfig) => T;
|
|
850
943
|
actions: (value: ActionElement[]) => T;
|
|
944
|
+
wilma: (value: WilmaChatElement) => T;
|
|
851
945
|
_: (name: string, value: any) => T;
|
|
852
946
|
}
|
|
853
947
|
}
|
|
@@ -928,12 +1022,12 @@ export interface InitialMessage {
|
|
|
928
1022
|
sms?: boolean | undefined;
|
|
929
1023
|
smsStatus?: MessageSmsStatus | undefined;
|
|
930
1024
|
/**
|
|
931
|
-
* A customer messaging channel that reaches x-bees through classound and is not SMS or WhatsApp. One discriminator instead of a boolean per channel, so a new channel adds a member here and not a set of channel fields.
|
|
1025
|
+
* A customer messaging channel that reaches x-bees through classound and is not SMS or WhatsApp. One discriminator instead of a boolean per channel, so a new channel adds a member here and not a set of channel fields. An RCS conversation is not a telephony channel, and its customer id is the person's phone number.
|
|
932
1026
|
* @public
|
|
933
1027
|
*/
|
|
934
1028
|
messagingChannel?: MessagingChannel | undefined;
|
|
935
1029
|
/**
|
|
936
|
-
* The delivery state of a message an
|
|
1030
|
+
* The delivery state of a message an x-bees user sent over a customer messaging channel (see MessagingChannel), the same four states as WhatsApp. TRYING, SENT and ERROR are written by kite around the send; DELIVERED and a late ERROR arrive through the channel's status stream event (MESSENGER.STATUS, RCS.STATUS). A READ report is recorded as DELIVERED, as the WhatsApp producer does one hop earlier.
|
|
937
1031
|
* @public
|
|
938
1032
|
*/
|
|
939
1033
|
messagingStatus?: MessageMessagingStatus | undefined;
|
|
@@ -1001,12 +1095,12 @@ export interface WelcomeMessage {
|
|
|
1001
1095
|
sms?: boolean | undefined;
|
|
1002
1096
|
smsStatus?: MessageSmsStatus | undefined;
|
|
1003
1097
|
/**
|
|
1004
|
-
* A customer messaging channel that reaches x-bees through classound and is not SMS or WhatsApp. One discriminator instead of a boolean per channel, so a new channel adds a member here and not a set of channel fields.
|
|
1098
|
+
* A customer messaging channel that reaches x-bees through classound and is not SMS or WhatsApp. One discriminator instead of a boolean per channel, so a new channel adds a member here and not a set of channel fields. An RCS conversation is not a telephony channel, and its customer id is the person's phone number.
|
|
1005
1099
|
* @public
|
|
1006
1100
|
*/
|
|
1007
1101
|
messagingChannel?: MessagingChannel | undefined;
|
|
1008
1102
|
/**
|
|
1009
|
-
* The delivery state of a message an
|
|
1103
|
+
* The delivery state of a message an x-bees user sent over a customer messaging channel (see MessagingChannel), the same four states as WhatsApp. TRYING, SENT and ERROR are written by kite around the send; DELIVERED and a late ERROR arrive through the channel's status stream event (MESSENGER.STATUS, RCS.STATUS). A READ report is recorded as DELIVERED, as the WhatsApp producer does one hop earlier.
|
|
1010
1104
|
* @public
|
|
1011
1105
|
*/
|
|
1012
1106
|
messagingStatus?: MessageMessagingStatus | undefined;
|
|
@@ -1070,6 +1164,201 @@ export interface CreateKiteChannelOutput {
|
|
|
1070
1164
|
requestDuration?: number | undefined;
|
|
1071
1165
|
channel: Channel;
|
|
1072
1166
|
}
|
|
1167
|
+
/**
|
|
1168
|
+
* @public
|
|
1169
|
+
*/
|
|
1170
|
+
export interface CreateScheduledMessageInput {
|
|
1171
|
+
/**
|
|
1172
|
+
* The unique identifier of the tenant when a service token is used.
|
|
1173
|
+
* @public
|
|
1174
|
+
*/
|
|
1175
|
+
companyId?: string | undefined;
|
|
1176
|
+
/**
|
|
1177
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
1178
|
+
* @public
|
|
1179
|
+
*/
|
|
1180
|
+
userId?: string | undefined;
|
|
1181
|
+
/**
|
|
1182
|
+
* Text body. Required unless `attachments` is non-empty.
|
|
1183
|
+
* @public
|
|
1184
|
+
*/
|
|
1185
|
+
text?: string | undefined;
|
|
1186
|
+
/**
|
|
1187
|
+
* When true, the message body is interpreted as Markdown.
|
|
1188
|
+
* @public
|
|
1189
|
+
*/
|
|
1190
|
+
markdown?: boolean | undefined;
|
|
1191
|
+
/**
|
|
1192
|
+
* Direct `@user` ids. `@all`, `@here`, and `@channel` are not supported.
|
|
1193
|
+
* @public
|
|
1194
|
+
*/
|
|
1195
|
+
mentions?: string[] | undefined;
|
|
1196
|
+
/**
|
|
1197
|
+
* Pre-uploaded file references. Required unless `text` is provided.
|
|
1198
|
+
* @public
|
|
1199
|
+
*/
|
|
1200
|
+
attachments?: MessageAttachmentRequest[] | undefined;
|
|
1201
|
+
/**
|
|
1202
|
+
* Reply context referencing a quoted message.
|
|
1203
|
+
* @public
|
|
1204
|
+
*/
|
|
1205
|
+
quote?: MessageQuoteRef | undefined;
|
|
1206
|
+
/**
|
|
1207
|
+
* Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
|
|
1208
|
+
* @public
|
|
1209
|
+
*/
|
|
1210
|
+
channelId: string;
|
|
1211
|
+
/**
|
|
1212
|
+
* Send time. Between 60 seconds and 30 days from now.
|
|
1213
|
+
* @public
|
|
1214
|
+
*/
|
|
1215
|
+
scheduledAt: string;
|
|
1216
|
+
}
|
|
1217
|
+
/**
|
|
1218
|
+
* File attached to a message as returned by listing and lookup endpoints.
|
|
1219
|
+
* @public
|
|
1220
|
+
*/
|
|
1221
|
+
export interface MessageAttachment {
|
|
1222
|
+
/**
|
|
1223
|
+
* Identifier of the stored file in the file service. Returned by the upload flow and referenced verbatim on the message row.
|
|
1224
|
+
* @public
|
|
1225
|
+
*/
|
|
1226
|
+
fsId: string;
|
|
1227
|
+
/**
|
|
1228
|
+
* MIME type.
|
|
1229
|
+
* @public
|
|
1230
|
+
*/
|
|
1231
|
+
mime?: string | undefined;
|
|
1232
|
+
/**
|
|
1233
|
+
* Original file name.
|
|
1234
|
+
* @public
|
|
1235
|
+
*/
|
|
1236
|
+
name: string;
|
|
1237
|
+
/**
|
|
1238
|
+
* File size in bytes.
|
|
1239
|
+
* @public
|
|
1240
|
+
*/
|
|
1241
|
+
size: number;
|
|
1242
|
+
/**
|
|
1243
|
+
* Image or video width in pixels.
|
|
1244
|
+
* @public
|
|
1245
|
+
*/
|
|
1246
|
+
width?: number | undefined;
|
|
1247
|
+
/**
|
|
1248
|
+
* Image or video height in pixels.
|
|
1249
|
+
* @public
|
|
1250
|
+
*/
|
|
1251
|
+
height?: number | undefined;
|
|
1252
|
+
/**
|
|
1253
|
+
* Thumbnail URL when available.
|
|
1254
|
+
* @public
|
|
1255
|
+
*/
|
|
1256
|
+
thumbnail?: string | undefined;
|
|
1257
|
+
/**
|
|
1258
|
+
* Attachment identifier within the message.
|
|
1259
|
+
* @public
|
|
1260
|
+
*/
|
|
1261
|
+
id: string;
|
|
1262
|
+
}
|
|
1263
|
+
/**
|
|
1264
|
+
* Reference to a quoted message.
|
|
1265
|
+
* @public
|
|
1266
|
+
*/
|
|
1267
|
+
export interface MessageQuote {
|
|
1268
|
+
/**
|
|
1269
|
+
* Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
|
|
1270
|
+
* @public
|
|
1271
|
+
*/
|
|
1272
|
+
channelId: string;
|
|
1273
|
+
messageId: string;
|
|
1274
|
+
/**
|
|
1275
|
+
* Author of the quoted message.
|
|
1276
|
+
* @public
|
|
1277
|
+
*/
|
|
1278
|
+
userId: string;
|
|
1279
|
+
/**
|
|
1280
|
+
* Text body captured at quote time.
|
|
1281
|
+
* @public
|
|
1282
|
+
*/
|
|
1283
|
+
text?: string | undefined;
|
|
1284
|
+
/**
|
|
1285
|
+
* ISO-8601 UTC timestamp with millisecond precision (e.g. `2026-05-07T05:35:00.000Z`).
|
|
1286
|
+
* @public
|
|
1287
|
+
*/
|
|
1288
|
+
createdAt: string;
|
|
1289
|
+
}
|
|
1290
|
+
/**
|
|
1291
|
+
* A message written by its author and sent later. Private to the author until sent.
|
|
1292
|
+
* @public
|
|
1293
|
+
*/
|
|
1294
|
+
export interface ScheduledMessage {
|
|
1295
|
+
id: string;
|
|
1296
|
+
/**
|
|
1297
|
+
* Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
|
|
1298
|
+
* @public
|
|
1299
|
+
*/
|
|
1300
|
+
channelId: string;
|
|
1301
|
+
/**
|
|
1302
|
+
* Id the message gets when sent. Fixed at creation.
|
|
1303
|
+
* @public
|
|
1304
|
+
*/
|
|
1305
|
+
messageId: string;
|
|
1306
|
+
text?: string | undefined;
|
|
1307
|
+
markdown?: boolean | undefined;
|
|
1308
|
+
mentions?: string[] | undefined;
|
|
1309
|
+
attachments?: MessageAttachment[] | undefined;
|
|
1310
|
+
/**
|
|
1311
|
+
* Reference to a quoted message.
|
|
1312
|
+
* @public
|
|
1313
|
+
*/
|
|
1314
|
+
quote?: MessageQuote | undefined;
|
|
1315
|
+
/**
|
|
1316
|
+
* Time at which the message is sent.
|
|
1317
|
+
* @public
|
|
1318
|
+
*/
|
|
1319
|
+
scheduledAt: string;
|
|
1320
|
+
status: ScheduledMessageStatus;
|
|
1321
|
+
/**
|
|
1322
|
+
* Reason of the failure. Present only when `status` is `failed`.
|
|
1323
|
+
* @public
|
|
1324
|
+
*/
|
|
1325
|
+
errorCode?: ScheduledMessageErrorCode | undefined;
|
|
1326
|
+
/**
|
|
1327
|
+
* ISO-8601 UTC timestamp with millisecond precision (e.g. `2026-05-07T05:35:00.000Z`).
|
|
1328
|
+
* @public
|
|
1329
|
+
*/
|
|
1330
|
+
createdAt: string;
|
|
1331
|
+
/**
|
|
1332
|
+
* ISO-8601 UTC timestamp with millisecond precision (e.g. `2026-05-07T05:35:00.000Z`).
|
|
1333
|
+
* @public
|
|
1334
|
+
*/
|
|
1335
|
+
updatedAt: string;
|
|
1336
|
+
/**
|
|
1337
|
+
* Increases on every change of the record.
|
|
1338
|
+
* @public
|
|
1339
|
+
*/
|
|
1340
|
+
version: number;
|
|
1341
|
+
}
|
|
1342
|
+
/**
|
|
1343
|
+
* @public
|
|
1344
|
+
*/
|
|
1345
|
+
export interface CreateScheduledMessageOutput {
|
|
1346
|
+
/**
|
|
1347
|
+
* The request ID of the request.
|
|
1348
|
+
* @public
|
|
1349
|
+
*/
|
|
1350
|
+
requestId?: string | undefined;
|
|
1351
|
+
/**
|
|
1352
|
+
* The duration of the request in milliseconds.
|
|
1353
|
+
* @public
|
|
1354
|
+
*/
|
|
1355
|
+
requestDuration?: number | undefined;
|
|
1356
|
+
/**
|
|
1357
|
+
* A message written by its author and sent later. Private to the author until sent.
|
|
1358
|
+
* @public
|
|
1359
|
+
*/
|
|
1360
|
+
scheduledMessage: ScheduledMessage;
|
|
1361
|
+
}
|
|
1073
1362
|
/**
|
|
1074
1363
|
* @public
|
|
1075
1364
|
*/
|
|
@@ -1276,52 +1565,6 @@ export interface DeleteMessageReactionInput {
|
|
|
1276
1565
|
*/
|
|
1277
1566
|
type: string;
|
|
1278
1567
|
}
|
|
1279
|
-
/**
|
|
1280
|
-
* File attached to a message as returned by listing and lookup endpoints.
|
|
1281
|
-
* @public
|
|
1282
|
-
*/
|
|
1283
|
-
export interface MessageAttachment {
|
|
1284
|
-
/**
|
|
1285
|
-
* Identifier of the stored file in the file service. Returned by the upload flow and referenced verbatim on the message row.
|
|
1286
|
-
* @public
|
|
1287
|
-
*/
|
|
1288
|
-
fsId: string;
|
|
1289
|
-
/**
|
|
1290
|
-
* MIME type.
|
|
1291
|
-
* @public
|
|
1292
|
-
*/
|
|
1293
|
-
mime?: string | undefined;
|
|
1294
|
-
/**
|
|
1295
|
-
* Original file name.
|
|
1296
|
-
* @public
|
|
1297
|
-
*/
|
|
1298
|
-
name: string;
|
|
1299
|
-
/**
|
|
1300
|
-
* File size in bytes.
|
|
1301
|
-
* @public
|
|
1302
|
-
*/
|
|
1303
|
-
size: number;
|
|
1304
|
-
/**
|
|
1305
|
-
* Image or video width in pixels.
|
|
1306
|
-
* @public
|
|
1307
|
-
*/
|
|
1308
|
-
width?: number | undefined;
|
|
1309
|
-
/**
|
|
1310
|
-
* Image or video height in pixels.
|
|
1311
|
-
* @public
|
|
1312
|
-
*/
|
|
1313
|
-
height?: number | undefined;
|
|
1314
|
-
/**
|
|
1315
|
-
* Thumbnail URL when available.
|
|
1316
|
-
* @public
|
|
1317
|
-
*/
|
|
1318
|
-
thumbnail?: string | undefined;
|
|
1319
|
-
/**
|
|
1320
|
-
* Attachment identifier within the message.
|
|
1321
|
-
* @public
|
|
1322
|
-
*/
|
|
1323
|
-
id: string;
|
|
1324
|
-
}
|
|
1325
1568
|
/**
|
|
1326
1569
|
* Reference to the original forwarded message.
|
|
1327
1570
|
* @public
|
|
@@ -1376,33 +1619,6 @@ export interface Reaction {
|
|
|
1376
1619
|
userId: string;
|
|
1377
1620
|
messageId: string;
|
|
1378
1621
|
}
|
|
1379
|
-
/**
|
|
1380
|
-
* Reference to a quoted message.
|
|
1381
|
-
* @public
|
|
1382
|
-
*/
|
|
1383
|
-
export interface MessageQuote {
|
|
1384
|
-
/**
|
|
1385
|
-
* Direct-channel ids are the 8-4-4-4-8 slices of the two member ids. An `a_` member id puts `_` in a slice, so the pattern allows it.
|
|
1386
|
-
* @public
|
|
1387
|
-
*/
|
|
1388
|
-
channelId: string;
|
|
1389
|
-
messageId: string;
|
|
1390
|
-
/**
|
|
1391
|
-
* Author of the quoted message.
|
|
1392
|
-
* @public
|
|
1393
|
-
*/
|
|
1394
|
-
userId: string;
|
|
1395
|
-
/**
|
|
1396
|
-
* Text body captured at quote time.
|
|
1397
|
-
* @public
|
|
1398
|
-
*/
|
|
1399
|
-
text?: string | undefined;
|
|
1400
|
-
/**
|
|
1401
|
-
* ISO-8601 UTC timestamp with millisecond precision (e.g. `2026-05-07T05:35:00.000Z`).
|
|
1402
|
-
* @public
|
|
1403
|
-
*/
|
|
1404
|
-
createdAt: string;
|
|
1405
|
-
}
|
|
1406
1622
|
/**
|
|
1407
1623
|
* Message row returned by listing and lookup endpoints. Deleted messages keep their position with `deletedAt` set and empty body.
|
|
1408
1624
|
* @public
|
|
@@ -1528,12 +1744,12 @@ export interface Message {
|
|
|
1528
1744
|
*/
|
|
1529
1745
|
pollId?: string | undefined;
|
|
1530
1746
|
/**
|
|
1531
|
-
* A customer messaging channel that reaches x-bees through classound and is not SMS or WhatsApp. One discriminator instead of a boolean per channel, so a new channel adds a member here and not a set of channel fields.
|
|
1747
|
+
* A customer messaging channel that reaches x-bees through classound and is not SMS or WhatsApp. One discriminator instead of a boolean per channel, so a new channel adds a member here and not a set of channel fields. An RCS conversation is not a telephony channel, and its customer id is the person's phone number.
|
|
1532
1748
|
* @public
|
|
1533
1749
|
*/
|
|
1534
1750
|
messagingChannel?: MessagingChannel | undefined;
|
|
1535
1751
|
/**
|
|
1536
|
-
* The delivery state of a message an
|
|
1752
|
+
* The delivery state of a message an x-bees user sent over a customer messaging channel (see MessagingChannel), the same four states as WhatsApp. TRYING, SENT and ERROR are written by kite around the send; DELIVERED and a late ERROR arrive through the channel's status stream event (MESSENGER.STATUS, RCS.STATUS). A READ report is recorded as DELIVERED, as the WhatsApp producer does one hop earlier.
|
|
1537
1753
|
* @public
|
|
1538
1754
|
*/
|
|
1539
1755
|
messagingStatus?: MessageMessagingStatus | undefined;
|
|
@@ -1558,6 +1774,37 @@ export interface DeleteMessageReactionOutput {
|
|
|
1558
1774
|
*/
|
|
1559
1775
|
requestDuration?: number | undefined;
|
|
1560
1776
|
}
|
|
1777
|
+
/**
|
|
1778
|
+
* @public
|
|
1779
|
+
*/
|
|
1780
|
+
export interface DeleteScheduledMessageInput {
|
|
1781
|
+
/**
|
|
1782
|
+
* The unique identifier of the tenant when a service token is used.
|
|
1783
|
+
* @public
|
|
1784
|
+
*/
|
|
1785
|
+
companyId?: string | undefined;
|
|
1786
|
+
/**
|
|
1787
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
1788
|
+
* @public
|
|
1789
|
+
*/
|
|
1790
|
+
userId?: string | undefined;
|
|
1791
|
+
scheduledMessageId: string;
|
|
1792
|
+
}
|
|
1793
|
+
/**
|
|
1794
|
+
* @public
|
|
1795
|
+
*/
|
|
1796
|
+
export interface DeleteScheduledMessageOutput {
|
|
1797
|
+
/**
|
|
1798
|
+
* The request ID of the request.
|
|
1799
|
+
* @public
|
|
1800
|
+
*/
|
|
1801
|
+
requestId?: string | undefined;
|
|
1802
|
+
/**
|
|
1803
|
+
* The duration of the request in milliseconds.
|
|
1804
|
+
* @public
|
|
1805
|
+
*/
|
|
1806
|
+
requestDuration?: number | undefined;
|
|
1807
|
+
}
|
|
1561
1808
|
/**
|
|
1562
1809
|
* @public
|
|
1563
1810
|
*/
|
|
@@ -1990,6 +2237,11 @@ export interface InboxChannel {
|
|
|
1990
2237
|
* @public
|
|
1991
2238
|
*/
|
|
1992
2239
|
autoRecord?: boolean | undefined;
|
|
2240
|
+
/**
|
|
2241
|
+
* Indicates if a conference in the channel starts transcription automatically. When absent, clients follow autoRecord, which used to start both recording and transcription.
|
|
2242
|
+
* @public
|
|
2243
|
+
*/
|
|
2244
|
+
autoTranscribe?: boolean | undefined;
|
|
1993
2245
|
/**
|
|
1994
2246
|
* Transcription language.
|
|
1995
2247
|
* @public
|
|
@@ -2006,7 +2258,7 @@ export interface InboxChannel {
|
|
|
2006
2258
|
*/
|
|
2007
2259
|
messagingStatus?: ChannelMessagingStatus | undefined;
|
|
2008
2260
|
/**
|
|
2009
|
-
* The business side of the conversation: the Facebook Page ID on Messenger, the Instagram account ID on Instagram.
|
|
2261
|
+
* The business side of the conversation: the Facebook Page ID on Messenger, the Instagram account ID on Instagram, the brand id on RCS. A reply has to name the sender it is sent from. On Messenger and Instagram kite writes it from the inbound event, because the channel id hashes the sender's linked service and not the sender; on RCS the channel id includes the brand, and it is written when the channel is created.
|
|
2010
2262
|
* @public
|
|
2011
2263
|
*/
|
|
2012
2264
|
messagingSenderId?: string | undefined;
|
|
@@ -2965,6 +3217,42 @@ export interface ListMessagesOutput {
|
|
|
2965
3217
|
*/
|
|
2966
3218
|
firstUnreadVisibleSeq?: number | undefined;
|
|
2967
3219
|
}
|
|
3220
|
+
/**
|
|
3221
|
+
* @public
|
|
3222
|
+
*/
|
|
3223
|
+
export interface ListScheduledMessagesInput {
|
|
3224
|
+
/**
|
|
3225
|
+
* The unique identifier of the tenant when a service token is used.
|
|
3226
|
+
* @public
|
|
3227
|
+
*/
|
|
3228
|
+
companyId?: string | undefined;
|
|
3229
|
+
/**
|
|
3230
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
3231
|
+
* @public
|
|
3232
|
+
*/
|
|
3233
|
+
userId?: string | undefined;
|
|
3234
|
+
/**
|
|
3235
|
+
* Return only messages scheduled for this channel.
|
|
3236
|
+
* @public
|
|
3237
|
+
*/
|
|
3238
|
+
channelId?: string | undefined;
|
|
3239
|
+
}
|
|
3240
|
+
/**
|
|
3241
|
+
* @public
|
|
3242
|
+
*/
|
|
3243
|
+
export interface ListScheduledMessagesOutput {
|
|
3244
|
+
/**
|
|
3245
|
+
* The request ID of the request.
|
|
3246
|
+
* @public
|
|
3247
|
+
*/
|
|
3248
|
+
requestId?: string | undefined;
|
|
3249
|
+
/**
|
|
3250
|
+
* The duration of the request in milliseconds.
|
|
3251
|
+
* @public
|
|
3252
|
+
*/
|
|
3253
|
+
requestDuration?: number | undefined;
|
|
3254
|
+
scheduledMessages: ScheduledMessage[];
|
|
3255
|
+
}
|
|
2968
3256
|
/**
|
|
2969
3257
|
* @public
|
|
2970
3258
|
*/
|
|
@@ -3238,6 +3526,11 @@ export interface PartialUpdateChannelSetOptions {
|
|
|
3238
3526
|
* @public
|
|
3239
3527
|
*/
|
|
3240
3528
|
autoRecord?: boolean | undefined;
|
|
3529
|
+
/**
|
|
3530
|
+
* Indicates if a conference in the channel starts transcription automatically. When absent, clients follow autoRecord, which used to start both recording and transcription.
|
|
3531
|
+
* @public
|
|
3532
|
+
*/
|
|
3533
|
+
autoTranscribe?: boolean | undefined;
|
|
3241
3534
|
/**
|
|
3242
3535
|
* Transcription language.
|
|
3243
3536
|
* @public
|
|
@@ -3254,7 +3547,7 @@ export interface PartialUpdateChannelSetOptions {
|
|
|
3254
3547
|
*/
|
|
3255
3548
|
messagingStatus?: ChannelMessagingStatus | undefined;
|
|
3256
3549
|
/**
|
|
3257
|
-
* The business side of the conversation: the Facebook Page ID on Messenger, the Instagram account ID on Instagram.
|
|
3550
|
+
* The business side of the conversation: the Facebook Page ID on Messenger, the Instagram account ID on Instagram, the brand id on RCS. A reply has to name the sender it is sent from. On Messenger and Instagram kite writes it from the inbound event, because the channel id hashes the sender's linked service and not the sender; on RCS the channel id includes the brand, and it is written when the channel is created.
|
|
3258
3551
|
* @public
|
|
3259
3552
|
*/
|
|
3260
3553
|
messagingSenderId?: string | undefined;
|
|
@@ -3355,12 +3648,12 @@ export interface PartialUpdateMessageSetInput {
|
|
|
3355
3648
|
sms?: boolean | undefined;
|
|
3356
3649
|
smsStatus?: MessageSmsStatus | undefined;
|
|
3357
3650
|
/**
|
|
3358
|
-
* A customer messaging channel that reaches x-bees through classound and is not SMS or WhatsApp. One discriminator instead of a boolean per channel, so a new channel adds a member here and not a set of channel fields.
|
|
3651
|
+
* A customer messaging channel that reaches x-bees through classound and is not SMS or WhatsApp. One discriminator instead of a boolean per channel, so a new channel adds a member here and not a set of channel fields. An RCS conversation is not a telephony channel, and its customer id is the person's phone number.
|
|
3359
3652
|
* @public
|
|
3360
3653
|
*/
|
|
3361
3654
|
messagingChannel?: MessagingChannel | undefined;
|
|
3362
3655
|
/**
|
|
3363
|
-
* The delivery state of a message an
|
|
3656
|
+
* The delivery state of a message an x-bees user sent over a customer messaging channel (see MessagingChannel), the same four states as WhatsApp. TRYING, SENT and ERROR are written by kite around the send; DELIVERED and a late ERROR arrive through the channel's status stream event (MESSENGER.STATUS, RCS.STATUS). A READ report is recorded as DELIVERED, as the WhatsApp producer does one hop earlier.
|
|
3364
3657
|
* @public
|
|
3365
3658
|
*/
|
|
3366
3659
|
messagingStatus?: MessageMessagingStatus | undefined;
|
|
@@ -3992,7 +4285,7 @@ export interface SearchUsersInput {
|
|
|
3992
4285
|
*/
|
|
3993
4286
|
q: string;
|
|
3994
4287
|
/**
|
|
3995
|
-
* How `q` is read. `auto` (default) takes `q` for an email address when it contains
|
|
4288
|
+
* How `q` is read. `auto` (default) takes `q` for an email address when it contains `@` (looked up exactly, so a malformed one matches nobody), for a phone number when it is a number with its country code (`+` and digits, grouped by spaces, `-`, `.`, `/` or brackets as written), and for a name otherwise. A number of seven or more digits without its country code is refused with a `ValidationException`: numbers are stored in E.164, so it would match nobody. `name`, `email` and `phone` force the reading and refuse input that cannot be it. An email or phone lookup is exact and gives every result a `confidence` of 1. `kind`, `withExtensionOnly` and `minConfidence` apply in every mode.
|
|
3996
4289
|
* @public
|
|
3997
4290
|
*/
|
|
3998
4291
|
mode?: SearchUsersMode | undefined;
|
|
@@ -4007,10 +4300,10 @@ export interface SearchUsersInput {
|
|
|
4007
4300
|
*/
|
|
4008
4301
|
cursor?: string | undefined;
|
|
4009
4302
|
/**
|
|
4010
|
-
*
|
|
4303
|
+
* Which users are searched: `human` (default) people only, `bot` bots only, `all` both.
|
|
4011
4304
|
* @public
|
|
4012
4305
|
*/
|
|
4013
|
-
|
|
4306
|
+
kind?: SearchUsersKind | undefined;
|
|
4014
4307
|
/**
|
|
4015
4308
|
* When true, returns only users that have an extension on a PBX, so a call can be transferred to them. Default false.
|
|
4016
4309
|
* @public
|
|
@@ -4175,12 +4468,12 @@ export interface SendMessageInput {
|
|
|
4175
4468
|
sms?: boolean | undefined;
|
|
4176
4469
|
smsStatus?: MessageSmsStatus | undefined;
|
|
4177
4470
|
/**
|
|
4178
|
-
* A customer messaging channel that reaches x-bees through classound and is not SMS or WhatsApp. One discriminator instead of a boolean per channel, so a new channel adds a member here and not a set of channel fields.
|
|
4471
|
+
* A customer messaging channel that reaches x-bees through classound and is not SMS or WhatsApp. One discriminator instead of a boolean per channel, so a new channel adds a member here and not a set of channel fields. An RCS conversation is not a telephony channel, and its customer id is the person's phone number.
|
|
4179
4472
|
* @public
|
|
4180
4473
|
*/
|
|
4181
4474
|
messagingChannel?: MessagingChannel | undefined;
|
|
4182
4475
|
/**
|
|
4183
|
-
* The delivery state of a message an
|
|
4476
|
+
* The delivery state of a message an x-bees user sent over a customer messaging channel (see MessagingChannel), the same four states as WhatsApp. TRYING, SENT and ERROR are written by kite around the send; DELIVERED and a late ERROR arrive through the channel's status stream event (MESSENGER.STATUS, RCS.STATUS). A READ report is recorded as DELIVERED, as the WhatsApp producer does one hop earlier.
|
|
4184
4477
|
* @public
|
|
4185
4478
|
*/
|
|
4186
4479
|
messagingStatus?: MessageMessagingStatus | undefined;
|
|
@@ -4271,6 +4564,42 @@ export interface SendMessageReactionOutput {
|
|
|
4271
4564
|
*/
|
|
4272
4565
|
requestDuration?: number | undefined;
|
|
4273
4566
|
}
|
|
4567
|
+
/**
|
|
4568
|
+
* @public
|
|
4569
|
+
*/
|
|
4570
|
+
export interface SendScheduledMessageNowInput {
|
|
4571
|
+
/**
|
|
4572
|
+
* The unique identifier of the tenant when a service token is used.
|
|
4573
|
+
* @public
|
|
4574
|
+
*/
|
|
4575
|
+
companyId?: string | undefined;
|
|
4576
|
+
/**
|
|
4577
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
4578
|
+
* @public
|
|
4579
|
+
*/
|
|
4580
|
+
userId?: string | undefined;
|
|
4581
|
+
scheduledMessageId: string;
|
|
4582
|
+
}
|
|
4583
|
+
/**
|
|
4584
|
+
* @public
|
|
4585
|
+
*/
|
|
4586
|
+
export interface SendScheduledMessageNowOutput {
|
|
4587
|
+
/**
|
|
4588
|
+
* The request ID of the request.
|
|
4589
|
+
* @public
|
|
4590
|
+
*/
|
|
4591
|
+
requestId?: string | undefined;
|
|
4592
|
+
/**
|
|
4593
|
+
* The duration of the request in milliseconds.
|
|
4594
|
+
* @public
|
|
4595
|
+
*/
|
|
4596
|
+
requestDuration?: number | undefined;
|
|
4597
|
+
/**
|
|
4598
|
+
* A message written by its author and sent later. Private to the author until sent.
|
|
4599
|
+
* @public
|
|
4600
|
+
*/
|
|
4601
|
+
scheduledMessage: ScheduledMessage;
|
|
4602
|
+
}
|
|
4274
4603
|
/**
|
|
4275
4604
|
* Empty payload for the WhatsApp 24-hour window closed system message.
|
|
4276
4605
|
* @public
|
|
@@ -4679,6 +5008,11 @@ export interface UpdateChannelInput {
|
|
|
4679
5008
|
* @public
|
|
4680
5009
|
*/
|
|
4681
5010
|
autoRecord?: boolean | undefined;
|
|
5011
|
+
/**
|
|
5012
|
+
* Indicates if a conference in the channel starts transcription automatically. When absent, clients follow autoRecord, which used to start both recording and transcription.
|
|
5013
|
+
* @public
|
|
5014
|
+
*/
|
|
5015
|
+
autoTranscribe?: boolean | undefined;
|
|
4682
5016
|
/**
|
|
4683
5017
|
* Transcription language.
|
|
4684
5018
|
* @public
|
|
@@ -4695,7 +5029,7 @@ export interface UpdateChannelInput {
|
|
|
4695
5029
|
*/
|
|
4696
5030
|
messagingStatus?: ChannelMessagingStatus | undefined;
|
|
4697
5031
|
/**
|
|
4698
|
-
* The business side of the conversation: the Facebook Page ID on Messenger, the Instagram account ID on Instagram.
|
|
5032
|
+
* The business side of the conversation: the Facebook Page ID on Messenger, the Instagram account ID on Instagram, the brand id on RCS. A reply has to name the sender it is sent from. On Messenger and Instagram kite writes it from the inbound event, because the channel id hashes the sender's linked service and not the sender; on RCS the channel id includes the brand, and it is written when the channel is created.
|
|
4699
5033
|
* @public
|
|
4700
5034
|
*/
|
|
4701
5035
|
messagingSenderId?: string | undefined;
|
|
@@ -4789,12 +5123,12 @@ export interface UpdateMessageInput {
|
|
|
4789
5123
|
sms?: boolean | undefined;
|
|
4790
5124
|
smsStatus?: MessageSmsStatus | undefined;
|
|
4791
5125
|
/**
|
|
4792
|
-
* A customer messaging channel that reaches x-bees through classound and is not SMS or WhatsApp. One discriminator instead of a boolean per channel, so a new channel adds a member here and not a set of channel fields.
|
|
5126
|
+
* A customer messaging channel that reaches x-bees through classound and is not SMS or WhatsApp. One discriminator instead of a boolean per channel, so a new channel adds a member here and not a set of channel fields. An RCS conversation is not a telephony channel, and its customer id is the person's phone number.
|
|
4793
5127
|
* @public
|
|
4794
5128
|
*/
|
|
4795
5129
|
messagingChannel?: MessagingChannel | undefined;
|
|
4796
5130
|
/**
|
|
4797
|
-
* The delivery state of a message an
|
|
5131
|
+
* The delivery state of a message an x-bees user sent over a customer messaging channel (see MessagingChannel), the same four states as WhatsApp. TRYING, SENT and ERROR are written by kite around the send; DELIVERED and a late ERROR arrive through the channel's status stream event (MESSENGER.STATUS, RCS.STATUS). A READ report is recorded as DELIVERED, as the WhatsApp producer does one hop earlier.
|
|
4798
5132
|
* @public
|
|
4799
5133
|
*/
|
|
4800
5134
|
messagingStatus?: MessageMessagingStatus | undefined;
|
|
@@ -4830,6 +5164,77 @@ export interface UpdateMessageOutput {
|
|
|
4830
5164
|
*/
|
|
4831
5165
|
requestDuration?: number | undefined;
|
|
4832
5166
|
}
|
|
5167
|
+
/**
|
|
5168
|
+
* @public
|
|
5169
|
+
*/
|
|
5170
|
+
export interface UpdateScheduledMessageInput {
|
|
5171
|
+
/**
|
|
5172
|
+
* The unique identifier of the tenant when a service token is used.
|
|
5173
|
+
* @public
|
|
5174
|
+
*/
|
|
5175
|
+
companyId?: string | undefined;
|
|
5176
|
+
/**
|
|
5177
|
+
* The unique identifier of the user when a service or PBX token is used.
|
|
5178
|
+
* @public
|
|
5179
|
+
*/
|
|
5180
|
+
userId?: string | undefined;
|
|
5181
|
+
/**
|
|
5182
|
+
* Text body. Required unless `attachments` is non-empty.
|
|
5183
|
+
* @public
|
|
5184
|
+
*/
|
|
5185
|
+
text?: string | undefined;
|
|
5186
|
+
/**
|
|
5187
|
+
* When true, the message body is interpreted as Markdown.
|
|
5188
|
+
* @public
|
|
5189
|
+
*/
|
|
5190
|
+
markdown?: boolean | undefined;
|
|
5191
|
+
/**
|
|
5192
|
+
* Direct `@user` ids. `@all`, `@here`, and `@channel` are not supported.
|
|
5193
|
+
* @public
|
|
5194
|
+
*/
|
|
5195
|
+
mentions?: string[] | undefined;
|
|
5196
|
+
/**
|
|
5197
|
+
* Pre-uploaded file references. Required unless `text` is provided.
|
|
5198
|
+
* @public
|
|
5199
|
+
*/
|
|
5200
|
+
attachments?: MessageAttachmentRequest[] | undefined;
|
|
5201
|
+
/**
|
|
5202
|
+
* Reply context referencing a quoted message.
|
|
5203
|
+
* @public
|
|
5204
|
+
*/
|
|
5205
|
+
quote?: MessageQuoteRef | undefined;
|
|
5206
|
+
scheduledMessageId: string;
|
|
5207
|
+
/**
|
|
5208
|
+
* New send time. Between 60 seconds and 30 days from now.
|
|
5209
|
+
* @public
|
|
5210
|
+
*/
|
|
5211
|
+
scheduledAt?: string | undefined;
|
|
5212
|
+
/**
|
|
5213
|
+
* `true` pauses the message, `false` resumes it.
|
|
5214
|
+
* @public
|
|
5215
|
+
*/
|
|
5216
|
+
paused?: boolean | undefined;
|
|
5217
|
+
}
|
|
5218
|
+
/**
|
|
5219
|
+
* @public
|
|
5220
|
+
*/
|
|
5221
|
+
export interface UpdateScheduledMessageOutput {
|
|
5222
|
+
/**
|
|
5223
|
+
* The request ID of the request.
|
|
5224
|
+
* @public
|
|
5225
|
+
*/
|
|
5226
|
+
requestId?: string | undefined;
|
|
5227
|
+
/**
|
|
5228
|
+
* The duration of the request in milliseconds.
|
|
5229
|
+
* @public
|
|
5230
|
+
*/
|
|
5231
|
+
requestDuration?: number | undefined;
|
|
5232
|
+
/**
|
|
5233
|
+
* A message written by its author and sent later. Private to the author until sent.
|
|
5234
|
+
* @public
|
|
5235
|
+
*/
|
|
5236
|
+
scheduledMessage: ScheduledMessage;
|
|
5237
|
+
}
|
|
4833
5238
|
/**
|
|
4834
5239
|
* Optional parameters for the upload presign flow.
|
|
4835
5240
|
* @public
|