LIliveavatar
Sessions

Stop Session

Changed on

Stop a session

post/v1/sessions/stop

Request

  • Base URL
    https://api.liveavatar.com
  • URL
    https://api.liveavatar.com/v1/sessions/stop
  • Auth
    • API key in header X-API-KEY
    • or HTTP bearer

Request body

session_idstring uuid
reason'UNKNOWN' | 'USER_DISCONNECTED' | 'SERVER_ERROR' | 'IDLE_TIMEOUT' | 'NO_CREDITS' | 'USER_CLOSED' | 'AVATAR_DELETED' | 'MAX_DURATION_REACHED' | 'ZOMBIE_SESSION_REAP' | 'AGENT_HANG_UP' | 'DISPATCH_FAILED'

Response

Successful Response

codeinteger
dataunknown
messagestring

Changes

  • 8bc38e64ff31Revision changes
    • breaking

      the response property became nullable for the status

    • info

      added the new DISPATCH_FAILED enum value to the request property