v2.livestream.get_session_detail
GET /api/v2/livestream/get_session_detail
Get basic information about the live streaming room, including cover, title, description, type (test live or normal live), create time, update time, stream url, etc. (For TW, ID, TH, PH, MY, SG, VN)
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/livestream/get_session_detail
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 |
|---|---|---|---|---|
| session_id | int64 | True | 6236215 | The identifier of livestream session. |
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 | 6236215 | The identifier of livestream session. |
| title | string | test title | The title of the livestream session. |
| description | string | test description | The description of the livestream session. |
| cover_image_url | string | https://cf.shopee.sg/file/id-11134104-7r98o-m9y7ly25ngg927 | The cover image URL of the livestream session. |
| status | int32 | 1 | The status of the livestream session, the enumeration values are as follows: 0 - Initial 1 - Ongoing 2 - Ended |
| share_url | string | https://live.test.shopee.co.id/share?from=live&session=6905656 | The share link of the livestream session. |
| is_test | boolean | false | Indicate whether this livestream session if for testing purpose only. |
| create_time | int64 | 1747651742003 | The creation time of the livestream session. It's unix timestamp in seconds. |
| update_time | int64 | 1747651742003 | The update time of the livestream session. It's unix timestamp in seconds. |
| start_time | int64 | 1747651742003 | The start time of the livestream session, 0 if session is not started yet. It's unix timestamp in seconds. |
| end_time | int64 | 1747651742003 | The end time of livestream session, 0 if session is not ended yet. It's unix timestamp in seconds. |
| stream_url_list | object | ||
| push_url | string | rtmp://push-zl.lvb.test.shopee.co.id/live | The push stream url for the livestream session. |
| push_key | string | id-test-1987885338002432-6905656?zlSecret=61ef843a6d8e48357ac3d94db52447bf&zlTime=682FF4B1&pushDomain=push-zl.lvb.test.shopee.co.id&cdnID=ZENLAYER&session_id=6905656 | The push stream key for the livestream session. |
| play_url | string | http://play-zl.livestream.test.shopee.co.id/live/id-test-1987885338002432-6905656.flv?auditkey=1.0~9EzaSlc1o3iNfkh\_yixD-7yKuXaLPvJNR3CXbUw\_8mN08xmA2QEcpACaVOBSP61kDO4cbhwVwM5B10kAms4mgKsTQJS-ji50MBDkH-m81cE~e298bae2599bf1447f21131e2d73a6baf97bd9edcbe460a17e09cdce2c80c40d&cdnID=ZENLAYER&expire\_ts=1747714157 | The pull stream url of the livestream session. |
| domain_id | int64 | 57 | The identifier of the stream domain, need to be passed in request for v2.livestream.start_session. |