| \n\nName\n\n | \n\nDescription\n\n |
|---|---|
| \n\naction\n\n | \n\nAction that the VA should take.Valid values:\n\n- [AGENT](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-apis/bot-api.md): Switches the conversation from VA to Live Agent.\n- [CREATE\\_CONVERSATION](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-apis/bot-api.md): Creates a chat interaction. Set **syncResponse** to `true` to return the conversation and interaction details back in the response.\n- [END\\_CONVERSATION](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-apis/bot-api.md): Ends the chat conversation. The **message.text** parameter should be empty when using this action.\n- [FAULT\\_CONVERSATION](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-apis/bot-api.md): Faults a conversation. When setting a FAULT\\_CONVERSATION action, provide a description for the **cause** parameter.\n- [SEND\\_HISTORY](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-apis/bot-api.md): Updates only the chat history. The chat history can also be sent using standard message processing with the **history** parameter.\n- SET\\_USER\\_TIMEZONE: Sets the user’s time zone to the time zone specified in the **timezone** parameter. This time zone remains in effect until you reset it using this same parameter.\n- [START\\_CONVERSATION](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-apis/bot-api.md): Starts a chat conversation.\n- [START\\_CREATED\\_CONVERSATION](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-apis/bot-api.md): Starts a chat conversation initiated using `CREATE_CONVERSATION`. Set **syncResponse** to `true` to process the request synchronously and avoid race conditions that cause timing issues.\n- [SWITCH](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-apis/bot-api.md): Switch the conversation to a topic that matches what is specified in the **intent.id** or **topic.name** parameters.\n\n**Note:** Only use the `SWITCH` action for topic switching when the intent discovery happens in the primary bot. If the intent discovery happens in the ServiceNow® VA, use the **message.text** parameter.\n\n- TYPING/VIEWING: Displays the typing indicator in Live Agent. First send `TYPING` and then after the user finishes typing, send `VIEWING`.\n- [UPDATE\\_MESSAGES](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-apis/bot-api.md): This action is used during live agent conversations and provides two message update functions for third-party chat integrations for the messages received from the live agent that are reflected on the agent chat panel:\n\n - The latest message delivery status after sending a message from third-party.\n - Updated text on the agent chat panel.\nThe third-party chat integration can update the text portion of the message before sending it to the end user. This action can be called to update the text on the agent chat panel so that the agent can see the updated text with an \"Updated\" tag.\n\nThis action is used with the **message.status** and **message.id** parameters.\n\nThis option is only valid if custom adapter property with name third\\_party\\_chat tied to provider application is set to `true`. This is a synchronous action irrespective of synchronous/asynchronous nature of the channel.\n\n- Null or parameter not passed: Sends the message to the ServiceNow VA.\n\nThe third-party chat integration can update the text message triggered from the live agent before sending it to the end user. This action can be called to update the text on the agent chat panel so that the agent can see the updated text with an \"Updated\" tag.\n\nData type: String\n\nDefault: Null\n\n |
| \n\nbotToBot\n\n | \n\nFlag that indicates whether the conversation is between bots, such as between a primary bot and secondary bot.Possible values:\n\n- true: Bot-to-bot conversation.\n- false: Standalone ServiceNow bot conversation.\n\nData type: Boolean\n\nDefault: true\n\n |
| \n\ncause\n\n | \n\nCause of a chat conversation fault, for example, `EXTERNAL_FAILURE`. This property is only used when the **action** property is set to **FAULT\\_CONVERSATION**.Data type: String\n\n |
| \n\nclientSessionId\n\n | \n\nUnique client session identifier of the application/service that the end user is using to communicate with the ServiceNow botor the supported third-party chat applications.- This ID helps identify the set of request/responses for a specific user conversation.\n- The format of this parameter is determined by the implementer.\n- This value is only updated if the value of the **third\\_party\\_chat** field is `true` in the **Custom Adapter Property** form.\n\nTable: Interaction \\[interaction\\]\n\nData type: String\n\nDefault: Null\n\n |
| \n\nclientVariables\n\n | \n\nPass-through JSON-formatted name-value pairs that are sent back in the response. These values aren't processed by the endpoint, but can be used to keep specific customer information attached to the conversation.Data type: Object\n\nDefault: Null\n\n |
| \n\ncontextVariables\n\n | \n\nJSON-formatted name-value pairs that provide addition information about the user. Provide this information to customize the conversation experience. For additional information on context variables, see [Define and publish chat context variables](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/conversational-interfaces/ac-configure-context-variables.md).For example:\n\n```\n\"contextVariables\": {\n \"requester_session_language\": \"es\", \n \"deviceTimeZone\": \"America/Los_Angeles\"\n \"live_agent_only\": \"true\",\n \"liveagent_deviceType\": \"test_device_type\"\n \"topic\": \"7c3c819073a3101066c7e9344ef6a7e4\" \n} \n```\n\nData type: Object\n\nDefault: Null\n\n |
| \n\nemailId\n\n | \n\nRequired when enabling account linking, otherwise all users are considered guest users. Email address of the chat client end user, the person the bot is interacting with. For additional information on account linking, see [Link your ServiceNow user account to a messaging application for Virtual Agent conversations](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/conversational-interfaces/link-accounts-with-virtual-agent.md).Data type: String\n\n |
| \n\nhistory\n\n | \n\nHistory of the primary bot’s conversation with the user, starting with the initial request by the user.Data type: Object\n\n```\n\"history\": {\n \"displayName\": \"String\",\n \"isBotMessage\": Boolean,\n \"timestamp\": \"String\",\n \"type\": \"String\",\n \"value\": \"String\"\n}\n```\n\n |
| \n\nhistory.displayName\n\n | \n\nName of the user to whom the message was sent. If the primary bot, pass `Bot`.Data type: String\n\n |
| \n\nhistory.isBotMessage\n\n | \n\nFlag that indicates whether the message was sent by the primary bot.Valid values:\n\n- true: Message was sent by the primary bot.\n- false: Message was sent by the user.\n\nData type: Boolean\n\n |
| \n\nhistory.timestamp\n\n | \n\nTimestamp indicating the time at which the message was sent in milliseconds.Valid values: 13-digit Unix timestamp\n\nData type: String\n\n |
| \n\nhistory.type\n\n | \n\nType of message sent.Valid values: text\n\nData type: String\n\n |
| \n\nhistory.value\n\n | \n\nContent of the information. For example, the message text.Data type: String\n\n |
| \n\nintent\n\n | \n\nDescribes the intent of the conversation. Provide this information when the **action** parameter is set to `SWITCH`.Data type: Object\n\n```\n\"intent\": {\n \"id\": \"String\"\n}\n```\n\n |
| \n\nintent.id\n\n | \n\nNLU Intent ID of the system topic to switch the conversation to. The **intent.id** is resolved based on the language passed in the chat session. If no language is passed when starting a conversation, it obtains the language from the user's session/profile.Data type: String\n\nTable: CS Topic Language \\[sys\\_cs\\_topic\\_language\\]\n\n |
| \n\nmessage\n\n | \n\nRequired. Details of the message to send to the ServiceNow bot.Data type: Object\n\n```\n\"message\": {\n \"attachment\": [Array of Objects],\n \"clientMessageId\": \"String\",\n \"status\": \"String\",\n \"text\": \"String\",\n \"typed\": Boolean\n}\n```\n\n |
| \n\nmessage.attachment\n\n | \n\nRequired if sending attachments. Details of each attachment to send.You can only pass attachments as a URL. A virus scan is triggered on all attachments. There is no restriction on the size of an attachment, however, large files can take significant time to transfer.\n\nData type: Array of Objects\n\n```\n\"attachment\": [\n {\n \"clientAttachmentId\": \"String\",\n \"contentType\": \"String\",\n \"fileName\": \"String\",\n \"headers\":{Object},\n \"id\": \"String\",\n \"url\": \"String\"\n }\n]\n```\n\n |
| \n\nmessage.attachment.clientAttachmentId\n\n | \n\nUnique identifier of the attachment to send to the ServiceNow bot. The format of this identifier is determined by the implementer.Data type: String\n\nDefault: Null\n\n |
| \n\nmessage.attachment.contentType\n\n | \n\nRequired if attachment specified. Standard mime type of the attachment.Valid values \\(not case-sensitive\\):\n\n- application/pdf\n- application/msword\n- image/png\n- image/jpeg\n- text/plain\n- video/mpeg\n\nData type: String\n\n |
| \n\nmessage.attachment.fileName\n\n | \n\nRequired if attachment specified. File name of the attachment.Data type: String\n\n |
| \n\nmessage.attachment.headers\n\n | \n\nAdditional information needed if the attachment file is private and protected.Data type: Object\n\n```\n\"headers\":{\n \"Authorization\":\"String\"\t\n}\n```\n\n |
| \n\nmessage.attachment.headers.Authorization\n\n | \n\nInformation needed to obtain authorization to access the attachment, such as a user name and password.Data type: String\n\n |
| \n\nmessage.attachment.url\n\n | \n\nRequired if attachment specified. URL where the attachment is located. The VA obtains the attachment from this URL, runs a virus scan, and then processes the file. If the attachment isn't a public file, you must pass an **message.attachment.header** object that contains the authorization information so that the attachment can be accessed. You must also ensure that URL domain is present in the trusted domains filed in **sys\\_cs\\_provider**.Data type: String\n\n |
| \n\nmessage.clientMessageId\n\n | \n\nUnique alphanumeric identifier for the message. The format of this identifier is determined by the implementer.Data type: String\n\nDefault: Null\n\n |
| \n\nmessage.id\n\n | \n\nOnly used with the **UPDATE\\_MESSAGES** action. Unique ID of the chat message to be updated.Data type: String\n\n |
| \n\nmessage.status\n\n | \n\nMessage status.Valid values \\(not case-sensitive\\):\n\n- external\\_error - Used when message delivery is failed from third-party chat integration to end user. The agent chat panel will be reflected as a \"Failed\" tag.\n- sent\\_to\\_user - Initially a single tick mark displays for messages delivered from live agent to third- party chat integration. This status must be used when the message is successfully delivered from third-party chat integration to the end user. Upon success, the double tick mark displays on the agent chat panel.\n\nData type: String\n\n |
| \n\nmessage.text\n\n | \n\nRequired if **attachment** parameter isn't specified. Message text. - The language of the message should be passed in the **contextVariables** parameter.\n- Must be empty if the value of the action property is `END_CONVERSATION`.\n- Must be the updated text to be reflected on agent chat panel if the value of the action property is `UPDATE_MESSAGES`.\n\nData type: String\n\nMaximum length: Unlimited\n\n |
| \n\nmessage.typed\n\n | \n\nRequired. Flag that indicates whether the message was typed in or was an option selection \\(selected\\).Valid values:\n\n- true: Message was typed in by the user.\n- false: Message was an option selection.\n\nData type: Boolean\n\n |
| \n\nrequestId\n\n | \n\nRequired. Unique alphanumeric identifier for this request. The format of this identifier is determined by the implementer.Data type: String\n\n |
| \n\nsilentMessage\n\n | \n\nFlag that indicates whether this is a silent message. A silent message is a message that doesn’t require a response.Valid values:\n\n- true: Silent message, no response message expected.\n- false: Regular message, response message expected.\n\n**Note:** If a request with `silentMessage = true` is sent, all subsequent bot messages remain suppressed until a request to turn off silent mode is sent by passing `silentMessage = false`.\n\nData type: Boolean\n\nDefault: false\n\n |
| \n\nsyncResponse\n\n | \n\nApplicable for CREATE\\_CONVERSATION and START\\_CREATED\\_CONVERSATION actions. Flag that indicates whether to wait before returning a synchronous response from the API.\n\n**Note:** This parameter prevents a potential race condition where the `Work Offer` API could be triggered before the `CREATE_CONVERSATION` and `START_CREATED_CONVERSATION` request finished processing. Making the response synchronous eliminates this timing issue.\n\n Valid values:\n\n- true: Returns a synchronous response.\n- false: Returns a response without waiting.\n\n Default: false\n\n |
| \n\ntimestamp\n\n | \n\nUnix epoch time when the message was sent from the end user of the chat client.Data type: Number\n\nUnit: Milliseconds\n\nDefault: Current time\n\n |
| \n\ntimezone\n\n | \n\nGMT time zone of the end user of the chat client.For example:\n\n```\n\"timezone\":\"Asia/Kolkata\"\n```\n\nFor a list of the available time zone values, see [https://en.wikipedia.org/wiki/List\\_of\\_tz\\_database\\_time\\_zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).\n\nData type: String\n\nDefault: GMT time zone of the ServiceNow instance.\n\n |
| \n\ntopic\n\n | \n\nRequired if the user wants to switch to a particular topic by specifying a topic name. Name-value pair of the topic to switch to. You can either specify the topic name or the topic sys\\_id.**Note:** You can only specify a single topic name or ID in the object.\n\nData type: Object\n\n```\n\"topic\": {\n \"name\": \"String\",\n \"id\": \"String\"\n}\n```\n\nFor example:\n\n```\n{ \n \"requestId\": \"xxxx-xxxx-xxxx-xxxx\",\n \"clientSessionId\": \"xxx-xxx-xxx-xxx\",\n \"action\":\"SWITCH\",\n \"topic\":{ \n \"name\": \"Topic Name\"\n }, \n \"userId\": \"beth\" \n} \n```\n\n |
| \n\ntopic.name\n\n | \n\nName of the topic to switch to.Data type: String\n\nTable: In the name field of the Virtual Agent topics \\[sys\\_cs\\_topic\\] table.\n\n |
| \n\ntopic.id\n\n | \n\nSys\\_id of the topic to switch to.Data type: String\n\nTable: Virtual Agent topics \\[sys\\_cs\\_topic\\]\n\n |
| \n\nuserId\n\n | \n\nRequired. Unique user identifier. This is the identifier of the end user who is interacting with the bot.Data type: String\n\n |
| \n\nHeader\n\n | \n\nDescription\n\n |
|---|---|
| \n\nAccept\n\n | \n\nData format of the response body. Only supports **application/json**.\n\n |
| \n\nContent-Type\n\n | \n\nData format of the request body. Only supports **application/json**.\n\n |
| \n\ntoken\n\n | \n\nRequired if using token-based authentication; optional for Basic or OAuth authentication. Authentication token to use if token authentication has been set up for this endpoint.Data type: String\n\n |
| \n\nStatus code\n\n | \n\nDescription\n\n |
|---|---|
| \n\n200\n\n | \n\nSuccessful. The request was successfully processed.If you receive a 200 status code, but don’t receive a response back, check the following things:\n\n- Whether the request is failing in Static, JWT, or Hash Based Token validation, which generally happens in the worker thread of Virtual Agent.\n- Whether the request body format is correct. If incorrect, the conversion doesn’t happen correctly.\n- Whether the request body is missing some required parameters. You can trace exceptions and errors in the System Logs on the ServiceNow instance.\n- Whether the site defined in the REST Message to receive the response is operational; able to detect in logs.\n- Ensure the REST Message that defines where to post the response is set correctly.\n\n |
| \n\n400\n\n | \n\nBad Request. A bad request type or malformed request was detected.\n\n |
| \n\n401\n\n | \n\nUnauthorized. The user credentials are incorrect or have not been passed.\n\n |
| \n\n405\n\n | \n\nInvalid method. The functionality is disabled.\n\n |
| \n\n500\n\n | \n\nInternal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.\n\n |
| \n\nName\n\n | \n\nDescription\n\n |
|---|---|
| \n\nerror\n\n | \n\nDescription of the detected error. Only returned if an error occurs.Data type: Object\n\n```\n\"error\": {\n \"detail\": \"String\",\n \"message\": \"String\"\n}\n```\n\n |
| \n\nerror.detail\n\n | \n\nDetails about the encountered error.Data type: String\n\n |
| \n\nerror.message\n\n | \n\nError message thrown.Data type: String\n\n |
| \n\nstatus\n\n | \n\nStatus of the endpoint call.Valid values:\n\n- failure\n- success\n\nData type: String\n\n |
| \n\nName\n\n | \n\nDescription\n\n |
|---|---|
| \n\nagentChat\n\n | \n\nFlag that indicates whether the conversation is connected to the ServiceNow Live Agent.Possible values:\n\n- true: Chat messages are coming from a live agent.\n- false: Chat messages are coming from a bot and this parameter isn’t returned in the response.\n\nData type: Boolean\n\n |
| \n\nbody\n\n | \n\nList of objects that describe the elements of the response message body.Data type: Array of Objects\n\n```\n\"body\": [\n {\n \"actionType\": \"String\",\n \"agentInfo\": {Object},\n \"data\": \"String\",\n \"group\": \"String\",\n \"header\": \"String\",\n \"height\": Number,\n \"itemType\": \"String\",\n \"label\": \"String\",\n \"maskType\": \"String\",\n \"maxCount\": Number,\n \"maxSize\": Number,\n \"message\": \"String\",\n \"messageId\": \"String\",\n \"multiSelect\": Boolean,\n \"nluTextEnabled\": Boolean,\n \"options\": {Object},\n \"promptMsg\": \"String\",\n \"required\": Boolean,\n \"style\": \"String\",\n \"templateName\": \"String\",\n \"type\": \"String\",\n \"uiType\": \"String\",\n \"value\": \"String/{Object}\",\n \"width\": Number\n }\n]\n```\n\n |
| \n\nbody.actionType\n\n | \n\nType of action message dispatched by the secondary bot to the primary bot. For example, typing indicator or agent wait time.Possible values:\n\n- EndTypingIndicator\n- StartSpinner\n- StartTypingIndicator\n\nFor example:\n\nSending `StartTypeIndicator` to the primary bot when the typing indicator is enabled.\n\n```\n\"body\": { \n \"uiType\":\"ActionMsg\", \n \"actionType\":\"StartTypingIndicator\" \n} \n```\n\nSending `StartSpinner` when transferring to Live Agent to display the wait time to the end user.\n\n```\n\"body\": { \n \"uiType\":\"ActionMsg\", \n \"actionType\":\"StartSpinner\", \n \"spinnerType\":\"wait_time\", \n \"message\":\"Routing you to a live agent...\", \n \"waitTime\":\"8 Seconds\" \n} \n```\n\nData type: String\n\n |
| \n\nbody.agentInfo\n\n | \n\nIf enabled in the agent chat setup, the name and avatar of the associated agent. Data type: Object\n\n```\n\"agentInfo\":{ \n \"agentAvatar\":\"String\",\n \"agentId\":\"String\",\n \"agentName\": \"String\", \n \"sentFromAgent\": Boolean\n}\n```\n\nFor example:\n\n```\n\"agentInfo\":{ \n \"sentFromAgent\": true,\n \"agentName\":\"Beth Anglin\", \n \"agentAvatar\":\"https://instance.servicenow.com/ee4eebf30a0004d963b5c5ac0d734dc4.iix?t=small\" \n} \n```\n\n |
| \n\nbody.agentInfo.agentAvatar\n\n | \n\nURL of the agent's associated avatar file.For example: \"https://instance.servicenow.com/ee4eebf30a0004d963b5c5ac0d734dc4.iix?t=small\"\n\nData type: String\n\n |
| \n\nbody.agentInfo.agentId\n\n | \n\nThe sys\\_id of the live agent.Table: Live Profile \\[live\\_profile\\]\n\nData type: String\n\n |
| \n\nbody.agentInfo.agentName\n\n | \n\nDisplay name of the agent.Data type: String\n\n |
| \n\nbody.agentInfo.sentFromAgent\n\n | \n\nFlag that indicates whether the message was sent by a live agent.Possible values:\n\n- true: Sent by a live agent.\n- false: Sent by a virtual agent.\n\nData type: Boolean\n\n |
| \n\nbody.data\n\n | \n\nJSON string that defines the data within the card.Data type: String\n\n |
| \n\nbody.group\n\n | \n\nRich control group to which the body element belongs. You can further transform these default controls by writing outbound transformation scripts. For additional information on these scripts, see [Virtual Agent action scripts](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/conversational-interfaces/va-action-scripts.md).Possible values:\n\n- DefaultOutputCard\n- DefaultDate\n- DefaultGroupedPartsOutputControl\n- DefaultHtml\n- DefaultOutputImage\n- DefaultOutputLink\n- DefaultText\n- DefaultPicker\n\nData type: String\n\n |
| \n\nbody.header\n\n | \n\nLink header.Data type: String\n\n |
| \n\nbody.height\n\n | \n\nHeight of the HTML element.Data type: Number\n\nUnit: Pixels\n\n |
| \n\nbody.itemType\n\n | \n\nType of body element.Possible values: \\(case-sensitive\\)\n\n- DefaultText\n - File\n - Image\n - Inputtext\n - outputtext\n- DefaultPicker\n - Picture: Items appear in a carousel.\n - List: Items appear in a dropdown-style list.\n\nData type: String\n\n |
| \n\nbody.label\n\n | \n\nLabel to display for the associated element.Data type: String\n\n |
| \n\nbody.maskType\n\n | \n\nSensitivity of the associated data.Possible values:\n\n- NONE: Associated data is of a general nature and doesn’t need to be secured.\n- SECURE: Associated data is of a sensitive nature and should be handled securely.\n\nData type: String\n\n |
| \n\nbody.maxCount\n\n | \n\nOnly returned when **uiType** is `FileUpload`. Maximum number of attachments that can be uploaded at one time.Data type: Number \\(Integer\\)\n\n |
| \n\nbody.maxSize\n\n | \n\nOnly returned when **uiType** is `FileUpload`. Maximum size of the attachment that can be uploaded.Data type: Number \\(Integer\\)\n\nUnit: Megabytes\n\n |
| \n\nbody.message\n\n | \n\nOnly returned when **actionType** is `StartSpinner`. Message to display to user.Data type: String\n\n |
| \n\nbody.messageId\n\n | \n\nUnique identifier for the message sent to the supported third-party chat applications from the ServiceNow Virtual Agent.Table: Conversation Message \\[sys\\_cs\\_message\\]\n\nData type: String\n\n |
| \n\nbody.multiSelect\n\n | \n\nFlag that indicates whether the user can select multiple options.Possible values:\n\n- true: Multiple selections.\n- false: Single selection.\n\nData type: Boolean\n\n |
| \n\nbody.nluTextEnabled\n\n | \n\nFlag that indicates whether the user chat client can receive Natural Language Understanding \\(NLU\\) text messages.Possible values:\n\n- true: Can receive NLU messages.\n- false: Can’t receive NLU messages.\n\nData type: Boolean\n\n |
| \n\nbody.options\n\n | \n\nList that describes the options available for a picker control.Data type: Array of Objects\n\n```\n\"options\": [\n {\n \"attachment\": \"String\",\n \"description\": \"String\",\n \"enabled\": Boolean,\n \"label\": \"String\",\n \"renderStyle\": \"String\",\n \"value\": \"String\"\n }\n]\n```\n\n |
| \n\nbody.options.attachment\n\n | \n\nURL of the image in the carousel to retrieve.Data type: String\n\n |
| \n\nbody.options.description\n\n | \n\nDescription of the carousel item.Data type: String\n\n |
| \n\nbody.options.enabled\n\n | \n\nFlag that indicates whether the picker control is enabled on the end user's chat client. In bot-to-bot implementations, the primary bot is responsible for ensuring the picker control is disabled.Possible values:\n\n- true: Enabled\n- false: Disabled\n\nData type: Boolean\n\n |
| \n\nbody.options.label\n\n | \n\nLabel to display for the associated **body.options.value** parameter.Data type: String\n\n |
| \n\nbody.options.renderStyle\n\n | \n\nStyle to use when rendering the associated element.Possible value: data\n\nData type: String\n\n |
| \n\nbody.options.value\n\n | \n\nValue to display for the associated **body.options.label** parameter.Data type: String\n\n |
| \n\nbody.promptMsg\n\n | \n\nPrompt message to display with the picker control.Data type: String\n\n |
| \n\nbody.required\n\n | \n\nFlag that indicates whether the end user must respond to the query in the body element.Possible values:\n\n- true: Required\n- false: Optional\n\nData type: Boolean\n\n |
| \n\nbody.spinnerType\n\n | \n\nOnly returned when **actionType** is `StartSpinner`. Type of spinner shown to chat user.Possible values:\n\n`wait_time:` Message indicating the amount of delay before being transferred to a live agent.\n\nData type: String\n\n |
| \n\nbody.style\n\n | \n\nStyle of body element.Possible values:\n\n- button\n- carousel\n- list\n- null\n\nData type: String\n\n |
| \n\nbody.templateName\n\n | \n\nName of the template to use to display the associated card.Data type: String\n\n |
| \n\nbody.type\n\n | \n\nOnly returned for DefaultOutputLink. Type of return data.Possible values: link\n\nData type: String\n\n |
| \n\nbody.uiType\n\n | \n\nType of body element. The possible values depend on the value in the **body.group** parameter. These values map back to the controls defined in the Virtual Agent Designer. For more information, see [Getting started with Virtual Agent Designer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/conversational-interfaces/conversation-designer-virtual-agent.md).Possible values:\n\n- ActionMsg\n- DefaultOutputCard\n\nOutputCard\n\n- DefaultDate\n - Date\n - DateTime\n - Time\n- DefaultGroupedPartsOutputControl\n\nGroupedPartsOutputControl\n\n- DefaultHtml\n\nOutputHtml\n\n- DefaultOutputImage\n\nOutputImage\n\n- DefaultOutputLink\n\nOutputLink\n\n- DefaultText\n - InputText\n - OutputText\n - FileUpload\n- DefaultPicker\n - Picker\n - TopicPickerControl\n - Boolean\n\nData type: String\n\n |
| \n\nbody.value\n\n | \n\nData to use to process the body element. The type of information that is passed back depends on the type of body element.OutputLink: Object.\n\n```\n\"value\": {\n \"action\": \"String\"\n}\n```\n\nOutputImage: String. Image URL.\n\nOutputHtml: String. HTML that the client needs to render.\n\nData type: String or Object\n\n |
| \n\nbody.value.action\n\n | \n\nOnly returned for DefaultOutputLink. URL of returned link.Data type: String\n\n |
| \n\nbody.waitTime\n\n | \n\nAmount of time that the user has to wait before being connected to a live agent.Data type: String\n\n |
| \n\nbody.width\n\n | \n\nWidth of the associated HTML element.Data type: Number\n\nUnit: Pixels\n\n |
| \n\nclientSessionId\n\n | \n\nUnique client session identifier of the chat application/service that the end user is using to communicate with the ServiceNow bot.Data type: String\n\n |
| \n\nclientVariables\n\n | \n\nJSON-formatted name-value pairs that are copied from what is passed in the **clientVariables** parameter in the request body. These values aren’t processed by the endpoint, but can be used to keep specific customer information attached to the conversation.Data type: Object\n\n |
| \n\ncompleted\n\n | \n\nFlag that indicates whether the ServiceNow Virtual Agent has successfully completed the conversation.Possible values:\n\n- true: Conversation has been successfully completed.\n- false: Conversation isn’t complete and this parameter isn’t returned in the response.\n\nData type: Boolean\n\n |
| \n\nenterpriseId\n\n | \n\nCurrently unused.\n\n |
| \n\ninteractionId\n\n | \n\nUnique identifier for each conversation between the ServiceNow Virtual Agent and the supported third-party chat applications.Data type: String\n\n |
| \n\nmessage\n\n | \n\nDetails of the message sent to the ServiceNow VA. This is the same as the passed in message object.Data type: Object\n\n```\n\"message\": {\n \"attachment\": {Object},\n \"clientMessageId\": \"String\",\n \"text\": \"String\",\n \"typed\": Boolean\n}\n```\n\n |
| \n\nmessage.attachment\n\n | \n\nDetails of the attachment. Attachments can be either a file or a URL.Data type: Object\n\n```\n\"attachment\": {\n \"clientAttachmentId\": \"String\",\n \"contentType\": \"String\",\n \"fileName\": \"String\",\n \"url\": \"String\"\n```\n\n |
| \n\nmessage.attachment.clientAttachmentId\n\n | \n\nUnique identifier of the attachment sent to the ServiceNow VA. The format of this identifier is determined by the implementer.Data type: String\n\n |
| \n\nmessage.attachment.contentType\n\n | \n\nStandard mime type of the attachment.Possible values \\(not case-sensitive\\):\n\n- application/msword\n- application/pdf\n- image/jpeg\n- image/png\n- text/plain\n- video/mpeg\n\nData type: String\n\n |
| \n\nmessage.attachment.fileName\n\n | \n\nFile name of the attachment.Data type: String\n\n |
| \n\nmessage.attachment.url\n\n | \n\nURL where the attachment is located.Data type: String\n\n |
| \n\nmessage.clientMessageId\n\n | \n\nUnique alphanumeric identifier for the message.Data type: String\n\n |
| \n\nmessage.text\n\n | \n\nMessage text.Data type: String\n\nMaximum length: Unlimited\n\n |
| \n\nmessage.typed\n\n | \n\nFlag that indicates whether the message was typed in or was an option selection \\(selected\\).Possible values:\n\n- true: Message was typed in by the user.\n- false: Message was an option selection.\n\nData type: Boolean\n\n |
| \n\nnowBotId\n\n | \n\nCurrently unused.\n\n |
| \n\nnowSessionId\n\n | \n\nCurrently unused.\n\n |
| \n\nrequestId\n\n | \n\nUnique identifier for this request.Data type: String\n\n |
| \n\nscore\n\n | \n\nIntent confidence score from the ServiceNow NLU model, specified as a percent, such as 87.3%. This score enables the primary bot to make the decision whether to surface the associated intent based on the primary bot’s NLU model’s confidence threshold. The ServiceNow NLU model’s confidence threshold is ignored on the ServiceNow instance so that the primary bot’s NLU model’s confidence threshold can be consistently applied across all secondary bots.Data type: Number\n\n |
| \n\ntakeControl\n\n | \n\nFlag that indicates that the ServiceNow Virtual Agent wants to hand control back over to the primary bot.Possible values:\n\n- true: Return control to the primary bot.\n- false: Keep control.\n\nData type: Boolean\n\nDefault: false\n\n |
| \n\nuserId\n\n | \n\nIdentifier of the end user who is interacting with the bot.Data type: String\n\n |