HappyOyster-Acting-Resume Travel API Reference

​

Scope

• Authentication: The primary API Key is not required; either the primary or a temporary API Key can call it. For how to obtain them, see Obtain authentication credentials.
• Prerequisites: The Travel must be confirmed as paused via Query Travel Status.
• Caller: Either your server or your client can call it.

​

HTTP request

curl --location 'https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/api/v2/apps/happyoyster-1.0-acting/openapi/v1/travels/resume' \
    -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
    -H 'Content-Type: application/json' \
    -d '{
    "encryptedTravelId": "{encryptedTravelId}",
    "userAgent": "HappyOyster-Web/1.2.0"
}'

{
    "code": 0,
    "message": null,
    "data": {
        "encryptedTravelId": "trvl_a1b2****",
        "status": "running"
    }
}

​

Prerequisite states and call notes

• The Travel must be confirmed as paused via Query Travel Status.
• The version in the enter-room response must be actingV2.
• A Travel that has already ended or failed cannot be resumed.
• After resuming, you can continue to send text process instructions; the client should converge its local running state based on the status query result.
• Resuming does not change the aspectRatio returned when entering the room.

​

Error codes

​

Next steps

• Query Travel Status: confirm the Travel is back to running.
• Send Process Instruction: continue to drive the role-play.
• End Travel: end the session and process artifacts.