O Real-time Conversational AI oferece as seguintes operações de API para geração de tokens, envio de mensagens e gerenciamento de instâncias de agentes.
getRtcAuthToken
Gera um token para uma chamada de comunicação em tempo real (RTC).
Notas de uso
Protocolo da requisição: HTTP ou HTTPS
Caminho da requisição: /api/v2/aiagent/getRtcAuthToken
Autorização necessária: Sim
Método da requisição: POST
Content-Type: JSON
Configurações obrigatórias: biz.live_mic.app_id e biz.live_mic.app_key
Parâmetros da requisição
|
Nome |
Tipo |
Obrigatório |
Exemplo |
Descrição |
|
user_id |
String |
Sim |
userid**** |
ID do usuário. |
|
channel_id |
String |
Não |
channelid**** |
ID do canal. Nota
Se este parâmetro não for especificado, o servidor gerará um UUID de 32 caracteres (sem hifens). |
Parâmetros de resposta
|
Nome |
Tipo |
Exemplo |
Descrição |
||||
|
code |
Integer |
200 |
Código de status HTTP retornado. |
||||
|
rtc_auth_token |
String |
eyJnc2xiIjp**** |
Token RTC. |
||||
|
channel_id |
String |
channelid**** |
ID do canal utilizado. |
||||
|
timestamp |
Long |
1700000000 |
Período de validade. Unidade: segundos. Por padrão, o token é válido por 24 horas. |
||||
Exemplos
Exemplo de requisição
{
"user_id": "usertid****",
"channel_id":"channelid****"
}Exemplo de resposta de sucesso
{
"code": 200,
"rtc_auth_token": "eyJnc2xiIjp****",
"channel_id": "channelid****",
"timestamp": 1700000000
}generateMessageChatToken
Gera o token necessário para mensagens interativas.
Notas de uso
Protocolo da requisição: HTTP ou HTTPS
Caminho da requisição: /api/v2/aiagent/generateMessageChatToken
Autorização necessária: Sim
Método da requisição: POST
Content-Type: JSON
Configurações obrigatórias: biz.openapi.access.key e biz.openapi.access.secret
Parâmetros da requisição
|
Nome |
Tipo |
Obrigatório |
Exemplo |
Descrição |
|
ai_agent_id |
String |
Sim |
19de81b3b3d94abda22**** |
ID do agente. |
|
user_id |
String |
Sim |
userid**** |
ID do usuário. Pode ter até 64 caracteres e conter apenas letras, dígitos e sublinhados (_). |
|
role |
String |
Não |
admin |
Função. Defina este parâmetro como admin para permitir que o usuário chame operações de API relacionadas ao gerenciamento. Por padrão, este parâmetro fica vazio. |
|
expire |
Integer |
Não |
3600 |
Tempo limite. Unidade: segundos. Valor padrão: 3600. |
|
region |
String |
Sim |
cn-shanghai |
Região onde o agente reside. Para mais informações, consulte Endpoints. |
Parâmetros de resposta
|
Nome |
Tipo |
Exemplo |
Descrição |
||||
|
code |
Integer |
200 |
Código de status HTTP retornado. |
||||
|
message |
String |
success |
Descrição. |
||||
|
request_id |
String |
7B117AF5-2A16-412C-B127-**** |
ID da requisição. |
||||
|
app_id |
String |
**** |
ID da aplicação. |
||||
|
token |
String |
acet**** |
Token gerado. |
||||
|
user_id |
String |
userid**** |
ID do usuário para entrar na chamada. |
||||
|
nonce |
String |
AK-**** |
Nonce usado para gerar o token. |
||||
|
role |
String |
admin |
Função usada para gerar o token. |
||||
|
timestamp |
Long |
1700000000 |
Horário de expiração. Unidade: segundos. Horário de expiração = Horário atual + Período de validade. |
||||
|
app_sign |
String |
H4sIAAAAAAAE**** |
Assinatura da aplicação. |
||||
Exemplos
Exemplo de requisição
{
"user_id": "userid****",
"ai_agent_id":"19de81b3b3d94abda22******",
"role":"admin",
"expire":1800,
"region":"cn-shanghai"
}Exemplo de resposta de sucesso
{
"code": 200,
"message": "success",
"role": "admin",
"user_id": "userid****",
"app_id": "****",
"nonce": "AK-****",
"request_id": "7B117AF5-2A16-412C-B127-****",
"token": "acet****",
"timestamp": 1700000000,
"app_sign": "H4sIAAAAAAAE****",
}describeAIAgentInstance
Consulta os detalhes de uma instância de agente.
Notas de uso
Protocolo da requisição: HTTP ou HTTPS
Caminho da requisição: /api/v2/aiagent/describeAIAgentInstance
Autorização necessária: Sim
Método da requisição: POST
Content-Type: JSON
Configurações obrigatórias: biz.openapi.access.key e biz.openapi.access.secret
Parâmetros da requisição
|
Nome |
Tipo |
Obrigatório |
Exemplo |
Descrição |
|
user_id |
String |
Sim |
userid**** |
ID do usuário. |
|
ai_agent_instance_id |
String |
Sim |
39f8e0bc005e4f309379701645f4**** |
ID da instância do agente. |
|
region |
String |
Sim |
cn-shanghai |
Região onde o agente reside. Para mais informações, consulte Endpoints. |
Parâmetros de resposta
|
Nome |
Tipo |
Exemplo |
Descrição |
||||
|
code |
Integer |
200 |
Código de status HTTP retornado. |
||||
|
message |
String |
success |
Descrição. |
||||
|
request_id |
String |
7B117AF5-2A16-412C-B127-**** |
ID da requisição. |
||||
|
call_log_url |
String |
https://example.com/call_logs/12345 |
URL do log de chamadas. |
||||
|
runtime_config |
String |
{"VoiceChat":{"AgentUserId":"voice_agent_001","ChannelId":"voice_channel_001","AuthToken":"your_voice_chat_auth_token"}} |
Configuração de runtime do agente. Para mais informações, consulte |
||||
|
status |
String |
Finished |
Status do agente. Valores válidos:
|
||||
|
template_config |
String |
{"VoiceChat": {"AppId": "your_voice_chat_app_id"}} |
Configuração de modelo para estabelecer uma chamada de agente. Para mais informações, consulte AIAgentTemplateConfig. |
||||
|
user_data |
String |
{"Email":"johndoe@example.com","Preferences":{"Language":"en"}} |
Dados personalizados do usuário. |
||||
|
agent_config |
String |
{"xxx":"xx"} |
Configuração do modelo de agente, mesclada com a configuração do console. Se deixado em branco, a configuração padrão do console será usada. Para mais informações, consulte AIAgentConfig. |
||||
Exemplos
Exemplo de requisição
{
"user_id":"userid****",
"ai_agent_instance_id": "39f8e0bc005e4f309379701645f4****",
"region":"cn-shanghai"
}Exemplo de resposta de sucesso
{
"code": 200,
"message": "success",
"request_id": "7B117AF5-2A16-412C-B127-****",
"agent_config": "{\"VoiceChat\": {\"AppId\": \"your_voice_chat_app_id\"}}",
"template_config": "{\"VoiceChat\": {\"AppId\": \"your_voice_chat_app_id\"}}",
"call_log_url": "https://example.com/call_logs/12345",
"user_data": "{\"user_id\": \"test\"}",
"runtime_config": "{\"VoiceChat\":{\"AgentUserId\":\"voice_agent_001\",\"ChannelId\":\"voice_channel_001\",\"AuthToken\":\"your_voice_chat_auth_token\"}}",
"status": "Finished"
}