# Douyin Barrage WSS XB Signature API

> Returns a signed xb parameter for Douyin web barrage WebSocket connections using a specified room ID, user browser agent, and unique user identifier.

Source: https://www.sandbase.ai/model/douyin/web/generate-wss-xb-signature
API reference: https://www.sandbase.ai/model/douyin/web/generate-wss-xb-signature/docs

## Facts

- Provider: Douyin
- Type: Data API
- Endpoint: `POST https://api.sandbase.ai/v1/api/douyin/web/generate-wss-xb-signature`
- Price: $0.0015 per call
- Free allowance: 100 calls per organization per UTC day, shared across eligible APIs
- Capabilities: api, douyin
- Billing: pay per use from one SandBase balance; no provider account or subscription needed

## Call it

`POST https://api.sandbase.ai/v1/api/douyin/web/generate-wss-xb-signature` with `Authorization: Bearer $SANDBASE_API_KEY` and the parameters as a JSON body.

| Parameter | Type | Required | Allowed values |
| --- | --- | --- | --- |
| `room_id` | string | yes |  |
| `user_agent` | string | yes |  |
| `user_unique_id` | string | yes |  |

## FAQ

### How do I use the Douyin Barrage WSS XB Signature API?

Send a POST request to https://api.sandbase.ai/v1/api/douyin/web/generate-wss-xb-signature with your SandBase API key in the Authorization header (Bearer) and the parameters as a JSON body. You can also try it in the Playground on this page without writing code.

### How much does the Douyin Barrage WSS XB Signature API cost?

$0.0015 per call. Every organization gets 100 free calls per UTC day, shared across eligible SandBase APIs including this one; after that each call is billed at this price from your SandBase balance. There is no subscription.

### What parameters does the Douyin Barrage WSS XB Signature API accept?

Required: room_id (string), user_agent (string) and user_unique_id (string). The Parameters table and the Playground on this page list every field.

### What does the Douyin Barrage WSS XB Signature API return?

A JSON response returned in the same HTTP request (synchronous).

### Do I need a Douyin developer account or API key?

No. Douyin Barrage WSS XB Signature runs through SandBase, so one SandBase API key covers this endpoint and every other API and model in the catalog. You do not need to apply for Douyin API access separately.

## README

### Douyin Barrage WSS XB Signature API

This endpoint produces an xb signature required for Douyin web barrage stream connections. Supply `room_id`, `user_agent`, and `user_unique_id` to obtain the signature value.

#### Use cases

- Obtaining signature parameters for web barrage connections.
- Connecting to Douyin chat streams with valid browser headers.
- Authenticating WebSocket sessions using a room identifier.

#### Request

```bash
curl -X POST "https://api.sandbase.ai/v1/api/douyin/web/generate-wss-xb-signature" \
  -H "Authorization: Bearer $SANDBASE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"room_id": "<room_id>", "user_agent": "<user_agent>", "user_unique_id": "<user_unique_id>"}'
```

#### Parameters

| Name | Type | Required | Description |
|---|---|---|---|
| `room_id` | string | Yes | Room ID |
| `user_agent` | string | Yes | User browser agent |
| `user_unique_id` | string | Yes | User unique ID |

#### Notes

- `room_id` is required to specify the target room.
- Supply `user_agent` corresponding to the client browser environment.
- `user_unique_id` represents the unique viewer identifier.

#### Related APIs

- [Douyin Batch Video ID Extraction](/model/douyin/web/all-aweme-id): Extracts video IDs from a list of Douyin video URLs.
- [Douyin sec_user_ids from URLs (Batch)](/model/douyin/web/all-sec-user-id): Extracts Douyin sec_user_id values in bulk from a list of user homepage URLs.
- [Douyin Webcast ID Extraction](/model/douyin/web/all-webcast-id): Extracts webcast IDs from a submitted list of Douyin live room links.
