You need to enable JavaScript to run this app.
最新活动
产品
解决方案
定价
生态与合作
支持与服务
开发者
了解我们
导航
企业直播
  • 文档首页
    • /
  • 企业直播

发送自定义系统消息

最近更新时间：2022.09.29 17:29:32

首次发布时间：2022.07.29 09:31:39

我的收藏

通过该接口实现自定义系统消息的发送。

请求说明

  • 接口名称：SendCustomSystemMessageAPI
  • 请求方式：POST
  • 接口地址：http://livesaas.volcengineapi.com/?Action=SendCustomSystemMessageAPI&Version=2020-06-01
  • 请求频率：单用户请求频率限制为 120 次/分钟。

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共请求参数。

Query

参数类型是否必选描述
ActionString是接口名称
VersionString是接口版本。直播当前 API 的版本为 2020-06-01

Body

参数类型是否必选描述
ActivityIdInt64是直播间 ID。您可通过ListActivityAPI 接口查询 ID
ContentString是待发送的自定义系统消息，长度不大于 120 个字符

返回参数

参数类型描述

Status

Boolean

自定义系统消息是否发送成功。

  • true：成功；
  • false：失败。

示例

请求示例

Post http://livesaas.volcengineapi.com/?Action=SendCustomSystemMessageAPI&Version=2020-06-01
{
    "ActivityId": 123123,
    "Content": "***下单成功"
}

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022062820372601021***",
        "Action": "SendCustomSystemMessageAPI",
        "Version": "2020-06-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1656419846
    },
    "Result": {
    		"Status": true
    }
}

异常返回示例

{
  	"ResponseMetadata":{
        "RequestId":"201806041104200100***",
        "Action":"SendCustomSystemMessageAPI",
        "Version":"2020-06-01",
        "Service":"livesaas",
        "Region":"cn-north-1",
        "SystemTime":1656067132,
        "Error":{
            "Code":"200000",
            "Message":"参数异常" 
        }
		}
}

错误码

访问公共错误码获取详细信息。