Knowledge Base

/session-create

POST https://{na,eu,ap}-api.teamspeaksdk.com/session-create

Definition

Creates a voice session on the region associated with the api endpoint you are posting to. 

 

Header includes:

X-API-KEY: YOUR-KEY-HERE

Body

{
    "CustomerLabel": "Raid #208052098",
    "MaxUsers": "10",
    "SDKVersion": "3.0.4"
}

Response

{
    "CustomerLabel": "Raid #208052098",
    "MaxUsers": 10,
    "ApiKey": "******",
    "SessionId": "na-64a6a6-e10b38-d8bb48-5be140-92cdf4",
    "Password": "98d05-6f115-a2fce-12bbb-e6936-0649c",
    "UDPPort": 13808,
    "Region": "na",
    "Hostname": "144.217.11.226",
    "Message": "Created session."
}

Example Error Response

{
    "Message": "Bad request - paramater not set."
}

{
    "Message": "Cannot have greater than 10 MaxUsers per voice server on a limited account."
}

{
    "Message": "No Instances available hosting that SDKVersion."
}

{
    "Message": "Failed to create voice session."
}

Please rate this article to help us improve our Knowledge Base.

0 0