/** * @example * { * appid: "appid", * name: "customer_service", * sip: { * to_number: "+19876543210", * from_number: "+11234567890", * rtc_uid: "100", * rtc_token: "" * }, * pipeline_id: "fzufjlweixxxxnlp", * properties: { * channel: "", * token: "", * agent_rtc_uid: "111", * remote_rtc_uids: ["100"] * } * } * * @example * { * appid: "appid", * name: "customer_service", * sip: { * to_number: "+19876543210", * from_number: "+11234567890", * rtc_uid: "100", * rtc_token: "" * }, * properties: { * channel: "", * token: "", * agent_rtc_uid: "111", * remote_rtc_uids: ["100"], * idle_timeout: 120, * llm: { * "url": "https://api.openai.com/v1/chat/completions", * "api_key": "", * "system_messages": [ * { * "role": "system", * "content": "You are a helpful chatbot." * } * ], * "max_history": 32, * "greeting_message": "Hello, how can I assist you today?", * "failure_message": "Please hold on a second.", * "params": { * "model": "gpt-4o-mini" * } * }, * tts: { * "vendor": "microsoft", * "params": { * "key": "", * "region": "eastus", * "voice_name": "en-US-AndrewMultilingualNeural" * } * }, * asr: { * "language": "en-US" * } * } * } */ export interface CallTelephonyRequest { /** The App ID of the project. */ appid: string; /** The name identifier of the call session. */ name: string; /** SIP (Session Initiation Protocol) call configuration object. */ sip: CallTelephonyRequest.Sip; /** The unique ID of a published project in AI Studio. */ pipeline_id?: string; /** * Call attribute configuration. The content of this field varies depending on the invocation method: * - **Using pipeline ID**: Simply pass in `channel`, `token`, `agent_rtc_uid`, and `remote_rtc_uids`. * - **Using complete configuration**: Pass in the complete parameters of the [Start a conversational AI agent](https://docs.agora.io/en/conversational-ai/rest-api/agent/join) `properties`, including all required fields such as `channel`, `token`, `agent_rtc_uid`, `remote_rtc_uids`, `tts`, and `llm`. */ properties: CallTelephonyRequest.Properties; } export declare namespace CallTelephonyRequest { /** * SIP (Session Initiation Protocol) call configuration object. */ interface Sip { /** Called number (target phone number), in E.164 format. */ to_number: string; /** Caller ID (the number that initiated the call), in E.164 format. */ from_number: string; /** The RTC UID used by the SIP gateway. */ rtc_uid: string; /** The RTC token used by the SIP gateway. */ rtc_token: string; } /** * Call attribute configuration. The content of this field varies depending on the invocation method: * - **Using pipeline ID**: Simply pass in `channel`, `token`, `agent_rtc_uid`, and `remote_rtc_uids`. * - **Using complete configuration**: Pass in the complete parameters of the [Start a conversational AI agent](https://docs.agora.io/en/conversational-ai/rest-api/agent/join) `properties`, including all required fields such as `channel`, `token`, `agent_rtc_uid`, `remote_rtc_uids`, `tts`, and `llm`. */ interface Properties { /** RTC channel name. */ channel: string; /** RTC Channel Token. */ token: string; /** The agent's user ID in the RTC channel. */ agent_rtc_uid: string; /** A list of RTC user IDs. When using pipeline ID, this should contain the SIP gateway UID. */ remote_rtc_uids?: string[]; /** Accepts any additional properties */ [key: string]: any; } }