'1.0',
'info' => [
'style' => 'RPC',
'product' => 'aiccs',
'version' => '2019-10-15',
],
'directories' => [
[
'id' => 208943,
'title' => '通信智能体',
'type' => 'directory',
'children' => [
'QueryConversationDetailInfoNew',
'ImportOneTaskPhoneNumber',
'QueryAiVoiceAgentDetail',
'PageQueryAgentList',
'QueryConversationDetailInfo',
'QueryAiCallDetailPage',
'StopAiCallTask',
'CancelAiCallDetails',
'StartAiCallTask',
'UpdateAiCallTask',
'QueryAiCallTaskPage',
'QueryAiCallTaskDetail',
'ImportTaskNumberDatas',
'CreateAiCallTask',
],
],
[
'id' => 200032,
'title' => '通信智能引擎',
'type' => 'directory',
'children' => [
'LlmSmartCall',
'LlmSmartCallEncrypt',
'HangupOperate',
'ListAvailableTts',
'GetCallDialogContent',
],
],
[
'id' => 164279,
'title' => '热线监控数据',
'type' => 'directory',
'children' => [
'GetHotlineServiceStatistics',
'GetSkillGroupAndAgentStatusSummary',
'GetDepartmentalLatitudeAgentStatus',
'GetSkillGroupLatitudeState',
'GetAgentBasisStatus',
'GetAgentStatistics',
],
],
[
'id' => 164286,
'title' => '在线监控数据',
'type' => 'directory',
'children' => [
'GetOnlineServiceVolume',
'GetSeatInformation',
'GetSkillGroupServiceCapability',
'GetSkillGroupAgentStatusDetails',
'GetOnlineSeatInformation',
'GetQueueInformation',
],
],
[
'id' => 164293,
'title' => '热线报表数据',
'type' => 'directory',
'children' => [
'GetSkillGroupStatusTotal',
'GetAgentDetailReport',
],
],
[
'id' => 164296,
'title' => '在线报表数据',
'type' => 'directory',
'children' => [
'GetSkillGroupServiceStatus',
'GetAgentServiceStatus',
],
],
[
'id' => 164299,
'title' => '坐席管理',
'type' => 'directory',
'children' => [
'CreateAgent',
'DeleteAgent',
'UpdateAgent',
'GetAgent',
'ListAgentBySkillGroupId',
'GetHotlineAgentStatus',
'RemoveAgentFromSkillGroup',
'GetHotlineAgentDetail',
],
],
[
'id' => 164308,
'title' => '技能组管理',
'type' => 'directory',
'children' => [
'CreateSkillGroup',
'UpdateSkillGroup',
'RemoveSkillGroup',
'QuerySkillGroups',
'ListSkillGroup',
'GetDepGroupTreeData',
],
],
[
'id' => 164315,
'title' => '部门管理',
'type' => 'directory',
'children' => [
'CreateDepartment',
'GetAllDepartment',
'DeleteDepartment',
'UpdateDepartment',
],
],
[
'id' => 164333,
'title' => '通道',
'type' => 'directory',
'children' => [
'GenerateWebSocketSign',
],
],
[
'id' => 164335,
'title' => '通话详情',
'type' => 'directory',
'children' => [
'HotlineSessionQuery',
'GetRecordData',
'GetRecordUrl',
'DescribeRecordData',
],
],
[
'id' => 164340,
'title' => '数据统计',
'type' => 'directory',
'children' => [
'GetIndexCurrentValue',
'GetAgentIndexRealTime',
'GetHotlineAgentDetailReport',
'GetHotlineGroupDetailReport',
],
],
[
'id' => 164345,
'title' => '会话数据',
'type' => 'directory',
'children' => [
'QueryTouchList',
'GetCustomerInfo',
'GetHotlineMessageLog',
'GetHotlineCallAction',
],
],
[
'id' => 164350,
'title' => '机器人外呼',
'type' => 'directory',
'children' => [
'RobotCall',
'ListRobotCallDialog',
'ListAiccsRobot',
'ListRobotParams',
'GetCallSoundRecord',
'ListRobotNode',
],
],
[
'id' => 164357,
'title' => '机器人外呼任务',
'type' => 'directory',
'children' => [
'CreateTask',
'AttachTask',
'StartTask',
'StopTask',
'CancelTask',
'ListTask',
'ListTaskDetail',
'ListDialog',
],
],
[
'id' => 164366,
'title' => '智能语音交互',
'type' => 'directory',
'children' => [
'SendCcoSmartCall',
'SendCcoSmartCallOperate',
],
],
[
'id' => 164370,
'title' => '智能外呼任务',
'type' => 'directory',
'children' => [
'CreateAiOutboundTask',
'CreateAiOutboundTaskBatch',
'DeleteAiOutboundTask',
'GetAiOutboundTaskBizData',
'GetAiOutboundTaskExecDetail',
'GetAiOutboundTaskDetail',
'UpdateAiOutboundTask',
'InsertAiOutboundPhoneNums',
'GetAiOutboundTaskProgress',
'StopAiOutboundTask',
'TerminateAiOutboundTask',
'GetAiOutboundTaskList',
'StartAiOutboundTask',
],
],
[
'id' => 164384,
'title' => '号码管理',
'type' => 'directory',
'children' => [
'AddHotlineNumber',
'DeleteHotlineNumber',
'ResetHotlineNumber',
'QueryHotlineNumber',
'GetConfigNumList',
],
],
[
'id' => 164813,
'title' => '话务管理',
'type' => 'directory',
'children' => [
'AnswerCall',
'FinishHotlineService',
'GetNumLocation',
'GetRtcToken',
'HangupCall',
'ListHotlineRecord',
'ListOutboundPhoneNumber',
'MakeDoubleCall',
'SendHotlineHeartBeat',
'StartCall',
'StartHotlineService',
'SuspendHotlineService',
],
],
[
'id' => 165936,
'title' => '其他',
'type' => 'directory',
'children' => [
'AddOuterAccount',
'AiccsSmartCall',
'AiccsSmartCallOperate',
'BatchCreateQualityProjects',
'ChangeChatAgentStatus',
'ChangeQualityProjectStatus',
'CreateOutboundTask',
'CreateQualityProject',
'CreateQualityRule',
'CreateThirdSsoAgent',
'DeleteOutboundTask',
'DeleteOuterAccount',
'DeleteQualityProject',
'DeleteQualityRule',
'EditQualityProject',
'EditQualityRule',
'EditQualityRuleTag',
'EncryptPhoneNum',
'FetchCall',
'GetAgentById',
'GetHotlineRuntimeInfo',
'GetHotlineWaitingNumber',
'GetInstanceList',
'GetMcuLvsIp',
'GetOutbounNumList',
'GetQualityProjectDetail',
'GetQualityProjectList',
'GetQualityProjectLog',
'GetQualityResult',
'GetQualityRuleDetail',
'GetQualityRuleList',
'GetQualityRuleTagList',
'HangUpDoubleCall',
'HangupThirdCall',
'HoldCall',
'InsertTaskDetail',
'JoinThirdCall',
'ListChatRecordDetail',
'ListHotlineRecordDetail',
'ListRoles',
'MakeCall',
'QueryHotlineInQueue',
'QueryOutboundTask',
'QueryTaskDetail',
'QueryTickets',
'RestartOutboundTask',
'StartCallV2',
'StartChatWork',
'StartMicroOutbound',
'SuspendOutboundTask',
'UpdateOuterAccount',
'TransferCallToSkillGroup',
'AddSkillGroup',
'DeleteSkillGroup',
],
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'QueryConversationDetailInfoNew' => [
'summary' => '查询通信智能体呼叫任务明细信息和通话详情信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'TaskId',
'in' => 'query',
'schema' => [
'description' => '任务ID。在[**呼叫任务管理**](https://aiccs.console.aliyun.com/agent/task)界面查看任务ID或通过[QueryAiCallTaskPage](~~2926799~~)接口获取任务ID。',
'type' => 'string',
'required' => true,
'example' => '138************',
],
],
[
'name' => 'DetailId',
'in' => 'query',
'schema' => [
'description' => '任务明细ID。在[**呼叫任务管理**](https://aiccs.console.aliyun.com/agent/task)>**详情**>**执行记录**>**已完成**>**通话详情**界面左上角查看任务明细ID或通过[QueryAiCallDetailPage](~~2926853~~)接口获取任务明细ID。',
'type' => 'string',
'required' => false,
'example' => '9662*************',
],
],
[
'name' => 'CallId',
'in' => 'query',
'schema' => [
'description' => '通话唯一 ID。',
'type' => 'string',
'required' => false,
'example' => '1552********^1420********',
],
],
[
'name' => 'OutId',
'in' => 'query',
'schema' => [
'description' => '预留给外部传入的业务流水号,可用唯一 ID 做业务关联。',
'type' => 'string',
'required' => false,
'example' => '123******',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => [
'description' => '访问被拒绝的详细原因。',
'type' => 'string',
'example' => 'None',
],
'Message' => [
'description' => '状态码描述。 ',
'type' => 'string',
'example' => 'success',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23',
],
'Data' => [
'description' => '返回结果数据。',
'type' => 'object',
'properties' => [
'CallerPhone' => [
'description' => '主叫号码',
'type' => 'string',
'example' => '0571*******',
],
'Options' => [
'description' => '运行时用到的变量信息,会以Key-Value的形式存储在该字段中。',
'type' => 'string',
'example' => '{'."\n"
.' "date": "666",'."\n"
.' "phoneNumber": "777",'."\n"
.' "distance": "555",'."\n"
.' "mendian": "444",'."\n"
.' "sex": "男",'."\n"
.' "name": "111",'."\n"
.' "age": "222"'."\n"
.'}',
],
'CallResult' => [
'description' => '外呼结果。取值:'."\n"
.'- CALL_FORWARDING:呼叫转移。'."\n"
.'- INCOMING_CALL_BARRED:限制呼入。'."\n"
.'- CALL_REJECTED:拒接。'."\n"
.'- ANSWERED:用户接通。'."\n"
.'- USER_BUSY:被叫忙。'."\n"
.'- POWERED_OFF:关机。'."\n"
.'- NO_USER_RESPONSE:不在服务区。'."\n"
.'- OPERATOR_BLOCK:运营商拦截。'."\n"
.'- OTHERS:其他状态。'."\n"
.'- SUSPEND:停机。'."\n"
.'- CANCEL:主叫取消。'."\n"
.'- INVALID_NUMBER:空号。'."\n"
.'- UNAVAILABLE:暂时无法接通。'."\n"
.'- NETWORK_BUSY:网络忙。'."\n"
.'- NO_ANSWER:无应答。',
'type' => 'string',
'example' => 'ANSWERED',
],
'StatusMsg' => [
'description' => '运营商返回的呼叫状态信息。',
'type' => 'string',
'example' => '呼叫结束(双呼)',
],
'ConversationTurnCount' => [
'description' => '对话轮次。',
'type' => 'integer',
'format' => 'int64',
'example' => '23',
],
'TaskId' => [
'description' => '任务ID。',
'type' => 'string',
'example' => '138************',
],
'StartCallTime' => [
'description' => '开始呼叫时间,时间戳,单位:毫秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '1286987391',
],
'StatusCode' => [
'description' => '呼叫状态码。在语音服务[呼叫状态码](~~112804~~)中查看。',
'type' => 'string',
'example' => '200005',
],
'CalledPhone' => [
'description' => '被叫号码',
'type' => 'string',
'example' => '130********',
],
'Variables' => [
'description' => '通话变量信息。',
'type' => 'array',
'items' => [
'description' => '通话变量信息。',
'type' => 'object',
'properties' => [
'Required' => [
'description' => '是否必填',
'type' => 'boolean',
'example' => 'false',
],
'Value' => [
'description' => '变量值',
'type' => 'string',
'example' => 'mike',
],
'Id' => [
'description' => '变量ID',
'type' => 'string',
'example' => '123',
],
'Key' => [
'description' => '变量Key',
'type' => 'string',
'example' => 'name',
],
'Source' => [
'description' => '来源',
'type' => 'string',
'example' => 'source',
],
'Name' => [
'description' => '变量名称。',
'type' => 'string',
'example' => 'user name',
],
],
],
'example' => '',
],
'RecordingFileDownloadUrl' => [
'description' => '录音文件下载地址,只有生成录音文件后才有该字段。',
'type' => 'string',
'example' => 'recording.oss.file',
],
'PickUpTime' => [
'description' => '电话接听时间,时间戳格式,单位毫秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '12349732441',
],
'ConversationRecord' => [
'description' => '聊天记录信息。结构为JSON数组,聊天记录时按照时间顺序已经排序好了。具体如下:'."\n"
.'```json'."\n"
.'['."\n"
.' {'."\n"
.' "content":"聊天内容",'."\n"
.' "role":"角色",//可取值:user(用户)、assistant(机器人)'."\n"
.' }'."\n"
.']'."\n"
.'```',
'type' => 'string',
'example' => '['."\n"
.' {'."\n"
.' "content": "111您好,年龄222,性别男,我这边是**汽车的官方顾问,我们新出了一款车型为**;**已经上市了,售价**万元起,**分钟破*台,您看要不了解一下?",'."\n"
.' "role": "assistant"'."\n"
.' },'."\n"
.' {'."\n"
.' "content": "<客户打断>哎,你是谁?",'."\n"
.' "role": "user"'."\n"
.' },'."\n"
.' {'."\n"
.' "content": "<客户打断>你再说一遍。",'."\n"
.' "role": "user"'."\n"
.' }]',
],
'Status' => [
'description' => '智能体状态。',
'type' => 'integer',
'format' => 'int64',
'example' => '72',
],
'ImportedTime' => [
'description' => '导入时间,时间戳,单位:毫秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '43',
],
'EncryptionType' => [
'type' => 'integer',
'format' => 'int64',
'example' => '28',
],
'MajorIntent' => [
'description' => '主意图',
'type' => 'string',
'example' => 'A',
],
'CallId' => [
'description' => '通话唯一ID。',
'type' => 'string',
'example' => '123*******^213******',
],
'BatchId' => [
'description' => '批次号ID。',
'type' => 'string',
'example' => '1234******',
],
'FailedReason' => [
'description' => '失败原因',
'type' => 'string',
'example' => '主动取消',
],
'Duration' => [
'description' => '通话时长,未打通情况下为0,单位:秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '30',
],
'HangupDirection' => [
'description' => '挂断方向。取值:'."\n"
."\n"
.'- **0**:用户。'."\n"
.'- **1**:机器人。',
'type' => 'string',
'example' => '0',
],
'DetailId' => [
'description' => '任务明细ID。',
'type' => 'string',
'example' => '1234*******',
],
'ReleaseTime' => [
'description' => '通话结束时间,时间戳,单位毫秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '7',
],
'OutId' => [
'description' => '外部传入的业务流水号,可用唯一ID做业务关联。',
'type' => 'string',
'example' => '123***',
],
'OutputTags' => [
'description' => '输出标签信息。',
'type' => 'array',
'items' => [
'description' => '输出标签信息。',
'type' => 'object',
'properties' => [
'OutputTagDescription' => [
'description' => '标签描述信息',
'type' => 'string',
'example' => '评估客户对车型的兴趣和购买可能性',
],
'OutputTagName' => [
'description' => '标签名称。',
'type' => 'string',
'example' => '客户意向度',
],
'OutputTagValue' => [
'description' => '标签值。',
'type' => 'string',
'example' => '["高(非常积极,大概率转化)"]',
],
'Id' => [
'description' => '标签ID。',
'type' => 'string',
'example' => '12',
],
],
],
'example' => '',
],
],
'example' => '',
],
'Code' => [
'description' => '状态码。',
'type' => 'string',
'example' => 'OK',
],
'Success' => [
'description' => '调用接口是否成功。取值:'."\n"
.'- **true**:成功。'."\n"
.'- **false**:失败。',
'type' => 'boolean',
'example' => 'false',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Data\\": {\\n \\"CallerPhone\\": \\"0571*******\\",\\n \\"Options\\": \\"{\\\\n \\\\\\"date\\\\\\": \\\\\\"666\\\\\\",\\\\n \\\\\\"phoneNumber\\\\\\": \\\\\\"777\\\\\\",\\\\n \\\\\\"distance\\\\\\": \\\\\\"555\\\\\\",\\\\n \\\\\\"mendian\\\\\\": \\\\\\"444\\\\\\",\\\\n \\\\\\"sex\\\\\\": \\\\\\"男\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"111\\\\\\",\\\\n \\\\\\"age\\\\\\": \\\\\\"222\\\\\\"\\\\n}\\",\\n \\"CallResult\\": \\"ANSWERED\\",\\n \\"StatusMsg\\": \\"呼叫结束(双呼)\\",\\n \\"ConversationTurnCount\\": 23,\\n \\"TaskId\\": \\"138************\\",\\n \\"StartCallTime\\": 1286987391,\\n \\"StatusCode\\": \\"200005\\",\\n \\"CalledPhone\\": \\"130********\\",\\n \\"Variables\\": [\\n {\\n \\"Required\\": false,\\n \\"Value\\": \\"mike\\",\\n \\"Id\\": \\"123\\",\\n \\"Key\\": \\"name\\",\\n \\"Source\\": \\"source\\",\\n \\"Name\\": \\"user name\\"\\n }\\n ],\\n \\"RecordingFileDownloadUrl\\": \\"recording.oss.file\\",\\n \\"PickUpTime\\": 12349732441,\\n \\"ConversationRecord\\": \\"[\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"111您好,年龄222,性别男,我这边是**汽车的官方顾问,我们新出了一款车型为**;**已经上市了,售价**万元起,**分钟破*台,您看要不了解一下?\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"<客户打断>哎,你是谁?\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"<客户打断>你再说一遍。\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\"\\\\n }]\\",\\n \\"Status\\": 72,\\n \\"ImportedTime\\": 43,\\n \\"EncryptionType\\": 28,\\n \\"MajorIntent\\": \\"A\\",\\n \\"CallId\\": \\"123*******^213******\\",\\n \\"BatchId\\": \\"1234******\\",\\n \\"FailedReason\\": \\"主动取消\\",\\n \\"Duration\\": 30,\\n \\"HangupDirection\\": \\"0\\",\\n \\"DetailId\\": \\"1234*******\\",\\n \\"ReleaseTime\\": 7,\\n \\"OutId\\": \\"123***\\",\\n \\"OutputTags\\": [\\n {\\n \\"OutputTagDescription\\": \\"评估客户对车型的兴趣和购买可能性\\",\\n \\"OutputTagName\\": \\"客户意向度\\",\\n \\"OutputTagValue\\": \\"[\\\\\\"高(非常积极,大概率转化)\\\\\\"]\\",\\n \\"Id\\": \\"12\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]',
'title' => '通信智能体呼叫任务明细及通话详情',
'description' => '- 您可通过此接口查询通信智能体通话详细,也可在[**呼叫任务管理**](https://aiccs.console.aliyun.com/agent/task)>**详情**>**执行记录**>**已完成**>**通话详情**界面查看通话详情。'."\n"
."\n"
.'- 在调用此接口前,请确保您已创建呼叫任务且已导入被叫数据。'."\n"
."\n"
.'- 若您没有已创建的呼叫任务,可在[**呼叫任务管理**](https://aiccs.console.aliyun.com/agent/task)界面创建呼叫任务并导入被叫数据,或通过[CreateAiCallTask](~~2926796~~)、[ImportTaskNumberDatas](~~2926815~~)接口创建呼叫任务并导入被叫数据。',
],
'ImportOneTaskPhoneNumber' => [
'summary' => '导入单个号码数据。',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'TaskId',
'in' => 'query',
'schema' => [
'description' => '任务ID',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '1231231212****',
],
],
[
'name' => 'OutId',
'in' => 'query',
'schema' => [
'description' => '外部流水号,建议使用唯一ID。不能超过128个字符。',
'type' => 'string',
'required' => false,
'example' => '94ba739b-xxxx-ef91-335d-4be006c34899',
],
],
[
'name' => 'PhoneNumber',
'in' => 'query',
'schema' => [
'description' => '被叫手机号。',
'type' => 'string',
'required' => true,
'example' => '180******',
],
],
[
'name' => 'EncryptionType',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '81',
],
],
[
'name' => 'Variables',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '变量列表。Map格式。',
'type' => 'object',
'required' => false,
'example' => '{"变量key1":"变量值1","变量key2":"变量值2"}',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => [
'description' => '访问被拒绝的详细原因。',
'type' => 'string',
'example' => 'None',
],
'Message' => [
'description' => '状态码描述。',
'type' => 'string',
'example' => '成功',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'D6A51251-F7C4-596A-9F45-3C3219A5450D',
],
'Data' => [
'description' => '返回结果',
'type' => 'object',
'properties' => [
'DetailId' => [
'description' => '任务明细ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '92304322323*****',
],
],
'example' => '',
],
'Code' => [
'description' => '状态码。',
'type' => 'string',
'example' => 'OK',
],
'Success' => [
'description' => '调用接口是否成功。取值:'."\n"
.'- **true**:成功。'."\n"
.'- **false**:失败。',
'type' => 'boolean',
'example' => 'false',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"D6A51251-F7C4-596A-9F45-3C3219A5450D\\",\\n \\"Data\\": {\\n \\"DetailId\\": 0\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]',
'title' => '导入单个号码数据',
],
'QueryAiVoiceAgentDetail' => [
'summary' => '查询通信智能体详情信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'AgentId',
'in' => 'query',
'schema' => [
'description' => '智能体ID。',
'type' => 'string',
'required' => false,
'example' => '123123********',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => [
'description' => '访问被拒绝的详细原因。',
'type' => 'string',
'example' => 'None',
],
'Message' => [
'description' => '状态码描述。',
'type' => 'string',
'example' => '成功',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '742C9243-2870-B8D6-0C68-C60BEB2DF09A',
],
'Data' => [
'description' => '智能体详情数据',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '智能体状态。',
'type' => 'integer',
'format' => 'int64',
'enumValueTitles' => [
1 => '已上线',
'已下线',
'审核中',
'审核失败',
'构建中',
'调试中',
'可上线',
'构建失败',
],
'example' => '7',
],
'BusinessTypeName' => [
'description' => '业务场景名称',
'type' => 'string',
'example' => '个人线索转化',
],
'Description' => [
'description' => '智能体说明。',
'type' => 'string',
'example' => '日常测试使用。',
],
'AiVoiceAgentModelConfig' => [
'description' => '智能体模型配置。',
'type' => 'object',
'properties' => [
'BasicTaskDescription' => [
'description' => '基础任务配置。',
'type' => 'string',
'example' => '任务描述。',
],
'MainPurpose' => [
'description' => '主意图配置。',
'type' => 'object',
'properties' => [
'MainPurposeEnum' => [
'description' => '主意图可取值列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Description' => [
'description' => '可取值说明。',
'type' => 'string',
'example' => '意向强烈。',
],
'Value' => [
'description' => '可取值。',
'type' => 'string',
'example' => 'A',
],
'Id' => [
'description' => '可取值唯一ID。',
'type' => 'string',
'example' => 'd5606d80-7625-dcea-xxxx-17f66fbb564a',
],
],
],
'example' => '',
],
'MainPurposeName' => [
'description' => '主意图名称。',
'type' => 'string',
'example' => '通话效果评级',
],
'MainPurposeType' => [
'description' => '主意图取值类型。目前只有ENUM类型。',
'type' => 'string',
'example' => 'ENUM',
],
'MainPurposeDescription' => [
'description' => '主意图说明。',
'type' => 'string',
'example' => '通话效果评级:A、B、C、D,(A最好)',
],
'Id' => [
'description' => '主意图ID。',
'type' => 'string',
'example' => '1ee6e994-08e0-xxxx-f662-1659cc54d409',
],
],
'example' => '',
],
'ChildTaskList' => [
'description' => '子任务配置列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ChildTaskName' => [
'description' => '子任务名称。',
'type' => 'string',
'example' => '开场与邀约',
],
'ChildTaskDescription' => [
'description' => '子任务描述。',
'type' => 'string',
'example' => '新用户邀约: \\"喂,家长您好!我是*****的王老师,我们现在有**课程100个试听名额,想帮宝贝安排一下体验,您看什么时候比较方便呢?\\',
],
'Id' => [
'description' => '子任务唯一ID。',
'type' => 'string',
'example' => '280cd4bf-*******df472c',
],
],
],
'example' => '',
],
'CustomExceptionFileName' => [
'description' => '自定义异常文件名称。',
'type' => 'string',
'example' => '异常测试文件.xlsx',
],
'StartWordType' => [
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'BusinessType' => [
'description' => '业务场景。',
'type' => 'integer',
'format' => 'int64',
'enumValueTitles' => [
1 => '个人客户线索转化',
'企业客户线索转化',
'会员提醒-续费/复购场景',
'会员提醒-促销/赠券场景',
'简单客服-答疑类客服场景',
'其他',
],
'example' => '1',
],
'CustomExceptionUrlPath' => [
'description' => '废弃字段,后续会下掉。',
'type' => 'string',
'example' => '-',
],
'KnowledgeId' => [
'description' => '知识库ID。',
'type' => 'string',
'example' => '1232131*******',
],
'KnowledgeDocOriginalNameList' => [
'description' => '知识库文档原始文件名列表。',
'type' => 'array',
'items' => [
'description' => '文件名。',
'type' => 'string',
'example' => '**会话引擎测试.xlsx',
],
'example' => '',
],
'KnowledgeEnable' => [
'description' => '是否关联知识库。',
'type' => 'boolean',
'example' => 'false',
],
'CustomExceptionEnable' => [
'description' => '是否开启自定义异常处理。',
'type' => 'boolean',
'example' => 'false',
],
'Prologue' => [
'description' => '开场白。',
'type' => 'string',
'example' => '你好,这里是******。',
],
'CustomExceptionFileId' => [
'description' => '自定义异常文件ID。',
'type' => 'string',
'example' => 'OSS文件ID',
],
'PhoneTagConfig' => [
'description' => '通话变量配置。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'PhoneTagType' => [
'description' => '变量值类型。',
'type' => 'string',
'enumValueTitles' => [
'ENUM' => '枚举类型',
'TEXT' => '文本类型',
],
'example' => 'ENUM',
],
'PhoneTagName' => [
'description' => '变量中文名称。',
'type' => 'string',
'example' => '意向车系',
],
'PhoneTagRequired' => [
'description' => '是否必填。',
'type' => 'boolean',
'example' => 'true',
],
'Id' => [
'description' => '变量唯一ID。',
'type' => 'string',
'example' => '280cd4bf-*******df472c'."\n",
],
'PhoneTagSource' => [
'type' => 'string',
'example' => '示例值',
],
'PhoneTagDescription' => [
'description' => '变量描述。',
'type' => 'string',
'example' => '用户感兴趣的车系。',
],
'PhoneTagEnum' => [
'description' => '变量枚举值列表。只有变量值类型为ENUM时才有该字段。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Description' => [
'description' => '枚举值描述。',
'type' => 'string',
'example' => '客户完全不接受挽留',
],
'Value' => [
'description' => '枚举值。',
'type' => 'string',
'example' => '完全不接受',
],
'Id' => [
'description' => '枚举值唯一ID。',
'type' => 'string',
'example' => 'c3d4ff4e-*********bc26dc044682',
],
],
],
'example' => '',
],
'PhoneTagKey' => [
'description' => '变量键名。',
'type' => 'string',
'example' => 'testParam',
],
],
],
'example' => '',
],
'FlowDesc' => [
'description' => '高级任务流程描述。',
'type' => 'string',
'example' => '这次外呼通过三个核心步骤与家长沟通,........ 3. 用户需求 > 主动介绍',
],
'UserRole' => [
'description' => '用户角色。',
'type' => 'string',
'example' => '急需课程的新用户',
],
'TaskType' => [
'description' => '任务类型。',
'type' => 'string',
'enumValueTitles' => [
'BASIC' => '基础任务',
'ADVANCED' => '高级任务',
],
'example' => 'ADVANCED',
],
'SysRole' => [
'description' => '系统角色。',
'type' => 'string',
'example' => '课程销售',
],
'OutputTagConfig' => [
'description' => '输出标签配置。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'OutputTagDescription' => [
'description' => '标签描述信息。',
'type' => 'string',
'example' => '记录本次通话的最终状态',
],
'OutputTagType' => [
'description' => '标签值类型。',
'type' => 'string',
'enumValueTitles' => [
'ENUM' => '枚举类型',
'TEXT' => '文本类型',
],
'example' => 'ENUM',
],
'OutputTagEnum' => [
'description' => '标签枚举值,只有标签值类型为ENUM时才有该字段。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Description' => [
'description' => '标签枚举值描述。',
'type' => 'string',
'example' => '高(非常积极,大概率转化)',
],
'Value' => [
'description' => '标签枚举值。',
'type' => 'string',
'example' => '高',
],
'Id' => [
'description' => '标签枚举值唯一ID。',
'type' => 'string',
'example' => '8757************2c499fa',
],
],
],
'example' => '',
],
'OutputTagName' => [
'description' => '标签名称。',
'type' => 'string',
'example' => '客户意向度',
],
'Id' => [
'description' => '标签唯一ID。',
'type' => 'string',
'example' => '8757************2c499fa'."\n",
],
],
],
'example' => '',
],
'CustomExceptionVoiceStyle' => [
'description' => '语言风格。',
'type' => 'integer',
'format' => 'int64',
'enumValueTitles' => [
1 => '平实',
'亲切',
'专业',
'严肃',
],
'example' => '2',
],
'RecordingFile' => [
'type' => 'string',
'example' => '示例值',
],
'CustomExceptionList' => [
'description' => '废弃字段,后续会下掉。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ExceptionType' => [
'description' => '异常类型',
'type' => 'string',
'example' => '-',
],
'SupportBreak' => [
'description' => '是否支持打断。',
'type' => 'boolean',
'example' => 'false',
],
'Reply' => [
'description' => '回复内容。',
'type' => 'string',
'example' => '-',
],
'ExceptionSign' => [
'description' => '是否作为异常标签输出。',
'type' => 'boolean',
'example' => 'true',
],
],
],
'example' => '',
],
'KnowledgeDocNameList' => [
'description' => '知识文档名列表。',
'type' => 'array',
'items' => [
'description' => '文件名。',
'type' => 'string',
'example' => '117d2********388f2a615be5c0d3546e.xlsx',
],
'example' => '',
],
'KnowledgeDocIdList' => [
'description' => '知识文档ID列表。',
'type' => 'array',
'items' => [
'description' => '知识文档ID。',
'type' => 'string',
'example' => '12213******',
],
'example' => '',
],
],
'example' => '',
],
'KnowledgeName' => [
'description' => '知识库名称。',
'type' => 'string',
'example' => '测试知识库',
],
'VoiceStyleName' => [
'description' => '语言风格名称。',
'type' => 'string',
'example' => '亲切',
],
'AgentId' => [
'description' => '智能体ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '12311212******',
],
'AgentName' => [
'description' => '智能体名称。',
'type' => 'string',
'example' => '测试智能体',
],
'AiVoiceAgentCallConfig' => [
'description' => '智能外呼语音配置。',
'type' => 'object',
'properties' => [
'VocabId' => [
'description' => '热词ID',
'type' => 'string',
'example' => 'afb2c43**********83e6df30551c11f7',
],
'TtsConfig' => [
'description' => 'TTS配置。',
'type' => 'object',
'properties' => [
'VoiceCode' => [
'type' => 'string',
'example' => '示例值',
],
'MixingTemplate' => [
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'BackgroundEnabled' => [
'type' => 'boolean',
'example' => 'true',
],
'TtsVolume' => [
'description' => 'TTS 播放的音量。'."\n"
.'> '."\n"
.'> - 取值范围:0~100,默认值为0。'."\n"
.'> - 不设置值时,默认取大模型应用配置的音量。',
'type' => 'integer',
'format' => 'int64',
'example' => '72',
],
'TtsStyle' => [
'description' => '音色风格。',
'type' => 'string',
'example' => 'longxiaoxia_v2p1',
],
'VoiceType' => [
'type' => 'string',
'example' => '示例值',
],
'MixingEnabled' => [
'type' => 'boolean',
'example' => 'true',
],
'TtsSpeed' => [
'description' => 'TTS 播放时的声音速度。'."\n"
."\n"
.'> '."\n"
.'> - 取值范围:-200~200,默认值为 0;'."\n"
.'> - 不设置值时,默认取大模型应用配置的声音速度;',
'type' => 'integer',
'format' => 'int64',
'example' => '34',
],
'BackgroundSound' => [
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'BackgroundVolume' => [
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
],
'example' => '',
],
'EventConfig' => [
'description' => '通话事件配置。',
'type' => 'object',
'properties' => [
'MuteActive' => [
'description' => '第一个静音是否唤起模型。',
'type' => 'boolean',
'example' => 'false',
],
'SessionTimeout' => [
'description' => '最大通话时长,超时后自动挂断。单位:秒。'."\n"
.'>'."\n"
.'>- 最大取值:3600s。'."\n"
.'>- 最小取值:600s。',
'type' => 'integer',
'format' => 'int64',
'example' => '600',
],
'CallAssistantHangup' => [
'description' => '识别到智能接听是否挂断。',
'type' => 'boolean',
'example' => 'false',
],
'CallAssistantRecognize' => [
'description' => '智能接听识别是否开启。',
'type' => 'boolean',
'example' => 'true',
],
'MuteDuration' => [
'description' => '静音时长。'."\n"
.'>'."\n"
.'>- 最大取值:15s。'."\n"
.'>- 最小取值:3s。',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'MuteHangupNum' => [
'description' => '连续多少个静音事件主动挂机。'."\n"
.'>'."\n"
.'>- 最大取值:5。'."\n"
.'>- 最小取值:1。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
],
'example' => '',
],
],
'example' => '',
],
],
'example' => '',
],
'Code' => [
'description' => '状态码。',
'type' => 'string',
'example' => 'OK',
],
'Success' => [
'description' => '调用接口是否成功。取值:'."\n"
.'- **true**:成功。'."\n"
.'- **false**:失败。',
'type' => 'boolean',
'example' => 'false',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"742C9243-2870-B8D6-0C68-C60BEB2DF09A\\",\\n \\"Data\\": {\\n \\"Status\\": 7,\\n \\"BusinessTypeName\\": \\"个人线索转化\\",\\n \\"Description\\": \\"日常测试使用。\\",\\n \\"AiVoiceAgentModelConfig\\": {\\n \\"BasicTaskDescription\\": \\"任务描述。\\",\\n \\"MainPurpose\\": {\\n \\"MainPurposeEnum\\": [\\n {\\n \\"Description\\": \\"意向强烈。\\",\\n \\"Value\\": \\"A\\",\\n \\"Id\\": \\"d5606d80-7625-dcea-xxxx-17f66fbb564a\\"\\n }\\n ],\\n \\"MainPurposeName\\": \\"通话效果评级\\",\\n \\"MainPurposeType\\": \\"ENUM\\",\\n \\"MainPurposeDescription\\": \\"通话效果评级:A、B、C、D,(A最好)\\",\\n \\"Id\\": \\"1ee6e994-08e0-xxxx-f662-1659cc54d409\\"\\n },\\n \\"ChildTaskList\\": [\\n {\\n \\"ChildTaskName\\": \\"开场与邀约\\",\\n \\"ChildTaskDescription\\": \\"新用户邀约: \\\\\\\\\\\\\\"喂,家长您好!我是*****的王老师,我们现在有**课程100个试听名额,想帮宝贝安排一下体验,您看什么时候比较方便呢?\\\\\\\\\\",\\n \\"Id\\": \\"280cd4bf-*******df472c\\"\\n }\\n ],\\n \\"CustomExceptionFileName\\": \\"异常测试文件.xlsx\\",\\n \\"StartWordType\\": 1,\\n \\"BusinessType\\": 1,\\n \\"CustomExceptionUrlPath\\": \\"-\\",\\n \\"KnowledgeId\\": \\"1232131*******\\",\\n \\"KnowledgeDocOriginalNameList\\": [\\n \\"**会话引擎测试.xlsx\\"\\n ],\\n \\"KnowledgeEnable\\": false,\\n \\"CustomExceptionEnable\\": false,\\n \\"Prologue\\": \\"你好,这里是******。\\",\\n \\"CustomExceptionFileId\\": \\"OSS文件ID\\",\\n \\"PhoneTagConfig\\": [\\n {\\n \\"PhoneTagType\\": \\"ENUM\\",\\n \\"PhoneTagName\\": \\"意向车系\\",\\n \\"PhoneTagRequired\\": true,\\n \\"Id\\": \\"280cd4bf-*******df472c\\\\n\\",\\n \\"PhoneTagSource\\": \\"示例值\\",\\n \\"PhoneTagDescription\\": \\"用户感兴趣的车系。\\",\\n \\"PhoneTagEnum\\": [\\n {\\n \\"Description\\": \\"客户完全不接受挽留\\",\\n \\"Value\\": \\"完全不接受\\",\\n \\"Id\\": \\"c3d4ff4e-*********bc26dc044682\\"\\n }\\n ],\\n \\"PhoneTagKey\\": \\"testParam\\"\\n }\\n ],\\n \\"FlowDesc\\": \\"这次外呼通过三个核心步骤与家长沟通,........ 3. 用户需求 > 主动介绍\\",\\n \\"UserRole\\": \\"急需课程的新用户\\",\\n \\"TaskType\\": \\"ADVANCED\\",\\n \\"SysRole\\": \\"课程销售\\",\\n \\"OutputTagConfig\\": [\\n {\\n \\"OutputTagDescription\\": \\"记录本次通话的最终状态\\",\\n \\"OutputTagType\\": \\"ENUM\\",\\n \\"OutputTagEnum\\": [\\n {\\n \\"Description\\": \\"高(非常积极,大概率转化)\\",\\n \\"Value\\": \\"高\\",\\n \\"Id\\": \\"8757************2c499fa\\"\\n }\\n ],\\n \\"OutputTagName\\": \\"客户意向度\\",\\n \\"Id\\": \\"8757************2c499fa\\\\n\\"\\n }\\n ],\\n \\"CustomExceptionVoiceStyle\\": 2,\\n \\"RecordingFile\\": \\"示例值\\",\\n \\"CustomExceptionList\\": [\\n {\\n \\"ExceptionType\\": \\"-\\",\\n \\"SupportBreak\\": false,\\n \\"Reply\\": \\"-\\",\\n \\"ExceptionSign\\": true\\n }\\n ],\\n \\"KnowledgeDocNameList\\": [\\n \\"117d2********388f2a615be5c0d3546e.xlsx\\"\\n ],\\n \\"KnowledgeDocIdList\\": [\\n \\"12213******\\"\\n ]\\n },\\n \\"KnowledgeName\\": \\"测试知识库\\",\\n \\"VoiceStyleName\\": \\"亲切\\",\\n \\"AgentId\\": 0,\\n \\"AgentName\\": \\"测试智能体\\",\\n \\"AiVoiceAgentCallConfig\\": {\\n \\"VocabId\\": \\"afb2c43**********83e6df30551c11f7\\",\\n \\"TtsConfig\\": {\\n \\"VoiceCode\\": \\"示例值\\",\\n \\"MixingTemplate\\": 1,\\n \\"BackgroundEnabled\\": true,\\n \\"TtsVolume\\": 72,\\n \\"TtsStyle\\": \\"longxiaoxia_v2p1\\",\\n \\"VoiceType\\": \\"示例值\\",\\n \\"MixingEnabled\\": true,\\n \\"TtsSpeed\\": 34,\\n \\"BackgroundSound\\": 1,\\n \\"BackgroundVolume\\": 1\\n },\\n \\"EventConfig\\": {\\n \\"MuteActive\\": false,\\n \\"SessionTimeout\\": 600,\\n \\"CallAssistantHangup\\": false,\\n \\"CallAssistantRecognize\\": true,\\n \\"MuteDuration\\": 10,\\n \\"MuteHangupNum\\": 1\\n }\\n }\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]',
'title' => '查询通信智能体详情信息',
],
'PageQueryAgentList' => [
'summary' => '分页查询智能体列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'AgentId',
'in' => 'query',
'schema' => [
'description' => '智能体ID。',
'type' => 'string',
'required' => false,
'example' => '1231*******',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '页大小,默认10。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '10',
],
],
[
'name' => 'PageNo',
'in' => 'query',
'schema' => [
'description' => '页编号,从1开始,默认1。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
],
[
'name' => 'AgentName',
'in' => 'query',
'schema' => [
'description' => '智能体名称。',
'type' => 'string',
'required' => false,
'example' => '测试智能体',
],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => [
'description' => '智能体状态。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'enumValueTitles' => [
1 => '已上线',
'已下线',
'审核中',
'审核失败',
'构建中',
'调试中',
'可上线',
'构建失败',
],
'example' => '7',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => [
'description' => '访问被拒绝的详细原因。',
'type' => 'string',
'example' => 'Access Denied',
],
'Message' => [
'description' => '状态码描述。',
'type' => 'string',
'example' => '成功',
],
'RequestId' => [
'description' => '请求ID',
'type' => 'string',
'example' => '742C9243-2870-B8D6-0C68-C60BEB2DF09A',
],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'PageSize' => [
'description' => '每页大小。',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'Total' => [
'description' => '总条数。',
'type' => 'integer',
'format' => 'int64',
'example' => '14',
],
'List' => [
'description' => '智能体数据列表。',
'type' => 'array',
'items' => [
'description' => '数据',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '智能体状态',
'type' => 'integer',
'format' => 'int64',
'enumValueTitles' => [
1 => '已上线',
'已下线',
'审核中',
'审核失败',
'构建中',
'调试中',
'可上线',
'构建失败',
],
'example' => '7',
],
'LastOnlineTime' => [
'description' => '最近一次上线时间。',
'type' => 'string',
'example' => '2025-10-28 14:38:15',
],
'ModifyTime' => [
'description' => '最近一次修改时间。',
'type' => 'string',
'example' => '2025-10-28 17:10:17',
],
'Description' => [
'description' => '智能体说明。',
'type' => 'string',
'example' => '用于日常测试',
],
'CreateTime' => [
'description' => '创建时间。',
'type' => 'string',
'example' => '2025-10-28 17:10:17',
],
'AuditReason' => [
'description' => '审核失败原因。',
'type' => 'string',
'example' => '请补充流程说明',
],
'BuildFailReason' => [
'description' => '构建失败原因',
'type' => 'string',
'example' => '系统错误',
],
'ApplicationCode' => [
'description' => '应用Code',
'type' => 'string',
'example' => 'DFAS*****',
],
'BusinessTypeName' => [
'description' => '业务场景名称',
'type' => 'string',
'example' => '个人客户线索转化',
],
'WithConfig' => [
'description' => '智能体是否已经配置过。',
'type' => 'boolean',
'example' => 'false',
],
'AgentName' => [
'description' => '智能体名称。',
'type' => 'string',
'example' => '测试智能体',
],
'AgentId' => [
'description' => '智能体ID。',
'type' => 'string',
'example' => '121312*******',
],
'WithActivePrompt' => [
'type' => 'boolean',
'example' => 'false',
],
],
],
'example' => '',
],
'PageNo' => [
'description' => '页面编号。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
],
'example' => '',
],
'Code' => [
'description' => '状态码。',
'type' => 'string',
'example' => 'OK',
],
'Success' => [
'description' => '调用接口是否成功。取值:'."\n"
.'- **true**:成功。'."\n"
.'- **false**:失败。',
'type' => 'boolean',
'example' => 'false',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"Access Denied\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"742C9243-2870-B8D6-0C68-C60BEB2DF09A\\",\\n \\"Data\\": {\\n \\"PageSize\\": 10,\\n \\"Total\\": 14,\\n \\"List\\": [\\n {\\n \\"Status\\": 7,\\n \\"LastOnlineTime\\": \\"2025-10-28 14:38:15\\",\\n \\"ModifyTime\\": \\"2025-10-28 17:10:17\\",\\n \\"Description\\": \\"用于日常测试\\",\\n \\"CreateTime\\": \\"2025-10-28 17:10:17\\",\\n \\"AuditReason\\": \\"请补充流程说明\\",\\n \\"BuildFailReason\\": \\"系统错误\\",\\n \\"ApplicationCode\\": \\"DFAS*****\\",\\n \\"BusinessTypeName\\": \\"个人客户线索转化\\",\\n \\"WithConfig\\": false,\\n \\"AgentName\\": \\"测试智能体\\",\\n \\"AgentId\\": \\"121312*******\\",\\n \\"WithActivePrompt\\": false\\n }\\n ],\\n \\"PageNo\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]',
'title' => '查询通信智能体列表',
],
'QueryConversationDetailInfo' => [
'summary' => '查询通信智能体呼叫通话详情信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'TaskId',
'in' => 'query',
'schema' => [
'description' => '任务ID。在[**呼叫任务管理**](https://aiccs.console.aliyun.com/agent/task)界面查看任务ID或通过[QueryAiCallTaskPage](~~2926799~~)接口获取任务ID。',
'type' => 'string',
'required' => true,
'example' => '138************',
],
],
[
'name' => 'DetailId',
'in' => 'query',
'schema' => [
'description' => '任务明细ID。在[**呼叫任务管理**](https://aiccs.console.aliyun.com/agent/task)>**详情**>**执行记录**>**已完成**>**通话详情**界面左上角查看任务明细ID或通过[QueryAiCallDetailPage](~~2926853~~)接口获取任务明细ID。',
'type' => 'string',
'required' => true,
'example' => '9662*************',
],
],
[
'name' => 'BatchId',
'in' => 'query',
'schema' => [
'description' => '任务批次ID。即为导入被叫数据时返回的批次ID,在[**呼叫任务管理**](https://aiccs.console.aliyun.com/agent/task)>**详情**>**执行记录**界面查看任务批次ID或通过[ImportTaskNumberDatas](~~2926815~~)接口导入被叫数据时返回的导入批次ID。',
'type' => 'string',
'required' => true,
'example' => '139*********216',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => [
'description' => '访问被拒绝详细信息。',
'type' => 'string',
'example' => 'None',
],
'Message' => [
'description' => '状态码描述。',
'type' => 'string',
'example' => '成功',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'F2051E18-FF3F-5C08-8D24-6F150D2AF757',
],
'Data' => [
'description' => '返回结果数据。',
'type' => 'object',
'properties' => [
'CallerPhone' => [
'description' => '主叫号码',
'type' => 'string',
'example' => '0571*******',
],
'EncryptionType' => [
'type' => 'string',
'example' => '示例值',
],
'CallResult' => [
'description' => '外呼结果。取值:'."\n"
.'- CALL_FORWARDING:呼叫转移。'."\n"
.'- INCOMING_CALL_BARRED:限制呼入。'."\n"
.'- CALL_REJECTED:拒接。'."\n"
.'- ANSWERED:用户接通。'."\n"
.'- USER_BUSY:被叫忙。'."\n"
.'- POWERED_OFF:关机。'."\n"
.'- NO_USER_RESPONSE:不在服务区。'."\n"
.'- OPERATOR_BLOCK:运营商拦截。'."\n"
.'- OTHERS:其他状态。'."\n"
.'- SUSPEND:停机。'."\n"
.'- CANCEL:主叫取消。'."\n"
.'- INVALID_NUMBER:空号。'."\n"
.'- UNAVAILABLE:暂时无法接通。'."\n"
.'- NETWORK_BUSY:网络忙。'."\n"
.'- NO_ANSWER:无应答。',
'type' => 'string',
'example' => 'ANSWERED',
],
'StatusMsg' => [
'description' => '运营商返回的呼叫状态信息。',
'type' => 'string',
'example' => '呼叫结束(双呼)',
],
'StartCallTime' => [
'description' => '开始呼叫时间,时间戳,单位:毫秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '123123123123123',
],
'MajorIntent' => [
'description' => '主意图',
'type' => 'string',
'example' => 'D',
],
'CallId' => [
'description' => '通话唯一ID。',
'type' => 'string',
'example' => '1231231231213^11231231231',
],
'FailedReason' => [
'description' => '失败原因',
'type' => 'string',
'example' => '主动取消',
],
'Duration' => [
'description' => '通话时长,未打通情况下为0,单位:秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '16',
],
'HangupDirection' => [
'description' => '挂断方向。取值:'."\n"
."\n"
.'- **0**:用户。'."\n"
.'- **1**:机器人。',
'type' => 'string',
'example' => '用户',
],
'StatusCode' => [
'description' => '呼叫状态码。在语音服务[呼叫状态码](~~112804~~)中查看。',
'type' => 'string',
'example' => '200005',
],
'CalledPhone' => [
'description' => '被叫号码',
'type' => 'string',
'example' => '186******',
],
'Variables' => [
'description' => '通话变量列表。即为您创建的呼叫任务所关联的通信智能体中配置的通话变量。',
'type' => 'array',
'items' => [
'description' => '通话变量信息。',
'type' => 'object',
'properties' => [
'Required' => [
'description' => '是否必填。取值:'."\n"
."\n"
.'- true:是。'."\n"
."\n"
.'- false:否。',
'type' => 'boolean',
'example' => 'false',
],
'Value' => [
'description' => '变量值。',
'type' => 'string',
'example' => '张三',
],
'Id' => [
'description' => '变量ID。',
'type' => 'string',
'example' => '22',
],
'Key' => [
'description' => '变量Key。',
'type' => 'string',
'example' => 'name',
],
'Source' => [
'type' => 'string',
'example' => '示例值',
],
'Name' => [
'description' => '变量名称。',
'type' => 'string',
'example' => '姓名',
],
],
],
'example' => '',
],
'RecordingFileDownloadUrl' => [
'description' => '录音文件下载地址,只有生成录音文件后才有该字段。',
'type' => 'string',
'example' => 'https://********',
],
'ReleaseTime' => [
'description' => '通话结束时间,时间戳,单位毫秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '98',
],
'PickUpTime' => [
'description' => '电话接听时间。时间戳格式,单位:毫秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '1754617273000',
],
'OutId' => [
'description' => '外部传入的业务流水号,可用唯一ID做业务关联。',
'type' => 'string',
'example' => 'bb3bc32d-54b8-49c4-80d3-61583417d22e'."\n",
],
'ConversationRecord' => [
'description' => '聊天记录信息。结构为JSON数组,聊天记录时按照时间顺序已经排序好了。具体如下:'."\n"
.'```json'."\n"
.'['."\n"
.' {'."\n"
.' "content":"聊天内容",'."\n"
.' "role":"角色",//可取值:user(用户)、assistant(机器人)'."\n"
.' }'."\n"
.']'."\n"
.'```',
'type' => 'string',
'example' => '['."\n"
.' {'."\n"
.' "content": "111您好,年龄222,性别男,我这边是**汽车的官方顾问,我们新出了一款车型为**;**已经上市了,售价**万元起,**分钟破*台,您看要不了解一下?",'."\n"
.' "role": "assistant"'."\n"
.' },'."\n"
.' {'."\n"
.' "content": "<客户打断>哎,你是谁?",'."\n"
.' "role": "user"'."\n"
.' },'."\n"
.' {'."\n"
.' "content": "<客户打断>你再说一遍。",'."\n"
.' "role": "user"'."\n"
.' },'."\n"
.' {'."\n"
.' "content": "哎,我没听清。",'."\n"
.' "role": "user"'."\n"
.' },'."\n"
.' {'."\n"
.' "content": "你在说什么?",'."\n"
.' "role": "user"'."\n"
.' },'."\n"
.' {'."\n"
.' "content": "您好,",'."\n"
.' "role": "assistant"'."\n"
.' },'."\n"
.' {'."\n"
.' "content": "我是**汽车总部销售服务顾问。",'."\n"
.' "role": "assistant"'."\n"
.' },'."\n"
.' {'."\n"
.' "content": "我们最近推出了一款新车**,想了解一下您是否对这款车型感兴趣?",'."\n"
.' "role": "assistant"'."\n"
.' },'."\n"
.' {'."\n"
.' "content": "<客户打断>哎,那我是谁?",'."\n"
.' "role": "user"'."\n"
.' },'."\n"
.' {'."\n"
.' "content": "你在说什么呢?",'."\n"
.' "role": "user"'."\n"
.' },'."\n"
.' {'."\n"
.' "content": "抱歉打扰了,111先生。",'."\n"
.' "role": "assistant"'."\n"
.' },'."\n"
.' {'."\n"
.' "content": "祝您生活愉快!再见!",'."\n"
.' "role": "assistant"'."\n"
.' }'."\n"
.']',
],
'OutputTags' => [
'description' => '输出标签列表。',
'type' => 'array',
'items' => [
'description' => '输出标签信息。',
'type' => 'object',
'properties' => [
'OutputTagDescription' => [
'description' => '标签描述信息。',
'type' => 'string',
'example' => '评估客户对车型的兴趣和购买可能性',
],
'OutputTagName' => [
'description' => '标签名称。',
'type' => 'string',
'example' => '客户意向度',
],
'OutputTagValue' => [
'description' => '标签值。',
'type' => 'string',
'example' => '["高(非常积极,大概率转化)"]',
],
'Id' => [
'description' => '标签ID。',
'type' => 'string',
'example' => '9ca2*****************************',
],
],
],
'example' => '',
],
],
'example' => '',
],
'Code' => [
'description' => '状态码。',
'type' => 'string',
'example' => 'OK',
],
'Success' => [
'description' => '调用接口是否成功。取值:'."\n"
.'- **true**:成功。'."\n"
.'- **false**:失败。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"F2051E18-FF3F-5C08-8D24-6F150D2AF757\\",\\n \\"Data\\": {\\n \\"CallerPhone\\": \\"0571*******\\",\\n \\"EncryptionType\\": \\"示例值\\",\\n \\"CallResult\\": \\"ANSWERED\\",\\n \\"StatusMsg\\": \\"呼叫结束(双呼)\\",\\n \\"StartCallTime\\": 123123123123123,\\n \\"MajorIntent\\": \\"D\\",\\n \\"CallId\\": \\"1231231231213^11231231231\\",\\n \\"FailedReason\\": \\"主动取消\\",\\n \\"Duration\\": 16,\\n \\"HangupDirection\\": \\"用户\\",\\n \\"StatusCode\\": \\"200005\\",\\n \\"CalledPhone\\": \\"186******\\",\\n \\"Variables\\": [\\n {\\n \\"Required\\": false,\\n \\"Value\\": \\"张三\\",\\n \\"Id\\": \\"22\\",\\n \\"Key\\": \\"name\\",\\n \\"Source\\": \\"示例值\\",\\n \\"Name\\": \\"姓名\\"\\n }\\n ],\\n \\"RecordingFileDownloadUrl\\": \\"https://********\\",\\n \\"ReleaseTime\\": 98,\\n \\"PickUpTime\\": 1754617273000,\\n \\"OutId\\": \\"bb3bc32d-54b8-49c4-80d3-61583417d22e\\\\n\\",\\n \\"ConversationRecord\\": \\"[\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"111您好,年龄222,性别男,我这边是**汽车的官方顾问,我们新出了一款车型为**;**已经上市了,售价**万元起,**分钟破*台,您看要不了解一下?\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"<客户打断>哎,你是谁?\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"<客户打断>你再说一遍。\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"哎,我没听清。\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"你在说什么?\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"您好,\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"我是**汽车总部销售服务顾问。\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"我们最近推出了一款新车**,想了解一下您是否对这款车型感兴趣?\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"<客户打断>哎,那我是谁?\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"你在说什么呢?\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"抱歉打扰了,111先生。\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"祝您生活愉快!再见!\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\"\\\\n }\\\\n]\\",\\n \\"OutputTags\\": [\\n {\\n \\"OutputTagDescription\\": \\"评估客户对车型的兴趣和购买可能性\\",\\n \\"OutputTagName\\": \\"客户意向度\\",\\n \\"OutputTagValue\\": \\"[\\\\\\"高(非常积极,大概率转化)\\\\\\"]\\",\\n \\"Id\\": \\"9ca2*****************************\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '通信智能体呼叫通话详情',
'description' => '- 您可通过此接口查询通信智能体通话详细,也可在[**呼叫任务管理**](https://aiccs.console.aliyun.com/agent/task)>**详情**>**执行记录**>**已完成**>**通话详情**界面查看通话详情。'."\n"
."\n"
.'- 在调用此接口前,请确保您已创建呼叫任务且已导入被叫数据。'."\n"
."\n"
.'- 若您没有已创建的呼叫任务,可在[**呼叫任务管理**](https://aiccs.console.aliyun.com/agent/task)界面创建呼叫任务并导入被叫数据,或通过[CreateAiCallTask](~~2926796~~)、[ImportTaskNumberDatas](~~2926815~~)接口创建呼叫任务并导入被叫数据。',
],
'QueryAiCallDetailPage' => [
'summary' => '分页查询通信智能体外呼任务明细。',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '269272',
'abilityTreeNodes' => [
'FEATUREaiccsTY5M4L',
],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'TaskId',
'in' => 'query',
'schema' => [
'description' => '任务ID。',
'type' => 'string',
'required' => true,
'example' => '1187**************',
],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => [
'description' => '任务状态。取值:'."\n"
."\n"
.'- 0:待完成。'."\n"
."\n"
.'- 1:已完成。'."\n"
."\n"
.'- 2:失败。',
'type' => 'integer',
'format' => 'int64',
'required' => true,
'enumValueTitles' => [],
'example' => '0',
],
],
[
'name' => 'BatchId',
'in' => 'query',
'schema' => [
'description' => '批次号ID。在[外呼任务管理](https://aiccs.console.aliyun.com/agent/task)界面单击详情查看批次号ID。',
'type' => 'string',
'required' => false,
'example' => '1183**************'."\n",
],
],
[
'name' => 'CalledNumber',
'in' => 'query',
'schema' => [
'description' => '被叫号码。',
'type' => 'string',
'required' => false,
'example' => '053714454****',
],
],
[
'name' => 'EncryptionType',
'in' => 'query',
'schema' => [
'description' => '加密方式。0: 不加密;1: MD5;2: SHA256;3: SM3;',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
],
[
'name' => 'CallResult',
'in' => 'query',
'schema' => [
'description' => '外呼结果。取值:'."\n"
.'- CALL_FORWARDING:呼叫转移。'."\n"
.'- INCOMING_CALL_BARRED:限制呼入。'."\n"
.'- CALL_REJECTED:拒接。'."\n"
.'- ANSWERED:用户接通。'."\n"
.'- USER_BUSY:被叫忙。'."\n"
.'- POWERED_OFF:关机。'."\n"
.'- NO_USER_RESPONSE:不在服务区。'."\n"
.'- OPERATOR_BLOCK:运营商拦截。'."\n"
.'- OTHERS:其他状态。'."\n"
.'- SUSPEND:停机。'."\n"
.'- CANCEL:主叫取消。'."\n"
.'- INVALID_NUMBER:空号。'."\n"
.'- UNAVAILABLE:暂时无法接通。'."\n"
.'- NETWORK_BUSY:网络忙。'."\n"
.'- NO_ANSWER:无应答。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'ANSWERED',
],
],
[
'name' => 'MajorIntent',
'in' => 'query',
'schema' => [
'description' => '主意图。在[通信智能体管理](https://aiccs.console.aliyun.com/agent/customize)界面单击智能体详情查看主意图。',
'type' => 'string',
'required' => false,
'example' => 'A',
],
],
[
'name' => 'MinConversationDuration',
'in' => 'query',
'schema' => [
'description' => '通话时长下限。单位:分钟。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '0',
],
],
[
'name' => 'MaxConversationDuration',
'in' => 'query',
'schema' => [
'description' => '通话时长上限。单位:分钟。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '20',
],
],
[
'name' => 'StartImportedTime',
'in' => 'query',
'schema' => [
'description' => '起始导入时间,时间戳,单位:ms。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1748948749000',
],
],
[
'name' => 'EndImportedTime',
'in' => 'query',
'schema' => [
'description' => '结束导入时间,时间戳,单位:ms。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1748948749000',
],
],
[
'name' => 'StartCallingTime',
'in' => 'query',
'schema' => [
'description' => '起始外呼时间,时间戳,单位:ms。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1748948749000',
],
],
[
'name' => 'EndCallingTime',
'in' => 'query',
'schema' => [
'description' => '结束外呼时间,时间戳,单位:ms。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1748948749000',
],
],
[
'name' => 'OutId',
'in' => 'query',
'schema' => [
'description' => '预留给调用方使用的ID。最终会通过在回执消息中将此ID带回给调用方。',
'type' => 'string',
'required' => false,
'example' => '94ba739b-c01a-ef91-335d-4be006c34899',
],
],
[
'name' => 'DetailIds',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '任务明细ID列表,最多不能超过100个。',
'type' => 'array',
'items' => [
'description' => '明细ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '992913231****',
],
'required' => false,
'example' => '示例值示例值',
],
],
[
'name' => 'PageNo',
'in' => 'query',
'schema' => [
'description' => '当前页。取值大于**0**,默认值:**1**。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
'default' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '每页数量。默认值:**10**。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '10',
'default' => '10',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => [
'description' => '访问被拒绝的详细原因。',
'type' => 'string',
'example' => 'None',
],
'Message' => [
'description' => '状态码描述。',
'type' => 'string',
'example' => '成功',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'A57441B2-8EB6-5B93-9F37-0A51B8E2C9F5',
],
'Data' => [
'description' => '返回结果数据。',
'type' => 'object',
'properties' => [
'PageSize' => [
'description' => '分页大小。',
'type' => 'integer',
'format' => 'int64',
'example' => '5',
],
'Total' => [
'description' => '总共记录数。',
'type' => 'integer',
'format' => 'int64',
'example' => '2',
],
'PageNo' => [
'description' => '当前页。',
'type' => 'integer',
'format' => 'int64',
'example' => '60',
],
'List' => [
'description' => '任务明细数据列表。',
'type' => 'array',
'items' => [
'description' => '任务明细数据。',
'type' => 'object',
'properties' => [
'ImportedTime' => [
'description' => '导入时间,时间戳,单位:毫秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '1748948749000',
],
'Status' => [
'description' => '任务明细状态。'."\n"
.'- 0:初始化'."\n"
.'- 1:等待外呼中'."\n"
.'- 2:等待重试中'."\n"
.'- 3:外呼中'."\n"
.'- 4:外呼结束'."\n"
.'- 5:外呼失败'."\n"
."\n"
.'只有4和5属于终态。',
'type' => 'integer',
'format' => 'int64',
'example' => '4',
],
'Options' => [
'description' => '运行时用到的变量信息,会以Key-Value的形式存储在该字段中。',
'type' => 'string',
'example' => '{'."\n"
.' "date": "666",'."\n"
.' "phoneNumber": "777",'."\n"
.' "distance": "555",'."\n"
.' "mendian": "444",'."\n"
.' "sex": "男",'."\n"
.' "name": "111",'."\n"
.' "age": "222"'."\n"
.'}',
],
'EncryptionType' => [
'description' => '加密方式:0-不加密;1-MD5;2-SHA256;3-SM3',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'CalledNumber' => [
'description' => '被叫号码。',
'type' => 'string',
'example' => '0537101****',
],
'CallResult' => [
'description' => '呼叫结果。',
'type' => 'string',
'example' => '用户接通',
],
'ConversationTurnCount' => [
'description' => '对话轮次。',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'TaskId' => [
'description' => '任务ID。',
'type' => 'string',
'example' => '1187**************',
],
'BatchId' => [
'description' => '批次号ID。',
'type' => 'string',
'example' => '1183**************',
],
'MajorIntent' => [
'description' => '主意图。',
'type' => 'string',
'example' => 'A',
],
'FailedReason' => [
'description' => '呼叫失败原因,只有呼叫失败时才会有。',
'type' => 'string',
'example' => '账户停机',
],
'BranchId' => [
'type' => 'integer',
'format' => 'int64',
'example' => '49',
],
'RecordingFilePath' => [
'description' => '录音文件下载路径,只有录音文件生成后才有该字段。',
'type' => 'string',
'example' => 'https://*******',
],
'CallingTime' => [
'description' => '呼叫时间,时间戳,单位:毫秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '1748948749000',
],
'DetailId' => [
'description' => '任务明细ID。',
'type' => 'string',
'example' => '9662*************',
],
'OutId' => [
'type' => 'string',
'example' => 'outId',
],
'BranchVersionId' => [
'type' => 'integer',
'format' => 'int64',
'example' => '9',
],
'ConversationRecord' => [
'description' => '聊天记录信息。结构为JSON数组,聊天记录时按照时间顺序已经排序好了。具体如下:'."\n"
.'```json'."\n"
.'['."\n"
.' {'."\n"
.' "content":"聊天内容",'."\n"
.' "role":"角色",//可取值:user(用户)、assistant(机器人)'."\n"
.' }'."\n"
.']'."\n"
.'```',
'type' => 'string',
'example' => '['."\n"
.' {'."\n"
.' "content": "111您好,年龄222,性别男,我这边是**汽车的官方顾问,我们新出了一款车型为**;**已经上市了,售价**万元起,**分钟破*台,您看要不了解一下?",'."\n"
.' "role": "assistant"'."\n"
.' },'."\n"
.' {'."\n"
.' "content": "<客户打断>哎,你是谁?",'."\n"
.' "role": "user",'."\n"
.' },'."\n"
.' {'."\n"
.' "content": "<客户打断>你再说一遍。",'."\n"
.' "role": "user",'."\n"
.' },'."\n"
.' {'."\n"
.' "content": "哎,我没听清。",'."\n"
.' "role": "user",'."\n"
.' },'."\n"
.' {'."\n"
.' "content": "你在说什么?",'."\n"
.' "role": "user",'."\n"
.' },'."\n"
.' {'."\n"
.' "content": "您好,",'."\n"
.' "role": "assistant",'."\n"
.' },'."\n"
.' {'."\n"
.' "content": "我是**汽车总部销售服务顾问。",'."\n"
.' "role": "assistant",'."\n"
.' },'."\n"
.' {'."\n"
.' "content": "我们最近推出了一款新车**,想了解一下您是否对这款车型感兴趣?",'."\n"
.' "role": "assistant",'."\n"
.' },'."\n"
.' {'."\n"
.' "content": "<客户打断>哎,那我是谁?",'."\n"
.' "role": "user",'."\n"
.' },'."\n"
.' {'."\n"
.' "content": "你在说什么呢?",'."\n"
.' "role": "user",'."\n"
.' },'."\n"
.' {'."\n"
.' "content": "抱歉打扰了,111先生。",'."\n"
.' "role": "assistant",'."\n"
.' },'."\n"
.' {'."\n"
.' "content": "祝您生活愉快!再见!",'."\n"
.' "role": "assistant",'."\n"
.' }'."\n"
.']',
],
'ConversationDuration' => [
'description' => '通话时长,单位:秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
],
],
'example' => '',
],
],
],
'Code' => [
'description' => '状态码。',
'type' => 'string',
'example' => 'OK',
],
'Success' => [
'description' => '调用接口是否成功。取值:'."\n"
.'- **true**:成功。'."\n"
.'- **false**:失败。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"A57441B2-8EB6-5B93-9F37-0A51B8E2C9F5\\",\\n \\"Data\\": {\\n \\"PageSize\\": 5,\\n \\"Total\\": 2,\\n \\"PageNo\\": 60,\\n \\"List\\": [\\n {\\n \\"ImportedTime\\": 1748948749000,\\n \\"Status\\": 4,\\n \\"Options\\": \\"{\\\\n \\\\\\"date\\\\\\": \\\\\\"666\\\\\\",\\\\n \\\\\\"phoneNumber\\\\\\": \\\\\\"777\\\\\\",\\\\n \\\\\\"distance\\\\\\": \\\\\\"555\\\\\\",\\\\n \\\\\\"mendian\\\\\\": \\\\\\"444\\\\\\",\\\\n \\\\\\"sex\\\\\\": \\\\\\"男\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"111\\\\\\",\\\\n \\\\\\"age\\\\\\": \\\\\\"222\\\\\\"\\\\n}\\",\\n \\"EncryptionType\\": 1,\\n \\"CalledNumber\\": \\"0537101****\\",\\n \\"CallResult\\": \\"用户接通\\",\\n \\"ConversationTurnCount\\": 10,\\n \\"TaskId\\": \\"1187**************\\",\\n \\"BatchId\\": \\"1183**************\\",\\n \\"MajorIntent\\": \\"A\\",\\n \\"FailedReason\\": \\"账户停机\\",\\n \\"BranchId\\": 49,\\n \\"RecordingFilePath\\": \\"https://*******\\",\\n \\"CallingTime\\": 1748948749000,\\n \\"DetailId\\": \\"9662*************\\",\\n \\"OutId\\": \\"outId\\",\\n \\"BranchVersionId\\": 9,\\n \\"ConversationRecord\\": \\"[\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"111您好,年龄222,性别男,我这边是**汽车的官方顾问,我们新出了一款车型为**;**已经上市了,售价**万元起,**分钟破*台,您看要不了解一下?\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"<客户打断>哎,你是谁?\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\",\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"<客户打断>你再说一遍。\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\",\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"哎,我没听清。\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\",\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"你在说什么?\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\",\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"您好,\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\",\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"我是**汽车总部销售服务顾问。\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\",\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"我们最近推出了一款新车**,想了解一下您是否对这款车型感兴趣?\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\",\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"<客户打断>哎,那我是谁?\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\",\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"你在说什么呢?\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\",\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"抱歉打扰了,111先生。\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\",\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"祝您生活愉快!再见!\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\",\\\\n }\\\\n]\\",\\n \\"ConversationDuration\\": 100\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '查询通信智能体外呼任务明细',
'description' => '- 在查询通信智能体外呼任务明细之前,请确保您已创建外呼任务。'."\n"
."\n"
.'- 若您没有创建外呼任务,可在[外呼任务管理](https://aiccs.console.aliyun.com/agent/task)界面创建外呼任务或者通过[CreateAiCallTask](~~2926796~~)接口创建外呼任务。',
],
'StopAiCallTask' => [
'summary' => '停止通信智能体呼出任务。',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'TaskId',
'in' => 'query',
'schema' => [
'description' => '任务ID。',
'type' => 'string',
'required' => true,
'example' => '1187**************',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => [
'description' => '访问被拒绝的详细原因。',
'type' => 'string',
'example' => 'None',
],
'Message' => [
'description' => '状态码描述。',
'type' => 'string',
'example' => '成功',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '7124F972-BAB8-5D1E-90FC-01CB10713B29',
],
'Data' => [
'description' => '返回数据结果。取值:'."\n"
.'- **true**:成功。'."\n"
.'- **false**:失败。',
'type' => 'boolean',
'enumValueTitles' => [],
'example' => 'true',
],
'Code' => [
'description' => '请求状态码。返回OK代表请求成功。',
'type' => 'string',
'example' => 'OK',
],
'Success' => [
'description' => '调用接口是否成功。取值:'."\n"
.'- **true**:成功。'."\n"
.'- **false**:失败。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"7124F972-BAB8-5D1E-90FC-01CB10713B29\\",\\n \\"Data\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '停止通信智能体呼出任务',
'description' => '- 在停止通信智能体呼出任务之前,请确保您已创建呼出任务且任务状态为运行中。'."\n"
."\n"
.'- 若您没有已创建的呼出任务,请先在[呼出任务管理](https://aiccs.console.aliyun.com/agent/task)界面创建呼出任务或通过[CreateAiCallTask](~~2926796~~)接口创建呼出任务。',
],
'CancelAiCallDetails' => [
'summary' => '通信智能体呼叫任务取消呼叫,如明细记录已经进入待呼队列或者正在呼叫,则无法取消。',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'TaskId',
'in' => 'query',
'schema' => [
'description' => '任务ID。在[呼叫任务管理](https://aiccs.console.aliyun.com/agent/task)界面查看任务ID或通过[QueryAiCallTaskPage](~~2926799~~)接口获取任务ID。',
'type' => 'string',
'required' => true,
'example' => '138************'."\n",
],
],
[
'name' => 'DetailIdList',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '任务明细ID列表,如果指定了该参数,则以该参数为准,BatchId和PhoneNumbers无效。',
'type' => 'array',
'items' => [
'description' => '任务明细ID。在[**呼叫任务管理**](https://aiccs.console.aliyun.com/agent/task)>**详情**>**执行记录**>**已完成**>**通话详情**界面左上角查看任务明细ID或通过[QueryAiCallDetailPage](~~2926853~~)接口获取任务明细ID。',
'type' => 'string',
'required' => false,
'example' => '12131231*****',
],
'required' => false,
],
],
[
'name' => 'BatchId',
'in' => 'query',
'schema' => [
'description' => '批次ID。即为导入被叫数据时返回的批次ID,在[**呼叫任务管理**](https://aiccs.console.aliyun.com/agent/task)>**详情**>**执行记录**界面查看任务批次ID或通过[ImportTaskNumberDatas](~~2926815~~)接口导入被叫数据时返回的导入批次ID,如果指定了DetailIdList,则该参数无效。',
'type' => 'string',
'required' => false,
'example' => '4253331213*****',
],
],
[
'name' => 'PhoneNumbers',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '手机号列表,如果需要使用该参数,则必须指定BatchId,否则认为参数无效。',
'type' => 'array',
'items' => [
'description' => '手机号。即为需要取消呼叫任务的手机号码,为导入被叫数据时传入的手机号码。',
'type' => 'string',
'required' => false,
'example' => '180*******',
],
'required' => false,
'example' => '',
],
],
[
'name' => 'EncryptionType',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '36',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => [
'description' => '访问被拒绝的详细原因。',
'type' => 'string',
'example' => 'None',
],
'Message' => [
'description' => '状态码描述。',
'type' => 'string',
'example' => '成功',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '46C98E28-9239-5D95-AC76-648B8FD4889A',
],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'TotalCount' => [
'description' => '总量。',
'type' => 'integer',
'format' => 'int64',
'example' => '50',
],
'FailedDetails' => [
'description' => '失败明细情况。是个Map,Key为失败的明细ID或者手机号码,Value为失败原因。',
'type' => 'object',
'example' => '{'."\n"
.' "176********": "明细记录当前状态不可取消"'."\n"
.'}',
],
'FailedCount' => [
'description' => '未成功取消是数量。',
'type' => 'integer',
'format' => 'int64',
'example' => '75',
],
'SucceedCount' => [
'description' => '成功取消的数量。',
'type' => 'integer',
'format' => 'int64',
'example' => '81',
],
'ResultCode' => [
'description' => '取消结果。取值:'."\n"
.'- ALL_FAILED:全部取消失败。'."\n"
.'- ALL_SUCCEED:全部取消成功。'."\n"
.'- PART_FAILED:部分取消失败。',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'PART_FAILED',
],
],
'example' => '',
],
'Code' => [
'description' => '状态码。',
'type' => 'string',
'example' => 'OK',
],
'Success' => [
'description' => '调用接口是否成功。取值:'."\n"
.'- **true**:成功。'."\n"
.'- **false**:失败。'."\n",
'type' => 'boolean',
'example' => 'false',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"46C98E28-9239-5D95-AC76-648B8FD4889A\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 50,\\n \\"FailedDetails\\": {\\n \\"176********\\": \\"明细记录当前状态不可取消\\"\\n },\\n \\"FailedCount\\": 75,\\n \\"SucceedCount\\": 81,\\n \\"ResultCode\\": \\"PART_FAILED\\"\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]',
'title' => '通信智能体呼叫任务取消呼叫',
'description' => '- 您可调用此接口取消通信智能体呼叫任务,也可在[**呼叫任务管理**](https://aiccs.console.aliyun.com/agent/task)>**管理**>**执行记录**>**待完成**界面手动取消通信智能体呼叫任务。'."\n"
."\n"
.'- 调用此接口之前,请确保您已创建呼叫任务且已导入被叫数据。'."\n"
."\n"
.'- 若您没有已创建的呼叫任务,可在呼叫任务管理界面创建呼叫任务并导入被叫数据,或通过[CreateAiCallTask](~~2926796~~)、[ImportTaskNumberDatas](~~2926815~~)接口创建呼叫任务并导入被叫数据。'."\n"
."\n"
.'- 通信智能体呼叫任务取消呼叫后,可能会对您的业务造成影响,请谨慎操作。',
],
'StartAiCallTask' => [
'summary' => '启动通信智能体外呼任务。',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'TaskId',
'in' => 'query',
'schema' => [
'description' => '任务ID。',
'type' => 'string',
'required' => true,
'example' => '1187**************',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => [
'description' => '访问被拒绝的详细原因。',
'type' => 'string',
'example' => 'None',
],
'Message' => [
'description' => '状态码描述。',
'type' => 'string',
'example' => '成功',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '58A32FFF-86EE-5CF0-B365-97E8C574C7F4',
],
'Data' => [
'description' => '启动结果。取值:'."\n"
.'- **true**:成功。'."\n"
.'- **false**:失败。',
'type' => 'boolean',
'enumValueTitles' => [],
'example' => 'false',
],
'Code' => [
'description' => '请求状态码。返回OK代表请求成功。',
'type' => 'string',
'example' => 'OK',
],
'Success' => [
'description' => '调用接口是否成功。取值:'."\n"
.'- **true**:成功。'."\n"
.'- **false**:失败。',
'type' => 'boolean',
'example' => 'false',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"58A32FFF-86EE-5CF0-B365-97E8C574C7F4\\",\\n \\"Data\\": false,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]',
'title' => '启动通信智能体外呼任务',
'description' => '- 在启动通信智能体呼出任务之前,请确保您的呼出任务状态为已停止。'."\n"
."\n"
.'- 若您没有已创建的呼叫任务,请先在[呼叫任务管理](https://aiccs.console.aliyun.com/agent/task)界面创建呼叫任务或通过[CreateAiCallTask](~~2926796~~)接口创建呼叫任务。',
],
'UpdateAiCallTask' => [
'summary' => '更新通信智能体外呼任务配置。',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'TaskName',
'in' => 'query',
'schema' => [
'description' => '任务名称,同一个账号下不允许重复。',
'type' => 'string',
'required' => true,
'example' => '测试任务',
],
],
[
'name' => 'VirtualNumber',
'in' => 'query',
'schema' => [
'description' => '呼出使用的服务实例。',
'type' => 'string',
'required' => false,
'example' => '0537022*****',
],
],
[
'name' => 'StartType',
'in' => 'query',
'schema' => [
'description' => '启动方式。取值:'."\n"
."\n"
.'- IMMEDIATE:立即启动。'."\n"
."\n"
.'- SCHEDULE:定时启动。',
'type' => 'string',
'required' => true,
'example' => 'IMMEDIATE',
],
],
[
'name' => 'MissCallRetry',
'in' => 'query',
'schema' => [
'description' => '是否开启重试。取值:'."\n"
."\n"
.'- true:是。'."\n"
."\n"
.'- false(默认):否。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'CallRetryReason',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '失败重试原因。',
'type' => 'array',
'items' => [
'description' => '具体重试原因。取值:'."\n"
."\n"
.'- CALL_REJECTED:拒接。'."\n"
."\n"
.'- USER_BUSY:被叫忙。'."\n"
."\n"
.'- SUSPEND:停机。'."\n"
."\n"
.'- INVALID_NUMBER:空号。'."\n"
."\n"
.'- POWERED_OFF:关机。'."\n"
."\n"
.'- NETWORK_BUSY:网络忙。'."\n"
."\n"
.'- NO_ANSWER:无应答。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'CALL_REJECTED',
],
'required' => false,
],
],
[
'name' => 'CallRetryTimes',
'in' => 'query',
'schema' => [
'description' => '重试次数,最大不能超过3次。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '2',
],
],
[
'name' => 'CallRetryInterval',
'in' => 'query',
'schema' => [
'description' => '重试间隔,单位:分钟,最大不能超过120分钟。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '25',
],
],
[
'name' => 'CallTime',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '可呼叫时间。',
'type' => 'array',
'items' => [
'description' => '呼叫时间段,格式如下:'."\n"
.'```json'."\n"
.'{"startTime":"09:00:00","endTime":"10:00:00"}'."\n"
.'```'."\n"
.'`startTime`代表开始时间,`endTime`代表结束时间,仅处于这个时间段内的时刻才会发起呼出调度,否则将等待下一个可调度是间段到来。',
'type' => 'string',
'required' => false,
'example' => '{"startTime":"09:00:00","endTime":"10:00:00"}',
],
'required' => true,
],
],
[
'name' => 'CallDay',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '可外呼日。',
'type' => 'array',
'items' => [
'description' => '可外呼日。取值:'."\n"
."\n"
.'- MONDAY:周一。'."\n"
."\n"
.'- TUESDAY:周二。'."\n"
."\n"
.'- WEDNESDAY:周三。'."\n"
."\n"
.'- THURSDAY:周四。'."\n"
."\n"
.'- FRIDAY:周五。'."\n"
."\n"
.'- SATURDAY:周六。'."\n"
."\n"
.'- SUNDAY:周天。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [
'WEDNESDAY' => '周三',
'MONDAY' => '周一',
'THURSDAY' => '周四',
'SUNDAY' => '周天',
'TUESDAY' => '周二',
'FRIDAY' => '周五',
'SATURDAY' => '周六',
],
'example' => 'MONDAY',
],
'required' => true,
],
],
[
'name' => 'TaskStartTime',
'in' => 'query',
'schema' => [
'description' => '任务预设的启动时间,时间戳,单位毫秒。StarType字段为SCHEDULE时该字段有效且必填,任务将在该字段设置的时间进行自动启动。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1748923429000',
],
],
[
'name' => 'TaskId',
'in' => 'query',
'schema' => [
'description' => '待更新的任务ID。',
'type' => 'string',
'required' => true,
'example' => '1187**************',
],
],
[
'name' => 'TaskCps',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int64',
'required' => true,
'example' => '57',
'default' => '',
],
],
[
'name' => 'PhoneType',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '53',
],
],
[
'name' => 'LineEncoding',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
'example' => '示例值示例值示例值',
],
],
[
'name' => 'LinePhoneNum',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
'example' => '示例值示例值',
],
],
[
'name' => 'Source',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '31',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => [
'description' => '访问被拒绝的详细原因。',
'type' => 'string',
'example' => 'None',
],
'Message' => [
'description' => '错误信息。仅当返回异常时显示。',
'type' => 'string',
'example' => '参数不合法',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'FCD94A7F-316D-54D1-9BFC-814006CB1C34',
],
'Data' => [
'description' => '更新结果。取值:'."\n"
."\n"
.'- **true**:更新成功。'."\n"
."\n"
.'- **false**:更新失败。',
'type' => 'boolean',
'example' => 'true',
],
'Code' => [
'description' => '状态码。',
'type' => 'string',
'example' => 'OK',
],
'Success' => [
'description' => '接口调用是否成功。取值:'."\n"
.'- **true**:成功。'."\n"
.'- **false**:失败。',
'type' => 'boolean',
'example' => 'false',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"参数不合法\\",\\n \\"RequestId\\": \\"FCD94A7F-316D-54D1-9BFC-814006CB1C34\\",\\n \\"Data\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]',
'title' => '更新通信智能体外呼任务配置',
'description' => '在更新通信智能体外呼任务配置前,请先确保外呼任务的状态为已停止。',
],
'QueryAiCallTaskPage' => [
'summary' => '查询通信智能体外呼任务列表。',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'PageNo',
'in' => 'query',
'schema' => [
'description' => '当前页。取值大于**0**,默认值:**1**。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
'default' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页查询时设置的每页行数。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '20',
'default' => '10',
],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => [
'description' => '任务状态。取值:'."\n"
.'- INIT:初始化(未启动)。'."\n"
.'- FAILED:启动失败。'."\n"
.'- RUNNING:运行中。'."\n"
.'- STOPPED:已停止。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'INIT',
],
],
[
'name' => 'TaskName',
'in' => 'query',
'schema' => [
'description' => '任务名称,系统根据任务名称模糊检索。',
'type' => 'string',
'required' => false,
'example' => '测试任务',
],
],
[
'name' => 'AgentName',
'in' => 'query',
'schema' => [
'description' => '智能体名称,系统根据智能体名称模糊检索。',
'type' => 'string',
'required' => false,
'example' => '测试智能体',
],
],
[
'name' => 'TaskId',
'in' => 'query',
'schema' => [
'description' => '任务ID。',
'type' => 'string',
'required' => false,
'example' => '1187**************'."\n",
],
],
[
'name' => 'ApplicationCode',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
'example' => '示例值',
],
],
[
'name' => 'Source',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '68',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => [
'description' => '访问被拒绝的详细原因。',
'type' => 'string',
'example' => 'None',
],
'Message' => [
'description' => '错误信息,正常调用时,不会返回该参数。',
'type' => 'string',
'example' => '参数不合法',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'B99C5955-5664-573D-97BE-A7CC1AFD8401',
],
'Data' => [
'description' => '任务详细信息。',
'type' => 'object',
'properties' => [
'PageSize' => [
'description' => '每页的数量。',
'type' => 'integer',
'format' => 'int64',
'example' => '74',
],
'Total' => [
'description' => '总记录数。',
'type' => 'integer',
'format' => 'int64',
'example' => '72',
],
'PageNo' => [
'description' => '当前页码。',
'type' => 'integer',
'format' => 'int64',
'example' => '37',
],
'List' => [
'description' => '任务数据。',
'type' => 'array',
'items' => [
'description' => '任务数据列表。',
'type' => 'object',
'properties' => [
'Status' => [
'description' => '任务状态。',
'type' => 'integer',
'format' => 'int64',
'enumValueTitles' => [
'初始化',
'运行中',
'已停止',
'启动失败',
],
'example' => '1',
],
'TaskId' => [
'description' => '任务ID。',
'type' => 'string',
'enumValueTitles' => [],
'example' => '1187**************',
],
'CompleteRate' => [
'description' => '任务完成率。',
'type' => 'string',
'example' => '70%',
],
'ApplicationName' => [
'type' => 'string',
'example' => '示例值',
],
'CreateTime' => [
'description' => '创建时间,时间戳,单位:毫秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '1748932499000',
],
'StartTime' => [
'description' => '任务计划启动时间,时间戳,单位:毫秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '1748932499000',
],
'RealStartTime' => [
'description' => '任务真实启动时间,时间戳,单位:毫秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '1748932499000',
],
'TotalCallCount' => [
'description' => '任务累计呼叫量。',
'type' => 'integer',
'format' => 'int64',
'example' => '58',
],
'DayCallCount' => [
'description' => '当天的呼叫量。',
'type' => 'integer',
'format' => 'int64',
'example' => '22',
],
'ApplicationCode' => [
'type' => 'string',
'example' => '示例值',
],
'TotalCount' => [
'description' => '任务总量。',
'type' => 'integer',
'format' => 'int64',
'example' => '71',
],
'TaskName' => [
'description' => '任务名称。',
'type' => 'string',
'example' => '测试任务',
],
'StartFailedReason' => [
'description' => '启动失败原因。',
'type' => 'string',
'example' => '智能体不在线',
],
'FailedCount' => [
'description' => '任务运行失败总量。',
'type' => 'integer',
'format' => 'int64',
'example' => '61',
],
'AgentName' => [
'description' => '智能体名称。',
'type' => 'string',
'example' => '测试智能体',
],
'CallingCount' => [
'description' => '正在通话量。',
'type' => 'integer',
'format' => 'int64',
'example' => '72',
],
'AgentId' => [
'description' => '智能体编码。',
'type' => 'string',
'example' => '1180**************'."\n",
],
'SucceedCount' => [
'description' => '任务运行成功总量。',
'type' => 'integer',
'format' => 'int64',
'example' => '36',
],
'DayImportCount' => [
'description' => '当天导入数据量。',
'type' => 'integer',
'format' => 'int64',
'example' => '400',
],
'ConcurrentCount' => [
'description' => '任务并发。',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
'HistoryConnectRate' => [
'description' => '历史接通率。历史接通率=历史接通数量➗累计呼叫量(TotalCallCount)。',
'type' => 'string',
'example' => '95.89%',
],
'DayConnectRate' => [
'description' => '当天接通率。当天接通率=当天接通数➗当天呼叫量(DayCallCount)。',
'type' => 'string',
'example' => '74.14%',
],
],
],
'example' => '',
],
],
],
'Code' => [
'description' => '状态码。',
'type' => 'string',
'example' => 'OK',
],
'Success' => [
'description' => '调用接口是否成功。取值:'."\n"
.'- **true**:成功。'."\n"
.'- **false**:失败。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"参数不合法\\",\\n \\"RequestId\\": \\"B99C5955-5664-573D-97BE-A7CC1AFD8401\\",\\n \\"Data\\": {\\n \\"PageSize\\": 74,\\n \\"Total\\": 72,\\n \\"PageNo\\": 37,\\n \\"List\\": [\\n {\\n \\"Status\\": 1,\\n \\"TaskId\\": \\"1187**************\\",\\n \\"CompleteRate\\": \\"70%\\",\\n \\"ApplicationName\\": \\"示例值\\",\\n \\"CreateTime\\": 1748932499000,\\n \\"StartTime\\": 1748932499000,\\n \\"RealStartTime\\": 1748932499000,\\n \\"TotalCallCount\\": 58,\\n \\"DayCallCount\\": 22,\\n \\"ApplicationCode\\": \\"示例值\\",\\n \\"TotalCount\\": 71,\\n \\"TaskName\\": \\"测试任务\\",\\n \\"StartFailedReason\\": \\"智能体不在线\\",\\n \\"FailedCount\\": 61,\\n \\"AgentName\\": \\"测试智能体\\",\\n \\"CallingCount\\": 72,\\n \\"AgentId\\": \\"1180**************\\\\n\\",\\n \\"SucceedCount\\": 36,\\n \\"DayImportCount\\": 400,\\n \\"ConcurrentCount\\": 10,\\n \\"HistoryConnectRate\\": \\"95.89%\\",\\n \\"DayConnectRate\\": \\"74.14%\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '查询通信智能体外呼任务列表',
],
'QueryAiCallTaskDetail' => [
'summary' => '查询通信智能体外呼任务基础信息。',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'TaskId',
'in' => 'query',
'schema' => [
'description' => '任务ID。',
'type' => 'string',
'required' => true,
'example' => '1187**************',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => [
'description' => '访问被拒绝详细信息,只有RAM校验失败才会返回此字段。',
'type' => 'string',
'example' => 'None',
],
'Message' => [
'description' => '错误信息,正常调用时,不会返回该参数。',
'type' => 'string',
'example' => '参数无效',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '23822ECB-8CAA-5C52-9C9E-807FD82A5A7F',
],
'Data' => [
'description' => '返回结果数据。',
'type' => 'object',
'properties' => [
'TaskId' => [
'description' => '任务ID。',
'type' => 'string',
'example' => '1187**************'."\n",
],
'ApplicationName' => [
'type' => 'string',
'example' => '示例值',
],
'RetryEnable' => [
'description' => '是否开启外呼重试。取值:'."\n"
.'- true:开启。'."\n"
.'- false:未开启。',
'type' => 'boolean',
'enumValueTitles' => [],
'example' => 'true',
],
'StartTime' => [
'description' => '任务预设启动时间,时间戳,单位:毫秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '1748932499000',
],
'RealStartTime' => [
'description' => '任务真实启动时间,时间戳,单位:毫秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '1748932499000',
],
'LinePhoneNum' => [
'type' => 'string',
'example' => '示例值',
],
'ApplicationCode' => [
'type' => 'string',
'example' => '示例值',
],
'CallerNumber' => [
'description' => '主叫号码。',
'type' => 'string',
'example' => '05370124****',
],
'CallTimes' => [
'description' => '允许外呼时间。',
'type' => 'array',
'items' => [
'description' => '允许呼叫时间段配置。',
'type' => 'object',
'properties' => [
'EndTime' => [
'description' => '结束时间。',
'type' => 'string',
'example' => '09:00:00',
],
'StartTime' => [
'description' => '开始时间。',
'type' => 'string',
'example' => '12:00:00',
],
],
],
'example' => '',
],
'RetryReasons' => [
'description' => '允许失败重呼的原因列表。',
'type' => 'array',
'items' => [
'description' => '具体重试原因。取值:'."\n"
."\n"
.'- CALL_REJECTED:拒接。'."\n"
."\n"
.'- USER_BUSY:被叫忙。'."\n"
."\n"
.'- SUSPEND:停机。'."\n"
."\n"
.'- INVALID_NUMBER:空号。'."\n"
."\n"
.'- POWERED_OFF:关机。'."\n"
."\n"
.'- NETWORK_BUSY:网络忙。'."\n"
."\n"
.'- NO_ANSWER:无应答。',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'CALL_REJECTED',
],
'example' => '',
],
'RetryCount' => [
'description' => '重呼次数。',
'type' => 'integer',
'format' => 'int64',
'example' => '2',
],
'PhoneType' => [
'type' => 'integer',
'format' => 'int64',
'example' => '17',
],
'TaskName' => [
'description' => '任务名称。',
'type' => 'string',
'example' => '测试任务',
],
'LineEncoding' => [
'type' => 'string',
'example' => '示例值',
],
'StartType' => [
'description' => '启动方式。取值:'."\n"
."\n"
.'- IMMEDIATE:立即启动。'."\n"
."\n"
.'- SCHEDULE:定时启动。',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'IMMEDIATE',
],
'AgentName' => [
'description' => '智能体名称。',
'type' => 'string',
'example' => '测试智能体',
],
'AgentId' => [
'description' => '已上线的智能体编码。',
'type' => 'string',
'example' => '1180**************'."\n",
],
'RetryInterval' => [
'description' => '重试间隔。单位:分钟。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
'CallDays' => [
'description' => '可外呼日列表。',
'type' => 'array',
'items' => [
'description' => '可外呼日。取值:'."\n"
."\n"
.'- MONDAY:周一。'."\n"
."\n"
.'- TUESDAY:周二。'."\n"
."\n"
.'- WEDNESDAY:周三。'."\n"
."\n"
.'- THURSDAY:周四。'."\n"
."\n"
.'- FRIDAY:周五。'."\n"
."\n"
.'- SATURDAY:周六。'."\n"
."\n"
.'- SUNDAY:周天。',
'type' => 'string',
'enumValueTitles' => [],
'example' => 'MONDAY',
],
'example' => '',
],
'ConcurrentCount' => [
'description' => '任务并发。',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
],
'example' => '',
],
'Code' => [
'description' => '错误编码。',
'type' => 'string',
'example' => 'OK',
],
'Success' => [
'description' => '调用接口是否成功。取值:'."\n"
.'- **true**:成功。'."\n"
.'- **false**:失败。',
'type' => 'boolean',
'example' => 'false',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"参数无效\\",\\n \\"RequestId\\": \\"23822ECB-8CAA-5C52-9C9E-807FD82A5A7F\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"1187**************\\\\n\\",\\n \\"ApplicationName\\": \\"示例值\\",\\n \\"RetryEnable\\": true,\\n \\"StartTime\\": 1748932499000,\\n \\"RealStartTime\\": 1748932499000,\\n \\"LinePhoneNum\\": \\"示例值\\",\\n \\"ApplicationCode\\": \\"示例值\\",\\n \\"CallerNumber\\": \\"05370124****\\",\\n \\"CallTimes\\": [\\n {\\n \\"EndTime\\": \\"09:00:00\\",\\n \\"StartTime\\": \\"12:00:00\\"\\n }\\n ],\\n \\"RetryReasons\\": [\\n \\"CALL_REJECTED\\"\\n ],\\n \\"RetryCount\\": 2,\\n \\"PhoneType\\": 17,\\n \\"TaskName\\": \\"测试任务\\",\\n \\"LineEncoding\\": \\"示例值\\",\\n \\"StartType\\": \\"IMMEDIATE\\",\\n \\"AgentName\\": \\"测试智能体\\",\\n \\"AgentId\\": \\"1180**************\\\\n\\",\\n \\"RetryInterval\\": 1,\\n \\"CallDays\\": [\\n \\"MONDAY\\"\\n ],\\n \\"ConcurrentCount\\": 10\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]',
'title' => '查询通信智能体外呼任务基础信息',
],
'ImportTaskNumberDatas' => [
'summary' => '通信智能体呼叫任务导入被叫数据。',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '268865',
'abilityTreeNodes' => [
'FEATUREaiccsTY5M4L',
],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'OssFileName',
'in' => 'query',
'schema' => [
'description' => 'OSS文件路径,非必填。'."\n"
.'> API调用暂时不支持Excel数据类型。因此上传OSS文件路径的方式暂不可用。',
'type' => 'string',
'required' => false,
'example' => '123dsdfsdfsdf.xlsx',
],
],
[
'name' => 'TaskId',
'in' => 'query',
'schema' => [
'description' => '任务ID。',
'type' => 'string',
'required' => true,
'example' => '119181071278******',
],
],
[
'name' => 'PhoneNumberList',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '如果DataType采用JSON列表,则需要通过该字段上传数据,且单次不能超过1000条。',
'type' => 'array',
'items' => [
'description' => '数据结构如下:'."\n"
.'```json'."\n"
.'{'."\n"
.' "calleeNumber":"被叫号码",'."\n"
.' "outId":"保留key,该字段可用于携带外部流水唯一ID,回执内容中会将该字段携带回来,可以用这个作为唯一呼叫记录,方便关联回执,限制长度128",'."\n"
.' "variable1":"value",'."\n"
.' "variable2":"value",//如果智能体中有用到通话变量,则这里variable1、variable2代表每个变量的key,value就是变量的值。'."\n"
.' }'."\n"
.'```'."\n"
.'> 通话变量在[**通信智能体管理**](https://aiccs.console.aliyun.com/agent/customize)>**详情**>**通话变量配置**界面查看。',
'type' => 'object',
'required' => false,
'example' => '{'."\n"
.' "calleeNumber": "0534556****",'."\n"
.' "outId": "CFC2F07E-F763-7C48-1A32-6EFFB6EA344E",'."\n"
.' "name": "Tom",'."\n"
.' "age": "18"'."\n"
.'}',
],
'required' => false,
],
],
[
'name' => 'DataType',
'in' => 'query',
'schema' => [
'description' => '数据类型。取值:'."\n"
.'- EXCEL'."\n"
.'- JSON'."\n"
.'>API调用暂时仅支持JSON数据类型。>',
'type' => 'string',
'required' => true,
'enumValueTitles' => [],
'example' => 'JSON',
'enum' => [
'EXCEL',
'JSON',
],
],
],
[
'name' => 'EncryptionType',
'in' => 'query',
'schema' => [
'description' => '加密方式:0-不加密;1-MD5;2-SHA256;3-SM3',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => [
'description' => '访问被拒绝的详细原因。',
'type' => 'string',
'example' => 'None',
],
'Message' => [
'description' => '状态码描述。',
'type' => 'string',
'example' => 'OK',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'CFC2F07E-F763-7C48-1A32-6EFFB6EA344E',
],
'Data' => [
'description' => '导入批次ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '123497836486******'."\n",
],
'Code' => [
'description' => '请求状态码。返回OK代表请求成功。',
'type' => 'string',
'example' => 'OK',
],
'Success' => [
'description' => '调用接口是否成功。取值:'."\n"
.'- **true**:成功。'."\n"
.'- **false**:失败。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"CFC2F07E-F763-7C48-1A32-6EFFB6EA344E\\",\\n \\"Data\\": 0,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '导入被叫数据',
'description' => '- 您可调用此接口导入被叫数据,也可在[呼叫任务管理](https://aiccs.console.aliyun.com/agent/task)界面单击导入被叫数据,下载模板并上传文件的方式导入被叫数据。'."\n"
."\n"
.'- 此接口在导入被叫数据时,暂仅支持JSON数据类型导入。'."\n"
."\n"
.'- 在调用此接口之前,请确保您已有创建成功的呼叫任务。'."\n"
."\n"
.'- 若您没有已创建成功的呼叫任务,可在[呼叫任务管理](https://aiccs.console.aliyun.com/agent/task)界面点击创建呼叫任务或通过[CreateAiCallTask](~~2926796~~)接口创建呼叫任务。',
],
'CreateAiCallTask' => [
'summary' => '创建通信智能体外呼任务。',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '268866',
'abilityTreeNodes' => [
'FEATUREaiccsTY5M4L',
],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'TaskName',
'in' => 'query',
'schema' => [
'description' => '任务名称,同一个账号下不允许重复。',
'type' => 'string',
'required' => true,
'example' => '测试任务',
],
],
[
'name' => 'AgentId',
'in' => 'query',
'schema' => [
'description' => '已上线的智能体编码。',
'type' => 'string',
'required' => false,
'example' => '1180**************'."\n",
],
],
[
'name' => 'VirtualNumber',
'in' => 'query',
'schema' => [
'description' => '呼出使用的服务实例。',
'type' => 'string',
'required' => false,
'example' => '032712122*****',
],
],
[
'name' => 'StartType',
'in' => 'query',
'schema' => [
'description' => '启动方式。取值:'."\n"
."\n"
.'- IMMEDIATE:立即启动。'."\n"
."\n"
.'- SCHEDULE:定时启动。',
'type' => 'string',
'required' => true,
'enumValueTitles' => [],
'example' => 'SCHEDULE',
],
],
[
'name' => 'MissCallRetry',
'in' => 'query',
'schema' => [
'description' => '是否开启重试。取值:'."\n"
."\n"
.'- true:是。'."\n"
."\n"
.'- false(默认):否。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
'default' => 'false',
],
],
[
'name' => 'CallRetryReason',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '失败重试原因列表。',
'type' => 'array',
'items' => [
'description' => '具体重试原因。取值:'."\n"
.'- CALL_REJECTED:拒接。'."\n"
.'- USER_BUSY:被叫忙。'."\n"
.'- SUSPEND:停机。'."\n"
.'- INVALID_NUMBER:空号。'."\n"
.'- POWERED_OFF:关机。'."\n"
.'- NETWORK_BUSY:网络忙。'."\n"
.'- NO_ANSWER:无应答。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'CALL_REJECTED',
],
'required' => false,
],
],
[
'name' => 'CallRetryTimes',
'in' => 'query',
'schema' => [
'description' => '重试次数,最大不能超过3次。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '2',
],
],
[
'name' => 'CallRetryInterval',
'in' => 'query',
'schema' => [
'description' => '重试间隔,单位:分钟,最大不能超过720分钟。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '32',
],
],
[
'name' => 'CallTime',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '可呼叫时间段列表。',
'type' => 'array',
'items' => [
'description' => '呼叫时间段,格式如下:'."\n"
.'```json'."\n"
.'{"startTime":"09:00:00","endTime":"10:00:00"}'."\n"
.'```'."\n"
.'`startTime`代表开始时间,`endTime`代表结束时间,仅处于这个时间段内的时刻才会发起呼出调度,否则将等待下一个可调度是间段到来。',
'type' => 'string',
'required' => false,
'example' => '{"startTime":"09:00:00","endTime":"10:00:00"}'."\n",
],
'required' => true,
],
],
[
'name' => 'CallDay',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '可外呼日列表。',
'type' => 'array',
'items' => [
'description' => '可外呼日。取值:'."\n"
."\n"
.'- MONDAY:周一。'."\n"
.'- TUESDAY:周二。'."\n"
.'- WEDNESDAY:周三。'."\n"
.'- THURSDAY:周四。'."\n"
.'- FRIDAY:周五。'."\n"
.'- SATURDAY:周六。'."\n"
.'- SUNDAY:周天。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'MONDAY',
],
'required' => true,
],
],
[
'name' => 'TaskStartTime',
'in' => 'query',
'schema' => [
'description' => '任务预设的启动时间,时间戳,单位毫秒。StarType字段为SCHEDULE时该字段有效且必填,任务将在该字段设置的时间进行自动启动。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '12313123133',
],
],
[
'name' => 'TaskCps',
'in' => 'query',
'schema' => [
'description' => '任务并发,最大不超过500。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '75',
],
],
[
'name' => 'Source',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '92',
],
],
[
'name' => 'ApplicationCode',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
'example' => '示例值示例值',
],
],
[
'name' => 'ApplicationName',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
'example' => '示例值示例值',
],
],
[
'name' => 'PhoneType',
'in' => 'query',
'schema' => [
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '54',
],
],
[
'name' => 'LineEncoding',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
'example' => '示例值示例值',
],
],
[
'name' => 'LinePhoneNum',
'in' => 'query',
'schema' => [
'type' => 'string',
'required' => false,
'example' => '示例值示例值',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => [
'description' => '访问被拒绝的详细原因。',
'type' => 'string',
'example' => 'None',
],
'Message' => [
'description' => '状态码描述。',
'type' => 'string',
'example' => '成功',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '8C93B345-F702-5449-BA7E-7D110D4BF798',
],
'Data' => [
'description' => '任务ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '1213123123*****',
],
'Code' => [
'description' => '请求状态码。',
'type' => 'string',
'example' => 'OK',
],
'Success' => [
'description' => '调用接口是否成功。取值:'."\n"
.'- **true**:成功。'."\n"
.'- **false**:失败。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"8C93B345-F702-5449-BA7E-7D110D4BF798\\",\\n \\"Data\\": 0,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '创建通信智能体外呼任务',
'description' => '在创建外呼任务之前,请先使用智能体进行拨测以确认效果符合您的要求。',
],
'LlmSmartCall' => [
'summary' => '基于大模型的智能外呼。',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeCode' => '256802',
'abilityTreeNodes' => [
'FEATUREaiccsA3JJUR',
],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'CalledNumber',
'in' => 'query',
'schema' => [
'description' => '接收智能外呼的被叫号码。',
'type' => 'string',
'required' => true,
'example' => '137****0000',
],
],
[
'name' => 'CallerNumber',
'in' => 'query',
'schema' => [
'description' => '主叫号码,为必填参数,仅支持中国内地号码。请前往语音服务[真实号管理](https://dyvmsnext.console.aliyun.com/number/list/normal)界面查看号码。',
'type' => 'string',
'required' => false,
'example' => '132****2054',
],
],
[
'name' => 'ApplicationCode',
'in' => 'query',
'schema' => [
'description' => '大模型应用编码。在[大模型应用管理](https://aiccs.console.aliyun.com/engine/llmApp)界面查看。',
'type' => 'string',
'required' => true,
'example' => 'F32******',
],
],
[
'name' => 'StartWordParam',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '开场白变量。请前往[大模型应用管理](https://aiccs.console.aliyun.com/engine/llmApp)界面单击详情查看您创建的大模型开场白变量。',
'type' => 'object',
'required' => false,
'example' => '{'."\n"
.' "name": "小明",'."\n"
.' "address": "浙江省杭州市"'."\n"
.'}',
],
],
[
'name' => 'PromptParam',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'Prompt提示词变量。请前往[大模型应用管理](https://aiccs.console.aliyun.com/engine/llmApp)界面单击详情查看您创建的Prompt提示词变量。',
'type' => 'object',
'required' => false,
'example' => '{'."\n"
.' "style": "温柔"'."\n"
.'}',
],
],
[
'name' => 'OutId',
'in' => 'query',
'schema' => [
'description' => '预留给调用方使用的 ID,最终会通过回执消息将此ID带回给调用方,长度为1~15个字节。',
'type' => 'string',
'required' => false,
'example' => '222356****',
'maxLength' => 32,
],
],
[
'name' => 'BizParam',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '业务参数,请求客户模型时,会将此参数带入给客户模型。',
'type' => 'object',
'required' => false,
'example' => '{\\"testKey\\":\\"test\\"}',
],
],
[
'name' => 'Extension',
'in' => 'query',
'schema' => [
'description' => 'X号码的分机号码,不超过5位。'."\n"
."\n"
.'>仅在AXN分机号模式下需要填写,如果不存在分机号,请务必不要填写。>',
'type' => 'string',
'required' => false,
'example' => '123',
'maxLength' => 5,
],
],
[
'name' => 'SessionTimeout',
'in' => 'query',
'schema' => [
'description' => '最大通话时长,超时后自动挂断。单位:秒。'."\n"
.'>'."\n"
.'>- 最大取值:3600s。'."\n"
.'>- 最小取值:600s。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '3600',
'minimum' => '300',
'example' => '1200',
],
],
[
'name' => 'TtsVoiceCode',
'in' => 'query',
'schema' => [
'description' => 'TTS 播放时的音色编码。'."\n"
."\n"
.'> '."\n"
.'> - 不设置值时,默认取大模型应用配置的音色编码。'."\n"
.'> - 支持通过[ListAvailableTts](~~2926668~~)接口查看全部音色编码。',
'type' => 'string',
'required' => false,
'example' => 'V65******',
],
],
[
'name' => 'TtsSpeed',
'in' => 'query',
'schema' => [
'description' => 'TTS 播放时的声音速度。'."\n"
."\n"
.'> '."\n"
.'> - 取值范围:-200~200,默认值为0。'."\n"
.'> - 不设置值时,默认取大模型应用配置的声音速度。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '50',
],
],
[
'name' => 'TtsVolume',
'in' => 'query',
'schema' => [
'description' => 'TTS 播放的音量。'."\n"
.'> '."\n"
.'> - 取值范围:0~100,默认值为0。'."\n"
.'> - 不设置值时,默认取大模型应用配置的音量。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
],
[
'name' => 'CustomerLineCode',
'in' => 'query',
'schema' => [
'description' => '用户自带线路编码。'."\n"
.'> '."\n"
.'> - 若使用客户自带线路,请联系小二开通此功能;'."\n"
.'> - 线路编码由小二给出,若无,请不要设置值。',
'type' => 'string',
'required' => false,
'example' => 'SELF_xxxxx_A_NET',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '请求 ID。',
'type' => 'string',
'example' => 'D6A51251-F7C4-596A-9F45-3C3219A5450D',
],
'Code' => [
'description' => '请求状态码。返回OK代表请求成功。',
'type' => 'string',
'example' => 'OK',
],
'Message' => [
'description' => '状态码的描述。',
'type' => 'string',
'example' => 'OK',
],
'CallId' => [
'description' => '此次通话的唯一回执ID。',
'type' => 'string',
'example' => '125165515***^11195613****',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ModelStatus.Invalid',
'errorMessage' => 'Model state invalid.',
],
[
'errorCode' => 'MissingParameter.CallerNumber',
'errorMessage' => 'Parameter "CallerNumber" which is mandatory for the request is not provided.',
],
[
'errorCode' => 'InvalidParameter.ApplicationCode',
'errorMessage' => 'The specified parameter "ApplicationCode" is invalid.',
],
[
'errorCode' => 'ModelNotExist',
'errorMessage' => 'The model does not exist.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D6A51251-F7C4-596A-9F45-3C3219A5450D\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"CallId\\": \\"125165515***^11195613****\\"\\n}","type":"json"}]',
'title' => '大模型智能呼叫',
'description' => '- 调用一次接口仅支持添加一个被叫号码。如果有多个被叫号码,可以多次调用。'."\n"
."\n"
.'- 在基于大模型发起智能呼叫之前,请确保您在[大模型应用管理](https://aiccs.console.aliyun.com/engine/llmApp)界面已创建大模型应用;在语音服务[真实号管理](https://dyvmsnext.console.aliyun.com/number/list/normal)界面已有申请成功的真实号码。',
],
'LlmSmartCallEncrypt' => [
'summary' => '基于大模型加密号码智能呼叫。',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeCode' => '270332',
'abilityTreeNodes' => [
'FEATUREaiccs6AMUI3',
],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'EncryptCalledNumber',
'in' => 'query',
'schema' => [
'description' => '加密被叫号码。',
'type' => 'string',
'required' => true,
'example' => '140*********243',
],
],
[
'name' => 'PromptParam',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '大模型应用prompt参数。',
'type' => 'object',
'required' => false,
'example' => '{"prompt":"推荐一部电影"}',
],
],
[
'name' => 'StartWordParam',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '大模型应用开场白参数。',
'type' => 'object',
'required' => false,
'example' => '{"name":"小明","address":"浙江省杭州市"}',
],
],
[
'name' => 'ApplicationCode',
'in' => 'query',
'schema' => [
'description' => '大模型应用编码。',
'type' => 'string',
'required' => true,
'example' => 'AD******45',
],
],
[
'name' => 'CallerNumber',
'in' => 'query',
'schema' => [
'description' => '主叫号码。',
'type' => 'string',
'required' => true,
'example' => '132******65',
],
],
[
'name' => 'OutId',
'in' => 'query',
'schema' => [
'description' => '客户自定义outId。',
'type' => 'string',
'required' => false,
'example' => 'dsa*******sad',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => [
'description' => '访问被拒绝的详细原因。',
'type' => 'string',
'example' => 'None',
],
'Message' => [
'description' => '状态码的描述。',
'type' => 'string',
'example' => '成功',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'F92F9749-105E-518F-8B08-CF16EF36A0E2',
],
'Data' => [
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'CallId' => [
'description' => '呼叫ID。',
'type' => 'string',
'example' => '149******206',
],
],
],
'Code' => [
'description' => '请求状态码。返回OK代表请求成功。',
'type' => 'string',
'example' => 'ok',
],
'Success' => [
'description' => '调用接口是否成功。取值:'."\n"
.'- **true**:成功。'."\n"
.'- **false**:失败。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"F92F9749-105E-518F-8B08-CF16EF36A0E2\\",\\n \\"Data\\": {\\n \\"CallId\\": \\"149******206\\"\\n },\\n \\"Code\\": \\"ok\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '大模型加密号智能外呼',
],
'HangupOperate' => [
'summary' => '通信智能引擎中主动挂断通话。',
'methods' => [
'post',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '259150',
'abilityTreeNodes' => [
'FEATUREaiccsA3JJUR',
],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'CallId',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => [
'description' => '通话回执ID。您可通过[LlmSmartCall](~~2862828~~)或[LlmSmartCallEncrypt](~~2881065~~)接口获取通话回执ID。',
'type' => 'string',
'required' => true,
'example' => '14777672****^13452272****',
],
],
[
'name' => 'ImmediateHangup',
'in' => 'query',
'schema' => [
'description' => '是否立刻挂断。取值:'."\n"
."\n"
.'- true(默认值):立刻挂断。'."\n"
."\n"
.'- false:前正在播放的内容播放完再挂断。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
'default' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => 'Id of the request',
'description' => '请求ID。',
'type' => 'string',
'example' => 'EFD543DD-E087-54A2-AC0B-54E0656511D7',
],
'Code' => [
'description' => '请求状态码。返回OK表示请求成功。',
'type' => 'string',
'example' => 'OK',
],
'Mesage' => [
'description' => '状态码的描述。',
'type' => 'string',
'example' => 'OK',
],
'Result' => [
'description' => '返回结果。取值:'."\n"
."\n"
.'- **true**:挂断成功。'."\n"
."\n"
.'- **false**:挂断失败。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidParameter.CallId',
'errorMessage' => 'The parameter CallId is invalid.',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EFD543DD-E087-54A2-AC0B-54E0656511D7\\",\\n \\"Code\\": \\"OK\\",\\n \\"Mesage\\": \\"OK\\",\\n \\"Result\\": true\\n}","type":"json"}]',
'title' => '通信智能引擎主动挂断通话',
'description' => '- 在通信智能引擎主动挂断通话之前,请先确保已有基于大模型发起的通话。'."\n"
."\n"
.'- 若没有基于大模型发起的通话,您可以通过[LlmSmartCall](~~2862828~~)或[LlmSmartCallEncrypt](~~2881065~~)接口发起通话。',
],
'ListAvailableTts' => [
'summary' => '获取大模型外呼支持的TTS音色列表,包括系统预置音色和个性化音色。',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '273987',
'abilityTreeNodes' => [
'FEATUREaiccsTY5M4L',
],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'TtsVoiceCode',
'in' => 'query',
'schema' => [
'title' => '复刻音色编码',
'description' => '个性化音色编码,在[个性化音色](https://aiccs.console.aliyun.com/engine/voiceprint)界面查看音色编码。',
'type' => 'string',
'required' => false,
'example' => 'V9A******',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => [
'description' => '访问被拒绝详细信息;只有RAM校验失败才会返回此字段。',
'type' => 'string',
'example' => 'None',
],
'RequestId' => [
'title' => '',
'description' => '本次调用请求的ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。',
'type' => 'string',
'example' => '5EBAEBE6-0E77-5E1F-99E4-7B20512F22222',
],
'Message' => [
'title' => '',
'description' => '状态码描述。',
'type' => 'string',
'example' => 'OK',
],
'Data' => [
'title' => '',
'description' => '返回结果。',
'type' => 'array',
'items' => [
'description' => '音色列表。',
'type' => 'object',
'properties' => [
'TtsVoiceName' => [
'title' => '音色名称',
'description' => '音色名称。',
'type' => 'string',
'example' => '龙小夏',
],
'TtsEngine' => [
'title' => '音色平台CosyVoice/Volcano',
'description' => '音色平台。取值:'."\n"
."\n"
.'- CosyVoice:个性化音色或系统预置音色。'."\n"
."\n"
.'- Volcano:豆包音色。',
'type' => 'string',
'example' => 'CosyVoice',
],
'TtsStyle' => [
'title' => '音色cosy类型 cosyvoice-v2-XXXX-XXXX',
'description' => '音色风格。',
'type' => 'string',
'example' => 'cosyvoice-v2-*********-*******',
],
'TtsAuditionFileUrl' => [
'title' => '音色试听文件',
'description' => '音色试听文件。',
'type' => 'string',
'example' => 'https://*******/longxiaoxia.mp3',
],
'TtsVoiceCode' => [
'title' => '音色编码',
'description' => '音色编码。',
'type' => 'string',
'example' => 'V9A******'."\n",
],
],
'enumValueTitles' => [],
],
'example' => '',
],
'Code' => [
'title' => '',
'description' => '状态码。返回OK表示调用成功。',
'type' => 'string',
'example' => 'OK',
],
'Success' => [
'title' => '',
'description' => '调用接口是否成功。取值:'."\n"
.'- **true**:成功。'."\n"
.'- **false**:失败。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"5EBAEBE6-0E77-5E1F-99E4-7B20512F22222\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": [\\n {\\n \\"TtsVoiceName\\": \\"龙小夏\\",\\n \\"TtsEngine\\": \\"CosyVoice\\",\\n \\"TtsStyle\\": \\"cosyvoice-v2-*********-*******\\",\\n \\"TtsAuditionFileUrl\\": \\"https://*******/longxiaoxia.mp3\\",\\n \\"TtsVoiceCode\\": \\"V9A******\\\\n\\"\\n }\\n ],\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '获取大模型呼叫支持的TTS音色列表',
'description' => '若您在[个性化音色](https://aiccs.console.aliyun.com/engine/voiceprint)界面没有已创建且上线的音色,则只能查到系统预置的音色。',
],
'GetCallDialogContent' => [
'summary' => '通过CallId查询对话内容,只支持查询近一个月通话已结束的通话对话内容。',
'methods' => [
'post',
'get',
],
'schemes' => [
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '275547',
'abilityTreeNodes' => [
'FEATUREaiccsA3JJUR',
],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'CallDate',
'in' => 'query',
'schema' => [
'description' => '外呼日期,只可查询最近30天的日期,格式:yyyy-MM-dd。',
'type' => 'string',
'required' => true,
'example' => '2025-06-06',
],
],
[
'name' => 'CallId',
'in' => 'query',
'schema' => [
'description' => '呼叫记录ID,用于标识一条通话记录。'."\n"
."\n"
.'> 在调用大模型外呼接口LlmSmartCall是,会返回此呼叫记录ID,即CallId。',
'type' => 'string',
'required' => true,
'example' => '123456^123478',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccessDeniedDetail' => [
'description' => '访问被拒绝详细信息;只有RAM校验失败才会返回此字段。',
'type' => 'string',
'example' => 'Access Denied',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'FB0B0481-F13E-16E0-8A7A-1AD2FXXXEF55',
],
'Message' => [
'description' => '返回消息',
'type' => 'string',
'example' => '成功',
],
'Data' => [
'description' => '返回数据结果。',
'type' => 'object',
'properties' => [
'DialogContent' => [
'description' => '对话内容',
'type' => 'string',
'example' => '[{\\"content\\":\\"您好。\\",\\"role\\":\\"assistant\\"},{\\"content\\":\\"不用了。\\",\\"role\\":\\"user\\"},{\\"content\\":\\"呃,不用了,再见,谢谢。\\",\\"role\\":\\"user\\"}]',
],
'CallId' => [
'description' => '呼叫ID',
'type' => 'string',
'example' => '123456^123478'."\n",
],
'CallStatus' => [
'description' => '呼叫状态 '."\n"
.'> 呼叫状态返回值描述'."\n"
.'> - 0:未接通;'."\n"
.'> - 1:已接通;'."\n"
.'> - 2:已挂断;',
'type' => 'integer',
'format' => 'int64',
'example' => '2',
],
],
],
'Code' => [
'description' => '请求返回Code。',
'type' => 'string',
'example' => 'OK',
],
'Success' => [
'description' => '调用接口是否成功。取值:'."\n"
.'- **true**:成功。'."\n"
.'- **false**:失败。',
'type' => 'boolean',
'example' => 'false',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'InvalidParameter.CallId',
'errorMessage' => 'The parameter CallId is invalid.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"Access Denied\\",\\n \\"RequestId\\": \\"FB0B0481-F13E-16E0-8A7A-1AD2FXXXEF55\\",\\n \\"Message\\": \\"成功\\",\\n \\"Data\\": {\\n \\"DialogContent\\": \\"[{\\\\\\\\\\\\\\"content\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"您好。\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"role\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"assistant\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"content\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"不用了。\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"role\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"user\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"content\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"呃,不用了,再见,谢谢。\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"role\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"user\\\\\\\\\\\\\\"}]\\",\\n \\"CallId\\": \\"123456^123478\\\\n\\",\\n \\"CallStatus\\": 2\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]',
'title' => '通过CallId查询近一个月通话已结束的通话对话内容',
],
'GetHotlineServiceStatistics' => [
'summary' => '获取热线监控下服务统计量。支持实例、时间纬度、坐席、部门、技能组分组查询。',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => [
'title' => 'AICCS实例ID,在智能联络中心控制台上可以看到',
'description' => 'AICCS实例ID。'."\n"
.'您可以在[智能联络中心控制台](https://aiccs.console.aliyun.com/overview)左侧导航栏的**实例管理**中获取。',
'type' => 'string',
'required' => true,
'example' => 'ccc_xp_pre-cn-***',
],
],
[
'name' => 'StartDate',
'in' => 'query',
'schema' => [
'title' => '开始日期时间戳(毫秒)',
'description' => '开始日期时间戳。单位:毫秒。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1615083365000',
],
],
[
'name' => 'EndDate',
'in' => 'query',
'schema' => [
'title' => '结束日期时间戳(毫秒)',
'description' => '结束日期时间戳。单位:毫秒。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1617761765000',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'title' => '每页大小(默认为10)',
'description' => '每页大小。取值大于**0**,默认值:**20**。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '10',
],
],
[
'name' => 'CurrentPage',
'in' => 'query',
'schema' => [
'title' => '当前页(默认为1)',
'description' => '当前页。取值大于**0**,默认值:**1**。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'AgentIds',
'in' => 'query',
'style' => 'simple',
'schema' => [
'title' => '坐席id列表',
'description' => '坐席ID列表。',
'type' => 'array',
'items' => [
'description' => '坐席ID。'."\n"
."\n"
.'可调用[GetAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getagent)接口,查看返回参数的**AgentId**,即坐席ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '111',
],
'required' => false,
],
],
[
'name' => 'DepIds',
'in' => 'query',
'style' => 'simple',
'schema' => [
'title' => '部门id列表',
'description' => '部门ID列表。',
'type' => 'array',
'items' => [
'description' => '部门ID。'."\n"
."\n"
.'可调用[GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment)接口,查看返回参数的**DepartmentId**,即部门ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '100',
],
'required' => false,
],
],
[
'name' => 'GroupIds',
'in' => 'query',
'style' => 'simple',
'schema' => [
'title' => '技能组id列表',
'description' => '技能组ID列表。',
'type' => 'array',
'items' => [
'description' => '技能组ID。'."\n"
."\n"
.'可调用[QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups)接口,查看返回参数的**SkillGroupId**,即技能组ID。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '123',
],
'required' => false,
],
],
[
'name' => 'TimeLatitudeType',
'in' => 'query',
'schema' => [
'title' => '时间纬度类型',
'description' => '时间纬度类型分组查询。取值:'."\n"
.'- **minute**:分钟。'."\n"
.'- **hour**:小时。',
'type' => 'string',
'required' => false,
'example' => 'minute',
],
],
[
'name' => 'ExistAgentGrouping',
'in' => 'query',
'schema' => [
'title' => '是否根据坐席分组',
'description' => '是否根据坐席分组查询。取值:'."\n"
."\n"
.'- **true**:是。'."\n"
.'- **false**:否。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'ExistDepartmentGrouping',
'in' => 'query',
'schema' => [
'title' => '是否根据部门分组',
'description' => '是否根据部门分组查询。取值:'."\n"
."\n"
.'- **true**:是。'."\n"
.'- **false**:否。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
[
'name' => 'ExistSkillGroupGrouping',
'in' => 'query',
'schema' => [
'title' => '是否根据技能组分组',
'description' => '是否根据技能组分组查询。取值:'."\n"
."\n"
.'- **true**:是。'."\n"
.'- **false**:否。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '请求ID,用于跟踪错误原因',
'description' => '请求ID。',
'type' => 'string',
'example' => 'EE338D98-9BD3-4413-B165',
],
'Message' => [
'title' => '错误描述',
'description' => '状态描述。',
'type' => 'string',
'example' => 'message',
],
'Data' => [
'title' => 'data',
'description' => '数据列表。',
'type' => 'object',
'properties' => [
'TotalNum' => [
'title' => '总记录数',
'description' => '总记录数。',
'type' => 'integer',
'format' => 'int32',
'example' => '4',
],
'PageNum' => [
'title' => '当前页数',
'description' => '当前页数。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'title' => '页大小',
'description' => '每页大小。',
'type' => 'integer',
'format' => 'int32',
'example' => '2000',
],
'Rows' => [
'title' => '信息为list