Références d'API - Intelligent Media Services - Centre de documentation Alibaba Cloud

getRtcAuthToken

Génère un jeton pour un appel en temps réel (RTC).

Notes d'utilisation

Protocole de requête : HTTP ou HTTPS
Chemin de la requête : /api/v2/aiagent/getRtcAuthToken
Autorisation requise : Oui
Méthode de requête : POST
Content-Type : JSON
Configurations requises : biz.live_mic.app_id et biz.live_mic.app_key

Paramètres de requête

Nom	Type	Obligatoire	Exemple	Description
user_id	String	Oui	userid****	ID utilisateur.
channel_id	String	Non	channelid****	ID du canal. Remarque Si vous ne spécifiez pas ce paramètre, le serveur génère un UUID de 32 caractères (sans tirets).

Paramètres de réponse

Nom	Type	Exemple	Description
code	Integer	200	Code d'état HTTP renvoyé.
rtc_auth_token	String	eyJnc2xiIjp****	Jeton RTC.
channel_id	String	channelid****	ID du canal utilisé.
timestamp	Long	1700000000	Période de validité. Unité : secondes. Par défaut, le jeton est valide pendant 24 heures.

Exemples

Exemple de requête

{
    "user_id": "usertid****",
    "channel_id":"channelid****"
}

Exemple de réponse réussie

{
    "code": 200,
    "rtc_auth_token": "eyJnc2xiIjp****",
    "channel_id": "channelid****",
    "timestamp": 1700000000
}

generateMessageChatToken

Génère le jeton requis pour la messagerie interactive.

Notes d'utilisation

Protocole de requête : HTTP ou HTTPS
Chemin de la requête : /api/v2/aiagent/generateMessageChatToken
Autorisation requise : Oui
Méthode de requête : POST
Content-Type : JSON
Configurations requises : biz.openapi.access.key et biz.openapi.access.secret

Paramètres de requête

Nom

Type

Obligatoire

Exemple

Description

ai_agent_id

String

Oui

19de81b3b3d94abda22****

ID de l'agent.

user_id

String

Oui

userid****

ID utilisateur.

Longueur maximale : 64 caractères. Seules les lettres, les chiffres et le trait de soulignement (_) sont autorisés.

role

String

Non

admin

Rôle. Définissez ce paramètre sur admin pour permettre à l'utilisateur d'appeler les opérations d'API liées à la gestion. Par défaut, ce paramètre est vide.

expire

Integer

Non

3600

Délai d'expiration. Unité : secondes. Valeur par défaut : 3600.

region

String

Oui

cn-shanghai

Région où réside l'agent. Pour plus d'informations, consultez Endpoints.

Paramètres de réponse

Nom	Type	Exemple	Description
code	Integer	200	Code d'état HTTP renvoyé.
message	String	success	Description.
request_id	String	7B117AF5-2A16-412C-B127-****	ID de la requête.
app_id	String	****	ID de l'application.
token	String	acet****	Jeton généré.
user_id	String	userid****	ID utilisateur pour rejoindre l'appel.
nonce	String	AK-****	Nonce utilisé pour générer le jeton.
role	String	admin	Rôle utilisé pour générer le jeton.
timestamp	Long	1700000000	Heure d'expiration. Unité : secondes. Heure d'expiration = Heure actuelle + Période de validité.
app_sign	String	H4sIAAAAAAAE****	Signature de l'application.

Exemples

Exemple de requête

{
    "user_id": "userid****",
    "ai_agent_id":"19de81b3b3d94abda22******",
    "role":"admin",
    "expire":1800,
    "region":"cn-shanghai"
}

Exemple de réponse réussie

{
    "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

Interroge les détails d'une instance d'agent.

Notes d'utilisation

Protocole de requête : HTTP ou HTTPS
Chemin de la requête : /api/v2/aiagent/describeAIAgentInstance
Autorisation requise : Oui
Méthode de requête : POST
Content-Type : JSON
Configurations requises : biz.openapi.access.key et biz.openapi.access.secret

Paramètres de requête

Nom

Type

Obligatoire

Exemple

Description

user_id

String

Oui

userid****

ID utilisateur.

ai_agent_instance_id

String

Oui

39f8e0bc005e4f309379701645f4****

ID de l'instance d'agent.

region

String

Oui

cn-shanghai

Région où réside l'agent. Pour plus d'informations, consultez Endpoints.

Paramètres de réponse

Nom	Type	Exemple	Description
code	Integer	200	Code d'état HTTP renvoyé.
message	String	success	Description.
request_id	String	7B117AF5-2A16-412C-B127-****	ID de la requête.
call_log_url	String	https://example.com/call_logs/12345	URL du journal des appels.
runtime_config	String	{"VoiceChat":{"AgentUserId":"voice_agent_001","ChannelId":"voice_channel_001","AuthToken":"your_voice_chat_auth_token"}}	Configuration d'exécution de l'agent. Pour plus d'informations, consultez AIAgentRuntimeConfig.
status	String	Finished	Statut de l'agent. Valeurs valides : Finished Executing
template_config	String	{"VoiceChat": {"AppId": "your_voice_chat_app_id"}}	Configuration du modèle pour configurer un appel d'agent. Pour plus d'informations, consultez AIAgentTemplateConfig.
user_data	String	{"Email":"johndoe@example.com","Preferences":{"Language":"en"}}	Données utilisateur personnalisées.
agent_config	String	{"xxx":"xx"}	Configuration du modèle d'agent, fusionnée avec la configuration de la console. Si ce champ est vide, la configuration par défaut de la console est utilisée. Pour plus d'informations, consultez AIAgentConfig.

Exemples

Exemple de requête

{
    "user_id":"userid****",
    "ai_agent_instance_id": "39f8e0bc005e4f309379701645f4****",
    "region":"cn-shanghai"
}

Exemple de réponse réussie

{
    "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"
}