Referencia de la API HappyOyster-Acting-Enter Travel - Alibaba Cloud Model Studio

El cliente utiliza el ticket para crear un viaje real y obtener la configuración de unión RTC, la versión de capacidad de Acting y la relación de aspecto del reproductor. Una llamada exitosa crea el viaje.

Ámbito

El cliente utiliza el ticket para crear un viaje real y obtener la configuración de unión RTC, la versión de capacidad de Acting y la relación de aspecto del reproductor. Antes de llamar, confirme lo siguiente:

Autenticación: La API Key principal no es obligatoria; el ticket completa la validación de entrada a la sala. Para saber cómo obtenerla, consulte Obtener credenciales de autenticación.
Requisitos previos: El ticket se obtiene de Obtener credencial de viaje, no ha caducado y no se ha utilizado, y el estado de su mundo es ready.
Solicitante: Invocado por su cliente.

Solicitud HTTP

Singapore

POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/travels/enter-travel

Reemplace {WorkspaceId} con su ID de espacio de trabajo real.

EE. UU. (Virginia)

POST https://{WorkspaceId}.us-east-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/travels/enter-travel

Reemplace {WorkspaceId} con su ID de espacio de trabajo real.

Parámetros de solicitud	Entrar al viaje (cliente) `curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/travels/enter-travel' \ -H "Authorization: Bearer $DASHSCOPE_API_KEY" \ -H 'Content-Type: application/json' \ -d '{ "ticket": "{ticket}" }'`
Content-Type`string`(Requerido) Tipo de contenido de la solicitud. Este parámetro debe establecerse en `application/json`.
Authorization `string` (Requerido) Autenticación mediante clave de API. No se requiere la clave de API principal; pueden invocarla tanto la clave principal como una temporal. Clave de API principal: comienza con `sk-`, por ejemplo, `sk-xxx`. Clave de API temporal: comienza con `st-`, por ejemplo, `st-xxx`.
Cuerpo de la solicitud
ticket `string` (Obligatorio) Una credencial de un solo uso, no caducada y no utilizada, obtenida de Obtener credencial de viaje. Reutilizar el mismo `ticket` devuelve `401011`.

NotaActing no consume maxExperienceTimeSec; no lo pase. Si aun así se pasa un nivel no válido, se devuelve 400000 antes del enrutamiento del modelo.

Parámetros de respuesta

Entrada exitosa

{
    "code": 0,
    "message": null,
    "data": {
        "encryptedTravelId": "trvl_a1b2****",
        "encryptedWorldId": "enc_a1b2****",
        "mode": 3,
        "creationModel": "simple",
        "playUrl": null,
        "firstFrame": "https://cdn.happyoyster.com/frames/acting_world_xyz789.jpg",
        "rtcConfig": {
            "channelId": "stream_abc123",
            "appId": "18bca2e3218c46aebf8ff3a32fb12311",
            "token": "007eJxTYOh...",
            "userId": "user_1"
        },
        "version": "actingV2",
        "aspectRatio": "9:16",
        "noStreamAutoEndTimeoutSec": 30,
        "maxExperienceTimeSec": null
    }
}

code integer

Código de retorno. 0 indica éxito; un valor distinto de cero es un código de error.

message string

Mensaje de error. null en caso de éxito.

data object

Datos de respuesta. null en caso de fallo.

Propiedades

encryptedTravelId string

El nuevo ID de viaje cifrado creado. Se utiliza para consultas posteriores de Consultar estado del viaje, pausa, reanudación, finalización y artefactos.

encryptedWorldId string

El ID de mundo cifrado al que corresponde este viaje.

mode integer

Siempre 3 para Acting.

creationModel string

Siempre simple para Acting.

playUrl null

Aún no disponible; fijado en null.

firstFrame string

URL del primer fotograma del mundo.

rtcConfig object

Configuración de unión RTC; null cuando no hay ningún canal de transmisión disponible, en cuyo caso el cliente no puede iniciar la reproducción basándose en ella.

channelId: ID de canal RTC
appId: ID de aplicación RTC asignado por la plataforma
token: token de unión RTC
userId: ID de usuario de unión RTC, fijado en user_1

version string

La versión de entrada a sala de Acting, fijada en actingV2. Las interfaces de control deben invocarse según esta versión.

aspectRatio string

Relación de aspecto. El cliente debe configurar la orientación del reproductor en consecuencia antes de extraer el flujo:

9:16 (vertical)
16:9 (horizontal)

noStreamAutoEndTimeoutSec integer

Tiempo de espera de finalización automática sin flujo en segundos, por defecto 30; prevalece la respuesta real. Si rtcStatus no entra en el estado de transmisión dentro de este tiempo después de entrar en la sala, llame a Finalizar viaje con failCode=TRAVEL_NO_STREAM_AUTO_END.

maxExperienceTimeSec null

Acting no utiliza la duración máxima de experiencia; fijado en null.

Estados previos y notas de llamada

El mundo correspondiente al ticket debe estar ready, y el ticket no debe haber caducado ni haber sido utilizado.
Una llamada exitosa crea el viaje; reutilizar el mismo ticket devuelve 401011.
Cuando la función o especificación de Acting no está habilitada, se devuelve 403007 y no se crea ningún viaje.
version debe tratarse como actingV2; no invoque interfaces de control según otra versión de capacidad.
El cliente debe leer aspectRatio antes de establecer la extracción de flujo o el contenedor de renderizado: use un contenedor vertical para 9:16 y un contenedor horizontal para 16:9.
No pase maxExperienceTimeSec. Acting no finaliza automáticamente por este campo, y el cliente no debe usarlo para implementar una cuenta regresiva.
rtcConfig=null significa que actualmente no hay ningún canal de transmisión disponible, y el cliente no puede iniciar la reproducción basándose en él.

Códigos de error

Si la llamada al modelo falla y devuelve un error, consulte Códigos de error de HappyOyster para resolverlo.

Siguientes pasos

Después de entrar en la sala correctamente:

Consultar estado del viaje: sondee cada 2–5 segundos; puede enviar instrucciones cuando el viaje esté en running o paused.
Enviar instrucción de proceso: dirigir la representación de juego de roles posterior.
Pausar viaje / Reanudar viaje: controle el ritmo de ejecución según sea necesario.
Finalizar viaje: al finalizar, entra en completed y comienza el procesamiento de artefactos.