swagger.json

{"basePath":"/","consumes":["application/json"],"definitions":{"RequestType.CloseSession":{"enum":["closeSession"],"type":"string"},"RequestType":{"enum":["configureSession","configureAuthenticatedSession","onAttachment","getAttachment","deleteAttachment","onMessage","closeSession","echo","getJwt","disconnectCustomer","resumeToken","subscribeToPush","getConfiguration"],"type":"string"},"CloseSessionRequest":{"properties":{"action":{"$ref":"#/definitions/RequestType.CloseSession"},"token":{"type":"string"},"closeAllConnections":{"type":"boolean"}},"required":["action","token","closeAllConnections"],"type":"object","additionalProperties":true},"RequestType.ConfigureSession":{"enum":["configureSession"],"type":"string"},"JourneyCustomer":{"properties":{"id":{"type":"string"},"idType":{"type":"string"}},"required":["id","idType"],"type":"object","additionalProperties":true},"JourneyCustomerSession":{"properties":{"id":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"type":"object","additionalProperties":true},"JourneyActionMap":{"properties":{"id":{"type":"string"},"version":{"type":"integer","format":"int32"}},"required":["id","version"],"type":"object","additionalProperties":true},"JourneyAction":{"properties":{"id":{"type":"string"},"actionMap":{"$ref":"#/definitions/JourneyActionMap"}},"required":["id","actionMap"],"type":"object","additionalProperties":true},"JourneyContext":{"properties":{"customer":{"$ref":"#/definitions/JourneyCustomer"},"customerSession":{"$ref":"#/definitions/JourneyCustomerSession"},"triggeringAction":{"$ref":"#/definitions/JourneyAction"}},"required":["customer","customerSession"],"type":"object","additionalProperties":true},"ConfigureSessionRequest":{"properties":{"action":{"$ref":"#/definitions/RequestType.ConfigureSession"},"token":{"type":"string"},"deploymentId":{"type":"string"},"journeyContext":{"$ref":"#/definitions/JourneyContext"},"resumeToken":{"type":"string"},"startNew":{"type":"boolean"}},"required":["action","token","deploymentId"],"type":"object","additionalProperties":true},"RequestType.DeleteAttachment":{"enum":["deleteAttachment"],"type":"string"},"DeleteAttachmentRequest":{"properties":{"action":{"$ref":"#/definitions/RequestType.DeleteAttachment"},"token":{"type":"string"},"attachmentId":{"type":"string"}},"required":["action","token","attachmentId"],"type":"object","additionalProperties":true},"RequestType.GenerateDownloadUrl":{"enum":["getAttachment"],"type":"string"},"GenerateDownloadUrlRequest":{"properties":{"action":{"$ref":"#/definitions/RequestType.GenerateDownloadUrl"},"token":{"type":"string"},"attachmentId":{"type":"string"}},"required":["action","token","attachmentId"],"type":"object","additionalProperties":true},"RequestType.GenerateUploadUrl":{"enum":["onAttachment"],"type":"string"},"GenerateUploadUrlRequest":{"properties":{"action":{"$ref":"#/definitions/RequestType.GenerateUploadUrl"},"token":{"type":"string"},"attachmentId":{"type":"string"},"fileName":{"type":"string"},"fileType":{"type":"string"},"fileSize":{"type":"integer","format":"int32"},"fileMd5":{"type":"string"}},"required":["action","token","fileName","fileType","fileSize","fileMd5"],"type":"object","additionalProperties":true},"RequestType.IncomingMessage":{"enum":["onMessage"],"type":"string"},"NormalizedType":{"description":"Message type.","enum":["Event","Message","Receipt","Structured","Text"],"type":"string"},"Status":{"description":"Message receipt status, only used with type Receipt.","enum":["Delivered","Failed","Published","Read","Removed","Sent"],"type":"string"},"MediaType":{"description":"The type of attachment this instance represents.","enum":["Audio","File","Image","Link","Video"],"type":"string"},"ContentAttachment":{"description":"Attachment content.\n\nMedia template header image.\n\nAttachment object.","properties":{"contentSizeBytes":{"type":"number","format":"double","description":"Size in bytes of the attachment content."},"filename":{"type":"string","description":"Suggested file name for attachment."},"id":{"type":"string","description":"Provider specific ID for attachment. For example, a LINE sticker ID."},"mediaType":{"$ref":"#/definitions/MediaType","description":"The type of attachment this instance represents."},"mime":{"type":"string","description":"Attachment mime type (https://www.iana.org/assignments/media-types/media-types.xhtml)."},"sha256":{"type":"string","description":"Secure hash of the attachment content."},"text":{"type":"string","description":"Text associated with attachment such as an image caption."},"url":{"type":"string","description":"URL of the attachment."}},"required":["mediaType"],"type":"object","additionalProperties":true},"ButtonResponseType":{"description":"Describes the button that resulted in the Button Response.","enum":["Button","QuickReply"],"type":"string"},"ContentButtonResponse":{"description":"Button response content.\n\nButton response object representing the click of a structured message button, such as a\nquick reply.","properties":{"id":{"type":"string","description":"An ID assigned to the button response (Deprecated)."},"payload":{"type":"string","description":"The response payload associated with the clicked button."},"text":{"type":"string","description":"The response text from the button click."},"type":{"$ref":"#/definitions/ButtonResponseType","description":"Describes the button that resulted in the Button Response."}},"required":["payload","text","type"],"type":"object","additionalProperties":true},"CardActionType":{"description":"Describes the type of action.","enum":["Link","Postback"],"type":"string"},"ContentCardAction":{"description":"A card action that a user can take.\n\nThe default button action.","properties":{"payload":{"type":"string","description":"Text to be returned as the payload from a ButtonResponse when a button is clicked. The\npayload and text are a combination which will have to be unique across each card and\ncarousel in order to determine which button was clicked in that card or carousel."},"text":{"type":"string","description":"The response text from the button click."},"type":{"$ref":"#/definitions/CardActionType","description":"Describes the type of action."},"url":{"type":"string","description":"A URL of a web page to direct the user to."}},"type":"object","additionalProperties":true},"ContentCard":{"description":"Card content\n\nCard content object.","properties":{"actions":{"items":{"additionalProperties":true},"type":"array","description":"An array of action objects."},"defaultAction":{"$ref":"#/definitions/ContentCardAction","description":"The default button action."},"description":{"type":"string","description":"Text to show in the description."},"image":{"type":"string","description":"URL of an image."},"title":{"type":"string","description":"Text to show in the title."},"video":{"type":"string","description":"URL of a video."}},"required":["actions","title"],"type":"object","additionalProperties":true},"ContentCarousel":{"description":"Carousel content\n\nCarousel content object.","properties":{"cards":{"items":{"$ref":"#/definitions/ContentCard"},"type":"array","description":"An array of card objects."}},"required":["cards"],"type":"object","additionalProperties":true},"ContentType":{"description":"Type of this content element.","enum":["Attachment","ButtonResponse","Card","Carousel","GenericTemplate","ListTemplate","Location","Mention","Notification","Postback","QuickReply","QuickReplyV2","Reactions","Story","Text"],"type":"string"},"ContentActions":{"description":"Actions to be taken (Deprecated).\n\nThe button actions (Deprecated).\n\nThe list actions (Deprecated).\n\nThe list item actions (Deprecated).\n\nUser actions available on the content. All actions are optional and all actions are\nexecuted simultaneously.","properties":{"commandName":{"type":"string","description":"Execute an organization's specific command (Deprecated)."},"context":{"properties":{},"additionalProperties":{"additionalProperties":true},"type":"object","description":"Additional context for the command (Deprecated)."},"textback":{"type":"string","description":"Text to be returned as the payload from a ButtonResponse when a button is clicked. The\ntextback and title are a combination which will have to be unique across each card and\ncarousel in order to determine which button was clicked in that card or carousel."},"url":{"type":"string","description":"A URL of a web page to direct the user to."},"urlTarget":{"type":"string","description":"The target window in which to open the URL. If empty will open a blank page or tab."}},"type":"object","additionalProperties":true},"ButtonComponent":{"description":"Structured template button object.","properties":{"actions":{"$ref":"#/definitions/ContentActions","description":"The button actions (Deprecated)."},"id":{"type":"string","description":"The ID of this component (Deprecated)."},"text":{"type":"string","description":"Deprecated - Use title instead."},"title":{"type":"string","description":"Text to show inside the button."}},"required":["actions","title"],"type":"object","additionalProperties":true},"ContentGeneric":{"description":"Generic content (Deprecated).\n\nDeprecated, should use Card.","properties":{"actions":{"$ref":"#/definitions/ContentActions","description":"Actions to be taken (Deprecated)."},"components":{"items":{"$ref":"#/definitions/ButtonComponent"},"type":"array","description":"An array of component objects."},"description":{"type":"string","description":"Text to show in the description."},"id":{"type":"string","description":"A unique ID assigned to this rich message content (Deprecated)."},"image":{"type":"string","description":"URL of an image."},"title":{"type":"string","description":"Text to show in the title."},"video":{"type":"string","description":"URL of a video."}},"required":["title"],"type":"object","additionalProperties":true},"ListItemType":{"description":"The type of list item to render.","enum":["ListItem","ListItemBig"],"type":"string"},"ListItemComponent":{"description":"An entry in a List template.","properties":{"actions":{"$ref":"#/definitions/ContentActions","description":"The list item actions (Deprecated)."},"description":{"type":"string","description":"Text to show in the list item description."},"id":{"type":"string","description":"An ID assigned to this list item."},"image":{"type":"string","description":"URL of an image."},"rmid":{"type":"string","description":"An ID of the rich message instance."},"title":{"type":"string","description":"The main headline of the list item."},"type":{"$ref":"#/definitions/ListItemType","description":"The type of list item to render."}},"type":"object","additionalProperties":true},"ListType":{"description":"The type of list this instance represents.","enum":["Selection","Vertical"],"type":"string"},"ContentList":{"description":"List content (Deprecated).\n\nList content object.","properties":{"actions":{"$ref":"#/definitions/ContentActions","description":"The list actions (Deprecated)."},"components":{"items":{"$ref":"#/definitions/ListItemComponent"},"type":"array","description":"An array of component objects."},"description":{"type":"string","description":"Text to show in the description."},"id":{"type":"string","description":"A unique ID assigned to this rich message content."},"listType":{"$ref":"#/definitions/ListType","description":"The type of list this instance represents."},"submitLabel":{"type":"string","description":"Label for Submit button."},"title":{"type":"string","description":"Text to show in the title."}},"type":"object","additionalProperties":true},"ContentLocation":{"description":"Location content.\n\nLocation object.","properties":{"address":{"type":"string","description":"Location postal address."},"latitude":{"type":"number","format":"double","description":"Latitude of the location."},"longitude":{"type":"number","format":"double","description":"Longitude of the location."},"text":{"type":"string","description":"Location name."},"url":{"type":"string","description":"URL of the Location."}},"type":"object","additionalProperties":true},"AdditionalIDType":{"description":"Type of the Identifier","enum":["Deployment","Subject"],"type":"string"},"RecipientAdditionalIdentifier":{"description":"Additional identifiers for describing messaging recipient.","properties":{"type":{"$ref":"#/definitions/AdditionalIDType","description":"Type of the Identifier"},"value":{"type":"string","description":"The Identifier value."}},"required":["type","value"],"type":"object","additionalProperties":true},"IDType":{"description":"The recipient ID type. This is used to indicate the format used for the ID.","enum":["Email","Opaque","Phone"],"type":"string"},"MessagingRecipient":{"description":"Information about the recipient the message is received from.\n\nInformation about the recipient the message is sent to or received from.\n\nInformation about the recipient the message is sent to.\n\nMention content.","properties":{"additionalIds":{"items":{"$ref":"#/definitions/RecipientAdditionalIdentifier"},"type":"array","description":"List of recipient additional identifiers"},"email":{"type":"string","description":"E-mail address of the recipient."},"firstName":{"type":"string","description":"First name of the recipient."},"id":{"type":"string","description":"The recipient ID specific to the provider."},"idType":{"$ref":"#/definitions/IDType","description":"The recipient ID type. This is used to indicate the format used for the ID."},"image":{"type":"string","description":"URL of an image that represents the recipient."},"lastName":{"type":"string","description":"Last name of the recipient."},"nickname":{"type":"string","description":"Nickname or display name of the recipient."}},"required":["id"],"type":"object","additionalProperties":true},"ContentPostback":{"description":"Structured message postback (Deprecated).\n\nPostback response object representing the click of a rich media button (Deprecated).","properties":{"id":{"type":"string","description":"An ID assigned to the button response."},"payload":{"type":"string","description":"The response payload associated with the clicked button."},"text":{"type":"string","description":"The response text from the button click."}},"required":["payload"],"type":"object","additionalProperties":true},"Action":{"description":"Specifies the type of action that is triggered upon clicking the quick reply.","enum":["Message"],"type":"string"},"ContentQuickReply":{"description":"Quick reply content.\n\nQuick reply object.","properties":{"action":{"$ref":"#/definitions/Action","description":"Specifies the type of action that is triggered upon clicking the quick reply."},"id":{"type":"string","description":"A unique ID assigned to the quick reply (Deprecated)."},"image":{"type":"string","description":"URL of an image associated with the quick reply."},"payload":{"type":"string","description":"Content of the payload included in the quick reply response. Could be an ID identifying\nthe quick reply response."},"text":{"type":"string","description":"Text to show inside the quick reply. This is also used as the response text after\nclicking on the quick reply."}},"required":["payload","text"],"type":"object","additionalProperties":true},"ContentQuickReplyV2":{"description":"Quick reply V2 content.\n\nQuick reply object V2.","properties":{"actions":{"items":{"$ref":"#/definitions/ContentQuickReply"},"type":"array","description":"An array of quick reply objects."},"title":{"type":"string","description":"Text to show as the title of the quick reply."}},"required":["actions","title"],"type":"object","additionalProperties":true},"ReactionType":{"description":"Type of reaction.","enum":["Angry","Care","Haha","Like","Love","None","Pride","Sad","Thankful","Wow"],"type":"string"},"ContentReaction":{"description":"User reaction to public message.","properties":{"count":{"type":"number","format":"double","description":"Number of users that reacted this way to the message."},"reactionType":{"$ref":"#/definitions/ReactionType","description":"Type of reaction."}},"required":["count","reactionType"],"type":"object","additionalProperties":true},"StoryType":{"description":"Type of ephemeral story attachment.","enum":["Mention","Reply"],"type":"string"},"ContentStory":{"description":"Ephemeral story content.\n\nAn ephemeral story.","properties":{"replyToId":{"type":"string","description":"ID of the ephemeral story being replied to."},"type":{"$ref":"#/definitions/StoryType","description":"Type of ephemeral story attachment."},"url":{"type":"string","description":"URL to the ephemeral story."}},"required":["type","url"],"type":"object","additionalProperties":true},"NotificationTemplateParameter":{"description":"Template parameters for placeholders in template.","properties":{"name":{"type":"string","description":"Parameter name."},"text":{"type":"string","description":"Parameter text value."}},"required":["text"],"type":"object","additionalProperties":true},"NotificationTemplateBody":{"description":"The template body.\n\nTemplate body object.","properties":{"parameters":{"items":{"$ref":"#/definitions/NotificationTemplateParameter"},"type":"array","description":"Template parameters for placeholders in template."},"text":{"type":"string","description":"Body text. For WhatsApp, ignored."}},"required":["parameters"],"type":"object","additionalProperties":true},"NotificationTemplateFooter":{"description":"The template footer.\n\nTemplate footer object.","properties":{"text":{"type":"string","description":"Footer text. For WhatsApp, ignored."}},"type":"object","additionalProperties":true},"HeaderType":{"description":"Template header type.","enum":["Media","Text"],"type":"string"},"NotificationTemplateHeader":{"description":"The template header.\n\nTemplate header object.","properties":{"media":{"$ref":"#/definitions/ContentAttachment","description":"Media template header image."},"parameters":{"items":{"$ref":"#/definitions/NotificationTemplateParameter"},"type":"array","description":"Template parameters for placeholders in template."},"text":{"type":"string","description":"Header text. For WhatsApp, ignored."},"type":{"$ref":"#/definitions/HeaderType","description":"Template header type."}},"required":["type"],"type":"object","additionalProperties":true},"ContentNotificationTemplate":{"description":"Template notification content.\n\nTemplate notification object.","properties":{"body":{"$ref":"#/definitions/NotificationTemplateBody","description":"The template body."},"footer":{"$ref":"#/definitions/NotificationTemplateFooter","description":"The template footer."},"header":{"$ref":"#/definitions/NotificationTemplateHeader","description":"The template header."},"id":{"type":"string","description":"The messaging provider template ID. For WhatsApp, 'namespace@name'."},"language":{"type":"string","description":"Template language."}},"required":["body"],"type":"object","additionalProperties":true},"TextType":{"description":"Type of text content.","enum":["Text"],"type":"string"},"ContentText":{"description":"Text content.\n\nMessage content element containing text only.","properties":{"body":{"type":"string","description":"Text to be shown for this content element."},"type":{"$ref":"#/definitions/TextType","description":"Type of text content."}},"required":["body"],"type":"object","additionalProperties":true},"MessageContent":{"description":"Message content element. If contentType = \"Attachment\" only one item is allowed.","properties":{"attachment":{"$ref":"#/definitions/ContentAttachment","description":"Attachment content."},"buttonResponse":{"$ref":"#/definitions/ContentButtonResponse","description":"Button response content."},"card":{"$ref":"#/definitions/ContentCard","description":"Card content"},"carousel":{"$ref":"#/definitions/ContentCarousel","description":"Carousel content"},"contentType":{"$ref":"#/definitions/ContentType"},"generic":{"$ref":"#/definitions/ContentGeneric","description":"Generic content (Deprecated)."},"list":{"$ref":"#/definitions/ContentList","description":"List content (Deprecated)."},"location":{"$ref":"#/definitions/ContentLocation","description":"Location content."},"mention":{"$ref":"#/definitions/MessagingRecipient","description":"Mention content."},"postback":{"$ref":"#/definitions/ContentPostback","description":"Structured message postback (Deprecated)."},"quickReply":{"$ref":"#/definitions/ContentQuickReply","description":"Quick reply content."},"quickReplyV2":{"$ref":"#/definitions/ContentQuickReplyV2","description":"Quick reply V2 content."},"reactions":{"items":{"$ref":"#/definitions/ContentReaction"},"type":"array","description":"A set of reactions to a message."},"story":{"$ref":"#/definitions/ContentStory","description":"Ephemeral story content."},"template":{"$ref":"#/definitions/ContentNotificationTemplate","description":"Template notification content."},"text":{"$ref":"#/definitions/ContentText","description":"Text content."}},"required":["contentType"],"type":"object","additionalProperties":true},"EventCoBrowseType":{"description":"Describes the type of CoBrowse event.","enum":["Offering","OfferingAccepted","OfferingExpired","OfferingRejected"],"type":"string"},"EventCoBrowse":{"description":"CoBrowse event.\n\nA CoBrowse event.","properties":{"sessionId":{"type":"string","description":"The CoBrowse session ID."},"sessionJoinToken":{"type":"string","description":"The CoBrowse session join token."},"type":{"$ref":"#/definitions/EventCoBrowseType","description":"Describes the type of CoBrowse event."}},"required":["type"],"type":"object","additionalProperties":true},"EventType":{"description":"Type of this event element","enum":["CoBrowse","Presence","Typing"],"type":"string"},"EventPresenceType":{"description":"Describes the type of Presence event.","enum":["Clear","Disconnect","Join","SignIn"],"type":"string"},"EventPresence":{"description":"Presence event.\n\nA Presence event.","properties":{"type":{"$ref":"#/definitions/EventPresenceType","description":"Describes the type of Presence event."}},"required":["type"],"type":"object","additionalProperties":true},"EventTypingType":{"description":"Describes the type of Typing event.","enum":["On"],"type":"string"},"EventTyping":{"description":"Typing event.\n\nA Typing event.","properties":{"duration":{"type":"number","format":"double","description":"The duration of the Typing event in milliseconds."},"type":{"$ref":"#/definitions/EventTypingType","description":"Describes the type of Typing event."}},"required":["type"],"type":"object","additionalProperties":true},"MessageEvent":{"description":"Message event element.  Examples include: system messages, typing indicators, cobrowse\nofferings.","properties":{"coBrowse":{"$ref":"#/definitions/EventCoBrowse","description":"CoBrowse event."},"eventType":{"$ref":"#/definitions/EventType"},"presence":{"$ref":"#/definitions/EventPresence","description":"Presence event."},"typing":{"$ref":"#/definitions/EventTyping","description":"Typing event."}},"required":["eventType"],"type":"object","additionalProperties":true},"IncomingNormalizedMessage":{"properties":{"id":{"type":"string"},"type":{"$ref":"#/definitions/NormalizedType"},"text":{"type":"string"},"status":{"$ref":"#/definitions/Status"},"content":{"items":{"$ref":"#/definitions/MessageContent"},"type":"array"},"events":{"items":{"$ref":"#/definitions/MessageEvent"},"type":"array"},"metadata":{"properties":{},"additionalProperties":{"type":"string"},"type":"object"},"channel":{"properties":{"metadata":{"properties":{"customAttributes":{"properties":{},"additionalProperties":{"type":"string"},"type":"object"}},"required":["customAttributes"],"type":"object"},"messageId":{"type":"string"}},"type":"object"}},"required":["type"],"type":"object","additionalProperties":true},"ChannelType":{"description":"Specifies if this message is part of a private or public conversation.","enum":["Private","Public"],"type":"string"},"BaseMessagingRecipient":{"properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"nickname":{"type":"string"},"image":{"type":"string"}},"type":"object","additionalProperties":true},"BaseChannelMetadata":{"properties":{"customAttributes":{"properties":{},"additionalProperties":{"type":"string"},"type":"object"}},"type":"object","additionalProperties":true},"BaseMessagingChannel":{"properties":{"time":{"type":"string"},"type":{"$ref":"#/definitions/ChannelType"},"messageId":{"type":"string"},"from":{"$ref":"#/definitions/BaseMessagingRecipient"},"to":{"$ref":"#/definitions/BaseMessagingRecipient"},"metadata":{"$ref":"#/definitions/BaseChannelMetadata"}},"type":"object","additionalProperties":true},"SendMessageRequest":{"properties":{"action":{"$ref":"#/definitions/RequestType.IncomingMessage"},"token":{"type":"string"},"time":{"type":"string"},"message":{"$ref":"#/definitions/IncomingNormalizedMessage"},"channel":{"$ref":"#/definitions/BaseMessagingChannel"}},"required":["action","token","time","message"],"type":"object","additionalProperties":true},"RequestType.EchoMessage":{"enum":["echo"],"type":"string"},"SendEchoRequest":{"properties":{"action":{"$ref":"#/definitions/RequestType.EchoMessage"},"token":{"type":"string"},"message":{"$ref":"#/definitions/IncomingNormalizedMessage"}},"required":["action","token","message"],"type":"object","additionalProperties":true},"RequestType.GetJwt":{"enum":["getJwt"],"type":"string"},"GetJwtRequest":{"properties":{"action":{"$ref":"#/definitions/RequestType.GetJwt"},"token":{"type":"string"}},"required":["action","token"],"type":"object","additionalProperties":true},"RequestType.ConfigureAuthenticatedSession":{"enum":["configureAuthenticatedSession"],"type":"string"},"oAuthParams":{"properties":{"code":{"type":"string"}},"required":["code"],"type":"object","additionalProperties":true},"ConfigureAuthenticatedSessionRequest":{"properties":{"action":{"$ref":"#/definitions/RequestType.ConfigureAuthenticatedSession"},"token":{"type":"string"},"deploymentId":{"type":"string"},"data":{"$ref":"#/definitions/oAuthParams"},"resumeToken":{"type":"string"},"startNew":{"type":"boolean"},"stepUp":{"type":"boolean"}},"required":["action","token","deploymentId","data"],"type":"object","additionalProperties":true},"RequestType.GetConfiguration":{"enum":["getConfiguration"],"type":"string"},"GetConfigurationRequest":{"properties":{"action":{"$ref":"#/definitions/RequestType.GetConfiguration"},"token":{"type":"string"},"deploymentId":{"type":"string"}},"required":["action","token","deploymentId"],"type":"object","additionalProperties":true},"BaseMessageType":{"enum":["message","response"],"type":"string"},"MessageDataType":{"enum":["string","SessionResponse","StructuredMessage","PresignedUrlResponse","AttachmentDeletedResponse","UploadFailureEvent","UploadSuccessEvent","ConnectionClosedEvent","LogoutEvent","SessionExpiredEvent","JwtResponse","GetConfigurationResponse","GenerateUrlError","TooManyRequestsErrorMessage","ResumeTokenResponse","SessionClearedEvent","Error","Unknown"],"type":"string"},"FileType":{"properties":{"type":{"type":"string"}},"required":["type"],"type":"object","additionalProperties":true},"FileUploadMode":{"properties":{"fileTypes":{"items":{"$ref":"#/definitions/FileType"},"type":"array"},"maxFileSizeKB":{"type":"number","format":"double"}},"required":["fileTypes","maxFileSizeKB"],"type":"object","additionalProperties":true},"AllowedMedia":{"properties":{"inbound":{"$ref":"#/definitions/FileUploadMode"}},"required":["inbound"],"type":"object","additionalProperties":true},"SessionResponse":{"properties":{"connected":{"type":"boolean"},"newSession":{"type":"boolean"},"readOnly":{"type":"boolean"},"clearedExistingSession":{"type":"boolean"},"allowedMedia":{"$ref":"#/definitions/AllowedMedia"},"blockedExtensions":{"items":{"type":"string"},"type":"array"},"maxCustomDataBytes":{"type":"number","format":"double"}},"required":["connected"],"type":"object","additionalProperties":true},"PresignedUrlResponse":{"properties":{"attachmentId":{"type":"string"},"headers":{"properties":{},"additionalProperties":{"type":"string"},"type":"object"},"url":{"type":"string"},"fileName":{"type":"string"},"fileSize":{"type":"integer","format":"int32"},"fileType":{"type":"string"}},"required":["attachmentId","headers","url"],"type":"object","additionalProperties":true},"AttachmentDeletedResponse":{"properties":{"attachmentId":{"type":"string"}},"required":["attachmentId"],"type":"object","additionalProperties":true},"JwtResponse":{"properties":{"jwt":{"type":"string"},"exp":{"type":"number","format":"double"}},"required":["jwt","exp"],"type":"object","additionalProperties":true},"GetConfigurationResponse":{"properties":{"allowedMedia":{"$ref":"#/definitions/AllowedMedia"},"blockedExtensions":{"items":{"type":"string"},"type":"array"},"maxCustomDataBytes":{"type":"number","format":"double"},"messageRoutingEnabled":{"type":"boolean"}},"required":["allowedMedia","maxCustomDataBytes","messageRoutingEnabled"],"type":"object","additionalProperties":true},"GenerateUrlError":{"properties":{"name":{"type":"string"},"message":{"type":"string"},"stack":{"type":"string"},"errorCode":{"type":"integer","format":"int32"},"errorMessage":{"type":"string"},"attachmentId":{"type":"string"},"timestamp":{"type":"string"}},"required":["name","message","errorCode","errorMessage"],"type":"object","additionalProperties":true},"TooManyRequestsErrorMessage":{"properties":{"name":{"type":"string"},"message":{"type":"string"},"stack":{"type":"string"},"errorCode":{"type":"integer","format":"int32"},"errorMessage":{"type":"string"},"retryAfter":{"type":"integer","format":"int32"}},"required":["name","message","errorCode","errorMessage","retryAfter"],"type":"object","additionalProperties":true},"ResumeTokenResponse":{"properties":{"resumeToken":{"type":"string"},"exp":{"type":"number","format":"double"}},"required":["resumeToken","exp"],"type":"object","additionalProperties":true},"ErrorMessage":{"properties":{"name":{"type":"string"},"message":{"type":"string"},"stack":{"type":"string"},"errorCode":{"type":"integer","format":"int32"},"errorMessage":{"type":"string"}},"required":["name","message","errorCode","errorMessage"],"type":"object","additionalProperties":true},"ResponseMessage":{"type":"object"},"Direction":{"description":"The direction of the message.","enum":["Inbound","Outbound"],"type":"string"},"BaseContentAttachment":{"properties":{"id":{"type":"string"},"filename":{"type":"string"},"fileSize":{"type":"integer","format":"int32"},"mediaType":{"$ref":"#/definitions/MediaType"},"mime":{"type":"string"},"sha256":{"type":"string"},"text":{"type":"string"},"url":{"type":"string"}},"required":["mediaType"],"type":"object","additionalProperties":true},"BaseMessagingContent":{"properties":{"attachment":{"$ref":"#/definitions/BaseContentAttachment"},"contentType":{"$ref":"#/definitions/ContentType"}},"required":["contentType"],"type":"object","additionalProperties":true},"StructuredMessage":{"properties":{"text":{"type":"string"},"type":{"$ref":"#/definitions/NormalizedType"},"direction":{"$ref":"#/definitions/Direction"},"id":{"type":"string"},"channel":{"$ref":"#/definitions/BaseMessagingChannel"},"content":{"items":{"$ref":"#/definitions/BaseMessagingContent"},"type":"array"},"metadata":{"properties":{},"additionalProperties":{"type":"string"},"type":"object"},"events":{"items":{"$ref":"#/definitions/MessageEvent"},"type":"array"}},"required":["type"],"type":"object","additionalProperties":true},"UploadSuccessEvent":{"properties":{"attachmentId":{"type":"string"},"downloadUrl":{"type":"string"},"timestamp":{"type":"string"}},"required":["attachmentId","downloadUrl","timestamp"],"type":"object","additionalProperties":true},"UploadFailureEvent":{"properties":{"attachmentId":{"type":"string"},"errorCode":{"type":"integer","format":"int32"},"errorMessage":{"type":"string"},"timestamp":{"type":"string"}},"required":["attachmentId","errorCode","errorMessage","timestamp"],"type":"object","additionalProperties":true},"CleanMessagingRecipient":{"properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"nickname":{"type":"string"},"image":{"type":"string"}},"type":"object","additionalProperties":true},"CleanChannelMetadata":{"properties":{"customAttributes":{"properties":{},"additionalProperties":{"type":"string"},"type":"object"}},"type":"object","additionalProperties":true},"CleanMessagingChannel":{"properties":{"time":{"type":"string"},"type":{"$ref":"#/definitions/ChannelType"},"messageId":{"type":"string"},"from":{"$ref":"#/definitions/CleanMessagingRecipient"},"to":{"$ref":"#/definitions/CleanMessagingRecipient"},"metadata":{"$ref":"#/definitions/CleanChannelMetadata"}},"type":"object","additionalProperties":true},"CleanContentAttachment":{"properties":{"id":{"type":"string"},"filename":{"type":"string"},"fileSize":{"type":"number","format":"double"},"mediaType":{"$ref":"#/definitions/MediaType"},"mime":{"type":"string"},"sha256":{"type":"string"},"text":{"type":"string"},"url":{"type":"string"}},"required":["mediaType"],"type":"object","additionalProperties":true},"CleanMessageContent":{"properties":{"attachment":{"$ref":"#/definitions/CleanContentAttachment"},"contentType":{"$ref":"#/definitions/ContentType"},"buttonResponse":{"$ref":"#/definitions/ContentButtonResponse"},"generic":{"$ref":"#/definitions/ContentGeneric"},"card":{"$ref":"#/definitions/ContentCard"},"carousel":{"$ref":"#/definitions/ContentCarousel"},"quickReply":{"$ref":"#/definitions/ContentQuickReply"},"text":{"$ref":"#/definitions/ContentText"},"quickReplyV2":{"$ref":"#/definitions/ContentQuickReplyV2"}},"required":["contentType"],"type":"object","additionalProperties":true},"CleanMessageEvent":{"properties":{"coBrowse":{"$ref":"#/definitions/EventCoBrowse","description":"CoBrowse event."},"eventType":{"$ref":"#/definitions/EventType"},"presence":{"$ref":"#/definitions/EventPresence","description":"Presence event."},"typing":{"$ref":"#/definitions/EventTyping","description":"Typing event."}},"required":["eventType"],"type":"object","additionalProperties":true},"OriginatingEntity":{"description":"Specifies if this message was sent by a human agent or bot. The platform may use this to\napply appropriate provider policies.","enum":["Bot","Human"],"type":"string"},"CleanMessage":{"properties":{"text":{"type":"string"},"type":{"$ref":"#/definitions/NormalizedType"},"direction":{"$ref":"#/definitions/Direction"},"id":{"type":"string"},"channel":{"$ref":"#/definitions/CleanMessagingChannel"},"content":{"items":{"$ref":"#/definitions/CleanMessageContent"},"type":"array"},"metadata":{"properties":{},"additionalProperties":{"type":"string"},"type":"object"},"events":{"items":{"$ref":"#/definitions/CleanMessageEvent"},"type":"array"},"originatingEntity":{"$ref":"#/definitions/OriginatingEntity"}},"required":["type"],"type":"object","additionalProperties":true},"ConnectionClosedEvent":{"properties":{},"type":"object","additionalProperties":true},"LogoutEvent":{"properties":{},"type":"object","additionalProperties":true},"SessionExpiredEvent":{"properties":{},"type":"object","additionalProperties":true},"SessionClearedEvent":{"properties":{},"type":"object","additionalProperties":true},"EventMessage":{"type":"object"},"BaseMessage":{"properties":{"type":{"$ref":"#/definitions/BaseMessageType"},"class":{"$ref":"#/definitions/MessageDataType"},"code":{"type":"integer","format":"int32"},"body":{"type":"object"}},"required":["type","class","code","body"],"type":"object","additionalProperties":true}},"info":{"title":"shyrka-chat","version":"1.0.0","license":{"name":"UNLICENSED"},"contact":{"name":"Genesys"}},"paths":{},"produces":["application/json"],"swagger":"2.0","securityDefinitions":{}}