v2.livestream.create_session
POST /api/v2/livestream/create_session
Create a new live stream, include basic information, like cover, title, description, type (test live or normal live). (For TW, ID, TH, PH, MY, SG, VN)
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/livestream/create_session
Common Request Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| partner_id | int | 1 | Partner ID is assigned upon registration is successful. Required for all requests. |
| timestamp | timestamp | 1610000000 | This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes. |
| access_token | string | c09222e3fc40ffb25fc947f738b1abf1 | The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours. |
| user_id | int | 1 | Shopee's unique identifier for a user. |
| sign | string | e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2 | Signature generated by(depends on different APIs) partner_id, api path, timestamp, access_token, user_id and partner_key via HMAC-SHA256 hashing algorithm. |
Request Parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| title | string | True | test livestream | The title of livestream session, cannot exceed 200 characters. |
| description | string | False | test | The description of livestream session, cannot exceed 200 characters. |
| cover_image_url | string | True | https://cf.shopee.sg/file/id-11134104-7r98o-m9pq7jw2cdhx5e | The cover image URL of livestream session. Please call the v2.livestream.upload_image to upload the cover image file and get the cover_image_url. |
| is_test | boolean | False | false | Indicate whether the livestream session is for testing purpose only. |
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| error | string | Indicate error type if hit error. Empty if no error happened. | |
| message | string | Indicate error details if hit error. Empty if no error happened. | |
| request_id | string | e3e3e7f3360690a5b55f0689f8a4e801 | The identifier for an API request for error tracking. |
| response | object | Detail informations you are querying. | |
| session_id | int64 | 636732 | The identifier of livestream session. |