最近更新时间:2024.04.15 11:37:02
首次发布时间:2023.12.28 21:21:53
阅读本文,您可以获取 Go SDK 回调管理的接口调用示例,实现快速开发。
说明
本文的调用示例包含接口的全部参数。由于参数间可能存在互斥关系,在调用时,请您参考注释,进行调整。
调用接口前,请先完成 Go SDK 的安装及初始化操作
本节为您介绍回调管理相关接口的功能和调用示例。
您可以调用 UpdateCallback 接口添加或更新回调配置。详细的参数说明可参见 UpdateCallback 接口文档。
接口调用示例如下所示。
package main import ( "os" "context" "fmt" "github.com/volcengine/volc-sdk-golang/base" "github.com/volcengine/volc-sdk-golang/service/live/v20230101" ) func main () { // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。 // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET service := live_v20230101.NewInstance() service.SetCredential(base.Credentials{ AccessKeyID: os.Getenv("ACCESS_KEY_ID"), SecretAccessKey: os.Getenv("ACCESS_KEY_SECRET"), }) body := &live_v20230101.UpdateCallbackBody{} //应用名称,取值与直播流地址中 AppName 字段取值相同,默认为空,表示查询所有应用名称。支持由大小写字母(A - Z、a - z)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 30 个字符。 // note: // 如果入参选择 `Domain`,则不可同时传 `App`。 var bodyApp *string var bodyAppValue string = "example_app" bodyApp = &bodyAppValue body.App = bodyApp //回调消息发送是否开启鉴权,默认为 `false`,取值及含义如下所示。 // <li> `false`:不开启; </li> // <li> `true`:开启。 </li> var bodyAuthEnable *bool var bodyAuthEnableValue bool = true bodyAuthEnable = &bodyAuthEnableValue body.AuthEnable = bodyAuthEnable //回调消息发送鉴权密钥。 // note: // 如果 `AuthEnable` 为 `true`,则密钥必填。 var bodyAuthKeyPrimary *string var bodyAuthKeyPrimaryValue string = "1622194197-0-0-5552*****e4e20387c6dc18afce****" bodyAuthKeyPrimary = &bodyAuthKeyPrimaryValue body.AuthKeyPrimary = bodyAuthKeyPrimary //回调信息列表。 updateCallbackBodyCallbackDetailListItem := live_v20230101.UpdateCallbackBodyCallbackDetailListItem{} //回调类型,支持设置为 HTTP,表示可以使用 HTTP 和 HTTPS 地址接收回调事件。 updateCallbackBodyCallbackDetailListItem.CallbackType = "http" //回调消息接收地址。 updateCallbackBodyCallbackDetailListItem.URL = "http://example.com/callback" body.CallbackDetailList = append(body.CallbackDetailList,updateCallbackBodyCallbackDetailListItem) //直播流使用的推流域名。您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console-stable.volcanicengine.com/live/main/domain/list)页面,查看直播流使用的域名。 // note: // `Vhost` 和 `Domain` 传且仅传一个。 var bodyDomain *string var bodyDomainValue string = "push.example.com" bodyDomain = &bodyDomainValue body.Domain = bodyDomain //回调的消息类型,取值及含义如下所示。 // <li> `push`:推流开始回调; </li> // <li> `push_end`:推流结束回调; </li> // <li> `snapshot`:截图回调; </li> // <li> `record`:录制任务状态回调; </li> // <li> `audit_snapshot`:截图审核结果回调。 </li> body.MessageType = "push" //是否开启转码流回调,默认为 0。取值及含义如下所示。 // <li> `0`:false,不开启; </li> // <li> `1`:true,开启。 </li> // note: // 回调类型为推流开始或推流结束时生效。 var bodyTranscodeCallback *int32 var bodyTranscodeCallbackValue int32 = 0 bodyTranscodeCallback = &bodyTranscodeCallbackValue body.TranscodeCallback = bodyTranscodeCallback //域名空间,即直播流地址的域名所属的域名空间。您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console-stable.volcanicengine.com/live/main/domain/list)页面,查看需要查询的直播流使用的域名所属的域名空间。 // note: // `Vhost` 和 `Domain` 传且仅传一个。 var bodyVhost *string var bodyVhostValue string = "push.example.com" bodyVhost = &bodyVhostValue body.Vhost = bodyVhost resp, err := service.UpdateCallback(context.Background(), body) if err != nil { fmt.Printf("error %v", err) } else { fmt.Printf("success %+v", resp) } }
您可以调用 DeleteCallback 接口删除回调配置。详细的参数说明可参见 DeleteCallback 接口文档。
接口调用示例如下所示。
package main import ( "os" "context" "fmt" "github.com/volcengine/volc-sdk-golang/base" "github.com/volcengine/volc-sdk-golang/service/live/v20230101" ) func main () { // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。 // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET service := live_v20230101.NewInstance() service.SetCredential(base.Credentials{ AccessKeyID: os.Getenv("ACCESS_KEY_ID"), SecretAccessKey: os.Getenv("ACCESS_KEY_SECRET"), }) body := &live_v20230101.DeleteCallbackBody{} //域名空间,与创建回调时传的值一致。您可以调用 [DescribeCallback](https://www.volcengine.com/docs/6469/1126931) 接口查看待删除回调配置的 `Vhost` 取值。 var bodyVhost *string var bodyVhostValue string = "push.live.example.com" bodyVhost = &bodyVhostValue body.Vhost = bodyVhost //推流域名,与创建回调时传的值一致。您可以调用 [DescribeCallback](https://www.volcengine.com/docs/6469/1126931) 接口查看待删除回调配置的 `Domain` 取值。 var bodyDomain *string var bodyDomainValue string = "push.live.example.com" bodyDomain = &bodyDomainValue body.Domain = bodyDomain //消息类型,与创建回调时传的值一致。您可以调用 [DescribeCallback](https://www.volcengine.com/docs/6469/1126931) 接口查看待删除回调配置的 `MessageType` 取值。 // 缺省情况下为空,表示删除符合 Vhost、Domain、App 配置下的所有回调类型配置。包括以下类型。 // <li> push:推流开始回调; </li> // <li> push_end:推流结束回调; </li> // <li> snapshot:截图回调; </li> // <li> record:录制任务状态回调; </li> // <li> audit_snapshot:截图审核结果回调。 </li> var bodyMessageType *string var bodyMessageTypeValue string = "push" bodyMessageType = &bodyMessageTypeValue body.MessageType = bodyMessageType //应用名称,与创建回调时传的值一致。您可以调用 [DescribeCallback](https://www.volcengine.com/docs/6469/1126931) 接口查看待删除回调配置的 `App` 取值。 var bodyApp *string var bodyAppValue string = "live" bodyApp = &bodyAppValue body.App = bodyApp resp, err := service.DeleteCallback(context.Background(), body) if err != nil { fmt.Printf("error %v", err) } else { fmt.Printf("success %+v", resp) } }
您可以调用 DescribeCallback 接口查询回调配置。详细的参数说明可参见 DescribeCallback 接口文档。
接口调用示例如下所示。
package main import ( "os" "context" "fmt" "github.com/volcengine/volc-sdk-golang/base" "github.com/volcengine/volc-sdk-golang/service/live/v20230101" ) func main () { // 强烈建议不要把 AccessKey ID 和 AccessKey Secret 保存到工程代码里,否则可能导致 AccessKey 泄露,威胁您账号下所有资源的安全。 // 本示例通过从环境变量中读取 AccessKey ID 和 AccessKey Secret,来实现 API 访问的身份验证。运行代码示例前,请配置环境变量 ACCESS_KEY_ID 和 ACCESS KEY_SECRET service := live_v20230101.NewInstance() service.SetCredential(base.Credentials{ AccessKeyID: os.Getenv("ACCESS_KEY_ID"), SecretAccessKey: os.Getenv("ACCESS_KEY_SECRET"), }) body := &live_v20230101.DescribeCallbackBody{} //应用名称,缺省情况下表示查询全部。 var bodyApp *string var bodyAppValue string = "Live" bodyApp = &bodyAppValue body.App = bodyApp //直播流使用的推流域名,默认为空,表示查询所有当前域名空间(Vhost)下的在线流。您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console-stable.volcanicengine.com/live/main/domain/list)页面,查看直播流使用的域名。 // note: // `Vhost` 和 `Domain` 传且仅传一个。 var bodyDomain *string var bodyDomainValue string = "push.example.com" bodyDomain = &bodyDomainValue body.Domain = bodyDomain //回调类型。默认为空,表示查询全部回调类型,取值及含义如下所示。 // <li> `push`:推流开始回调; </li> // <li> `push_end`:推流结束回调; </li> // <li> `snapshot`:截图回调; </li> // <li> `record`:录制回调; </li> // <li> `audit_snapshot`:截图审核回调。 </li> var bodyMessageType *string var bodyMessageTypeValue string = "push" bodyMessageType = &bodyMessageTypeValue body.MessageType = bodyMessageType //域名空间,即直播流地址的域名所属的域名空间。您可以调用 [ListDomainDetail](https://www.volcengine.com/docs/6469/1126815) 接口或在视频直播控制台的[域名管理](https://console-stable.volcanicengine.com/live/main/domain/list)页面,查看需要查询的直播流使用的域名所属的域名空间。 // note: // `Vhost` 和 `Domain` 传且仅传一个。 var bodyVhost *string var bodyVhostValue string = "push.example.com" bodyVhost = &bodyVhostValue body.Vhost = bodyVhost resp, err := service.DescribeCallback(context.Background(), body) if err != nil { fmt.Printf("error %v", err) } else { fmt.Printf("success %+v", resp) } }