BeeBotChat - Chat App Message Service - Alibaba Cloud ドキュメントセンター

Initiates a conversation with a chatbot by using the unique chatbot identifier (chatbot ID).

Operation description

The single-user queries per second (QPS) limit for this operation is 100. Exceeding this limit will trigger throttling, which may affect your business. Call this operation appropriately.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
SessionId	string	No	The session ID, which identifies the session and context information of a visitor.	en
Utterance	string	Yes	The input from the chatbot visitor.	659216218162179
IsvCode	string	No	The ISV verification code, which is used to verify whether a RAM user is authorized by the ISV.	ksiekdki39ksks93939
ChatBotInstanceId	string	Yes	The chatbot instance ID.	1
KnowledgeId	string	No	The ID of the knowledge title in the knowledge base.	1
IntentName	string	No	The intent name in the dialog flow. If you specify this name, the chatbot directly enters this intent for Q&A.	intent
SenderId	string	No	The visitor ID, which identifies the user in the current session.	861500000000
SenderNick	string	No	The nickname of the visitor in the current session.	nick
Perspective	array	No	The list of perspective codes.
	string	No	The perspective code, which is used to retrieve answers from different perspectives under the same knowledge title.	u6Yvizzjba
VendorParam	object	No	The custom parameter set. This is a JSON-formatted set of user-defined parameters that can be passed to various dialog engines.	{\"skills\":\"chat_search\",\"accessToken\":\"73f4d5c8e8c334d9b538890bca68ac9a\",\"senderStaffId\":\"1697204021326\",\"senderCorpId\":\"dingee291fb2828058b9\"}
CustSpaceId	string	No	The SpaceId of the ISV sub-customer.	293483938849493

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	90E63D28-E31D-1EB2-8939-A94866411B2O
Code	string	The return result. OK indicates normal.	OK
Message	string	The message returned when an exception occurs.	none
Data	object	The returned data.
MessageId	string	The ID of the response message in this session.	ab6be8af-cee4-40c3-9919-2ac7461d7d98
SessionId	string	The ID of this session.	1234
Messages	array<object>	The list of messages.
	array<object>	The message body.
Knowledge	object	The Knowledge object returned by the chatbot when AnswerType is Knowledge.
HitStatement	string	The hit statement.	Housing fund.
Summary	string	The summary of the hit question.	Housing fund withdrawal.
RelatedKnowledges	array<object>	The list of related knowledge items.
	object	The related knowledge object.
KnowledgeId	string	The ID of the related knowledge item.	735899
Title	string	The title of the related knowledge item.	Housing fund withdrawal.
Category	string	The knowledge category.	Housing fund.
Title	string	The title of the hit question.	Housing fund withdrawal.
Content	string	The content of the hit question.	Housing fund withdrawal. Search for "housing fund withdrawal" on the homepage and submit the application form.
AnswerSource	string	The answer type identifier.	KnowledgeBase
Id	string	The ID of the hit question in the knowledge base.	735898
ContentType	string	The indicator for whether the answer is plain text or rich text.	PLAIN_TEXT
Text	object	The Text object returned by the chatbot when AnswerType is Text.
HitStatement	string	The hit statement.	CheckWeather.
DialogName	string	The dialog unit name returned when AnswerSource is BotFramework.	Sample_CheckWeather.
AnswerSource	string	The answer type identifier.	BotFramework
Slots	array<object>	The list of slot information.
	object	The slot information.
Value	string	The specific value.	Beijing.
Origin	string	The original value.	Beijing.
Name	string	The name.	CheckWeatherIntent.city.
Hit	boolean	Indicates whether the slot is hit.	false
NodeName	string	The node name returned when AnswerSource is BotFramework.	Sample_CheckWeather.CheckWeatherSlotFilling.__city.
IntentName	string	The intent name returned when AnswerSource is BotFramework.	CheckWeatherIntent.
MetaData	string	The metadata.	[[{\"columnName\":\"Name\",\"stringValue\":\"Wang Shanshan\"}]]
ExternalFlags	object	The pass-through parameters returned when AnswerSource is BotFramework.
Ext	object	The pass-through parameters.
UserDefinedChatTitle	string	The custom chitchat topic title.	Greeting.
Content	string	The content of the text message.	Which location would you like to check the weather for?
NodeId	string	The node ID returned when AnswerSource is BotFramework.	1410-c7a72a78.__city
ContentType	string	The indicator for whether the answer is plain text or rich text.	PLAIN_TEXT
Recommends	array<object>	The list of recommendations returned by the chatbot when AnswerType is Recommend.
	object	The Recommend object.
KnowledgeId	string	The knowledge ID for clarification.	4548
Title	string	The clarification content, which can be an entity from knowledge graph Q&A or a knowledge title from knowledge-based Q&A.	Test plain text.
AnswerSource	string	The identifier of the clarification source.	KNOWLEDGE
AnswerType	string	The type of this message.	Text
AnswerSource	string	The source of the recommended answer when AnswerType is Recommend.	KNOWLEDGE
AccessDeniedDetail	string	The access denied details.	None.

Examples

Success response

JSON format

{
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2O",
  "Code": "OK",
  "Message": "none",
  "Data": {
    "MessageId": "ab6be8af-cee4-40c3-9919-2ac7461d7d98",
    "SessionId": "1234",
    "Messages": [
      {
        "Knowledge": {
          "HitStatement": "Housing fund.",
          "Summary": "Housing fund withdrawal.",
          "RelatedKnowledges": [
            {
              "KnowledgeId": "735899",
              "Title": "Housing fund withdrawal."
            }
          ],
          "Category": "Housing fund.",
          "Title": "Housing fund withdrawal.",
          "Content": "Housing fund withdrawal. Search for \"housing fund withdrawal\" on the homepage and submit the application form.",
          "AnswerSource": "KnowledgeBase",
          "Id": "735898",
          "ContentType": "PLAIN_TEXT"
        },
        "Text": {
          "HitStatement": "CheckWeather.",
          "DialogName": "Sample_CheckWeather.",
          "AnswerSource": "BotFramework",
          "Slots": [
            {
              "Value": "Beijing.",
              "Origin": "Beijing.",
              "Name": "CheckWeatherIntent.city.",
              "Hit": false
            }
          ],
          "NodeName": "Sample_CheckWeather.CheckWeatherSlotFilling.__city.",
          "IntentName": "CheckWeatherIntent.",
          "MetaData": "[[{\\\"columnName\\\":\\\"Name\\\",\\\"stringValue\\\":\\\"Wang Shanshan\\\"}]]",
          "ExternalFlags": {
            "test": "test",
            "test2": 1
          },
          "Ext": {
            "test": "test",
            "test2": 1
          },
          "UserDefinedChatTitle": "Greeting.",
          "Content": "Which location would you like to check the weather for?",
          "NodeId": "1410-c7a72a78.__city",
          "ContentType": "PLAIN_TEXT"
        },
        "Recommends": [
          {
            "KnowledgeId": "4548",
            "Title": "Test plain text.",
            "AnswerSource": "KNOWLEDGE"
          }
        ],
        "AnswerType": "Text",
        "AnswerSource": "KNOWLEDGE"
      }
    ]
  },
  "AccessDeniedDetail": "None."
}

Error codes

HTTP status code	Error code	Error message	Description
400	Product.Unsubscript	You have not subscribed to the specified product.	You have not subscribed to the specified product.
400	Ram.PermissionDeny	You are not authorized to perform the operation.
400	System.LimitControl	The system is under flow control.	The system is under flow control.
400	Unknown.ResourceOwnerId	The resource does not belong to the current user.	The resource does not belong to the current user.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.