Referensi API - Intelligent Media Services

Topik ini menjelaskan operasi API yang terkait dengan AI Percakapan Waktu Nyata.

getRtcAuthToken

Menghasilkan token untuk panggilan komunikasi waktu nyata (RTC).

Catatan penggunaan

Protokol Permintaan: HTTP atau HTTPS
Path Permintaan: /api/v2/aiagent/getRtcAuthToken
Otorisasi Diperlukan: Ya
Metode Permintaan: POST
Content-Type: JSON
Konfigurasi yang Diperlukan: biz.live_mic.app_id dan biz.live_mic.app_key

Parameter permintaan

Nama	Tipe	Diperlukan	Contoh	Deskripsi
user_id	String	Ya	userid****	ID pengguna.
channel_id	String	Tidak	channelid****	ID saluran. Catatan Jika Anda tidak menentukan parameter ini, server akan menghasilkan UUID 32 karakter (tanpa tanda hubung).

Parameter respons

Nama	Tipe	Contoh	Deskripsi
code	Integer	200	Kode status HTTP yang dikembalikan.
rtc_auth_token	String	eyJnc2xiIjp****	Token RTC.
channel_id	String	channelid****	ID saluran yang digunakan.
timestamp	Long	1.700.000.000	Periode validitas. Satuan: detik. Secara default, token berlaku selama 24 jam.

Contoh

Contoh Permintaan

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

Contoh Respons Sukses

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

generateMessageChatToken

Menghasilkan token yang diperlukan untuk pesan interaktif.

Catatan penggunaan

Protokol Permintaan: HTTP atau HTTPS
Path Permintaan: /api/v2/aiagent/generateMessageChatToken
Otorisasi Diperlukan: Ya
Metode Permintaan: POST
Content-Type: JSON
Konfigurasi yang Diperlukan: biz.openapi.access.key dan biz.openapi.access.secret

Parameter permintaan

Nama	Tipe	Diperlukan	Contoh	Deskripsi
ai_agent_id	String	Ya	19de81b3b3d94abda22****	ID agen.
user_id	String	Ya	userid****	ID pengguna. Panjang maksimumnya adalah 64 karakter dan hanya dapat berisi huruf, angka, dan garis bawah (_).
role	String	Tidak	admin	Peran. Nilai admin menunjukkan bahwa pengguna dapat memanggil operasi API terkait manajemen. Secara default, parameter ini dibiarkan kosong.
expire	Integer	Tidak	3.600	Periode timeout. Satuan: detik. Nilai default: 3.600.
region	String	Ya	cn-shanghai	Wilayah tempat agen berada. Untuk informasi lebih lanjut, lihat Endpoints.

Parameter respons

Nama	Tipe	Contoh	Deskripsi
code	Integer	200	Kode status HTTP yang dikembalikan.
message	String	success	Deskripsi.
request_id	String	7B117AF5-2A16-412C-B127-****	ID permintaan.
app_id	String	****	ID aplikasi.
token	String	acet****	Token yang dihasilkan.
user_id	String	userid****	ID pengguna untuk bergabung dalam panggilan.
nonce	String	AK-****	Nonce yang digunakan untuk menghasilkan token.
role	String	admin	Peran yang digunakan untuk menghasilkan token.
timestamp	Long	1.700.000.000	Waktu kedaluwarsa. Satuan: detik. Waktu kedaluwarsa = Waktu saat ini + Periode validitas.
app_sign	String	H4sIAAAAAAAE****	Tanda tangan aplikasi.

Contoh

Contoh Permintaan

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

Contoh Respons Sukses

{
    "code": 200,
    "message": "success",
    "role": "admin",
    "user_id": "userid****",
    "app_id": "****",
    "nonce": "AK-****",
    "request_id": "7B117AF5-2A16-412C-B127-****",
    "token": "acet****",
    "timestamp": 1.700.000.000,
    "app_sign": "H4sIAAAAAAAE****",
}

describeAIAgentInstance

Meminta detail dari instance Agen.

Catatan Penggunaan

Protokol Permintaan: HTTP atau HTTPS
Path Permintaan: /api/v2/aiagent/describeAIAgentInstance
Otorisasi Diperlukan: Ya
Metode Permintaan: POST
Content-Type: JSON
Konfigurasi yang Diperlukan: biz.openapi.access.key dan biz.openapi.access.secret

Parameter Permintaan

Nama	Tipe	Diperlukan	Contoh	Deskripsi
user_id	String	Ya	userid****	ID pengguna.
ai_agent_instance_id	String	Ya	39f8e0bc005e4f309379701645f4****	ID instance agen.
region	String	Ya	cn-shanghai	Wilayah tempat agen berada. Untuk informasi lebih lanjut, lihat Endpoints.

Parameter Respons

Nama	Tipe	Contoh	Deskripsi
code	Integer	200	Kode status HTTP yang dikembalikan.
message	String	success	Deskripsi.
request_id	String	7B117AF5-2A16-412C-B127-****	ID permintaan.
call_log_url	String	https://example.com/call_logs/12345	URL log panggilan.
runtime_config	String	{"VoiceChat":{"AgentUserId":"voice_agent_001","ChannelId":"voice_channel_001","AuthToken":"your_voice_chat_auth_token"}}	Konfigurasi runtime agen. Untuk informasi lebih lanjut, lihat AIAgentRuntimeConfig.
status	String	Finished	Status agen. Nilai valid: Finished Executing
template_config	String	{"VoiceChat": {"AppId": "your_voice_chat_app_id"}}	Konfigurasi template untuk menyiapkan panggilan agen. Untuk informasi lebih lanjut, lihat AIAgentTemplateConfig.
user_data	String	{"Email":"johndoe@example.com","Preferences":{"Language":"en"}}	Data pengguna kustom.
agent_config	String	{"xxx":"xx"}	Konfigurasi template agen, yang akan digabungkan dengan konfigurasi konsol. Jika dibiarkan kosong, konfigurasi default dari konsol akan digunakan. Untuk informasi lebih lanjut, lihat AIAgentConfig.

Contoh

Contoh Permintaan

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

Contoh Respons Sukses

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