swagger.json

{"swagger":"2.0","host":"","info":{"title":"shyrka-chat","version":"1.0.0","license":{"name":"UNLICENSED"},"contact":{"name":"Genesys"}},"externalDocs":{"description":"","url":""},"consumes":["application/json"],"produces":["application/json"],"tags":[],"definitions":{"RequestType.CloseSession":{"enum":["closeSession"],"type":"string"},"RequestType":{"enum":["configureSession","configureAuthenticatedSession","onAttachment","getAttachment","deleteAttachment","onMessage","closeSession","echo","getJwt","disconnectCustomer","resumeToken","getConfiguration"],"type":"string"},"CloseSessionRequest":{"properties":{"action":{"$ref":"#/definitions/RequestType.CloseSession"},"token":{"type":"string"},"tracingId":{"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"},"tracingId":{"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"},"tracingId":{"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"},"tracingId":{"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"},"tracingId":{"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":{"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 or component that resulted in the Button Response.","enum":["Button","DatePicker","Form","ListPicker","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, list picker selections etc.","properties":{"id":{"type":"string","description":"An ID assigned to the button response (Deprecated)."},"originatingMessageId":{"type":"string","description":"Reference to the ID of the original message (e.g., list picker) this button response is\nreplying to."},"payload":{"type":"string","description":"The response payload associated with the clicked button or selected item."},"text":{"type":"string","description":"The response text from the button click or selection."},"type":{"$ref":"#/definitions/ButtonResponseType","description":"Describes the button or component 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":{},"type":"array","description":"An array of action objects."},"defaultAction":{"description":"The default button action.","$ref":"#/definitions/ContentCardAction"},"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":{"enum":["Attachment","ButtonResponse","Card","Carousel","DatePicker","Form","GenericTemplate","InteractiveApplication","ListPicker","ListTemplate","Location","Mention","Notification","PaymentRequest","PaymentResponse","Postback","Push","QuickReply","QuickReplyV2","Reactions","RichLink","RoadsideAssistance","Story","Text"],"type":"string"},"ContentDatePickerAvailableTime":{"description":"A datepicker available time that a user can take.","properties":{"dateTime":{"description":"The date and times of the event being scheduled.","type":"string"},"duration":{"type":"number","format":"double","description":"The duration of the scheduling event in seconds."}},"required":["dateTime","duration"],"type":"object","additionalProperties":true},"DateDisplayFormat":{"enum":["dayMonthYear","monthDayYear","yearMonthDay"],"type":"string"},"ContentLocation":{"description":"The location of the event.\n\nLocation content.\n\nUser Location object\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."}},"required":["text"],"type":"object","additionalProperties":true},"ContentDatePicker":{"description":"DatePicker content.\n\nDatePicker content object.\n\nDate Picker content.","properties":{"availableTimes":{"items":{"$ref":"#/definitions/ContentDatePickerAvailableTime"},"type":"array","description":"An array of available times objects."},"dateDisplayFormat":{"description":"The format the date should be presented to the end user.","$ref":"#/definitions/DateDisplayFormat"},"dateMaximum":{"description":"The maximum Date Enabled in the datepicker calendar","type":"string"},"dateMinimum":{"description":"The minimum Date Enabled in the datepicker calendar","type":"string"},"id":{"type":"string","description":"Optional unique identifier to help map component replies to form messages where multiple\nDatePickers can be present"},"imageUrl":{"type":"string","description":"URL of an image"},"location":{"description":"The location of the event.","$ref":"#/definitions/ContentLocation"},"subtitle":{"type":"string","description":"Text to show in the description."},"title":{"type":"string","description":"Text to show in the title."}},"type":"object","additionalProperties":true},"FormComponentType":{"enum":["DatePicker","Input","ListPicker","WheelPicker"],"type":"string"},"AutoCompleteType":{"description":"A string value representing the keyboard and system information about the expected\nsemantic meaning for the content that users enter","enum":["Addressline1","Addressline2","Birthdate","BirthdateDay","BirthdateMonth","BirthdateYear","City","Country","DateTime","Email","FamilyName","FlightNumber","GivenName","Location","MiddleName","Name","Nickname","OneTimeCode","Organization","PaymentCardExpiration","PaymentCardExpirationMonth","PaymentCardExpirationYear","PaymentCardFamilyName","PaymentCardGivenName","PaymentCardMiddleName","PaymentCardName","PaymentCardNumber","PaymentCardSecurityCode","PaymentCardType","Phone","PostalCode","Prefix","State","StreetAddress","Suffix","Title","Url","Username"],"type":"string"},"KeyboardType":{"enum":["Decimal","Default","Email","Number","NumberPunctuation","Phone","URL","Websearch"],"type":"string"},"ContentInput":{"description":"Input content.\n\nSingle or multiline text input component","properties":{"autoCompleteType":{"$ref":"#/definitions/AutoCompleteType","description":"A string value representing the keyboard and system information about the expected\nsemantic meaning for the content that users enter."},"id":{"type":"string","description":"Unique identifier for the input"},"isMultipleLine":{"type":"boolean","description":"Whether the input should allow multiple lines of text."},"isRequired":{"type":"boolean","description":"Whether the input field(s) are required to be filled in."},"keyboardType":{"description":"Type of keyboard to be shown.","$ref":"#/definitions/KeyboardType"},"placeholderText":{"type":"string","description":"Placeholder text for input field(s)."},"subtitle":{"type":"string","description":"Additional text providing more details about the input field(s)."},"title":{"type":"string","description":"The main text displayed for the input field(s)."}},"required":["id","isMultipleLine","isRequired"],"type":"object","additionalProperties":true},"ContentReceivedReplyMessage":{"description":"The message prompt to select options in the List Picker sections.\n\nReceived and reply messages schema.\n\nThe reply message after the user has selected the options from the List Picker.\n\nThe message prompt to fill out the form received.\n\nThe reply message after the user has filled out the form received.\n\nThe message displayed in the received message bubble.\n\nThe message displayed in the reply message bubble.\n\nThe message prompt to complete a payment transaction.\n\nThe reply message after the user has completed the payment transaction.\n\nA sign in prompt message for when the authenticate event is received.\n\nA reply message on authentication success.","properties":{"buttonLabel":{"type":"string","description":"Label text for the button."},"header":{"type":"string","description":"Text to show in the header."},"imageUrl":{"type":"string","description":"URL of an image."},"subtitle":{"type":"string","description":"Text to show in the subtitle."},"title":{"type":"string","description":"Text to show in the title."}},"type":"object","additionalProperties":true},"ContentListPickerItem":{"description":"Represents a selectable item in a List Picker.","properties":{"id":{"type":"string","description":"Unique identifier for the list picker item"},"imageUrl":{"type":"string","description":"URL of an image to be displayed alongside the item."},"subtitle":{"type":"string","description":"Additional text providing more details about the item."},"title":{"type":"string","description":"The main text displayed for the item."}},"required":["id","title"],"type":"object","additionalProperties":true},"ContentListPickerSection":{"description":"List Picker object for presenting a section of selectable items.","properties":{"items":{"items":{"$ref":"#/definitions/ContentListPickerItem"},"type":"array","description":"The choices/items available to choose from in the section."},"multipleSelection":{"type":"boolean","description":"Whether multiple items can be selected in this section."},"title":{"type":"string","description":"Required title for the section."}},"required":["items","multipleSelection","title"],"type":"object","additionalProperties":true},"ContentListPicker":{"description":"List Picker content.\n\nListPicker content.\n\nList Picker object for presenting multiple sections of selectable items.","properties":{"id":{"type":"string","description":"Optional unique identifier to help map component replies to form messages where multiple\nList Pickers can be present."},"receivedMessage":{"$ref":"#/definitions/ContentReceivedReplyMessage","description":"The message prompt to select options in the List Picker sections."},"replyMessage":{"$ref":"#/definitions/ContentReceivedReplyMessage","description":"The reply message after the user has selected the options from the List Picker."},"sections":{"items":{"$ref":"#/definitions/ContentListPickerSection"},"type":"array","description":"An array of sections in the List Picker."}},"required":["receivedMessage","replyMessage","sections"],"type":"object","additionalProperties":true},"ContentWheelPickerItem":{"description":"Represents a selectable item in a Wheel Picker","properties":{"id":{"type":"string","description":"Unique identifier for the wheel picker item"},"title":{"type":"string","description":"The main text displayed for the item."},"value":{"type":"string","description":"The value of the item"}},"required":["id","title"],"type":"object","additionalProperties":true},"ContentWheelPicker":{"description":"Wheel Picker content.\n\nWheel Picker object for representing single selection of selectable items.","properties":{"id":{"type":"string","description":"Optional unique identifier to help map component replies to form messages where multiple\nWheel Pickers can be present."},"items":{"items":{"$ref":"#/definitions/ContentWheelPickerItem"},"type":"array","description":"An array of options in the Wheel Picker."}},"required":["items"],"type":"object","additionalProperties":true},"FormPageComponent":{"description":"Form component element. Examples include: List Picker, Date Picker, Wheel Picker and\nInput text.","properties":{"datePicker":{"description":"Date Picker content.","$ref":"#/definitions/ContentDatePicker"},"formComponentType":{"$ref":"#/definitions/FormComponentType"},"input":{"description":"Input content.","$ref":"#/definitions/ContentInput"},"listPicker":{"description":"List Picker content.","$ref":"#/definitions/ContentListPicker"},"wheelPicker":{"description":"Wheel Picker content.","$ref":"#/definitions/ContentWheelPicker"}},"type":"object","additionalProperties":true},"FormPage":{"description":"Form page object.","properties":{"pageComponents":{"items":{"$ref":"#/definitions/FormPageComponent"},"type":"array","description":"Page components in this form page."},"subtitle":{"type":"string","description":"Text to show in the subtitle."},"title":{"type":"string","description":"Text to show in the title."}},"required":["subtitle","title"],"type":"object","additionalProperties":true},"ContentIntroduction":{"description":"The introduction component, used to give an intro into what the form entails\n\nIntroduction content object.","properties":{"buttonText":{"type":"string","description":"Text to show on the button."},"imageUrl":{"type":"string","description":"URL of an image."},"subtitle":{"type":"string","description":"Text to show in the subtitle."},"title":{"type":"string","description":"Text to show in the title."}},"required":["buttonText","title"],"type":"object","additionalProperties":true},"FormResponseContentType":{"enum":["ButtonResponse"],"type":"string"},"Ent":{"description":"The content object capturing component response from the original message.\n\nMessage content element for form responses","properties":{"buttonResponse":{"description":"Button response content.","$ref":"#/definitions/ContentButtonResponse"},"contentType":{"$ref":"#/definitions/FormResponseContentType"}},"type":"object","additionalProperties":true},"FormResponseComponent":{"description":"A response component from a form","properties":{"component":{"$ref":"#/definitions/Ent","description":"The content object capturing component response from the original message."},"id":{"type":"string","description":"The id of the component in the original message."}},"required":["component","id"],"type":"object","additionalProperties":true},"ContentForm":{"description":"Form content.\n\nForm content object.","properties":{"cannedResponseId":{"type":"string","description":"The id of the canned response which was used to create the form."},"formPages":{"items":{"$ref":"#/definitions/FormPage"},"type":"array","description":"Form pages"},"introduction":{"description":"The introduction component, used to give an intro into what the form entails","$ref":"#/definitions/ContentIntroduction"},"originatingMessageId":{"type":"string","description":"Reference to the ID of the original message."},"receivedMessage":{"description":"The message prompt to fill out the form received.","$ref":"#/definitions/ContentReceivedReplyMessage"},"replyMessage":{"description":"The reply message after the user has filled out the form received.","$ref":"#/definitions/ContentReceivedReplyMessage"},"response":{"items":{"$ref":"#/definitions/FormResponseComponent"},"type":"array","description":"Content of the payload included in the Form response."},"showSummary":{"type":"boolean","description":"Show summary at end of form submission."}},"required":["cannedResponseId"],"type":"object","additionalProperties":true},"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":{},"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":{"description":"The button actions (Deprecated).","$ref":"#/definitions/ContentActions"},"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":{"description":"Actions to be taken (Deprecated).","$ref":"#/definitions/ContentActions"},"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},"ContentInteractiveApplication":{"description":"InteractiveApplication content.\n\nInteractive message to send external applications to end users.","properties":{"name":{"type":"string","description":"The name of the message app."},"receivedMessage":{"description":"The message displayed in the received message bubble.","$ref":"#/definitions/ContentReceivedReplyMessage"},"replyMessage":{"description":"The message displayed in the reply message bubble.","$ref":"#/definitions/ContentReceivedReplyMessage"},"url":{"type":"string","description":"Contains the data that is sent to the message app."}},"required":["name","url"],"type":"object","additionalProperties":true},"ListItemType":{"enum":["ListItem","ListItemBig"],"type":"string"},"ListItemComponent":{"description":"An entry in a List template.","properties":{"actions":{"description":"The list item actions (Deprecated).","$ref":"#/definitions/ContentActions"},"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":{"description":"The type of list item to render.","$ref":"#/definitions/ListItemType"}},"type":"object","additionalProperties":true},"ListType":{"enum":["Selection","Vertical"],"type":"string"},"ContentList":{"description":"List content (Deprecated).\n\nList content object.","properties":{"actions":{"description":"The list actions (Deprecated).","$ref":"#/definitions/ContentActions"},"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":{"description":"The type of list this instance represents.","$ref":"#/definitions/ListType"},"submitLabel":{"type":"string","description":"Label for Submit button."},"title":{"type":"string","description":"Text to show in the title."}},"type":"object","additionalProperties":true},"AdditionalIDType":{"description":"Type of the Identifier","enum":["Deployment","IngestionRule","IngestionRuleVersion","PhoneNumber","Subject","Topic"],"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":{"enum":["Email","Opaque","Phone","Topic"],"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."},"externalContactDivisionId":{"type":"string","description":"The ID of the division the external contact is a member of. Must be set to '*' for the\nUnassigned division."},"externalContactId":{"type":"string","description":"The identifier of the external contact."},"externalOrganizationId":{"type":"string","description":"The identifier of the external organization the external contact is associated to."},"firstName":{"type":"string","description":"First name of the recipient."},"id":{"type":"string","description":"The recipient ID specific to the provider."},"idType":{"description":"The recipient ID type. This is used to indicate the format used for the ID.","$ref":"#/definitions/IDType"},"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},"ContentLineItem":{"description":"Item included in an order.","properties":{"description":{"type":"string","description":"Additional details about the item (e.g. the length of time to deliver for shipping\noptions)."},"identifier":{"type":"string","description":"A client defined value used to identify the item."},"name":{"type":"string","description":"The display name for the item."},"price":{"type":"number","format":"double","description":"The price of the item."}},"required":["name","price"],"type":"object","additionalProperties":true},"PaymentPlatform":{"description":"The payment platform being used (e.g. Apple Pay)","enum":["ApplePay"],"type":"string"},"ContactField":{"description":"The name of the contact field","enum":["Address","Email","Name","Phone"],"type":"string"},"ContentRequiredContactField":{"description":"Contact fields a merchant requires to complete a payment request.","properties":{"contactField":{"$ref":"#/definitions/ContactField","description":"The name of the contact field"}},"required":["contactField"],"type":"object","additionalProperties":true},"ContentPaymentRequest":{"description":"Payment request content.\n\nPayment Request object.","properties":{"countryCode":{"type":"string","description":"The merchant's two-letter ISO 3166 country code."},"currencyCode":{"type":"string","description":"The three-letter ISO 4217 currency code for the payment."},"lineItems":{"items":{"$ref":"#/definitions/ContentLineItem"},"type":"array","description":"The items that make up the order."},"orderTotal":{"type":"number","format":"double","description":"The total price of the order."},"paymentPlatform":{"$ref":"#/definitions/PaymentPlatform","description":"The payment platform being used (e.g. Apple Pay)"},"receivedMessage":{"description":"The message prompt to complete a payment transaction.","$ref":"#/definitions/ContentReceivedReplyMessage"},"replyMessage":{"description":"The reply message after the user has completed the payment transaction.","$ref":"#/definitions/ContentReceivedReplyMessage"},"requiredContactFields":{"items":{"$ref":"#/definitions/ContentRequiredContactField"},"type":"array","description":"Contact fields required to complete the order."},"shippingOptions":{"items":{"$ref":"#/definitions/ContentLineItem"},"type":"array","description":"The available shipping options."}},"required":["countryCode","currencyCode","orderTotal","paymentPlatform"],"type":"object","additionalProperties":true},"PaymentStatus":{"description":"The status of the payment transaction.","enum":["Completed","Failed"],"type":"string"},"ContentPaymentResponse":{"description":"Payment response content.\n\nPayment response object representing the status of a payment transaction.","properties":{"failureReason":{"type":"string","description":"The reason the payment request failed."},"originatingMessageId":{"type":"string","description":"Reference to the ID of the original payment request message this response is for."},"paymentStatus":{"$ref":"#/definitions/PaymentStatus","description":"The status of the payment transaction."}},"required":["originatingMessageId","paymentStatus"],"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},"DeviceType":{"description":"The device type used to send the push notification","enum":["Android","IOS"],"type":"string"},"PushFailedMessageReferences":{"description":"References of failed messages requiring a push.","properties":{"id":{"type":"string","description":"Unique ID of the message."}},"required":["id"],"type":"object","additionalProperties":true},"NotificationMessage":{"description":"Title and body localized according to deployment\n\nA Push notification message label.","properties":{"body":{"type":"string","description":"Body to use in the push for each language configured in the deploymentId"},"title":{"type":"string","description":"Title to use in the push for each language configured in the deploymentId"}},"required":["body","title"],"type":"object","additionalProperties":true},"Provider":{"description":"Type of the integration","enum":["APNS","FCM"],"type":"string"},"PushProviderIntegration":{"description":"push provider integrations details configured on the deployment\n\nA Push provider integration.","properties":{"id":{"type":"string","description":"Genesys Cloud Integration ID"},"provider":{"$ref":"#/definitions/Provider","description":"Type of the integration"}},"required":["id","provider"],"type":"object","additionalProperties":true},"ContentPush":{"description":"Push content.\n\nA Push object","properties":{"deviceToken":{"type":"string","description":"device token from the notification provider"},"deviceTokenId":{"type":"string","description":"Unique Id of the device token"},"deviceType":{"$ref":"#/definitions/DeviceType","description":"The device type used to send the push notification"},"expiration":{"type":"number","format":"double","description":"The time to live of the pushed message"},"failedMessages":{"items":{"$ref":"#/definitions/PushFailedMessageReferences"},"type":"array","description":"MessageIds failed to be sent which trigger the push event"},"notificationMessage":{"$ref":"#/definitions/NotificationMessage","description":"Title and body localized according to deployment"},"pushProviderIntegration":{"$ref":"#/definitions/PushProviderIntegration","description":"push provider integrations details configured on the deployment"}},"required":["deviceToken","deviceTokenId","deviceType","expiration","failedMessages","notificationMessage","pushProviderIntegration"],"type":"object","additionalProperties":true},"Action":{"enum":["Message"],"type":"string"},"ContentQuickReply":{"description":"Quick reply content.\n\nQuick reply object.","properties":{"action":{"description":"Specifies the type of action that is triggered upon clicking the quick reply.","$ref":"#/definitions/Action"},"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."},"summaryText":{"type":"string","description":"Summary of what the quick reply relates to."},"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","Comment","Haha","Like","Love","None","Pride","Rating","Sad","Share","Thankful","View","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},"Type":{"description":"Describes the Rich Link header type.","enum":["File","Image","Text","Video"],"type":"string"},"ContentRichLinkHeader":{"description":"Header for the Rich Link","properties":{"type":{"$ref":"#/definitions/Type","description":"Describes the Rich Link header type."},"value":{"type":"string","description":"Rich Link header value"}},"required":["type","value"],"type":"object","additionalProperties":true},"ContentRichLink":{"description":"A Rich Link button.\n\nA Rich Link","properties":{"footer":{"type":"string","description":"Footer text for the Rich Link."},"header":{"$ref":"#/definitions/ContentRichLinkHeader"},"text":{"type":"string","description":"Text for the body of the Rich Link."},"url":{"type":"string","description":"Url for the Rich Link."},"urlLabel":{"type":"string","description":"Text for the URL of the Rich Link."}},"required":["text","url"],"type":"object","additionalProperties":true},"ContentRoadsideAssistance":{"description":"Roadside Assistance content\n\nRoadside Assistance request object.","properties":{"isDevicePhoneNumber":{"type":"boolean","description":"If the user provided their own phone number"},"location":{"description":"User Location object","$ref":"#/definitions/ContentLocation"},"messageNumber":{"type":"number","format":"double","description":"The counter of the message"},"phoneNumber":{"type":"string","description":"Phone number the user provided"},"text":{"type":"string","description":"The Roadside Assistance message text"}},"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},"TemplateButtonType":{"description":"Specifies the type of the button.","enum":["PhoneNumber","QuickReply","Url"],"type":"string"},"NotificationTemplateButton":{"description":"Template button object","properties":{"index":{"type":"number","format":"double","description":"index of the button in the list."},"parameters":{"items":{"$ref":"#/definitions/NotificationTemplateParameter"},"type":"array","description":"Template parameters for placeholders in the button."},"payload":{"type":"string","description":"Content of the payload to be included in the quick reply response when the button is\npressed."},"phoneNumber":{"type":"string","description":"Button phone number."},"text":{"type":"string","description":"Button text message."},"type":{"$ref":"#/definitions/TemplateButtonType","description":"Specifies the type of the button."},"url":{"type":"string","description":"Button URL link."}},"required":["index","text","type"],"type":"object","additionalProperties":true},"HeaderType":{"description":"Template header type.","enum":["Media","Text"],"type":"string"},"Header":{"description":"The template header.\n\nTemplate header object.","properties":{"media":{"description":"Media template header image.","$ref":"#/definitions/ContentAttachment"},"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},"NotificationTemplateCard":{"description":"Card Template object.","properties":{"body":{"description":"The template body.","$ref":"#/definitions/NotificationTemplateBody"},"buttons":{"items":{},"type":"array","description":"Template buttons (max 2 for WhatsApp carousel cards)"},"header":{"$ref":"#/definitions/Header","description":"The template header."}},"required":["buttons","header"],"type":"object","additionalProperties":true},"NotificationTemplateCarousel":{"description":"The template carousel.\n\nCarousel Template object.","properties":{"cards":{"items":{"$ref":"#/definitions/NotificationTemplateCard"},"type":"array","description":"An array of template card objects."}},"required":["cards"],"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},"NotificationTemplateHeader":{"description":"The template header.\n\nTemplate header object.","properties":{"media":{"description":"Media template header image.","$ref":"#/definitions/ContentAttachment"},"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."},"buttons":{"items":{"$ref":"#/definitions/NotificationTemplateButton"},"type":"array","description":"Template buttons"},"carousel":{"description":"The template carousel.","$ref":"#/definitions/NotificationTemplateCarousel"},"footer":{"description":"The template footer.","$ref":"#/definitions/NotificationTemplateFooter"},"header":{"description":"The template header.","$ref":"#/definitions/NotificationTemplateHeader"},"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":{"description":"Attachment content.","$ref":"#/definitions/ContentAttachment"},"buttonResponse":{"description":"Button response content.","$ref":"#/definitions/ContentButtonResponse"},"card":{"description":"Card content","$ref":"#/definitions/ContentCard"},"carousel":{"description":"Carousel content","$ref":"#/definitions/ContentCarousel"},"contentType":{"$ref":"#/definitions/ContentType"},"datePicker":{"description":"DatePicker content.","$ref":"#/definitions/ContentDatePicker"},"form":{"description":"Form content.","$ref":"#/definitions/ContentForm"},"generic":{"description":"Generic content (Deprecated).","$ref":"#/definitions/ContentGeneric"},"interactiveApplication":{"description":"InteractiveApplication content.","$ref":"#/definitions/ContentInteractiveApplication"},"list":{"description":"List content (Deprecated).","$ref":"#/definitions/ContentList"},"listPicker":{"description":"ListPicker content.","$ref":"#/definitions/ContentListPicker"},"location":{"description":"Location content.","$ref":"#/definitions/ContentLocation"},"mention":{"description":"Mention content.","$ref":"#/definitions/MessagingRecipient"},"paymentRequest":{"description":"Payment request content.","$ref":"#/definitions/ContentPaymentRequest"},"paymentResponse":{"description":"Payment response content.","$ref":"#/definitions/ContentPaymentResponse"},"postback":{"description":"Structured message postback (Deprecated).","$ref":"#/definitions/ContentPostback"},"push":{"description":"Push content.","$ref":"#/definitions/ContentPush"},"quickReply":{"description":"Quick reply content.","$ref":"#/definitions/ContentQuickReply"},"quickReplyV2":{"description":"Quick reply V2 content.","$ref":"#/definitions/ContentQuickReplyV2"},"reactions":{"items":{"$ref":"#/definitions/ContentReaction"},"type":"array","description":"A set of reactions to a message."},"richLink":{"description":"A Rich Link button.","$ref":"#/definitions/ContentRichLink"},"roadsideAssistance":{"description":"Roadside Assistance content","$ref":"#/definitions/ContentRoadsideAssistance"},"story":{"description":"Ephemeral story content.","$ref":"#/definitions/ContentStory"},"template":{"description":"Template notification content.","$ref":"#/definitions/ContentNotificationTemplate"},"text":{"description":"Text content.","$ref":"#/definitions/ContentText"}},"required":["contentType"],"type":"object","additionalProperties":true},"EventType":{"description":"Describes the type of CoBrowse event.\n\nDescribes the type of Video 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/EventType","description":"Describes the type of CoBrowse event."}},"required":["type"],"type":"object","additionalProperties":true},"EventTypeEnum":{"enum":["CoBrowse","Presence","Reactions","Typing","Video"],"type":"string"},"EventPresenceType":{"description":"Describes the type of Presence event.","enum":["Authenticate","AuthenticateCancel","AuthenticateFailure","Clear","Disconnect","Join","SessionExpired","SignIn"],"type":"string"},"EventPresence":{"description":"Presence event.\n\nA Presence event.","properties":{"receivedMessage":{"description":"A sign in prompt message for when the authenticate event is received.","$ref":"#/definitions/ContentReceivedReplyMessage"},"replyMessage":{"description":"A reply message on authentication success.","$ref":"#/definitions/ContentReceivedReplyMessage"},"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},"EventVideo":{"description":"Video event.\n\nA Video event.","properties":{"jwt":{"type":"string","description":"The Video offering JWT token."},"offeringId":{"type":"string","description":"The Video offering ID."},"type":{"$ref":"#/definitions/EventType","description":"Describes the type of Video event."}},"required":["type"],"type":"object","additionalProperties":true},"MessageEvent":{"description":"Message event element.  Examples include: system messages, typing indicators, cobrowse\nofferings.","properties":{"coBrowse":{"description":"CoBrowse event.","$ref":"#/definitions/EventCoBrowse"},"eventType":{"$ref":"#/definitions/EventTypeEnum"},"presence":{"description":"Presence event.","$ref":"#/definitions/EventPresence"},"reactions":{"items":{"$ref":"#/definitions/ContentReaction"},"type":"array","description":"A list of reactions to a message."},"typing":{"description":"Typing event.","$ref":"#/definitions/EventTyping"},"video":{"description":"Video event.","$ref":"#/definitions/EventVideo"}},"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"},"tracingId":{"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"},"tracingId":{"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"},"tracingId":{"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"},"tracingId":{"type":"string"},"deploymentId":{"type":"string"},"data":{"$ref":"#/definitions/oAuthParams"},"resumeToken":{"type":"string"},"startNew":{"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"},"tracingId":{"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":{"tracingId":{"type":"string"},"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"},"durationSeconds":{"type":"number","format":"double"},"expirationDate":{"type":"number","format":"double"},"autoStarted":{"type":"boolean"}},"required":["connected"],"type":"object","additionalProperties":true},"PresignedUrlResponse":{"properties":{"tracingId":{"type":"string"},"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":{"tracingId":{"type":"string"},"attachmentId":{"type":"string"}},"required":["attachmentId"],"type":"object","additionalProperties":true},"JwtResponse":{"properties":{"tracingId":{"type":"string"},"jwt":{"type":"string"},"exp":{"type":"number","format":"double"}},"required":["jwt","exp"],"type":"object","additionalProperties":true},"GetConfigurationResponse":{"properties":{"tracingId":{"type":"string"},"allowedMedia":{"$ref":"#/definitions/AllowedMedia"},"blockedExtensions":{"items":{"type":"string"},"type":"array"},"maxCustomDataBytes":{"type":"number","format":"double"},"messageRoutingEnabled":{"type":"boolean"},"sessionDurationSeconds":{"type":"number","format":"double"}},"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"},"tracingId":{"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"},"tracingId":{"type":"string"},"retryAfter":{"type":"integer","format":"int32"}},"required":["name","message","errorCode","errorMessage","retryAfter"],"type":"object","additionalProperties":true},"ResumeTokenResponse":{"properties":{"tracingId":{"type":"string"},"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"},"tracingId":{"type":"string"}},"required":["name","message","errorCode","errorMessage"],"type":"object","additionalProperties":true},"BaseResponse":{"properties":{"tracingId":{"type":"string"}},"type":"object","additionalProperties":true},"ResponseMessage":{"type":"object"},"Direction":{"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":{"tracingId":{"type":"string"},"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":{"tracingId":{"type":"string"},"attachmentId":{"type":"string"},"downloadUrl":{"type":"string"},"timestamp":{"type":"string"}},"required":["attachmentId","downloadUrl","timestamp"],"type":"object","additionalProperties":true},"UploadFailureEvent":{"properties":{"tracingId":{"type":"string"},"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"},"datePicker":{"$ref":"#/definitions/ContentDatePicker"},"listPicker":{"$ref":"#/definitions/ContentListPicker"},"quickReply":{"$ref":"#/definitions/ContentQuickReply"},"text":{"$ref":"#/definitions/ContentText"},"quickReplyV2":{"$ref":"#/definitions/ContentQuickReplyV2"}},"required":["contentType"],"type":"object","additionalProperties":true},"CleanMessageEvent":{"properties":{"coBrowse":{"description":"CoBrowse event.","$ref":"#/definitions/EventCoBrowse"},"eventType":{"$ref":"#/definitions/EventTypeEnum"},"presence":{"description":"Presence event.","$ref":"#/definitions/EventPresence"},"reactions":{"items":{"$ref":"#/definitions/ContentReaction"},"type":"array","description":"A list of reactions to a message."},"typing":{"description":"Typing event.","$ref":"#/definitions/EventTyping"},"video":{"description":"Video event.","$ref":"#/definitions/EventVideo"}},"required":["eventType"],"type":"object","additionalProperties":true},"OriginatingEntity":{"enum":["Bot","Human"],"type":"string"},"CleanMessage":{"properties":{"tracingId":{"type":"string"},"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":{"tracingId":{"type":"string"},"reasonCode":{"type":"string"}},"type":"object","additionalProperties":true},"LogoutEvent":{"properties":{"tracingId":{"type":"string"}},"type":"object","additionalProperties":true},"SessionExpiredEvent":{"properties":{"tracingId":{"type":"string"}},"type":"object","additionalProperties":true},"SessionClearedEvent":{"properties":{"tracingId":{"type":"string"}},"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"},"tracingId":{"type":"string"}},"required":["type","class","code","body"],"type":"object","additionalProperties":true}},"paths":{},"responses":{},"schemes":[],"securityDefinitions":{},"basePath":"/"}