POST Chat

Touch Session ("keep alive")

Users who are not active will automatically exit the room.

POST /api/v3/{appid}/chat/rooms/{roomid}/sessions/{userid}/touch

Users who are not active will automatically exit the room. This method lets the room know that the user is still active so the user doesn't need to rejoin. The SDKs will do this for you automatically.

You can configure a room to not auto-expire sessions in the settings for that room.

Request

Parameters

Values in the path and query string.

appid path

string TalkLabs ID required

The TalkLabs application ID assigned to your account.

Example: your-app-id

roomid path

string TalkLabs ID required

The TalkLabs assigned room ID returned when the room was created.

Example: room-id

userid path

string customer-defined required

The customer defined user ID from your application or identity system.

Example: u-8842

Response

Status codes

Every JSON response uses the API result envelope.

200 OK ApiResult

400 Bad Request ApiResult

403 Forbidden ApiResult

404 Not Found ApiResult

500 Internal Server Error ApiResult

curl --request POST \
  --url "https://api.sportstalk247.com/api/v3/${APP_ID}/chat/rooms/${ROOM_ID}/sessions/${USER_ID}/touch" \
  --header "Accept: application/json" \
  --header "x-api-token: ${TALKLABS_API_TOKEN}"

const appId = process.env.TALKLABS_APP_ID;
const roomid = 'room-id';
const userid = 'u-8842';

const response = await fetch(
  `https://api.sportstalk247.com/api/v3/${appId}/chat/rooms/${roomid}/sessions/${userid}/touch`,
{
  method: 'POST',
  headers: {
    Accept: 'application/json',
    'x-api-token': process.env.TALKLABS_API_TOKEN,
  },
});

const result = await response.json();

import json
import os
import requests

app_id = os.environ["TALKLABS_APP_ID"]
roomid = "room-id"
userid = "u-8842"

response = requests.post(
    f"https://api.sportstalk247.com/api/v3/{app_id}/chat/rooms/{roomid}/sessions/{userid}/touch",
    headers={
        "Accept": "application/json",
        "x-api-token": os.environ["TALKLABS_API_TOKEN"],
    },
)
response.raise_for_status()
result = response.json()

Environment variables TALKLABS_APP_ID TALKLABS_API_TOKEN

Response