# [Mini Program Live] Management Interface of Live Broadcast Room

# I. Introduction

Live room management interface, is the Mini Program live to provide developers to live room for batch operation interface capabilities. Developers can create a live room, access live room information, get live room playback, and import goods into the live room.

# Second, the interface document

# 1. Create a live studio

# Interface explaination:

Call this interface to create a live room, create a successful list of live room display

# Call frequency

Call quota: 10000 times/One day.

# Request method

POST

# Requested URL:

https://api.weixin.qq.com/wxaapi/broadcast/room/createaccess_token=

# Sample request parameters: json

{
      name: "Test live room 1,"  // Room Name
      coverImg: "",   // adopt uploadfile Upload, fill in mediaID
      startTime: 1588237130,   // Start time
      endTime: 1588237130 , // End time
      anchorName: "zefzhang1",  // Anchor nickname
      anchorWechat: "WxgQiao_04",  // Anchor WeChat account
      subAnchorWechat: "WxgQiao_03",  // Anchor vice number WeChat
      createrWechat: 'test_creater', // Founder's WeChat
      shareImg: "hw7zsntcr0rE-RBfBAaF553DqBk-J02UtWsP8VqrUh3tKu3jO_JwEO8n1cWTJ5TN" ,  //adopt uploadfile Upload, fill in mediaID
      feedsImg: "hw7zsntcr0rE-RBfBAaF553DqBk-J02UtWsP8VqrUh3tKu3jO_JwEO8n1cWTJ5TN",   //adopt uploadfile Upload, fill in mediaID
      isFeedsPublic: 1, // Whether to open the official collection, 1 Open, 0 Stop
      type: 1 , // Live stream type, 1 Pushing stream 0 Mobile Live
      closeLike: 0 , // Turn off Like 1: Closed
      closeGoods: 0, // Whether to close the goods shelves, 1: closed
      closeComment: 0 // Whether to open a comment, 1: close
      closeReplay: 1 , // Turn off playback 1 Stop
      closeShare: 0,   //  Turn off sharing 1 Stop
      closeKf: 0, // Whether to close customer service, 1 Stop
}

# Request parameter meaning

# Return Examples Correctly

{
    "roomId": 33, //Room ID
    "errcode": 0,
    // When anchor WeChat is not in "Mini Program Live" Mini Program real-name authentication Returns this field
    "qrcode_url": "https://res.wx.qq.com/on_nothing/9rSix1dhHfK4rR049JL0PHJ7TpOvkuZ3mE0z7Ou_Etvjf-w1J_jVX0rZqeStLfwh"
} 

# Return Parameter Meaning

# 2. Get a list of live rooms

# Interface Dxplaination

Call this interface to get live room list and live room information

# Call frequency

Call quota: 100,000 times/One day (shared with get playback interface)

# Request method

POST

# Requested URL:

https://api.weixin.qq.com/wxa/business/getliveinfoaccess_token=

# Sample request parameters: json

{
    "start": 0, // Start pulling room, start = 0 Express from 1 A room began to pull
    "limit": 10 // The maximum number of pull each time, do not set too large, it is recommended 100 Inside
}

# Request parameter meaning

# Return Examples Correctly

{
    "errcode": 0,    // Error code, 0 is successful, 1 is not created live room
    "errmsg": "ok",   // Error message
    "total":1,
    "room_info":[{
        "name": "live room name"
        "roomid": 1,
        "cover_img":"http://http://Mmbiz.qpic.cn/mmbiz_jpgRl1RuhdstSfZa8EEljedAYcbtX3Ejpdl2et1tPAQ37bservicnxoVialDLCKDcPBy8Iic0kCiaiaalXg3EbpNKoicrweQ/0wx_fmt=jpeg",
        "share_img":"http://http://Mmbiz.qpic.cn/mmbiz_jpgRl1RuhdstSfZa8EEljedAYcbtX3Ejpdl2et1tPAQ37bservicnxoVialDLCKDcPBy8Iic0kCiaiaalXg3EbpNKoicrweQ/0wx_fmt=jpeg",
        "live_status": 101,
        "start_time": 1568128900,
        "end_time": 1568131200,
        "anchor_Name ": Reese " ，
        "goods":[{
            "cover_img":"http://http://Mmbiz.qpic.cn/mmbiz_jpg/Rl1RuhdstSfZa8EEljedAYcbtX3Ejpdl2et1tPAQ37bservicnxoVialDLCKDcPBy8Iic0kCiaiaalXg3EbpNKoicrweQ/0wx_fmt=jpeg",
            "url":"pages/index/index.html",
            "name": "cup,"
            "price": 1889,          // Price (cents)
            "price2": 0,
            "price_type": 1,        // Price type, 1: one price (only need to pass price, price 2 not pass) Price range (price field is left boundary, price 2 field is right border, price and price 2 must pass) 3: Display discount price (price field is original price, price 2 field is current price, Price and price 2 must pass)
            "goods_id": 256,        // Goods id 
            "third_party_Appid': "wx3d0fae56402d8a81" //Third Party Goods appid The current Mini Program item is empty
        }],
        "live_type": 0,				// Live stream type, 1 Pushing stream 0 Mobile Live
        "close_like": 0,			// Turn off Like [0: Open, 1: Close] (If closed, the audience will hide the "like" on, after the live broadcast is not allowed to open)
        "close_goods": 0,			// Whether to close the shelf [0: Open, 1: Close] (If closed, the audience will hide the goods shelf, after the live broadcast is not allowed to open)
        "close_comment": 0,			// Close your comments [0: Open, 1: Close] (If closed, the audience will hide the comment entry, after the live broadcast is not allowed to open)
        "close_kf": 1,				// Turn off customer service [0: on, 1: off] Turn off customer service by default (allow to turn on after the live broadcast)
        "close_replay": 1,			// Turn off playback [0: On, 1: Off] Playback is off by default (allowed after live stream starts)
        "is_feeds_public": 0,		// Whether to open the official collection, 1 Open, 0 Stop
        "creater_openid": "oawjt4t9NWZV2BYaEPA89sh1XblE", // Creator openid
        "feeds_img": "XXX"			// Official Cover
    }]
}

# Return Parameter Meaning

Room parameters

**Commodity parameter **

# 3. Get live room playback

# Interface Dxplaination

Call the interface to get the playback of the source video between the end of the live broadcast (generally generated within 10 minutes after the broadcast, source video no comments, etc.)

# Call frequency

Call quota: 100,000 times/One day.

# Request method

POST

# Requested URL:

https://api.weixin.qq.com/wxa/business/getliveinfoaccess_token=

# Sample request parameters: json

{
     "action": "get_replay",  
     "room_id": 354,   
     "start": 0,   
     "limit": 10        
}

# Request parameter meaning

# Return Examples Correctly

{
     "live_replay":[{
         "expire_time":"",
         "create_time":"",
         "media_url":""
      }],
      "errcode": 0,
      "total": 1,
      "errmsg":"ok"
}

# Return Parameter Meaning

# 4. Import goods in the live room

# Interface Dxplaination

Call the interface to import goods stored in the specified live room

# Call frequency

Call quota: 10000 times/One day.

# Request method

POST

# Requested URL:

https://api.weixin.qq.com/wxaapi/broadcast/room/addgoodsaccess_token=

# Sample request parameters: json

{
    "ids": [1150, 1111],  // ArrayList, can be passed in more than one, which fill in product ID
    "roomId": 2554
}

# Request parameter meaning

# Return Examples Correctly

{
   "errcode": 0 // 0: Success 
}

# 5. Delete Live Room

# Interface Dxplaination

Delete Live Room

# Call frequency

Call quota: 10000 times/One day.

# Request method

POST

# Requested URL:

https://api.weixin.qq.com/wxaapi/broadcast/room/deleteroomaccess_token=

# Sample request parameters: json

{
    "id" : 6491
}

# Request parameter meaning

# Return Examples Correctly

{
   "errcode": 0 // 0: Success
}

# 6. Editing Live Room

# Interface Dxplaination

Edit Live Room

# Call frequency

Call quota: 10000 times/One day.

# Request method

POST

# Requested URL:

https://api.weixin.qq.com/wxaapi/broadcast/room/editroomaccess_token=

# Sample request parameters: json

{
    "id": 811,
    "name": "Test update secondary 1,"
    "coverImg": "hw7zsntcr0rE-RBfBAaF553DqBk-J02UtWsP8VqrUh3tKu3jO_JwEO8n1cWTJ5TN",
    "startTime": 1607443200,
    "endTime": 1607450400,
    "anchorName": "Anchor nickname 11,"
    "anchorWechat": "lintest1",
    "shareImg": "hw7zsntcr0rE-RBfBAaF553DqBk-J02UtWsP8VqrUh3tKu3jO_JwEO8n1cWTJ5TN",
    "closeLike": 0,
    "closeGoods": 0,
    "closeComment": 0,
    "isFeedsPublic": 0,
    "closeReplay": 0,
    "closeShare": 0,
    "closeKf": 0,
    "feedsImg": "hw7zsntcr0rE-RBfBAaF553DqBk-J02UtWsP8VqrUh3tKu3jO_JwEO8n1cWTJ5TN"
}

# Request parameter meaning

# Return Examples Correctly

{
   "errcode": 0 // 0: Success
}

# 7. Get the Live Streaming Address

# Interface Dxplaination

Get Live Stream Push Address

# Call frequency

Call quota: 10000 times/One day.

# Request method

GET

# Requested URL:

https://api.weixin.qq.com/wxaapi/broadcast/room/getpushurlaccess_token=

# URL query parameter

{
    "roomId" : 6209
}

# Request parameter meaning

# Return Examples Correctly

{
    "pushAddr": "rtmp://wxalivepush.weixin.qq.com/live/wx40f8626ddf43d362-6209txSecret= 5 da 4 f 0 b 7 b 7 a 6 c 25 b 238311 de 8 c 81 a 65 a&txTime= 5 fc 4 f 631", 
    "errcode": 0
}

# 8. Get the QR Code for Live Sharing

# Interface Dxplaination

Get the QR code to share the live room

# Call frequency

Call quota: 10000 times/One day.

# Request method

GET

# Requested URL:

https://api.weixin.qq.com/wxaapi/broadcast/room/getsharedcodeaccess_token=

# URL query parameter

{
    "roomId" : 6209,
    "params" : EncodeURIComponent(JSON.stringify(custom_params))
}

# Request parameter meaning

# Return Examples Correctly

{
    "cdnUrl": " http://Mmbiz.qpic.cn/mmbiz_jpg/FVribAGdErI2jhO1hbzVDH1E5LW7VQ9D1SIvTLFmyYwkIUucJqE72icgAj6NYw92kbJRNV0zwnGZWaO0Y8T0vqlg/0", // Share QR code
    "pagePath": "plugin-private://wx2b03c6e691cd7370/pages/live-player-pluginroom_id=6209", // Sharing Path
    "posterUrl": " http://Mmbiz.qpic.cn/mmbiz_jpg/dlFudV139LtQn96YNHSGtVfcUkUwQaYeR5OiaJ6bPr7OZxy3yhIK3icjxop0QeRBiaDPiaxuzENtCj15zFIM8sh7ag/0", // Share the poster
    "errcode": 0
}

# 9. Add live room management mini assistant

# Interface Dxplaination

Add Management Live Room Assistant

# Call frequency

Call quota: 10000 times/One day.

# Request method

POST

# Requested URL:

https://api.weixin.qq.com/wxaapi/broadcast/room/addassistantaccess_token=

# Sample request parameters: json

{
    "roomId": 6474,
    "users": [{"username":"testwechat","nickname":"testnick"}]
}

# Request parameter meaning

# Return Examples Correctly

{
   "errcode": 0 // 0: Success
}

# 10. Modify the live room management mini assistant

# Interface Dxplaination

Modify the management of live room small assistant

# Call frequency

Call quota: 10000 times/One day.

# Request method

POST

# Requested URL:

https://api.weixin.qq.com/wxaapi/broadcast/room/modifyassistantaccess_token=

# Sample request parameters: json

{
    "roomId": 6474,
    "username": 'testwechat';
    "nickname": "testnick"
}

# Request parameter meaning

# Return Examples Correctly

{
   "errcode": 0 // 0: Success
}

# 11. Delete live room management mini assistant

# Interface Dxplaination

Delete Management Live Room Assistant

# Call frequency

Call quota: 10000 times/One day.

# Request method

POST

# Requested URL:

https://api.weixin.qq.com/wxaapi/broadcast/room/removeassistantaccess_token=

# Sample request parameters: json

{
    "roomId": 6623,
    "username": 'testwechat'
}

# Request parameter meaning

# Return Examples Correctly

{
   "errcode": 0 // 0: Success
}

# 12. Query management live room small assistant

# Interface Dxplaination

Query management live broadcast assistant

# Call frequency

Call quota: 10000 times/One day.

# Request method

GET

# Requested URL:

https://api.weixin.qq.com/wxaapi/broadcast/room/getassistantlistaccess_token=

# URL query parameter

{
    "roomId" : 6491
}

# Request parameter meaning

# Return Examples Correctly

{
    "list": [
        {
            "timestamp": 1601199369,
            "headimg": " http://wx.qlogo.cn/mmhead/USXYj7XUar4OmtmhpYR3IS1X54ibLgjcNjEXp3ne5C6I/0",
            "nickname": "nickname",
            "alias": "wechat",
            "openid": "o7esq5K76p47O-ien1kuaVAuSsvw"
        }
    ],
    "count": 1,
    "maxCount": 10,
    "errcode": 0
}

# Return Parameter Meaning

# 13. Add anchor sub number

# Interface Dxplaination

Add anchor side

# Call frequency

Call quota: 10000 times/One day.

# Request method

POST

# Requested URL:

https://api.weixin.qq.com/wxaapi/broadcast/room/addsubanchoraccess_token=

# Sample request parameters: json

{
    "roomId": 6827,
    "username": "lintest2"
}

# Request parameter meaning

# Return Examples Correctly

{
   "errcode": 0 // 0: Success
}

# 14. Change Anchor Sub Number

# Interface Dxplaination

Modification of anchor subtitles

# Call frequency

Call quota: 10000 times/One day.

# Request method

POST

# Requested URL:

https://api.weixin.qq.com/wxaapi/broadcast/room/modifysubanchoraccess_token=

# Sample request parameters: json

{
    "roomId": 6827,
    "username": 'Wechattest'
}

# Request parameter meaning

# Return Examples Correctly

{
   "errcode": 0 // 0: Success
}

# 15. Remove the anchor subtitle

# Interface Dxplaination

Remove anchor subtitles

# Call frequency

Call quota: 10000 times/One day.

# Request method

POST

# Requested URL:

https://api.weixin.qq.com/wxaapi/broadcast/room/deletesubanchoraccess_token=

# Sample request parameters: json

{
    "roomId" : 6491
}

# Request parameter meaning

# Return Examples Correctly

{
   "errcode": 0 // 0: Success
}

# 16. Get Anchor Sub Number

# Interface Dxplaination

Get the anchor sub

# Call frequency

Call quota: 10000 times/One day.

# Request method

GET

# Requested URL:

https://api.weixin.qq.com/wxaapi/broadcast/room/getsubanchoraccess_token=

# URL query parameter

{
    "roomId" : 6491
}

# Request parameter meaning

# Return Examples Correctly

{
    "username": 'testwechat';
    "errcode": 0
}

# 17. Opening/The Official Collection

# Interface Dxplaination

open/The Official Collection

# Call frequency

Call quota: 10000 times/One day.

# Request method

POST

# Requested URL:

https://api.weixin.qq.com/wxaapi/broadcast/room/updatefeedpublicaccess_token=

# Sample request parameters: json

{
    "roomId": 6474,
    "isFeedsPublic" : 0
}

# Request parameter meaning

# Return Examples Correctly

{
   "errcode": 0 // 0: Success
}

# 18. Opening/Turn off playback

# Interface Dxplaination

open/Turn off playback

# Call frequency

Call quota: 10000 times/One day.

# Request method

POST

# Requested URL:

https://api.weixin.qq.com/wxaapi/broadcast/room/updatereplayaccess_token=

# Sample request parameters: json

{
    "roomId": 6474,
    "closeReplay" : 0
}

# Request parameter meaning

# Return Examples Correctly

{
   "errcode": 0 // 0: Success
}

# 19. Opening/Turn off customer service functions

# Interface Dxplaination

open/Turn off customer service functions

# Call frequency

Call quota: 10000 times/One day.

# Request method

POST

# Requested URL:

https://api.weixin.qq.com/wxaapi/broadcast/room/updatekfaccess_token=

# Sample request parameters: json

{
    "roomId" : 6491,
    "closeKf" : 0
}

# Request parameter meaning

# Return Examples Correctly

{
   "errcode": 0 // 0: Success
}

# 20. Opening/Close the live room global gag

# Interface Dxplaination

open/Close the live room global gag

# Call frequency

Call quota: 10000 times/One day.

# Request method

POST

# Requested URL:

https://api.weixin.qq.com/wxaapi/broadcast/room/updatecommentaccess_token=

# Sample request parameters: json

{
    "roomId": 6474,
    "banComment" : 1
}

# Request parameter meaning

# Return Examples Correctly

{
   "errcode": 0 // 0: Success
}

# 21. Off the shelf

# Interface Dxplaination

Top and bottom goods

# Call frequency

Call quota: 10000 times/One day.

# Request method

POST

# Requested URL:

https://api.weixin.qq.com/wxaapi/broadcast/goods/onsaleaccess_token=

# Sample request parameters: json

{
    "roomId": 6474,
    "goodsId" : 1,
    "onSale": 0
}

# Request parameter meaning

# Return Examples Correctly

{
   "errcode": 0 // 0: Success
}

# 22. Delete commodities

# Interface Dxplaination

Remove Live Room Products

# Call frequency

Call quota: 10000 times/One day.

# Request method

POST

# Requested URL:

https://api.weixin.qq.com/wxaapi/broadcast/goods/deleteInRoomaccess_token=

# Sample request parameters: json

{
    "roomId": 6474,
    "goodsId" : 1
}

# Request parameter meaning

# Return Examples Correctly

{
   "errcode": 0 // 0: Success
}

# 23. Push goods

# Interface Dxplaination

Push goods

# Call frequency

Call quota: 10000 times/One day.

# Request method

POST

# Requested URL:

https://api.weixin.qq.com/wxaapi/broadcast/goods/pushaccess_token=

# Sample request parameters: json

{
    "roomId": 6474,
    "goodsId" : 1
}

# Request parameter meaning

# Return Examples Correctly

{
   "errcode": 0 // 0: Success
}

# 24. Ranking of commodities

# Interface Dxplaination

Live Streaming Product Ranking

# Call frequency

Call quota: 10000 times/One day.

# Request method

POST

# Requested URL:

https://api.weixin.qq.com/wxaapi/broadcast/goods/sortaccess_token=

# Sample request parameters: json

{
    "roomId": 6474,
    "goods" : [{"goodsId":"123"}, {"goodsId":"234"}]
}

# Request parameter meaning

# Return Examples Correctly

{
   "errcode": 0 // 0: Success
}

# 25. Download videos explaining the products

# Interface Dxplaination

Download Product Description Video

# Call frequency

Call quota: 10000 times/One day.

# Request method

POST

# Requested URL:

https://api.weixin.qq.com/wxaapi/broadcast/goods/getVideoaccess_token=

# Sample request parameters: json

{
    "roomId": 6474,
    "goodsId" : 1
}

# Request parameter meaning

# Return Examples Correctly

{
    "url": "xxx", // Explain the link
   "errcode": 0 // 0: Success
}

# Appendix: Error codes

-1: System error

1: No live studio created

1003: product id does not exist

47001: Entry format does not comply with specifications

200002: Input error

300001: Prohibition to create/Update goods or No editing & updating rooms

300002: Name length not in line with rules

300006: Image upload failed (e.g. mediaID expired)

300022: This room number does not exist

300023: State of the room Intercept (current room state does not allow this action)

300024: Goods do not exist

300025: Goods not approved

300026: The number of room goods is full

300027: Import failed

300028: Room name violation

300029: Anchor nickname violation

300030: the anchorman's WeChat account is illegal.

300031: Live room cover map non-compliance

300032: Live Sharing Map Violation

300033: Add merchandise over live room limit

300034: Anchor WeChat nickname length does not meet the requirements

300035: Anchor WeChat does not exist

300036: Anchor WeChat account without real name authentication

300037: Shopping live channel cover map non-compliant

300038: Customer service not configured in Mini Program admin background

300039: Anchor sub-signal micro signal illegal

300040: Name contains unqualified characters (contains special characters)

300041: Founder's WeChat ID illegal

300042: No editing rooms in the push stream

300043: Only one live stream per day is allowed to open attention

300044: Merchandise not explained Video

300045: Explanation video not generated

300046: Failed to generate demo video

Please try again later.

300048: Failed to pull item list

300049: Goods are not allowed to push up and down the shelf

300050: Sort item list empty

300051: Error parsing JSON

300052: Products that have been taken down cannot be pushed

300053: live room did not add this item

500001: Subcode not compliant

500002: Unreal Name of Associate

500003: has set the side number, can not be repeated settings

500004: Can't set duplicate bynumbers

500005: The secondary number cannot be repeated with the main number

600001: User has been added as Little Assistant

600002: User not found

9410000: Live room list is empty

9410001: Get room failure

9410002: Failure to acquire goods

9410003: Get playback failure