CreateChatSession - 创建实时数字人会话

创建实时数字人会话。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
lingmou:CreateChatSessioncreate
*全部资源
*

请求语法

POST /openapi/chat/init/{id} HTTP/1.1

请求参数

名称类型必填描述示例值
idstring

即对话数字人的项目 ID,通过灵眸控制台对话互动页面点击对话项目右下角更多选项查看。

C1gttTrdX7l98YCPck7Jr-iA
licensestring

灵眸平台颁发的个人凭证(在使用端渲染数字人的场景下必填)。

b9be4b25c2d38c409c376ffd2372be1
platformstring

运行 SDK 的平台(在使用端渲染数字人的场景下必填)。

枚举值:
  • WebWeb
  • iOSiOS
  • AndroidAndroid
Web | Android | iOS
instanceIdstring

需要在数字人实时交互服务购买完成对应的服务购买,当前有可用的服务时,前往阿里云-我的订单页面对应订单详情下进行查询

rmq-cn-9t946y43m1d

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

请求 ID

7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8
messagestring

状态码描述。

success
httpStatusCodelong

http 响应码

200
dataobject

响应数据。

sessionIdstring

会话 ID

9827f4bd-5008-4d34-98fb-62598f3ad3b5
rtcParamsobject

RTC 入参。

appIdstring

应用 id。

895cbf3b
avatarUserIdstring

数字人侧用户 ID。

E7enIvjUos
channelstring

RTC 通道 ID。

pPltqR3FovNCK3hNQc8eHUL3Ztq1wY
clientUserIdstring

客户端侧用户 ID。

aw0tqpFlP4
gslbstring

RTC 服务地址。

https://gw.rtn.aliyuncs.com
noncestring

随机串。

f8b0ef02c5da778f4488e2470c
serverUserIdstring

服务端侧用户 ID。

YzZtSQP8QX
timestamplong

过期时间戳。

1560588594
tokenstring

访问凭证 token。

PtGgv2dM9F8tEuAtda50c0VNNFjn0WUbyTDRPa1im4cUBEcxlo
avatarAssetsobject

端渲染数字人资产信息。

urlstring

资产下载链接。

https://daily-avatar-property.oss-cn-beijing.aliyuncs.com/avatar-share-property/AVATAR_3D_TRADITIONAL/Mt.CNMU6BO4RBYU2/secret_assets_web.zip?Expires=1752637519&OSSAccessKeyId=STS.NZULzwLRx8thHDHQxem94dWdN&Signature=Oni3%2Be8dY8Xrv3iRGDyzn7uReVc%3D&security-token=CAISzAJ1q6Ft5B2yfSjIr5ngB8DDoY1Zj7aDSmL5tXgwYbYYi5LPrDz2IHhMfnloB%2BEcsfU3nmxT6vkZlrp6SJtIXleCZtF94oxN9h2gb4fb4093DEHt08%2FLI3OaLjKm9u2wCryLYbGwU%2FOpbE%2B%2B5U0X6LDmdDKkckW4OJmS8%2FBOZcgWWQ%2FKBlgvRq0hRG1YpdQdKGHaONu0LxfumRCwNkdzvRdmgm4NgsbWgO%2Fks0KA1QSml7ZP%2B9WuesH0M%2FMBZskvD42Hu8VtbbfE3SJq7BxHybx7lqQs%2B02c5onHUwEPsk%2FZYrKOroYzc1RjAbM%2FErRY6fP8nOE9ovbUm5RXHpT05CrMOs62ZPdDoKOscIvBXr6yZaP7JmcGC6iQLG%2FznQkSc081IsK2C7Xq0pe54O3lg9Ab41ZGNYEjq%2BpCIUP%2Fs97dqXEelD2e%2Bh8UezDnKxqAAXuAiYRY7Ox3cf6h2MlmRsK5yywg45O%2FizjiK2k8Z8p6WeOA54W3pfbg6ElV4d8TMWCVZ7tuAbSgRCKBg3q5YYrdS2ENqDu6njIea1pxG4LT4ydGxDBkYpjwcUxutDd0aAhFjsypSK%2Feuk0%2FDCfKMrWzCmkr1AtPpcNfJ8LPj58qIA
md5string

资产 MD5 值。

5B83BE2114489274BB88BADE7EBC9BC0
secretstring

SDK 使用的密钥。

J562PNqJBZDhzOQpLBgIcIW8+rHQoM7P6IONGMP7P5vGxrWLxT7VtRenFnMY+wg/zpA2qwpFBmJYO2rVexnlCQ2WE4kvYOH/OKmlTzpQddY34U5jS9KaS3b3ulpq4xnKDjWJ+sLZSRMhuPDdlq8ZPfcfEPhJhF3zPO8Hu4QOSu+D/pAIDJUoixOTo9Q14DXFKGFuuVRQOQ7f/VxJcoSLIWIusV917pLtph/IYBaLd27gzbrTZBEVD8qrucR+WOQPY1g67PGAdafkhJWrs/+coM7+5dc3HEUC+KgI9JN4X4Akelc94aJcy78RZ6tRdr73hBzN83/cMZdzt2hxnjzg==
typestring

资产类型。

AVATAR_3D_TRADITIONAL
minRequiredVersionstring

支持的 SDK 最低版本。

0.0.1
codestring

响应码。

200
successboolean

请求是否成功

枚举值:
  • TrueTrue
  • FalseFalse
True

示例

正常返回示例

JSON格式

{
  "requestId": "7239F9E5-A4DB-55BA-B701-0CE47DBDB0A8",
  "message": "success",
  "httpStatusCode": 200,
  "data": {
    "sessionId": "9827f4bd-5008-4d34-98fb-62598f3ad3b5",
    "rtcParams": {
      "appId": "895cbf3b",
      "avatarUserId": "E7enIvjUos",
      "channel": "pPltqR3FovNCK3hNQc8eHUL3Ztq1wY",
      "clientUserId": "aw0tqpFlP4",
      "gslb": "https://gw.rtn.aliyuncs.com",
      "nonce": "f8b0ef02c5da778f4488e2470c",
      "serverUserId": "YzZtSQP8QX",
      "timestamp": 1560588594,
      "token": "PtGgv2dM9F8tEuAtda50c0VNNFjn0WUbyTDRPa1im4cUBEcxlo"
    },
    "avatarAssets": {
      "url": "https://daily-avatar-property.oss-cn-beijing.aliyuncs.com/avatar-share-property/AVATAR_3D_TRADITIONAL/Mt.CNMU6BO4RBYU2/secret_assets_web.zip?Expires=1752637519&OSSAccessKeyId=STS.NZULzwLRx8thHDHQxem94dWdN&Signature=Oni3%2Be8dY8Xrv3iRGDyzn7uReVc%3D&security-token=CAISzAJ1q6Ft5B2yfSjIr5ngB8DDoY1Zj7aDSmL5tXgwYbYYi5LPrDz2IHhMfnloB%2BEcsfU3nmxT6vkZlrp6SJtIXleCZtF94oxN9h2gb4fb4093DEHt08%2FLI3OaLjKm9u2wCryLYbGwU%2FOpbE%2B%2B5U0X6LDmdDKkckW4OJmS8%2FBOZcgWWQ%2FKBlgvRq0hRG1YpdQdKGHaONu0LxfumRCwNkdzvRdmgm4NgsbWgO%2Fks0KA1QSml7ZP%2B9WuesH0M%2FMBZskvD42Hu8VtbbfE3SJq7BxHybx7lqQs%2B02c5onHUwEPsk%2FZYrKOroYzc1RjAbM%2FErRY6fP8nOE9ovbUm5RXHpT05CrMOs62ZPdDoKOscIvBXr6yZaP7JmcGC6iQLG%2FznQkSc081IsK2C7Xq0pe54O3lg9Ab41ZGNYEjq%2BpCIUP%2Fs97dqXEelD2e%2Bh8UezDnKxqAAXuAiYRY7Ox3cf6h2MlmRsK5yywg45O%2FizjiK2k8Z8p6WeOA54W3pfbg6ElV4d8TMWCVZ7tuAbSgRCKBg3q5YYrdS2ENqDu6njIea1pxG4LT4ydGxDBkYpjwcUxutDd0aAhFjsypSK%2Feuk0%2FDCfKMrWzCmkr1AtPpcNfJ8LPj58qIA",
      "md5": "5B83BE2114489274BB88BADE7EBC9BC0",
      "secret": "J562PNqJBZDhzOQpLBgIcIW8+rHQoM7P6IONGMP7P5vGxrWLxT7VtRenFnMY+wg/zpA2qwpFBmJYO2rVexnlCQ2WE4kvYOH/OKmlTzpQddY34U5jS9KaS3b3ulpq4xnKDjWJ+sLZSRMhuPDdlq8ZPfcfEPhJhF3zPO8Hu4QOSu+D/pAIDJUoixOTo9Q14DXFKGFuuVRQOQ7f/VxJcoSLIWIusV917pLtph/IYBaLd27gzbrTZBEVD8qrucR+WOQPY1g67PGAdafkhJWrs/+coM7+5dc3HEUC+KgI9JN4X4Akelc94aJcy78RZ6tRdr73hBzN83/cMZdzt2hxnjzg==",
      "type": "AVATAR_3D_TRADITIONAL",
      "minRequiredVersion": "0.0.1"
    }
  },
  "code": 200,
  "success": true
}

错误码

访问错误中心查看更多错误码。