This page provides Agora RTC SDK v2.1+, Agora Web SDK v2.4+, Agora Recording SDK v2.1+, and Agora RTSA SDK users with a quick guide on generating a sample token using the RtcTokenBuilderSample demos we provide, as well as token-generating API references in Go.

An introduction to Agora's token repository

Your token needs to be generated on your own server, hence you are required to first deploy a token generator on the server. In our GitHub Repository, we provide source codes and token generator demos in C++, Java, Python, PHP, Ruby, Node.js, Go, C# and other programming languages.

The ./<language>/src folder of each language holds source codes for generating different types of dynamic keys and tokens. Note that both AccessToken and SimpleTokenBuilder can generate a token for the following SDKs:

• Agora RTC SDK (Java, Objective-C, C++, Electron) v2.1+
• Agora Web SDK v2.4+
• Agora Recording SDK v2.1+
• Agora RTSA SDK

However, we recommend using RtcTokenBuilder instead of AccessToken. AccessToken implements all the core algorithms for generating a token, while RtcTokenBuilder is a wrapper of AccessToken and provides much more simplified Interfaces.

The ./<language>/sample folder of each language holds token generator demos we create for demonstration purposes. RtcTokenBuilderSample is a demo for generating a token for the Agora RTC SDK, Agora Web SDK, Agora Recording SDK or Agora RTSA SDK. You can customize it based on your real business needs.

Generate a token using RtcTokenBuilderSample

We take RtcTokenBuilderSample.go as an example:

1. Log onto the Golang official site to download the latest Stable version of Golang.
2. Synchronize the GitHub repository to your local drive.
3. Navigate to the /go/sample/RtcTokenBuilder/ folder and open sample.go.

   Our demo provides sample-App ID, appCertificate, channelName, uid, and userAccount for demonstration purposes.

4. Replace the sample-App ID, appCertificate, uid, and channelName with your own. For information about getting an App ID and an App certificate, see Token Security.
   • If you use an int uid to join a channel, comment out the following code block:

     result, err = rtctokenbuilder.BuildTokenWithUserAccount(appID, appCertificate, channelName, uidStr, rtctokenbuilder.RoleAttendee, expireTimestamp)
     if err != nil {
       fmt.Println(err)
     } else {
       fmt.Printf("Token with userAccount: %s\n", result)
     }

   • If you use a string userAccount to join a channel, comment out the following code block:

     result, err := rtctokenbuilder.BuildTokenWithUID(appID, appCertificate, channelName, uid, rtctokenbuilder.RoleAttendee, expireTimestamp)
     if err != nil {
       fmt.Println(err)
     } else {
       fmt.Printf("Token with uid: %s\n", result)
     }

     Skip this step if you just want to take a quick look at how a token is generated.

5. Open your terminal and navigate to the local folder holding sample.go.
6. Run the following command:
   go build
   Your token is printed in your terminal window.

API Reference

Source code: ../go/src/RtcTokenBuilder/RtcTokenBuilder.go

You can create your own token generator using the public methods that RtcTokenBuilder.go provides. Note that RtcTokenBuilder.go supports both int uid and string userAccount. Ensure that you choose the right method.

buildTokenWithUid

   func BuildTokenWithUID(appID string, appCertificate string, channelName string, uid uint32, role Role, privilegeExpiredTs uint32) (string, error)

This method builds a token with your int uid.

buildTokenWithUserAccount

  func BuildTokenWithUserAccount(appID string, appCertificate string, channelName string, userAccount string, role Role, privilegeExpiredTs uint32) (string, error)

This method builds a token with your string userAccount.

Reference

When generating a token, you can also refer to the following articles:

• Troubleshooting token-related errors for Agora RTC SDK
• Troubleshooting 101 error for Cloud Recording