{"paths":{"/api/v1/assets/{id}":{"get":{"tags":["Assets"],"summary":"Fetch Asset","description":"Fetch an existing Asset within Quiq","operationId":"Fetch Asset","parameters":[{"name":"id","in":"path","description":"The ID of the Asset to be fetched","required":true,"type":"string"}],"responses":{"303":{"description":"The redirect response to the Asset"}}}},"/api/v1/assets/uploads/prepare":{"post":{"tags":["Assets"],"summary":"Prepare Upload","description":"Prepare to create an Asset in Quiq","operationId":"Prepare Upload","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicUploadPrepareRequest","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"200":{"description":"Response object for preparing to create an Asset in Quiq","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicUploadPrepareResponse","exampleSetFlag":false},"exampleSetFlag":false}}}}}},"/api/v1/assets/uploads/promote":{"post":{"tags":["Assets"],"summary":"Promote Upload","description":"Promote an upload into a Quiq Asset","operationId":"Promote Upload","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicUploadPromote","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"204":{}}}},"/api/v1/messaging/agents-available":{"get":{"tags":["Messaging"],"summary":"Get Agent Availability","description":"Check to see if agents are available\n #### High Volume API:\n This API can be called with a high volume of requests. Thus, you are **required to call it\n through https://{tenant}.quiq-api.com**. This allows for the API to be served in a distributed manner that will\n provide the highest performance and scalability benefits to you and your end users.\n        ","operationId":"Get Agent Availability","parameters":[{"name":"contactPoint","in":"query","description":"The contact point","required":true,"schema":{"description":"The contact point","$ref":"#/components/schemas/ContactPointReference","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},{"name":"platform","in":"query","description":"The messaging platform","required":true,"schema":{"type":"string","description":"The messaging platform","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["SMS","Facebook","Kik","Chat","Twitter","AppleMessages","GoogleRBM","GoogleMessages","WeChat","WhatsApp","Instagram","Voice"]}}],"responses":{"200":{"description":"The result of the agent availability request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentAvailabilityResult","exampleSetFlag":false},"exampleSetFlag":false}}}}}},"/api/v1/messaging/queues/{queue}/info":{"get":{"tags":["Messaging"],"summary":"Get queue info","description":"Check info about a queue","operationId":"Get queue info","parameters":[{"name":"Authorization","in":"header","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","required":false,"schema":{"type":"string","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},{"name":"queue","in":"path","description":"The queue to fetch info for","required":true,"schema":{"description":"The queue to fetch info for","$ref":"#/components/schemas/QueueReference","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}}],"responses":{"200":{"description":"The result of the queue info request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueInfoResult","exampleSetFlag":false},"exampleSetFlag":false}}}}}},"/api/v1/messaging/agents-available-cross-platform":{"get":{"tags":["Messaging"],"summary":"Get Agent Availability Across Platforms","description":"Check to see if agents are available across multiple platforms\n #### High Volume API:\n This API can be called with a high volume of requests. Thus, you are **required to call it\n through https://{tenant}.quiq-api.com**. This allows for the API to be served in a distributed manner that will\n provide the highest performance and scalability benefits to you and your end users.\n        ","operationId":"Get Agent Availability Across Platforms","parameters":[{"name":"contactPoint","in":"query","description":"The contact point","required":true,"schema":{"description":"The contact point","$ref":"#/components/schemas/ContactPointReference","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},{"name":"platforms","in":"query","description":"The messaging platforms to check, comma separated","required":true,"schema":{"type":"string","description":"The messaging platforms to check, comma separated","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}}],"responses":{"200":{"description":"The result of the agent availability request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentAvailabilityCrossPlatformResults","exampleSetFlag":false},"exampleSetFlag":false}}}}}},"/api/v1/agent-hooks/pong":{"post":{"tags":["Bot API"],"summary":"Pong","description":"If your application receives an agent hook with \"ping\" set to True, you must post to this endpoint within 60 seconds\n    ","operationId":"Pong","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PongRequest","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"204":{}}}},"/api/v1/messaging/custom-interaction":{"get":{"tags":["Messaging"],"summary":"Gets the custom interaction message","description":"Retrieves the custom interaction message","operationId":"Gets the custom interaction message","parameters":[{"name":"X-Quiq-Access-Token","in":"header","description":"The payload","required":true,"schema":{"type":"string","description":"The payload","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}}],"responses":{"200":{"description":"The metadata the message wrapper","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicMessageWrapper Metadata","exampleSetFlag":false},"exampleSetFlag":false}}}}},"post":{"tags":["Messaging"],"summary":"Replies to the custom interaction message","description":"Replies to the custom interaction message","operationId":"Replies to the custom interaction message","parameters":[{"name":"X-Quiq-Access-Token","in":"header","description":"The payload","required":true,"schema":{"type":"string","description":"The payload","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},{"name":"X-Quiq-Custom-Interaction-Key","in":"header","description":"The custom interaction key","required":true,"schema":{"type":"string","description":"The custom interaction key","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostCustomInteractionRequestDef","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"200":{"description":"The post message result definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostMessageResultMetadata","exampleSetFlag":false},"exampleSetFlag":false}}}}}},"/api/v1/messaging/platforms/{platform}/start-conversation":{"post":{"tags":["Messaging"],"summary":"Start conversation","description":"Allows you to start a conversation with a customer. The conversation will be visible to agents and routed if necessary. In addition to starting proactive conversations, you can use this API to transfer ongoing customer interactions from another system (e.g. IVR) into Quiq messaging. This API will return an error if a conversation is already in progress, and the existingConversationId will be returned in the error data.","operationId":"Start conversation","parameters":[{"name":"Authorization","in":"header","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","required":false,"schema":{"type":"string","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},{"name":"platform","in":"path","description":"The messaging platform on which to start the conversation. Note: you cannot call Start conversation on WhatsApp. To begin interactions with WhatsApp users, please use the Notify API instead.","required":false,"schema":{"type":"string","description":"The messaging platform on which to start the conversation. Note: you cannot call Start conversation on WhatsApp. To begin interactions with WhatsApp users, please use the Notify API instead.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["SMS","Chat","GoogleRBM"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartConversationRequest","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"200":{"description":"A response object for starting a conversation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartConversationResponse","exampleSetFlag":false},"exampleSetFlag":false}}}}}},"/api/v1/messaging/start-conversation":{"post":{"tags":["Messaging"],"summary":"Start a conversation (cross platform)","description":"Allows you to start a conversation with a customer. The conversation will be visible to agents and routed if necessary. You can provide a list of preferential platforms with pairs occurring earlier in the list receiving preference over those later in the list. The message will be sent via the first platform the customer is capable of receiving the message on. This API will return an error if a conversation is already in progress, and the existingConversationId will be returned in the error data. Note: you cannot call Start conversation on WhatsApp. To begin interactions with WhatsApp users, please use the Notify API instead.","operationId":"Start a conversation (cross platform)","parameters":[{"name":"Authorization","in":"header","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","required":false,"schema":{"type":"string","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartRichConversationRequest","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"200":{"description":"A response object for starting a conversation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartConversationResponse","exampleSetFlag":false},"exampleSetFlag":false}}}}}},"/api/v1/messaging/conversations/{conversationId}/send-message":{"post":{"tags":["Bot API"],"summary":"Send Message","description":"Allows you to send a conversational message to a customer","operationId":"Send Message","parameters":[{"name":"Authorization","in":"header","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","required":false,"schema":{"type":"string","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},{"name":"conversationId","in":"path","description":"The conversation id on which to send the message","required":false,"schema":{"maxLength":36,"type":"string","description":"The conversation id on which to send the message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessageRequest","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"204":{}}}},"/api/v1/messaging/conversations/{conversationId}/send-messages":{"post":{"tags":["Bot API"],"summary":"Send multiple messages on 1 conversation","description":"Allows you to send multiple messages on one conversation.","operationId":"Send multiple messages on 1 conversation","parameters":[{"name":"Authorization","in":"header","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","required":false,"schema":{"type":"string","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},{"name":"conversationId","in":"path","description":"The conversation id on which to send the message","required":false,"schema":{"maxLength":36,"type":"string","description":"The conversation id on which to send the message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessagesRequest","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"200":{"description":"Response object for public send messages apis.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessagesResponse","exampleSetFlag":false},"exampleSetFlag":false}}}}}},"/api/v2/messaging/conversations/{conversationId}/send-message":{"post":{"tags":["Bot API"],"summary":"Send Message v2","description":"Allows you to send a conversational message to a customer. Returns a response body with message fields.","operationId":"Send Message v2","parameters":[{"name":"Authorization","in":"header","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","required":false,"schema":{"type":"string","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},{"name":"conversationId","in":"path","description":"The conversation id on which to send the message","required":false,"schema":{"maxLength":36,"type":"string","description":"The conversation id on which to send the message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessageRequest","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"200":{"description":"Response object for public send message apis.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessageResponse","exampleSetFlag":false},"exampleSetFlag":false}}}}}},"/api/v1/messaging/conversations/{conversationId}/acknowledge":{"post":{"tags":["Bot API"],"summary":"Acknowledge a conversation state update","description":"Call this API when using blocking agent hooks to acknowledge that you have received the last state update","operationId":"Acknowledge a conversation state update","parameters":[{"name":"Authorization","in":"header","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","required":false,"schema":{"type":"string","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},{"name":"conversationId","in":"path","description":"The conversation to acknowledge","required":false,"schema":{"maxLength":36,"type":"string","description":"The conversation to acknowledge","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcknowledgeRequest","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"204":{}}}},"/api/v1/messaging/conversations/{conversationId}/close":{"post":{"tags":["Bot API"],"summary":"Close a conversation","description":"Call this API to close a conversation of which you're the owner","operationId":"Close a conversation","parameters":[{"name":"Authorization","in":"header","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","required":false,"schema":{"type":"string","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},{"name":"conversationId","in":"path","description":"The conversation to close","required":false,"schema":{"maxLength":36,"type":"string","description":"The conversation to close","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}}],"responses":{"204":{}}}},"/api/v1/messaging/conversations/{conversationId}/mark-inactive":{"post":{"tags":["Bot API"],"summary":"Mark a conversation inactive","description":"Use this API to mark a conversation inactive. Inactive conversations are automatically closed after inactivity by a system timer","operationId":"Mark a conversation inactive","parameters":[{"name":"Authorization","in":"header","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","required":false,"schema":{"type":"string","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},{"name":"conversationId","in":"path","description":"The conversation to mark inactive","required":false,"schema":{"maxLength":36,"type":"string","description":"The conversation to mark inactive","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}}],"responses":{"204":{}}}},"/api/v1/messaging/conversations/{conversationId}/send-to-queue":{"post":{"tags":["Bot API"],"summary":"Send a conversation to a queue","description":"Send this conversation to a queue. This is useful when you can't satisfy the customer's needs or are overloaded","operationId":"Send a conversation to a queue","parameters":[{"name":"Authorization","in":"header","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","required":false,"schema":{"type":"string","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},{"name":"conversationId","in":"path","description":"The conversation to send","required":false,"schema":{"maxLength":36,"type":"string","description":"The conversation to send","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendConversationToQueueRequest","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"204":{}}}},"/api/v1/messaging/conversations/{conversationId}/accept":{"post":{"tags":["Bot API"],"summary":"Accept a conversation","description":"Accept a conversation that you're currently invited to","operationId":"Accept a conversation","parameters":[{"name":"Authorization","in":"header","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","required":false,"schema":{"type":"string","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},{"name":"conversationId","in":"path","description":"The conversation to accept","required":false,"schema":{"maxLength":36,"type":"string","description":"The conversation to accept","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}}],"responses":{"204":{}}}},"/api/v1/messaging/conversations/{conversationId}/reject":{"post":{"tags":["Bot API"],"summary":"Reject a conversation","description":"Reject a conversation that you're currently invited to","operationId":"Reject a conversation","parameters":[{"name":"Authorization","in":"header","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","required":false,"schema":{"type":"string","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},{"name":"conversationId","in":"path","description":"The conversation to reject","required":false,"schema":{"maxLength":36,"type":"string","description":"The conversation to reject","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}}],"responses":{"204":{}}}},"/api/v1/messaging/conversations/{conversationId}/update-fields":{"post":{"tags":["Bot API"],"summary":"Update fields on a conversation","description":"Update both custom or standard fields on a given conversation","operationId":"Update fields on a conversation","parameters":[{"name":"Authorization","in":"header","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","required":false,"schema":{"type":"string","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},{"name":"conversationId","in":"path","description":"The conversation to update fields on","required":false,"schema":{"maxLength":36,"type":"string","description":"The conversation to update fields on","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateConversationFields","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"200":{"description":"The response object for updating fields on a conversation when allowPartial is true","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateConversationFieldsResponse","exampleSetFlag":false},"exampleSetFlag":false}}}}}},"/api/v1/messaging/conversations/{conversationId}/send-to-user":{"post":{"tags":["Bot API"],"summary":"Send a conversation to a user","description":"Assigns a conversation to the given user. If the user is offline then the conversation is added to the provided queue","operationId":"Send a conversation to a user","parameters":[{"name":"Authorization","in":"header","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","required":false,"schema":{"type":"string","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},{"name":"conversationId","in":"path","description":"The conversation to assign to the assignee","required":false,"schema":{"maxLength":36,"type":"string","description":"The conversation to assign to the assignee","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendToUserRequestMeta","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"204":{}}}},"/api/v1/messaging/conversations/{conversationId}/accept-transfer":{"post":{"tags":["Bot API"],"summary":"Accept a conversation transfer","description":"Accepts a conversation that has been transferred to an agent","operationId":"Accept a conversation transfer","parameters":[{"name":"Authorization","in":"header","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","required":false,"schema":{"type":"string","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},{"name":"conversationId","in":"path","description":"The conversation to whose transfer will be accepted","required":false,"schema":{"maxLength":36,"type":"string","description":"The conversation to whose transfer will be accepted","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}}],"responses":{"204":{}}}},"/api/v1/messaging/conversations/{conversationId}/reject-transfer":{"post":{"tags":["Bot API"],"summary":"Reject a conversation transfer","description":"Rejects a conversation that has been transferred to an agent","operationId":"Reject a conversation transfer","parameters":[{"name":"Authorization","in":"header","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","required":false,"schema":{"type":"string","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},{"name":"conversationId","in":"path","description":"The conversation to whose transfer will be accepted","required":false,"schema":{"maxLength":36,"type":"string","description":"The conversation to whose transfer will be accepted","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}}],"responses":{"204":{}}}},"/api/v1/messaging/conversation/{conversationId}":{"get":{"tags":["Messaging"],"summary":"Get a conversation","description":"Retrieve a conversation record","operationId":"Get a conversation","parameters":[{"name":"Authorization","in":"header","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","required":false,"schema":{"type":"string","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},{"name":"conversationId","in":"path","description":"The conversation to fetch","required":false,"schema":{"maxLength":36,"type":"string","description":"The conversation to fetch","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}}],"responses":{"200":{"description":"A Conversation Object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Conversation","exampleSetFlag":false},"exampleSetFlag":false}}}}}},"/api/v1/messaging/conversations/{conversationId}/send-message-map":{"post":{"tags":["Bot API"],"summary":"Send Message Map","description":"Allows you to send a message map to a customer","operationId":"Send Message Map","parameters":[{"name":"Authorization","in":"header","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","required":false,"schema":{"type":"string","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},{"name":"conversationId","in":"path","description":"The conversation id on which to send the message","required":false,"schema":{"maxLength":36,"type":"string","description":"The conversation id on which to send the message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessageMapRequest","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"204":{}}}},"/api/v1/messaging/conversations/{conversationId}/send-message-maps":{"post":{"tags":["Bot API"],"summary":"Send Message Maps","description":"Allows your to send up to 10 message maps to a customer. Returns a response body with message fields","operationId":"Send Message Maps","parameters":[{"name":"Authorization","in":"header","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","required":false,"schema":{"type":"string","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},{"name":"conversationId","in":"path","description":"The conversation id on which to send the message","required":false,"schema":{"maxLength":36,"type":"string","description":"The conversation id on which to send the message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessageMapsRequest","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"200":{"description":"Response object for public send messages apis.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessagesResponse","exampleSetFlag":false},"exampleSetFlag":false}}}}}},"/api/v2/messaging/conversations/{conversationId}/send-message-map":{"post":{"tags":["Bot API"],"summary":"Send Message Map v2","description":"Allows you to send a message map to a customer. Returns a response body with message fields.","operationId":"Send Message Map v2","parameters":[{"name":"Authorization","in":"header","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","required":false,"schema":{"type":"string","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},{"name":"conversationId","in":"path","description":"The conversation id on which to send the message","required":false,"schema":{"maxLength":36,"type":"string","description":"The conversation id on which to send the message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessageMapRequest","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"200":{"description":"Response object for public send message apis.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMessageResponse","exampleSetFlag":false},"exampleSetFlag":false}}}}}},"/api/v1/messaging/conversation/most-recent":{"post":{"tags":["Messaging"],"summary":"Get Most Recent Conversation","description":"Allows you to get the most recent conversation based on the handles","operationId":"Get Most Recent Conversation","parameters":[{"name":"Authorization","in":"header","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","required":false,"schema":{"type":"string","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FindLastConversationRequest","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"200":{"description":"A Conversation Object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Conversation","exampleSetFlag":false},"exampleSetFlag":false}}}}}},"/api/v1/messaging/capabilities/rcs":{"get":{"tags":["Messaging"],"summary":"RCS Capabilities Check","description":"Determines if the number in the request is RCS enabled","operationId":"RCS Capabilities Check","parameters":[{"name":"contactPoint","in":"query","description":"The Contact Point","required":true,"schema":{"type":"string","description":"The Contact Point","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},{"name":"phoneNumber","in":"query","description":"The Phone Number (+15554445555 format)","required":true,"schema":{"type":"string","description":"The Phone Number (+15554445555 format)","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}}],"responses":{"200":{"description":"The capabilities check definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CapabilitiesCheckResponseMetadatas","exampleSetFlag":false},"exampleSetFlag":false}}}}}},"/api/v1/messaging/stored-context":{"post":{"tags":["Messaging"],"summary":"Stored context","description":"Allows you to post in context (ex. CRM ticket ids) to receive an identifier. This identifier can be utilized to reference this context later.","operationId":"Stored context","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoredContextRequest","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"200":{"description":"A global reference key to this stored data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoredContextRequestResponse","exampleSetFlag":false},"exampleSetFlag":false}}}}}},"/api/v1/messaging/conversations/{conversationId}/typing":{"post":{"tags":["Messaging"],"summary":"Toggle typing indicator on a conversation","description":"Toggle typing indicator on a conversation","operationId":"Toggle typing indicator on a conversation","parameters":[{"name":"conversationId","in":"path","description":"Id of the conversation","required":false,"schema":{"type":"string","description":"Id of the conversation","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConversationTypingRequest","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"204":{}}}},"/api/v1/messaging/conversations/{conversationId}/thinking":{"post":{"tags":["Messaging"],"summary":"Send thinking messages on a conversation","description":"Shows short, transient status lines (for example \"Searching for hotels in Paris\") in the customer's chat window while a response is being generated. They replace each other, are never stored in the transcript, and are cleared by thinking=false, by a new sequence, or by a real message. Chat only. The caller must be a member of the conversation.","operationId":"Send thinking messages on a conversation","parameters":[{"name":"conversationId","in":"path","description":"Id of the conversation","required":false,"schema":{"type":"string","description":"Id of the conversation","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentThinkingRequest","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"200":{"description":"Whether the thinking message reached a chat window, and why not if it did not","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentThinkingResponse","exampleSetFlag":false},"exampleSetFlag":false}}}}}},"/api/v1/messaging/least-loaded-handle":{"get":{"tags":["Messaging"],"summary":"Get least loaded handle","description":"Get the least loaded handle for a given contact point and messaging platform\n #### High Volume API:\n This API can be called with a high volume of requests. Thus, you are **required to call it\n through https://{tenant}.quiq-api.com**. This allows for the API to be served in a distributed manner that will\n provide the highest performance and scalability benefits to you and your end users.\n        ","operationId":"Get least loaded handle","parameters":[{"name":"contactPoint","in":"query","description":"The contact point on which to find the least loaded handle","required":true,"schema":{"description":"The contact point on which to find the least loaded handle","$ref":"#/components/schemas/ContactPointReference","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},{"name":"platform","in":"query","description":"The messaging platform on which to find the least loaded handle","required":true,"schema":{"type":"string","description":"The messaging platform on which to find the least loaded handle","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["SMS"]}}],"responses":{"200":{"description":"A response object for getting the least loaded handle","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeastLoadedHandleResponse","exampleSetFlag":false},"exampleSetFlag":false}}}}}},"/api/v1/ai-resources/dataset/{datasetId}/sync":{"post":{"tags":["AI Studio"],"summary":"Sync Dataset","description":"Synchronize a dataset's contents with an external data source. Data must be in a supported AI Resources format - currently either CSV or newline-delimited JSON","operationId":"Sync Dataset","parameters":[{"name":"datasetId","in":"path","description":"The id of the dataset to sync","required":true,"schema":{"type":"string","description":"The id of the dataset to sync","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncDatasetRequest","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"204":{}}}},"/api/v1/ai-resources/search":{"post":{"tags":["AI Studio"],"summary":"Search","description":"Search AI resources for relevant documents","operationId":"Search","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceSearchActionRequest","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"200":{"description":"Resource search action response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceSearchActionResponse","exampleSetFlag":false},"exampleSetFlag":false}}}}}},"/api/v1/messaging/notify":{"post":{"tags":["Messaging"],"summary":"Notify","description":"Allows you to send outbound notifications. This API allows the notification to be expressed across multiple platforms (e.g. Google RBM, SMS) and will send to the preferred platform. Any replies will become conversations. Deliverability results can be tracked by the returned message ids. Care must be taken to not violate the TCPA. Go [here](https://knowledge.quiq.com/docs/outbound-messaging-best-practices) for more information.","operationId":"Notify","parameters":[{"name":"Authorization","in":"header","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","required":false,"schema":{"type":"string","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},{"name":"allowMultipleSegments","in":"query","description":"Whether or not to allow sending a given message as multiple message segments. If false or unspecified, any messages longer than one segment will fail with error code 24009.","required":false,"schema":{"type":"boolean","description":"Whether or not to allow sending a given message as multiple message segments. If false or unspecified, any messages longer than one segment will fail with error code 24009.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotifyRequest","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"200":{"description":"A response object for sending multiple notifications","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotifyResponse","exampleSetFlag":false},"exampleSetFlag":false}}}}}},"/api/v1/messaging/platforms/{platform}/send-notification":{"post":{"tags":["Messaging"],"summary":"Send notification","description":"Allows you to send an outbound notification to a customer. Note that unlike a conversation, a notification is not visible to agents or routed in any way. A message is simply sent to the customer. If the customer responds, their response will become a conversation. Care must be taken to not violate TCPA. Go [here](https://knowledge.quiq.com/docs/outbound-messaging-best-practices) for more information.","operationId":"Send notification","parameters":[{"name":"Authorization","in":"header","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","required":false,"schema":{"type":"string","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},{"name":"platform","in":"path","description":"The messaging platform on which to send the notification","required":false,"schema":{"type":"string","description":"The messaging platform on which to send the notification","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["SMS"]}},{"name":"allowMultipleSegments","in":"query","description":"Whether or not to allow sending a given message as multiple message segments. If false, you will be unable to send messages longer than one segment.","required":false,"schema":{"type":"boolean","description":"Whether or not to allow sending a given message as multiple message segments. If false, you will be unable to send messages longer than one segment.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendNotificationRequest","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"200":{"description":"A response object for sending a notification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendNotificationResponse","exampleSetFlag":false},"exampleSetFlag":false}}}}}},"/api/v1/messaging/platforms/{platform}/send-notifications":{"post":{"tags":["Messaging"],"summary":"Send notifications","description":"Allows you to send outbound notifications to multiple customers. Any customer replies will become conversations. Deliverability results can be tracked by the returned message ids. Care must be taken to not violate TCPA. Go [here](https://knowledge.quiq.com/docs/outbound-messaging-best-practices) for more information.","operationId":"Send notifications","parameters":[{"name":"Authorization","in":"header","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","required":false,"schema":{"type":"string","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},{"name":"platform","in":"path","description":"The messaging platform on which to send the notification","required":false,"schema":{"type":"string","description":"The messaging platform on which to send the notification","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["SMS"]}},{"name":"allowMultipleSegments","in":"query","description":"Whether or not to allow sending a given message as multiple message segments. If false, you will be unable to send messages longer than one segment.","required":false,"schema":{"type":"boolean","description":"Whether or not to allow sending a given message as multiple message segments. If false, you will be unable to send messages longer than one segment.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendNotificationsRequest","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"200":{"description":"A response object for sending multiple notifications","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendNotificationsResponse","exampleSetFlag":false},"exampleSetFlag":false}}}}}},"/api/v1/messaging/platforms/{platform}/message-segments":{"post":{"tags":["Messaging"],"summary":"Count message segments","description":"Returns the number of segments the supplied text will be broken into when sent. For SMS this depends on emoji and special character usage. A count above one means the message cannot be sent with allowMultipleSegments set to false. This endpoint only measures the text; no message is sent.","operationId":"Count message segments","parameters":[{"name":"Authorization","in":"header","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","required":false,"schema":{"type":"string","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},{"name":"platform","in":"path","description":"The messaging platform the message would be sent on","required":false,"schema":{"type":"string","description":"The messaging platform the message would be sent on","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["SMS"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageSegmentsRequest","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"200":{"description":"A response object describing how a message will be segmented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageSegmentsResponse","exampleSetFlag":false},"exampleSetFlag":false}}}}}},"/api/v1/messaging/platforms/{platform}/notifications-deliverability":{"post":{"tags":["Messaging"],"summary":"Check deliverability","description":" <h3><span style=\"color:red\">NOTE: This is a beta API</span></h3> Check the deliverability results of multiple notifications","operationId":"Check deliverability","parameters":[{"name":"Authorization","in":"header","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","required":false,"schema":{"type":"string","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},{"name":"platform","in":"path","description":"The platform the notifications will be delivered on","required":false,"schema":{"description":"The platform the notifications will be delivered on","$ref":"#/components/schemas/MessagePlatform","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetNotificationsDeliverabilityRequest","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"200":{"description":"A response object for a deliverability check of multiple notifications","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckDeliverabilityResponse","exampleSetFlag":false},"exampleSetFlag":false}}}}}},"/api/v1/voice/register-call":{"post":{"tags":["Voice APIs"],"summary":"Register Call","description":"Notify Quiq that a call from a specific number is coming in - if this is not called prior to a customer call, Quiq will reject the call with a busy signal.","operationId":"Register Call","parameters":[{"name":"Authorization","in":"header","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","required":false,"schema":{"type":"string","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterInboundCallRequest","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"200":{"description":"RegisterInboundCallResponse","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterInboundCallResponse","exampleSetFlag":false},"exampleSetFlag":false}}}}}},"/api/v1/voice/fetch-call":{"post":{"tags":["Voice APIs"],"summary":"Fetch Call","description":"Query to find out if a call was created in Quiq for a customer number and Quiq number pair within a certain amount of time.","operationId":"Fetch Call","parameters":[{"name":"Authorization","in":"header","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","required":false,"schema":{"type":"string","description":"Should contain the identity and secret of a valid app token generated through the Quiq admin interface and be of the form <app_id>:<app_secret>. This auth mechanism should only be used by server-side integrations.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchCallRequest","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"200":{"description":"FetchCallResponse","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchCallResponse","exampleSetFlag":false},"exampleSetFlag":false}}}}}}},"openapi":"3.1.0","info":{"title":"Quiq API","description":"## Introduction\n\nQuiq provides integration frameworks for each of its product offerings. Frameworks consist of REST APIs and complementary webhooks.\nThe Messaging Framework facilitates integrations such as IVR handoff, outbound notifications, data synchronization and bots.\nMatters such as encryption and authentication are handled consistently across frameworks.\n## REST APIs Overview\nSSL is required for all API requests. APIs utilize JSON unless otherwise noted.\n### Authentication\nQuiq’s REST APIs are built on two forms of authentication: basic authentication and access tokens. Basic authentication should only be used for server-side integrations,\nwhereas access tokens are suitable for client-side integrations such as browser & mobile apps. Quiq also provides several fully public APIs that don’t require any authentication.\n\n#### Basic Authentication\nQuiq’s basic authentication mechanism is built on top of Client Apps which are administered through the Quiq Admin interface.\nClient apps are tied to a user account and inherit their roles and permissions from that account. Each app is assigned an ID and secret as well as a label.\nThe ID and secret serve as the username and password in the basic auth header. Note that basic authentication should only be used in secure server-side environments.\n\n\n### API Versioning and Backwards Compatibility\nAll documentation reflects the current version of Quiq's API’s. Version information is identified in the path of a given API.\nFor example: /api/v1/messaging. Quiq will not make breaking changes to a given contract without bumping the major version\nnumber referenced in an API's path. However, we will make additive “non-breaking” changes such as adding an additional\nproperty to a contract.\n\n### Cross-Origin Resource Sharing (CORS)\nQuiq's REST APIs support Cross-Origin Resource Sharing (CORS) implemented in compliance with  [W3C spec](https://www.w3.org/TR/cors/).\nThis facilitates cross-domain communication from the browser. Administrators can set what domains are allowed to\ncommunicate with their site within the Quiq Admin interface.\n\n### Response Codes and Error Handling\nQuiq’s REST APIs utilize standard HTTP response codes. When a 4xx response code is returned, there will be a response body with a media-type of application/json and the following structure:\n```\n{\n  “status”: 400,\n  “code”:  3001,\n  “message”: “The customer is engaged in a conversation with another agent”\n}\n```\n\n### Outbound Message Error Codes\nWhen Quiq is unable to deliver an outbound message or notification, the failure is reported with one of the\nfollowing error codes. These appear in the ```errorCode``` field of deliverability results and deliverability\nstatus webhooks.\n\n|Code|Error|Description|\n|-|-|-|\n|24002|INVALID_DESTINATION|The destination you are trying to reach is not valid or a landline.|\n|24004|BLOCKED|Message failed to send. The customer may have sent \"STOP\".|\n|24005|SENDING_OWN_CONTACT_POINT|An attempt to send to your own number.|\n|24006|LOAD_ERROR|The destination messaging platform is currently under high load. Please try again later.|\n|24007|CONFIGURATION_ERROR|An error occurred due to invalid system configuration information.|\n|24008|DELIVERY_ERROR|The message recipient is unreachable or a landline.|\n|24009|MESSAGE_TOO_LONG|The message was too long.|\n|24010|UNKNOWN_RETRYABLE_ERROR|An unknown error occurred. Recommendation is to retry the message.|\n|24011|SPAM|There was an error sending this message, it has been blocked by a carrier.|\n|24012|MEDIA_TOO_LARGE|The media you are trying to send violates a size limit.|\n|24013|INVALID_FORMAT|The message was not formatted correctly.|\n|24014|CANT_RESOLVE_PLATFORM|Quiq was unable to find a messaging platform for this customer. Confirm your topic and precedent settings.|\n|24015|LANDLINE|The destination handset is a landline.|\n|24016|DEMO_LIMIT_EXCEEDED|The outbound message limit for this demo tenant has been exceeded.|\n|24017|RESPONSE_WINDOW_CLOSED|The response window was closed on this platform. Typically used by WhatsApp and other richer channels.|\n|24018|MESSAGE_CONTENTS_RESTRICTED|The message contained restricted contents.|\n|24019|UNREGISTERED_10DLC|The 10DLC registration is not completed and so the delivery failed.|\n|24020|MESSAGE_TIMEOUT|The message was sitting in queue for too long, so it timed out without being sent on to Quiq's downstream platform partners.|\n|24021|VOLUME_VIOLATION|Exceeded volume limits on this carrier.|\n|24022|RESTRICTED_COUNTRY_CODE|The country code is restricted by your configuration.|\n|24023|MESSAGE_CANCELLED|At some point in the message lifecycle it was enqueued and subsequently canceled.|\n|24024|OUTSIDE_SEND_WINDOW|The message arrived outside of the notification send window configured for this topic, and that window is set to reject rather than hold messages. Retrying will fail until the window reopens.|\n\n### Conversation Error Codes\n\n|Code|Error|Description|\n|-|-|-|\n|3000|CUSTOMER_ENGAGED_IN_ANOTHER_CONVERSATION|The customer is already engaged in a conversation with another agent or bot, so a new conversation cannot be started. The error response's `data.existingConversationId` identifies the existing conversation.|\n|3016|EXTERNAL_USER_MUST_BE_ONLINE|When an external routing engine (e.g. Salesforce Omni-Channel) is in use, the user must be online in that routing engine before a conversation can be started. This error only occurs for users of an external routing engine.|\n\n### Notification Request Error Codes\n\n|Code|Error|Description|\n|-|-|-|\n|24001|CUSTOMER_ENGAGED_IN_CONVERSATION|A notification cannot be sent to a customer who is currently engaged in a conversation.|\n|24003|TOO_MANY_SCHEDULED_MESSAGES|Processing this request would exceed the total number of scheduled messages allowed by the system.|\n|24500|INVALID_CONTACT_POINT|The contact point in the request is not valid.|\n|24501|INVALID_TOPIC|The topic in the request was not found.|\n|24502|FILE_TO_LARGE|The uploaded file exceeds the maximum number of rows.|\n|24503|FILE_EMPTY|The uploaded file has no valid lines.|\n|24504|INVALID_FILE_FORMAT|The uploaded file is not in a valid format.|\n|24505|REPEATED_CUSTOMER_SEND|Processing this request would send too many notifications to the same contact.|\n|24506|QUEUE_LIMIT_EXCEEDED|Processing this request would exceed the configured queued message limit.|\n\n## Webhooks Overview\nQuiq supports registering external webhooks to be called whenever certain events, such as a conversation closing, occur in the system. This enables you to write integrations that do things such as synchronizing conversation data to an external system. Webhooks are always POSTed to your endpoint with the payload of the event encoded in the request body as JSON.\n\n### Requirements and Security\nQuiq requires encrypted communication to any external webhooks (HTTPS). When you register your URL with Quiq we will give you a secret token. When we post to your webhook, the request will include a header with the id of \"X-Centricient-Hook-Token\" and a value of this secret token. You can use this to verify that it is in fact Quiq posting to your endpoint.\n\n### Webhook Payload\nAll webhooks events are wrapped in the following standard payload::\n```\n{\n    id: String (guid - unique id for every event we post to you),\n    eventType: String (Test, ConversationRequested, ConversationActivated, ...)\n    data: Object (Payload specific to they type of event)\n    timestamp: Long (Unix timestamp (in milliseconds) of when the event occurred\n}\n```\n\n_Note: The ID will be unique for each unique event in the system. On rare occasions you may receive a call to your webhook with a duplicate payload as a previous call. You can use this ID to verify that this is in fact a duplicate message you are receiving. These scenarios can occur for example if we publish to your endpoint and don't receive a timely response because of network issues. We will then republish the message in order to make sure you've received it._\n\n#### Test Event Type\nWhen the test webhook API is called, Quiq will post to your registered webhook with an event type of Test. It is expected that you will respond with a valid 200 or 204 response code.\n\n**Example Json:**\n```json\n{\n   \"eventType\":\"test\",\n   \"id\":\"245bc2f9-414e-4f49-a296-dc5e50d85292\",\n   \"data\":{}\n}\n```\n\n### In case of errors\nQuiq gracefully handles errors that occur while calling an external webhook. Such errors can occur because your hook returns a non 200 level HTTP response or a timeout occurs trying to call your hook. In either of these scenarios we will retry a few seconds later and continue retrying with an exponential back off. We will also send all of the site admins an email when an error first occurs and periodically after that. Once the errors quit occuring all events that were published while the error occurred will be passed to the webhook.\n\n### Developer tips\n* **Running/Debugging behind private firewall**: If you are running on a development box behind a firewall and don't have a way to route traffic from a public URL we suggest checking out [ngrok](https://ngrok.com) as a simple (and free) tool to route traffic in this scenario.\n* **Validating Webhook Payloads**: If you are validating webhook payloads in a way that could cause an error (and block the flow of additional payloads), below is some guidance for doing this in a way that will prevent unnecessary errors.\n   - **Allow for new fields.** Quiq's [API Versioning and Backwards Compatibility Policy](https://developers.quiq.com/api/docs#section/REST-APIs-Overview) allows for us to add new fields to the payload at any time. Make sure your validation is tolerant of this so that a new field will not break your webhook processing.\n   - **Allow for new enum values.** Quiq's [API Versioning and Backwards Compatibility Policy](https://developers.quiq.com/api/docs#section/REST-APIs-Overview) allows for us to add new values to enum fields at any time. Make sure your validation is tolerant of this so that a new enum value will not break your webhook processing.\n   - **Allow for optional fields.** All fields on the payload not marked as **Required** in Quiq's documentation should be considered as optional (meaning they could be omitted from the payload or be null). Even if a field seems like it will always be populated, there may be some valid situations that could cause it to be null. If you cannot take action on a payload without an optional field being populated, we recommend accepting the payload but taking no action on it so that future payloads can be delivered.\n\n### Sample Code\nWe have provided some sample code in different technologies so you can easily see how to integrate. If you are working in a technology we don't yet have a sample for we suggest you check out the [Python Sample](https://github.com/Quiq/webhook-integrations/tree/master/samples/python) as it is very straightfoward to understand and translate into your given techonology stack.\n\n* [Python Sample](https://github.com/Quiq/webhook-integrations/tree/master/samples/python) - Uses python and flask to host a self-contained microservice integration\n* [Java Sample](https://github.com/Quiq/webhook-integrations/tree/master/samples/java) - Uses java and the Dropwizard framework to host a self-contained microservice integration\n      ","version":null,"contact":null,"extensions":null,"license":null,"summary":null,"termsOfService":null},"components":{"schemas":{"GenerateTokenResponse":{"type":"object","properties":{"accessToken":{"type":"string","description":"A newly generated or renewed access token","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"tokenId":{"type":"string","description":"Unique identifier for this access token","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"A response to a generate request that contains the new or generated token","exampleSetFlag":false,"types":["object"]},"PublicUploadPrepareRequest":{"type":"object","properties":{"numUploads":{"maximum":10.0,"minimum":1,"type":"integer","description":"The number of Assets to be uploaded","format":"int32","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]}},"description":"Request object for preparing to create an Asset in Quiq","exampleSetFlag":false,"types":["object"]},"UploadDirectiveFormEntry":{"type":"object","properties":{"name":{"type":"string","description":"The form field name","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"value":{"type":"string","description":"The form field value","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"An upload directive form entry","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"PublicUploadCallbackPayload":{"type":"object","properties":{"eventType":{"type":"string","description":"The type of the event","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["UploadPromotionCompleted"]},"data":{"description":"The generic data associated with the event","$ref":"#/components/schemas/PublicUploadCallbackPayload","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"id":{"type":"string","description":"The id of the event","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"timestamp":{"type":"number","description":"The millisecond timestamp that the event was created","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]}},"description":"A public event","exampleSetFlag":false,"types":["object"]},"PreparedUpload":{"type":"object","properties":{"uploadId":{"maxLength":36,"minLength":36,"type":"string","description":"The Upload ID","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"directive":{"description":"The Upload directive","$ref":"#/components/schemas/UploadDirective","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"A prepared upload object","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"UploadDirective":{"type":"object","properties":{"url":{"maxLength":2000,"type":"string","description":"The url to perform a multipart form post against","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"method":{"type":"string","description":"The http method to use when submitting your request","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"formEntries":{"type":"array","description":"Form entries to be included in your form post","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/AssetUploadDirectiveFormEntry","exampleSetFlag":false},"types":["array"]},"headers":{"type":"array","description":"Headers to be included in your request","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/AssetUploadDirectiveHeader","exampleSetFlag":false},"types":["array"]}},"description":"An object describing how a client should upload assets","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"UploadDirectiveHeader":{"type":"object","properties":{"name":{"type":"string","description":"The header name","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"value":{"type":"string","description":"The header value","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"An upload directive header value","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"PublicUploadPrepareResponse":{"type":"object","properties":{"uploads":{"type":"array","description":"The prepared uploads","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/PreparedUpload","exampleSetFlag":false},"types":["array"]}},"description":"Response object for preparing to create an Asset in Quiq","exampleSetFlag":false,"types":["object"]},"PublicPromotedUpload":{"type":"object","properties":{"success":{"type":"boolean","description":"The status of the upload","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"assetId":{"type":"string","description":"The id of the asset that has been uploaded","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"contentType":{"type":"string","description":"The type and detail of the file (e.g. image/jpeg)","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"callbackData":{"type":"string","description":"The optional object that will be included with the callback request","nullable":true,"readOnly":false,"extensions":{"x-quiq-skip-validation":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"errorCode":{"type":"integer","description":"Error code indicating reason for failure during asset promotion\n\n|Error Code|Description|\n|-|-|\n|11001|An unknown error occurred|\n|11002|The upload was marked as infected|\n|11003|The upload's content type is not allowed|\n|11004|Unable to find upload|\n|11005|The upload's content length is zero|\n|10006|The upload's content length exceeds the limit|","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]}},"description":"Detailed information regarding an asset that has been promoted","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"PublicUploadCallbackInformation":{"type":"object","properties":{"webhookId":{"maxLength":2000,"type":"string","description":"The webhookId that will be requested during callback procedure","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"callbackData":{"type":"string","description":"The optional object that will be included with the callback request","nullable":true,"readOnly":false,"extensions":{"x-quiq-skip-validation":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"The information used when performing callback after upload processing","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"PublicUploadPromote":{"type":"object","properties":{"callbackInfo":{"description":"The information used when performing callback after upload processing","$ref":"#/components/schemas/PublicUploadCallbackInformation","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"fileName":{"type":"string","description":"The optional name of the upload","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"uploadId":{"maxLength":36,"minLength":36,"type":"string","description":"The ID of the upload to be promoted into a Quiq Asset","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Request object for promoting an upload into a Quiq Asset","exampleSetFlag":false,"types":["object"]},"StatusChangedPublicEvent":{"type":"object","properties":{"eventType":{"type":"string","description":"The type of the event","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["AgentStatusChanged"]},"data":{"description":"The generic data associated with the event","$ref":"#/components/schemas/AgentStatusChangePayload","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"id":{"type":"string","description":"The id of the event","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"timestamp":{"type":"number","description":"The millisecond timestamp that the event was created","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]}},"description":"A public event","exampleSetFlag":false,"types":["object"]},"GetSubStatusesResponse":{"type":"object","properties":{"statuses":{"type":"object","properties":{"unavailable":{"type":"array","description":"sub statuses","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/AgentSubStatusModel","exampleSetFlag":false},"types":["array"]},"available":{"type":"array","description":"sub statuses","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/AgentSubStatusModel","exampleSetFlag":false},"types":["array"]},"available-for-existing":{"type":"array","description":"sub statuses","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/AgentSubStatusModel","exampleSetFlag":false},"types":["array"]}},"additionalProperties":{"type":"array","description":"sub statuses","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/AgentSubStatusModel","exampleSetFlag":false},"types":["array"]},"description":"Statuses","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]}},"description":"Get sub statuses response","exampleSetFlag":false,"types":["object"]},"AgentSummary":{"type":"object","properties":{"available":{"type":"array","description":"The list of available agents","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"maxLength":254,"type":"string","description":"A user ID","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"types":["array"]},"unavailable":{"type":"array","description":"The list of unavailable agents","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"maxLength":254,"type":"string","description":"A user ID","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"types":["array"]},"availableForExisting":{"type":"array","description":"The list of available-for-existing agents","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"maxLength":254,"type":"string","description":"A user ID","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"types":["array"]}},"description":"Agent status summary","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"AgentAvailabilityCrossPlatformResults":{"type":"object","properties":{"results":{"type":"array","description":"Individual platform specific results","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/AgentAvailabilityCrossPlatformResult","exampleSetFlag":false},"types":["array"]}},"description":"The result of the agent availability request","exampleSetFlag":false,"types":["object"]},"CreateSubStatusRequest":{"type":"object","properties":{"subStatus":{"description":"sub-status model","$ref":"#/components/schemas/AgentSubStatusModel","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"Creates a sub status","exampleSetFlag":false,"types":["object"]},"AgentAvailabilityCrossPlatformResult":{"type":"object","properties":{"contactPoint":{"description":"The contact point","$ref":"#/components/schemas/ContactPointReference","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"platform":{"type":"string","description":"The messaging platform","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["SMS","Facebook","Kik","Chat","Twitter","AppleMessages","GoogleRBM","GoogleMessages","WeChat","WhatsApp","Instagram","Voice"]},"available":{"type":"boolean","description":"Indicator of the agents availibility","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"The result of the agent availability request","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"AgentAvailabilityResult":{"type":"object","properties":{"available":{"type":"boolean","description":"Indicator of the agents availibility","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"The result of the agent availability request","exampleSetFlag":false,"types":["object"]},"UpdateSubStatusRequest":{"type":"object","properties":{"subStatus":{"description":"sub-status model","$ref":"#/components/schemas/AgentSubStatusModel","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"updates a sub status","exampleSetFlag":false,"types":["object"]},"QueueWorkloadSummary":{"type":"object","properties":{"queue":{"maxLength":64,"type":"string","description":"The queue identity","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"agentsSummary":{"description":"Agents assigned to this queue by availability status","$ref":"#/components/schemas/AgentSummary","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"totalItems":{"minimum":0,"type":"integer","description":"Total items assigned to this queue","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"waitingItems":{"minimum":0,"type":"integer","description":"Total number of work items waiting in this queue","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"estimatedWaitTime":{"description":"Estimated wait time for this queue (if enabled and waitingItems > 0)","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"Workload summary for a queue","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"QueueReference":{"maxLength":64,"type":"string","description":"Queue identifier","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"AgentSessionMetricsPublicEvent":{"type":"object","properties":{"eventType":{"type":"string","description":"The type of the event","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["AgentSessionMetrics"]},"data":{"description":"The generic data associated with the event","$ref":"#/components/schemas/AgentSessionMetricsPayload","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"id":{"type":"string","description":"The id of the event","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"timestamp":{"type":"number","description":"The millisecond timestamp that the event was created","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]}},"description":"A public event","exampleSetFlag":false,"types":["object"]},"AgentSubStatusModel":{"type":"object","properties":{"label":{"maxLength":255,"minLength":1,"type":"string","description":"The label","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Sub status for agents","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"WorkloadSummary":{"type":"object","properties":{"agentsSummary":{"description":"Agents by availability status","$ref":"#/components/schemas/AgentSummary","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"queueSummaries":{"type":"array","description":"Summary information for individual queues","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/QueueWorkloadSummary","exampleSetFlag":false},"types":["array"]},"totalItems":{"minimum":0,"type":"integer","description":"Total items across all queues","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"waitingItems":{"minimum":0,"type":"integer","description":"Total number of waiting work items across all queues","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"longestWaitTime":{"type":"number","description":"The wait time of the work item that has been waiting the longest","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]}},"description":"Workload summary","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"AgentStatusChangePayload":{"type":"object","properties":{"userId":{"maxLength":254,"type":"string","description":"The ID of the user whose status has changed","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"statusBefore":{"type":"string","description":"The status of the user before undergoing a status change","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["unavailable","available","available-for-existing","offline"]},"statusAfter":{"type":"string","description":"The status of the user after undergoing a status change","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["unavailable","available","available-for-existing","offline"]},"subStatusIdBefore":{"type":"string","description":"The id of the sub-status of the user before undergoing a status change. This is optionally present.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"subStatusIdAfter":{"type":"string","description":"The id of the sub-status of the user after undergoing a status change. This is optionally present.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"The Webhook payload delivered upon an agent status change","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"AgentWorkload":{"type":"object","properties":{"agent":{"maxLength":254,"type":"string","description":"The user ID","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"agentStatus":{"type":"string","description":"The agent's current status","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["unavailable","available","available-for-existing","offline"]},"queueWorkloadTotals":{"type":"array","description":"The agent's workload broken out by queue","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/QueueWorkloadTotals","exampleSetFlag":false},"types":["array"]}},"description":"Agent workload summary","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"AgentWorkloadPublicEvent":{"type":"object","properties":{"eventType":{"type":"string","description":"The type of the event","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["AgentWorkloadSummary"]},"data":{"description":"The generic data associated with the event","$ref":"#/components/schemas/AgentWorkloadSummary","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"id":{"type":"string","description":"The id of the event","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"timestamp":{"type":"number","description":"The millisecond timestamp that the event was created","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]}},"description":"A public event","exampleSetFlag":false,"types":["object"]},"WorkloadSummaryPublicEvent":{"type":"object","properties":{"eventType":{"type":"string","description":"The type of the event","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["WorkloadSummary"]},"data":{"description":"The generic data associated with the event","$ref":"#/components/schemas/WorkloadSummary","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"id":{"type":"string","description":"The id of the event","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"timestamp":{"type":"number","description":"The millisecond timestamp that the event was created","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]}},"description":"A public event","exampleSetFlag":false,"types":["object"]},"QueueInfoResult":{"type":"object","properties":{"estimatedWaitTime":{"minimum":0,"type":"integer","description":"The estimated wait time (in seconds) for new entries in this queue. Will be zero when there is no expected wait. Will be null if the wait is indefinite.","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]}},"description":"The result of the queue info request","exampleSetFlag":false,"types":["object"]},"DurationMillis":{"type":"number","description":"A duration of time in milliseconds","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["number"]},"AgentSessionMetricsPayload":{"type":"object","properties":{"userId":{"maxLength":254,"type":"string","description":"The ID of the user who has gone offline.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"loginTime":{"type":"number","description":"The login timestamp of the user in UTC.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"logoutTime":{"type":"number","description":"The logout timestamp of the user in UTC.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"averageInitialResponseTime":{"description":"The average duration (in milliseconds) it took for the first agent response measured from the time the conversation was assigned to the agent to the first message sent by the agent.","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"averageResponseTime":{"description":"The average duration (in milliseconds) it took for the agent to respond to customer messages. In the event of multiple contiguous customer messages, we measure from the oldest message.","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"numberOfConversationsAccepted":{"minimum":0,"type":"integer","description":"The number of conversations the agent accepted.","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"numberOfConversationsDeclined":{"minimum":0,"type":"integer","description":"The number of conversations the agent declined either explicitly or implicitly through accepting then requeueing, rejecting or missing an invitation, or failing to respond in time and the system automatically requeueing. If you wish to only count the number of times an agent clicked decline, see the numberOfConversationsRejected field.","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"numberOfConversationsRejected":{"minimum":0,"type":"integer","description":"The number of conversations the agent explicitly rejected during an invitation.","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"numberOfConversationsMissed":{"minimum":0,"type":"integer","description":"The number of conversations offered to the agent that they did not accept or decline in time.","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"numberOfConversationsOffered":{"minimum":0,"type":"integer","description":"The number of conversations the agent was offered.","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"numberOfConversationsMarkedAsSpam":{"minimum":0,"type":"integer","description":"The number of conversations the agent marked as spam.","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"numberOfConversationsRequeued":{"minimum":0,"type":"integer","description":"The number of conversations the agent requeued and did not remain as the owner.","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"numberOfConversationsClosed":{"minimum":0,"type":"integer","description":"The number of conversations the agent closed during their session. Note: Conversations closed by the system outside of the agent's session due to rules/timers/etc will not be counted.","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"numberOfNovelConversationsAssigned":{"minimum":0,"type":"integer","description":"The number of unique conversations assigned to an agent during their session.","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"numberOfTimesMarkedUnresponsive":{"minimum":0,"type":"integer","description":"The number of times the agent was marked as unresponsive due to not responding to a customer in time.","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"timeAvailable":{"description":"The amount of time (in milliseconds) the agent was in the available status.","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"timeAvailableForExisting":{"description":"The amount of time (in milliseconds) the agent was in the current conversations status.","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"timeInConversations":{"description":"The total amount of time (in milliseconds) spent as the owner of a conversation.","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"timeUnavailable":{"description":"The amount of time (in milliseconds) the agent was in the unavailable status.","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"totalWorkTime":{"description":"The total amount of time (in milliseconds) we determined the agent was working based on our worktime metric.","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"timeInUtilizationBands":{"type":"object","properties":{},"additionalProperties":{"type":"number","description":"A default long value","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["number"]},"description":"Mapping of utilization bands (an integer from 0 through 10) to how long (in milliseconds) the agent spent in that band for this session. Utilization is calculated as the agent's workload / soft assignment limit. <br>Band 0 = 0 utilization<br>Band 1 = 0.0 < utilization <= 0.1<br>Band 2 = 0.1 < utilization <= 0.2<br>Band 3 = 0.2 < utilization <= 0.3<br>Band 4 = 0.3 < utilization <= 0.4<br>Band 5 = 0.4 < utilization <= 0.5<br>Band 6 = 0.5 < utilization <= 0.6<br>Band 7 = 0.6 < utilization <= 0.7<br>Band 8 = 0.7 < utilization <= 0.8<br>Band 9 = 0.8 < utilization <= 0.9<br>Band 10 = 0.9 < utilization <= 1.0","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"handleTime":{"description":"These metrics will measure the time that a conversation occupies an agent slot prior to being closed.","$ref":"#/components/schemas/AgentHandleTimeMetrics","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"The Webhook payload delivered upon an agent offline event","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"AgentHandleTimeMetrics":{"type":"object","properties":{"totalBasic":{"description":"A basic measurement of how long conversations were actively assigned to the agent without adjustments for conversation weight or agent concurrency.","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"totalConcurrencyAdjusted":{"description":"A measurement of how long conversations were actively assigned to the agent that accounts for conversation weight and is normalized by whichever is greater of the agent’s soft limit and the agent’s current workload.","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"availableBasic":{"description":"A basic measurement of how long conversations were actively assigned to the agent without adjustments for conversation weight or agent concurrency while the agent was in an available status.","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"availableConcurrencyAdjusted":{"description":"A measurement of how long conversations were actively assigned to the agent that accounts for conversation weight and is normalized by whichever is greater of the agent’s soft limit and the agent’s current workload while the agent was in an available status.","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"availableForExistingBasic":{"description":"A basic measurement of how long conversations were actively assigned to the agent without adjustments for conversation weight or agent concurrency while the agent was in an available for existing status.","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"availableForExistingConcurrencyAdjusted":{"description":"A measurement of how long conversations were actively assigned to the agent that accounts for conversation weight and is normalized by whichever is greater of the agent’s soft limit and the agent’s current workload while the agent was in an available for existing status.","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"unavailableBasic":{"description":"A basic measurement of how long conversations were actively assigned to the agent without adjustments for conversation weight or agent concurrency while the agent was in an unavailable status.","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"unavailableConcurrencyAdjusted":{"description":"A measurement of how long conversations were actively assigned to the agent that accounts for conversation weight and is normalized by whichever is greater of the agent’s soft limit and the agent’s current workload while the agent was in an unavailable status.","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"Agent handle time metrics","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"AgentWorkloadSummary":{"type":"object","properties":{"agentWorkloads":{"type":"array","description":"The workload data for agents currently assigned an active or inactive conversation","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/AgentWorkload","exampleSetFlag":false},"types":["array"]}},"description":"Agent workload summary","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"QueueWorkloadTotals":{"type":"object","properties":{"queue":{"maxLength":64,"type":"string","description":"The queue identity","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"numberOfActiveConversations":{"minimum":0,"type":"integer","description":"The number of active conversations assigned to the agent in this queue","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"numberOfInactiveConversations":{"minimum":0,"type":"integer","description":"The number of inactive conversations assigned to the agent in this queue","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]}},"description":"Workload totals broken out by queue","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ContactPointReference":{"maxLength":64,"type":"string","description":"Contact point identifier","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"sub status response":{"type":"object","properties":{"subStatus":{"description":"sub-status model","$ref":"#/components/schemas/AgentSubStatusModel","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"sub status","exampleSetFlag":false,"types":["object"]},"ContactCustomFields":{"type":"object","description":"Contact Custom Fields","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"IntegrationReference":{"type":"object","properties":{"provider":{"maxLength":32,"type":"string","description":"The integration provider","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"name":{"maxLength":32,"type":"string","description":"The integration reference name","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"id":{"maxLength":64,"type":"string","description":"The integration id","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"An object describing a reference to a record in an integrated system","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ConversationHandleTime":{"type":"object","properties":{"basic":{"description":"A basic measurement of how long the conversation was actively assigned to human agents without adjustments for conversation weight or agent concurrency","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"concurrencyAdjusted":{"description":"A measurement that accounts for conversation weight and is normalized by whichever is greater of the agent’s soft limit and the agent’s current workload","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"Human agent handle time","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"QuiqPlatformInvitationResult":{"type":"object","properties":{"value":{"type":"string","description":"The result value of the invitation","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["undetermined","accepted","rejected"]}},"description":"The result of a platform invitation","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"PublicChatConversationContext":{"type":"object","properties":{"intent":{"maxLength":255,"type":"string","description":"The conversation intent","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"data":{"type":"string","description":"The custom context data provided via web chat","nullable":true,"readOnly":false,"extensions":{"x-quiq-skip-validation":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"shopify":{"description":"The optional Chat Shopify context","$ref":"#/components/schemas/ShopifyChatContext","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"A PublicChatConversationContext object","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ShopifyContextPropertyPair":{"type":"object","properties":{"name":{"type":"string","description":"The property name","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"value":{"type":"string","description":"The property value","nullable":true,"readOnly":false,"extensions":{"x-quiq-skip-validation":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Shopify property pair data","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"QuiqCarouselSection":{"type":"object","properties":{"id":{"maxLength":50,"type":"string","description":"The identifier of the section","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"title":{"type":"string","description":"The display title for the section","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"allowMultiSelect":{"type":"boolean","description":"Whether or not to allow multiple items to be selected within the section. Defaults to false.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"A section on a Quiq Carousel","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"SlackIntegration":{"type":"object","properties":{"id":{"type":"string","description":"Server-assigned ID of the integration","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"slackUrl":{"type":"string","description":"Slack API URL for event logs to be sent to","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"channel":{"type":"string","description":"Slack channel name for event logs to be sent to","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"An object that describes a bot's slack integrations","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"BotsSettings":{"title":"BotsSettings","type":"array","description":"A collection of bot settings","exampleSetFlag":false,"items":{"$ref":"#/components/schemas/BotSettingsItem","exampleSetFlag":false},"types":["array"]},"ClaimVerificationResult":{"type":"object","properties":{"claim":{"type":"string","description":"The textual claim that was verified","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"model":{"type":"string","description":"The model that was used to perform claim verification","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"evidenceScores":{"type":"array","description":"Each piece of evidence used to justify the claim and its score according to the model","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/EvidenceScore","exampleSetFlag":false},"types":["array"]}},"description":"Result of claim verification","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"SearchResult":{"type":"object","properties":{"record":{"type":"object","description":"The record","nullable":true,"readOnly":false,"extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"distance":{"type":"number","description":"The distance between the record's embedding and the search text embedding","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]}},"description":"An individual search result","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"Conversation":{"type":"object","properties":{"id":{"maxLength":36,"type":"string","description":"Globally unique identifier for this conversation","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"status":{"description":"The current status of the conversation","$ref":"#/components/schemas/ConversationStatus","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"invitee":{"maxLength":254,"type":"string","description":"The user ID of the invitee of the conversation if applicable","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"owner":{"maxLength":254,"type":"string","description":"The user ID of the owner of the conversation if applicable","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"ownedSince":{"description":"If the conversation has an owner, the time at which the current owner became the owner","$ref":"#/components/schemas/Timestamp","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"customerPlatform":{"description":"The messaging platform used by the customer during this conversation","$ref":"#/components/schemas/CustomerPlatformMeta","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"customerHandle":{"maxLength":255,"type":"string","description":"The customer's handle (e.g. phone number) on the customer platform","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"customer":{"description":"Details about the customer","$ref":"#/components/schemas/Customer","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"contactPointId":{"description":"The contact point on which the conversation occurred or is occurring","$ref":"#/components/schemas/ContactPointReference","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"collaboration":{"description":"The associated collaboration conversation if any","$ref":"#/components/schemas/Collaboration","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"events":{"type":"array","description":"The sequence of non-message events that have occurred on this conversation","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/ConversationEvent","exampleSetFlag":false},"types":["array"]},"messages":{"type":"array","description":"The sequence of messages that have occurred on this conversation","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/Message","exampleSetFlag":false},"types":["array"]},"metrics":{"description":"A collection of metrics derived from this conversation","$ref":"#/components/schemas/ConversationMetrics","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"integrations":{"type":"array","description":"An object describing a reference to a record in an integrated system","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/IntegrationReference","exampleSetFlag":false},"types":["array"]},"integrationsData":{"type":"object","properties":{},"additionalProperties":{"maxLength":4096,"type":"string","description":"a data blob","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"description":"An integration data map","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"lastNotification":{"description":"The last notification sent before the conversation begins","$ref":"#/components/schemas/LastNotification","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"startTime":{"description":"The time the conversation started","$ref":"#/components/schemas/Timestamp","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"endTime":{"description":"The time the conversation ended, if applicable","$ref":"#/components/schemas/Timestamp","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"queue":{"description":"The identity of the queue the conversation is or was in","$ref":"#/components/schemas/QueueReference","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"custom":{"description":"Custom fields. These are stored as a key/value dictionary where the ID of the custom field is the key.","$ref":"#/components/schemas/ConversationCustomFields","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"members":{"type":"object","properties":{},"additionalProperties":{"$ref":"#/components/schemas/Membership","exampleSetFlag":false},"description":"A membership map","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"timers":{"description":"Information about timers that may be present on this conversation","$ref":"#/components/schemas/TimerInfo","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"webData":{"description":"Information about any web dat that may be present on this conversation","$ref":"#/components/schemas/PublicWebData","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"appleMessages":{"description":"Information specific to Apple Messages platform","$ref":"#/components/schemas/PublicAppleMessagesData","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"startedBy":{"description":"The entity that started the conversation","$ref":"#/components/schemas/Entity","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"customerSentiment":{"description":"Information about the customer sentiment for this conversation","$ref":"#/components/schemas/CustomerSentiment","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"originalTenantHandle":{"description":"The tenant platform/handle that was used to initiate this conversation.","$ref":"#/components/schemas/OriginalTenantHandle","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"currentTenantHandle":{"description":"The tenant platform/handle that this conversation is currently using or has ended with.","$ref":"#/components/schemas/CurrentTenantHandle","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"agentInfo":{"description":"Agent Attribution Information","$ref":"#/components/schemas/AgentInfo","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"originalContactPointId":{"description":"The contact point on which the conversation started","$ref":"#/components/schemas/ContactPointReference","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"googleMessages":{"description":"Information specific to the Google Messages platform","$ref":"#/components/schemas/PublicGoogleMessagesData","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"lastConversation":{"description":"The last conversation for this customer on this platform and contact point.","$ref":"#/components/schemas/LastConversation","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"pay":{"description":"All payment operations that took place on the conversation","$ref":"#/components/schemas/Pay","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"surveys":{"description":"Survey data possibly collected as part of this conversation","$ref":"#/components/schemas/Surveys","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"instagram":{"description":"Information specific to Instagram platform","$ref":"#/components/schemas/PublicInstagramData","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"goals":{"description":"Conversation goal states. These are stored as a key/value dictionary where the ID of the goal is the key.","$ref":"#/components/schemas/ConversationGoals","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"autoSummary":{"maxLength":512,"minLength":0,"type":"string","description":"AI-generated summary of the conversation","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"activeMessagingKeys":{"type":"array","description":"Currently active contact method messaging keys","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/MessagingKey","exampleSetFlag":false},"types":["array"]},"primaryMessagingKey":{"description":"The primary contact method messaging key","$ref":"#/components/schemas/MessagingKey","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"secondaryMessagingKey":{"description":"The secondary contact method messaging key","$ref":"#/components/schemas/MessagingKey","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"platformTransitionMode":{"type":"string","description":"How the primary contact method messaging key transitions during the conversation","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["adaptive","manual"]},"voice":{"description":"Information specific to the Voice platform","$ref":"#/components/schemas/PublicVoiceData","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"customerAiAgent":{"description":"Set when the customer appears to be an AI agent acting for a person","$ref":"#/components/schemas/CustomerAiAgent","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"A Conversation Object","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"AIAgentErrorPayload":{"type":"object","properties":{"correlationId":{"type":"string","description":"The correlation ID of the trace in which the error occurred","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"projectId":{"type":"string","description":"The ID of the project","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"conversationId":{"type":"string","description":"The ID of the conversation in which the error occurred","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"errorMessage":{"type":"string","description":"The error message","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"nodeId":{"description":"The ID of the node where the error occurred, if applicable","$ref":"#/components/schemas/BotNodeReferenceType","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"nodeLabel":{"type":"string","description":"The label of the node where the error occurred, if applicable","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"AI Agent error payload delivered via webhook","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"QuiqPlatformInvitation":{"type":"object","properties":{"result":{"description":"The result object for invitation","$ref":"#/components/schemas/QuiqPlatformInvitationResult","nullable":true,"readOnly":true,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"An object used for platform invitations","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"WrittenLanguage":{"type":"string","description":"The written language type","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["af","am","ar","az","be","bg","bn","bs","ca","ceb","co","cs","cy","da","de","el","en","eo","es","es-419","et","eu","fa","fi","fr","fr-CA","fy","ga","gd","gl","gu","ha","haw","he","hi","hmn","hr","ht","hu","hy","id","ig","is","it","ja","jv","ka","kk","km","kn","ko","ku","ky","la","lb","lo","lt","lv","mg","mi","mk","ml","mn","mr","ms","mt","my","ne","nl","no","ny","or","pa","pl","ps","pt","pt-BR","ro","ru","rw","sd","si","sk","sl","sm","sn","so","sq","sr","st","su","sv","sw","ta","te","tg","th","tk","tl","tr","tt","ug","uk","und","ur","uz","vi","xh","yi","yo","zh","zh-Hant","zu"]},"ShopifyContextOrder":{"type":"object","properties":{"id":{"type":"string","description":"The order ID","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"orderNumber":{"type":"number","description":"The order number","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"fulfillmentStatus":{"type":"string","description":"The fulfillment status of the order","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"lineItems":{"type":"array","description":"The order line items","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/ShopifyContextOrderItem","exampleSetFlag":false},"types":["array"]},"cancelledAt":{"type":"string","description":"The time the order was cancelled","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"createdAt":{"type":"string","description":"The time the order was created","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"cancelReason":{"type":"string","description":"The reason the order was cancelled","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"totalPrice":{"type":"string","description":"The total price of the order","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"orderStatusUrl":{"type":"string","description":"The URL to view the order status","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"name":{"type":"string","description":"The name of the order","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"note":{"type":"string","description":"The order note","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"noteAttributes":{"type":"array","description":"The order note attributes","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/ShopifyContextPropertyPair","exampleSetFlag":false},"types":["array"]},"refunds":{"type":"array","description":"The order refunds","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/ShopifyContextOrderRefund","exampleSetFlag":false},"types":["array"]},"tags":{"type":"string","description":"The order's tags","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Shopify order data","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"SentimentScore":{"maximum":1,"minimum":-1,"type":"number","description":"A sentiment score","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["number"]},"ShopifyContextCartTotals":{"type":"object","properties":{"tax":{"type":"number","description":"The cart tax","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"subtotal":{"type":"number","description":"The cart subtotal","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"total":{"type":"number","description":"The cart total","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]}},"description":"Shopify cart totals data","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"CustomerPlatformMeta":{"type":"string","description":"Customer's messaging platform","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["SMS","Facebook","Kik","Chat","Twitter","AppleMessages","GoogleRBM","None","GoogleMessages","WhatsApp","Instagram","Voice"]},"BotSessionSummaryEvent":{"type":"object","properties":{"eventType":{"type":"string","description":"The type of the event","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["BotSessionMetrics"]},"data":{"description":"The generic data associated with the event","$ref":"#/components/schemas/BotSessionSummary","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"id":{"type":"string","description":"The id of the event","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"timestamp":{"type":"number","description":"The millisecond timestamp that the event was created","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]}},"description":"A public event","exampleSetFlag":false,"types":["object"]},"Timezone":{"type":"string","description":"All timezone options","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["Etc/GMT+12","Etc/GMT+11","MIT","Pacific/Apia","Pacific/Midway","Pacific/Niue","Pacific/Pago_Pago","Pacific/Samoa","US/Samoa","America/Adak","America/Atka","Etc/GMT+10","HST","Pacific/Fakaofo","Pacific/Honolulu","Pacific/Johnston","Pacific/Rarotonga","Pacific/Tahiti","SystemV/HST10","US/Aleutian","US/Hawaii","Pacific/Marquesas","AST","America/Anchorage","America/Juneau","America/Nome","America/Yakutat","Etc/GMT+9","Pacific/Gambier","SystemV/YST9","SystemV/YST9YDT","US/Alaska","America/Dawson","America/Ensenada","America/Los_Angeles","America/Tijuana","America/Vancouver","America/Whitehorse","Canada/Pacific","Canada/Yukon","Etc/GMT+8","Mexico/BajaNorte","PST","PST8PDT","Pacific/Pitcairn","SystemV/PST8","SystemV/PST8PDT","US/Pacific","US/Pacific-New","America/Boise","America/Cambridge_Bay","America/Chihuahua","America/Dawson_Creek","America/Denver","America/Edmonton","America/Hermosillo","America/Inuvik","America/Mazatlan","America/Phoenix","America/Shiprock","America/Yellowknife","Canada/Mountain","Etc/GMT+7","MST","MST7MDT","Mexico/BajaSur","Navajo","PNT","SystemV/MST7","SystemV/MST7MDT","US/Arizona","US/Mountain","America/Belize","America/Cancun","America/Chicago","America/Costa_Rica","America/El_Salvador","America/Guatemala","America/Managua","America/Menominee","America/Merida","America/Mexico_City","America/Monterrey","America/North_Dakota/Center","America/Rainy_River","America/Rankin_Inlet","America/Regina","America/Swift_Current","America/Tegucigalpa","America/Winnipeg","CST","CST6CDT","Canada/Central","Canada/East-Saskatchewan","Canada/Saskatchewan","Chile/EasterIsland","Etc/GMT+6","Mexico/General","Pacific/Easter","Pacific/Galapagos","SystemV/CST6","SystemV/CST6CDT","US/Central","America/Bogota","America/Cayman","America/Detroit","America/Eirunepe","America/Fort_Wayne","America/Grand_Turk","America/Guayaquil","America/Havana","America/Indiana/Indianapolis","America/Indiana/Knox","America/Indiana/Marengo","America/Indiana/Vevay","America/Indianapolis","America/Iqaluit","America/Jamaica","America/Kentucky/Louisville","America/Kentucky/Monticello","America/Knox_IN","America/Lima","America/Louisville","America/Montreal","America/Nassau","America/New_York","America/Nipigon","America/Panama","America/Pangnirtung","America/Port-au-Prince","America/Porto_Acre","America/Rio_Branco","America/Thunder_Bay","America/Toronto","Brazil/Acre","Canada/Eastern","Cuba","EST","EST5EDT","Etc/GMT+5","IET","Jamaica","SystemV/EST5","SystemV/EST5EDT","US/East-Indiana","US/Eastern","US/Indiana-Starke","US/Michigan","America/Anguilla","America/Antigua","America/Aruba","America/Asuncion","America/Barbados","America/Boa_Vista","America/Campo_Grande","America/Caracas","America/Cuiaba","America/Curacao","America/Dominica","America/Glace_Bay","America/Goose_Bay","America/Grenada","America/Guadeloupe","America/Guyana","America/Halifax","America/La_Paz","America/Manaus","America/Martinique","America/Montserrat","America/Port_of_Spain","America/Porto_Velho","America/Puerto_Rico","America/Santiago","America/Santo_Domingo","America/St_Kitts","America/St_Lucia","America/St_Thomas","America/St_Vincent","America/Thule","America/Tortola","America/Virgin","Antarctica/Palmer","Atlantic/Bermuda","Atlantic/Stanley","Brazil/West","Canada/Atlantic","Chile/Continental","Etc/GMT+4","PRT","SystemV/AST4","SystemV/AST4ADT","America/St_Johns","CNT","Canada/Newfoundland","AGT","America/Araguaina","America/Bahia","America/Belem","America/Buenos_Aires","America/Catamarca","America/Cayenne","America/Cordoba","America/Fortaleza","America/Godthab","America/Jujuy","America/Maceio","America/Mendoza","America/Miquelon","America/Montevideo","America/Paramaribo","America/Recife","America/Rosario","America/Sao_Paulo","Antarctica/Rothera","BET","Brazil/East","Etc/GMT+3","America/Noronha","Atlantic/South_Georgia","Brazil/DeNoronha","Etc/GMT+2","America/Scoresbysund","Atlantic/Azores","Atlantic/Cape_Verde","Etc/GMT+1","Africa/Abidjan","Africa/Accra","Africa/Bamako","Africa/Banjul","Africa/Bissau","Africa/Casablanca","Africa/Conakry","Africa/Dakar","Africa/El_Aaiun","Africa/Freetown","Africa/Lome","Africa/Monrovia","Africa/Nouakchott","Africa/Ouagadougou","Africa/Sao_Tome","Africa/Timbuktu","America/Danmarkshavn","Atlantic/Canary","Atlantic/Faeroe","Atlantic/Madeira","Atlantic/Reykjavik","Atlantic/St_Helena","Eire","Etc/GMT","Etc/GMT+0","Etc/GMT-0","Etc/GMT0","Etc/Greenwich","Etc/UCT","Etc/UTC","Etc/Universal","Etc/Zulu","Europe/Belfast","Europe/Dublin","Europe/Lisbon","Europe/London","GB","GB-Eire","GMT","GMT0","Greenwich","Iceland","Portugal","UCT","UTC","Universal","WET","Zulu","Africa/Algiers","Africa/Bangui","Africa/Brazzaville","Africa/Ceuta","Africa/Douala","Africa/Kinshasa","Africa/Lagos","Africa/Libreville","Africa/Luanda","Africa/Malabo","Africa/Ndjamena","Africa/Niamey","Africa/Porto-Novo","Africa/Tunis","Africa/Windhoek","Arctic/Longyearbyen","Atlantic/Jan_Mayen","CET","ECT","Etc/GMT-1","Europe/Amsterdam","Europe/Andorra","Europe/Belgrade","Europe/Berlin","Europe/Bratislava","Europe/Brussels","Europe/Budapest","Europe/Copenhagen","Europe/Gibraltar","Europe/Ljubljana","Europe/Luxembourg","Europe/Madrid","Europe/Malta","Europe/Monaco","Europe/Oslo","Europe/Paris","Europe/Prague","Europe/Rome","Europe/San_Marino","Europe/Sarajevo","Europe/Skopje","Europe/Stockholm","Europe/Tirane","Europe/Vaduz","Europe/Vatican","Europe/Vienna","Europe/Warsaw","Europe/Zagreb","Europe/Zurich","MET","Poland","ART","Africa/Blantyre","Africa/Bujumbura","Africa/Cairo","Africa/Gaborone","Africa/Harare","Africa/Johannesburg","Africa/Kigali","Africa/Lubumbashi","Africa/Lusaka","Africa/Maputo","Africa/Maseru","Africa/Mbabane","Africa/Tripoli","Asia/Amman","Asia/Beirut","Asia/Damascus","Asia/Gaza","Asia/Istanbul","Asia/Jerusalem","Asia/Nicosia","Asia/Tel_Aviv","CAT","EET","Egypt","Etc/GMT-2","Europe/Athens","Europe/Bucharest","Europe/Chisinau","Europe/Helsinki","Europe/Istanbul","Europe/Kaliningrad","Europe/Kiev","Europe/Minsk","Europe/Nicosia","Europe/Riga","Europe/Simferopol","Europe/Sofia","Europe/Tallinn","Europe/Tiraspol","Europe/Uzhgorod","Europe/Vilnius","Europe/Zaporozhye","Israel","Libya","Turkey","Africa/Addis_Ababa","Africa/Asmera","Africa/Dar_es_Salaam","Africa/Djibouti","Africa/Kampala","Africa/Khartoum","Africa/Mogadishu","Africa/Nairobi","Antarctica/Syowa","Asia/Aden","Asia/Baghdad","Asia/Bahrain","Asia/Kuwait","Asia/Qatar","Asia/Riyadh","EAT","Etc/GMT-3","Europe/Moscow","Indian/Antananarivo","Indian/Comoro","Indian/Mayotte","W-SU","Asia/Riyadh87","Asia/Riyadh88","Asia/Riyadh89","Mideast/Riyadh87","Mideast/Riyadh88","Mideast/Riyadh89","Asia/Tehran","Iran","Asia/Aqtau","Asia/Baku","Asia/Dubai","Asia/Muscat","Asia/Oral","Asia/Tbilisi","Asia/Yerevan","Etc/GMT-4","Europe/Samara","Indian/Mahe","Indian/Mauritius","Indian/Reunion","NET","Asia/Kabul","Asia/Aqtobe","Asia/Ashgabat","Asia/Ashkhabad","Asia/Bishkek","Asia/Dushanbe","Asia/Karachi","Asia/Samarkand","Asia/Tashkent","Asia/Yekaterinburg","Etc/GMT-5","Indian/Kerguelen","Indian/Maldives","PLT","Asia/Calcutta","IST","Asia/Katmandu","Antarctica/Mawson","Antarctica/Vostok","Asia/Almaty","Asia/Colombo","Asia/Dacca","Asia/Dhaka","Asia/Novosibirsk","Asia/Omsk","Asia/Qyzylorda","Asia/Thimbu","Asia/Thimphu","BST","Etc/GMT-6","Indian/Chagos","Asia/Rangoon","Indian/Cocos","Antarctica/Davis","Asia/Bangkok","Asia/Hovd","Asia/Jakarta","Asia/Kolkata","Asia/Krasnoyarsk","Asia/Phnom_Penh","Asia/Pontianak","Asia/Saigon","Asia/Vientiane","Etc/GMT-7","Indian/Christmas","VST","Antarctica/Casey","Asia/Brunei","Asia/Chongqing","Asia/Chungking","Asia/Harbin","Asia/Hong_Kong","Asia/Irkutsk","Asia/Kashgar","Asia/Kuala_Lumpur","Asia/Kuching","Asia/Macao","Asia/Macau","Asia/Makassar","Asia/Manila","Asia/Shanghai","Asia/Singapore","Asia/Taipei","Asia/Ujung_Pandang","Asia/Ulaanbaatar","Asia/Ulan_Bator","Asia/Urumqi","Australia/Perth","Australia/West","CTT","Etc/GMT-8","Hongkong","PRC","Singapore","Asia/Choibalsan","Asia/Dili","Asia/Jayapura","Asia/Pyongyang","Asia/Seoul","Asia/Tokyo","Asia/Yakutsk","Etc/GMT-9","JST","Japan","Pacific/Palau","ROK","ACT","Australia/Adelaide","Australia/Broken_Hill","Australia/Darwin","Australia/North","Australia/South","Australia/Yancowinna","AET","Antarctica/DumontDUrville","Asia/Sakhalin","Asia/Vladivostok","Australia/ACT","Australia/Brisbane","Australia/Canberra","Australia/Hobart","Australia/Lindeman","Australia/Melbourne","Australia/NSW","Australia/Queensland","Australia/Sydney","Australia/Tasmania","Australia/Victoria","Etc/GMT-10","Pacific/Guam","Pacific/Port_Moresby","Pacific/Saipan","Pacific/Truk","Pacific/Yap","Australia/LHI","Australia/Lord_Howe","Asia/Magadan","Etc/GMT-11","Pacific/Efate","Pacific/Guadalcanal","Pacific/Kosrae","Pacific/Noumea","Pacific/Ponape","SST","Pacific/Norfolk","Antarctica/McMurdo","Antarctica/South_Pole","Asia/Anadyr","Asia/Kamchatka","Etc/GMT-12","Kwajalein","NST","NZ","Pacific/Auckland","Pacific/Fiji","Pacific/Funafuti","Pacific/Kwajalein","Pacific/Majuro","Pacific/Nauru","Pacific/Tarawa","Pacific/Wake","Pacific/Wallis","NZ-CHAT","Pacific/Chatham","Etc/GMT-13","Pacific/Enderbury","Pacific/Tongatapu","Etc/GMT-14","Pacific/Kiritimati"]},"MessageSurveySolicitation":{"type":"object","properties":{"surveyId":{"description":"The survey being solicited","$ref":"#/components/schemas/SurveyReference","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"Message Survey Solicitation Effect","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"PublicBrowserCaps":{"type":"object","properties":{"deviceType":{"type":"string","description":"The device type the conversation is being held on.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["Desktop","Mobile","Tablet","Unknown"]},"devicePlatform":{"type":"string","description":"The device platform the conversation is being held on.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"A PublicBrowserCaps object","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"WhatsAppCtaUrlButton":{"type":"object","properties":{"buttonText":{"maxLength":20,"minLength":0,"type":"string","description":"The text that is displayed on the button icon","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"WhatsApp CTA Button Url data","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"PublicAppleMessagesData":{"type":"object","properties":{"group":{"maxLength":255,"type":"string","description":"The Apple Messaging business group id the conversation is from.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"intent":{"maxLength":255,"type":"string","description":"The Apple Messaging business intent id the conversation is from.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"locale":{"maxLength":20,"type":"string","description":"The Apple Messaging locale the conversation is from. Examples: en_US, en_CA, fr_CA, es_MX","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"A PublicAppleMessageData object","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ShopifyCart":{"type":"object","properties":{"token":{"type":"string","description":"Unique identifier of the cart","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"currency":{"type":"string","description":"Currency symbol of the cart","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"items":{"type":"array","description":"The cart's line items","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/ShopifyCartItem","exampleSetFlag":false},"types":["array"]},"total_discount":{"type":"number","description":"Total discount applied to cart","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"original_total_price":{"type":"number","description":"Total value of cart before discounts","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"items_subtotal_price":{"type":"number","description":"Item subtotal, before discounts","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"requires_shipping":{"type":"boolean","description":"Whether the cart includes items that require physical shipping","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"A Shopify customer cart","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ShopifyContextCartCalculation":{"type":"object","properties":{"totalsWithoutShipping":{"description":"The cart totals without shipping","$ref":"#/components/schemas/ShopifyContextCartTotals","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"shippingOption":{"type":"array","description":"The shipping options","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/ShopifyContextShippingOption","exampleSetFlag":false},"types":["array"]},"shippingRequired":{"type":"boolean","description":"Whether shipping is required","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"Shopify cart calculation data","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"QuiqPay":{"type":"object","properties":{"processorId":{"type":"string","description":"The ID of the payment processor to be used to process they payment (e.g. stripe)","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"currencyCode":{"type":"string","description":"The currency code to be used to process the payment (e.g. USD)","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"total":{"description":"The total amount for the transaction","$ref":"#/components/schemas/QuiqPayAmount","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"lineItems":{"type":"array","description":"The line items for the transaction","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/QuiqPayAmount","exampleSetFlag":false},"types":["array"]},"description":{"type":"string","description":"The description of the transaction","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"metadata":{"type":"object","properties":{},"additionalProperties":{"type":"string","description":"Metadata Value","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"description":"An optional metadata map","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"successMessage":{"type":"string","description":"An optional message to present to the end user if the transaction succeeds","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"failureMessage":{"type":"string","description":"An optional message to present to the end user if the transaction fails","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"tag":{"type":"string","description":"Optional payment tag","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"paymentKey":{"type":"string","description":"Option payment key to include on payment link if using a custom processor","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"expiration":{"description":"An optional time at which this transaction expires in milliseconds since the Epoch","$ref":"#/components/schemas/Timestamp","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"result":{"description":"The result object for the transaction","$ref":"#/components/schemas/QuiqPayResult","nullable":true,"readOnly":true,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"fields":{"description":"Optional fields to be used with the payment transaction","$ref":"#/components/schemas/PaymentFields","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"An object used to solicit a payment","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"QuiqTimesItem":{"type":"object","properties":{"startTime":{"description":"When the time event starts as a Unix timestamp","$ref":"#/components/schemas/Timestamp","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"durationSeconds":{"minimum":0,"type":"integer","description":"The duration of the time event in seconds","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"directives":{"description":"Optional reply directives such as data bindings","$ref":"#/components/schemas/RichReplyDirectives","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"postbackData":{"type":"object","description":"Optional json that will get sent through to the platform and returned when this item is selected.","nullable":true,"readOnly":false,"extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]}},"description":"Quiq time item","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ShopifyContextOrderTransaction":{"type":"object","properties":{"amount":{"type":"string","description":"The transaction amount","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Shopify order transaction data","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ShopifyContextCustomer":{"type":"object","properties":{"id":{"type":"number","description":"The customer ID","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"acceptsMarketing":{"type":"boolean","description":"Whether the customer accepts marketing","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"firstName":{"type":"string","description":"The customer's first name","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"lastName":{"type":"string","description":"The customer's last name","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"phone":{"type":"string","description":"The customer's phone number","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"email":{"type":"string","description":"The customer's email address","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"createdAt":{"type":"string","description":"The time the customer was created","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"addresses":{"type":"array","description":"The customer's addresses","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/ShopifyContextCustomerAddressMeta","exampleSetFlag":false},"types":["array"]},"orders":{"type":"array","description":"The customer's orders","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/ShopifyContextOrder","exampleSetFlag":false},"types":["array"]},"quiqCart":{"description":"The customer's cart","$ref":"#/components/schemas/ShopifyContextQuiqCart","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"Shopify customer data","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"QuiqAuthFieldUpdate":{"type":"object","properties":{"fieldUpdate":{"description":"The field and value to update","$ref":"#/components/schemas/FieldUpdate","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"overwriteFieldValue":{"type":"boolean","description":"Whether or not the field update value should override a field that's already set","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"A field update object associated with an auth message","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"LookupItemsResponseType":{"type":"object","properties":{"items":{"type":"array","description":"The lookup result items","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/LookupItemType","exampleSetFlag":false},"types":["array"]}},"description":"LookupItemsResponseType","exampleSetFlag":false,"types":["object"]},"PublicWebData":{"type":"object","properties":{"ip":{"maxLength":100,"type":"string","description":"The IP address the conversation is from.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"userAgent":{"maxLength":512,"type":"string","description":"The user agent string the conversation is from","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"referrer":{"type":"string","description":"The URL that the conversation is taking place from","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"timeZone":{"description":"The timezone that the conversation is taking place from","$ref":"#/components/schemas/Timezone","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"browserCaps":{"description":"The browser capabilities for the conversation","$ref":"#/components/schemas/PublicBrowserCaps","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"acceptLanguage":{"type":"string","description":"The user's language setting from the browser","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"context":{"description":"The web chat context for the conversation","$ref":"#/components/schemas/PublicChatConversationContext","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"A PublicWebData object","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"AIAgentErrorEvent":{"type":"object","properties":{"eventType":{"type":"string","description":"The type of the event","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["AIAgentError"]},"data":{"description":"The generic data associated with the event","$ref":"#/components/schemas/AIAgentErrorPayload","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"id":{"type":"string","description":"The id of the event","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"timestamp":{"type":"number","description":"The millisecond timestamp that the event was created","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]}},"description":"A public event","exampleSetFlag":false,"types":["object"]},"EvidenceScore":{"type":"object","properties":{"evidence":{"type":"string","description":"The textual evidence","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"score":{"description":"The verification score according to the model","$ref":"#/components/schemas/Percentage","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"error":{"type":"string","description":"An error message if anything went wrong scoring the evidence","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"metadata":{"type":"object","description":"Optional metadata payload associated with the evidence","nullable":true,"readOnly":false,"extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"tags":{"type":"array","description":"Evidence tags","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"type":"string","description":"","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"types":["array"]}},"description":"Evidence/score pair","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"Pay":{"type":"object","properties":{"payments":{"type":"array","description":"All payment operations that took place on the conversation","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/QuiqPay","exampleSetFlag":false},"types":["array"]}},"description":"Object containing payment data on a conversation.","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"QuiqRichText":{"type":"object","properties":{"markdownText":{"type":"string","description":"The markdown text used for the rich text","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Rich text for a message. This is only used if the platform supports rich text, otherwise regular text is used.","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ShopifyContextOrderItem":{"type":"object","properties":{"productId":{"type":"number","description":"The product ID","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"quantity":{"type":"integer","description":"The quantity of the product","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"sku":{"type":"string","description":"The product SKU","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"name":{"type":"string","description":"The product name","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"properties":{"type":"array","description":"The product properties","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/ShopifyContextPropertyPair","exampleSetFlag":false},"types":["array"]},"price":{"type":"string","description":"The product price","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Shopify order item data","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"CardPreviewLink":{"type":"object","properties":{"url":{"type":"string","description":"The video url","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"mimeType":{"type":"string","description":"Mime type of the video","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Url wrapping structure for the url on a card preview link. This field is currently only supported on the Apple Messages platform.","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"PublicVoiceData":{"type":"object","properties":{"callDurationMillis":{"description":"The amount of time Quiq had control of this call","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"callHandedBack":{"type":"boolean","description":"Whether the Quiq Assistant intended to hand back the call for further communication with the customer, or hangup. Set to false for hangup, set to true for further communication.","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"tenantPhoneNumber":{"type":"string","description":"The Quiq phone number that received this call","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"callWrappingUp":{"type":"boolean","description":"Whether the call has ended and the assigned human agent is completing post-call wrap-up on this (still-open) conversation.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"isOutboundCall":{"type":"boolean","description":"Whether external telephony identified this voice call as outbound.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"PublicVoiceData","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ShopifyContext":{"type":"object","properties":{"customer":{"description":"The shopify customer data","$ref":"#/components/schemas/ShopifyContextCustomer","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"Loaded Shopify data","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"MagicMessageDetailsMeta":{"type":"object","properties":{"messages":{"type":"array","description":"generated message list","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/GeneratedMessageDetailsMeta","exampleSetFlag":false},"types":["array"]}},"description":"magic message details data","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"PlatformInvitationDirective":{"type":"object","properties":{"result":{"type":"string","description":"Type of invitation result","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["accepted","rejected"]},"aliased":{"description":"Aliased based result","$ref":"#/components/schemas/PlatformInvitationAliasBasis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"Platform invitation directive","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"FallbackDataMeta":{"type":"object","properties":{"originalMessageId":{"type":"string","description":"The message id that triggered the fallback","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"fallbackMessageId":{"type":"string","description":"The fallback message id","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Details about the fallback data","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"WhatsAppCtaButtonSettings":{"type":"object","properties":{"buttons":{"type":"array","description":"The text that is displayed on the button icon","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/WhatsAppCtaUrlButton","exampleSetFlag":false},"types":["array"]},"footerText":{"maxLength":60,"minLength":0,"type":"string","description":"The text for the footer","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Settings for WhatsApp CTA Button Url Message","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ShopifyContextShippingOption":{"type":"object","properties":{"externalId":{"type":"string","description":"The shipping option ID","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"price":{"type":"number","description":"The shipping option price","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"title":{"type":"string","description":"The shipping option title","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"totalIfSelected":{"description":"The total if this shipping option is selected","$ref":"#/components/schemas/ShopifyContextCartTotals","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"Shopify shipping option data","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ShopifyContextQuiqCart":{"type":"object","properties":{"items":{"type":"array","description":"The cart items","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/ShopifyContextOrderItem","exampleSetFlag":false},"types":["array"]},"platform":{"type":"string","description":"The platform the cart is on","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["shopify"]},"shippingAddress":{"description":"The shipping address","$ref":"#/components/schemas/ShopifyContextCustomerAddressMeta","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"shippingMethod":{"description":"The shipping method","$ref":"#/components/schemas/ShopifyContextShippingOption","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"customerPhone":{"type":"string","description":"The customer's phone number","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"customerEmail":{"type":"string","description":"The customer's email address","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"calculation":{"description":"The cart calculation","$ref":"#/components/schemas/ShopifyContextCartCalculation","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"orderId":{"type":"string","description":"The order ID","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Shopify cart data","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ControlMessage":{"type":"object","properties":{"type":{"type":"string","description":"The type of control message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["conversation-started"]},"data":{"type":"object","description":"Optional contextual data provided by the platform","nullable":true,"readOnly":false,"extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]}},"description":"ControlMessage","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"PublicAssetIngress":{"type":"object","properties":{"assetId":{"type":"string","description":"The ID of the asset","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"publicUrl":{"maxLength":2000,"type":"string","description":"Public URL pointing to the asset","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"References an asset (e.g. image)","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"BotSessionAnalyticsRequest":{"type":"object","properties":{"botId":{"maxLength":254,"type":"string","description":"The bot id","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"revisionId":{"type":"string","description":"The bot revisionId","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"mode":{"type":"string","description":"Whether or not to include all historic nodes, or only current nodes","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["all","current"]},"from":{"description":"The unix timestamp for the beginning of search interval","$ref":"#/components/schemas/Timestamp","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"to":{"description":"The unix timestamp for the end of search interval","$ref":"#/components/schemas/Timestamp","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"formatting":{"description":"The formatting of the content of the resulting analytics file","$ref":"#/components/schemas/CSVFormatting","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"A request object for getting an analytics file","exampleSetFlag":false,"types":["object"]},"BotUserReference":{"maxLength":254,"type":"string","description":"A bot user ID","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"VoiceProperties":{"type":"object","properties":{"preparedAudioId":{"type":"string","description":"The id used for preparing the audio for the message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"preparedAudioIds":{"type":"array","description":"If Quiq's audio split mode is used, the sequence of audio IDs used for preparing the audio on this message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"type":"string","description":"Any string","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"types":["array"]},"boostedKeywords":{"type":"array","description":"Keywords that should be boosted in STT processing (if available)","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"type":"string","description":"Any string","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"types":["array"]},"ssmlText":{"type":"string","description":"The text raw text content of this message with SSML tags included","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"responseHints":{"description":"The way the customer is expected to this message, should only be set on outbound messages","$ref":"#/components/schemas/VoiceResponseHints","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"inboundMetadata":{"description":"Inbound voice message metadata, including the average, minimum and maximum confidence. Only set on inbound messages.","$ref":"#/components/schemas/LastInboundVoiceMessageMetadata","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"Properties specific to the voice platform.","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"MessageResult":{"type":"object","properties":{"status":{"type":"string","description":"Status of the message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["Pending","Success","Failure"]},"errorCode":{"type":"string","description":"Error code of the message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["INVALID_DESTINATION","BLOCKED","SENDING_OWN_CONTACT_POINT","LOAD_ERROR","CONFIGURATION_ERROR","DELIVERY_ERROR","MESSAGE_TOO_LONG","UNKNOWN_RETRYABLE_ERROR","SPAM","MEDIA_TOO_LARGE","INVALID_FORMAT","CANT_RESOLVE_PLATFORM","LANDLINE","DEMO_LIMIT_EXCEEDED","RESPONSE_WINDOW_CLOSED","MESSAGE_CONTENTS_RESTRICTED","UNREGISTERED_10DLC","MESSAGE_TIMEOUT","VOLUME_VIOLATION","RESTRICTED_COUNTRY_CODE","MESSAGE_CANCELLED","OUTSIDE_SEND_WINDOW"]}},"description":"Message result details","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"PlatformInvitationAliasBasis":{"type":"object","properties":{"acceptedAliases":{"type":"array","description":"Aliases that indicate acceptance","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"type":"string","description":"","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"types":["array"]},"rejectedAliases":{"type":"array","description":"Aliases that indicate rejected","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"type":"string","description":"","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"types":["array"]}},"description":"Platform invitation alias basis","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"BotWebhookRequest":{"type":"object","properties":{"conversation":{"description":"The ongoing conversation with the bot","$ref":"#/components/schemas/Conversation","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"tenant":{"type":"string","description":"The associated tenant","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"botSession":{"description":"Bot session fields stored as a key/value dictionary where the ID of the session field is the key","$ref":"#/components/schemas/SessionFieldMap","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"The outermost payload of the Bot Call Webhook API","exampleSetFlag":false,"types":["object"]},"ConversationMetrics":{"type":"object","properties":{"initialAgentResponseDuration":{"description":"The time elapsed in milliseconds between when the conversation first entered the human staffed queue and the first human agent response","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"initialAgentResponseDurationSinceAssignment":{"description":"The time elapsed in milliseconds between the initial human assignment of the conversation and the first human agent response","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"averageAgentMessageDuration":{"description":"The average duration in milliseconds it took for the human agent(s) to respond to customer messages. In the event of multiple contiguous customer messages, we measure from the oldest message.","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"averageCustomerMessageDuration":{"description":"The average duration in milliseconds it took for the customer to respond to agent messages. In the event of multiple contiguous agent messages, we measure from the oldest message.","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"numberOfAgentMessages":{"minimum":0,"type":"integer","description":"The number of messages sent by an agent","format":"int32","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"numberOfHumanAgentMessages":{"minimum":0,"type":"integer","description":"The number of messages sent by a human agent","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"numberOfAutomatedAssistantMessages":{"minimum":0,"type":"integer","description":"The number of messages sent by an automated assistant","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"numberOfCustomerMessages":{"minimum":0,"type":"integer","description":"The number of messages sent by the customer","format":"int32","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"numberOfSystemMessages":{"minimum":0,"type":"integer","description":"The number of messages sent by the system (auto-responses)","format":"int32","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"numberOfAcceptedTransfers":{"minimum":0,"type":"integer","description":"The number of accepted transfers of this conversation","format":"int32","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"numberOfRequeues":{"minimum":0,"type":"integer","description":"The total number of times this conversation was sent back to the queue","format":"int32","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"numberOfResponseTimerExpirations":{"minimum":0,"type":"integer","description":"The number of times this conversation was sent back to the queue due to an unresponsive agent","format":"int32","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"workTime":{"description":"The amount of time in milliseconds that agents have spent actively working on this conversation","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"handleTime":{"description":"The collected handle time of this conversation","$ref":"#/components/schemas/ConversationHandleTime","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"billingUnits":{"minimum":0,"type":"integer","description":"The billing units calculated for this conversation. Only present once the conversation has reached a terminal state.","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]}},"description":"A collection of metrics derived from this conversation","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"GoogleMessagesDialer":{"type":"object","properties":{"deflectedPhoneNumber":{"description":"The deflected phone number of the Google Messages dialer","$ref":"#/components/schemas/PhoneNumber","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"An object containing Google Messages dialer information","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"TimerInfo":{"type":"object","properties":{"invitationTimer":{"description":"If non-null, indicates when the invitation timer will fire on this conversation.","$ref":"#/components/schemas/Timestamp","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"responseTimer":{"description":"If non-null, indicates when the response timer will fire for this conversation.","$ref":"#/components/schemas/Timestamp","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"A TimerInfo object","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"SessionFieldMap":{"type":"object","properties":{"nlu":{"type":"object","properties":{},"additionalProperties":{"type":"string","description":"value","extensions":{"x-quiq-skip-validation":true,"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"description":"The values of any NLU specific bot session variables stored as a key/value dictionary","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]}},"description":"Bot session fields stored as a key/value dictionary where the ID of the session field is the key","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"Entity":{"type":"object","properties":{"type":{"type":"string","description":"The type of the entity","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["user","customer","system","rules"]},"id":{"maxLength":254,"type":"string","description":"The identifier of the entity if applicable","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"An object referring to an entity that took action within the system","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"BotSessionSummary":{"type":"object","properties":{"botId":{"maxLength":254,"type":"string","description":"The user id of the bot who handled the conversation","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"revisionId":{"type":"string","description":"The user id of the bot who handled the conversation","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"startTime":{"type":"number","description":"The time the bot session started","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"endTime":{"type":"number","description":"The time the bot session ended","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"botSessionId":{"type":"string","description":"The unique id of the bot session","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"convoId":{"maxLength":36,"type":"string","description":"The conversation id of the bot session","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"contactPoint":{"maxLength":64,"type":"string","description":"The contact point the bot session belongs to","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"customerPlatform":{"description":"The platform the bot session takes place on","$ref":"#/components/schemas/CustomerPlatformMeta","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"botJourney":{"type":"array","description":"The bot nodes visited in chronological order","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/BotNodeVisit","exampleSetFlag":false},"types":["array"]},"customFields":{"description":"The custom fields as they exist on the conversation at the end of the bot session. These are stored as a key/value dictionary where the ID of the custom field is the key.","$ref":"#/components/schemas/ConversationCustomFields","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"sessionFields":{"description":"The session fields as they exist on the conversation at the end of the bot session. These are stored as a key/value dictionary where the ID of the session field is the key.","$ref":"#/components/schemas/ConversationSessionFields","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"goalsFields":{"description":"The conversation goals as they exist on the conversation at the end of the bot session. These are stored in a key/value dictionary where the ID of the goal field is the key.","$ref":"#/components/schemas/ConversationGoalsFields","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"Bot Session Summary","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"QuiqMessageIngress":{"type":"object","properties":{"text":{"type":"string","description":"Text for the messsage","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"richText":{"description":"Rich text for the messsage","$ref":"#/components/schemas/QuiqRichText","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"proxyInteraction":{"description":"A proxy interaction","$ref":"#/components/schemas/ProxyInteraction","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"quiqReply":{"description":"Suggested reply messages for the recipient","$ref":"#/components/schemas/QuiqReply","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"card":{"description":"QuiqCard definition","$ref":"#/components/schemas/QuiqCard","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"carousel":{"description":"QuiqCarousel definition","$ref":"#/components/schemas/QuiqCarousel","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"pay":{"description":"QuiqPay definition","$ref":"#/components/schemas/QuiqPay","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"auth":{"description":"QuiqAuth definition","$ref":"#/components/schemas/QuiqAuth","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"times":{"description":"A collection of time items, which are similar to calendar events.","$ref":"#/components/schemas/QuiqTimes","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"transcriptHints":{"description":"Transcript hints","$ref":"#/components/schemas/MessageTranscriptHints","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"directives":{"description":"Optional reply directives such as data bindings","$ref":"#/components/schemas/RichReplyDirectives","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"followUpSettings":{"description":"Whether or not this message requires an additional follow-up message from an agent","$ref":"#/components/schemas/FollowUpSettings","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"surveySolicitation":{"description":"Mark this message as a solicitation for a specified survey","$ref":"#/components/schemas/MessageSurveySolicitation","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"postbackData":{"type":"object","description":"Optional json that will be populated if this message is in reply to an item that was sent with postback data.","nullable":true,"readOnly":false,"extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"platformProperties":{"description":"Platform specific properties","$ref":"#/components/schemas/PlatformProperties","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"magicMessageDetails":{"description":"Quiq compose details","$ref":"#/components/schemas/MagicMessageDetailsMeta","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"platformInvitation":{"description":"QuiqPlatformInvitation definition","$ref":"#/components/schemas/QuiqPlatformInvitation","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"assets":{"maxItems":10,"type":"array","description":"A list of assets (e.g. images, video, etc) to include with the message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/PublicAssetIngress","exampleSetFlag":false},"types":["array"]}},"description":"Quiq Message","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"RichReplyDirectives":{"type":"object","properties":{"fieldUpdates":{"type":"array","description":"Optional list of field updates to apply as a side effect of this reply","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/FieldUpdate","exampleSetFlag":false},"types":["array"]},"newConversationRouting":{"description":"Routing specifications to be applied if this reply represents a new conversation","$ref":"#/components/schemas/RoutingDirective","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"preventMessage":{"type":"boolean","description":"If true the selection of this reply will not result in the creation of a message in Quiq","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"queueChange":{"description":"Collection of directives relating to the conversation's queue","$ref":"#/components/schemas/QueueChangeDirective","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"statusChange":{"description":"Collection of directives relating to the conversation's status","$ref":"#/components/schemas/StatusChangeDirective","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"custom":{"type":"object","properties":{},"additionalProperties":{"type":"object","description":"A json object used to store information associated with this directive","extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"description":"Map of custom directives. Directive keys that start with Quiq are reserved for internal Quiq directives.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"dismissalReply":{"type":"boolean","description":"If selecting this item means the user has dismissed the quiq reply","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"storedContextId":{"maxLength":200,"type":"string","description":"Optional stored context ID","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"platformInvitation":{"description":"Platform Invitation Reply Directive","$ref":"#/components/schemas/PlatformInvitationDirective","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"Rich reply directives","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"MessagePlatform":{"type":"string","description":"Message platform","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["SMS","Quiq","Facebook","Kik","Chat","Imported","Twitter","AppleMessages","GoogleRBM","None","GoogleMessages","WeChat","WhatsApp","Instagram","Voice"]},"BotWebhookResponse":{"type":"object","properties":{"actions":{"type":"array","description":"The actions for the Quiq bot to take once execution continues in the Quiq bot engine.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/ActionType","exampleSetFlag":false},"types":["array"]},"waitForCustomerResponseOverride":{"description":"Wait for customer response behavior override","$ref":"#/components/schemas/WaitForCustomerResponseOveride","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"The expected return format from a bot webhook.","exampleSetFlag":false,"types":["object"]},"PongRequest":{"type":"object","properties":{"healthy":{"type":"boolean","description":"Whether or not you're healthy","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"A pong request object","exampleSetFlag":false,"types":["object"]},"GeneratedMessageDetailsMeta":{"type":"object","properties":{"originalMessageText":{"type":"string","description":"Original message","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"generatedMessageText":{"type":"string","description":"Generated message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"wasError":{"type":"boolean","description":"Message could not be improved","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"wasRefused":{"type":"boolean","description":"Agent refused generated message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"Generated message details meta","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"QuiqCardButtonAction":{"type":"object","properties":{"type":{"type":"string","description":"The type of the action","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["postbackAction","openUrlAction","raiseSdkEventAction"]},"target":{"type":"string","description":"`(When type='openUrlAction')` Open url target in the same window, a new tab, or an inline Webview. Only supported on webchat.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["Same","New","Webview"]},"url":{"type":"string","description":"`(When type='openUrlAction')` The url to open","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"directives":{"description":"The directives","$ref":"#/components/schemas/RichReplyDirectives","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"postbackData":{"type":"object","description":"`(When type='postbackAction' or 'raiseSdkEventAction')` Optional json that will get sent through to the platform and returned when this item is selected.","nullable":true,"readOnly":false,"extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]}},"description":"An action that is tied to a button.","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"PhoneNumber":{"maxLength":20,"type":"string","description":"A phone number","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"PaymentFields":{"type":"object","properties":{"receiptEmail":{"description":"An optional email address to send the transaction email receipt message to. Only supported for Stripe payments.","$ref":"#/components/schemas/Email","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"Fields to use for this payment transaction","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"LastNotification":{"type":"object","properties":{"topicId":{"description":"The topic of the notification","$ref":"#/components/schemas/TopicReference","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"time":{"description":"The time the notification was sent","$ref":"#/components/schemas/Timestamp","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"id":{"maxLength":36,"type":"string","description":"The mid associated with the notification","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"integrations":{"type":"array","description":"An object describing a reference to a record in an integrated system","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/IntegrationReference","exampleSetFlag":false},"types":["array"]},"agent":{"description":"The ID of the agent associated with sending the notification","$ref":"#/components/schemas/UserReference","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"text":{"maxLength":1024,"type":"string","description":"The text of the notification","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"References the last notification sent","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"OriginalTenantHandle":{"type":"object","properties":{"platform":{"description":"The message platform associated with the tenant handle","$ref":"#/components/schemas/CustomerPlatformMeta","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"handle":{"maxLength":255,"type":"string","description":"The handle (e.g. phone number)","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"An optional TenantHandle object that reflects the tenant platform/handle that was used to initiate this conversation","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"Email":{"maxLength":254,"type":"string","description":"An email","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"BotNodeVisit":{"type":"object","properties":{"nodeId":{"type":"string","description":"The id of the bot node","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"nodeLabel":{"type":"string","description":"The label of the bot node","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Bot Node Visit","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ProxyInteraction":{"type":"object","properties":{"interactionType":{"type":"string","description":"The type of the interaction","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["apple-interactive-message","google-rbm","facebook","google-messages","instagram","chat","whats-app"]},"interaction":{"description":"Contains the payload of the interaction","$ref":"#/components/schemas/ProxyInteractionPayloadWrapperMeta","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"A ProxyInteraction Object","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"BotWebhookMessageMap":{"type":"object","properties":{"default":{"description":"The default, or fallback representation of the message. Platform agnostic","$ref":"#/components/schemas/QuiqMessageIngress","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"overrides":{"type":"object","properties":{"Chat":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false},"WhatsApp":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false},"GoogleRBM":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false},"SMS":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false},"Kik":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false},"Twitter":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false},"Email":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false},"AppleMessages":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false},"Quiq":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false},"Facebook":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false},"GoogleMessages":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false},"Instagram":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false},"None":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false},"WeChat":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false},"Voice":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false},"Imported":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false}},"additionalProperties":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false},"description":"Platform-specific implementations of the message.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]}},"description":"`(When action='sendMessage')`A message and its platform equivalents","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"MessageTranscriptIcon":{"type":"object","properties":{"builtInIcon":{"type":"string","description":"Use this property to choose from built-in Quiq transcript icons","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["list","calendar","card","app","payment","location","authentication","attachments","sideEffects","partialResponse","carousel","default"]}},"description":"Rich interaction icon object","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ProxyRequest":{"type":"object","properties":{"httpRequest":{"description":"HTTP request","$ref":"#/components/schemas/ProxyHTTPRequest","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"async":{"type":"boolean","description":"Whether to issue the proxy call asynchronously","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"A proxy request","exampleSetFlag":false,"types":["object"]},"Params":{"type":"object","description":"Query parameters stored as a key/value dictionary.","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"TopicReference":{"maxLength":64,"type":"string","description":"Topic identifier","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"QuiqReplyItem":{"type":"object","properties":{"text":{"maxLength":36,"type":"string","description":"The text associated with this reply","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"directives":{"description":"Optional reply directives such as data bindings","$ref":"#/components/schemas/RichReplyDirectives","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"postbackData":{"type":"object","description":"Optional json that will get sent through to the platform and returned when this item is selected.","nullable":true,"readOnly":false,"extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"label":{"maxLength":1,"minLength":1,"type":"string","description":"Option label to identify the choice in text-based representations of this option","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"aliases":{"type":"array","description":"Optional list of aliases that an end-user could type signaling they desire to pick this choice.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"type":"string","description":"alias","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"types":["array"]}},"description":"Quiq reply item","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ConversationGoalsFields":{"type":"object","description":"Goals Fields","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"Map":{"type":"object","description":"Key/value map of config values. The values of these are defined within the project and are static values.","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"LookupItemType":{"type":"object","properties":{"id":{"type":"string","description":"The lookup result id","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"label":{"type":"string","description":"The lookup result label","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"LookupItemType","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"RoutingDirective":{"type":"object","properties":{"queueId":{"maxLength":64,"type":"string","description":"Queue to which to route the conversation","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Instructions for routing","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"CurrentTenantHandle":{"type":"object","properties":{"platform":{"description":"The message platform associated with the tenant handle","$ref":"#/components/schemas/CustomerPlatformMeta","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"handle":{"maxLength":255,"type":"string","description":"The handle (e.g. phone number)","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"An optional TenantHandle object that reflects the tenant platform/handle that this conversation is currently on or has ended with","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"QuiqPayResult":{"type":"object","properties":{"failureCode":{"type":"string","description":"If the payment failed, a possible code indicating the reason for failure","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"failureMessage":{"type":"string","description":"If the payment failed, a possible message explaining why the payment failed.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"processorRequestId":{"type":"string","description":"A unique ID provided by the payment processor for this charge","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"resultType":{"type":"string","description":"Whether this payment request was a success or failure","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["success","failure"]}},"description":"A Quiq Pay Result object","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"QueueChangeDirective":{"type":"object","properties":{"queueId":{"description":"Queue to which to route the conversation","$ref":"#/components/schemas/QueueReference","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"allowMidConversation":{"type":"boolean","description":"Whether or not this directive should change the conversation queue once the conversation has been assigned","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"Instructions for routing","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"PlatformData":{"type":"object","properties":{"tenantPhoneNumber":{"maxLength":255,"type":"string","description":"When the customer platform of the conversation is SMS, this field will be populated with the specific tenant phone number that was texted in the case of incoming, or the specific phone number that sent the text in the case of outgoing messages","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Platform-specific message data","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ReferencedMessageData":{"type":"object","properties":{"transcriptText":{"type":"string","description":"The text of the referenced message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Details about the referenced message data","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"Proxy Response":{"type":"object","properties":{"httpResponse":{"description":"HTTP response","$ref":"#/components/schemas/ProxyHTTPResponse","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"A proxy response","exampleSetFlag":false,"types":["object"]},"LastConversation":{"type":"object","properties":{"started":{"description":"The time the last conversation started","$ref":"#/components/schemas/Timestamp","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"ended":{"description":"The time the last conversation ended","$ref":"#/components/schemas/Timestamp","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"lastMessageTime":{"description":"The time of the last sent message by agent or user on the last conversation","$ref":"#/components/schemas/Timestamp","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"owner":{"description":"The owner of the last conversation","$ref":"#/components/schemas/UserReference","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"cid":{"maxLength":36,"type":"string","description":"The conversation id of the last conversation","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"References the last notification sent","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ProxyInteractionPayloadWrapperMeta":{"type":"object","properties":{"payload":{"type":"object","description":"The payload of the interaction as opaque JSON. Either this or payloadId will be set","nullable":true,"readOnly":false,"extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"payloadId":{"type":"string","description":"An ID that can be used to retrieve the payload. Either this or payload will be set","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"An interaction payload wrapper object","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"StatusChangeDirective":{"type":"object","properties":{"newStatus":{"description":"The new status the conversation should take on","$ref":"#/components/schemas/ConversationStatus","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"fromCustomer":{"type":"boolean","description":"If the new status request is originating from the customer","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"Conversation status changes","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"VoiceResponseHints":{"type":"object","properties":{"type":{"type":"string","description":"The type of hint","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["numeric-only","numeric-allowed","speech-only"]},"endpointAddition":{"maximum":30000.0,"minimum":0,"type":"integer","description":"`(When type='numeric-allowed' or 'speech-only')` Optional endpointing time to add (in millis) when gathering the response to this message","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"length":{"maximum":50.0,"minimum":1,"type":"integer","description":"`(When type='numeric-only' or 'numeric-allowed')` Optional maximum number of digits to collect","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"stopCharacter":{"type":"string","description":"`(When type='numeric-only' or 'numeric-allowed')` Optional stop character","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["#","*","1","2","3","4","5","6","7","8","9","0"]}},"description":"Hints about how Quiq should gather the response to this outbound voice message","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"BotNodeReference":{"minLength":4,"type":"string","description":"Node identifier","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"LastInboundVoiceMessageMetadata":{"type":"object","properties":{"averageConfidence":{"maximum":1,"minimum":0,"type":"number","description":"The average confidence score for this message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"maximumConfidence":{"maximum":1,"minimum":0,"type":"number","description":"The maximum confidence score for this message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"minimumConfidence":{"maximum":1,"minimum":0,"type":"number","description":"The minimum confidence score for this message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]}},"description":"Last Inbound Voice Message Metadata","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"Asset":{"type":"object","properties":{"assetId":{"type":"string","description":"The ID of the asset","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"contentType":{"type":"string","description":"The content-type of the asset","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"publicUrl":{"maxLength":2000,"type":"string","description":"Public URL pointing to the asset","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"isInappropriate":{"type":"boolean","description":"Whether or not this asset is inappropriate","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"References an asset (e.g. image)","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"CustomerSentiment":{"type":"object","properties":{"last5LinearWeightedAverage":{"description":"A linear weighted average of the 5 most recent customer messages with greater emphasis placed on the most recent messages","$ref":"#/components/schemas/SentimentScore","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"Customer sentiment information","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"Headers":{"type":"object","description":"Header values stored as a key/value dictionary.","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"WebhookConfiguration":{"type":"object","properties":{"webhookId":{"type":"string","description":"Quiq assigned webhook ids of the integration","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"An object that describes a bot's webhook configurations","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"DerivedConversationData":{"type":"object","properties":{"lastCustomerMessage":{"description":"Last message sent from the customer","$ref":"#/components/schemas/Message","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"Helper data derived from a conversation","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ConversationSessionFields":{"type":"object","description":"Session Fields","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ConversationStatus":{"type":"string","description":"New Conversation Status","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["closed","inactive","active","inactive","deniedAsSpam","mergedAsDangling","closed","abandoned"]},"TimeContext":{"type":"object","properties":{"now":{"description":"The current time","$ref":"#/components/schemas/Timestamp","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"Time context for rules","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"FacebookProperties":{"type":"object","properties":{"messageTag":{"type":"string","description":"Facebook Message Tag Information","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Properties specific to facebook's platform","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"FieldUpdate":{"type":"object","properties":{"field":{"type":"string","description":"The field to be updated (JMESPath notation). To set conversation fields the path should be \"schema.conversation.custom.fieldId\" or \"schema.conversation.customer.custom.fieldId\"","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"value":{"type":"string","description":"The value to be applied","nullable":true,"readOnly":false,"extensions":{"x-quiq-skip-validation":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"An object that describes a desired field update","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"PublicGoogleMessagesWidgetWebData":{"type":"object","properties":{"referrer":{"type":"string","description":"The referrer for the Google Messages widget","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"The public Google Messages widget web data object","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ConversationCustomFields":{"type":"object","description":"Custom Fields","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ProxyHTTPRequest":{"type":"object","properties":{"url":{"type":"string","description":"The target URL for the request","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"method":{"type":"string","description":"The HTTP method of the request (e.g. POST)","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"body":{"type":"string","description":"Optional request body, base64 encoded","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"headers":{"type":"array","description":"Request headers","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"maxItems":2,"minItems":2,"type":"array","description":"Header","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"items":{"type":"string","description":"Header","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"types":["array"]},"types":["array"]}},"description":"Defines an HTTP request","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"GetAnalyticBotFieldsMetadataResponseMeta":{"type":"object","properties":{"analyticBotFieldsSchema":{"type":"object","description":"Schema of analytic enabled bot fields","nullable":true,"readOnly":false,"extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]}},"description":"A response object containing the analytic bot fields metadata","exampleSetFlag":false,"types":["object"]},"GoogleMessagesShopping":{"type":"object","properties":{"productTitle":{"type":"string","description":"The title of the product","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"productUri":{"type":"string","description":"The uri of the product","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"productImageUri":{"type":"string","description":"The uri of the product image","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"productCategory":{"type":"string","description":"The product category","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"merchantOfferId":{"type":"string","description":"The merchant offer id","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"allGlobalTradeItemNumbers":{"type":"string","description":"A set of Global Trade Item Numbers, delimited by commas","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"conversationType":{"type":"string","description":"The intent of the conversation","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"An object containing Google Messages shopping information","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"WhatsAppProperties":{"type":"object","properties":{"templateId":{"type":"string","description":"The id of the template","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"ctaUrlButtonSettings":{"description":"Settings for cta button url message","$ref":"#/components/schemas/WhatsAppCtaButtonSettings","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"disableInteractiveCarousel":{"type":"boolean","description":"When true, carousel will be sent as individual cards instead of a WhatsApp interactive carousel","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"mergeTextIntoCardBody":{"type":"boolean","description":"When true, a message carrying both text and a card is sent as a single WhatsApp message with the text prepended to the card's body or image caption, instead of a separate text message followed by the card. Note that WhatsApp enforces its own limit on body and caption length; a combined body exceeding it will be rejected by WhatsApp","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"Properties specific to the WhatsApp Message platform.","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"FollowUpSettings":{"type":"object","properties":{"required":{"type":"boolean","description":"Whether or not this message requires a follow-up message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"FollowUpSettings","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"QuiqReply":{"type":"object","properties":{"replies":{"type":"array","description":"The ordered list of replies the customer will be able to select from","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/QuiqReplyItem","exampleSetFlag":false},"types":["array"]}},"description":"Quiq reply","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"QuiqBotEnvironmentContext":{"type":"object","properties":{"tenantId":{"type":"string","description":"The tenant that this assistant is on","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Context about the environment that bot is executing in","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"QuiqCard":{"type":"object","properties":{"title":{"maxLength":200,"type":"string","description":"The title of the card","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"subTitle":{"type":"string","description":"The subtitle of the card","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"image":{"description":"The image of the card","$ref":"#/components/schemas/QuiqImageRef","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"link":{"description":"A url that the card links to","$ref":"#/components/schemas/QuiqCardUrl","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"secondaryTitle":{"maxLength":100,"type":"string","description":"A secondary title","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"tertiaryTitle":{"maxLength":200,"type":"string","description":"A tertiary title","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"buttons":{"type":"array","description":"The buttons displayed in the card. This definition is currently only supported on the Google RBM, Google Messages, and Conversation Starter Chat platforms.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/QuiqCardButton","exampleSetFlag":false},"types":["array"]},"imageHeight":{"type":"string","description":"The height of the image displayed in the card. This field is currently only supported on the Google RBM, Google Messages, and Conversation Starter Chat platforms. It is not supported if used in a Vertical Carousel. If used in a Google Messages Carousel, the Image Height on the first card will be used on all cards.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["Short","Medium","Tall"]},"orientation":{"type":"string","description":"The orientation of the cards. This field is currently only supported on the Google RBM platform, and only for cards NOT displayed in a carousel.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["Vertical","Horizontal"]},"titleLocation":{"type":"string","description":"The location of the title. This field is currently only supported on the SMS platform.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["Upper","Lower"]},"postbackData":{"type":"object","description":"Optional json that will get sent through to the platform and returned when this item is selected. Only applicable to cards on \"selectable\" carousels","nullable":true,"readOnly":false,"extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"replyDirectives":{"description":"The directives to be applied if this card is selected. Only applicable to cards on \"selectable\" carousels","$ref":"#/components/schemas/RichReplyDirectives","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"replyText":{"maxLength":200,"type":"string","description":"The text to be used if this card is selected. Only applicable to cards on \"selectable\" carousels","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"sectionId":{"maxLength":50,"type":"string","description":"Optional ID of the section this card belongs to. Only applicable to selectable carousels.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"previewLink":{"description":"The inline video preview in a card message. This field is currently only supported on the Apple Messages platform.","$ref":"#/components/schemas/CardPreviewLink","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"A rich display of an image, title, subtilte, and optional url to link to.","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"GetAllBotsAnalyticFieldsMetadataResponseMeta":{"type":"object","properties":{"botsSchema":{"type":"object","properties":{},"additionalProperties":{"type":"object","description":"the schema","extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"description":"Schema of analytic enabled bot fields","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]}},"description":"A response object containing ALL the analytic bot fields metadata","exampleSetFlag":false,"types":["object"]},"Timestamp":{"type":"number","description":"A timestamp in milliseconds since the Epoch","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["number"]},"Customer":{"type":"object","properties":{"firstName":{"maxLength":40,"type":"string","description":"The customer's first name","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"lastName":{"maxLength":80,"type":"string","description":"The customer's last name","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"email":{"description":"The customer's email address","$ref":"#/components/schemas/Email","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"phoneNumber":{"description":"The customer's phone number","$ref":"#/components/schemas/PhoneNumber","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"custom":{"description":"Custom fields. These are stored as a key/value dictionary where the ID of the custom field is the key.","$ref":"#/components/schemas/ContactCustomFields","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{},"x-quiq-type-meta":{}},"exampleSetFlag":false,"type":"object","properties":{},"additionalProperties":{"type":"string","description":"Field value","extensions":{"x-quiq-skip-validation":true,"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"types":["object"]},"preferredLanguage":{"description":"The customer's preferred language","$ref":"#/components/schemas/WrittenLanguage","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"Customer details","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ConversationGoals":{"type":"object","description":"Conversation Goal States","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"LinkImage":{"type":"object","properties":{"url":{"type":"string","description":"The url of the image","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"References an image link","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ShopifyChatContext":{"type":"object","properties":{"cart":{"description":"The chat customer's current cart in Shopify","$ref":"#/components/schemas/ShopifyCart","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"customerId":{"type":"string","description":"The optional ID of the Shopify customer","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Shopify-specific data attached to the conversation","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"PlatformProperties":{"type":"object","properties":{"facebookProperties":{"description":"Facebook specific platform properties","$ref":"#/components/schemas/FacebookProperties","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"googleProperties":{"description":"Google specific platform properties","$ref":"#/components/schemas/GoogleProperties","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"appleProperties":{"description":"Apple specific platform properties","$ref":"#/components/schemas/PublicAppleMessagesData","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"voiceProperties":{"description":"Voice specific platform properties","$ref":"#/components/schemas/VoiceProperties","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"whatsappProperties":{"description":"Whatsapp specific platform properties","$ref":"#/components/schemas/WhatsAppProperties","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"Map of Properties specific to the platform","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"Percentage":{"maximum":100.0,"minimum":0,"type":"number","description":"A percentage","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["number"]},"WebhookResult":{"type":"object","properties":{"targetId":{"type":"string","description":"The id of the webhook HTTP target","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"request":{"description":"The request sent to the webhook url","$ref":"#/components/schemas/RawWebhookRequest","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"response":{"description":"The raw response from the webhook","$ref":"#/components/schemas/raw webhook response","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"The webhook request and raw response","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"QuiqCarousel":{"type":"object","properties":{"cards":{"type":"array","description":"The cards displayed in the carousel","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/QuiqCard","exampleSetFlag":false},"types":["array"]},"cardWidth":{"type":"string","description":"The width of the cards in the carousel. This field is currently only supported on the Google RBM platform.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["Small","Medium"]},"selectable":{"type":"boolean","description":"Whether or not the cards on the carousel represent selectable options. This field is currently only relevant on the Apple Messages platform.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"allowMultiSelect":{"type":"boolean","description":"Whether or not to allow multiple items to be selected. If sections are defined, their multi-select options are prioritized.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"sections":{"maxItems":50,"type":"array","description":"The groups that multiple cards can be assigned to.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/QuiqCarouselSection","exampleSetFlag":false},"types":["array"]}},"description":"A rich display multiple cards. This definition is currently only supported on the Google RBM, Business Messages, SMS, and AppleMessages platforms.","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"PromptRuntimeContextMeta":{"type":"object","properties":{"completion":{"type":"string","description":"The raw completion response returned from the LLM unless overridden by the completion handler","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"User turn runtime context for executed prompt nodes","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ProgrammaticConversation":{"type":"object","properties":{"id":{"maxLength":36,"type":"string","description":"Globally unique identifier for this conversation","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"canaryValue":{"maximum":99,"minimum":0,"type":"integer","description":"A deterministic value between 0 and 99 (inclusive) that can be used for percent-based canary testing","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"owner":{"maxLength":254,"type":"string","description":"The user ID of the owner of the conversation if applicable","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"ownedSince":{"description":"If the conversation has an owner, the time at which the current owner became the owner","$ref":"#/components/schemas/Timestamp","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"customerPlatform":{"description":"The messaging platform used by the customer during this conversation","$ref":"#/components/schemas/CustomerPlatformMeta","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"customerHandle":{"maxLength":255,"type":"string","description":"The handle for the customer on the messaging platform.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"customer":{"description":"Details about the customer","$ref":"#/components/schemas/Customer","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"contactPointId":{"description":"The contact point on which the conversation occurred or is occurring","$ref":"#/components/schemas/ContactPointReference","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"queue":{"description":"The identity of the queue the conversation is or was in","$ref":"#/components/schemas/QueueReference","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"previousQueue":{"description":"The identity of the queue the conversation was in before the most recent queue change, if any","$ref":"#/components/schemas/QueueReference","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"messages":{"type":"array","description":"The sequence of messages that have occurred on this conversation","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/Message","exampleSetFlag":false},"types":["array"]},"events":{"type":"array","description":"The sequence of non-message events that have occurred on this conversation","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/ConversationEvent","exampleSetFlag":false},"types":["array"]},"startTime":{"description":"The time the conversation started","$ref":"#/components/schemas/Timestamp","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"endTime":{"description":"The time the conversation ended, if applicable","$ref":"#/components/schemas/Timestamp","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"currentTenantHandle":{"description":"The tenant platform/handle that this conversation is currently using or has ended with.","$ref":"#/components/schemas/CurrentTenantHandle","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"goals":{"description":"Conversation goal states. These are stored as a key/value dictionary where the ID of the goal is the key.","$ref":"#/components/schemas/ConversationGoals","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"custom":{"description":"Custom fields. These are stored as a key/value dictionary where the ID of the custom field is the key.","$ref":"#/components/schemas/ConversationCustomFields","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"webData":{"description":"The identity of the queue the conversation is or was in","$ref":"#/components/schemas/PublicWebData","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"lastConversation":{"description":"The last conversation for this customer on this platform and contact point.","$ref":"#/components/schemas/LastConversation","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"lastNotification":{"description":"The last notification sent before the conversation begins","$ref":"#/components/schemas/LastNotification","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"integrations":{"type":"array","description":"An object describing a reference to a record in an integrated system","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/IntegrationReference","exampleSetFlag":false},"types":["array"]},"activeMessagingKeys":{"type":"array","description":"Currently active contact method messaging keys","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/MessagingKey","exampleSetFlag":false},"types":["array"]},"primaryMessagingKey":{"description":"The primary contact method messaging key","$ref":"#/components/schemas/MessagingKey","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"secondaryMessagingKey":{"description":"The secondary contact method messaging key","$ref":"#/components/schemas/MessagingKey","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"appleMessages":{"description":"Information specific to Apple Messages platform","$ref":"#/components/schemas/PublicAppleMessagesData","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"integrationsData":{"type":"object","properties":{},"additionalProperties":{"maxLength":4096,"type":"string","description":"a data blob","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"description":"An integration data map","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"surveys":{"description":"Survey data possibly collected as part of this conversation","$ref":"#/components/schemas/Surveys","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"agentInfo":{"description":"Agent attribution information","$ref":"#/components/schemas/AgentInfo","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"attachments":{"type":"array","description":"Attachments associated with this conversation","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/PublicConversationAttachment","exampleSetFlag":false},"types":["array"]}},"description":"The current state of the conversation","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"Message":{"type":"object","properties":{"id":{"maxLength":36,"type":"string","description":"Globally unique identifier for the message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"sourcePlatform":{"description":"The platform on which the message originated","$ref":"#/components/schemas/MessagePlatform","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"author":{"maxLength":254,"type":"string","description":"The identity of the message author. Will be the customer handle on customer messages, the username of the agent on agent messages and empty on system messages","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"fromCustomer":{"type":"boolean","description":"True if message was sent by customer, false otherwise","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"text":{"maxLength":1024,"type":"string","description":"The text of the message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"timestamp":{"description":"Timestamp of when the message was received by or sent from the system","$ref":"#/components/schemas/Timestamp","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"assets":{"type":"array","description":"Any assets (e.g. images) attached to this message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/Asset","exampleSetFlag":false},"types":["array"]},"platformData":{"description":"Platform-specific data for this message","$ref":"#/components/schemas/PlatformData","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"links":{"type":"array","description":"Links for this message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/Link","exampleSetFlag":false},"types":["array"]},"messageResult":{"description":"Message result for this message","$ref":"#/components/schemas/MessageResult","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"proxyInteraction":{"description":"A proxy interaction","$ref":"#/components/schemas/ProxyInteraction","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"inResponseTo":{"maxLength":36,"type":"string","description":"The optional message ID that this message is in response to","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"externalAssets":{"type":"array","description":"Assets attached to this message of which Quiq is not in charge.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/Asset","exampleSetFlag":false},"types":["array"]},"platformProperties":{"description":"Platform-specific properties for this message","$ref":"#/components/schemas/PlatformProperties","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"isOutboundTemplate":{"type":"boolean","description":"Is the message an outbound template","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"customerPlatform":{"description":"The platform on which the message was delivered","$ref":"#/components/schemas/MessagePlatform","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"fallbackData":{"description":"Fallback data","$ref":"#/components/schemas/FallbackDataMeta","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"referencedMessage":{"description":"Referenced message data","$ref":"#/components/schemas/ReferencedMessageData","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"controlMessage":{"description":"A message sent by a platform - ex. ConversationStarted for calls","$ref":"#/components/schemas/ControlMessage","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"quiqReply":{"description":"Suggested reply messages for the recipient","$ref":"#/components/schemas/QuiqReply","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"card":{"description":"QuiqCard definition","$ref":"#/components/schemas/QuiqCard","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"carousel":{"description":"QuiqCarousel definition","$ref":"#/components/schemas/QuiqCarousel","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"pay":{"description":"QuiqPay definition","$ref":"#/components/schemas/QuiqPay","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"auth":{"description":"QuiqAuth definition","$ref":"#/components/schemas/QuiqAuth","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"times":{"description":"A collection of time items, which are similar to calendar events.","$ref":"#/components/schemas/QuiqTimes","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"transcriptHints":{"description":"Transcript hints","$ref":"#/components/schemas/MessageTranscriptHints","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"directives":{"description":"Directives that will run unless different directives are chosen from a QuiqReply or QuiqCarousel","$ref":"#/components/schemas/RichReplyDirectives","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"postbackData":{"type":"object","description":"Optional json that will be populated if this message is in reply to an item that was sent with postback data.","nullable":true,"readOnly":false,"extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"platformInvitation":{"description":"QuiqPlatformInvitation definition","$ref":"#/components/schemas/QuiqPlatformInvitation","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"A message","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"CSVFormatting":{"type":"object","properties":{"timezone":{"description":"the timezone","$ref":"#/components/schemas/Timezone","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"optional formatting configurations for the content of a CSV.","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"UserReference":{"maxLength":254,"type":"string","description":"A user ID","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"QuiqCardUrl":{"type":"object","properties":{"url":{"type":"string","description":"The url","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"target":{"type":"string","description":"Open url target in the same window, a new tab, or an inline Webview. Only supported on webchat.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["Same","New","Webview"]}},"description":"Url wrapping structure for the url on a Quiqcard","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"CustomerAssistantContext":{"type":"object","properties":{"botSession":{"description":"Bot session fields stored as a key/value dictionary where the ID of the session field is the key. Values persist until updated or the session ends","$ref":"#/components/schemas/SessionFieldMap","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"buffers":{"type":"object","properties":{},"additionalProperties":{"type":"object","description":"Json Serializable object","extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"description":"Key/value map of buffer state where key is the buffer name. Buffer values persist until updated or the session ends","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"conversation":{"description":"The current state of the conversation","$ref":"#/components/schemas/ProgrammaticConversation","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"derivedData":{"description":"Helper data derived from the conversation","$ref":"#/components/schemas/DerivedConversationData","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"searchResults":{"type":"array","description":"The AI Resource search results accumulated so far during the current user turn. Results do not persist across user turns.","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/Search","exampleSetFlag":false},"types":["array"]},"apiResults":{"type":"array","description":"The api results accumulated so far during the current user turn. Results do not persist across user turns.","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/WebhookResult","exampleSetFlag":false},"types":["array"]},"prompts":{"type":"object","properties":{},"additionalProperties":{"$ref":"#/components/schemas/PromptRuntimeContextMeta","exampleSetFlag":false},"description":"Key/value map of prompt state. The prompt states do not persist across user turns.","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"bot":{"description":"Bot runtime state","$ref":"#/components/schemas/QuiqBotRuntimeContextMeta","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"configs":{"description":"Key/value map of config values. The values of these are defined within the bot designer and are static values.","$ref":"#/components/schemas/Map","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"time":{"description":"Time data, like the current epoch","$ref":"#/components/schemas/TimeContext","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"environment":{"description":"Data about the current environment the assistant is executing within, like the current tenant ID","$ref":"#/components/schemas/QuiqBotEnvironmentContext","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"claimVerificationResults":{"type":"array","description":"Results of claim verifications performed during the current flow execution","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/ClaimVerificationResult","exampleSetFlag":false},"types":["array"]},"shopify":{"description":"Data fetched from Shopify","$ref":"#/components/schemas/ShopifyContext","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"timeline":{"type":"array","description":"An ordered list of timeline events which include messages and manually created events.","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/TimelineEvent","exampleSetFlag":false},"types":["array"]},"transcriptHistory":{"type":"array","description":"An ordered list of historical messages loaded into the context with the Load Historical Transcript action.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/Message","exampleSetFlag":false},"types":["array"]},"eventSearchResults":{"type":"array","description":"Contact events loaded into the context with the Search Event History action.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"type":"object","description":"A contact event result","extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"types":["array"]}},"description":"The context for customer assistants. Not actually a webhook but rather documents the shape of the data passed as the 'context' argument to various functions","exampleSetFlag":false,"types":["object"]},"RawWebhookRequest":{"type":"object","properties":{"body":{"description":"An optional request body","$ref":"#/components/schemas/webhook body","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"headers":{"description":"A map of headers included in the request","$ref":"#/components/schemas/Headers","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"params":{"description":"A map of query parameters included in the request","$ref":"#/components/schemas/Params","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"method":{"type":"string","description":"The http request method","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["GET","POST","PUT","PATCH"]},"path":{"type":"string","description":"An optional path for the request","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"The data provided by the python pre request function.","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"UpdateBotSettingsRequestMeta":{"type":"object","properties":{"settings":{"description":"The bot settings","$ref":"#/components/schemas/BotSettings","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"A request object for updating bot settings","exampleSetFlag":false,"types":["object"]},"QuiqTimes":{"type":"object","properties":{"solicitResponse":{"type":"boolean","description":"When true, the time events will be presented in a way that solicits a response from the recipient.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"items":{"type":"array","description":"The ordered list of time items to be ","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/QuiqTimesItem","exampleSetFlag":false},"types":["array"]},"title":{"maxLength":40,"type":"string","description":"The title of the items","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Collection of time events to be exchanged as part of a message","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"WaitForCustomerResponseOveride":{"type":"object","properties":{"shouldWait":{"type":"boolean","description":"Whether or not to wait for the customer response before proceeding","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"Object that allows for runtime override of wait for customer response behavior","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"Surveys":{"type":"object","description":"Surveys type","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"DocumentSetReferenceType":{"type":"string","description":"Search index reference","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"QuiqCardButton":{"type":"object","properties":{"text":{"maxLength":100,"type":"string","description":"The text of the button","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"action":{"description":"The action of the button","$ref":"#/components/schemas/QuiqCardButtonAction","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"A list of button displayed in a card.","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"PublicConversationAttachment":{"type":"object","properties":{"name":{"type":"string","description":"The name of the attachment","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"comment":{"type":"string","description":"An optional comment on the attachment","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"A conversation attachment","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"BotSettings":{"type":"object","properties":{"url":{"maxLength":2000,"type":"string","description":"The URL at which to receive bot webhooks","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"conversational":{"type":"boolean","description":"Whether or not the bot is conversational and therefore allowed to go online","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"desiredOnline":{"type":"boolean","description":"Whether or not you want the bot online","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"secret":{"maxLength":36,"minLength":36,"type":"string","description":"A secret token that will be sent as a header.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"type":{"type":"string","description":"The type of a bot","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["url","bot-designer","servo-agent","automation-service","servo-service","agent-assistant","servo-assistant","transformation","translation","conversation-analyzer","servo-analyst","umf","response-obligor","built-in","zenith","formbot"]},"slackIntegrations":{"type":"array","description":"List of slack integrations with a slack API URL and a channel. Defines where event errors are sent","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/SlackIntegration","exampleSetFlag":false},"types":["array"]},"webhookConfigurations":{"type":"array","description":"List of webhook configurations. Defines where event errors are sent","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/WebhookConfiguration","exampleSetFlag":false},"types":["array"]},"apiCredentialId":{"type":"string","description":"ID of a managed credential whose auth headers should be attached to outbound bot webhook requests","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"An object that describes bot management settings","exampleSetFlag":false,"types":["object"]},"Search":{"type":"object","properties":{"searchIndex":{"description":"The search index that was searched","$ref":"#/components/schemas/DocumentSetReferenceType","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"searchText":{"type":"string","description":"The search text","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"results":{"type":"array","description":"The search results","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/SearchResult","exampleSetFlag":false},"types":["array"]},"maxRecords":{"maximum":10.0,"minimum":1,"type":"integer","description":"The maximum number of results requested","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"maxDistance":{"minimum":0,"type":"number","description":"The maximum distance allowed for search results","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"maxDifferential":{"minimum":0,"type":"number","description":"Maximum distance a result can be from the best result in order to be returned","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]}},"description":"An occurrence of a search and its associated results","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"QuiqBotRuntimeContextMeta":{"type":"object","properties":{"location":{"description":"Where the conversation is at in the bot's dialog graph","$ref":"#/components/schemas/BotNodeReference","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"firstVisit":{"type":"boolean","description":"True if this is the first time the bot has been to this location","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"Bot runtime data","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"SurveyReference":{"maxLength":64,"type":"string","description":"Survey identifier","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"ShopifyContextOrderRefund":{"type":"object","properties":{"orderId":{"type":"number","description":"The order ID","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"transactions":{"type":"array","description":"The order transactions","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/ShopifyContextOrderTransaction","exampleSetFlag":false},"types":["array"]}},"description":"Shopify order refund data","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"BotNodeReferenceType":{"minLength":4,"type":"string","description":"Bot revision identifier","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"webhook body":{"type":"object","description":"webhook body","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ConversationEvent":{"type":"object","properties":{"triggeredBy":{"description":"The entity that triggered the event","$ref":"#/components/schemas/Entity","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"timestamp":{"description":"When the event occurred","$ref":"#/components/schemas/Timestamp","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"type":{"type":"string","description":"The type of the event that occurred","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["activated","pending","closed","inactivated","requested","deniedAsSpam","mergedAsDangling","abandoned","join","leave","ownerChanged","queueChanged","customerRequestEndConvo","customerRequestedEndConvoV2"]},"newOwner":{"maxLength":254,"type":"string","description":"`(When type='ownerChanged')` The new owner of the conversation","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"newQueue":{"maxLength":64,"type":"string","description":"`(When type='queueChanged')` The new queue","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"oldOwner":{"maxLength":254,"type":"string","description":"`(When type='ownerChanged')` The old owner of the conversation","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"oldQueue":{"maxLength":64,"type":"string","description":"`(When type='queueChanged')` The old queue","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"An object describing an important conversation event","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"Membership":{"type":"object","properties":{"attributes":{"uniqueItems":true,"type":"array","description":"The attributes of a membership","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"type":"string","description":"A membership attribute","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"types":["array"]}},"description":"A membership object","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"Collaboration":{"type":"object","properties":{"id":{"maxLength":36,"type":"string","description":"Conversation identifier","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"events":{"type":"array","description":"The sequence of non-message events that have occurred on this collaboration","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/ConversationEvent","exampleSetFlag":false},"types":["array"]},"messages":{"type":"array","description":"The sequence of messages that have occurred on this collaboration","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/Message","exampleSetFlag":false},"types":["array"]},"startTime":{"description":"The time the collaboration started","$ref":"#/components/schemas/Timestamp","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"A Collaboration Object","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ActionType":{"type":"object","properties":{"action":{"description":"An action the Quiq bot will take once execution continues in the Quiq bot engine.","$ref":"#/components/schemas/Action","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"field":{"type":"string","description":"`(When action='setField' or 'incrementField')` Field","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"value":{"type":"string","description":"`(When action='setField' or 'incrementField')` Value","nullable":true,"readOnly":false,"extensions":{"x-quiq-skip-validation":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"message":{"description":"Message","$ref":"#/components/schemas/BotWebhookMessageMap","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"Actions for the bot to take.","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"PublicGoogleMessagesData":{"type":"object","properties":{"store":{"description":"Optional Google Messages location information","$ref":"#/components/schemas/PublicGoogleMessagesStore","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"entryPoint":{"maxLength":255,"type":"string","description":"The entry point where the Google Messages conversation originated","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"widget":{"description":"Optional Google Messages widget information","$ref":"#/components/schemas/GoogleMessagesWidget","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"userDeviceLocale":{"maxLength":255,"type":"string","description":"The device locale of the end user's device","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"shopping":{"description":"Options Google Messages shopping context information","$ref":"#/components/schemas/GoogleMessagesShopping","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"dialer":{"description":"Optional Google Messages dialer information","$ref":"#/components/schemas/GoogleMessagesDialer","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"An optional object containing Google Messages information","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"PublicGoogleMessagesStore":{"type":"object","properties":{"placeId":{"maxLength":255,"type":"string","description":"The place identifier for the Google Messages location","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"address":{"maxLength":255,"type":"string","description":"The address of the Google Messages location","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"name":{"maxLength":255,"type":"string","description":"The name of the Google Messages location","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"An object containing Google Messages store location information","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ShopifyContextCustomerAddressMeta":{"type":"object","properties":{"firstName":{"type":"string","description":"The customer's first name","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"lastName":{"type":"string","description":"The customer's last name","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"address1":{"type":"string","description":"The customer's address line 1","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"address2":{"type":"string","description":"The customer's address line 2","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"city":{"type":"string","description":"The customer's city","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"province":{"type":"string","description":"The customer's province","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"provinceCode":{"type":"string","description":"The customer's province code","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"countryName":{"type":"string","description":"The customer's country name","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"countryCode":{"type":"string","description":"The customer's country code","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"zip":{"type":"string","description":"The customer's zip code","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"default":{"type":"boolean","description":"Whether this is the customer's default address","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"Shopify customer address data","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"MessagingKey":{"type":"object","properties":{"platform":{"description":"The platform","$ref":"#/components/schemas/MessagePlatform","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"customerHandle":{"maxLength":255,"type":"string","description":"The customer handle","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"tenantHandle":{"type":"string","description":"The optional tenant handle","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"A platform/handle combination upon which messages may be exchanged","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"QuiqPayAmount":{"type":"object","properties":{"label":{"type":"string","description":"The amount label","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"amount":{"type":"number","description":"The amount in the smallest currency unit available (e.g. cents)","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]}},"description":"A Quiq Pay Amount object","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"QuiqImageRef":{"type":"object","properties":{"publicUrl":{"type":"string","description":"A public url location of the image","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"assetId":{"type":"string","description":"An assetId representing the image","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Image object defined by either an assetId or a publicUrl","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"MessageTranscriptHints":{"type":"object","properties":{"icon":{"description":"An icon for the interaction","$ref":"#/components/schemas/MessageTranscriptIcon","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"heading1":{"maxLength":2000,"type":"string","description":"Primary heading for the interaction","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"heading2":{"maxLength":2000,"type":"string","description":"Secondary heading for the interaction","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"description":{"maxLength":2000,"type":"string","description":"Detailed description of the interaction","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Hints for conversation transcripts","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"GoogleMessagesWidget":{"type":"object","properties":{"url":{"maxLength":255,"type":"string","description":"The url for the Google Messages widget","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"className":{"maxLength":255,"type":"string","description":"The class identifier for the Google Messages widget","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"groupId":{"maxLength":255,"type":"string","description":"The group id for the Google Messages widget","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"intentId":{"maxLength":255,"type":"string","description":"The intent id for the Google Messages widget","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"storedContextId":{"type":"string","description":"The optional context ID associated with the widget","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"webData":{"description":"The optional Google Messages widget web data object","$ref":"#/components/schemas/PublicGoogleMessagesWidgetWebData","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"An object containing Google Messages widget information","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"AgentInfo":{"type":"object","properties":{"lastHumanAgent":{"description":"The last human agent to send a message","$ref":"#/components/schemas/UserReference","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"humanAgentMostMessages":{"description":"The human agent who sent the most messages","$ref":"#/components/schemas/UserReference","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"mostMessages":{"description":" The user, human or bot, who sent the most messages","$ref":"#/components/schemas/UserReference","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"Message data regarding a human agent conversation","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"Action":{"type":"string","description":"Action","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["sendMessage","setField","incrementField"]},"QuiqAuth":{"type":"object","properties":{"configurationId":{"type":"string","description":"The identifier for the auth configuration to be used","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"successMessage":{"type":"string","description":"An optional message to be shown to the end user upon successful authentication","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"failureMessage":{"type":"string","description":"An optional message to be shown to the end user upon failed authentication","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"identity":{"description":"The identity of the end user","$ref":"#/components/schemas/QuiqAuthIdentity","nullable":true,"readOnly":true,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"redirectUrlOverride":{"maxLength":2000,"type":"string","description":"The optional URL to redirect to after authentication completion.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"signInLabel":{"type":"string","description":"An optional label to apply to the sign in button (Chat only)","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"declineLabel":{"type":"string","description":"An optional label to the decline button (Chat only - if not provided, no decline button will be shown)","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"An object used to identify an end user","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ProxyHTTPResponse":{"type":"object","properties":{"status":{"minimum":0,"type":"integer","description":"Status code of the response","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"body":{"type":"string","description":"Optional response body, base 64 encoded","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"headers":{"type":"array","description":"Response headers","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"maxItems":2,"minItems":2,"type":"array","description":"Header","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"items":{"type":"string","description":"Header","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"types":["array"]},"types":["array"]}},"description":"Response to a proxy HTTP request","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"QuiqAuthIdentity":{"type":"object","properties":{"verified":{"type":"boolean","description":"Whether or not the end user has been verified","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"email":{"description":"The email address of the end user","$ref":"#/components/schemas/Email","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"username":{"type":"string","description":"The user name of the end user","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"firstName":{"maxLength":40,"type":"string","description":"The first name of the end user","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"lastName":{"maxLength":80,"type":"string","description":"The last name of the end user","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"fieldUpdates":{"type":"array","description":"Optional field updates associated with the auth message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/QuiqAuthFieldUpdate","exampleSetFlag":false},"types":["array"]}},"description":"The Quiq Auth identity","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"PublicInstagramData":{"type":"object","properties":{"username":{"type":"string","description":"The Instagram username of the user at the time the conversation is started.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"isVerifiedUser":{"type":"boolean","description":"The verification status of the user's account on Instagram","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"followerCount":{"type":"number","description":"The number of followers of the user's account on Instagram","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"conversationStartedFromStoryMention":{"type":"boolean","description":"Identifies if the conversation started from an Instagram story mention","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"A PublicInstagramData object","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"BotSettingsItem":{"type":"object","properties":{"botId":{"type":"string","description":"The id of the subject bot","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"botSettings":{"description":"The settings of the subject bot","$ref":"#/components/schemas/BotSettings","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"A class containing a bot-id and the settings associated","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ShopifyCartItem":{"type":"object","properties":{"sku":{"type":"string","description":"Product SKU","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"url":{"type":"string","description":"Path to storefront (exclusive of domain name) of the product","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"image":{"type":"string","description":"Path to product image, hosted on Shopify","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"quantity":{"type":"integer","description":"The quantity of this product","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"product_title":{"type":"string","description":"Display name of the product","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"variant_title":{"type":"string","description":"Name of the selected product variant, such as size and color","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"final_line_price":{"type":"number","description":"Final price of given quantity of item after discount","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"final_price":{"type":"number","description":"Final price of single item","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"original_line_price":{"type":"number","description":"Original price of given quantity item before discounts","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"original_price":{"type":"number","description":"Original price of single item, before discount","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"product_id":{"type":"number","description":"The Shopify product ID","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]}},"description":"An item in a customer's shopify cart","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"raw webhook response":{"type":"object","description":"raw webhook response","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"GoogleProperties":{"type":"object","properties":{"sendTime":{"type":"number","description":"The time the inbound message was sent from Google's servers","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"createTime":{"type":"number","description":"The time the inbound message was sent from the user's device (only available on Google Messages)","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]}},"description":"Properties specific to the Google RBM and Google Messages platforms. ","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"TimelineEvent":{"type":"object","properties":{"type":{"type":"string","description":"The event type","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"data":{"type":"object","description":"Data associated to the event","nullable":true,"readOnly":false,"extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"timestamp":{"description":"The time the event occurred","$ref":"#/components/schemas/Timestamp","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"A single occurrence of either a message or custom timeline event","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"Link":{"type":"object","properties":{"title":{"type":"string","description":"The title of the link","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"siteName":{"type":"string","description":"The name of the site associated with the link","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"description":{"type":"string","description":"The description of the site associated with the link","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"originalUrl":{"type":"string","description":"The url of the link","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"image":{"description":"The image to be associated with this link","$ref":"#/components/schemas/LinkImage","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"References a link","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"InteractionMessageRequestMetadata":{"type":"object","properties":{"text":{"maxLength":1024,"type":"string","description":"The text body","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"responseMessageId":{"type":"string","description":"Response message id","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"times":{"description":"Times solicitation","$ref":"#/components/schemas/PublicQuiqTimes","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"selectedButton":{"description":"Selected button","$ref":"#/components/schemas/ButtonSelection","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"The interaction message request definition","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"DownloadTranscriptRequest":{"type":"object","properties":{"originUrl":{"type":"string","description":"Url of the chat page","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"timezone":{"description":"The timezone","$ref":"#/components/schemas/Timezone","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"","exampleSetFlag":false,"types":["object"]},"WebSocketPong":{"type":"object","properties":{"id":{"maxLength":32,"type":"string","description":"Id for this pong","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"result":{"type":"string","description":"Will always be the value 'Pong'","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Response to a websocket ping request","exampleSetFlag":false,"types":["object"]},"ChatPrepareUploadsResponse":{"type":"object","properties":{"uploads":{"type":"array","description":"Upload directives for upload of assets","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/UploadDef","exampleSetFlag":false},"types":["array"]}},"description":"A response object containing asset upload directives","exampleSetFlag":false,"types":["object"]},"ContactPointOptions":{"type":"object","properties":{"preserveContactPoint":{"type":"boolean","description":"Whether to preserve the contact point","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"Contact Point Options","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"WebRuleEndpointRegistrationDef":{"type":"object","properties":{"url":{"type":"string","description":"The url of the end point","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"headers":{"type":"object","properties":{},"additionalProperties":{"type":"string","description":"Value","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"description":"The map of headers","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"body":{"type":"array","description":"The map of body values","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/WebRuleEndpointBodyParameterDef","exampleSetFlag":false},"types":["array"]}},"description":"An Api Endpoint Configuration","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ChatSecurityConfigDef":{"type":"object","properties":{"iframeSandbox":{"description":"IFrame Sandbox Security","$ref":"#/components/schemas/ChatIFrameSandboxConfigDef","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"The Chat Security Configuration","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"EmailTranscriptRequest":{"type":"object","properties":{"email":{"maxLength":255,"type":"string","description":"Customer email","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"originUrl":{"type":"string","description":"Url of the chat page","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"timezone":{"description":"The timezone","$ref":"#/components/schemas/Timezone","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"","exampleSetFlag":false,"types":["object"]},"InteractionOptions Metadata":{"type":"object","properties":{"useModernDesign":{"type":"boolean","description":"Render the modern card, carousel and page shell","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"useFullImageHeight":{"type":"boolean","description":"Show carousel card images at full height rather than a cropped shared band","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"How the interaction webview should render this message","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"WebThemeConfigurationMetadata":{"type":"object","properties":{"id":{"type":"string","description":"Id","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"label":{"type":"string","description":"Label","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"quiqOptions":{"type":"string","description":"Quiq Options","nullable":true,"readOnly":false,"extensions":{"x-quiq-skip-validation":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"The fetch theme definition response","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"NotificationConfigurationMetadata":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Blurb Type Enabled","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"autoHideTimeout":{"minimum":10000.0,"type":"integer","description":"Auto-Hide Timeout","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]}},"description":"The notification configuration for an item","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ChatContactEventDef":{"type":"object","properties":{"eventDefinitionId":{"type":"string","description":"The event name of the event","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"time":{"type":"number","description":"The time the event occurred","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"payload":{"type":"object","description":"The event specific payload","nullable":true,"readOnly":false,"extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]}},"description":"A definition for contact events sent to chat.","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"MappedUrl":{"type":"object","properties":{"originalUrl":{"type":"string","description":"Original url","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Url that has been mapped","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"TransferModelMetaData":{"type":"object","properties":{"accessToken":{"type":"string","description":"Access token","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"The metadata for this transfer","exampleSetFlag":false,"types":["object"]},"UnifiedAsset":{"type":"object","properties":{"assetId":{"type":"string","description":"The asset ID","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"contentType":{"type":"string","description":"The content type of the asset","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"publicUrl":{"maxLength":2000,"type":"string","description":"A public URL where the asset can be fetched","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"assetUrl":{"maxLength":2000,"type":"string","description":"A public URL where the asset can be fetched","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"isInappropriate":{"type":"boolean","description":"Whether or not the asset was marked as inappropriate","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"The unified asset object","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"PublicTextMessage":{"type":"object","properties":{"id":{"maxLength":36,"type":"string","description":"The id of the chat message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"type":{"type":"string","description":"The type of the message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["Text"]},"timestamp":{"description":"Timestamp of message","$ref":"#/components/schemas/Timestamp","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"pay":{"description":"QuiqPay definition","$ref":"#/components/schemas/QuiqPay","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"text":{"type":"string","description":"`(When type='Text')` The text body","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"messageAttributes":{"description":"Attributes for the message","$ref":"#/components/schemas/QuiqMessageAttributes","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"platformProperties":{"description":"Platform specific properties","$ref":"#/components/schemas/PlatformProperties","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"links":{"type":"array","description":"`(When type='Text')` The message links","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/ChatMessageLink","exampleSetFlag":false},"types":["array"]},"paymentSession":{"description":"An optional payment session object","$ref":"#/components/schemas/CreatePaymentSessionResponse","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"carousel":{"description":"Quiq Carousel definition","$ref":"#/components/schemas/ChatCarouselDef","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"timezone":{"maxLength":40,"type":"string","description":"`(When type='Text')` The timezone assigned to the contact point","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"authorType":{"type":"string","description":"`(When type='Text')` Who wrote this message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["Customer","User","System"]},"mappedUrls":{"type":"object","properties":{},"additionalProperties":{"$ref":"#/components/schemas/MappedUrl","exampleSetFlag":false},"description":"`(When type='Text')` Set if urls in message are mapped from other original urls","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"rawUrls":{"type":"array","description":"`(When type='Text')` The raw links","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"type":"string","description":"A url","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"types":["array"]},"externalId":{"type":"string","description":"`(When type='Text')` The external id of the message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"quiqReply":{"description":"Suggested reply messages for the recipient","$ref":"#/components/schemas/QuiqReply","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"card":{"description":"QuiqCard definition","$ref":"#/components/schemas/ChatCardDef","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"directives":{"description":"Optional reply directives such as data bindings","$ref":"#/components/schemas/RichReplyDirectives","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"postbackData":{"type":"object","description":"`(When type='Text')` Optional json that will be populated if this message is in reply to an item that was sent with postback data.","nullable":true,"readOnly":false,"extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"authorProfilePicture":{"type":"string","description":"`(When type='Text')` The author's profile picture url","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"assets":{"type":"array","description":"`(When type='Text')` The message assets","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/UnifiedAsset","exampleSetFlag":false},"types":["array"]},"richText":{"description":"The rich text body","$ref":"#/components/schemas/QuiqRichText","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"authorDisplayName":{"maxLength":120,"minLength":1,"type":"string","description":"`(When type='Text')` The author's display name","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"times":{"description":"A collection of time items, which are similar to calendar events.","$ref":"#/components/schemas/QuiqTimes","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"inResponseTo":{"maxLength":36,"type":"string","description":"`(When type='Text')` The optional message ID that this message is in response to","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"auth":{"description":"QuiqAuth definition","$ref":"#/components/schemas/ChatQuiqAuth","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"proxyInteraction":{"description":"A proxy interaction","$ref":"#/components/schemas/ProxyInteraction","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"authorDetails":{"description":"Details about who wrote this message","$ref":"#/components/schemas/MessageAuthorDetails","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"transcriptHints":{"description":"Transcript hints","$ref":"#/components/schemas/MessageTranscriptHints","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"choiceResponse":{"description":"Optional context associated with the selected carousel item","$ref":"#/components/schemas/InboundChoiceResponseContext","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"A PublicTextMessage message","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"WebSocketInfo":{"type":"object","properties":{"url":{"type":"string","description":"The url to establish a websocket connection on","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"protocol":{"type":"string","description":"The websocket protocol to use","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Information to connect a websocket connection","exampleSetFlag":false,"types":["object"]},"PriorityConfigurationDef":{"type":"object","properties":{"fallback":{"type":"array","description":"The fallback priority","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/MessagePlatform","exampleSetFlag":false},"types":["array"]},"desktop":{"type":"array","description":"The desktop priority","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/MessagePlatform","exampleSetFlag":false},"types":["array"]},"ios":{"type":"array","description":"The iOS priority","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/MessagePlatform","exampleSetFlag":false},"types":["array"]},"android":{"type":"array","description":"The Android priority","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/MessagePlatform","exampleSetFlag":false},"types":["array"]},"treatTabletsAsMobile":{"type":"boolean","description":"Whether to consider tablets as mobile devices or not","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"The priority configuration","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ButtonSelection":{"type":"object","properties":{"cardIndex":{"type":"integer","description":"The index of the card, if this button was on a card in a carousel.","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"buttonIndex":{"type":"integer","description":"The index of the button","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]}},"description":"Information regarding what button was selected","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"AttachmentChatMessageRequest":{"type":"object","properties":{"uploadId":{"maxLength":36,"minLength":36,"type":"string","description":"The attachment upload ID","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"externalId":{"type":"string","description":"The external ID","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"context":{"description":"Current conversation context","$ref":"#/components/schemas/ChatConversationContext","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"fields":{"type":"array","description":"The chat contact point","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/FieldUpdate","exampleSetFlag":false},"types":["array"]}},"description":"Post an attachment message","exampleSetFlag":false,"types":["object"]},"UploadDef":{"type":"object","properties":{"uploadId":{"maxLength":36,"minLength":36,"type":"string","description":"The identifier for this upload","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"directive":{"description":"Directives for this upload","$ref":"#/components/schemas/UploadDirective","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"An upload object","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"LinkTrackEventRequest":{"type":"object","description":"Post a linkTrack event","exampleSetFlag":false,"types":["object"]},"MessageDefinitionInstance":{"type":"object","properties":{"version":{"type":"string","description":"The Message Definition's version","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"message":{"description":"The Message","$ref":"#/components/schemas/ChatQuiqMessageDef","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"A message definition instance","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"TypingNotificationRequest":{"type":"object","properties":{"typing":{"type":"boolean","description":"True to indicate customer started or continued typing, False to indicate done typing.","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"text":{"maxLength":1024,"type":"string","description":"(Applicable if typing = true) - The text typed so far","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"","exampleSetFlag":false,"types":["object"]},"FetchMessageRequestMetadata":{"type":"object","description":"The fetch message request definition","exampleSetFlag":false,"types":["object"]},"GoogleAnalyticsConfigDef":{"type":"object","properties":{"isEnabled":{"type":"boolean","description":"Is Google Analytics Enabled","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"events":{"description":"The enabled events to track in Google Analytics","$ref":"#/components/schemas/GoogleAnalyticsEventsDef","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"measurementId":{"type":"string","description":"Optional Google Analytics Measurement Id","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"excludedWidgetIds":{"type":"array","description":"Optional widget id list to ignore posting events to Google Analytics","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"type":"string","description":"Widget Id","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"types":["array"]},"excludedContactPoints":{"type":"array","description":"Optional contact point list to ignore posting events to Google Analytics","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"type":"string","description":"Contact Point","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"types":["array"]}},"description":"The Google Analytics Configuration","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"WidgetConfigurationMetadata":{"type":"object","properties":{"contactPoint":{"type":"string","description":"Contact Point","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"platform":{"description":"Platform","$ref":"#/components/schemas/MessagePlatform","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"element":{"type":"string","description":"Element","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"layout":{"type":"string","description":"Layout","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"position":{"type":"string","description":"Position","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"template":{"type":"string","description":"Template","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"id":{"type":"string","description":"Id","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"label":{"type":"string","description":"Label","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"styles":{"type":"string","description":"Styles","nullable":true,"readOnly":false,"extensions":{"x-quiq-skip-validation":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"theme":{"description":"Theme","$ref":"#/components/schemas/ThemeConfigurationMetadata","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"context":{"description":"Context","$ref":"#/components/schemas/ContextConfigConfigurationMetadata","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"notificationBlurb":{"description":"Notification Blurb","$ref":"#/components/schemas/NotificationConfigurationMetadata","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"platformSelector":{"description":"Platform Selector","$ref":"#/components/schemas/PlatformSelectorConfiguration","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"ruleBaseId":{"maxLength":64,"type":"string","description":"Web rule Base Id","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"themeId":{"maxLength":255,"type":"string","description":"Web theme Id","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"useAsEntryPoint":{"type":"boolean","description":"Use as Entry Point","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"autoStartWebchatOnEntryPointAccessed":{"type":"boolean","description":"Auto-start Webchat on Entry Point Accessed","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"initialMessage":{"type":"string","description":"Initial Message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"platformPriorityOverrides":{"description":"Platform Priority Overrides","$ref":"#/components/schemas/PriorityConfigurationDef","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"The fetch widget definition response","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"WebsocketChatMessage":{"type":"object","properties":{"id":{"maxLength":36,"type":"string","description":"The id of the chat message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"type":{"type":"string","description":"The type of the message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["Text","Join","Leave","Register","SendTranscript","DownloadTranscript","End","Spam","Attachment","Failed","CustomerTyping","AgentTyping","AgentThinking","Rich","CoBrowse"]},"timestamp":{"description":"Timestamp of message","$ref":"#/components/schemas/Timestamp","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"errorCode":{"type":"integer","description":"`(When type='Failed')` The optional error code\n\n|Error Code|Description|\n|-|-|\n|11001|An unknown error occurred|\n|11002|The upload was marked as infected|\n|11003|The upload's content type is not allowed|\n|11004|Unable to find upload|\n|11005|The upload's content length is zero|\n|10006|The upload's content length exceeds the limit|","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"pay":{"description":"QuiqPay definition","$ref":"#/components/schemas/QuiqPay","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"text":{"type":"string","description":"`(When type='Text' or 'CustomerTyping')` The text body","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"ttlMillis":{"type":"number","description":"`(When type='AgentThinking')` How long to show each line whose ttlMillis is null, in milliseconds: the caller's sequence ttl, else the configured default. Null means neither is set: apply your own default (the chat window uses 5000, and lets the page's defaults and presets beat this value)","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"typing":{"type":"boolean","description":"`(When type='CustomerTyping' or 'AgentTyping')` Whether or not the user is typing","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"messageAttributes":{"description":"Attributes for the message","$ref":"#/components/schemas/QuiqMessageAttributes","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"platformProperties":{"description":"Platform specific properties","$ref":"#/components/schemas/PlatformProperties","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"thinking":{"type":"boolean","description":"`(When type='AgentThinking')` True to show the sequence, false to clear whatever is showing","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"links":{"type":"array","description":"`(When type='Text')` The message links","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/ChatMessageLink","exampleSetFlag":false},"types":["array"]},"paymentSession":{"description":"An optional payment session object","$ref":"#/components/schemas/CreatePaymentSessionResponse","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"carousel":{"description":"Quiq Carousel definition","$ref":"#/components/schemas/ChatCarouselDef","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"timezone":{"maxLength":40,"type":"string","description":"`(When type='Text')` The timezone assigned to the contact point","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"authorType":{"type":"string","description":"`(When type='AgentTyping' or 'Text' or 'Spam' or 'Attachment' or 'AgentThinking' or 'End')` Who wrote this message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["Customer","User","System"]},"mappedUrls":{"type":"object","properties":{},"additionalProperties":{"$ref":"#/components/schemas/MappedUrl","exampleSetFlag":false},"description":"`(When type='Text')` Set if urls in message are mapped from other original urls","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"rawUrls":{"type":"array","description":"`(When type='Text')` The raw links","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"type":"string","description":"A url","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"types":["array"]},"externalId":{"type":"string","description":"`(When type='Text' or 'Attachment')` The external id of the message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"url":{"type":"string","description":"`(When type='Attachment')` The URL of the file attachment","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"description":{"maxLength":256,"type":"string","description":"`(When type='Attachment')` Optional description for the attachment","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"quiqReply":{"description":"Suggested reply messages for the recipient","$ref":"#/components/schemas/QuiqReply","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"card":{"description":"QuiqCard definition","$ref":"#/components/schemas/ChatCardDef","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"preset":{"type":"string","description":"`(When type='AgentThinking')` The sequence's preset name. Null: none. Preset names are chosen by the caller and defined by the web chat page (its webchat JSON, agentThinking.presets; see [Agent Thinking web chat options](/docs/conversation-starter/#/webchat/advanced/agent_thinking)); the frame carries no settings for them. Treat the name, like the text and ttls, as untrusted input","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"directives":{"description":"Optional reply directives such as data bindings","$ref":"#/components/schemas/RichReplyDirectives","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"postbackData":{"type":"object","description":"`(When type='Text')` Optional json that will be populated if this message is in reply to an item that was sent with postback data.","nullable":true,"readOnly":false,"extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"authorProfilePicture":{"type":"string","description":"`(When type='Text' or 'Attachment' or 'AgentTyping' or 'AgentThinking')` The author's profile picture url","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"assets":{"type":"array","description":"`(When type='Text')` The message assets","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/UnifiedAsset","exampleSetFlag":false},"types":["array"]},"richText":{"description":"The rich text body","$ref":"#/components/schemas/QuiqRichText","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"authorDisplayName":{"maxLength":120,"minLength":1,"type":"string","description":"`(When type='Text' or 'Attachment' or 'AgentTyping' or 'AgentThinking')` The author's display name","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"times":{"description":"A collection of time items, which are similar to calendar events.","$ref":"#/components/schemas/QuiqTimes","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"contentType":{"type":"string","description":"`(When type='Attachment')` The content type of the file attachment","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"inResponseTo":{"maxLength":36,"type":"string","description":"`(When type='Text')` The optional message ID that this message is in response to","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"messages":{"type":"array","description":"`(When type='AgentThinking')` The sequence to show, in order. Empty when thinking is false","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/AgentThinkingMessageLine","exampleSetFlag":false},"types":["array"]},"auth":{"description":"QuiqAuth definition","$ref":"#/components/schemas/ChatQuiqAuth","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"proxyInteraction":{"description":"A proxy interaction","$ref":"#/components/schemas/ProxyInteraction","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"authorDetails":{"description":"Details about who wrote this message","$ref":"#/components/schemas/MessageAuthorDetails","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"transcriptHints":{"description":"Transcript hints","$ref":"#/components/schemas/MessageTranscriptHints","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"choiceResponse":{"description":"Optional context associated with the selected carousel item","$ref":"#/components/schemas/InboundChoiceResponseContext","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"A WebsocketChatMessage message","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"MessageDefinitionReference":{"type":"object","properties":{"definitionId":{"maxLength":36,"type":"string","description":"The Message Definition ID","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"version":{"type":"string","description":"The optional Message Definition version ID","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"A reference to a Message Definition object","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"PreConversationContactEvent":{"type":"object","properties":{"eventName":{"type":"string","description":"The event name of the event","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"time":{"type":"number","description":"The time the event occurred","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"payload":{"type":"object","description":"The event specific payload","nullable":true,"readOnly":false,"extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"transcriptHints":{"description":"Information for the client to display on the contact transcript","$ref":"#/components/schemas/EventTranscriptHints","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"Context for an event that occurred before the conversation started.","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"TranscriptVisibilityOptions":{"type":"object","properties":{"transcriptHintsOnly":{"type":"boolean","description":"Whether or not to display this message using only transcript hints.","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"Transcript Visibility Options","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ContactPointMetadata":{"type":"object","properties":{"registrationForm":{"description":"Registration form definition","$ref":"#/components/schemas/ChatFormDefinition","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"registrationFormVersionId":{"type":"string","description":"An optional version ID that corresponds to the registration form to be submitted.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"configs":{"type":"object","properties":{},"additionalProperties":{"type":"string","description":"Chat config value","extensions":{"x-quiq-skip-validation":true,"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"description":"Webchat configuration","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"tenantId":{"type":"string","description":"Tenant Id for this contact point","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"contactPointLabel":{"type":"string","description":"Label for this contact point","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"leastLoadedNumber":{"description":"The least loaded phone number for this contact point (contact Quiq Support to get this populated). ","$ref":"#/components/schemas/LeastLoadedNumberMetadata","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"The metadata for this contact point","exampleSetFlag":false,"types":["object"]},"ChatMessageLink":{"type":"object","properties":{"title":{"type":"string","description":"The link's title","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"type":{"type":"string","description":"The link type (e.g. website) if available","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"siteName":{"type":"string","description":"The name of the website if available","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"description":{"type":"string","description":"The link description if available","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"icon":{"description":"The link icon if available","$ref":"#/components/schemas/MessageLinkMedia","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"image":{"description":"The link image if available","$ref":"#/components/schemas/MessageLinkMedia","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"video":{"description":"The link video if available","$ref":"#/components/schemas/MessageLinkMedia","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"originalUrl":{"maxLength":2000,"type":"string","description":"The original URL that the message link came from","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"A chat message link object","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"PreConversationMessage":{"type":"object","properties":{"messageDefinition":{"description":"MessageDefinition","$ref":"#/components/schemas/MessageDefinitionReference","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"timestamp":{"description":"Timestamp","$ref":"#/components/schemas/Timestamp","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"externalId":{"type":"string","description":"External Id","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"variableReplacementContext":{"description":"Variable Replacement Context","$ref":"#/components/schemas/PreConversationVariableReplacementContext","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"Context for a message that occurred before the conversation started.","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"QuiqMessageAttributes":{"type":"object","properties":{"cssClassName":{"type":"string","description":"Class name used for CSS styling on end-user platforms. Currently only applicable on Webchat","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"excludeFromLinkScraping":{"type":"boolean","description":"Whether or not to exclude this message from link scraping.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"excludeFromLinkTracking":{"type":"boolean","description":"Whether or not to exclude this message from link tracking. Links are sent as written even when link tracking is enabled.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"isInterruptable":{"type":"boolean","description":"Allow this message to be interrupted by the end user (Voice only). By default this is the behavior for messages containing Quiq Replies.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"transcriptVisibilityOptions":{"description":"Options to specify the visibility of this message when displayed in transcripts","$ref":"#/components/schemas/TranscriptVisibilityOptions","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"chatDisplayOptions":{"description":"Options to specify the visibility of this message when displayed in transcripts","$ref":"#/components/schemas/ChatDisplayOptions","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"alignment":{"type":"string","description":"Alignment of the message in the end user transcript. Currently only applicable on Webchat","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["left","right","center"]}},"description":"Message attributes for the messages","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ChatContextData":{"type":"object","description":"Custom context data attached to the conversation","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"QuiqPayResponseDef":{"type":"object","properties":{"result":{"description":"The result","$ref":"#/components/schemas/QuiqPayResult","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"lineItems":{"type":"array","description":"The line items for the transaction, if you wish to override ","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/QuiqPayAmount","exampleSetFlag":false},"types":["array"]},"metadata":{"type":"object","properties":{},"additionalProperties":{"type":"string","description":"Metadata Value","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"description":"An optional metadata map, if you wish to override","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]}},"description":"The quiq pay response","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"InboundChoiceResponseContext":{"type":"object","properties":{"promptingMessageId":{"maxLength":36,"type":"string","description":"The message ID that prompted this selection","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"chosenItemIndex":{"type":"integer","description":"The index of the chosen item","format":"int32","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"chosenItemIndexes":{"type":"array","description":"The indexes of the chosen items","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"type":"integer","description":"The chosen index","format":"int32","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["integer"]},"types":["array"]}},"description":"The response context for a selected carousel item","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"MessageAuthorDetails":{"type":"object","properties":{"authorDisplayName":{"maxLength":120,"minLength":1,"type":"string","description":"The author's display name","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"authorProfilePicture":{"type":"string","description":"The author's profile picture url","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"authorType":{"type":"string","description":"Who wrote this message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["Customer","User","System"]},"isBot":{"type":"boolean","description":"Whether or not the author is a bot","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"Details about the message author","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"InstrumentData":{"type":"object","properties":{"chargeEndpoint":{"type":"string","description":"The endpoint at which the charge will occur","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"clientTokenEndpoint":{"type":"string","description":"The endpoint at which a client token can be returned","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"instrumentSession":{"type":"string","description":"The optional raw instrument session data","nullable":true,"readOnly":false,"extensions":{"x-quiq-skip-validation":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"instrumentMerchantIdentifier":{"type":"string","description":"The optional instrument merchant identifier","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"The payment instrument data","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ChatConversationContext":{"type":"object","properties":{"intent":{"maxLength":255,"type":"string","description":"The intent of the conversation","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"data":{"description":"Custom data","$ref":"#/components/schemas/ChatContextData","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"shopify":{"description":"Shopify data associated with the chat conversation","$ref":"#/components/schemas/ShopifyChatContext","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"storedContextId":{"type":"string","description":"The stored context id of the conversation","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"expectedStoredContext":{"description":"The expected stored context that the storedContextId should equate to","$ref":"#/components/schemas/HallpassContext","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"The context currently associated with a chat conversation","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"EntryPointAccessedResponse":{"type":"object","properties":{"eventId":{"type":"string","description":"The event ID","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Response after recording an entry point access","exampleSetFlag":false,"types":["object"]},"AssetUploadDirectiveFormEntry":{"type":"object","properties":{"name":{"type":"string","description":"The name of this form field","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"value":{"type":"string","description":"The value to be associated with this form entry","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"A form entry included as part of an upload directive","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"PlatformProxyResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Did the call succeed","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"A response object when requesting a proxy chat","exampleSetFlag":false,"types":["object"]},"StorageMode":{"type":"string","description":"Storage mode","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["local","session","temporary"]},"ChatFormDefinition":{"type":"object","properties":{"headerText":{"type":"string","description":"Header text for the form","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"fields":{"type":"array","description":"The form input field definitions","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/ChatFormField","exampleSetFlag":false},"types":["array"]},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"string","description":"Additional property value","extensions":{"x-quiq-skip-validation":true,"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"description":"The additional properties of the form","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]}},"description":"A chat form definition","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"EventTranscriptHints":{"type":"object","properties":{"heading1":{"type":"string","description":"The first heading to display","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"heading2":{"type":"string","description":"The second heading to display","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"description":{"type":"string","description":"The description to display","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Event Transcript Hints","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"PublicProcessorDefinition":{"type":"object","properties":{"processorType":{"type":"string","description":"The payment processor type","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["stripe","brain-tree","custom"]},"supportedInstruments":{"uniqueItems":true,"type":"array","description":"The supported payment instruments","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"type":"string","description":"The payment instrument","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["apple_pay_web","apple_pay_abc","google_pay","card"]},"types":["array"]},"supportedNetworks":{"uniqueItems":true,"type":"array","description":"The supported payment networks","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"type":"string","description":"The payment network","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["mastercard","amex","discover","diners_club","visa"]},"types":["array"]},"publicKey":{"type":"string","description":"An optional public key","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"googlePay":{"description":"Optional Google Pay options","$ref":"#/components/schemas/GooglePayOptions","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"stripe":{"description":"The optional public Stripe configuration","$ref":"#/components/schemas/PublicStripeConfigurationMeta","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"custom":{"description":"The optional public custom configuration","$ref":"#/components/schemas/PublicCustomConfigurationMeta","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"A public processor definition object","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"MessageLinkMedia":{"type":"object","properties":{"url":{"maxLength":2000,"type":"string","description":"The URL of the media","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"assetId":{"type":"string","description":"The quiq asset id of the media","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"An object describing message link media","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"TransferResponseDef":{"type":"object","properties":{"transferUrl":{"type":"string","description":"Transfer Url","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"The metadata for this transfer","exampleSetFlag":false,"types":["object"]},"MessageWrapper Metadata":{"type":"object","properties":{"message":{"description":"The message","$ref":"#/components/schemas/PublicTextMessage","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"response":{"description":"The optional response message","$ref":"#/components/schemas/PublicTextMessage","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"customerPlatform":{"description":"The optional messaging platform used by the customer for this message","$ref":"#/components/schemas/CustomerPlatformMeta","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"interactionOptions":{"description":"Optional rendering options for the interaction webview","$ref":"#/components/schemas/InteractionOptions Metadata","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"The metadata the message wrapper","exampleSetFlag":false,"types":["object"]},"HallpassContext":{"type":"object","properties":{"integrations":{"type":"array","description":"Integration references","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/IntegrationReference","exampleSetFlag":false},"types":["array"]},"fieldUpdates":{"type":"array","description":"A sequence of field updates","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/FieldUpdate","exampleSetFlag":false},"types":["array"]}},"description":"The context to store","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ChatContactEventsResponse":{"type":"object","properties":{"events":{"type":"array","description":"The intent of the conversation","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/ChatContactEventDef","exampleSetFlag":false},"types":["array"]}},"description":"Response containing Contact Events","exampleSetFlag":false,"types":["object"]},"UpdateFieldsRequest":{"type":"object","properties":{"fields":{"type":"array","description":"The chat contact point","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/FieldUpdate","exampleSetFlag":false},"types":["array"]}},"description":"","exampleSetFlag":false,"types":["object"]},"RatingDisplayRenderer":{"type":"object","properties":{"ratingDisplayType":{"type":"string","description":"Rating Control","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["stars"]},"reverseBindingOrder":{"type":"boolean","description":"Reverse Binding Order","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"Rating Display Renderer","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"GooglePayOptions":{"type":"object","properties":{"merchantId":{"type":"string","description":"The optional merchant ID","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"A Google Pay options object","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ChatQuiqMessageDef":{"type":"object","properties":{"text":{"type":"string","description":"Text for the messsage","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"richText":{"description":"Rich text for the messsage","$ref":"#/components/schemas/QuiqRichText","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"proxyInteraction":{"description":"A proxy interaction","$ref":"#/components/schemas/ProxyInteraction","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"quiqReply":{"description":"Suggested reply messages for the recipient","$ref":"#/components/schemas/QuiqReply","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"card":{"description":"QuiqCard definition","$ref":"#/components/schemas/ChatCardDef","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"carousel":{"description":"QuiqCarousel definition","$ref":"#/components/schemas/ChatCarouselDef","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"pay":{"description":"QuiqPay definition","$ref":"#/components/schemas/QuiqPay","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"auth":{"description":"QuiqAuth definition","$ref":"#/components/schemas/QuiqAuth","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"times":{"description":"A collection of time items, which are similar to calendar events.","$ref":"#/components/schemas/QuiqTimes","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"assets":{"type":"array","description":"The assets","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/UnifiedAsset","exampleSetFlag":false},"types":["array"]},"transcriptHints":{"description":"Transcript hints","$ref":"#/components/schemas/MessageTranscriptHints","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"directives":{"description":"Optional reply directives such as data bindings","$ref":"#/components/schemas/RichReplyDirectives","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"followUpSettings":{"description":"Whether or not this message requires an additional follow-up message from an agent","$ref":"#/components/schemas/FollowUpSettings","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"surveySolicitation":{"description":"Mark this message as a solicitation for a specified survey","$ref":"#/components/schemas/MessageSurveySolicitation","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"postbackData":{"type":"object","description":"Optional json that will be populated if this message is in reply to an item that was sent with postback data.","nullable":true,"readOnly":false,"extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"platformProperties":{"description":"Platform specific properties","$ref":"#/components/schemas/PlatformProperties","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"magicMessageDetails":{"description":"Quiq compose details","$ref":"#/components/schemas/MagicMessageDetailsMeta","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"platformInvitation":{"description":"QuiqPlatformInvitation definition","$ref":"#/components/schemas/QuiqPlatformInvitation","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"A message definition for chat messages.","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"PageConfigurationMetadata":{"type":"object","properties":{"id":{"type":"string","description":"Page Configuration ID","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"contactPoint":{"type":"string","description":"Contact Point","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"priorityConfiguration":{"description":"Priority Configuration","$ref":"#/components/schemas/PriorityConfigurationDef","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"tenantId":{"type":"string","description":"Tenant ID","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"widgets":{"type":"array","description":"Widgets","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/WidgetConfigurationMetadata","exampleSetFlag":false},"types":["array"]},"defaultWidgetId":{"type":"string","description":"Default Widget Id","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"storageMode":{"description":"StorageMode","$ref":"#/components/schemas/StorageMode","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"ruleBases":{"type":"object","properties":{},"additionalProperties":{"type":"string","description":"Web rule base","extensions":{"x-quiq-skip-validation":true,"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"description":"RuleBases","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"messageDefinitions":{"type":"object","properties":{},"additionalProperties":{"$ref":"#/components/schemas/MessageDefinitionInstance","exampleSetFlag":false},"description":"MessageDefinitions","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"themes":{"type":"object","properties":{},"additionalProperties":{"$ref":"#/components/schemas/WebThemeConfigurationMetadata","exampleSetFlag":false},"description":"Themes","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"isSinglePageAppEnabled":{"type":"boolean","description":"Is Single Page App Enabled","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"googleAnalytics":{"description":"Google Analytics Configuration","$ref":"#/components/schemas/GoogleAnalyticsConfigDef","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"security":{"description":"Chat Secutiry Configuration","$ref":"#/components/schemas/ChatSecurityConfigDef","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"apiEndPoints":{"type":"object","properties":{},"additionalProperties":{"$ref":"#/components/schemas/WebRuleEndpointRegistrationDef","exampleSetFlag":false},"description":"Api End Points","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]}},"description":"The configuration for this page configurationID","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"WebRuleEndpointBodyParameterDef":{"type":"object","properties":{"valueLocation":{"type":"string","description":"The path to where the value comes from","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"endpointProperty":{"type":"string","description":"The property on the body the value is set on","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"valueType":{"type":"string","description":"The value type","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"An Api Endpoint Body Parameter","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"Registration":{"type":"object","properties":{"form":{"type":"object","properties":{},"additionalProperties":{"maxLength":4096,"type":"string","description":"The form data value","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"description":"Results of the form","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"formVersionId":{"type":"string","description":"The version ID of the registration form registered with Quiq","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Registration form data","exampleSetFlag":false,"types":["object"]},"ChatIFrameSandboxConfigDef":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Is IFrame Sandbox Security Enabled","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"storage":{"type":"array","description":"List of permissions to enable for the storage iframe","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"type":"string","description":"A permission","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"types":["array"]},"webchat":{"type":"array","description":"List of permissions to enable for the storage iframe","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"type":"string","description":"A permission","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"types":["array"]}},"description":"The Chat IFrame Sandbox Security Configuration","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"MessageIdResult":{"type":"object","properties":{"id":{"maxLength":36,"type":"string","description":"The id of the chat message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"timestamp":{"description":"The time in milliseconds since the epoch at which this message was created","$ref":"#/components/schemas/Timestamp","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"The result with an ID that corresponds to a chat message id","exampleSetFlag":false,"types":["object"]},"LeastLoadedNumberMetadata":{"type":"object","properties":{"number":{"type":"string","description":"The least loaded phone number (null if none was available)","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"The metadata for the least loaded number","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ThemeStylesConfigurationMetadata":{"type":"object","properties":{"ToggleChatButton":{"type":"string","description":"Toggle Chat Button","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"ToggleChatButtonIcon":{"type":"string","description":"ToggleChatButton Icon","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"The theme styles configuration","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ChatFormField":{"type":"object","properties":{"type":{"type":"string","description":"The type of the input field","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"label":{"type":"string","description":"The label for the input field","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"description":{"type":"string","description":"The optional description of the field","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"id":{"type":"string","description":"The id of the input field","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"required":{"type":"boolean","description":"True if the input is required","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"numRows":{"minimum":0,"type":"integer","description":"Number of input rows","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"isInitialMessage":{"type":"boolean","description":"Whether or not the response to this field should be used as the initial message for the conversation","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"string","description":"Additional property value","extensions":{"x-quiq-skip-validation":true,"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"description":"The additional properties of the field","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]}},"description":"A field within a chat form","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"PreConversationVariableReplacementContext":{"type":"object","properties":{"conversation":{"description":"Conversation Data","$ref":"#/components/schemas/ConversationDataForPreConversationContext","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"Context for variable replacement.","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ChatMessage":{"type":"object","properties":{"id":{"maxLength":36,"type":"string","description":"The id of the chat message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"type":{"type":"string","description":"The type of the message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["Text","Join","Leave","Register","SendTranscript","DownloadTranscript","End","Spam","Attachment","CoBrowse"]},"timestamp":{"description":"Timestamp of message","$ref":"#/components/schemas/Timestamp","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"pay":{"description":"QuiqPay definition","$ref":"#/components/schemas/QuiqPay","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"text":{"type":"string","description":"`(When type='Text')` The text body","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"messageAttributes":{"description":"Attributes for the message","$ref":"#/components/schemas/QuiqMessageAttributes","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"platformProperties":{"description":"Platform specific properties","$ref":"#/components/schemas/PlatformProperties","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"links":{"type":"array","description":"`(When type='Text')` The message links","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/ChatMessageLink","exampleSetFlag":false},"types":["array"]},"paymentSession":{"description":"An optional payment session object","$ref":"#/components/schemas/CreatePaymentSessionResponse","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"carousel":{"description":"Quiq Carousel definition","$ref":"#/components/schemas/ChatCarouselDef","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"timezone":{"maxLength":40,"type":"string","description":"`(When type='Text')` The timezone assigned to the contact point","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"authorType":{"type":"string","description":"`(When type='Text' or 'End' or 'Spam' or 'Attachment')` Who wrote this message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["Customer","User","System"]},"mappedUrls":{"type":"object","properties":{},"additionalProperties":{"$ref":"#/components/schemas/MappedUrl","exampleSetFlag":false},"description":"`(When type='Text')` Set if urls in message are mapped from other original urls","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"rawUrls":{"type":"array","description":"`(When type='Text')` The raw links","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"type":"string","description":"A url","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"types":["array"]},"externalId":{"type":"string","description":"`(When type='Text' or 'Attachment')` The external id of the message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"url":{"type":"string","description":"`(When type='Attachment')` The URL of the file attachment","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"description":{"maxLength":256,"type":"string","description":"`(When type='Attachment')` Optional description for the attachment","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"quiqReply":{"description":"Suggested reply messages for the recipient","$ref":"#/components/schemas/QuiqReply","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"card":{"description":"QuiqCard definition","$ref":"#/components/schemas/ChatCardDef","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"directives":{"description":"Optional reply directives such as data bindings","$ref":"#/components/schemas/RichReplyDirectives","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"postbackData":{"type":"object","description":"`(When type='Text')` Optional json that will be populated if this message is in reply to an item that was sent with postback data.","nullable":true,"readOnly":false,"extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"authorProfilePicture":{"type":"string","description":"`(When type='Text' or 'Attachment')` The author's profile picture url","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"assets":{"type":"array","description":"`(When type='Text')` The message assets","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/UnifiedAsset","exampleSetFlag":false},"types":["array"]},"richText":{"description":"The rich text body","$ref":"#/components/schemas/QuiqRichText","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"authorDisplayName":{"maxLength":120,"minLength":1,"type":"string","description":"`(When type='Text' or 'Attachment')` The author's display name","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"times":{"description":"A collection of time items, which are similar to calendar events.","$ref":"#/components/schemas/QuiqTimes","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"contentType":{"type":"string","description":"`(When type='Attachment')` The content type of the file attachment","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"inResponseTo":{"maxLength":36,"type":"string","description":"`(When type='Text')` The optional message ID that this message is in response to","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"auth":{"description":"QuiqAuth definition","$ref":"#/components/schemas/ChatQuiqAuth","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"proxyInteraction":{"description":"A proxy interaction","$ref":"#/components/schemas/ProxyInteraction","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"authorDetails":{"description":"Details about who wrote this message","$ref":"#/components/schemas/MessageAuthorDetails","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"transcriptHints":{"description":"Transcript hints","$ref":"#/components/schemas/MessageTranscriptHints","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"choiceResponse":{"description":"Optional context associated with the selected carousel item","$ref":"#/components/schemas/InboundChoiceResponseContext","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"A ChatMessage message","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ChatQuiqAuth":{"type":"object","properties":{"configurationId":{"type":"string","description":"The identifier for the auth configuration to be used","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"successMessage":{"type":"string","description":"An optional message to be shown to the end user upon successful authentication","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"failureMessage":{"type":"string","description":"An optional message to be shown to the end user upon failed authentication","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"identity":{"description":"The identity of the end user","$ref":"#/components/schemas/QuiqAuthIdentity","nullable":true,"readOnly":true,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"url":{"type":"string","description":"The URL at which the end user provides their identity","nullable":true,"readOnly":true,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"redirectUrlOverride":{"maxLength":2000,"type":"string","description":"The optional URL to redirect to after authentication completion.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"signInLabel":{"type":"string","description":"An optional label to apply to the sign in button (Chat only)","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"declineLabel":{"type":"string","description":"An optional label to the decline button (Chat only - if not provided, no decline button will be shown)","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"A chat message auth object","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"PublicCustomConfigurationMeta":{"type":"object","properties":{"paymentCollectionUrl":{"type":"string","description":"The endpoint at which payment collection occurs","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"A public custom payment configuration object","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"DownloadTranscriptResponse":{"type":"object","properties":{"transcript":{"type":"string","description":"Transcript","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"DownloadTranscriptResponse","exampleSetFlag":false,"types":["object"]},"GoogleAnalyticsEventsDef":{"type":"object","properties":{"actionButtonShown":{"type":"boolean","description":"Action Button Shown","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"actionButtonHidden":{"type":"boolean","description":"Action Button Hidden","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"chatBecameAvailable":{"type":"boolean","description":"Chat Became Available","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"chatBecameUnavailable":{"type":"boolean","description":"Chat Became Unavailable","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"notificationBlurbShown":{"type":"boolean","description":"Notification Blurb Shown","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"notificationBlurbHidden":{"type":"boolean","description":"Notification Blurb Hidden","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"userEngagedWithChat":{"type":"boolean","description":"User Engaged with Chat","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"webchatOpened":{"type":"boolean","description":"Webchat Opened","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"webchatClosed":{"type":"boolean","description":"Webchat Closed","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"welcomeFormShown":{"type":"boolean","description":"Welcome Form Shown","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"welcomeFormSubmitted":{"type":"boolean","description":"Welcome Form Submitted","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"transcriptShown":{"type":"boolean","description":"Transcript Shown","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"conversationBegan":{"type":"boolean","description":"Conversation Began","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"conversationEnded":{"type":"boolean","description":"Conversation Ended","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"webviewOpened":{"type":"boolean","description":"Webview Opened","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"webviewClosed":{"type":"boolean","description":"Webview Closed","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"ruleTriggered":{"type":"boolean","description":"Rule Triggered","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"customEventTriggered":{"type":"boolean","description":"Custom Event Triggered","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"agentJoined":{"type":"boolean","description":"Agent Joined","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"platformSelectorOpened":{"type":"boolean","description":"Platform Selector Opened","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"platformSelectorClosed":{"type":"boolean","description":"Platform Selector Closed","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"platformSelectorPlatformSelected":{"type":"boolean","description":"Platform Selector Platform Selected","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"The Google Analytics Events Configuration","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ChatContactEventRequest":{"type":"object","properties":{"from":{"description":"The unix timestamp for the beginning of search interval","$ref":"#/components/schemas/Timestamp","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"to":{"description":"The unix timestamp for the end of search interval","$ref":"#/components/schemas/Timestamp","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"Request for Contact Events in a given time range","exampleSetFlag":false,"types":["object"]},"PublicQuiqTimesItem":{"type":"object","properties":{"startTime":{"description":"When the time event starts as a Unix timestamp","$ref":"#/components/schemas/Timestamp","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"durationSeconds":{"minimum":0,"type":"integer","description":"The duration of the time event in seconds","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]}},"description":"Quiq time item","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"CustomInteractionLinkRequest":{"type":"object","description":"A request object that's tied to a message id","exampleSetFlag":false,"types":["object"]},"TextChatMessageRequest":{"type":"object","properties":{"text":{"maxLength":1024,"type":"string","description":"The text body of the message.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"responseMessageId":{"maxLength":36,"type":"string","description":"Message ID that this message is in response to","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"times":{"description":"Response to a times solicitation","$ref":"#/components/schemas/PublicQuiqTimes","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"context":{"description":"Current conversation context","$ref":"#/components/schemas/ChatConversationContext","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"proxyInteraction":{"description":"ProxyInteraction","$ref":"#/components/schemas/ProxyInteraction","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"transcriptHints":{"description":"TranscriptHints","$ref":"#/components/schemas/MessageTranscriptHints","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"preConversationContext":{"description":"PreConversationContext","$ref":"#/components/schemas/PreConversationContext","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"menuButtonId":{"type":"string","description":"Menu Button Id","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"selectedButton":{"description":"Selected Button","$ref":"#/components/schemas/ButtonSelection","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"selectedCardIndex":{"type":"integer","description":"Selected Card Index","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"externalId":{"type":"string","description":"The external ID","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"fields":{"type":"array","description":"The chat contact point","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/FieldUpdate","exampleSetFlag":false},"types":["array"]}},"description":"Post a chat text or rich message","exampleSetFlag":false,"types":["object"]},"EntryPointAccessedRequest":{"type":"object","properties":{"platform":{"description":"The message platform","$ref":"#/components/schemas/CustomerPlatformMeta","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"customerHandle":{"maxLength":255,"type":"string","description":"The customer handle ID","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"source":{"description":"The entry point source","$ref":"#/components/schemas/EntryPointSourceMeta","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"sourceId":{"type":"string","description":"The source ID associated with this entry point","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"intentId":{"type":"string","description":"The intent ID associated with this entry point","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Record that an entry point was accessed","exampleSetFlag":false,"types":["object"]},"PostCustomInteractionRequestDef":{"type":"object","properties":{"request":{"description":"Interaction message request","$ref":"#/components/schemas/CustomInteractionRequestMetadata","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"The post custom message request definition","exampleSetFlag":false,"types":["object"]},"ChatCardQuiqImageDef":{"type":"object","properties":{"publicUrl":{"type":"string","description":"A public url location of the image","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"assetId":{"type":"string","description":"An assetId representing the image","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Image object defined by either an assetId or a publicUrl","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"PublicStripeConfigurationMeta":{"type":"object","properties":{"connectedAccountId":{"type":"string","description":"The connected account ID","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"A public Stripe configuration object","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"EntryPointSourceMeta":{"type":"string","description":"Entry Point Source","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["ConversationStarterWidget"]},"PlatformProxyRequest":{"type":"object","properties":{"platform":{"type":"string","description":"Platform","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["SMS","Quiq","Facebook","Kik","Chat","Imported","Twitter","AppleMessages","GoogleRBM","None","GoogleMessages","WeChat","WhatsApp","Instagram","Voice"]},"outgoingHandle":{"maxLength":255,"type":"string","description":"The handle (e.g. Apple business id, phone number,  facebook page id) that you want to send messages from. Required for Apple & Facebook.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"customerHandle":{"maxLength":255,"type":"string","description":"The handle (e.g. phone number) of the customer with whom you wish to start a conversation","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"importedMessageText":{"maxLength":1024,"type":"string","description":"The text of the message to show as imported from the customer","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"context":{"description":"Current conversation context","$ref":"#/components/schemas/ChatConversationContext","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"Request a chat to start on the specified platform","exampleSetFlag":false,"types":["object"]},"Chat Websocket Message":{"type":"object","properties":{"messageType":{"type":"string","description":"Type of websocket message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["ChatMessage"]},"data":{"description":"A chat message that just occurred","$ref":"#/components/schemas/WebsocketChatMessage","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"All messages sent from Quiq out to the client will have this wrapper object","exampleSetFlag":false,"types":["object"]},"ThemeConfigurationMetadata":{"type":"object","properties":{"styles":{"description":"Styles","$ref":"#/components/schemas/ThemeStylesConfigurationMetadata","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"The theme configuration","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ChatTranscript":{"type":"object","properties":{"id":{"maxLength":32,"type":"string","description":"This will match the tracking ID for the customer","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"messages":{"type":"array","description":"Chat messages","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/ChatMessage","exampleSetFlag":false},"types":["array"]},"subscribed":{"type":"boolean","description":"If true client should subscribe to updates either via a websocket or through polling","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"registered":{"type":"boolean","description":"Whether or not the has been previously registered through a registration form","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"queueDisposition":{"type":"string","description":"The customer's disposition to a queue","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["unknown","assigned","waiting","indefinite"]},"queueInfo":{"description":"The customer's queue information","$ref":"#/components/schemas/ConversationQueueInfo","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"The full chat transcript between the customer and the company","exampleSetFlag":false,"types":["object"]},"ChatCarouselDef":{"type":"object","properties":{"cards":{"type":"array","description":"The cards displayed in the carousel","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/ChatCardDef","exampleSetFlag":false},"types":["array"]},"cardWidth":{"type":"string","description":"The width of the cards in the carousel. This field is currently only supported on the Google RBM platform.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["Small","Medium"]},"selectable":{"type":"boolean","description":"Whether or not the cards on the carousel represent selectable options. This field is currently only relevant on the Apple Messages platform.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"allowMultiSelect":{"type":"boolean","description":"Whether or not to allow multiple items to be selected. If sections are defined, their multi-select options are prioritized.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"sections":{"maxItems":50,"type":"array","description":"The groups that multiple cards can be assigned to.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/QuiqCarouselSection","exampleSetFlag":false},"types":["array"]}},"description":"A carousel def for chat messages","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"AgentThinkingMessageLine":{"type":"object","properties":{"text":{"type":"string","description":"Plain text to show","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"ttlMillis":{"type":"number","description":"How long to show this line before advancing to the next, in milliseconds, when the line set its own; it beats every preset. Null: the chat window uses its presets, then the message's ttlMillis; when both ttls are null, apply your own default (the chat window uses 5000)","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"preset":{"type":"string","description":"This line's preset name, applied over the message's preset. Null: none. Preset names are chosen by the caller and defined by the web chat page (its webchat JSON, agentThinking.presets; see [Agent Thinking web chat options](/docs/conversation-starter/#/webchat/advanced/agent_thinking)); the frame carries no settings for them. Treat the name, like the text and ttls, as untrusted input","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"One status line of a thinking sequence: its text, its own ttl and its preset name","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"CustomInteractionRequestMetadata":{"type":"object","properties":{"text":{"maxLength":1024,"type":"string","description":"The text body","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"responseMessageId":{"type":"string","description":"Response message id","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"payResponse":{"description":"Pay response","$ref":"#/components/schemas/QuiqPayResponseDef","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"times":{"description":"Times response","$ref":"#/components/schemas/PublicQuiqTimes","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"The interaction message request definition","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"CreateContextualLinkResponse":{"type":"object","properties":{"link":{"type":"string","description":"The contextual link","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Response object when creating a contextual link","exampleSetFlag":false,"types":["object"]},"customInteractionLinkResponseDef":{"type":"object","properties":{"customUrl":{"type":"string","description":"The custom link","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"A custom interaction link response","exampleSetFlag":false,"types":["object"]},"ContactPointConfigurationRequest":{"type":"object","description":"A request object that's tied to a contact point for the config endpoint","exampleSetFlag":false,"types":["object"]},"FetchPageRequestMetadata":{"type":"object","properties":{"pageDefinition":{"description":"The Page Config","$ref":"#/components/schemas/PageConfigurationMetadata","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"The fetch page configuration response","exampleSetFlag":false,"types":["object"]},"PostMessageRequestMetadata":{"type":"object","properties":{"message":{"description":"Interaction message request","$ref":"#/components/schemas/InteractionMessageRequestMetadata","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"The post message request definition","exampleSetFlag":false,"types":["object"]},"PreConversationContext":{"type":"object","properties":{"messages":{"type":"array","description":"Pre conversation messages","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/PreConversationMessage","exampleSetFlag":false},"types":["array"]},"contactEvents":{"type":"array","description":"Pre conversation contact events","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/PreConversationContactEvent","exampleSetFlag":false},"types":["array"]},"clientTimestamp":{"type":"number","description":"The Client Timestamp (in ms)","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]}},"description":"Context for messages and events that occurred before the conversation started.","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"PostEventRequest":{"type":"object","properties":{"customerHandleId":{"maxLength":255,"type":"string","description":"The customer handle associated with the event","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"eventName":{"type":"string","description":"The event name of the event","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"messageId":{"maxLength":36,"type":"string","description":"MessageId this event is tied to","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"payload":{"type":"object","description":"The event specific payload","nullable":true,"readOnly":false,"extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"transcriptHints":{"description":"Transcript hints for this event","$ref":"#/components/schemas/EventTranscriptHints","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"Post a chat event","exampleSetFlag":false,"types":["object"]},"EventIdResult":{"type":"object","properties":{"id":{"maxLength":36,"type":"string","description":"The id of the event","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"The result with an event id","exampleSetFlag":false,"types":["object"]},"FetchWidgetResponseMetadata":{"type":"object","properties":{"widget":{"description":"The Widget","$ref":"#/components/schemas/WidgetConfigurationMetadata","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"The fetch widget configuration response","exampleSetFlag":false,"types":["object"]},"PublicMessageWrapper Metadata":{"type":"object","properties":{"message":{"description":"The message","$ref":"#/components/schemas/PublicTextMessage","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"response":{"description":"The optional response message","$ref":"#/components/schemas/PublicTextMessage","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"customerPlatform":{"description":"The optional messaging platform used by the customer for this message","$ref":"#/components/schemas/CustomerPlatformMeta","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"The metadata the message wrapper","exampleSetFlag":false,"types":["object"]},"CreatePaymentSessionResponse":{"type":"object","properties":{"sessionId":{"type":"string","description":"The identifier for the payment session","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"processor":{"description":"The processor definition","$ref":"#/components/schemas/PublicProcessorDefinition","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"instruments":{"type":"object","properties":{"apple_pay_web":{"$ref":"#/components/schemas/InstrumentData","exampleSetFlag":false},"apple_pay_abc":{"$ref":"#/components/schemas/InstrumentData","exampleSetFlag":false},"google_pay":{"$ref":"#/components/schemas/InstrumentData","exampleSetFlag":false},"card":{"$ref":"#/components/schemas/InstrumentData","exampleSetFlag":false}},"additionalProperties":{"$ref":"#/components/schemas/InstrumentData","exampleSetFlag":false},"description":"The instruments map","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"sessionToken":{"type":"string","description":"The session token","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"businessName":{"type":"string","description":"The business name","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"A response object for creating a payment session","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"PlatformChannelConfiguration":{"type":"object","properties":{"platform":{"description":"Platform","$ref":"#/components/schemas/MessagePlatform","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"contactPoint":{"type":"string","description":"Contact Point","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"icon":{"type":"string","description":"Icon","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"intentId":{"type":"string","description":"Intent Id","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"storedContextId":{"type":"string","description":"Stored Context Id","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"messages":{"type":"string","description":"Messages","nullable":true,"readOnly":false,"extensions":{"x-quiq-skip-validation":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"styles":{"type":"string","description":"Styles","nullable":true,"readOnly":false,"extensions":{"x-quiq-skip-validation":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"The platform selector channel configuration","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ContextConfigConfigurationMetadata":{"type":"object","properties":{"context":{"type":"string","description":"Context","nullable":true,"readOnly":false,"extensions":{"x-quiq-skip-validation":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"mergeWithExisting":{"type":"boolean","description":"MergeWithExisting","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"The context config configuration","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"PostMessageResultMetadata":{"type":"object","properties":{"messageId":{"type":"string","description":"Message id","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"The post message result definition","exampleSetFlag":false,"types":["object"]},"PlatformSelectorConfiguration":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Enabled","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"channels":{"type":"array","description":"Channels","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/PlatformChannelConfiguration","exampleSetFlag":false},"types":["array"]},"platformSelectorButton":{"description":"PlatformSelectorButton","$ref":"#/components/schemas/PlatformSelectorButtonConfiguration","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"The platform selector configuration","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"AssetUploadDirectiveHeader":{"type":"object","properties":{"name":{"type":"string","description":"The name of this header","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"value":{"type":"string","description":"The value to be associated with this header","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"A header included as part of an upload directive","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ChatPrepareUploadsRequest":{"type":"object","properties":{"numUploads":{"maximum":10.0,"minimum":1,"type":"integer","description":"The number of uploads to prepare","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]}},"description":"A request object for preparing asset uploads","exampleSetFlag":false,"types":["object"]},"CreateContextualLinkRequest":{"type":"object","properties":{"platform":{"type":"string","description":"The platform to create a link for","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["SMS","Quiq","Facebook","Kik","Chat","Imported","Twitter","AppleMessages","GoogleRBM","None","GoogleMessages","WeChat","WhatsApp","Instagram","Voice"]},"context":{"description":"Current conversation context","$ref":"#/components/schemas/ChatConversationContext","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"tenantHandle":{"type":"string","description":"The tenant handle to use in the link","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"isIOS":{"type":"boolean","description":"If we are generating the link for IOS","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"contactPointOptions":{"description":"Contact Point Options","$ref":"#/components/schemas/ContactPointOptions","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"fallbackSms":{"type":"string","description":"Fallback SMS (Google RBM Only)","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"initialMessage":{"type":"string","description":"Optional initial message. Use {{contextualId}} to embed the contextual code.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Creates a contextual link for SMS or WhatsApp","exampleSetFlag":false,"types":["object"]},"ConversationQueueInfo":{"type":"object","properties":{"rawAssignedEst":{"type":"number","description":"The raw estimated assignment time for a customer in seconds","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]}},"description":"An object representing a conversation's queue info","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"TransferRequest":{"type":"object","description":"A request object that's tied to a contact point","exampleSetFlag":false,"types":["object"]},"ConversationDataForPreConversationContext":{"type":"object","properties":{"customer":{"description":"Customer Details","$ref":"#/components/schemas/Customer","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"custom":{"type":"object","properties":{},"additionalProperties":{"type":"string","description":"Field value","extensions":{"x-quiq-skip-validation":true,"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"description":"Custom fields. These are stored as a key/value dictionary where the ID of the custom field is the key.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]}},"description":"Conversation data for preconversation context","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ChatDisplayOptions":{"type":"object","properties":{"displayLocation":{"type":"string","description":"Display Location","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["transcript","actionSheet"]},"ratingDisplayRenderer":{"description":"Rating Display Renderer","$ref":"#/components/schemas/RatingDisplayRenderer","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"Chat Display Options","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"PublicQuiqTimes":{"type":"object","properties":{"items":{"maxItems":10,"type":"array","description":"The ordered list of time items to be ","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/PublicQuiqTimesItem","exampleSetFlag":false},"types":["array"]},"title":{"maxLength":40,"type":"string","description":"The title of the items","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Collection of time events to be exchanged as part of a message","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"PlatformSelectorButtonConfiguration":{"type":"object","properties":{"messages":{"type":"string","description":"Messages","nullable":true,"readOnly":false,"extensions":{"x-quiq-skip-validation":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"styles":{"type":"string","description":"Styles","nullable":true,"readOnly":false,"extensions":{"x-quiq-skip-validation":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"The platform selector button configuration","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ContactPointRequest":{"type":"object","description":"A request object that's tied to a contact point","exampleSetFlag":false,"types":["object"]},"ChatCardDef":{"type":"object","properties":{"title":{"maxLength":200,"type":"string","description":"The title of the card","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"subTitle":{"type":"string","description":"The subtitle of the card","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"image":{"description":"The image of the card","$ref":"#/components/schemas/ChatCardQuiqImageDef","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"link":{"description":"A url that the card links to","$ref":"#/components/schemas/QuiqCardUrl","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"secondaryTitle":{"maxLength":100,"type":"string","description":"A secondary title","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"tertiaryTitle":{"maxLength":200,"type":"string","description":"A tertiary title","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"buttons":{"type":"array","description":"The buttons displayed in the card. This definition is currently only supported on the Google RBM, Google Messages, and Conversation Starter Chat platforms.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/QuiqCardButton","exampleSetFlag":false},"types":["array"]},"imageHeight":{"type":"string","description":"The height of the image displayed in the card. This field is currently only supported on the Google RBM, Google Messages, and Conversation Starter Chat platforms. It is not supported if used in a Vertical Carousel. If used in a Google Messages Carousel, the Image Height on the first card will be used on all cards.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["Short","Medium","Tall"]},"orientation":{"type":"string","description":"The orientation of the cards. This field is currently only supported on the Google RBM platform, and only for cards NOT displayed in a carousel.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["Vertical","Horizontal"]},"titleLocation":{"type":"string","description":"The location of the title. This field is currently only supported on the SMS platform.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["Upper","Lower"]},"postbackData":{"type":"object","description":"Optional json that will get sent through to the platform and returned when this item is selected. Only applicable to cards on \"selectable\" carousels","nullable":true,"readOnly":false,"extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"replyDirectives":{"description":"The directives to be applied if this card is selected. Only applicable to cards on \"selectable\" carousels","$ref":"#/components/schemas/RichReplyDirectives","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"replyText":{"maxLength":200,"type":"string","description":"The text to be used if this card is selected. Only applicable to cards on \"selectable\" carousels","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"sectionId":{"maxLength":50,"type":"string","description":"Optional ID of the section this card belongs to. Only applicable to selectable carousels.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"previewLink":{"description":"The inline video preview in a card message. This field is currently only supported on the Apple Messages platform.","$ref":"#/components/schemas/CardPreviewLink","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"A card def for the chat messages","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"AppleBusinessId":{"type":"object","properties":{"businessId":{"type":"string","description":"The Apple business identifier that scopes 'id'","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"id":{"type":"string","description":"Identifier for this contact within the context of an Apple business","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Identifier for this contact within the scope of an Apple Messages business","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"":{"type":"object","description":"","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"PlatformSpecification":{"type":"object","properties":{"platform":{"type":"string","description":"The platform to send the notification to","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"tenantHandle":{"type":"string","description":"The tenant handle (Apple business id, Facebook page id) to use if this platform is resolved.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"A platform specification","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"StartConversationRequestMessage":{"type":"object","properties":{"text":{"maxLength":1024,"type":"string","description":"The text of the message","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"authorType":{"type":"string","description":"The author type of the message","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["Customer","User","System"]},"author":{"maxLength":254,"type":"string","description":"The author identity of the message (Agent messages only)","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"imported":{"type":"boolean","description":"Denotes whether the message is being imported from an external conversation or if it's a new message. All customer messages must be imported","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"assets":{"maxItems":10,"type":"array","description":"A list of assets (e.g. images, video, etc) to include with the message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/PublicAssetIngress","exampleSetFlag":false},"types":["array"]},"proxyInteraction":{"description":"A proxy interaction","$ref":"#/components/schemas/ProxyInteraction","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"quiqReply":{"description":"Suggested reply messages for the recipient","$ref":"#/components/schemas/QuiqReply","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"card":{"description":"QuiqCard definition","$ref":"#/components/schemas/QuiqCard","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"carousel":{"description":"QuiqCarousel definition","$ref":"#/components/schemas/QuiqCarousel","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"pay":{"description":"QuiqPay definition","$ref":"#/components/schemas/QuiqPay","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"auth":{"description":"QuiqAuth definition","$ref":"#/components/schemas/QuiqAuth","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"times":{"description":"A collection of time items, which are similar to calendar events.","$ref":"#/components/schemas/QuiqTimes","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"transcriptHints":{"description":"Transcript hints","$ref":"#/components/schemas/MessageTranscriptHints","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"directives":{"description":"Directives that will run unless different directives are chosen from a QuiqReply or QuiqCarousel","$ref":"#/components/schemas/RichReplyDirectives","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"postbackData":{"type":"object","description":"Optional JSON that will get sent through to the platform and returned when this message is replied to.","nullable":true,"readOnly":false,"extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"platformInvitation":{"description":"QuiqPlatformInvitation definition","$ref":"#/components/schemas/QuiqPlatformInvitation","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"A message object to be used when starting a conversation","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"FetchAiEventHistoryResponse":{"type":"object","properties":{"events":{"type":"array","description":"The contact events","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/AiEventHistoryResult","exampleSetFlag":false},"types":["array"]}},"description":"Response containing AI contact event history","exampleSetFlag":false,"types":["object"]},"UpdateConversationFields":{"type":"object","properties":{"fields":{"type":"array","description":"A sequence of field updates","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/FieldUpdate","exampleSetFlag":false},"types":["array"]},"allowPartial":{"type":"boolean","description":"When true, allow fields that pass validation to be set and return validation errors for fields that are not set.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"A request object for updating the custom fields on a conversation","exampleSetFlag":false,"types":["object"]},"StartConversationRequest":{"type":"object","properties":{"handle":{"maxLength":255,"type":"string","description":"The handle (e.g. phone number) of the customer with whom you wish to start a conversation","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"contactPoint":{"description":"The contact point from which to initiate the conversation","$ref":"#/components/schemas/ContactPointReference","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"outgoingHandle":{"maxLength":255,"type":"string","description":"The handle (e.g. Apple business id, facebook page id) that you want to send messages from. Required for Apple & Facebook.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"messages":{"type":"array","description":"The messages to include in the initial record of the conversation","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/StartConversationRequestMessage","exampleSetFlag":false},"types":["array"]},"integrations":{"type":"array","description":"A list of references to objects in an integrated system that will be associated with the conversation upon creation","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/IntegrationReference","exampleSetFlag":false},"types":["array"]},"integrationsData":{"type":"object","properties":{},"additionalProperties":{"maxLength":4096,"type":"string","description":"a data blob","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"description":"A map from integration provider to a data blob for use by third-party integrations that will be associated with the conversation upon creation","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"autoResponsesEnabled":{"type":"boolean","description":"Whether or not auto-responses should be calculated and sent when this conversation is started","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"fields":{"type":"array","description":"A sequence of field updates","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/FieldUpdate","exampleSetFlag":false},"types":["array"]},"requestedOwner":{"maxLength":254,"type":"string","description":"Attempt to assign the conversation to the specified owner","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"summary":{"type":"string","description":"A summary of the conversation so far (e.g. from a bot that is handing off), shown to agents as the conversation summary. Replaced by the automatic conversation summary once new messages arrive, if automatic summaries are enabled.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"summaryLanguage":{"description":"Optional language the summary is written in (e.g. \"en\"); used to translate the summary for agents working in another language","$ref":"#/components/schemas/GlobalWrittenLanguage","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"A request object for starting a conversation","exampleSetFlag":false,"types":["object"]},"FetchHistoricalTranscriptRequest":{"type":"object","properties":{"conversationId":{"maxLength":36,"type":"string","description":"The conversation id to fetch the historical transcript for","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"limit":{"minimum":0,"type":"integer","description":"Maximum number of messages to return","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"unifiedContactSearch":{"type":"boolean","description":"When true, resolves all identities associated with the contactId and searches across all of them","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"duration":{"description":"How far back to search in milliseconds (e.g. 86400000 for the last day)","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"Request for fetching historical message transcript","exampleSetFlag":false,"types":["object"]},"SendConversationToQueueRequest":{"type":"object","properties":{"targetQueue":{"description":"The queue to which to send the conversation","$ref":"#/components/schemas/QueueReference","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"awaitingCustomerResponse":{"type":"boolean","description":"Whether or not the burden of response should remain on the customer","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"A request object for sending a conversation to a queue","exampleSetFlag":false,"types":["object"]},"TenantSupportedLanguagesResponse":{"type":"object","properties":{"languages":{"type":"array","description":"The supported languages","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/WrittenLanguage","exampleSetFlag":false},"types":["array"]}},"description":"A response object for the supported languages of the tenant","exampleSetFlag":false,"types":["object"]},"PostTriggerResponse":{"type":"object","properties":{"submitted":{"type":"boolean","description":"True if the trigger was submitted for processing","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"Response object for postTrigger API","exampleSetFlag":false,"types":["object"]},"AssignmentStartReasonsMeta":{"type":"string","description":"Assignment start reason","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["Conversation started","Inactive conversation reactivated","Queue changed","Reassigned by other user","Routed from queue","Takeover","Transferred to agent"]},"SendMessageResponse":{"type":"object","properties":{"messageFields":{"description":"Message-related response fields","$ref":"#/components/schemas/MessageFields","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"Response object for public send message apis.","exampleSetFlag":false,"types":["object"]},"GoogleMessagesId":{"type":"object","properties":{"agentId":{"type":"string","description":"The Google agent associated with the 'id'","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"id":{"type":"string","description":"Identifier for this contact within the context of a Google agent","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Identifier for this contact within the scope of an Google Messages agent","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"SendMessagesRequest":{"type":"object","properties":{"messages":{"maxItems":10,"type":"array","description":"The messages to send","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/PapiMessageToSend","exampleSetFlag":false},"types":["array"]}},"description":"Request object for public send messages api","exampleSetFlag":false,"types":["object"]},"FetchLastConversationRequest":{"type":"object","properties":{"platform":{"description":"The messaging platform on which the conversation is taking place","$ref":"#/components/schemas/MessagePlatform","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"handle":{"maxLength":255,"type":"string","description":"The handle (e.g. phone number) of the customer associated with the conversation","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"outgoingHandle":{"maxLength":255,"type":"string","description":"The handle (e.g. Apple business id, facebook page id) associated with the conversation","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"A request object for fetching the last conversation","exampleSetFlag":false,"types":["object"]},"TranscriptHintSubmission":{"type":"object","properties":{"heading1":{"type":"string","description":"The first heading to display","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"heading2":{"type":"string","description":"The second heading to display","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"description":{"type":"string","description":"The description to display","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Event Transcript Hints","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"FetchAiEventHistoryRequest":{"type":"object","properties":{"conversationId":{"maxLength":36,"type":"string","description":"The conversation id to fetch events for","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"limit":{"minimum":0,"type":"integer","description":"Maximum number of events to return","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"onlyThisConversation":{"type":"boolean","description":"When true, only returns events from this specific conversation rather than all events for the unified contact","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"eventDefinitions":{"type":"array","description":"Optional list of event definition IDs to filter results by","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/EventDefinitionReference","exampleSetFlag":false},"types":["array"]},"duration":{"description":"How far back to search in milliseconds (e.g. 86400000 for the last day)","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"orderByDesc":{"type":"boolean","description":"When true, returns events in descending order by time (most recent first)","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"Request for fetching AI contact event history","exampleSetFlag":false,"types":["object"]},"ConversationGoalExport":{"type":"object","properties":{"export":{"type":"string","description":"The string representation of the export","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"version":{"type":"string","description":"The export version","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"signature":{"type":"string","description":"The signature value of the export","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Conversation goal export data","exampleSetFlag":false,"types":["object"]},"AvailablePlatformsResponse":{"type":"object","properties":{"pairs":{"description":"Pairs of message platforms and tenant handle for the user that was resolved from the SearchInfo object","$ref":"#/components/schemas/PlatformHandlePair","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"A response that contains all of a users supported platforms","exampleSetFlag":false,"types":["object"]},"CustomFieldsImportResponse":{"type":"object","properties":{"skippedCustomerFields":{"type":"array","description":"A list of customer fields that were skipped during import","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"type":"string","description":"field","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"types":["array"]},"skippedConversationFields":{"type":"array","description":"A list of conversation fields that were skipped during import","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"type":"string","description":"field","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"types":["array"]}},"description":"Custom fields import response data","exampleSetFlag":false,"types":["object"]},"StartRichConversationRequest":{"type":"object","properties":{"contactPoint":{"description":"The contact point from which to initiate the conversation","$ref":"#/components/schemas/ContactPointReference","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"searchInfo":{"description":"An object with search information for the conversation recipient","$ref":"#/components/schemas/SearchInfo","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"precedence":{"type":"array","description":"An ordered array of message platforms. API will prefer the left-most entry that is available for the recipient","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/PlatformSpecification","exampleSetFlag":false},"types":["array"]},"messageMaps":{"type":"array","description":"The message map to use to build the notification message based on the platform that the message will go out on","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/PublicMessageMapIngress","exampleSetFlag":false},"types":["array"]},"fields":{"type":"array","description":"A sequence of field updates","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/FieldUpdate","exampleSetFlag":false},"types":["array"]},"requestedOwner":{"maxLength":254,"type":"string","description":"Attempt to assign the conversation to the specified owner","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"summary":{"type":"string","description":"A summary of the conversation so far (e.g. from a bot that is handing off), shown to agents as the conversation summary. Replaced by the automatic conversation summary once new messages arrive, if automatic summaries are enabled.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"summaryLanguage":{"description":"Optional language the summary is written in (e.g. \"en\"); used to translate the summary for agents working in another language","$ref":"#/components/schemas/GlobalWrittenLanguage","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"A request object for starting a conversation","exampleSetFlag":false,"types":["object"]},"StartConversationMessageMap":{"type":"object","properties":{"default":{"description":"The default, or fallback represenation of the message. Platform agnostic","$ref":"#/components/schemas/StartConversationQuiqMessage","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"overrides":{"type":"object","properties":{"Chat":{"$ref":"#/components/schemas/StartConversationQuiqMessage","exampleSetFlag":false},"WhatsApp":{"$ref":"#/components/schemas/StartConversationQuiqMessage","exampleSetFlag":false},"GoogleRBM":{"$ref":"#/components/schemas/StartConversationQuiqMessage","exampleSetFlag":false},"SMS":{"$ref":"#/components/schemas/StartConversationQuiqMessage","exampleSetFlag":false},"Kik":{"$ref":"#/components/schemas/StartConversationQuiqMessage","exampleSetFlag":false},"Twitter":{"$ref":"#/components/schemas/StartConversationQuiqMessage","exampleSetFlag":false},"Email":{"$ref":"#/components/schemas/StartConversationQuiqMessage","exampleSetFlag":false},"AppleMessages":{"$ref":"#/components/schemas/StartConversationQuiqMessage","exampleSetFlag":false},"Quiq":{"$ref":"#/components/schemas/StartConversationQuiqMessage","exampleSetFlag":false},"Facebook":{"$ref":"#/components/schemas/StartConversationQuiqMessage","exampleSetFlag":false},"GoogleMessages":{"$ref":"#/components/schemas/StartConversationQuiqMessage","exampleSetFlag":false},"Instagram":{"$ref":"#/components/schemas/StartConversationQuiqMessage","exampleSetFlag":false},"None":{"$ref":"#/components/schemas/StartConversationQuiqMessage","exampleSetFlag":false},"WeChat":{"$ref":"#/components/schemas/StartConversationQuiqMessage","exampleSetFlag":false},"Voice":{"$ref":"#/components/schemas/StartConversationQuiqMessage","exampleSetFlag":false},"Imported":{"$ref":"#/components/schemas/StartConversationQuiqMessage","exampleSetFlag":false}},"additionalProperties":{"$ref":"#/components/schemas/StartConversationQuiqMessage","exampleSetFlag":false},"description":"PLatform-specific implementations of the message.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]}},"description":"A message and its platform equivalents","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"AiEventHistoryResult":{"type":"object","properties":{"id":{"type":"string","description":"Event ID","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"eventDefinitionId":{"type":"string","description":"Event definition ID","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"time":{"description":"When the event occurred in epoch milliseconds","$ref":"#/components/schemas/Timestamp","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"source":{"type":"string","description":"Source of the event","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"correlationId":{"type":"string","description":"Correlation ID","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"userId":{"type":"string","description":"User that triggered the event, if source is User","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"contactId":{"type":"string","description":"Contact ID","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"contactPointId":{"type":"string","description":"Contact point ID","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"payload":{"type":"object","description":"Event payload data","nullable":true,"readOnly":false,"extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"transcriptHints":{"type":"object","description":"Hints for displaying this event in a transcript","nullable":true,"readOnly":false,"extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]}},"description":"A contact event result","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ConversationGoalsDefinition":{"type":"object","properties":{"goals":{"type":"array","description":"The list of goals defined for the tenant","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/ConversationGoalDefinition","exampleSetFlag":false},"types":["array"]}},"description":"Tenant level Conversation Goals Definition","exampleSetFlag":false,"types":["object"]},"MessageFields":{"type":"object","properties":{"id":{"maxLength":36,"type":"string","description":"Globally unique identifier for the message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Message related response fields","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"PostTriggerRequest":{"type":"object","properties":{"triggerId":{"type":"string","description":"The trigger to be fired on the assigned assistant","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"description":{"maxLength":80,"type":"string","description":"A brief description of the trigger payload","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"payload":{"type":"object","description":"The trigger payload - an arbitrary JSON object","nullable":true,"readOnly":false,"extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]}},"description":"Request object for postTrigger API","exampleSetFlag":false,"types":["object"]},"CustomFieldsDefinition":{"type":"object","properties":{"openApiModel":{"description":"OpenAPI model definition","$ref":"#/components/schemas/OpenApiModelSpec","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"Custom field definitions as an OpenAPI model","exampleSetFlag":false,"types":["object"]},"PapiSetExternalContactLinkRequest":{"type":"object","properties":{"link":{"description":"External contact link to set the convo to.","$ref":"#/components/schemas/ExternalContactLink","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"A request object for setting a conversation's external contact link.","exampleSetFlag":false,"types":["object"]},"RelativeMove":{"type":"object","properties":{"before":{"type":"boolean","description":"Before","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"key":{"minimum":0,"type":"integer","description":"Key","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]}},"description":"RelativeMove","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"AvailableChannelsRequest":{"type":"object","properties":{"contactPoint":{"description":"The contact point from which to initiate the conversation","$ref":"#/components/schemas/ContactPointReference","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"searchInfo":{"description":"An object with search information for the conversation recipient","$ref":"#/components/schemas/SearchInfo","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"A request object for getting a users available platforms","exampleSetFlag":false,"types":["object"]},"SetSecondaryPlatformResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Whether or not we were able to update the secondary","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"failureReason":{"type":"string","description":"Reason the API didn't succeed","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"A request object for acknowledging a conversation state update","exampleSetFlag":false,"types":["object"]},"ConversationAssignmentEndedPublicEvent":{"type":"object","properties":{"eventType":{"type":"string","description":"The type of the event","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["ConversationAssignmentEnded"]},"data":{"description":"The generic data associated with the event","$ref":"#/components/schemas/ConversationAssignmentEnded","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"id":{"type":"string","description":"The id of the event","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"timestamp":{"type":"number","description":"The millisecond timestamp that the event was created","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]}},"description":"A public event","exampleSetFlag":false,"types":["object"]},"HistoricalTranscriptResponse":{"type":"object","properties":{"messages":{"type":"array","description":"The historical transcript messages","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/Message","exampleSetFlag":false},"types":["array"]}},"description":"Response containing historical transcript messages","exampleSetFlag":false,"types":["object"]},"ConversationGoalDefinition":{"type":"object","properties":{"id":{"type":"string","description":"The goal identifier","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"label":{"type":"string","description":"A label for the goal","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"description":{"type":"string","description":"The goals description","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"disabledOn":{"type":"number","description":"(Optional) When the goal was disabled (in millis)","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]}},"description":"A single goal definition","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"AgentHooksEnvelope":{"type":"object","properties":{"ping":{"type":"boolean","description":"If true the client is expected to immediately post to the pong API","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"conversationUpdates":{"type":"array","description":"A collection of conversation state updates","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/AgentHooksConversationUpdate","exampleSetFlag":false},"types":["array"]},"timestamp":{"type":"array","description":"The unix timestamp at which the webhook was sent","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/AgentHooksConversationUpdate","exampleSetFlag":false},"types":["array"]}},"description":"The outermost payload of the agent hooks API","exampleSetFlag":false,"types":["object"]},"PromoteSecondaryPlatformResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Whether or not we were able to update the secondary","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"failureReason":{"type":"string","description":"Reason the API didn't succeed","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"newPrimary":{"description":"The new primary platform if successful","$ref":"#/components/schemas/CustomerPlatformMeta","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"newSecondary":{"description":"The new secondary platform if successful and a new secondary was available","$ref":"#/components/schemas/CustomerPlatformMeta","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"A request object for acknowledging a conversation state update","exampleSetFlag":false,"types":["object"]},"ConversationIntegration":{"type":"object","properties":{"provider":{"type":"string","description":"The integration provider","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"name":{"type":"string","description":"The name of the integration","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"id":{"type":"string","description":"The id of the integration record","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"A conversation integration","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"PapiMessageToSend":{"type":"object","properties":{"text":{"maxLength":1024,"type":"string","description":"The text of the message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"assets":{"maxItems":10,"type":"array","description":"A list of assets (e.g. images, video, etc) to include with the message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/PublicAssetIngress","exampleSetFlag":false},"types":["array"]},"followUpSettings":{"description":"Whether or not this message requires an additional follow-up message from an agent","$ref":"#/components/schemas/FollowUpSettings","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"surveySolicitation":{"description":"Mark this message as a solicitation to take a given survey","$ref":"#/components/schemas/MessageSurveySolicitation","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"proxyInteraction":{"description":"A proxy interaction","$ref":"#/components/schemas/ProxyInteraction","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"quiqReply":{"description":"Suggested reply messages for the recipient","$ref":"#/components/schemas/QuiqReply","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"card":{"description":"QuiqCard definition","$ref":"#/components/schemas/QuiqCard","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"carousel":{"description":"QuiqCarousel definition","$ref":"#/components/schemas/QuiqCarousel","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"pay":{"description":"QuiqPay definition","$ref":"#/components/schemas/QuiqPay","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"auth":{"description":"QuiqAuth definition","$ref":"#/components/schemas/QuiqAuth","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"times":{"description":"A collection of time items, which are similar to calendar events.","$ref":"#/components/schemas/QuiqTimes","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"transcriptHints":{"description":"Transcript hints","$ref":"#/components/schemas/MessageTranscriptHints","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"directives":{"description":"Directives that will run unless different directives are chosen from a QuiqReply or QuiqCarousel","$ref":"#/components/schemas/RichReplyDirectives","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"postbackData":{"type":"object","description":"Optional JSON that will get sent through to the platform and returned when this message is replied to.","nullable":true,"readOnly":false,"extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"platformInvitation":{"description":"QuiqPlatformInvitation definition","$ref":"#/components/schemas/QuiqPlatformInvitation","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"A message to send via public api","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"SendMessageRequest":{"type":"object","properties":{"text":{"maxLength":1024,"type":"string","description":"The text of the message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"assets":{"maxItems":10,"type":"array","description":"A list of assets (e.g. images, video, etc) to include with the message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/PublicAssetIngress","exampleSetFlag":false},"types":["array"]},"followUpSettings":{"description":"Whether or not this message requires an additional follow-up message from an agent","$ref":"#/components/schemas/FollowUpSettings","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"surveySolicitation":{"description":"Mark this message as a solicitation to take a given survey","$ref":"#/components/schemas/MessageSurveySolicitation","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"proxyInteraction":{"description":"A proxy interaction","$ref":"#/components/schemas/ProxyInteraction","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"quiqReply":{"description":"Suggested reply messages for the recipient","$ref":"#/components/schemas/QuiqReply","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"card":{"description":"QuiqCard definition","$ref":"#/components/schemas/QuiqCard","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"carousel":{"description":"QuiqCarousel definition","$ref":"#/components/schemas/QuiqCarousel","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"pay":{"description":"QuiqPay definition","$ref":"#/components/schemas/QuiqPay","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"auth":{"description":"QuiqAuth definition","$ref":"#/components/schemas/QuiqAuth","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"times":{"description":"A collection of time items, which are similar to calendar events.","$ref":"#/components/schemas/QuiqTimes","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"transcriptHints":{"description":"Transcript hints","$ref":"#/components/schemas/MessageTranscriptHints","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"directives":{"description":"Directives that will run unless different directives are chosen from a QuiqReply or QuiqCarousel","$ref":"#/components/schemas/RichReplyDirectives","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"postbackData":{"type":"object","description":"Optional JSON that will get sent through to the platform and returned when this message is replied to.","nullable":true,"readOnly":false,"extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"platformInvitation":{"description":"QuiqPlatformInvitation definition","$ref":"#/components/schemas/QuiqPlatformInvitation","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"A request object for sending a message.","exampleSetFlag":false,"types":["object"]},"SetConversationSummary":{"type":"object","properties":{"summary":{"type":"string","description":"A summary of the conversation","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"lastMessageId":{"type":"string","description":"The id of the last message included in the convo when the summary was generated","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"summaryLanguage":{"description":"Optional language the summary is written in (e.g. \"en\"); stamped on the summary for auto-translation","$ref":"#/components/schemas/GlobalWrittenLanguage","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"A request object to set the summary on a conversation","exampleSetFlag":false,"types":["object"]},"ConversationStatusChangePublicEvent":{"type":"object","properties":{"eventType":{"type":"string","description":"The type of the event","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["ConversationPending","ConversationRequested","ConversationActivated","ConversationInactivated","ConversationClosed","ConversationDeniedAsSpam","ConversationMergedAsDangling","ConversationAbandoned","ConversationOwnerChanged","ConversationEnqueued"]},"data":{"description":"The generic data associated with the event","$ref":"#/components/schemas/Conversation","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"id":{"type":"string","description":"The id of the event","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"timestamp":{"type":"number","description":"The millisecond timestamp that the event was created","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]}},"description":"A public event","exampleSetFlag":false,"types":["object"]},"SearchInfo":{"type":"object","properties":{"phoneNumber":{"maxLength":255,"type":"string","description":"The recipient's primary phone number","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"appleId":{"description":"The recipient's apple id","$ref":"#/components/schemas/AppleBusinessId","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"searchId":{"maxLength":50,"type":"string","description":"An optional identifier. If set, this will be returned in the response.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"googleMessagesId":{"description":"The recipient's google id","$ref":"#/components/schemas/GoogleMessagesId","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"An object with search information about the recipient.","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"PapiEventCreatedResult":{"type":"object","properties":{"eventId":{"type":"string","description":"The created event id","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"timestamp":{"type":"number","description":"The timestamp the event was created","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]}},"description":"Event creation result object","exampleSetFlag":false,"types":["object"]},"AcknowledgeRequest":{"type":"object","properties":{"ackId":{"minimum":0,"type":"integer","description":"The state id that's being acknowledged - this is sent out as ackId in the corresponding agent hook payload","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"clientState":{"type":"string","description":"Optional client state associated with this acknowledgement that will be passed back to the client with the next conversation state update","nullable":true,"readOnly":false,"extensions":{"x-quiq-skip-validation":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"A request object for acknowledging a conversation state update","exampleSetFlag":false,"types":["object"]},"MarkConversationAsDurableRequest":{"type":"object","properties":{"durable":{"type":"boolean","description":"Whether or not this conversation should continue after a hangup from voice","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"hangup":{"type":"boolean","description":"Whether or not we should hangup after the durability is updated.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"A request object for marking a voice conversation as durable","exampleSetFlag":false,"types":["object"]},"CustomerAiAgent":{"type":"object","properties":{"level":{"type":"string","description":"How sure we are that the customer is an AI agent","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["likely","confirmed"]}},"description":"Customer AI agent information","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"SendMessageMapRequest":{"type":"object","properties":{"messageMap":{"description":"The message map to use to build the notification message based on the platform that the message will go out on","$ref":"#/components/schemas/PublicMessageMapIngress","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"A request object for sending a message.","exampleSetFlag":false,"types":["object"]},"SendToUserRequestMeta":{"type":"object","properties":{"userId":{"description":"The assignee's userId","$ref":"#/components/schemas/UserReference","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"fallbackQueue":{"description":"Queue that conversation should be added to if the assignee is offline or unavailable","$ref":"#/components/schemas/QueueReference","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"targetQueue":{"description":"Queue to always change the conversation to before assignment. When set, the queue change occurs regardless of assignee availability.","$ref":"#/components/schemas/QueueReference","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"awaitingCustomerResponse":{"type":"boolean","description":"Whether or not the burden of response should remain on the customer","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"A request object for assigning a conversation to a given user","exampleSetFlag":false,"types":["object"]},"PapiSendAssociatedOutboundRequest":{"type":"object","properties":{"platform":{"description":"The messaging platform to send the outbound message on.","$ref":"#/components/schemas/MessagePlatform","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"fallbackOptions":{"description":"The messaging platform to send the outbound message on.","$ref":"#/components/schemas/AssociatedOutboundFallbackOptions","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"messageDefinitions":{"type":"array","description":"The outbound messages to send.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/MessageDefinitionReference","exampleSetFlag":false},"types":["array"]},"customerHandleOverride":{"maxLength":255,"type":"string","description":"The customer handle to use instead of deriving from the conversation","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"messageMaps":{"maxItems":10,"type":"array","description":"Inline messages to send instead of message definitions, each resolved for the platform it goes out on","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/MessageMapIngress","exampleSetFlag":false},"types":["array"]}},"description":"A request object for sending an associated outbound message.","exampleSetFlag":false,"types":["object"]},"SyncedCustomFields":{"type":"object","properties":{"fields":{"type":"array","description":"The fields that were synced","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"type":"string","description":"A field","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"types":["array"]}},"description":"The fields that were synced","exampleSetFlag":false,"types":["object"]},"PapiPushContactEventRequest":{"type":"object","properties":{"eventDefinitionId":{"type":"string","description":"The event definition id","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"payload":{"type":"object","description":"The event specific payload","nullable":true,"readOnly":false,"extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"transcriptHints":{"description":"Transcript information, should be provided if the event will be displayed on the transcript","$ref":"#/components/schemas/TranscriptHintSubmission","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"Push contact event request object","exampleSetFlag":false,"types":["object"]},"SendMessageMapsRequest":{"type":"object","properties":{"messageMaps":{"maxItems":10,"type":"array","description":"The Message maps to send","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/PublicMessageMapIngress","exampleSetFlag":false},"types":["array"]}},"description":"Request object for public send message maps api","exampleSetFlag":false,"types":["object"]},"AddIntegrationsRequest":{"type":"object","properties":{"integrations":{"type":"array","description":"A list of references to objects in an integrated system that will be associated with the conversation","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/IntegrationReference","exampleSetFlag":false},"types":["array"]}},"description":"A request object to add integrations to a conversation","exampleSetFlag":false,"types":["object"]},"SetCustomTimerResponse":{"type":"object","properties":{"timerId":{"type":"string","description":"The Id for the custom timer","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"A response object for setting a custom timer.","exampleSetFlag":false,"types":["object"]},"StartConversationResponse":{"type":"object","properties":{"id":{"maxLength":36,"type":"string","description":"The id of the conversation that was started ","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"messageIds":{"type":"array","description":"The ids of the messages that were used to start the conversation ","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"maxLength":36,"type":"string","description":"Message identifier","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"types":["array"]}},"description":"A response object for starting a conversation","exampleSetFlag":false,"types":["object"]},"MessageMapIngress":{"type":"object","properties":{"default":{"description":"The default, or fallback representation of the message. Platform agnostic","$ref":"#/components/schemas/QuiqMessageIngress","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"overrides":{"type":"object","properties":{"Chat":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false},"WhatsApp":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false},"GoogleRBM":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false},"SMS":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false},"Kik":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false},"Twitter":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false},"Email":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false},"AppleMessages":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false},"Quiq":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false},"Facebook":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false},"GoogleMessages":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false},"Instagram":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false},"None":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false},"WeChat":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false},"Voice":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false},"Imported":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false}},"additionalProperties":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false},"description":"Platform-specific implementations of the message.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]}},"description":"A message and its platform equivalents","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"FindLastConversationRequest":{"type":"object","properties":{"platform":{"description":"The messaging platform on which the conversation is taking place","$ref":"#/components/schemas/MessagePlatform","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"customerHandle":{"maxLength":255,"type":"string","description":"The customer handle (e.g. phone number) of the customer associated with the conversation","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"contactPoint":{"maxLength":64,"type":"string","description":"The contact point associated with the conversation","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"outgoingHandle":{"maxLength":64,"type":"string","description":"The handle (e.g. Apple business id, facebook page id) that the conversation took place on. Required if the platform is not SMS, Chat, or Voice, otherwise this field is ignored.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"A request object for fetching the most recent conversation","exampleSetFlag":false,"types":["object"]},"StartConversationCrossPlatformMessage":{"type":"object","properties":{"text":{"maxLength":1024,"type":"string","description":"The text of the message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"snippetId":{"type":"string","description":"The text of the message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"imported":{"type":"boolean","description":"Is the message imported","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"assets":{"maxItems":10,"type":"array","description":"The assets of the message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/PublicAssetIngress","exampleSetFlag":false},"types":["array"]},"proxyInteraction":{"description":"A proxy interaction","$ref":"#/components/schemas/ProxyInteraction","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"quiqReply":{"description":"Suggested reply messages for the recipient","$ref":"#/components/schemas/QuiqReply","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"card":{"description":"QuiqCard definition","$ref":"#/components/schemas/QuiqCard","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"carousel":{"description":"QuiqCarousel definition","$ref":"#/components/schemas/QuiqCarousel","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"pay":{"description":"QuiqPay definition","$ref":"#/components/schemas/QuiqPay","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"auth":{"description":"QuiqAuth definition","$ref":"#/components/schemas/QuiqAuth","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"times":{"description":"A collection of time items, which are similar to calendar events.","$ref":"#/components/schemas/QuiqTimes","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"transcriptHints":{"description":"Transcript hints","$ref":"#/components/schemas/MessageTranscriptHints","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"directives":{"description":"Directives that will run unless different directives are chosen from a QuiqReply or QuiqCarousel","$ref":"#/components/schemas/RichReplyDirectives","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"postbackData":{"type":"object","description":"Optional JSON that will get sent through to the platform and returned when this message is replied to.","nullable":true,"readOnly":false,"extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"platformInvitation":{"description":"QuiqPlatformInvitation definition","$ref":"#/components/schemas/QuiqPlatformInvitation","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"A message object to be used when starting a conversation","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"SetSecondaryPlatformRequest":{"type":"object","properties":{"platform":{"description":"The platform to use as secondary","$ref":"#/components/schemas/CustomerPlatformMeta","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"A request object for acknowledging a conversation state update","exampleSetFlag":false,"types":["object"]},"RestartConversationRequestMeta":{"type":"object","properties":{"originalConversationId":{"type":"string","description":"The conversation that we are going to restart","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"messageMap":{"description":"The message map to use to build the notification message based on the platform that the message will go out on","$ref":"#/components/schemas/MessageMapIngress","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"A request object used to restart a conversation.","exampleSetFlag":false,"types":["object"]},"SetCustomTimerRequest":{"type":"object","properties":{"durationMillis":{"description":"The duration of the custom timer in milliseconds","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"userId":{"description":"The assignee's userId","$ref":"#/components/schemas/UserReference","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"A request object for setting a custom timer.","exampleSetFlag":false,"types":["object"]},"SetPlatformTransitionModeRequest":{"type":"object","properties":{"mode":{"type":"string","description":"The platform to demote","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["adaptive","manual"]}},"description":"A request object to set the platform transition mode on a conversation","exampleSetFlag":false,"types":["object"]},"DemoteMessagingKeyRequest":{"type":"object","properties":{"platform":{"description":"The platform to demote","$ref":"#/components/schemas/CustomerPlatformMeta","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"A request object to demote a messaging key from active use on a conversation","exampleSetFlag":false,"types":["object"]},"OpenApiModelSpec":{"type":"object","properties":{"description":{"type":"string","description":"Description","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"properties":{"type":"object","properties":{},"additionalProperties":{"type":"object","description":"values","extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"description":"properties","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]}},"description":"An OpenApi Model Specification","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ConversationGoalImportResponse":{"type":"object","properties":{"skippedGoals":{"type":"array","description":"A list of goals that were skipped during import","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"type":"string","description":"field","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"types":["array"]}},"description":"Conversation goal import response data","exampleSetFlag":false,"types":["object"]},"CustomFieldsExport":{"type":"object","properties":{"export":{"type":"string","description":"The string representation of the export","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"version":{"type":"string","description":"The export version","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"signature":{"type":"string","description":"The signature value of the export","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Custom fields export data","exampleSetFlag":false,"types":["object"]},"ConversationAssignmentEnded":{"type":"object","properties":{"conversationId":{"maxLength":36,"type":"string","description":"The ID of the conversation","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"owner":{"maxLength":254,"type":"string","description":"The owner of the conversation during this assignment","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"ownerIsBot":{"type":"boolean","description":"Whether the owner is a bot","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"contactPoint":{"maxLength":64,"type":"string","description":"Contact point to which the conversation belongs","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"platform":{"description":"The messaging platform","$ref":"#/components/schemas/MessagePlatform","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"handle":{"maxLength":255,"type":"string","description":"The customer's handle on the messaging platform","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"tenantHandle":{"maxLength":255,"type":"string","description":"The messaging handle used by the business/tenant","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"endSource":{"type":"string","description":"The source/entity that ended the assignment","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["contact","user","system","ai-service"]},"endStatus":{"description":"The conversations status at the end of the assignment","$ref":"#/components/schemas/ConversationStatus","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"assignmentStartTime":{"description":"The time the assignment started","$ref":"#/components/schemas/Timestamp","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"assignmentStartReason":{"description":"The reason the assignment started","$ref":"#/components/schemas/AssignmentStartReasonsMeta","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"assignmentStartQueue":{"description":"The queue at the time the assignment started","$ref":"#/components/schemas/QueueReference","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"assignmentStartOtherUser":{"description":"The other user involved in starting the assignment, this will not be set if another user was not involved","$ref":"#/components/schemas/UserReference","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"assignmentEndTime":{"description":"The time the assignment ended","$ref":"#/components/schemas/Timestamp","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"assignmentEndReason":{"description":"The reason the assignment ended","$ref":"#/components/schemas/AssignmentEndReasonsMeta","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"assignmentEndQueue":{"description":"The queue at the time the assignment ended","$ref":"#/components/schemas/QueueReference","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"assignmentEndOtherUser":{"description":"The other user involved in ending the assignment, this will not be set if another user was not involved","$ref":"#/components/schemas/UserReference","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"assignmentDuration":{"description":"The total duration of the assignment","$ref":"#/components/schemas/DurationMillis","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"assignmentIndex":{"minimum":0,"type":"integer","description":"A counter indicating how many assignment occurred before this segment","format":"int32","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"intervalSinceLastAssignment":{"description":"The time elapsed (in ms) from the end of the prior assignment to the start of the current assignment. Will not be set for the first assignment of each conversation.","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"isAgentInitiatedConversation":{"type":"boolean","description":"True if the conversation was started by an outgoing message from an agent","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"isAgentInitiatedAssignment":{"type":"boolean","description":"True if the assignment was started by an agent action","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"hasFirstLiveAgentResponse":{"type":"boolean","description":"True if this assignment had the first message sent by a human agent","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"acceptDuration":{"description":"The amount of time it took the agent to accept the conversation. Will not be set if invitations are disabled or the agent didn’t accept.","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"timeToFirstMessageSentFromAssignment":{"description":"The amount of time it took the agent to respond to the customer after becoming the owner. Will not be set if the agent never sends a message.","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"numAgentMessages":{"minimum":0,"type":"integer","description":"Count of the number of messages the agent sent during the assignment","format":"int32","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"numCustomerMessages":{"minimum":0,"type":"integer","description":"Count of the number of messages the customer sent during the assignment","format":"int32","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"numQueueChanges":{"minimum":0,"type":"integer","description":"Count of the number of times the queue was changed during the assignment","format":"int32","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"workTime":{"description":"The total amount of work time the agent accumulated on this assignment record. A work segment is credited to the assignment it ended in, so on an assignment that started with reason 'Queue changed' it can include time from before the queue change and exceed assignmentDuration","$ref":"#/components/schemas/DurationMillis","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"concurrencyAdjustedHandleTime":{"description":"The concurrency adjusted agent handle time during this assignment, only applies to human agents","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"workloadAdjustedHandleTime":{"description":"The workload adjusted agent handle time during this assignment, only applies to human agents","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"nonWeightedAdjustedHandleTime":{"description":"The non weighted adjusted agent handle time during this assignment, only applies to human agents","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"ConversationAssignmentEnded","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"AgentHooksConversationUpdate":{"type":"object","properties":{"state":{"description":"The state of the conversation","$ref":"#/components/schemas/Conversation","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"ackId":{"minimum":0,"type":"integer","description":"The identifier for this state. Use this to acknowledge in a blocking agent hooks scenario","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"hints":{"type":"array","description":"Hints about actionable items in the conversation's state","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/ConversationUpdateHint","exampleSetFlag":false},"types":["array"]},"clientState":{"type":"string","description":"Optional state set by the client in its last acknowledgement","nullable":true,"readOnly":false,"extensions":{"x-quiq-skip-validation":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"derivedData":{"description":"Easy to access helper data that has been derived from the conversation","$ref":"#/components/schemas/DerivedConversationData","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"A state update object for a conversation","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ConversationStatusTransition":{"type":"string","description":"New Conversation Status","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["closed","inactive"]},"PapiSendAssociatedOutboundResponse":{"type":"object","properties":{"messageFields":{"type":"array","description":"Message-related response fields","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/MessageFields","exampleSetFlag":false},"types":["array"]}},"description":"A response object for sending associated outbound messages","exampleSetFlag":false,"types":["object"]},"ClassifyPlatformInvitationResponseRequest":{"type":"object","properties":{"invitationResponseMessageId":{"maxLength":36,"type":"string","description":"The message id of the invitation response message","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"isAcceptedInvitation":{"type":"boolean","description":"The intended invitation response of the customer, True if the invitation was accpeted, False if the invitation was rejected","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"A request object to explicitly classify a platform invitation response","exampleSetFlag":false,"types":["object"]},"EventDefinitionReference":{"maxLength":36,"type":"string","description":"Event definition reference identifier","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"ExternalContactLink":{"type":"object","properties":{"source":{"type":"string","description":"The source","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"sourceType":{"type":"string","description":"The source type","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"externalId":{"type":"string","description":"The external id","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"ExternalContactLink","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"StartConversationCrossPlatformMessagePair":{"type":"object","properties":{"platform":{"type":"string","description":"The platform of the message","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["SMS","GoogleRBM"]},"messages":{"type":"array","description":"The message to use when starting the conversation","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/StartConversationCrossPlatformMessage","exampleSetFlag":false},"types":["array"]}},"description":"A message object paired with a platform to be used when starting a conversation","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ObjectUpdateAction":{"type":"object","properties":{"target":{"type":"string","description":"Target field to update","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"action":{"type":"string","description":"Name of the action","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["set","add","remove","move"]},"values":{"type":"array","description":"`(When action='add')` Values to add to the target","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"type":"string","description":"Value of the entry","extensions":{"x-quiq-skip-validation":true,"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"types":["array"]},"position":{"description":"The move position","$ref":"#/components/schemas/MovePosition","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"value":{"type":"string","description":"`(When action='set')` New value of the field","nullable":true,"readOnly":false,"extensions":{"x-quiq-skip-validation":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"keys":{"type":"array","description":"`(When action='remove' or 'move')` Keys to remove from the target","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"minimum":0,"type":"integer","description":"The key","format":"int32","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["integer"]},"types":["array"]}},"description":"ObjectUpdateAction","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"PublicMessageMapIngress":{"type":"object","properties":{"authorType":{"type":"string","description":"The author type of the message","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["Customer","User","System"]},"author":{"maxLength":254,"type":"string","description":"The author identity of the message (Agent messages only)","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"imported":{"type":"boolean","description":"Denotes whether the message is being imported from an external conversation or if it's a new message. All customer messages must be imported","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"default":{"description":"The default, or fallback represenation of the message. Platform agnostic","$ref":"#/components/schemas/QuiqMessageIngress","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"overrides":{"type":"object","properties":{"Chat":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false},"WhatsApp":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false},"GoogleRBM":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false},"SMS":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false},"Kik":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false},"Twitter":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false},"Email":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false},"AppleMessages":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false},"Quiq":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false},"Facebook":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false},"GoogleMessages":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false},"Instagram":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false},"None":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false},"WeChat":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false},"Voice":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false},"Imported":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false}},"additionalProperties":{"$ref":"#/components/schemas/QuiqMessageIngress","exampleSetFlag":false},"description":"Platform-specific implementations of the message.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]}},"description":"A message and its platform equivalents","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"AssociatedOutboundFallbackOptions":{"type":"object","properties":{"fallbackPlatform":{"type":"string","description":"Fallback platform to send failed notification on","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["SMS","Quiq","Facebook","Kik","Chat","Imported","Twitter","AppleMessages","GoogleRBM","None","GoogleMessages","WeChat","WhatsApp","Instagram","Voice"]}},"description":"A notify request entry object","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"StartConversationCrossPlatformRequest":{"type":"object","properties":{"customerHandle":{"type":"string","description":"The customer handle","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"tenantHandle":{"type":"string","description":"DO NOT USE - The contact point","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"endpointId":{"type":"string","description":"The endpoint Id","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"messageFormats":{"type":"array","description":"The different message formats available","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/StartConversationCrossPlatformMessagePair","exampleSetFlag":false},"types":["array"]},"integrations":{"type":"array","description":"The different integrations available","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/ConversationIntegration","exampleSetFlag":false},"types":["array"]},"integrationsData":{"type":"object","properties":{},"additionalProperties":{"type":"string","description":"Value","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"description":"The integration data","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"precedence":{"type":"array","description":"An ordered array of message platforms. API will prefer the left-most entry that is available for the recipient","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/PlatformSpecification","exampleSetFlag":false},"types":["array"]},"messageMap":{"description":"The message map to use to build the notification message based on the platform that the message will go out on","$ref":"#/components/schemas/StartConversationMessageMap","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"fieldSetActions":{"type":"array","description":"The fields to set along with their values using the action syntax","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/ObjectUpdateAction","exampleSetFlag":false},"types":["array"]},"assigneeOverride":{"type":"string","description":"Optional assigneeOverride, if set the conversation.owner will be set directly to this user","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"A request object used to start a conversation across platforms","exampleSetFlag":false,"types":["object"]},"UpdateConversationFieldsResponse":{"type":"object","properties":{"errors":{"type":"array","description":"The validation errors for fields that were not applied","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"type":"string","description":"Error message","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"types":["array"]}},"description":"The response object for updating fields on a conversation when allowPartial is true","exampleSetFlag":false,"types":["object"]},"StartConversationQuiqMessage":{"type":"object","properties":{"text":{"type":"string","description":"Text for the messsage","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"richText":{"description":"Rich text for the messsage","$ref":"#/components/schemas/QuiqRichText","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"proxyInteraction":{"description":"A proxy interaction","$ref":"#/components/schemas/ProxyInteraction","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"quiqReply":{"description":"Suggested reply messages for the recipient","$ref":"#/components/schemas/QuiqReply","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"card":{"description":"QuiqCard definition","$ref":"#/components/schemas/QuiqCard","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"carousel":{"description":"QuiqCarousel definition","$ref":"#/components/schemas/QuiqCarousel","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"pay":{"description":"QuiqPay definition","$ref":"#/components/schemas/QuiqPay","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"auth":{"description":"QuiqAuth definition","$ref":"#/components/schemas/QuiqAuth","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"times":{"description":"A collection of time items, which are similar to calendar events.","$ref":"#/components/schemas/QuiqTimes","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"transcriptHints":{"description":"Transcript hints","$ref":"#/components/schemas/MessageTranscriptHints","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"directives":{"description":"Optional reply directives such as data bindings","$ref":"#/components/schemas/RichReplyDirectives","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"followUpSettings":{"description":"Whether or not this message requires an additional follow-up message from an agent","$ref":"#/components/schemas/FollowUpSettings","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"surveySolicitation":{"description":"Mark this message as a solicitation for a specified survey","$ref":"#/components/schemas/MessageSurveySolicitation","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"postbackData":{"type":"object","description":"Optional json that will be populated if this message is in reply to an item that was sent with postback data.","nullable":true,"readOnly":false,"extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"platformProperties":{"description":"Platform specific properties","$ref":"#/components/schemas/PlatformProperties","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"magicMessageDetails":{"description":"Quiq compose details","$ref":"#/components/schemas/MagicMessageDetailsMeta","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"platformInvitation":{"description":"QuiqPlatformInvitation definition","$ref":"#/components/schemas/QuiqPlatformInvitation","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"assets":{"maxItems":10,"type":"array","description":"A list of assets (e.g. images, video, etc) to include with the message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/PublicAssetIngress","exampleSetFlag":false},"types":["array"]},"imported":{"type":"boolean","description":"Whether or not the message is imported","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"authorType":{"type":"string","description":"Who wrote this message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["Customer","User","System"]},"variableDefinitions":{"type":"object","properties":{},"additionalProperties":{"type":"string","description":"Function","extensions":{"x-quiq-skip-validation":true,"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"description":"The variable definitions map","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]}},"description":"Quiq Message","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"PlatformHandlePair":{"type":"object","properties":{"platform":{"description":"A messaging platform that is supported by the customer","$ref":"#/components/schemas/MessagePlatform","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"customerHandle":{"maxLength":255,"type":"string","description":"The handle for the customer on the messaging platform","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"A pair of a messaging platform and a customer handle who supports that platform","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"GlobalWrittenLanguage":{"type":"string","description":"The written language type","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["af","am","ar","az","be","bg","bn","bs","ca","ceb","co","cs","cy","da","de","el","en","eo","es","es-419","et","eu","fa","fi","fr","fr-CA","fy","ga","gd","gl","gu","ha","haw","he","hi","hmn","hr","ht","hu","hy","id","ig","is","it","ja","jv","ka","kk","km","kn","ko","ku","ky","la","lb","lo","lt","lv","mg","mi","mk","ml","mn","mr","ms","mt","my","ne","nl","no","ny","or","pa","pl","ps","pt","pt-BR","ro","ru","rw","sd","si","sk","sl","sm","sn","so","sq","sr","st","su","sv","sw","ta","te","tg","th","tk","tl","tr","tt","ug","uk","und","ur","uz","vi","xh","yi","yo","zh","zh-Hant","zu"]},"SendMessagesResponse":{"type":"object","properties":{"messageFields":{"type":"array","description":"Message-related response fields","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/MessageFields","exampleSetFlag":false},"types":["array"]}},"description":"Response object for public send messages apis.","exampleSetFlag":false,"types":["object"]},"AssignmentEndReasonsMeta":{"type":"string","description":"Assignment end reason","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["Agent unresponsive","Agent went offline","Conversation became inactive","Conversation ended","Conversation requeued","Invitation missed","Invitation rejected","Queue changed","Reassigned by other user","Takeover","Transferred to another agent"]},"MovePosition":{"type":"object","properties":{"head":{"type":"boolean","description":"Head","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"last":{"type":"boolean","description":"Last","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"relative":{"description":"Relative","$ref":"#/components/schemas/RelativeMove","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"MovePosition","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"NewServiceConversationResponse":{"type":"object","properties":{"id":{"type":"string","description":"The conversation's id","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"A response containing the new conversation's id","exampleSetFlag":false,"types":["object"]},"SetConvoPriorityRequestMeta":{"type":"object","properties":{"priority":{"maximum":100.0,"minimum":0,"type":"integer","description":"The priority","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]}},"description":"A request object for setting the conversation priority","exampleSetFlag":false,"types":["object"]},"ConversationUpdateHint":{"type":"object","properties":{"hint":{"type":"string","description":"The type of hint","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["invitation-timer-active","response-timer-active","no-message-since-assignment","no-longer-a-member","last-agent-message-failed","transfer-requested","custom-timer-expired","contact-event-occurred"]},"data":{"description":"Data associated with the hint","$ref":"#/components/schemas/","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"A hint about a conversation state update","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"GoogleRegistration":{"type":"object","properties":{"registrations":{"type":"object","properties":{},"additionalProperties":{"$ref":"#/components/schemas/ContactPointRegistration","exampleSetFlag":false},"description":"The contact point registrations","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"tenantDisabled":{"type":"boolean","description":"Whether or not the tenant is disabled","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"validationCode":{"type":"string","description":"Validation code for the tenant","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"A tenant's Google registration","exampleSetFlag":false,"types":["object"]},"RcsAgentLaunch":{"type":"object","properties":{"contactPoint":{"description":"The contact point","$ref":"#/components/schemas/ContactPointReference","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"carriers":{"type":"object","properties":{},"additionalProperties":{"$ref":"#/components/schemas/RcsCarrierLaunch","exampleSetFlag":false},"description":"Launch state per carrier","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"content":{"description":"The submitted content","$ref":"#/components/schemas/RcsLaunchContent","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"An RCS agent's launch record, kept apart from its registration and credentials","exampleSetFlag":false,"types":["object"]},"RcsCarrierLaunchRequest":{"type":"object","properties":{"launchState":{"type":"string","description":"Launch state","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["UNLAUNCHED","PENDING","LAUNCHED","REJECTED","SUSPENDED"]},"comment":{"type":"string","description":"The carrier's or provider's feedback","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Set an RCS agent's launch state at one carrier. updatedAt/updatedBy are set by the service.","exampleSetFlag":false,"types":["object"]},"UpdateContactPointProjectGoogleRegistration":{"type":"object","properties":{"startMessage":{"type":"string","description":"The message sent in response to a START request","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"stopMessage":{"type":"string","description":"The message sent in response to a STOP request","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"helpMessage":{"type":"string","description":"The message sent in response to a HELP request","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"includeAgentId":{"type":"boolean","description":"Whether to include the agentId when making API requests.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"provider":{"type":"string","description":"Provider","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"bandWidthCredentials":{"description":"Provider","$ref":"#/components/schemas/BandwidthAccountCredentialsMeta","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"nativeAgentId":{"type":"string","description":"Native Agent Id","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Update a project's google registration","exampleSetFlag":false,"types":["object"]},"BandwidthAccountCredentialsMeta":{"type":"object","properties":{"topAccountId":{"type":"string","description":"Account Id","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"webhookUser":{"type":"string","description":"Webhook User","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"webhookPassword":{"type":"string","description":"Webhook Password","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"applicationId":{"type":"string","description":"App Id","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"apiToken":{"type":"string","description":"Token","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"apiSecret":{"type":"string","description":"Secret","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"clientId":{"type":"string","description":"OAuth Client Id","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"clientSecret":{"type":"string","description":"OAuth Client Secret","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Bandwidth Account Credentials","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"RcsLaunchContentRequest":{"type":"object","properties":{"optInDescription":{"type":"string","description":"How end users opt in","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"optInUrl":{"type":"string","description":"Where the opt-in is advertised","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"privacyPolicyLink":{"type":"string","description":"Privacy Policy link","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"termsAndConditionsLink":{"type":"string","description":"Terms and Conditions link","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Replace the content block of an RCS agent's launch record. updatedAt/updatedBy are set by the service.","exampleSetFlag":false,"types":["object"]},"CreateContactPointRequest":{"type":"object","properties":{"contactPoint":{"description":"The contact point","$ref":"#/components/schemas/ContactPointReference","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"enabled":{"type":"boolean","description":"Whether or not the contact point is enabled","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"authenticationKeys":{"type":"array","description":"The authentication keys used to validate incoming messages","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"type":"string","description":"Key","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"types":["array"]},"spamHandles":{"type":"array","description":"Customer handles who will be blocked from sending messages to Quiq. The messages are sent to a black hole.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"type":"string","description":"","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"types":["array"]}},"description":"Create a Contact point registration","exampleSetFlag":false,"types":["object"]},"AddRcsAllowlistPhoneRequest":{"type":"object","properties":{"phoneNumber":{"type":"string","description":"The phone number","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"A phone number to add to the tenant's RCS capability allowlist","exampleSetFlag":false,"types":["object"]},"ContactPointProjectGoogleRegistration":{"type":"object","properties":{"keyFile":{"type":"object","description":"The key file","nullable":true,"readOnly":false,"extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"startMessage":{"type":"string","description":"The message sent in response to a START request","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"stopMessage":{"type":"string","description":"The message sent in response to a STOP request","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"helpMessage":{"type":"string","description":"The message sent in response to a HELP request","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"includeAgentId":{"type":"boolean","description":"Whether to include the agentId when making API requests.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"provider":{"type":"string","description":"Provider","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"bandWidthCredentials":{"description":"Provider","$ref":"#/components/schemas/BandwidthAccountCredentialsMeta","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"nativeAgentId":{"type":"string","description":"Native Agent Id","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"A project's google registration","exampleSetFlag":false,"types":["object"]},"RcsLaunchContent":{"type":"object","properties":{"optInDescription":{"type":"string","description":"How end users opt in","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"optInUrl":{"type":"string","description":"Where the opt-in is advertised","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"privacyPolicyLink":{"type":"string","description":"Privacy Policy link","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"termsAndConditionsLink":{"type":"string","description":"Terms and Conditions link","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"updatedAt":{"type":"number","description":"When this block was last written","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"updatedBy":{"type":"string","description":"Who last wrote this block (the caller, never the body)","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"The content submitted for an RCS agent's launch","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"RcsCarrierLaunch":{"type":"object","properties":{"launchState":{"type":"string","description":"Launch state","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["UNLAUNCHED","PENDING","LAUNCHED","REJECTED","SUSPENDED"]},"comment":{"type":"string","description":"The carrier's or provider's feedback","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"updatedAt":{"type":"number","description":"When this entry was last written","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"updatedBy":{"type":"string","description":"Who last wrote this entry (the caller, never the body)","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"An RCS agent's launch state at one carrier","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"RcsAllowlist":{"type":"object","properties":{"phoneNumbers":{"type":"array","description":"The allowlisted phone numbers, sorted","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"type":"string","description":"A phone number in E.164 format, e.g. +15554445555","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"types":["array"]}},"description":"Phone numbers that pass the tenant's Bandwidth RCS capability check regardless of Bandwidth's answer","exampleSetFlag":false,"types":["object"]},"UpdateContactPointRequest":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether or not the contact point is enabled","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"signatureToken":{"type":"string","description":"Token to use when checking signatures","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"authenticationKeys":{"type":"array","description":"The authentication keys used to validate incoming messages","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"type":"string","description":"Key","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"types":["array"]},"spamHandles":{"type":"array","description":"Customer handles who will be blocked from sending messages to Quiq. The messages are sent to a black hole.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"type":"string","description":"","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"types":["array"]}},"description":"Update a given contact-point","exampleSetFlag":false,"types":["object"]},"CapabilitiesCheckResponseMetadatas":{"type":"object","properties":{"isEnabled":{"type":"boolean","description":"If the number is RCS Enabled","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"The capabilities check definition","exampleSetFlag":false,"types":["object"]},"ContactPointRegistration":{"type":"object","properties":{"contactPoint":{"description":"The contact point","$ref":"#/components/schemas/ContactPointReference","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"googleRegistrations":{"type":"object","properties":{},"additionalProperties":{"$ref":"#/components/schemas/ContactPointBusiness","exampleSetFlag":false},"description":"The google registrations","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"enabled":{"type":"boolean","description":"Whether or not the contact point is enabled","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"signatureToken":{"type":"string","description":"Token to use when checking signatures","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"authenticationKeys":{"type":"array","description":"The authentication keys used to validate incoming messages","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"type":"string","description":"Key","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"types":["array"]},"spamHandles":{"type":"array","description":"Customer handles who will be blocked from sending messages to Quiq. The messages are sent to a black hole.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"type":"string","description":"","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"types":["array"]}},"description":"A contact point registration","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ContactPointBusiness":{"type":"object","properties":{"googleKeyFile":{"type":"string","description":"A string representation of the key file","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"startMessage":{"type":"string","description":"The message sent in response to a START request","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"stopMessage":{"type":"string","description":"The message sent in response to a STOP request","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"helpMessage":{"type":"string","description":"The message sent in response to a HELP request","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"includeAgentId":{"type":"boolean","description":"Whether to include the agentId when making API requests.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"provider":{"type":"string","description":"The RBM Provider","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"A contact point business","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"TenantValidationCodeRequest":{"type":"object","properties":{"code":{"type":"string","description":"The validation code","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Sets the validation code for a tenant","exampleSetFlag":false,"types":["object"]},"SurveyDefinitionResultDef":{"type":"object","properties":{"surveyDefinition":{"description":"Survey definition context","$ref":"#/components/schemas/SurveyDefinitionContext","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"Survey Definition Response","exampleSetFlag":false,"types":["object"]},"AgentsSurveySummaryRequestDef":{"type":"object","properties":{"surveyId":{"type":"string","description":"Survey id","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"from":{"type":"number","description":"From","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"to":{"type":"number","description":"To","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]}},"description":"Agents Survey Summary Request","exampleSetFlag":false,"types":["object"]},"SurveyDefinitionContext":{"type":"object","properties":{"isEnabled":{"type":"boolean","description":"IsEnabled","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"surveyDefinition":{"description":"Survey definition","$ref":"#/components/schemas/SurveyDefinition","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"A survey definition with additional properties","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"SurveyQuestionSubmissionStat":{"type":"object","properties":{"numberOfSubmissions":{"type":"integer","description":"number of submissions","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"averageScore":{"type":"number","description":"avg score","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]}},"description":"Question Submission Stat","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"SurveyContextDefinition":{"type":"object","properties":{"importedProperties":{"type":"array","description":"The imported properties","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"type":"string","description":"The imported property","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"types":["array"]}},"description":"The context definition for the survey","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"SurveyDefinitionUpdateRequestDef":{"type":"object","properties":{"definition":{"description":"Survey definition","$ref":"#/components/schemas/SurveyDefinition","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"Survey Def Update","exampleSetFlag":false,"types":["object"]},"AgentSurveySummaryDef":{"type":"object","properties":{"agentId":{"type":"string","description":"agent id","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"numberOfSubmissions":{"type":"integer","description":"number of submissions","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"questionSubmissionStats":{"type":"object","properties":{},"additionalProperties":{"$ref":"#/components/schemas/SurveyQuestionSubmissionStat","exampleSetFlag":false},"description":"a map of the question/field id to the submission stats for that question","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]}},"description":"Agent Survey Summary","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"FeedbackCsvRequestDef":{"type":"object","properties":{"surveyId":{"type":"string","description":"Survey id","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"from":{"type":"number","description":"Start time of the survey result export","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"to":{"type":"number","description":"End time of the survey result export","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"includeCrmColumns":{"type":"boolean","description":"Whether or not to force inclusion of the CRM columns (client shouldn't use this, it's optional)","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"formatting":{"description":"The formatting of the content of the resulting analytics file","$ref":"#/components/schemas/CSVFormatting","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"Feedback CSV Request","exampleSetFlag":false,"types":["object"]},"FeedbackCsvResultDef":{"type":"object","properties":{"id":{"type":"string","description":"The search id","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Feedback CSV Result","exampleSetFlag":false,"types":["object"]},"SurveySubmissionReceivedPayload":{"type":"object","properties":{"surveyId":{"type":"string","description":"The ID of the survey that was submitted","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"submissionId":{"type":"string","description":"The ID of this distinct submission","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"submitted":{"type":"number","description":"The timestamp when the survey was submitted","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"customerPlatform":{"description":"The messaging platform used by the customer for this survey","$ref":"#/components/schemas/CustomerPlatformMeta","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"customerHandle":{"maxLength":255,"type":"string","description":"The customer's handle (e.g. phone number) on the customer platform","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"solicitingIntegrationReferences":{"type":"array","description":"The integration references associated with the soliciting conversation","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/IntegrationReference","exampleSetFlag":false},"types":["array"]},"solicitingConversationId":{"maxLength":36,"type":"string","description":"The ID of the conversation that solicited the survey","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"recentConversationIds":{"type":"array","description":"The IDs of conversations completed around the time of the survey submission. These can be used to provide more context to the survey results.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"maxLength":36,"type":"string","description":"Conversation identifier","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"types":["array"]},"agentId":{"maxLength":512,"type":"string","description":"The human agent who sent the most messages on the conversation that solicited the survey","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"responses":{"type":"object","properties":{},"additionalProperties":{"type":"string","description":"The response value","extensions":{"x-quiq-skip-validation":true,"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"description":"An object containing the customer's responses to the survey questions. The keys are the survey field IDs and values are the responses corresponding to those fields.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"sentimentScores":{"type":"object","properties":{},"additionalProperties":{"$ref":"#/components/schemas/SentimentScore","exampleSetFlag":false},"description":"An object containing the sentiment analysis scores for natural language responses. The keys are the natural language survey field IDs and values are the responses corresponding to those fields.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"additionalProperties":{"type":"object","properties":{},"additionalProperties":{"type":"string","description":"The additional property value","extensions":{"x-quiq-skip-validation":true,"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"description":"Any additional properties configured in the survey definition","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]}},"description":"The Webhook payload delivered upon receiving a survey response","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"Score Choice":{"type":"object","properties":{"label":{"maxLength":36,"type":"string","description":"Label","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"value":{"maximum":10.0,"minimum":0,"type":"integer","description":"Value","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]}},"description":"Score Choice","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"AgentsSurveySummaryResultDef":{"type":"object","properties":{"agentSummary":{"type":"array","description":"Agent Summary","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/AgentSurveySummaryDef","exampleSetFlag":false},"types":["array"]}},"description":"Agents Survey Summary Response","exampleSetFlag":false,"types":["object"]},"SurveyDefinitionRequestDef":{"type":"object","properties":{"definitionId":{"type":"string","description":"Survey definition id","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Survey Definition Request","exampleSetFlag":false,"types":["object"]},"SurveyFieldType":{"type":"object","properties":{"fieldType":{"type":"string","description":"fieldType","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"reflectsSentiment":{"type":"boolean","description":"`(When fieldType='natural-language')` ","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"max":{"maximum":100.0,"minimum":1,"type":"integer","description":"`(When fieldType='int-score')` ","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"choices":{"type":"array","description":"`(When fieldType='score-choice')` ","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/Score Choice","exampleSetFlag":false},"types":["array"]},"min":{"maximum":99,"minimum":0,"type":"integer","description":"`(When fieldType='int-score')` ","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]}},"description":"SurveyFieldType","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"SurveyListDefinitionsResultDef":{"type":"object","properties":{"surveyDefinitions":{"type":"array","description":"Survey definition ids","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/SurveyDefinitionContext","exampleSetFlag":false},"types":["array"]}},"description":"Survey List IDs Response","exampleSetFlag":false,"types":["object"]},"SurveyDefinition":{"type":"object","properties":{"id":{"type":"string","description":"Id","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"label":{"type":"string","description":"Label","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"fields":{"type":"array","description":"Fields","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/SurveyField","exampleSetFlag":false},"types":["array"]},"solicitationMessage":{"description":"Solicitation Message","$ref":"#/components/schemas/QuiqMessage","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"contextDefinition":{"description":"The Survey Context Definition","$ref":"#/components/schemas/SurveyContextDefinition","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"solicitationMessageMap":{"description":"Solicitation Message Map","$ref":"#/components/schemas/MessageMap","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"solicitationRepeatWindowMinutes":{"maximum":43800.0,"minimum":0,"type":"integer","description":"Solicitation Repeat Window (minutes)","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"advancedMode":{"type":"boolean","description":"Advanced editing mode","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"SurveyDeifintion","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"SurveySubmissionReceivedEvent":{"type":"object","properties":{"eventType":{"type":"string","description":"The type of the event","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["SurveySubmissionReceived"]},"data":{"description":"The generic data associated with the event","$ref":"#/components/schemas/SurveySubmissionReceivedPayload","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"id":{"type":"string","description":"The id of the event","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"timestamp":{"type":"number","description":"The millisecond timestamp that the event was created","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]}},"description":"A public event","exampleSetFlag":false,"types":["object"]},"SurveyField":{"type":"object","properties":{"id":{"type":"string","description":"Id","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"label":{"type":"string","description":"Label","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"type":{"description":"Type","$ref":"#/components/schemas/SurveyFieldType","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"required":{"type":"boolean","description":"Required","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"SurveyField","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"SurveyDefinitionReferenceType":{"maxLength":64,"type":"string","description":"Survey definition identifier","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"CreateSurveyDefinitionRequest":{"type":"object","properties":{"surveyDefinitionId":{"type":"string","description":"Survey definition id","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"label":{"type":"string","description":"Label","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Create a new Survey Definition reflecting teh given request","exampleSetFlag":false,"types":["object"]},"MessageMap":{"type":"object","properties":{"default":{"description":"The default, or fallback representation of the message. Platform agnostic","$ref":"#/components/schemas/QuiqMessage","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"overrides":{"type":"object","properties":{"Chat":{"$ref":"#/components/schemas/QuiqMessage","exampleSetFlag":false},"WhatsApp":{"$ref":"#/components/schemas/QuiqMessage","exampleSetFlag":false},"GoogleRBM":{"$ref":"#/components/schemas/QuiqMessage","exampleSetFlag":false},"SMS":{"$ref":"#/components/schemas/QuiqMessage","exampleSetFlag":false},"Kik":{"$ref":"#/components/schemas/QuiqMessage","exampleSetFlag":false},"Twitter":{"$ref":"#/components/schemas/QuiqMessage","exampleSetFlag":false},"Email":{"$ref":"#/components/schemas/QuiqMessage","exampleSetFlag":false},"AppleMessages":{"$ref":"#/components/schemas/QuiqMessage","exampleSetFlag":false},"Quiq":{"$ref":"#/components/schemas/QuiqMessage","exampleSetFlag":false},"Facebook":{"$ref":"#/components/schemas/QuiqMessage","exampleSetFlag":false},"GoogleMessages":{"$ref":"#/components/schemas/QuiqMessage","exampleSetFlag":false},"Instagram":{"$ref":"#/components/schemas/QuiqMessage","exampleSetFlag":false},"None":{"$ref":"#/components/schemas/QuiqMessage","exampleSetFlag":false},"WeChat":{"$ref":"#/components/schemas/QuiqMessage","exampleSetFlag":false},"Voice":{"$ref":"#/components/schemas/QuiqMessage","exampleSetFlag":false},"Imported":{"$ref":"#/components/schemas/QuiqMessage","exampleSetFlag":false}},"additionalProperties":{"$ref":"#/components/schemas/QuiqMessage","exampleSetFlag":false},"description":"Platform-specific implementations of the message.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]}},"description":"A message and its platform equivalents","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"QuiqMessage":{"type":"object","properties":{"text":{"type":"string","description":"Text for the messsage","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"richText":{"description":"Rich text for the messsage","$ref":"#/components/schemas/QuiqRichText","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"proxyInteraction":{"description":"A proxy interaction","$ref":"#/components/schemas/ProxyInteraction","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"quiqReply":{"description":"Suggested reply messages for the recipient","$ref":"#/components/schemas/QuiqReply","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"card":{"description":"QuiqCard definition","$ref":"#/components/schemas/QuiqCard","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"carousel":{"description":"QuiqCarousel definition","$ref":"#/components/schemas/QuiqCarousel","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"pay":{"description":"QuiqPay definition","$ref":"#/components/schemas/QuiqPay","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"auth":{"description":"QuiqAuth definition","$ref":"#/components/schemas/QuiqAuth","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"times":{"description":"A collection of time items, which are similar to calendar events.","$ref":"#/components/schemas/QuiqTimes","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"assets":{"maxItems":10,"type":"array","description":"A list of assets (e.g. images, video, etc) to include with the message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/Asset","exampleSetFlag":false},"types":["array"]},"transcriptHints":{"description":"Transcript hints","$ref":"#/components/schemas/MessageTranscriptHints","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"directives":{"description":"Optional reply directives such as data bindings","$ref":"#/components/schemas/RichReplyDirectives","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"followUpSettings":{"description":"Whether or not this message requires an additional follow-up message from an agent","$ref":"#/components/schemas/FollowUpSettings","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"surveySolicitation":{"description":"Mark this message as a solicitation for a specified survey","$ref":"#/components/schemas/MessageSurveySolicitation","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"postbackData":{"type":"object","description":"Optional json that will be populated if this message is in reply to an item that was sent with postback data.","nullable":true,"readOnly":false,"extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"platformProperties":{"description":"Platform specific properties","$ref":"#/components/schemas/PlatformProperties","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"magicMessageDetails":{"description":"Quiq compose details","$ref":"#/components/schemas/MagicMessageDetailsMeta","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"platformInvitation":{"description":"QuiqPlatformInvitation definition","$ref":"#/components/schemas/QuiqPlatformInvitation","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"Quiq Message","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"StoredContextRequestResponse":{"type":"object","properties":{"key":{"maxLength":200,"type":"string","description":"A secure key to act as a global reference to this data","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"alias":{"type":"string","description":"The shortened alias of the key","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"A global reference key to this stored data","exampleSetFlag":false,"types":["object"]},"StoredContextRequest":{"type":"object","properties":{"context":{"description":"the context to be stored","$ref":"#/components/schemas/HallpassContext","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"A request to store some context for later, verified retrieval","exampleSetFlag":false,"types":["object"]},"AgentThinkingRequest":{"type":"object","properties":{"thinking":{"type":"boolean","description":"true to show the sequence in messages; false to clear whatever is showing. A clear always clears: messages, preset and ttlMillis sent with it are ignored and named in the response's warnings","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"messages":{"type":"array","description":"The sequence to show, in order. Required when thinking is true; at most 10 entries unless AGENT_THINKING.limits for the tenant or contact point says otherwise.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/AgentThinkingRequestLine","exampleSetFlag":false},"types":["array"]},"preset":{"type":"string","description":"One preset name for the whole sequence, or null for none. A letter, then up to 63 letters, digits, - or _. What a preset looks like is defined by the chat window's webchat JSON (agentThinking.presets; see [Agent Thinking web chat options](/docs/conversation-starter/#/webchat/advanced/agent_thinking)); a name the page does not define is allowed and ignored by the chat window. Webhook consumers receive the name as given and should treat it as untrusted input.","nullable":true,"readOnly":false,"extensions":{"x-quiq-skip-validation":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"ttlMillis":{"type":"number","description":"How long to show each line of this sequence, in milliseconds. Must be positive; absent or null uses AGENT_THINKING.ttlMillis, then the client's own default (the chat window: 5000). It sits under the chat window: the webchat JSON's agentThinking defaults and presets beat it, and a line's own ttlMillis beats everything. Sent as the frame's ttlMillis. There is no maximum.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]}},"description":"Push a sequence of transient thinking messages into a chat, or clear them. The request carries only text, durations and preset names; its ttlMillis sits under the chat window's defaults and presets; every look (motion, icon, classes, placement, what happens after the last line) is set by the chat window's webchat JSON (agentThinking; see [Agent Thinking web chat options](/docs/conversation-starter/#/webchat/advanced/agent_thinking))","exampleSetFlag":false,"types":["object"]},"AgentThinkingRequestLine":{"type":"object","properties":{"text":{"type":"string","description":"Plain text to show. Required and must not be empty when thinking is true; ignored on a clear. At most 512 characters unless AGENT_THINKING.limits for the tenant or contact point says otherwise.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"ttlMillis":{"type":"number","description":"How long to show this line before advancing to the next, in milliseconds. For the last line under the page's onComplete=clear it is the clear deadline. Must be positive. A line's own value beats every preset. Absent or null uses the presets, then the chat window's webchat defaults, then the request's ttlMillis, then AGENT_THINKING.ttlMillis, then the client's own default (the chat window: 5000). There is no maximum.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"preset":{"type":"string","description":"One preset name applied to this line over the sequence's preset, or null. A letter, then up to 63 letters, digits, - or _. What a preset looks like is defined by the chat window's webchat JSON (agentThinking.presets; see [Agent Thinking web chat options](/docs/conversation-starter/#/webchat/advanced/agent_thinking)); a name the page does not define is allowed and ignored by the chat window. Webhook consumers receive the name as given and should treat it as untrusted input.","nullable":true,"readOnly":false,"extensions":{"x-quiq-skip-validation":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"One status line in a thinking sequence: its text, how long it shows, and optionally a preset","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ConversationTypingRequest":{"type":"object","properties":{"typing":{"type":"boolean","description":"Whether to toggle the typing indicator on or off","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"Conversation typing request object","exampleSetFlag":false,"types":["object"]},"AgentThinkingResponse":{"type":"object","properties":{"delivered":{"type":"boolean","description":"true if at least one channel accepted the message: a chat socket, or the contact point's webchat webhook integration (sent when the registration is enabled and webhook typing indicators are on for the tenant)","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"deliveredVia":{"type":"array","description":"The channels that accepted the message: websocket, webchatWebhook. Empty when delivered is false.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"type":"string","description":"Channel","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["websocket","webchatWebhook"]},"types":["array"]},"reason":{"type":"string","description":"Why nothing was delivered. Absent when delivered is true.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["NoSubscription","UnsupportedPlatform","Disabled","NotAuthorized"]},"warnings":{"type":"array","description":"Request fields that were accepted but ignored, for example a preset sent with thinking=false. Names the field, never its value. Empty when there are none.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"type":"string","description":"Warning","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"types":["array"]}},"description":"Whether the thinking message reached a chat window, and why not if it did not","exampleSetFlag":false,"types":["object"]},"MaterializedConversationWorkspace":{"type":"object","properties":{"snippets":{"type":"array","description":"The snippets associated with the workspace","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/SnippetModel","exampleSetFlag":false},"types":["array"]},"workspace":{"description":"The conversation workspace object","$ref":"#/components/schemas/ConversationWorkspaceRequest","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"An object representing a materialized conversation workspace","exampleSetFlag":false,"types":["object"]},"MessageDefinitionIndexFetchResponse":{"type":"object","properties":{"definitions":{"type":"array","description":"The Message Definition Index records","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/MessageDefinitionIndexRecord","exampleSetFlag":false},"types":["array"]}},"description":"Response object for fetching Message Definitions","exampleSetFlag":false,"types":["object"]},"ConversationWorkspaceRequest":{"type":"object","properties":{"id":{"type":"string","description":"The conversation workspace ID","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"label":{"type":"string","description":"The conversation workspace label","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"rhsDefinition":{"type":"object","description":"The conversation workspace RHS definition","nullable":false,"readOnly":false,"extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"enabled":{"type":"boolean","description":"Whether or not the Conversation Workspace is enabled","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"agentAssistantId":{"description":"The agent assistant for the workspace","$ref":"#/components/schemas/AgentAssistantReference","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"agentAssistantSettings":{"description":"The agent assistant settings","$ref":"#/components/schemas/AgentAssistWorkspaceSettings","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"An object representing a conversation workspace","exampleSetFlag":false,"types":["object"]},"WorkspacesResponse":{"type":"object","properties":{"workspaces":{"type":"array","description":"The workspace","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/ConversationWorkspaceRequest","exampleSetFlag":false},"types":["array"]}},"description":"Response object for listing workspaces","exampleSetFlag":false,"types":["object"]},"MessageDefinitionIndexRecord":{"type":"object","properties":{"id":{"maxLength":36,"type":"string","description":"The Message Definition's ID","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"label":{"type":"string","description":"The Message Definition's label","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"visibilitySettings":{"description":"The visibility settings of the Message Definition","$ref":"#/components/schemas/MessageDefinitionVisibilitySettings","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"snippetInfo":{"description":"The Message Definition's snippet information","$ref":"#/components/schemas/MessageDefinitionSnippetInformation","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"disabledOn":{"type":"number","description":"Optional time (in millis) when the Message Definition was disabled, null implies it is enabled","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"userId":{"description":"The Id of the user if the message definition is agent scoped","$ref":"#/components/schemas/UserReference","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"The Message Definition index record","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"MessageCatalogMetaDictionaryResponse":{"type":"object","properties":{"dictionary":{"type":"object","description":"The meta dictionary in string form","nullable":true,"readOnly":false,"extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]}},"description":"Response object for fetching a message catalog meta dictionary","exampleSetFlag":false,"types":["object"]},"SnippetFetchResponse":{"type":"object","properties":{"snippets":{"type":"array","description":"The Versioned Snippet Message Definitions","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/VersionedMessageDefinition","exampleSetFlag":false},"types":["array"]}},"description":"Response object for fetching Snippet Message Definitions","exampleSetFlag":false,"types":["object"]},"Snippet":{"type":"object","properties":{"level":{"type":"string","description":"level that his snippet applies to","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["tenant","agent"]},"trigger":{"type":"string","description":"shortcuts for agents to insert snippets","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"tags":{"type":"array","description":"Levels of applicability for this snippet -- outbound, conversation, notificaiton, etc.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"type":"string","description":"","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"types":["array"]},"content":{"type":"array","description":"The message content that comprises the snippet","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/MessageMap","exampleSetFlag":false},"types":["array"]},"workspaceIds":{"type":"array","description":"The workspace ids that this snippet is attached to.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"type":"string","description":"","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"types":["array"]},"filteredByWorkspace":{"type":"boolean","description":"Whether or not this snippet is only applies to specified workspaces. Only applicable if tenant level snippet","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"The building block of the messaging experience","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"SnippetIngress":{"type":"object","properties":{"level":{"type":"string","description":"level that his snippet applies to","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["tenant","agent"]},"trigger":{"type":"string","description":"shortcuts for agents to insert snippets","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"tags":{"type":"array","description":"Levels of applicability for this snippet -- outbound, conversation, notificaiton, etc.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"type":"string","description":"","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"types":["array"]},"workspaceIds":{"type":"array","description":"The workspace ids that this snippet is attached to.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"type":"string","description":"","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"types":["array"]},"filteredByWorkspace":{"type":"boolean","description":"Whether or not this snippet is only applies to specified workspaces. Only applicable if tenant level snippet","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"content":{"type":"array","description":"The message content that comprises the snippet","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/MessageMapIngress","exampleSetFlag":false},"types":["array"]}},"description":"The building block of the messaging experience","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"MessageDefinitionContent":{"type":"object","properties":{"message":{"description":"The Message Definition message","$ref":"#/components/schemas/MessageMap","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"The Message Definition Content","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"VersionedMessageDefinition":{"type":"object","properties":{"version":{"type":"string","description":"The Message Definition's version","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"definition":{"description":"The Message Definition","$ref":"#/components/schemas/MessageDefinition","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"lastModified":{"type":"number","description":"The last time this Message Definition was modified","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]}},"description":"A Message Definition object along with its version and the time it was last modified","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"AgentAssistWorkspaceSettings":{"type":"object","properties":{"noSuggestionIndicator":{"type":"boolean","description":"Whether to show an indicator when the assistant generates no suggestions","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"An object representing a agent assist settings","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"SnippetModel Sequence":{"title":"SnippetModel Sequence","type":"array","description":"sequence of snippet models","exampleSetFlag":false,"items":{"$ref":"#/components/schemas/SnippetModel","exampleSetFlag":false},"types":["array"]},"MessageCatalogMetaDictionaryRequest":{"type":"object","properties":{"visibilitySettings":{"description":"The visibility settings of the Message Definition","$ref":"#/components/schemas/MessageDefinitionVisibilitySettings","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"agentId":{"type":"string","description":"The agent associated to the message definition","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Request object for fetching a message catalog meta dictionary","exampleSetFlag":false,"types":["object"]},"UpdateMessageDefinitionRequest":{"type":"object","properties":{"disable":{"type":"boolean","description":"Whether or not to disable the message definition","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"messageDefinition":{"description":"The message definition to update","$ref":"#/components/schemas/MessageDefinition","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"Update a message definition","exampleSetFlag":false,"types":["object"]},"MessageDefinitionVisibilitySettings":{"type":"object","properties":{"visibility":{"uniqueItems":true,"type":"array","description":"The areas in which this message definition should be visible","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"type":"string","description":"The Message Definition's visibility","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["Outbound","StartConversation","Bot","ConversationRules","ProactiveAI","InteractionRules","Conversation","AiAssistant"]},"types":["array"]}},"description":"The message definition visibility settings","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"MessageDefinition":{"type":"object","properties":{"id":{"maxLength":36,"type":"string","description":"The Message Definition's ID","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"label":{"type":"string","description":"The Message Definition's label","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"content":{"description":"The Message Definition content","$ref":"#/components/schemas/MessageDefinitionContent","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"visibilitySettings":{"description":"The visibility settings of the Message Definition","$ref":"#/components/schemas/MessageDefinitionVisibilitySettings","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"snippetInfo":{"description":"The Message Definition's snippet information","$ref":"#/components/schemas/MessageDefinitionSnippetInformation","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"disabledOn":{"type":"number","description":"(Optional) When the message definition was disabled (in millis)","nullable":true,"readOnly":true,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"userId":{"description":"The Id of the user if the message definition is agent scoped","$ref":"#/components/schemas/UserReference","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"sendOnApiRequest":{"type":"boolean","description":"Allow this message definition to be sent via api request","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"The Message Definition Model","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"AddSnippetRequest":{"type":"object","properties":{"snippet":{"description":"snippet object","$ref":"#/components/schemas/SnippetIngress","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"adds the provided snippet","exampleSetFlag":false,"types":["object"]},"UpdateSnippetRequest":{"type":"object","properties":{"snippet":{"description":"snippet object","$ref":"#/components/schemas/SnippetIngress","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"A request object that represents an updated version of an existing snippet","exampleSetFlag":false,"types":["object"]},"EitherMessageDefinitionIdOrMessageMapMeta":{"type":"object","properties":{"messageDefinitionId":{"maxLength":36,"type":"string","description":"The message definition ID","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"messageMap":{"description":"An optional message map","$ref":"#/components/schemas/MessageMap","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"Either a message def ID or message map to variable replace","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"AgentAssistantReference":{"maxLength":64,"type":"string","description":"AI Assistant identifier","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"SnippetModel":{"type":"object","properties":{"id":{"type":"string","description":"id in snippets table","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"snippet":{"description":"Snippet object","$ref":"#/components/schemas/Snippet","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"The storage model of the snippet object","exampleSetFlag":false,"types":["object"]},"PublicMessageDefinitionEgress":{"type":"object","properties":{"definition":{"description":"The message definition","$ref":"#/components/schemas/MessageDefinition","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"version":{"type":"string","description":"The message definition's current version","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"lastModified":{"type":"number","description":"When the message definition was last modified (if ever)","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]}},"description":"Response object for fetching Message Definitions","exampleSetFlag":false,"types":["object"]},"ApplyVariableReplacementsRequestMeta":{"type":"object","properties":{"conversationId":{"maxLength":36,"type":"string","description":"Optional conversation ID to fetch so we can apply variable replacements on conversation fields","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"customerLookup":{"description":"Optional customer lookup data so we can fetch a contact and apply variable replacements based on contact data","$ref":"#/components/schemas/CustomerLookupMeta","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"messageTemplate":{"description":"Either a message definition ID or message map to variable replace","$ref":"#/components/schemas/EitherMessageDefinitionIdOrMessageMapMeta","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"externalVariableData":{"type":"object","properties":{},"additionalProperties":{"type":"string","description":"value","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"description":"Data from external sources that will be referenced during variable replacement","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]}},"description":"Apply variable replacements request object","exampleSetFlag":false,"types":["object"]},"MaterializedConversationWorkspaceV2":{"type":"object","properties":{"snippets":{"type":"array","description":"The snippets associated with the workspace in message definition format","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/VersionedMessageDefinition","exampleSetFlag":false},"types":["array"]},"workspace":{"description":"The conversation workspace object","$ref":"#/components/schemas/ConversationWorkspaceRequest","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"An object representing a materialized conversation workspace","exampleSetFlag":false,"types":["object"]},"CustomerLookupMeta":{"type":"object","properties":{"phoneNumber":{"description":"Phone number to lookup with","$ref":"#/components/schemas/PhoneNumber","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"instagramId":{"description":"Instagram ID and Page ID to lookup by","$ref":"#/components/schemas/InstagramId","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"appleId":{"description":"Apple ID and Business ID to lookup by","$ref":"#/components/schemas/AppleBusinessId","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"facebookId":{"description":"Facebook ID and Page ID to lookup by","$ref":"#/components/schemas/InstagramId","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"Info to use to lookup a contact","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"InstagramId":{"type":"object","properties":{"pageId":{"type":"string","description":"The facebook page associated with the instagram account 'id'","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"id":{"type":"string","description":"Identifier for this contact within the context of an Instagram account","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Identifier for this contact within the scope of an Instagram account","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"MessageDefinitionSnippetInformation":{"type":"object","properties":{"trigger":{"type":"string","description":"shortcuts for agents to insert snippets","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"workspaceIds":{"type":"array","description":"The workspace IDs that this snippet is attached to.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"type":"string","description":"","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"types":["array"]},"filteredByWorkspace":{"type":"boolean","description":"Whether or not this snippet is only applies to specified workspaces","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"The Message Definition's Snippet Info","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"OtherSettings":{"type":"object","properties":{"outboundRate":{"type":"number","description":"The outbound rate","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]}},"description":"Other external settings","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"TwilioNumbePurchaserRequest":{"type":"object","properties":{"number":{"description":"A phone number","$ref":"#/components/schemas/PhoneNumber","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"friendlyName":{"maxLength":64,"minLength":1,"type":"string","description":"An optional friendly name to give the number","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"voiceNumber":{"description":"An optional number used to route voice traffic","$ref":"#/components/schemas/PhoneNumber","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"A request object for purchasing a Twilio number","exampleSetFlag":false,"types":["object"]},"LeastLoadedHandleResponse":{"type":"object","properties":{"handle":{"maxLength":255,"type":"string","description":"The least loaded handle","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"A response object for getting the least loaded handle","exampleSetFlag":false,"types":["object"]},"TwilioNumberSearchResponse":{"type":"object","properties":{"numbers":{"type":"array","description":"The available Twilio numbers","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/TwilioAvailableNumber","exampleSetFlag":false},"types":["array"]}},"description":"A response object for the Twilio number search result","exampleSetFlag":false,"types":["object"]},"TwilioUnallocatedNumberListResult":{"type":"object","properties":{"number":{"description":"A phone number","$ref":"#/components/schemas/PhoneNumber","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"An object representing an allocated number","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"TwilioNumberRequest":{"type":"object","properties":{"number":{"description":"A phone number","$ref":"#/components/schemas/PhoneNumber","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"A request object containing a Twilio number","exampleSetFlag":false,"types":["object"]},"SMSAdminTenantRegistration":{"type":"object","properties":{"contactPoints":{"type":"array","description":"The tenant's contact point registrations","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/SmsContactPointRegistration","exampleSetFlag":false},"types":["array"]}},"description":"An SMS admin tenant registration","exampleSetFlag":false,"types":["object"]},"SmsContactPointRegistration":{"type":"object","properties":{"id":{"description":"The contact point ID","$ref":"#/components/schemas/ContactPointReference","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"label":{"maxLength":80,"type":"string","description":"The contact point label","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"incomingOnlyNumbers":{"type":"array","description":"Numbers that only handle inbound traffic","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/ExternalAdminSmsNumber","exampleSetFlag":false},"types":["array"]},"bidirectionalNumbers":{"type":"array","description":"Numbers that handle inbound and outbound traffic","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/ExternalAdminSmsNumber","exampleSetFlag":false},"types":["array"]},"otherSettings":{"description":"Other settings on the contact point","$ref":"#/components/schemas/OtherSettings","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"An object for a SMS admin contact point registration","exampleSetFlag":false,"types":["object"]},"TwilioAvailableNumber":{"type":"object","properties":{"number":{"description":"A phone number","$ref":"#/components/schemas/PhoneNumber","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"An available Twilio number","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"TwilioNumberUnallocatedListResponse":{"type":"object","properties":{"numbers":{"type":"array","description":"An array of unallocated numbers","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/TwilioUnallocatedNumberListResult","exampleSetFlag":false},"types":["array"]}},"description":"A response object for listing unallocated numbers for a Twilio account","exampleSetFlag":false,"types":["object"]},"ExternalAdminSmsNumber":{"type":"object","properties":{"number":{"description":"The number in E.164 format","$ref":"#/components/schemas/PhoneNumber","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"An external SMS number","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"SearchDocumentSetRequest":{"type":"object","properties":{"searchText":{"type":"string","description":"The text to search for","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"topK":{"maximum":10.0,"minimum":1,"type":"integer","description":"Maximum documents to return","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"maxDistance":{"minimum":0,"type":"number","description":"Maximum distance of documents to search text","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"maxDifferential":{"minimum":0,"type":"number","description":"Maximum differential from best document to return","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"filters":{"type":"object","description":"Additional filters to apply","nullable":true,"readOnly":false,"extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]}},"description":"SearchDocumentSetRequest","exampleSetFlag":false,"types":["object"]},"InsertIntoVectorDBRequest":{"type":"object","properties":{"indexId":{"type":"string","description":"The ID of the index to insert into","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"embeddedRecords":{"type":"array","description":"The records to insert into the vector database.","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"type":"object","properties":{},"additionalProperties":{"type":"string","description":"Anything","extensions":{"x-quiq-skip-validation":true,"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"description":"A vector database record","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"types":["array"]},"append":{"type":"boolean","description":"Whether or not to append or rewrite the records","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"Request to insert records into the vector database","exampleSetFlag":false,"types":["object"]},"SearchDocumentSetResponse":{"type":"object","properties":{"results":{"type":"array","description":"The search results","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/DocumentSearchResult","exampleSetFlag":false},"types":["array"]}},"description":"SearchDocumentSetResponse","exampleSetFlag":false,"types":["object"]},"VectorSearchResponse":{"type":"object","properties":{"results":{"type":"array","description":"The search results","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/VectorSearchItem","exampleSetFlag":false},"types":["array"]}},"description":"Vector search results","exampleSetFlag":false,"types":["object"]},"VectorSearchRequest":{"type":"object","properties":{"indexId":{"type":"string","description":"The ID of the index to search","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"queryEmbedding":{"type":"array","description":"The query vector to find similar results to","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"type":"number","description":"EmbeddedValue","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["number"]},"types":["array"]},"topK":{"maximum":10000.0,"minimum":1,"type":"integer","description":"The amount of nearest neighbors to return in the search","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]}},"description":"Perform a similarity search across vectors","exampleSetFlag":false,"types":["object"]},"VectorSearchItem":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the record","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"distance":{"type":"number","description":"The distance from the query vector","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"properties":{"type":"object","properties":{},"additionalProperties":{"type":"string","description":"Anything","extensions":{"x-quiq-skip-validation":true,"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"description":"The dynamic properties on the record, as defined by its schema","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]}},"description":"A single result from vector search","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ResourceSearchActionRequest":{"type":"object","properties":{"searchIndexId":{"type":"string","description":"The index to search","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"searchText":{"type":"string","description":"The text to search in a document","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"topK":{"maximum":10.0,"minimum":1,"type":"integer","description":"Maximum documents to return","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"maxDistance":{"minimum":0,"type":"number","description":"Maximum distance of documents to search text","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"filters":{"type":"object","description":"Filters that can be applied to the search.\n\nThe following operators are supported:\n\n* ```or``` - returns true if any operators are true\n* ```and``` - returns true if all operators are true\n* ```equals``` - returns true if the left field is equivalent to the right field\n\nThe following fieldTypes are supported:\n\n* ```property``` - allows you to specify the name of a filter property to use in the condition\n* ```constant``` - allows you to specify a constant value to use in the condition\n\nYou can nest operators two levels deep. An example filter specification would be:\n```json\n{\n    \"operator\": \"or\",\n    \"operands\": [\n        {\n            \"operator\": \"equals\",\n            \"left\": {\n                \"fieldtype\": \"property\",\n                \"propertyName\": \"title\"\n            },\n            \"right\": {\n                \"fieldtype\": \"constant\",\n                \"value\": \"Tell me about security\"\n            }\n        },\n        {\n            \"operator\": \"equals\",\n            \"left\": {\n                \"fieldtype\": \"property\",\n                \"propertyName\": \"title\"\n            },\n            \"right\": {\n                \"fieldtype\": \"constant\",\n                \"value\": \"Tell me about quiq\"\n            }\n        }\n    ]\n}\n```\n","nullable":true,"readOnly":false,"extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]}},"description":"Perform a search request","exampleSetFlag":false,"types":["object"]},"ResourceSearchItem":{"type":"object","properties":{"distance":{"minimum":0,"type":"number","description":"The accuracy of the document to the search text","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"document":{"type":"object","description":"The document","nullable":true,"readOnly":false,"extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]}},"description":"A single search result","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ResourceSearchActionResponse":{"type":"object","properties":{"results":{"type":"array","description":"The resource search results","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/ResourceSearchItem","exampleSetFlag":false},"types":["array"]}},"description":"Resource search action response","exampleSetFlag":false,"types":["object"]},"SyncDatasetRequest":{"type":"object","properties":{"syncUrl":{"maxLength":2000,"type":"string","description":"A URL to the data to sync","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"syncUploadId":{"maxLength":36,"minLength":36,"type":"string","description":"An upload ID pointing to data to sync","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Sync dataset","exampleSetFlag":false,"types":["object"]},"DocumentSearchResult":{"type":"object","properties":{"distance":{"minimum":0,"type":"number","description":"The distance between this result and the search text","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"document":{"type":"object","description":"The document itself","nullable":true,"readOnly":false,"extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]}},"description":"DocumentSearchResult","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"MessageMapIngressNotification":{"type":"object","properties":{"default":{"description":"The default, or fallback representation of the message. Platform agnostic","$ref":"#/components/schemas/QuiqMessageIngressNotification","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"overrides":{"type":"object","properties":{"Chat":{"$ref":"#/components/schemas/QuiqMessageIngressNotification","exampleSetFlag":false},"WhatsApp":{"$ref":"#/components/schemas/QuiqMessageIngressNotification","exampleSetFlag":false},"GoogleRBM":{"$ref":"#/components/schemas/QuiqMessageIngressNotification","exampleSetFlag":false},"SMS":{"$ref":"#/components/schemas/QuiqMessageIngressNotification","exampleSetFlag":false},"Kik":{"$ref":"#/components/schemas/QuiqMessageIngressNotification","exampleSetFlag":false},"Twitter":{"$ref":"#/components/schemas/QuiqMessageIngressNotification","exampleSetFlag":false},"Email":{"$ref":"#/components/schemas/QuiqMessageIngressNotification","exampleSetFlag":false},"AppleMessages":{"$ref":"#/components/schemas/QuiqMessageIngressNotification","exampleSetFlag":false},"Quiq":{"$ref":"#/components/schemas/QuiqMessageIngressNotification","exampleSetFlag":false},"Facebook":{"$ref":"#/components/schemas/QuiqMessageIngressNotification","exampleSetFlag":false},"GoogleMessages":{"$ref":"#/components/schemas/QuiqMessageIngressNotification","exampleSetFlag":false},"Instagram":{"$ref":"#/components/schemas/QuiqMessageIngressNotification","exampleSetFlag":false},"None":{"$ref":"#/components/schemas/QuiqMessageIngressNotification","exampleSetFlag":false},"WeChat":{"$ref":"#/components/schemas/QuiqMessageIngressNotification","exampleSetFlag":false},"Voice":{"$ref":"#/components/schemas/QuiqMessageIngressNotification","exampleSetFlag":false},"Imported":{"$ref":"#/components/schemas/QuiqMessageIngressNotification","exampleSetFlag":false}},"additionalProperties":{"$ref":"#/components/schemas/QuiqMessageIngressNotification","exampleSetFlag":false},"description":"Platform-specific implementations of the message.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]}},"description":"A message and its platform equivalents","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"UpdateTopicRequestDef":{"type":"object","properties":{"id":{"description":"Identifier of the topic","$ref":"#/components/schemas/TopicReference","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"label":{"maxLength":80,"type":"string","description":"Topic Name","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"disabled":{"type":"boolean","description":"Disable","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"subscriptionSettings":{"description":"Optional settings the define the subscription aspect of this topic.","$ref":"#/components/schemas/TopicSubscriptionSettings","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"A request object to update a topic for a notification","exampleSetFlag":false,"types":["object"]},"NotifyRequest":{"type":"object","properties":{"contactPoint":{"description":"The contact point from which to send the notifications","$ref":"#/components/schemas/ContactPointReference","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"notifications":{"maxItems":1000,"type":"array","description":"The notifications you want sent out","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/NotifyRequestEntry","exampleSetFlag":false},"types":["array"]},"topic":{"description":"The topic of the notifications","$ref":"#/components/schemas/TopicReference","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"Request object for notify API","exampleSetFlag":false,"types":["object"]},"MessageSegmentsRequest":{"type":"object","properties":{"text":{"maxLength":1024,"type":"string","description":"The text of the message to measure","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"A request object for counting the segments a message will be broken into","exampleSetFlag":false,"types":["object"]},"NotificationDeliverabilityStatus":{"type":"object","properties":{"updates":{"type":"array","description":"The deliverability updates","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/DeliverabilityEvent","exampleSetFlag":false},"types":["array"]}},"description":"A response object for a deliverability check of multiple notifications","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"GetNotificationsDeliverabilityRequest":{"type":"object","properties":{"ids":{"maxItems":50,"minItems":1,"type":"array","description":"The ids of the notifications to check","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"maxLength":36,"type":"string","description":"Message identifier","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"types":["array"]}},"description":"A request object for checking the deliverability of multiple notifications","exampleSetFlag":false,"types":["object"]},"SendNotificationResponse":{"type":"object","properties":{"id":{"maxLength":36,"type":"string","description":"The id of the notification. Can be used to track the notification's deliverability status.","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"A response object for sending a notification","exampleSetFlag":false,"types":["object"]},"TopicSubscriptionSettings":{"type":"object","description":"The settings for this topic's subscription","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"Topic":{"type":"object","properties":{"id":{"description":"Topic identifier","$ref":"#/components/schemas/TopicReference","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"label":{"maxLength":80,"type":"string","description":"Topic Name","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"disabledOn":{"description":"If disabled, the time in milliseconds since the epoch at which this topic was disabled.","$ref":"#/components/schemas/Timestamp","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"subscriptionSettings":{"description":"Optional settings the define the subscription aspect of this topic.","$ref":"#/components/schemas/TopicSubscriptionSettings","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"The topic of the notification","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"SendNotificationsResponseEntry":{"type":"object","properties":{"handle":{"maxLength":255,"type":"string","description":"The customer handle","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"id":{"maxLength":36,"type":"string","description":"The id of the notification. Can be used to track the notification's deliverability status.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"valid":{"type":"boolean","description":"Whether or not the notification handle and payload were valid. When true, the id field will also be present","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"errorCode":{"type":"integer","description":"When valid is false this error code will be returned to indicate why validation failed.","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]}},"description":"A response entry for the send-notifications (batch) API","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"CheckDeliverabilityResponse":{"type":"object","properties":{"results":{"type":"object","properties":{},"additionalProperties":{"$ref":"#/components/schemas/DeliverabilityResult","exampleSetFlag":false},"description":"The deliverability results","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]}},"description":"A response object for a deliverability check of multiple notifications","exampleSetFlag":false,"types":["object"]},"PlatformSpecificationNotify":{"type":"object","properties":{"platform":{"type":"string","description":"The platform to send the notification to","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"tenantHandle":{"type":"string","description":"The business id or project id associated with the platform. This is needed when sending to a platform such as Apple Messages, which may not be registered on the contact point that the notification is being sent from.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"A platform specification","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"NotifyRequestEntry":{"type":"object","properties":{"searchInfo":{"description":"Information about the intended recipient to help identify them and their availability on various messaging platforms","$ref":"#/components/schemas/SearchInfo","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"integrations":{"type":"array","description":"A list of references to objects in an integrated system that will be associated if the user replies and a conversation is created","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/IntegrationReference","exampleSetFlag":false},"types":["array"]},"precedence":{"type":"array","description":"An ordered array of message platforms. API will prefer the left-most entry that is available for the recipient","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/PlatformSpecificationNotify","exampleSetFlag":false},"types":["array"]},"messageMap":{"description":"The message map to use to build the notification message based on the platform that the message will go out on.","$ref":"#/components/schemas/MessageMapIngressNotification","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"messageMapSequence":{"type":"array","description":"The sequence of message maps to use to build a series of notification messages based on the platform that the message will go out on.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/MessageMapIngressNotification","exampleSetFlag":false},"types":["array"]}},"description":"A notify request entry object","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"SendNotificationRequest":{"type":"object","properties":{"handle":{"maxLength":255,"type":"string","description":"The handle (e.g. phone number) of the customer to whom you wish to send a notification","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"contactPoint":{"description":"The contact point from which to send the notification","$ref":"#/components/schemas/ContactPointReference","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"message":{"description":"The message you want sent out as a notification","$ref":"#/components/schemas/SendNotificationMessage","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"topic":{"description":"The topic of the notification","$ref":"#/components/schemas/TopicReference","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"integrations":{"type":"array","description":"A list of references to objects in an integrated system that will be associated if the user replies and a conversation is created","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/IntegrationReference","exampleSetFlag":false},"types":["array"]}},"description":"A request object for sending a notification","exampleSetFlag":false,"types":["object"]},"NotifyResponseEntry":{"type":"object","properties":{"id":{"maxLength":36,"type":"string","description":"The id of the notification. Can be used to track the notification's deliverability status.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"sequenceIds":{"type":"array","description":"The ids of the notifications (if a sequence of them was sent). Can be used to track the notification's deliverability status.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"maxLength":36,"type":"string","description":"Message identifier","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"types":["array"]},"valid":{"type":"boolean","description":"Whether or not the request was valid. When true, the id field will also be present","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"errorCode":{"type":"integer","description":"When valid is false this error code will be returned to indicate why validation failed.","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"searchId":{"maxLength":50,"type":"string","description":"The ID assigned to the search info object. This will be returned if set in the request.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Response object for a notify request","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"QuiqMessageIngressNotification":{"type":"object","properties":{"text":{"type":"string","description":"Text for the messsage","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"richText":{"description":"Rich text for the messsage","$ref":"#/components/schemas/QuiqRichText","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"proxyInteraction":{"description":"A proxy interaction","$ref":"#/components/schemas/ProxyInteraction","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"quiqReply":{"description":"Suggested reply messages for the recipient","$ref":"#/components/schemas/QuiqReply","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"card":{"description":"QuiqCard definition","$ref":"#/components/schemas/QuiqCard","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"carousel":{"description":"QuiqCarousel definition","$ref":"#/components/schemas/QuiqCarousel","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"pay":{"description":"QuiqPay definition","$ref":"#/components/schemas/QuiqPay","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"auth":{"description":"QuiqAuth definition","$ref":"#/components/schemas/QuiqAuth","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"times":{"description":"A collection of time items, which are similar to calendar events.","$ref":"#/components/schemas/QuiqTimes","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"transcriptHints":{"description":"Transcript hints","$ref":"#/components/schemas/MessageTranscriptHints","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"directives":{"description":"Optional reply directives such as data bindings","$ref":"#/components/schemas/RichReplyDirectives","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"followUpSettings":{"description":"Whether or not this message requires an additional follow-up message from an agent","$ref":"#/components/schemas/FollowUpSettings","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"surveySolicitation":{"description":"Mark this message as a solicitation for a specified survey","$ref":"#/components/schemas/MessageSurveySolicitation","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"postbackData":{"type":"object","description":"Optional json that will be populated if this message is in reply to an item that was sent with postback data.","nullable":true,"readOnly":false,"extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"platformProperties":{"description":"Platform specific properties","$ref":"#/components/schemas/PlatformProperties","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"magicMessageDetails":{"description":"Quiq compose details","$ref":"#/components/schemas/MagicMessageDetailsMeta","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"platformInvitation":{"description":"QuiqPlatformInvitation definition","$ref":"#/components/schemas/QuiqPlatformInvitation","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"assets":{"maxItems":10,"type":"array","description":"A list of assets (e.g. images, video, etc) to include with the message","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/PublicAssetIngressNotification","exampleSetFlag":false},"types":["array"]}},"description":"Quiq Message","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"SendNotificationsRequest":{"type":"object","properties":{"contactPoint":{"description":"The contact point from which to send the notification","$ref":"#/components/schemas/ContactPointReference","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"notifications":{"maxItems":1000,"type":"array","description":"The notifications you want sent out","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/SendNotificationsRequestEntry","exampleSetFlag":false},"types":["array"]},"topic":{"description":"The topic of the notification","$ref":"#/components/schemas/TopicReference","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"A request object for sending multiple notifications","exampleSetFlag":false,"types":["object"]},"NotifyResponse":{"type":"object","properties":{"results":{"type":"array","description":"The results corresponding to each requested notification","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/NotifyResponseEntry","exampleSetFlag":false},"types":["array"]}},"description":"A response object for sending multiple notifications","exampleSetFlag":false,"types":["object"]},"NotificationsDeliverabilityStatusPublicEvent":{"type":"object","properties":{"eventType":{"type":"string","description":"The type of the event","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["NotificationsDeliverabilityStatus"]},"data":{"description":"The generic data associated with the event","$ref":"#/components/schemas/NotificationDeliverabilityStatus","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"id":{"type":"string","description":"The id of the event","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"timestamp":{"type":"number","description":"The millisecond timestamp that the event was created","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]}},"description":"A public event","exampleSetFlag":false,"types":["object"]},"SendNotificationsRequestEntry":{"type":"object","properties":{"handle":{"maxLength":255,"type":"string","description":"The customer handle you wish to notify","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"message":{"description":"The message you want sent out as a notification","$ref":"#/components/schemas/SendNotificationMessage","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"integrations":{"type":"array","description":"A list of references to objects in an integrated system that will be associated if the user replies and a conversation is created","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/IntegrationReference","exampleSetFlag":false},"types":["array"]}},"description":"A notification request entry","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"DeliverabilityResult":{"type":"object","properties":{"status":{"type":"string","description":"The deliverability status","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["Sent","Scheduled","Pending","Failed","Delivered"]},"errorCode":{"type":"integer","description":"Deliverability error code, if applicable\n\n|Error Code|Description|\n|-|-|\n|24002|The destination you are trying to reach is not valid or a landline.|\n|24004|Message failed to send. The customer may have sent \"STOP\".|\n|24005|An attempt to send to your own number.|\n|24006|The destination messaging platform is currently under high load. Please try again later.|\n|24007|An error occurred due to invalid system configuration information.|\n|24008|The message recipient is unreachable or a landline.|\n|24009|The message was too long.|\n|24010|An unknown error occurred. Recommendation is to retry the message.|\n|24011|There was an error sending this message, it has been blocked by a carrier.|\n|24012|The media you are trying to send violates a size limit.|\n|24013|The message was not formatted correctly.|\n|24014|Quiq was unable to find a messaging platform for this customer. Confirm your topic and precedent settings.|\n|24015|The destination handset is a landline.|\n|24016|The outbound message limit for this demo tenant has been exceeded.|\n|24017|The response window was closed on this platform. Typically used by WhatsApp and other richer channels.|\n|24018|The message contained restricted contents.|\n|24019|The 10DLC registration is not completed and so the delivery failed.|\n|24020|The message was sitting in queue for too long, so it timed out without being sent on to Quiq's downstream platform partners.|\n|24021|Exceeded volume limits on this carrier.|\n|24022|The country code is restricted by your configuration.|\n|24023|At some point in the message lifecycle it was enqueued and subsequently canceled.|\n|24024|The message arrived outside of the notification send window configured for this topic, and that window is set to reject rather than hold messages. Retrying will fail until the window reopens.|","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]}},"description":"Describes the deliverability status","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"PublicAssetIngressNotification":{"type":"object","properties":{"assetId":{"type":"string","description":"The ID of the asset","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"References an asset (e.g. image)","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"DeliverabilityEvent":{"type":"object","properties":{"handle":{"type":"string","description":"The customer handle","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"id":{"type":"string","description":"The notification id","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"status":{"type":"string","description":"The deliverability status","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["Sent","Failed","Delivered"]},"time":{"type":"number","description":"The time of the deliveribility event ","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"platform":{"type":"string","description":"The messaging platform on which the notification was sent","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["SMS"]},"agent":{"type":"string","description":"The ID of the agent associated with sending the notification","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"contactPoint":{"type":"string","description":"The ID of the contact point that the notification was sent on","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"topic":{"type":"string","description":"The ID of the topic that the notification was sent on","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"errorCode":{"type":"integer","description":"Deliverability error code, if applicable\n\n|Error Code|Description|\n|-|-|\n|24002|The destination you are trying to reach is not valid or a landline.|\n|24004|Message failed to send. The customer may have sent \"STOP\".|\n|24005|An attempt to send to your own number.|\n|24006|The destination messaging platform is currently under high load. Please try again later.|\n|24007|An error occurred due to invalid system configuration information.|\n|24008|The message recipient is unreachable or a landline.|\n|24009|The message was too long.|\n|24010|An unknown error occurred. Recommendation is to retry the message.|\n|24011|There was an error sending this message, it has been blocked by a carrier.|\n|24012|The media you are trying to send violates a size limit.|\n|24013|The message was not formatted correctly.|\n|24014|Quiq was unable to find a messaging platform for this customer. Confirm your topic and precedent settings.|\n|24015|The destination handset is a landline.|\n|24016|The outbound message limit for this demo tenant has been exceeded.|\n|24017|The response window was closed on this platform. Typically used by WhatsApp and other richer channels.|\n|24018|The message contained restricted contents.|\n|24019|The 10DLC registration is not completed and so the delivery failed.|\n|24020|The message was sitting in queue for too long, so it timed out without being sent on to Quiq's downstream platform partners.|\n|24021|Exceeded volume limits on this carrier.|\n|24022|The country code is restricted by your configuration.|\n|24023|At some point in the message lifecycle it was enqueued and subsequently canceled.|\n|24024|The message arrived outside of the notification send window configured for this topic, and that window is set to reject rather than hold messages. Retrying will fail until the window reopens.|","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"integrations":{"type":"array","description":"A list of references to objects in an integrated system that will be associated if the user replies and a conversation is created","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/IntegrationReference","exampleSetFlag":false},"types":["array"]},"segmentDetails":{"description":"The number of segments the notification ended up ","$ref":"#/components/schemas/SegmentDetails","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"fallbackData":{"description":"Data related to fallback data","$ref":"#/components/schemas/FallbackDataMeta","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"Describes the deliverability event","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"SendNotificationMessage":{"type":"object","properties":{"text":{"maxLength":1024,"type":"string","description":"The text of the message. The maximum length of the message will depend on the platform. For SMS the maximum length depends on emoji and special character usage.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Defines a message to be sent out as a notification","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"SegmentDetails":{"type":"object","properties":{"numSegments":{"type":"integer","description":"The number of segments","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"numMedia":{"type":"integer","description":"The number of media attachments","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"hasMedia":{"type":"boolean","description":"MMS or not","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"Details about the sms and media segments on a message","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"MessageSegmentsResponse":{"type":"object","properties":{"segments":{"minimum":1,"type":"integer","description":"The number of segments the message will be broken into when sent","format":"int32","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]}},"description":"A response object describing how a message will be segmented","exampleSetFlag":false,"types":["object"]},"CreateTopicRequestDef":{"type":"object","properties":{"id":{"maxLength":64,"type":"string","description":"Identifier of the topic","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"label":{"maxLength":80,"type":"string","description":"Topic Name","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"subscriptionSettings":{"description":"Optional settings the define the subscription aspect of this topic.","$ref":"#/components/schemas/TopicSubscriptionSettings","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"A request object to create a topic for a notification","exampleSetFlag":false,"types":["object"]},"SendNotificationsResponse":{"type":"object","properties":{"ids":{"type":"array","description":"The results corresponding to each requested notification","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/SendNotificationsResponseEntry","exampleSetFlag":false},"types":["array"]}},"description":"A response object for sending multiple notifications","exampleSetFlag":false,"types":["object"]},"TopicList":{"title":"TopicList","type":"array","description":"List of topics","exampleSetFlag":false,"items":{"$ref":"#/components/schemas/Topic","exampleSetFlag":false},"types":["array"]},"PersonImportItem":{"type":"object","properties":{"importId":{"type":"string","description":"The optional import ID","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"data":{"description":"The contact data to import","$ref":"#/components/schemas/ImportData","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"PersonImportItem","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"WeChatBusinessScopedId":{"type":"object","properties":{"businessId":{"type":"string","description":"The identifier of the WeChat business that scopes 'id'","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"id":{"type":"string","description":"Identifier for this contact within the context of a WeChat business","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"attributes":{"description":"Attributes for this contact field","$ref":"#/components/schemas/PersonContactFieldAttributes","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"xQuiqKey":{"type":"integer","description":"The key of this collection element","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]}},"description":"Identifier for this contact within the context of a specific WeChat business account","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"PersonPhoneNumber":{"type":"object","properties":{"number":{"description":"The phone number","$ref":"#/components/schemas/PhoneNumber","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"attributes":{"description":"Attributes for this contact field","$ref":"#/components/schemas/PersonContactFieldAttributes","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"xQuiqKey":{"type":"integer","description":"The key of this collection element","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]}},"description":"PersonPhoneNumber","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"CustomerOptOutStatusChangedPublicEvent":{"type":"object","properties":{"eventType":{"type":"string","description":"The type of the event","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["CustomerOptOutStatusChanged"]},"data":{"description":"The generic data associated with the event","$ref":"#/components/schemas/OptOutStatusChangedEvent","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"id":{"type":"string","description":"The id of the event","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"timestamp":{"type":"number","description":"The millisecond timestamp that the event was created","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]}},"description":"A public event","exampleSetFlag":false,"types":["object"]},"ContactImportResponse":{"type":"object","properties":{"results":{"type":"array","description":"The results of the attempted imports","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/ImportContactResult","exampleSetFlag":false},"types":["array"]}},"description":"ContactImportResponse","exampleSetFlag":false,"types":["object"]},"OutboundOptResponseDefinition":{"type":"object","properties":{"results":{"type":"array","description":"The outbound opt results. The ordering of the results mirrors the order specified in the original request.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/OutboundOptResult","exampleSetFlag":false},"types":["array"]}},"description":"A response object for performing an outbound opt action on an end user","exampleSetFlag":false,"types":["object"]},"OptOutStatusChangedEvent":{"type":"object","properties":{"updates":{"type":"array","description":"The opt-out status changed updates","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/OptOutStatusChangedUpdate","exampleSetFlag":false},"types":["array"]}},"description":"An object for multiple opt-out status changed updates","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ImportPersonEmailAddress":{"type":"object","properties":{"email":{"description":"The email address","$ref":"#/components/schemas/Email","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"ImportPersonEmailAddress","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"PersonEmailAddress":{"type":"object","properties":{"email":{"description":"The email address","$ref":"#/components/schemas/Email","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"attributes":{"description":"Attributes for this contact field","$ref":"#/components/schemas/PersonContactFieldAttributes","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"xQuiqKey":{"type":"integer","description":"The key of this collection element","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]}},"description":"PersonEmailAddress","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"GoogleMessagesBusinessScopedId":{"type":"object","properties":{"businessId":{"type":"string","description":"The identifier of the Google Messages business that scopes 'id'","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"id":{"type":"string","description":"Identifier for this contact within the context of a Google Messages business","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"attributes":{"description":"Attributes for this contact field","$ref":"#/components/schemas/PersonContactFieldAttributes","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"xQuiqKey":{"type":"integer","description":"The key of this collection element","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]}},"description":"Identifier for this contact within the context of a specific Facebook page","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ImportFacebookPageScopedId":{"type":"object","properties":{"pageId":{"type":"string","description":"The identifier of the Facebook page that scopes 'id'","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"id":{"type":"string","description":"Identifier for this contact within the context of a Facebook Page","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Identifier for this contact within the context of a specific Facebook page","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"Contact":{"type":"object","properties":{"ids":{"type":"array","description":"Identifiers for this contact. Multiple identifiers can occur when contact records are merged","nullable":true,"readOnly":true,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"maxLength":36,"type":"string","description":"Contact identifier","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"types":["array"]},"person":{"description":"Personal information for this contact","$ref":"#/components/schemas/Person","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"externalLinks":{"type":"array","description":"External links for this contact","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/ExternalContactLink","exampleSetFlag":false},"types":["array"]},"globallyBlockedUntil":{"type":"number","description":"Globally Blocked Until","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"dedicatedAgentMappings":{"description":"Dedicated agent mappings for this contact","$ref":"#/components/schemas/DedicatedAgentMappings","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"Contact","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ChatAccount":{"type":"object","properties":{"trackingId":{"type":"string","description":"A chat tracking ID","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"attributes":{"description":"Attributes for this contact field","$ref":"#/components/schemas/PersonContactFieldAttributes","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"xQuiqKey":{"type":"integer","description":"The key of this collection element","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]}},"description":"Chat account details","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"OutboundOptRequestDefinition":{"type":"object","properties":{"opts":{"maxItems":50,"type":"array","description":"A sequence of outbound opt request objects","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/OutboundOpt","exampleSetFlag":false},"types":["array"]}},"description":"Perform an outbound opt action on an end user","exampleSetFlag":false,"types":["object"]},"RecordContactEventResponse":{"type":"object","properties":{"eventId":{"maxLength":36,"type":"string","description":"The eventId of the recorded event","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"timestamp":{"type":"number","description":"The timestamp the event was recorded at","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]}},"description":"RecordContactEventResponse","exampleSetFlag":false,"types":["object"]},"ContactImportRequest":{"type":"object","properties":{"imports":{"maxItems":100,"type":"array","description":"The contact data to import","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/PersonImportItem","exampleSetFlag":false},"types":["array"]}},"description":"ContactImportRequest","exampleSetFlag":false,"types":["object"]},"PersonVoiceHandle":{"type":"object","properties":{"handle":{"type":"string","description":"A Voice identifier for this contact that is not a phone number","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"attributes":{"description":"Attributes for this contact field","$ref":"#/components/schemas/PersonContactFieldAttributes","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"xQuiqKey":{"type":"integer","description":"The key of this collection element","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]}},"description":"Non-phone Voice handle details","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"FacebookPageScopedId":{"type":"object","properties":{"pageId":{"type":"string","description":"The identifier of the Facebook page that scopes 'id'","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"id":{"type":"string","description":"Identifier for this contact within the context of a Facebook Page","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"attributes":{"description":"Attributes for this contact field","$ref":"#/components/schemas/PersonContactFieldAttributes","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"xQuiqKey":{"type":"integer","description":"The key of this collection element","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]}},"description":"Identifier for this contact within the context of a specific Facebook page","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"TwitterAccount":{"type":"object","properties":{"id":{"type":"string","description":"Global identifier for this user on Twitter. Not their Twitter handle","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"handle":{"type":"string","description":"A twitter handle used by this contact","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"attributes":{"description":"Attributes for this contact field","$ref":"#/components/schemas/PersonContactFieldAttributes","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"xQuiqKey":{"type":"integer","description":"The key of this collection element","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]}},"description":"Twitter account details","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ImportContactResult":{"type":"object","properties":{"contactId":{"maxLength":36,"type":"string","description":"The contactId of the imported contact","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"previouslyImported":{"type":"boolean","description":"Indicates whether the contact was previously imported under the provided import ID. If true then the contact was not updated or created because it was previously imported.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"ImportContactResult","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ConditionallyRequiredEventPlatformContext":{"type":"object","properties":{"platform":{"type":"string","description":"The message platform","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["SMS","Facebook","Kik","Chat","Twitter","AppleMessages","GoogleRBM","GoogleMessages","WeChat","WhatsApp","Instagram","Voice"]},"customerHandleId":{"maxLength":255,"type":"string","description":"The customer handle of the contact","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"tenantHandleId":{"type":"string","description":"The tenant handle (Apple business id, Facebook page id) to use if this platform requires one","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"A platform context can be optionally provided, however if the event definition requires platform context then platform context must be provided","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"InstagramPageScopedId":{"type":"object","properties":{"pageId":{"type":"string","description":"The identifier of the Instagram page that scopes 'id'","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"id":{"type":"string","description":"Identifier for this contact within the context of a Instagram Page","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"attributes":{"description":"Attributes for this contact field","$ref":"#/components/schemas/PersonContactFieldAttributes","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"xQuiqKey":{"type":"integer","description":"The key of this collection element","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]}},"description":"Identifier for this contact within the context of a specific Instagram page","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ComplianceSearchInfo":{"type":"object","properties":{"searchId":{"maxLength":50,"type":"string","description":"An optional identifier. If set, this can be used to correlate compliance processing results","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"phoneNumber":{"description":"The customer's phone number","$ref":"#/components/schemas/PhoneNumber","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"emailAddress":{"description":"The customer's email address","$ref":"#/components/schemas/Email","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"appleId":{"description":"The customer's apple id","$ref":"#/components/schemas/AppleBusinessId","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"instagramId":{"description":"The customer's instagram id","$ref":"#/components/schemas/InstagramId","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"facebookId":{"description":"The customer's facebook id","$ref":"#/components/schemas/InstagramId","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"chatId":{"description":"The customer's chat id","$ref":"#/components/schemas/ChatId","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"Search information used to identify customers to delete. If multiple IDs are specified each will be processed","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"AppleBusinessScopedId":{"type":"object","properties":{"businessId":{"type":"string","description":"The Apple business identifier that scopes 'id'","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"id":{"type":"string","description":"Identifier for this contact within the context of an Apple business","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"attributes":{"description":"Attributes for this contact field","$ref":"#/components/schemas/PersonContactFieldAttributes","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"xQuiqKey":{"type":"integer","description":"The key of this collection element","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]}},"description":"Identifier for this contact within the scope of an Apple Messages business","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ImportTwitterAccount":{"type":"object","properties":{"id":{"type":"string","description":"Global identifier for this user on Twitter. Not their Twitter handle","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"handle":{"type":"string","description":"A twitter handle used by this contact","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Twitter account details","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"DedicatedAgentMappings":{"type":"object","description":"Dedicated agent mappings","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ImportData":{"type":"object","properties":{"firstName":{"maxLength":40,"type":"string","description":"First name","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"lastName":{"maxLength":80,"type":"string","description":"Last name","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"emailAddresses":{"type":"array","description":"Email addresses","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/ImportPersonEmailAddress","exampleSetFlag":false},"types":["array"]},"phoneNumbers":{"type":"array","description":"Phone numbers","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/ImportPersonPhoneNumber","exampleSetFlag":false},"types":["array"]},"appleBusinessScopedIds":{"type":"array","description":"Apple business-scoped IDs for this person","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/ImportAppleBusinessScopedId","exampleSetFlag":false},"types":["array"]},"facebookPageScopedIds":{"type":"array","description":"Facebook page-scoped IDs for this person","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/ImportFacebookPageScopedId","exampleSetFlag":false},"types":["array"]},"kikAccounts":{"type":"array","description":"Kik accounts associated with this person","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/ImportKikAccount","exampleSetFlag":false},"types":["array"]},"twitterAccounts":{"type":"array","description":"Twitter accounts associated with this person","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/ImportTwitterAccount","exampleSetFlag":false},"types":["array"]}},"description":"ImportData","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"PersonContactFieldAttributes":{"type":"object","properties":{"vetted":{"type":"boolean","description":"Indicates whether we have vetted this alias with a messaging platform.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"Alias Source details","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ImportPersonPhoneNumber":{"type":"object","properties":{"number":{"description":"The phone number","$ref":"#/components/schemas/PhoneNumber","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"vetted":{"type":"boolean","description":"Is the phone number vetted","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"PersonPhoneNumber","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"RecordContactEventByIdRequest":{"type":"object","properties":{"contactId":{"maxLength":36,"type":"string","description":"The contactId to associate the recorded event with","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"contactPoint":{"description":"The contact point of the recorded event","$ref":"#/components/schemas/ContactPointReference","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"eventDefinitionId":{"description":"The event definition id of the recorded event","$ref":"#/components/schemas/EventDefinitionReference","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"platformContext":{"description":"Platform specific context information about the recorded event. May be optional or required based on the event definition context requirements.","$ref":"#/components/schemas/ConditionallyRequiredEventPlatformContext","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"payload":{"type":"object","description":"The event specific payload. May be optional or required based on the event definition payload requirements","nullable":true,"readOnly":false,"extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"transcriptHints":{"description":"Transcript hints","$ref":"#/components/schemas/TranscriptHintSubmission","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"botSessionContext":{"description":"Bot session specific context information about the recorded event","$ref":"#/components/schemas/OptionalEventBotSessionContext","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"RecordContactEventRequest","exampleSetFlag":false,"types":["object"]},"Person":{"type":"object","properties":{"firstName":{"maxLength":40,"type":"string","description":"First name","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"lastName":{"maxLength":80,"type":"string","description":"Last name","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"emailAddresses":{"type":"array","description":"Email addresses","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/PersonEmailAddress","exampleSetFlag":false},"types":["array"]},"phoneNumbers":{"type":"array","description":"Phone numbers","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/PersonPhoneNumber","exampleSetFlag":false},"types":["array"]},"appleBusinessScopedIds":{"type":"array","description":"Apple business-scoped IDs for this person","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/AppleBusinessScopedId","exampleSetFlag":false},"types":["array"]},"facebookPageScopedIds":{"type":"array","description":"Facebook page-scoped IDs for this person","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/FacebookPageScopedId","exampleSetFlag":false},"types":["array"]},"instagramPageScopedIds":{"type":"array","description":"Instagram page-scoped IDs for this person","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/InstagramPageScopedId","exampleSetFlag":false},"types":["array"]},"googleMessagesBusinessScopedIds":{"type":"array","description":"Google Messages business-scoped IDs for this person","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/GoogleMessagesBusinessScopedId","exampleSetFlag":false},"types":["array"]},"weChatBusinessScopedIds":{"type":"array","description":"WeChat business-scoped IDs for this person","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/WeChatBusinessScopedId","exampleSetFlag":false},"types":["array"]},"kikAccounts":{"type":"array","description":"Kik accounts associated with this person","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/KikAccount","exampleSetFlag":false},"types":["array"]},"twitterAccounts":{"type":"array","description":"Twitter accounts associated with this person","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/TwitterAccount","exampleSetFlag":false},"types":["array"]},"chatAccounts":{"type":"array","description":"Chat accounts associated with this person","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/ChatAccount","exampleSetFlag":false},"types":["array"]},"whatsAppAccounts":{"type":"array","description":"WhatsApp accounts associated with this person","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/WhatsAppAccount","exampleSetFlag":false},"types":["array"]},"voiceHandles":{"type":"array","description":"Voice identifiers for this person that are not phone numbers (SIP extensions, Cisco BIB identifiers, or the per-call identifier minted for a blocked caller ID)","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/PersonVoiceHandle","exampleSetFlag":false},"types":["array"]},"custom":{"description":"Custom fields. These are stored as a key/value dictionary where the ID of the custom field is the key.","$ref":"#/components/schemas/ContactCustomFields","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"importId":{"type":"string","description":"Id that was used when importing this contact","nullable":true,"readOnly":true,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"lastUpdated":{"type":"number","description":"Last Updated","nullable":true,"readOnly":true,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"created":{"type":"number","description":"Created","nullable":true,"readOnly":true,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"deleted":{"type":"number","description":"Deleted","nullable":true,"readOnly":true,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"promoted":{"type":"number","description":"Promoted","nullable":true,"readOnly":true,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"preferredLanguage":{"description":"Preferred Language","$ref":"#/components/schemas/GlobalWrittenLanguage","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"nameAttributes":{"description":"Name Attributes","$ref":"#/components/schemas/PersonContactFieldAttributes","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"Person","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"RecordContactEventByPlatformContextRequest":{"type":"object","properties":{"contactPoint":{"description":"The contact point of the recorded event","$ref":"#/components/schemas/ContactPointReference","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"eventDefinitionId":{"description":"The event definition id of the recorded event","$ref":"#/components/schemas/EventDefinitionReference","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"platformContext":{"description":"Platform specific context information about the recorded event","$ref":"#/components/schemas/RequiredEventPlatformContext","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"payload":{"type":"object","description":"The event specific payload. May be optional or required based on the event definition payload requirements","nullable":true,"readOnly":false,"extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"transcriptHints":{"description":"Transcript hints","$ref":"#/components/schemas/TranscriptHintSubmission","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"botSessionContext":{"description":"Bot session specific context information about the recorded event","$ref":"#/components/schemas/OptionalEventBotSessionContext","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"RecordContactEventRequest","exampleSetFlag":false,"types":["object"]},"GetContactResponse":{"type":"object","properties":{"result":{"description":"The contact","$ref":"#/components/schemas/Contact","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"GetContactResponse","exampleSetFlag":false,"types":["object"]},"ChatId":{"type":"object","properties":{"trackingId":{"maxLength":36,"type":"string","description":"The tracking identifier","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Identifier for this contact within the scope of a Chat session","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"OutboundOptResult":{"type":"object","properties":{"success":{"type":"boolean","description":"Whether or not the outbound opt action was successful","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"errorCode":{"type":"integer","description":"An optional error code that will be returned if the outbound opt action is invalid\n\n|Error Code|Description|\n|-|-|\n|49000|The contact point specified either does not exist or has not been initialized for the specified platform|\n|49001|The customer handle specified has explicitly blocked communication from tenant handles involved with the request context. This often occurs when the unblock action is applied to a customer handle and contact point where the customer has texted STOP to the specified contact point.|\n|49002|The customer handle is not properly formatted for the specified platform|\n|49003|The outbound opt action conflicts with one or more actions specified in the request. For example, both block and unblock actions are specified for the same customer handle in the same request.|","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"blockedTenantHandles":{"type":"array","description":"An optional list of tenant handles (e.g. phone numbers) on which the customer has blocked explicitly communication (e.g. texted STOP). This will be returned when the desired outbound opt action requires that no such block can be present for the given context. The customer must explicitly allow communications (e.g. text START) before the outbound opt action can be performed.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"maxLength":255,"type":"string","description":"A customer handle","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"types":["array"]}},"description":"Outbound Opt result object","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"DeleteCustomerDataBatchRequest":{"type":"object","properties":{"requests":{"maxItems":25,"minItems":1,"type":"array","description":"Compliance requests to process","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/DeleteCustomerDataRequest","exampleSetFlag":false},"types":["array"]}},"description":"DeleteCustomerDataBatchRequest","exampleSetFlag":false,"types":["object"]},"OptionalEventBotSessionContext":{"type":"object","properties":{"botId":{"type":"string","description":"Identity of the bot on which the prompt event occurred","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"botRevision":{"type":"string","description":"Revision of the bot on which the prompt event occurred","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"fields":{"type":"object","description":"The bot session fields.","nullable":true,"readOnly":false,"extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]}},"description":"Bot session specific context information about the recorded event","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"OutboundOpt":{"type":"object","properties":{"action":{"type":"string","description":"The outbound opt action","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["block","unblock"]},"platform":{"type":"string","description":"The message platform on which to perform the outbound opt action","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["SMS","GoogleRBM","AppleMessages"]},"customerHandle":{"maxLength":255,"type":"string","description":"The customer handle (i.e. phone number) to perform the outbound opt action on. If this value is defined, platform must also be defined.","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"contactPoint":{"description":"The optional contact point on which to perform the outbound opt action. If not specified, the customer opt action will apply to all contact points.","$ref":"#/components/schemas/ContactPointReference","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"Outbound Opt request object","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"DeleteCustomerDataRequest":{"type":"object","properties":{"searchInfo":{"description":"Information about customer(s) to be deleted","$ref":"#/components/schemas/ComplianceSearchInfo","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"DeleteCustomerDataRequest","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"OptOutStatusChangedUpdate":{"type":"object","properties":{"handle":{"maxLength":255,"type":"string","description":"The customer handle","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"contactPoint":{"description":"The contact point","$ref":"#/components/schemas/ContactPointReference","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"platform":{"type":"string","description":"The messaging platform","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["SMS","GoogleRBM","AppleMessages","WhatsApp"]},"optedOut":{"type":"boolean","description":"Whether or not the customer is opted out from receiving any messages","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"customOptOutKeyword":{"type":"string","description":"The custom keyword that was matched when this customer opted out. Not set if the customer did not opt out with a custom keyword.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Describes the customer's opt-out status changed update","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"RequiredEventPlatformContext":{"type":"object","properties":{"platform":{"type":"string","description":"The message platform","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["SMS","Facebook","Kik","Chat","Twitter","AppleMessages","GoogleRBM","GoogleMessages","WeChat","WhatsApp","Instagram","Voice"]},"customerHandleId":{"maxLength":255,"type":"string","description":"The customer handle of the contact","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"tenantHandleId":{"type":"string","description":"The tenant handle (Apple business id, Facebook page id) to use if this platform requires one","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Platform specific context information about the recorded event","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ImportKikAccount":{"type":"object","properties":{"username":{"type":"string","description":"A kik username associated with this contact","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Kik account details","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"WhatsAppAccount":{"type":"object","properties":{"id":{"type":"string","description":"Identifier for this contact within WhatsApp","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"attributes":{"description":"Attributes for this contact field","$ref":"#/components/schemas/PersonContactFieldAttributes","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"xQuiqKey":{"type":"integer","description":"The key of this collection element","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]}},"description":"WhatsApp account details","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"KikAccount":{"type":"object","properties":{"username":{"type":"string","description":"A kik username associated with this contact","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"attributes":{"description":"Attributes for this contact field","$ref":"#/components/schemas/PersonContactFieldAttributes","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"xQuiqKey":{"type":"integer","description":"The key of this collection element","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]}},"description":"Kik account details","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ImportAppleBusinessScopedId":{"type":"object","properties":{"businessId":{"type":"string","description":"The Apple business identifier that scopes 'id'","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"id":{"type":"string","description":"Identifier for this contact within the context of an Apple business","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Identifier for this contact within the scope of an Apple Messages business","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"FetchCallRequest":{"type":"object","properties":{"contactPoint":{"description":"The contact point the call occurred on","$ref":"#/components/schemas/ContactPointReference","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"customerHandle":{"description":"The end user's phone number","$ref":"#/components/schemas/PhoneNumber","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"inTheLastSeconds":{"maximum":86400.0,"minimum":0,"type":"integer","description":"How long ago this call would have taken place - the default is 3600 (1 hour)","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]}},"description":"FetchCallRequest","exampleSetFlag":false,"types":["object"]},"FetchCallResponse":{"type":"object","properties":{"callCreated":{"type":"boolean","description":"Whether or not the call was created in Quiq","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"callReferenceId":{"maxLength":64,"type":"string","description":"The associated reference ID. Check this against your records to make sure things line up.","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"conversation":{"description":"The associated conversation - null if the call was not created","$ref":"#/components/schemas/Conversation","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"errorInformation":{"description":"Information about why the call was not created - null if the call was created","$ref":"#/components/schemas/VoiceErrorInformation","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"callHandedBack":{"type":"boolean","description":"Whether the Quiq Assistant intended to hand back the call for further communication with the customer, or hangup. Will be set to false for hangup, true for further communication.","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"FetchCallResponse","exampleSetFlag":false,"types":["object"]},"VoiceErrorInformation":{"type":"object","properties":{"reason":{"type":"string","description":"The reason the call could not be created","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"VoiceErrorInformation","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"RegisterInboundCallResponse":{"type":"object","properties":{"callReferenceId":{"type":"string","description":"The ID by which to fetch call information by.","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"tenantHandle":{"description":"The tenant handle you should forward this new call to.","$ref":"#/components/schemas/PhoneNumber","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"RegisterInboundCallResponse","exampleSetFlag":false,"types":["object"]},"RegisterInboundCallRequest":{"type":"object","properties":{"customerHandle":{"description":"The end user's phone number","$ref":"#/components/schemas/PhoneNumber","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"contactPoint":{"description":"The contact point that is being routed to","$ref":"#/components/schemas/ContactPointReference","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"callReferenceId":{"maxLength":64,"type":"string","description":"Optional, an ID for you to reference this incoming call by - must be unique. If not provided, Quiq will generate one automatically","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"storedContext":{"description":"Optional stored context to be applied when the call starts","$ref":"#/components/schemas/HallpassContext","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"RegisterInboundCallRequest","exampleSetFlag":false,"types":["object"]},"AIServiceErrorEvent":{"type":"object","properties":{"eventType":{"type":"string","description":"The type of the event","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["AIServiceError"]},"data":{"description":"The generic data associated with the event","$ref":"#/components/schemas/AIServiceErrorPayload","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"id":{"type":"string","description":"The id of the event","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"timestamp":{"type":"number","description":"The millisecond timestamp that the event was created","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]}},"description":"A public event","exampleSetFlag":false,"types":["object"]},"AiServiceReference":{"maxLength":254,"type":"string","description":"An AI Service Id","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"FlowEnvironmentContext":{"type":"object","properties":{"tenantId":{"type":"string","description":"The tenant that this project is on","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Context about the environment that project is executing in","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ServiceContext":{"type":"object","properties":{"request":{"type":"object","description":"The current service execution request payload","nullable":false,"readOnly":false,"extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"response":{"type":"object","description":"The current service execution response payload","nullable":false,"readOnly":false,"extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"queryParams":{"type":"object","description":"The current service execution request query parameters","nullable":false,"readOnly":false,"extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"headers":{"type":"object","properties":{},"additionalProperties":{"type":"string","description":"header value","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"description":"The current service execution request headers","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"fields":{"description":"Flow fields stored as a key/value dictionary where the ID of the field is the key","$ref":"#/components/schemas/FieldMap","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"buffers":{"type":"object","properties":{},"additionalProperties":{"type":"object","description":"Json Serializable object","extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"description":"Key/value map of buffer state where key is the buffer name","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"searchResults":{"type":"array","description":"The AI Resource search results accumulated so far during the current execution","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/Search","exampleSetFlag":false},"types":["array"]},"apiResults":{"type":"array","description":"The api results accumulated so far during the current execution","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/WebhookResult","exampleSetFlag":false},"types":["array"]},"prompts":{"type":"object","properties":{},"additionalProperties":{"$ref":"#/components/schemas/PromptRuntimeContextMeta","exampleSetFlag":false},"description":"Key/value map of prompt state","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"configs":{"description":"Key/value map of config values. The values of these are defined within AI Studio and are static values.","$ref":"#/components/schemas/Map","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"time":{"description":"Time data, like the current epoch","$ref":"#/components/schemas/TimeContext","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"environment":{"description":"Data about the current environment the service is executing within, like the current tenant ID","$ref":"#/components/schemas/FlowEnvironmentContext","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"claimVerificationResults":{"type":"array","description":"Results of claim verifications performed during the current service execution","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/ClaimVerificationResult","exampleSetFlag":false},"types":["array"]},"service":{"description":"Data about the current service execution","$ref":"#/components/schemas/ServiceRuntimeContext","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"The context for services. Not actually a webhook but rather documents the shape of the data passed as the 'context' argument to various functions","exampleSetFlag":false,"types":["object"]},"OutcomeReference":{"maxLength":64,"type":"string","description":"Outcome identifier","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"AIServiceErrorPayload":{"type":"object","properties":{"correlationId":{"type":"string","description":"The correlation ID of the trace in which the error occurred","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"projectId":{"description":"The ID of the AI Service","$ref":"#/components/schemas/AiServiceReference","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"errorMessage":{"type":"string","description":"The error message","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"nodeId":{"description":"The ID of the node where the error occurred, if applicable","$ref":"#/components/schemas/AiServiceNodeReferenceType","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"nodeLabel":{"type":"string","description":"The label of the node where the error occurred, if applicable","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"conversationId":{"type":"string","description":"The ID of the conversation in which the error occurred","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"AI Service error payload delivered via webhook","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"ServiceRuntimeContext":{"type":"object","properties":{"endpointId":{"type":"string","description":"The endpoint that is currently being executed","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"correlationId":{"type":"string","description":"The correlation id of the execution","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"Context about the service execution","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"FieldMap":{"type":"object","description":"Flow fields stored as a key/value dictionary where the ID of the field is the key","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"AiServiceNodeReferenceType":{"minLength":4,"type":"string","description":"AI Service Node","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"Outcome":{"type":"object","properties":{"id":{"description":"Outcome identifier","$ref":"#/components/schemas/OutcomeReference","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"label":{"maxLength":80,"type":"string","description":"Outcome Name","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"disabledOn":{"description":"If disabled, the time in milliseconds since the epoch at which this outcome was disabled.","$ref":"#/components/schemas/Timestamp","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"The outcome of the project","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"OutcomeList":{"title":"OutcomeList","type":"array","description":"List of outcomes","exampleSetFlag":false,"items":{"$ref":"#/components/schemas/Outcome","exampleSetFlag":false},"types":["array"]},"CreateOutcomeRequestDef":{"type":"object","properties":{"id":{"maxLength":64,"type":"string","description":"Identifier of the outcome","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"label":{"maxLength":80,"type":"string","description":"Outcome Name","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"A request object to create an outcome","exampleSetFlag":false,"types":["object"]},"UpdateOutcomeRequestDef":{"type":"object","properties":{"id":{"description":"Identifier of the outcome","$ref":"#/components/schemas/OutcomeReference","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"label":{"maxLength":80,"type":"string","description":"Outcome Name","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"disabled":{"type":"boolean","description":"Disable","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"A request object to update an outcome","exampleSetFlag":false,"types":["object"]},"AgentAssistProgrammaticContext":{"type":"object","properties":{"conversation":{"description":"The current state of the conversation","$ref":"#/components/schemas/ProgrammaticConversation","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"fields":{"description":"Flow fields stored as a key/value dictionary where the ID of the field is the key","$ref":"#/components/schemas/FieldMap","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"buffers":{"type":"object","properties":{},"additionalProperties":{"type":"object","description":"Json Serializable object","extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"description":"Key/value map of buffer state where key is the buffer name","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"searchResults":{"type":"array","description":"The AI Resource search results accumulated so far during the current execution","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/Search","exampleSetFlag":false},"types":["array"]},"apiResults":{"type":"array","description":"The api results accumulated so far during the current execution","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/WebhookResult","exampleSetFlag":false},"types":["array"]},"prompts":{"type":"object","properties":{},"additionalProperties":{"$ref":"#/components/schemas/PromptRuntimeContextMeta","exampleSetFlag":false},"description":"Key/value map of prompt state","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"configs":{"description":"Key/value map of config values. The values of these are defined within AI Studio and are static values.","$ref":"#/components/schemas/Map","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"time":{"description":"Time data, like the current epoch","$ref":"#/components/schemas/TimeContext","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"environment":{"description":"Data about the current environment the service is executing within, like the current tenant ID","$ref":"#/components/schemas/FlowEnvironmentContext","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"claimVerificationResults":{"type":"array","description":"Results of claim verifications performed during the current service execution","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/ClaimVerificationResult","exampleSetFlag":false},"types":["array"]},"assist":{"description":"Additional assist related fields","$ref":"#/components/schemas/AgentAssistantContext","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"request":{"type":"object","description":"The UI extension trigger request","nullable":false,"readOnly":false,"extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]},"timeline":{"type":"array","description":"An ordered list of timeline events which include messages and manually created events.","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/TimelineEvent","exampleSetFlag":false},"types":["array"]},"triggers":{"type":"object","properties":{},"additionalProperties":{"type":"object","description":"trigger data","extensions":{"x-quiq-ignore-extra-fields":true,"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"description":"Trigger data keyed by trigger ID, containing the request payload for the active UI extension trigger","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["object"]}},"description":"The context for agent assistants. Not actually a webhook but rather documents the shape of the data passed as the 'context' argument to various functions","exampleSetFlag":false,"types":["object"]},"AIAssistantErrorEvent":{"type":"object","properties":{"eventType":{"type":"string","description":"The type of the event","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["AIAssistantError"]},"data":{"description":"The generic data associated with the event","$ref":"#/components/schemas/AIAssistantErrorPayload","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"id":{"type":"string","description":"The id of the event","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"timestamp":{"type":"number","description":"The millisecond timestamp that the event was created","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]}},"description":"A public event","exampleSetFlag":false,"types":["object"]},"AiAssistantNodeReferenceType":{"minLength":4,"type":"string","description":"AI Assistant Node","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["string"]},"AIAssistantErrorPayload":{"type":"object","properties":{"correlationId":{"type":"string","description":"The correlation ID of the trace in which the error occurred","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"projectId":{"description":"The ID of the AI Assistant project","$ref":"#/components/schemas/AgentAssistantReference","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"errorMessage":{"type":"string","description":"The error message","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"conversationId":{"type":"string","description":"The conversation id","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"nodeId":{"description":"The ID of the node where the error occurred, if applicable","$ref":"#/components/schemas/AiAssistantNodeReferenceType","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"nodeLabel":{"type":"string","description":"The label of the node where the error occurred, if applicable","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]}},"description":"AI Assistant error payload delivered via webhook","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"AgentAssistantContext":{"type":"object","properties":{"agentName":{"type":"string","description":"The name of the agent assigned to the conversation","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"agentNeedsToRespond":{"type":"boolean","description":"Whether the agent has response obligation","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]}},"description":"Additional assist related context","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"IntervalAgentMetrics":{"type":"object","properties":{"userId":{"maxLength":254,"type":"string","description":"The agent's user ID; the key for this row and the same identifier the users API and other webhooks use","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"firstName":{"type":"string","description":"The agent's first name as it was when this interval was emitted, the same field the users API returns. For display; it can change and is not unique, so key on userId","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"lastName":{"type":"string","description":"The agent's last name as it was when this interval was emitted, the same field the users API returns. For display; it can change and is not unique, so key on userId","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"timeOnline":{"description":"Total time logged into Quiq during the interval, in any status","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"timeAvailable":{"description":"Total time in the Available status","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"timeAvailableForExisting":{"description":"Total time in the Available for Existing (Current Conversations) status","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"timeUnavailable":{"description":"Total time in the Unavailable status","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"statuses":{"type":"array","description":"Time in each status, split by sub-status. Sums to the three status totals above","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/AgentStatusTime","exampleSetFlag":false},"types":["array"]},"numberOfConversationsAssigned":{"minimum":0,"type":"integer","description":"The number of conversations received by the agent during the interval, as Agent Insights counts them: assignments that started in the interval, excluding reactivations of inactive conversations and same-agent queue changes. Compare numberOfAssignmentsStarted, which excludes neither and is the counterpart of numberOfAssignmentsEnded","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"numberOfConversationsCompleted":{"minimum":0,"type":"integer","description":"The number of conversations the agent completed during the interval","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"numberOfAssignmentsStarted":{"minimum":0,"type":"integer","description":"The number of the agent's assignments that started in the interval. Counts every start reason (a routing, a transfer, a takeover, a reactivation, and a same-agent queue change where queue-change segmentation is enabled), excluding merged-as-dangling conversations and conversations that ended as danglers: exactly the population numberOfAssignmentsEnded counts, so across any span started minus ended is the change in open assignments. Across the agent's queueTotals entries these sum to this number, less assignments whose conversation never had a queue","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"numberOfAssignmentsEnded":{"minimum":0,"type":"integer","description":"The number of the agent's assignments that ended in the interval: the population behind totalHandleTimeBasic, totalHandleTimeConcurrencyAdjusted and totalWorkTime, and the sum of numberOfAssignmentsEnded across this row's queueTotals. Differs from numberOfConversationsCompleted, which counts conversations: a conversation that is transferred, re-queued or goes inactive and comes back ends one assignment each time Where the tenant has queue-change segmentation enabled, a queue change that keeps the same agent ends one assignment and starts another, and both count here","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"averageUtilization":{"type":"number","description":"Agent Utilization: the degree to which the agent's routing slots were filled, time weighted. This is concurrency saturation, not WFM occupancy","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"averageFirstResponseTime":{"description":"Average time from assignment to the agent's first message, over the assignments that ended in the interval in which the agent sent a message. Equals totalFirstResponseTime / numberOfAssignmentsWithResponse","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"totalHandleTimeBasic":{"description":"Sum of Handle Time Basic over the assignments that ended in the interval. The agent row carries no per-interval average of this: the only denominator in the same population is numberOfAssignmentsEnded, and a per-interval average of time credited when the assignment ended is not a per-conversation figure; divide this total by numberOfAssignmentsEnded for a per-assignment figure in the interval, or sum totals and counts across the span of interest and divide once. The whole handle time of an assignment is credited to the interval in which the assignment ended (re-assigned, re-queued, inactive or closed, or moved to another queue by the same agent where queue-change segmentation is enabled), so at 15 minutes it often lands in a later interval than the one where the work happened and can exceed the interval length; sum totals and counts across intervals for a per-conversation figure over a longer period. This is the When-Contact-Ended (WCE) convention rather than True-to-Interval, so an occupancy derived from a single interval can exceed 100% without indicating an error.","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"totalHandleTimeConcurrencyAdjusted":{"description":"Sum of Handle Time Concurrency Adjusted over the assignments that ended in the interval. The agent row carries no per-interval average of this: the only denominator in the same population is numberOfAssignmentsEnded, and a per-interval average of time credited when the assignment ended is not a per-conversation figure; divide this total by numberOfAssignmentsEnded for a per-assignment figure in the interval, or sum totals and counts across the span of interest and divide once. The whole handle time of an assignment is credited to the interval in which the assignment ended (re-assigned, re-queued, inactive or closed, or moved to another queue by the same agent where queue-change segmentation is enabled), so at 15 minutes it often lands in a later interval than the one where the work happened and can exceed the interval length; sum totals and counts across intervals for a per-conversation figure over a longer period. This is the When-Contact-Ended (WCE) convention rather than True-to-Interval, so an occupancy derived from a single interval can exceed 100% without indicating an error.","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"totalWorkTime":{"description":"Sum of Work Time over the assignments that ended in the interval, not after-contact work: the time the agent spent focused on the conversation while it was open. The agent row carries no per-interval average of this: the only denominator in the same population is numberOfAssignmentsEnded, and a per-interval average of time credited when the assignment ended is not a per-conversation figure; divide this total by numberOfAssignmentsEnded for a per-assignment figure in the interval, or sum totals and counts across the span of interest and divide once. The whole work time of an assignment is credited to the interval in which the assignment ended (re-assigned, re-queued, inactive or closed, or moved to another queue by the same agent where queue-change segmentation is enabled), so at 15 minutes it often lands in a later interval than the one where the work happened; sum totals and counts across intervals for a per-conversation figure over a longer period. This is the When-Contact-Ended (WCE) convention rather than True-to-Interval, so an occupancy derived from a single interval can exceed 100% without indicating an error. Work time has no in-interval form: segments are recorded when the agent sends, so an interval cannot know work that has not been sent yet, and the feed never revises an emitted interval","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"handleTimeInInterval":{"description":"True-to-interval basic handle time: the seconds, summed across concurrent assignments, during which the agent held an assignment inside this interval, whenever each assignment started or will end. This is the True-to-Interval (TTI) convention as NICE defines it (an interaction is counted in each interval it spans, with handle time in each interval it is active), beside the When-Contact-Ended (WCE) totals on the same row, which credit the whole handle time to the interval the assignment ended in. NICE's third-party ACD path accepts WCE only; this field is for consumers that need the in-interval view. Summed over a day the two agree up to the assignments open at its edges. Measured from the agent snapshot, which changes on every assignment, status, login, logout or limit change, so exact to the second. The population is assignment-manager's: invitations count, inactive conversations and dedicated-queue work do not, and offline time earns nothing. Diverges from totalHandleTimeBasic, which is conversation-manager's assignment end minus start and includes offline time, so their day-sums agree only approximately. At most the interval length times the agent's peak concurrency. 0 when the agent held nothing while online","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"concurrencyAdjustedHandleTimeInInterval":{"description":"True-to-interval concurrency-adjusted handle time: every moment inside this interval credited at workload divided by the larger of the agent's soft limit and their workload, which is assignment-manager's own accrual rule, summed over the agent's online time. This is the True-to-Interval (TTI) convention as NICE defines it (an interaction is counted in each interval it spans, with handle time in each interval it is active), beside the When-Contact-Ended (WCE) totals on the same row, which credit the whole handle time to the interval the assignment ended in. NICE's third-party ACD path accepts WCE only; this field is for consumers that need the in-interval view. Summed over a day the two agree up to the assignments open at its edges. Same source and population as handleTimeInInterval, and the same rule that produced totalHandleTimeConcurrencyAdjusted, so summed over a day the two agree up to the assignments open at its edges. Never exceeds timeOnline. 0 when the agent held nothing while online","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"totalFirstResponseTime":{"description":"Sum of time from assignment to the agent's first message over the assignments with a response that ended in the interval","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"numberOfAssignmentsWithResponse":{"minimum":0,"type":"integer","description":"The number of assignments that ended in the interval in which the agent sent at least one message; the denominator of averageFirstResponseTime. Excludes assignments that began with an agent-started (outbound) conversation and reactivated conversations, which the queue row's field of the same name includes; the two do not reconcile row for row","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"queueTotals":{"type":"array","description":"This agent's work split by queue: one entry per queue in which an assignment of theirs ended during the interval, ordered by queue. Empty when none did. Sparse: a queue the agent was online for but completed nothing in does not appear, so an absent queue means no activity in it, not that the agent is unassociated with it. The entries reconcile with this row: numberOfAssignmentsEnded and totalWorkTime summed across entries equal this row's, and summed across every agent for one queue they equal that queue's in IntervalMetrics, except for assignments of bots and of agents with no online time in the interval, which appear on the queue row only since neither has a row here. Time in status is not split by queue and cannot be, since an agent is online for all of their queues simultaneously; use IntervalMetrics for per-queue staffing","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/IntervalAgentQueueMetrics","exampleSetFlag":false},"types":["array"]}},"description":"Metrics for one agent over one interval","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"IntervalAgentQueueMetrics":{"type":"object","properties":{"queue":{"description":"The queue identity: the queue the assignment started in. Where the tenant has queue-change segmentation enabled (ASSIGNMENT_SEGMENT_ON_QUEUE_CHANGE_ENABLED), a queue change that keeps the same agent ends the assignment and starts a new one in the new queue, so each queue gets exactly the work done in it and both segments count. Where it is not, an assignment whose conversation changed queue while the same agent kept it is credited entirely to the queue it started in, matching IntervalMetrics","$ref":"#/components/schemas/QueueReference","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"numberOfAssignmentsStarted":{"minimum":0,"type":"integer","description":"The number of this agent's assignments in this queue that started in the interval. Counts every start reason (a routing, a transfer, a takeover, a reactivation, and a same-agent queue change where queue-change segmentation is enabled), excluding merged-as-dangling conversations and conversations that ended as danglers: exactly the population numberOfAssignmentsEnded counts, so across any span started minus ended is the change in open assignments. An entry exists when this or numberOfAssignmentsEnded is non-zero, so either may be 0 but not both. Across an agent's entries these sum to the agent row's numberOfAssignmentsStarted","format":"int32","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"numberOfAssignmentsEnded":{"minimum":0,"type":"integer","description":"The number of this agent's assignments in this queue that ended in the interval. An entry exists when this or numberOfAssignmentsStarted is non-zero, so either may be 0 but not both. Across an agent's entries these sum to the agent row's numberOfAssignmentsEnded","format":"int32","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"totalHandleTimeBasic":{"description":"Sum of Handle Time Basic over those assignments. Across an agent's entries these sum to the agent row's totalHandleTimeBasic, and across every agent's entries for one queue to that queue's totalHandleTimeBasic in IntervalMetrics, less the work of bots and of agents with no online time in the interval. The whole handle time of an assignment is credited to the interval in which the assignment ended (re-assigned, re-queued, inactive or closed, or moved to another queue by the same agent where queue-change segmentation is enabled), so at 15 minutes it often lands in a later interval than the one where the work happened and can exceed the interval length; sum totals and counts across intervals for a per-conversation figure over a longer period. This is the When-Contact-Ended (WCE) convention rather than True-to-Interval, so an occupancy derived from a single interval can exceed 100% without indicating an error.","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"totalHandleTimeConcurrencyAdjusted":{"description":"Sum of Handle Time Concurrency Adjusted over those assignments. Across an agent's entries these sum to the agent row's totalHandleTimeConcurrencyAdjusted, and across every agent's entries for one queue to that queue's totalHandleTimeConcurrencyAdjusted in IntervalMetrics, less the work of bots and of agents with no online time in the interval. The whole handle time of an assignment is credited to the interval in which the assignment ended (re-assigned, re-queued, inactive or closed, or moved to another queue by the same agent where queue-change segmentation is enabled), so at 15 minutes it often lands in a later interval than the one where the work happened and can exceed the interval length; sum totals and counts across intervals for a per-conversation figure over a longer period. This is the When-Contact-Ended (WCE) convention rather than True-to-Interval, so an occupancy derived from a single interval can exceed 100% without indicating an error.","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"totalWorkTime":{"description":"Sum of Work Time over those assignments. Null when none of them carried work time, which can happen beside a non-zero count. Across an agent's entries these sum to the agent row's totalWorkTime. The whole work time of an assignment is credited to the interval in which the assignment ended (re-assigned, re-queued, inactive or closed, or moved to another queue by the same agent where queue-change segmentation is enabled), so at 15 minutes it often lands in a later interval than the one where the work happened; sum totals and counts across intervals for a per-conversation figure over a longer period. This is the When-Contact-Ended (WCE) convention rather than True-to-Interval, so an occupancy derived from a single interval can exceed 100% without indicating an error.","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"One agent's work in one queue over one interval","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"IntervalMetricsPayload":{"type":"object","properties":{"intervalStart":{"description":"The instant the interval opened, inclusive","$ref":"#/components/schemas/Timestamp","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"intervalEnd":{"description":"The instant the interval closed, exclusive","$ref":"#/components/schemas/Timestamp","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"page":{"minimum":0,"type":"integer","description":"This page, 1-based. Pages of one interval are keyed on intervalStart and may arrive in any order; use the interval once all totalPages have arrived. The same intervalStart can arrive again from a retry or a re-emission, in which case the event with the latest timestamp wins","format":"int32","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"totalPages":{"minimum":0,"type":"integer","description":"How many pages this interval has. Always present; never infer the last page from a short one","format":"int32","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"queues":{"type":"array","description":"One entry per queue on this page. Across all pages of an interval every queue appears exactly once, including idle ones","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/IntervalQueueMetrics","exampleSetFlag":false},"types":["array"]}},"description":"Queue metrics for one closed 15-minute interval, one page","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"IntervalMetricsPublicEvent":{"type":"object","properties":{"eventType":{"type":"string","description":"The type of the event","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["IntervalMetrics"]},"data":{"description":"The generic data associated with the event","$ref":"#/components/schemas/IntervalMetricsPayload","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"id":{"type":"string","description":"The id of the event","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"timestamp":{"type":"number","description":"The millisecond timestamp that the event was created","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]}},"description":"A public event","exampleSetFlag":false,"types":["object"]},"IntervalAgentMetricsPublicEvent":{"type":"object","properties":{"eventType":{"type":"string","description":"The type of the event","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"],"enum":["IntervalAgentMetrics"]},"data":{"description":"The generic data associated with the event","$ref":"#/components/schemas/IntervalAgentMetricsPayload","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"id":{"type":"string","description":"The id of the event","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"timestamp":{"type":"number","description":"The millisecond timestamp that the event was created","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]}},"description":"A public event","exampleSetFlag":false,"types":["object"]},"AgentStatusTime":{"type":"object","properties":{"status":{"type":"string","description":"The status: available, availableForExisting or unavailable","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"subStatusId":{"type":"string","description":"The sub-status the agent had selected, or null for time in the status with no sub-status selected","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"timeInStatus":{"description":"Agent Time in Status: total time in this status and sub-status during the interval","$ref":"#/components/schemas/DurationMillis","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false}},"description":"Time in one status and sub-status","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"IntervalAgentMetricsPayload":{"type":"object","properties":{"intervalStart":{"description":"The instant the interval opened, inclusive","$ref":"#/components/schemas/Timestamp","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"intervalEnd":{"description":"The instant the interval closed, exclusive","$ref":"#/components/schemas/Timestamp","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"page":{"minimum":0,"type":"integer","description":"This page, 1-based. Pages of one interval are keyed on intervalStart and may arrive in any order; use the interval once all totalPages have arrived. The same intervalStart can arrive again from a retry or a re-emission, in which case the event with the latest timestamp wins","format":"int32","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"totalPages":{"minimum":0,"type":"integer","description":"How many pages this interval has. Always present; never infer the last page from a short one","format":"int32","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"agents":{"type":"array","description":"One entry per human agent who was online at any point in the interval, on this page. Bots are not included; their work is in IntervalMetrics under the queue","nullable":false,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"items":{"$ref":"#/components/schemas/IntervalAgentMetrics","exampleSetFlag":false},"types":["array"]}},"description":"Agent metrics for one closed 15-minute interval, one page","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]},"IntervalQueueMetrics":{"type":"object","properties":{"queue":{"description":"The queue identity; the key for this row and the value queueTotals[].queue carries in IntervalAgentMetrics","$ref":"#/components/schemas/QueueReference","nullable":false,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"queueLabel":{"type":"string","description":"The queue's display name as it was when this interval was emitted. For display; it can change and is not unique, so key on queue","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["string"]},"botOnly":{"type":"boolean","description":"True when every member of the queue is a bot, as of when this interval was emitted, so the queue's numbers describe automation rather than people; survey and web-form queues are the usual cases. False when the queue has human members, including a queue with no explicit members. Null when the queue is no longer in the tenant's configuration, so the feed could not tell; do not read null as false","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["boolean"]},"numberOfConversationsEntered":{"minimum":0,"type":"integer","description":"The number of conversations that entered the queue during the interval","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"numberOfConversationsCompleted":{"minimum":0,"type":"integer","description":"The number of conversations completed from the queue during the interval","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"numberOfConversationsAbandoned":{"minimum":0,"type":"integer","description":"The number of conversations abandoned from the queue during the interval","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"averageWaitTime":{"description":"Wait Time (ASA): the conversation's FIRST EVER human agent response, measured from arrival in queue with bot time excluded, averaged over the conversations answered in the interval. Counted in the interval of the first human response, credited to the queue the conversation was in at that moment. A conversation that already had a human response elsewhere does not count here. Equals totalWaitTime / numberOfConversationsAnswered","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"maximumWaitTime":{"description":"The longest Wait Time among the conversations answered in the interval. A conversation still waiting at the end of the interval is not included until it is answered","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"averageUnassignedTime":{"description":"Average time a conversation spent in the queue unassigned, over queue assignments that ended during the interval. Equals totalUnassignedTime / numberOfQueueAssignmentsEnded","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"averageFirstHumanResponseTimeInQueue":{"description":"Per queue assignment: time from entering THIS queue to the first human response within this assignment, averaged over assignments that ended during the interval. Unlike averageWaitTime it includes conversations that already had a human response in another queue, so transfers and re-queues count here. Equals totalFirstHumanResponseTimeInQueue / numberOfQueueAssignmentsWithHumanResponse","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"averageHandleTimeBasic":{"description":"Handle Time Basic per conversation, over assignments that ended during the interval. Equals totalHandleTimeBasic / numberOfConversationsHandled. The whole handle time of an assignment is credited to the interval in which the assignment ended (re-assigned, re-queued, inactive or closed, or moved to another queue by the same agent where queue-change segmentation is enabled), so at 15 minutes it often lands in a later interval than the one where the work happened and can exceed the interval length; sum totals and counts across intervals for a per-conversation figure over a longer period. This is the When-Contact-Ended (WCE) convention rather than True-to-Interval, so an occupancy derived from a single interval can exceed 100% without indicating an error.","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"averageHandleTimeConcurrencyAdjusted":{"description":"Handle Time Concurrency Adjusted per conversation, over assignments that ended during the interval. Equals totalHandleTimeConcurrencyAdjusted / numberOfConversationsHandled. The whole handle time of an assignment is credited to the interval in which the assignment ended (re-assigned, re-queued, inactive or closed, or moved to another queue by the same agent where queue-change segmentation is enabled), so at 15 minutes it often lands in a later interval than the one where the work happened and can exceed the interval length; sum totals and counts across intervals for a per-conversation figure over a longer period. This is the When-Contact-Ended (WCE) convention rather than True-to-Interval, so an occupancy derived from a single interval can exceed 100% without indicating an error.","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"averageWorkTime":{"description":"Work Time per conversation: the time the agent spent focused on the conversation while it was open, not after-contact work, over assignments that ended during the interval. Equals totalWorkTime / numberOfConversationsWithWorkTime. The whole work time of an assignment is credited to the interval in which the assignment ended (re-assigned, re-queued, inactive or closed, or moved to another queue by the same agent where queue-change segmentation is enabled), so at 15 minutes it often lands in a later interval than the one where the work happened; sum totals and counts across intervals for a per-conversation figure over a longer period. This is the When-Contact-Ended (WCE) convention rather than True-to-Interval, so an occupancy derived from a single interval can exceed 100% without indicating an error.","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"averageOnlineAgents":{"type":"number","description":"Average number of agents online in the queue. Time weighted over the interval. To roll up: sum across queues, average across intervals","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"averageAvailableAgents":{"type":"number","description":"Average number of agents in the Available status in the queue. Time weighted over the interval. To roll up: sum across queues, average across intervals","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"averageUnavailableAgents":{"type":"number","description":"Average number of agents in the Unavailable status in the queue. Time weighted over the interval. To roll up: sum across queues, average across intervals","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"averageAvailableForExistingAgents":{"type":"number","description":"Average number of agents in the Available for Existing (Current Conversations) status in the queue. Time weighted over the interval. To roll up: sum across queues, average across intervals","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"averageTotalAgentCapacity":{"type":"number","description":"Average total conversation capacity of the agents in the queue (sum of soft limits). An agent in several queues counts toward each. Time weighted over the interval. To roll up: sum across queues, average across intervals","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"averageTotalAgentWorkload":{"type":"number","description":"Average total workload of the agents in the queue. An agent in several queues counts toward each. Time weighted over the interval. To roll up: sum across queues, average across intervals","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"averageAvailableAgentCapacity":{"type":"number","description":"Average conversation capacity of the Available agents in the queue. Time weighted over the interval. To roll up: sum across queues, average across intervals","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"averageAvailableAgentWorkload":{"type":"number","description":"Average workload of the Available agents in the queue. Time weighted over the interval. To roll up: sum across queues, average across intervals","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"totalWaitTime":{"description":"Sum of Wait Time over the conversations answered in the interval. Counted in the interval of the first human response, credited to the queue the conversation was in at that moment","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"numberOfConversationsAnswered":{"minimum":0,"type":"integer","description":"The number of conversations whose first-ever human response happened in the interval; the denominator of averageWaitTime and the base for service level. Counted in the interval of the first human response, credited to the queue the conversation was in at that moment","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"totalUnassignedTime":{"description":"Sum of unassigned time over the queue assignments that ended in the interval","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"numberOfQueueAssignmentsEnded":{"minimum":0,"type":"integer","description":"The number of queue assignments that ended in the interval; the denominator of averageUnassignedTime","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"totalFirstHumanResponseTimeInQueue":{"description":"Sum of in-queue first human response time over the queue assignments with a human response that ended in the interval","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"numberOfQueueAssignmentsWithHumanResponse":{"minimum":0,"type":"integer","description":"The number of queue assignments with a human response that ended in the interval; the denominator of averageFirstHumanResponseTimeInQueue","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"totalHandleTimeBasic":{"description":"Sum of Handle Time Basic over the assignments that ended in the interval. Counted in the interval the assignment ended, credited to the queue the assignment started in. The whole handle time of an assignment is credited to the interval in which the assignment ended (re-assigned, re-queued, inactive or closed, or moved to another queue by the same agent where queue-change segmentation is enabled), so at 15 minutes it often lands in a later interval than the one where the work happened and can exceed the interval length; sum totals and counts across intervals for a per-conversation figure over a longer period. This is the When-Contact-Ended (WCE) convention rather than True-to-Interval, so an occupancy derived from a single interval can exceed 100% without indicating an error.","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"totalHandleTimeConcurrencyAdjusted":{"description":"Sum of Handle Time Concurrency Adjusted over the assignments that ended in the interval. Counted in the interval the assignment ended, credited to the queue the assignment started in. The whole handle time of an assignment is credited to the interval in which the assignment ended (re-assigned, re-queued, inactive or closed, or moved to another queue by the same agent where queue-change segmentation is enabled), so at 15 minutes it often lands in a later interval than the one where the work happened and can exceed the interval length; sum totals and counts across intervals for a per-conversation figure over a longer period. This is the When-Contact-Ended (WCE) convention rather than True-to-Interval, so an occupancy derived from a single interval can exceed 100% without indicating an error.","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"numberOfConversationsHandled":{"minimum":0,"type":"integer","description":"Distinct conversations among the assignments that ended in the interval; the denominator of the two handle time averages. Counted in the interval the assignment ended, credited to the queue the assignment started in","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"numberOfAssignmentsStarted":{"minimum":0,"type":"integer","description":"The number of assignments that started in the interval in this queue. Counts every start reason (a routing, a transfer, a takeover, a reactivation, and a same-agent queue change where queue-change segmentation is enabled), excluding merged-as-dangling conversations and conversations that ended as danglers: exactly the population numberOfAssignmentsEnded counts, so across any span started minus ended is the change in open assignments. Summing numberOfAssignmentsStarted across every agent's queueTotals entry for this queue in IntervalAgentMetrics gives this number, less the assignments of bots and of agents with no online time in the interval","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"numberOfAssignmentsEnded":{"minimum":0,"type":"integer","description":"The number of assignments that ended in the interval, credited to the queue the assignment started in: the population behind totalHandleTimeBasic and totalHandleTimeConcurrencyAdjusted, counted per assignment where numberOfConversationsHandled counts distinct conversations. Summing numberOfAssignmentsEnded across every agent's queueTotals entry for this queue in IntervalAgentMetrics gives this number, less the assignments of bots, which that feed does not carry, and of agents with no online time in the interval Where the tenant has queue-change segmentation enabled, a queue change that keeps the same agent ends one assignment and starts another, and both count here","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"totalWorkTime":{"description":"Sum of Work Time over the assignments with work time that ended in the interval. Counted in the interval the assignment ended, credited to the queue the assignment started in. The whole work time of an assignment is credited to the interval in which the assignment ended (re-assigned, re-queued, inactive or closed, or moved to another queue by the same agent where queue-change segmentation is enabled), so at 15 minutes it often lands in a later interval than the one where the work happened; sum totals and counts across intervals for a per-conversation figure over a longer period. This is the When-Contact-Ended (WCE) convention rather than True-to-Interval, so an occupancy derived from a single interval can exceed 100% without indicating an error.","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"handleTimeInInterval":{"description":"True-to-interval handle time for the queue: the seconds, summed across concurrently owned conversations, during which a conversation in this queue was assigned to an agent inside this interval, whenever the assignment started or will end. This is the True-to-Interval (TTI) convention as NICE defines it (an interaction is counted in each interval it spans, with handle time in each interval it is active), beside the When-Contact-Ended (WCE) totals on the same row, which credit the whole handle time to the interval the assignment ended in. NICE's third-party ACD path accepts WCE only; this field is for consumers that need the in-interval view. Summed over a day the two agree up to the assignments open at its edges. Owned means the conversation has an owner, so invitations count and inactive conversations do not. Measured from the queue snapshot, which is regularized once a minute and written on change, so precision is about a minute. At most the interval length times the queue's peak number of owned conversations. 0 when nothing in the queue was owned during the interval","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"numberOfConversationsWithWorkTime":{"minimum":0,"type":"integer","description":"Distinct conversations among the assignments with work time that ended in the interval; the denominator of averageWorkTime","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"averageWaitTimeWhileAgentsAvailable":{"description":"Wait Time counting only the part of each wait during which the queue had at least one agent in the Available status, averaged over the same conversations as averageWaitTime. Time waited after hours, over lunch logouts, or while every agent was in Available for Existing (Current Conversations) or Unavailable is excluded. Time spent in an earlier queue before a transfer is checked against that queue's staffing, and the whole wait is credited to the queue that answered. Precision is the queue snapshot pulse, about a minute. Equals totalWaitTimeWhileAgentsAvailable divided by the answered conversations that have a wait time, the same denominator as averageWaitTime; that is numberOfConversationsAnswered unless a conversation's wait time is missing","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"totalWaitTimeWhileAgentsAvailable":{"description":"Sum of the wait time while agents were available, over the conversations answered in the interval","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"averageWaitTimeWhileAgentsStaffed":{"description":"Wait Time counting only the part of each wait during which the queue had at least one agent in the Available or Available for Existing (Current Conversations) status, i.e. someone on shift, averaged over the same conversations as averageWaitTime. Time spent in an earlier queue before a transfer is checked against that queue's staffing, and the whole wait is credited to the queue that answered. Equals totalWaitTimeWhileAgentsStaffed divided by the answered conversations that have a wait time, the same denominator as averageWaitTime","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"totalWaitTimeWhileAgentsStaffed":{"description":"Sum of the wait time while agents were staffed, over the conversations answered in the interval","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"numberOfAssignmentsWithResponse":{"minimum":0,"type":"integer","description":"The number of assignments that ended in the interval in which the agent sent at least one message; the base for the agent response time thresholds. Counted in the interval the assignment ended, credited to the queue the assignment started in. Includes every assignment start reason, so unlike the agent row's field of the same name it also counts assignments that began with an agent-started (outbound) conversation and reactivated conversations; the two do not reconcile row for row","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"numberOfConversationsAnsweredWithin30Seconds":{"minimum":0,"type":"integer","description":"Of numberOfConversationsAnswered, how many were answered within 30 seconds of entering the queue (Wait Time at most 30 s). Cumulative: every conversation within 30 s is also within 60 s","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"totalWaitTimeWithin30Seconds":{"description":"Sum of Wait Time over the conversations answered within 30 seconds. With numberOfConversationsAnsweredWithin30Seconds this gives the average wait of the conversations answered within 30 s, and with totalWaitTime and numberOfConversationsAnswered the average of those answered later","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"numberOfConversationsAnsweredWithin60Seconds":{"minimum":0,"type":"integer","description":"Of numberOfConversationsAnswered, how many were answered within 60 seconds of entering the queue (Wait Time at most 60 s). Cumulative: every conversation within 30 s is also within 60 s","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"totalWaitTimeWithin60Seconds":{"description":"Sum of Wait Time over the conversations answered within 60 seconds. With numberOfConversationsAnsweredWithin60Seconds this gives the average wait of the conversations answered within 60 s, and with totalWaitTime and numberOfConversationsAnswered the average of those answered later","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"numberOfConversationsAnsweredWithin90Seconds":{"minimum":0,"type":"integer","description":"Of numberOfConversationsAnswered, how many were answered within 90 seconds of entering the queue (Wait Time at most 90 s). Cumulative: every conversation within 30 s is also within 60 s","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"totalWaitTimeWithin90Seconds":{"description":"Sum of Wait Time over the conversations answered within 90 seconds. With numberOfConversationsAnsweredWithin90Seconds this gives the average wait of the conversations answered within 90 s, and with totalWaitTime and numberOfConversationsAnswered the average of those answered later","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"numberOfConversationsAnsweredWithin120Seconds":{"minimum":0,"type":"integer","description":"Of numberOfConversationsAnswered, how many were answered within 120 seconds of entering the queue (Wait Time at most 120 s). Cumulative: every conversation within 30 s is also within 60 s","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"totalWaitTimeWithin120Seconds":{"description":"Sum of Wait Time over the conversations answered within 120 seconds. With numberOfConversationsAnsweredWithin120Seconds this gives the average wait of the conversations answered within 120 s, and with totalWaitTime and numberOfConversationsAnswered the average of those answered later","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"numberOfConversationsAnsweredWithin300Seconds":{"minimum":0,"type":"integer","description":"Of numberOfConversationsAnswered, how many were answered within 300 seconds of entering the queue (Wait Time at most 300 s). Cumulative: every conversation within 30 s is also within 60 s","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"totalWaitTimeWithin300Seconds":{"description":"Sum of Wait Time over the conversations answered within 300 seconds. With numberOfConversationsAnsweredWithin300Seconds this gives the average wait of the conversations answered within 300 s, and with totalWaitTime and numberOfConversationsAnswered the average of those answered later","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"numberOfConversationsAnsweredWithin3600Seconds":{"minimum":0,"type":"integer","description":"Of numberOfConversationsAnswered, how many were answered within 3600 seconds of entering the queue (Wait Time at most 3600 s). Cumulative: every conversation within 30 s is also within 60 s","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"totalWaitTimeWithin3600Seconds":{"description":"Sum of Wait Time over the conversations answered within 3600 seconds. With numberOfConversationsAnsweredWithin3600Seconds this gives the average wait of the conversations answered within 3600 s, and with totalWaitTime and numberOfConversationsAnswered the average of those answered later","$ref":"#/components/schemas/DurationMillis","nullable":true,"readOnly":false,"extensions":{"x-quiq-property-meta":{}},"exampleSetFlag":false},"numberOfAssignmentsRespondedWithin30Seconds":{"minimum":0,"type":"integer","description":"Of numberOfAssignmentsWithResponse, how many had the agent's first message within 30 seconds of assignment. Cumulative","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"numberOfAssignmentsRespondedWithin60Seconds":{"minimum":0,"type":"integer","description":"Of numberOfAssignmentsWithResponse, how many had the agent's first message within 60 seconds of assignment. Cumulative","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"numberOfAssignmentsRespondedWithin90Seconds":{"minimum":0,"type":"integer","description":"Of numberOfAssignmentsWithResponse, how many had the agent's first message within 90 seconds of assignment. Cumulative","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"numberOfAssignmentsRespondedWithin120Seconds":{"minimum":0,"type":"integer","description":"Of numberOfAssignmentsWithResponse, how many had the agent's first message within 120 seconds of assignment. Cumulative","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"numberOfAssignmentsRespondedWithin300Seconds":{"minimum":0,"type":"integer","description":"Of numberOfAssignmentsWithResponse, how many had the agent's first message within 300 seconds of assignment. Cumulative","format":"int32","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["integer"]},"minimumOnlineAgents":{"type":"number","description":"The lowest number of agents online in the queue at any moment in the interval; the companion of averageOnlineAgents","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"maximumOnlineAgents":{"type":"number","description":"The highest number of agents online in the queue at any moment in the interval; the companion of averageOnlineAgents","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"minimumAvailableAgents":{"type":"number","description":"The lowest number of agents in the Available status in the queue at any moment in the interval; the companion of averageAvailableAgents","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"maximumAvailableAgents":{"type":"number","description":"The highest number of agents in the Available status in the queue at any moment in the interval; the companion of averageAvailableAgents","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"minimumUnavailableAgents":{"type":"number","description":"The lowest number of agents in the Unavailable status in the queue at any moment in the interval; the companion of averageUnavailableAgents","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"maximumUnavailableAgents":{"type":"number","description":"The highest number of agents in the Unavailable status in the queue at any moment in the interval; the companion of averageUnavailableAgents","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"minimumAvailableForExistingAgents":{"type":"number","description":"The lowest number of agents in the Available for Existing status in the queue at any moment in the interval; the companion of averageAvailableForExistingAgents","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"maximumAvailableForExistingAgents":{"type":"number","description":"The highest number of agents in the Available for Existing status in the queue at any moment in the interval; the companion of averageAvailableForExistingAgents","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"minimumTotalAgentCapacity":{"type":"number","description":"The lowest number of total conversation capacity of the agents in the queue at any moment in the interval; the companion of averageTotalAgentCapacity","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"maximumTotalAgentCapacity":{"type":"number","description":"The highest number of total conversation capacity of the agents in the queue at any moment in the interval; the companion of averageTotalAgentCapacity","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"minimumTotalAgentWorkload":{"type":"number","description":"The lowest number of total workload of the agents in the queue at any moment in the interval; the companion of averageTotalAgentWorkload","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"maximumTotalAgentWorkload":{"type":"number","description":"The highest number of total workload of the agents in the queue at any moment in the interval; the companion of averageTotalAgentWorkload","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"minimumAvailableAgentCapacity":{"type":"number","description":"The lowest number of conversation capacity of the Available agents in the queue at any moment in the interval; the companion of averageAvailableAgentCapacity","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"maximumAvailableAgentCapacity":{"type":"number","description":"The highest number of conversation capacity of the Available agents in the queue at any moment in the interval; the companion of averageAvailableAgentCapacity","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"minimumAvailableAgentWorkload":{"type":"number","description":"The lowest number of workload of the Available agents in the queue at any moment in the interval; the companion of averageAvailableAgentWorkload","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]},"maximumAvailableAgentWorkload":{"type":"number","description":"The highest number of workload of the Available agents in the queue at any moment in the interval; the companion of averageAvailableAgentWorkload","nullable":true,"readOnly":false,"extensions":{"x-quiq-type-meta":{},"x-quiq-property-meta":{}},"exampleSetFlag":false,"types":["number"]}},"description":"Metrics for one queue over one interval","extensions":{"x-quiq-type-meta":{}},"exampleSetFlag":false,"types":["object"]}}},"webhooks":{"UploadPromotionCompleted":{"post":{"tags":["Assets"],"summary":"UploadPromotionCompleted","description":"Fired after an upload has been processed.","operationId":"UploadPromotionCompleted","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicUploadCallbackPayload","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"204":{}}}},"AgentStatusChanged":{"post":{"tags":["Messaging"],"summary":"AgentStatusChanged","description":"Fired when the status of an agent changes or when they logout or login.","operationId":"AgentStatusChanged","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusChangedPublicEvent","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"204":{}}}},"AgentSessionMetrics":{"post":{"tags":["Messaging"],"summary":"AgentSessionMetrics","description":"Fired when the agent goes offline","operationId":"AgentSessionMetrics","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentSessionMetricsPublicEvent","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"204":{}}}},"AgentWorkloadSummary":{"post":{"tags":["Messaging"],"summary":"AgentWorkloadSummary","description":"Fired approximately once a minute, this webhook contains summary information about agent per-queue workload","operationId":"AgentWorkloadSummary","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentWorkloadPublicEvent","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"204":{}}}},"WorkloadSummary":{"post":{"tags":["Messaging"],"summary":"WorkloadSummary","description":"Fired approximately once a minute, this webhook contains summary information about current global and per-queue workload","operationId":"WorkloadSummary","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkloadSummaryPublicEvent","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"204":{}}}},"BotSessionMetrics":{"post":{"tags":["Bot API"],"summary":"BotSessionMetrics","description":"Fired when a Quiq bot leaves a conversation","operationId":"BotSessionMetrics","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BotSessionSummaryEvent","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"204":{}}}},"AIAgentError":{"post":{"tags":["AI Agent API"],"summary":"AIAgentError","description":"Fired when an AI Agent encounters an error","operationId":"AIAgentError","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AIAgentErrorEvent","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"204":{}}}},"CustomerAssistantContext":{"post":{"tags":["AI Studio"],"summary":"CustomerAssistantContext","description":"The context for customer assistants. Not actually a webhook but rather the shape of the data passed as the 'context' argument to various Functions","operationId":"CustomerAssistantContext","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerAssistantContext","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"204":{}}}},"Webhook Behavior":{"post":{"tags":["Bot API"],"summary":"Webhook Behavior","description":"Fires when a bot changes location to a Webhook Behavior. This is applicable to bots built directly within Quiq as opposed to bots built directly against the API. The response schema illustrates the actions you can send back to be enacted by your bot.","operationId":"Webhook Behavior","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BotWebhookRequest","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BotWebhookResponse","exampleSetFlag":false},"exampleSetFlag":false}}}}}},"ConversationStatusChanged":{"post":{"tags":["Messaging"],"summary":"ConversationStatusChanged","description":"Fired when a conversation goes through important lifecycle events such as being requested, closed, inactivated, etc.","operationId":"ConversationStatusChanged","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConversationStatusChangePublicEvent","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"204":{}}}},"ConversationAssignmentEnded":{"post":{"tags":["Messaging"],"summary":"ConversationAssignmentEnded","description":"Fired whenever a conversation becomes unassigned from an agent (human or bot) and contains important details regarding that assignment","operationId":"ConversationAssignmentEnded","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConversationAssignmentEndedPublicEvent","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"204":{}}}},"AgentHooks":{"post":{"tags":["Bot API"],"summary":"AgentHooks","description":"Fired when business objects (e.g. conversations) that an agent is subscribed to undergo a state change. These requests timeout after 10 seconds.","operationId":"AgentHooks","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentHooksEnvelope","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"204":{}}}},"SurveySubmissionReceived":{"post":{"tags":["Messaging"],"summary":"SurveySubmissionReceived","description":"Fired when a survey submission is received.","operationId":"SurveySubmissionReceived","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SurveySubmissionReceivedEvent","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"204":{}}}},"NotificationsDeliverabilityStatus":{"post":{"tags":["Messaging"],"summary":"NotificationsDeliverabilityStatus","description":"Fired when batches of notification deliverability updates are ready.","operationId":"NotificationsDeliverabilityStatus","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationsDeliverabilityStatusPublicEvent","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"204":{}}}},"CustomerOptOutStatusChanged":{"post":{"tags":["Messaging"],"summary":"CustomerOptOutStatusChanged","description":"Fired when at least one customer's opt out status has changed","operationId":"CustomerOptOutStatusChanged","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerOptOutStatusChangedPublicEvent","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"204":{}}}},"ServiceContext":{"post":{"tags":["AI Studio"],"summary":"ServiceContext","description":"The context for services. Not actually a webhook but rather documents the shape of the data passed as the 'context' argument to various functions","operationId":"ServiceContext","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceContext","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"204":{}}}},"AIServiceError":{"post":{"tags":["AI Service API"],"summary":"AIServiceError","description":"Fired when an AI Service encounters an error.","operationId":"AIServiceError","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AIServiceErrorEvent","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"204":{}}}},"AgentAssistantContext":{"post":{"tags":["AI Studio"],"summary":"AgentAssistantContext","description":"The context for agent assistants. Not actually a webhook but rather documents the shape of the data passed as the 'context' argument to various functions","operationId":"AgentAssistantContext","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentAssistProgrammaticContext","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"204":{}}}},"AIAssistantError":{"post":{"tags":["AI Studio"],"summary":"AIAssistantError","description":"Fired when an AI Assistant encounters an error.","operationId":"AIAssistantError","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AIAssistantErrorEvent","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"204":{}}}},"IntervalMetrics":{"post":{"tags":["Messaging"],"summary":"IntervalMetrics","description":"Beta: this contract is planned and may change. Fired once per closed 15-minute interval, shortly after it closes, with the queue metrics for that interval. Every queue appears once across the interval's pages; a field is null when nothing of that kind happened in the interval","operationId":"IntervalMetrics","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntervalMetricsPublicEvent","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"204":{}}}},"IntervalAgentMetrics":{"post":{"tags":["Messaging"],"summary":"IntervalAgentMetrics","description":"Beta: this contract is planned and may change. Fired once per closed 15-minute interval, shortly after it closes, with metrics for every human agent who was online during the interval; bots are not included. Subscribe to this separately from IntervalMetrics; it carries per-agent productivity data","operationId":"IntervalAgentMetrics","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntervalAgentMetricsPublicEvent","exampleSetFlag":false},"exampleSetFlag":false}}},"responses":{"204":{}}}}},"extensions":null,"externalDocs":null,"jsonSchemaDialect":null,"security":null,"servers":null,"tags":[{"description":"The following APIs comprise the main Quiq Messaging product.","extensions":null,"externalDocs":null,"name":"Messaging"}]}