すべてのプロダクト
Search

このプロダクト

    Intelligent Media Services:API リファレンス

    ドキュメントセンター

    Intelligent Media Services:API リファレンス

    最終更新日:Nov 10, 2025

    このトピックでは、リアルタイム対話型 AI に関連する API 操作について説明します。

    getRtcAuthToken

    リアルタイムコミュニケーション ( RTC ) 通話のトークンを生成します。

    使用方法に関する注意事項

    • リクエストプロトコル：HTTP または HTTPS

    • リクエストパス：/api/v2/aiagent/getRtcAuthToken

    • 必要な承認：はい

    • リクエストメソッド：POST

    • Content-Type：JSON

    • 必要な構成：biz.live_mic.app_id および biz.live_mic.app_key

    リクエストパラメーター

    名前

    タイプ

    必須

    例

    説明

    user_id

    String

    はい

    userid****

    ユーザー ID。

    channel_id

    String

    いいえ

    channelid****

    チャネル ID。

    説明

    このパラメーターを指定しない場合、サーバーは 32 文字の UUID（ハイフンなし）を生成します。

    レスポンスパラメーター

    名前

    タイプ

    例

    説明

    code

    Integer

    200

    返された HTTP ステータスコード。

    rtc_auth_token

    String

    eyJnc2xiIjp****

    RTC トークン。

    channel_id

    String

    channelid****

    使用されているチャネル ID。

    timestamp

    Long

    1700000000

    有効期間。単位：秒。デフォルトでは、トークンは 24 時間有効です。

    例

    リクエストの例

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

    成功レスポンスの例

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

    generateMessageChatToken

    インタラクティブメッセージに必要なトークンを生成します。

    使用方法に関する注意事項

    • リクエストプロトコル：HTTP または HTTPS

    • リクエストパス：/api/v2/aiagent/generateMessageChatToken

    • 必要な承認：はい

    • リクエストメソッド：POST

    • Content-Type：JSON

    • 必要な構成：biz.openapi.access.key および biz.openapi.access.secret

    リクエストパラメーター

    名前

    タイプ

    必須

    例

    説明

    ai_agent_id

    String

    はい

    19de81b3b3d94abda22****

    エージェント ID。

    user_id

    String

    はい

    userid****

    ユーザー ID。

    最大 64 文字で、文字、数字、およびアンダースコア（_）のみを含めることができます。

    role

    String

    いいえ

    admin

    ロール。admin の値は、ユーザーが管理関連の API 操作を呼び出すことができることを示します。デフォルトでは、このパラメーターは空のままです。

    expire

    Integer

    いいえ

    3600

    タイムアウト期間。単位：秒。デフォルト値：3600。

    region

    String

    はい

    cn-shanghai

    エージェントが存在するリージョン。詳細については、「エンドポイント」をご参照ください。

    レスポンスパラメーター

    名前

    タイプ

    例

    説明

    code

    Integer

    200

    返された HTTP ステータスコード。

    message

    String

    success

    説明。

    request_id

    String

    7B117AF5-2A16-412C-B127-****

    リクエスト ID。

    app_id

    String

    ****

    アプリケーション ID。

    token

    String

    acet****

    生成されたトークン。

    user_id

    String

    userid****

    通話に参加するためのユーザー ID。

    nonce

    String

    AK-****

    トークンの生成に使用される nonce。

    role

    String

    admin

    トークンの生成に使用されるロール。

    timestamp

    Long

    1700000000

    有効期限。単位：秒。有効期限 = 現在時刻 + 有効期間。

    app_sign

    String

    H4sIAAAAAAAE****

    アプリケーション署名。

    例

    リクエストの例

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

    成功レスポンスの例

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

    エージェントインスタンスの詳細をクエリします。

    使用上の注意

    • リクエストプロトコル：HTTP または HTTPS

    • リクエストパス：/api/v2/aiagent/describeAIAgentInstance

    • 必要な承認：はい

    • リクエストメソッド：POST

    • Content-Type：JSON

    • 必要な構成：biz.openapi.access.key および biz.openapi.access.secret

    リクエストパラメーター

    名前

    タイプ

    必須

    例

    説明

    user_id

    String

    はい

    userid****

    ユーザー ID。

    ai_agent_instance_id

    String

    はい

    39f8e0bc005e4f309379701645f4****

    エージェントインスタンスの ID。

    region

    String

    はい

    cn-shanghai

    エージェントが存在するリージョン。詳細については、「エンドポイント」をご参照ください。

    レスポンスパラメーター

    名前

    タイプ

    例

    説明

    code

    Integer

    200

    返された HTTP ステータスコード。

    message

    String

    success

    説明。

    request_id

    String

    7B117AF5-2A16-412C-B127-****

    リクエスト ID。

    call_log_url

    String

    https://example.com/call_logs/12345

    通話ログ URL。

    runtime_config

    String

    {"VoiceChat":{"AgentUserId":"voice_agent_001","ChannelId":"voice_channel_001","AuthToken":"your_voice_chat_auth_token"}}

    エージェントのランタイム構成です。詳細については、

    エージェントの実行時構成。詳細については、「AIAgentRuntimeConfig」をご参照ください。

    status

    String

    Finished

    エージェントのステータス。

    有効な値：

    • Finished

    • Executing

    template_config

    String

    {"VoiceChat": {"AppId": "your_voice_chat_app_id"}}

    エージェントコールを設定するためのテンプレート構成。詳細については、「AIAgentTemplateConfig」をご参照ください。

    user_data

    String

    {"Email":"johndoe@example.com","Preferences":{"Language":"en"}}

    カスタムユーザーデータ。

    agent_config

    String

    {"xxx":"xx"}

    エージェントのテンプレート構成。コンソール構成とマージされます。空のままにすると、コンソールのデフォルト構成が使用されます。詳細については、「AIAgentConfig」をご参照ください。

    例

    リクエストの例

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

    成功レスポンスの例

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