GetTextbookAssistantToken

更新时间:
复制 MD 格式

Obtains an authorization token to make API calls.

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

aicontent:GetTextbookAssistantToken

get

*All Resource

*

None None

Request syntax

POST /api/v1/textbookAssistant/teachingResource/GetToken HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

body

object

No

The request body.

deviceId

string

Yes

The device ID.

700d4d9411efbe6e0

model

string

Yes

The device model.

25032PS56C

Response elements

Element

Type

Description

Example

object

The schema of the response.

requestId

string

The request ID.

0A5E9849-A2F0-551D-A7D8-1A8118557BAB

success

boolean

Indicates whether the API call succeeded.

  • true: The API call succeeded.

  • false: The API call failed.

true

errCode

string

The error code.

0

errMessage

string

The error message.

未知错误

httpStatusCode

integer

The HTTP status code.

200

data

object

The data object.

expire

integer

The expiration time of the authorization token, in seconds.

5400

authToken

string

The authorization token. Use this token to make API calls to the English textbook-style AI teacher service.

tc_197bf5bb81889cc79eb51ae9b8c0cea3

Examples

Success response

JSON format

{
  "requestId": "0A5E9849-A2F0-551D-A7D8-1A8118557BAB",
  "success": true,
  "errCode": "0",
  "errMessage": "未知错误",
  "httpStatusCode": 200,
  "data": {
    "expire": 5400,
    "authToken": "tc_197bf5bb81889cc79eb51ae9b8c0cea3"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.