{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:aliyun-aiccs/add-agent":{"post":{"operationId":"cloud_aliyun_aiccs_add_agent","summary":"Creates an agent","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Account","Password","ExtensionPwd","Name"],"properties":{"endpoint":{"type":"string","enum":["https://aiccs.aliyuncs.com"],"default":"https://aiccs.aliyuncs.com","description":"Regional endpoint, for example https://aiccs.aliyuncs.com"},"Account":{"type":"string","description":"The name of the agent account. The name must be unique"},"Password":{"type":"string","description":"The password of the agent account. The password can be the same as the extension password"},"ExtensionPwd":{"type":"string","description":"The extension password"},"Name":{"type":"string","description":"The name of the agent"},"AgentTag":{"type":"string","description":"The unique identifier of the partner"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-aiccs/add-agent-group":{"post":{"operationId":"cloud_aliyun_aiccs_add_agent_group","summary":"Creates an agent group","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AgentGroupName"],"properties":{"endpoint":{"type":"string","enum":["https://aiccs.aliyuncs.com"],"default":"https://aiccs.aliyuncs.com","description":"Regional endpoint, for example https://aiccs.aliyuncs.com"},"AgentGroupName":{"type":"string","description":"The name of the agent group. The name cannot be empty and can be up to 20 characters in length"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-aiccs/add-blacklist":{"post":{"operationId":"cloud_aliyun_aiccs_add_blacklist","summary":"Adds phone numbers to the blacklist for the Industry Edition","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Numbers","ExpiredDay","Remark"],"properties":{"endpoint":{"type":"string","enum":["https://aiccs.aliyuncs.com"],"default":"https://aiccs.aliyuncs.com","description":"Regional endpoint, for example https://aiccs.aliyuncs.com"},"Numbers":{"type":"string","description":"The list of phone numbers (JSON-encoded)"},"ExpiredDay":{"type":"string","description":"The validity period in days"},"Remark":{"type":"string","description":"The remark"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-aiccs/add-task":{"post":{"operationId":"cloud_aliyun_aiccs_add_task","summary":"Creates a task for the industry edition","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TaskType","Name"],"properties":{"endpoint":{"type":"string","enum":["https://aiccs.aliyuncs.com"],"default":"https://aiccs.aliyuncs.com","description":"Regional endpoint, for example https://aiccs.aliyuncs.com"},"TaskType":{"type":"integer","description":"The type of the task. Valid values: 1: Batch AI outbound call without transfer to a human agent. 2: Batch voice notification. 6: New voice…"},"Name":{"type":"string","description":"The name of the task"},"StartTime":{"type":"string","description":"The start date of the task"},"TemplateType":{"type":"integer","description":"The script templatetype. Valid values: 1: Single template. 2: Intelligent script Policy Template. Default value: 1"},"TemplateId":{"type":"integer","description":"The ID of the script template"},"MaxConcurrency":{"type":"integer","description":"The number of concurrent calls. Default value: 1. The value cannot exceed the maximum concurrency configured for the enterprise"},"RecallType":{"type":"integer","description":"The recall configuration. Valid values: 1: No recall. 2: Interval-based recall. 3: Scheduled recall. Default value: 1"},"RepeatInterval":{"type":"integer","description":"The recall interval. This parameter is required when RecallType is set to 2. Unit: minutes. The value must be a positive integer greater…"},"RepeatCount":{"type":"integer","description":"The number of recall attempts. This parameter is required when RecallType is set to 2. The value must be a positive integer greater than…"},"RepeatTimes":{"type":"string","description":"The recall times (JSON-encoded)"},"RecordPath":{"type":"string","description":"The URL of the recording. This parameter is required when the business type enabled for the enterprise is voice notification"},"PlaySleepVal":{"type":"integer","description":"The playback interval. This parameter is required when the business type enabled for the enterprise is voice notification. Unit: seconds.…"},"PlayTimes":{"type":"integer","description":"The number of times the recording is played. This parameter is required when the business type enabled for the enterprise is voice…"},"RepeatReason":{"type":"string","description":"The recall conditions (JSON-encoded)"},"CallTimeList":{"type":"string","description":"The outbound call time. Format example: for \"8:30-12:00 13:30-19:00\", pass [[8.5,12][13.5,19]]. Default value: [[8,20]] (JSON-encoded)"},"SendSmsPlan":{"type":"string","description":"The SMS sending rule (JSON-encoded)"},"CallbackUrl":{"type":"string","description":"The callback URL"},"FlashSmsType":{"type":"integer","description":"The flash SMS configuration"},"FlashSmsTemplateId":{"type":"integer","description":"The ID of the flash SMS template. This parameter is required when FlashSmsType is set to 1"},"CallTimeStrList":{"type":"string","description":"The outbound call time accurate to the minute. If both fields have values, this field takes precedence. Use this field for minute-level…"},"WeekTag":{"type":"string","description":"The days of the week for outbound calls. For example, [1,2,3,4,5,6,7] indicates calls from Monday to Sunday (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-aiccs/agent-call-list":{"post":{"operationId":"cloud_aliyun_aiccs_agent_call_list","summary":"Queries the outbound call records of agents","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["CallDate","EndCallDate","Page"],"properties":{"endpoint":{"type":"string","enum":["https://aiccs.aliyuncs.com"],"default":"https://aiccs.aliyuncs.com","description":"Regional endpoint, for example https://aiccs.aliyuncs.com"},"AgentId":{"type":"integer","description":"The agent ID"},"AgentTag":{"type":"string","description":"The agent tag"},"Numbers":{"type":"string","description":"The list of phone numbers (JSON-encoded)"},"NumberMD5s":{"type":"string","description":"The list of MD5 hashes of phone numbers (JSON-encoded)"},"Tags":{"type":"string","description":"The list of custom tags (JSON-encoded)"},"CallDate":{"type":"string","description":"The start time of the outbound call"},"EndCallDate":{"type":"string","description":"The end time of the outbound call"},"Page":{"type":"integer","description":"The page number"},"PageSize":{"type":"integer","description":"The number of outbound call records per page"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-aiccs/agent-cancel-call":{"post":{"operationId":"cloud_aliyun_aiccs_agent_cancel_call","summary":"Cancels outbound calls for agents in the Industry Edition","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://aiccs.aliyuncs.com"],"default":"https://aiccs.aliyuncs.com","description":"Regional endpoint, for example https://aiccs.aliyuncs.com"},"AgentId":{"type":"integer","description":"The agent ID"},"AgentTag":{"type":"string","description":"The agent tag"},"Numbers":{"type":"string","description":"The list of phone numbers (JSON-encoded)"},"Tags":{"type":"string","description":"The list of custom tags (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-aiccs/agent-group-page":{"post":{"operationId":"cloud_aliyun_aiccs_agent_group_page","summary":"Performs a paging query of agent groups","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://aiccs.aliyuncs.com"],"default":"https://aiccs.aliyuncs.com","description":"Regional endpoint, for example https://aiccs.aliyuncs.com"},"AgentGroupId":{"type":"integer","description":"The ID of the agent group"},"PageNum":{"type":"integer","description":"The current page number"},"PageSize":{"type":"integer","description":"The number of entries per page"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-aiccs/agent-import-number":{"post":{"operationId":"cloud_aliyun_aiccs_agent_import_number","summary":"Imports phone numbers for agent outbound calls","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["CallType","Customers"],"properties":{"endpoint":{"type":"string","enum":["https://aiccs.aliyuncs.com"],"default":"https://aiccs.aliyuncs.com","description":"Regional endpoint, for example https://aiccs.aliyuncs.com"},"OutId":{"type":"string","description":"The unique request ID used for idempotent processing. A request ID is valid for 10 minutes. If this parameter is not specified, idempotent…"},"AgentId":{"type":"integer","description":"The ID of the agent. This parameter can be left empty, but you must specify either AgentId or AgentTag. This parameter is used to query…"},"AgentTag":{"type":"string","description":"The unique identifier of the agent, which is the unique user identifier specified when the agent is created. This parameter can be left…"},"CallType":{"type":"integer","description":"The type of the outbound call. Valid values: 1001: agent manual outbound call"},"TemplateId":{"type":"integer","description":"The ID of the AI script that is created and published by the customer or authorized by the platform. If CallType is set to 1001, this…"},"GatewayId":{"type":"integer","description":"The outbound call line selected for agent manual outbound calls. This parameter takes effect only when CallType is set to 1001. If…"},"Customers":{"type":"string","description":"The specific customer information, such as the phone number and name. You must specify this parameter based on the requirements of the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-aiccs/agent-recover-call":{"post":{"operationId":"cloud_aliyun_aiccs_agent_recover_call","summary":"Restores canceled outbound call numbers to the pending status for agents to initiate outbound calls","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://aiccs.aliyuncs.com"],"default":"https://aiccs.aliyuncs.com","description":"Regional endpoint, for example https://aiccs.aliyuncs.com"},"AgentId":{"type":"integer","description":"The agent ID"},"AgentTag":{"type":"string","description":"The agent tag"},"Tags":{"type":"string","description":"The list of custom tags (JSON-encoded)"},"Numbers":{"type":"string","description":"The list of phone numbers (JSON-encoded)"},"BeginImportTime":{"type":"string","description":"The start time of the import for the query"},"EndImportTime":{"type":"string","description":"The end time of the import for the query"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-aiccs/call-chat-list":{"post":{"operationId":"cloud_aliyun_aiccs_call_chat_list","summary":"Retrieves chat content","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://aiccs.aliyuncs.com"],"default":"https://aiccs.aliyuncs.com","description":"Regional endpoint, for example https://aiccs.aliyuncs.com"},"TaskId":{"type":"integer","description":"The task ID"},"CallId":{"type":"string","description":"callId"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-aiccs/call-number-detail":{"post":{"operationId":"cloud_aliyun_aiccs_call_number_detail","summary":"Retrieves the details of a phone number","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"endpoint":{"type":"string","enum":["https://aiccs.aliyuncs.com"],"default":"https://aiccs.aliyuncs.com","description":"Regional endpoint, for example https://aiccs.aliyuncs.com"},"Id":{"type":"integer","description":"The ID of the outbound call"},"TaskId":{"type":"integer","description":"The ID of the task"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-aiccs/details":{"post":{"operationId":"cloud_aliyun_aiccs_details","summary":"Queries the status of phone numbers in AI batch tasks","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TaskId","PageSize"],"properties":{"endpoint":{"type":"string","enum":["https://aiccs.aliyuncs.com"],"default":"https://aiccs.aliyuncs.com","description":"Regional endpoint, for example https://aiccs.aliyuncs.com"},"TaskId":{"type":"integer","description":"The task ID"},"StartTime":{"type":"string","description":"The start time of the import. Format: yyyy-MM-dd HH:mm:ss"},"EndTime":{"type":"string","description":"The end time of the import. Format: yyyy-MM-dd HH:mm:ss"},"BatchId":{"type":"integer","description":"The batch ID"},"Numbers":{"type":"string","description":"The list of phone numbers (JSON-encoded)"},"NumberStatus":{"type":"integer","description":"The phone number status to be queried exactly. Valid values: 1: Outbound call failed. 2: Outbound call in progress. 3: Outbound call…"},"PageNo":{"type":"integer","description":"The page number"},"PageSize":{"type":"integer","description":"The number of entries per page"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-aiccs/edit-task":{"post":{"operationId":"cloud_aliyun_aiccs_edit_task","summary":"Updates a task for the Industry Edition","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TaskId"],"properties":{"endpoint":{"type":"string","enum":["https://aiccs.aliyuncs.com"],"default":"https://aiccs.aliyuncs.com","description":"Regional endpoint, for example https://aiccs.aliyuncs.com"},"TaskId":{"type":"integer","description":"The task ID"},"Status":{"type":"integer","description":"The task status. Valid values: 2: Start. 4: Stop. If you do not specify this parameter, the task status is not modified"},"Name":{"type":"string","description":"The task name. The name cannot exceed 100 characters in length. If you do not specify this parameter, the task name is not modified"},"TemplateType":{"type":"integer","description":"The script template type. Valid values: 1: Single-mode template. 2: Intelligent script policy template. If you do not specify this…"},"TemplateId":{"type":"integer","description":"The script template ID. If you do not specify this parameter, the script template ID is not modified"},"MaxConcurrency":{"type":"integer","description":"The maximum number of concurrent calls. Default value: 1. The value cannot exceed the maximum concurrency configured for the enterprise.…"},"RecallType":{"type":"integer","description":"The redial configuration. Valid values: 1: Do not redial. 2: Redial at intervals. 3: Redial at scheduled times. Default value: 1. If you…"},"CallTimeList":{"type":"string","description":"The outbound call time. Example: If the time is 8:30-12:00 and 13:30-19:00, pass [[8.5,12],[13.5,19]]. If you do not specify this…"},"RepeatInterval":{"type":"integer","description":"The redial interval. This parameter is required when the redial option is set to 2. Unit: minutes. The value must be a positive integer…"},"RepeatCount":{"type":"integer","description":"The number of redials. This parameter is required when the redial option is set to 2. The value must be a positive integer greater than or…"},"RepeatTimes":{"type":"string","description":"The redial time (JSON-encoded)"},"RecordPath":{"type":"string","description":"The recording URL"},"PlaySleepVal":{"type":"integer","description":"The playback interval duration"},"PlayTimes":{"type":"integer","description":"The number of recording playbacks"},"SendSmsPlan":{"type":"string","description":"The SMS sending rule. Specifies the sending rule for hang-up SMS messages. If this parameter is left empty, no SMS message is sent…"},"RepeatReason":{"type":"string","description":"The redial condition (JSON-encoded)"},"CallbackUrl":{"type":"string","description":"The callback URL"},"FlashSmsType":{"type":"integer","description":"The flash SMS configuration. Valid values: 0: Do not send flash SMS messages. 1: Send flash SMS messages. Default value: 0"},"FlashSmsTemplateId":{"type":"integer","description":"The flash SMS template ID. This parameter is required when the flash SMS configuration is set to 1"},"CallTimeStrList":{"type":"string","description":"The outbound call time accurate to the minute. If both time fields have values, this field prevails. We recommend that you use this field…"},"WeekTag":{"type":"string","description":"The days of the week for outbound calls. Example: [1,2,3,4,5,6,7] indicates that outbound calls are made from Monday to Sunday…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-aiccs/import-number":{"post":{"operationId":"cloud_aliyun_aiccs_import_number","summary":"Imports task phone numbers in batches for the Industry Edition","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["OutId","TaskId","Customers"],"properties":{"endpoint":{"type":"string","enum":["https://aiccs.aliyuncs.com"],"default":"https://aiccs.aliyuncs.com","description":"Regional endpoint, for example https://aiccs.aliyuncs.com"},"OutId":{"type":"string","description":"The ID used for idempotency control"},"TaskId":{"type":"integer","description":"The task ID. You must determine this ID in advance"},"Customers":{"type":"string","description":"The outbound call customers, including specific user information such as phone numbers and names. The maximum number of customers is 1,000…"},"FailReturn":{"type":"integer","description":"Specifies the behavior when some imported data fails validation. Valid values: 0: Imports the data that passes validation and returns the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-aiccs/import-number-v2":{"post":{"operationId":"cloud_aliyun_aiccs_import_number_v2","summary":"Imports task numbers in batches for the Industry Edition and increases the import limit","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://aiccs.aliyuncs.com"],"default":"https://aiccs.aliyuncs.com","description":"Regional endpoint, for example https://aiccs.aliyuncs.com"},"OutId":{"type":"string","description":"Required. The external serial number"},"TaskId":{"type":"integer","description":"Required. The task ID"},"Customers":{"type":"string","description":"Required. The specific user information of outbound call customers, such as phone numbers and names. The maximum number of customers is…"},"FailReturn":{"type":"integer","description":"Valid values: 0 and 1. Default value: 1. If some of the imported data fails verification: 0 indicates that the data that passes…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-aiccs/join-agent-group":{"post":{"operationId":"cloud_aliyun_aiccs_join_agent_group","summary":"Associates an agent group","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AgentGroupId","AgentIds"],"properties":{"endpoint":{"type":"string","enum":["https://aiccs.aliyuncs.com"],"default":"https://aiccs.aliyuncs.com","description":"Regional endpoint, for example https://aiccs.aliyuncs.com"},"AgentGroupId":{"type":"integer","description":"The agent group ID"},"AgentIds":{"type":"string","description":"The list of agent IDs (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-aiccs/page":{"post":{"operationId":"cloud_aliyun_aiccs_page","summary":"Queries the industry edition blacklist","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://aiccs.aliyuncs.com"],"default":"https://aiccs.aliyuncs.com","description":"Regional endpoint, for example https://aiccs.aliyuncs.com"},"Numbers":{"type":"string","description":"The list of phone numbers (JSON-encoded)"},"PageNo":{"type":"integer","description":"The page number"},"PageSize":{"type":"integer","description":"The paging Settings for the number of entries to return on each page in a paged query"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-aiccs/query-agent-info":{"post":{"operationId":"cloud_aliyun_aiccs_query_agent_info","summary":"Queries the details of an agent","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://aiccs.aliyuncs.com"],"default":"https://aiccs.aliyuncs.com","description":"Regional endpoint, for example https://aiccs.aliyuncs.com"},"AgentId":{"type":"integer","description":"The agent ID. This parameter can be left empty. However, you must specify at least one of AgentId and AgentTag. If both are specified,…"},"AgentTag":{"type":"string","description":"The agent tag. Specify the unique identifier of the agent in your business system to query the corresponding AgentId. This parameter can…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-aiccs/quick-add-task":{"post":{"operationId":"cloud_aliyun_aiccs_quick_add_task","summary":"Quickly creates a task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name","ReferenceTaskId"],"properties":{"endpoint":{"type":"string","enum":["https://aiccs.aliyuncs.com"],"default":"https://aiccs.aliyuncs.com","description":"Regional endpoint, for example https://aiccs.aliyuncs.com"},"Name":{"type":"string","description":"The name of the task"},"StartTime":{"type":"string","description":"The start date of the task"},"TemplateType":{"type":"integer","description":"The script templatetype. If you do not specify this parameter, the default value is 1. Valid values: 1: Single template. 2: Intelligent…"},"TemplateId":{"type":"integer","description":"The ID of the script template. If you do not specify this parameter, the script template of the reference task is used"},"SmsTemplateId":{"type":"integer","description":"The ID of the SMS template"},"ReferenceTaskId":{"type":"integer","description":"The ID of the reference task"},"AgentGroupId":{"type":"integer","description":"The ID of the agent group"},"CallTimeList":{"type":"string","description":"The outbound call time (JSON-encoded)"},"CallTimeStrList":{"type":"string","description":"The outbound call time accurate to the minute. If both this parameter and CallTimeList are specified, this parameter takes precedence. We…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-aiccs/quit-agent-group":{"post":{"operationId":"cloud_aliyun_aiccs_quit_agent_group","summary":"Disassociates an agent group","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AgentGroupId","AgentIds"],"properties":{"endpoint":{"type":"string","enum":["https://aiccs.aliyuncs.com"],"default":"https://aiccs.aliyuncs.com","description":"Regional endpoint, for example https://aiccs.aliyuncs.com"},"AgentGroupId":{"type":"integer","description":"The ID of the agent group"},"AgentIds":{"type":"string","description":"The list of agent IDs (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-aiccs/sms-template-create":{"post":{"operationId":"cloud_aliyun_aiccs_sms_template_create","summary":"Creates an SMS template for the Industry Edition","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TemplateName","Sign","Content"],"properties":{"endpoint":{"type":"string","enum":["https://aiccs.aliyuncs.com"],"default":"https://aiccs.aliyuncs.com","description":"Regional endpoint, for example https://aiccs.aliyuncs.com"},"TemplateName":{"type":"string","description":"The name of the template"},"Sign":{"type":"string","description":"The SMS signature"},"TemplateType":{"type":"integer","description":"The templatetype"},"Content":{"type":"string","description":"The content of the SMS message"},"SmsType":{"type":"integer","description":"The type of the SMS message"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-aiccs/sms-template-page-list":{"post":{"operationId":"cloud_aliyun_aiccs_sms_template_page_list","summary":"Queries the SMS templates for the Industry Edition","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://aiccs.aliyuncs.com"],"default":"https://aiccs.aliyuncs.com","description":"Regional endpoint, for example https://aiccs.aliyuncs.com"},"PageNo":{"type":"integer","description":"The page number"},"PageSize":{"type":"integer","description":"The number of items per page"},"TemplateType":{"type":"integer","description":"The templatetype"},"TemplateId":{"type":"integer","description":"The template ID"},"SmsType":{"type":"integer","description":"The SMS type"},"Status":{"type":"integer","description":"The template status"},"Sign":{"type":"string","description":"The SMS signature"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-aiccs/task-call-chats":{"post":{"operationId":"cloud_aliyun_aiccs_task_call_chats","summary":"Queries the chat records of the Industry Edition","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["CallId"],"properties":{"endpoint":{"type":"string","enum":["https://aiccs.aliyuncs.com"],"default":"https://aiccs.aliyuncs.com","description":"Regional endpoint, for example https://aiccs.aliyuncs.com"},"TaskId":{"type":"integer","description":"The task ID in the decision system. This parameter can be left empty. However, at least one of TaskId, AgentId, and AgentTag must be…"},"AgentId":{"type":"integer","description":"The agent ID. This parameter can be left empty. However, at least one of TaskId, AgentId, and AgentTag must be specified. If multiple…"},"AgentTag":{"type":"string","description":"The unique identifier of the agent in your business system. We recommend that you specify this parameter to query the corresponding…"},"CallId":{"type":"string","description":"The outbound call ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-aiccs/task-call-info":{"post":{"operationId":"cloud_aliyun_aiccs_task_call_info","summary":"Retrieves the outbound call status of a task for the industry edition","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TaskId"],"properties":{"endpoint":{"type":"string","enum":["https://aiccs.aliyuncs.com"],"default":"https://aiccs.aliyuncs.com","description":"Regional endpoint, for example https://aiccs.aliyuncs.com"},"TaskId":{"type":"integer","description":"The task ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-aiccs/task-call-list":{"post":{"operationId":"cloud_aliyun_aiccs_task_call_list","summary":"Queries the outbound call records of AI batch tasks in the Industry Edition","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TaskId","CallDate","EndCallDate","Page"],"properties":{"endpoint":{"type":"string","enum":["https://aiccs.aliyuncs.com"],"default":"https://aiccs.aliyuncs.com","description":"Regional endpoint, for example https://aiccs.aliyuncs.com"},"TaskId":{"type":"integer","description":"The task ID"},"IntentTags":{"type":"string","description":"The intent tags. To query data with a specific intent tag, specify the tag, such as \"C\". To query data with multiple intent tags, specify…"},"BatchId":{"type":"string","description":"The batch ID returned when phone numbers are imported"},"Numbers":{"type":"string","description":"The phone numbers to be queried exactly. A maximum of 1,000 phone numbers are supported (JSON-encoded)"},"CallDate":{"type":"string","description":"The start time of outbound calls. You can only query data from the last 30 days. Format: 2020-03-06 10:10:10"},"EndCallDate":{"type":"string","description":"The end time of outbound calls. You can query data for only a single day. The start and end times must fall on the same day. Supported…"},"Page":{"type":"integer","description":"The page number"},"PageSize":{"type":"integer","description":"The number of outbound call records per page. The value must be a positive integer. Default value: 10000"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-aiccs/task-cancel-call":{"post":{"operationId":"cloud_aliyun_aiccs_task_cancel_call","summary":"Cancels outbound calls for a task in the industry edition","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TaskId"],"properties":{"endpoint":{"type":"string","enum":["https://aiccs.aliyuncs.com"],"default":"https://aiccs.aliyuncs.com","description":"Regional endpoint, for example https://aiccs.aliyuncs.com"},"TaskId":{"type":"integer","description":"The task ID"},"Numbers":{"type":"string","description":"The list of phone numbers (JSON-encoded)"},"Tags":{"type":"string","description":"The list of labels (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-aiccs/task-list":{"post":{"operationId":"cloud_aliyun_aiccs_task_list","summary":"Queries the list of tasks for the Industry Edition","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://aiccs.aliyuncs.com"],"default":"https://aiccs.aliyuncs.com","description":"Regional endpoint, for example https://aiccs.aliyuncs.com"},"TaskId":{"type":"integer","description":"The task ID"},"LastCallTime":{"type":"string","description":"The time of the last outbound call"},"CreateTime":{"type":"string","description":"The creation time"},"Status":{"type":"integer","description":"The task status. Valid values: 2: Published. 4: Disabled. 6: Deleted"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-aiccs/task-recover-call":{"post":{"operationId":"cloud_aliyun_aiccs_task_recover_call","summary":"Resumes outbound calls for canceled numbers in an Enterprise Edition task and adds them back to the outbound…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TaskId"],"properties":{"endpoint":{"type":"string","enum":["https://aiccs.aliyuncs.com"],"default":"https://aiccs.aliyuncs.com","description":"Regional endpoint, for example https://aiccs.aliyuncs.com"},"TaskId":{"type":"integer","description":"The task ID"},"Tags":{"type":"string","description":"The list of custom tags (JSON-encoded)"},"Numbers":{"type":"string","description":"The list of phone numbers (JSON-encoded)"},"BeginImportTime":{"type":"string","description":"The start time of the import period to query"},"EndImportTime":{"type":"string","description":"The end time of the import period to query"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-aiccs/template-list":{"post":{"operationId":"cloud_aliyun_aiccs_template_list","summary":"Queries the list of industry edition script templates","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://aiccs.aliyuncs.com"],"default":"https://aiccs.aliyuncs.com","description":"Regional endpoint, for example https://aiccs.aliyuncs.com"},"TemplateId":{"type":"integer","description":"Required empty parameter"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-aiccs/update-agent-status":{"post":{"operationId":"cloud_aliyun_aiccs_update_agent_status","summary":"Updates the agent status for the Industry Edition","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://aiccs.aliyuncs.com"],"default":"https://aiccs.aliyuncs.com","description":"Regional endpoint, for example https://aiccs.aliyuncs.com"},"AgentId":{"type":"integer","description":"The agent ID"},"AgentTag":{"type":"string","description":"The agent tag"},"AgentStatus":{"type":"integer","description":"The agent status. Valid values: 1: Online. 2: Busy. 3: Break. 4: Offline"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-aiccs/update-task-customer":{"post":{"operationId":"cloud_aliyun_aiccs_update_task_customer","summary":"Updates the number parameters of a task for the industry edition","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TaskId","Customers"],"properties":{"endpoint":{"type":"string","enum":["https://aiccs.aliyuncs.com"],"default":"https://aiccs.aliyuncs.com","description":"Regional endpoint, for example https://aiccs.aliyuncs.com"},"TaskId":{"type":"integer","description":"The task ID"},"Customers":{"type":"string","description":"The outbound call customers (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-aiccs/version":{"post":{"operationId":"cloud_aliyun_aiccs_version","summary":"version","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://aiccs.aliyuncs.com"],"default":"https://aiccs.aliyuncs.com","description":"Regional endpoint, for example https://aiccs.aliyuncs.com"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}