CreateDialog

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.

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action	Access level	Resource type	Condition key	Dependent action
dianjin:CreateDialog	create	All Resource ``	None	None

Action

Access level

Resource type

Condition key

Dependent action

dianjin:CreateDialog

create

*All Resource

*

None

Request syntax

POST /{workspaceId}/api/virtualHuman/dialog/create HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
workspaceId	string	Yes	The workspace ID.	llm-xxxxx

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
playCode	string	Yes	The playbook code.	live_broadcast_qa
channel	string	Yes	The channel.	taobao
metaData	object	No	Other information.	null
qaLibraryList	array	No	A list of Q&A library IDs.
	string	No	The Q&A library ID.	d86a4b9cd3
requestId	string	Yes	The request ID.	ebf83826-dc1c-46f8-9759-0fb6da4c8xxx
enableLibrary	boolean	No	Specifies whether to enable the intent library.	false
selfDirected	boolean	No	Specifies whether to enable autonomous Q&A.	false

Response elements

Element	Type	Description	Example
	object	Result code:
success	boolean	Indicates whether the request was successful.	true
dataType	string	The data type.	null
time	string	The timestamp.	2024-01-01 00:00:00
errCode	string	The error code.	0
message	string	The error message.	ok
data	object	The response data.
sessionId	string	The session ID.	1728545917713234
openingRemarks	string	The opening remarks.	你好，我是XX客服人员。
requestId	string	The request ID.	003D019A-1BB3-53EC-A0D2-CE76DA5D73B1
cost	integer	The time consumed.	null

Examples

Success response JSON format

{
  "success": true,
  "dataType": "null",
  "time": "2024-01-01 00:00:00",
  "errCode": "0",
  "message": "ok",
  "data": {
    "sessionId": "1728545917713234",
    "openingRemarks": "你好，我是XX客服人员。"
  },
  "requestId": "003D019A-1BB3-53EC-A0D2-CE76DA5D73B1",
  "cost": 0
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.

​Try it now

​RAM authorization

​Request syntax

​Path Parameters

​Request parameters

​Response elements

​Examples

​Error codes

​Release notes