Cancel a session

POST

/v1/sessions/{id}/cancellations

Cancels an in-flight or pending session using the shared service contract.

请求参数

Path 参数

Body 参数application/json必填

示例

{
    "sessionID": "11111111-1111-1111-1111-111111111111",
    "reason": "user_cancelled"
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/v1/sessions//cancellations' \
--header 'Content-Type: application/json' \
--data '{
    "sessionID": "11111111-1111-1111-1111-111111111111",
    "reason": "user_cancelled"
}'

返回响应

🟢200成功

application/json

Session cancelled.

Bodyapplication/json

示例

{
    "endpoint": "POST /v1/sessions/{id}/cancellations",
    "session": {
        "id": "11111111-1111-1111-1111-111111111111",
        "userID": "local-user-001",
        "workflow": "dictation",
        "status": "canceled",
        "capabilitySnapshot": {
            "allowsRealtime": true,
            "allowsRefine": true,
            "allowsInsert": true
        },
        "providerRoute": {
            "asrProvider": "aliyun.realtime.asr",
            "refineProvider": "aliyun.refine"
        },
        "createdAt": "2026-04-01T16:19:40Z",
        "startedAt": "2026-04-01T16:19:45Z",
        "endedAt": "2026-04-01T16:20:00Z",
        "recordingDurationSeconds": 18.4,
        "partialTranscript": "hey can you help me rewrite",
        "finalTranscript": "hey can you help me rewrite this note",
        "refinedText": "Could you help me rewrite this note?",
        "billingStatus": {
            "state": "quota_consumed",
            "quotaSource": "pro",
            "consumedSeconds": 18.4,
            "updatedAt": "2026-04-01T16:20:00Z"
        },
        "privacyFlags": {
            "values": [
                "audit_trail_recorded"
            ]
        }
    }
}

修改于 2026-08-26 04:04:36

Mark a session as inserted

Read dedicated realtime gateway health