Consulta os eventos gerados nos canais inscritos.
Descrição da operação
Esta API permite até 50 chamadas por segundo por conta. O sistema descarta solicitações que excedem esse limite, o que pode causar interrupções no serviço. Considere essa restrição ao utilizar esta operação.
Depuração
Informações de autorização
A tabela a seguir apresenta as informações de autorização correspondentes à API. Use essas informações no elemento de política Action para conceder permissões a um usuário RAM ou função RAM e chamar esta operação da API. Descrição:
Operação: valor utilizado no elemento Action para especificar a ação sobre um recurso.
Nível de acesso: define o nível de acesso de cada operação. Os níveis incluem leitura, escrita e listagem.
-
Tipo de recurso: indica o tipo de recurso no qual o usuário RAM ou a função RAM tem permissão para executar a operação. Observe os seguintes pontos:
Tipos de recursos obrigatórios são indicados com o prefixo * .
Caso não seja possível conceder permissões no nível do recurso, utiliza-se
All Resourcesna coluna Tipo de recurso da operação.
Chave de condição: chave de condição definida pelo serviço de nuvem.
Operação associada: outras operações que o usuário RAM ou a função RAM precisa ter permissão para executar a fim de concluir a operação principal. Para finalizar a tarefa, é necessário possuir permissões também nas operações associadas.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| live:ListEventSub | list | *Rtc acs:live::{#accountId}:rtc/{#AppId} |
| none |
Parâmetros de solicitação
|
Parameter |
Type |
Required |
Description |
Example |
|
AppId |
string |
Yes |
O ID do aplicativo. |
9qb1**** |
Parâmetros de resposta
| Parameter | Type | Description | Example |
|---|---|---|---|
| object | Os parâmetros de resposta. | ||
| RequestId | string | O ID da solicitação. | AE050E24-BE9B-1E79-BB30-7EA0BBAE7F08 |
| Subscribers | array<object> | Os eventos. | |
| data | object | As informações sobre o evento. | |
| SubId | string | O ID do evento. | 09be0d2254cb5a89f4cbd86403ec**** |
| ChannelId | string | O ID do canal inscrito. | testmodify |
| Events | array | O tipo do evento. Valores válidos:
| |
| events | string | Eventos inscritos. | ChannelEvent |
| CallbackUrl | string | A URL de callback. | http://****.com/callback |
| CreateTime | string | Horário de criação da inscrição. Exibido em UTC+8. Formato: yyyy-MM-dd hh:mm:ss. | 2023-08-18 10:14:49 |
| ModifyTime | string | Horário da última modificação da inscrição. Exibido em UTC+8. Formato: yyyy-MM-dd hh:mm:ss. | 2023-08-18 10:14:49 |
| Users | array | Usuário cujos eventos são retornados. Recomenda-se utilizar este parâmetro ou Roles, mas não ambos simultaneamente. | |
| users | string | Aciona callback apenas para eventos deste usuário. Não é recomendado usar em conjunto com Roles. | testUser |
Rolesdeprecated | integer | Função do usuário cujos eventos são retornados. Valores válidos:
Um valor vazio ou diferente de 1 e 2 indica que os eventos de todos os usuários no canal serão retornados. Nota
Este parâmetro foi descontinuado. Ele não é mais suportado durante a criação de inscrições.
| 1 |
Exemplos
Exemplo de resposta de sucesso
Formato JSON
{
"RequestId": "AE050E24-BE9B-1E79-BB30-7EA0BBAE7F08",
"Subscribers": [
{
"SubId": "09be0d2254cb5a89f4cbd86403ec****",
"ChannelId": "testmodify",
"Events": [
"ChannelEvent"
],
"CallbackUrl": "http://****.com/callback",
"CreateTime": "2023-08-18 10:14:49",
"ModifyTime": "2023-08-18 10:14:49",
"Users": [
"testUser"
],
"Roles": 1
}
]
}
Códigos de erro
|
HTTP status code |
Error code |
Error message |
Description |
|
400 |
InputInvalid |
%s. |
Parâmetros de entrada inválidos |
|
403 |
NoAuth |
%s. |
Sem permissão |
|
404 |
ResourceNotExist |
%s. |
O recurso solicitado não existe. Verifique e tente novamente |
|
500 |
ServerError |
%s. |
Erro desconhecido. Tente novamente mais tarde ou envie um ticket para suporte. |
Para obter uma lista completa dos códigos de erro, consulte os Códigos de erro do serviço.
Histórico de alterações
|
Change time |
Summary of changes |
Operation |
Nenhum histórico de alterações