Skip to main content
POST
Close Session
See Session errors for the error codes session endpoints return.

Authorizations

Authorization
string
header
required

Your Vivix API key. Keep it on your server.

Path Parameters

session_id
string
required

Identifier of the Streaming Avatar session to close.

Body

application/json
close_reason
string

Caller-defined reason stored as the session close reason.

Response

200 - application/json

Success

code
integer
required

0 on success; any other value is an error code.

message
string
required

success, or an English error description.

data
object
required