DescribeGlobalQuestion-阿里云帮助中心

Retrieves the details of a global question in a legacy canvas script.

Operation description

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

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

outboundbot:DescribeGlobalQuestion

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance.	7cefbff0-8d50-4d6f-b93c-73cee23c1555
ScriptId	string	Yes	The ID of the script.	b7ee988b-2837-4bc1-9d56-f76e7c831f60
GlobalQuestionId	string	Yes	The ID of the global question.	e851e242-ad67-4507-96a2-d4114564dcec

Response elements

Element	Type	Description	Example
	object
HttpStatusCode	integer	The HTTP status code.	200
Code	string	The status code.	OK
Message	string	The returned message.	Success
RequestId	string	The request ID.	254EB995-DEDF-48A4-9101-9CA5B72FFBCC
Success	boolean	Indicates whether the request was successful.	true
GlobalQuestion	object	The details of the global question.
GlobalQuestionId	string	The ID of the global question.	f160ec2e-94f2-4c03-87be-ece5b52d5dd9
Answers	string	The answers to the global question.	["你好,我是你的专属客服顾问."]
GlobalQuestionType	string	The type of the global question.	COMMON
GlobalQuestionName	string	The name of the global question.	你是谁-全局问题
Questions	string	The questions mapped to this global question.	["你是谁","你叫什么"]
ScriptId	string	The ID of the script.	290e06a5-6de2-4cc8-8a9c-72b7c152256c

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "Success",
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Success": true,
  "GlobalQuestion": {
    "GlobalQuestionId": "f160ec2e-94f2-4c03-87be-ece5b52d5dd9",
    "Answers": "[\"你好,我是你的专属客服顾问.\"]",
    "GlobalQuestionType": "COMMON",
    "GlobalQuestionName": "你是谁-全局问题",
    "Questions": " [\"你是谁\",\"你叫什么\"]",
    "ScriptId": "290e06a5-6de2-4cc8-8a9c-72b7c152256c"
  }
}

Error codes

HTTP status code	Error code	Error message
500	InternalError	An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.
404	NotExist.Instance	The specified Instance does not exist.
404	NotExist.Script	The specified Script does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.