{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:aliyun-dyvmsapi/add-virtual-number-relation":{"post":{"operationId":"cloud_aliyun_dyvmsapi_add_virtual_number_relation","summary":"Associates service instances with real numbers in batches","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["NumberList","RouteType","PhoneNum"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"ProdCode":{"type":"string","description":"The product name. Default value: dyvms"},"CorpNameList":{"type":"string","description":"The list of company names. Separate multiple company names with commas (,)"},"NumberList":{"type":"string","description":"The list of real numbers. Separate multiple numbers with commas (,). You can log on to the Voice Messaging console…"},"RouteType":{"type":"integer","description":"The routing type. Valid values: 0: Home location priority. 1: Random"},"PhoneNum":{"type":"string","description":"Instance ID of the service instance. You can log on to the Voice Messaging console (https://dyvms.console.aliyun.com/virtual/list) and…"}}}}}},"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-dyvmsapi/batch-robot-smart-call":{"post":{"operationId":"cloud_aliyun_dyvmsapi_batch_robot_smart_call","summary":"Initiates outbound robocall tasks in a batch. You can set up to 100 numbers in a task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["CalledShowNumber","CalledNumber","DialogId","TaskName"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"CalledShowNumber":{"type":"string","description":"The number displayed to called parties, which must be a number you purchased. You can view the numbers you purchased in the Voice…"},"CorpName":{"type":"string","description":"The company name, which must be the same as the company name specified on the qualification management page…"},"CalledNumber":{"type":"string","description":"The called number. Only mobile phone numbers in the Chinese mainland are supported. You can set up to 1,000 called numbers and separate…"},"DialogId":{"type":"string","description":"The ID of the robot or communication script that is used to initiate a call. You can obtain the communication script ID from the…"},"EarlyMediaAsr":{"type":"string","description":"The speech recognition identifier of early media. The default value is false, which means that the speech recognition identifier of early…"},"TaskName":{"type":"string","description":"The task name. The task name can be up to 30 characters in length"},"ScheduleTime":{"type":"integer","description":"The preset call time. This value is a UNIX timestamp. Unit: milliseconds. This parameter is required only when ScheduleCall is set to true"},"ScheduleCall":{"type":"string","description":"Specifies whether the call is scheduled. If you set this parameter to true, the ScheduleTime parameter is required"},"TtsParam":{"type":"string","description":"The variable value of the TTS template, in the JSON format. The variable value must correspond to a number. The TtsParam parameter must be…"},"TtsParamHead":{"type":"string","description":"The call tasks with variables, in the JSON format. The parameter value is a list of variable names. The TtsParamHead parameter must be…"},"IsSelfLine":{"type":"string","description":"Specifies whether to call the self-managed line. Default value: false"}}}}}},"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-dyvmsapi/cancel-call":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cancel_call","summary":"Call the CancelCall operation to cancel incoming and outgoing calls initiated by ClickToDial","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["CallId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"CallId":{"type":"string","description":"The unique receipt ID for this call. Obtain it from the return information of the ClickToDial…"}}}}}},"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-dyvmsapi/cancel-order-robot-task":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cancel_order_robot_task","summary":"Cancels a robocall task that has not been started","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TaskId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"TaskId":{"type":"integer","description":"The unique ID of the robocall task. You can call the https://help.aliyun.com/document_detail/393531.html operation to obtain the ID 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-dyvmsapi/cancel-robot-task":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cancel_robot_task","summary":"Stops an intelligent voice task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"TaskId":{"type":"integer","description":"The unique task ID of the robot call task. You can call the https://help.aliyun.com/document_detail/393531.html operation to obtain 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-dyvmsapi/clink-agent-status":{"post":{"operationId":"cloud_aliyun_dyvmsapi_clink_agent_status","summary":"Monitors agent statuses","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The ID of the call center"},"Offset":{"type":"integer","description":"The offset. Default value: 0. Maximum value: 10000"},"Limit":{"type":"integer","description":"The number of records to query. Default value: 10. Maximum value: 100"}}}}}},"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-dyvmsapi/clink-agent-status-detail":{"post":{"operationId":"cloud_aliyun_dyvmsapi_clink_agent_status_detail","summary":"Queries the details of the agent status","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","Cno"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The ID of the call center"},"Cno":{"type":"string","description":"The ID of the agent"}}}}}},"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-dyvmsapi/clink-bind-client-tel":{"post":{"operationId":"cloud_aliyun_dyvmsapi_clink_bind_client_tel","summary":"Binds an agent phone number","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","Cno","Tel"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID"},"Cno":{"type":"string","description":"The agent ID"},"Tel":{"type":"string","description":"The phone number"},"IsBind":{"type":"integer","description":"Specifies whether to bind the phone number. Valid values: 1: Yes. 0: No"},"IsReserveTel":{"type":"integer","description":"Specifies whether to synchronize the phone number as a backup mobile phone. Valid values: 1: Yes. 0: No"}}}}}},"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-dyvmsapi/clink-cdr-ob-details":{"post":{"operationId":"cloud_aliyun_dyvmsapi_clink_cdr_ob_details","summary":"Queries the details of outbound call records","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","MainUniqueId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The ID of the call center"},"MainUniqueId":{"type":"string","description":"The unique identifier of the call record"},"HiddenType":{"type":"integer","description":"Specifies whether to hide phone numbers. Valid values: 0: do not hide. 1: hide the middle four digits. 2: hide the last eight digits. 3:…"}}}}}},"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-dyvmsapi/clink-create-client":{"post":{"operationId":"cloud_aliyun_dyvmsapi_clink_create_client","summary":"Creates an agent","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","Cno","Name","AreaCode","Password","Permission"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The ID of the call center"},"Cno":{"type":"integer","description":"The ID of the agent. The ID must be 4 to 11 characters in length, contain only digits, and be unique"},"Name":{"type":"string","description":"The name of the agent. The name can be up to 20 characters in length and can contain only letters, digits, underscores (_), and Chinese…"},"AreaCode":{"type":"string","description":"The area code"},"Password":{"type":"string","description":"The password of the agent. The password is encrypted by using AES and is 8 characters in length by default. If password security settings…"},"Role":{"type":"integer","description":"The role of the agent. Valid values: 0: regular agent 1: supervisor Default value: 0"},"Active":{"type":"integer","description":"The activation status of the agent. Valid values: 0: disabled 1: enabled Default value: 1"},"Qnos":{"type":"string","description":"The queue numbers associated with the agent (JSON-encoded)"},"HiddenTel":{"type":"integer","description":"The number masking type. Valid values: 0: do not mask 1: follow global masking rules Default value: 0"},"WrapupTime":{"type":"integer","description":"The wrap-up time after an outbound call. Valid values: 0 to 300. Unit: seconds. Default value: 30"},"CrmId":{"type":"integer","description":"The CRM ID. This ID can be used as a unique identifier when integrating with a third-party CRM system"},"ClidType":{"type":"integer","description":"The outbound caller ID type. Valid values: 0: all 2: specified by agent 3: smart caller ID Default value: 0"},"ClidRule":{"type":"integer","description":"The outbound caller ID rule. Default value: 1. If ClidType is set to 0, valid values are 1 for random and 2 for round-robin. If ClidType…"},"AssignType":{"type":"integer","description":"The number type. Valid values: 0: phone number 1: dynamic number group Default value: 0"},"DynamicTelGroupName":{"type":"string","description":"The name of the dynamic number group. This parameter is required if AssignType is set to 1"},"Clid":{"type":"string","description":"The outbound caller IDs. This parameter is required if ClidType is not set to 0 (JSON-encoded)"},"ClidDefault":{"type":"string","description":"The default outbound caller IDs. You can configure this parameter if ClidType is set to 3 and ClidRule is set to 1 (JSON-encoded)"},"ClidArea":{"type":"string","description":"The region-based outbound caller ID configuration. This parameter takes effect if ClidType is set to 3 and ClidRule is set to 2. For more…"},"RecurrentselectionType":{"type":"integer","description":"The round-robin mode. Valid values: 1: daily round-robin 2: per-call round-robin This parameter takes effect only if the outbound caller…"},"RecurrentselectionValue":{"type":"integer","description":"The round-robin value. This parameter takes effect only if the outbound caller ID type is set to all and the outbound caller ID rule is…"},"Permission":{"type":"string","description":"permission (JSON-encoded)"},"Type":{"type":"integer","description":"The agent type. Valid values: 1: Omnichannel. 2: Call center. 3: Online customer service. Default value: 2"},"WechatMiniProgramRtc":{"type":"integer","description":"Specifies whether to enable the RTC feature for WeChat mini programs. Valid values: 1: Enabled. 0: Disabled. Default value: Disabled"},"ObClidDefaultType":{"type":"integer","description":"The default number type. Valid values: 0: Number. 1: Dynamic number group. Default value: 0"},"DynamicTelGroupIdDefault":{"type":"integer","description":"The default dynamic outbound call group ID. This parameter is required when ObClidDefaultType is set to 1"},"ServeArea":{"type":"string","description":"The agent service areas. This parameter is an array of area codes used to configure the service areas for agents. It can be used in the…"},"CloudNumberEnabled":{"type":"integer","description":"Specifies whether to enable outbound calls by using cloud numbers. Valid values: 0: Disabled. 1: Enabled"},"CloudNumberModes":{"type":"string","description":"The four cloud number call modes. The array length is 4, which corresponds to the enabling status of the four cloud number outbound call…"},"ObHangupSms":{"type":"integer","description":"Specifies whether to enable the outbound call hang-up SMS feature. Valid values: 0: Disabled. 1: Enabled. When enabled, if an agent…"},"PauseLogin":{"type":"integer","description":"Specifies whether to allow busy logon. When disabled, agents are not allowed to log on in the busy state. Valid values: 0: Disabled. 1:…"}}}}}},"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-dyvmsapi/clink-create-enterprise-pause":{"post":{"operationId":"cloud_aliyun_dyvmsapi_clink_create_enterprise_pause","summary":"Adds a pause state","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","PauseStatus","IsRest","IsDefault"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The ID of the call center"},"PauseStatus":{"type":"string","description":"The description of the pause state. The description cannot exceed 4 characters"},"IsRest":{"type":"string","description":"Specifies whether the state is a rest state. Valid values: 0: No. 1: Yes"},"IsDefault":{"type":"integer","description":"Specifies whether the state is the default state. Valid values: 0: No. 1: Yes"}}}}}},"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-dyvmsapi/clink-create-exten":{"post":{"operationId":"cloud_aliyun_dyvmsapi_clink_create_exten","summary":"Creates a phone","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","ExtenNumber","Password","AreaCode","Type","Allow"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The ID of the call center"},"ExtenNumber":{"type":"string","description":"The phone number. It must be 3 to 6 digits in length and unique"},"Password":{"type":"string","description":"The password of the phone. For password rules, refer to the enterprise configuration"},"AreaCode":{"type":"string","description":"The area code of the phone. It must be 3 to 4 digits in length and start with 0"},"Type":{"type":"integer","description":"The type of the phone. Valid values: 1: IP phone. 2: Softphone"},"Allow":{"type":"integer","description":"The voice codec. Valid values for IP phones: 1, 2, 3, 4, and 5. Valid values for softphones: 5 and 6. 1: g729 (deprecated). 2: g729, alaw,…"},"IsDirect":{"type":"integer","description":"Specifies whether to allow direct outbound calls. Valid values: 1: allowed. 0: not allowed. If the phone type is IP phone, you can enable…"},"JittBuffer":{"type":"integer","description":"Specifies whether to enable the network jitter buffer. Valid values: 0: disabled. 1: enabled. Default value: 0. When this feature is…"}}}}}},"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-dyvmsapi/clink-create-queue":{"post":{"operationId":"cloud_aliyun_dyvmsapi_clink_create_queue","summary":"Creates a queue","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","Qno","Name"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID"},"Qno":{"type":"string","description":"The queue number. It must be a unique 4-digit number"},"Name":{"type":"string","description":"The queue name. It can contain only Chinese characters, letters, digits, and underscores, and can be up to 20 characters in length"},"MaxWait":{"type":"integer","description":"The maximum number of waiting calls. Valid values: 0 to 999. A value of 0 indicates no limit. Default value: 5"},"MemberTimeout":{"type":"integer","description":"The agent timeout period in seconds. Valid values: 20 to 60. Default value: 25"},"QueueTimeout":{"type":"integer","description":"The queue timeout period in seconds. Valid values: 30 to 600. Default value: 600"},"Strategy":{"type":"integer","description":"The call routing strategy. Valid values: 1: Sequential. 2: Round-robin. 3: Average. 4: Random. 5: Skill priority. 6: Longest cumulative…"},"Weight":{"type":"integer","description":"The queue priority. Valid values: 1 to 10. Default value: 1. If an agent belongs to multiple queues, calls from the queue with a higher…"},"WrapupTime":{"type":"integer","description":"The wrap-up time in seconds. Valid values: 3 to 300. During the wrap-up period, the agent does not receive new calls. Default value: 15"},"ServiceLevel":{"type":"integer","description":"The service level threshold in seconds. Valid values: 10 to 30. Calls answered within this time are considered to have a high service…"},"JoinEmpty":{"type":"integer","description":"Specifies whether to allow joining the queue when it is empty. Valid values: 1: Busy. 2: On a call. 4: Ringing. 8: Invalid. 16: Wrap-up.…"},"QueueMembers":{"type":"string","description":"The agents in the queue and their skill levels. Valid skill levels: 1 to 10, where 1 indicates the highest priority. Cno represents the…"},"IbAllowed":{"type":"integer","description":"Specifies whether to allow inbound calls to the queue. Valid values: 0: No. 1: Yes. Default value: 1"},"SayCno":{"type":"integer","description":"Specifies whether to announce the agent number. Valid values: 0: No. 1: Yes. Default value: 0"},"VipSupport":{"type":"integer","description":"Specifies whether to prioritize VIP customers. Valid values: 0: Not supported. 1: Supported. Default value: 0"},"MaxPauseClientFlag":{"type":"integer","description":"Specifies whether to enable the limit on the maximum number of concurrent busy agents. Valid values: 0: Disable. 1: Enable. Default value: 0"},"MaxPauseClientType":{"type":"integer","description":"The limit type for the maximum number of concurrent busy agents. Valid values: 0: Percentage. 1: Absolute value. Default value: 0"},"MaxPauseClientValue":{"type":"integer","description":"The limit value for the maximum number of concurrent busy agents. If the limit type is set to percentage, the maximum value is 100.…"},"ChatStrategy":{"type":"integer","description":"The online chat routing strategy. Valid values: 2: Round-robin. 4: Random. 5: Skill priority. Default value: 2"},"ChatMaxWait":{"type":"integer","description":"The maximum number of waiting online chat sessions. Default value: 20"},"ChatLocation":{"type":"integer","description":"The threshold for pushing the online chat queue position. A push notification is sent when the queue position is less than this value.…"}}}}}},"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-dyvmsapi/clink-delete-client":{"post":{"operationId":"cloud_aliyun_dyvmsapi_clink_delete_client","summary":"Deletes an agent","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","Cno"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID"},"Cno":{"type":"integer","description":"The agent ID. The value must be 4 to 11 characters in length and contain only digits"}}}}}},"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-dyvmsapi/clink-delete-exten":{"post":{"operationId":"cloud_aliyun_dyvmsapi_clink_delete_exten","summary":"Deletes a phone","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","ExtenNumber"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID"},"ExtenNumber":{"type":"string","description":"The phone number. It must be 3 to 6 digits 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-dyvmsapi/clink-describe-cdr-ib":{"post":{"operationId":"cloud_aliyun_dyvmsapi_clink_describe_cdr_ib","summary":"Queries inbound call records","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","MainUniqueId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The ID of the call center"},"MainUniqueId":{"type":"string","description":"The unique identifier of the call record"},"HiddenType":{"type":"integer","description":"Specifies whether to hide phone numbers. Valid values: 0: Do not hide. 1: Hide the middle four digits. 2: Hide the last eight digits. 3:…"}}}}}},"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-dyvmsapi/clink-describe-cdr-ib-details":{"post":{"operationId":"cloud_aliyun_dyvmsapi_clink_describe_cdr_ib_details","summary":"Queries the details of inbound call records","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID"},"MainUniqueId":{"type":"string","description":"The unique identifier of the call record"}}}}}},"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-dyvmsapi/clink-describe-cdr-ob":{"post":{"operationId":"cloud_aliyun_dyvmsapi_clink_describe_cdr_ob","summary":"Queries outbound call records","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","MainUniqueId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The ID of the call center"},"MainUniqueId":{"type":"string","description":"The unique identifier of the call record"},"HiddenType":{"type":"integer","description":"Specifies whether to mask phone numbers. Valid values: 0: Do not mask. 1: Mask the middle four digits. 2: Mask the last eight digits. 3:…"}}}}}},"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-dyvmsapi/clink-describe-cdr-ob-details":{"post":{"operationId":"cloud_aliyun_dyvmsapi_clink_describe_cdr_ob_details","summary":"Queries the details of outbound call records","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID"},"MainUniqueId":{"type":"string","description":"The unique identifier of the call record"}}}}}},"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-dyvmsapi/clink-describe-client":{"post":{"operationId":"cloud_aliyun_dyvmsapi_clink_describe_client","summary":"Queries the details of an agent","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","Cno"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID"},"Cno":{"type":"string","description":"The agent number"}}}}}},"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-dyvmsapi/clink-describe-queue":{"post":{"operationId":"cloud_aliyun_dyvmsapi_clink_describe_queue","summary":"Queries the details of a queue","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","Qno"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The ID of the call center"},"Qno":{"type":"string","description":"The queue number"}}}}}},"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-dyvmsapi/clink-describe-record-file-url":{"post":{"operationId":"cloud_aliyun_dyvmsapi_clink_describe_record_file_url","summary":"Retrieves the URL of a call recording","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","MainUniqueId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The ID of the call center"},"MainUniqueId":{"type":"string","description":"The unique identifier of the call record"},"RecordSide":{"type":"integer","description":"Specifies the recording side. If this parameter is not specified, an MP3 recording is retrieved. If this parameter is specified, a WAV…"},"Timeout":{"type":"integer","description":"The timeout period for retrieving the recording URL, in seconds. Default value: 3600. Valid values: 3600 to 86400"},"Download":{"type":"integer","description":"Specifies the action for the recording. Valid values: 0: playback. 1: download. Default value: 1"},"RecordType":{"type":"string","description":"The type of the recording. Valid values: record: call recording. voicemail: voice mail. Default value: record"}}}}}},"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-dyvmsapi/clink-detail-cdr-ib":{"post":{"operationId":"cloud_aliyun_dyvmsapi_clink_detail_cdr_ib","summary":"Queries the details of customer inbound call records","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","MainUniqueId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The ID of the call center"},"MainUniqueId":{"type":"string","description":"The unique identifier of the call record"},"HiddenType":{"type":"integer","description":"Specifies the number masking type. Valid values: 0: No masking. 1: Middle four digits. 2: Last eight digits. 3: All digits. 4: Last four…"}}}}}},"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-dyvmsapi/clink-list-cdr-ib":{"post":{"operationId":"cloud_aliyun_dyvmsapi_clink_list_cdr_ib","summary":"Queries a list of customer incoming call records","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The ID of the call center"},"StartTime":{"type":"integer","description":"The start time. The value is a UNIX timestamp accurate to seconds. Default value: the first day of the current month"},"StartTimeEnd":{"type":"integer","description":"The end of the start time range. The value is a UNIX timestamp accurate to seconds. The time span between the start time and end time…"},"BridgeTime":{"type":"integer","description":"The time when the call is answered. The value is a UNIX timestamp accurate to seconds"},"BridgeTimeEnd":{"type":"integer","description":"The end of the answer time range. The value is a UNIX timestamp accurate to seconds"},"EndTime":{"type":"integer","description":"The end time. The value is a UNIX timestamp accurate to seconds"},"EndTimeEnd":{"type":"integer","description":"The end of the end time range. The value is a UNIX timestamp accurate to seconds"},"HiddenType":{"type":"integer","description":"Specifies whether to mask the phone number. Valid values: 0: Do not mask. 1: Mask the middle four digits. 2: Mask the last eight digits.…"},"BridgeDuration":{"type":"integer","description":"The minimum call duration for the range query. This parameter must be used together with BridgeDurationEnd"},"BridgeDurationEnd":{"type":"integer","description":"The maximum call duration for the range query"},"TotalDuration":{"type":"integer","description":"The minimum total duration for the range query. This parameter must be used together with TotalDurationEnd"},"TotalDurationEnd":{"type":"integer","description":"The maximum total duration for the range query"},"Cnos":{"type":"string","description":"The ID of the agent"},"Qnos":{"type":"string","description":"The ID of the queue"},"Statuses":{"type":"integer","description":"The answer status. Valid values: 1: Answered by an agent. 2: Not answered by an agent. 3: Answered by the system. 4: Not answered by the…"},"MainUniqueId":{"type":"string","description":"The unique ID of the call record"},"ScrollSearch":{"type":"string","description":"Specifies whether to use scroll search. Valid values: true and false. Default value: false"},"ScrollId":{"type":"string","description":"The ID for scroll search. This parameter must be used together with ScrollSearch. You do not need to specify this parameter for the first…"},"Offset":{"type":"integer","description":"The offset. Valid values: 0 to 99990. Default value: 0. Note: The sum of Limit and Offset cannot exceed 100,000"},"Limit":{"type":"integer","description":"The number of entries to return. Valid values: 10 to 100. Default value: 10. Note: The sum of Limit and Offset cannot exceed 100,000"},"FirstCallCno":{"type":"string","description":"The ID of the agent who handled the first call"},"FirstCallQno":{"type":"string","description":"The ID of the queue that handled the first call"},"FirstCallNumber":{"type":"string","description":"The phone number of the agent who handled the first call"},"ClientNumber":{"type":"string","description":"The phone number of the agent"},"CustomerNumber":{"type":"string","description":"The phone number of the customer"}}}}}},"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-dyvmsapi/clink-list-cdr-ib-agent":{"post":{"operationId":"cloud_aliyun_dyvmsapi_clink_list_cdr_ib_agent","summary":"Queries a list of agent answer records","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The ID of the call center"},"StartTime":{"type":"integer","description":"The start time. The value is a timestamp accurate to seconds. Default value: the first day of the current month"},"StartTimeEnd":{"type":"integer","description":"The upper bound of the start time. The value is a timestamp accurate to seconds. The time span between the start time and the end time…"},"BridgeTime":{"type":"integer","description":"The answer time. The value is a timestamp accurate to seconds"},"BridgeTimeEnd":{"type":"integer","description":"The upper bound of the answer time. The value is a timestamp accurate to seconds"},"EndTime":{"type":"integer","description":"The end time. The value is a timestamp accurate to seconds"},"EndTimeEnd":{"type":"integer","description":"The upper bound of the end time. The value is a timestamp accurate to seconds"},"HiddenType":{"type":"integer","description":"Specifies whether to mask phone numbers. Valid values: 0: Do not mask. 1: Mask the middle four digits. 2: Mask the last eight digits. 3:…"},"ClientNumber":{"type":"string","description":"The agent phone number"},"BridgeDuration":{"type":"integer","description":"The minimum call duration for range queries. Use this parameter together with BridgeDurationEnd"},"BridgeDurationEnd":{"type":"integer","description":"The maximum call duration for range queries"},"AgentAnswerInTime":{"type":"integer","description":"Specifies whether the call was answered promptly. Valid values: 0: No. 1: Yes. Default value: all"},"MainUniqueId":{"type":"string","description":"The unique identifier of the call record"},"CustomerNumber":{"type":"string","description":"The customer phone number"},"HotlineName":{"type":"string","description":"The hotline alias"},"ScrollId":{"type":"string","description":"The scroll ID. Use this parameter together with scrollSearch. You do not need to specify this parameter for the first query. For…"},"Offset":{"type":"integer","description":"The offset. Valid values: 0 to 99990. Default value: 0. Note: The sum of Limit and Offset cannot exceed 100,000"},"Limit":{"type":"integer","description":"The number of entries to return. Valid values: 10 to 100. Default value: 10. Note: The sum of Limit and Offset cannot exceed 100,000"},"Qno":{"type":"string","description":"The queue number"},"Cno":{"type":"string","description":"The agent 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-dyvmsapi/clink-list-cdr-ibs":{"post":{"operationId":"cloud_aliyun_dyvmsapi_clink_list_cdr_ibs","summary":"Queries the list of inbound call records","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID"},"HiddenType":{"type":"integer","description":"Specifies whether to hide phone numbers. Valid values: 0: do not hide 1: hide the middle four digits 2: hide the last eight digits 3: hide…"},"Qno":{"type":"string","description":"The queue number"},"CustomerNumber":{"type":"string","description":"The customer number"},"Cno":{"type":"string","description":"The agent ID"},"Status":{"type":"integer","description":"The answer status. Valid values: 0: all 1: answered by agent 2: agent called but not answered 3: answered by system 4: not answered by…"},"MainUniqueId":{"type":"string","description":"The unique identifier of the call record"},"ClientNumber":{"type":"string","description":"The agent phone number"},"QueueAnswerInTime":{"type":"integer","description":"Specifies whether the queue was answered in a timely manner. Valid values: 0: no 1: yes 2: -"},"StartTime":{"type":"integer","description":"The start time. The timestamp is accurate to seconds. Default value: the first day of the current month"},"EndTime":{"type":"integer","description":"The end time. The timestamp is accurate to seconds. The time span between the start time and the end time cannot exceed one month. Default…"},"Offset":{"type":"integer","description":"The offset. Valid values: 0 to 99990. Default value: 0. Note: The sum of limit and offset cannot exceed 100,000"},"Limit":{"type":"integer","description":"The number of entries to return. Valid values: 10 to 100. Default value: 10. Note: The sum of limit and offset cannot exceed 100,000"}}}}}},"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-dyvmsapi/clink-list-cdr-ob":{"post":{"operationId":"cloud_aliyun_dyvmsapi_clink_list_cdr_ob","summary":"Queries a list of outbound call records","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The ID of the call center"},"StartTime":{"type":"integer","description":"The start time. The timestamp is accurate to seconds. Default value: the first day of the current month"},"StartTimeEnd":{"type":"integer","description":"The end of the start time range for the query. The timestamp is accurate to seconds. The time span between the start time and the end time…"},"BridgeTime":{"type":"integer","description":"The time when the call is answered. The timestamp is accurate to seconds"},"BridgeTimeEnd":{"type":"integer","description":"The end of the answer time range for the query. The timestamp is accurate to seconds"},"EndTime":{"type":"integer","description":"The end time. The timestamp is accurate to seconds"},"EndTimeEnd":{"type":"integer","description":"The end of the end time range for the query. The timestamp is accurate to seconds"},"HiddenType":{"type":"integer","description":"Specifies whether to mask the phone number. Valid values: 0: Do not mask. 1: Mask the middle four digits. 2: Mask the last eight digits.…"},"BridgeDuration":{"type":"integer","description":"The minimum value of the call duration range for the query. This parameter is used together with BridgeDurationEnd"},"BridgeDurationEnd":{"type":"integer","description":"The maximum value of the call duration range for the query"},"TotalDuration":{"type":"integer","description":"The minimum value of the total duration range for the query. This parameter is used together with TotalDurationEnd"},"TotalDurationEnd":{"type":"integer","description":"The maximum value of the total duration range for the query"},"Cnos":{"type":"string","description":"The ID of the agent"},"Qnos":{"type":"string","description":"The outbound call group"},"ClientNumber":{"type":"string","description":"The phone number of the agent"},"CustomerNumber":{"type":"string","description":"The phone number of the customer"},"CallType":{"type":"integer","description":"The type of the call. Valid values: 4: Preview outbound call. 6: Active outbound call. Default value: all"},"LeftClid":{"type":"string","description":"The caller ID number"},"Xnumber":{"type":"string","description":"The number of the service instance"},"Status":{"type":"integer","description":"The answer status. Valid values: 1: The customer did not answer. 2: The agent did not answer. 3: The customer answered. 4: The agent…"},"MainUniqueId":{"type":"string","description":"The unique identifier of the call record"},"TaskName":{"type":"string","description":"The name of the call task"},"Offset":{"type":"integer","description":"The offset. Valid values: 0 to 99990. Default value: 0. Note: The sum of Limit and Offset cannot exceed 100,000"},"Limit":{"type":"integer","description":"The number of entries to return. Valid values: 10 to 100. Default value: 10. Note: The sum of Limit and Offset cannot exceed 100,000"},"ScrollSearch":{"type":"string","description":"Specifies whether to use scroll search. Valid values: true: Use scroll search. false: Do not use scroll search. Default value: false"},"ScrollId":{"type":"string","description":"The ID for scroll search. This parameter is used together with ScrollSearch. You do not need to specify this parameter for the first…"}}}}}},"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-dyvmsapi/clink-list-cdr-obs":{"post":{"operationId":"cloud_aliyun_dyvmsapi_clink_list_cdr_obs","summary":"Queries a list of outbound call records","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The ID of the call center"},"HiddenType":{"type":"integer","description":"Specifies whether to mask phone numbers. Valid values: 0: Do not mask. 1: Mask the middle four digits. 2: Mask the last eight digits. 3:…"},"CustomerNumber":{"type":"string","description":"The phone number of the customer"},"Cno":{"type":"string","description":"The ID of the agent. The value must be 4 to 11 digits in length"},"Hotline":{"type":"string","description":"The hotline number"},"Status":{"type":"integer","description":"The answer status of the call. Valid values: 0: All. 1: Not answered by the customer. 2: Not answered by the agent. 3: Answered by both…"},"Mark":{"type":"integer","description":"The mark of the call. Valid values: Empty: All. 1: Voicemail. 2: Transfer. 3: Consultation. 4: Three-way call. 5: Fax received. 6:…"},"Province":{"type":"string","description":"The province of the customer"},"City":{"type":"string","description":"The city of the customer"},"MainUniqueId":{"type":"string","description":"The unique identifier of the call record"},"RequestUniqueId":{"type":"string","description":"The unique identifier of the request"},"ClientNumber":{"type":"string","description":"The phone number of the agent"},"QueueAnswerInTime":{"type":"integer","description":"Specifies whether the call was answered in the queue within the specified time. Valid values: 0: No. 1: Yes. 2: Not applicable"},"Evaluation":{"type":"integer","description":"Specifies whether the customer was invited to evaluate the service. Valid values: 0: No. 1: Yes. 2: Not applicable"},"IdType":{"type":"integer","description":"The type of the business ID. Valid values: 1: Ticket. 2: Business record"},"AssociatedId":{"type":"integer","description":"The business ID"},"StartTime":{"type":"integer","description":"The start time. The value must be a UNIX timestamp accurate to seconds. Default value: the first day of the current month"},"EndTime":{"type":"integer","description":"The end time. The value must be a UNIX timestamp accurate to seconds. The time span between the start time and the end time cannot exceed…"},"Offset":{"type":"integer","description":"The offset. Valid values: 0 to 99990. Default value: 0. Note: The sum of Limit and Offset cannot exceed 100,000"},"Limit":{"type":"integer","description":"The number of entries to return. Valid values: 10 to 100. Default value: 10. Note: The sum of Limit and Offset cannot exceed 100,000"}}}}}},"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-dyvmsapi/clink-list-clients":{"post":{"operationId":"cloud_aliyun_dyvmsapi_clink_list_clients","summary":"Queries the list of agents","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The ID of the call center"},"Qno":{"type":"string","description":"The queue number"},"Active":{"type":"integer","description":"Specifies whether the agent is activated. Valid values: 1: Activated. 0: Not activated"},"Clid":{"type":"string","description":"The outbound caller ID"},"BindTel":{"type":"string","description":"The bound phone number"},"StartTime":{"type":"integer","description":"The start time of the creation time range. The value is a UNIX timestamp in seconds"},"EndTime":{"type":"integer","description":"The end time of the creation time range. The value is a UNIX timestamp in seconds"},"UpdateStartTime":{"type":"integer","description":"The start time of the update time range. The value is a UNIX timestamp in seconds"},"UpdateEndTime":{"type":"integer","description":"The end time of the update time range. The value is a UNIX timestamp in seconds"},"Offset":{"type":"integer","description":"The offset. Default value: 0. Maximum value: 10000"},"Limit":{"type":"integer","description":"The maximum number of records to return. Default value: 10. Maximum value: 100"}}}}}},"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-dyvmsapi/clink-list-enterprise-pauses":{"post":{"operationId":"cloud_aliyun_dyvmsapi_clink_list_enterprise_pauses","summary":"Queries the list of pause statuses","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center 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-dyvmsapi/clink-list-extens":{"post":{"operationId":"cloud_aliyun_dyvmsapi_clink_list_extens","summary":"Queries a list of phones","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The ID of the call center"},"AreaCode":{"type":"string","description":"The area code of the phone. It must be a 3- to 4-digit number starting with 0"},"Type":{"type":"integer","description":"The type of the phone. Valid values: 1: IP phone. 2: Softphone"},"Offset":{"type":"integer","description":"The offset. Valid values: 0 to 10000. Default value: 0"},"Limit":{"type":"integer","description":"The number of entries to return. Valid values: 10 to 100. Default value: 10"}}}}}},"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-dyvmsapi/clink-list-ivr-nodes":{"post":{"operationId":"cloud_aliyun_dyvmsapi_clink_list_ivr_nodes","summary":"Queries the list of IVR nodes","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","IvrName"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The ID of the call center"},"IvrName":{"type":"string","description":"The name of the IVR"}}}}}},"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-dyvmsapi/clink-list-ivrs":{"post":{"operationId":"cloud_aliyun_dyvmsapi_clink_list_ivrs","summary":"Queries the IVR list","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center 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-dyvmsapi/clink-list-queues":{"post":{"operationId":"cloud_aliyun_dyvmsapi_clink_list_queues","summary":"Queries the list of queues","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The ID of the call center"},"Offset":{"type":"integer","description":"The offset. Default value: 0. Maximum value: 10000"},"Limit":{"type":"integer","description":"The number of entries to return. Default value: 10. Maximum value: 100"}}}}}},"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-dyvmsapi/clink-stat-ib":{"post":{"operationId":"cloud_aliyun_dyvmsapi_clink_stat_ib","summary":"Queries inbound call statistics","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","Date"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The ID of the call center"},"Date":{"type":"string","description":"The synchronization date. Format: yyyyMMdd"},"DateEnd":{"type":"string","description":"The end synchronization date. Format: yyyyMMdd. Default value: the value of Date. The maximum time range for a query is 6 months"},"Hotlines":{"type":"string","description":"The hotline numbers to query. Default value: all hotline numbers"},"Fields":{"type":"string","description":"The fields to display. Default value: all fields"},"StatisticMethod":{"type":"integer","description":"The statistical method. Valid values: 2: aggregate statistics. 3: time-based statistics. Default value: 2. Note: For time-based…"},"StartHour":{"type":"integer","description":"The start hour for the query. Valid values: 0 to 23. Default value: 0"},"EndHour":{"type":"integer","description":"The end hour for the query. Valid values: 0 to 23. Default value: 23"},"StartMinute":{"type":"integer","description":"The start minute for the query. Valid values: 0, 15, 30, and 45. Default value: 0"},"EndMinute":{"type":"integer","description":"The end minute for the query. Valid values: 0, 15, 30, 45, and 59. Default value: 59. Note: The start time composed of StartHour and…"}}}}}},"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-dyvmsapi/clink-update-client":{"post":{"operationId":"cloud_aliyun_dyvmsapi_clink_update_client","summary":"Updates an agent","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","Cno","Permission"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID"},"Cno":{"type":"integer","description":"The unique agent ID. The ID must be 4 to 11 digits in length"},"Name":{"type":"string","description":"The agent name. The name can contain only Chinese characters, letters, digits, and underscores (_), and can be up to 20 characters in length"},"AreaCode":{"type":"string","description":"The area code"},"Password":{"type":"string","description":"The agent password. The password is encrypted by using AES and is 8 characters in length by default. If password security settings are…"},"Role":{"type":"integer","description":"The agent role. Valid values: 0: regular agent 1: supervisor"},"Active":{"type":"integer","description":"The activation status. Valid values: 0: disabled 1: enabled"},"Qnos":{"type":"string","description":"The queue numbers (JSON-encoded)"},"HiddenTel":{"type":"integer","description":"The phone number masking type. Valid values: 0: do not mask 1: follow global settings"},"IbWrapupType":{"type":"integer","description":"The inbound wrap-up type. Valid values: 1: queue 2: agent"},"IbWrapupTime":{"type":"integer","description":"The inbound wrap-up time. This is the after-call processing time for an agent after an inbound call ends. During this period, the agent…"},"WrapupTime":{"type":"integer","description":"The wrap-up time. This is the after-call processing time for an agent after an outbound call ends. Valid values: 0 to 300. Unit: seconds"},"CrmId":{"type":"integer","description":"The CRM ID. This ID can be used as a unique identifier when integrating with a third-party CRM system"},"ClidType":{"type":"integer","description":"The caller ID type. Valid values: 0: all 2: specified by agent 3: smart caller ID"},"AssignType":{"type":"integer","description":"The number type. Valid values: 0: number 1: dynamic number group Default value: 0"},"DynamicTelGroupName":{"type":"string","description":"The dynamic number group name. This parameter is required when AssignType is set to 1"},"ClidRule":{"type":"integer","description":"The caller ID rule. Valid values when ClidType is set to 0: 1: random 2: round-robin Valid values when ClidType is set to 3: 1: dynamic 2:…"},"Clid":{"type":"string","description":"The available caller IDs. This parameter is required when the caller ID type is not set to all (JSON-encoded)"},"ClidDefault":{"type":"string","description":"The default caller IDs. This parameter is supported when ClidType is set to 3 and ClidRule is set to 1 (JSON-encoded)"},"ClidArea":{"type":"string","description":"The region-based caller ID configuration. This parameter takes effect when ClidType is set to 3 and ClidRule is set to 2. For specific…"},"RecurrentselectionType":{"type":"integer","description":"The round-robin mode. This parameter takes effect when the caller ID type is set to all and the caller ID rule is set to round-robin.…"},"RecurrentselectionValue":{"type":"integer","description":"The round-robin value. This parameter takes effect when the caller ID type is set to all and the caller ID rule is set to round-robin.…"},"Permission":{"type":"string","description":"permission (JSON-encoded)"},"WechatMiniProgramRtc":{"type":"integer","description":"Specifies whether to enable RTC for WeChat mini programs. Valid values: 1: Enabled. 0: Disabled. Default value: 0"},"ObClidDefaultType":{"type":"integer","description":"The default number type. Valid values: 0: Number. 1: Dynamic number group. Default value: 0"},"DynamicTelGroupIdDefault":{"type":"integer","description":"The ID of the default dynamic outbound group. This parameter is required when ObClidDefaultType is set to 1"},"ServeArea":{"type":"string","description":"The service areas of agents, represented as an array of area codes. You can configure the service areas for agents, which can be used in…"},"CloudNumberEnabled":{"type":"integer","description":"Specifies whether to enable outbound calls by using cloud numbers. Valid values: 0: Disabled. 1: Enabled"},"CloudNumberModes":{"type":"string","description":"The four call modes for cloud numbers. The array length is 4, which corresponds to the enabling status of the four outbound call modes for…"},"ObHangupSms":{"type":"integer","description":"Specifies whether to enable the hang-up SMS feature for outbound calls. Valid values: 0: Disabled. 1: Enabled. After this feature is…"},"PauseLogin":{"type":"integer","description":"Specifies whether to allow agents to log on in the busy state. If this feature is disabled, agents are not allowed to log on in the busy…"}}}}}},"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-dyvmsapi/cloud-agent-login":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_agent_login","summary":"Sets an agent to online status","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","Cno","BindTel","BindType"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID"},"Cno":{"type":"string","description":"The agent ID. The value is a positive integer of 3 to 10 digits"},"BindTel":{"type":"string","description":"The bound phone number"},"BindType":{"type":"integer","description":"The bind type. Valid values: - 1: Regular phone. - 2: Extension. - 3: WebRTC. Note: If the bind type is set to extension, the extension…"},"LoginStatus":{"type":"integer","description":"The logon status. Valid values: 1: Available. 2: Busy. Default value: 1"},"PauseDescription":{"type":"string","description":"The description for the busy status"}}}}}},"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-dyvmsapi/cloud-agent-logout":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_agent_logout","summary":"Offlines an agent","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","Cno"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID. Before calling this operation, create a call center instance in the Cloud Call Center console and obtain the instance…"},"Cno":{"type":"string","description":"The agent ID. The value is a positive integer of 3 to 10 digits"},"RemoveBinding":{"type":"integer","description":"Specifies whether to unbind the phone. Valid values: 0: Do not unbind the phone. 1: Unbind the phone. Default value: 0"},"IsKickout":{"type":"integer","description":"Specifies whether to send a kickout event to the agent. Valid values: 0: Do not send. 1: Send. Default value: 1"},"IgnoreOffline":{"type":"integer","description":"Specifies whether to ignore duplicate offline errors. Valid values: 0: Do not ignore. 1: Ignore. Default value: 0"}}}}}},"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-dyvmsapi/cloud-agent-monitor-statistics":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_agent_monitor_statistics","summary":"Collects real-time call statistics for agents","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID. Before calling this operation, create a call center instance in the Cloud Contact Center console and obtain the…"},"Fields":{"type":"string","description":"The names of the statistics fields. Specify the field names used in queue real-time statistics. Separate multiple field names with commas…"},"Cnos":{"type":"string","description":"The agent IDs used to query statistics for specified agents. You can specify multiple agent IDs separated by commas (,). By default,…"},"IsUseGno":{"type":"integer","description":"Specifies whether to enable outbound group query. Valid values: 0: disabled (default). 1: enabled"},"Gno":{"type":"string","description":"The outbound group IDs used to query statistics for specified agents. You can specify multiple outbound group IDs separated by commas (,).…"},"Limit":{"type":"integer","description":"The number of entries to return. The value must be a positive integer. Default value: 10. Maximum value: 500"},"Offset":{"type":"integer","description":"The starting position of the query. The value must be a positive integer. Default value: 0. This parameter is used together with Limit.…"},"StartHour":{"type":"integer","description":"The start hour of the statistical period. The value must be a positive integer from 0 to 23. Maximum value: 23"},"EndHour":{"type":"integer","description":"The end hour of the statistical period. The value must be a positive integer from 1 to 24. Maximum value: 24"},"IsNeedQueueName":{"type":"string","description":"Specifies whether to return the queue name. Valid values: 0: not required (default). 1: required"}}}}}},"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-dyvmsapi/cloud-agent-set-user-data":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_agent_set_user_data","summary":"Sets the call-associated data for an agent","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","Cno","Direction","UserData"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The ID of the call center"},"Cno":{"type":"string","description":"The ID of the agent. The value must be a positive integer of 3 to 10 digits"},"Direction":{"type":"integer","description":"The direction of the call-associated data. Valid values: 1: Agent side. 2: Non-agent side"},"UserData":{"type":"string","description":"The user data in JSON string format. The specified values are injected into channel variables. Format: JSON string {\"key\":\"value\"}. 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-dyvmsapi/cloud-agent-unlink":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_agent_unlink","summary":"Ends a call for an agent","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID"},"Cno":{"type":"string","description":"The ID of the agent. The value must be a positive integer of 3 to 10 digits. You must specify one of the Cno, UniqueId, and…"},"UniqueId":{"type":"string","description":"The unique ID of the call. You must specify one of the Cno, UniqueId, and RequestUniqueId parameters"},"RequestUniqueId":{"type":"string","description":"The unique ID of the request. You must specify one of the Cno, UniqueId, and RequestUniqueId parameters. Note: The hang-up feature based…"},"Side":{"type":"integer","description":"Specifies whether the call is disconnected on the agent side. Valid values: 1: Agent side. 2: Non-agent side. Default value: 1"}}}}}},"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-dyvmsapi/cloud-agent-workload-report":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_agent_workload_report","summary":"Retrieves agent workload report data","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","StatisticMethod","TimeRangeType","StartTime","EndTime"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID. Before calling this operation, create a call center instance in the Cloud Call Center console and obtain the instance…"},"StatisticMethod":{"type":"integer","description":"The statistical method. Valid values: 0: by hour. 1: by day. 2: summary. 10: queue summary"},"TimeRangeType":{"type":"integer","description":"The statistical report type. Valid values: 1: Daily report. 2: Weekly report. 3: Monthly report. 4: Custom time range"},"StartTime":{"type":"string","description":"The start time of the statistical date range. Format: yyyy-MM-dd"},"EndTime":{"type":"string","description":"The end time of the statistical date range. Format: yyyy-MM-dd"},"Cnos":{"type":"string","description":"The agent ID. Queries workload statistics for specified agents by agent ID. You can specify multiple agent IDs separated by commas (,). By…"},"Gnos":{"type":"string","description":"The outbound call ID. Queries workload statistics for specified agents by outbound call ID. By default, workload statistics for all agents…"},"Start":{"type":"integer","description":"The query start position. The value must be greater than or equal to 0. Default value: 0"},"Limit":{"type":"integer","description":"The number of records to query. Maximum value: 1000. Default value: 10"}}}}}},"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-dyvmsapi/cloud-assign-agent-group":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_assign_agent_group","summary":"Assigns agents to an outbound call group","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID"},"Gno":{"type":"string","description":"The outbound call group number. This parameter binds the outbound call group specified by Gno to the agents specified by Cnos. A single…"},"Cnos":{"type":"string","description":"The agent numbers. Separate multiple agent numbers with commas (,). You can specify up to 1,000 agent numbers at a time. An agent 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-dyvmsapi/cloud-batch-create-agent":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_batch_create_agent","summary":"Creates multiple agents in batches. A single batch can contain up to 100 agents","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","Cno","EndCno","Name","AreaCode"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The ID of the call center"},"Cno":{"type":"string","description":"The starting agent ID. It must be a positive integer consisting of 3 to 10 digits"},"EndCno":{"type":"string","description":"The ending agent ID. It must be a positive integer consisting of 3 to 10 digits. The maximum number of agents that can be created in a…"},"Name":{"type":"string","description":"The name of the agent. The name must be URL-encoded in UTF-8 format"},"AreaCode":{"type":"string","description":"The area code to which the agent belongs"},"Active":{"type":"integer","description":"Specifies whether the agent is activated. Valid values: 0: Not activated. 1: Activated. Default value: 1"},"Power":{"type":"integer","description":"The role of the agent. Valid values: 1: Supervisor. 0: Regular agent. Default value: 0"},"CallPower":{"type":"integer","description":"The call permissions of the agent. Valid values: 0: Unlimited. 1: Domestic long-distance calls. 2: Domestic local calls. 3: Internal…"},"Wrapup":{"type":"integer","description":"The wrap-up time. Unit: seconds. Default value: 10"},"IsOb":{"type":"integer","description":"Specifies whether outbound calls are allowed. Valid values: 0: Not allowed. 1: Allowed. Default value: 1"},"ObClidType":{"type":"integer","description":"The caller ID display rule. Valid values: 1: Default. 2: Random. 3: By area code. 4: Dynamic caller ID. Default value: 1"},"ObClid":{"type":"string","description":"The pass-through number. You can specify an enterprise trunk number or a configured customer-facing caller ID number. This parameter is…"},"ObClidProperty":{"type":"string","description":"The caller ID display properties. Example value: {\"isMatchCapital\":0,\"areaCodeRule\":1}. When ObClidType is set to 4, isMatchCapital…"},"IbRecord":{"type":"integer","description":"Specifies whether to record inbound calls. Valid values: 0: Do not record. 1: Record. Default value: 1"},"ObRecord":{"type":"integer","description":"Specifies whether to record outbound calls. Valid values: 0: Do not record. 1: Record. Default value: 1"},"SkillIds":{"type":"string","description":"The IDs of the selected skills. You can specify multiple IDs separated by commas (,). Example: \"1,2,3\". If you specify SkillIds, you must…"},"SkillLevels":{"type":"string","description":"The levels of the selected skills. A smaller value indicates a higher skill level. Specify multiple levels separated by commas (,). The…"},"IsAsr":{"type":"integer","description":"Specifies whether to enable automatic speech recognition (ASR) transcription. Valid values: 0: Disabled. 1: Enabled. Default value: 0"},"IsQualityCheck":{"type":"integer","description":"Specifies whether to enable agent quality check. Valid values: 0: Disabled. 1: Enabled. Default value: 1"},"WebrtcUrlType":{"type":"integer","description":"The return address type for the WebRTC softphone. Valid values: 0: Enterprise default. 1: Public domain name. 2: Leased line domain name.…"},"Comment":{"type":"string","description":"The remarks"}}}}}},"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-dyvmsapi/cloud-batch-get-agent-status":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_batch_get_agent_status","summary":"Retrieves the real-time status of agents in batches based on agent IDs","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","Cnos"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The ID of the call center"},"Cnos":{"type":"string","description":"The list of agent IDs. Separate multiple agent IDs with commas (,). Example: cnos=2000,2001. A maximum of 100 agents are supported"}}}}}},"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-dyvmsapi/cloud-batch-update-agent":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_batch_update_agent","summary":"Updates the basic information of multiple agents in a batch, excluding the skill information bound to the…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","Cnos"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The ID of the call center"},"Cnos":{"type":"string","description":"The list of agent IDs. Separate multiple IDs with commas (,). You can update up to 100 agents at a time. Example: \"0001,0002,00103\". An…"},"Name":{"type":"string","description":"The name of the agent. The value must be URL-encoded in UTF-8 format"},"AreaCode":{"type":"string","description":"The area code of the agent"},"Active":{"type":"integer","description":"Specifies whether the agent is activated. Valid values: 0: Not activated. 1: Activated. Default value: 1"},"AgentType":{"type":"integer","description":"The type of the agent. Valid values: 1: Phone agent. 2: Computer agent. Default value: 1"},"Power":{"type":"integer","description":"The role of the agent. Valid values: 1: Supervisor. 0: Regular agent. Default value: 0"},"CallPower":{"type":"integer","description":"The call permission of the agent. Valid values: 0: Unlimited. 1: Domestic long-distance calls. 2: Domestic local calls. 3: Internal calls.…"},"Wrapup":{"type":"integer","description":"The wrap-up time in seconds. Default value: 10"},"IsOb":{"type":"integer","description":"Specifies whether outbound calls are allowed. Valid values: 0: Not allowed. 1: Allowed. Default value: 1"},"ObClidType":{"type":"integer","description":"The caller ID display rule. Valid values: 1: Default. 2: Random. 3: By area code. 4: Dynamic caller ID. Default value: 1"},"ObClid":{"type":"string","description":"The caller ID number. You can enter an enterprise trunk number or a configured customer-facing caller ID number. This parameter is…"},"IsRandom":{"type":"string","description":"Specifies whether to use a random caller ID. Valid values: 0: No. 1: Yes. This parameter is required when ObClidType is set to 4. Default…"},"IbRecord":{"type":"integer","description":"Specifies whether to record inbound calls. Valid values: 0: Do not record. 1: Record. Default value: 1"},"ObRecord":{"type":"integer","description":"Specifies whether to record outbound calls. Valid values: 0: Do not record. 1: Record. Default value: 1"},"IsAsr":{"type":"integer","description":"Specifies whether to enable automatic speech recognition (ASR) transcription. Valid values: 0: Disabled. 1: Enabled. Default value: 0"},"IsQualityCheck":{"type":"integer","description":"Specifies whether to enable agent quality checks. Valid values: 0: Disabled. 1: Enabled. Default value: 1"},"ObClidProperty":{"type":"string","description":"The caller ID properties. Example value: {\"isMatchCapital\":0,\"areaCodeRule\":1}. When ObClidType is set to 4, isMatchCapital specifies…"},"WebrtcUrlType":{"type":"integer","description":"The URL type for the WebRTC softphone. Valid values: 0: Enterprise default. 1: Public domain name. 2: Leased line domain name. 3: Public…"},"IsObRemember":{"type":"string","description":"Specifies whether to enable the outbound caller ID memory feature. Valid values: 0: Disabled. 1: Enabled. Default value: 1"},"Comment":{"type":"string","description":"The remarks"},"PermitObPreviewTime":{"type":"string","description":"The time period during which outbound calls are allowed. Format: 08:00,20:00"}}}}}},"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-dyvmsapi/cloud-create-agent":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_create_agent","summary":"Creates an agent","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","Cno","Name","AreaCode"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID. Before calling this operation, create a call center instance in the Cloud Call Center console and obtain the instance…"},"Cno":{"type":"string","description":"The agent number. The value must be a positive integer of 3 to 10 digits"},"Name":{"type":"string","description":"The agent name. The value must be URL-encoded in UTF-8 format"},"AreaCode":{"type":"string","description":"The area code of the agent"},"Active":{"type":"integer","description":"Specifies whether to activate the agent. Valid values: 0: not activated. 1: activated. Default value: 1"},"Power":{"type":"integer","description":"The permission level of the agent. Valid values: 0: regular agent. 1: supervisor. Default value: 0"},"CallPower":{"type":"integer","description":"The call permission of the agent. Valid values: 0: no restrictions. 1: domestic long-distance calls. 2: local calls within the city. 3:…"},"Wrapup":{"type":"integer","description":"The wrap-up time, in seconds. Default value: 10"},"IsOb":{"type":"integer","description":"Specifies whether to allow outbound calls. Valid values: 0: not allowed. 1: allowed. Default value: 1"},"ObClidType":{"type":"integer","description":"The caller ID display rule for outbound calls. Valid values: 1: default. 2: random. 3: by area code. 4: dynamic caller ID display. Default…"},"ObClid":{"type":"string","description":"The pass-through number. You can specify an enterprise trunk number or a preconfigured customer-side caller ID number. This parameter is…"},"ObClidProperty":{"type":"string","description":"The caller ID display properties. Example: {\"isMatchCapital\":0,\"areaCodeRule\":1,\"isRandom\":1}. This parameter takes effect when ObClidType…"},"IbRecord":{"type":"integer","description":"Specifies whether to record inbound calls. Valid values: 0: disabled. 1: enabled. Default value: 1"},"ObRecord":{"type":"integer","description":"Specifies whether to record outbound calls. Valid values: 0: disabled. 1: enabled. Default value: 1"},"SkillIds":{"type":"string","description":"The IDs of the skills assigned to the agent. You can specify multiple skill IDs separated by commas, for example, \"1,2,3\". If you specify…"},"SkillLevels":{"type":"string","description":"The levels of the assigned skills. A lower value indicates a higher skill level. Specify multiple levels separated by commas, in the same…"},"IsAsr":{"type":"integer","description":"Specifies whether to enable automatic speech recognition (ASR) transcription. Valid values: 0: disabled. 1: enabled. Default value: 0"},"IsQualityCheck":{"type":"integer","description":"Specifies whether to enable agent quality inspection. Valid values: 0: disabled. 1: enabled. Default value: 1"},"WebrtcUrlType":{"type":"integer","description":"The return address type for the WebRTC softphone. Valid values: 0: enterprise default. 1: public domain name. 2: dedicated line domain…"},"IsObRemember":{"type":"string","description":"Specifies whether to enable outbound caller ID memory. Valid values: 0: disabled. 1: enabled. Default value: 1"},"Comment":{"type":"string","description":"The remarks"},"PermitObPreviewTime":{"type":"string","description":"The permitted time range for outbound calls. Format: 08:00,20:00"}}}}}},"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-dyvmsapi/cloud-create-agent-group":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_create_agent_group","summary":"Creates an outbound call group","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","Gno","GroupName"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID. Before calling this operation, create a call center instance in the Cloud Call Center console and obtain the instance…"},"Gno":{"type":"string","description":"The outbound call group number. The number must be unique within the same enterprise, 2 to 20 characters in length, start with a letter,…"},"GroupName":{"type":"string","description":"The outbound call group name. The name cannot be empty, cannot exceed 50 characters in length, and must be URL-encoded in UTF-8 format"},"Comment":{"type":"string","description":"The description. The description cannot exceed 100 characters in length and must be URL-encoded in UTF-8 format"}}}}}},"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-dyvmsapi/cloud-create-asr":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_create_asr","summary":"Uploads a recording file and creates an ASR transcription task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","CallType","RecordFile","RecordType","RecordSide","UniqueId","MainUniqueId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID"},"CallType":{"type":"integer","description":"The call type. Valid values: 1: inbound call, 2: web call, 4: preview outbound call, 5: predictive outbound call, 6: active outbound call,…"},"RecordFile":{"type":"string","description":"The name of the recording file. Example: 7000002-20170320140327-1581-1500-record-sip-2-148998.366"},"RecordType":{"type":"string","description":"The type of the audio file. Valid values: record: recording, voicemail: voice mail"},"RecordSide":{"type":"integer","description":"The type of the recording channel. Valid values: 0: mixed audio, 1: customer side in split recording, 2: agent side in split recording,…"},"UniqueId":{"type":"string","description":"The unique ID of the secondary channel"},"MainUniqueId":{"type":"string","description":"The unique ID of the primary channel"},"SupportMp3":{"type":"string","description":"Specifies whether to use MP3 for transcription when the WAV file expires. Valid values: 0: not supported (default). 1: supported. If 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-dyvmsapi/cloud-create-enterprise-time":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_create_enterprise_time","summary":"Creates a time condition configuration","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","Name","Priority","Type","TimeType","StartTime","EndTime"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID. Before calling this operation, create a call center instance in the Cloud Contact Center console and obtain the…"},"Name":{"type":"string","description":"The name of the time condition. The name must be unique within the same call center"},"Priority":{"type":"integer","description":"The priority of the time condition. The priority must be unique within the same call center. The value starts from 1. A smaller value…"},"Type":{"type":"integer","description":"The condition type. Valid values: 1: configured by day of the week. 2: configured by fixed date"},"TimeType":{"type":"integer","description":"The time type. Valid values: 1: continuous. 2: interval"},"FromDay":{"type":"string","description":"The start date. This parameter is required when Type is set to 2. Format: yyyy-MM-dd. Set this parameter to an empty string when Type is…"},"ToDay":{"type":"string","description":"The end date. This parameter is required when Type is set to 2. Format: yyyy-MM-dd. Set this parameter to an empty string when Type is set…"},"DayOfWeek":{"type":"string","description":"The days of the week. This parameter is required when Type is set to 1. Monday: 2, Tuesday: 3, Wednesday: 4, Thursday: 5, Friday: 6,…"},"StartTime":{"type":"string","description":"The start time. Format: HH:mm. For example, 06:00. The value of StartTime cannot be later than the value of EndTime"},"EndTime":{"type":"string","description":"The end time. Format: HH:mm. For example, 19:00. The value of StartTime cannot be later than the value of EndTime"}}}}}},"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-dyvmsapi/cloud-create-exten":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_create_exten","summary":"Creates an extension","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","Exten","Password","AreaCode","Type"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID. Before calling this operation, create a call center instance in the Cloud Contact Center console and obtain the…"},"Exten":{"type":"string","description":"The extension number, which contains 3 to 11 digits"},"Password":{"type":"string","description":"The password"},"CallPower":{"type":"string","description":"The call permission. Valid values: 0: No restriction. 1: Domestic long-distance calls. 2: Local calls. 3: Internal calls. Default value: 0"},"IsOb":{"type":"string","description":"Specifies whether outbound calls are allowed. Valid values: 0: Not allowed. 1: Allowed. Default value: 1"},"IsDirect":{"type":"integer","description":"Specifies whether off-hook outbound calls are allowed. Valid values: 0: Not allowed. 1: Allowed. Default value: 1"},"IbRecord":{"type":"integer","description":"Specifies whether inbound calls are recorded. Valid values: 0: Not recorded. 1: Recorded. Default value: 1"},"ObRecord":{"type":"integer","description":"Specifies whether outbound calls are recorded. Valid values: 0: Not recorded. 1: Recorded. Default value: 1"},"AreaCode":{"type":"string","description":"The area code"},"JitterBuffer":{"type":"integer","description":"Specifies whether the jitter buffer is enabled. Valid values: 0: Disabled. 1: Enabled. Default value: 0"},"Type":{"type":"integer","description":"The extension type. Valid values: 1: Registered to an IAD extension. 2: Registered to WebRTC. 3: Registered to a remote phone"},"Allow":{"type":"string","description":"The allowed voice codecs. Supported formats: 1: g729 2: g729,alaw,ulaw 3: alaw,ulaw,g729 4: alaw,ulaw 5: myopus,alaw,ulaw 6:…"},"IadName":{"type":"string","description":"The IAD gateway. This parameter takes effect only when the type is set to registered to an IAD extension"},"Property":{"type":"string","description":"The property"},"Denoise":{"type":"string","description":"Specifies whether noise reduction is enabled. Valid values: 0: Disabled. 1: Enabled. This parameter takes effect only when the type is set…"}}}}}},"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-dyvmsapi/cloud-create-queue":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_create_queue","summary":"Creates a queue","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","Queue","QueueSkills"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID. Before calling this operation, create a call center instance in the Cloud Call Center console and obtain the instance…"},"Queue":{"type":"string","description":"The queue information (JSON-encoded)"},"QueueSkills":{"type":"string","description":"The queue skills (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-dyvmsapi/cloud-create-queue-skill":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_create_queue_skill","summary":"Adds a skill to a queue","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","Qno","SkillId","SkillLevel"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID. Before calling this operation, create a call center instance in the Artificial Intelligence Cloud Call Service console…"},"Qno":{"type":"string","description":"The queue number"},"SkillId":{"type":"integer","description":"The skill ID"},"SkillLevel":{"type":"integer","description":"The skill level"}}}}}},"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-dyvmsapi/cloud-create-skill":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_create_skill","summary":"Creates a skill","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","Name"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID. Before calling this operation, create a call center instance in the Artificial Intelligence Cloud Call Service console…"},"Name":{"type":"string","description":"The skill name"},"Comment":{"type":"string","description":"The description"}}}}}},"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-dyvmsapi/cloud-create-task":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_create_task","summary":"Creates an outbound call task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","Name","Type"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The ID of the call center"},"Name":{"type":"string","description":"The name of the task. The name must be URL-encoded in UTF-8 format and be less than 50 characters in length"},"Description":{"type":"string","description":"The description of the task. The description must be URL-encoded in UTF-8 format and be less than 200 characters in length"},"Type":{"type":"integer","description":"The type of the task. The task type cannot be modified after the task is created. Valid values: 1: predictive dialing task. 2: automatic…"},"TemplateName":{"type":"string","description":"The name of the task template. Task templates allow unified management of task parameters and simplify parameter passing in API…"},"AutoStart":{"type":"integer","description":"Specifies whether to enable scheduled start. Default value: disabled. Valid values: 0: disabled. 1: enabled. This parameter takes effect…"},"AutoStartDay":{"type":"string","description":"The scheduled start date. This parameter takes effect when autoStart is set to 1. If this parameter is not specified, the task is…"},"AutoStartTime":{"type":"string","description":"The scheduled start time. This parameter takes effect when autoStart is set to 1. If this parameter is not specified, the task is…"},"AutoStop":{"type":"integer","description":"Specifies whether to enable scheduled completion. Default value: disabled. Valid values: 0: disabled. 1: enabled. This parameter takes…"},"AutoStopDay":{"type":"string","description":"The scheduled completion date. This parameter takes effect when autoStop is set to 1. If this parameter is not specified, the task is…"},"AutoStopTime":{"type":"string","description":"The scheduled completion time. This parameter takes effect when autoStop is set to 1. If this parameter is not specified, the task is…"},"ForceEndFlag":{"type":"integer","description":"Specifies whether to force end the task upon scheduled completion. This parameter takes effect when autoStop is set to 1. Default value:…"},"AutoTaskType":{"type":"integer","description":"The auto task type. This parameter is used together with the scheduled start (autoStart) and scheduled completion (autoStop) parameters.…"},"AutoTriggerTimeStrategy":{"type":"string","description":"The time period for interval calling. This parameter is required when autoTaskType is set to 1. This parameter configures the time period…"},"AutoComplete":{"type":"integer","description":"Specifies whether to enable auto completion. Default value: enabled. Valid values: 1: enabled. After all phone numbers in the task are…"},"RetryStrategy":{"type":"string","description":"The retry policy. Basic pattern: - Data structure in JSON format:…"},"RetryStrategyTimeType":{"type":"integer","description":"The time type for the retry strategy. This parameter takes effect when a retry strategy is configured. Valid values: 1: based on the first…"},"RetryStrategyOnlyToday":{"type":"integer","description":"Specifies whether the task is valid only on the current day. Valid values: 0: disabled. 1: enabled. Deletes data pending retry and data…"},"CallPriorityStrategy":{"type":"string","description":"The call priority strategy. Data structure in JSON format: ```{\"strategy\":[{\"sort\":1,\"type\":\"retryCall\",…"},"CustomerClidsCategory":{"type":"integer","description":"The type of the caller ID displayed to the customer. Valid values: 1: landline. 2: mobile phone number. 4: caller ID pool. 5: caller ID…"},"CustomerClids":{"type":"string","description":"The list of caller IDs displayed to the customer. This parameter is required when customerClidsCategory is set to 1 or 2. Multiple caller…"},"CustomerClidType":{"type":"integer","description":"The caller ID rule for the customer side. This parameter takes effect when customerClidsCategory is set to 1 or 2. Default value: random.…"},"ClidProperty":{"type":"string","description":"The caller ID rule. This parameter takes effect when customerClidType is set to 2. The value is in JSON format and specifies the caller ID…"},"CustomerClidWeightFlag":{"type":"integer","description":"Specifies whether to enable the caller ID ratio configuration. This parameter takes effect when customerClidsCategory is set to 1. Default…"},"CustomerClidWeight":{"type":"string","description":"The content of the caller ID ratio configuration. This parameter takes effect when customerClidsCategory is set to 1 and…"},"CustomerClidsGroup":{"type":"string","description":"The name of the caller ID pool or the caller ID navigation ID displayed to the customer. This parameter is required when…"},"CustomerTimeout":{"type":"integer","description":"The customer timeout period. Unit: seconds. Default value: 30. Valid values: 5 to 60"},"CallRouteStrategy":{"type":"integer","description":"The call routing strategy. Valid values: 1: direct connection to an agent. In this mode, the call is directly assigned to an agent after…"},"IvrId":{"type":"integer","description":"The ID of the IVR. You must specify either the ivrId or ivrName parameter. If both are specified, ivrId takes effect. When creating an…"},"IvrName":{"type":"string","description":"The name of the IVR. You must specify either ivrId or ivrName. If both are specified, ivrId takes effect. When creating an automatic…"},"Concurrency":{"type":"integer","description":"The maximum concurrency limit at the task level. The actual concurrency does not exceed this limit. When type is set to 1, setting this…"},"UserFields":{"type":"string","description":"The custom fields of the task. The value is in JSON array format. Each element in the array supports only one key-value pair. If multiple…"},"CallVariables":{"type":"string","description":"The agent channel variables. The value is in JSON array format. A maximum of 5 variables are supported. Default value: empty. Example:…"},"TimeStrategy":{"type":"string","description":"The do-not-call time period. Calls are prohibited during the specified time period. Parameter format: time condition ID. Multiple IDs are…"},"AutoDelete":{"type":"integer","description":"Specifies whether to automatically delete the earliest completed task when the number of tasks exceeds the maximum task limit. A value of…"},"CallGroupType":{"type":"integer","description":"The method to assign agents. Valid values: 1: agent ID list. 2: outbound call group. Default value: 1. This parameter cannot be modified…"},"Cnos":{"type":"string","description":"The list of agent IDs. This parameter is required when callGroupType is set to 1. Multiple agent IDs are supported and must be separated…"},"AgentGroup":{"type":"string","description":"The ID of the outbound call group. This parameter is required when callGroupType is set to 2. Note: An outbound call group can be bound to…"},"CallStrategy":{"type":"string","description":"The rule to allocate agents. Default value: 1. Valid values: 1: Random. 2: Sequential. 3: Longest time without an incoming call,…"},"AgentTimeout":{"type":"integer","description":"The agent timeout period in seconds. Default value: 10. Valid values: 5 to 60"},"Wrapup":{"type":"integer","description":"The agent wrap-up time in seconds. Default value: 30. Valid values: 1 to 10800. The wrap-up time affects the number of calls made each…"},"MaxWaitTime":{"type":"integer","description":"The maximum allowed idle time for an agent in seconds. Default value: 40. Valid values: 10 to 600. During task execution, if the average…"},"MinAvailableAgentCount":{"type":"integer","description":"The minimum number of available agents. Default value: 10. Valid values: 1 to 10. If the number of available agents in the task is less…"},"Quotiety":{"type":"number","description":"The harassment rate. Default value: 1. Valid values: greater than 0 and less than or equal to 20. Decimals are supported and accurate to…"},"PredictAdjust":{"type":"integer","description":"The over-dial rate. Default value: 100. Valid values: 50 to 400"},"CallLimitStrategy":{"type":"string","description":"The maximum number of calls an agent can answer per day. For usage instructions, see the following description. Format: JSON array.…"},"CustomerMoh":{"type":"string","description":"The hold music played to the customer after the customer answers the call and while waiting for an agent to answer. Default value: silent…"},"CustomerVoice":{"type":"string","description":"The prompt audio played to the customer after the customer answers the call and before the call is transferred to an agent. The system…"},"AnswerRate":{"type":"integer","description":"The initial expected customer answer rate. Default value: 50. Valid values: 1 to 100. During the warm-up phase, the call frequency is…"},"WarmUpDuration":{"type":"integer","description":"The task warm-up duration in seconds. Default value: 300. Valid values: 60 to 600"},"IsRewarm":{"type":"integer","description":"Specifies whether to re-warm up the task after it is paused. Default value: 1. Valid values: 0: Disabled. 1: Enabled"}}}}}},"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-dyvmsapi/cloud-delete-agent":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_delete_agent","summary":"Deletes an agent by agent ID","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","Cno"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID. Before calling this operation, create a call center instance in the Cloud Call Center console and obtain the instance…"},"Cno":{"type":"string","description":"The agent ID. The value is an integer of 3 to 10 digits"}}}}}},"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-dyvmsapi/cloud-delete-agent-group":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_delete_agent_group","summary":"Deletes an outbound call group","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID. Before calling this operation, create a call center instance in the Cloud Contact Center console and obtain the…"},"Gno":{"type":"string","description":"The outbound call group number. The outbound call group corresponding to this Gno value is 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-dyvmsapi/cloud-delete-agent-tel":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_delete_agent_tel","summary":"Deletes a phone number associated with an agent","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","Cno","Tel"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The ID of the call center"},"Cno":{"type":"string","description":"The ID of the agent. The value must be 3 to 10 digits in length"},"Tel":{"type":"string","description":"The phone number bound to the agent. For landlines, include the area code. For mobile phones, do not add a leading 0. For landlines with…"}}}}}},"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-dyvmsapi/cloud-delete-enterprise-time":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_delete_enterprise_time","summary":"Deletes a time condition setting","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID. Before calling this operation, create a call center instance in the Cloud Call Center console and obtain the instance…"},"Id":{"type":"integer","description":"The time condition ID. You must specify either Id or Name. Both parameters cannot be empty at the same time"},"Name":{"type":"string","description":"The time condition name. You must specify either Id or Name. Both parameters cannot be empty at the same time"}}}}}},"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-dyvmsapi/cloud-delete-exten":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_delete_exten","summary":"Deletes an extension by extension number","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","Exten"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The ID of the call center"},"Exten":{"type":"integer","description":"The extension number, which must be 3 to 11 digits 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-dyvmsapi/cloud-delete-queue":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_delete_queue","summary":"Deletes a queue","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","Qno"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID"},"Qno":{"type":"string","description":"The queue number"}}}}}},"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-dyvmsapi/cloud-delete-queue-skill":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_delete_queue_skill","summary":"Removes a skill from a queue","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","Qno","SkillId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID. Before calling this operation, create a call center instance in the Artificial Intelligence Cloud Call Service console…"},"Qno":{"type":"string","description":"The queue number"},"SkillId":{"type":"integer","description":"The skill 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-dyvmsapi/cloud-delete-skill":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_delete_skill","summary":"Deletes a skill","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID. Before calling this operation, create a call center instance in the Cloud Call Center console and obtain the instance…"},"Id":{"type":"integer","description":"The skill ID. This parameter must be a positive integer. Either Id or Name must be specified, but they cannot both be empty. If both are…"},"Name":{"type":"string","description":"The skill name. Either Id or Name must be specified, but they cannot both be empty. If both are specified, Id takes precedence"}}}}}},"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-dyvmsapi/cloud-delete-task":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_delete_task","summary":"Deletes predictive and automatic outbound call tasks. Only tasks in the initial or completed state can be…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","TaskId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The ID of the call center"},"TaskId":{"type":"integer","description":"The ID of the outbound call 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-dyvmsapi/cloud-delete-task-tel":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_delete_task_tel","summary":"Deletes phone numbers from a call task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","TaskId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID. Before calling this operation, create a call center instance in the Cloud Call Center console and obtain the instance…"},"TaskId":{"type":"integer","description":"The task ID"},"FileId":{"type":"integer","description":"The batch ID"},"FileName":{"type":"string","description":"The batch name. If you delete by name, the most recently added batch is deleted"},"Status":{"type":"integer","description":"The phone number status. Valid values: 0: Not called. 1: Called"},"Tels":{"type":"string","description":"The phone numbers. Separate multiple numbers with commas (,). Numbers can be deleted even while the task is running. A maximum of 100,000…"}}}}}},"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-dyvmsapi/cloud-get-agent":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_get_agent","summary":"Retrieves the details of a specific agent","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","Cno"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID. Before calling this operation, create a call center instance in the Cloud Contact Center console and obtain the…"},"Cno":{"type":"string","description":"The agent work number. Queries the agent information corresponding to the specified work number"}}}}}},"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-dyvmsapi/cloud-get-agent-status":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_get_agent_status","summary":"Retrieves the real-time status information of an agent","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","Cno"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID. Before calling this operation, create a call center instance in the Cloud Call Center console and obtain the instance…"},"Cno":{"type":"string","description":"The agent number"}}}}}},"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-dyvmsapi/cloud-get-area-code":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_get_area_code","summary":"Queries the attribution information of a phone number","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","Tel"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID. Before calling this operation, create a call center instance in the Cloud Contact Center console and obtain the…"},"Tel":{"type":"string","description":"The 11-digit mobile phone number. Only mobile phone numbers can be queried"}}}}}},"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-dyvmsapi/cloud-get-asr":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_get_asr","summary":"Queries the task result of an ASR node and retrieves the data","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","CallType","MainUniqueId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID. Before calling this operation, create a call center instance in the Cloud Contact Center console and obtain the…"},"CallType":{"type":"integer","description":"The call type. Valid values: 1: inbound call 2: web call 4: preview outbound call 5: predictive outbound call 6: caller outbound call 9:…"},"MainUniqueId":{"type":"string","description":"The unique identifier of the main channel"},"All":{"type":"string","description":"Specifies whether to return conversation text from both sides sorted by beginTime. If this parameter is set to true, the conversation text…"}}}}}},"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-dyvmsapi/cloud-get-exten":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_get_exten","summary":"Queries the information about a specified extension","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","Exten"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID. Before calling this operation, create a call center instance in the Cloud Call Center console and obtain the instance…"},"Exten":{"type":"string","description":"The extension number, which contains 3 to 11 digits"}}}}}},"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-dyvmsapi/cloud-get-ob-cdr":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_get_ob_cdr","summary":"Queries the details of a specified agent's outbound call record based on the unique identifier of the call","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","UniqueId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The ID of the call center"},"UniqueId":{"type":"string","description":"The unique identifier of the call, which corresponds to the uniqueId of the agent's outbound call record"}}}}}},"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-dyvmsapi/cloud-get-queue":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_get_queue","summary":"Queries queue information","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","Qno"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID. Before calling this operation, create a call center instance in the Cloud Call Center console and obtain the instance…"},"Qno":{"type":"string","description":"The queue number"}}}}}},"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-dyvmsapi/cloud-get-record-url":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_get_record_url","summary":"Call this operation to obtain a preview or download URL for a recording file based on its name","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","RecordFile"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The ID of the call center"},"RecordType":{"type":"string","description":"The recording type. If you do not specify this parameter, the system automatically determines the type from the `RecordFile` name. Valid…"},"RecordFile":{"type":"string","description":"The recording file name. Example: `7000101-20160815140025-01087120766-01087120766--record-sip-1-1471240825.87`"},"RecordFormat":{"type":"integer","description":"The recording file type. Valid values: `0` for MP3 (default) and `1` for WAV"},"CallType":{"type":"integer","description":"The call type. This parameter is required to retrieve `customer-side` or `agent-side` recordings when `separate-channel recording` is…"},"RecordSide":{"type":"integer","description":"Specifies the recording side for a `separate-channel recording`. This parameter is required to retrieve `customer-side` or `agent-side`…"},"Download":{"type":"integer","description":"Specifies whether to generate a download link. Set this to `1` for a download URL. If you set this to `0` or leave it empty, a preview URL…"}}}}}},"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-dyvmsapi/cloud-get-task":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_get_task","summary":"Retrieves the configuration information of a specific task by task ID","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","TaskId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The ID of the call center"},"TaskId":{"type":"integer","description":"The ID of the outbound call 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-dyvmsapi/cloud-import-task-tel":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_import_task_tel","summary":"Imports phone numbers for an outbound call task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","Name","TaskId","TaskTelList"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID. Before calling this operation, create a call center instance in the Cloud Contact Center console and obtain the…"},"Name":{"type":"string","description":"The batch name"},"TaskId":{"type":"integer","description":"The task ID"},"FileId":{"type":"integer","description":"The batch ID. If this parameter is specified, phone numbers are added to the existing batch"},"Priority":{"type":"integer","description":"The priority. Default value: 0. A larger value indicates a higher priority. Maximum value: 999999"},"IsRepeat":{"type":"integer","description":"Specifies the deduplication mode. Default value: 1. Valid values: 0: no deduplication. 1: task-level deduplication. 2: imported number…"},"BridgeVoicePath":{"type":"string","description":"The voice variable value from the enterprise voice library. This value specifies the opening voice that is automatically played to both…"},"BridgeVoiceType":{"type":"integer","description":"The type of the opening voice that is automatically played to both parties when an agent answers the call. Default value: 3. Valid values:…"},"TaskTelList":{"type":"string","description":"The list of task phone numbers. In CtiLinkTaskTel, only Tel is required. The maximum size is 8 MB. Note: To obtain import failure details,…"},"ImportTelAutoStart":{"type":"integer","description":"Specifies whether to automatically start the task. Default value: 0. Valid values: 0: Do not automatically start. 1: Automatically start"}}}}}},"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-dyvmsapi/cloud-interrupt-ivr":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_interrupt_ivr","summary":"Interrupts the wait state of the current call if it is at a wait node in the interactive voice response…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","UniqueId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The ID of the call center"},"UniqueId":{"type":"string","description":"The unique ID of the call and the channel"},"UserField":{"type":"string","description":"The custom field. The value is a JSON string"},"CheckName":{"type":"string","description":"The name of the variable used to retrieve the corresponding value from the channel variables"},"CheckValue":{"type":"string","description":"The expected value of the variable specified by CheckName. The wait state is interrupted only when the actual variable value matches this…"}}}}}},"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-dyvmsapi/cloud-list-agent-group":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_list_agent_group","summary":"Queries a list of agent groups","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID"},"Start":{"type":"string","description":"The index of the first entry to return. The value must be greater than or equal to `0`. The default value is `0`"},"Limit":{"type":"string","description":"The number of entries to return on each page. Valid values: `1` to `1000`. Default value: `10`"},"GroupName":{"type":"string","description":"The agent group name used to filter the query results"},"Gno":{"type":"string","description":"The agent group ID used to filter the query results"}}}}}},"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-dyvmsapi/cloud-list-agent-tel":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_list_agent_tel","summary":"Retrieves agent phone information by agent work number","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","Cno"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID. Before calling this operation, create a call center instance in the Artificial Intelligence Cloud Call Service console…"},"Cno":{"type":"string","description":"The agent work number. The value must be 3 to 10 digits"},"Tel":{"type":"string","description":"The agent phone number"}}}}}},"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-dyvmsapi/cloud-list-assigned-agent-group":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_list_assigned_agent_group","summary":"Queries the list of agents in a specified outbound call group","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","Gno"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID. Before calling this operation, create a call center instance in the Artificial Intelligence Cloud Call Service console…"},"Gno":{"type":"string","description":"The outbound call group number. The operation returns the list of agents bound to this group"},"Cno":{"type":"string","description":"The agent number used as a filter condition for the conditional query"},"Cname":{"type":"string","description":"The agent name used as a filter condition for the conditional 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-dyvmsapi/cloud-list-curl-log":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_list_curl_log","summary":"Queries push logs of a user","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","StartTime","EndTime"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID. Before calling this operation, create a call center instance in the Cloud Contact Center console and obtain the…"},"Type":{"type":"integer","description":"The push type. Valid values: 1: inbound call push 2: inbound ringing push 3: outbound ringing push 4: webcall-to-agent ringing push 5:…"},"Result":{"type":"integer","description":"The push result. Valid values: 1: Succeeded. 0: Failed"},"Url":{"type":"string","description":"The push URL, which is the destination URL"},"StartTime":{"type":"string","description":"The query start time. Format: \"yyyy-MM-dd HH:mm:ss\", accurate to seconds. StartTime and EndTime cannot span across months. Default value:…"},"EndTime":{"type":"string","description":"The query end time. Format: \"yyyy-MM-dd HH:mm:ss\", accurate to seconds. StartTime and EndTime cannot span across months. Default value:…"},"Retry":{"type":"integer","description":"The number of retries. Default value: -2"},"Start":{"type":"string","description":"The offset from which to start retrieving records. The value must be greater than or equal to 0. Default value: 0"},"Limit":{"type":"string","description":"The number of records to retrieve. The value must be greater than 0 and cannot exceed 500. Default value: 10"}}}}}},"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-dyvmsapi/cloud-list-enterprise-time":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_list_enterprise_time","summary":"Queries the list of time condition settings","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The ID of the call center"},"Name":{"type":"string","description":"The name of the time condition. The name must be unique within the same call center"},"Type":{"type":"integer","description":"The type of the time condition. Valid values: 1: configured by day of the week. 2: configured by fixed time"},"Priority":{"type":"integer","description":"The priority of the time condition. The priority must be unique within the same call center. The value starts from 1. A smaller value…"}}}}}},"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-dyvmsapi/cloud-list-exten":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_list_exten","summary":"Queries the list of extension information","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The ID of the call center"},"Exten":{"type":"string","description":"The extension number"},"CallPower":{"type":"string","description":"The call permission. Valid values: 0: No restriction. 1: Domestic long-distance calls. 2: Local calls. 3: Internal calls. Default value: 0"},"IsOb":{"type":"string","description":"Specifies whether outbound calls are allowed. Valid values: 0: Not allowed. 1: Allowed. Default value: 1"},"IbRecord":{"type":"integer","description":"Specifies whether inbound calls are recorded. Valid values: 0: Not recorded. 1: Recorded. Default value: 1"},"ObRecord":{"type":"integer","description":"Specifies whether outbound calls are recorded. Valid values: 0: Not recorded. 1: Recorded. Default value: 1"},"AreaCode":{"type":"string","description":"The area code"},"JitterBuffer":{"type":"integer","description":"The jitter buffer setting for network anti-jitter"},"Type":{"type":"integer","description":"The type of the extension. Valid values: 1: Registered to an IAD extension. 2: Registered to WebRTC. 3: Registered to a remote phone"},"IsBind":{"type":"integer","description":"Specifies whether the extension is bound to an agent. Valid values: 1: Bound. 0: Not bound"},"Limit":{"type":"integer","description":"The number of entries to return. The value must be a positive integer greater than 0 and less than or equal to 500. Default value: 10"},"Offset":{"type":"integer","description":"The offset from which to start the query. The value must be a non-negative integer. Default value: 0"}}}}}},"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-dyvmsapi/cloud-list-free-agent":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_list_free_agent","summary":"Queries the list of online agents","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID. Before calling this operation, create a call center instance in the Cloud Call Center console and obtain the instance…"}}}}}},"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-dyvmsapi/cloud-list-online-agent":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_list_online_agent","summary":"Queries the list of online agent information","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID. Before calling this operation, create a call center instance in the Cloud Contact Center console and obtain the…"},"Qnos":{"type":"string","description":"The queue numbers. If you specify queue numbers, the monitoring information of the corresponding queues is returned. You can specify…"},"Cnos":{"type":"string","description":"The agent IDs. If you specify agent IDs, the monitoring information of the corresponding agents is returned. You can specify multiple…"},"StateCode":{"type":"string","description":"The agent status codes. You can specify multiple status codes separated by commas (,). Valid values: s1 (idle), s2 (busy), s3 (wrap-up),…"},"PauseType":{"type":"string","description":"The busy types used to filter monitoring data by agent busy type. You can specify multiple busy types separated by commas (,). If you do…"},"PauseDescription":{"type":"string","description":"The busy reasons used to filter monitoring data by agent busy reason. You can specify multiple busy reasons separated by commas (,). If…"}}}}}},"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-dyvmsapi/cloud-list-queue":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_list_queue","summary":"Queries the list of queue information","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID. Before calling this operation, create a call center instance in the Cloud Call Center console and obtain the instance…"},"Limit":{"type":"integer","description":"The number of entries to return. The value must be a positive integer greater than 0 and cannot exceed 500. Default value: 500"},"Offset":{"type":"integer","description":"The start position of the query. The value must be a non-negative integer. Default value: 0"},"Qno":{"type":"string","description":"The queue number"},"Description":{"type":"string","description":"The description"},"Order":{"type":"integer","description":"The sort order by creation time. Valid values: 0: ascending order. 1: descending order"},"StartTime":{"type":"string","description":"The start time of the creation time range. Example: \"2019-10-11 00:00:00\". Format: yyyy-MM-dd HH:mm:ss"},"EndTime":{"type":"string","description":"The end time of the creation time range. Example: \"2019-10-11 23:59:59\". Format: yyyy-MM-dd HH:mm:ss"}}}}}},"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-dyvmsapi/cloud-list-queue-skill":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_list_queue_skill","summary":"Retrieves the skill information of a queue","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","Qno"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID. Before calling this operation, create a call center instance in the Artificial Intelligence Cloud Call Service console…"},"Qno":{"type":"string","description":"The queue number"}}}}}},"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-dyvmsapi/cloud-list-skill":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_list_skill","summary":"Queries the list of skills","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The ID of the call center"},"Name":{"type":"string","description":"The name of the skill"},"Comment":{"type":"string","description":"The description"},"Limit":{"type":"string","description":"The number of entries. Valid values: positive integers. Default value: 10. Maximum value: 500"},"Offset":{"type":"string","description":"The starting entry. Valid values: positive integers. Default value: 0"},"Order":{"type":"integer","description":"The sort order by creation time. Valid values: 0: ascending order. 1: descending order"}}}}}},"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-dyvmsapi/cloud-list-task-file":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_list_task_file","summary":"Retrieves the list of call task batches","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","TaskId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID. Before calling this operation, create a call center instance in the Cloud Contact Center console and obtain the…"},"TaskId":{"type":"integer","description":"The task ID"},"Status":{"type":"integer","description":"The batch status. Valid values: 0: not imported. 1: import completed. 2: loaded to cache. 3: calls completed"},"StartTime":{"type":"string","description":"The start time of the statistical period. Format: yyyy-MM-dd HH:mm:ss"},"EndTime":{"type":"string","description":"The end time of the statistical period. Format: yyyy-MM-dd HH:mm:ss. The maximum query range is one month"},"Start":{"type":"integer","description":"The query start position. The value must be greater than or equal to 0. Default value: 0"},"Limit":{"type":"integer","description":"The number of records to query. Maximum value: 5000. Default value: 10"}}}}}},"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-dyvmsapi/cloud-monitor-task":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_monitor_task","summary":"Monitors a call task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","TaskId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID. Before calling this operation, create a call center instance in the Cloud Call Center console and obtain the instance…"},"TaskId":{"type":"integer","description":"The outbound call 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-dyvmsapi/cloud-outbound-ob-clid-report":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_outbound_ob_clid_report","summary":"Retrieves report data for preview outbound call caller numbers","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","TimeRangeType","StatisticMethod","StartTime","EndTime"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The ID of the call center"},"TimeRangeType":{"type":"integer","description":"The time range type for the statistical report. Valid values: 1: daily report. 2: weekly report. 3: monthly report. 4: custom time range"},"StatisticMethod":{"type":"integer","description":"The statistics method. Valid values: 0: by hour. 1: by day. 2: summary. 11: trunk group summary"},"AreaCodes":{"type":"string","description":"The area codes used to query preview outbound called number statistics for specified regions. Separate multiple area codes with commas…"},"StartTime":{"type":"string","description":"The start time of the statistics date. Format: yyyy-MM-dd"},"EndTime":{"type":"string","description":"The end time of the statistics date. Format: yyyy-MM-dd"},"StartHour":{"type":"integer","description":"The start hour of the statistics period. Valid values: 0 to 23. Default value: 0"},"EndHour":{"type":"integer","description":"The end hour of the statistics period. Valid values: 0 to 23. Default value: 24"},"Start":{"type":"integer","description":"The start position of the query. The value must be greater than or equal to 0. Default value: 0"},"Limit":{"type":"integer","description":"The maximum number of entries to return. Maximum value: 1000. Default value: 10"}}}}}},"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-dyvmsapi/cloud-outbound-preview-ob-report":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_outbound_preview_ob_report","summary":"Retrieves the preview outbound call report","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","TimeRangeType","StatisticMethod","Cnos","StartTime","EndTime"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID. Before calling this operation, create a call center instance in the Cloud Call Center console and obtain the instance…"},"TimeRangeType":{"type":"integer","description":"The statistics type that specifies the time range of the Statistical report. Valid values: 1: daily report. 2: weekly report. 3: monthly…"},"StatisticMethod":{"type":"integer","description":"The statistics method. Valid values: 0: by hour. 1: by day. 2: summary"},"Cnos":{"type":"string","description":"The agent IDs. Queries preview outbound call statistics for specified agents by agent ID. Separate multiple agent IDs with commas (,). By…"},"StartTime":{"type":"string","description":"The start time of the statistics date range. Format: yyyy-MM-dd"},"EndTime":{"type":"string","description":"The end time of the statistics date range. Format: yyyy-MM-dd"},"StartHour":{"type":"integer","description":"The start hour of the statistics period. Valid values: 0 to 23. Default value: 0"},"EndHour":{"type":"integer","description":"The end hour of the statistics period. Valid values: 0 to 23. Default value: 24"},"Start":{"type":"integer","description":"The start position of the query. The value must be greater than or equal to 0. Default value: 0"},"Limit":{"type":"integer","description":"The maximum number of entries to return. Maximum value: 1000. Default value: 10"}}}}}},"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-dyvmsapi/cloud-pause-task":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_pause_task","summary":"Pauses a call task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","TaskId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The ID of the call center"},"TaskId":{"type":"integer","description":"The ID of the outbound call task"},"PauseDuration":{"type":"integer","description":"The pause duration. Default value: 0"}}}}}},"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-dyvmsapi/cloud-previewoutcall":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_previewoutcall","summary":"Initiates an outbound call when the agent is online","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","Cno","Tel"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID. Before calling this operation, create a call center instance in the Cloud Contact Center console and obtain the…"},"Cno":{"type":"string","description":"The agent ID. The value is a 3- to 10-digit number"},"Tel":{"type":"string","description":"The phone number of the customer to call. Include the area code for landline numbers. Do not add 0 before mobile numbers. When number…"},"Timeout":{"type":"integer","description":"The timeout period on the agent side, in seconds. Valid values: 5 to 60. Default value: 30"},"DialTelTimeout":{"type":"integer","description":"The timeout period on the customer side, in seconds. Valid values: 5 to 60. Default value: 45"},"CallVariables":{"type":"string","description":"The channel variables. Channel variables can be used in the following scenarios: 1. Event push: used as push fields. 2. Call records:…"},"RequestUniqueId":{"type":"string","description":"The unique ID of the request. If no value is passed in, the system generates one automatically. If the value is encrypted, URL-encode it…"},"BackupTels":{"type":"string","description":"The backup outbound numbers. When the primary number (Tel) fails to connect, the backup numbers are called. A maximum of five numbers are…"},"IsInvestigation":{"type":"integer","description":"Specifies whether to conduct a satisfaction survey. Valid values: 0: Do not conduct a satisfaction survey. 1: Conduct a satisfaction…"},"CdrIsAsr":{"type":"integer","description":"Specifies whether to perform automatic speech recognition (ASR) transcription on the call recording. Valid values: 0: Do not perform. 1:…"},"CrnId":{"type":"string","description":"The caller ID navigation identifier"},"ObClid":{"type":"string","description":"The enterprise trunk number or the preconfigured caller ID number displayed to the customer"},"ObClidAreaCode":{"type":"string","description":"The specified caller ID area code. Pass in an area code to display a caller ID number under the specified area code. If both ObClid and…"},"ObClidGroup":{"type":"string","description":"The caller ID number group displayed to the customer. To use ClidGroup, the account must support identifier-based routing. When this…"},"ClidList":{"type":"string","description":"The collection of caller ID numbers. Format example:…"}}}}}},"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-dyvmsapi/cloud-query-agent":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_query_agent","summary":"Queries the detailed information list of agents","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The ID of the call center"},"Qno":{"type":"string","description":"The queue number. If this parameter is not empty, all agent records in the specified queue are queried"},"Cnos":{"type":"string","description":"Multiple agent numbers separated by commas. A maximum of 500 agents are supported"},"Start":{"type":"integer","description":"The start offset for the query. A positive integer greater than or equal to 0. Default value: 0"},"Limit":{"type":"integer","description":"The number of records to query. A positive integer greater than 0. The maximum value is 1000. Default value: 10"},"Active":{"type":"integer","description":"Specifies whether the agent is enabled. Valid values: 0: Disabled. 1: Enabled"},"Status":{"type":"integer","description":"Specifies whether the agent is online. Valid values: 0: Offline. 1: Online"},"Order":{"type":"integer","description":"The sort order based on creation time. Valid values: 0: ascending order. 1: descending order"},"WebrtcUrlType":{"type":"integer","description":"The type of the WebRTC softphone return address. Valid values: 0: enterprise default. 1: public domain name. 2: dedicated line domain…"},"StartTime":{"type":"string","description":"The start time of the creation time range. Example: \"2019-10-11 00:00:00\". Format: yyyy-MM-dd HH:mm:ss"},"EndTime":{"type":"string","description":"The end time of the creation time range. Example: \"2019-10-11 23:59:59\". Format: yyyy-MM-dd HH:mm:ss"},"ReturnQueue":{"type":"integer","description":"Specifies whether to return the queue information bound to the agent. Valid values: 0: Do not return. 1: Return. Default value: 1"},"Name":{"type":"string","description":"The agent name used for searching. Fuzzy match is supported with both prefix and suffix"},"Comment":{"type":"string","description":"The agent comment used for searching. Prefix fuzzy match is supported"}}}}}},"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-dyvmsapi/cloud-query-agent-cno-and-name":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_query_agent_cno_and_name","summary":"Retrieves agent IDs and names","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID"},"Cnos":{"type":"string","description":"A comma-separated list of up to 1,000 agent IDs. Example: 2000,20001"}}}}}},"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-dyvmsapi/cloud-query-agent-group":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_query_agent_group","summary":"Queries the information about the outbound call group to which an agent belongs","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","Cno"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID. Before calling this operation, create a call center instance in the Cloud Call Center console and obtain the instance…"},"Cno":{"type":"string","description":"The agent 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-dyvmsapi/cloud-query-agent-skill":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_query_agent_skill","summary":"Queries agent skills by agent work number","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","Cnos"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID. Before calling this operation, create a call center instance in the Artificial Intelligence Cloud Call Service console…"},"Cnos":{"type":"string","description":"The agent work numbers. You can specify multiple work numbers separated by commas (,)"}}}}}},"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-dyvmsapi/cloud-query-ib-cdr":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_query_ib_cdr","summary":"Queries inbound call records based on a conditional query","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The ID of the call center. Before calling this operation, create a call center instance in the Cloud Contact Center console and obtain the…"},"UniqueId":{"type":"string","description":"The unique identifier of a call. If this parameter is not empty, all other parameters are ignored, and only the record matching this…"},"Status":{"type":"integer","description":"The call result. Parameter description: 1: answered by agent. 2: agent was called but did not answer. 3: answered by system. 4: not…"},"Province":{"type":"string","description":"The province to which the customer phone number belongs. Leave this parameter empty to query all provinces. Example: \"Beijing\". This…"},"City":{"type":"string","description":"The city to which the customer phone number belongs. Leave this parameter empty to query all cities. Example: \"Chengdu\". This parameter…"},"TimeRangeType":{"type":"string","description":"The type of time range to apply for the startTime and endTime parameters. This parameter takes effect only when both startTime and endTime…"},"StartTime":{"type":"integer","description":"The start time of the query. The value is a UNIX timestamp accurate to seconds. The startTime and endTime values must be within the same…"},"EndTime":{"type":"integer","description":"The end time of the query. The value is a UNIX timestamp accurate to seconds. The startTime and endTime values must be within the same…"},"Start":{"type":"integer","description":"The offset from which to start retrieving records. The value must be greater than or equal to 0. Default value: 0"},"Limit":{"type":"integer","description":"The number of records to retrieve. The value must be greater than 0 and cannot exceed 1000. Default value: 10"},"UserFieldkey":{"type":"string","description":"The key of a user-defined parameter for field-specific search. When this parameter is specified, userFieldValue must also be specified.…"},"UserFieldValue":{"type":"string","description":"The value of a user-defined parameter for field-specific search. When this parameter is specified, userFieldKey must also be specified.…"},"CustomerNumber":{"type":"string","description":"The phone number of the customer"},"Cno":{"type":"string","description":"The agent ID. You can specify multiple agent IDs separated by commas (,)"},"Qno":{"type":"string","description":"The queue number. Parameter description: -1: did not enter queue"},"LeaveQueueCode":{"type":"integer","description":"The reason for leaving the queue. Parameter description: 2: abandoned in queue. 3: timeout overflow in queue. 4: no agent available,…"},"JoinQueueCode":{"type":"integer","description":"The reason for not entering the queue. Parameter description: 4: no agent available, did not enter queue. 3: queue full, did not enter queue"},"CalleeNumber":{"type":"string","description":"The phone number of the agent"},"Hotline":{"type":"string","description":"The hotline number"}}}}}},"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-dyvmsapi/cloud-query-ob-cdr":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_query_ob_cdr","summary":"Queries outbound call records of agents by using a conditional query","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The ID of the call center. Before you call this operation, create a call center instance in the Cloud Call Center console and obtain the…"},"UniqueId":{"type":"string","description":"The unique ID of the call. If this parameter is not empty, other parameters become invalid, and only the record with the specified unique…"},"RequestUniqueId":{"type":"string","description":"The unique ID of the request. By default, records of the current month are queried. If the request unique ID does not belong to the…"},"CallType":{"type":"integer","description":"The call type. If this parameter is left empty, all call types are queried. Valid values: 4: preview outbound call 6: caller-initiated…"},"Status":{"type":"integer","description":"The call result. Parameter metric description: 30: the agent did not answer 31: the agent answered but did not call the customer 32: the…"},"Province":{"type":"string","description":"The province to which the customer's phone number belongs. If this parameter is left empty, all provinces are queried. Example: Sichuan.…"},"City":{"type":"string","description":"The city to which the customer's phone number belongs. If this parameter is left empty, all cities are queried. Example: Chengdu. This…"},"TimeRangeType":{"type":"string","description":"The time range type for the query. This parameter takes effect when StartTime and EndTime are not empty. Valid values: 1: call start time…"},"StartTime":{"type":"integer","description":"The start time of the query. The value is a UNIX timestamp accurate to seconds. The time range specified by StartTime and EndTime cannot…"},"EndTime":{"type":"integer","description":"The end time of the query. The value is a UNIX timestamp accurate to seconds. The time range specified by StartTime and EndTime cannot…"},"Start":{"type":"integer","description":"The starting index of the query. The value must be greater than or equal to 0. Default value: 0"},"Limit":{"type":"integer","description":"The number of entries to return. The value must be greater than 0 and cannot exceed 1000. Default value: 10"},"UserFieldkey":{"type":"string","description":"The key of the custom user parameter for the query. If you specify this parameter, you must also specify UserFieldValue. Only one field…"},"UserFieldValue":{"type":"string","description":"The value of the custom user parameter for the query. If you specify this parameter, you must also specify UserFieldkey. Only one field…"},"CustomerNumber":{"type":"string","description":"The customer phone number. You can specify one or more customer phone numbers. Separate multiple numbers with commas (,). You can specify…"},"Cno":{"type":"string","description":"The agent ID. An agent ID must be 3 to 10 characters in length. You can specify one or more agent IDs. Separate multiple IDs with commas…"},"Gno":{"type":"string","description":"The ID of the outbound call group to which the agent belongs. A group ID must be 2 to 20 characters in length. You can specify one or more…"},"AgentNumber":{"type":"string","description":"The agent number"},"AgentName":{"type":"string","description":"The name of the agent"},"Clid":{"type":"string","description":"The filter condition for the caller ID displayed to the customer"},"LeftDisplayNumber":{"type":"string","description":"The filter condition for the actual caller ID displayed to the customer. When a service instance is used for AXB outbound calls and the…"},"Order":{"type":"integer","description":"The sort order. Valid values: 0: sort by record creation time in ascending order 1: sort by record creation time in descending order 2:…"},"ReturnCount":{"type":"integer","description":"Specifies whether to return the total number of records. Valid values: 0: do not return the total count 1: return the total count Default…"},"DownGrade":{"type":"integer","description":"Specifies whether the call is downgraded. Valid values: 0: no 1: yes"},"IsRealAnswer":{"type":"integer","description":"Specifies whether the call is answered by a real person. Valid values: 1: yes 0: no"}}}}}},"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-dyvmsapi/cloud-query-predictive-call-cdr":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_query_predictive_call_cdr","summary":"Queries predictive outbound call records","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The ID of the call center"},"TaskId":{"type":"integer","description":"The ID of the outbound call task"},"TaskFileId":{"type":"integer","description":"The ID of the batch"},"UniqueId":{"type":"string","description":"The unique identifier of the phone call. If this parameter is specified, other parameters are ignored and only the record with this unique…"},"RequestUniqueId":{"type":"string","description":"The unique ID of the request. By default, records of the current month are queried. If the request unique ID does not belong to the…"},"CustomerNumber":{"type":"string","description":"The customer phone number. Example: 18012345678"},"Cno":{"type":"string","description":"The agent ID, which must be 3 to 10 digits in length"},"Gno":{"type":"string","description":"The outbound call group to which the agent belongs. A single group ID must be 2 to 20 characters in length. You can specify one or more…"},"Clid":{"type":"string","description":"The displayed caller ID number"},"DisplayNumber":{"type":"string","description":"The actual caller ID number displayed to the customer. When the AXB scenario is used for outbound calls, the actual caller ID number…"},"DownGrade":{"type":"integer","description":"Specifies whether the call is downgraded. Valid values: 0 (no) and 1 (yes)"},"Status":{"type":"integer","description":"The call result parameter. The metric description is as follows: 40 (predictive outbound call, customer did not answer), 41 (predictive…"},"Province":{"type":"string","description":"The province to which the customer phone number belongs. If this parameter is empty, all provinces are queried. Example: Sichuan. This…"},"City":{"type":"string","description":"The city to which the customer phone number belongs. If this parameter is empty, all cities are queried. Example: Chengdu. This parameter…"},"AgentName":{"type":"string","description":"The name of the agent"},"TimeRangeType":{"type":"string","description":"The effective type of the start and end time range for the query. This parameter takes effect when startTime and endTime are specified.…"},"StartTime":{"type":"integer","description":"The start time of the query. The value must be a UNIX timestamp accurate to seconds. The time range specified by startTime and endTime…"},"EndTime":{"type":"integer","description":"The end time of the query. The value must be a UNIX timestamp accurate to seconds. The time range specified by startTime and endTime…"},"Start":{"type":"integer","description":"The starting entry number for the query. The value must be greater than or equal to 0. Default value: 0"},"Limit":{"type":"integer","description":"The number of entries to return. The value must be greater than 0 and cannot exceed 1000. Default value: 10"},"UserFieldkey":{"type":"string","description":"The key of the custom user parameter for the query. If you specify this parameter, you must also specify UserFieldValue. Only one field…"},"UserFieldValue":{"type":"string","description":"The value of the custom user parameter for the query. If you specify this parameter, you must also specify UserFieldkey. Only one field…"},"IsRealAnswer":{"type":"integer","description":"Specifies whether the call is answered by a real person. Valid values: 1 (yes) and 0 (no)"}}}}}},"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-dyvmsapi/cloud-query-rasr-event":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_query_rasr_event","summary":"Retrieves RASR information by uniqueId","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","UniqueId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID. Before calling this operation, create a call center instance in the Artificial Intelligence Cloud Call Service console…"},"UniqueId":{"type":"string","description":"The unique identifier of the call"}}}}}},"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-dyvmsapi/cloud-query-task":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_query_task","summary":"Queries a list of call nodes. Supports conditional query","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","Type"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID. Before calling this operation, create a call center instance in the Cloud Call Center console and obtain the instance…"},"Type":{"type":"integer","description":"The task type. Valid values: 1: predictive outbound call task. 2: automatic outbound call task"},"Name":{"type":"string","description":"The task name. The value must be URL-encoded in UTF-8 format"},"Status":{"type":"integer","description":"The task status. Valid values: 0: initial. 1: running. 2: paused. 3: ended"},"AutoStart":{"type":"integer","description":"Specifies whether scheduled start is enabled. Valid values: 0: disabled. 1: enabled"},"AutoStop":{"type":"integer","description":"Specifies whether scheduled stop is enabled. Valid values: 0: disabled. 1: enabled"},"TimeType":{"type":"integer","description":"The time filter condition. Valid values: 1: task start time. 2: task end time. 3: task creation time"},"StartTime":{"type":"string","description":"The start time of the query. Format: \"2019-10-11 00:00:00\""},"EndTime":{"type":"string","description":"The end time of the query. Format: \"2019-10-11 23:59:59\""},"Start":{"type":"integer","description":"The offset from which to start fetching data. The value must be greater than or equal to 0. Default value: 0"},"Limit":{"type":"integer","description":"The number of records to fetch. The value must be greater than 0 and cannot exceed 100. Default value: 10"}}}}}},"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-dyvmsapi/cloud-query-webcall-cdr":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_query_webcall_cdr","summary":"Queries WebCall call records","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID. Before calling this operation, you must create a call center instance in the Cloud Call Center console and obtain the…"},"UniqueId":{"type":"string","description":"The unique ID of the call. If this parameter is not empty, other parameters are invalid, and only the record with the specified unique ID…"},"RequestUniqueId":{"type":"string","description":"The unique ID of the request. By default, records of the current month are queried. If the request unique ID does not belong to the…"},"Status":{"type":"integer","description":"The call result. Metric description of the parameter. Valid values: 20: WebCall, TTS synthesis failed. 21: WebCall, customer did not…"},"Province":{"type":"string","description":"The province to which the customer's phone number belongs. If this parameter is empty, all provinces are queried. Example: Sichuan. This…"},"City":{"type":"string","description":"The city to which the customer's phone number belongs. If this parameter is empty, all cities are queried. Example: Chengdu. This…"},"TimeRangeType":{"type":"string","description":"The effective type of the start and end time range for the query. This parameter takes effect when StartTime and EndTime are not empty.…"},"StartTime":{"type":"integer","description":"The start time of the query. The value must be a UNIX timestamp accurate to seconds. StartTime and EndTime cannot span across months. The…"},"EndTime":{"type":"integer","description":"The end time of the query. The value must be a UNIX timestamp accurate to seconds. StartTime and EndTime cannot span across months. The…"},"Start":{"type":"integer","description":"The starting index of the records to return. The value must be greater than or equal to 0. Default value: 0"},"Limit":{"type":"integer","description":"The number of records to return. The value must be greater than 0 and cannot exceed 1000. Default value: 10"},"UserFieldkey":{"type":"string","description":"The key of the custom user parameter for the query. If you specify this parameter, you must also specify UserFieldValue. Only one field…"},"UserFieldValue":{"type":"string","description":"The value of the custom user parameter for the query. If you specify this parameter, you must also specify UserFieldkey. Only one field…"},"CustomerNumber":{"type":"string","description":"The phone number of the customer"},"Cno":{"type":"string","description":"The ID of the agent"},"Gno":{"type":"string","description":"The outbound call group to which the agent belongs. A single outbound call group ID must be 2 to 20 characters in length. You can query…"},"CalleeNumber":{"type":"string","description":"The phone number of the agent"},"DisplayNumber":{"type":"string","description":"The actual caller ID number. When the AXB scenario is used for outbound calls, the actual caller ID number is the service instance"},"CalleeDisplayNumber":{"type":"string","description":"The actual display number for the second party"},"Clid":{"type":"string","description":"The caller ID number"},"CalleeClid":{"type":"string","description":"The caller ID number for the second party"},"ReturnCount":{"type":"integer","description":"Specifies whether to return the total number of records. Valid values: 0: Do not return. 1: Return. Default value: 1"},"IsRealAnswer":{"type":"integer","description":"Specifies whether the call was answered by a human. Valid values: 1: Yes. 0: No"}}}}}},"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-dyvmsapi/cloud-start-task":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_start_task","summary":"Manually starts an outbound call task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","TaskId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The ID of the call center instance. Before calling this operation, create a call center instance in the Cloud Contact Center console and…"},"TaskId":{"type":"integer","description":"The ID of the outbound call task. Call CloudCreateTask first to create an outbound call task under the same EnterpriseId, and use 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-dyvmsapi/cloud-unassign-agent-group":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_unassign_agent_group","summary":"Clears the bindng relationship between an outbound call group and an agent","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","Gno","Cno"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The call center ID. Before calling this operation, create a call center instance in the Cloud Call Center console and obtain the instance…"},"Gno":{"type":"string","description":"The outbound call group number. This operation dissociates the outbound call group corresponding to this Gno from the agent corresponding…"},"Cno":{"type":"string","description":"The agent number. This operation dissociates the agent corresponding to this Cno from the outbound call group corresponding to the Gno"}}}}}},"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-dyvmsapi/cloud-update-agent":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_update_agent","summary":"Update the agent's basic information","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","Cno"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The ID of the call center"},"Cno":{"type":"string","description":"The agent ID. The value must be a positive integer with 3 to 10 digits"},"Name":{"type":"string","description":"The agent's name, which must be URL-encoded in UTF-8"},"AreaCode":{"type":"string","description":"The agent's area code"},"Active":{"type":"integer","description":"Specifies whether to activate the agent. Valid values: `0`: Inactive. `1`: Active. The default value is `1`"},"AgentType":{"type":"integer","description":"The agent type. Valid values: `1`: Phone agent. `2`: PC-based agent. The default value is `1`"},"Power":{"type":"integer","description":"The agent's role. Valid values: `1`: Supervisor. `0`: Standard agent. The default value is `0`"},"CallPower":{"type":"integer","description":"The call permissions. Valid values: `0`: Unrestricted. `1`: Domestic long-distance. `2`: Local city. `3`: Internal calls. The default…"},"Wrapup":{"type":"integer","description":"The wrap-up time, in seconds. The default value is 10"},"IsOb":{"type":"integer","description":"Specifies whether outbound calls are allowed. Valid values: `0`: Not allowed. `1`: Allowed. The default value is `1`"},"ObClidType":{"type":"integer","description":"The outbound caller ID rule. Valid values: `1`: Default. `2`: Random. `3`: By area code. `4`: Dynamic. The default value is `1`"},"ObClid":{"type":"string","description":"The pass-through number. This can be a corporate trunk number or a pre-configured outbound caller ID. This parameter is required when…"},"IsRandom":{"type":"string","description":"Specifies whether to use a random outbound caller ID. Valid values: `0`: No. `1`: Yes. This parameter is required when `ObClidType` is set…"},"ObClidProperty":{"type":"string","description":"The properties of the outbound caller ID. Example: {\"isMatchCapital\":0,\"areaCodeRule\":1}. When ObClidType is `4`, isMatchCapital specifies…"},"IbRecord":{"type":"integer","description":"Specifies whether to record inbound calls. Valid values: `0`: Do not record. `1`: Record. The default value is `1`"},"ObRecord":{"type":"integer","description":"Specifies whether to record outbound calls. Valid values: `0`: Do not record. `1`: Record. The default value is `1`"},"SkillIds":{"type":"string","description":"A comma-separated list of skill IDs to assign to the agent. Example: \"1,2,3\". To remove all skills from the agent, set this value to \"0\".…"},"SkillLevels":{"type":"string","description":"A comma-separated list of levels for the skills specified in `SkillIds`. The order of levels must match the order of IDs. A smaller value…"},"IsAsr":{"type":"integer","description":"Specifies whether to enable ASR transcription. Valid values: `0`: Disable. `1`: Enable. The default value is `0`"},"IsQualityCheck":{"type":"integer","description":"Specifies whether to enable agent quality check. Valid values: `0`: Disable. `1`: Enable. The default value is `1`"},"WebrtcUrlType":{"type":"integer","description":"The URL type returned for the WebRTC softphone. Valid values: `0`: Corporate default. `1`: Public domain name. `2`: Leased line domain…"},"IsObRemember":{"type":"string","description":"Specifies whether to enable outbound caller ID memory. Valid values: `0`: Disable. `1`: Enable. The default value is `1`"},"Comment":{"type":"string","description":"A comment or description for the agent"},"PermitObPreviewTime":{"type":"string","description":"The time range during which outbound calls are permitted. Format: `HH:mm,HH:mm`"}}}}}},"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-dyvmsapi/cloud-update-task":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_update_task","summary":"Modifies the basic information of an outbound call task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","TaskId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The ID of the call center"},"TaskId":{"type":"string","description":"The ID of the outbound call task"},"Name":{"type":"string","description":"The task name. The value must be URL-encoded in UTF-8 format and cannot exceed 50 characters in length"},"Description":{"type":"string","description":"The task description. The value must be URL-encoded in UTF-8 format and cannot exceed 200 characters in length"},"AutoStart":{"type":"integer","description":"Specifies whether to enable scheduled start. Valid values: 0: Disabled. 1: Enabled. Default value: 0. When the value is 1, the…"},"AutoStartDay":{"type":"string","description":"The scheduled start date. This parameter takes effect only when autoStart is set to 1. If this parameter is not specified, the task starts…"},"AutoStartTime":{"type":"string","description":"The scheduled start time. This parameter takes effect only when autoStart is set to 1. If this parameter is not specified, the task starts…"},"AutoStop":{"type":"integer","description":"Specifies whether to enable scheduled stop. Valid values: 0: Disabled. 1: Enabled. Default value: 0. When the value is 1, the autoStopDay…"},"AutoStopDay":{"type":"string","description":"The scheduled stop date. This parameter takes effect only when autoStop is set to 1. If this parameter is not specified, the task stops at…"},"AutoStopTime":{"type":"string","description":"The scheduled stop time. This parameter takes effect only when autoStop is set to 1. If this parameter is not specified, the task stops at…"},"ForceEndFlag":{"type":"integer","description":"Specifies whether to forcibly end the task at the scheduled stop time. This parameter takes effect only when autoStop is set to 1. Valid…"},"AutoTaskType":{"type":"integer","description":"The auto task type. Valid values: 0: Continuous calling. 1: Interval calling. Default value: 0. Use this parameter together with the…"},"AutoTriggerTimeStrategy":{"type":"string","description":"The interval calling time periods. This parameter is required when autoTaskType is set to 1. Specifies the time period configuration for…"},"AutoComplete":{"type":"integer","description":"Specifies whether to enable auto complete. Valid values: 0: Disabled. After all numbers in the task are called, the task is automatically…"},"RetryStrategy":{"type":"string","description":"The retry policy. Basic pattern: The data structure is in JSON format.…"},"RetryStrategyTimeType":{"type":"integer","description":"The time type for the retry strategy. This parameter takes effect when a retry strategy is configured. Valid values: 1: Based on the first…"},"RetryStrategyOnlyToday":{"type":"integer","description":"Specifies whether the task is effective only on the current day. Valid values: 0: Disabled. 1: Enabled. Deletes both pending retry data…"},"CallPriorityStrategy":{"type":"string","description":"The call priority strategy. The data structure is in JSON format. ```{\"strategy\":[{\"sort\":1,\"type\":\"retryCall\",…"},"CustomerClidsCategory":{"type":"integer","description":"The type of the caller ID displayed to the customer. Valid values: 1: landline number. 2: mobile number. 4: number pool. 5: caller ID…"},"CustomerClids":{"type":"string","description":"The list of caller IDs displayed to the customer. This parameter is required when customerClidsCategory is set to 1 or 2. Multiple values…"},"CustomerClidType":{"type":"integer","description":"The caller ID selection rule for the customer side. This parameter takes effect when customerClidsCategory is set to 1 or 2. Valid values:…"},"ClidProperty":{"type":"string","description":"The caller ID selection rule. This parameter takes effect when customerClidType is set to 2. The value is in JSON format and specifies the…"},"CustomerClidWeightFlag":{"type":"integer","description":"Specifies whether to enable the caller ID weight configuration. This parameter takes effect when customerClidsCategory is set to 1. Valid…"},"CustomerClidWeight":{"type":"string","description":"The caller ID weight configuration. This parameter takes effect when customerClidsCategory is set to 1 and customerClidWeightFlag is set…"},"CustomerClidsGroup":{"type":"string","description":"The name of the customer-side number pool or the caller ID routing identifier. This parameter is required when customerClidsCategory is…"},"CustomerTimeout":{"type":"integer","description":"The customer timeout period, in seconds. Default value: 30. Valid values: 5 to 60"},"CallRouteStrategy":{"type":"integer","description":"The call routing strategy. Valid values: 1: Direct agent connection. After the customer answers, an agent is directly assigned. If no idle…"},"IvrId":{"type":"integer","description":"The ID of the IVR. Specify either the ivrId or ivrName parameter. If both are specified, ivrId takes precedence. When creating an…"},"IvrName":{"type":"string","description":"The name of the IVR. Specify either ivrId or ivrName. If both are specified, ivrId takes precedence. When creating an automatic outbound…"},"Concurrency":{"type":"integer","description":"The maximum number of concurrent calls at the task level. The actual concurrency does not exceed this limit. When type is set to 1, a…"},"UserFields":{"type":"string","description":"The task custom fields. The value is in JSON array format. Each element in the array supports only one key-value pair. If multiple pairs…"},"CallVariables":{"type":"string","description":"The agent channel variables. The value is in JSON array format. A maximum of 5 variables are supported. Default value: empty. Example:…"},"TimeStrategy":{"type":"string","description":"The call prohibition time periods during which calls are not allowed. Format: time condition IDs. Multiple IDs are supported and separated…"},"Cnos":{"type":"string","description":"The list of agent IDs. This parameter is required when callGroupType is set to 1. Multiple agent IDs are supported and separated by commas…"},"AgentGroup":{"type":"string","description":"The ID of the outbound call group. This parameter is required when callGroupType is set to 2. Note: An outbound call group can be bound to…"},"CallStrategy":{"type":"string","description":"The agent allocation rule. Valid values: 1: Random. 2: Sequential. 3: Longest idle since last call (the total duration from the end of the…"},"AgentTimeout":{"type":"integer","description":"The agent timeout period, in seconds. Default value: 10. Valid values: 5 to 60"},"Wrapup":{"type":"integer","description":"The agent wrap-up time. Default value: 30 seconds. Valid values: 1 to 10800. The wrap-up time affects the number of calls per round. A…"},"MaxWaitTime":{"type":"integer","description":"The maximum agent wait time. Default value: 40 seconds. Minimum value: 10. Maximum value: 600. The maximum idle time allowed for agents.…"},"MinAvailableAgentCount":{"type":"integer","description":"The minimum number of available agents. Default value: 10. Valid values: 1 to 10. If the number of available agents in the task is less…"},"Quotiety":{"type":"number","description":"The harassment rate. Default value: 1. Valid values: greater than 0 and less than or equal to 20. Decimal values are supported with up to…"},"PredictAdjust":{"type":"integer","description":"The over-dial rate. Default value: 100. Valid values: 50 to 400"},"CallLimitStrategy":{"type":"string","description":"The maximum number of calls an agent can answer per day. For more information, see the description below. JsonArray format:…"},"CustomerMoh":{"type":"string","description":"The customer-side hold music. The audio played to the customer while waiting for an agent to answer after the customer picks up. Default…"},"CustomerVoice":{"type":"string","description":"The customer-side prompt tone. The audio played to the customer after the customer picks up and before the call is transferred to an…"},"AnswerRate":{"type":"integer","description":"The initial estimated customer answer rate. Default value: 50. Valid values: 1 to 100. During the warm-up phase, the call frequency is…"},"WarmUpDuration":{"type":"integer","description":"The task warm-up duration. Default value: 300 seconds. Valid values: 60 to 600"},"IsRewarm":{"type":"integer","description":"Specifies whether to re-warm-up after the task is paused. Valid values: 0 (disabled) and 1 (enabled). Default value: 1 (enabled)"}}}}}},"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-dyvmsapi/cloud-webcall":{"post":{"operationId":"cloud_aliyun_dyvmsapi_cloud_webcall","summary":"This API operation lets a third-party platform send a call request to a hosted call center. The system calls…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EnterpriseId","Tel"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"EnterpriseId":{"type":"integer","description":"The ID of the call center"},"Tel":{"type":"string","description":"The phone number. For landlines, include the area code. For mobile numbers, do not add the `0` prefix. For landlines with an extension,…"},"RequestUniqueId":{"type":"string","description":"A unique request ID, up to 300 bytes long. The system saves this ID to the `requestUniqueId` field in the call record, which you can use…"},"UserField":{"type":"string","description":"A user-defined field, up to 250 bytes long. This value is saved to the `userField` in the call record for later queries. This parameter…"},"Timeout":{"type":"integer","description":"The timeout for the customer call, in seconds. The value must be between 0 and 60, inclusive. The default is 30"},"Amd":{"type":"integer","description":"Specifies whether to enable answering machine detection (AMD). Valid values: `1` (enable) and `0` (disable). The default is `0`"},"Delay":{"type":"integer","description":"The call initiation delay, in seconds. The value must be between 0 and 60, inclusive. The default is 0"},"MultiTelDelay":{"type":"integer","description":"The delay, in seconds, between call attempts when `Tel` contains multiple numbers. The maximum value is 120. The default is 0"},"MultiTelPush":{"type":"integer","description":"When calling multiple numbers, this parameter specifies whether to send a hang-up notification for each call attempt. Valid values: `0`…"},"Clid":{"type":"string","description":"The caller ID to display to the recipient. You can use an enterprise trunk number or a pre-configured caller ID"},"ClidGroup":{"type":"string","description":"To use this parameter, your account must support identifier-based routing. This parameter has a lower priority than `Clid`"},"ClidList":{"type":"string","description":"Specifies a set of caller IDs for the outbound call. The system selects an available number from this set based on the number scheduling…"},"ClidAreaCode":{"type":"string","description":"A caller ID from a specific region. This parameter has a lower priority than `Clid`"},"IvrId":{"type":"integer","description":"The ID of the IVR flow to enter after the call connects. If you do not specify this parameter, the system uses the IVR flow configured in…"},"CrnId":{"type":"string","description":"The caller ID navigation identifier"},"Vid":{"type":"string","description":"The language of the IVR prompt. Valid values: `1` (Mandarin), `2` (Cantonese), `4` (Biaobei TTS), and `5` (Mandarin - sweet female voice).…"},"Retry":{"type":"integer","description":"The number of retries. The maximum value is 5. To use this parameter, you must enable the webcall auto-retry feature for your enterprise…"},"RetryInterval":{"type":"integer","description":"The retry interval, in minutes. The value must be between 0 and 59, inclusive"},"ExpirTime":{"type":"string","description":"The request's expiration time, accurate to the second. Format: `YYYY-MM-DD HH:mm:ss`"}}}}}},"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-dyvmsapi/create-call-task":{"post":{"operationId":"cloud_aliyun_dyvmsapi_create_call_task","summary":"Creates text-to-speech tasks, voice notification tasks, and voice verification code tasks for multiple…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"TaskName":{"type":"string","description":"The name of the call task"},"BizType":{"type":"string","description":"The templatetype of the voice template. Valid values: VMS_VOICE_TTS: text-to-speech template for voice notifications. VMS_VOICE_CODE:…"},"TemplateCode":{"type":"string","description":"The template code. Valid values: For a text-to-speech template for voice notifications, obtain the Template ID on the Text-to-Speech…"},"TemplateName":{"type":"string","description":"The template name. Valid values: For a text-to-speech template for voice notifications, obtain the Template Name on the Text-to-Speech…"},"ResourceType":{"type":"string","description":"The type of the calling number. Fixed value: LIST"},"Resource":{"type":"string","description":"The calling number. Specify the service instance ID. Only service instances with bound real numbers are supported. Call tasks cannot be…"},"DataType":{"type":"string","description":"The type of the called number. Valid values: LIST: the LIST format, which is used for text-to-speech templates or voice files without…"},"Data":{"type":"string","description":"The called numbers or called data that contains variable parameter values. If DataType is set to LIST, specify called numbers separated by…"},"FireTime":{"type":"string","description":"This parameter is not available"},"StopTime":{"type":"string","description":"This parameter is not available"},"ScheduleType":{"type":"string","description":"This parameter is not available"}}}}}},"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-dyvmsapi/create-robot-task":{"post":{"operationId":"cloud_aliyun_dyvmsapi_create_robot_task","summary":"Initiates an outbound call task for an intelligent voice robot","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TaskName","DialogId","Caller","NumberStatusIdent","RetryType"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"TaskName":{"type":"string","description":"The task name. Chinese and English characters are supported. The name cannot exceed 30 characters in length"},"DialogId":{"type":"integer","description":"The robot ID, which is the script ID. This parameter specifies which robot script to use for initiating the call. You can log on to the…"},"CorpName":{"type":"string","description":"The company name. The name must be exactly the same as the Enterprise Name on the qualification management page"},"Caller":{"type":"string","description":"The calling number for outbound calls. The number must be a purchased number. Separate multiple numbers with commas (,). You can log on to…"},"NumberStatusIdent":{"type":"string","description":"Specifies whether to enable number status (early media) identification. Valid values: false (default): Disabled. true: Enabled. If this…"},"RetryType":{"type":"integer","description":"Specifies whether to enable automatic redial. Valid values: 1: Enable redial. 0: Disable redial"},"RecallStateCodes":{"type":"string","description":"The call states that require a redial. Separate multiple states with commas (,). Valid values: 200010: powered off. 200011: out of…"},"RecallTimes":{"type":"integer","description":"The number of redial attempts"},"RecallInterval":{"type":"integer","description":"The redial interval. Unit: minutes. The value must be greater than 1. The maximum interval is 30 minutes"},"IsSelfLine":{"type":"string","description":"Specifies whether to use your own line. Valid values: false (default): Do not use your own line. true: Use your own line. If this…"}}}}}},"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-dyvmsapi/degrade-video-file":{"post":{"operationId":"cloud_aliyun_dyvmsapi_degrade_video_file","summary":"Downgrades a video call to a voice call","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["CalledNumber"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"CallId":{"type":"string","description":"The call ID. You can obtain the CallId from the response parameters of the SingleCallByVideo…"},"MediaType":{"type":"string","description":"The media type. Set the value to video"},"OutId":{"type":"string","description":"The ID reserved for the caller. This ID is returned to the caller in the receipt message. The value is a string that is 1 to 15 bytes in…"},"CalledNumber":{"type":"string","description":"The phone number that receives the voice notification"}}}}}},"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-dyvmsapi/delete-robot-task":{"post":{"operationId":"cloud_aliyun_dyvmsapi_delete_robot_task","summary":"Deletes a robocall task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TaskId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"TaskId":{"type":"integer","description":"The unique ID of the robocall task. You can call the [CreateRobotTask](~~CreateRobotTask~~) operation to obtain 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-dyvmsapi/execute-call-task":{"post":{"operationId":"cloud_aliyun_dyvmsapi_execute_call_task","summary":"Executes a call task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TaskId","Status"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"TaskId":{"type":"integer","description":"The task ID. You can call the [CreateCallTask](~~CreateCallTask~~) operation to obtain the task ID"},"Status":{"type":"string","description":"The task state. Valid values: RUNNING STOP CANCEL"},"FireTime":{"type":"string","description":"The time when the call task is executed, in the yyyy-MM-dd HH:mm:ss format. You can leave this parameter empty"}}}}}},"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-dyvmsapi/get-call-media-type":{"post":{"operationId":"cloud_aliyun_dyvmsapi_get_call_media_type","summary":"You can obtain the call type during a call","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["CalledNumber"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"CallId":{"type":"string","description":"Call ID. You can get this value from the response of the SingleCallByVideo…"},"CalledNumber":{"type":"string","description":"Mobile phone number used in the call"}}}}}},"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-dyvmsapi/get-hotline-qualification-by-order":{"post":{"operationId":"cloud_aliyun_dyvmsapi_get_hotline_qualification_by_order","summary":"Retrieves the qualification ID of a 400 number by the qualification application ticket number","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["OrderId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"OrderId":{"type":"string","description":"The ticket number. You can view the ticket number on the 400 Qualification page in the Voice Messaging console…"}}}}}},"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-dyvmsapi/get-temporary-file-url":{"post":{"operationId":"cloud_aliyun_dyvmsapi_get_temporary_file_url","summary":"Obtains a temporary URL for a video or audio file to allow immediate viewing","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["VideoId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"VideoId":{"type":"string","description":"The ID of the audio or video file. You can find this ID on the Voice Files (https://dyvms.console.aliyun.com/files/list/voiceFiles) or…"}}}}}},"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-dyvmsapi/get-token":{"post":{"operationId":"cloud_aliyun_dyvmsapi_get_token","summary":"Obtains the token for authentication","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"TokenType":{"type":"string","description":"The token type"}}}}}},"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-dyvmsapi/ivr-call":{"post":{"operationId":"cloud_aliyun_dyvmsapi_ivr_call","summary":"Initiates an interactive voice response (IVR) call to a specified number","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["CalledShowNumber","CalledNumber","StartCode"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"CalledShowNumber":{"type":"string","description":"The calling number. The value must be a number you purchased. Each request supports only one calling number. In most cases, a calling…"},"CalledNumber":{"type":"string","description":"The called number. Only phone numbers in the Chinese mainland are supported. Each request supports only one called number"},"StartCode":{"type":"string","description":"The voice that is played when the call begins. If you use a voice notification file, this parameter specifies the voice ID. You can log on…"},"StartTtsParams":{"type":"string","description":"The variables in the TTS template, in the JSON format. This parameter is required when the StartCode parameter is set to the ID of a TTS…"},"PlayTimes":{"type":"integer","description":"The number of replay times. Valid values: 1 to 3"},"ByeCode":{"type":"string","description":"The end voice. If you use a voice notification file, this parameter specifies the voice ID. You can log on to the Voice Messaging Service…"},"ByeTtsParams":{"type":"string","description":"The variables in the TTS template, in the JSON format. This parameter is required when the ByeCode parameter is set to the ID of a TTS…"},"Timeout":{"type":"integer","description":"The timeout period for the subscriber to press a key. Unit: milliseconds"},"OutId":{"type":"string","description":"The ID that is reserved for the caller of the operation. This ID is returned to the caller in a receipt message. The value is of the…"},"MenuKeyMap":{"type":"string","description":"The information about the key pressed by the subscriber (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-dyvmsapi/list-call-task":{"post":{"operationId":"cloud_aliyun_dyvmsapi_list_call_task","summary":"Queries the status of voice call tasks, including the task ID, current task status, and template information…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"PageNumber":{"type":"integer","description":"The current page number. Default value: 1"},"PageSize":{"type":"integer","description":"The number of tasks to display per page. Default value: 10"},"TemplateName":{"type":"string","description":"The template name. If the template is a text-to-speech template for voice notifications, you can obtain the Template Name on the…"},"Status":{"type":"string","description":"Create task status. Valid values: INIT: Create task is created but not started. RELEASE: Create task is being parsed. RUNNING: Create task…"},"TaskName":{"type":"string","description":"The task name. You can view the task name on the Task Center page in the Voice Messaging Service console…"},"TaskId":{"type":"string","description":"The task ID. You can obtain the task ID by calling the CreateCallTask…"},"BizType":{"type":"string","description":"The node templatetype. Valid values: VMS_VOICE_TTS: text-to-speech template for voice notifications. VMS_VOICE_CODE: voice file template…"}}}}}},"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-dyvmsapi/list-call-task-detail":{"post":{"operationId":"cloud_aliyun_dyvmsapi_list_call_task_detail","summary":"Queries the details of a specified call task by task ID after the call task is complete","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TaskId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"TaskId":{"type":"integer","description":"The task ID. Obtain the task ID by calling the CreateCallTask…"},"CalledNum":{"type":"string","description":"The called number"},"Status":{"type":"string","description":"The task status. Valid values: SUCCESS: The outbound call succeeded. FAIL: The outbound call failed. INIT: The outbound call has not started"},"PageNumber":{"type":"integer","description":"The current page number. Default value: 1"},"PageSize":{"type":"integer","description":"The number of tasks to display on each page. Default value: 10"}}}}}},"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-dyvmsapi/list-hotline-transfer-register-file":{"post":{"operationId":"cloud_aliyun_dyvmsapi_list_hotline_transfer_register_file","summary":"Retrieves the registration information of a phone number after you submit the registration information by…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["QualificationId","HotlineNumber"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"QualificationId":{"type":"string","description":"The qualification ID. You can obtain this ID by calling the https://help.aliyun.com/document_detail/393548.html operation"},"PageNo":{"type":"integer","description":"The page number. Default value: 1"},"PageSize":{"type":"integer","description":"The number of entries per page. Valid values: 1 to 10"},"HotlineNumber":{"type":"string","description":"The 400 phone number"}}}}}},"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-dyvmsapi/list-service-instance-for-page":{"post":{"operationId":"cloud_aliyun_dyvmsapi_list_service_instance_for_page","summary":"Retrieves a paginated list of service instances","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"Code":{"type":"string","description":"The service instance number"},"SceneId":{"type":"integer","description":"The scenario ID"},"UsageId":{"type":"integer","description":"The usage ID"},"RelationNumber":{"type":"string","description":"The number of the associated entity"},"Pager":{"type":"string","description":"The paging information (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-dyvmsapi/pause-video-file":{"post":{"operationId":"cloud_aliyun_dyvmsapi_pause_video_file","summary":"Pauses video playback during a voice call when a video file is being played","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["CalledNumber"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"CallId":{"type":"string","description":"The call ID. You can obtain the CallId from the response parameters of the SingleCallByVideo…"},"CalledNumber":{"type":"string","description":"The phone number for which video playback is paused"}}}}}},"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-dyvmsapi/play-video-file":{"post":{"operationId":"cloud_aliyun_dyvmsapi_play_video_file","summary":"Inserts a video file during a voice call","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["VideoId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"VideoId":{"type":"string","description":"The ID of the video file to insert. You can view the IDs of approved videos on the Video Insert Files…"},"CalledNumber":{"type":"string","description":"The phone number that receives the video playback"},"CallId":{"type":"string","description":"The call ID. You can obtain the CallId from the response parameters of the SingleCallByVideo…"},"OutId":{"type":"string","description":"The ID reserved for the caller. This ID is returned to the caller in the receipt message. The value is a string with a length of 1 to 15…"},"OnlyPhone":{"type":"string","description":"Specifies whether to play the video only on the mobile phone. Valid values: true false (default)"}}}}}},"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-dyvmsapi/query-call-detail-by-call-id":{"post":{"operationId":"cloud_aliyun_dyvmsapi_query_call_detail_by_call_id","summary":"Queries the call details based on a call ID, including the call start time, call duration, call status, call…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["CallId","ProdId","QueryDate"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"CallId":{"type":"string","description":"The unique ID of the call. The CallId parameter is included in the response parameters of the outbound call operation that you call to…"},"ProdId":{"type":"integer","description":"The service ID. Valid values: 11000000300006: voice notification. You can call the SingleCallByVoice…"},"QueryDate":{"type":"integer","description":"The time at which call details are queried. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since…"}}}}}},"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-dyvmsapi/query-call-detail-by-task-id":{"post":{"operationId":"cloud_aliyun_dyvmsapi_query_call_detail_by_task_id","summary":"Queries the call details of an outbound robocall task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TaskId","QueryDate","Callee"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"TaskId":{"type":"string","description":"The unique ID of the outbound robocall task. The task ID is returned after the outbound robocall task is successfully delivered. You can…"},"QueryDate":{"type":"integer","description":"The start time of the outbound robocall task. This value is a UNIX timestamp representing the number of milliseconds that have elapsed…"},"Callee":{"type":"string","description":"The called number. You can view the outbound call records of only one called number"}}}}}},"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-dyvmsapi/query-call-in-pool-transfer-config":{"post":{"operationId":"cloud_aliyun_dyvmsapi_query_call_in_pool_transfer_config","summary":"Queries the configuration of the phone number used to transfer a call","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PhoneNumber"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"PhoneNumber":{"type":"string","description":"The China 400 number used to transfer the call"}}}}}},"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-dyvmsapi/query-call-in-transfer-record":{"post":{"operationId":"cloud_aliyun_dyvmsapi_query_call_in_transfer_record","summary":"Queries call transfer records","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PhoneNumber","QueryDate","PageNo","PageSize"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"PhoneNumber":{"type":"string","description":"The phone number to which a call is transferred"},"CallInCaller":{"type":"string","description":"The calling number of the inbound call"},"QueryDate":{"type":"string","description":"The time at which call transfer records are queried, in the YYYY-MM-DD hh:mm:ss format. The query result is all the call transfer records…"},"PageNo":{"type":"integer","description":"The page number. Default value: 1"},"PageSize":{"type":"integer","description":"The number of entries per page. Valid values: 1 to 10"}}}}}},"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-dyvmsapi/query-robot-info-list":{"post":{"operationId":"cloud_aliyun_dyvmsapi_query_robot_info_list","summary":"Queries a list of robots to obtain their details","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"AuditStatus":{"type":"string","description":"The review state. Valid values: CONFIGURABLE AUDITING AUDITPASS AUDITFAIL"}}}}}},"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-dyvmsapi/query-robot-task-call-detail":{"post":{"operationId":"cloud_aliyun_dyvmsapi_query_robot_task_call_detail","summary":"Queries the call details of a called number","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TaskId","Callee","QueryDate"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"TaskId":{"type":"integer","description":"The unique ID of the robocall task. You can call the https://help.aliyun.com/document_detail/393531.html operation to obtain the task ID"},"Callee":{"type":"string","description":"The called number"},"QueryDate":{"type":"integer","description":"The timestamp of the time at which the call details you want 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-dyvmsapi/query-robot-task-call-list":{"post":{"operationId":"cloud_aliyun_dyvmsapi_query_robot_task_call_list","summary":"Queries the information about a robocall task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TaskId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"PageNo":{"type":"integer","description":"The page number"},"PageSize":{"type":"integer","description":"The number of entries per page"},"TaskId":{"type":"string","description":"The unique ID of the robocall task. You can call the https://help.aliyun.com/document_detail/393531.html operation to obtain the task ID"},"DurationFrom":{"type":"string","description":"The minimum call duration"},"DurationTo":{"type":"string","description":"The maximum call duration"},"DialogCountFrom":{"type":"string","description":"The minimum number of conversation rounds in the call"},"DialogCountTo":{"type":"string","description":"The maximum number of conversation rounds in the call"},"HangupDirection":{"type":"string","description":"The party who hangs up. Valid values: 0: the called party. 1: the robot"},"CallResult":{"type":"string","description":"The call result. Valid values: 200002: The line is busy. 200005: The called party cannot be connected. 200010: The phone of the called…"},"Called":{"type":"string","description":"The called number"}}}}}},"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-dyvmsapi/query-robot-task-detail":{"post":{"operationId":"cloud_aliyun_dyvmsapi_query_robot_task_detail","summary":"Retrieves the details of a specified intelligent voice task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"Id":{"type":"integer","description":"The unique task ID of the robot call task. You can obtain this ID by calling the [CreateRobotTask](~~CreateRobotTask~~) operation"}}}}}},"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-dyvmsapi/query-robot-task-list":{"post":{"operationId":"cloud_aliyun_dyvmsapi_query_robot_task_list","summary":"Queries the information about all robocall tasks","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"TaskName":{"type":"string","description":"The task name"},"Status":{"type":"string","description":"The task state. Valid values: INIT: The task is not started. READY: The task is ready to start. DISPATCH: The task is being parsed.…"},"Time":{"type":"string","description":"The date when the task is created, in the yyyy-MM-dd format"},"PageSize":{"type":"integer","description":"The number of entries per page"},"PageNo":{"type":"integer","description":"The page number"}}}}}},"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-dyvmsapi/query-robotv2-all-list":{"post":{"operationId":"cloud_aliyun_dyvmsapi_query_robotv2_all_list","summary":"Queries a list of robot communication scripts","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.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"}},"/v1/cloud:aliyun-dyvmsapi/query-video-play-progress":{"post":{"operationId":"cloud_aliyun_dyvmsapi_query_video_play_progress","summary":"Queries the video playback progress after a video file is inserted into a voice call","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["CalledNumber"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"CallId":{"type":"string","description":"The call ID. You can obtain the CallId from the response parameters of the SingleCallByVideo…"},"CalledNumber":{"type":"string","description":"The phone number for which to query the video playback progress"}}}}}},"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-dyvmsapi/query-virtual-number-relation":{"post":{"operationId":"cloud_aliyun_dyvmsapi_query_virtual_number_relation","summary":"Queries the binding data of service instances and real numbers, including the binding time, the creation…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"ProdCode":{"type":"string","description":"The product name. Default value: dyvms"},"PageNo":{"type":"integer","description":"The current page number. Default value: 1"},"PageSize":{"type":"integer","description":"The number of entries to return on each page"},"RouteType":{"type":"integer","description":"The routing type. Valid values: 0: Location priority. 1: Random"},"QualificationId":{"type":"integer","description":"The qualification ID. You can leave this parameter empty"},"RegionNameCity":{"type":"string","description":"The location of the real number. You can query the location of the number on the Real Number Management page in the Voice Messaging…"},"SpecId":{"type":"integer","description":"The number type. Valid values: 1: Virtual carrier number. 2: Carrier number. 3: Number starting with 95"},"RelatedNum":{"type":"string","description":"The real number. You can obtain the real number on the Real Number Management page in the Voice Messaging console…"},"PhoneNum":{"type":"string","description":"The service instance number. You can obtain the service instance ID on the Service Instance Management page in the Voice Messaging console…"}}}}}},"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-dyvmsapi/query-vms-real-number-call-connection-rate-info":{"post":{"operationId":"cloud_aliyun_dyvmsapi_query_vms_real_number_call_connection_rate_info","summary":"Queries the call connection rate of real numbers","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"VirtualNumber":{"type":"string","description":"The service instance"},"RealNumber":{"type":"string","description":"The real number"},"TimePeriod":{"type":"string","description":"The time period, specified as a start timestamp and an end timestamp in milliseconds"}}}}}},"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-dyvmsapi/query-vms-virtual-number-relation-by-page":{"post":{"operationId":"cloud_aliyun_dyvmsapi_query_vms_virtual_number_relation_by_page","summary":"Queries the binding relationships between service instances and real numbers","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"PageSize":{"type":"integer","description":"The number of entries to return on each page. Valid values: 1 to 100. Default value: 20"},"PageNo":{"type":"integer","description":"The page number. Default value: 1"},"VirtualNumber":{"type":"string","description":"The service instance"},"RealNumber":{"type":"string","description":"The real number"},"State":{"type":"integer","description":"The state. Valid values: 1: Valid. 0: Invalid. -1: Unregistered"},"NumberCity":{"type":"string","description":"The city of the number location"},"NumberProvince":{"type":"string","description":"The province of the number location"}}}}}},"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-dyvmsapi/query-voice-file-audit-info":{"post":{"operationId":"cloud_aliyun_dyvmsapi_query_voice_file_audit_info","summary":"Queries the review state of a voice file","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["VoiceCodes"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"VoiceCodes":{"type":"string","description":"The ID of the voice file. You can log on to the Voice Messaging Service console (https://dyvms.console.aliyun.com/overview/home), choose…"},"BusinessType":{"type":"integer","description":"The type of the voice file. Valid values: 0 (default): the voice notification file. 2: the recording file"}}}}}},"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-dyvmsapi/recover-call-in-config":{"post":{"operationId":"cloud_aliyun_dyvmsapi_recover_call_in_config","summary":"Calls RecoverCallInConfig to resume inbound calls for a specified 400 call forwarding number","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Number"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"Number":{"type":"string","description":"The 400 number for which you want to resume inbound calls"}}}}}},"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-dyvmsapi/resume-video-file":{"post":{"operationId":"cloud_aliyun_dyvmsapi_resume_video_file","summary":"Resumes video playback after it is paused during a voice call","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["CalledNumber"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"CallId":{"type":"string","description":"The call ID. You can obtain the CallId from the response parameters of the SingleCallByVideo…"},"CalledNumber":{"type":"string","description":"The phone number for which video playback is resumed"}}}}}},"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-dyvmsapi/send-verification":{"post":{"operationId":"cloud_aliyun_dyvmsapi_send_verification","summary":"Sends an SMS verification code","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["VerifyType","BizType","Target"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"VerifyType":{"type":"string","description":"The sending type of the SMS verification code. Set the value to SMS"},"BizType":{"type":"string","description":"The business type. Set the value to CONTACT"},"Target":{"type":"string","description":"The mobile phone number that receives the SMS verification code"}}}}}},"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-dyvmsapi/set-transfer-callee-pool-config":{"post":{"operationId":"cloud_aliyun_dyvmsapi_set_transfer_callee_pool_config","summary":"Sets the call forwarding number for a 400 number","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Details","PhoneNumber","QualificationId","CalledRouteMode"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"Details":{"type":"string","description":"The call forwarding number information (JSON-encoded)"},"PhoneNumber":{"type":"string","description":"The call forwarding number. The 400 number that you purchased on the Real Number Management page of the Voice Messaging Service console…"},"QualificationId":{"type":"string","description":"The qualification ID. You can call the https://help.aliyun.com/document_detail/393548.html operation to obtain the qualification ID"},"CalledRouteMode":{"type":"string","description":"The call mode. Valid values: roundRobin: round-robin. random: random"}}}}}},"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-dyvmsapi/single-call-by-tts":{"post":{"operationId":"cloud_aliyun_dyvmsapi_single_call_by_tts","summary":"Sends a voice verification code or a voice notification with variables to a specified phone number","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["CalledNumber","TtsCode"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"CalledShowNumber":{"type":"string","description":"The number displayed to the called party. You do not need to specify this parameter if you use the text-to-speech (TTS) notification…"},"CalledNumber":{"type":"string","description":"The mobile phone number that receives voice notifications. Number format in the Chinese mainland: * Mobile phone number, for example,…"},"TtsCode":{"type":"string","description":"The ID of the approved TTS notification template or voice verification code template. You can log on to the Voice Messaging Service…"},"TtsParam":{"type":"string","description":"The variables in the template, in the JSON format. The variables in the template must be less than 250 characters in length. The length of…"},"PlayTimes":{"type":"integer","description":"The number of times a voice notification is played back in a call. Valid values: 1 to 3. Default value: 3"},"Volume":{"type":"integer","description":"The playback volume of the voice notification. Valid values: 0 to 100. Default value: 100"},"Speed":{"type":"integer","description":"The playback speed. Valid value: -500 to 500"},"OutId":{"type":"string","description":"The custom ID that is reserved for the caller of the operation when the request is initiated. This ID is returned to the caller in a…"}}}}}},"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-dyvmsapi/single-call-by-video":{"post":{"operationId":"cloud_aliyun_dyvmsapi_single_call_by_video","summary":"Sends a voice file notification or a video file notification to a single called number","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["CalledNumber","VoiceCode","VideoCode"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"CalledShowNumber":{"type":"string","description":"The caller ID number used to send the video notification. If you use a caller ID number in the common pattern, leave this parameter empty.…"},"CalledNumber":{"type":"string","description":"The called number that receives the video notification. Number formats: Mobile number. Example: 159****0000. Landline number. Example:…"},"VoiceCode":{"type":"string","description":"The voice ID of the voice notification file. You can log on to the Voice Messaging Service console…"},"PlayTimes":{"type":"integer","description":"The number of times the notification file is played. Valid values: 1 to 3"},"Volume":{"type":"integer","description":"The volume of the notification file. Valid values: 0 to 100. Default value: 100"},"Speed":{"type":"integer","description":"The playback speed of the voice file. Valid values: -500 to 500"},"OutId":{"type":"string","description":"The custom ID that is reserved for the caller when the request is initiated. This ID is returned to the caller in the receipt message. The…"},"VideoCode":{"type":"string","description":"The ID of the video notification file. You can view the IDs of approved video notification files on the Video Notification Files…"}}}}}},"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-dyvmsapi/single-call-by-voice":{"post":{"operationId":"cloud_aliyun_dyvmsapi_single_call_by_voice","summary":"Sends a voice notification to a phone number by using a voice notification file","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["CalledNumber","VoiceCode"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"CalledShowNumber":{"type":"string","description":"The number displayed to the called party. You do not need to specify this parameter if you use a voice notification file that uses the…"},"CalledNumber":{"type":"string","description":"The number for receiving voice notifications. Number format: In the Chinese mainland: * Mobile phone number, for example, 159\\\\0000. *…"},"VoiceCode":{"type":"string","description":"The voice ID of the voice notification file. You can log on to the Voice Messaging Service console…"},"PlayTimes":{"type":"integer","description":"The number of times the voice notification file is played. Valid values: 1 to 3"},"Volume":{"type":"integer","description":"The playback volume of the voice notification file. Valid values: 0 to 100. Default value: 100"},"Speed":{"type":"integer","description":"The playback speed of the voice notification file. Valid values: -500 to 500"},"OutId":{"type":"string","description":"The ID reserved for the caller. This ID is returned to the caller in a receipt message. The value must be of the STRING type and 1 to 15…"}}}}}},"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-dyvmsapi/skip-video-file":{"post":{"operationId":"cloud_aliyun_dyvmsapi_skip_video_file","summary":"Seeks forward or backward in a video during playback","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SkipTimes","CalledNumber"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"CallId":{"type":"string","description":"The call ID. You can obtain the CallId from the response parameters of the SingleCallByVideo…"},"SkipTimes":{"type":"integer","description":"The time position to seek to for video playback. Unit: milliseconds"},"OutId":{"type":"string","description":"The ID reserved for the caller. This ID is returned to the caller in the receipt message. The value is a string that is 1 to 15 bytes in…"},"CalledNumber":{"type":"string","description":"The phone number that receives the video playback"}}}}}},"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-dyvmsapi/smart-call":{"post":{"operationId":"cloud_aliyun_dyvmsapi_smart_call","summary":"Initiates an intelligent interactive voice response call. Intelligent interactive voice response is a…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["CalledShowNumber","CalledNumber","VoiceCode"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"CalledShowNumber":{"type":"string","description":"The caller ID displayed to the called party. The number must be a purchased number. You can log on to the Voice Messaging Service console…"},"CalledNumber":{"type":"string","description":"The called number. Only numbers in the Chinese mainland are supported"},"VoiceCode":{"type":"string","description":"The audio file played during the intelligent outbound call. If the audio file is uploaded to the console, set the VoiceCode parameter to…"},"RecordFlag":{"type":"string","description":"Specifies whether to record the call. Valid values: true: Record the call. false: Do not record the call"},"Volume":{"type":"integer","description":"The volume for user audio playback. Valid values: -4 to 4. The recommended value is 1"},"Speed":{"type":"integer","description":"This parameter is not supported"},"AsrModelId":{"type":"string","description":"The automatic speech recognition (ASR) model. Valid values: customer_service_8k (default): Mandarin. dialect_customer_service_8k: Heavy…"},"PauseTime":{"type":"integer","description":"The pause duration. This parameter specifies how long a user must pause to indicate the end of a sentence. Unit: milliseconds. Valid…"},"MuteTime":{"type":"integer","description":"The mute duration. This parameter specifies how long a user can remain silent before the call ends. Unit: milliseconds. Valid values: 1000…"},"ActionCodeBreak":{"type":"string","description":"Specifies whether the currently returned media file can be interrupted. Default value: true, which indicates that the media file can be…"},"OutId":{"type":"string","description":"The custom ID provided for the caller. This ID is returned to the caller in the receipt message. The value must be a string and 1 to 15…"},"DynamicId":{"type":"string","description":"The custom dynamic extension ID provided for the caller. This ID is returned in the callback URL and used as a development identifier for…"},"EarlyMediaAsr":{"type":"string","description":"Specifies whether to enable early media speech recognition. Valid values: false (default): Disable early media speech recognition. true:…"},"VoiceCodeParam":{"type":"string","description":"The text-to-speech (TTS) parameter string in JSON format. The parameters must correspond to the TTS parameters of VoiceCode"},"SessionTimeout":{"type":"integer","description":"The maximum call duration. The call is automatically hung up after the timeout period. Unit: seconds. The maximum call duration is 3,600…"},"ActionCodeTimeBreak":{"type":"integer","description":"The continuous speaking duration of the user that triggers an interruption. Unit: milliseconds. If ActionCodeBreak of the current media…"},"TtsStyle":{"type":"string","description":"The voice style used for TTS variable playback. Default value: xiaoyun. For more information, see the voice style list"},"TtsVolume":{"type":"integer","description":"The volume for TTS variable playback. Valid values: 0 to 100. Default value: 0"},"TtsSpeed":{"type":"integer","description":"The speech rate for TTS variable playback. Valid values: -200 to 200. Default value: 0"},"TtsConf":{"type":"string","description":"Specifies whether to configure TTS voice parameters. Valid values: true: Configure TTS voice parameters. You must use the TtsStyle,…"},"AsrBaseId":{"type":"string","description":"The ASR foundation model. Valid values: customer_service_8k (default): Mandarin. dialect_customer_service_8k: Heavy accent. When you call…"},"StreamAsr":{"type":"integer","description":"Specifies whether to enable streaming ASR, which intelligently determines the semantics based on the first few words spoken by the user.…"},"BackgroundFileCode":{"type":"string","description":"The ID of the background audio file played during the conversation between the user and the robot. You can logon to the Voice Messaging…"},"BackgroundVolume":{"type":"integer","description":"This parameter is not supported"},"BackgroundSpeed":{"type":"integer","description":"This parameter is not supported"},"EnableITN":{"type":"string","description":"Specifies whether to perform inverse text normalization (ITN) during post-processing. Default value: false, which indicates that ITN is…"},"NoiseThreshold":{"type":"number","description":"The NoiseThreshold"}}}}}},"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-dyvmsapi/smart-call-operate":{"post":{"operationId":"cloud_aliyun_dyvmsapi_smart_call_operate","summary":"Initiates an action in an outbound robocall. This operation is applicable only when the robocall is…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["CallId","Command"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"CallId":{"type":"string","description":"The unique receipt ID of the call. You can call the https://help.aliyun.com/document_detail/393526.html operation to obtain the receipt ID"},"Command":{"type":"string","description":"The action that is initiated to the called number of an outbound robocall. Only the value parallelBridge is supported. This value…"},"Param":{"type":"string","description":"The extended field"}}}}}},"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-dyvmsapi/start-robot-task":{"post":{"operationId":"cloud_aliyun_dyvmsapi_start_robot_task","summary":"Starts a robocall task immediately or at a scheduled time","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TaskId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"TaskId":{"type":"integer","description":"The unique ID of the robocall task. You can call the [CreateRobotTask](~~CreateRobotTask~~) operation to obtain the task ID"},"ScheduleTime":{"type":"string","description":"The time scheduled for starting the robocall task, in the yyyy-MM-dd HH:mm:ss format"}}}}}},"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-dyvmsapi/stop-call-in-config":{"post":{"operationId":"cloud_aliyun_dyvmsapi_stop_call_in_config","summary":"Stops the inbound call that is transferred from a China 400 number","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Number"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"Number":{"type":"string","description":"The China 400 number from which the inbound call to be stopped is transferred"}}}}}},"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-dyvmsapi/stop-robot-task":{"post":{"operationId":"cloud_aliyun_dyvmsapi_stop_robot_task","summary":"Stops a robocall task that is in progress","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TaskId"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"TaskId":{"type":"integer","description":"The unique ID of the robocall task. You can call the [CreateRobotTask](~~CreateRobotTask~~) operation to obtain 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-dyvmsapi/submit-hotline-transfer-register":{"post":{"operationId":"cloud_aliyun_dyvmsapi_submit_hotline_transfer_register","summary":"Submits a phone number registration before you set up call forwarding numbers for a 400 number","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TransferPhoneNumberInfos","QualificationId","OperatorName","OperatorMail","OperatorMobile","OperatorMobileVerifyCode","OperatorIdentityCard","Agreement","HotlineNumber"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"TransferPhoneNumberInfos":{"type":"string","description":"The phone number registration information (JSON-encoded)"},"QualificationId":{"type":"string","description":"The qualification ID. You can obtain this value by calling the https://help.aliyun.com/document_detail/393548.html operation"},"OperatorName":{"type":"string","description":"The name of the operator"},"OperatorMail":{"type":"string","description":"The email address of the operator"},"OperatorMailVerifyCode":{"type":"string","description":"The email verification code of the operator"},"OperatorMobile":{"type":"string","description":"The mobile phone number of the operator"},"OperatorMobileVerifyCode":{"type":"string","description":"The mobile phone verification code of the operator"},"OperatorIdentityCard":{"type":"string","description":"The ID card number of the operator"},"Agreement":{"type":"string","description":"Specifies whether to confirm the authenticity of the commitment letter. Valid values: true: Authentic. false: Not authentic"},"HotlineNumber":{"type":"string","description":"The 400 number"}}}}}},"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-dyvmsapi/upgrade-video-file":{"post":{"operationId":"cloud_aliyun_dyvmsapi_upgrade_video_file","summary":"Upgrades a voice call to a video call","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["CalledNumber"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"CallId":{"type":"string","description":"The call ID. You can obtain the CallId from the response parameters of the SingleCallByVideo…"},"MediaType":{"type":"string","description":"The media type. Set the value to video"},"OutId":{"type":"string","description":"The ID reserved for the caller. This ID is returned to the caller in the receipt message. The value is a string with a length of 1 to 15…"},"CalledNumber":{"type":"string","description":"The phone number that receives the video call"}}}}}},"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-dyvmsapi/upload-robot-task-called-file":{"post":{"operationId":"cloud_aliyun_dyvmsapi_upload_robot_task_called_file","summary":"Uploads the called numbers of a robocall task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id","CalledNumber"],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.aliyuncs.com"},"Id":{"type":"integer","description":"The unique ID of the robocall task. You can call the [CreateRobotTask](~~CreateRobotTask~~) operation to obtain the ID of the robocall task"},"CalledNumber":{"type":"string","description":"The called numbers. Separate multiple called numbers with commas (,). After you create a robocall task, you must upload called numbers in…"},"TtsParam":{"type":"string","description":"The values of the variable in the text-to-speech (TTS) template, in the JSON format. The variable values specified by the TtsParam…"},"TtsParamHead":{"type":"string","description":"The list of variable names carried in the robocall task, in the JSON format. The TtsParamHead parameter must be used together with 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-dyvmsapi/version":{"post":{"operationId":"cloud_aliyun_dyvmsapi_version","summary":"version","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://dyvmsapi.aliyuncs.com"],"default":"https://dyvmsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyvmsapi.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"}}}}}}}