Getting Started
This guide explains how to make your first authenticated call to the UpTalkTV API and where to find the Realtime Chatting API docs. The most important part of the flow is the two-step authentication:
-
POST to
/api/userto initiate auth and get a token/verification context. -
POST to
/api/user/verifyto confirm the code you received and get the real auth token you’ll use on subsequent requests.
The official reference is here: https://docs.uptalktv.com/api-reference
The realtime chat API is here: https://realtime.uptalktv.com
1. Prerequisites
-
Base URL: the realtime docs show the platform is served from
api.uptalktv.com(WebSocket is atwss://api.uptalktv.com). It’s safe to assume the REST endpoints live under the same host, e.g.https://api.uptalktv.com. -
HTTP client:
curl, Postman, or your backend’s HTTP library.
2. Authentication Flow
-
Start Authentication
Request (example):
curl -X POST https://api.uptalktv.com/api/user \ -H "Content-Type: application/json" \ -d '{ "email": "you@example.com", "phoneNumber": "+447111111111" }'
What this does:-
Tells UpTalkTV “I want to log in / identify as this user.”
-
Sends the verification code to the email provided.
-
-
Verify User
Once you have the verification code (e.g.
123456), call/api/user/verify:curl -X POST https://api.uptalktv.com/api/user/verify \ -H "Content-Type: application/json" \ -d '{ "code": "123456", "email": "you@example.com" }'
What you get back:-
This is the moment you get the real authentication token (often a JWT or bearer token).
-
This is the token you must put in the
Authorizationheader for all protected endpoints.
-
3. Calling authenticated endpoints
Once you have the final token from /api/user/verify, send it like this:
curl https://api.uptalktv.com/api/chat \
-H "Authorization: Bearer YOUR_FINAL_TOKEN_HERE"
General rules:
-
Header name:
Authorization -
Format:
Bearer <token> -
Use this on any endpoint in the reference that is marked “requires authentication.”
4. Realtime Chatting API (WebSocket)
UpTalkTV also exposes a realtime/chat layer described here:
👉 Realtime docs: https://realtime.uptalktv.com
A typical integration looks like this:
-
Use the REST flow above to authenticate and obtain a user/device token.
-
Open a WebSocket to
wss://api.uptalktv.com. -
Subscribe to the chat channel described in that realtime doc (it lists topics like “Send a message to a specific chat” and “Get messages from a specific chat and be added to this chat”).
-
Send messages in the format the realtime doc specifies.