Overview

In addition to the SDK that you integrate into the app client, Agora provides RESTful APIs for channel management. You use these APIs to manage users in the channel and query channel statistics at the app server.

This page provides detailed documentation for the Agora Channel Management RESTful APIs.

All requests are sent to the domain name: api.agora.io.

The Content-Type field in all HTTP request headers is application/json. All requests and responses are in JSON format. All request URLs and request bodies are case-sensitive.

The Agora Channel Management RESTful APIs only support HTTPS. Before sending HTTP requests, you must generate a Base64-encoded credential with the Customer ID and Customer Secret provided by Agora, and pass the credential to the Authorization field in the HTTP request header. See RESTful authentication for details.

For each Agora account (not each App ID), the maximum call frequency of each online channel statistics query API is 20 queries per second. The maximum call frequency of every other API is 10 queries per second. If you are frequency limited when calling the APIs, please see How can I avoid being frequency limited when calling Agora Server RESTful APIs to optimize API call frequency.

For a description of the response status codes returned when calling the Channel Management RESTful API, refer to Response status codes.