'1.0', 'info' => ['style' => 'RPC', 'product' => 'CCC', 'version' => '2020-07-01'], 'directories' => [ [ 'children' => ['ListPrivilegesOfUser'], 'type' => 'directory', 'title' => 'Permissions', ], [ 'children' => ['ListInstancesOfUser', 'ModifyInstance'], 'type' => 'directory', 'title' => 'Instances', ], [ 'children' => ['AddPersonalNumbersToUser', 'AddPhoneNumbers', 'AddPhoneNumberToSkillGroups', 'ListOutboundNumbersOfUser', 'ListPersonalNumbersOfUser', 'ListPhoneNumbers', 'ListPhoneNumbersOfSkillGroup', 'ListUnassignedNumbers', 'ModifyPhoneNumber', 'ImportCorpNumbers', 'RemovePersonalNumbersFromUser', 'RemovePhoneNumberFromSkillGroups', 'RemovePhoneNumbers', 'RemovePhoneNumbersFromSkillGroup'], 'type' => 'directory', 'title' => 'Numbers', ], [ 'children' => ['AddNumbersToSkillGroup', 'AddUsersToSkillGroup', 'GetSkillGroup', 'ListBriefSkillGroups', 'ListSkillGroups', 'ListSkillLevelsOfUser', 'ModifySkillGroup', 'ModifySkillLevelsOfUser', 'RemoveSkillGroupsFromUser'], 'type' => 'directory', 'title' => 'Skill groups', ], [ 'children' => ['ImportRamUsers', 'ChangeVisibility', 'AddSkillGroupsToUser', 'AssignUsers', 'ChangeWorkMode', 'ImportAdmins', 'ListDevices', 'ListRamUsers', 'ListUserLevelsOfSkillGroup', 'ModifyUserLevelsOfSkillGroup', 'RegisterDevice', 'RegisterDevices', 'RemoveUsersFromSkillGroup', 'ResetAgentState', 'UnregisterDevice'], 'type' => 'directory', 'title' => 'Agents', ], [ 'children' => [ 'BargeInCall', 'BlindTransfer', 'CancelAttendedTransfer', 'CoachCall', 'CompleteAttendedTransfer', 'EndConference', 'GetNumberLocation', 'InitiateAttendedTransfer', 'InterceptCall', 'LaunchAuthentication', 'LaunchSurvey', 'MonitorCall', 'MuteCall', 'PickOutboundNumbers', 'PollUserStatus', 'ReadyForService', 'RedialCall', 'ReleaseCall', 'RetrieveCall', 'SaveRTCStatsV2', 'SaveTerminalLog', 'SaveWebRtcInfo', 'SaveWebRTCStats', 'SendDtmfSignaling', 'SignInGroup', 'SignOutGroup', 'StartBack2BackCall', 'StartConference', 'StartPredictiveCall', 'StartPrivacyCall', 'SwitchToConference', 'TakeBreak', 'UnmuteCall', ], 'type' => 'directory', 'title' => 'Call management', ], [ 'children' => ['ModifyCampaignNumbers', 'AbortCampaign', 'AddCases', 'AppendCases', 'CreateCampaign', 'GetCampaign', 'GetCaseFileUploadUrl', 'GetHistoricalCampaignReport', 'GetRealtimeCampaignStats', 'ListAttempts', 'ListCampaigns', 'ListCampaignTrendingReport', 'ListCases', 'PauseCampaign', 'ResumeCampaign', 'UpdateCampaign', 'SubmitCampaign'], 'type' => 'directory', 'title' => 'Predictive outbound calls', ], [ 'children' => [ 'GetIvrTrackingSummary', 'ListIntervalAgentSkillGroupReport', 'ListHistoricalAgentSkillGroupReport', 'GetConversationDetail', 'GetHistoricalCallerReport', 'GetHistoricalInstanceReport', 'GetInstanceTrendingReport', 'GetRealtimeInstanceStates', 'ListAgentStateLogs', 'ListCallDetailRecordsV2', 'ListHistoricalAgentReport', 'ListHistoricalSkillGroupReport', 'ListIntervalAgentReport', 'ListIntervalInstanceReport', 'ListIntervalSkillGroupReport', 'ListIvrTrackingDetails', 'ListRealtimeAgentStates', 'ListRealtimeSkillGroupStates', 'ListRecentCallDetailRecords', 'ListAgentStates', 'ListAgentSummaryReportsSinceMidnight', 'ListLegacyAgentEventLogs', 'ListLegacyAgentStatusLogs', 'ListLegacyQueueEventLogs', 'ListSkillGroupStates', 'ListSkillGroupSummaryReportsSinceMidnight', 'ListVoicemails', 'ListGroupChatMessages', ], 'type' => 'directory', 'title' => 'Reports', ], [ 'children' => ['RestoreArchivedRecordings', 'GetMonoRecording', 'GetMultiChannelRecording', 'GetVoicemailRecording', 'GetEarlyMediaRecording', 'ListMultiChannelRecordings', 'ListMonoRecordings'], 'type' => 'directory', 'title' => 'Recordings', ], [ 'children' => ['CreateAudioFile', 'DeleteAudioFile', 'GetAudioFile', 'GetAudioFileDownloadUrl', 'GetAudioFileUploadParameters', 'ListAudioFiles', 'ModifyAudioFile'], 'type' => 'directory', 'title' => 'Audio', ], [ 'children' => ['GetLoginDetails', 'GetTurnCredentials', 'GetTurnServerList', 'ListConfigItems', 'UpdateConfigItems'], 'type' => 'directory', 'title' => 'Configuration', ], [ 'children' => ['ProcessCustomIMCallback', 'CreateChatMediaUrl', 'ListVisitorChatMessages', 'GetChatRoutingProfile', 'UpdateChatRoutingProfile', 'GetChatMediaUrl', 'ListWaitingChats', 'ClaimChat', 'ReleaseChat', 'StartChat', 'RejectChat', 'GetVisitorLoginDetails', 'AcceptChat'], 'type' => 'directory', 'title' => 'IM', ], [ 'children' => ['FinishTicketTask', 'UpdateTicket', 'GetTicket', 'ListCommonTicketFields', 'TerminateTicket', 'GetTicketSummaryReport', 'ResubmitTicket', 'DeleteTicketTemplate', 'RejectTicket', 'DisableTicketTemplate', 'WithdrawTicket', 'ListTicketTasks', 'ListTickets', 'TransferTicketTask', 'EnableTicketTemplate', 'AddTicketTask', 'ListTicketTemplates', 'ListCategories', 'GetTicketTemplate'], 'type' => 'directory', 'title' => 'Tickets', ], [ 'children' => ['AddBlacklistCallTagging', 'CreateCallTags', 'CreateCustomCallTagging', 'DeleteCallTag', 'DeleteCustomCallTagging', 'ExportCustomCallTagging', 'ImportCustomCallTagging', 'ListBlacklistCallTaggings', 'ListCallTags', 'ListCustomCallTagging', 'ModifyCustomCallTagging', 'RemoveBlacklistCallTagging'], 'type' => 'directory', 'title' => 'Inbound call control', ], [ 'children' => ['ExportDoNotCallNumbers', 'GetDoNotCallFileUploadParameters', 'ImportDoNotCallNumbers', 'ListDoNotCallNumbers', 'RemoveDoNotCallNumbers'], 'type' => 'directory', 'title' => 'Outbound call control', ], [ 'children' => ['ListFlashSmsSettings', 'ListFlashSmsApplications', 'ListFlashSmsTemplates', 'ListSmsMetadata'], 'type' => 'directory', 'title' => 'SMS', ], [ 'children' => ['ExportContactFlow', 'ImportContactFlow', 'CreateContactFlow', 'ListContactFlows', 'GetContactFlow', 'StartEditContactFlow', 'CommitContactFlow', 'PublishContactFlow', 'DiscardEditingContactFlow', 'DeleteContactFlow'], 'type' => 'directory', 'title' => 'IVR', ], [ 'children' => ['DeleteSchemaProperty', 'DisableSchemaProperty', 'EnableSchemaProperty', 'GetDocumentUploadParameters', 'UpdateSchemaProperty', 'SaveDocument', 'DeleteDocuments', 'ImportDocuments', 'AddSchemaProperty'], 'type' => 'directory', 'title' => 'Customers', ], [ 'children' => ['GetSummaryTemplate', 'UpdateCallSummary', 'CreateCallSummary', 'ListCallSummaries', 'AnalyzeConversation', 'AddFeedback'], 'type' => 'directory', 'title' => 'Agent assistance', ], [ 'children' => ['GetUploadAudioDataParams'], 'type' => 'directory', 'title' => 'Quality inspection', ], [ 'children' => [ 'ListFeedbacks', 'AnswerCall', 'ClaimCall', 'CreateInstance', 'CreateSchema', 'CreateSkillGroup', 'CreateTicket', 'CreateUser', 'DeleteDocument', 'DeleteInstance', 'DeleteSchema', 'DeleteSkillGroup', 'DeleteTicket', 'GetCallDetailRecord', 'GetInstance', 'GetSchema', 'GetUser', 'HoldCall', 'ListCallDetailRecords', 'ListDocuments', 'ListInstances', 'ListNotificationRecords', 'ListRoles', 'ListUsers', 'MakeCall', 'ModifyUser', 'RemoveUsers', 'ResetUserPassword', 'UpdateSubscription', ], 'type' => 'directory', 'title' => 'Others', ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ 'AbortCampaign' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccQFUGXR'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => [ 'description' => 'Instance ID.', 'enumValueTitles' => [], 'type' => 'string', 'required' => true, 'example' => 'ccc-test', 'title' => '', ], ], [ 'name' => 'CampaignId', 'in' => 'query', 'schema' => ['description' => 'Predictive outbound calling Activity ID.', 'type' => 'string', 'required' => true, 'example' => '6badb397-a8b5-40b6-21019d382a09', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Response parameters.', 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '7CC6523B-0E51-1B62-8DA5-6A9831CAE315'], 'Code' => ['title' => 'code', 'description' => 'Response code.', 'type' => 'string', 'example' => 'OK'], 'Message' => ['title' => 'message', 'description' => 'Response message.', 'type' => 'string', 'example' => '无'], 'HttpStatusCode' => ['title' => 'httpStatusCode', 'description' => 'HTTP status code.', 'type' => 'string', 'example' => '200'], ], 'example' => '', ], ], ], 'title' => 'Stop Predictive Outbound Calling Activity', 'summary' => 'Invoke AbortCampaign to stop the predictive outbound calling Activity corresponding to the specified Activity ID under the specified instance.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AbortCampaign'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7CC6523B-0E51-1B62-8DA5-6A9831CAE315\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', ], 'AcceptChat' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The job ID.', 'type' => 'string', 'required' => true, 'example' => 'chat-65382141036853491', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2263B273-AC1B-44EB-BA98-87F2322C6780', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''], ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => ''], ['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid.', 'description' => ''], ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], 409 => [ ['errorCode' => 'AlreadyExists.SkillGroup', 'errorMessage' => 'The skill group %s already exists in instance %s.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"2263B273-AC1B-44EB-BA98-87F2322C6780\\"\\n}","type":"json"}]', 'title' => 'Accept Chat', 'summary' => 'Call this operation to accept a chat.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'AddBlacklistCallTagging' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc1MRAID'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the Cloud Contact Center instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'Number', 'in' => 'query', 'schema' => ['description' => 'The phone number.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1764590****', 'title' => ''], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The call ID. If the phone number is encrypted and contains asterisks (\\*), specify the JobId. This parameter is not required for unencrypted numbers.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => 'job-6582589278232****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response schema.', 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'ID of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '9FBA26B0-462B-4D77-B78F-AF35560DBC71'], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => ''], ['errorCode' => 'LimitExceed.CallTagsPerNumber', 'errorMessage' => 'The total number of call tag of numbers exceeds the limit %s.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.CustomCallTagging', 'errorMessage' => 'Custom call tagging %s does not exist in instance %s.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.DB', 'errorMessage' => 'An internal DB service error occurred. %s', 'description' => ''], ], ], 'title' => 'Add Blacklist Label to Number', 'summary' => 'Adds a blacklist tag to a specified phone number. You can use this feature with your Interactive Voice Response (IVR) settings to block frequent harassing calls.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9FBA26B0-462B-4D77-B78F-AF35560DBC71\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\"\\n}","type":"json"}]', ], 'AddCases' => [ 'summary' => 'Invoke AddCases to add an outbound call list to a predictive dialing activity identified by a specified ID under a specified instance.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccQFUGXR'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'CampaignId', 'in' => 'query', 'schema' => ['description' => 'The predictive outbound call activity ID.', 'type' => 'string', 'required' => true, 'example' => 'c58b9719-3bc3-441d-a4d3-fc0309ef7066'."\n", 'title' => ''], ], [ 'name' => 'CaseList', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The list of outbound call cases.', 'type' => 'array', 'items' => [ 'description' => 'An outbound call case.', 'type' => 'object', 'properties' => [ 'ReferenceId' => ['description' => 'The business ID, which is an identifier from the customer\'s operational system used in integration scenarios.', 'type' => 'string', 'required' => false, 'example' => '01', 'title' => ''], 'PhoneNumber' => ['description' => 'The contact\'s phone number.', 'type' => 'string', 'required' => false, 'example' => '188888****', 'title' => ''], 'CustomVariables' => ['description' => 'Customer-defined custom variables in JSON object format. The object can contain up to 10 properties, and both the name and value of each property are defined by the customer.', 'type' => 'string', 'required' => false, 'example' => '{"name":"customer","客户标签":"tag"}'."\n", 'title' => ''], 'MaskedCallee' => ['description' => 'The desensitized callee number. If this field is not empty, it indicates that the callee number must be desensitized. The desensitization rule is defined by the customer, and only the desensitized callee number needs to be provided here. Using a desensitized callee number means that in certain scenarios, the displayed callee number will be the desensitized version, and the real callee number cannot be viewed.', 'type' => 'string', 'required' => false, 'example' => '166******66', 'title' => ''], 'Caller' => ['description' => 'The caller number. If this field is specified, the corresponding contact will be called using this number instead of a randomly selected one.', 'type' => 'string', 'required' => false, 'example' => '185022xxxx', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '41298961-CAD7-5270-9378-FFD69F153144'], 'Code' => ['title' => 'code', 'description' => 'The response code.', 'type' => 'string', 'example' => 'OK'], 'Message' => ['title' => 'message', 'description' => 'The response message.', 'type' => 'string', 'example' => '无'], 'HttpStatusCode' => ['title' => 'httpStatusCode', 'description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200'], ], 'example' => '', ], ], ], 'title' => 'Add Predictive Outbound Call List', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AddCases'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"41298961-CAD7-5270-9378-FFD69F153144\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', ], 'AddFeedback' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => ['description' => 'AI task ID.', 'type' => 'string', 'required' => false, 'example' => 'f780ade8-****-458b-b067-63077946a570', 'title' => ''], ], [ 'name' => 'TaskName', 'in' => 'query', 'schema' => ['description' => 'Task type.'."\n" ."\n" .'- Abstract:fields (Field extraction)'."\n" ."\n" .'- Abstract:keywords (Hot keywords)'."\n" ."\n" .'- Abstract:title\\_summary (Summary)', 'type' => 'string', 'required' => false, 'example' => 'Abstract:fields'."\n", 'title' => ''], ], [ 'name' => 'Feedback', 'in' => 'query', 'schema' => ['description' => 'The feedback provided by returning users.', 'type' => 'string', 'required' => false, 'example' => '{"问题描述":"客户询问沙发生产周期并尝试加快", "客服方案":"订单确认，建议联系在线客服", "完成度判断":"否"}'."\n", 'title' => ''], ], [ 'name' => 'Rating', 'in' => 'query', 'schema' => ['description' => 'Rating:'."\n" ."\n" .'- thumbsDown: Thumbs down.'."\n" ."\n" .'- thumbsUp: Thumbs up.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'thumbsUp', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Error message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'C81FD1A5-4B99-470A-A527-D80150228784', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid. %s', 'description' => ''], ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"C81FD1A5-4B99-470A-A527-D80150228784\\"\\n}","type":"json"}]', 'title' => 'AI Summary Rating', 'summary' => 'You can use the AddFeedback API to evaluate and rate AI features.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'AddNumbersToSkillGroup' => [ 'summary' => 'You can invoke AddNumbersToSkillGroup to add one or more numbers to the same skill group.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc1MRAID'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'SkillGroupId', 'in' => 'query', 'schema' => ['description' => 'Skill group ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'skillgroup@ccc-test', 'title' => ''], ], [ 'name' => 'NumberList', 'in' => 'query', 'schema' => ['description' => 'List of numbers. Ensure that the numbers already exist under the current instance.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '["0103182****","0102387****"]', 'title' => ''], ], [ 'name' => 'InstNumberGroupIdList', 'in' => 'query', 'schema' => ['description' => 'List of number collections.', 'type' => 'string', 'required' => false, 'example' => '["38f5b191-b764-45b8-bd93-4b65f839e13a"]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.SkillGroupId', 'errorMessage' => 'The skill group ID %s does not exist in instance %s.', 'description' => ''], ], ], 'title' => 'Add multiple numbers to a skill group ', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-11-07T07:21:05.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddNumbersToSkillGroup'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\"\\n}","type":"json"}]', ], 'AddPersonalNumbersToUser' => [ 'summary' => 'You can invoke AddPersonalNumbersToUser to add one or more personal outbound numbers to a specified agent under a specified instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc1MRAID'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'Agent ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'agent@ccc-test', 'title' => ''], ], [ 'name' => 'NumberList', 'in' => 'query', 'schema' => ['description' => 'List of numbers to be added. The numbers must be attachable to the agent corresponding to UserId. If you are unsure which numbers the agent can attach, refer to the ListPersonalNumbersOfUser API.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["0101234****","0105678****"]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', 'title' => ''], 'Data' => [ 'description' => 'List of numbers that failed to be added.', 'type' => 'array', 'items' => ['description' => 'Number', 'type' => 'string', 'example' => '0101234****', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => ''], ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Add multiple numbers to an agent', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddPersonalNumbersToUser'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Data\\": [\\n \\"0101234****\\"\\n ]\\n}","type":"json"}]', ], 'AddPhoneNumberToSkillGroups' => [ 'summary' => 'You can invoke AddPhoneNumberToSkillGroups to associate a phone number with one or more skill groups under a specified instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc1MRAID'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'Number', 'in' => 'query', 'schema' => ['description' => 'Phone number.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0101234****', 'title' => ''], ], [ 'name' => 'SkillGroupIdList', 'in' => 'query', 'schema' => ['description' => 'List of skill group IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["skillgroup1@ccc-test","skillgroup2@ccc-test"]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Add a phone number to multiple skill groups', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddPhoneNumberToSkillGroups'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\"\\n}","type":"json"}]', ], 'AddPhoneNumbers' => [ 'summary' => 'You can invoke AddPhoneNumbers to add one or more phone numbers to a specified instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc1MRAID'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'ContactFlowId', 'in' => 'query', 'schema' => ['description' => 'ID of the IVR contact flow to attach. This parameter is valid only when the number usage includes inbound calls. It is optional and defaults to empty.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'dDMD_0mif4hv', 'title' => ''], ], [ 'name' => 'Usage', 'in' => 'query', 'schema' => [ 'description' => 'Usage of the phone number. Note: If the provided number is a 400 number, the usage must be set to Inbound.', 'enumValueTitles' => ['Outbound' => 'Outbound', 'Inbound' => 'Inbound', 'Bidirection' => 'Inbound and outbound'], 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Bidirection', 'title' => '', ], ], [ 'name' => 'NumberList', 'in' => 'query', 'schema' => ['description' => 'List of phone numbers to add.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '["0101234****", "0105678****"]', 'title' => ''], ], [ 'name' => 'NumberGroupId', 'in' => 'query', 'schema' => ['description' => 'Number group ID. You can view number grouping information in the Cloud Contact Center console. This parameter is optional and defaults to empty.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '2cb77c29-5f60-4b90-b21e-9d2ba9833f14', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], 'Data' => [ 'description' => 'List of phone numbers that failed to be added.', 'type' => 'array', 'items' => ['description' => 'Phone number.', 'type' => 'string', 'example' => '0101234****', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => ''], ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Add Phone Numbers', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddPhoneNumbers'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": [\\n \\"0101234****\\"\\n ]\\n}","type":"json"}]', ], 'AddSchemaProperty' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'parameters' => [ [ 'name' => 'SchemaId', 'in' => 'formData', 'schema' => ['description' => 'schema id', 'type' => 'string', 'required' => true, 'example' => 'profile', 'title' => ''], ], [ 'name' => 'Property', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Field', 'type' => 'object', 'properties' => [ 'DisplayName' => ['description' => 'Name', 'type' => 'string', 'required' => false, 'example' => 'name', 'title' => ''], 'Description' => ['description' => 'Description.', 'type' => 'string', 'required' => false, 'example' => '-', 'title' => ''], 'Name' => ['description' => 'Name', 'type' => 'string', 'required' => true, 'example' => 'name', 'title' => ''], 'DataType' => ['description' => 'Data type', 'type' => 'string', 'required' => true, 'example' => 'string', 'title' => ''], 'Pattern' => ['description' => 'Regular expression validation rule', 'type' => 'string', 'required' => false, 'example' => '*', 'title' => ''], 'PatternErrorMessage' => ['description' => 'Regular expression validation error message', 'type' => 'string', 'required' => false, 'example' => '格式错误', 'title' => ''], 'MinLength' => ['description' => 'Minimum length', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], 'MaxLength' => ['description' => 'Maximum length', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], 'Minimum' => ['description' => 'Minimum numeric value', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '1', 'title' => ''], 'Maximum' => ['description' => 'Maximum numeric value', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '1', 'title' => ''], 'Required' => ['description' => 'Is required', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], 'Disabled' => ['description' => 'Is disabled', 'type' => 'boolean', 'required' => false, 'example' => 'False', 'title' => ''], 'Array' => ['description' => 'Is array', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], 'ReadOnly' => ['description' => 'Is read-only', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], 'EditorType' => ['description' => 'Editor type', 'type' => 'string', 'required' => false, 'example' => 'textbox', 'title' => ''], 'Attributes' => ['description' => 'Extension attributes', 'type' => 'string', 'required' => false, 'example' => '{\\"newName\\":\\"小桔充电-demo\\",\\"appId\\":\\"69FRKB4193W8BYP0\\"}', 'title' => ''], 'DisplayOrder' => ['description' => 'List display order', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'RequestId', 'in' => 'formData', 'schema' => ['description' => 'Request ID.', 'type' => 'string', 'required' => false, 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1xxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'AddSchemaPropertyResponse', 'title' => 'AddSchemaPropertyResponse', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'BF268B34-09C2-43FD-BAC4-5D31EA633111', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'Response code', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Params' => [ 'description' => 'Response parameters.', 'type' => 'array', 'items' => ['description' => 'The response parameters.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BF268B34-09C2-43FD-BAC4-5D31EA633111\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', 'title' => 'Add schema field', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'summary' => '', ], 'AddSkillGroupsToUser' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccPBOQGO'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'Agent ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'agent@ccc-test', 'title' => ''], ], [ 'name' => 'SkillLevelList', 'in' => 'query', 'schema' => ['description' => 'A JSON-formatted string representing an array of skill levels for skill groups. Each array element is an object containing two fields: skillGroupId and skillLevel. Specify the skill group ID in skillGroupId and the skill level in skillLevel. The skill level must be an integer from 1 to 10, where a lower value indicates stronger business capability and the ability to handle more calls per unit time.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[{"skillGroupId":"test1@ccc-test","skillLevel":5},{"skillGroupId":"test2@ccc-test","skillLevel":5}]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BA7F9545-8312-4190-9BD0-63144B3F1ACC', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => ''], ], 403 => [ ['errorCode' => 'Permission.SkillGroup', 'errorMessage' => 'You have no permission to access skill group(s) %s.', 'description' => ''], ], [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.SkillGroupId', 'errorMessage' => 'The skill group ID %s does not exist in instance %s.', 'description' => ''], ['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => ''], ], ], 'title' => 'Add multiple skill groups to an agent', 'summary' => 'You can invoke AddSkillGroupsToUser to add one or more skill groups to a specified agent under a specified instance.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddSkillGroupsToUser'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA7F9545-8312-4190-9BD0-63144B3F1ACC\\"\\n}","type":"json"}]', ], 'AddTicketTask' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'TicketId', 'in' => 'query', 'schema' => ['description' => 'The ticket ID.', 'type' => 'string', 'required' => true, 'example' => '3d26b90a-c5d2-4b09-8219-********', 'title' => ''], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => ['description' => 'The ticket flow node ID.', 'type' => 'string', 'required' => true, 'example' => '3b8c672f-48f6-45f5-bf41-9d4cb2b4a716', 'title' => ''], ], [ 'name' => 'Assignee', 'in' => 'query', 'schema' => ['description' => 'The assignee for the signature.', 'type' => 'string', 'required' => true, 'example' => 'assignee@ccc-test', 'title' => ''], ], [ 'name' => 'Comment', 'in' => 'query', 'schema' => ['description' => 'Comments.', 'type' => 'string', 'required' => true, 'example' => '请assignee处理。', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'Position', 'in' => 'query', 'schema' => ['description' => 'The position to add the signature.'."\n" ."\n" .'- Before: Before the current handler.'."\n" ."\n" .'- After: After the current handler.', 'type' => 'string', 'required' => false, 'example' => 'After', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'AddAssigneeToTicketTaskResponse', 'title' => 'AddAssigneeToTicketTaskResponse', 'type' => 'object', 'properties' => [ 'Data' => ['description' => 'The data.', 'type' => 'any', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B06B3244-1B44-481B-90C4-F2F92E59D6B5', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Params' => [ 'description' => 'The list of incorrect parameters.', 'type' => 'array', 'items' => ['description' => 'The incorrect parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"B06B3244-1B44-481B-90C4-F2F92E59D6B5\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', 'title' => 'Add Signatory to Ticket', 'summary' => 'Use AddTicketTask to add a signature and assign an assignee.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'AddUsersToSkillGroup' => [ 'summary' => 'You can invoke AddUsersToSkillGroup to add one or more agents to the same skill group.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccPBOQGO'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'SkillGroupId', 'in' => 'query', 'schema' => ['description' => 'Skill group ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test1@ccc-test', 'title' => ''], ], [ 'name' => 'UserSkillLevelList', 'in' => 'query', 'schema' => ['description' => 'A list of agent skill levels in the skill group, formatted as a JSON array string. Each array element is an object containing two fields: userId and skillLevel. The userId field specifies the ID of the agent to be added, and the skillLevel field specifies the agent\'s skill level after joining the skill group. Skill levels range from 1 to 10; a lower value indicates stronger service capability and the ability to handle more calls per unit time.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[{"userId":"agent1@ccc-test","skillLevel":10},{"userId":"agent2@ccc-test","skillLevel":10}]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.SkillGroupId', 'errorMessage' => 'The skill group ID %s does not exist in instance %s.', 'description' => ''], ], ], 'title' => 'Add multiple agents to a skill group ', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddUsersToSkillGroup'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\"\\n}","type":"json"}]', ], 'AnalyzeConversation' => [ 'summary' => 'Analyze the specified text-based conversation content and extract summary-related information, such as the title, keywords, summary, and other specified details.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => ['FEATUREccc5HY0NN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Cloud Contact Center instance ID', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', 'title' => ''], ], [ 'name' => 'ContactId', 'in' => 'query', 'schema' => ['description' => 'Call ID.', 'type' => 'string', 'required' => false, 'example' => 'job-10963442671187****', 'title' => ''], ], [ 'name' => 'TaskListJson', 'in' => 'query', 'schema' => ['description' => 'List of Task Types for analysis. Valid values include:'."\n" ."\n" .'- title: title'."\n" ."\n" .'- summary: summary'."\n" ."\n" .'- keywords: keywords'."\n" ."\n" .'- fields: fields'."\n" ."\n" .'Currently, only "summary" and "title" can be passed together. All other parameters must be passed individually.', 'type' => 'string', 'required' => false, 'example' => '["keywords"]', 'title' => ''], ], [ 'name' => 'FieldListJson', 'in' => 'query', 'schema' => ['description' => 'When the TaskListJson parameter is set to "fields", this parameter specifies the field content to fetch.', 'type' => 'string', 'required' => false, 'example' => '['."\n" .' {'."\n" .' "code": "OrderNo",'."\n" .' "name": "订单号",'."\n" .' "description": "订单号"'."\n" .' },'."\n" .' {'."\n" .' "code": "ProductName",'."\n" .' "name": "商品名称",'."\n" .' "description": "商品名称"'."\n" .' }'."\n" .']', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID, which can be used for LogSearch of this API.', 'type' => 'string', 'example' => '9F766284-F103-4298-8EC5-19F9F9BE5522', 'title' => ''], 'Data' => ['description' => 'Return Result. The content varies depending on the analysis job.', 'type' => 'string', 'example' => '{'."\n" .' "订单号": "1234",'."\n" .' "商品名称": "笔记本"'."\n" .'}', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid. %s', 'description' => ''], ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Analyze Conversation Content ', 'description' => 'This API can be used for both online chat sessions and voice sessions. When used for voice sessions, the real-time speech-to-text transcription feature must be enabled.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"9F766284-F103-4298-8EC5-19F9F9BE5522\\",\\n \\"Data\\": \\"{\\\\n \\\\\\"订单号\\\\\\": \\\\\\"1234\\\\\\",\\\\n \\\\\\"商品名称\\\\\\": \\\\\\"笔记本\\\\\\"\\\\n}\\"\\n}","type":"json"}]', ], 'AnswerCall' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'The agent ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test', 'title' => ''], ], [ 'name' => 'DeviceId', 'in' => 'query', 'schema' => ['description' => 'The device ID. This parameter is meaningless and can be filled with any value.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device', 'title' => ''], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The call ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-65382141036853491', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], 'Params' => [ 'description' => 'List of response parameters.', 'type' => 'array', 'items' => ['description' => 'Response parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'ContextId' => ['description' => 'System auto increment ID. Customers do not need to concern themselves with this.', 'type' => 'integer', 'format' => 'int64', 'example' => '103655', 'title' => ''], 'CallContext' => [ 'description' => 'Call context environment.', 'type' => 'object', 'properties' => [ 'JobId' => ['description' => 'Call ID. ', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'ChannelContexts' => [ 'description' => 'List of channels. ', 'type' => 'array', 'items' => [ 'description' => 'Channel. ', 'type' => 'object', 'properties' => [ 'Index' => ['description' => 'The order in which the channel was created during the call procedure.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'ReleaseInitiator' => ['description' => 'The party that initiated the release of the voice channel, indicating who hung up first. ', 'type' => 'string', 'example' => '1390501****', 'title' => ''], 'ChannelState' => [ 'enumValueTitles' => ['CREATED' => 'Created ', 'ANSWERED' => 'Answered ', 'RELEASED' => 'Released ', 'RETIRED' => 'Out Of Effect ', 'EARLY_MEDIA' => 'Early Media ', 'NONE' => 'Initial Status ', 'RINGING' => 'Ringing '], 'description' => 'The status of the voice channel. ', 'type' => 'string', 'example' => 'ANSWERED', 'title' => '', ], 'Destination' => ['description' => 'The callee of the voice channel. ', 'type' => 'string', 'example' => '1390501****', 'title' => ''], 'UserId' => ['description' => 'The agent ID associated with the ingest endpoint. This field is empty if the ingest endpoint belongs to a customer.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'SkillGroupId' => ['description' => 'The skill group ID associated with the ingest endpoint. In inbound scenarios, the associated skill group ID is determined by the skill group configured in the IVR transfer-to-agent module. In outbound scenarios, the associated skill group ID is the first skill group that the agent signed into.', 'type' => 'string', 'example' => 'skillgroup@ccc-test', 'title' => ''], 'Timestamp' => ['description' => 'The UNIX timestamp of the most recent status change of the ingest endpoint, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315', 'title' => ''], 'ReleaseReason' => ['description' => 'The hang-up reason for the ingest endpoint, indicating why the current ingest endpoint was disconnected. The value corresponds to the response codes defined in the SIP protocol. Customers should refer to the SIP protocol to analyze the hang-up reason.', 'type' => 'string', 'example' => '404 - No destination', 'title' => ''], 'CallType' => [ 'enumValueTitles' => [ 'INBOUND' => 'Inbound', 'BARGE' => 'Barge-in', 'CONSULTANT' => 'Consultation', 'CONFERENCE' => 'Conference', 'MONITOR' => 'Listener', 'INTERNAL' => 'Internal Call', 'OUTBOUND' => 'Outbound', 'INTERCEPT' => 'Intercept', 'BACK2BACK' => 'Back-to-Back Call', 'PREDICTIVE' => 'Predictive Outbound', 'COACH' => 'Coaching', ], 'description' => 'The call type of the channel.', 'type' => 'string', 'example' => 'INBOUND', 'title' => '', ], 'JobId' => ['description' => 'The call ID.', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'ChannelId' => ['description' => 'The ingest endpoint ID.', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****', 'title' => ''], 'Originator' => ['description' => 'The calling party of the ingest endpoint.', 'type' => 'string', 'example' => '0830019****', 'title' => ''], 'UserExtension' => ['description' => 'The extension number of the agent associated with the voice channel.', 'type' => 'string', 'example' => '8032****', 'title' => ''], 'ChannelVariables' => ['description' => 'Channel-associated data.', 'type' => 'string', 'example' => 'a=b;c=d;', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'CallType' => [ 'enumValueTitles' => [ 'INBOUND' => 'Inbound ', 'BARGE' => 'Barge ', 'CONSULTANT' => 'Consultation ', 'CONFERENCE' => 'Conference ', 'MONITOR' => 'Listener ', 'INTERNAL' => 'Internal Call ', 'OUTBOUND' => 'Outbound ', 'INTERCEPT' => 'Intercept ', 'BACK2BACK' => 'Back-to-Back ', 'PREDICTIVE' => 'Predictive Outbound ', 'COACH' => 'Coaching ', ], 'description' => 'Call type. ', 'type' => 'string', 'example' => 'INBOUND', 'title' => '', ], ], 'title' => '', 'example' => '', ], 'UserContext' => [ 'description' => 'Agent context environment.', 'type' => 'object', 'properties' => [ 'Extension' => ['description' => 'The agent\'s extension number.', 'type' => 'string', 'example' => '8032****', 'title' => ''], 'Heartbeat' => ['description' => 'The time when the last heartbeat was received from the agent, formatted as a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378', 'title' => ''], 'WorkMode' => [ 'enumValueTitles' => ['ON_SITE' => 'On-site mode', 'OFF_SITE' => 'Off-site mode', 'OFFICE_PHONE' => 'Office phone mode'], 'description' => 'Work mode.', 'type' => 'string', 'example' => 'ON_SITE', 'title' => '', ], 'DeviceId' => ['description' => 'Device ID, the identity ID of a browser-based Web Real-Time Communication (WebRTC) softphone or a physical phone device. Only one type of device can be registered at a time.', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****', 'title' => ''], 'UserId' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'Reserved' => ['description' => 'The most recent time the agent was reserved. Being reserved means an incoming call will soon be assigned to the agent. The value is formatted as a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378', 'title' => ''], 'BreakCode' => [ 'enumValueTitles' => ['RingingTimeout' => 'Break caused by agent ringing timeout', 'RejectCall' => 'Break caused by agent call rejection', 'Warm-up' => 'Temporary break state after an agent is published and before becoming idle'], 'description' => 'Break status code, which can be either System-defined or Custom-defined. System-defined break codes include: Warm-up (temporary break state after an agent is published and before becoming idle), RingingTimeout (break caused by agent ringing timeout), and RejectCall (break caused by agent call rejection). There are no restrictions on Custom-defined status codes; customers can define them as needed for their business.', 'type' => 'string', 'example' => 'Warm-up', 'title' => '', ], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'OutboundScenario' => ['description' => 'Indicates whether the agent is in outbound-only mode.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Mobile' => ['description' => 'The agent\'s personal phone number.', 'type' => 'string', 'example' => '1324730****', 'title' => ''], 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'UserState' => [ 'enumValueTitles' => ['READY' => 'empty', 'WORKING' => 'post-processing', 'DIALING' => 'dial-up', 'BREAK' => 'break', 'OFFLINE' => 'offline', 'TALKING' => 'talking', 'RINGING' => 'ringing'], 'description' => 'Agent status.', 'type' => 'string', 'example' => 'TALKING', 'title' => '', ], 'SignedSkillGroupIdList' => [ 'description' => 'List of skill group IDs that the agent has signed into.', 'type' => 'array', 'items' => ['description' => 'Skill group ID.', 'type' => 'string', 'example' => 'skillgroup1@ccc-test', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidOperation', 'errorMessage' => 'The operation is not allowed in current state.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.ChannelId', 'errorMessage' => 'The specified channel %s does not exist in call %s.', 'description' => ''], ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"ContextId\\": 103655,\\n \\"CallContext\\": {\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 1,\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"INBOUND\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"Originator\\": \\"0830019****\\",\\n \\"UserExtension\\": \\"8032****\\",\\n \\"ChannelVariables\\": \\"a=b;c=d;\\"\\n }\\n ],\\n \\"CallType\\": \\"INBOUND\\"\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","type":"json"}]', 'title' => 'Answer a call', 'summary' => 'You can invoke AnswerCall to answer the call associated with a specified call ID under a specified instance.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2024-02-05T03:20:14.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-10-26T07:15:58.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-06-05T23:22:12.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2021-12-21T04:35:33.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AnswerCall'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'AppendCases' => [ 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccQFUGXR'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'CampaignId', 'in' => 'query', 'schema' => ['description' => 'The predictive campaign ID.', 'type' => 'string', 'required' => true, 'example' => '78cf6864-9a22-4ea8-a59d-5adc2d747b0e', 'title' => ''], ], [ 'name' => 'body', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'The list of cases to be added.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'ReferenceId' => ['description' => 'The business ID, which is a custom ID from your business system, used for integration purposes.', 'type' => 'string', 'required' => false, 'example' => '01', 'title' => ''], 'PhoneNumber' => ['description' => 'The phone number of the contact.', 'type' => 'string', 'required' => false, 'example' => '188888****', 'title' => ''], 'CustomVariables' => ['description' => 'Custom variables in the format of a JSON object. The object can contain up to 10 properties, and the name and value of each property are custom.', 'type' => 'string', 'required' => false, 'example' => '{'."\n" .' "name": "customer",'."\n" .' "客户标签": "tag"'."\n" .'}', 'title' => ''], 'MaskedCallee' => ['description' => 'The masked callee number. If this parameter is not empty, the callee number will be masked. You can define the masking rule and specify the masked callee number. In some cases, you can only view the masked callee number instead of the real one.', 'type' => 'string', 'required' => false, 'example' => '071*****801', 'title' => ''], 'Caller' => ['description' => 'The caller number. If you specify this parameter, the system preferentially uses the specified number to initiate a call. If you leave this parameter empty, the system automatically selects a number to initiate a call.', 'type' => 'string', 'required' => false, 'example' => '01012345678', 'title' => ''], 'AgentId' => ['description' => 'The agent ID. If you specify this parameter, the system routes the call to the specified agent. If you leave this parameter empty, the system routes the call to an idle agent in the skill group.', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response.', 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'BC976D32-AC4C-4E0F-8AA9-F4BC6C4E2B3E'], 'Code' => ['title' => 'code', 'description' => 'The response code.', 'type' => 'string', 'example' => 'OK'], 'Message' => ['title' => 'message', 'description' => 'The response message.', 'type' => 'string', 'example' => '无'], 'HttpStatusCode' => ['title' => 'httpStatusCode', 'description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200'], 'Data' => [ 'description' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'ReferenceId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'PhoneNumber' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'CustomVariables' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'title' => 'Append Predictive Outbound Call List', 'summary' => 'Adds cases to a predictive campaign in a specified instance.', 'changeSet' => [ ['createdAt' => '2025-11-13T08:46:17.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AppendCases'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BC976D32-AC4C-4E0F-8AA9-F4BC6C4E2B3E\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": [\\n {\\n \\"ReferenceId\\": \\"\\",\\n \\"PhoneNumber\\": \\"\\",\\n \\"CustomVariables\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', ], 'AssignUsers' => [ 'summary' => 'Call AssignUsers to import one or more RAM users into a specified instance. After the import, the RAM users become agents in the instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'write', 'deprecated' => true, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'RoleId', 'in' => 'query', 'schema' => ['description' => 'The ID of the role to assign to the users in the instance. After the RAM users are imported, they are assigned this role. Valid roles are Administrator, Teamleader, and Agent.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Agent@ccc-test', 'title' => ''], ], [ 'name' => 'SkillLevelList', 'in' => 'query', 'schema' => ['description' => 'A JSON array of skill objects, provided as a string. Each object specifies a skillGroupId and a skillLevel from 1 to 10. A lower skillLevel value indicates higher proficiency and greater call-handling capacity.', 'type' => 'string', 'required' => false, 'example' => '[{"skillGroupId":"skillgroup@ccc-test","skillLevel":5}]', 'title' => ''], ], [ 'name' => 'RamIdList', 'in' => 'query', 'schema' => ['description' => 'A JSON array of RAM user IDs to import, formatted as a string.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["28036411123456****","29234301123456****"]', 'title' => ''], ], [ 'name' => 'WorkMode', 'in' => 'query', 'schema' => [ 'description' => 'The work mode for the agents.', 'enumValueTitles' => ['ON_SITE' => 'on-site mode', 'OFF_SITE' => 'off-site mode', 'OFFICE_PHONE' => 'office phone mode'], 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ON_SITE', 'title' => '', ], ], [ 'name' => 'Async', 'in' => 'query', 'schema' => ['type' => 'boolean', 'default' => 'true', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Data' => ['description' => 'The returned data, which is the same as the workflow ID.', 'type' => 'string', 'example' => '1ca2b084-6f0a-454b-9851-29768a9a5832', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'WorkflowId' => ['description' => 'The workflow ID.', 'type' => 'string', 'example' => '1ca2b084-6f0a-454b-9851-29768a9a5832', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => ''], ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'staticInfo' => [ 'substitutions' => ['CCC::2020-07-01::ImportRamUsers'], ], 'title' => 'Import multiple agents', 'description' => 'Accounts with RAM permissions can view all RAM users under an Alibaba Cloud account in the RAM console. You can access the RAM console at https\\://ram.console.aliyun.com/users.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AssignUsers'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"1ca2b084-6f0a-454b-9851-29768a9a5832\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Code\\": \\"OK\\",\\n \\"WorkflowId\\": \\"1ca2b084-6f0a-454b-9851-29768a9a5832\\",\\n \\"Message\\": \\"无\\"\\n}","type":"json"}]', ], 'BargeInCall' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'Agent ID initiating the force insert.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test', 'title' => ''], ], [ 'name' => 'DeviceId', 'in' => 'query', 'schema' => ['description' => 'Device ID. This parameter is meaningless and can be filled in with any value.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device', 'title' => ''], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'Call ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6538214103685****', 'title' => ''], ], [ 'name' => 'BargedUserId', 'in' => 'query', 'schema' => ['description' => 'Agent ID whose call was barged in on.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'agent2@ccc-test', 'title' => ''], ], [ 'name' => 'TimeoutSeconds', 'in' => 'query', 'schema' => ['description' => 'Timeout for force insert, in seconds. If the force insert operation does not succeed within the specified time, it is canceled. Normally, the force insert operation succeeds immediately. The timeout setting is provided to handle abnormal scenarios. This field is optional and defaults to 30 seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '3600', 'minimum' => '0', 'example' => '60', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], 'Params' => [ 'description' => 'List of response parameters.', 'type' => 'array', 'items' => ['description' => 'Response parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'CallContext' => [ 'description' => 'Call context environment.', 'type' => 'object', 'properties' => [ 'CallType' => [ 'description' => 'Call type.', 'enumValueTitles' => [ 'INBOUND' => 'Inbound', 'BARGE' => 'Barge-in', 'CONSULTANT' => 'Consultation', 'CONFERENCE' => 'Conference', 'MONITOR' => 'Listener', 'INTERNAL' => 'Internal Call', 'OUTBOUND' => 'Outbound', 'INTERCEPT' => 'Intercept', 'BACK2BACK' => 'Back-to-Back Call', 'PREDICTIVE' => 'Predictive Outbound', 'COACH' => 'Coaching', ], 'type' => 'string', 'example' => 'BARGE', 'title' => '', ], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'ChannelContexts' => [ 'description' => 'List of call channels.', 'type' => 'array', 'items' => [ 'description' => 'Call channel.', 'type' => 'object', 'properties' => [ 'Index' => ['description' => 'An auto-increment ID assigned by the System. Customers do not need to concern themselves with this value.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'ReleaseInitiator' => ['description' => 'The party that initiated the release of the call channel, indicating who first hung up the call.', 'type' => 'string', 'example' => '1390501****', 'title' => ''], 'ChannelState' => [ 'description' => 'The status of the call channel.', 'enumValueTitles' => ['CREATED' => 'Created', 'ANSWERED' => 'Answered', 'RELEASED' => 'Released', 'RETIRED' => 'Out Of Effect', 'EARLY_MEDIA' => 'Early Media', 'NONE' => 'Initial Status', 'RINGING' => 'Ringing'], 'type' => 'string', 'example' => 'ANSWERED', 'title' => '', ], 'Destination' => ['description' => 'Callee of the call channel.', 'type' => 'string', 'example' => '1390501****', 'title' => ''], 'UserId' => ['description' => 'The agent ID associated with the channel. This field is empty if the channel belongs to a customer.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'ChannelFlags' => [ 'description' => 'Channel flag.', 'enumValueTitles' => ['COACHING' => 'Coaching', 'MONITORING' => 'Monitoring', 'MONITORED' => 'Monitored', 'COACHED' => 'Coached', 'HOLD' => 'Hold', 'MUTED' => 'Muted'], 'type' => 'string', 'example' => 'MONITORING', 'title' => '', ], 'SkillGroupId' => ['description' => 'The skill group ID associated with the voice channel. In inbound scenarios, the associated skill group ID is determined by the skill group configured in the IVR-to-agent module. In outbound scenarios, the associated skill group ID is the first skill group that the agent signed into.', 'type' => 'string', 'example' => 'skillgroup@ccc-test', 'title' => ''], 'Timestamp' => ['description' => 'The UNIX timestamp of the most recent status change of the voice channel, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315', 'title' => ''], 'ReleaseReason' => ['description' => 'The hang-up reason for the voice channel, indicating why the current voice channel was disconnected. The value corresponds to a response code defined in the SIP protocol. Customers should refer to the SIP protocol to analyze the hang-up reason.', 'type' => 'string', 'example' => '404 - No destination', 'title' => ''], 'CallType' => [ 'description' => 'The call type of the channel.', 'enumValueTitles' => [ 'INBOUND' => 'Inbound', 'BARGE' => 'Barge', 'CONSULTANT' => 'Consultant', 'CONFERENCE' => 'Conference', 'MONITOR' => 'Listener', 'INTERNAL' => 'Internal Call', 'OUTBOUND' => 'Outbound', 'INTERCEPT' => 'Intercept', 'BACK2BACK' => 'Back-to-Back', 'PREDICTIVE' => 'Predictive Outbound', 'COACH' => 'Coach', ], 'type' => 'string', 'example' => 'BARGE', 'title' => '', ], 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'ChannelId' => ['description' => 'The voice channel ID.', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****', 'title' => ''], 'UserExtension' => ['description' => 'The extension number of the agent associated with the channel.', 'type' => 'string', 'example' => '8032****', 'title' => ''], 'Originator' => ['description' => 'The originator of the channel.', 'type' => 'string', 'example' => '0830019****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'UserContext' => [ 'description' => 'Agent context environment.', 'type' => 'object', 'properties' => [ 'Extension' => ['description' => 'The agent\'s extension number.', 'type' => 'string', 'example' => '8032****', 'title' => ''], 'Heartbeat' => ['description' => 'The time when the last heartbeat was received from the agent, in UNIX timestamp format, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378', 'title' => ''], 'WorkMode' => [ 'description' => 'Work mode.', 'enumValueTitles' => ['ON_SITE' => 'On-site mode', 'OFF_SITE' => 'Off-site mode', 'OFFICE_PHONE' => 'Office phone mode'], 'type' => 'string', 'example' => 'ON_SITE', 'title' => '', ], 'DeviceId' => ['description' => 'Device ID, the identity ID of a browser-based Web Real-Time Communication (WebRTC) softphone or a physical phone device. Only one type of device can be registered at a time.', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****', 'title' => ''], 'UserId' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'Reserved' => ['description' => 'The time when the agent was most recently reserved. Being reserved means an incoming call will be assigned to the agent shortly. The value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378', 'title' => ''], 'BreakCode' => [ 'description' => 'Break status code, which can be either System-defined or Custom-defined. System-defined break codes include: Warm-up (temporary break state after an agent is published and before becoming idle), RingingTimeout (break caused by agent ringing timeout), and RejectCall (break caused by agent call rejection). There are no restrictions on Custom-defined status codes; customers can define them according to their business needs.', 'enumValueTitles' => ['RingingTimeout' => 'Break caused by agent ringing timeout', 'RejectCall' => 'Break caused by agent call rejection', 'Warm-up' => 'Temporary break state after an agent is published and before becoming idle'], 'type' => 'string', 'example' => 'Warm-up', 'title' => '', ], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'OutboundScenario' => ['description' => 'Indicates whether the agent is in outbound-only mode.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Mobile' => ['description' => 'The agent\'s personal phone number.', 'type' => 'string', 'example' => '1324730****', 'title' => ''], 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'UserState' => [ 'description' => 'Agent status.', 'enumValueTitles' => ['READY' => 'Idle', 'WORKING' => 'Post-processing', 'DIALING' => 'Dialing', 'BREAK' => 'On break', 'OFFLINE' => 'Offline', 'TALKING' => 'In a call', 'RINGING' => 'Ringing'], 'type' => 'string', 'example' => 'TALKING', 'title' => '', ], 'SignedSkillGroupIdList' => [ 'description' => 'List of skill group IDs that the agent has signed into.', 'type' => 'array', 'items' => ['description' => 'Skill group ID.', 'type' => 'string', 'example' => 'skillgroup1@ccc-test', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ['errorCode' => 'InvalidOperation.DeviceState', 'errorMessage' => 'The operation is not allowed. Device state (%s) does not meet expectations (%s).', 'description' => ''], ['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => ''], ], ], 'title' => 'Force Insert Call ', 'summary' => 'You can invoke BargeInCall to forcibly insert into an ongoing call associated with a specified call ID under a specified instance. After the forced insertion succeeds, the original two-party call becomes a three-party conference call.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-10-26T08:13:48.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BargeInCall'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"BARGE\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 10,\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"BARGE\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"UserExtension\\": \\"8032****\\",\\n \\"Originator\\": \\"0830019****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","type":"json"}]', ], 'BlindTransfer' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'The agent ID that initiates a direct transfer.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test', 'title' => ''], ], [ 'name' => 'DeviceId', 'in' => 'query', 'schema' => ['description' => 'Device ID. This parameter is meaningless and can be filled with any value.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'ACC-YUNBS-1.0.10-****', 'title' => ''], ], [ 'name' => 'Transferor', 'in' => 'query', 'schema' => ['description' => 'The transfer initiator. When the scenario involves directly transferring to an external number, the number specified by this parameter is used as the caller. This parameter is invalid when transferring to an internal agent or skill group; in such cases, the initiator is specified by the UserId parameter.', 'type' => 'string', 'required' => false, 'example' => '08314325****', 'title' => ''], ], [ 'name' => 'Transferee', 'in' => 'query', 'schema' => ['description' => 'The transfer recipient, which can be either an agent ID or a skill group ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'agent@ccc-test', 'title' => ''], ], [ 'name' => 'TimeoutSeconds', 'in' => 'query', 'schema' => ['description' => 'Timeout duration for the direct transfer, in seconds. If the transferee does not answer within the specified time, the call is disconnected. This field is optional and defaults to 30 seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '120', 'minimum' => '3', 'example' => '60', 'title' => ''], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The call ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6538214103685****', 'title' => ''], ], [ 'name' => 'CallPriority', 'in' => 'query', 'schema' => ['description' => 'The queue priority when transferring to a skill group. Valid values are 0–9, where 0 is the highest priority and 9 is the lowest.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', 'title' => ''], ], [ 'name' => 'StrategyName', 'in' => 'query', 'schema' => ['description' => 'The policy name for agent assignment when transferring to a skill group queue.', 'type' => 'string', 'required' => false, 'example' => 'MOST_IDLE，MOST_SKILLED，MOST_ACQUAINTED，CUSTOMIZED等', 'title' => ''], ], [ 'name' => 'StrategyParams', 'in' => 'query', 'schema' => ['description' => 'The parameters for the agent assignment policy when transferring to a skill group queue.', 'type' => 'string', 'required' => false, 'example' => '当分配策略为CUSTOMIZED时，本参数的内容为如下格式：'."\n" .' {'."\n" .' "functionId": "512fed64-e379-400f-a1a5-14d5730xxxxx",'."\n" .' "functionName": "routing-strategy-test-2"'."\n" .'}', 'title' => ''], ], [ 'name' => 'TransfereeType', 'in' => 'query', 'schema' => ['description' => 'Destination type for the transfer. Valid values are AGENT, SKILL\\_GROUP, IVR, and EXTERNAL\\_NUMBER. If this parameter is not specified, the system determines the destination type based on the format of the target number. If the automatic detection is inaccurate, you must explicitly specify this parameter.', 'type' => 'string', 'required' => false, 'example' => 'SKILL_GROUP', 'title' => ''], ], [ 'name' => 'ContactFlowVariables', 'in' => 'query', 'schema' => ['description' => 'Variables passed to the contact flow. This field is optional. The variables configured here can be retrieved and used in the IVR flow. The format is a JSON string representing a set of key-value pairs.', 'type' => 'string', 'required' => false, 'example' => '{"name":"王先生","time":"19点20分","address":"某某中心"}', 'title' => ''], ], [ 'name' => 'RoutingType', 'in' => 'query', 'schema' => ['description' => 'The call routing type. Valid values are Automatic or Manual. If this parameter is empty, the system defaults to Automatic routing, which is also the current default behavior of the system. When Manual routing is selected, you must invoke APIs such as ClaimCall to assign the call to a specific agent.', 'type' => 'string', 'required' => false, 'example' => 'Manual', 'title' => ''], ], [ 'name' => 'Tags', 'in' => 'query', 'schema' => ['description' => 'Ingest endpoint data, primarily used for extension purposes. Regular users do not need to concern themselves with this field.', 'type' => 'string', 'required' => false, 'example' => '5295578135#WAEtqY5U&Biz_Package_Rexian_Zhuanjieanquanyungaojie_2527', 'title' => ''], ], [ 'name' => 'QueuingTimeoutSeconds', 'in' => 'query', 'schema' => ['description' => 'The queuing timeout duration in seconds when the transfer target is a skill group queue.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'QueuingOverflowThreshold', 'in' => 'query', 'schema' => ['description' => 'The queuing overflow threshold when the transfer target is a skill group queue. The default value is 0, which means no overflow occurs.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'SkillGroupId', 'in' => 'query', 'schema' => ['description' => 'Skill group ID.', 'type' => 'string', 'required' => false, 'example' => 'ee914df4-82bf-4919-bcb3-9cb8aa437f35', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], 'Params' => [ 'description' => 'List of response parameters.', 'type' => 'array', 'items' => ['description' => 'Response parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'ContextId' => ['description' => 'System auto increment ID. Customers do not need to concern themselves with this.', 'type' => 'integer', 'format' => 'int64', 'example' => '103654', 'title' => ''], 'CallContext' => [ 'description' => 'Call context environment.', 'type' => 'object', 'properties' => [ 'CallType' => [ 'description' => 'Call type.', 'enumValueTitles' => [ 'INBOUND' => 'Inbound', 'BARGE' => 'Barge-in', 'CONSULTANT' => 'Consultation', 'CONFERENCE' => 'Conference', 'MONITOR' => 'Monitor', 'INTERNAL' => 'Internal Call', 'OUTBOUND' => 'Outbound', 'INTERCEPT' => 'Intercept', 'BACK2BACK' => 'Back-to-Back Call', 'PREDICTIVE' => 'Predictive Outbound', 'COACH' => 'Coaching', ], 'type' => 'string', 'example' => 'OUTBOUND', 'title' => '', ], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'ChannelContexts' => [ 'description' => 'List of call channels.', 'type' => 'array', 'items' => [ 'description' => 'Call channel', 'type' => 'object', 'properties' => [ 'ReleaseInitiator' => ['description' => 'The party that initiated the hang-up of the call channel, indicating who first terminated the call.', 'type' => 'string', 'example' => '1390501****', 'title' => ''], 'ChannelState' => [ 'description' => 'The status of the voice channel.', 'enumValueTitles' => ['CREATED' => 'Creation', 'ANSWERED' => 'Answered', 'RELEASED' => 'Released', 'RETIRED' => 'Out Of Effect', 'EARLY_MEDIA' => 'Early Media', 'NONE' => 'Initial Status', 'RINGING' => 'Ringing'], 'type' => 'string', 'example' => 'ANSWERED', 'title' => '', ], 'Destination' => ['description' => 'The callee of the voice channel.', 'type' => 'string', 'example' => '1390501****', 'title' => ''], 'UserId' => ['description' => 'The agent ID associated with the call channel. This field is empty for a Customer\'s call channel.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'ChannelFlags' => [ 'description' => 'Call channel flags.', 'enumValueTitles' => ['COACHING' => 'Coaching', 'MONITORING' => 'Monitoring', 'MONITORED' => 'Monitored', 'COACHED' => 'Coached', 'HOLD' => 'Hold', 'MUTED' => 'Muted'], 'type' => 'string', 'example' => 'MONITORING', 'title' => '', ], 'Timestamp' => ['description' => 'The UNIX timestamp (in milliseconds) of the most recent status change of the channel.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315', 'title' => ''], 'ReleaseReason' => ['description' => 'The reason for releasing the voice channel, indicating why the current voice channel was disconnected. The value is derived from the response codes defined in the SIP protocol. Customers can refer to the SIP protocol to analyze the disconnection reason.', 'type' => 'string', 'example' => '404 - No destination', 'title' => ''], 'CallType' => [ 'description' => 'The call type of the channel.', 'enumValueTitles' => [ 'INBOUND' => 'Inbound', 'BARGE' => 'Barge-in', 'CONSULTANT' => 'Consultation', 'CONFERENCE' => 'Conference', 'MONITOR' => 'Monitor', 'INTERNAL' => 'Internal Call', 'OUTBOUND' => 'Outbound', 'INTERCEPT' => 'Intercept', 'BACK2BACK' => 'Back-to-Back', 'PREDICTIVE' => 'Predictive Dialing', 'COACH' => 'Coaching', ], 'type' => 'string', 'example' => 'OUTBOUND', 'title' => '', ], 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'ChannelId' => ['description' => 'Channel ID.', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****', 'title' => ''], 'Originator' => ['description' => 'The calling party of the call channel.', 'type' => 'string', 'example' => '0830019****', 'title' => ''], 'UserExtension' => ['description' => 'The extension number of the agent associated with the channel.', 'type' => 'string', 'example' => '8032****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'UserContext' => [ 'description' => 'Agent context environment.', 'type' => 'object', 'properties' => [ 'Extension' => ['description' => 'The agent\'s extension number.', 'type' => 'string', 'example' => '8032****', 'title' => ''], 'Heartbeat' => ['description' => 'The time when the last heartbeat was received from the agent, formatted as a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378', 'title' => ''], 'WorkMode' => [ 'description' => 'Work mode.', 'enumValueTitles' => ['ON_SITE' => 'On-site mode', 'OFF_SITE' => 'Off-site mode', 'OFFICE_PHONE' => 'Office phone mode'], 'type' => 'string', 'example' => 'ON_SITE', 'title' => '', ], 'DeviceId' => ['description' => 'Device ID, the identity ID of a browser-based Web Real-Time Communication (WebRTC) softphone or a physical phone device. Only one type of device can be registered at a time.', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****', 'title' => ''], 'UserId' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'Reserved' => ['description' => 'The most recent time when the agent was reserved. Being reserved means an incoming call will soon be assigned to this agent. The format is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378', 'title' => ''], 'BreakCode' => [ 'description' => 'Break status code, which can be either System-defined or Custom-defined. System-defined break codes include: Warm-up (temporary break state after agent is published and before becoming idle), RingingTimeout (break caused by agent ringing timeout), and RejectCall (break caused by agent call rejection). There are no restrictions on Custom-defined status codes; customers can define them according to their business needs.', 'enumValueTitles' => ['RingingTimeout' => 'Break caused by agent ringing timeout', 'RejectCall' => 'Break caused by agent call rejection', 'Warm-up' => 'Temporary break state after agent is published and before becoming idle'], 'type' => 'string', 'example' => 'Warm-up', 'title' => '', ], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'OutboundScenario' => ['description' => 'Indicates whether the agent is in outbound-only mode.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Mobile' => ['description' => 'The agent\'s personal phone number.', 'type' => 'string', 'example' => '1324730****', 'title' => ''], 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'UserState' => [ 'description' => 'Agent status.', 'enumValueTitles' => ['READY' => 'Ready', 'WORKING' => 'Post-processing', 'DIALING' => 'Dialing', 'BREAK' => 'Break', 'OFFLINE' => 'Offline', 'TALKING' => 'Talking', 'RINGING' => 'Ringing'], 'type' => 'string', 'example' => 'TALKING', 'title' => '', ], 'SignedSkillGroupIdList' => [ 'description' => 'List of skill group IDs that the agent has signed into.', 'type' => 'array', 'items' => ['description' => 'Skill group ID.', 'type' => 'string', 'example' => 'skillgroup1@ccc-test', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ['errorCode' => 'Parameter.Invalid', 'errorMessage' => 'The parameter %s is invalid. %s.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => ''], ], ], 'title' => 'Direct call transfer ', 'summary' => 'Directly transfer a call to another agent, a skill group queue, or an external number. Direct transfer is also known as blind transfer or single-step transfer.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2024-10-28T02:30:26.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-04-01T09:23:01.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-11-07T07:21:07.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-04-25T07:33:48.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-04-12T02:15:28.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2021-12-21T09:15:55.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BlindTransfer'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"ContextId\\": 103654,\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"Originator\\": \\"0830019****\\",\\n \\"UserExtension\\": \\"8032****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","type":"json"}]', ], 'CancelAttendedTransfer' => [ 'summary' => 'You can invoke the CancelAttendedTransfer API to cancel an attended transfer. You can call this API at any time after initiating the attended transfer and before completing it, even if the transferee has already answered the call.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'The agent ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test', 'title' => ''], ], [ 'name' => 'DeviceId', 'in' => 'query', 'schema' => ['description' => 'The Device ID. This parameter is meaningless and can be filled with any value.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device', 'title' => ''], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The call ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6538214103685****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], 'Params' => [ 'description' => 'List of response parameters.', 'type' => 'array', 'items' => ['description' => 'Response parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'ContextId' => ['description' => 'System auto increment ID. The Customer does not need to concern themselves with this.', 'type' => 'integer', 'format' => 'int64', 'example' => '103656', 'title' => ''], 'CallContext' => [ 'description' => 'Call context environment.', 'type' => 'object', 'properties' => [ 'CallType' => [ 'description' => 'Call type.', 'enumValueTitles' => [ 'INBOUND' => 'Inbound', 'BARGE' => 'Barge', 'CONSULTANT' => 'Consultant', 'CONFERENCE' => 'Conference', 'MONITOR' => 'Listener', 'INTERNAL' => 'Internal Call', 'OUTBOUND' => 'Outbound', 'INTERCEPT' => 'Intercept', 'BACK2BACK' => 'Back-to-Back', 'PREDICTIVE' => 'Predictive Outbound', 'COACH' => 'Coach', ], 'type' => 'string', 'example' => 'OUTBOUND', 'title' => '', ], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'ChannelContexts' => [ 'description' => 'List of call channels.', 'type' => 'array', 'items' => [ 'description' => 'Call channel.', 'type' => 'object', 'properties' => [ 'Index' => ['description' => 'An auto-increment ID generated by the system. Customers do not need to follow it.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'ReleaseInitiator' => ['description' => 'The party that initiated the release of the call channel, indicating who first hung up the call.', 'type' => 'string', 'example' => '1390501****', 'title' => ''], 'ChannelState' => [ 'description' => 'The status of the call channel.', 'enumValueTitles' => ['CREATED' => 'Created', 'ANSWERED' => 'Answered', 'RELEASED' => 'Released', 'RETIRED' => 'Out Of Effect', 'EARLY_MEDIA' => 'Early Media', 'NONE' => 'Initial Status', 'RINGING' => 'Ringing'], 'type' => 'string', 'example' => 'ANSWERED', 'title' => '', ], 'Destination' => ['description' => 'The callee of the call channel.', 'type' => 'string', 'example' => '1390501****', 'title' => ''], 'UserId' => ['description' => 'The agent ID associated with the voice channel. This field is empty for customer voice channels.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'ChannelFlags' => [ 'description' => 'Channel flags.', 'enumValueTitles' => ['COACHING' => 'Coaching', 'MONITORING' => 'Monitoring', 'MONITORED' => 'Monitored', 'COACHED' => 'Coached', 'HOLD' => 'Hold', 'MUTED' => 'Muted'], 'type' => 'string', 'example' => 'MONITORING', 'title' => '', ], 'Timestamp' => ['description' => 'The UNIX timestamp of the most recent status change of the channel, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315', 'title' => ''], 'ReleaseReason' => ['description' => 'The reason for releasing the channel, indicating why the current channel was disconnected. The value is a response code defined in the SIP protocol. Customers can refer to the SIP protocol to analyze the disconnection reason.', 'type' => 'string', 'example' => '404 - No destination', 'title' => ''], 'CallType' => [ 'description' => 'The call type of the channel.', 'enumValueTitles' => [ 'INBOUND' => 'Inbound', 'BARGE' => 'Barge', 'CONSULTANT' => 'Consultant', 'CONFERENCE' => 'Conference', 'MONITOR' => 'Monitor', 'INTERNAL' => 'Internal Call', 'OUTBOUND' => 'Outbound', 'INTERCEPT' => 'Intercept', 'BACK2BACK' => 'Back-to-Back', 'PREDICTIVE' => 'Predictive Outbound', 'COACH' => 'Coach', ], 'type' => 'string', 'example' => 'CONSULTANT', 'title' => '', ], 'JobId' => ['description' => 'The call ID.', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'ChannelId' => ['description' => 'The channel ID.', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****', 'title' => ''], 'UserExtension' => ['description' => 'The extension number of the agent associated with the voice channel.', 'type' => 'string', 'example' => '8032****', 'title' => ''], 'Originator' => ['description' => 'The originator of the voice channel.', 'type' => 'string', 'example' => '0830019****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'UserContext' => [ 'description' => 'Agent context environment.', 'type' => 'object', 'properties' => [ 'Extension' => ['description' => 'Agent extension number.', 'type' => 'string', 'example' => '8032****', 'title' => ''], 'Heartbeat' => ['description' => 'The time when the last heartbeat was received from the agent, in UNIX timestamp format, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378', 'title' => ''], 'WorkMode' => [ 'description' => 'Work mode.', 'enumValueTitles' => ['ON_SITE' => 'On-site mode', 'OFF_SITE' => 'Off-site mode', 'OFFICE_PHONE' => 'Office phone mode'], 'type' => 'string', 'example' => 'ON_SITE', 'title' => '', ], 'DeviceId' => ['description' => 'Device ID, which is the identity ID of a browser-based Web Real-Time Communication (WebRTC) softphone or a physical phone device. Only one type of device can be registered at a time.', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****', 'title' => ''], 'UserId' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'Reserved' => ['description' => 'The most recent time the agent was reserved. Being reserved means an incoming call will soon be assigned to the agent, in UNIX timestamp format, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378', 'title' => ''], 'BreakCode' => [ 'description' => 'Break status code, which can be either system-defined or customer-defined. System-defined break codes include: Warm-up (temporary break state after the agent is published and before becoming idle), RingingTimeout (break caused by agent ringing timeout), and RejectCall (break caused by agent rejecting a call). There are no restrictions on customer-defined status codes; customers can define them as needed for their business.', 'enumValueTitles' => ['RingingTimeout' => 'Break due to agent ringing timeout', 'RejectCall' => 'Break due to agent call rejection', 'Warm-up' => 'Temporary break state after agent is published and before becoming idle'], 'type' => 'string', 'example' => 'Warm-up', 'title' => '', ], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'OutboundScenario' => ['description' => 'Indicates whether the agent is in outbound-only mode.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Mobile' => ['description' => 'The agent\'s personal phone number.', 'type' => 'string', 'example' => '1324730****', 'title' => ''], 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'UserState' => [ 'description' => 'Agent status.', 'enumValueTitles' => ['READY' => 'Ready', 'WORKING' => 'Post-processing', 'DIALING' => 'Dialing', 'BREAK' => 'Break', 'OFFLINE' => 'Offline', 'TALKING' => 'Talking', 'RINGING' => 'Ringing'], 'type' => 'string', 'example' => 'TALKING', 'title' => '', ], 'SignedSkillGroupIdList' => [ 'description' => 'List of skill group IDs that the agent has signed into.', 'type' => 'array', 'items' => ['description' => 'Skill group ID.', 'type' => 'string', 'example' => 'skillgroup1@ccc-test', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ['errorCode' => 'InvalidOperation.ChannelState', 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', 'description' => ''], ['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.ChannelId', 'errorMessage' => 'The specified channel %s does not exist in call %s.', 'description' => ''], ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => ''], ], ], 'title' => 'Cancel consultation transfer', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-10-26T08:13:48.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelAttendedTransfer'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"ContextId\\": 103656,\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 10,\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"CONSULTANT\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"UserExtension\\": \\"8032****\\",\\n \\"Originator\\": \\"0830019****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","type":"json"}]', ], 'ChangeVisibility' => [ 'summary' => 'Changes an agent\'s status to invisible. This is equivalent to the outbound-only mode.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the Cloud Connect Center instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'szpczf', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'The ID of the agent.', 'type' => 'string', 'required' => false, 'example' => 'sam@szpczf', 'title' => ''], ], [ 'name' => 'Invisible', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to set the agent\'s status to invisible.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Internal service issue. Detail:.', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '24BE19E8-BF7D-4992-A35E-15EBA874F2E5', 'title' => ''], 'Params' => [ 'description' => 'The response parameters.', 'type' => 'array', 'items' => ['description' => 'A response parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], 'Data' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'Extension' => ['description' => 'The agent\'s extension number.', 'type' => 'string', 'example' => '8001****', 'title' => ''], 'WorkMode' => ['description' => 'The work mode.', 'type' => 'string', 'example' => 'ON_SITE', 'title' => ''], 'DeviceId' => ['description' => 'The device ID. This can be the ID of a browser-based WebRTC softphone or a physical phone. Only one device can be registered at a time.', 'type' => 'string', 'example' => 'Yealink SIP-T23G 44.84.203.6', 'title' => ''], 'JobId' => ['description' => 'The call ID. If populated, this field indicates that the agent is in a call.', 'type' => 'string', 'example' => 'job-330557290544431104', 'title' => ''], 'UserId' => ['description' => 'The agent ID.', 'type' => 'string', 'example' => 'sam@szpczf', 'title' => ''], 'BreakCode' => ['description' => 'The break code.', 'type' => 'string', 'example' => '会议', 'title' => ''], 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'szpczf', 'title' => ''], 'OutboundScenario' => ['description' => 'Indicates whether the agent is in outbound-only mode.', 'type' => 'boolean', 'example' => 'False', 'title' => ''], 'UserState' => ['description' => 'The agent state.', 'type' => 'string', 'example' => 'Ready', 'title' => ''], 'SignedSkillGroupIdList' => [ 'description' => 'The IDs of the skill groups to which the agent is signed in.', 'type' => 'array', 'items' => ['description' => 'The ID of a skill group.', 'type' => 'string', 'example' => 'skillgroup@ccc-test', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidOperation.ChannelState', 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', 'description' => ''], ['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Internal service issue. Detail:.\\",\\n \\"RequestId\\": \\"24BE19E8-BF7D-4992-A35E-15EBA874F2E5\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"Extension\\": \\"8001****\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"Yealink SIP-T23G 44.84.203.6\\",\\n \\"JobId\\": \\"job-330557290544431104\\",\\n \\"UserId\\": \\"sam@szpczf\\",\\n \\"BreakCode\\": \\"会议\\",\\n \\"InstanceId\\": \\"szpczf\\",\\n \\"OutboundScenario\\": true,\\n \\"UserState\\": \\"Ready\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup@ccc-test\\"\\n ]\\n }\\n}","type":"json"}]', 'title' => 'Modify Agent Visibility', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'ChangeWorkMode' => [ 'summary' => 'You can invoke ChangeWorkMode to change the agent\'s work mode.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'Agent ID. If not specified, the agent mapped to the current Resource Access Management (RAM) user is used by default.', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test', 'title' => ''], ], [ 'name' => 'DeviceId', 'in' => 'query', 'schema' => ['description' => 'Device ID, which is the identity ID of a browser-based Web Real-Time Communication (WebRTC) softphone or a physical phone device. Only one type of device can be registered at a time.', 'type' => 'string', 'required' => false, 'example' => 'ACC-YUNBS-1.0.10-****', 'title' => ''], ], [ 'name' => 'WorkMode', 'in' => 'query', 'schema' => [ 'description' => 'Work mode.', 'enumValueTitles' => ['ON_SITE' => 'On-site mode', 'OFF_SITE' => 'Off-site mode', 'OFFICE_PHONE' => 'Office phone mode'], 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ON_SITE', 'title' => '', ], ], [ 'name' => 'SignedSkillGroupIdList', 'in' => 'query', 'schema' => ['description' => 'List of skill groups to sign in to. When changing the work mode to off-site mode, you can use this parameter to specify the list of skill groups that the off-site agent needs to sign in to.', 'type' => 'string', 'required' => false, 'example' => '["online-1@ccc-test","online-2@ccc-test","online-3@ccc-test","skg-default@ccc-test"]', 'title' => ''], ], [ 'name' => 'Mobile', 'in' => 'query', 'schema' => ['description' => 'The agent\'s personal phone number, which is used in off-site mode. The agent can use this number to answer calls in off-site mode.', 'type' => 'string', 'required' => false, 'example' => '1382114****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '87731ED1-6224-48A5-99E3-6237FF9B1C00', 'title' => ''], 'Params' => [ 'description' => 'Response parameters.', 'type' => 'array', 'items' => ['description' => 'Response parameters.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'Extension' => ['description' => 'Agent extension number.', 'type' => 'string', 'example' => '8001****', 'title' => ''], 'WorkMode' => [ 'description' => 'Work mode.', 'enumValueTitles' => ['ON_SITE' => 'On-site mode', 'OFF_SITE' => 'Off-site mode', 'OFFICE_PHONE' => 'Office phone mode'], 'type' => 'string', 'example' => 'ON_SITE', 'title' => '', ], 'DeviceId' => ['description' => 'Device ID, which is the identity of a browser-based Web Real-Time Communication (WebRTC) softphone or a physical phone device. Only one type of device can be registered at a time.', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****', 'title' => ''], 'JobId' => ['description' => 'Call ID. If this field has a value, the agent is currently in a call.', 'type' => 'string', 'example' => '无', 'title' => ''], 'UserId' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'BreakCode' => [ 'description' => 'Break status code, which can be either System-defined or Custom-defined. System-defined break codes include: Warm-up (temporary break state after agent is published and before becoming idle), RingingTimeout (break caused by agent ringing timeout), and RejectCall (break caused by agent rejecting a call). There are no restrictions on Custom-defined status codes; customers can define them according to their business needs.', 'enumValueTitles' => ['RingingTimeout' => 'Break caused by agent ringing timeout', 'RejectCall' => 'Break caused by agent rejecting a call', 'Warm-up' => 'Temporary break state after agent is published and before becoming idle'], 'type' => 'string', 'example' => 'Warm-up', 'title' => '', ], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'OutboundScenario' => ['description' => 'Indicates whether the agent has enabled outbound-only mode.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'UserState' => [ 'description' => 'Agent status.', 'enumValueTitles' => ['READY' => 'Ready', 'WORKING' => 'Post-processing', 'DIALING' => 'Dialing', 'BREAK' => 'Break', 'OFFLINE' => 'Offline', 'TALKING' => 'Talking', 'RINGING' => 'Ringing'], 'type' => 'string', 'example' => 'OFFLINE', 'title' => '', ], 'SignedSkillGroupIdList' => [ 'description' => 'List of skill group IDs that the agent has signed into.', 'type' => 'array', 'items' => ['description' => 'Skill group ID.', 'type' => 'string', 'example' => 'skillgroup@ccc-test', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => ''], ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ], ], 'title' => 'Change Agent Work Mode ', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2022-11-28T07:08:39.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeWorkMode'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"87731ED1-6224-48A5-99E3-6237FF9B1C00\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"Extension\\": \\"8001****\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"JobId\\": \\"无\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"UserState\\": \\"OFFLINE\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup@ccc-test\\"\\n ]\\n }\\n}","type":"json"}]', ], 'ClaimCall' => [ 'summary' => 'Call the `ClaimCall` API to assign a call to an agent.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'The ID of the agent claiming the call.', 'type' => 'string', 'required' => false, 'example' => 'invoker@ccc-test', 'title' => ''], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The ID of the call.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6538214103685****', 'title' => ''], ], [ 'name' => 'SkillGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the skill group that the call is assigned to.', 'type' => 'string', 'required' => false, 'example' => 'test_sg_****@ccc-test', 'title' => ''], ], [ 'name' => 'CandidateUserListJson', 'in' => 'query', 'schema' => ['description' => 'A JSON string that lists the agents and their corresponding skill groups eligible to claim the call.', 'type' => 'string', 'required' => false, 'example' => '['."\n" .'{'."\n" .'"f0": "zeren001@report-test-2",'."\n" .'"f1": "desktop-voip-box@report-test-2"'."\n" .'}'."\n" .']', 'title' => ''], ], [ 'name' => 'Tags', 'in' => 'query', 'schema' => ['description' => 'A unique business identifier for scheduling purposes. Subsequent event notifications include this identifier.', 'type' => 'string', 'required' => false, 'example' => 'tags', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '93CDC17E-3E8A-48F2-99E5-FA2E238DE8B4', 'title' => ''], 'Params' => [ 'type' => 'array', 'items' => ['description' => 'The error parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'description' => 'The list of error parameters.', 'title' => '', 'example' => '', ], 'Data' => [ 'type' => 'object', 'properties' => [ 'CallContext' => [ 'type' => 'object', 'properties' => [ 'JobId' => ['description' => 'The call ID.', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'ChannelContexts' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ReleaseInitiator' => ['description' => 'The party who initiated the channel release.', 'type' => 'string', 'example' => '1390501****', 'title' => ''], 'ChannelState' => ['description' => 'The state of the channel.', 'type' => 'string', 'example' => 'ANSWERED', 'title' => ''], 'Destination' => ['description' => 'The destination of the channel.', 'type' => 'string', 'example' => '1390501****', 'title' => ''], 'UserId' => ['description' => 'The agent ID.', 'type' => 'string', 'example' => 'invoker@ccc-test', 'title' => ''], 'Timestamp' => ['description' => 'The Unix timestamp that indicates the last time the channel state changed. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609225718295', 'title' => ''], 'ReleaseReason' => ['description' => 'The reason why the channel was released. This is a SIP response code. For more information, see the SIP protocol specification.', 'type' => 'string', 'example' => '无', 'title' => ''], 'CallType' => ['description' => 'The call type of the channel.', 'type' => 'string', 'example' => 'OUTBOUND', 'title' => ''], 'JobId' => ['description' => 'The call ID.', 'type' => 'string', 'example' => 'job-6573574060089****', 'title' => ''], 'ChannelId' => ['description' => 'The channel ID.', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****', 'title' => ''], 'Originator' => ['description' => 'The originator of the channel.', 'type' => 'string', 'example' => '0830019****', 'title' => ''], 'UserExtension' => ['description' => 'The agent extension number.', 'type' => 'string', 'example' => '8059****', 'title' => ''], 'ChannelVariables' => ['description' => 'The channel variables.', 'type' => 'string', 'example' => 'a=b;c=d;', 'title' => ''], ], 'description' => 'The channel context.', 'title' => '', 'example' => '', ], 'description' => 'The channel contexts.', 'title' => '', 'example' => '', ], ], 'description' => 'The call context.', 'title' => '', 'example' => '', ], 'UserContext' => [ 'type' => 'object', 'properties' => [ 'Extension' => ['description' => 'The extension number.', 'type' => 'string', 'example' => '0830019****', 'title' => ''], 'WorkMode' => ['description' => 'The work mode.', 'type' => 'string', 'example' => 'ON_SITE', 'title' => ''], 'DeviceId' => ['description' => 'The device ID.', 'type' => 'string', 'example' => 'device-xxxx', 'title' => ''], 'JobId' => ['description' => 'The call ID.', 'type' => 'string', 'example' => 'job-6573574060089****', 'title' => ''], 'UserId' => ['description' => 'The agent ID.', 'type' => 'string', 'example' => 'user@ccc-test', 'title' => ''], 'BreakCode' => ['description' => 'The break code.', 'type' => 'string', 'example' => 'Customized', 'title' => ''], 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'OutboundScenario' => ['description' => 'Indicates whether this is an outbound scenario.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'UserState' => ['description' => 'The agent state.', 'type' => 'string', 'example' => 'Dialing', 'title' => ''], 'SignedSkillGroupIdList' => [ 'type' => 'array', 'items' => ['description' => 'The skill group ID.', 'type' => 'string', 'example' => 'skill@ccc-test', 'title' => ''], 'description' => 'The list of signed-in skill group IDs.', 'title' => '', 'example' => '', ], ], 'description' => 'The agent context.', 'title' => '', 'example' => '', ], 'ContextId' => ['description' => 'The context ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', 'title' => ''], ], 'description' => 'The data.', 'title' => '', 'example' => '', ], ], 'description' => 'The response object.', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'ClaimCall', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"93CDC17E-3E8A-48F2-99E5-FA2E238DE8B4\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"invoker@ccc-test\\",\\n \\"Timestamp\\": 1609225718295,\\n \\"ReleaseReason\\": \\"无\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6573574060089****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"Originator\\": \\"0830019****\\",\\n \\"UserExtension\\": \\"8059****\\",\\n \\"ChannelVariables\\": \\"a=b;c=d;\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"0830019****\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"device-xxxx\\",\\n \\"JobId\\": \\"job-6573574060089****\\",\\n \\"UserId\\": \\"user@ccc-test\\",\\n \\"BreakCode\\": \\"Customized\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"UserState\\": \\"Dialing\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skill@ccc-test\\"\\n ]\\n },\\n \\"ContextId\\": 123456\\n }\\n}","type":"json"}]', ], 'ClaimChat' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'SkillGroupId', 'in' => 'query', 'schema' => ['description' => 'Filter by skill group ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'skillgroup@ccc-test', 'title' => ''], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The ID of the call.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'chat-65382141036853491', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BC976D32-AC4C-4E0F-8AA9-F4BC6C4E2B3E', 'title' => ''], 'Params' => [ 'description' => 'List of response parameters.', 'type' => 'array', 'items' => ['description' => 'Response parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'ContextId' => ['description' => 'System auto-increment ID. Customers do not need to be concerned.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456789', 'title' => ''], 'UserContext' => [ 'description' => 'Agent context.', 'type' => 'object', 'properties' => [ 'Heartbeat' => ['description' => 'Time of the agent\'s last heartbeat, in Unix timestamp format, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378', 'title' => ''], 'Extension' => ['description' => 'Agent extension number.', 'type' => 'string', 'example' => '8032****'."\n", 'title' => ''], 'WorkMode' => ['description' => 'Work mode. Not applicable for chat scenarios.'."\n" ."\n" .'Enumerated values:'."\n" ."\n" .'- ON\\_SITE: On-site mode.'."\n" ."\n" .'- OFF\\_SITE: Off-site mode.'."\n" ."\n" .'- OFFICE\\_PHONE: Office phone mode.', 'type' => 'string', 'example' => 'ON_SITE', 'title' => ''], 'DeviceId' => ['description' => 'Device ID.', 'type' => 'string', 'example' => 'CCC-169.254.165.2-browser125.0.0-bs48b41903450e6c8', 'title' => ''], 'UserId' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => 'userId@ccc-test', 'title' => ''], 'Reserved' => ['description' => 'Time when the agent was last reserved, in Unix timestamp format, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => 'false', 'title' => ''], 'BreakCode' => ['description' => 'Break status code.', 'type' => 'string', 'example' => 'Warm-up', 'title' => ''], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'OutboundScenario' => ['description' => 'Outbound call scenario only. Not applicable for chat services.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'DeviceState' => ['description' => 'Device state.', 'type' => 'string', 'example' => 'ONLINE', 'title' => ''], 'Mobile' => ['description' => 'Agent\'s personal phone number. Not applicable for chat scenarios.', 'type' => 'string', 'example' => '18******102', 'title' => ''], 'JobId' => ['description' => 'Job ID.', 'type' => 'string', 'example' => 'chat-65382141036853491'."\n", 'title' => ''], 'UserState' => ['description' => 'Agent state.'."\n" ."\n" .'Enumerated values:'."\n" ."\n" .'- READY: Idle.'."\n" ."\n" .'- WORKING: Post-call processing.'."\n" ."\n" .'- BREAK: Break.'."\n" ."\n" .'- OFFLINE: Offline.'."\n" ."\n" .'- TALKING: Chatting.'."\n" ."\n" .'- RINGING: Incoming chat.', 'type' => 'string', 'example' => 'TALKING', 'title' => ''], 'SignedSkillGroupIdList' => [ 'description' => 'List of skill group IDs the agent is signed into.', 'type' => 'array', 'items' => ['description' => 'Skill group ID.', 'type' => 'string', 'example' => 'skg-default@ccc-test', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'ChatContexts' => [ 'description' => 'Session context.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'JobId' => ['description' => 'Job ID.', 'type' => 'string', 'example' => 'chat-65382141036853491'."\n", 'title' => ''], 'ChatType' => ['description' => 'Session type.', 'type' => 'string', 'example' => 'INBOUND', 'title' => ''], 'CallVariables' => ['description' => 'Call variables.', 'type' => 'string', 'example' => '无', 'title' => ''], 'AccessChannelId' => ['description' => 'Network service channel ID.', 'type' => 'string', 'example' => '226****-cbb6-****-8fea-1e71baf7bfa7', 'title' => ''], 'AccessChannelType' => ['description' => 'Network service channel type.', 'type' => 'string', 'example' => 'Web', 'title' => ''], 'AccessChannelName' => ['description' => 'Network service channel name.', 'type' => 'string', 'example' => '测试渠道', 'title' => ''], 'BeingAssigned' => ['description' => 'Whether the session has been assigned to an agent.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.ChannelId', 'errorMessage' => 'The specified channel %s does not exist in call %s.', 'description' => ''], ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BC976D32-AC4C-4E0F-8AA9-F4BC6C4E2B3E\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"ContextId\\": 123456789,\\n \\"UserContext\\": {\\n \\"Heartbeat\\": 1609136956378,\\n \\"Extension\\": \\"8032****\\\\n\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"CCC-169.254.165.2-browser125.0.0-bs48b41903450e6c8\\",\\n \\"UserId\\": \\"userId@ccc-test\\",\\n \\"Reserved\\": 0,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"DeviceState\\": \\"ONLINE\\",\\n \\"Mobile\\": \\"18******102\\",\\n \\"JobId\\": \\"chat-65382141036853491\\\\n\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skg-default@ccc-test\\"\\n ]\\n },\\n \\"ChatContexts\\": [\\n {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"chat-65382141036853491\\\\n\\",\\n \\"ChatType\\": \\"INBOUND\\",\\n \\"CallVariables\\": \\"无\\",\\n \\"AccessChannelId\\": \\"226****-cbb6-****-8fea-1e71baf7bfa7\\",\\n \\"AccessChannelType\\": \\"Web\\",\\n \\"AccessChannelName\\": \\"测试渠道\\",\\n \\"BeingAssigned\\": true\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => 'Claim Chat', 'summary' => 'You can call ClaimChat to claim the chat for a specified Job ID in a specified instance.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'CoachCall' => [ 'summary' => 'You can invoke CoachCall to coach a specified agent in a specified call (identified by a call ID) under a specified instance. During the coaching session, the coached agent can hear the coach\'s voice, but the customer cannot hear the coach\'s voice.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'Agent ID initiating the coaching.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test', 'title' => ''], ], [ 'name' => 'DeviceId', 'in' => 'query', 'schema' => ['description' => 'Device ID. This field is meaningless and can be filled with any value.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device', 'title' => ''], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'Call ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-65382141036853491', 'title' => ''], ], [ 'name' => 'CoachedUserId', 'in' => 'query', 'schema' => ['description' => 'Agent ID being coached.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'coached-agent@ccc-test', 'title' => ''], ], [ 'name' => 'TimeoutSeconds', 'in' => 'query', 'schema' => ['description' => 'Coaching timeout. If the coaching session is not established within the specified time, the coaching operation is canceled. This field is optional and defaults to 30 seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '3600', 'minimum' => '0', 'example' => '30', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', 'title' => ''], 'Params' => [ 'description' => 'List of response parameters.', 'type' => 'array', 'items' => ['description' => 'Response parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'CallContext' => [ 'description' => 'Call context environment.', 'type' => 'object', 'properties' => [ 'CallType' => [ 'description' => 'Call type.', 'enumValueTitles' => [ 'INBOUND' => 'Inbound', 'BARGE' => 'Barge-in', 'CONSULTANT' => 'Consultation', 'CONFERENCE' => 'Conference', 'MONITOR' => 'Monitor', 'INTERNAL' => 'Internal call', 'OUTBOUND' => 'Outbound', 'INTERCEPT' => 'Intercept', 'BACK2BACK' => 'Back-to-back', 'PREDICTIVE' => 'Predictive outbound', 'COACH' => 'Coach', ], 'type' => 'string', 'example' => 'COACH', 'title' => '', ], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'ChannelContexts' => [ 'description' => 'List of call channels.', 'type' => 'array', 'items' => [ 'description' => 'Call channel.', 'type' => 'object', 'properties' => [ 'Index' => ['description' => 'An auto-incremented ID assigned by the system. Customers do not need to concern themselves with this value.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'ReleaseInitiator' => ['description' => 'The party that initiated the hang-up of the call channel, indicating who first terminated the call.', 'type' => 'string', 'example' => '1390501****', 'title' => ''], 'ChannelState' => [ 'description' => 'The status of the call channel.', 'enumValueTitles' => ['CREATED' => 'Created', 'ANSWERED' => 'Answered', 'RELEASED' => 'Released', 'RETIRED' => 'Out Of Effect', 'EARLY_MEDIA' => 'Early Media', 'NONE' => 'Initial Status', 'RINGING' => 'Ringing'], 'type' => 'string', 'example' => 'ANSWERED', 'title' => '', ], 'Destination' => ['description' => 'The called party of the call channel.', 'type' => 'string', 'example' => '1390501****', 'title' => ''], 'UserId' => ['description' => 'The agent ID associated with the channel. This field is empty for a Customer channel.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'ChannelFlags' => [ 'description' => 'Channel flags.', 'enumValueTitles' => ['COACHING' => 'Coaching', 'MONITORING' => 'Monitoring', 'MONITORED' => 'Monitored', 'COACHED' => 'Coached', 'HOLD' => 'On Hold', 'MUTED' => 'Muted'], 'type' => 'string', 'example' => 'COACHING', 'title' => '', ], 'SkillGroupId' => ['description' => 'The skill group ID associated with the channel. In inbound scenarios, the associated skill group ID is determined by the agent transfer module configured in the IVR. In outbound scenarios, the associated skill group ID is the first skill group ID that the agent signed into.', 'type' => 'string', 'example' => 'skillgroup@ccc-test', 'title' => ''], 'Timestamp' => ['description' => 'The UNIX timestamp indicating the most recent status change of the channel, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315', 'title' => ''], 'ReleaseReason' => ['description' => 'The reason for releasing the channel, indicating why the current channel was disconnected. The value corresponds to response codes defined in the SIP protocol. Customers should refer to the SIP protocol to analyze the disconnection reason.', 'type' => 'string', 'example' => '404 - No destination', 'title' => ''], 'CallType' => [ 'description' => 'The call type of the channel.', 'enumValueTitles' => [ 'INBOUND' => 'Inbound', 'BARGE' => 'Barge-in', 'CONSULTANT' => 'Consultation', 'CONFERENCE' => 'Conference', 'MONITOR' => 'Listener', 'INTERNAL' => 'Internal Call', 'OUTBOUND' => 'Outbound', 'INTERCEPT' => 'Intercept', 'BACK2BACK' => 'Back-to-Back Call', 'PREDICTIVE' => 'Predictive Dialing', 'COACH' => 'Coaching', ], 'type' => 'string', 'example' => 'COACH', 'title' => '', ], 'JobId' => ['description' => 'The call ID.', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'ChannelId' => ['description' => 'The channel ID.', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****', 'title' => ''], 'UserExtension' => ['description' => 'The extension number of the agent associated with the channel.', 'type' => 'string', 'example' => '8032****', 'title' => ''], 'Originator' => ['description' => 'The originator of the channel.', 'type' => 'string', 'example' => '0830019****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'UserContext' => [ 'description' => 'Agent context environment.', 'type' => 'object', 'properties' => [ 'Extension' => ['description' => 'The agent\'s extension number.', 'type' => 'string', 'example' => '8032****', 'title' => ''], 'Heartbeat' => ['description' => 'The UNIX timestamp in milliseconds of the last heartbeat received from the agent.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378', 'title' => ''], 'WorkMode' => [ 'description' => 'Work mode.', 'enumValueTitles' => ['ON_SITE' => 'On-site mode', 'OFF_SITE' => 'Off-site mode', 'OFFICE_PHONE' => 'Office phone mode'], 'type' => 'string', 'example' => 'ON_SITE', 'title' => '', ], 'DeviceId' => ['description' => 'Device ID, the identity ID of a browser-based Web Real-Time Communication (WebRTC) softphone or a physical phone device. Only one type of device can be registered at a time.', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****', 'title' => ''], 'UserId' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'Reserved' => ['description' => 'The UNIX timestamp in milliseconds when the agent was most recently reserved. Being reserved means an incoming call will be assigned to the agent shortly.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956370', 'title' => ''], 'BreakCode' => [ 'description' => 'Break status code, which can be either System-defined or Custom-defined. System-defined break codes include: Warm-up (temporary break state after an agent is published and before becoming idle), RingingTimeout (break caused by agent ringing timeout), and RejectCall (break caused by agent call rejection). There are no restrictions on Custom-defined status codes; customers can define them according to their business needs.', 'enumValueTitles' => ['RingingTimeout' => 'Break caused by agent ringing timeout', 'RejectCall' => 'Break caused by agent call rejection', 'Warm-up' => 'Temporary break state after an agent is published and before becoming idle'], 'type' => 'string', 'example' => 'Warm-up', 'title' => '', ], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'OutboundScenario' => ['description' => 'Indicates whether the agent is in outbound-only mode.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'DeviceState' => [ 'description' => 'The status of the SIP phone device. If the SIP phone is not registered, the status is UNREGISTERED (unregistered). If the SIP phone was previously registered but is currently offline, the status is OFFLINE (offline). If the SIP phone is registered and online, the status is ONLINE (online).', 'enumValueTitles' => ['UNREGISTERED' => 'Unregistered', 'OFFLINE' => 'Offline', 'ONLINE' => 'Online'], 'type' => 'string', 'example' => 'UNREGISTERED', 'title' => '', ], 'Mobile' => ['description' => 'The agent\'s personal phone number.', 'type' => 'string', 'example' => '1324730****', 'title' => ''], 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'UserState' => [ 'description' => 'Agent status.', 'enumValueTitles' => ['READY' => 'Idle', 'WORKING' => 'Post-processing', 'DIALING' => 'Dialing', 'BREAK' => 'Break', 'OFFLINE' => 'Offline', 'TALKING' => 'Talking', 'RINGING' => 'Ringing'], 'type' => 'string', 'example' => 'TALKING', 'title' => '', ], 'SignedSkillGroupIdList' => [ 'description' => 'List of skill group IDs that the agent has signed into.', 'type' => 'array', 'items' => ['description' => 'Skill group ID.', 'type' => 'string', 'example' => 'skillgroup1@ccc-test', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidOperation.DeviceState', 'errorMessage' => 'The operation is not allowed. Device state (%s) does not meet expectations (%s).', 'description' => ''], ['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => ''], ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ['errorCode' => 'UserBusy', 'errorMessage' => 'The user %s you called was busy. Please try again later.', 'description' => ''], ], 403 => [ ['errorCode' => 'Permission.Common', 'errorMessage' => 'You have no permission to access. %s', 'description' => ''], ], [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => ''], ], ], 'title' => 'Coaching call', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2024-01-11T08:11:36.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CoachCall'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"COACH\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 1,\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"COACHING\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"COACH\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"UserExtension\\": \\"8032****\\",\\n \\"Originator\\": \\"0830019****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956370,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"DeviceState\\": \\"UNREGISTERED\\",\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","type":"json"}]', ], 'CommitContactFlow' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccTPIKHY'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'ContactFlowId', 'in' => 'query', 'schema' => ['description' => 'The contact flow ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '7d706489-d06d-4a92-8666-8c9dba2c5cb1', 'title' => ''], ], [ 'name' => 'Definition', 'in' => 'query', 'schema' => ['description' => 'The definition of the Interactive Voice Response (IVR).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"activities":[{"type":"INCOMING_CALL","id":"e98f0d47","name":"开始","properties":{"position":{"x":263,"y":164}},"events":[{"event":"complete","next":"2d3ad2c2","edgeId":"41f7dbd0"}],"nodeIndex":0},{"type":"HANGUP","id":"bd4f37e2","name":"挂机","properties":{"position":{"x":765,"y":185}},"events":[{"event":"complete","next":null}],"nodeIndex":999},{"type":"PLAY_SAY","id":"2d3ad2c2","name":"放音","properties":{"say":"您好，欢迎来到云联络中心。","audioResourceId":"","position":{"x":485.5,"y":153.5},"audioType":"tts","audioInterrupt":false},"events":[{"event":"complete","next":"bd4f37e2","edgeId":"e1af4f1f"}],"nodeIndex":1}],"description":""}', 'title' => ''], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['description' => 'The version description.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'DraftId', 'in' => 'query', 'schema' => ['description' => 'The draft ID. This is the ID of the draft version that corresponds to the current contact flow.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'b28f74ca-5846-4496-8bbd-34fb1750798c', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '937617D5-01E9-5A39-B52D-15D5C143260C', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Submit Contact Flow', 'summary' => 'Commits a contact flow.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"937617D5-01E9-5A39-B52D-15D5C143260C\\"\\n}","type":"json"}]', ], 'CompleteAttendedTransfer' => [ 'summary' => 'You can invoke CompleteAttendedTransfer to complete a consultative transfer.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'The agent ID initiating the consultation transfer.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test', 'title' => ''], ], [ 'name' => 'DeviceId', 'in' => 'query', 'schema' => ['description' => 'Device ID. This parameter is meaningless and can be filled with any value.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device', 'title' => ''], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'Call ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6538214103685****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], 'Params' => [ 'description' => 'List of response parameters.', 'type' => 'array', 'items' => ['description' => 'Response parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'ContextId' => ['description' => 'System auto increment ID. Customers do not need to concern themselves with this.', 'type' => 'integer', 'format' => 'int64', 'example' => '103652', 'title' => ''], 'CallContext' => [ 'description' => 'Call context environment.', 'type' => 'object', 'properties' => [ 'CallType' => [ 'description' => 'Call type.', 'enumValueTitles' => [ 'INBOUND' => 'Inbound', 'BARGE' => 'Barge', 'CONSULTANT' => 'Consultation', 'CONFERENCE' => 'Conference', 'MONITOR' => 'Monitor', 'INTERNAL' => 'Internal Call', 'OUTBOUND' => 'Outbound', 'INTERCEPT' => 'Intercept', 'BACK2BACK' => 'Back-to-Back', 'PREDICTIVE' => 'Predictive Outbound', 'COACH' => 'Coach', ], 'type' => 'string', 'example' => 'OUTBOUND', 'title' => '', ], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'ChannelContexts' => [ 'description' => 'List of call channels.', 'type' => 'array', 'items' => [ 'description' => 'Call channel.', 'type' => 'object', 'properties' => [ 'Index' => ['description' => 'An auto increment ID assigned by the system. Customers do not need to follow this.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'ReleaseInitiator' => ['description' => 'The party that initiated the hang-up of the voice channel, indicating who first terminated the call.', 'type' => 'string', 'example' => '1390501****', 'title' => ''], 'ChannelState' => [ 'description' => 'The status of the voice channel.', 'enumValueTitles' => ['CREATED' => 'Created', 'ANSWERED' => 'Answered', 'RELEASED' => 'Released', 'RETIRED' => 'Out Of Effect', 'EARLY_MEDIA' => 'Early Media', 'NONE' => 'Initial Status', 'RINGING' => 'Ringing'], 'type' => 'string', 'example' => 'ANSWERED', 'title' => '', ], 'Destination' => ['description' => 'The callee of the voice channel.', 'type' => 'string', 'example' => '1390501****', 'title' => ''], 'UserId' => ['description' => 'The agent ID associated with the channel. This field is empty if the channel belongs to a customer.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'ChannelFlags' => [ 'description' => 'Channel flags.', 'enumValueTitles' => ['COACHING' => 'Coaching', 'MONITORING' => 'Monitoring', 'MONITORED' => 'Monitored', 'COACHED' => 'Coached', 'HOLD' => 'Hold', 'MUTED' => 'Muted'], 'type' => 'string', 'example' => 'MONITORING', 'title' => '', ], 'SkillGroupId' => ['description' => 'The skill group ID associated with the voice channel. In inbound scenarios, the associated skill group ID is determined by the skill group configured in the IVR transfer-to-agent module. In outbound scenarios, the associated skill group ID is the first skill group that the agent signed into.', 'type' => 'string', 'example' => 'skillgroup@ccc-test', 'title' => ''], 'Timestamp' => ['description' => 'The UNIX timestamp of the most recent status change of the voice channel, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315', 'title' => ''], 'ReleaseReason' => ['description' => 'The hang-up reason for the voice channel, indicating why the current voice channel was disconnected. The value corresponds to response codes defined in the SIP protocol. Customers should refer to the SIP protocol to analyze the hang-up reason.', 'type' => 'string', 'example' => '404 - No destination', 'title' => ''], 'CallType' => [ 'description' => 'The call type of the channel.', 'enumValueTitles' => [ 'INBOUND' => 'Inbound', 'BARGE' => 'Barge-in', 'CONSULTANT' => 'Consultation', 'CONFERENCE' => 'Conference', 'MONITOR' => 'Listener', 'INTERNAL' => 'Internal Call', 'OUTBOUND' => 'Outbound', 'INTERCEPT' => 'Intercept', 'BACK2BACK' => 'Back-to-Back Call', 'PREDICTIVE' => 'Predictive Outbound', 'COACH' => 'Coaching', ], 'type' => 'string', 'example' => 'OUTBOUND', 'title' => '', ], 'JobId' => ['description' => 'The call ID.', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'ChannelId' => ['description' => 'The voice channel ID.', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****', 'title' => ''], 'UserExtension' => ['description' => 'The extension number of the agent associated with the channel.', 'type' => 'string', 'example' => '8032****', 'title' => ''], 'Originator' => ['description' => 'The originator of the channel.', 'type' => 'string', 'example' => '0830019****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'UserContext' => [ 'description' => 'Agent context environment.', 'type' => 'object', 'properties' => [ 'Extension' => ['description' => 'The agent\'s extension number.', 'type' => 'string', 'example' => '8032****', 'title' => ''], 'Heartbeat' => ['description' => 'The time when the last heartbeat was received from the agent, formatted as a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378', 'title' => ''], 'WorkMode' => [ 'description' => 'Work mode.', 'enumValueTitles' => ['ON_SITE' => 'On-site mode', 'OFF_SITE' => 'Off-site mode', 'OFFICE_PHONE' => 'Office phone mode'], 'type' => 'string', 'example' => 'ON_SITE', 'title' => '', ], 'DeviceId' => ['description' => 'Device ID, the identity ID of a browser-based Web Real-Time Communication (WebRTC) softphone or a physical phone device. Only one type of device can be registered at a time.', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'."\n", 'title' => ''], 'UserId' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'Reserved' => ['description' => 'The most recent time when the agent was reserved. Being reserved means an incoming call will soon be assigned to this agent. The format is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378', 'title' => ''], 'BreakCode' => [ 'description' => 'Break status code, which can be either System-defined or Custom-defined. System-defined break codes include: Warm-up (temporary break state after agent is published and before becoming idle), RingingTimeout (break caused by agent ringing timeout), and RejectCall (break caused by agent rejecting a call). There are no restrictions on Custom-defined status codes; customers can define them according to their business needs.', 'enumValueTitles' => ['RingingTimeout' => 'Break due to agent ringing timeout', 'RejectCall' => 'Break due to agent call rejection', 'Warm-up' => 'Temporary break state after agent is published and before becoming idle'], 'type' => 'string', 'example' => 'Warm-up', 'title' => '', ], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'OutboundScenario' => ['description' => 'Indicates whether the agent is in outbound-only mode.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Mobile' => ['description' => 'The agent\'s personal phone number.', 'type' => 'string', 'example' => '1324730****', 'title' => ''], 'JobId' => ['description' => 'Call ID during the call state.', 'type' => 'string', 'example' => 'job-65382141036853491', 'title' => ''], 'UserState' => [ 'description' => 'Agent status.', 'enumValueTitles' => ['READY' => 'Ready', 'WORKING' => 'Post-processing', 'DIALING' => 'Dialing', 'BREAK' => 'Break', 'OFFLINE' => 'Offline', 'TALKING' => 'Talking', 'RINGING' => 'Ringing'], 'type' => 'string', 'example' => 'TALKING', 'title' => '', ], 'SignedSkillGroupIdList' => [ 'description' => 'List of skill group IDs that the agent has signed into.', 'type' => 'array', 'items' => ['description' => 'Skill group ID.', 'type' => 'string', 'example' => 'skillgroup1@ccc-test', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ['errorCode' => 'InvalidOperation.ChannelState', 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', 'description' => ''], ['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.ChannelId', 'errorMessage' => 'The specified channel %s does not exist in call %s.', 'description' => ''], ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => ''], ], ], 'title' => 'Complete consultation transfer ', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-10-26T08:13:48.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CompleteAttendedTransfer'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"ContextId\\": 103652,\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 10,\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"UserExtension\\": \\"8032****\\",\\n \\"Originator\\": \\"0830019****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\\\n\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-65382141036853491\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","type":"json"}]', ], 'CreateAudioFile' => [ 'summary' => 'You can invoke CreateAudioFile to create an audio resource under a specified instance. The created audio resource can be used in the instance, such as selecting the audio file for playback during IVR.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccKYIENB'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'Display name of the audio, containing 1 to 32 characters.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '欢迎语', 'title' => ''], ], [ 'name' => 'AudioFileName', 'in' => 'query', 'schema' => ['description' => 'Audio file name, containing 1 to 32 characters.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-file.wav', 'title' => ''], ], [ 'name' => 'OssFileKey', 'in' => 'query', 'schema' => ['description' => 'Key of the OSS file, returned by the GetAudioFileUploadParameters API.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test/test-file.wav', 'title' => ''], ], [ 'name' => 'Usage', 'in' => 'query', 'schema' => ['description' => 'Usage of the audio file. The default value is General (used in scenarios such as IVR). Other optional values include HoldMusic (hold music during a call).', 'type' => 'string', 'required' => false, 'example' => 'General', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Data' => ['description' => 'Data, which is the ID of the audio resource and uniquely identifies an audio resource.', 'type' => 'string', 'example' => '2301b83f-1f9f-491e-9f97-2f832ed92f0b', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '94E29B9B-DBC6-5951-B3DD-C85C1BDF20ED', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Create Audio File', 'changeSet' => [ ['createdAt' => '2023-11-22T01:05:25.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAudioFile'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"2301b83f-1f9f-491e-9f97-2f832ed92f0b\\",\\n \\"RequestId\\": \\"94E29B9B-DBC6-5951-B3DD-C85C1BDF20ED\\"\\n}","type":"json"}]', ], 'CreateCallSummary' => [ 'summary' => 'Use the CreateCallSummary operation to create a call summary.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], ], 'parameters' => [ [ 'name' => 'CustomerId', 'in' => 'query', 'schema' => ['title' => 'The customer ID. ', 'description' => 'Customer ID', 'type' => 'string', 'required' => false, 'example' => '51e155ce-3747-*****-b402-13c69597b920'], ], [ 'name' => 'Context', 'in' => 'query', 'schema' => ['title' => 'Summary information ', 'description' => 'Summary information', 'type' => 'string', 'required' => false, 'example' => '{"summaryTitle":"标题","summaryContent":"内容","keywords":"关键信息"}'], ], [ 'name' => 'ContactId', 'in' => 'query', 'schema' => ['title' => 'The session ID. ', 'description' => 'The ID of the session.', 'type' => 'string', 'required' => false, 'example' => 'job-522327189435260928'], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID', 'type' => 'string', 'required' => true, 'example' => 'ccc-test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'CreateTicketResponse', 'title' => 'CreateTicketResponse ', 'type' => 'object', 'properties' => [ 'Data' => ['description' => 'Data. The summary ID.', 'type' => 'string', 'example' => 'c58b9719-3bc3-441d-a4d3-fc0309ef7066', 'title' => ''], 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '8707EB29-BAED-4302-B999-40BA61877437', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'Response code', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'Response message', 'type' => 'string', 'example' => '无', 'title' => ''], 'Params' => [ 'description' => 'List of invalid parameters', 'type' => 'array', 'items' => ['description' => 'Invalid parameter', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Create a session summary ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"c58b9719-3bc3-441d-a4d3-fc0309ef7066\\",\\n \\"RequestId\\": \\"8707EB29-BAED-4302-B999-40BA61877437\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', ], 'CreateCallTags' => [ 'summary' => 'You can invoke CreateCallTags to create multiple call tags under a specified instance.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc1MRAID'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'CallTagNameList', 'in' => 'query', 'schema' => ['description' => 'A JSON-formatted string representing an array of call tag names. Each array element is a call tag name to be created. The length of each call tag name must be between 1 and 10 characters.', 'type' => 'string', 'required' => true, 'example' => '["TagA","TagB"]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Data' => [ 'description' => 'The list of call tags that failed to be created.', 'type' => 'array', 'items' => [ 'description' => 'Information about a call tag that failed to be created.', 'type' => 'object', 'properties' => [ 'Item' => ['description' => 'The name of the call tag that failed to be created.', 'type' => 'string', 'example' => 'TagC', 'title' => ''], 'Reason' => [ 'description' => 'The reason why the call tag creation failed.', 'enumValueTitles' => ['CALL_TAG_NAME_DUPLICATED' => 'Duplicate items exist in the input list.', 'CALL_TAG_NAME_INSERT_DUPLICATED' => 'Duplicate items were detected when writing call tags in the backend.', 'CALL_TAG_NAME_ILLEGAL' => 'The input list contains call tags with invalid formats.'], 'type' => 'string', 'example' => 'CALL_TAG_NAME_DUPLICATED', 'title' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => ''], ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => ''], ['errorCode' => 'LimitExceed.CallTagsPerInstance', 'errorMessage' => 'The total number of call tag of the instance exceeds the limit %s.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.DB', 'errorMessage' => 'An internal DB service error occurred. %s', 'description' => ''], ], ], 'title' => 'Create Multiple Call Tags', 'changeSet' => [ ['createdAt' => '2022-02-24T13:00:36.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCallTags'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": [\\n {\\n \\"Item\\": \\"TagC\\",\\n \\"Reason\\": \\"CALL_TAG_NAME_DUPLICATED\\"\\n }\\n ]\\n}","type":"json"}]', ], 'CreateCampaign' => [ 'summary' => 'You can invoke CreateCampaign to create a predictive outbound calling activity under a specified instance.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccQFUGXR'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID. ', 'type' => 'string', 'required' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'CaseList', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'List of predictive outbound dialing contacts. This parameter cannot be used together with CaseFileKey (import from file). You must choose either file import or list import. '."\n", 'type' => 'array', 'items' => [ 'description' => 'Predictive outbound dialing contact. ', 'type' => 'object', 'properties' => [ 'ReferenceId' => ['description' => 'Business ID, an identifier from the Customer\'s Operational System, used in integration scenarios. ', 'type' => 'string', 'required' => false, 'example' => '01', 'title' => ''], 'PhoneNumber' => ['description' => 'Contact phone number. ', 'type' => 'string', 'required' => false, 'example' => '1888888888', 'title' => ''], 'CustomVariables' => ['description' => 'Customer-defined custom variables in JSON object format. The object can contain up to 10 properties, each with a name and value defined by the customer. ', 'type' => 'string', 'required' => false, 'example' => '{"name":"customer","客户标签":"tag"}', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'QueueId', 'in' => 'query', 'schema' => ['description' => 'The skill group ID associated with the predictive outbound dialing activity. ', 'type' => 'string', 'required' => true, 'example' => 'skillgroup@ccc-test', 'title' => ''], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'Name of the predictive outbound dialing activity. ', 'type' => 'string', 'required' => true, 'example' => 'test-campaign', 'title' => ''], ], [ 'name' => 'CaseFileKey', 'in' => 'query', 'schema' => ['description' => 'Predictive outbound dialing contact file, specified as the key of an OSS object. Obtain this key by calling the GetCaseFileUploadUrl API. ', 'type' => 'string', 'required' => false, 'example' => 'ccc-test/namelist.csv', 'title' => ''], ], [ 'name' => 'ContactFlowId', 'in' => 'query', 'schema' => ['description' => 'The contact flow ID associated with the predictive outbound dialing activity. ', 'type' => 'string', 'required' => true, 'example' => 'c1f2bc75-422e-43c7-9c9d9d95633a', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The start time of the predictive outbound dialing activity, in Unix timestamp format with millisecond precision. ', 'type' => 'string', 'required' => true, 'example' => '1634140800000', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end time of the predictive outbound calling activity, formatted as a UNIX timestamp in milliseconds.', 'type' => 'string', 'required' => true, 'example' => '1634313600000', 'title' => ''], ], [ 'name' => 'CallableTime', 'in' => 'query', 'schema' => ['description' => 'The callable time window for the predictive outbound dialing activity, formatted as a JSON object containing two properties: beginTime and endTime. Example: [{"beginTime":"00:00:00","endTime":"23:00:00"}]. ', 'type' => 'string', 'required' => true, 'example' => '[{"beginTime":"00:00:00","endTime":"23:00:00" }]', 'title' => ''], ], [ 'name' => 'StrategyType', 'in' => 'query', 'schema' => [ 'enumValueTitles' => ['PACING' => 'Fixed-ratio outbound dialing: the number of outbound calls equals the number of idle agents multiplied by the ratio.', 'PID' => 'The system automatically adjusts the number of outbound calls based on a PID control policy.'], 'description' => 'The strategy pattern for the predictive outbound calling activity.', 'type' => 'string', 'required' => true, 'enum' => ['SP', 'PID', 'PACING', 'ASAP', 'CUSTOMIZED'], 'example' => 'PACING', 'title' => '', ], ], [ 'name' => 'StrategyParameters', 'in' => 'query', 'schema' => ['description' => 'Strategy parameters for the predictive outbound dialing activity. For PID strategy, an example format is: {"abandonRate":"5","historicalConnectedRate":"35"}. For PACING strategy, an example format is: {"ratio":1}. abandonRate represents the desired abandonment rate, historicalConnectedRate represents the historical reference connection rate, and ratio represents the fixed dialing ratio. ', 'type' => 'string', 'required' => true, 'example' => '{"ratio":1}', 'title' => ''], ], [ 'name' => 'MaxAttemptCount', 'in' => 'query', 'schema' => ['description' => 'The maximum number of attempts for the predictive outbound calling activity. This specifies how many times a number can be redialed if the initial call fails.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'MinAttemptInterval', 'in' => 'query', 'schema' => ['description' => 'The minimum redial interval for the predictive outbound calling activity, which specifies the minimum time interval between redial attempts after a failed call, in minutes.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'Simulation', 'in' => 'query', 'schema' => ['description' => 'Indicates whether this is a simulation activity used for testing. Regular customers do not need to concern themselves with this. ', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => '无', 'title' => ''], ], [ 'name' => 'SimulationParameters', 'in' => 'query', 'schema' => ['description' => 'Simulation parameters used for testing. Regular customers do not need to concern themselves with this. ', 'type' => 'string', 'required' => false, 'example' => '无', 'title' => ''], ], [ 'name' => 'ExecutingUntilTimeout', 'in' => 'query', 'schema' => ['description' => 'Whether to keep the activity in the executing state until it expires. The default value is false. If false, the activity automatically transitions to the completed state after all contacts have been called. If true, the activity remains in the executing state even after all contacts have been called, allowing you to append additional contacts and continue dialing until the activity expires or is manually stopped.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'FlashSmsParameters', 'in' => 'query', 'schema' => ['description' => 'Flash SMS parameters ', 'title' => 'Flash SMS parameters ', 'type' => 'string', 'example' => '{"applicationId":"08e6b63a-****-****-****-689a288cdbb5","templateId":"325"}', 'required' => false], ], [ 'name' => 'NumberList', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'List of caller numbers ', 'title' => 'List of caller numbers ', 'type' => 'array', 'items' => ['description' => 'Number ', 'title' => 'Number ', 'type' => 'string', 'example' => '01012345678', 'required' => false], 'required' => false, 'example' => '', ], ], [ 'name' => 'InstGroupId', 'in' => 'query', 'schema' => ['description' => 'Phone number collection ID ', 'title' => 'Phone number collection ID ', 'type' => 'string', 'example' => '0d368091-2c70-4d26-979a-6997ddc9c34f', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'title' => 'Id of the request', 'type' => 'string', 'example' => '7CC6523B-0E51-1B62-8DA5-6A9831CAE315'], 'Data' => ['description' => 'The predictive outbound calling campaign ID.', 'title' => 'campaign id', 'type' => 'string', 'example' => 'c58b9719-3bc3-441d-a4d3-fc0309ef7066'], 'Code' => ['description' => 'The response code.', 'title' => 'code', 'type' => 'string', 'example' => 'OK'], 'Message' => ['description' => 'The response message.', 'title' => 'message', 'type' => 'string', 'example' => '无'], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7CC6523B-0E51-1B62-8DA5-6A9831CAE315\\",\\n \\"Data\\": \\"c58b9719-3bc3-441d-a4d3-fc0309ef7066\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', 'title' => 'Create a predictive outbound calling activity', 'changeSet' => [ ['createdAt' => '2025-11-13T08:46:07.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2021-12-21T04:35:33.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCampaign'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'CreateChatMediaUrl' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '263385', 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'MimeType', 'in' => 'formData', 'schema' => ['title' => 'Media ID ', 'description' => 'Media ID.', 'type' => 'string', 'required' => true, 'example' => 'jpg'], ], [ 'name' => 'RequestId', 'in' => 'formData', 'schema' => ['description' => 'Request ID.', 'type' => 'string', 'required' => false, 'example' => '9F766284-F103-4298-8EC5-19F9F9BE5522', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['description' => 'Cloud Contact Center instance ID.', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'GetChatMediaUrlResponse', 'title' => 'GetChatMediaUrlResponse ', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'MediaId' => ['description' => 'Media ID.', 'type' => 'string', 'example' => '$iAHNCNQCo21wMwMGBAAFAAbaACOEAaQhIH6TAqogDGyb-qD2Hbj0A88AAAGRLKYVnwTOACwwYwcACM8AAAGRLRPynQ', 'title' => ''], 'Url' => ['description' => 'File URL.', 'type' => 'string', 'example' => 'https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-test/namelist.csv?Expires=1642067227&OSSAccessKeyId=****&Signature=****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Params' => [ 'description' => 'Response parameters.', 'type' => 'array', 'items' => ['description' => 'Error parameter.', 'type' => 'string', 'example' => '[\'OFFLINE\', \'BREAK,READY,WORKING\']', 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"MediaId\\": \\"$iAHNCNQCo21wMwMGBAAFAAbaACOEAaQhIH6TAqogDGyb-qD2Hbj0A88AAAGRLKYVnwTOACwwYwcACM8AAAGRLRPynQ\\",\\n \\"Url\\": \\"https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-test/namelist.csv?Expires=1642067227&OSSAccessKeyId=****&Signature=****\\"\\n },\\n \\"RequestId\\": \\"03C67DAD-EB26-41D8-949D-9B0C470FB716\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"[\'OFFLINE\', \'BREAK,READY,WORKING\']\\"\\n ]\\n}","type":"json"}]', 'title' => 'Obtain media file upload URL ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'summary' => '', ], 'CreateContactFlow' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'Contact flow name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '默认流程', 'title' => ''], ], [ 'name' => 'Definition', 'in' => 'query', 'schema' => ['description' => 'IVR content.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"activities":[{"type":"INCOMING_CALL","id":"e98f0d47","name":"开始","properties":{"position":{"x":263,"y":164}},"events":[{"event":"complete","next":"2d3ad2c2","edgeId":"41f7dbd0"}],"nodeIndex":0},{"type":"HANGUP","id":"bd4f37e2","name":"挂机","properties":{"position":{"x":765,"y":185}},"events":[{"event":"complete","next":null}],"nodeIndex":999},{"type":"PLAY_SAY","id":"2d3ad2c2","name":"放音","properties":{"say":"您好，欢迎来到云联络中心。","audioResourceId":"","position":{"x":485.5,"y":153.5},"audioType":"tts","audioInterrupt":false},"events":[{"event":"complete","next":"bd4f37e2","edgeId":"e1af4f1f"}],"nodeIndex":1}],"description":""}', 'title' => ''], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['description' => 'Version description.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1.0', 'title' => ''], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => ['description' => 'Flow type.
'."\n" .'Main flow: MAIN\\_FLOW
'."\n" .'Child flow: SUB\\_FLOW
'."\n" .'Survey flow: SURVEY\\_FLOW


', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MAIN_FLOW', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Data' => ['description' => 'IVR contact flow ID.', 'type' => 'string', 'example' => '78128960-bb00-4ddc-8e82-923a8c5bd22d', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '2778FA12-EDD6-42AA-9B15-AF855072E5E5', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"78128960-bb00-4ddc-8e82-923a8c5bd22d\\",\\n \\"RequestId\\": \\"2778FA12-EDD6-42AA-9B15-AF855072E5E5\\"\\n}","type":"json"}]', 'title' => 'Create Contact Flow', 'summary' => 'Creates an IVR flow.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateContactFlow'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'CreateCustomCallTagging' => [ 'summary' => 'You can invoke CreateCustomCallTagging to create one or more inbound number tags under a specified instance.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'write', 'deprecated' => true, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc1MRAID'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'CustomNumberList', 'in' => 'query', 'schema' => ['description' => 'A list of inbound control tags, formatted as a JSON array string. The number of array elements must be between 1 and 10,000. Each element in the array is an object with the following properties: number (must be a numeric string of 4 to 32 characters), description, and callTagNameList. The callTagNameList is an array whose elements are number labels (ensure that these number labels have already been created).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[{"number":"1312121****","description":"王先生","callTagNameList":["TagA"]},{"number":"1388888****","description":"张先生","callTagNameList":["TagB"]}]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'enumValueTitles' => [], 'description' => 'Schema of Response', 'title' => 'Schema of Response ', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Data' => [ 'description' => 'The list of inbound number tags that failed to be created.', 'type' => 'array', 'items' => [ 'enumValueTitles' => [], 'description' => 'Information about an inbound number tag that failed to be created.', 'type' => 'object', 'properties' => [ 'Item' => ['description' => 'The number of the inbound number tag that failed to be created.', 'type' => 'string', 'example' => '1312121****', 'title' => ''], 'Reason' => [ 'description' => 'The reason why the creation of the inbound number tag failed.', 'enumValueTitles' => ['CUSTOM_NUMBER_ILLEGAL' => 'The input list contains numbers with invalid formats.', 'CUSTOM_NUMBER_DUPLICATED' => 'The input list contains duplicate numbers.', 'CUSTOM_NUMBER_ALREADY_EXISTS' => 'The input list contains numbers for which tags already exist.', 'CUSTOM_NUMBER_TAG_NOT_EXIST' => 'The input list contains numbers associated with tags that have not been created.', 'CUSTOM_NUMBER_INSERT_DUPLICATED' => 'Duplicate entries were detected when writing inbound number tags to the backend.', 'CUSTOM_NUMBER_TOO_MANY_TAGS' => 'The input list contains numbers that exceed the maximum allowed number of tags per number.'], 'type' => 'string', 'example' => 'CUSTOM_NUMBER_DUPLICATED', 'title' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => ''], ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.RamId', 'errorMessage' => 'RAM user %s does not exist.', 'description' => ''], ], 409 => [ ['errorCode' => 'AlreadyExists.CustomNumber', 'errorMessage' => 'Custom number already exists.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.DB', 'errorMessage' => 'An internal DB service error occurred. %s', 'description' => ''], ], ], 'staticInfo' => [ 'substitutions' => ['CCC::2020-07-01::CreateCustomCallTaggings'], ], 'title' => 'Create Multiple Inbound Number Tags ', 'changeSet' => [ ['createdAt' => '2022-02-24T14:31:19.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCustomCallTagging'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": [\\n {\\n \\"Item\\": \\"1312121****\\",\\n \\"Reason\\": \\"CUSTOM_NUMBER_DUPLICATED\\"\\n }\\n ]\\n}","type":"json"}]', ], 'CreateInstance' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => ['FEATUREcccTMAX45'], ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'Instance name. The length must be between 4 and 32 characters.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '测试实例', 'title' => ''], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['description' => 'Description of the instance. The length must not exceed 256 characters.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '云联络中心的测试实例。', 'title' => ''], ], [ 'name' => 'DomainName', 'in' => 'query', 'schema' => ['description' => 'Second-level domain name of the Cloud Contact Center instance, which serves as the instance ID and is globally unique. It must be 4 to 48 characters long and can only contain uppercase and lowercase English letters, digits, underscores (\\_), and hyphens (-).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'NumberList', 'in' => 'query', 'schema' => ['description' => 'List of phone numbers for the Cloud Contact Center instance to be created. The current account must have usage rights to these numbers, and the numbers must not be associated with any other instance.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '["0830011xxxx", "0830312xxxx"]', 'title' => ''], ], [ 'name' => 'AdminRamIdList', 'in' => 'query', 'schema' => ['description' => 'List of RAM IDs to be assigned as administrators of this Cloud Contact Center instance. After successful creation, the RAM IDs in this list will be automatically imported into the newly created instance with administrator privileges.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["24861380681070****","105980354482****"]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Data' => ['description' => 'Data, which is the ID of the pipeline used to create the instance in the backend.', 'type' => 'string', 'example' => '75c1346c-1dc2-4ed8-973f-edf8b1e5fe77', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '2778FA12-EDD6-42AA-9B15-AF855072E5E5', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.Number', 'errorMessage' => 'The specified number %s does not exist in instance %s.', 'description' => ''], ], 409 => [ ['errorCode' => 'AlreadyExists.InstanceId', 'errorMessage' => 'The instance %s already exists.', 'description' => 'The cloud contact center instance already exists.'], ], ], 'title' => 'Create Instance', 'summary' => 'Invoke CreateInstance to create a Cloud Contact Center instance.', 'changeSet' => [ ['createdAt' => '2025-10-28T09:55:19.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstance'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"75c1346c-1dc2-4ed8-973f-edf8b1e5fe77\\",\\n \\"RequestId\\": \\"2778FA12-EDD6-42AA-9B15-AF855072E5E5\\"\\n}","type":"json"}]', ], 'CreateSchema' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'parameters' => [ [ 'name' => 'Id', 'in' => 'formData', 'schema' => ['description' => 'The schema ID.', 'type' => 'string', 'required' => false, 'example' => 'profile', 'title' => ''], ], [ 'name' => 'Description', 'in' => 'formData', 'schema' => ['description' => 'The description.', 'type' => 'string', 'required' => false, 'example' => '-', 'title' => ''], ], [ 'name' => 'Properties', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'The list of fields.', 'type' => 'array', 'items' => [ 'description' => 'The list of fields.', 'type' => 'object', 'properties' => [ 'DisplayName' => ['description' => 'The display name for agents.', 'type' => 'string', 'required' => false, 'example' => '显示名称', 'title' => ''], 'Description' => ['description' => 'The description of the version.', 'type' => 'string', 'required' => false, 'example' => '-', 'title' => ''], 'Name' => ['description' => 'The name.', 'type' => 'string', 'required' => true, 'example' => 'name', 'title' => ''], 'DataType' => ['description' => 'The data type.', 'type' => 'string', 'required' => true, 'example' => 'string', 'title' => ''], 'Pattern' => ['description' => 'The regular expression that is used for validation.', 'type' => 'string', 'required' => false, 'example' => '*', 'title' => ''], 'PatternErrorMessage' => ['description' => 'The error message that is returned when the regular expression fails to match.', 'type' => 'string', 'required' => false, 'example' => '错误的格式', 'title' => ''], 'MinLength' => ['description' => 'The minimum length.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], 'MaxLength' => ['description' => 'The maximum length.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], 'Minimum' => ['description' => 'The minimum value of the number.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '1', 'title' => ''], 'Maximum' => ['description' => 'The maximum value of the number.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '1', 'title' => ''], 'Required' => ['description' => 'Indicates whether the field is required.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], 'Disabled' => ['description' => 'Indicates whether the field is disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], 'Array' => ['description' => 'Indicates whether the field is an array.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], 'ReadOnly' => ['description' => 'Indicates whether the field is read-only.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], 'EditorType' => ['description' => 'The editor type.', 'type' => 'string', 'required' => false, 'example' => 'textbox', 'title' => ''], 'Attributes' => ['description' => 'The extended properties.', 'type' => 'string', 'required' => false, 'example' => '{\'Clusters\': {\'Description\': \'The list of clusters.\'}, \'ClusterIds\': {\'Description\': \'The list of cluster IDs.\'}}', 'title' => ''], 'DisplayOrder' => ['description' => 'The display order in the list.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'RequestId', 'in' => 'formData', 'schema' => ['description' => 'The request ID.', 'type' => 'string', 'required' => false, 'example' => '7BEEA660-A45A-45E3-98CC-AFC65E715C23', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'CreateSchemaResponse', 'title' => 'CreateSchemaResponse ', 'type' => 'object', 'properties' => [ 'Data' => ['description' => 'The data.', 'type' => 'string', 'example' => '1ca2b084-6f0a-454b-9851-29768a9a5832', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9F766284-F103-4298-8EC5-19F9F9BE5522', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Params' => [ 'description' => 'The response parameters.', 'type' => 'array', 'items' => ['description' => 'The response parameters.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"1ca2b084-6f0a-454b-9851-29768a9a5832\\",\\n \\"RequestId\\": \\"9F766284-F103-4298-8EC5-19F9F9BE5522\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', 'title' => 'Create Schema ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'summary' => '', ], 'CreateSkillGroup' => [ 'summary' => 'You can call CreateSkillGroup to create a skill group under a specified instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccPBOQGO'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'The skill group name. It must be 1 to 64 characters in length, can contain digits, letters, underscores (\\_), and hyphens (-), and must start with a letter.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'skillgroup', 'title' => ''], ], [ 'name' => 'DisplayName', 'in' => 'query', 'schema' => ['description' => 'Display name of the skill group. It must be 1 to 64 characters in length.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '测试技能组', 'title' => ''], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['description' => 'Description of the skill group. This parameter is optional. If not specified, it defaults to empty.', 'type' => 'string', 'required' => false, 'example' => '云联络中心的测试技能组。', 'title' => ''], ], [ 'name' => 'MediaType', 'in' => 'query', 'schema' => ['description' => 'Media type. The default value is AUDIO. Other valid values include CHAT and VIDEO.', 'type' => 'string', 'required' => false, 'example' => 'CHAT', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'Description' => ['description' => 'Description of the skill group.', 'type' => 'string', 'example' => '云联络中心的测试技能组。', 'title' => ''], 'Name' => ['description' => 'Skill group name.', 'type' => 'string', 'example' => 'skillgroup', 'title' => ''], 'SkillGroupId' => ['description' => 'Skill group ID, in the format: skill group name\\@instance ID.', 'type' => 'string', 'example' => 'skillgroup@ccc-test', 'title' => ''], 'MediaType' => ['description' => 'Media type. The default value is AUDIO. Other valid values include CHAT and VIDEO.', 'type' => 'string', 'example' => 'VIDEO', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid. %s', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], 409 => [ ['errorCode' => 'AlreadyExists.SkillGroupId', 'errorMessage' => 'Skill group %s already exists in instance %s.', 'description' => 'The specified skill group already exists in the cloud contact center instance.'], ], 500 => [ ['errorCode' => 'InternalService.DB', 'errorMessage' => 'An internal DB service error occurred. %s', 'description' => ''], ], ], 'title' => 'Create a skill group', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-11-06T05:44:50.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSkillGroup'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Description\\": \\"云联络中心的测试技能组。\\",\\n \\"Name\\": \\"skillgroup\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"MediaType\\": \\"VIDEO\\"\\n }\\n}","type":"json"}]', ], 'CreateTicket' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => ['description' => 'Ticket template ID.', 'type' => 'string', 'required' => false, 'example' => 'e9e4c76c-948d-4a6e-9ce2-9da0f5967a73', 'title' => ''], ], [ 'name' => 'CustomerId', 'in' => 'query', 'schema' => ['description' => 'Customer ID, the customer ID in Cloud Contact Center customer profiles.', 'type' => 'string', 'required' => false, 'example' => '51e155ce-3747-4f21-b402-13c69597b920', 'title' => ''], ], [ 'name' => 'Title', 'in' => 'query', 'schema' => ['description' => 'Ticket title.', 'type' => 'string', 'required' => false, 'example' => '售后工单。', 'title' => ''], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => ['description' => 'Ticket source.', 'type' => 'string', 'required' => false, 'example' => 'CHAT', 'title' => ''], ], [ 'name' => 'ContactId', 'in' => 'query', 'schema' => ['description' => 'The ID of the call.', 'type' => 'string', 'required' => false, 'example' => 'job-38860977107324****', 'title' => ''], ], [ 'name' => 'Context', 'in' => 'query', 'schema' => ['description' => 'Ticket field information.', 'type' => 'string', 'required' => false, 'example' => '{"productName":"玩具1"}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'A450574A-337F-43E2-BC59-9C6594C994C6', 'title' => ''], 'Data' => ['description' => 'Returned data, ticket ID.', 'type' => 'string', 'example' => '3d26b90a-c5d2-4b09-8219-60cda1******', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''], ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => ''], ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"A450574A-337F-43E2-BC59-9C6594C994C6\\",\\n \\"Data\\": \\"3d26b90a-c5d2-4b09-8219-60cda1******\\"\\n}","type":"json"}]', 'title' => 'Create Ticket', 'summary' => 'Use CreateTicket to create a ticket.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'CreateUser' => [ 'summary' => 'Call the CreateUser operation to create a new agent in a specified instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'LoginName', 'in' => 'query', 'schema' => ['description' => 'The logon name of the agent. It must be 4 to 64 characters in length and can contain uppercase letters, lowercase letters, digits, periods (.), underscores (\\_), and hyphens (-).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'agent', 'title' => ''], ], [ 'name' => 'DisplayName', 'in' => 'query', 'schema' => ['description' => 'The display name of the agent. It must be 1 to 128 characters in length.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'maxLength' => 500, 'minLength' => 0, 'example' => '坐席小王', 'title' => ''], ], [ 'name' => 'Mobile', 'in' => 'query', 'schema' => ['description' => 'The personal phone number of the agent. This number is used in OFF\\_SITE mode. The agent can use this number to answer calls in OFF\\_SITE mode.', 'type' => 'string', 'required' => false, 'example' => '1382114****', 'title' => ''], ], [ 'name' => 'Email', 'in' => 'query', 'schema' => ['description' => 'The email address of the agent. After the agent is created, an email is sent to this address. The email contains the logon URL for Cloud Contact Center, and the username and password for the RAM account. Keep this information secure.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'username@example.com', 'title' => ''], ], [ 'name' => 'WorkMode', 'in' => 'query', 'schema' => [ 'description' => 'The work mode.', 'enumValueTitles' => ['ON_SITE' => 'On-site mode', 'OFF_SITE' => 'Off-site mode', 'OFFICE_PHONE' => 'Office phone mode'], 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'ON_SITE', 'title' => '', ], ], [ 'name' => 'RoleId', 'in' => 'query', 'schema' => ['description' => 'The role ID. The format is Role\\@InstanceID. The following roles are supported: Admin (administrator), Manager (skill group leader), and Agent (agent).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Agent@ccc-test', 'title' => ''], ], [ 'name' => 'SkillLevelList', 'in' => 'query', 'schema' => ['description' => 'A list of skill levels for skill groups. This is a string in the format of a JSON array. The array can contain up to 100 elements. Each element is an object that contains two fields: skillGroupId and skillLevel. For skillGroupId, enter the ID of the skill group to add. For skillLevel, enter the skill level to add. The value can range from 1 to 10. A smaller value indicates a higher skill level, meaning the agent can handle more calls per unit of time.', 'type' => 'string', 'required' => false, 'example' => '[{"skillGroupId":"skillgroup1@ccc-test","skillLevel":1},{"skillGroupId":"skillgroup2@ccc-test","skillLevel":10}]', 'title' => ''], ], [ 'name' => 'ResetPassword', 'in' => 'query', 'schema' => ['description' => 'Specifies whether the agent must reset the password upon the first logon. If set to true, the agent is prompted to reset the password when they first log on to the RAM account. Otherwise, they are not prompted. The default value is false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'DisplayId', 'in' => 'query', 'schema' => ['description' => 'The agent\'s ID number. Set this as needed.', 'type' => 'string', 'required' => false, 'example' => '1001', 'title' => ''], ], [ 'name' => 'AvatarUrl', 'in' => 'query', 'schema' => ['description' => 'The URL of the agent\'s profile picture.', 'type' => 'string', 'required' => false, 'example' => 'http://abc.com/sam.jpg', 'title' => ''], ], [ 'name' => 'Nickname', 'in' => 'query', 'schema' => ['description' => 'The agent\'s nickname.', 'type' => 'string', 'required' => false, 'example' => '老王', 'title' => ''], ], [ 'name' => 'NeedEmailNotification', 'in' => 'query', 'schema' => ['title' => 'Specifies whether to send an Email Notification. '."\n" .'- true: Send '."\n" .'- false: Not Send ', 'description' => 'Specifies whether to send an email notification.'."\n" ."\n" .'- true: Send'."\n" ."\n" .'- false: Do not send', 'type' => 'string', 'example' => 'true', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', 'title' => ''], 'Data' => [ 'description' => 'The data.', 'type' => 'object', 'properties' => [ 'DisplayName' => ['description' => 'The display name of the agent.', 'type' => 'string', 'example' => '坐席小王', 'title' => ''], 'Extension' => ['description' => 'The agent\'s extension number.', 'type' => 'string', 'example' => '8032****', 'title' => ''], 'Email' => ['description' => 'The email address.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], 'LoginName' => ['description' => 'The logon name of the agent.', 'type' => 'string', 'example' => 'agent', 'title' => ''], 'WorkMode' => [ 'description' => 'The work mode.', 'enumValueTitles' => ['ON_SITE' => 'On-site mode', 'OFF_SITE' => 'Off-site mode', 'OFFICE_PHONE' => 'Office phone mode'], 'type' => 'string', 'example' => 'ON_SITE', 'title' => '', ], 'Mobile' => ['description' => 'The personal phone number of the agent.', 'type' => 'string', 'example' => '1382114****', 'title' => ''], 'UserId' => ['description' => 'The agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'AvatarUrl' => ['description' => 'The URL of the agent\'s profile picture.', 'type' => 'string', 'example' => 'http://abc.com/sam.jpg', 'title' => ''], 'Nickname' => ['description' => 'The agent\'s nickname.', 'type' => 'string', 'example' => '老王。', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Params' => [ 'description' => 'The response parameters.', 'type' => 'array', 'items' => ['description' => 'The response parameters.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => ''], ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => ''], ], 403 => [ ['errorCode' => 'Permission.StsToken', 'errorMessage' => 'You have no permission to access sts token %s.', 'description' => ''], ], [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.RoleId', 'errorMessage' => 'Role %s does not exist.', 'description' => ''], ], 409 => [ ['errorCode' => 'AlreadyExists.User', 'errorMessage' => 'User %s already exists in instance %s.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Data\\": {\\n \\"DisplayName\\": \\"坐席小王\\",\\n \\"Extension\\": \\"8032****\\",\\n \\"Email\\": \\"username@example.com\\",\\n \\"LoginName\\": \\"agent\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"Mobile\\": \\"1382114****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"AvatarUrl\\": \\"http://abc.com/sam.jpg\\",\\n \\"Nickname\\": \\"老王。\\"\\n },\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', 'title' => 'Create Agent ', 'description' => 'Creating an agent is equivalent to creating a Resource Access Management (RAM) sub-account. Agents in Cloud Contact Center are mapped to RAM sub-accounts. Therefore, the parameters for creating an agent are similar to those for creating a RAM account. For example, LoginName is the logon name for the RAM account. Email is the email address associated with the RAM account. This email address receives an email containing the initial logon password for the RAM account.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-12-22T03:22:03.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-11-07T07:21:07.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2021-12-21T09:15:55.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateUser'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'DeleteAudioFile' => [ 'summary' => 'You can invoke DeleteAudioFile to delete the audio file associated with a specified audio resource ID under a specified instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'AudioResourceId', 'in' => 'query', 'schema' => ['description' => 'Audio resource ID, which is the UUID of the audio file.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'd5cd7a94-3b6a-47d2-b7fd-0b1cd839bf77', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Data' => ['description' => 'Data.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'FB77821C-912F-57FF-8834-6336A6479093', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Delete an audio file', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAudioFile'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"FB77821C-912F-57FF-8834-6336A6479093\\"\\n}","type":"json"}]', ], 'DeleteCallTag' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc1MRAID'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'TagName', 'in' => 'query', 'schema' => ['description' => 'The phone number tag name. Ensure that the tag you specify has already been created.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'TagA', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.DB', 'errorMessage' => 'An internal DB service error occurred. %s', 'description' => ''], ], ], 'title' => 'Delete a phone number tag', 'summary' => 'You can invoke DeleteCallTag to delete a phone number tag under a specified instance.', 'changeSet' => [ ['createdAt' => '2022-02-24T13:00:36.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCallTag'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\"\\n}","type":"json"}]', ], 'DeleteContactFlow' => [ 'summary' => 'Deletes the specified contact flow.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccTPIKHY'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'ContactFlowId', 'in' => 'query', 'schema' => ['description' => 'The ID of the contact flow.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0f87c997-b0c1-41d4-9e9e-1b791de6ad1f', 'title' => ''], ], [ 'name' => 'Force', 'in' => 'query', 'schema' => ['type' => 'boolean', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The message returned for the request.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '07511949-6DC4-5D0B-8FA8-FF8FA29B4217', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Delete Contact Flow', 'changeSet' => [ ['createdAt' => '2025-06-18T03:18:59.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteContactFlow'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"07511949-6DC4-5D0B-8FA8-FF8FA29B4217\\"\\n}","type":"json"}]', ], 'DeleteCustomCallTagging' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc1MRAID'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => ' ccc-test', 'title' => ''], ], [ 'name' => 'Number', 'in' => 'query', 'schema' => ['description' => 'The number associated with the inbound call tag.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1312121****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.DB', 'errorMessage' => 'An internal DB service error occurred. %s', 'description' => ''], ], ], 'title' => 'Delete inbound number tag', 'summary' => 'You can invoke DeleteCustomCallTagging to delete the inbound number tag associated with a specified number under a specified instance.', 'changeSet' => [ ['createdAt' => '2022-02-24T14:31:19.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCustomCallTagging'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\"\\n}","type":"json"}]', ], 'DeleteDocument' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'parameters' => [ [ 'name' => 'SchemaId', 'in' => 'formData', 'schema' => ['description' => 'The schema ID.', 'type' => 'string', 'required' => true, 'example' => 'profile', 'title' => ''], ], [ 'name' => 'DocumentId', 'in' => 'formData', 'schema' => ['description' => 'The document ID.', 'type' => 'string', 'required' => true, 'example' => 'xxx', 'title' => ''], ], [ 'name' => 'RequestId', 'in' => 'formData', 'schema' => ['description' => 'The request ID.', 'type' => 'string', 'required' => false, 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE ', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'd278629c-c687-4aa3-b044-4fe9b012****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'DeleteDocumentResponse', 'title' => 'DeleteDocumentResponse ', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8707EB29-BAED-4302-B999-40BA61877437', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Params' => [ 'description' => 'The response parameters.', 'type' => 'array', 'items' => ['description' => 'The response parameters.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8707EB29-BAED-4302-B999-40BA61877437\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', 'title' => 'Delete document ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'summary' => '', ], 'DeleteDocuments' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'parameters' => [ [ 'name' => 'SchemaId', 'in' => 'formData', 'schema' => ['description' => 'The schema ID.', 'type' => 'string', 'required' => true, 'example' => 'profile', 'title' => ''], ], [ 'name' => 'DocumentIds', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'A list of document IDs.', 'type' => 'array', 'items' => ['description' => 'A document ID.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'RequestId', 'in' => 'formData', 'schema' => ['description' => 'The request ID.', 'type' => 'string', 'required' => false, 'example' => '0630E5DF-CEB0-445B-8626-D5C7481181C3', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'DeleteDocumentsResponse', 'title' => 'DeleteDocumentsResponse', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A450574A-337F-43E2-BC59-9C6594C994C6', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Params' => [ 'description' => 'The parameter information.', 'type' => 'array', 'items' => ['description' => 'The response parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A450574A-337F-43E2-BC59-9C6594C994C6\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', 'title' => 'Delete documents (batch)', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'summary' => '', ], 'DeleteInstance' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '251524', 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Data' => ['description' => 'The ID of the delete task.', 'type' => 'string', 'example' => 'b7feb007-994a-497f-8934-2f0c6f89867c', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], 'Params' => [ 'description' => 'The list of error parameters.', 'type' => 'array', 'items' => ['description' => 'An error parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"b7feb007-994a-497f-8934-2f0c6f89867c\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', 'title' => 'Delete Instance ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'summary' => '', ], 'DeleteSchema' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'parameters' => [ [ 'name' => 'SchemaId', 'in' => 'formData', 'schema' => ['description' => 'The schema ID.', 'type' => 'string', 'required' => true, 'example' => 'profile', 'title' => ''], ], [ 'name' => 'RequestId', 'in' => 'formData', 'schema' => ['description' => 'The request ID.', 'type' => 'string', 'required' => false, 'example' => '0630E5DF-CEB0-445B-8626-D5C7481181C3', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'DeleteSchemaResponse', 'title' => 'DeleteSchemaResponse', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '678F7002-CA01-4ABF-A112-585AFBDF3A3B', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Params' => [ 'description' => 'The response parameters.', 'type' => 'array', 'items' => ['description' => 'The response parameters.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"678F7002-CA01-4ABF-A112-585AFBDF3A3B\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', 'title' => 'Delete schema', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'summary' => '', ], 'DeleteSchemaProperty' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'parameters' => [ [ 'name' => 'SchemaId', 'in' => 'formData', 'schema' => ['description' => 'The schema ID.', 'type' => 'string', 'required' => true, 'example' => 'profile', 'title' => ''], ], [ 'name' => 'PropertyName', 'in' => 'formData', 'schema' => ['description' => 'The field name.', 'type' => 'string', 'required' => true, 'example' => 'name', 'title' => ''], ], [ 'name' => 'RequestId', 'in' => 'formData', 'schema' => ['description' => 'The request ID.', 'type' => 'string', 'required' => false, 'example' => '7BEEA660-A45A-45E3-98CC-AFC65E715C23', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'DeleteSchemaPropertyResponse', 'title' => 'DeleteSchemaPropertyResponse ', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7BEEA660-A45A-45E3-98CC-AFC65E715C23', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'User 244715989906081477 does not exist in instance worldfirst01.', 'title' => ''], 'Params' => [ 'description' => 'The information about error parameters.', 'type' => 'array', 'items' => ['description' => 'The error parameter.', 'type' => 'string', 'example' => 'id格式错误', 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7BEEA660-A45A-45E3-98CC-AFC65E715C23\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"User 244715989906081477 does not exist in instance worldfirst01.\\",\\n \\"Params\\": [\\n \\"id格式错误\\"\\n ]\\n}","type":"json"}]', 'title' => 'Delete schema field ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'summary' => '', ], 'DeleteSkillGroup' => [ 'summary' => 'Invoke DeleteSkillGroup to delete the skill group associated with the specified skill group ID under the specified instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccPBOQGO'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'SkillGroupId', 'in' => 'query', 'schema' => ['description' => 'Skill group ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'skillgroup@ccc-test', 'title' => ''], ], [ 'name' => 'Force', 'in' => 'query', 'schema' => ['description' => 'Whether to force delete. If the skill group is associated with a number or agent, you must enable the force delete flag to successfully delete it.', 'type' => 'boolean', 'required' => false, 'docRequired' => true, 'maximum' => '200', 'minimum' => '1', 'default' => 'false', 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => ''], ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => ''], ['errorCode' => 'InUse.SkillGroup', 'errorMessage' => 'Skill group %s is in use now.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Delete Skill Group', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSkillGroup'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\"\\n}","type":"json"}]', ], 'DeleteTicket' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'TicketId', 'in' => 'query', 'schema' => ['description' => 'The ticket ID.', 'type' => 'string', 'required' => false, 'example' => '3d26b90a-c5d2-4b09-8219-********', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ccc-test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'DeleteTicketResponse', 'title' => 'DeleteTicketResponse', 'type' => 'object', 'properties' => [ 'Data' => ['description' => 'The response data.', 'type' => 'any', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2263B273-AC1B-44EB-BA98-87F2322C6780', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Params' => [ 'description' => 'A list of error parameters.', 'type' => 'array', 'items' => ['description' => 'An error parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"2263B273-AC1B-44EB-BA98-87F2322C6780\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', 'title' => 'Delete ticket', 'summary' => 'Deletes a specified ticket.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'DeleteTicketTemplate' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => ['description' => 'The ID of the ticket template.', 'type' => 'string', 'required' => false, 'example' => '**43c2671b-8939-4223-***-6bd187905cc8_1717664210492', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => false, 'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'DeleteTicketTemplateResponse', 'title' => 'DeleteTicketTemplateResponse', 'type' => 'object', 'properties' => [ 'Data' => ['description' => 'The returned data.', 'type' => 'any', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '01B12EE4-6AF2-4730-8B78-EC15F4E5C025', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Params' => [ 'description' => 'The list of incorrect parameters.', 'type' => 'array', 'items' => ['description' => 'The incorrect parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"01B12EE4-6AF2-4730-8B78-EC15F4E5C025\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', 'title' => 'Delete ticket template', 'summary' => 'Deletes a specified ticket template.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'DisableSchemaProperty' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'parameters' => [ [ 'name' => 'SchemaId', 'in' => 'formData', 'schema' => ['description' => 'Schema ID', 'type' => 'string', 'required' => true, 'example' => 'profile', 'title' => ''], ], [ 'name' => 'PropertyName', 'in' => 'formData', 'schema' => ['description' => 'Field name', 'type' => 'string', 'required' => true, 'example' => 'name', 'title' => ''], ], [ 'name' => 'RequestId', 'in' => 'formData', 'schema' => ['description' => 'Request ID', 'type' => 'string', 'required' => false, 'example' => '2263B273-AC1B-44EB-BA98-87F2322C6780', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['description' => 'Instance ID', 'type' => 'string', 'required' => true, 'example' => 'ef1e71e9-ae9d-487c-96ad-9181d85cf802', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'DisableSchemaPropertyResponse', 'title' => 'DisableSchemaPropertyResponse ', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '9FBA26B0-462B-4D77-B78F-AF35560DBC71', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'Response code', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'Additional information', 'type' => 'string', 'example' => 'User 244715989906081477 does not exist in instance worldfirst01.', 'title' => ''], 'Params' => [ 'description' => 'Parameter information', 'type' => 'array', 'items' => ['description' => 'Response parameter', 'type' => 'string', 'example' => '[\'userId\']', 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9FBA26B0-462B-4D77-B78F-AF35560DBC71\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"User 244715989906081477 does not exist in instance worldfirst01.\\",\\n \\"Params\\": [\\n \\"[\'userId\']\\"\\n ]\\n}","type":"json"}]', 'title' => 'Disable schema field ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'summary' => '', ], 'DisableTicketTemplate' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => ['description' => 'The ticket template ID.', 'type' => 'string', 'required' => false, 'example' => '43c2671b-8939-4223-86d0-6bd187905cc8_1717664210492', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ccc-test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'DisableTicketTemplateResponse', 'title' => 'DisableTicketTemplateResponse', 'type' => 'object', 'properties' => [ 'Data' => ['description' => 'The returned data.', 'type' => 'any', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '943D8EF3-3321-471F-A104-51C96FCA94D6', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Params' => [ 'description' => 'The list of incorrect parameters.', 'type' => 'array', 'items' => ['description' => 'The incorrect parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"943D8EF3-3321-471F-A104-51C96FCA94D6\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', 'title' => 'Unpublish Ticket Template', 'summary' => 'Use the DisableTicketTemplate operation to disable a ticket template. A disabled template cannot be selected when you create a new ticket.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'DiscardEditingContactFlow' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'ContactFlowId', 'in' => 'query', 'schema' => ['description' => 'Contact flow ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '3ff4e021-fd63-4572-ad8c-10ed69972965', 'title' => ''], ], [ 'name' => 'DraftId', 'in' => 'query', 'schema' => ['description' => 'Draft ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0aa493d6-58eb-4290-9ba2-e1c2c615b46b', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'CB72B537-B531-598F-9617-A636FB8040C0', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"CB72B537-B531-598F-9617-A636FB8040C0\\"\\n}","type":"json"}]', 'title' => 'Revoke Contact Flow Editing', 'summary' => 'Revoke contact flow editing and discard the associated draft.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DiscardEditingContactFlow'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'EnableSchemaProperty' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'parameters' => [ [ 'name' => 'SchemaId', 'in' => 'formData', 'schema' => ['description' => 'schema id', 'type' => 'string', 'required' => true, 'example' => 'profile', 'title' => ''], ], [ 'name' => 'PropertyName', 'in' => 'formData', 'schema' => ['description' => 'Field name', 'type' => 'string', 'required' => true, 'example' => 'name', 'title' => ''], ], [ 'name' => 'RequestId', 'in' => 'formData', 'schema' => ['description' => 'Request ID', 'type' => 'string', 'required' => false, 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'EnableSchemaPropertyResponse', 'title' => 'EnableSchemaPropertyResponse ', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '2778FA12-EDD6-42AA-9B15-AF855072E5E5', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'Response code', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'Response message', 'type' => 'string', 'example' => 'The operation is not allowed. User state (READY) does not meet expectations (OFFLINE).', 'title' => ''], 'Params' => [ 'description' => 'Response parameters.', 'type' => 'array', 'items' => ['description' => 'Response parameters.', 'type' => 'string', 'example' => '[\'wudi@zcwlwhkf\']', 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2778FA12-EDD6-42AA-9B15-AF855072E5E5\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"The operation is not allowed. User state (READY) does not meet expectations (OFFLINE).\\",\\n \\"Params\\": [\\n \\"[\'wudi@zcwlwhkf\']\\"\\n ]\\n}","type":"json"}]', 'title' => 'Enable a schema field ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'summary' => '', ], 'EnableTicketTemplate' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => ['description' => 'The ID of the ticket template.', 'type' => 'string', 'required' => false, 'example' => '43c2671b-8939-4223-86d0-6bd187905cc8_1717664210492', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ccc-test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'EnableTicketTemplateResponse', 'title' => 'EnableTicketTemplateResponse', 'type' => 'object', 'properties' => [ 'Data' => ['description' => 'The returned data.', 'type' => 'any', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Params' => [ 'description' => 'The list of incorrect parameters.', 'type' => 'array', 'items' => ['description' => 'The incorrect parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', 'title' => 'Publish Ticket Template', 'summary' => 'The EnableTicketTemplate operation publishes a ticket template. Published ticket templates can be used to create tickets.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'EndConference' => [ 'summary' => 'You can invoke EndConference to make the specified agent exit the call associated with the specified call ID under the specified instance. The call must be in a conference state.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'Agent ID to leave the meeting. Optional. If not specified, defaults to the agent mapped to the current RAM account.', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test', 'title' => ''], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'Call ID.', 'type' => 'string', 'required' => true, 'example' => 'job-6538214103685****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '0630E5DF-CEB0-445B-8626-D5C7481181C3', 'title' => ''], 'Params' => [ 'description' => 'List of response parameters.', 'type' => 'array', 'items' => ['description' => 'Response parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'CallContext' => [ 'description' => 'Call context environment.', 'type' => 'object', 'properties' => [ 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'ChannelContexts' => [ 'description' => 'List of call channels.', 'type' => 'array', 'items' => [ 'description' => 'Call channel.', 'type' => 'object', 'properties' => [ 'ReleaseInitiator' => ['description' => 'The party that initiated the hang-up of the voice channel.', 'type' => 'string', 'example' => '1390501****', 'title' => ''], 'ChannelState' => [ 'description' => 'The status of the voice channel.', 'enumValueTitles' => ['CREATED' => 'Created', 'ANSWERED' => 'Answered', 'RELEASED' => 'Released', 'RETIRED' => 'Out Of Effect', 'EARLY_MEDIA' => 'Early Media', 'NONE' => 'Initial Status', 'RINGING' => 'Ringing'], 'type' => 'string', 'example' => 'CREATED', 'title' => '', ], 'Destination' => ['description' => 'The called party of the call channel.', 'type' => 'string', 'example' => '8001****', 'title' => ''], 'UserId' => ['description' => 'The agent ID associated with the voice channel. This field is empty for customer voice channels.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'Timestamp' => ['description' => 'The UNIX timestamp of the most recent status change of the channel, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315', 'title' => ''], 'ReleaseReason' => ['description' => 'The hang-up reason for the voice channel, indicating why the current voice channel was disconnected. The value comes from the response codes defined in the SIP protocol. Customers can refer to the SIP protocol to analyze the hang-up reason.', 'type' => 'string', 'example' => '404 - No destination', 'title' => ''], 'CallType' => [ 'description' => 'The call type of the channel.', 'enumValueTitles' => [ 'INBOUND' => 'Inbound', 'BARGE' => 'Barge-in', 'CONSULTANT' => 'Consultation', 'CONFERENCE' => 'Conference', 'MONITOR' => 'listener', 'INTERNAL' => 'internal call', 'OUTBOUND' => 'outbound', 'INTERCEPT' => 'forced disconnect', 'BACK2BACK' => 'double call', 'PREDICTIVE' => 'predictive outbound', 'COACH' => 'coaching', ], 'type' => 'string', 'example' => 'OUTBOUND', 'title' => '', ], 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'ChannelId' => ['description' => 'The channel ID.', 'type' => 'string', 'example' => 'ch:user:131888****->8001****:1609225718294:job-65700074013925376', 'title' => ''], 'Originator' => ['description' => 'The calling party of the voice channel.', 'type' => 'string', 'example' => '0830019****', 'title' => ''], 'UserExtension' => ['description' => 'The extension number of the agent associated with the channel.', 'type' => 'string', 'example' => '8032****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'UserContext' => [ 'description' => 'Agent context environment.', 'type' => 'object', 'properties' => [ 'Extension' => ['description' => 'Agent extension number.', 'type' => 'string', 'example' => '8032****', 'title' => ''], 'DeviceState' => [ 'description' => 'The status of the SIP phone device. If the SIP phone is not registered, the status is UNREGISTERED (unregistered). If the SIP phone is registered but offline, the status is OFFLINE (offline). If the SIP phone is registered and online, the status is ONLINE (online).', 'enumValueTitles' => ['UNREGISTERED' => 'Unregistered', 'OFFLINE' => 'Offline', 'ONLINE' => 'Online'], 'type' => 'string', 'example' => 'UNREGISTERED', 'title' => '', ], 'WorkMode' => [ 'description' => 'Work mode.', 'enumValueTitles' => ['ON_SITE' => 'On-site mode', 'OFF_SITE' => 'Off-site mode', 'OFFICE_PHONE' => 'Office phone mode'], 'type' => 'string', 'example' => 'ON_SITE', 'title' => '', ], 'DeviceId' => ['description' => 'Device ID, which is the identity ID of a browser-based Web Real-Time Communication (WebRTC) softphone or a physical phone device. Only one type of device can be registered at a time.', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****', 'title' => ''], 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'UserId' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'BreakCode' => [ 'description' => 'Break code, which can be either System-defined or Custom-defined. System-defined break codes include: Warm-up (temporary break state after agent is published and before becoming idle), RingingTimeout (break caused by agent ringing timeout), and RejectCall (break caused by agent call rejection). There are no restrictions on Custom-defined break codes; Customers can define them as needed for their business.', 'enumValueTitles' => ['RingingTimeout' => 'Break caused by agent ringing timeout', 'RejectCall' => 'Break caused by agent call rejection', 'Warm-up' => 'Temporary break state after agent is published and before becoming idle'], 'type' => 'string', 'example' => 'Warm-up', 'title' => '', ], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'OutboundScenario' => ['description' => 'Indicates whether the agent is in outbound-only mode.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'UserState' => [ 'description' => 'Agent status.', 'enumValueTitles' => ['READY' => 'Idle', 'WORKING' => 'In post-processing', 'DIALING' => 'Dialing', 'BREAK' => 'Break', 'OFFLINE' => 'Offline', 'TALKING' => 'Talking', 'RINGING' => 'Ringing'], 'type' => 'string', 'example' => 'TALKING', 'title' => '', ], 'SignedSkillGroupIdList' => [ 'description' => 'List of skill group IDs that the agent has signed into.', 'type' => 'array', 'items' => ['description' => 'Skill group ID.', 'type' => 'string', 'example' => 'skillgroup1@ccc-test', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'ContextId' => ['description' => 'System auto-increment ID. Customers do not need to be concerned about this.', 'type' => 'integer', 'format' => 'int64', 'example' => '103655', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Leave Meeting', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EndConference'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"0630E5DF-CEB0-445B-8626-D5C7481181C3\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"CREATED\\",\\n \\"Destination\\": \\"8001****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:131888****->8001****:1609225718294:job-65700074013925376\\",\\n \\"Originator\\": \\"0830019****\\",\\n \\"UserExtension\\": \\"8032****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"DeviceState\\": \\"UNREGISTERED\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n },\\n \\"ContextId\\": 103655\\n }\\n}","type":"json"}]', ], 'ExportContactFlow' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '251084', 'abilityTreeNodes' => ['FEATUREcccTPIKHY'], ], 'parameters' => [ [ 'name' => 'FlowId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the IVR contact flow.', 'type' => 'string', 'required' => true, 'example' => 'lc-uf61xdtm0mf73k', 'title' => ''], ], [ 'name' => 'RequestId', 'in' => 'formData', 'schema' => ['description' => 'The request ID.', 'type' => 'string', 'required' => false, 'example' => 'AF9834D8-6D09-4A1B-BADB-B019D9D444C8', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb3xxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'ExportFlowResponse', 'title' => 'ExportFlowResponse', 'type' => 'object', 'properties' => [ 'FlowPackageData' => ['description' => 'The data.', 'type' => 'string', 'example' => '{}', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE ', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Params' => [ 'description' => 'The response parameters.', 'type' => 'array', 'items' => ['description' => 'Invalid parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"FlowPackageData\\": \\"{}\\",\\n \\"RequestId\\": \\"DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\\\t\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', 'title' => 'Export IVR flow', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'summary' => '', ], 'ExportCustomCallTagging' => [ 'summary' => 'You can invoke ExportCustomCallTagging to export all inbound number tags under a specified instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => true, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc1MRAID'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Data' => ['description' => 'Data. The download link to the OSS object containing the export result. The link has a validity period of 24 hours.', 'type' => 'string', 'example' => 'http://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-test/tagging.xlsx ?Expires=1610910578&OSSAccessKeyId=****&Signature=****', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F
', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => ''], ['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => ''], ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'staticInfo' => [ 'substitutions' => ['CCC::2020-07-01::ExportCustomCallTaggings'], ], 'title' => 'Export Inbound Number Tags', 'changeSet' => [ ['createdAt' => '2022-02-24T13:00:36.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExportCustomCallTagging'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"http://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-test/tagging.xlsx ?Expires=1610910578&OSSAccessKeyId=****&Signature=****\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F
\\"\\n}","type":"json"}]', ], 'ExportDoNotCallNumbers' => [ 'summary' => 'The ExportDoNotCallNumbers operation exports a filtered list of do-not-call numbers from a specified instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc1MRAID'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'SearchPattern', 'in' => 'query', 'schema' => ['description' => 'The keyword for a fuzzy search of phone numbers or remarks. If this parameter is left empty, no keyword-based filtering is applied.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'RemarkA', 'title' => ''], ], [ 'name' => 'Scope', 'in' => 'query', 'schema' => [ 'description' => 'Specifies the scope of the do-not-call numbers. A value of SYSTEM applies to your entire Alibaba Cloud account, while INSTANCE applies only to the current instance. The default value is INSTANCE.', 'enumValueTitles' => ['SYSTEM' => 'The system-level do-not-call configuration.', 'INSTANCE' => 'The instance-level do-not-call configuration.'], 'type' => 'string', 'required' => false, 'example' => 'INSTANCE', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Data' => ['description' => 'The OSS download link for the exported file. The link is valid for 24 hours.', 'type' => 'string', 'example' => 'https://****.oss-cn-shanghai.aliyuncs.com/ccc-test/blacklist.xlsx?Expires=3294624578&OSSAccessKeyId=****&Signature=****', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', 'title' => ''], 'Params' => [ 'description' => 'The response parameters.', 'type' => 'array', 'items' => ['description' => 'A response parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => ''], ['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => ''], ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Export Do-Not-Call Numbers', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-11-06T05:44:50.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-02-24T13:00:36.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExportDoNotCallNumbers'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"https://****.oss-cn-shanghai.aliyuncs.com/ccc-test/blacklist.xlsx?Expires=3294624578&OSSAccessKeyId=****&Signature=****\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', ], 'FinishTicketTask' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'TicketId', 'in' => 'query', 'schema' => ['description' => 'Ticket ID.', 'type' => 'string', 'required' => false, 'example' => 'f2c6722b-cd13-442d-bf10-22a07c70d6d5', 'title' => ''], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => ['description' => 'Node ID.', 'type' => 'string', 'required' => false, 'example' => 'b52a34dc-f514-4600-9c39-3cf657167c97', 'title' => ''], ], [ 'name' => 'Comment', 'in' => 'query', 'schema' => ['description' => 'Processing comments.', 'type' => 'string', 'required' => true, 'example' => '同意', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ccc-test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'FinishTicketTaskResponse', 'title' => 'FinishTicketTaskResponse', 'type' => 'object', 'properties' => [ 'Data' => ['description' => 'Data.', 'type' => 'any', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '7BEEA660-A45A-45E3-98CC-AFC65E715C23', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Params' => [ 'description' => 'List of error parameters.', 'type' => 'array', 'items' => ['description' => 'Error parameter', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"7BEEA660-A45A-45E3-98CC-AFC65E715C23\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', 'title' => 'Ticket Processing', 'summary' => 'Use the FinishTicketTask operation to process tickets.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'GetAudioFile' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccKYIENB'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'AudioResourceId', 'in' => 'query', 'schema' => ['description' => 'Audio resource ID, the UUID of the audio file.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'c1a06b46-302a-4c6e-928b-a43c0df485cf', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EEE26562-D921-5CB2-AE49-E4C45A42D432', 'title' => ''], 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Data' => [ 'description' => 'Audio file data.', 'type' => 'object', 'properties' => [ 'AudioFileName' => ['description' => 'Audio file name.', 'type' => 'string', 'example' => 'test-file.wav', 'title' => ''], 'OssFileKey' => ['description' => 'Key of the audio resource file in OSS.', 'type' => 'string', 'example' => 'ccc-test/test-file.wav', 'title' => ''], 'UpdatedTime' => ['description' => 'Last Updated At of the audio resource.', 'type' => 'string', 'example' => '2021-07-14 10:48:43.0', 'title' => ''], 'AudioResourceId' => ['description' => 'Audio resource ID, the UUID of the audio file.', 'type' => 'string', 'example' => 'c1a06b46-302a-4c6e-928b-a43c0df485cf', 'title' => ''], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'Name' => ['description' => 'Display name of the audio.', 'type' => 'string', 'example' => '欢迎语'."\n", 'title' => ''], 'CreatedTime' => ['description' => 'Creation Time of the audio resource.', 'type' => 'string', 'example' => '2021-07-14 10:48:43.0', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Get Audio File', 'summary' => 'Invoke GetAudioFile to obtain the audio file information corresponding to a specified audio resource ID under a specified instance.', 'changeSet' => [ ['createdAt' => '2022-06-30T02:20:46.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAudioFile'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"EEE26562-D921-5CB2-AE49-E4C45A42D432\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"AudioFileName\\": \\"test-file.wav\\",\\n \\"OssFileKey\\": \\"ccc-test/test-file.wav\\",\\n \\"UpdatedTime\\": \\"2021-07-14 10:48:43.0\\",\\n \\"AudioResourceId\\": \\"c1a06b46-302a-4c6e-928b-a43c0df485cf\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Name\\": \\"欢迎语\\\\n\\",\\n \\"CreatedTime\\": \\"2021-07-14 10:48:43.0\\"\\n }\\n}","type":"json"}]', ], 'GetAudioFileDownloadUrl' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'AudioResourceId', 'in' => 'query', 'schema' => ['description' => 'Audio resource ID, which uniquely identifies an audio file.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'acc300c4-75c9-41ba-ba5e-2a365c96c248', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Data' => ['description' => 'Data. The OSS download link for the audio resource file. Note that the validity period of the download link is 24 hours. Do not store this link permanently.', 'type' => 'string', 'example' => 'https://****.oss-cn-shanghai.aliyuncs.com/ccc-test/****.wav?Expires=1656472158&OSSAccessKeyId=****&Signature=****', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '943D8EF3-3321-471F-A104-51C96FCA94D6', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"https://****.oss-cn-shanghai.aliyuncs.com/ccc-test/****.wav?Expires=1656472158&OSSAccessKeyId=****&Signature=****\\",\\n \\"RequestId\\": \\"943D8EF3-3321-471F-A104-51C96FCA94D6\\"\\n}","type":"json"}]', 'title' => 'Obtain Audio File Download Link', 'summary' => 'Invoke GetAudioFileDownloadUrl to obtain the OSS download link for a specified audio resource under a specified instance.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAudioFileDownloadUrl'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'GetAudioFileUploadParameters' => [ 'summary' => 'Invoke the GetAudioFileUploadParameters API to obtain audio file upload parameters. Before creating an audio file, you must first call this API to retrieve the upload parameters and then call CreateAudioFile to create the audio file. This API is typically invoked by the default public cloud CRM system provided by Cloud Contact Center. It is not recommended for integration customers to call this API directly, because file upload must be performed through a Page operation first; only after the upload is complete can the GetAudioFileUploadParameters API be called.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccKYIENB'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'AudioFileName', 'in' => 'query', 'schema' => ['description' => 'Audio file name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-file.wav', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'C81FD1A5-4B99-470A-A527-D80150228784', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'FilePath' => ['description' => 'Key of the OSS file.', 'type' => 'string', 'example' => 'ccc-test/test-file.wav', 'title' => ''], 'Signature' => ['description' => 'Signature information of the temporary credential for file upload, used to authenticate the upload request.', 'type' => 'string', 'example' => 'HIyClras8IcVlbTV7RIJWJbU****', 'title' => ''], 'Host' => ['description' => 'Endpoint domain name of OSS.', 'type' => 'string', 'example' => 'https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com', 'title' => ''], 'Policy' => ['description' => 'Signature policy.', 'type' => 'string', 'example' => 'eyJleHBpcmF0aW9uIjoiMjAyMi0wNi0yOVQwMDoyOTowMC42NTRaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjBdLFsic3RhcnRzLXdpdGgiLCIka2V5IiwiYXVkaW8vMTU3NzI0NzExNTQ5MDQwMS9seS1vbmxpbmUvMjAyMjA2MjkwNzI5MDAvIl1d****', 'title' => ''], 'ExpireTime' => ['description' => 'Expiration time.', 'type' => 'integer', 'format' => 'int32', 'example' => '1647313420', 'title' => ''], 'AccessKeyId' => ['description' => 'AccessKey ID used for signing.', 'type' => 'string', 'example' => '****', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Obtain Audio File Upload Parameters', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAudioFileUploadParameters'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"C81FD1A5-4B99-470A-A527-D80150228784\\",\\n \\"Data\\": {\\n \\"FilePath\\": \\"ccc-test/test-file.wav\\",\\n \\"Signature\\": \\"HIyClras8IcVlbTV7RIJWJbU****\\",\\n \\"Host\\": \\"https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com\\",\\n \\"Policy\\": \\"eyJleHBpcmF0aW9uIjoiMjAyMi0wNi0yOVQwMDoyOTowMC42NTRaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjBdLFsic3RhcnRzLXdpdGgiLCIka2V5IiwiYXVkaW8vMTU3NzI0NzExNTQ5MDQwMS9seS1vbmxpbmUvMjAyMjA2MjkwNzI5MDAvIl1d****\\",\\n \\"ExpireTime\\": 1647313420,\\n \\"AccessKeyId\\": \\"****\\"\\n }\\n}","type":"json"}]', ], 'GetCallDetailRecord' => [ 'summary' => 'You can invoke the GetCallDetailRecord operation to retrieve call details for a specific call ID within a specific instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc5HY0NN'], ], 'parameters' => [ [ 'name' => 'ContactId', 'in' => 'query', 'schema' => ['description' => 'The call ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-10963442671187****', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7BEEA660-A45A-45E3-98CC-AFC65E715C23', 'title' => ''], 'Data' => [ 'description' => 'The data.', 'type' => 'object', 'properties' => [ 'ReleaseInitiator' => [ 'description' => 'The release initiator.', 'enumValueTitles' => ['agent ' => 'Agent', 'customer ' => 'Customer'], 'type' => 'string', 'example' => 'customer', 'title' => '', ], 'ContactDisposition' => [ 'description' => 'The reason why the call ended. Note: The \\`Voicemail\\`, \\`QueuingFailed\\`, \\`QueuingTimeout\\`, \\`QueuingOverflow\\`, and \\`IVRException\\` reasons are returned only if you configure the hang-up reason node. If you do not configure this node and the IVR flow does not include a module to transfer the call to an agent, the default reason is \\`AbandonedInIVR\\`.', 'enumValueTitles' => [ 'AbandonedInQueue' => 'Abandoned in queue', 'NoAnswer' => 'Customer did not answer', 'QueuingTimeout' => 'Queue timeout', 'Voicemail' => 'Transferred to voicemail', 'QueuingFailed' => 'Failed to transfer to agent', 'QueuingOverflow' => 'Queue overflow', 'AbandonedInVoiceNavigator' => 'Abandoned in intelligent navigation', 'Success' => 'Normal end', 'IVRException' => 'IVR system exception', 'AbandonedInRing' => 'Abandoned during ringing', 'AbandonedInIVR' => 'IVR abandonment', 'Reject' => 'Customer rejected', 'ForwardToOutsideNumber' => 'Transferred to outside line', ], 'type' => 'string', 'example' => 'Success', 'title' => '', ], 'ContactType' => [ 'description' => 'The call type.', 'enumValueTitles' => ['INBOUND' => 'Inbound call', 'CONFERENCE' => 'Conference', 'INTERNAL' => 'Internal call', 'PRIVACY_DIAL' => 'Encrypted call', 'OUTBOUND' => 'Outbound call', 'BACK2BACK' => 'Two-way call', 'PREDICTIVE' => 'Predictive outbound call'], 'type' => 'string', 'example' => 'OUTBOUND', 'title' => '', ], 'AgentIds' => ['description' => 'The IDs of the agents who are involved in the call. Multiple IDs are separated by commas.', 'type' => 'string', 'example' => 'agent1@ccc-test,agent2@ccc-test', 'title' => ''], 'CallDuration' => ['description' => 'The call duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '50', 'title' => ''], 'RecordingReady' => ['description' => 'Indicates whether the recording was generated. A value of \\`false\\` is returned if the call was not connected.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'EstablishedTime' => ['description' => 'The time when the call was connected. This parameter is empty if the call was not connected. The value is a UNIX timestamp, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1532458000000', 'title' => ''], 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'SatisfactionSurveyOffered' => ['description' => 'Indicates whether a satisfaction survey was initiated.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'CalledNumber' => ['description' => 'The called number.', 'type' => 'string', 'example' => '1332315****', 'title' => ''], 'AgentNames' => ['description' => 'The names of the agents who are involved in the call. Multiple names are separated by commas.', 'type' => 'string', 'example' => 'agent1,agent2', 'title' => ''], 'Satisfaction' => ['description' => 'The satisfaction score. The value and its meaning are defined by you.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'StartTime' => ['description' => 'The time when the call started. For an inbound call, this is the time when the call enters the IVR. For an outbound call, this is the time when the call is initiated. The value is a UNIX timestamp, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1532458000000', 'title' => ''], 'ContactId' => ['description' => 'The call ID.', 'type' => 'string', 'example' => 'job-10963442671187****', 'title' => ''], 'SatisfactionSurveyChannel' => [ 'description' => 'The channel through which the satisfaction survey was initiated.', 'enumValueTitles' => ['IVR' => 'Voice satisfaction', 'SMS' => 'Text message satisfaction'], 'type' => 'string', 'example' => 'IVR', 'title' => '', ], 'ReleaseTime' => ['description' => 'The time when the call ended. This is the time when the last party of the call hangs up. The value is a UNIX timestamp, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1532458000000', 'title' => ''], 'CallingNumber' => ['description' => 'The calling number.', 'type' => 'string', 'example' => '0533128****', 'title' => ''], 'SkillGroupNames' => ['description' => 'The names of the skill groups to which the agents involved in the call belong. Multiple names are separated by commas.', 'type' => 'string', 'example' => '测试技能组', 'title' => ''], 'SkillGroupIds' => ['description' => 'The IDs of the skill groups to which the agents involved in the call belong. Multiple IDs are separated by commas.', 'type' => 'string', 'example' => 'skillgroup@ccc-test', 'title' => ''], 'AgentEvents' => [ 'description' => 'The list of agent events.', 'type' => 'array', 'items' => [ 'description' => 'The agent event.', 'type' => 'object', 'properties' => [ 'AgentName' => ['description' => 'The agent name.', 'type' => 'string', 'example' => '坐席小王', 'title' => ''], 'AgentId' => ['description' => 'The agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'SkillGroupId' => ['description' => 'The skill group ID.', 'type' => 'string', 'example' => 'skillgroup@ccc-test', 'title' => ''], 'EventSequence' => [ 'description' => 'The sequence of events.', 'type' => 'array', 'items' => [ 'description' => 'The event.', 'type' => 'object', 'properties' => [ 'Event' => [ 'description' => 'The event type.', 'enumValueTitles' => [ 'Released' => 'Hang up', 'BlindTransfer' => 'Blind transfer', 'Coaching' => 'Coaching', 'Barging' => 'Barge-in', 'Consulting' => 'Consultative transfer', 'Ringing' => 'Ringing', 'StartConference' => 'Start conference', 'Established' => 'Call established', 'Dialing' => 'Dialing', 'Intercepting' => 'Intercept', 'Monitoring' => 'Monitoring', ], 'type' => 'string', 'example' => 'Dialing', 'title' => '', ], 'EventTime' => ['description' => 'The time when the event occurred. The value is a UNIX timestamp, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1604639129000', 'title' => ''], 'Duration' => ['description' => 'The event duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'IvrEvents' => [ 'description' => 'The list of IVR events.', 'type' => 'array', 'items' => [ 'description' => 'The IVR event.', 'type' => 'object', 'properties' => [ 'FlowId' => ['description' => 'The ID of the IVR contact flow.', 'type' => 'string', 'example' => 'edaf2eaa-8f88-44ca-812e-41b3cd2b7a90', 'title' => ''], 'EventSequence' => [ 'description' => 'The sequence of events.', 'type' => 'array', 'items' => [ 'description' => 'The event.', 'type' => 'object', 'properties' => [ 'Event' => [ 'description' => 'The event type.', 'enumValueTitles' => ['Route2IVR' => 'Enter IVR', 'Abandoned' => 'Abandoned in IVR'], 'type' => 'string', 'example' => 'Route2IVR', 'title' => '', ], 'EventTime' => ['description' => 'The time when the event occurred. The value is a UNIX timestamp, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1604639129000', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'FlowType' => [ 'description' => 'The type of the contact flow.', 'enumValueTitles' => ['SURVEY_FLOW' => 'Satisfaction flow', 'MAIN_FLOW' => 'Main flow'], 'type' => 'string', 'example' => 'MAIN_FLOW', 'title' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'QueueEvents' => [ 'description' => 'The list of queue events.', 'type' => 'array', 'items' => [ 'description' => 'The queue event.', 'type' => 'object', 'properties' => [ 'QueueId' => ['description' => 'The queue ID. If the call is routed to a skill group, this is the skill group ID. If the call is routed to an agent, this is the agent ID.', 'type' => 'string', 'example' => 'skillgroup@ccc-test', 'title' => ''], 'QueueName' => ['description' => 'The queue name.', 'type' => 'string', 'example' => '测试技能组', 'title' => ''], 'FlowId' => ['description' => 'The contact flow ID.', 'type' => 'string', 'example' => 'edaf2eaa-8f88-44ca-812e-41b3cd2b7a90', 'title' => ''], 'QueueType' => [ 'description' => 'The queue type.', 'enumValueTitles' => [1 => 'Skill group', 'Agent'], 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => '', ], 'EventSequence' => [ 'description' => 'The sequence of events.', 'type' => 'array', 'items' => [ 'description' => 'The event.', 'type' => 'object', 'properties' => [ 'Event' => [ 'description' => 'The event type.', 'enumValueTitles' => ['AssignAgent' => 'Assign agent', 'GiveUp' => 'Abandoned during ringing', 'Enqueue' => 'Enter queue', 'QueueingOverflow' => 'Queue overflow', 'Abandoned' => 'Queue abandonment', 'QueueingTimeout' => 'Queue timeout'], 'type' => 'string', 'example' => 'Enqueue', 'title' => '', ], 'EventTime' => ['description' => 'The time when the event occurred. The value is a UNIX timestamp, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1604639129000', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'CustomerEvents' => [ 'description' => 'The list of customer events.', 'type' => 'array', 'items' => [ 'description' => 'The customer event.', 'type' => 'object', 'properties' => [ 'CustomerId' => ['description' => 'The customer ID. This is usually the customer\'s phone number.', 'type' => 'string', 'example' => '1332315****', 'title' => ''], 'EventSequence' => [ 'description' => 'The sequence of events.', 'type' => 'array', 'items' => [ 'description' => 'The event.', 'type' => 'object', 'properties' => [ 'Event' => [ 'description' => 'The event type.', 'enumValueTitles' => ['established' => 'Call established', 'ringing' => 'Ringing', 'released' => 'Hang up'], 'type' => 'string', 'example' => 'Released', 'title' => '', ], 'EventTime' => ['description' => 'The time when the event occurred. The value is a UNIX timestamp, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1532458000000', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'CallerLocation' => ['description' => 'The location of the calling number.', 'type' => 'string', 'example' => ' 山东省-淄博', 'title' => ''], 'CalleeLocation' => ['description' => 'The location of the called number.', 'type' => 'string', 'example' => '河北省-唐山', 'title' => ''], 'EarlyMediaState' => [ 'description' => 'The state of the early media. An exception occurred during the early media phase, which is when the customer is being called. An exception at this stage can cause the call to fail. This parameter provides possible reasons for the connection failure based on an analysis of the early media state.', 'enumValueTitles' => ['NoAnswer' => 'No answer', 'OutOfService' => 'Out of service', 'NotExist' => 'Nonexistent number', 'Restricted' => 'Call restricted', 'Busy' => 'Busy', 'NotConnected' => 'Unable to connect', 'PowerOff' => 'Powered off'], 'type' => 'string', 'example' => 'NotConnected', 'title' => '', ], 'ReleaseReason' => ['description' => 'The reason why the call ended. The value is usually the SIP code followed by a text description.', 'type' => 'string', 'example' => '200 - OK', 'title' => ''], 'AnalyticsReportReady' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], 'AnalyticsReport' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'ProblemSolving' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'TaskId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], 'Solved' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], 'Problem' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Solution' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], 'Emotion' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'TaskId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], 'Type' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Confidence' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], 'Remark' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], 'Satisfaction' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'TaskId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], 'SatisfactionDescription' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Remark' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], 'TodoList' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'TaskId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], 'Tasks' => [ 'description' => '', 'type' => 'array', 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'OutsideNumberReleaseReason' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"7BEEA660-A45A-45E3-98CC-AFC65E715C23\\",\\n \\"Data\\": {\\n \\"ReleaseInitiator\\": \\"customer\\",\\n \\"ContactDisposition\\": \\"Success\\",\\n \\"ContactType\\": \\"OUTBOUND\\",\\n \\"AgentIds\\": \\"agent1@ccc-test,agent2@ccc-test\\",\\n \\"CallDuration\\": 50,\\n \\"RecordingReady\\": true,\\n \\"EstablishedTime\\": 1532458000000,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"SatisfactionSurveyOffered\\": true,\\n \\"CalledNumber\\": \\"1332315****\\",\\n \\"AgentNames\\": \\"agent1,agent2\\",\\n \\"Satisfaction\\": 1,\\n \\"StartTime\\": 1532458000000,\\n \\"ContactId\\": \\"job-10963442671187****\\",\\n \\"SatisfactionSurveyChannel\\": \\"IVR\\",\\n \\"ReleaseTime\\": 1532458000000,\\n \\"CallingNumber\\": \\"0533128****\\",\\n \\"SkillGroupNames\\": \\"测试技能组\\",\\n \\"SkillGroupIds\\": \\"skillgroup@ccc-test\\",\\n \\"AgentEvents\\": [\\n {\\n \\"AgentName\\": \\"坐席小王\\",\\n \\"AgentId\\": \\"agent@ccc-test\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"EventSequence\\": [\\n {\\n \\"Event\\": \\"Dialing\\",\\n \\"EventTime\\": 1604639129000,\\n \\"Duration\\": 3\\n }\\n ]\\n }\\n ],\\n \\"IvrEvents\\": [\\n {\\n \\"FlowId\\": \\"edaf2eaa-8f88-44ca-812e-41b3cd2b7a90\\",\\n \\"EventSequence\\": [\\n {\\n \\"Event\\": \\"Route2IVR\\",\\n \\"EventTime\\": 1604639129000\\n }\\n ],\\n \\"FlowType\\": \\"MAIN_FLOW\\"\\n }\\n ],\\n \\"QueueEvents\\": [\\n {\\n \\"QueueId\\": \\"skillgroup@ccc-test\\",\\n \\"QueueName\\": \\"测试技能组\\",\\n \\"FlowId\\": \\"edaf2eaa-8f88-44ca-812e-41b3cd2b7a90\\",\\n \\"QueueType\\": 1,\\n \\"EventSequence\\": [\\n {\\n \\"Event\\": \\"Enqueue\\",\\n \\"EventTime\\": 1604639129000\\n }\\n ]\\n }\\n ],\\n \\"CustomerEvents\\": [\\n {\\n \\"CustomerId\\": \\"1332315****\\",\\n \\"EventSequence\\": [\\n {\\n \\"Event\\": \\"Released\\",\\n \\"EventTime\\": 1532458000000\\n }\\n ]\\n }\\n ],\\n \\"CallerLocation\\": \\" 山东省-淄博\\",\\n \\"CalleeLocation\\": \\"河北省-唐山\\",\\n \\"EarlyMediaState\\": \\"NotConnected\\",\\n \\"ReleaseReason\\": \\"200 - OK\\",\\n \\"AnalyticsReportReady\\": false,\\n \\"AnalyticsReport\\": {\\n \\"ProblemSolving\\": {\\n \\"TaskId\\": \\"\\",\\n \\"Success\\": false,\\n \\"Solved\\": false,\\n \\"Problem\\": \\"\\",\\n \\"Solution\\": \\"\\"\\n },\\n \\"Emotion\\": {\\n \\"TaskId\\": \\"\\",\\n \\"Success\\": false,\\n \\"Type\\": \\"\\",\\n \\"Confidence\\": 0,\\n \\"Remark\\": \\"\\"\\n },\\n \\"Satisfaction\\": {\\n \\"TaskId\\": \\"\\",\\n \\"Success\\": false,\\n \\"SatisfactionDescription\\": \\"\\",\\n \\"Remark\\": \\"\\"\\n },\\n \\"TodoList\\": {\\n \\"TaskId\\": \\"\\",\\n \\"Success\\": false,\\n \\"Tasks\\": [\\n \\"\\"\\n ]\\n }\\n },\\n \\"OutsideNumberReleaseReason\\": \\"\\"\\n }\\n}","type":"json"}]', 'title' => 'Obtain call details', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2025-06-12T11:54:29.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-10-14T06:47:33.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-03-03T08:33:16.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-02-23T06:53:06.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2021-09-08T02:42:38.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCallDetailRecord'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'GetCampaign' => [ 'summary' => 'Gets a predictive outbound campaign by its ID from a specified instance.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccQFUGXR'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'CampaignId', 'in' => 'query', 'schema' => ['description' => 'The ID of the campaign.', 'type' => 'string', 'required' => true, 'example' => '6badb397-a8b5-40b6-21019d382a09', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6CCEF32F-8614-535F-A1D9-D85B8C0DC4F0', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Data' => [ 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'ActualEndTime' => ['description' => 'The actual end time of the predictive outbound campaign. This is a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1634008800000', 'title' => ''], 'ActualStartTime' => ['description' => 'The actual start time of the predictive outbound campaign. This is a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1634000460000', 'title' => ''], 'CasesAborted' => ['description' => 'The number of aborted contacts.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CasesUncompleted' => ['description' => 'The number of uncompleted contacts.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CasesConnected' => ['description' => 'The number of connected contacts.', 'type' => 'integer', 'format' => 'int64', 'example' => '40', 'title' => ''], 'MaxAttemptCount' => ['description' => 'The maximum number of call attempts for each contact. If an attempt fails, the contact is redialed until this limit is reached.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'MinAttemptInterval' => ['description' => 'The minimum interval, in seconds, to wait before redialing a failed call.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'Name' => ['description' => 'The name of the predictive outbound campaign.', 'type' => 'string', 'example' => 'test-campaign', 'title' => ''], 'PlanedEndTime' => ['description' => 'The planned end time of the predictive outbound campaign. This is a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1634054400000', 'title' => ''], 'PlanedStartTime' => ['description' => 'The planned start time of the predictive outbound campaign. This is a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1633968000000', 'title' => ''], 'QueueName' => ['description' => 'The name of the associated skill group.', 'type' => 'string', 'example' => '测试技能组', 'title' => ''], 'TotalCases' => ['description' => 'The total number of contacts.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'State' => [ 'description' => 'The state of the predictive outbound campaign.', 'enumValueTitles' => ['Draft' => 'The campaign is a draft.', 'Completed' => 'The campaign has finished.', 'Executing' => 'The campaign is running.', 'Pending' => 'The campaign is scheduled to start.', 'Aborted' => 'The campaign was canceled.', 'Paused' => 'The campaign is temporarily stopped.'], 'type' => 'string', 'example' => 'Completed', 'title' => '', ], 'CampaignId' => ['title' => 'id', 'description' => 'The ID of the predictive outbound campaign.', 'type' => 'string', 'example' => '6badb397-a8b5-40b6-21019d382a09'], 'StrategyType' => [ 'description' => 'The dialing strategy for the predictive outbound campaign.', 'enumValueTitles' => ['PACING' => 'A fixed-ratio dialing strategy. The number of outbound calls = number of idle agents × ratio.', 'PID' => 'A Proportional-Integral-Derivative (PID) control strategy. The system automatically adjusts the number of outbound calls.'], 'type' => 'string', 'example' => 'PACING', 'title' => '', ], 'StrategyParameters' => ['description' => 'The strategy parameters for the predictive outbound campaign, in JSON format. For a `PID` strategy, the format is `{"abandonRate":"5","historicalConnectedRate":"35"}`. For a `PACING` strategy, the format is `{"ratio":1}`. `abandonRate` specifies the target abandon rate, `historicalConnectedRate` specifies the historical connection rate for reference, and `ratio` specifies the fixed dialing ratio.', 'type' => 'string', 'example' => '{"ratio":1}', 'title' => ''], 'QueueId' => ['description' => 'The ID of the associated skill group.', 'type' => 'string', 'example' => 'skillgroup@ccc-test', 'title' => ''], 'Simulation' => ['description' => 'Indicates whether the campaign is a test simulation. This parameter is not intended for production use.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'SimulationParameters' => ['description' => 'The parameters for a test simulation. This parameter is not intended for production use.', 'type' => 'string', 'example' => '无', 'title' => ''], 'CasesUncompletedAfterAttempted' => ['description' => 'The number of attempted but unconnected contacts that are still eligible for redial.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'CasesUncompletedAfterAttempt' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'CompletionRate' => ['description' => 'The ratio of connected contacts to the total number of contacts.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => ''], 'ContactFlowId' => ['description' => 'The ID of the associated Contact Flow.', 'type' => 'string', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'title' => 'Retrieve a predictive dialing Activity ', 'changeSet' => [ ['createdAt' => '2024-06-06T11:38:12.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-11-22T01:05:27.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCampaign'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6CCEF32F-8614-535F-A1D9-D85B8C0DC4F0\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": {\\n \\"ActualEndTime\\": 1634008800000,\\n \\"ActualStartTime\\": 1634000460000,\\n \\"CasesAborted\\": 0,\\n \\"CasesUncompleted\\": 0,\\n \\"CasesConnected\\": 40,\\n \\"MaxAttemptCount\\": 1,\\n \\"MinAttemptInterval\\": 1,\\n \\"Name\\": \\"test-campaign\\",\\n \\"PlanedEndTime\\": 1634054400000,\\n \\"PlanedStartTime\\": 1633968000000,\\n \\"QueueName\\": \\"测试技能组\\",\\n \\"TotalCases\\": 100,\\n \\"State\\": \\"Completed\\",\\n \\"CampaignId\\": \\"6badb397-a8b5-40b6-21019d382a09\\",\\n \\"StrategyType\\": \\"PACING\\",\\n \\"StrategyParameters\\": \\"{\\\\\\"ratio\\\\\\":1}\\",\\n \\"QueueId\\": \\"skillgroup@ccc-test\\",\\n \\"Simulation\\": false,\\n \\"SimulationParameters\\": \\"无\\",\\n \\"CasesUncompletedAfterAttempted\\": 1,\\n \\"CasesUncompletedAfterAttempt\\": \\"\\",\\n \\"CompletionRate\\": 0,\\n \\"ContactFlowId\\": \\"\\"\\n }\\n}","type":"json"}]', ], 'GetCaseFileUploadUrl' => [ 'summary' => 'Invoke GetCaseFileUploadUrl to obtain the OSS upload parameters for a predictive outbound calling list file under a specified instance. When creating a predictive outbound calling Activity by importing a file, you must first invoke this API to retrieve the file upload parameters and then invoke the CreateCampaign API.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccQFUGXR'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'FileName', 'in' => 'query', 'schema' => ['description' => 'The file name of the predictive outbound calling Activity list. The name must consist of uppercase and lowercase English letters, and the file format must be CSV.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'case.csv', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'Url' => ['description' => 'A pre-signed OSS file upload URL for uploading the file. The validity period is one hour.', 'type' => 'string', 'example' => 'https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-test/namelist.csv?Expires=1642067227&OSSAccessKeyId=****&Signature=****', 'title' => ''], 'CaseFileKey' => ['description' => 'The key of the OSS file.', 'type' => 'string', 'example' => 'ccc-test/namelist.csv', 'title' => ''], ], 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Obtain Upload Parameters for Predictive Outbound Calling List', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCaseFileUploadUrl'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"Url\\": \\"https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-test/namelist.csv?Expires=1642067227&OSSAccessKeyId=****&Signature=****\\",\\n \\"CaseFileKey\\": \\"ccc-test/namelist.csv\\"\\n },\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\"\\n}","type":"json"}]', ], 'GetChatMediaUrl' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'MediaId', 'in' => 'formData', 'schema' => ['title' => 'media id', 'description' => 'Media ID.', 'type' => 'string', 'required' => true, 'example' => '$iAHNCNQCo3dhdgMGBAAFAAbaACOEAaQhIEeoAqpjjBl42N6o_kg7A88AAAGRIRRuBgTOACrxHgcACM8AAAGRIYJLBQ'], ], [ 'name' => 'RequestId', 'in' => 'formData', 'schema' => ['description' => 'Request ID.', 'type' => 'string', 'required' => false, 'example' => '8707EB29-BAED-4302-B999-40BA61877437', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ccc-test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Response object for GetChatMediaUrl.', 'title' => 'GetChatMediaUrlResponse', 'type' => 'object', 'properties' => [ 'Data' => ['description' => 'Response data.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '9FBA26B0-462B-4D77-B78F-AF35560DBC71', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => 'Internal service issue. Detail:.', 'title' => ''], 'Params' => [ 'description' => 'Response parameters.', 'type' => 'array', 'items' => ['description' => 'Response parameter value.', 'type' => 'string', 'example' => '[\'OFFLINE\', \'READY,RINGING,TALKING\']', 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"9FBA26B0-462B-4D77-B78F-AF35560DBC71\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Internal service issue. Detail:.\\",\\n \\"Params\\": [\\n \\"[\'OFFLINE\', \'READY,RINGING,TALKING\']\\"\\n ]\\n}","type":"json"}]', 'title' => 'Obtain the access URL of a chat message media file', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'summary' => '', ], 'GetChatRoutingProfile' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '30C7D235-DDCF-4C7F-A462-5E2598252C2B', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'RoutingType' => ['description' => 'Call distribution type.'."\n" ."\n" .'- Automatic distribution (Automatic).'."\n" ."\n" .'- Manual distribution (Manual).', 'type' => 'string', 'example' => 'Automatic', 'title' => ''], 'AgentConcurrencySettings' => ['description' => 'Agent session concurrent configuration.'."\n" ."\n" .'- AllowExceedingLimitWhenTransferring: Allow exceeding the limit when transferring. When transferring sessions to other agents, exceeding the recipient\'s limit is allowed, but the total cannot exceed 30.'."\n" ."\n" .'- AllowExceedingLimitWhenClaiming: Allow exceeding the limit when claiming. When an agent actively claims sessions from the queue, exceeding the limit is allowed, but the total cannot exceed 30.'."\n" ."\n" .'- ConcurrencyLimit: The number of network business sessions an agent can process simultaneously.'."\n" ."\n" .'- Enabled: Enable this configuration.', 'type' => 'string', 'example' => '{'."\n" .' "AllowExceedingLimitWhenTransferring": false,'."\n" .' "ConcurrencyLimit": 4,'."\n" .' "AllowExceedingLimitWhenClaiming": true,'."\n" .' "Enabled": true'."\n" .'}', 'title' => ''], 'DistributionSettings' => ['description' => 'Agent session allocation configuration.'."\n" ."\n" .'- AgentRingTimeoutSeconds: Agent processing timeout limit.'."\n" ."\n" .'- MaxNumberOfConversationsAgentCanMiss: The maximum number of consecutive unanswered sessions an agent can miss.'."\n" ."\n" .'- PostAgentMissingConversionsAction: After an agent misses more than the set number of consecutive responses, the system sets the agent\'s status, such as Break, Invisible, or Nothing (remain unchanged).'."\n" ."\n" .'- Enabled: Enable.', 'type' => 'string', 'example' => '{'."\n" .' "AgentRingTimeoutSeconds": 30,'."\n" .' "Enabled": true,'."\n" .' "MaxNumberOfConversationsAgentCanMiss": 5,'."\n" .' "PostAgentMissingConversionsAction": "Nothing"'."\n" .'}', 'title' => ''], 'ChatSettings' => ['description' => 'Session configuration.'."\n" ."\n" .'- IdleChatTimeoutSeconds: Automatic session end time. If no customer response is received within a specific period, the system ends the session. Unit: seconds.', 'type' => 'string', 'example' => '{"IdleChatTimeoutSeconds":300}', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''], ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => ''], ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"30C7D235-DDCF-4C7F-A462-5E2598252C2B\\",\\n \\"Data\\": {\\n \\"RoutingType\\": \\"Automatic\\",\\n \\"AgentConcurrencySettings\\": \\"{\\\\n \\\\\\"AllowExceedingLimitWhenTransferring\\\\\\": false,\\\\n \\\\\\"ConcurrencyLimit\\\\\\": 4,\\\\n \\\\\\"AllowExceedingLimitWhenClaiming\\\\\\": true,\\\\n \\\\\\"Enabled\\\\\\": true\\\\n}\\",\\n \\"DistributionSettings\\": \\"{\\\\n \\\\\\"AgentRingTimeoutSeconds\\\\\\": 30,\\\\n \\\\\\"Enabled\\\\\\": true,\\\\n \\\\\\"MaxNumberOfConversationsAgentCanMiss\\\\\\": 5,\\\\n \\\\\\"PostAgentMissingConversionsAction\\\\\\": \\\\\\"Nothing\\\\\\"\\\\n}\\",\\n \\"ChatSettings\\": \\"{\\\\\\"IdleChatTimeoutSeconds\\\\\\":300}\\"\\n }\\n}","type":"json"}]', 'title' => 'Obtain Session Transfer Configuration', 'summary' => 'Use GetChatRoutingProfile to retrieve the chat routing configuration.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'GetContactFlow' => [ 'summary' => 'Retrieve a specified contact flow.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccTPIKHY'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'ContactFlowId', 'in' => 'query', 'schema' => ['description' => 'The contact flow ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '274601be-a6d5-4429-bcef-32b51d031c6e', 'title' => ''], ], [ 'name' => 'DraftId', 'in' => 'query', 'schema' => ['description' => 'The draft ID. This is the ID of the editable draft version for the current contact flow.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '566399d7-5558-447c-a72f-9be2768b6a82', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2263B273-AC1B-44EB-BA98-87F2322C6780', 'title' => ''], 'Data' => [ 'description' => 'The response data.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The flow type:
'."\n" .'MAIN\\_FLOW (main flow)
'."\n" .'SUB\\_FLOW (child flow)
'."\n" .'SURVEY\\_FLOW (survey flow)


', 'type' => 'string', 'example' => 'MAIN_FLOW', 'title' => ''], 'Definition' => ['description' => 'IVR content.', 'type' => 'string', 'example' => '{"activities":[{"type":"INCOMING_CALL","id":"e98f0d47","name":"开始","properties":{"position":{"x":263,"y":164}},"events":[{"event":"complete","next":"2d3ad2c2","edgeId":"41f7dbd0"}],"nodeIndex":0},{"type":"HANGUP","id":"bd4f37e2","name":"挂机","properties":{"position":{"x":765,"y":185}},"events":[{"event":"complete","next":null}],"nodeIndex":999},{"type":"PLAY_SAY","id":"2d3ad2c2","name":"放音","properties":{"say":"您好，欢迎来到云联络中心。","audioResourceId":"","position":{"x":485.5,"y":153.5},"audioType":"tts","audioInterrupt":false},"events":[{"event":"complete","next":"bd4f37e2","edgeId":"e1af4f1f"}],"nodeIndex":1}],"description":""}', 'title' => ''], 'DraftId' => ['description' => 'The draft ID. This is the ID of the editable draft version for the current contact flow.', 'type' => 'string', 'example' => '566399d7-5558-447c-a72f-9be2768b6a82'."\n", 'title' => ''], 'Description' => ['description' => 'The version description.', 'type' => 'string', 'example' => '1.0'."\n", 'title' => ''], 'UpdatedTime' => ['description' => 'The time when the contact flow was last updated.', 'type' => 'string', 'example' => '2021-07-14 10:48:43.0', 'title' => ''], 'Editor' => ['description' => 'The agent login name of the current editor of this draft.', 'type' => 'string', 'example' => 'editor-xxx', 'title' => ''], 'Published' => ['description' => 'Indicates whether the contact flow is published.'."\n" .'True: Published'."\n" .'False: Not published', 'type' => 'boolean', 'example' => 'False', 'title' => ''], 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'Name' => ['description' => 'The IVR name.', 'type' => 'string', 'example' => '欢迎语', 'title' => ''], 'ContactFlowId' => ['description' => 'The contact flow ID.', 'type' => 'string', 'example' => '274601be-a6d5-4429-bcef-32b51d031c6e'."\n", 'title' => ''], 'CreatedTime' => ['description' => 'The time when the contact flow draft was created.', 'type' => 'string', 'example' => '2021-07-14 10:48:43.0', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Retrieve a specified contact flow', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetContactFlow'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"2263B273-AC1B-44EB-BA98-87F2322C6780\\",\\n \\"Data\\": {\\n \\"Type\\": \\"MAIN_FLOW\\",\\n \\"Definition\\": \\"{\\\\\\"activities\\\\\\":[{\\\\\\"type\\\\\\":\\\\\\"INCOMING_CALL\\\\\\",\\\\\\"id\\\\\\":\\\\\\"e98f0d47\\\\\\",\\\\\\"name\\\\\\":\\\\\\"开始\\\\\\",\\\\\\"properties\\\\\\":{\\\\\\"position\\\\\\":{\\\\\\"x\\\\\\":263,\\\\\\"y\\\\\\":164}},\\\\\\"events\\\\\\":[{\\\\\\"event\\\\\\":\\\\\\"complete\\\\\\",\\\\\\"next\\\\\\":\\\\\\"2d3ad2c2\\\\\\",\\\\\\"edgeId\\\\\\":\\\\\\"41f7dbd0\\\\\\"}],\\\\\\"nodeIndex\\\\\\":0},{\\\\\\"type\\\\\\":\\\\\\"HANGUP\\\\\\",\\\\\\"id\\\\\\":\\\\\\"bd4f37e2\\\\\\",\\\\\\"name\\\\\\":\\\\\\"挂机\\\\\\",\\\\\\"properties\\\\\\":{\\\\\\"position\\\\\\":{\\\\\\"x\\\\\\":765,\\\\\\"y\\\\\\":185}},\\\\\\"events\\\\\\":[{\\\\\\"event\\\\\\":\\\\\\"complete\\\\\\",\\\\\\"next\\\\\\":null}],\\\\\\"nodeIndex\\\\\\":999},{\\\\\\"type\\\\\\":\\\\\\"PLAY_SAY\\\\\\",\\\\\\"id\\\\\\":\\\\\\"2d3ad2c2\\\\\\",\\\\\\"name\\\\\\":\\\\\\"放音\\\\\\",\\\\\\"properties\\\\\\":{\\\\\\"say\\\\\\":\\\\\\"您好，欢迎来到云联络中心。\\\\\\",\\\\\\"audioResourceId\\\\\\":\\\\\\"\\\\\\",\\\\\\"position\\\\\\":{\\\\\\"x\\\\\\":485.5,\\\\\\"y\\\\\\":153.5},\\\\\\"audioType\\\\\\":\\\\\\"tts\\\\\\",\\\\\\"audioInterrupt\\\\\\":false},\\\\\\"events\\\\\\":[{\\\\\\"event\\\\\\":\\\\\\"complete\\\\\\",\\\\\\"next\\\\\\":\\\\\\"bd4f37e2\\\\\\",\\\\\\"edgeId\\\\\\":\\\\\\"e1af4f1f\\\\\\"}],\\\\\\"nodeIndex\\\\\\":1}],\\\\\\"description\\\\\\":\\\\\\"\\\\\\"}\\",\\n \\"DraftId\\": \\"566399d7-5558-447c-a72f-9be2768b6a82\\\\n\\",\\n \\"Description\\": \\"1.0\\\\n\\",\\n \\"UpdatedTime\\": \\"2021-07-14 10:48:43.0\\",\\n \\"Editor\\": \\"editor-xxx\\",\\n \\"Published\\": true,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Name\\": \\"欢迎语\\",\\n \\"ContactFlowId\\": \\"274601be-a6d5-4429-bcef-32b51d031c6e\\\\n\\",\\n \\"CreatedTime\\": \\"2021-07-14 10:48:43.0\\"\\n }\\n}","type":"json"}]', ], 'GetConversationDetail' => [ 'summary' => 'Call GetConversationDetail to obtain the conversation details for the call corresponding to the specified contact ID within the specified instance. The instance and skill group must have quality inspection push enabled to obtain these details.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '136495', 'abilityTreeNodes' => ['FEATUREccc5HY0NN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'ContactId', 'in' => 'query', 'schema' => ['description' => 'The ID of the conversation.', 'type' => 'string', 'required' => true, 'example' => 'job-25884193037652****', 'title' => ''], ], [ 'name' => 'AgentId', 'in' => 'query', 'schema' => ['title' => 'Agent ID. ', 'description' => 'Agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '7E407F9B-A278-52A0-B193-3EE5471D7A87', 'title' => ''], 'Phrases' => [ 'description' => 'List of conversations.', 'type' => 'array', 'items' => [ 'description' => 'Conversation information.', 'type' => 'object', 'properties' => [ 'Identity' => ['description' => 'The ARN of the role. The system uses this identifier internally to identify the role. This parameter does not require management.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'Role' => [ 'description' => 'Role.', 'enumValueTitles' => ['客服' => 'Customer Service', '客户' => 'Customer'], 'type' => 'string', 'example' => '客服', 'title' => '', ], 'Begin' => ['description' => 'The offset of the sentence start time relative to the session start time, in milliseconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '240', 'title' => ''], 'End' => ['description' => 'The offset of the sentence end time relative to the session start time, in milliseconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '1280', 'title' => ''], 'Words' => ['description' => 'Conversation text content.', 'type' => 'string', 'example' => '欢迎致电云联络中心', 'title' => ''], 'Finished' => ['description' => 'Is finished.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"7E407F9B-A278-52A0-B193-3EE5471D7A87\\",\\n \\"Phrases\\": [\\n {\\n \\"Identity\\": \\"agent@ccc-test\\",\\n \\"Role\\": \\"客服\\",\\n \\"Begin\\": 240,\\n \\"End\\": 1280,\\n \\"Words\\": \\"欢迎致电云联络中心\\",\\n \\"Finished\\": false\\n }\\n ]\\n}","type":"json"}]', 'title' => 'Obtain Conversation Details', 'changeSet' => [ ['createdAt' => '2024-12-12T15:20:46.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetConversationDetail'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'GetDoNotCallFileUploadParameters' => [ 'summary' => 'Invoke GetDoNotCallFileUploadParameters to obtain the upload parameters for a do-not-call file. When importing prohibited outbound call numbers through a file, you must first invoke this API to upload the do-not-call number file to the public OSS space of Cloud Contact Center, and then invoke ImportDoNotCallNumbers to execute the import.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccTMAX45'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'FileName', 'in' => 'query', 'schema' => ['description' => 'Name of the file containing prohibited outbound call numbers.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'blacklist.xlsx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', 'title' => ''], 'Success' => ['description' => 'Indicates whether the operation succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'FilePath' => ['description' => 'Key of the OSS file.', 'type' => 'string', 'example' => 'ccc-test/blacklist.xlsx', 'title' => ''], 'Signature' => ['description' => 'Signature information of the temporary credential for file upload, used to authenticate validity during upload.', 'type' => 'string', 'example' => 'zi31STIMtIfa/UN2l+6lww****', 'title' => ''], 'Host' => ['description' => 'Endpoint domain name of OSS.', 'type' => 'string', 'example' => 'https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com', 'title' => ''], 'Policy' => ['description' => 'Signature policy.', 'type' => 'string', 'example' => 'eyJleHBpcmF0aW9uIjoiMjAyMi0wMy0xNVQwMzowMzo0MC4zMTJaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjBdLFsic3RhcnRzLXdpdGgiLCIka2V5IiwidGVtcC9ibGFja2xpc3QvaW1wb3J0LzE1NzcyNDcxMTU0OTA0MDEvY2NjVjIta216LzIwMjIE1MTAwMzQwLyJd****', 'title' => ''], 'ExpireTime' => ['description' => 'Expiration time, formatted as a Unix timestamp in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '1647313420', 'title' => ''], 'AccessKeyId' => ['description' => 'AccessKeyId used for signing.', 'type' => 'string', 'example' => '****', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Obtain Upload Parameters for Do-Not-Call File', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2022-02-24T13:00:36.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDoNotCallFileUploadParameters'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"FilePath\\": \\"ccc-test/blacklist.xlsx\\",\\n \\"Signature\\": \\"zi31STIMtIfa/UN2l+6lww****\\",\\n \\"Host\\": \\"https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com\\",\\n \\"Policy\\": \\"eyJleHBpcmF0aW9uIjoiMjAyMi0wMy0xNVQwMzowMzo0MC4zMTJaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjBdLFsic3RhcnRzLXdpdGgiLCIka2V5IiwidGVtcC9ibGFja2xpc3QvaW1wb3J0LzE1NzcyNDcxMTU0OTA0MDEvY2NjVjIta216LzIwMjIE1MTAwMzQwLyJd****\\",\\n \\"ExpireTime\\": 1647313420,\\n \\"AccessKeyId\\": \\"****\\"\\n }\\n}","type":"json"}]', ], 'GetDocumentUploadParameters' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'parameters' => [ [ 'name' => 'FileName', 'in' => 'formData', 'schema' => ['description' => 'File name.', 'type' => 'string', 'required' => true, 'example' => 'blacklist.xlsx', 'title' => ''], ], [ 'name' => 'RequestId', 'in' => 'formData', 'schema' => ['description' => 'Request ID.', 'type' => 'string', 'required' => false, 'example' => '24BE19E8-BF7D-4992-A35E-15EBA874F2E5', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'GetTempAttachmentUploadUrlResponse', 'title' => 'GetTempAttachmentUploadUrlResponse ', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'AccessKeyId' => ['title' => 'AccessKeyId used for signing ', 'description' => 'AccessKeyId used for signing', 'type' => 'string', 'example' => '****'], 'Policy' => ['title' => 'Signature policy ', 'description' => 'Signature policy', 'type' => 'string', 'example' => 'Permit'], 'Signature' => ['title' => 'Signature ', 'description' => 'Signature', 'type' => 'string', 'example' => 'zi31STIMtIfa/UN2l+6lww****'], 'FilePath' => ['title' => 'OSS file path ', 'description' => 'OSS file path', 'type' => 'string', 'example' => 'ccc-test/blacklist.xlsx'], 'Host' => ['title' => 'OSS host ', 'description' => 'OSS host', 'type' => 'string', 'example' => 'https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com'], 'ExpireTime' => ['title' => 'Expiration Time', 'description' => 'Expired At', 'type' => 'integer', 'format' => 'int32', 'example' => '1647313420'], ], 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '9FBA26B0-462B-4D77-B78F-AF35560DBC71', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'Response code', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'Response message', 'type' => 'string', 'example' => '无', 'title' => ''], 'Params' => [ 'description' => 'Response parameters.', 'type' => 'array', 'items' => ['description' => 'Response parameters.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"AccessKeyId\\": \\"****\\",\\n \\"Policy\\": \\"Permit\\",\\n \\"Signature\\": \\"zi31STIMtIfa/UN2l+6lww****\\",\\n \\"FilePath\\": \\"ccc-test/blacklist.xlsx\\",\\n \\"Host\\": \\"https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com\\",\\n \\"ExpireTime\\": 1647313420\\n },\\n \\"RequestId\\": \\"9FBA26B0-462B-4D77-B78F-AF35560DBC71\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', 'title' => 'Obtain the upload URL for importing a document', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'summary' => '', ], 'GetEarlyMediaRecording' => [ 'summary' => 'Retrieve early-media audio recordings for a call in a specified Cloud Contact Center instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccKYIENB'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Cloud Contact Center instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'ContactId', 'in' => 'query', 'schema' => ['description' => 'Call ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6538214103689****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'FileUrl' => ['description' => 'OSS download URL for the recording file. Note the expiration time. The URL is valid for one day.', 'type' => 'string', 'example' => 'https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-record-mixed/ccc-test/2022/06/voicemail.job-054ded02****.wav?Expires=1656074923&OSSAccessKeyId=****&Signature=****', 'title' => ''], 'FileName' => ['description' => 'Recording file name.', 'type' => 'string', 'example' => 'job-6538214103689****-earlyMedia.wav', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''], ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => ''], ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Obtain Early Media Audio of a Call', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEarlyMediaRecording'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"03C67DAD-EB26-41D8-949D-9B0C470FB716\\",\\n \\"Data\\": {\\n \\"FileUrl\\": \\"https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-record-mixed/ccc-test/2022/06/voicemail.job-054ded02****.wav?Expires=1656074923&OSSAccessKeyId=****&Signature=****\\",\\n \\"FileName\\": \\"job-6538214103689****-earlyMedia.wav\\"\\n }\\n}","type":"json"}]', ], 'GetHistoricalCallerReport' => [ 'summary' => 'Invoke GetHistoricalCallerReport to retrieve the historical inbound call report for a specified calling number under a specified instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'CallingNumber', 'in' => 'query', 'schema' => ['description' => 'Calling number.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1900000****', 'title' => ''], ], [ 'name' => 'StopTime', 'in' => 'query', 'schema' => ['description' => 'End time of the query, formatted as a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '4102416000000', 'minimum' => '0', 'example' => '1646928000000', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'Start time of the query, formatted as a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '4102416000000', 'minimum' => '0', 'example' => '1646841600000', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'LastCallingTime' => ['description' => 'The UNIX timestamp (in milliseconds) of the most recent incoming call.', 'type' => 'integer', 'format' => 'int64', 'example' => '1646917200000', 'title' => ''], 'TotalCalls' => ['description' => 'Total number of incoming calls from this number during the query time period.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid. %s', 'description' => ''], ['errorCode' => 'Parameter.Invalid', 'errorMessage' => 'The parameter %s is invalid. %s.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => ''], ], ], 'title' => 'Retrieve Historical Inbound Call Report', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHistoricalCallerReport'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Data\\": {\\n \\"LastCallingTime\\": 1646917200000,\\n \\"TotalCalls\\": 10\\n }\\n}","type":"json"}]', ], 'GetHistoricalCampaignReport' => [ 'summary' => 'You can invoke the GetHistoricalCampaignReport API to retrieve the historical data report of a predictive outbound calling activity corresponding to a specified ID under a specified instance.', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccQFUGXR'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['title' => 'Instance ID', 'description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'], ], [ 'name' => 'CampaignId', 'in' => 'query', 'schema' => ['title' => 'Activity ID', 'description' => 'Predictive outbound call activity ID.', 'type' => 'string', 'required' => true, 'example' => '4fc85829-f6fc-476e-9c0d-c350184e36f1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'E3A847C1-9800-57DF-9172-2CDDC026388D', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'CallsConnected' => ['description' => 'Number of connected calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '50', 'title' => ''], 'CallsDialed' => ['description' => 'Number of calls dialed, including retries.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'CallsAbandoned' => ['description' => 'Number of abandoned calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], 'ConnectedRate' => ['description' => 'Deprecated. Refer to AnswerRate instead.', 'type' => 'number', 'format' => 'float', 'example' => '0.50', 'title' => ''], 'AnswerRate' => ['description' => 'Answer rate, in %.', 'type' => 'number', 'format' => 'float', 'example' => '0.50', 'title' => ''], 'AbandonedRate' => ['description' => 'Deprecated. Refer to AbandonRate instead.', 'type' => 'number', 'format' => 'float', 'example' => '0.10', 'title' => ''], 'AbandonRate' => ['description' => 'Abandon rate, calculated as: number of abandoned calls divided by total calls.', 'type' => 'number', 'format' => 'float', 'example' => '0.10', 'title' => ''], 'OccupancyRate' => ['description' => 'Agent occupancy rate, calculated as: (total talk duration + total post-processing duration) divided by total agent online duration. Total agent online duration refers to the sum of online durations of all agents in the skill group associated with this activity.', 'type' => 'number', 'format' => 'float', 'example' => '0.50', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'title' => 'Obtain Historical Data Report for Predictive Outbound Call Activity', 'changeSet' => [ ['createdAt' => '2023-11-22T01:05:27.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHistoricalCampaignReport'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"E3A847C1-9800-57DF-9172-2CDDC026388D\\",\\n \\"Data\\": {\\n \\"CallsConnected\\": 50,\\n \\"CallsDialed\\": 100,\\n \\"CallsAbandoned\\": 5,\\n \\"ConnectedRate\\": 0.5,\\n \\"AnswerRate\\": 0.5,\\n \\"AbandonedRate\\": 0.1,\\n \\"AbandonRate\\": 0.1,\\n \\"OccupancyRate\\": 0.5\\n }\\n}","type":"json"}]', ], 'GetHistoricalInstanceReport' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The start time of the Historical Data to retrieve, in UNIX timestamp format with millisecond precision. This parameter is optional. The default value is 00:00:00 of the current day. The earliest allowed time is 180 days before the current time. The time precision for statistics is hourly, snapped to the previous full hour, and the interval is closed.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1532448000000', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end time of the Historical Data to retrieve, in UNIX timestamp format with millisecond precision. This parameter is optional. The default value is the current time. The time precision for statistics is hourly, snapped to the next full hour, and the interval is open. For example, if the start time is 11:12:20 and the end time is 11:45:50, the snapped input parameter Time Range becomes \\[11:00:00, 12:00:00), meaning greater than or equal to 11:00:00 and less than 12:00:00.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1532707199000', 'title' => ''], ], [ 'name' => 'MediaType', 'in' => 'query', 'schema' => ['description' => 'Media Type. The default value is Audio. Other valid values include Chat and Video.', 'type' => 'string', 'required' => false, 'example' => 'VIDEO', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '943D8EF3-3321-471F-A104-51C96FCA94D6', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'Inbound' => [ 'description' => 'Inbound data.', 'type' => 'object', 'properties' => [ 'AverageRingTime' => ['description' => 'Average ring time in seconds. Calculation Formula: TotalRingTime / CallsRinged.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'CallsVoicemail' => ['description' => 'Number of calls transferred to voicemail. The count increases by 1 when a call enters the voicemail module configured in IVR.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxAbandonedInIVRTime' => ['description' => 'Maximum IVR abandonment duration, in seconds. IVR abandonment is defined as a customer hanging up during IVR interaction. This does not include hang-ups while waiting in queue or during agent ringing after call assignment.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'CallsHandled' => ['description' => 'Acknowledgement count, which refers to the number of calls answered by agents. If a single call is answered by multiple agents, it is counted only once.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsIVRException' => ['description' => 'Number of calls with IVR exceptions. A call is counted when the IVR enters a hang-up reason node and the hang-up reason configured in that node is "transfer to agent failed."', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsAbandonedInIVR' => ['description' => 'Number of calls abandoned in IVR, which refers to the count of calls where the customer hung up during the IVR flow after entering it. This is determined by the hang-up reason in call details being marked as "IVR abandoned."', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxWorkTime' => ['description' => 'Maximum post-processing time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalHoldTime' => ['description' => 'Total call hold duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxAbandonTime' => ['description' => 'Maximum abandon time, in seconds. A call is considered abandoned if the customer hangs up after entering the IVR but before an agent answers.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageAbandonTime' => ['description' => 'Average abandon time, in seconds. Calculation formula: TotalAbandonTime / CallsAbandoned.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'CallsRinged' => ['description' => 'Number of calls that rang agents. If a single call is assigned to multiple agents and rings, it is counted once.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsQueuingFailed' => ['description' => 'The number of queue failures, which refers to the count of calls where the customer hung up while waiting in the queue after entering it.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalRingTime' => ['description' => '\\[responses\\_200\\_schema\\_properties\\_Data\\_properties\\_Inbound\\_properties\\_CallsQueuingFailed\\_type]integer', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AbandonRate' => ['description' => 'Abandon rate. Calculation Formula: CallsAbandoned / CallsOffered (because abandonment events and assignment events may fall into different time ranges, the result may exceed 100% in certain cases).', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'TotalTalkTime' => ['description' => '\\[responses\\_200\\_schema\\_properties\\_Data\\_properties\\_Inbound\\_properties\\_CallsToVoicemail\\_type]integer', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxAbandonedInRingTime' => ['description' => 'Maximum ringing abandonment duration, in seconds. Ringing abandonment is defined as the customer hanging up while the call is ringing on the agent\'s side after being assigned to the agent.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsBlindTransferred' => ['description' => 'The number of blind transfers, which refers to the count of calls directly transferred without consultation. If a single call is transferred multiple times, it is counted as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageAbandonedInIVRTime' => ['description' => 'Average IVR abandonment duration, in seconds. Calculation Formula: TotalAbandonedInIVRTime / CallsAbandonedInIVR.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'AverageAbandonedInQueueTime' => ['description' => '\\[responses\\_200\\_schema\\_properties\\_Data\\_properties\\_Inbound\\_properties\\_MaxAbandonedInQueueTime\\_type]integer', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'MaxWaitTime' => ['description' => 'Maximum wait time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageTalkTime' => ['description' => 'Average talk time, in seconds. Calculation Formula: TotalTalkTime / CallsHandled.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'CallsAttendedTransferred' => ['description' => 'Number of consultative transfers, which refers to the number of calls that were transferred via consultative transfer. If a single call is transferred multiple times, it is counted as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalAbandonedInIVRTime' => ['description' => 'Total IVR abandonment duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsQueuingOverflow' => ['description' => 'The number of calls that overflowed from the queue, where queue overflow refers to calls exceeding the queue capacity while waiting in the IVR queue.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsAbandonedInRing' => ['description' => 'Number of calls abandoned during ringing, which refers to the quantity of calls where the customer hung up while the agent\'s phone was ringing.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalAbandonedInRingTime' => ['description' => '\\[responses\\_200\\_schema\\_properties\\_Data\\_properties\\_Inbound\\_properties\\_SatisfactionSurveysOffered\\_type]integer', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalWorkTime' => ['description' => 'Total post-processing duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageWaitTime' => ['description' => '\\[responses\\_200\\_schema\\_properties\\_Data\\_properties\\_Inbound\\_properties\\_AverageFirstResponseTime\\_type]number', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'AverageWorkTime' => ['description' => 'Average post-processing time, in seconds. Calculation formula: TotalWorkTime / CallsHandled.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'CallsQueued' => ['description' => 'Number of calls entering the queue. If a single call enters the queue multiple times, it is counted once.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageAbandonedInRingTime' => ['description' => 'Average ring-time abandon duration, in seconds. Calculation formula: TotalAbandonedInRingTime / CallsAbandonedInRing.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'SatisfactionIndex' => ['description' => '\\[responses\\_200\\_schema\\_properties\\_Data\\_properties\\_Inbound\\_properties\\_CallsQueuingOverflow\\_type]integer', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'CallsAbandoned' => ['description' => 'Total number of abandoned calls. Calculation Formula: CallsAbandonedInIVR + CallsAbandonedInQueue + CallsAbandonedInRing.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxAbandonedInQueueTime' => ['description' => 'Maximum queue abandonment duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsAbandonedInVoiceNavigator' => ['description' => 'Number of calls abandoned in the Intelligent Voice Navigator module.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalWaitTime' => ['description' => 'Total wait time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxTalkTime' => ['description' => 'Maximum talk time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxRingTime' => ['description' => 'Maximum ring duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalAbandonTime' => ['description' => 'Total abandonment duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsOffered' => ['description' => '\\[responses\\_200\\_schema\\_properties\\_Data\\_properties\\_Inbound\\_properties\\_TotalAbandonedInRingTime\\_type]integer', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsQueuingTimeout' => ['description' => 'Number of calls that timed out during the queuing phase.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'ServiceLevel20' => ['description' => 'Service level within 20 seconds: number of calls with wait time less than or equal to 20 seconds divided by CallsQueued.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'MaxHoldTime' => ['description' => 'Maximum hold time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsForwardToOutsideNumber' => ['description' => 'Number of calls forwarded to an external number.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionRate' => ['description' => 'Satisfaction rate. Calculation Formula: Number of evaluations marked as satisfied / Count of satisfaction survey responses.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'CallsHold' => ['description' => '\\[responses\\_200\\_schema\\_properties\\_Data\\_properties\\_Inbound\\_properties\\_TotalAbandonTime\\_type]integer', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionSurveysOffered' => ['description' => 'Sending Count of satisfaction surveys.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'HandleRate' => ['description' => '\\[responses\\_200\\_schema\\_properties\\_Data\\_properties\\_Inbound\\_properties\\_CallsBlindTransferred\\_type]integer', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'SatisfactionSurveysResponded' => ['description' => 'Count of satisfaction survey responses.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageHoldTime' => ['description' => 'Average call hold duration, in seconds. Calculation Formula: TotalHoldTime / CallsHold.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'CallsAbandonedInQueue' => ['description' => 'Number of calls abandoned in queue, which refers to the number of calls where the customer hung up while waiting in the queue after the call entered the queue.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalAbandonedInQueueTime' => ['description' => 'Total queue abandon time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsCausedIVRException' => ['description' => 'Number of calls that caused IVR exceptions.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsToVoicemail' => ['description' => 'The number of calls routed to voicemail.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], 'ServiceLevel15' => ['description' => 'Service level within 15 seconds.', 'type' => 'number', 'format' => 'float', 'example' => '0.78', 'title' => ''], 'ServiceLevel30' => ['description' => 'Service level within 30 seconds.', 'type' => 'number', 'format' => 'float', 'example' => '0.9', 'title' => ''], 'TotalMessagesSent' => ['description' => 'Total number of messages sent in chat sessions.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], 'TotalMessagesSentByAgent' => ['description' => 'Total number of messages sent by agents in chat sessions.', 'type' => 'integer', 'format' => 'int64', 'example' => '8', 'title' => ''], 'TotalMessagesSentByCustomer' => ['description' => 'Total number of messages sent by the customer in chat sessions.', 'type' => 'integer', 'format' => 'int64', 'example' => '4', 'title' => ''], 'AverageFirstResponseTime' => ['description' => 'Average first response time for chat sessions, in seconds.', 'type' => 'number', 'format' => 'float', 'example' => '12', 'title' => ''], 'AccessChannelTypeDetailList' => [ 'description' => 'Statistics for each channel.', 'type' => 'array', 'items' => [ 'description' => 'Statistics for the channel.', 'type' => 'object', 'properties' => [ 'AccessChannelType' => ['description' => 'Channel Type.', 'type' => 'string', 'example' => 'Web', 'title' => ''], 'CallsOffered' => ['description' => 'Number of assigned sessions.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'AverageResponseTime' => ['description' => 'Average response time (RT) for chat sessions.', 'type' => 'number', 'format' => 'float', 'example' => '15', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Outbound' => [ 'description' => 'Outbound metrics.', 'type' => 'object', 'properties' => [ 'AverageRingTime' => ['description' => 'Average ring time, in seconds. Calculation Formula: TotalRingTime / CallsRinged.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'CallsDialed' => ['description' => 'Dial-up Call Count.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsAnswered' => ['description' => 'Answered Call Count.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalWorkTime' => ['description' => 'Total post-processing duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxWorkTime' => ['description' => 'Maximum post-processing time per call, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalDialingTime' => ['description' => 'Total dial-up duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalHoldTime' => ['description' => 'Total hold duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageWorkTime' => ['description' => 'Average post-processing time per call, in seconds. Calculation Formula: TotalWorkTime / CallsDialed.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'SatisfactionIndex' => ['description' => 'Satisfaction Index, which is the average of the satisfaction keypress digits (single-digit numbers).', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'CallsRinged' => ['description' => 'Number of calls that rang for agents. If a single call is assigned to multiple agents and rings for each, it is counted as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalRingTime' => ['description' => 'Total Ring Time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxTalkTime' => ['description' => 'Maximum Talk Time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxRingTime' => ['description' => 'Maximum ring duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalTalkTime' => ['description' => 'Total Talk Time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxDialingTime' => ['description' => 'Maximum Dial-up Time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsBlindTransferred' => ['description' => 'Number of blind transfers, which refers to the quantity of calls that underwent blind transfer. If a single call is transferred multiple times, it is counted as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AnswerRate' => ['description' => 'Answer rate. Calculation Formula: CallsAnswered / CallsDialed. (Because the answering event and the acknowledgement event may fall into different time ranges, the result may exceed 100% in certain cases.)', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'MaxHoldTime' => ['description' => 'Maximum call hold duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageTalkTime' => ['description' => 'Average talk time, in seconds. Calculation Formula: TotalTalkTime / CallsAnswered.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'SatisfactionRate' => ['description' => 'Satisfaction Rate. Calculation Formula: Number of responses marked as satisfied / Count of satisfaction survey responses.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'CallsAttendedTransferred' => ['description' => 'Number of attended transfers, which refers to the quantity of calls that underwent attended transfer. If a single call is transferred multiple times, it is counted as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsHold' => ['description' => 'Hold Count, which is the number of calls that were placed on hold. If a single call was put on hold multiple times, it is counted as one.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'SatisfactionSurveysOffered' => ['description' => 'Sending Count of satisfaction surveys.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionSurveysResponded' => ['description' => 'Response Count of satisfaction surveys.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageHoldTime' => ['description' => 'Average hold duration, in seconds. Calculation formula: TotalHoldTime / CallsHold.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'AverageDialingTime' => ['description' => 'Average Dial-up Time, in seconds. Calculation Formula: TotalDialingTime / CallsDialed.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Overall' => [ 'description' => 'Overall metrics.', 'type' => 'object', 'properties' => [ 'TotalTalkTime' => ['description' => 'Total talk time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalLoggedInTime' => ['description' => 'Total logon duration, in seconds. Exclude break time.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'OccupancyRate' => ['description' => 'Agent occupancy rate. Calculation Formula: (TotalWorkTime + TotalTalkTime) / TotalLoggedInTime.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'TotalWorkTime' => ['description' => 'Total post-processing time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxHoldTime' => ['description' => 'Maximum call hold duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxWorkTime' => ['description' => 'Maximum post-processing time per call, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageBreakTime' => ['description' => 'Average break duration, in seconds. Calculation Formula: TotalBreakTime / Count of breaks. The count of breaks is not an exposed API field.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'TotalHoldTime' => ['description' => 'Total hold time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionRate' => ['description' => 'Satisfaction rate. Calculation Formula: Count of evaluations marked as satisfied / Count of satisfaction survey responses.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'MaxBreakTime' => ['description' => 'Maximum short break duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageWorkTime' => ['description' => 'Average post-processing time per call, in seconds. Calculation Formula: TotalWorkTime / TotalCalls.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'AverageTalkTime' => ['description' => 'Average talk time, in seconds. Calculation Formula: TotalTalkTime / (CallsAnswered + CallsHandled).', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'SatisfactionIndex' => ['description' => 'Satisfaction index, which is the average value of the satisfaction keypress digits (single-digit numbers).', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'SatisfactionSurveysOffered' => ['description' => 'Sending Count of satisfaction surveys.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionSurveysResponded' => ['description' => 'Count of satisfaction survey responses.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxReadyTime' => ['description' => 'Maximum ready time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageReadyTime' => ['description' => 'Average ready duration, in seconds. Calculation Formula: TotalReadyTime / Count of ready events. The count of ready events is not currently exposed externally.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'AverageHoldTime' => ['description' => 'Average call hold duration, in seconds. Calculation Formula: TotalHoldTime / (InboundCallsHold + OutboundCallsHold).', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'TotalReadyTime' => ['description' => 'Total ready time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalBreakTime' => ['description' => 'Total break time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxTalkTime' => ['description' => 'Maximum talk time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalCalls' => ['description' => 'Total call volume. Calculation Formula: CallsOffered + CallsDialed.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxLoggedInAgents' => ['description' => 'Maximum number of agents simultaneously logged on during the Time Range.', 'type' => 'integer', 'format' => 'int64', 'example' => '102', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Internal' => [ 'description' => 'Internal call metrics.', 'type' => 'object', 'properties' => [ 'CallsDialed' => ['description' => 'Dial-up volume.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'CallsAnswered' => ['description' => 'Number of answered calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ], ], 'title' => 'Retrieve Historical Instance Data Report', 'summary' => 'You can invoke GetHistoricalInstanceReport to obtain the historical data report for a specified instance.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-11-22T01:05:26.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHistoricalInstanceReport'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"943D8EF3-3321-471F-A104-51C96FCA94D6\\",\\n \\"Data\\": {\\n \\"Inbound\\": {\\n \\"AverageRingTime\\": 0,\\n \\"CallsVoicemail\\": 0,\\n \\"MaxAbandonedInIVRTime\\": 100,\\n \\"CallsHandled\\": 0,\\n \\"CallsIVRException\\": 0,\\n \\"CallsAbandonedInIVR\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"TotalHoldTime\\": 0,\\n \\"MaxAbandonTime\\": 0,\\n \\"AverageAbandonTime\\": 0,\\n \\"CallsRinged\\": 0,\\n \\"CallsQueuingFailed\\": 0,\\n \\"TotalRingTime\\": 0,\\n \\"AbandonRate\\": 0,\\n \\"TotalTalkTime\\": 0,\\n \\"MaxAbandonedInRingTime\\": 0,\\n \\"CallsBlindTransferred\\": 0,\\n \\"AverageAbandonedInIVRTime\\": 0,\\n \\"AverageAbandonedInQueueTime\\": 0,\\n \\"MaxWaitTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"CallsAttendedTransferred\\": 0,\\n \\"TotalAbandonedInIVRTime\\": 0,\\n \\"CallsQueuingOverflow\\": 0,\\n \\"CallsAbandonedInRing\\": 0,\\n \\"TotalAbandonedInRingTime\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"AverageWaitTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"CallsQueued\\": 0,\\n \\"AverageAbandonedInRingTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"CallsAbandoned\\": 0,\\n \\"MaxAbandonedInQueueTime\\": 0,\\n \\"CallsAbandonedInVoiceNavigator\\": 0,\\n \\"TotalWaitTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"MaxRingTime\\": 0,\\n \\"TotalAbandonTime\\": 0,\\n \\"CallsOffered\\": 0,\\n \\"CallsQueuingTimeout\\": 0,\\n \\"ServiceLevel20\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"CallsForwardToOutsideNumber\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"CallsHold\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"HandleRate\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"CallsAbandonedInQueue\\": 0,\\n \\"TotalAbandonedInQueueTime\\": 0,\\n \\"CallsCausedIVRException\\": 0,\\n \\"CallsToVoicemail\\": 3,\\n \\"ServiceLevel15\\": 0.78,\\n \\"ServiceLevel30\\": 0.9,\\n \\"TotalMessagesSent\\": 12,\\n \\"TotalMessagesSentByAgent\\": 8,\\n \\"TotalMessagesSentByCustomer\\": 4,\\n \\"AverageFirstResponseTime\\": 12,\\n \\"AccessChannelTypeDetailList\\": [\\n {\\n \\"AccessChannelType\\": \\"Web\\",\\n \\"CallsOffered\\": 5\\n }\\n ],\\n \\"AverageResponseTime\\": 15\\n },\\n \\"Outbound\\": {\\n \\"AverageRingTime\\": 0,\\n \\"CallsDialed\\": 0,\\n \\"CallsAnswered\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"TotalDialingTime\\": 0,\\n \\"TotalHoldTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"CallsRinged\\": 0,\\n \\"TotalRingTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"MaxRingTime\\": 0,\\n \\"TotalTalkTime\\": 0,\\n \\"MaxDialingTime\\": 0,\\n \\"CallsBlindTransferred\\": 0,\\n \\"AnswerRate\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"CallsAttendedTransferred\\": 0,\\n \\"CallsHold\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"AverageDialingTime\\": 0\\n },\\n \\"Overall\\": {\\n \\"TotalTalkTime\\": 0,\\n \\"TotalLoggedInTime\\": 0,\\n \\"OccupancyRate\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"AverageBreakTime\\": 0,\\n \\"TotalHoldTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"MaxBreakTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"MaxReadyTime\\": 0,\\n \\"AverageReadyTime\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"TotalReadyTime\\": 0,\\n \\"TotalBreakTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"TotalCalls\\": 0,\\n \\"MaxLoggedInAgents\\": 102\\n },\\n \\"Internal\\": {\\n \\"CallsDialed\\": 100,\\n \\"CallsAnswered\\": 100\\n }\\n }\\n}","type":"json"}]', ], 'GetInstance' => [ 'summary' => 'Retrieves the details of a Cloud Contact Center instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccTMAX45'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2778FA12-EDD6-42AA-9B15-AF855072E5E5', 'title' => ''], 'Data' => [ 'description' => 'The data.', 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The instance status.', 'enumValueTitles' => ['RELEASED' => 'The instance is released.', 'RUNNING' => 'The instance is running.', 'STOPPED' => 'The service is stopped.', 'CREATING' => 'The instance is being created.'], 'type' => 'string', 'example' => 'RUNNING', 'title' => '', ], 'ConsoleUrl' => ['description' => 'The URL of the Cloud Contact Center instance homepage. This URL is formed by combining the base URL of Cloud Contact Center and the instance ID.', 'type' => 'string', 'example' => 'https://ccc-v2.aliyun.com/#/workbench/ccc-test', 'title' => ''], 'Description' => ['description' => 'The description of the instance.', 'type' => 'string', 'example' => '云联络中心的测试实例。', 'title' => ''], 'AliyunUid' => ['description' => 'The ID of the Alibaba Cloud account to which the instance belongs.', 'type' => 'string', 'example' => '157123456789****', 'title' => ''], 'Name' => ['description' => 'The instance name.', 'type' => 'string', 'example' => '测试实例', 'title' => ''], 'DomainName' => ['description' => 'The domain name of the instance. It is globally unique.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'Id' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'ccc-test'."\n", 'title' => ''], 'AdminList' => [ 'description' => 'The list of administrators.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'DisplayName' => ['description' => 'The name of the administrator.', 'type' => 'string', 'example' => '管理员', 'title' => ''], 'Extension' => ['description' => 'The agent\'s extension number.', 'type' => 'string', 'example' => '8032****', 'title' => ''], 'LoginName' => ['description' => 'The agent\'s logon name.', 'type' => 'string', 'example' => 'agent', 'title' => ''], 'Email' => ['description' => 'The mailbox.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], 'WorkMode' => [ 'description' => 'The work mode.', 'enumValueTitles' => ['ON_SITE' => 'On-site', 'OFF_SITE' => 'Off-site', 'OFFICE_PHONE' => 'Office phone'], 'type' => 'string', 'example' => 'ON_SITE', 'title' => '', ], 'Mobile' => ['description' => 'The agent\'s personal phone number.', 'type' => 'string', 'example' => '1382114****', 'title' => ''], 'UserId' => ['description' => 'The agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'RoleName' => [ 'description' => 'The role name.', 'enumValueTitles' => ['Agent' => 'Agent', 'Manager' => 'Skill group leader', 'Admin' => 'Administrator'], 'type' => 'string', 'example' => 'Admin', 'title' => '', ], 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'RoleId' => ['description' => 'The role ID. The format is: Role\\@Instance ID.', 'type' => 'string', 'example' => 'Admin@ccc-test', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'NumberList' => [ 'description' => 'The list of numbers.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Active' => ['description' => 'Indicates whether the number is active.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'UserId' => ['description' => 'The agent ID. If this parameter is not empty, the number is a personal outbound number for the agent.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'Number' => ['description' => 'The phone number.', 'type' => 'string', 'example' => '0830011****', 'title' => ''], 'City' => ['description' => 'The city where the number is registered.', 'type' => 'string', 'example' => '乐山', 'title' => ''], 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'Usage' => [ 'description' => 'The purpose of the number.', 'enumValueTitles' => ['Outbound' => 'Outbound calls', 'Inbound' => 'Inbound calls', 'Bidirection' => 'Inbound and outbound calls'], 'type' => 'string', 'example' => 'Bidirection', 'title' => '', ], 'ContactFlowId' => ['description' => 'The ID of the contact flow (IVR) associated with the phone number.', 'type' => 'string', 'example' => '2ec7a58f-3243-4815-bb21-97b480b95f5e', 'title' => ''], 'Province' => ['description' => 'The province where the number is registered.', 'type' => 'string', 'example' => '四川', 'title' => ''], 'SkillGroups' => [ 'description' => 'The list of skill groups associated with the number.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'DisplayName' => ['description' => 'The display name of the skill group.', 'type' => 'string', 'example' => '测试技能组', 'title' => ''], 'Description' => ['description' => 'The description of the skill group.', 'type' => 'string', 'example' => '云联络中心的测试技能组。', 'title' => ''], 'PhoneNumberCount' => ['description' => 'The number of phone numbers associated with the skill group.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'SkillGroupId' => ['description' => 'The skill group ID.', 'type' => 'string', 'example' => 'skillgroup@ccc-test', 'title' => ''], 'UserCount' => ['description' => 'The number of agents associated with the skill group.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'Name' => ['description' => 'The name of the skill group.', 'type' => 'string', 'example' => 'skillgroup', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'ChatbotBusinessUnit' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'UnitId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], 'UnitKey' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], 'AgentType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"2778FA12-EDD6-42AA-9B15-AF855072E5E5\\",\\n \\"Data\\": {\\n \\"Status\\": \\"RUNNING\\",\\n \\"ConsoleUrl\\": \\"https://ccc-v2.aliyun.com/#/workbench/ccc-test\\",\\n \\"Description\\": \\"云联络中心的测试实例。\\",\\n \\"AliyunUid\\": \\"157123456789****\\",\\n \\"Name\\": \\"测试实例\\",\\n \\"DomainName\\": \\"ccc-test\\",\\n \\"Id\\": \\"ccc-test\\\\n\\",\\n \\"AdminList\\": [\\n {\\n \\"DisplayName\\": \\"管理员\\",\\n \\"Extension\\": \\"8032****\\",\\n \\"LoginName\\": \\"agent\\",\\n \\"Email\\": \\"username@example.com\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"Mobile\\": \\"1382114****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"RoleName\\": \\"Admin\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"RoleId\\": \\"Admin@ccc-test\\"\\n }\\n ],\\n \\"NumberList\\": [\\n {\\n \\"Active\\": true,\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Number\\": \\"0830011****\\",\\n \\"City\\": \\"乐山\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Usage\\": \\"Bidirection\\",\\n \\"ContactFlowId\\": \\"2ec7a58f-3243-4815-bb21-97b480b95f5e\\",\\n \\"Province\\": \\"四川\\",\\n \\"SkillGroups\\": [\\n {\\n \\"DisplayName\\": \\"测试技能组\\",\\n \\"Description\\": \\"云联络中心的测试技能组。\\",\\n \\"PhoneNumberCount\\": 1,\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"UserCount\\": 3,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Name\\": \\"skillgroup\\"\\n }\\n ]\\n }\\n ],\\n \\"ChatbotBusinessUnit\\": {\\n \\"UnitId\\": 0,\\n \\"UnitKey\\": \\"\\"\\n },\\n \\"AgentType\\": \\"\\"\\n }\\n}","type":"json"}]', 'title' => 'Get Instance', 'changeSet' => [ ['createdAt' => '2025-10-16T07:13:16.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstance'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'GetInstanceTrendingReport' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'Start UNIX timestamp. The default value is the start time of the current day. The earliest allowed time is 180 days before the current time. The interval between the start time and end time cannot exceed 7 days. The format is a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1604639129000', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'End UNIX timestamp. The default value is the current time. The format is a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1604725528000', 'title' => ''], ], [ 'name' => 'MediaType', 'in' => 'query', 'schema' => ['description' => 'Media type. The default value is Audio. Other valid values include Chat and Video.', 'type' => 'string', 'required' => false, 'example' => 'Audio', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '943D8EF3-3321-471F-A104-51C96FCA94D6', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'Inbound' => [ 'description' => 'Inbound metrics.', 'type' => 'array', 'items' => [ 'description' => 'Segmented statistics for inbound metrics.', 'type' => 'object', 'properties' => [ 'StatsTime' => ['description' => 'The start time of the segment statistics, in UNIX timestamp format, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1604639129000', 'title' => ''], 'CallsQueued' => ['description' => 'Number of calls that entered the queue. If a single call enters the queue multiple times, it is counted as one call.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsAbandonedInRing' => ['description' => 'Number of calls abandoned during ringing.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsHandled' => ['description' => 'Number of calls answered by agents. If a single call is distributed to multiple agents, it is counted as one call.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalCalls' => ['description' => 'Total number of incoming calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsAbandonedInIVR' => ['description' => 'Number of calls abandoned in the IVR, meaning calls that were abandoned during the IVR flow after entering it.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsAbandonedInQueue' => ['description' => 'Number of calls abandoned in the queue, meaning calls that were abandoned while waiting in the skill group queue after entering it.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Outbound' => [ 'description' => 'Outbound metrics.', 'type' => 'array', 'items' => [ 'description' => 'Segmented statistics for outbound metrics.', 'type' => 'object', 'properties' => [ 'StatsTime' => ['description' => 'Start time of the segment, in UNIX timestamp format, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1604639129000', 'title' => ''], 'CallsAnswered' => ['description' => 'Number of answered outbound calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalCalls' => ['description' => 'Total number of outbound calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Overall' => [ 'description' => 'Overall metrics.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'StatsTime' => ['description' => 'The start time of the segment statistics, in UNIX timestamp format, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1604639129000', 'title' => ''], 'MaxLoggedInAgents' => ['description' => 'Maximum number of agents logged on simultaneously during this time range.', 'type' => 'integer', 'format' => 'int64', 'example' => '102', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ], ], 'title' => 'Obtain instance trend report', 'summary' => 'You can call GetInstanceTrendingReport to retrieve the trend report for a specified instance.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-11-07T07:21:05.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstanceTrendingReport'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"943D8EF3-3321-471F-A104-51C96FCA94D6\\",\\n \\"Data\\": {\\n \\"Inbound\\": [\\n {\\n \\"StatsTime\\": 1604639129000,\\n \\"CallsQueued\\": 0,\\n \\"CallsAbandonedInRing\\": 0,\\n \\"CallsHandled\\": 0,\\n \\"TotalCalls\\": 0,\\n \\"CallsAbandonedInIVR\\": 0,\\n \\"CallsAbandonedInQueue\\": 0\\n }\\n ],\\n \\"Outbound\\": [\\n {\\n \\"StatsTime\\": 1604639129000,\\n \\"CallsAnswered\\": 0,\\n \\"TotalCalls\\": 0\\n }\\n ],\\n \\"Overall\\": [\\n {\\n \\"StatsTime\\": 1604639129000,\\n \\"MaxLoggedInAgents\\": 102\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'GetIvrTrackingSummary' => [ 'summary' => 'Retrieve the IVR tracking summary.', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccKJSOHN'], ], 'parameters' => [ [ 'name' => 'ContactId', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['description' => 'The call ID.', 'type' => 'string', 'required' => true, 'example' => 'job-489361145506897920', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0f7ad007-ab50-4b3d-a87a-56864eb40dab', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Error message.', 'type' => 'string', 'example' => 'Unknown error code \'NoPermission.Recording\'. Reason: null', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE ', 'title' => ''], 'Data' => ['description' => 'Returned data result.', 'type' => 'string', 'example' => '无', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid. %s', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Unknown error code \'NoPermission.Recording\'. Reason: null\\",\\n \\"RequestId\\": \\"DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\\\t\\",\\n \\"Data\\": \\"无\\"\\n}","type":"json"}]', 'title' => 'Obtain IVR trajectory summary ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'GetLoginDetails' => [ 'summary' => 'Invoke GetLoginDetails to obtain the agent\'s logon information, including basic agent information, server address information, authentication information, and more. This API can only be invoked by the agent themselves; administrators are not permitted to invoke it on behalf of others.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccBRR180'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'Agent ID. This parameter is optional. If not specified, the agent mapped to the current RAM account is used by default.', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test', 'title' => ''], ], [ 'name' => 'ChatDeviceId', 'in' => 'query', 'schema' => ['description' => 'Chat Device ID.', 'type' => 'string', 'required' => false, 'example' => '4c51c9116c36537cb850dc1081d745df', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'F1A4774A-F28B-5C40-AEF6-D88D2DD6C7E4', 'title' => ''], 'Params' => [ 'description' => 'Response parameters.', 'type' => 'array', 'items' => ['description' => 'Response parameters.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], 'Data' => [ 'description' => 'Logon information data.', 'type' => 'object', 'properties' => [ 'DisplayName' => ['description' => 'Agent display name.', 'type' => 'string', 'example' => '坐席小王', 'title' => ''], 'Extension' => ['description' => 'Agent extension number.', 'type' => 'string', 'example' => '8001****', 'title' => ''], 'Signature' => ['description' => 'Signature information generated using an asymmetric key encryption algorithm. This information is required for authentication when registering with the SIP server.', 'type' => 'string', 'example' => 'zi31STIMtIfa/UN2l+6lww****', 'title' => ''], 'SipServerUrl' => ['description' => 'SIP registration server URL. The agent must register with the server as an SIP user to perform transactional processing (TP) operations.', 'type' => 'string', 'example' => 'sh-sip-ccc.aliyuncs.com:443', 'title' => ''], 'DeviceId' => ['description' => 'If the agent has registered an SIP phone, this parameter is the Device ID of the SIP phone device; otherwise, it is empty.', 'type' => 'string', 'example' => 'Yealink SIP-T23G 44.84.XX.XX', 'title' => ''], 'AgentServerUrl' => ['description' => 'Agent data push server URL. After a successful connection, the server pushes agent status data to the agent Workbench.', 'type' => 'string', 'example' => 'sh-wss-ccc.aliyuncs.com', 'title' => ''], 'UserId' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'UserKey' => ['description' => 'Signature data used to generate signature information. Because this signature mechanism does not support Chinese characters, UserKey2 is currently used for signing instead.', 'type' => 'string', 'example' => '坐席@aliyun:802001:1656406628862', 'title' => ''], 'WorkMode' => [ 'description' => 'Work mode.', 'enumValueTitles' => ['ON_SITE' => 'On-site mode', 'OFF_SITE' => 'Off-site mode', 'OFFICE_PHONE' => 'Office phone mode'], 'type' => 'string', 'example' => 'ON_SITE', 'title' => '', ], 'UserKey2' => ['description' => 'Signature data used to generate signature information. UserKey2 was added because UserKey does not support Chinese characters in signatures.', 'type' => 'string', 'example' => '802001:1656406628862"', 'title' => ''], 'Signature2' => ['description' => 'Signature information generated using an asymmetric key encryption algorithm. This information is required for authentication when registering with the SIP server.', 'type' => 'string', 'example' => 'zi31STIMtIfa/UN2l+6lww****', 'title' => ''], 'DeviceExt' => ['description' => 'SIP device extension number. This field is required when using a SIP phone.', 'type' => 'string', 'example' => '8033****', 'title' => ''], 'DeviceState' => [ 'description' => 'SIP device status.', 'enumValueTitles' => ['UNREGISTERED' => 'Unregistered', 'ONLINE' => 'Online', 'OFFLINE' => 'Offline'], 'type' => 'string', 'example' => 'OFFLINE', 'title' => '', ], 'ChatUserId' => ['description' => 'Chat session Device ID.', 'type' => 'string', 'example' => 'A-8000100x', 'title' => ''], 'ChatDeviceId' => ['description' => 'Chat Device ID.', 'type' => 'string', 'example' => '4c51c9116c36537cb850dc1081d745df', 'title' => ''], 'ChatLoginToken' => ['description' => 'Chat session logon token.', 'type' => 'string', 'example' => '{"accessToken":"oauth_cloud_key:4xxx0=","accessTokenExpiredTime":864xxxx,"refreshToken":"oauth_cloud_key:Paxxxx=="}', 'title' => ''], 'ChatAppId' => ['description' => 'Chat session application ID.', 'type' => 'string', 'example' => '7pjxxx', 'title' => ''], 'ChatAppKey' => ['description' => 'Chat session application key.', 'type' => 'string', 'example' => '955e4bd7xxxxxxxxxxxxxd7898ba9fa0d0', 'title' => ''], 'ChatServerUrl' => ['description' => 'Chat session server URL.', 'type' => 'string', 'example' => 'wss://wss.im.dingtalk.cn', 'title' => ''], 'Nickname' => ['description' => 'Agent nickname', 'type' => 'string', 'example' => '老王', 'title' => ''], 'AvatarUrl' => ['description' => 'Agent profile picture URL.', 'type' => 'string', 'example' => 'http://abc.com/sam.jpb', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => ''], ], ], 'title' => 'Obtain logon information ', 'changeSet' => [ ['createdAt' => '2023-11-07T07:21:07.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2022-01-19T00:08:15.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2021-12-22T06:05:17.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLoginDetails'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"F1A4774A-F28B-5C40-AEF6-D88D2DD6C7E4\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"DisplayName\\": \\"坐席小王\\",\\n \\"Extension\\": \\"8001****\\",\\n \\"Signature\\": \\"zi31STIMtIfa/UN2l+6lww****\\",\\n \\"SipServerUrl\\": \\"sh-sip-ccc.aliyuncs.com:443\\",\\n \\"DeviceId\\": \\"Yealink SIP-T23G 44.84.XX.XX\\",\\n \\"AgentServerUrl\\": \\"sh-wss-ccc.aliyuncs.com\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"UserKey\\": \\"坐席@aliyun:802001:1656406628862\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"UserKey2\\": \\"802001:1656406628862\\\\\\"\\",\\n \\"Signature2\\": \\"zi31STIMtIfa/UN2l+6lww****\\",\\n \\"DeviceExt\\": \\"8033****\\",\\n \\"DeviceState\\": \\"OFFLINE\\",\\n \\"ChatUserId\\": \\"A-8000100x\\",\\n \\"ChatDeviceId\\": \\"4c51c9116c36537cb850dc1081d745df\\",\\n \\"ChatLoginToken\\": \\"{\\\\\\"accessToken\\\\\\":\\\\\\"oauth_cloud_key:4xxx0=\\\\\\",\\\\\\"accessTokenExpiredTime\\\\\\":864xxxx,\\\\\\"refreshToken\\\\\\":\\\\\\"oauth_cloud_key:Paxxxx==\\\\\\"}\\",\\n \\"ChatAppId\\": \\"7pjxxx\\",\\n \\"ChatAppKey\\": \\"955e4bd7xxxxxxxxxxxxxd7898ba9fa0d0\\",\\n \\"ChatServerUrl\\": \\"wss://wss.im.dingtalk.cn\\",\\n \\"Nickname\\": \\"老王\\",\\n \\"AvatarUrl\\": \\"http://abc.com/sam.jpb\\"\\n }\\n}","type":"json"}]', ], 'GetMonoRecording' => [ 'summary' => 'You can invoke GetMonoRecording to obtain the single-track recording of a specified call under a specified instance. A single-track recording contains only one audio track, with both the agent-side and customer-side recordings merged into the same track in WAV format.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccKYIENB'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'ContactId', 'in' => 'query', 'schema' => ['description' => 'Call ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6538214103689****', 'title' => ''], ], [ 'name' => 'ExpireSeconds', 'in' => 'query', 'schema' => ['description' => 'Expiration time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '300', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'FileUrl' => ['description' => 'The OSS download URL of the recording file. Note that the download URL expires after a validity period of 1 Day.', 'type' => 'string', 'example' => 'http://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-record/job-6538214103689****.wav?Expires=1610910578&OSSAccessKeyId=****&Signature=****', 'title' => ''], 'FileName' => ['description' => 'Recording file name.', 'type' => 'string', 'example' => 'job-6538214103689****.wav', 'title' => ''], 'Duration' => ['description' => 'Recording duration, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '30000', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => ''], ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Obtain Single-Track Recording', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-06-05T09:01:48.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '400', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMonoRecording'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"FileUrl\\": \\"http://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-record/job-6538214103689****.wav?Expires=1610910578&OSSAccessKeyId=****&Signature=****\\",\\n \\"FileName\\": \\"job-6538214103689****.wav\\",\\n \\"Duration\\": 30000\\n }\\n}","type":"json"}]', ], 'GetMultiChannelRecording' => [ 'summary' => 'You can invoke GetMultiChannelRecording to obtain the multi-track recording of a specified call under a specified instance. In the multi-track recording, the agent\'s and customer\'s audio are distributed across different sound channels. During each playback, only one sound channel can be played, meaning you can hear only one party\'s voice. The format is MKV.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccKYIENB'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'ContactId', 'in' => 'query', 'schema' => ['description' => 'Call ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6538214103689****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'FileUrl' => ['description' => 'The OSS download URL of the recording file. Note that the download URL expires after a validity period of 1 day.', 'type' => 'string', 'example' => 'https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-record-mixed/ccc-test/2021/04/job-6538214103689****.mkv?Expires=1617435462&OSSAccessKeyId=****&Signature=****', 'title' => ''], 'FileName' => ['description' => 'Recording file name.', 'type' => 'string', 'example' => 'job-6538214103689****.mkv', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Obtain Multi-Track Recording', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMultiChannelRecording'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"FileUrl\\": \\"https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-record-mixed/ccc-test/2021/04/job-6538214103689****.mkv?Expires=1617435462&OSSAccessKeyId=****&Signature=****\\",\\n \\"FileName\\": \\"job-6538214103689****.mkv\\"\\n }\\n}","type":"json"}]', ], 'GetNumberLocation' => [ 'summary' => 'Invoke the GetNumberLocation API to obtain number location information.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc1MRAID'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'Number', 'in' => 'query', 'schema' => ['description' => 'The number to query.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1312121****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '584AA2E3-9AC4-561B-BC8D-C74BA11B1387', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'Number' => ['description' => 'Number.', 'type' => 'string', 'example' => '1312121****', 'title' => ''], 'City' => ['description' => 'City of the number\'s registration location.', 'type' => 'string', 'example' => '北京', 'title' => ''], 'Province' => ['description' => 'Province of the number\'s registration location.', 'type' => 'string', 'example' => '北京', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Obtain Number Location Information', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetNumberLocation'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"584AA2E3-9AC4-561B-BC8D-C74BA11B1387\\",\\n \\"Data\\": {\\n \\"Number\\": \\"1312121****\\",\\n \\"City\\": \\"北京\\",\\n \\"Province\\": \\"北京\\"\\n }\\n}","type":"json"}]', ], 'GetRealtimeCampaignStats' => [ 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccQFUGXR'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['title' => 'Instance ID', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'."\n"], ], [ 'name' => 'QueueId', 'in' => 'query', 'schema' => ['title' => 'Activity ID', 'description' => 'The predictive outbound dialing activity ID.', 'type' => 'string', 'required' => true, 'example' => 'skillgroup@ccc-test'."\n"], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '42970829-E2C8-515A-8F42-5A6B59F852A7', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'LoggedInAgents' => ['description' => 'Number of logged-in agents.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], 'ReadyAgents' => ['description' => 'Number of idle agents.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], 'BreakingAgents' => ['description' => 'Number of agents on break.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'TalkingAgents' => ['description' => 'Number of agents in a call.', 'type' => 'integer', 'format' => 'int64', 'example' => '4', 'title' => ''], 'WorkingAgents' => ['description' => 'Number of agents in post-processing.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], 'Caps' => ['description' => 'The number of concurrent calls per second. "Concurrent" means calls happening simultaneously.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], 'TotalAgents' => ['description' => 'Total number of agents.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], 'OutboundScenarioReadyAgents' => ['description' => 'The number of agents in outbound-only mode who are idle.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'OutboundScenarioBreakingAgents' => ['description' => 'The number of agents in outbound-only mode who are on a break.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'OutboundScenarioTalkingAgents' => ['description' => 'Number of agents in a call under outbound-only mode.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'OutboundScenarioWorkingAgents' => ['description' => 'Number of agents in post-processing status under outbound-only mode.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'title' => 'Retrieve real-time agent status for a predictive outbound dialing activity', 'summary' => 'You can invoke GetRealtimeCampaignStats to retrieve real-time agent status data for a predictive outbound calling Activity with a specified ID under a specified instance.', 'changeSet' => [ ['createdAt' => '2023-11-07T07:21:06.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRealtimeCampaignStats'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"42970829-E2C8-515A-8F42-5A6B59F852A7\\",\\n \\"Data\\": {\\n \\"LoggedInAgents\\": 10,\\n \\"ReadyAgents\\": 3,\\n \\"BreakingAgents\\": 1,\\n \\"TalkingAgents\\": 4,\\n \\"WorkingAgents\\": 2,\\n \\"Caps\\": 5,\\n \\"TotalAgents\\": 10,\\n \\"OutboundScenarioReadyAgents\\": 1,\\n \\"OutboundScenarioBreakingAgents\\": 1,\\n \\"OutboundScenarioTalkingAgents\\": 1,\\n \\"OutboundScenarioWorkingAgents\\": 1\\n }\\n}","type":"json"}]', ], 'GetRealtimeInstanceStates' => [ 'summary' => 'You can invoke GetRealtimeInstanceStates to obtain the real-time status of a specified instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccTMAX45'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'MediaType', 'in' => 'query', 'schema' => [ 'description' => 'Media type. The default is audio (AUDIO).', 'enumValueTitles' => ['ALL' => 'All', 'VIDEO' => 'Video', 'CHAT' => 'Chat', 'AUDIO' => 'Audio'], 'type' => 'string', 'required' => false, 'example' => 'AUDIO', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '943D8EF3-3321-471F-A104-51C96FCA94D6', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'WorkingAgents' => ['description' => 'Number of agents in post-processing status.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'LongestWaitingTime' => ['description' => 'Maximum queue waiting time among currently queued incoming calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'LoggedInAgents' => ['description' => 'Number of logged-in agents (including agents in ready, on break, on call, or other non-unpublished statuses).', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalAgents' => ['description' => 'Total number of agents.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'WaitingCalls' => ['description' => 'Number of incoming calls currently queued.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'BreakingAgents' => ['description' => 'Number of agents on break.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TalkingAgents' => ['description' => 'Number of agents on calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'InteractiveCalls' => ['description' => 'Number of calls interacting within IVR.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'ReadyAgents' => ['description' => 'Number of agents in ready status.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'BreakCodeDetailList' => [ 'description' => 'List of distributions of break code counts.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'BreakCode' => ['description' => 'Break code.', 'type' => 'string', 'example' => '默认', 'title' => ''], 'Count' => ['description' => 'Break count.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ], ], 'title' => 'Get real-time instance status', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-11-07T07:21:06.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRealtimeInstanceStates'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"943D8EF3-3321-471F-A104-51C96FCA94D6\\",\\n \\"Data\\": {\\n \\"WorkingAgents\\": 0,\\n \\"LongestWaitingTime\\": 0,\\n \\"LoggedInAgents\\": 0,\\n \\"TotalAgents\\": 0,\\n \\"WaitingCalls\\": 0,\\n \\"BreakingAgents\\": 0,\\n \\"TalkingAgents\\": 0,\\n \\"InteractiveCalls\\": 0,\\n \\"ReadyAgents\\": 0,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"BreakCodeDetailList\\": [\\n {\\n \\"BreakCode\\": \\"默认\\",\\n \\"Count\\": 1\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'GetSchema' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'parameters' => [ [ 'name' => 'SchemaId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the schema.', 'type' => 'string', 'required' => true, 'example' => 'profile', 'title' => ''], ], [ 'name' => 'RequestId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the request.', 'type' => 'string', 'required' => false, 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1xxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'GetSchemaResponse', 'title' => 'GetSchemaResponse ', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'InstanceId' => ['description' => 'The ID of the instance.', 'type' => 'string', 'example' => '5e0964fd-951c-4e45-b518-d09d4d2db8ca', 'title' => ''], 'Id' => ['description' => 'The ID of the schema.', 'type' => 'string', 'example' => 'profile', 'title' => ''], 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => '客户profile', 'title' => ''], 'Properties' => [ 'description' => 'The list of fields.', 'additionalProperties' => [ 'description' => 'A field.', 'type' => 'object', 'properties' => [ 'DisplayName' => ['description' => 'The display name.', 'type' => 'string', 'example' => '姓名', 'title' => ''], 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'name', 'title' => ''], 'Name' => ['description' => 'The name.', 'type' => 'string', 'example' => 'name', 'title' => ''], 'DataType' => ['description' => 'The data type.', 'type' => 'string', 'example' => 'string', 'title' => ''], 'Pattern' => ['description' => 'The regular expression that is used for validation.', 'type' => 'string', 'example' => '^', 'title' => ''], 'PatternErrorMessage' => ['description' => 'The error message that is returned if the value does not match the regular expression.', 'type' => 'string', 'example' => '不是有效的email地址', 'title' => ''], 'MinLength' => ['description' => 'The minimum length.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'MaxLength' => ['description' => 'The maximum length.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'Minimum' => ['description' => 'The minimum value.', 'type' => 'number', 'format' => 'double', 'example' => '1', 'title' => ''], 'Maximum' => ['description' => 'The maximum value.', 'type' => 'number', 'format' => 'double', 'example' => '10', 'title' => ''], 'Required' => ['description' => 'Indicates whether the field is required.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'System' => ['description' => 'Indicates whether the field is a system field.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Disabled' => ['description' => 'Indicates whether the field is disabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Array' => ['description' => 'Indicates whether the field is an array.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'ReadOnly' => ['description' => 'Indicates whether the field is read-only.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'EditorType' => ['description' => 'The type of the editor.', 'type' => 'string', 'example' => 'textbox', 'title' => ''], 'Attributes' => ['description' => 'The extended properties.', 'type' => 'string', 'example' => '{}', 'title' => ''], 'DisplayOrder' => ['description' => 'The display order.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'CreatedTime' => ['description' => 'The time when the field was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '2021-07-14 10:48:43.0', 'title' => ''], 'UpdatedTime' => ['description' => 'The time when the field was last updated.', 'type' => 'integer', 'format' => 'int64', 'example' => '2021-07-14 10:48:43.0', 'title' => ''], 'Creator' => ['description' => 'Creator', 'type' => 'string', 'example' => 'tom', 'title' => ''], ], 'title' => '', 'example' => '', ], 'type' => 'object', 'title' => '', 'example' => '', ], 'CreatedTime' => ['description' => 'The time when the schema was created.', 'type' => 'string', 'example' => '2021-07-14 10:48:43.0', 'title' => ''], 'UpdatedTime' => ['description' => 'The time when the schema was last modified.', 'type' => 'string', 'example' => '2021-07-14 10:48:43.0', 'title' => ''], 'Deleted' => ['description' => 'Indicates whether the schema is deleted.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '19D09CCC-F298-4124-849A-AFA217819011', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Service abnormal, the instance 0418 is ceased.', 'title' => ''], 'Params' => [ 'description' => 'The response parameters.', 'type' => 'array', 'items' => ['description' => 'A response parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"InstanceId\\": \\"5e0964fd-951c-4e45-b518-d09d4d2db8ca\\",\\n \\"Id\\": \\"profile\\",\\n \\"Description\\": \\"客户profile\\",\\n \\"Properties\\": {\\n \\"key\\": {\\n \\"DisplayName\\": \\"姓名\\",\\n \\"Description\\": \\"name\\",\\n \\"Name\\": \\"name\\",\\n \\"DataType\\": \\"string\\",\\n \\"Pattern\\": \\"^\\",\\n \\"PatternErrorMessage\\": \\"不是有效的email地址\\",\\n \\"MinLength\\": 1,\\n \\"MaxLength\\": 10,\\n \\"Minimum\\": 1,\\n \\"Maximum\\": 10,\\n \\"Required\\": false,\\n \\"System\\": false,\\n \\"Disabled\\": false,\\n \\"Array\\": false,\\n \\"ReadOnly\\": false,\\n \\"EditorType\\": \\"textbox\\",\\n \\"Attributes\\": \\"{}\\",\\n \\"DisplayOrder\\": 1,\\n \\"CreatedTime\\": 0,\\n \\"UpdatedTime\\": 0,\\n \\"Creator\\": \\"tom\\"\\n }\\n },\\n \\"CreatedTime\\": \\"2021-07-14 10:48:43.0\\",\\n \\"UpdatedTime\\": \\"2021-07-14 10:48:43.0\\",\\n \\"Deleted\\": false\\n },\\n \\"RequestId\\": \\"19D09CCC-F298-4124-849A-AFA217819011\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Service abnormal, the instance 0418 is ceased.\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', 'title' => 'Get schema ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'summary' => '', ], 'GetSkillGroup' => [ 'summary' => 'You can invoke GetSkillGroup to obtain information about the skill group corresponding to a specified skill group ID under a specified instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccPBOQGO'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'SkillGroupId', 'in' => 'query', 'schema' => ['description' => 'Skill group ID, in the format: skill group name\\@instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'skillgroup@ccc-test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'CF1C21B9-2D49-4B54-880F-FBE248C16903', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'DisplayName' => ['description' => 'Display name of the skill group.', 'type' => 'string', 'example' => '测试技能组', 'title' => ''], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'Name' => ['description' => 'Name of the skill group.', 'type' => 'string', 'example' => 'skillgroup', 'title' => ''], 'Description' => ['description' => 'Description of the skill group.', 'type' => 'string', 'example' => '云联络中心的测试技能组。', 'title' => ''], 'SkillGroupId' => ['description' => 'Skill group ID, in the format: skill group name\\@instance ID.', 'type' => 'string', 'example' => 'skillgroup@ccc-test', 'title' => ''], 'MediaType' => ['description' => 'Media type. The default value is AUDIO. Other valid values include CHAT and VIDEO.', 'type' => 'string', 'example' => 'VIDEO', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => ''], ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Get Skill Group', 'changeSet' => [ ['createdAt' => '2023-11-06T05:44:50.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSkillGroup'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"CF1C21B9-2D49-4B54-880F-FBE248C16903\\",\\n \\"Data\\": {\\n \\"DisplayName\\": \\"测试技能组\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Name\\": \\"skillgroup\\",\\n \\"Description\\": \\"云联络中心的测试技能组。\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"MediaType\\": \\"VIDEO\\"\\n }\\n}","type":"json"}]', ], 'GetSummaryTemplate' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => ['description' => 'The template ID.', 'type' => 'string', 'required' => true, 'example' => '43c2671b-8939-4223-86d0-6bd187905cc8_1717664210492', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ccc-test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'GetSummaryTemplateResponse', 'title' => 'GetSummaryTemplateResponse ', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The data.', 'type' => 'object', 'properties' => [ 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'example' => '43c2671b-8939-4223-86d0-6bd187905cc8_1717664210492'."\n", 'title' => ''], 'CategoryId' => ['description' => 'The ID of the summary category.', 'type' => 'string', 'example' => '8939-4223-86d0-6bd187905cc8', 'title' => ''], 'Name' => ['description' => 'The name of the template.', 'type' => 'string', 'example' => '测试模板', 'title' => ''], 'State' => ['description' => 'The status code.'."\n" ."\n" .'- Enabled: The template is enabled.'."\n" ."\n" .'- Disabled: The template is disabled.', 'type' => 'string', 'example' => 'Enabled', 'title' => ''], 'Editor' => ['description' => 'The user who edited the template.', 'type' => 'string', 'example' => 'editor-xxx@ccc-test', 'title' => ''], 'PropertyList' => [ 'description' => 'The list of template fields.', 'type' => 'array', 'items' => [ 'description' => 'The field definition.', 'type' => 'object', 'properties' => [ 'DisplayName' => ['description' => 'The display name.', 'type' => 'string', 'example' => 'DisplayName-A', 'title' => ''], 'Description' => ['description' => 'The description of the field.', 'type' => 'string', 'example' => 'Description-xxxx', 'title' => ''], 'Name' => ['description' => 'The name of the field.', 'type' => 'string', 'example' => 'Name-A', 'title' => ''], 'DataType' => ['description' => 'The data type.', 'type' => 'string', 'example' => 'string'."\n", 'title' => ''], 'Pattern' => ['description' => 'The validation rule that is specified by a regular expression.', 'type' => 'string', 'example' => '^', 'title' => ''], 'PatternErrorMessage' => ['description' => 'The error message that is returned when the regular expression fails to pass the validation.', 'type' => 'string', 'example' => '不是有效的email地址'."\n", 'title' => ''], 'MinLength' => ['description' => 'The minimum length.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'MaxLength' => ['description' => 'The maximum length.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], 'Minimum' => ['description' => 'The minimum value of the number.', 'type' => 'number', 'format' => 'double', 'example' => '1', 'title' => ''], 'Maximum' => ['description' => 'The maximum value of the number.', 'type' => 'number', 'format' => 'double', 'example' => '10', 'title' => ''], 'Required' => ['description' => 'Indicates whether the field is required.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'System' => ['description' => 'Indicates whether the field is a system field.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Disabled' => ['description' => 'Indicates whether the field is disabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Array' => ['description' => 'Indicates whether the field is an array.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'ReadOnly' => ['description' => 'Indicates whether the field is read-only.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'EditorType' => ['description' => 'The type of the editor.', 'type' => 'string', 'example' => 'textbox', 'title' => ''], 'Attributes' => ['description' => 'The extended properties.', 'type' => 'string', 'example' => '{}', 'title' => ''], 'DisplayOrder' => ['description' => 'The display order in the list.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'CreatedTime' => ['description' => 'The time when the field was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1717664210000', 'title' => ''], 'UpdatedTime' => ['description' => 'The time when the field was last updated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1717664210000', 'title' => ''], 'Creator' => ['description' => 'The user who created the field.', 'type' => 'string', 'example' => 'cretor-xxx@ccc-test'."\n", 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '30C7D235-DDCF-4C7F-A462-5E2598252C2B', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Params' => [ 'description' => 'The list of error parameters.', 'type' => 'array', 'items' => ['description' => 'The error parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"TemplateId\\": \\"43c2671b-8939-4223-86d0-6bd187905cc8_1717664210492\\\\n\\",\\n \\"CategoryId\\": \\"8939-4223-86d0-6bd187905cc8\\",\\n \\"Name\\": \\"测试模板\\",\\n \\"State\\": \\"Enabled\\",\\n \\"Editor\\": \\"editor-xxx@ccc-test\\",\\n \\"PropertyList\\": [\\n {\\n \\"DisplayName\\": \\"DisplayName-A\\",\\n \\"Description\\": \\"Description-xxxx\\",\\n \\"Name\\": \\"Name-A\\",\\n \\"DataType\\": \\"string\\\\n\\",\\n \\"Pattern\\": \\"^\\",\\n \\"PatternErrorMessage\\": \\"不是有效的email地址\\\\n\\",\\n \\"MinLength\\": 1,\\n \\"MaxLength\\": 30,\\n \\"Minimum\\": 1,\\n \\"Maximum\\": 10,\\n \\"Required\\": false,\\n \\"System\\": false,\\n \\"Disabled\\": false,\\n \\"Array\\": false,\\n \\"ReadOnly\\": false,\\n \\"EditorType\\": \\"textbox\\",\\n \\"Attributes\\": \\"{}\\",\\n \\"DisplayOrder\\": 1,\\n \\"CreatedTime\\": 1717664210000,\\n \\"UpdatedTime\\": 1717664210000,\\n \\"Creator\\": \\"cretor-xxx@ccc-test\\\\n\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"30C7D235-DDCF-4C7F-A462-5E2598252C2B\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', 'title' => 'Retrieve session summary template', 'summary' => 'Retrieves the content of a session summary template.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'GetTicket' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'TicketId', 'in' => 'query', 'schema' => ['description' => 'The ticket ID.', 'type' => 'string', 'required' => true, 'example' => '3d26b90a-c5d2-4b09-8219-********', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'DescribeTicketResponse', 'title' => 'DescribeTicketResponse', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The data.', 'type' => 'object', 'properties' => [ 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'TicketId' => ['description' => 'The ticket ID.', 'type' => 'string', 'example' => 'b3a6a131-359e-46bd-9bc5-1f5cb0ea093f', 'title' => ''], 'TemplateId' => ['description' => 'The ticket template ID.', 'type' => 'string', 'example' => 'ccc-test_43c2671b-8939-4223-86d0-6bd187905cc8_*****0666238', 'title' => ''], 'TemplateVersion' => ['description' => 'The version of the ticket template.', 'type' => 'string', 'example' => '0', 'title' => ''], 'Title' => ['description' => 'The ticket title.', 'type' => 'string', 'example' => '售后工单', 'title' => ''], 'Context' => ['description' => 'The fields of the ticket.', 'type' => 'string', 'example' => '{"productName":"商品A"}', 'title' => ''], 'Assignee' => ['description' => 'The ID of the assignee.', 'type' => 'string', 'example' => 'agent1@ccc-test', 'title' => ''], 'AssigneeName' => ['description' => 'The name of the assignee.', 'type' => 'string', 'example' => '坐席A', 'title' => ''], 'Creator' => ['description' => 'The ID of the creator.', 'type' => 'string', 'example' => 'creator@ccc-test'."\n", 'title' => ''], 'CreatorName' => ['description' => 'The name of the creator.', 'type' => 'string', 'example' => '坐席B', 'title' => ''], 'CategoryId' => ['description' => 'The ticket category ID.', 'type' => 'string', 'example' => '8939-4223-86d0-6bd187905cc8', 'title' => ''], 'CategoryName' => ['description' => 'The name of the ticket category.', 'type' => 'string', 'example' => '售后类目', 'title' => ''], 'JobId' => ['description' => 'The call ID.', 'type' => 'string', 'example' => 'job-399383842187575296', 'title' => ''], 'StartTime' => ['description' => 'The time when the ticket processing started.', 'type' => 'integer', 'format' => 'int64', 'example' => '1620259200000', 'title' => ''], 'EndTime' => ['description' => 'The time when the ticket processing was completed.', 'type' => 'integer', 'format' => 'int64', 'example' => '1687846259999', 'title' => ''], 'CreatedTime' => ['description' => 'The time when the ticket was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1620259200000', 'title' => ''], 'UpdatedTime' => ['description' => 'The time of the last update.', 'type' => 'integer', 'format' => 'int64', 'example' => '1693793208075', 'title' => ''], 'CurrentTaskId' => ['description' => 'The ID of the current node.', 'type' => 'string', 'example' => '912f0b78-6639-4a93-ae18-0d832885c27e', 'title' => ''], 'CurrentTaskName' => ['description' => 'The name of the current node.', 'type' => 'string', 'example' => '节点1', 'title' => ''], 'CurrentTaskStartTime' => ['description' => 'The time when the current node started.', 'type' => 'integer', 'format' => 'int64', 'example' => '1693793208075', 'title' => ''], 'Source' => ['description' => 'The source of the ticket.'."\n" ."\n" .'- AUDIO: Voice service.'."\n" ."\n" .'- CHAT: Web service.'."\n" ."\n" .'- Console: Created in the ticket console.', 'type' => 'string', 'example' => 'Audio', 'title' => ''], 'CustomerId' => ['description' => 'The customer ID. This is the customer ID in the customer profile of Cloud Contact Center.', 'type' => 'string', 'example' => '4223-86d0-6bd187905-891798749', 'title' => ''], 'State' => ['description' => 'The ticket status.'."\n" ."\n" .'- Processing'."\n" ."\n" .'- Withdrawal'."\n" ."\n" .'- Rejected'."\n" ."\n" .'- Closed', 'type' => 'string', 'example' => 'Processing', 'title' => ''], 'CloseCode' => ['description' => 'The reason for closing the ticket.'."\n" ."\n" .'- Completed'."\n" ."\n" .'- Terminated', 'type' => 'string', 'example' => 'Completed', 'title' => ''], 'Comment' => ['description' => 'The comment.', 'type' => 'string', 'example' => '无', 'title' => ''], ], 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BF268B34-09C2-43FD-BAC4-5D31EA633111', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Params' => [ 'description' => 'The list of incorrect parameters.', 'type' => 'array', 'items' => ['description' => 'The incorrect parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"TicketId\\": \\"b3a6a131-359e-46bd-9bc5-1f5cb0ea093f\\",\\n \\"TemplateId\\": \\"ccc-test_43c2671b-8939-4223-86d0-6bd187905cc8_*****0666238\\",\\n \\"TemplateVersion\\": \\"0\\",\\n \\"Title\\": \\"售后工单\\",\\n \\"Context\\": \\"{\\\\\\"productName\\\\\\":\\\\\\"商品A\\\\\\"}\\",\\n \\"Assignee\\": \\"agent1@ccc-test\\",\\n \\"AssigneeName\\": \\"坐席A\\",\\n \\"Creator\\": \\"creator@ccc-test\\\\n\\",\\n \\"CreatorName\\": \\"坐席B\\",\\n \\"CategoryId\\": \\"8939-4223-86d0-6bd187905cc8\\",\\n \\"CategoryName\\": \\"售后类目\\",\\n \\"JobId\\": \\"job-399383842187575296\\",\\n \\"StartTime\\": 1620259200000,\\n \\"EndTime\\": 1687846259999,\\n \\"CreatedTime\\": 1620259200000,\\n \\"UpdatedTime\\": 1693793208075,\\n \\"CurrentTaskId\\": \\"912f0b78-6639-4a93-ae18-0d832885c27e\\",\\n \\"CurrentTaskName\\": \\"节点1\\",\\n \\"CurrentTaskStartTime\\": 1693793208075,\\n \\"Source\\": \\"Audio\\",\\n \\"CustomerId\\": \\"4223-86d0-6bd187905-891798749\\",\\n \\"State\\": \\"Processing\\",\\n \\"CloseCode\\": \\"Completed\\",\\n \\"Comment\\": \\"无\\"\\n },\\n \\"RequestId\\": \\"BF268B34-09C2-43FD-BAC4-5D31EA633111\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', 'title' => 'Retrieve ticket', 'summary' => 'Retrieves information about a specific ticket.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'GetTicketSummaryReport' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'State', 'in' => 'query', 'schema' => ['description' => 'Ticket state.'."\n" ."\n" .'- Processing'."\n" ."\n" .'- Withdrawal'."\n" ."\n" .'- Rejected'."\n" ."\n" .'- Closed', 'type' => 'string', 'required' => false, 'example' => '无', 'title' => ''], ], [ 'name' => 'CategoryId', 'in' => 'query', 'schema' => ['description' => 'Ticket category ID.', 'type' => 'string', 'required' => false, 'example' => '43c2671b-***-***-86d0-6bd187905cc8', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'Start time. Filter tickets by creation time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1716998400000', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'End time. Filter tickets by creation time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1719590399999', 'title' => ''], ], [ 'name' => 'Creator', 'in' => 'query', 'schema' => ['description' => 'Creator ID.', 'type' => 'string', 'required' => false, 'example' => 'creator@ccc-test', 'title' => ''], ], [ 'name' => 'Assignee', 'in' => 'query', 'schema' => ['description' => 'Assignee ID. This can be an agent ID or a skill group ID.', 'type' => 'string', 'required' => false, 'example' => 'assignee@ccc-test'."\n", 'title' => ''], ], [ 'name' => 'AssigneeType', 'in' => 'query', 'schema' => ['description' => 'Assignee type.'."\n" ."\n" .'- Agent'."\n" ."\n" .'- SkillGroup', 'type' => 'string', 'required' => false, 'example' => 'Agent', 'title' => ''], ], [ 'name' => 'Participant', 'in' => 'query', 'schema' => ['description' => 'Participant ID.', 'type' => 'string', 'required' => false, 'example' => 'participant@ccc-test'."\n", 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'Page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'Page size. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EAF3C248-E123-441B-A545-B6CD02E98EED', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'TicketsCreated' => ['description' => 'Number of tickets created.', 'type' => 'string', 'example' => '10', 'title' => ''], 'TicketsParticipated' => ['description' => 'Number of tickets processed.', 'type' => 'string', 'example' => '5', 'title' => ''], 'TicketsAssigned' => ['description' => 'Number of tickets pending processing.', 'type' => 'string', 'example' => '3', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EAF3C248-E123-441B-A545-B6CD02E98EED\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"TicketsCreated\\": \\"10\\",\\n \\"TicketsParticipated\\": \\"5\\",\\n \\"TicketsAssigned\\": \\"3\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', 'title' => 'Obtain ticket processing data', 'summary' => 'You can call GetTicketSummaryReport to retrieve a summary of ticket statuses.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'GetTicketTemplate' => [ 'summary' => 'Call GetTicketTemplate to retrieve ticket template definitions.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccFSWXV5'], ], 'parameters' => [ [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => ['description' => 'Template ID.', 'type' => 'string', 'required' => false, 'example' => '4ca2e2-c8d19b82c-d7ce393ac8197d3ab', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'TemplateVersion', 'in' => 'query', 'schema' => ['description' => 'Template version.', 'type' => 'string', 'required' => false, 'example' => '1703517780627', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'GetTicketTemplateResponse', 'title' => 'GetTicketTemplateResponse ', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'TemplateId' => ['description' => 'Template ID.', 'type' => 'string', 'example' => '4ca2e2-c8d19b82c-d7ce393ac8197d3ab'."\n", 'title' => ''], 'Name' => ['description' => 'Template name.', 'type' => 'string', 'example' => '测试模板。'."\n" ."\n", 'title' => ''], 'State' => ['description' => 'Status code.', 'type' => 'string', 'example' => 'Enabled', 'title' => ''], 'Editor' => ['description' => 'Template editor.', 'type' => 'string', 'example' => 'editor-xxx@ccc-test', 'title' => ''], 'CategoryId' => ['description' => 'Ticket category ID.', 'type' => 'string', 'example' => '43c2671b-****-4223-86d0-6bd187905cc8', 'title' => ''], 'TicketFields' => [ 'description' => 'List of template fields.', 'type' => 'array', 'items' => [ 'description' => 'Template field.', 'type' => 'object', 'properties' => [ 'DisplayName' => ['description' => 'Display name.', 'type' => 'string', 'example' => '姓名', 'title' => ''], 'Description' => ['description' => 'Description.', 'type' => 'string', 'example' => '姓名描述', 'title' => ''], 'Name' => ['description' => 'Name.', 'type' => 'string', 'example' => 'name', 'title' => ''], 'DataType' => ['description' => 'Data type.', 'type' => 'string', 'example' => 'string', 'title' => ''], 'Pattern' => ['description' => 'Regular expression validation rule.', 'type' => 'string', 'example' => '^', 'title' => ''], 'PatternErrorMessage' => ['description' => 'Error message for regular expression validation.', 'type' => 'string', 'example' => '不是有效的email地址'."\n", 'title' => ''], 'MinLength' => ['description' => 'Minimum length.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'MaxLength' => ['description' => 'Maximum length.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], 'Minimum' => ['description' => 'Numeric minimum value.', 'type' => 'number', 'format' => 'double', 'example' => '1', 'title' => ''], 'Maximum' => ['description' => 'Numeric maximum value.', 'type' => 'number', 'format' => 'double', 'example' => '10', 'title' => ''], 'Required' => ['description' => 'Whether the field is required.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'System' => ['description' => 'Whether the field is a system field.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Disabled' => ['description' => 'Whether the field is disabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Array' => ['description' => 'Whether the field is an array.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'ReadOnly' => ['description' => 'Whether the field is read-only.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'EditorType' => ['description' => 'Editor type.', 'type' => 'string', 'example' => 'textbox', 'title' => ''], 'Attributes' => ['description' => 'Extension attributes.', 'type' => 'string', 'example' => '{}', 'title' => ''], 'DisplayOrder' => ['description' => 'Display order in lists.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'CreatedTime' => ['description' => 'Creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1717664210000', 'title' => ''], 'UpdatedTime' => ['description' => 'Update time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1717664210000', 'title' => ''], 'Creator' => ['description' => 'Creator.', 'type' => 'string', 'example' => 'creator@cccV2-kmz', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'ProcessDefinition' => ['description' => 'Workflow information.', 'type' => 'string', 'example' => '[{\\"id\\":\\"TICKET_START\\",\\"name\\":\\"开始\\",\\"nodeIndex\\":0,\\"properties\\":{\\"position\\":{\\"x\\":250,\\"y\\":200}},\\"type\\":\\"TICKET_START\\",\\"events\\":[{\\"edgeId\\":\\"8bd07339\\",\\"sourceAnchor\\":0,\\"next\\":\\"APPROVAL__JNBSSREc\\",\\"targetAnchor\\":0}]},{\\"id\\":\\"TICKET_FINISH\\",\\"name\\":\\"结束\\",\\"nodeIndex\\":9999,\\"properties\\":{\\"position\\":{\\"x\\":767,\\"y\\":206}},\\"type\\":\\"TICKET_FINISH\\",\\"events\\":[]},{\\"id\\":\\"APPROVAL__JNBSSREc\\",\\"name\\":\\"流程节点\\",\\"nodeIndex\\":1,\\"properties\\":{\\"skillGroupId\\":\\"chat001@cccV2-kmz\\",\\"position\\":{\\"x\\":537,\\"y\\":164.5}},\\"type\\":\\"APPROVAL\\",\\"events\\":[{\\"edgeId\\":\\"74031613\\",\\"sourceAnchor\\":1,\\"next\\":\\"TICKET_FINISH\\",\\"targetAnchor\\":0}]}]', 'title' => ''], 'UpdatedTime' => ['description' => 'Last modified time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1717664210000', 'title' => ''], ], 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BF268B34-09C2-43FD-BAC4-5D31EA633111', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Params' => [ 'description' => 'List of error parameters.', 'type' => 'array', 'items' => ['description' => 'Error parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Retrieve ticket template', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"TemplateId\\": \\"4ca2e2-c8d19b82c-d7ce393ac8197d3ab\\\\n\\",\\n \\"Name\\": \\"测试模板。\\\\n\\\\n\\",\\n \\"State\\": \\"Enabled\\",\\n \\"Editor\\": \\"editor-xxx@ccc-test\\",\\n \\"CategoryId\\": \\"43c2671b-****-4223-86d0-6bd187905cc8\\",\\n \\"TicketFields\\": [\\n {\\n \\"DisplayName\\": \\"姓名\\",\\n \\"Description\\": \\"姓名描述\\",\\n \\"Name\\": \\"name\\",\\n \\"DataType\\": \\"string\\",\\n \\"Pattern\\": \\"^\\",\\n \\"PatternErrorMessage\\": \\"不是有效的email地址\\\\n\\",\\n \\"MinLength\\": 1,\\n \\"MaxLength\\": 30,\\n \\"Minimum\\": 1,\\n \\"Maximum\\": 10,\\n \\"Required\\": false,\\n \\"System\\": false,\\n \\"Disabled\\": false,\\n \\"Array\\": false,\\n \\"ReadOnly\\": false,\\n \\"EditorType\\": \\"textbox\\",\\n \\"Attributes\\": \\"{}\\",\\n \\"DisplayOrder\\": 1,\\n \\"CreatedTime\\": 1717664210000,\\n \\"UpdatedTime\\": 1717664210000,\\n \\"Creator\\": \\"creator@cccV2-kmz\\"\\n }\\n ],\\n \\"ProcessDefinition\\": \\"[{\\\\\\\\\\\\\\"id\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"TICKET_START\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"开始\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"nodeIndex\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"properties\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"position\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"x\\\\\\\\\\\\\\":250,\\\\\\\\\\\\\\"y\\\\\\\\\\\\\\":200}},\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"TICKET_START\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"events\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"edgeId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"8bd07339\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"sourceAnchor\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"next\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"APPROVAL__JNBSSREc\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"targetAnchor\\\\\\\\\\\\\\":0}]},{\\\\\\\\\\\\\\"id\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"TICKET_FINISH\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"结束\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"nodeIndex\\\\\\\\\\\\\\":9999,\\\\\\\\\\\\\\"properties\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"position\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"x\\\\\\\\\\\\\\":767,\\\\\\\\\\\\\\"y\\\\\\\\\\\\\\":206}},\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"TICKET_FINISH\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"events\\\\\\\\\\\\\\":[]},{\\\\\\\\\\\\\\"id\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"APPROVAL__JNBSSREc\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"流程节点\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"nodeIndex\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"properties\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"skillGroupId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"chat001@cccV2-kmz\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"position\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"x\\\\\\\\\\\\\\":537,\\\\\\\\\\\\\\"y\\\\\\\\\\\\\\":164.5}},\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"APPROVAL\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"events\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"edgeId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"74031613\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"sourceAnchor\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"next\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"TICKET_FINISH\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"targetAnchor\\\\\\\\\\\\\\":0}]}]\\",\\n \\"UpdatedTime\\": 1717664210000\\n },\\n \\"RequestId\\": \\"BF268B34-09C2-43FD-BAC4-5D31EA633111\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', ], 'GetTurnCredentials' => [ 'summary' => 'Call GetTurnCredentials to get the connection credentials for a Cloud Contact Center Point of Presence (PoP). These credentials include a username and password for authentication. Connecting to Cloud Contact Center through a PoP improves network quality and stability.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccTMAX45'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'The ID of the agent. This parameter is optional. If you do not specify this parameter, the agent mapped to the current RAM user is used by default.', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], 'Data' => [ 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'UserName' => ['description' => 'The username.', 'type' => 'string', 'example' => '1602585817:****', 'title' => ''], 'Password' => ['description' => 'The password.', 'type' => 'string', 'example' => 'M0NQNG/uRUrfIxW7er/S9gKX****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Params' => [ 'description' => '', 'type' => 'array', 'items' => ['description' => 'The response parameters.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => ''], ], ], 'title' => 'Obtain access point credentials ', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-11-06T05:44:49.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTurnCredentials'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"UserName\\": \\"1602585817:****\\",\\n \\"Password\\": \\"M0NQNG/uRUrfIxW7er/S9gKX****\\"\\n },\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', ], 'GetTurnServerList' => [ 'summary' => 'Call GetTurnServerList to get a list of front-end access points for Alibaba Cloud Contact Center. Connecting through these access points improves network quality and stability.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccTMAX45'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'title' => '', 'example' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'title' => '', 'example' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => ''], 'Data' => ['description' => 'A list of front-end access point servers.', 'type' => 'string', 'example' => '['."\n" .' {'."\n" .' "region":"hangzhou",'."\n" .' "name":"杭州",'."\n" .' "domain":"turn-hz-ecs.ccc.aliyuncs.com",'."\n" .' "cidr":"172.31.XX.XX/28"'."\n" .' },'."\n" .' {'."\n" .' "region":"qingdao",'."\n" .' "name":"青岛",'."\n" .' "domain":"turn-qd-ecs.ccc.aliyuncs.com",'."\n" .' "cidr":"172.31.XX.XX/28"'."\n" .' },'."\n" .' {'."\n" .' "region":"shanghai",'."\n" .' "name":"上海",'."\n" .' "domain":"turn-sh-ecs.ccc.aliyuncs.com",'."\n" .' "cidr":"172.31.XX.XX/28"'."\n" .' },'."\n" .' {'."\n" .' "region":"chengdu",'."\n" .' "name":"成都",'."\n" .' "domain":"turn-cd-ecs.ccc.aliyuncs.com",'."\n" .' "cidr":"172.31.XX.XX/28"'."\n" .' },'."\n" .' {'."\n" .' "region":"beijing",'."\n" .' "name":"北京",'."\n" .' "domain":"turn-bj-ecs.ccc.aliyuncs.com",'."\n" .' "cidr":"172.31.XX.XX/28"'."\n" .' },'."\n" .' {'."\n" .' "region":"huanan",'."\n" .' "name":"深圳",'."\n" .' "domain":"turn-sz-ecs.ccc.aliyuncs.com",'."\n" .' "cidr":"172.31.XX.XX/28"'."\n" .' },'."\n" .' {'."\n" .' "region":"zhangbei",'."\n" .' "name":"张北",'."\n" .' "domain":"turn-zb-ecs.ccc.aliyuncs.com",'."\n" .' "cidr":"172.31.XX.XX/28"'."\n" .' }'."\n" .']', 'title' => ''], 'Params' => [ 'description' => '', 'type' => 'array', 'items' => ['description' => 'The parameters returned in the response.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Obtain the access point list', 'changeSet' => [ ['createdAt' => '2023-11-06T05:44:49.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTurnServerList'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Data\\": \\"[\\\\n\\\\t{\\\\n\\\\t\\\\t\\\\\\"region\\\\\\":\\\\\\"hangzhou\\\\\\",\\\\n\\\\t\\\\t\\\\\\"name\\\\\\":\\\\\\"杭州\\\\\\",\\\\n\\\\t\\\\t\\\\\\"domain\\\\\\":\\\\\\"turn-hz-ecs.ccc.aliyuncs.com\\\\\\",\\\\n\\\\t\\\\t\\\\\\"cidr\\\\\\":\\\\\\"172.31.XX.XX/28\\\\\\"\\\\n\\\\t},\\\\n\\\\t{\\\\n\\\\t\\\\t\\\\\\"region\\\\\\":\\\\\\"qingdao\\\\\\",\\\\n\\\\t\\\\t\\\\\\"name\\\\\\":\\\\\\"青岛\\\\\\",\\\\n\\\\t\\\\t\\\\\\"domain\\\\\\":\\\\\\"turn-qd-ecs.ccc.aliyuncs.com\\\\\\",\\\\n\\\\t\\\\t\\\\\\"cidr\\\\\\":\\\\\\"172.31.XX.XX/28\\\\\\"\\\\n\\\\t},\\\\n\\\\t{\\\\n\\\\t\\\\t\\\\\\"region\\\\\\":\\\\\\"shanghai\\\\\\",\\\\n\\\\t\\\\t\\\\\\"name\\\\\\":\\\\\\"上海\\\\\\",\\\\n\\\\t\\\\t\\\\\\"domain\\\\\\":\\\\\\"turn-sh-ecs.ccc.aliyuncs.com\\\\\\",\\\\n\\\\t\\\\t\\\\\\"cidr\\\\\\":\\\\\\"172.31.XX.XX/28\\\\\\"\\\\n\\\\t},\\\\n\\\\t{\\\\n\\\\t\\\\t\\\\\\"region\\\\\\":\\\\\\"chengdu\\\\\\",\\\\n\\\\t\\\\t\\\\\\"name\\\\\\":\\\\\\"成都\\\\\\",\\\\n\\\\t\\\\t\\\\\\"domain\\\\\\":\\\\\\"turn-cd-ecs.ccc.aliyuncs.com\\\\\\",\\\\n\\\\t\\\\t\\\\\\"cidr\\\\\\":\\\\\\"172.31.XX.XX/28\\\\\\"\\\\n\\\\t},\\\\n\\\\t{\\\\n\\\\t\\\\t\\\\\\"region\\\\\\":\\\\\\"beijing\\\\\\",\\\\n\\\\t\\\\t\\\\\\"name\\\\\\":\\\\\\"北京\\\\\\",\\\\n\\\\t\\\\t\\\\\\"domain\\\\\\":\\\\\\"turn-bj-ecs.ccc.aliyuncs.com\\\\\\",\\\\n\\\\t\\\\t\\\\\\"cidr\\\\\\":\\\\\\"172.31.XX.XX/28\\\\\\"\\\\n\\\\t},\\\\n\\\\t{\\\\n\\\\t\\\\t\\\\\\"region\\\\\\":\\\\\\"huanan\\\\\\",\\\\n\\\\t\\\\t\\\\\\"name\\\\\\":\\\\\\"深圳\\\\\\",\\\\n\\\\t\\\\t\\\\\\"domain\\\\\\":\\\\\\"turn-sz-ecs.ccc.aliyuncs.com\\\\\\",\\\\n\\\\t\\\\t\\\\\\"cidr\\\\\\":\\\\\\"172.31.XX.XX/28\\\\\\"\\\\n\\\\t},\\\\n\\\\t{\\\\n\\\\t\\\\t\\\\\\"region\\\\\\":\\\\\\"zhangbei\\\\\\",\\\\n\\\\t\\\\t\\\\\\"name\\\\\\":\\\\\\"张北\\\\\\",\\\\n\\\\t\\\\t\\\\\\"domain\\\\\\":\\\\\\"turn-zb-ecs.ccc.aliyuncs.com\\\\\\",\\\\n\\\\t\\\\t\\\\\\"cidr\\\\\\":\\\\\\"172.31.XX.XX/28\\\\\\"\\\\n\\\\t}\\\\n]\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', ], 'GetUploadAudioDataParams' => [ 'summary' => 'Obtain the parameters related to offline quality inspection audio files. Normally, if the Customer has configured the quality inspection feature in Cloud Contact Center, the audio files requiring offline quality inspection and their corresponding parameters are automatically passed to Intelligent Quality Inspection. You only need to invoke this API to obtain the parameters for pushing quality inspection recordings when the Customer has not configured the quality inspection feature in Cloud Contact Center and wishes to manually push Cloud Contact Center call recordings to the quality inspection system.', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Cloud Contact Center instance ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'test', 'title' => ''], ], [ 'name' => 'ContactId', 'in' => 'query', 'schema' => ['description' => 'Call ID.', 'type' => 'string', 'required' => true, 'example' => 'job-38860977107324****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID, which can be used for LogSearch of the API.', 'type' => 'string', 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'ParamsStr' => ['description' => 'Parameters related to offline quality inspection audio files.', 'type' => 'string', 'example' => '{'."\n" .' "autoSplit": 1,'."\n" .' "appKey": ****,'."\n" .' "sampleRate": 8,'."\n" .' "callList": ['."\n" .' {'."\n" .' "callId": "job-46686139435843****",'."\n" .' "validTimes": ['."\n" .' {'."\n" .' "begin_time": 0,'."\n" .' "end_time": 30720,'."\n" .' "speaker_id": "张**"'."\n" .' }'."\n" .' ],'."\n" .' "resolveType": "ali-ACC",'."\n" .' "instance": "c****",'."\n" .' "callee": "153****",'."\n" .' "accUid": 105****967,'."\n" .' "callStartTime": 1704870035381,'."\n" .' "customerServiceName": "张**",'."\n" .' "tid": "2ccd8732-62ed-****b9",'."\n" .' "callType": 1,'."\n" .' "skillGroupUUID": "skg-default@c****",'."\n" .' "caller": "2023****",'."\n" .' "customerServicePhone": "80****54",'."\n" .' "channels": ['."\n" .' {'."\n" .' "speaker_id": "张**",'."\n" .' "channel_key": "ch-user-153****-80****54-1704870030317-job-46686139435843****"'."\n" .' }'."\n" .' ],'."\n" .' "sourceType": 1,'."\n" .' "channelKey": "ch-user-153****-80****54-1704870030317-job-46686139435843****",'."\n" .' "skillGroupName": "金****",'."\n" .' "voiceFileUrl": "https://ccc-***.oss-cn-****.aliyuncs.com/ccc-****/c****/2024/01/job-46686139435843****.mkv?Expires=****&OSSAccessKeyId=****&Signature=****",'."\n" .' "skillGroupId": 0,'."\n" .' "customerServiceId": 203242802****'."\n" .' }'."\n" .' ]'."\n" .'}', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'title' => 'Obtain Parameters Related to Offline Quality Inspection Audio Files', 'changeSet' => [ ['createdAt' => '2022-08-24T07:34:47.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUploadAudioDataParams'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"03C67DAD-EB26-41D8-949D-9B0C470FB716\\",\\n \\"Data\\": {\\n \\"ParamsStr\\": \\"{\\\\n \\\\\\"autoSplit\\\\\\": 1,\\\\n \\\\\\"appKey\\\\\\": ****,\\\\n \\\\\\"sampleRate\\\\\\": 8,\\\\n \\\\\\"callList\\\\\\": [\\\\n {\\\\n \\\\\\"callId\\\\\\": \\\\\\"job-46686139435843****\\\\\\",\\\\n \\\\\\"validTimes\\\\\\": [\\\\n {\\\\n \\\\\\"begin_time\\\\\\": 0,\\\\n \\\\\\"end_time\\\\\\": 30720,\\\\n \\\\\\"speaker_id\\\\\\": \\\\\\"张**\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"resolveType\\\\\\": \\\\\\"ali-ACC\\\\\\",\\\\n \\\\\\"instance\\\\\\": \\\\\\"c****\\\\\\",\\\\n \\\\\\"callee\\\\\\": \\\\\\"153****\\\\\\",\\\\n \\\\\\"accUid\\\\\\": 105****967,\\\\n \\\\\\"callStartTime\\\\\\": 1704870035381,\\\\n \\\\\\"customerServiceName\\\\\\": \\\\\\"张**\\\\\\",\\\\n \\\\\\"tid\\\\\\": \\\\\\"2ccd8732-62ed-****b9\\\\\\",\\\\n \\\\\\"callType\\\\\\": 1,\\\\n \\\\\\"skillGroupUUID\\\\\\": \\\\\\"skg-default@c****\\\\\\",\\\\n \\\\\\"caller\\\\\\": \\\\\\"2023****\\\\\\",\\\\n \\\\\\"customerServicePhone\\\\\\": \\\\\\"80****54\\\\\\",\\\\n \\\\\\"channels\\\\\\": [\\\\n {\\\\n \\\\\\"speaker_id\\\\\\": \\\\\\"张**\\\\\\",\\\\n \\\\\\"channel_key\\\\\\": \\\\\\"ch-user-153****-80****54-1704870030317-job-46686139435843****\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"sourceType\\\\\\": 1,\\\\n \\\\\\"channelKey\\\\\\": \\\\\\"ch-user-153****-80****54-1704870030317-job-46686139435843****\\\\\\",\\\\n \\\\\\"skillGroupName\\\\\\": \\\\\\"金****\\\\\\",\\\\n \\\\\\"voiceFileUrl\\\\\\": \\\\\\"https://ccc-***.oss-cn-****.aliyuncs.com/ccc-****/c****/2024/01/job-46686139435843****.mkv?Expires=****&OSSAccessKeyId=****&Signature=****\\\\\\",\\\\n \\\\\\"skillGroupId\\\\\\": 0,\\\\n \\\\\\"customerServiceId\\\\\\": 203242802****\\\\n }\\\\n ]\\\\n}\\"\\n }\\n}","type":"json"}]', ], 'GetUser' => [ 'summary' => 'You can invoke GetUser to obtain the agent information corresponding to a specified agent ID under a specified instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'Agent ID. This parameter is optional. You must specify either UserId or Extension.', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test', 'title' => ''], ], [ 'name' => 'Extension', 'in' => 'query', 'schema' => ['description' => 'Agent extension number. This parameter is optional. You must specify either UserId or Extension.', 'type' => 'string', 'required' => false, 'example' => '8003****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'DisplayName' => ['description' => 'Agent display name.', 'type' => 'string', 'example' => '坐席小王', 'title' => ''], 'DisplayId' => ['description' => 'Agent\'s employee ID.', 'type' => 'string', 'example' => '1001', 'title' => ''], 'Extension' => ['description' => 'Agent extension number.', 'type' => 'string', 'example' => '8003****', 'title' => ''], 'LoginName' => ['description' => 'Agent logon name.', 'type' => 'string', 'example' => 'agent', 'title' => ''], 'Email' => ['description' => 'Mailbox.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], 'WorkMode' => [ 'description' => 'Work mode.', 'enumValueTitles' => ['ON_SITE' => 'On-site mode', 'OFF_SITE' => 'Off-site mode', 'OFFICE_PHONE' => 'Office phone mode'], 'type' => 'string', 'example' => 'ON_SITE', 'title' => '', ], 'Mobile' => ['description' => 'Agent\'s personal phone number.', 'type' => 'string', 'example' => '1391234****', 'title' => ''], 'UserId' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'RoleName' => [ 'description' => 'Role name.', 'enumValueTitles' => ['Agent' => 'Agent', 'Admin' => 'Administrator', 'Manager' => 'Skill Group Leader'], 'type' => 'string', 'example' => 'Admin', 'title' => '', ], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'RoleId' => ['description' => 'Role ID, in the format: role\\@instance ID.', 'type' => 'string', 'example' => 'Admin@ccc-test', 'title' => ''], 'DeviceId' => ['description' => 'Device ID, which is the identity of a browser-based Web Real-Time Communication (WebRTC) softphone or a physical phone device. Only one type of device can be registered at a time.', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****', 'title' => ''], 'DeviceExt' => ['description' => 'SIP phone extension number. If the agent has registered a SIP phone, this parameter is the extension number of the SIP phone device.', 'type' => 'string', 'example' => '8033****', 'title' => ''], 'DeviceState' => [ 'description' => 'The status of the SIP phone device. If no SIP phone is registered, the status is UNREGISTERED (Unregistered). If a SIP phone was previously registered but is currently offline, the status is OFFLINE (Offline). If a SIP phone is registered and currently online, the status is ONLINE (Online).', 'enumValueTitles' => ['UNREGISTERED' => 'Unregistered', 'OFFLINE' => 'Offline', 'ONLINE' => 'Online'], 'type' => 'string', 'example' => 'OFFLINE', 'title' => '', ], 'Nickname' => ['description' => 'Agent nickname', 'type' => 'string', 'example' => '阿云', 'title' => ''], 'AvatarUrl' => ['description' => 'Agent profile picture URL.', 'type' => 'string', 'example' => 'http://xxx.com/xxx.jpg', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Params' => [ 'description' => 'Extension parameters.', 'type' => 'array', 'items' => ['description' => 'Response parameters.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Get agent ', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-11-07T07:21:06.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-01-19T00:08:15.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-01-19T00:08:15.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUser'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"DisplayName\\": \\"坐席小王\\",\\n \\"DisplayId\\": \\"1001\\",\\n \\"Extension\\": \\"8003****\\",\\n \\"LoginName\\": \\"agent\\",\\n \\"Email\\": \\"username@example.com\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"Mobile\\": \\"1391234****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"RoleName\\": \\"Admin\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"RoleId\\": \\"Admin@ccc-test\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"DeviceExt\\": \\"8033****\\",\\n \\"DeviceState\\": \\"OFFLINE\\",\\n \\"Nickname\\": \\"阿云\\",\\n \\"AvatarUrl\\": \\"http://xxx.com/xxx.jpg\\"\\n },\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', ], 'GetVisitorLoginDetails' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => false, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'VisitorId', 'in' => 'query', 'schema' => ['description' => 'Visitor ID.', 'type' => 'string', 'required' => true, 'example' => 'fcd020fe-d8e4-40e5-8c77-1a272a174a7d', 'title' => ''], ], [ 'name' => 'ChatDeviceId', 'in' => 'query', 'schema' => ['description' => 'Chat device ID.', 'type' => 'string', 'required' => true, 'example' => '4c51c9116c36537cb850dc1081d745df', 'title' => ''], ], [ 'name' => 'Token', 'in' => 'query', 'schema' => ['description' => 'Channel token for network services.', 'type' => 'string', 'required' => false, 'example' => '9XYGTGWtq2wFi_Bpg7aUnIoYi_vG_rO3b***YtsxbHRHrYHlz1LDBLJAyZcLxieRQR4h_6AnWvTjJeNU5jgxzO*****bHwej7WgWrmA', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '19D09CCC-F298-4124-849A-AFA217819011', 'title' => ''], 'Params' => [ 'description' => 'Parameter information.', 'type' => 'array', 'items' => ['description' => 'Parameter list.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], 'Data' => [ 'description' => 'Returned data.', 'type' => 'object', 'properties' => [ 'ChatLoginToken' => ['description' => 'Chat session login token.', 'type' => 'string', 'example' => '{"accessToken":"oauth_cloud_key:+4oJXUAFSWxGD2YuRW4V/oUN0/8qJGNc0I*********n1E3DOr3Q3lX00ZnTpyqRi8Y6hYoLYA7n2ZkWuv485hVtXeSgnIQkKxXPbMgwoLxWaK//lI5Dn/mb4YuDifigv+ZyFzc+07vxm9ZFu/NjA==","accessTokenExpiredTime":86400000,"refreshToken":"oauth_cloud_key:/U+8UueDmpeUszhXC+SWow4pNLZp2C***********U/377BNXF+Mjo1lFgDk6GtEjNNoJpapX2mHH8GcRke2+yKQs/w4gAN9xSMn543Ciung+93pXV6IpQGbEVlu"}', 'title' => ''], 'ChatUserId' => ['description' => 'Visitor\'s identity ID.', 'type' => 'string', 'example' => 'dac9c001****a15684ea91a81317', 'title' => ''], 'ChatDeviceId' => ['description' => 'Chat device ID.', 'type' => 'string', 'example' => '4c51c9116c36537cb850dc1081d745df', 'title' => ''], 'ChatServerUrl' => ['description' => 'Chat session server address.', 'type' => 'string', 'example' => 'wss://wss.im.dingtalk.cn', 'title' => ''], 'ChatAppKey' => ['description' => 'Chat session application key.', 'type' => 'string', 'example' => '955e4bd7xxxxxxxxxxxxxd7898ba9fa0d0', 'title' => ''], 'ChatAppId' => ['description' => 'Chat session application ID.', 'type' => 'string', 'example' => '7pjxxx', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"19D09CCC-F298-4124-849A-AFA217819011\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"ChatLoginToken\\": \\"{\\\\\\"accessToken\\\\\\":\\\\\\"oauth_cloud_key:+4oJXUAFSWxGD2YuRW4V/oUN0/8qJGNc0I*********n1E3DOr3Q3lX00ZnTpyqRi8Y6hYoLYA7n2ZkWuv485hVtXeSgnIQkKxXPbMgwoLxWaK//lI5Dn/mb4YuDifigv+ZyFzc+07vxm9ZFu/NjA==\\\\\\",\\\\\\"accessTokenExpiredTime\\\\\\":86400000,\\\\\\"refreshToken\\\\\\":\\\\\\"oauth_cloud_key:/U+8UueDmpeUszhXC+SWow4pNLZp2C***********U/377BNXF+Mjo1lFgDk6GtEjNNoJpapX2mHH8GcRke2+yKQs/w4gAN9xSMn543Ciung+93pXV6IpQGbEVlu\\\\\\"}\\",\\n \\"ChatUserId\\": \\"dac9c001****a15684ea91a81317\\",\\n \\"ChatDeviceId\\": \\"4c51c9116c36537cb850dc1081d745df\\",\\n \\"ChatServerUrl\\": \\"wss://wss.im.dingtalk.cn\\",\\n \\"ChatAppKey\\": \\"955e4bd7xxxxxxxxxxxxxd7898ba9fa0d0\\",\\n \\"ChatAppId\\": \\"7pjxxx\\"\\n }\\n}","type":"json"}]', 'title' => 'Obtain Visitor Logon Information', 'summary' => 'Call GetVisitorLoginDetails to retrieve login, server address, and authentication information for network service visitors.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'GetVoicemailRecording' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccKYIENB'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'ContactId', 'in' => 'query', 'schema' => ['description' => 'Call ID. Ensure that this call ID has a voicemail message; otherwise, the return result will contain no data.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-12515239414412****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'FileUrl' => ['description' => 'The OSS download URL of the recording file. Note that the download URL expires after 1 day.', 'type' => 'string', 'example' => 'https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-record-mixed/ccc-test/2022/06/voicemail.job-054ded02****.wav?Expires=1656074923&OSSAccessKeyId=****&Signature=****', 'title' => ''], 'FileName' => ['description' => 'Recording file name.', 'type' => 'string', 'example' => 'voicemail.job-054ded02****.wav', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => ''], ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Get Voicemail Recording', 'summary' => 'You can invoke GetVoicemailRecording to obtain the voicemail recording of a specified call under a specified instance. The recording is single-track and in WAV format.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetVoicemailRecording'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"FileUrl\\": \\"https://ccc-v2-online.oss-cn-shanghai.aliyuncs.com/ccc-record-mixed/ccc-test/2022/06/voicemail.job-054ded02****.wav?Expires=1656074923&OSSAccessKeyId=****&Signature=****\\",\\n \\"FileName\\": \\"voicemail.job-054ded02****.wav\\"\\n }\\n}","type":"json"}]', ], 'HoldCall' => [ 'summary' => 'You can invoke HoldCall to hold the call associated with a specified call ID under a specified instance. After the call is held, it will be temporarily suspended, and the held party will hear hold music.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'Agent ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test', 'title' => ''], ], [ 'name' => 'DeviceId', 'in' => 'query', 'schema' => ['description' => 'A unique ID provided by the agent endpoint to represent an agent workbench. An agent can have multiple workbenches of different types, such as browser, iOS, or Android, but only one can be active at a time.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'ACC-YUNBS-1.0.10-****', 'title' => ''], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'Call job ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6582589278232****', 'title' => ''], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => ['description' => 'Channel ID to be held.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ch:customer:010123****->1318888****:1609255715825:job-6582589278232****', 'title' => ''], ], [ 'name' => 'Music', 'in' => 'query', 'schema' => ['description' => 'Name of the hold music. This parameter is optional and defaults to empty.', 'type' => 'string', 'required' => false, 'example' => '无', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '174F7777-2F6C-4F10-B889-C698E26C1AE0', 'title' => ''], 'Params' => [ 'description' => 'List of response parameters.', 'type' => 'array', 'items' => ['description' => 'Response parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'CallContext' => [ 'description' => 'Call context environment.', 'type' => 'object', 'properties' => [ 'CallType' => [ 'description' => 'Call type.', 'enumValueTitles' => [ 'INBOUND' => 'Inbound', 'BARGE' => 'Barge-in', 'CONSULTANT' => 'Consultation', 'CONFERENCE' => 'Conference', 'MONITOR' => 'Listener', 'INTERNAL' => 'Internal Call', 'OUTBOUND' => 'Outbound', 'INTERCEPT' => 'Intercept', 'BACK2BACK' => 'Back-to-Back Call', 'PREDICTIVE' => 'Predictive Outbound', 'COACH' => 'Coaching', ], 'type' => 'string', 'example' => 'OUTBOUND', 'title' => '', ], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-6582589278232****', 'title' => ''], 'ChannelContexts' => [ 'description' => 'List of call channels.', 'type' => 'array', 'items' => [ 'description' => 'Call channel.', 'type' => 'object', 'properties' => [ 'ReleaseInitiator' => ['description' => 'The party that initiated the release of the call channel, indicating who first initiated the hang-up for this call channel.', 'type' => 'string', 'example' => '1390501****', 'title' => ''], 'ChannelState' => [ 'description' => 'The status of the call channel.', 'enumValueTitles' => ['CREATED' => 'Created', 'ANSWERED' => 'Answered', 'RELEASED' => 'Released', 'RETIRED' => 'Out Of Effect', 'EARLY_MEDIA' => 'Early Media', 'NONE' => 'Initial Status', 'RINGING' => 'Ringing'], 'type' => 'string', 'example' => 'ANSWERED', 'title' => '', ], 'Destination' => ['description' => 'Called party of the call channel.', 'type' => 'string', 'example' => '8001****', 'title' => ''], 'UserId' => ['description' => 'The agent ID associated with the voice channel. This field is empty if the channel belongs to a Customer.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'SkillGroupId' => ['description' => 'The skill group ID associated with the channel. In inbound scenarios, the associated skill group ID is determined by the skill group configured in the IVR transfer-to-agent module. In outbound scenarios, the associated skill group ID is the ID of the first skill group the agent signed into.', 'type' => 'string', 'example' => 'skillgroup@ccc-test', 'title' => ''], 'Timestamp' => ['description' => 'The UNIX timestamp (in milliseconds) of the most recent status change of the channel.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609255716900', 'title' => ''], 'ReleaseReason' => ['description' => 'The release reason of the call channel, indicating why the current call channel was released. The value comes from the response codes defined in the SIP protocol. Customers can refer to the SIP protocol to analyze the release reason.', 'type' => 'string', 'example' => '404 - No destination', 'title' => ''], 'CallType' => [ 'description' => 'The call type of the channel.', 'enumValueTitles' => [ 'INBOUND' => 'Inbound', 'BARGE' => 'Barge', 'CONSULTANT' => 'Consultation', 'CONFERENCE' => 'Conference', 'MONITOR' => 'Listener', 'INTERNAL' => 'Internal Call', 'OUTBOUND' => 'Outbound', 'INTERCEPT' => 'Intercept', 'BACK2BACK' => 'Back-to-Back', 'PREDICTIVE' => 'Predictive outbound call', 'COACH' => 'Coaching', ], 'type' => 'string', 'example' => 'OUTBOUND', 'title' => '', ], 'JobId' => ['description' => 'The call ID.', 'type' => 'string', 'example' => 'job-6582589278232****', 'title' => ''], 'ChannelId' => ['description' => 'The channel ID.', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****', 'title' => ''], 'Originator' => ['description' => 'The calling party of the voice channel.', 'type' => 'string', 'example' => '1318888****', 'title' => ''], 'UserExtension' => ['description' => 'The extension number of the agent associated with the channel.', 'type' => 'string', 'example' => '8001****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'UserContext' => [ 'description' => 'Agent context environment.', 'type' => 'object', 'properties' => [ 'Extension' => ['description' => 'The agent\'s extension number.', 'type' => 'string', 'example' => '8001****', 'title' => ''], 'Heartbeat' => ['description' => 'The time when the last heartbeat was received from the agent, formatted as a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609255716908', 'title' => ''], 'WorkMode' => [ 'description' => 'Work mode.', 'enumValueTitles' => ['ON_SITE' => 'On-site mode', 'OFF_SITE' => 'Off-site mode', 'OFFICE_PHONE' => 'Office phone mode'], 'type' => 'string', 'example' => 'ON_SITE', 'title' => '', ], 'DeviceId' => ['description' => 'Device ID, the identity ID of a browser-based Web Real-Time Communication (WebRTC) softphone or a physical phone device. Only one type of device can be registered at a time.', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****', 'title' => ''], 'UserId' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'Reserved' => ['description' => 'The time when the agent was most recently reserved. Being reserved means an incoming call will soon be assigned to this agent. The format is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609255715822', 'title' => ''], 'BreakCode' => [ 'description' => 'Break status code, which can be either System-defined or Custom-defined. System-defined break codes include: Warm-up (temporary break state after an agent is published and before becoming idle), RingingTimeout (break caused by agent ringing timeout), and RejectCall (break caused by agent call rejection). There are no restrictions on Custom-defined status codes; customers can define them according to their business needs.', 'enumValueTitles' => ['RingingTimeout' => 'Break due to agent ringing timeout', 'RejectCall' => 'Break due to agent call rejection', 'Warm-up' => 'Temporary break state after an agent is published and before becoming idle'], 'type' => 'string', 'example' => 'Warm-up', 'title' => '', ], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'OutboundScenario' => ['description' => 'Indicates whether the agent is in outbound-only mode.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Mobile' => ['description' => 'The agent\'s personal phone number.', 'type' => 'string', 'example' => '1390000****', 'title' => ''], 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-6582589278232****', 'title' => ''], 'UserState' => [ 'description' => 'Agent status.', 'enumValueTitles' => ['READY' => 'Idle', 'WORKING' => 'Post-processing', 'DIALING' => 'Dialing', 'BREAK' => 'Break', 'OFFLINE' => 'Offline', 'TALKING' => 'Talking', 'RINGING' => 'Ringing'], 'type' => 'string', 'example' => 'TALKING', 'title' => '', ], 'SignedSkillGroupIdList' => [ 'description' => 'List of skill group IDs that the agent has signed into.', 'type' => 'array', 'items' => ['description' => 'Skill group ID.', 'type' => 'string', 'example' => 'skillgroup1@ccc-test', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ['errorCode' => 'InvalidOperation.ChannelState', 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', 'description' => ''], ['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.ChannelId', 'errorMessage' => 'The specified channel %s does not exist in call %s.', 'description' => ''], ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => ''], ], ], 'title' => 'Hold call', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-10-26T08:13:47.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'HoldCall'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"174F7777-2F6C-4F10-B889-C698E26C1AE0\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6582589278232****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"8001****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609255716900,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6582589278232****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"Originator\\": \\"1318888****\\",\\n \\"UserExtension\\": \\"8001****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8001****\\",\\n \\"Heartbeat\\": 1609255716908,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609255715822,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1390000****\\",\\n \\"JobId\\": \\"job-6582589278232****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","type":"json"}]', ], 'ImportAdmins' => [ 'summary' => 'Imports one or more admins to a specified instance. The caller must have the `AliyunCCCFullAccess` permission, which you can grant in the RAM console.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'RamIdList', 'in' => 'query', 'schema' => ['description' => 'A list of UIDs for Alibaba Cloud RAM accounts. The value must be a string-encoded JSON array. The array supports up to 20 UIDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["26972543893791****"]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response object.', 'type' => 'object', 'properties' => [ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1CDB5C94-ACFB-59B5-85FE-C1DAF8049C63', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Data' => [ 'description' => 'A list of imported admins.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'UserId' => ['description' => 'The agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'RoleId' => ['description' => 'The role ID.', 'type' => 'string', 'example' => 'Admin@ccc-test', 'title' => ''], 'Extension' => ['description' => 'The agent extension.', 'type' => 'string', 'example' => '8021****', 'title' => ''], 'RamId' => ['description' => 'The UID of the Alibaba Cloud RAM account.', 'type' => 'string', 'example' => '26972543893791****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => ''], ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"1CDB5C94-ACFB-59B5-85FE-C1DAF8049C63\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": [\\n {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"RoleId\\": \\"Admin@ccc-test\\",\\n \\"Extension\\": \\"8021****\\",\\n \\"RamId\\": \\"26972543893791****\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'Import multiple administrators', 'changeSet' => [ ['createdAt' => '2022-04-19T12:16:06.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ImportAdmins'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'ImportContactFlow' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '251083', 'abilityTreeNodes' => ['FEATUREcccTPIKHY'], ], 'parameters' => [ [ 'name' => 'FlowPackageData', 'in' => 'formData', 'schema' => ['description' => 'Data', 'type' => 'string', 'required' => true, 'example' => '{}', 'title' => ''], ], [ 'name' => 'RequestId', 'in' => 'formData', 'schema' => ['description' => 'The request ID.', 'type' => 'string', 'required' => false, 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE ', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'ImportFlowResponse', 'title' => 'ImportFlowResponse', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '27DD30C4-CAE2-481A-97CC-D3C54625341D', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Params' => [ 'description' => 'The response parameters.', 'type' => 'array', 'items' => ['description' => 'The parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"27DD30C4-CAE2-481A-97CC-D3C54625341D\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', 'title' => 'Import IVR flow', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'summary' => '', ], 'ImportCorpNumbers' => [ 'summary' => 'Imports your organization’s telephone line numbers. Before performing the first import, contact Cloud Contact Center technical support to add the numbers to the allowlist.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc1MRAID'], ], 'parameters' => [ [ 'name' => 'NumberList', 'in' => 'query', 'schema' => ['description' => 'The list of numbers.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[\'029xxxxxx\']', 'title' => ''], ], [ 'name' => 'TagList', 'in' => 'query', 'schema' => ['description' => 'The business tags.', 'type' => 'string', 'required' => false, 'example' => '无', 'title' => ''], ], [ 'name' => 'Province', 'in' => 'query', 'schema' => ['description' => 'The province.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '陕西', 'title' => ''], ], [ 'name' => 'City', 'in' => 'query', 'schema' => ['description' => 'The city.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '西安', 'title' => ''], ], [ 'name' => 'Provider', 'in' => 'query', 'schema' => ['description' => 'The line information.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'xxx通信-陕西线路', 'title' => ''], ], [ 'name' => 'CorpName', 'in' => 'query', 'schema' => ['description' => 'The enterprise name.', 'type' => 'string', 'required' => false, 'example' => 'xxx公司', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C42981C7-93D9-55CD-B078-784F8522E0E1', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"C42981C7-93D9-55CD-B078-784F8522E0E1\\"\\n}","type":"json"}]', 'title' => 'Import your own line numbers ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ImportCorpNumbers'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'ImportCustomCallTagging' => [ 'summary' => 'You can invoke ImportCustomCallTagging to import multiple inbound number tags into a specified instance.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'write', 'deprecated' => true, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc1MRAID'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'FilePath', 'in' => 'query', 'schema' => ['description' => 'The ObjectKey of the OSS object that contains the inbound number mark file. OSS is configured with the public customer storage bucket for Cloud Call Center. You can upload the inbound number mark file to this public customer storage bucket through the inbound management page of Cloud Call Center. After the upload succeeds, invoking this API reads the file content from OSS and imports it in batch. We do not recommend directly invoking this API. Instead, you can perform this operation through the default public cloud CRM System provided by Cloud Call Center.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'temp/ImportCustomCallTagging.xlsx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => 'Schema of Response ', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request ', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Data' => [ 'description' => 'The list of inbound number tags that failed to be created.', 'type' => 'array', 'items' => [ 'description' => 'Information about an inbound number tag that failed to be created.', 'type' => 'object', 'properties' => [ 'Item' => ['description' => 'The number of the inbound number tag that failed to be created.', 'type' => 'string', 'example' => '1312121****', 'title' => ''], 'Reason' => [ 'description' => 'The reason why the inbound number tag creation failed.', 'enumValueTitles' => ['CUSTOM_NUMBER_ILLEGAL' => 'The input list contains numbers with invalid formats.', 'CUSTOM_NUMBER_DUPLICATED' => 'The input list contains duplicate numbers.', 'CUSTOM_NUMBER_ALREADY_EXISTS' => 'The input list contains number tags that have already been created.', 'CUSTOM_NUMBER_TAG_NOT_EXIST' => 'The input list contains number tags that have not been created.', 'CUSTOM_NUMBER_INSERT_DUPLICATED' => 'Duplicate entries existed when writing inbound number tags to the backend.', 'CUSTOM_NUMBER_TOO_MANY_TAGS' => 'The input list contains numbers that exceed the maximum allowed number of tags.'], 'type' => 'string', 'example' => 'CUSTOM_NUMBER_DUPLICATED', 'title' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => ''], ['errorCode' => 'Parameter.InvalidFileContent', 'errorMessage' => 'The content or format of the file (%s) is invalid.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.RamId', 'errorMessage' => 'RAM user %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.UserResourceFileKey', 'errorMessage' => 'User resource file key %s does not exist.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.OSS', 'errorMessage' => 'An internal OSS service error occurred. %s', 'description' => ''], ['errorCode' => 'InternalService.DB', 'errorMessage' => 'An internal DB service error occurred. %s', 'description' => ''], ], ], 'staticInfo' => [ 'substitutions' => ['CCC::2020-07-01::ImportCustomCallTaggings'], ], 'title' => 'Import Inbound Number Marks ', 'changeSet' => [ ['createdAt' => '2022-02-24T13:00:36.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ImportCustomCallTagging'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": [\\n {\\n \\"Item\\": \\"1312121****\\",\\n \\"Reason\\": \\"CUSTOM_NUMBER_DUPLICATED\\"\\n }\\n ]\\n}","type":"json"}]', ], 'ImportDoNotCallNumbers' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc1MRAID'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'NumberList', 'in' => 'query', 'schema' => ['description' => 'A JSON string that represents an array of do-not-call numbers.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '["1900000****","1312121****"]', 'title' => ''], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => ['description' => 'The remark for the do-not-call numbers.', 'type' => 'string', 'required' => false, 'example' => '测试', 'title' => ''], ], [ 'name' => 'FilePath', 'in' => 'query', 'schema' => ['description' => 'The key of the OSS file. You can obtain the key from the response of the GetDoNotCallFileUploadParameters API. This parameter is required only for file uploads.', 'type' => 'string', 'required' => false, 'example' => 'temp/blacklist/import/15772471154xxxx/ccc-test/20220315100340/blacklist.xlsx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', 'title' => ''], 'Params' => [ 'description' => '', 'type' => 'array', 'items' => ['description' => 'Supplementary response parameters.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => ''], ['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => ''], ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Import Do-Not-Call Numbers', 'summary' => 'Imports one or more do-not-call numbers to a specified instance. You can import numbers by manual entry or file upload.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-11-06T05:44:49.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-02-24T13:00:36.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ImportDoNotCallNumbers'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', ], 'ImportDocuments' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'SchemaId', 'in' => 'formData', 'schema' => ['description' => 'The schema ID.', 'type' => 'string', 'required' => true, 'example' => 'profile', 'title' => ''], ], [ 'name' => 'OssFileKey', 'in' => 'formData', 'schema' => ['description' => 'The key of the OSS file.', 'type' => 'string', 'required' => true, 'example' => 'ccc-test/test-file.wav', 'title' => ''], ], [ 'name' => 'RequestId', 'in' => 'formData', 'schema' => ['description' => 'The request ID.', 'type' => 'string', 'required' => false, 'example' => '7BEEA660-A45A-45E3-98CC-AFC65E715C23', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1c450', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'ImportDocumentsResponse', 'title' => 'ImportDocumentsResponse', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '01B12EE4-6AF2-4730-8B78-EC15F4E5C025', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Params' => [ 'description' => 'The response parameters.', 'type' => 'array', 'items' => ['description' => 'The response parameters.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"01B12EE4-6AF2-4730-8B78-EC15F4E5C025\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', 'title' => 'Import documents', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'summary' => '', ], 'ImportRamUsers' => [ 'summary' => 'Import existing RAM users as contact center agents.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'RoleId', 'in' => 'query', 'schema' => ['description' => 'Role ID. This is the agent\'s role in the instance after successful import. Roles include administrator, skill group leader, and agent.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Agent@ccc-test'."\n", 'title' => ''], ], [ 'name' => 'SkillLevelList', 'in' => 'query', 'schema' => ['description' => 'Skill level list for the skill group. This is a JSON array string. Each array element is an object with two fields: skillGroupId and skillLevel. skillGroupId is the ID of the skill group the agent wants to associate with. skillLevel is the agent\'s skill level in that skill group. The range is 1-10. A smaller value indicates stronger business capability and the ability to handle more calls per unit of time.', 'type' => 'string', 'required' => false, 'example' => '[{"skillGroupId":"skillgroup@ccc-test","skillLevel":5}]'."\n", 'title' => ''], ], [ 'name' => 'RamIdList', 'in' => 'query', 'schema' => ['description' => 'List of RAM user IDs to add.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["28036411123456****","29234301123456****"]'."\n", 'title' => ''], ], [ 'name' => 'WorkMode', 'in' => 'query', 'schema' => ['description' => 'Work mode.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ON_SITE', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Data' => ['description' => 'Data, import execution ID.', 'type' => 'string', 'example' => '1ca2b084-6f0a-454b-9851-29768a9a5832'."\n", 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716', 'title' => ''], 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => ''], ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Import Agents from RAM', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"1ca2b084-6f0a-454b-9851-29768a9a5832\\\\n\\",\\n \\"RequestId\\": \\"03C67DAD-EB26-41D8-949D-9B0C470FB716\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\"\\n}","type":"json"}]', ], 'InitiateAttendedTransfer' => [ 'summary' => 'Consultation transfer refers to transferring a call to another agent, a skill group queue, or an external number. It is also known as follow transfer or two-step transfer.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'The agent ID initiating the consultation transfer.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test', 'title' => ''], ], [ 'name' => 'DeviceId', 'in' => 'query', 'schema' => ['description' => 'Device ID. This parameter is meaningless and can be filled with any value.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'ACC-YUNBS-1.0.10-****', 'title' => ''], ], [ 'name' => 'Transferor', 'in' => 'query', 'schema' => ['description' => 'The party initiating the transfer. When transferring to an external number, this parameter specifies the caller number. This parameter is invalid when transferring to an internal agent or skill group; in such cases, the initiator is determined by the UserId parameter.', 'type' => 'string', 'required' => false, 'example' => '无', 'title' => ''], ], [ 'name' => 'Transferee', 'in' => 'query', 'schema' => ['description' => 'The transferee, which can be an agent ID or a skill group ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'agent2@ccc-test', 'title' => ''], ], [ 'name' => 'TimeoutSeconds', 'in' => 'query', 'schema' => ['description' => 'Timeout duration for the consultation transfer, in seconds. If the transferee does not answer within the specified time, the call is disconnected. This field is optional. Default value is 30 seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60', 'title' => ''], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The call ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6538214103685****', 'title' => ''], ], [ 'name' => 'CallPriority', 'in' => 'query', 'schema' => ['description' => 'The queuing priority when transferring to a skill group queue. Valid values range from 0 to 9, where 0 is the highest priority and 9 is the lowest.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', 'title' => ''], ], [ 'name' => 'StrategyName', 'in' => 'query', 'schema' => ['description' => 'The policy name for agent assignment when transferring to a skill group queue.', 'type' => 'string', 'required' => false, 'example' => 'MOST_IDLE，MOST_SKILLED，MOST_ACQUAINTED，CUSTOMIZED等', 'title' => ''], ], [ 'name' => 'StrategyParams', 'in' => 'query', 'schema' => ['description' => 'The policy parameters for agent assignment when transferring to a skill group queue.', 'type' => 'string', 'required' => false, 'example' => '当分配策略为CUSTOMIZED时，本参数的内容为如下格式：'."\n" .' {'."\n" .' "functionId": "512fed64-e379-400f-a1a5-14d5730xxxxx",'."\n" .' "functionName": "routing-strategy-test-2"'."\n" .'}', 'title' => ''], ], [ 'name' => 'TransfereeType', 'in' => 'query', 'schema' => [ 'description' => 'The destination type for the transfer. Valid values are AGENT, SKILL\\_GROUP, and EXTERNAL. If this parameter is not provided, the system determines the destination type based on the format of the target number. If inaccurate detection occurs, explicitly specify this parameter.', 'enumValueTitles' => ['AGENT' => 'Agent', 'EXTERNAL' => 'External Number', 'SKILL_GROUP' => 'Skill Group'], 'type' => 'string', 'required' => false, 'example' => 'SKILL_GROUP', 'title' => '', ], ], [ 'name' => 'RoutingType', 'in' => 'query', 'schema' => [ 'description' => 'The call assignment type. Valid values are Automatic or Manual. If this parameter is empty, the default value is Automatic, which is also the current system\'s default behavior. When Manual is selected, you must invoke APIs such as ClaimCall to assign the call to a specific agent.', 'enumValueTitles' => ['Manual' => 'Manual assignment', 'Automatic' => 'Automatic assignment'], 'type' => 'string', 'required' => false, 'example' => 'Automatic', 'title' => '', ], ], [ 'name' => 'Tags', 'in' => 'query', 'schema' => ['description' => 'Ingest endpoint data, primarily used for extension requirements. Regular users do not need to concern themselves with this.', 'type' => 'string', 'required' => false, 'example' => 'a=b', 'title' => ''], ], [ 'name' => 'QueuingTimeoutSeconds', 'in' => 'query', 'schema' => ['description' => 'The queuing timeout period in seconds when the transfer target is a skill group queue.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'QueuingOverflowThreshold', 'in' => 'query', 'schema' => ['description' => 'The queuing overflow threshold when the transfer target is a skill group queue. The default value is 0, which means no overflow occurs.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], 'Params' => [ 'description' => 'List of response parameters.', 'type' => 'array', 'items' => ['description' => 'Response parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'ContextId' => ['description' => 'System auto increment ID. Customers do not need to concern themselves with this field.', 'type' => 'integer', 'format' => 'int64', 'example' => '103655', 'title' => ''], 'CallContext' => [ 'description' => 'Call context environment.', 'type' => 'object', 'properties' => [ 'CallType' => [ 'description' => 'Call type.', 'enumValueTitles' => [ 'INBOUND' => 'Inbound', 'BARGE' => 'Barge', 'CONSULTANT' => 'Consultation', 'CONFERENCE' => 'Conference', 'MONITOR' => 'Listener', 'INTERNAL' => 'Internal Call', 'OUTBOUND' => 'Outbound', 'INTERCEPT' => 'Intercept', 'BACK2BACK' => 'Back-to-Back', 'PREDICTIVE' => 'Predictive Outbound', 'COACH' => 'Coaching', ], 'type' => 'string', 'example' => 'OUTBOUND', 'title' => '', ], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'ChannelContexts' => [ 'description' => 'List of call channels.', 'type' => 'array', 'items' => [ 'description' => 'Call channel.', 'type' => 'object', 'properties' => [ 'Index' => ['description' => 'Records the order in which this channel was created during the call.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'ReleaseInitiator' => ['description' => 'The party that initiated the release of the call channel, indicating who hung up first.', 'type' => 'string', 'example' => '1390501****', 'title' => ''], 'ChannelState' => [ 'description' => 'The status of the call channel.', 'enumValueTitles' => ['CREATED' => 'Created', 'ANSWERED' => 'Answered', 'RELEASED' => 'Released', 'RETIRED' => 'Out Of Effect', 'EARLY_MEDIA' => 'Early Media', 'NONE' => 'Initial Status', 'RINGING' => 'Ringing'], 'type' => 'string', 'example' => 'ANSWERED', 'title' => '', ], 'Destination' => ['description' => 'The callee of the call channel.', 'type' => 'string', 'example' => '1390501****', 'title' => ''], 'UserId' => ['description' => 'The agent ID associated with the channel. This field is empty for a Customer channel.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'ChannelFlags' => [ 'description' => 'Channel flags.', 'enumValueTitles' => ['COACHING' => 'Coaching', 'MONITORING' => 'Monitoring', 'MONITORED' => 'monitored', 'COACHED' => 'coached', 'HOLD' => 'held', 'MUTED' => 'muted'], 'type' => 'string', 'example' => 'MONITORING', 'title' => '', ], 'SkillGroupId' => ['description' => 'The skill group ID associated with the voice channel. In inbound scenarios, the associated skill group ID is determined by the agent transfer module configured in the IVR. In outbound scenarios, the associated skill group ID is the first skill group the agent signed into.', 'type' => 'string', 'example' => 'skillgroup@ccc-test', 'title' => ''], 'Timestamp' => ['description' => 'The UNIX timestamp of the most recent status change of the voice channel, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315', 'title' => ''], 'ReleaseReason' => ['description' => 'The hang-up reason for the voice channel, indicating why the current voice channel was disconnected. The value comes from the response codes defined in the SIP protocol. Customers should refer to the SIP protocol to analyze the hang-up reason.', 'type' => 'string', 'example' => '404 - No destination', 'title' => ''], 'CallType' => ['description' => 'The call type of the call channel.', 'type' => 'string', 'example' => 'OUTBOUND', 'title' => ''], 'JobId' => ['description' => 'The call ID.', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'ChannelId' => ['description' => 'Channel ID.', 'type' => 'string', 'example' => 'ch:user:139xxxx0501->80326034:1609138902226:job-6538214103685****', 'title' => ''], 'UserExtension' => ['description' => 'The extension number of the agent associated with the channel.', 'type' => 'string', 'example' => '8032****', 'title' => ''], 'Originator' => ['description' => 'The originator of the channel.', 'type' => 'string', 'example' => '0830019****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'UserContext' => [ 'description' => 'Agent context environment.', 'type' => 'object', 'properties' => [ 'Extension' => ['description' => 'The agent\'s extension number.', 'type' => 'string', 'example' => '8032****', 'title' => ''], 'Heartbeat' => ['description' => 'The time when the last heartbeat was received from the agent, in UNIX timestamp format with millisecond precision.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378', 'title' => ''], 'WorkMode' => [ 'description' => 'Work mode.', 'enumValueTitles' => ['ON_SITE' => 'On-site mode', 'OFF_SITE' => 'Off-site mode', 'OFFICE_PHONE' => 'Office phone mode'], 'type' => 'string', 'example' => 'ON_SITE', 'title' => '', ], 'DeviceId' => ['description' => 'Device ID, the identity ID of a browser-based Web Real-Time Communication (WebRTC) softphone or a physical phone device. Only one type of device can be registered at a time.', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****', 'title' => ''], 'UserId' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'Reserved' => ['description' => 'The most recent time when the agent was reserved. Being reserved means an incoming call will be assigned to the agent shortly. The value is formatted as a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378', 'title' => ''], 'BreakCode' => [ 'description' => 'Break status code, which can be either System-defined or Custom-defined. System-defined break codes include: Warm-up (temporary break state after an agent is published and before becoming idle), RingingTimeout (break caused by agent ringing timeout), and RejectCall (break caused by agent call rejection). There are no restrictions on Custom-defined status codes; customers can define them as needed for their business.', 'enumValueTitles' => ['RingingTimeout' => 'Break caused by agent ringing timeout', 'RejectCall' => 'Break caused by agent call rejection', 'Warm-up' => 'Temporary break state after an agent is published and before becoming idle'], 'type' => 'string', 'example' => 'Warm-up', 'title' => '', ], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'OutboundScenario' => ['description' => 'Indicates whether the agent is in outbound-only mode.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Mobile' => ['description' => 'The agent\'s personal phone number.', 'type' => 'string', 'example' => '1324730****', 'title' => ''], 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'UserState' => [ 'description' => 'Agent status.', 'enumValueTitles' => ['READY' => 'Ready', 'WORKING' => 'Post-processing', 'DIALING' => 'Dialing', 'BREAK' => 'Break', 'OFFLINE' => 'Offline', 'TALKING' => 'Talking', 'RINGING' => 'Ringing'], 'type' => 'string', 'example' => 'TALKING', 'title' => '', ], 'SignedSkillGroupIdList' => [ 'description' => 'List of skill group IDs that the agent has signed into.', 'type' => 'array', 'items' => ['description' => 'Skill group ID.', 'type' => 'string', 'example' => 'skillgroup1@ccc-test', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ['errorCode' => 'InvalidOperation.ChannelState', 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', 'description' => ''], ['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.ChannelId', 'errorMessage' => 'The specified channel %s does not exist in call %s.', 'description' => ''], ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => ''], ], ], 'title' => 'Initiate Consultation Transfer ', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2024-04-01T09:23:01.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-10-26T08:13:47.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-04-25T07:33:48.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-04-12T02:15:28.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InitiateAttendedTransfer'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"ContextId\\": 103655,\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 10,\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:139xxxx0501->80326034:1609138902226:job-6538214103685****\\",\\n \\"UserExtension\\": \\"8032****\\",\\n \\"Originator\\": \\"0830019****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","type":"json"}]', ], 'InterceptCall' => [ 'summary' => 'You can invoke InterceptCall to forcibly disconnect the call associated with a specified call ID under a given instance. The call must be in the listener state, and the forced disconnection must be initiated by the listener. After the forced disconnection succeeds, the agent who was originally talking with the customer will be disconnected, and the agent who initiated the forced disconnection will replace the original agent and continue the conversation with the customer.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => '实例 ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => '发起强拆的坐席。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test', 'title' => ''], ], [ 'name' => 'DeviceId', 'in' => 'query', 'schema' => ['description' => 'Device ID. This parameter is meaningless and can be filled in with any value.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device', 'title' => ''], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The call ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6538214103685****', 'title' => ''], ], [ 'name' => 'InterceptedUserId', 'in' => 'query', 'schema' => ['description' => 'The agent ID that is forcibly disconnected.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'agent2@ccc-test', 'title' => ''], ], [ 'name' => 'TimeoutSeconds', 'in' => 'query', 'schema' => ['description' => '强拆超时时间，经过指定的时间强拆仍未成功，则取消强拆，正常情况下，强拆操作会马上成功，设置超时时间是为了防止异常发生，此字段选填，默认 30，单位秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '3600', 'minimum' => '0', 'example' => '60', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], 'Params' => [ 'description' => 'List of response parameters.', 'type' => 'array', 'items' => ['description' => 'Response parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'CallContext' => [ 'description' => 'Call context environment.', 'type' => 'object', 'properties' => [ 'CallType' => [ 'description' => 'The call type of the channel.', 'enumValueTitles' => [ 'INBOUND' => 'Inbound', 'BARGE' => 'Barge-in', 'CONSULTANT' => 'Consultation', 'CONFERENCE' => 'Conference', 'MONITOR' => 'Listener', 'INTERNAL' => 'Internal Call', 'OUTBOUND' => 'Outbound', 'INTERCEPT' => 'Intercept', 'BACK2BACK' => 'Back-to-Back Call', 'PREDICTIVE' => 'Predictive Outbound', 'COACH' => 'Coaching', ], 'type' => 'string', 'example' => 'INTERCEPT', 'title' => '', ], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'JobId' => ['description' => 'The call ID.', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'ChannelContexts' => [ 'description' => 'The list of channels.', 'type' => 'array', 'items' => [ 'description' => 'The channel.', 'type' => 'object', 'properties' => [ 'Index' => ['description' => 'An auto-incremented ID assigned by the system. Customers do not need to concern themselves with this value.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'ReleaseInitiator' => ['description' => '\\[responses\\_200\\_schema\\_properties\\_Data\\_properties\\_CallContext\\_properties\\_ChannelContexts\\_items\\_properties\\_CallType\\_type]string', 'type' => 'string', 'example' => '1390501****', 'title' => ''], 'ChannelState' => [ 'description' => '\\[responses\\_200\\_schema\\_properties\\_Data\\_properties\\_CallContext\\_properties\\_ChannelContexts\\_items\\_properties\\_CallType\\_enumValueTitles\\_COACH]Coaching', 'enumValueTitles' => ['CREATED' => '\\[responses\\_200\\_schema\\_properties\\_Data\\_properties\\_CallContext\\_properties\\_ChannelContexts\\_items\\_properties\\_CallType\\_enumValueTitles\\_CONFERENCE]Conference', 'ANSWERED' => '\\[responses\\_200\\_schema\\_properties\\_Data\\_properties\\_CallContext\\_properties\\_ChannelContexts\\_items\\_properties\\_CallType\\_enumValueTitles\\_MONITOR]Monitor', 'RELEASED' => '\\[responses\\_200\\_schema\\_properties\\_Data\\_properties\\_CallContext\\_properties\\_ChannelContexts\\_items\\_properties\\_CallType\\_enumValueTitles\\_INTERNAL]Internal Call', 'RETIRED' => '\\[responses\\_200\\_schema\\_properties\\_Data\\_properties\\_CallContext\\_properties\\_ChannelContexts\\_items\\_properties\\_CallType\\_enumValueTitles\\_OUTBOUND]Outbound', 'EARLY_MEDIA' => '\\[responses\\_200\\_schema\\_properties\\_Data\\_properties\\_CallContext\\_properties\\_ChannelContexts\\_items\\_properties\\_CallType\\_enumValueTitles\\_INTERCEPT]Intercept', 'NONE' => '\\[responses\\_200\\_schema\\_properties\\_Data\\_properties\\_CallContext\\_properties\\_ChannelContexts\\_items\\_properties\\_CallType\\_enumValueTitles\\_BACK2BACK]Back-to-Back Call', 'RINGING' => '\\[responses\\_200\\_schema\\_properties\\_Data\\_properties\\_CallContext\\_properties\\_ChannelContexts\\_items\\_properties\\_CallType\\_enumValueTitles\\_PREDICTIVE]Predictive Outbound'], 'type' => 'string', 'example' => 'ANSWERED', 'title' => '', ], 'Destination' => ['description' => '\\[responses\\_200\\_schema\\_properties\\_Data\\_properties\\_CallContext\\_properties\\_ChannelContexts\\_items\\_properties\\_CallType\\_enumValueTitles\\_BARGE]Barge-in', 'type' => 'string', 'example' => '1390501****', 'title' => ''], 'UserId' => ['description' => '话务通道关联的坐席 ID，如果是客户的话务通道，该字段为空。', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'ChannelFlags' => [ 'description' => '话务通道标志。', 'enumValueTitles' => ['COACHING' => '辅导中', 'MONITORING' => '监听中', 'MONITORED' => '被监听', 'COACHED' => '被辅导', 'HOLD' => '保持', 'MUTED' => '静音'], 'type' => 'string', 'example' => '无', 'title' => '', ], 'SkillGroupId' => ['description' => '话务通道关联的技能组 ID，呼入场景下，关联的技能组 ID 由 IVR 中转人工模块配置的技能组决定，呼出场景下，关联的技能组 ID 为座席签入的第一个技能组的 ID。', 'type' => 'string', 'example' => 'skillgroup@ccc-test', 'title' => ''], 'Timestamp' => ['description' => '话务通道最近一次状态变化的时间戳，格式是 Unix 时间戳，单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315', 'title' => ''], 'ReleaseReason' => ['description' => '话务通道的挂断原因，表示当前话务通道为什么会被挂断，取值来自 SIP 协议中定义的响应码，请客户参考 SIP 协议分析挂断原因。', 'type' => 'string', 'example' => '404 - No destination', 'title' => ''], 'CallType' => [ 'description' => 'The call type of the channel.', 'enumValueTitles' => [ 'INBOUND' => '\\[responses\\_200\\_schema\\_properties\\_Data\\_properties\\_CallContext\\_properties\\_ChannelContexts\\_items\\_properties\\_Index\\_type]integer', 'BARGE' => 'Barge-in', 'CONSULTANT' => 'Consultation', 'CONFERENCE' => 'Conference', 'MONITOR' => 'Monitor', 'INTERNAL' => 'Internal Call', 'OUTBOUND' => 'Outbound', 'INTERCEPT' => 'Intercept', 'BACK2BACK' => 'Back-to-Back Call', 'PREDICTIVE' => 'Predictive Outbound', 'COACH' => 'Coaching', ], 'type' => 'string', 'example' => 'INTERCEPT', 'title' => '', ], 'JobId' => ['description' => '通话 ID。', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'ChannelId' => ['description' => '话务通道 ID。', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****', 'title' => ''], 'UserExtension' => ['description' => '话务通道关联的坐席的分机号。', 'type' => 'string', 'example' => '8032****', 'title' => ''], 'Originator' => ['description' => '话务通道的主叫方。', 'type' => 'string', 'example' => '0830019****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'UserContext' => [ 'description' => 'Agent context environment.', 'type' => 'object', 'properties' => [ 'Extension' => ['description' => 'Agent extension number.', 'type' => 'string', 'example' => '8032****', 'title' => ''], 'Heartbeat' => ['description' => 'The time when the last heartbeat was received from the agent, formatted as a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378', 'title' => ''], 'WorkMode' => [ 'description' => 'Work mode.', 'enumValueTitles' => ['ON_SITE' => 'On-site mode', 'OFF_SITE' => 'Off-site mode', 'OFFICE_PHONE' => 'Office phone mode'], 'type' => 'string', 'example' => 'ON_SITE', 'title' => '', ], 'DeviceId' => ['description' => 'Device ID, which is the identity ID of a browser-based Web Real-Time Communication (WebRTC) softphone or a physical phone device. Only one type of device can be registered at a time.', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****', 'title' => ''], 'UserId' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'Reserved' => ['description' => 'The time when the agent was most recently reserved. Being reserved means an incoming call will be assigned to the agent shortly. The format is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378', 'title' => ''], 'BreakCode' => [ 'description' => 'Break status code, which can be either System-defined or Custom-defined. System-defined break codes include: Warm-up (temporary break state after an agent is published and before becoming idle), RingingTimeout (break caused by agent ringing timeout), and RejectCall (break caused by agent call rejection). There are no restrictions on Custom-defined status codes, and customers can define them according to their business needs.', 'enumValueTitles' => ['RingingTimeout' => 'Break caused by agent ringing timeout', 'RejectCall' => 'Break caused by agent call rejection', 'Warm-up' => 'Temporary break state after an agent is published and before becoming idle'], 'type' => 'string', 'example' => 'Warm-up', 'title' => '', ], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'OutboundScenario' => ['description' => 'Indicates whether the agent is in outbound-only mode.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Mobile' => ['description' => 'The agent\'s personal phone number.', 'type' => 'string', 'example' => '1324730****', 'title' => ''], 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'UserState' => [ 'description' => 'Agent status.', 'enumValueTitles' => ['READY' => 'Idle', 'WORKING' => 'Post-processing', 'DIALING' => 'Dialing', 'BREAK' => 'Break', 'OFFLINE' => 'Offline', 'TALKING' => 'Talking', 'RINGING' => 'Ringing'], 'type' => 'string', 'example' => 'TALKING', 'title' => '', ], 'SignedSkillGroupIdList' => [ 'description' => 'List of skill group IDs that the agent has signed into.', 'type' => 'array', 'items' => ['description' => 'Skill group ID.', 'type' => 'string', 'example' => 'skillgroup1@ccc-test', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidOperation.ChannelState', 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', 'description' => ''], ['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => ''], ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => ''], ], ], 'title' => '强拆通话', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-11-06T05:44:49.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InterceptCall'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"INTERCEPT\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 10,\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"无\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"INTERCEPT\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"UserExtension\\": \\"8032****\\",\\n \\"Originator\\": \\"0830019****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","type":"json"}]', ], 'LaunchAuthentication' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccTPIKHY'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'The agent ID that initiates identity verification.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test', 'title' => ''], ], [ 'name' => 'DeviceId', 'in' => 'query', 'schema' => ['description' => 'Device ID. This parameter is meaningless and can be filled in with any value.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'ACC-YUNBS-1.0.10-****', 'title' => ''], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The call ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6538214103685****', 'title' => ''], ], [ 'name' => 'ContactFlowId', 'in' => 'query', 'schema' => ['description' => 'The contact flow ID for the IVR identity verification flow.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'af145gfc-1108-4d55-8fca-f719bd512ebb', 'title' => ''], ], [ 'name' => 'ContactFlowVariables', 'in' => 'query', 'schema' => ['description' => 'Variables passed to the contact flow. This parameter is optional. The configured variables can be retrieved and used within the IVR flow. The format is a JSON string representing a collection of key-value pairs.', 'type' => 'string', 'required' => false, 'example' => '{'."\n" .' "customerID": "208880281831****",'."\n" .' "operateType": "cipherCode",'."\n" .' "taskId": "1234567890",'."\n" .' "crmOther": "123"'."\n" .'}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], 'Params' => [ 'description' => 'List of response parameters.', 'type' => 'array', 'items' => ['description' => 'Response parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'CallContext' => [ 'description' => 'Call context environment.', 'type' => 'object', 'properties' => [ 'CallType' => [ 'description' => 'Call type.', 'enumValueTitles' => [ 'INBOUND' => 'Inbound', 'BARGE' => 'Barge-in', 'CONSULTANT' => 'Consultation', 'CONFERENCE' => 'Conference', 'MONITOR' => 'Listener', 'INTERNAL' => 'Internal Call', 'OUTBOUND' => 'Outbound', 'INTERCEPT' => 'Intercept', 'BACK2BACK' => 'Back-to-Back Call', 'PREDICTIVE' => 'Predictive Outbound', 'COACH' => 'Coaching', ], 'type' => 'string', 'example' => 'OUTBOUND', 'title' => '', ], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'ChannelContexts' => [ 'description' => 'List of call channels.', 'type' => 'array', 'items' => [ 'description' => 'Call channel.', 'type' => 'object', 'properties' => [ 'Index' => ['description' => 'An auto-increment ID assigned by the System. Customers do not need to concern themselves with this value.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'ReleaseInitiator' => ['description' => 'The party that initiated the release of the call channel, indicating who first hung up the call.', 'type' => 'string', 'example' => '1390501****', 'title' => ''], 'ChannelState' => [ 'description' => 'The status of the call channel.', 'enumValueTitles' => ['CREATED' => 'Created', 'ANSWERED' => 'Answered', 'RELEASED' => 'Released', 'RETIRED' => 'Out Of Effect', 'EARLY_MEDIA' => 'Early Media', 'NONE' => 'Initial Status', 'RINGING' => 'Ringing'], 'type' => 'string', 'example' => 'ANSWERED', 'title' => '', ], 'Destination' => ['description' => 'Called party of the call channel.', 'type' => 'string', 'example' => '1390501****', 'title' => ''], 'UserId' => ['description' => 'The agent ID associated with the channel. This field is empty if the channel belongs to a Customer.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'ChannelFlags' => [ 'description' => 'Channel flags.', 'enumValueTitles' => ['COACHING' => 'Coaching', 'MONITORING' => 'Monitoring', 'MONITORED' => 'Monitored', 'COACHED' => 'Coached', 'HOLD' => 'Hold', 'MUTED' => 'Muted'], 'type' => 'string', 'example' => 'MONITORING', 'title' => '', ], 'SkillGroupId' => ['description' => 'The skill group ID associated with the voice channel. In inbound scenarios, the associated skill group ID is determined by the skill group configured in the IVR transfer-to-agent module. In outbound scenarios, the associated skill group ID is the first skill group that the agent signed into.', 'type' => 'string', 'example' => 'skillgroup@ccc-test', 'title' => ''], 'Timestamp' => ['description' => 'The UNIX timestamp of the most recent status change of the voice channel, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315', 'title' => ''], 'ReleaseReason' => ['description' => 'The hang-up reason for the voice channel, indicating why the current voice channel was disconnected. The value comes from the response codes defined in the SIP protocol. Customers should refer to the SIP protocol to analyze the hang-up reason.', 'type' => 'string', 'example' => '404 - No destination', 'title' => ''], 'CallType' => [ 'description' => 'The call type of the channel.', 'enumValueTitles' => [ 'INBOUND' => 'Inbound', 'BARGE' => 'Barge', 'CONSULTANT' => 'Consultation', 'CONFERENCE' => 'Conference', 'MONITOR' => 'Listener', 'INTERNAL' => 'Internal Call', 'OUTBOUND' => 'Outbound', 'INTERCEPT' => 'Intercept', 'BACK2BACK' => 'Back-to-Back', 'PREDICTIVE' => 'Predictive Outbound', 'COACH' => 'Coaching', ], 'type' => 'string', 'example' => 'OUTBOUND', 'title' => '', ], 'JobId' => ['description' => 'The call ID.', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'ChannelId' => ['description' => 'The voice channel ID.', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****', 'title' => ''], 'UserExtension' => ['description' => 'The extension number of the agent associated with the channel.', 'type' => 'string', 'example' => '8032****', 'title' => ''], 'Originator' => ['description' => 'The originator of the channel.', 'type' => 'string', 'example' => '0830019****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'UserContext' => [ 'description' => 'Agent context environment.', 'type' => 'object', 'properties' => [ 'Extension' => ['description' => 'The agent\'s extension number.', 'type' => 'string', 'example' => '8032****', 'title' => ''], 'Heartbeat' => ['description' => 'The time when the last heartbeat was received from the agent, in UNIX timestamp format, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378', 'title' => ''], 'WorkMode' => [ 'description' => 'Work mode.', 'enumValueTitles' => ['ON_SITE' => 'On-site mode', 'OFF_SITE' => 'Off-site mode', 'OFFICE_PHONE' => 'Office phone mode'], 'type' => 'string', 'example' => 'ON_SITE', 'title' => '', ], 'DeviceId' => ['description' => 'Device ID, the identity ID of a browser-based Web Real-Time Communication (WebRTC) softphone or a physical phone device. Only one type of device can be registered at a time.', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****', 'title' => ''], 'UserId' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'Reserved' => ['description' => 'The most recent time when the agent was reserved. Being reserved means an incoming call will be assigned to the agent shortly. The value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378', 'title' => ''], 'BreakCode' => [ 'description' => 'Break status code, which can be either System-defined or Custom-defined. System-defined break codes include: Warm-up (temporary break state after an agent is published and before becoming idle), RingingTimeout (break caused by agent ringing timeout), and RejectCall (break caused by agent call rejection). There are no restrictions on Custom-defined status codes; customers can define them according to their business needs.', 'enumValueTitles' => ['RingingTimeout' => 'Break due to agent ringing timeout', 'RejectCall' => 'Break due to agent call rejection', 'Warm-up' => 'Temporary break state after an agent is published and before becoming idle'], 'type' => 'string', 'example' => 'Warm-up', 'title' => '', ], 'InstanceId' => ['description' => 'instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'OutboundScenario' => ['description' => 'Indicates whether the agent is in outbound-only mode.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Mobile' => ['description' => 'The agent\'s personal phone number.', 'type' => 'string', 'example' => '1324730****', 'title' => ''], 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'UserState' => [ 'description' => 'Agent status.', 'enumValueTitles' => ['READY' => 'empty', 'WORKING' => 'post-processing', 'DIALING' => 'dial-up', 'BREAK' => 'break', 'OFFLINE' => 'offline', 'TALKING' => 'talking', 'RINGING' => 'ringing'], 'type' => 'string', 'example' => 'TALKING', 'title' => '', ], 'SignedSkillGroupIdList' => [ 'description' => 'List of skill group IDs that the agent has signed into.', 'type' => 'array', 'items' => ['description' => 'Skill group ID.', 'type' => 'string', 'example' => 'skillgroup1@ccc-test', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.ChannelId', 'errorMessage' => 'The specified channel %s does not exist in call %s.', 'description' => ''], ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => ''], ], ], 'title' => 'Initiate IVR Identity Verification ', 'summary' => 'You can invoke LaunchAuthentication to temporarily transfer a call into a specified IVR flow. After invoking this API, the call enters an IVR interaction phase, which is commonly used for identity verification operations.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-10-26T08:13:47.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'LaunchAuthentication'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 10,\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"UserExtension\\": \\"8032****\\",\\n \\"Originator\\": \\"0830019****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","type":"json"}]', ], 'LaunchSurvey' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc3I1HSP'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'The agent ID that initiates the satisfaction survey.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test', 'title' => ''], ], [ 'name' => 'DeviceId', 'in' => 'query', 'schema' => ['description' => 'Device ID. This parameter has no effect and can be filled with any value.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device', 'title' => ''], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The call ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6580466654649****', 'title' => ''], ], [ 'name' => 'ContactFlowId', 'in' => 'query', 'schema' => ['description' => 'The contact flow ID of the IVR satisfaction survey flow. Ensure that the specified contact flow ID corresponds to an active satisfaction survey flow.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '4685b65a-eb8f-11ec-8ea0-0242ac120002', 'title' => ''], ], [ 'name' => 'ContactFlowVariables', 'in' => 'query', 'schema' => ['description' => 'Variables passed to the contact flow. The variables configured here can be retrieved and used in the IVR flow. The format is a JSON string containing a collection of key-value pairs. This parameter is optional and defaults to empty.', 'type' => 'string', 'required' => false, 'example' => '{'."\n" .' "customerID": "208880281831****",'."\n" .' "operateType": "cipherCode",'."\n" .' "taskId": "1234567890",'."\n" .' "crmOther": "123"'."\n" .'}', 'title' => ''], ], [ 'name' => 'SurveyChannel', 'in' => 'query', 'schema' => [ 'description' => 'The channel for collecting satisfaction feedback. This parameter is optional and defaults to Voice Satisfaction.', 'enumValueTitles' => ['IVR' => 'Voice Satisfaction', 'SMS' => 'Text Message Satisfaction'], 'type' => 'string', 'required' => false, 'example' => 'IVR', 'title' => '', ], ], [ 'name' => 'SmsMetadataId', 'in' => 'query', 'schema' => ['description' => 'The configuration ID for text message satisfaction. This parameter is required only when the collection channel is SMS. It is optional and defaults to empty.', 'type' => 'string', 'required' => false, 'example' => '4685b65a-eb8f-11ec-8ea0-0242ac120002', 'title' => ''], ], [ 'name' => 'SurveyTemplateId', 'in' => 'query', 'schema' => ['description' => 'The ID of the satisfaction survey template.', 'type' => 'string', 'required' => false, 'example' => '19dc793c-9a01-4cb0-b7d5-fcb5431bab6b', 'title' => ''], ], [ 'name' => 'SurveyTemplateVariables', 'in' => 'query', 'schema' => ['description' => 'Satisfaction survey configuration.', 'type' => 'string', 'required' => false, 'example' => '[]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'AF1E5957-5276-48FF-A6E6-347166A4ADCD', 'title' => ''], 'Params' => [ 'description' => 'List of response parameters.', 'type' => 'array', 'items' => ['description' => 'Response parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'CallContext' => [ 'description' => 'Call context environment.', 'type' => 'object', 'properties' => [ 'CallType' => [ 'description' => 'Call type.', 'enumValueTitles' => [ 'INBOUND' => 'Inbound', 'BARGE' => 'Barge-in', 'CONSULTANT' => 'Consultation', 'CONFERENCE' => 'Conference', 'MONITOR' => 'Listener', 'INTERNAL' => 'Internal Call', 'OUTBOUND' => 'Outbound', 'INTERCEPT' => 'Intercept', 'BACK2BACK' => 'Back-to-Back Call', 'PREDICTIVE' => 'Predictive Outbound', 'COACH' => 'Coaching', ], 'type' => 'string', 'example' => 'OUTBOUND', 'title' => '', ], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-6580466654649****', 'title' => ''], 'ChannelContexts' => [ 'description' => 'List of channels.', 'type' => 'array', 'items' => [ 'description' => 'Channel.', 'type' => 'object', 'properties' => [ 'Index' => ['description' => 'System auto increment ID, which the customer does not need to concern themselves with.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'ReleaseInitiator' => ['description' => 'The party that initiated the release of the voice channel, indicating who hung up first.', 'type' => 'string', 'example' => '无', 'title' => ''], 'ChannelState' => [ 'description' => 'The status of the voice channel.', 'enumValueTitles' => ['CREATED' => 'Created', 'ANSWERED' => 'Answered', 'RELEASED' => 'Released', 'RETIRED' => 'Out Of Effect', 'EARLY_MEDIA' => 'Early Media', 'NONE' => 'Initial Status', 'RINGING' => 'Ringing'], 'type' => 'string', 'example' => 'ANSWERED', 'title' => '', ], 'Destination' => ['description' => 'The callee of the voice channel.', 'type' => 'string', 'example' => '1318888****', 'title' => ''], 'UserId' => ['description' => 'The agent ID associated with the channel. This field is empty if the channel belongs to a Customer.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'ChannelFlags' => [ 'description' => 'Channel flags.', 'enumValueTitles' => ['COACHING' => 'Coaching', 'MONITORING' => 'Monitoring', 'MONITORED' => 'Monitored', 'COACHED' => 'Coached', 'HOLD' => 'Hold', 'MUTED' => 'Muted'], 'type' => 'string', 'example' => 'MONITORING', 'title' => '', ], 'SkillGroupId' => ['description' => 'The skill group ID associated with the channel. In inbound scenarios, the associated skill group ID is determined by the agent transfer module configured in the IVR. In outbound scenarios, the associated skill group ID is the first skill group that the agent signed into.', 'type' => 'string', 'example' => 'skillgroup@ccc-test', 'title' => ''], 'Timestamp' => ['description' => 'The UNIX timestamp of the most recent status change of the channel, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609250655922', 'title' => ''], 'ReleaseReason' => ['description' => 'The reason for releasing the channel, indicating why the current channel was disconnected. The value corresponds to response codes defined in the SIP protocol. Customers should refer to the SIP protocol to analyze the disconnection reason.', 'type' => 'string', 'example' => '无', 'title' => ''], 'CallType' => [ 'description' => 'The call type of the channel.', 'enumValueTitles' => [ 'INBOUND' => 'Inbound', 'BARGE' => 'Barge', 'CONSULTANT' => 'Consultation', 'CONFERENCE' => 'Conference', 'MONITOR' => 'Monitor', 'INTERNAL' => 'Internal Call', 'OUTBOUND' => 'Outbound', 'INTERCEPT' => 'Intercept', 'BACK2BACK' => 'Back-to-Back', 'PREDICTIVE' => 'Predictive Dialing', 'COACH' => 'Coaching', ], 'type' => 'string', 'example' => 'OUTBOUND', 'title' => '', ], 'JobId' => ['description' => 'The call ID.', 'type' => 'string', 'example' => 'job-6580466654649****', 'title' => ''], 'ChannelId' => ['description' => 'The channel ID.', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****', 'title' => ''], 'UserExtension' => ['description' => 'The extension number of the agent associated with the channel.', 'type' => 'string', 'example' => '8001****', 'title' => ''], 'Originator' => ['description' => 'The originator of the channel.', 'type' => 'string', 'example' => '1318888****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'UserContext' => [ 'description' => 'Agent context environment.', 'type' => 'object', 'properties' => [ 'Extension' => ['description' => 'Agent extension number.', 'type' => 'string', 'example' => '8001****', 'title' => ''], 'Heartbeat' => ['description' => 'The time when the last heartbeat was received from the agent, formatted as a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609250656122', 'title' => ''], 'WorkMode' => [ 'description' => 'Work mode.', 'enumValueTitles' => ['ON_SITE' => 'On-site mode', 'OFF_SITE' => 'Off-site mode', 'OFFICE_PHONE' => 'Office phone mode'], 'type' => 'string', 'example' => 'ON_SITE', 'title' => '', ], 'DeviceId' => ['description' => 'Device ID, which is the identity ID of a browser-based Web Real-Time Communication (WebRTC) softphone or a physical phone device. Only one type of device can be registered at a time.', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****', 'title' => ''], 'UserId' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'Reserved' => ['description' => 'The most recent time the agent was reserved. Being reserved means an incoming call will be assigned to the agent shortly. The format is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609250655090', 'title' => ''], 'BreakCode' => [ 'description' => 'Break status code, which can be either system-defined or customer-defined. System-defined break codes include: Warm-up (temporary break state after agent is published and before becoming idle), RingingTimeout (break caused by agent ringing timeout), and RejectCall (break caused by agent call rejection). Customer-defined status codes have no restrictions, and customers can define them according to their business needs.', 'enumValueTitles' => ['RingingTimeout' => 'Break caused by agent ringing timeout', 'RejectCall' => 'Break caused by agent call rejection', 'Warm-up' => 'Temporary break state after agent is published and before becoming idle'], 'type' => 'string', 'example' => 'Warm-up', 'title' => '', ], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'OutboundScenario' => ['description' => 'Indicates whether the agent is in outbound-only mode.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Mobile' => ['description' => 'Agent\'s personal phone number.', 'type' => 'string', 'example' => '1390000****', 'title' => ''], 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-6580466654649****', 'title' => ''], 'UserState' => [ 'description' => 'Agent status.', 'enumValueTitles' => ['READY' => 'Idle', 'WORKING' => 'Post-processing', 'DIALING' => 'Dialing', 'BREAK' => 'Break', 'OFFLINE' => 'Offline', 'TALKING' => 'Talking', 'RINGING' => 'Ringing'], 'type' => 'string', 'example' => 'TALKING', 'title' => '', ], 'SignedSkillGroupIdList' => [ 'description' => 'List of skill group IDs that the agent has signed into.', 'type' => 'array', 'items' => ['description' => 'Skill group ID.', 'type' => 'string', 'example' => 'skillgroup1@ccc-test', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'ContextId' => ['description' => 'System auto increment ID. Customers do not need to concern themselves with this.', 'type' => 'integer', 'format' => 'int64', 'example' => '102323', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.ChannelId', 'errorMessage' => 'The specified channel %s does not exist in call %s.', 'description' => ''], ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => ''], ], ], 'title' => 'Initiate a satisfaction survey ', 'summary' => 'Invoke LaunchSurvey to send a satisfaction survey. This operation causes the agent to hang up. If it is a voice-based satisfaction survey, the customer enters the IVR satisfaction survey flow after the agent hangs up and completes the satisfaction collection within the IVR flow. If it is an SMS-based satisfaction survey, the call ends and the customer receives a satisfaction survey text message.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2024-08-13T06:54:43.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-06-21T06:40:16.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-10-26T08:13:47.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2021-12-22T03:36:07.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'LaunchSurvey'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"AF1E5957-5276-48FF-A6E6-347166A4ADCD\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6580466654649****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 1,\\n \\"ReleaseInitiator\\": \\"无\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"1318888****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609250655922,\\n \\"ReleaseReason\\": \\"无\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6580466654649****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"UserExtension\\": \\"8001****\\",\\n \\"Originator\\": \\"1318888****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8001****\\",\\n \\"Heartbeat\\": 1609250656122,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609250655090,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1390000****\\",\\n \\"JobId\\": \\"job-6580466654649****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n },\\n \\"ContextId\\": 102323\\n }\\n}","type":"json"}]', ], 'ListAgentStateLogs' => [ 'summary' => 'Invoke ListAgentStateLogs to obtain the status log list of a specified agent under a specified instance. Note that this API will soon expire. Use the override API ListRealtimeAgentStates instead.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccSART34'], ], 'parameters' => [ [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'Start UNIX timestamp. The default value is the start time of the current day. The earliest allowed value is 180 days before the current date. The format is a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1620230400000', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'End UNIX timestamp. The default value is the current time. The time difference between EndTime and StartTime must not exceed 7 days. The format is a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1620273600000', 'title' => ''], ], [ 'name' => 'AgentId', 'in' => 'query', 'schema' => ['description' => 'Agent ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'agent@ccc-test', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '943D8EF3-3321-471F-A104-51C96FCA94D6', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'type' => 'array', 'items' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'StartTime' => ['description' => 'Start Time of the status, in UNIX timestamp format, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1620259200000', 'title' => ''], 'StateCode' => [ 'description' => 'Sub-status, which provides additional details for the status code. In certain scenarios, an agent\'s status is jointly identified by State and StateCode. For example, in a monitoring scenario, the State is Talking and the StateCode is Monitoring.', 'enumValueTitles' => ['Monitored' => 'Listener', 'Consulted' => 'Consulted', 'Consulting' => 'Consulting', 'Conference' => 'Conference', 'Monitoring' => 'Monitoring'], 'type' => 'string', 'example' => 'CHECK_IN_BREAK', 'title' => '', ], 'Duration' => ['description' => 'Duration of the status, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '32', 'title' => ''], 'State' => [ 'description' => 'Status code.', 'enumValueTitles' => ['Ready' => 'Ready', 'Talking' => 'Talking', 'ACW' => 'Post-processing', 'Ringing' => 'Ringing', 'Break' => 'Break', 'Offline' => 'Unpublish', 'Dialing' => 'Dial-up'], 'type' => 'string', 'example' => 'Break', 'title' => '', ], 'OutboundScenario' => ['description' => 'Indicates whether the agent is in outbound-only mode.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'BreakCode' => ['description' => 'Break code.', 'type' => 'string', 'example' => '会议', 'title' => ''], 'WorkMode' => ['description' => 'Work mode.', 'type' => 'string', 'example' => 'ON_SITE', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ], ], 'title' => 'Retrieve Agent Status Log List ', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-05-10T07:29:41.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAgentStateLogs'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"943D8EF3-3321-471F-A104-51C96FCA94D6\\",\\n \\"Data\\": [\\n {\\n \\"StartTime\\": 1620259200000,\\n \\"StateCode\\": \\"CHECK_IN_BREAK\\",\\n \\"Duration\\": 32,\\n \\"State\\": \\"Break\\",\\n \\"OutboundScenario\\": false,\\n \\"BreakCode\\": \\"会议\\",\\n \\"WorkMode\\": \\"ON_SITE\\"\\n }\\n ]\\n}","type":"json"}]', ], 'ListAgentStates' => [ 'summary' => 'You can invoke the ListAgentStates API to retrieve a list of agent statuses under a specified instance, filtered by specified conditions. This API is available only to specific Users. Other Customers are not recommended to invoke it.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => true, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccSART34'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'SkillGroupId', 'in' => 'query', 'schema' => ['description' => 'Filters by skill group ID.', 'type' => 'string', 'required' => false, 'example' => 'skillgroup@ccc-test', 'title' => ''], ], [ 'name' => 'AgentIds', 'in' => 'query', 'schema' => ['description' => 'Filters by a list of agent IDs.', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test', 'title' => ''], ], [ 'name' => 'State', 'in' => 'query', 'schema' => [ 'description' => 'Filters agents by status. Only a single status can be specified.', 'enumValueTitles' => ['Ready' => 'Idle', 'Talking' => 'Talking', 'ACW' => 'Post-processing', 'Break' => 'Break', 'Ringing' => 'Ringing', 'Offline' => 'Unpublish', 'Dialing' => 'Dial-up'], 'type' => 'string', 'required' => false, 'example' => 'Ready', 'title' => '', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'Page number, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'Page size, ranging from 1 to 300.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], ], [ 'name' => 'ExcludeOfflineUsers', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => 'Filters out offline agents. This parameter is fixed to true and does not support false at present.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716', 'title' => ''], 'Success' => ['description' => 'Indicates whether the operation succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'Page number, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'Page size, ranging from 1 to 300.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'TotalCount' => ['description' => 'Total count.', 'type' => 'integer', 'format' => 'int32', 'example' => '11', 'title' => ''], 'List' => [ 'description' => 'List.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'LoginName' => ['description' => 'Agent logon name.', 'type' => 'string', 'example' => 'agent', 'title' => ''], 'Dn' => ['description' => 'Agent extension number.', 'type' => 'string', 'example' => '8030****', 'title' => ''], 'StateDuration' => ['description' => 'Duration of the agent status.', 'type' => 'string', 'example' => '10', 'title' => ''], 'State' => [ 'description' => 'Agent status.', 'enumValueTitles' => ['Ready' => 'Ready', 'Talking' => 'Talking', 'ACW' => 'Post-processing', 'Ringing' => 'Ringing', 'Break' => 'Break', 'Offline' => 'Unpublish', 'Dialing' => 'Dial-up'], 'type' => 'string', 'example' => 'Ready', 'title' => '', ], 'AgentId' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'AgentName' => ['description' => 'Agent name.', 'type' => 'string', 'example' => '坐席小王', 'title' => ''], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'BreakCode' => [ 'description' => 'Break code.', 'enumValueTitles' => ['RingingTimeout' => 'Break due to agent ringing timeout', 'RejectCall' => 'Break due to agent call rejection', 'Warm-up' => 'Temporary break state after agent is published and before becoming idle'], 'type' => 'string', 'example' => 'Warm-up', 'title' => '', ], 'OutboundScenario' => ['description' => 'Indicates whether the agent is in outbound-only mode.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'staticInfo' => [ 'substitutions' => ['CCC::2020-07-01::ListRealtimeAgentStates'], ], 'title' => 'Obtain the agent status list ', 'changeSet' => [ ['createdAt' => '2022-07-01T13:16:03.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-06-29T14:26:34.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAgentStates'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"03C67DAD-EB26-41D8-949D-9B0C470FB716\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 11,\\n \\"List\\": [\\n {\\n \\"LoginName\\": \\"agent\\",\\n \\"Dn\\": \\"8030****\\",\\n \\"StateDuration\\": \\"10\\",\\n \\"State\\": \\"Ready\\",\\n \\"AgentId\\": \\"agent@ccc-test\\",\\n \\"AgentName\\": \\"坐席小王\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"OutboundScenario\\": false\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'ListAgentSummaryReportsSinceMidnight' => [ 'summary' => 'You can invoke the ListAgentSummaryReportsSinceMidnight API to retrieve agent historical data reports under a specified instance, filtered by given conditions. The statistics cover data from 00:00 of the current day up to the current time. This API is available only to specific users; other customers are not recommended to invoke it.', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => true, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'SkillGroupId', 'in' => 'query', 'schema' => ['description' => 'Filter by skill group ID.', 'type' => 'string', 'required' => false, 'example' => 'skillgroup@ccc-test', 'title' => ''], ], [ 'name' => 'AgentIds', 'in' => 'query', 'schema' => ['description' => 'Filter by a list of agent IDs, with up to 100 IDs.'."\n" ."\n" .'> If the agent ID list is not empty, the system directly queries based on the provided agent ID list. In this case, the pageSize and pageNumber parameters are invalid, and the data is returned directly. For example, if the request parameter is pageNumber = 3, the response parameter will also be pageNumber = 3.', 'type' => 'string', 'required' => false, 'example' => '["agent1@ccc-test", "agent2@ccc-test"]', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'Page number, ranging from 1 to 100. Optional. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'Page size, ranging from 1 to 100. Optional. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '27DD30C4-CAE2-481A-97CC-D3C54625341D', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'PagedAgentSummaryReport' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'Page number, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'Page size, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'TotalCount' => ['description' => 'Total count.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], 'List' => [ 'description' => 'List of agent summary data.', 'type' => 'array', 'items' => [ 'description' => 'Agent summary data.', 'type' => 'object', 'properties' => [ 'LoginName' => ['description' => 'Agent logon name.', 'type' => 'string', 'example' => 'agent', 'title' => ''], 'AgentId' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'AgentName' => ['description' => 'Agent name.', 'type' => 'string', 'example' => '坐席小王。', 'title' => ''], 'SkillGroupNames' => ['description' => 'List of skill group names to which the agent belongs, formatted as a JSON array string, where each array element is a skill group name.', 'type' => 'string', 'example' => '["测试技能组1","测试技能组2"]', 'title' => ''], 'Timestamp' => ['description' => 'The timestamp of the statistics data point.', 'type' => 'string', 'example' => '2018-09-13 00:00:00', 'title' => ''], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'SkillGroupIds' => ['description' => 'List of skill group IDs to which the agent belongs, formatted as a JSON array string, where each array element is a skill group ID.', 'type' => 'string', 'example' => '["skillgroup1@ccc-test","skillgroup2@ccc-test"]'."\n", 'title' => ''], 'Overall' => [ 'description' => 'Overall metric.', 'type' => 'object', 'properties' => [ 'TotalTalkTime' => ['description' => 'Total talk time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalLoggedInTime' => ['description' => 'Total logon time, excluding break time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'OccupancyRate' => ['description' => 'Agent occupancy rate. Calculation Formula: (TotalWorkTime + TotalTalkTime) / TotalLoggedInTime.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'TotalWorkTime' => ['description' => 'Total post-processing time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxWorkTime' => ['description' => 'Maximum post-processing time after a call, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageWorkTime' => ['description' => 'Average post-processing time. Calculation Formula: TotalWorkTime divided by TotalCalls, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageTalkTime' => ['description' => 'Average talk time. Calculation Formula: TotalTalkTime / (CallsAnswered + CallsHandled), in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionIndex' => ['description' => 'Satisfaction index, which is the average of the satisfaction rating digits (single-digit numbers).', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'SatisfactionSurveysOffered' => ['description' => 'Sending Count of satisfaction surveys.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionSurveysResponded' => ['description' => 'Count of satisfaction survey responses.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageReadyTime' => ['description' => 'Average ready time. Calculation Formula: TotalReadyTime divided by the Count of ready events. The Count of ready events is a non-API statistical field, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxReadyTime' => ['description' => 'Maximum ready time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '37', 'title' => ''], 'OneTransferCalls' => ['description' => 'Quantity of directly transferred calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxTalkTime' => ['description' => 'Maximum talk time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalReadyTime' => ['description' => 'Total ready time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalBreakTime' => ['description' => 'Total break time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalCalls' => ['description' => 'Total call volume. Calculation Formula: CallsOffered + CallsDialed.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Inbound' => [ 'description' => 'Inbound metrics.', 'type' => 'object', 'properties' => [ 'TotalTalkTime' => ['description' => 'Total talk time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsOffered' => ['description' => 'Assign Count, which is the number of calls assigned to this agent, including calls blindly transferred or consultation-transferred from other agents.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageRingTime' => ['description' => 'Average ring time, in seconds. Calculation Formula: TotalRingTime / CallsRinged.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsHandled' => ['description' => 'Acknowledgement Count, which is the number of times the agent answered calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'ServiceLevel20' => ['description' => 'Answer rate within 20 seconds, in percent (%).', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'TotalWorkTime' => ['description' => 'Total post-processing time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxWorkTime' => ['description' => 'Maximum post-processing time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageWorkTime' => ['description' => 'Average post-processing time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageTalkTime' => ['description' => 'Average talk time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionIndex' => ['description' => 'Satisfaction Index, which is the average value of the single-digit satisfaction rating entered by customers.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'SatisfactionSurveysOffered' => ['description' => 'Sending Count of satisfaction surveys.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'HandleRate' => ['description' => 'Acknowledgement rate. Calculation Formula: CallsHandled / CallsOffered (because acknowledgement events and assign events may fall into different Time Ranges, the Result may exceed 100% in certain cases).', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'SatisfactionSurveysResponded' => ['description' => 'Response Count of satisfaction surveys.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalRingTime' => ['description' => 'Total ring time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxTalkTime' => ['description' => 'Maximum talk time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxRingTime' => ['description' => 'Maximum ring time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Outbound' => [ 'description' => 'Outbound metrics.', 'type' => 'object', 'properties' => [ 'TotalTalkTime' => ['description' => 'Total talk time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxDialingTime' => ['description' => 'Maximum dial-up duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsDialed' => ['description' => 'Number of dial-up calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsAnswered' => ['description' => 'Number of answered calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AnswerRate' => ['description' => 'Answer rate. Calculation Formula: CallsAnswered / CallsDialed. (Because management events for answering and acknowledgement may fall into different Time Ranges, the Result may exceed 100% in some cases.)', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'TotalWorkTime' => ['description' => 'Total post-processing time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxWorkTime' => ['description' => 'Maximum post-processing duration, in seconds.', 'type' => 'string', 'example' => '0', 'title' => ''], 'TotalDialingTime' => ['description' => 'Total dial-up time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageTalkTime' => ['description' => 'Average talk time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageWorkTime' => ['description' => 'Average post-processing duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionIndex' => ['description' => 'Satisfaction index, which is the average value of the satisfaction rating digits (single-digit numbers).', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'SatisfactionSurveysOffered' => ['description' => 'Sending Count of satisfaction surveys.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionSurveysResponded' => ['description' => 'Response Count of satisfaction surveys.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxTalkTime' => ['description' => 'Maximum talk time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageDialingTime' => ['description' => 'Average dial-up time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'staticInfo' => [ 'substitutions' => ['CCC::2020-07-01::ListHistoricalAgentReport'], ], 'title' => 'Retrieve the list of agent summary data', 'changeSet' => [ ['createdAt' => '2022-02-28T02:23:24.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '250', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAgentSummaryReportsSinceMidnight'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"27DD30C4-CAE2-481A-97CC-D3C54625341D\\",\\n \\"Success\\": true,\\n \\"PagedAgentSummaryReport\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 2,\\n \\"List\\": [\\n {\\n \\"LoginName\\": \\"agent\\",\\n \\"AgentId\\": \\"agent@ccc-test\\",\\n \\"AgentName\\": \\"坐席小王。\\",\\n \\"SkillGroupNames\\": \\"[\\\\\\"测试技能组1\\\\\\",\\\\\\"测试技能组2\\\\\\"]\\",\\n \\"Timestamp\\": \\"2018-09-13 00:00:00\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"SkillGroupIds\\": \\"[\\\\\\"skillgroup1@ccc-test\\\\\\",\\\\\\"skillgroup2@ccc-test\\\\\\"]\\\\n\\",\\n \\"Overall\\": {\\n \\"TotalTalkTime\\": 0,\\n \\"TotalLoggedInTime\\": 0,\\n \\"OccupancyRate\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageReadyTime\\": 0,\\n \\"MaxReadyTime\\": 37,\\n \\"OneTransferCalls\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"TotalReadyTime\\": 0,\\n \\"TotalBreakTime\\": 0,\\n \\"TotalCalls\\": 0\\n },\\n \\"Inbound\\": {\\n \\"TotalTalkTime\\": 0,\\n \\"CallsOffered\\": 0,\\n \\"AverageRingTime\\": 0,\\n \\"CallsHandled\\": 0,\\n \\"ServiceLevel20\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"HandleRate\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"TotalRingTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"MaxRingTime\\": 0\\n },\\n \\"Outbound\\": {\\n \\"TotalTalkTime\\": 0,\\n \\"MaxDialingTime\\": 0,\\n \\"CallsDialed\\": 0,\\n \\"CallsAnswered\\": 0,\\n \\"AnswerRate\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"MaxWorkTime\\": \\"0\\",\\n \\"TotalDialingTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"AverageDialingTime\\": 0\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'ListAttempts' => [ 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccQFUGXR'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['title' => 'Instance ID', 'description' => 'Instance ID', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'], ], [ 'name' => 'CampaignId', 'in' => 'query', 'schema' => ['title' => 'Activity ID', 'description' => 'Predictive outbound dialing Activity ID.', 'type' => 'string', 'required' => true, 'example' => '6badb397-a8b5-40b6-21019d382a09'], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['title' => 'Start Time', 'description' => 'Start Time. This parameter is optional. If not specified, it defaults to the Start Time of the predictive outbound dialing Activity. The format is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1634115688291'], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['title' => 'End Time', 'description' => 'End Time. This parameter is optional. If not specified, it defaults to the End Time of the predictive outbound dialing Activity. The format is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1634115698291'], ], [ 'name' => 'QueueId', 'in' => 'query', 'schema' => ['title' => 'Queue ID', 'description' => 'Filter by skill group ID. This parameter is optional and defaults to empty, which means no filtering is applied.', 'type' => 'string', 'example' => 'skillgroup@ccc-test', 'required' => false], ], [ 'name' => 'CaseId', 'in' => 'query', 'schema' => ['title' => 'CaseID', 'description' => 'System-generated contact ID. Customers do not need to concern themselves with this value.', 'type' => 'string', 'required' => true, 'example' => '60ecb1a2-4480-4d01-bede-c5b7655bfadf'], ], [ 'name' => 'AttemptId', 'in' => 'query', 'schema' => ['title' => 'Record ID', 'description' => 'Call record ID, which has the same value as the call ID.', 'type' => 'string', 'example' => 'job-16976964500325****', 'required' => false], ], [ 'name' => 'ContactId', 'in' => 'query', 'schema' => ['title' => 'Call ID', 'description' => 'Filter by call ID. This parameter is optional and defaults to empty.', 'type' => 'string', 'example' => 'job-16976964500325****', 'required' => false], ], [ 'name' => 'AgentId', 'in' => 'query', 'schema' => ['title' => 'Agent ID', 'description' => 'Filter by agent ID. This parameter is optional and defaults to empty.', 'type' => 'string', 'example' => 'agent@ccc-test', 'required' => false], ], [ 'name' => 'Caller', 'in' => 'query', 'schema' => ['title' => 'Caller', 'description' => 'Filter by caller number. This parameter is optional and defaults to empty.', 'type' => 'string', 'example' => '05711234****', 'required' => false], ], [ 'name' => 'Callee', 'in' => 'query', 'schema' => ['title' => 'Called number', 'description' => 'Filter by called number. Optional. Default is empty.', 'type' => 'string', 'example' => '1888888****', 'required' => false], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['title' => 'Page Number', 'description' => 'Page number. The product of PageNumber and PageSize must not exceed 10 000.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['title' => 'Page Size', 'description' => 'Page size. The product of PageNumber and PageSize must not exceed 10 000.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '100'], ], [ 'name' => 'Criteria', 'in' => 'query', 'schema' => ['description' => 'Extended query conditions in JSON format. Currently supports caseIds for batch queries.', 'type' => 'string', 'required' => false, 'example' => '{"caseIds":["964f05a7-fc15-4a05-93a6-cd7421c4459e","5e2d508b-0df6-4077-8099-d3fff51ea6d0","da037029-8c83-4270-a90e-e7734be76af6"]}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => 'Schema of Response ', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '7CC6523B-0E51-1B62-8DA5-6A9831CAE315', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'TotalCount' => ['description' => 'Total count.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageNumber' => ['description' => 'Page number. The product of PageNumber and PageSize must not exceed 10 000.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'Page size. The product of PageNumber and PageSize must not exceed 10 000.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'List' => [ 'description' => 'List of contact dialing records.', 'type' => 'array', 'items' => [ 'description' => 'Contact dialing record.', 'type' => 'object', 'properties' => [ 'AttemptId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-1704342174816****', 'title' => ''], 'ContactId' => ['description' => 'The call ID.', 'type' => 'string', 'example' => 'job-1704342174816****', 'title' => ''], 'CaseId' => ['description' => 'A contact ID generated by the system. Customers do not need to be concerned with this value.', 'type' => 'string', 'example' => '21d194a7-60b7-4824-932b-48ed03a83704', 'title' => ''], 'CampaignId' => ['description' => 'Predictive outbound dialing Activity ID.', 'type' => 'string', 'example' => '083046e3-5822-4cda-9b84-04f2a02eb605', 'title' => ''], 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'QueueId' => ['description' => 'The skill group ID.', 'type' => 'string', 'example' => 'skillgroup@ccc-test', 'title' => ''], 'Caller' => ['description' => 'Calling number.', 'type' => 'string', 'example' => '05711234****', 'title' => ''], 'Callee' => ['description' => 'Callee number.', 'type' => 'string', 'example' => '1888888****', 'title' => ''], 'AgentId' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'DialTime' => ['description' => 'Time when the dial-up was initiated, in UNIX timestamp format, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1634196283974', 'title' => ''], 'DialDuration' => ['description' => 'The dial-up duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '2734', 'title' => ''], 'CustomerEstablishedTime' => ['description' => 'The time when the Customer answered the call, formatted as a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1634196286708', 'title' => ''], 'CustomerReleasedTime' => ['description' => 'The time when the Customer hung up, formatted as a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1634196317888', 'title' => ''], 'EnterIvrTime' => ['description' => 'The time when the call was transferred into IVR, formatted as a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1634196286740', 'title' => ''], 'IvrDuration' => ['description' => 'The duration spent in IVR, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1049', 'title' => ''], 'EnqueueTime' => ['description' => 'The time when the contact entered the queue, in Unix timestamp format, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1634196287789', 'title' => ''], 'QueueDuration' => ['description' => 'The queue duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '80', 'title' => ''], 'AssignAgentTime' => ['description' => 'The time when the agent was assigned, formatted as a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1634196287869', 'title' => ''], 'AgentRingDuration' => ['description' => 'Agent ring duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '23', 'title' => ''], 'AgentEstablishedTime' => ['description' => 'The time when the agent answered the call, in Unix timestamp format, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1632883592732', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'title' => 'Retrieve contact dialing record List', 'summary' => 'You can invoke ListAttempts to obtain the list of contact dialing records for a specified predictive outbound calling Activity under a specified instance.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAttempts'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"7CC6523B-0E51-1B62-8DA5-6A9831CAE315\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"List\\": [\\n {\\n \\"AttemptId\\": \\"job-1704342174816****\\",\\n \\"ContactId\\": \\"job-1704342174816****\\",\\n \\"CaseId\\": \\"21d194a7-60b7-4824-932b-48ed03a83704\\",\\n \\"CampaignId\\": \\"083046e3-5822-4cda-9b84-04f2a02eb605\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"QueueId\\": \\"skillgroup@ccc-test\\",\\n \\"Caller\\": \\"05711234****\\",\\n \\"Callee\\": \\"1888888****\\",\\n \\"AgentId\\": \\"agent@ccc-test\\",\\n \\"DialTime\\": 1634196283974,\\n \\"DialDuration\\": 2734,\\n \\"CustomerEstablishedTime\\": 1634196286708,\\n \\"CustomerReleasedTime\\": 1634196317888,\\n \\"EnterIvrTime\\": 1634196286740,\\n \\"IvrDuration\\": 1049,\\n \\"EnqueueTime\\": 1634196287789,\\n \\"QueueDuration\\": 80,\\n \\"AssignAgentTime\\": 1634196287869,\\n \\"AgentRingDuration\\": 23,\\n \\"AgentEstablishedTime\\": 1632883592732\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'ListAudioFiles' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccKYIENB'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The paging ordinal number, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'Page size, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => ['description' => 'Converting (transforming)
'."\n" .'Completed (transformation completed)
'."\n" .'Failed (transformation failed)
'."\n" .'If this parameter is not specified, resources in all statuses are queried.', 'type' => 'string', 'required' => false, 'example' => 'Completed', 'title' => ''], ], [ 'name' => 'Usage', 'in' => 'query', 'schema' => ['description' => 'Purpose of the audio file. The default value is General (used in scenarios such as IVR). Other optional values include HoldMusic (hold music during calls).', 'type' => 'string', 'required' => false, 'example' => 'General', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '53223330-EBF1-586B-A2CB-93C3B711FDA0', 'title' => ''], 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Data' => [ 'description' => 'The data.', 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'The page number, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The paging size, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'TotalCount' => ['description' => 'The total count.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'List' => [ 'description' => 'The list of audio files.', 'type' => 'array', 'items' => [ 'description' => 'The audio file information.', 'type' => 'object', 'properties' => [ 'AudioFileName' => ['description' => 'Audio file name.', 'type' => 'string', 'example' => 'test-file.wav', 'title' => ''], 'OssFileKey' => ['description' => 'The key of the audio resource file in OSS.', 'type' => 'string', 'example' => 'ccc-test/test-file.wav', 'title' => ''], 'UpdatedTime' => ['description' => 'Last modified time of the audio resource.', 'type' => 'string', 'example' => '2021-03-08 15:34:49.0', 'title' => ''], 'AudioResourceId' => ['description' => 'Audio resource ID, which is the UUID of the audio file.', 'type' => 'string', 'example' => 'd5cd7a94-3b6a-47d2-b7fd-0b1cd839bf77', 'title' => ''], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'Name' => ['description' => 'Display name of the audio resource.', 'type' => 'string', 'example' => '欢迎语', 'title' => ''], 'CreatedTime' => ['description' => 'The creation time of the audio resource.', 'type' => 'string', 'example' => '2021-03-05 17:35:45.0', 'title' => ''], 'Status' => ['description' => 'The status of the audio file.', 'type' => 'string', 'example' => 'Completed', 'title' => ''], 'Usage' => ['description' => 'The usage of the audio file. The default value is General (used in scenarios such as IVR). Other optional values include HoldMusic (hold music during call waiting).', 'type' => 'string', 'example' => 'General', 'title' => ''], 'AuditResult' => ['description' => 'Audio content threat review result.', 'type' => 'string', 'example' => '无', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => ''], ], ], 'title' => 'Obtain Audio File List', 'summary' => 'Invoke ListAudioFiles to obtain the list of audio files under a specified instance.', 'changeSet' => [ ['createdAt' => '2023-11-17T01:12:03.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2022-06-30T02:20:46.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAudioFiles'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"53223330-EBF1-586B-A2CB-93C3B711FDA0\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"AudioFileName\\": \\"test-file.wav\\",\\n \\"OssFileKey\\": \\"ccc-test/test-file.wav\\",\\n \\"UpdatedTime\\": \\"2021-03-08 15:34:49.0\\",\\n \\"AudioResourceId\\": \\"d5cd7a94-3b6a-47d2-b7fd-0b1cd839bf77\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Name\\": \\"欢迎语\\",\\n \\"CreatedTime\\": \\"2021-03-05 17:35:45.0\\",\\n \\"Status\\": \\"Completed\\",\\n \\"Usage\\": \\"General\\",\\n \\"AuditResult\\": \\"无\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'ListBlacklistCallTaggings' => [ 'summary' => 'Queries the blacklist tag status of specified numbers in a batch.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc1MRAID'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the Cloud Contact Center instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'NumberList', 'in' => 'query', 'schema' => ['description' => 'A list of numbers to query for their blacklist tag status. The jobId field is required if a number is encrypted (contains \\*\\*\\*).', 'type' => 'string', 'required' => true, 'example' => '[{"number":"1521083xxxx","jobId":"job-481841171213393920"}]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'ID of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '032C73C4-3A6F-4502-872B-4F5B41161C6E'], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Data' => [ 'description' => 'The data.', 'type' => 'array', 'items' => [ 'description' => 'The blacklist tag information for the number.', 'type' => 'object', 'properties' => [ 'JobId' => ['description' => 'The call ID.', 'type' => 'string', 'example' => 'job-481841171213393920', 'title' => ''], 'Number' => ['description' => 'The phone number.', 'type' => 'string', 'example' => '1521083xxxx', 'title' => ''], 'Blacklisted' => ['description' => 'Indicates whether the number has a blacklist tag.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => ''], ['errorCode' => 'LimitExceed.CallTagsPerNumber', 'errorMessage' => 'The total number of call tag of numbers exceeds the limit %s.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.CustomCallTagging', 'errorMessage' => 'Custom call tagging %s does not exist in instance %s.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.DB', 'errorMessage' => 'An internal DB service error occurred. %s', 'description' => ''], ], ], 'title' => 'Obtain the blacklist tagging status of numbers', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"032C73C4-3A6F-4502-872B-4F5B41161C6E\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": [\\n {\\n \\"JobId\\": \\"job-481841171213393920\\",\\n \\"Number\\": \\"1521083xxxx\\",\\n \\"Blacklisted\\": true\\n }\\n ]\\n}","type":"json"}]', ], 'ListBriefSkillGroups' => [ 'summary' => 'You can invoke ListBriefSkillGroups to obtain the list of skill group summary information under a specified instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'SearchPattern', 'in' => 'query', 'schema' => ['description' => 'Perform fuzzy matching based on the skill group name or display name. This parameter is optional and defaults to empty, which means no filtering is applied.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'skillgroup', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number for paging, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The page size for paging, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''], ], [ 'name' => 'MediaType', 'in' => 'query', 'schema' => ['description' => 'The media type. The default value is AUDIO. Other valid values include CHAT and VIDEO.', 'type' => 'string', 'required' => false, 'example' => 'CHAT', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '3969FC68-CEC2-4398-B76A-60D2F7EDEBAF', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'Page number, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'Page size, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'TotalCount' => ['description' => 'Total count.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'List' => [ 'description' => 'List of skill group summary information.', 'type' => 'array', 'items' => [ 'description' => 'Skill group', 'type' => 'object', 'properties' => [ 'DisplayName' => ['description' => 'The display name of the skill group.', 'type' => 'string', 'example' => '测试技能组', 'title' => ''], 'Description' => ['description' => 'Description of the skill group.', 'type' => 'string', 'example' => '云联络中心的测试技能组。', 'title' => ''], 'PhoneNumberCount' => ['description' => 'Quantity of phone numbers associated with the skill group.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'SkillGroupId' => ['description' => 'The skill group ID.', 'type' => 'string', 'example' => 'skillgroup@ccc-test', 'title' => ''], 'SkillGroupName' => ['description' => 'Name of the skill group.', 'type' => 'string', 'example' => 'skillgroup', 'title' => ''], 'UserCount' => ['description' => 'The number of agents associated with the skill group.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'MediaType' => ['description' => 'The media type. The default value is AUDIO. Other valid values include CHAT and VIDEO.', 'type' => 'string', 'example' => 'VIDEO', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Retrieve a summary list of skill groups', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-11-17T01:12:03.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListBriefSkillGroups'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"3969FC68-CEC2-4398-B76A-60D2F7EDEBAF\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"DisplayName\\": \\"测试技能组\\",\\n \\"Description\\": \\"云联络中心的测试技能组。\\",\\n \\"PhoneNumberCount\\": 1,\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"SkillGroupName\\": \\"skillgroup\\",\\n \\"UserCount\\": 10,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"MediaType\\": \\"VIDEO\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'ListCallDetailRecords' => [ 'summary' => 'You can invoke ListCallDetailRecords to obtain a list of call details filtered by specified search conditions under a specified instance. This API is no longer iteratively updated. We recommend that you use the ListCallDetailRecordsV2 API instead.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc5HY0NN'], ], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'Page number for paging, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'Page size, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '100', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'Start time of the historical data to retrieve. The default value is 00:00:00 of the current day, in UNIX timestamp format with millisecond precision.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1532448000000', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'End time of the historical data to retrieve. The default value is the current time, in UNIX timestamp format with millisecond precision.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1532707199000', 'title' => ''], ], [ 'name' => 'ContactType', 'in' => 'query', 'schema' => [ 'description' => 'Filter by call type.', 'enumValueTitles' => ['Outbound' => 'Outbound', 'Back2Back' => 'Back-to-back', 'PrivacyDial' => 'Encrypted call', 'Internal' => 'Internal call', 'Predictive' => 'Predictive outbound', 'Inbound' => 'Inbound', 'Conference' => 'Conference'], 'type' => 'string', 'required' => false, 'example' => 'Outbound', 'title' => '', ], ], [ 'name' => 'ContactDisposition', 'in' => 'query', 'schema' => [ 'description' => 'Filter by disposition type. Note: Disposition reasons such as voicemail, transfer to agent failed, queuing timeout, queuing overflow, and IVR abnormal are only displayed if the customer has configured a disposition reason node. If no such node is configured and there is no transfer-to-agent module in the IVR, the disposition reason defaults to "Abandoned in IVR".', 'enumValueTitles' => [ 'AbandonedInQueue' => 'Abandoned in queue', 'NoAnswer' => 'Customer did not answer', 'QueuingTimeout' => 'Queuing timeout', 'Voicemail' => 'Forwarded to voicemail', 'QueuingFailed' => 'Transfer to agent failed', 'QueuingOverflow' => 'Queuing overflow', 'AbandonedInVoiceNavigator' => 'Abandoned during Intelligent Voice Navigator', 'Success' => 'Normal end', 'IVRException' => 'IVR abnormal', 'AbandonedInRing' => 'Abandoned during ringing', 'AbandonedInIVR' => 'Abandoned in IVR', 'Reject' => 'Customer rejected', 'ForwardToOutsideNumber' => 'Forwarded to external number', ], 'type' => 'string', 'required' => false, 'example' => 'Success', 'title' => '', ], ], [ 'name' => 'ContactId', 'in' => 'query', 'schema' => ['description' => 'Query the record of a specific call by specifying a contactId. The contactId can be obtained from the softphone software development kit (SDK) during a call. If this parameter is provided, all other query parameters are automatically ignored.', 'type' => 'string', 'required' => false, 'example' => 'job-12515239414412****', 'title' => ''], ], [ 'name' => 'AgentId', 'in' => 'query', 'schema' => ['description' => 'Filter by agent ID.', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test', 'title' => ''], ], [ 'name' => 'SkillGroupId', 'in' => 'query', 'schema' => ['description' => 'Filter by skill group ID.', 'type' => 'string', 'required' => false, 'example' => 'skillgroup@ccc-test', 'title' => ''], ], [ 'name' => 'SortOrder', 'in' => 'query', 'schema' => [ 'description' => 'Sorting order. This parameter is optional and defaults to descending.', 'enumValueTitles' => ['ASC' => 'Ascending', 'DESC' => 'Descending'], 'type' => 'string', 'required' => false, 'example' => 'DESC', 'title' => '', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'OrderByField', 'in' => 'query', 'schema' => [ 'description' => 'Sorting field. Optional. Default value is startTime (call start time).', 'enumValueTitles' => ['callDuration' => 'Call Duration', 'ringTime' => 'Ring Time', 'talkTime' => 'Talk Time', 'dialingTime' => 'Dialing Time', 'startTime' => 'Start Time', 'ivrTime' => 'IVR Duration', 'queueTime' => 'Queue Duration'], 'type' => 'string', 'required' => false, 'example' => 'startTime', 'title' => '', ], ], [ 'name' => 'Criteria', 'in' => 'query', 'schema' => ['description' => 'Perform a fuzzy query based on the calling or called number. The value must be a JSON string containing only one field, phoneNumber, which can be the full number or a partial segment of either the calling or called number.', 'type' => 'string', 'required' => false, 'example' => '{"phoneNumber":"0735"}', 'title' => ''], ], [ 'name' => 'CallingNumber', 'in' => 'query', 'schema' => ['description' => 'Filter by calling number.', 'type' => 'string', 'required' => false, 'example' => '07353988****', 'title' => ''], ], [ 'name' => 'CalledNumber', 'in' => 'query', 'schema' => ['description' => 'Filter by called number.', 'type' => 'string', 'required' => false, 'example' => '1320523****', 'title' => ''], ], [ 'name' => 'SatisfactionList', 'in' => 'query', 'schema' => ['description' => 'Filter by satisfaction List. Separate multiple satisfaction Results with commas.', 'type' => 'string', 'required' => false, 'example' => '["1","3"]', 'title' => ''], ], [ 'name' => 'SatisfactionSurveyChannel', 'in' => 'query', 'schema' => [ 'description' => 'Filter by satisfaction survey channel.', 'enumValueTitles' => ['IVR' => 'Voice Satisfaction Survey', 'SMS' => 'Text Message Satisfaction Survey'], 'type' => 'string', 'required' => false, 'example' => 'IVR', 'title' => '', ], ], [ 'name' => 'SatisfactionDescriptionList', 'in' => 'query', 'schema' => ['description' => 'Filter by satisfaction description list. The description content is Custom by the Customer.', 'type' => 'string', 'required' => false, 'example' => '["满意","一般"]', 'title' => ''], ], [ 'name' => 'EarlyMediaStateList', 'in' => 'query', 'schema' => [ 'description' => 'Filter by a list of reasons for failed connection.', 'enumValueTitles' => ['NoAnswer' => 'No Answer', 'OutOfService' => 'Out of Service', 'NotExist' => 'Nonexistent Number', 'Restricted' => 'Call Restricted', 'Busy' => 'Busy', 'NotConnected' => 'Unable to Connect', 'PowerOff' => 'Power Off'], 'type' => 'string', 'required' => false, 'example' => '["NotConnected","NoAnswer"]', 'title' => '', ], ], [ 'name' => 'ContactDispositionList', 'in' => 'query', 'schema' => [ 'description' => 'Filter by hang-up reason list.', 'enumValueTitles' => [ 'AbandonedInQueue' => 'Abandoned in Queue', 'NoAnswer' => 'Customer Did Not Answer', 'QueuingTimeout' => 'Queue Timeout', 'Voicemail' => 'Transferred to Voicemail', 'QueuingFailed' => 'Transfer to Agent Failed', 'QueuingOverflow' => 'Queue Overflow', 'AbandonedInVoiceNavigator' => 'Abandoned in Intelligent Navigator', 'Success' => 'Normal End', 'IVRException' => 'IVR Abnormal', 'AbandonedInRing' => 'Abandoned During Ringing', 'AbandonedInIVR' => 'Abandoned in IVR', 'Reject' => 'Customer Rejected Call', 'ForwardToOutsideNumber' => 'Transferred to External Number', ], 'type' => 'string', 'required' => false, 'example' => '["Success","NoAnswer"]', 'title' => '', ], ], [ 'name' => 'ContactTypeList', 'in' => 'query', 'schema' => [ 'description' => 'Filter by contact type list.', 'enumValueTitles' => ['Outbound' => 'Outbound', 'Back2Back' => 'Back-to-back', 'PrivacyDial' => 'Encrypted call', 'Internal' => 'Internal call', 'Predictive' => 'Predictive outbound', 'Inbound' => 'Inbound', 'Conference' => 'Conference'], 'type' => 'string', 'required' => false, 'example' => '["Internal","Inbound"]', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'Page number, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'Page size, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'TotalCount' => ['description' => 'Total count. A real numeric value is returned only when PageNumber is 1; otherwise, 0 is returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '11', 'title' => ''], 'List' => [ 'description' => 'List of call records.', 'type' => 'array', 'items' => [ 'description' => 'Call record.', 'type' => 'object', 'properties' => [ 'ContactDisposition' => [ 'description' => 'Reason for call termination.', 'enumValueTitles' => [ 'AbandonedInQueue' => 'Abandoned in Queue', 'NoAnswer' => 'Customer Did Not Answer', 'QueuingTimeout' => 'Queuing Timeout', 'Voicemail' => 'Transferred to Voicemail', 'QueuingFailed' => 'Transfer to Agent Failed', 'QueuingOverflow' => 'Queuing Overflow', 'AbandonedInVoiceNavigator' => 'Abandoned During Intelligent IVR Navigation', 'Success' => 'Normal End', 'IVRException' => 'IVR Abnormal', 'AbandonedInRing' => 'Abandoned during ringing', 'AbandonedInIVR' => 'Abandoned in IVR', 'Reject' => 'Rejected by customer', 'ForwardToOutsideNumber' => 'Forwarded to external number', ], 'type' => 'string', 'example' => 'Success', 'title' => '', ], 'ContactType' => [ 'description' => 'Call type.', 'enumValueTitles' => ['Outbound' => 'Outbound', 'Back2Back' => 'Double Call', 'PrivacyDial' => 'Encrypted Call', 'Internal' => 'Internal Call', 'Predictive' => 'Predictive Outbound Call', 'Inbound' => 'Inbound Call', 'Conference' => 'Conference Call'], 'type' => 'string', 'example' => 'Outbound', 'title' => '', ], 'EstablishedTime' => ['description' => 'The time when the call was established. If the call was not established, this value is empty. The format is a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1532448000000', 'title' => ''], 'CalledNumber' => ['description' => 'Called number.', 'type' => 'string', 'example' => '1332315****', 'title' => ''], 'AdditionalBroker' => ['description' => 'An additional broker number, which may be used in double-call scenarios.', 'type' => 'string', 'example' => '0533128****', 'title' => ''], 'SatisfactionIndex' => ['description' => 'Satisfaction rating, represented as a single-digit numeric value entered by the customer.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'SatisfactionSurveyChannel' => [ 'description' => 'The channel used for the satisfaction survey.', 'enumValueTitles' => ['IVR' => 'Voice satisfaction survey', 'SMS' => 'Text message satisfaction survey'], 'type' => 'string', 'example' => 'IVR', 'title' => '', ], 'ReleaseTime' => ['description' => 'The call end time, formatted as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1532707199000', 'title' => ''], 'WaitTime' => ['description' => 'The customer\'s waiting duration, which equals QueueTime plus RingTime. If the customer abandons the call during waiting, the value is 0. The unit is seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], 'SkillGroupNames' => ['description' => 'The names of the skill groups to which the agents participating in the call belong. Multiple skill group names are separated by commas.', 'type' => 'string', 'example' => '测试技能组', 'title' => ''], 'IvrTime' => ['description' => 'IVR duration, in seconds. This is the time interval from when the IVR starts until the call enters the agent queue (or the customer hangs up).', 'type' => 'integer', 'format' => 'int64', 'example' => '8', 'title' => ''], 'SatisfactionDescription' => ['description' => 'The satisfaction description, corresponding to the configuration of the satisfaction module in the satisfaction IVR. This is defined by the customer.', 'type' => 'string', 'example' => '满意', 'title' => ''], 'ReleaseInitiator' => [ 'description' => 'The party that ended the call.', 'enumValueTitles' => ['agent' => 'Agent', 'customer' => 'Customer'], 'type' => 'string', 'example' => 'customer', 'title' => '', ], 'AgentIds' => ['description' => 'A list of agent IDs, with multiple values separated by commas.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'CallDuration' => ['description' => 'Call duration. For inbound calls, timing starts when the call enters IVR. For outbound calls, timing starts when the call is connected. The unit is seconds.', 'type' => 'string', 'example' => '30', 'title' => ''], 'RecordingReady' => ['description' => 'Indicates whether the recording has been generated. Returns false if the call was not established.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'RingTime' => ['description' => 'Ring duration, which is the time from when the agent\'s phone starts ringing until the agent answers (or the customer hangs up), in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], 'SatisfactionSurveyOffered' => ['description' => 'Indicates whether a satisfaction survey was initiated.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'AgentNames' => ['description' => 'List of agent names involved in the call, separated by commas.', 'type' => 'string', 'example' => '坐席小王', 'title' => ''], 'StartTime' => ['description' => 'Call start time. For inbound calls, timing starts when the call enters IVR. For outbound calls, timing starts from dial-up. The format is a Unix string in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1532448000000', 'title' => ''], 'ContactId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-12515239414412****', 'title' => ''], 'RecordingDuration' => ['description' => 'Recording duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], 'CallingNumber' => ['description' => 'Calling number.', 'type' => 'string', 'example' => '0533128****', 'title' => ''], 'QueueTime' => ['description' => 'The queue duration, in seconds, measured from when the customer entered the agent queue until the agent started ringing (or the customer abandoned the call, the queue timed out, or the queue overflowed).', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'Broker' => ['description' => 'The intermediary number.', 'type' => 'string', 'example' => '0533127****', 'title' => ''], 'SkillGroupIds' => ['description' => 'The IDs of the skill groups to which the agents participating in the call belong. Multiple skill group IDs are separated by commas.', 'type' => 'string', 'example' => 'skillgroup@ccc-test', 'title' => ''], 'CallerLocation' => ['description' => 'Caller location.', 'type' => 'string', 'example' => '北京市-北京', 'title' => ''], 'CalleeLocation' => ['description' => 'The callee\'s location.', 'type' => 'string', 'example' => '山东省-济南', 'title' => ''], 'EarlyMediaState' => [ 'description' => 'Reason for failure to connect.', 'enumValueTitles' => ['NoAnswer' => 'No answer', 'OutOfService' => 'Out of service', 'NotExist' => 'Nonexistent number', 'Restricted' => 'Call restricted', 'Busy' => 'Busy', 'NotConnected' => 'Unable to connect', 'PowerOff' => 'Powered off'], 'type' => 'string', 'example' => 'NotConnected', 'title' => '', ], 'ReleaseReason' => ['description' => 'Hang-up reason for the channel, indicating why the current channel was disconnected. The value is derived from response codes defined in the SIP protocol. Customers should refer to the SIP protocol to analyze the hang-up reason.', 'type' => 'string', 'example' => '486:USER_BUSY', 'title' => ''], 'DialingTime' => ['description' => 'Dial-up duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TalkTime' => ['description' => 'Talk time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'HeldTime' => ['description' => 'The hold duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], 'CallIds' => ['description' => 'The Call-Id field in the underlying SIP protocol. If you need to obtain the call ID from the number provider side, you can retrieve it from this field.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75'."\n", 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid. %s', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => ''], ], ], 'title' => 'Obtain call detail list ', 'description' => 'To ensure query efficiency, the TotalCount field in the response data is populated only when the first page is queried. For other pages, this field returns 0.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2024-07-29T10:25:36.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-10-09T15:22:40.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-03-20T06:35:11.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-12-07T10:56:27.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-10-14T06:47:33.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2021-09-08T02:42:38.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCallDetailRecords'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 11,\\n \\"List\\": [\\n {\\n \\"ContactDisposition\\": \\"Success\\",\\n \\"ContactType\\": \\"Outbound\\",\\n \\"EstablishedTime\\": 1532448000000,\\n \\"CalledNumber\\": \\"1332315****\\",\\n \\"AdditionalBroker\\": \\"0533128****\\",\\n \\"SatisfactionIndex\\": 1,\\n \\"SatisfactionSurveyChannel\\": \\"IVR\\",\\n \\"ReleaseTime\\": 1532707199000,\\n \\"WaitTime\\": 5,\\n \\"SkillGroupNames\\": \\"测试技能组\\",\\n \\"IvrTime\\": 8,\\n \\"SatisfactionDescription\\": \\"满意\\",\\n \\"ReleaseInitiator\\": \\"customer\\",\\n \\"AgentIds\\": \\"agent@ccc-test\\",\\n \\"CallDuration\\": \\"30\\",\\n \\"RecordingReady\\": true,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"RingTime\\": 5,\\n \\"SatisfactionSurveyOffered\\": true,\\n \\"AgentNames\\": \\"坐席小王\\",\\n \\"StartTime\\": 1532448000000,\\n \\"ContactId\\": \\"job-12515239414412****\\",\\n \\"RecordingDuration\\": 10,\\n \\"CallingNumber\\": \\"0533128****\\",\\n \\"QueueTime\\": 0,\\n \\"Broker\\": \\"0533127****\\",\\n \\"SkillGroupIds\\": \\"skillgroup@ccc-test\\",\\n \\"CallerLocation\\": \\"北京市-北京\\",\\n \\"CalleeLocation\\": \\"山东省-济南\\",\\n \\"EarlyMediaState\\": \\"NotConnected\\",\\n \\"ReleaseReason\\": \\"486:USER_BUSY\\",\\n \\"DialingTime\\": 0,\\n \\"TalkTime\\": 0,\\n \\"HeldTime\\": 12,\\n \\"CallIds\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\\\n\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'ListCallDetailRecordsV2' => [ 'summary' => 'Retrieves call details from a specified instance that match the search criteria.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc5HY0NN'], ], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '100', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The start of the time range to query, specified as a Unix timestamp in milliseconds. Defaults to 00:00:00 on the current day.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1657853640015', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query, specified as a Unix timestamp in milliseconds. Defaults to the current time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1657879880010', 'title' => ''], ], [ 'name' => 'SortOrder', 'in' => 'query', 'schema' => ['description' => 'The sort order of the results. The default value is `DESC`.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'`ASC`: Ascending order.'."\n" ."\n" .'`DESC`: Descending order.', 'type' => 'string', 'required' => false, 'example' => 'DESC', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the call center instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'OrderByField', 'in' => 'query', 'schema' => ['description' => 'The field for sorting the results. The default is `startTime`.'."\n" ."\n" .'Valid value:'."\n" ."\n" .'`startTime`: the start time of the call.', 'type' => 'string', 'required' => false, 'example' => 'startTime', 'title' => ''], ], [ 'name' => 'SearchPattern', 'in' => 'query', 'schema' => ['description' => 'A custom query string that follows the Lucene query syntax.'."\n" ."\n" .'The following fields and query types are supported:'."\n" ."\n" .'`accessChannelUserId`: The visitor ID. Exact and fuzzy searches are supported.'."\n" ."\n" .'`accessChannelName`: The channel name. Exact and fuzzy searches are supported.'."\n" ."\n" .'`text`: The conversation text. Fuzzy search is supported.', 'type' => 'string', 'required' => false, 'example' => 'text:请稍后 AND accessChannelUserId:af1a0-afaa-5086e2946e0b* AND accessChannelName:专属开发渠道*', 'title' => ''], ], [ 'name' => 'MediaType', 'in' => 'query', 'schema' => ['description' => 'The media type.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'`AUDIO`: audio.'."\n" ."\n" .'`VIDEO`: video.'."\n" ."\n" .'`CHAT`: chat message.'."\n" ."\n" .'`ALL`: all media types.', 'type' => 'string', 'required' => false, 'example' => 'AUDIO', 'title' => ''], ], [ 'name' => 'ContactIdList', 'in' => 'query', 'schema' => ['description' => 'A list of call IDs.', 'type' => 'string', 'required' => false, 'example' => '["job-123456789","job-234567891"]', 'title' => ''], ], [ 'name' => 'ContactTypeList', 'in' => 'query', 'schema' => ['description' => 'A list of call types to include in the results.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'`OUTBOUND`: outbound call.'."\n" ."\n" .'`BACK2BACK`: back-to-back call.'."\n" ."\n" .'`PRIVACY_DIAL`: privacy dial.'."\n" ."\n" .'`INTERNAL`: internal call.'."\n" ."\n" .'`PREDICTIVE`: predictive dialing.'."\n" ."\n" .'`INBOUND`: inbound call.'."\n" ."\n" .'`CONFERENCE`: conference call.', 'type' => 'string', 'required' => false, 'example' => '["INBOUND","OUTBOUND"]', 'title' => ''], ], [ 'name' => 'ContactDispositionList', 'in' => 'query', 'schema' => ['description' => 'A list of call dispositions to include in the results.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'`AbandonedInQueue`: The call was abandoned in the queue.'."\n" ."\n" .'`NoAnswer`: The call was not answered by the customer.'."\n" ."\n" .'`QueuingTimeout`: The call timed out in the queue.'."\n" ."\n" .'`Voicemail`: The call was transferred to voicemail.'."\n" ."\n" .'`QueuingFailed`: The call failed to be transferred to an agent.'."\n" ."\n" .'`QueuingOverflow`: The queue overflowed.'."\n" ."\n" .'`AbandonedInVoiceNavigator`: The call was abandoned in the voice navigator.'."\n" ."\n" .'`Success`: The call ended normally.'."\n" ."\n" .'`IVRException`: An IVR exception occurred.'."\n" ."\n" .'`AbandonedInRing`: The call was abandoned during ringing.'."\n" ."\n" .'`AbandonedInIVR`: The call was abandoned in the IVR.'."\n" ."\n" .'`Reject`: The call was rejected by the customer.'."\n" ."\n" .'`ForwardToOutsideNumber`: The call was forwarded to an external number.', 'type' => 'string', 'required' => false, 'example' => '["Success","NoAnswer"]', 'title' => ''], ], [ 'name' => 'EarlyMediaStateList', 'in' => 'query', 'schema' => ['description' => 'Filters the results by a list of reasons for call connection failure.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'`NoAnswer`: No answer.'."\n" ."\n" .'`OutOfService`: The number is out of service.'."\n" ."\n" .'`NotExist`: The number does not exist.'."\n" ."\n" .'`Restricted`: The call is restricted.'."\n" ."\n" .'`Busy`: The line is busy.'."\n" ."\n" .'`NotConnected`: Could not connect.'."\n" ."\n" .'`PowerOff`: The phone is powered off.', 'type' => 'string', 'required' => false, 'example' => '["NotConnected","NoAnswer"]', 'title' => ''], ], [ 'name' => 'SatisfactionSurveyChannel', 'in' => 'query', 'schema' => ['description' => 'The channel for the satisfaction survey.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'`IVR`: IVR-based survey.'."\n" ."\n" .'`SMS`: SMS-based survey.'."\n" ."\n" .'`CHAT`: chat-based survey.', 'type' => 'string', 'required' => false, 'example' => 'IVR', 'title' => ''], ], [ 'name' => 'SatisfactionRateList', 'in' => 'query', 'schema' => ['description' => 'Filters the results by satisfaction ratings. The value is a JSON array of strings. The array can contain rating values or comparison expressions.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'`-2`: The survey was not sent.'."\n" ."\n" .'`-1`: The customer did not provide a rating.'."\n" ."\n" .'Other positive integers: Custom rating values.', 'type' => 'string', 'required' => false, 'example' => '["-1","3"]'."\n" .'[">2"]'."\n" .'["<3"]', 'title' => ''], ], [ 'name' => 'SatisfactionDescriptionList', 'in' => 'query', 'schema' => ['description' => 'Filters the results by a list of user-defined satisfaction descriptions.', 'type' => 'string', 'required' => false, 'example' => '["满意","一般"]', 'title' => ''], ], [ 'name' => 'SkillGroupIdList', 'in' => 'query', 'schema' => ['description' => 'Filters the results by a list of skill group IDs.', 'type' => 'string', 'required' => false, 'example' => '['."\n" .' "skg1@ccc-test",'."\n" .' "skg2@ccc-test"'."\n" .']', 'title' => ''], ], [ 'name' => 'AgentId', 'in' => 'query', 'schema' => ['description' => 'The agent ID.', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test', 'title' => ''], ], [ 'name' => 'FirstAgentId', 'in' => 'query', 'schema' => ['description' => 'The ID of the first agent who joined the call.', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test', 'title' => ''], ], [ 'name' => 'CallingNumber', 'in' => 'query', 'schema' => ['description' => 'The calling number.', 'type' => 'string', 'required' => false, 'example' => '191***9993', 'title' => ''], ], [ 'name' => 'CalledNumber', 'in' => 'query', 'schema' => ['description' => 'The called number.', 'type' => 'string', 'required' => false, 'example' => '191***9993', 'title' => ''], ], [ 'name' => 'Number', 'in' => 'query', 'schema' => ['description' => 'The phone number.', 'type' => 'string', 'required' => false, 'example' => '191***9993', 'title' => ''], ], [ 'name' => 'Broker', 'in' => 'query', 'schema' => ['description' => 'The broker number. It must be an outbound number available in the instance. For a back-to-back call, the system uses this number to call the calling number and the called number in sequence.', 'type' => 'string', 'required' => false, 'example' => '021****4972', 'title' => ''], ], [ 'name' => 'AccessChannelTypeList', 'in' => 'query', 'schema' => ['description' => 'A list of visitor channel types to include in the results.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'`Web`: Web.'."\n" ."\n" .'`DingTalkServiceWindow`: DingTalk service window.'."\n" ."\n" .'`AliMe`: chatbot.'."\n" ."\n" .'`DingTalkRobot`: DingTalk robot.', 'type' => 'string', 'required' => false, 'example' => '["Web","AliMe"]', 'title' => ''], ], [ 'name' => 'ReleaseInitiatorList', 'in' => 'query', 'schema' => ['description' => 'Filters the results by the party that initiated the call release.', 'type' => 'string', 'required' => false, 'example' => '[\\"AGENT\\"]', 'title' => ''], ], [ 'name' => 'ReleaseReasonList', 'in' => 'query', 'schema' => ['description' => 'Filters the results by the release reason.', 'type' => 'string', 'required' => false, 'example' => '[\\"VisitorInitiatedClosure\\",\\"AgentInitiatedClosure\\"]', 'title' => ''], ], [ 'name' => 'AnalyticsReportReady', 'in' => 'query', 'schema' => ['description' => 'Specifies whether the post-call AI analytics report is ready.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '01B12EE4-6AF2-4730-8B78-EC15F4E5C025', 'title' => ''], 'Data' => [ 'description' => 'The response data.', 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'TotalCount' => ['description' => 'The total number of matching call detail records.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'List' => [ 'description' => 'A list of call detail records.', 'type' => 'array', 'items' => [ 'description' => 'The call detail record.', 'type' => 'object', 'properties' => [ 'ContactDisposition' => ['description' => 'The reason the call ended. For a list of valid values, see the `ContactDispositionList` query parameter.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'ContactType' => ['description' => 'The type of the call. For a list of valid values, see the `ContactTypeList` query parameter.', 'type' => 'string', 'example' => 'OUTBOUND', 'title' => ''], 'EstablishedTime' => ['description' => 'The time the call was established, represented as a Unix timestamp in milliseconds. This field is empty if the call was not established.', 'type' => 'integer', 'format' => 'int64', 'example' => '1532448000000', 'title' => ''], 'CalledNumber' => ['description' => 'The called number.', 'type' => 'string', 'example' => '1332315****', 'title' => ''], 'AdditionalBroker' => ['description' => 'An additional broker number. This field may be used in click-to-dial scenarios.', 'type' => 'string', 'example' => '0533128****', 'title' => ''], 'SatisfactionIndex' => ['description' => 'The satisfaction rating, provided as a single-digit key press during a survey.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'SatisfactionSurveyChannel' => ['description' => 'The channel used for the satisfaction survey.', 'type' => 'string', 'example' => 'IVR', 'title' => ''], 'ReleaseTime' => ['description' => 'The time the call ended, represented as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1532707199000', 'title' => ''], 'WaitTime' => ['description' => 'The customer\'s total wait time, in seconds. This value is the sum of `QueueTime` and `RingTime`. It is `0` if the customer abandons the call while waiting.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], 'SkillGroupNames' => ['description' => 'A comma-separated list of skill group names for agents who participated in the call.', 'type' => 'string', 'example' => '测试技能组1,测试技能组2', 'title' => ''], 'IvrTime' => ['description' => 'The time, in seconds, the call spent in the Interactive Voice Response (IVR) system. This is the time from when the call enters the IVR until it is transferred to an agent queue or abandoned by the customer.', 'type' => 'integer', 'format' => 'int64', 'example' => '8', 'title' => ''], 'SatisfactionDescription' => ['description' => 'The description for the satisfaction rating. This is a customer-defined value configured in the IVR satisfaction module.', 'type' => 'string', 'example' => '满意', 'title' => ''], 'ReleaseInitiator' => ['description' => 'The party that ended the call.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'`agent`: The agent.'."\n" ."\n" .'`customer`: The customer.', 'type' => 'string', 'example' => 'customer', 'title' => ''], 'AgentIds' => ['description' => 'A comma-separated list of IDs for the agents who participated in the call.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'CallDuration' => ['description' => 'The call duration in seconds. For an inbound call, timing starts when the call enters the IVR. For an outbound call, timing starts when the call is connected.', 'type' => 'string', 'example' => '16', 'title' => ''], 'RecordingReady' => ['description' => 'Indicates if the call recording is available. This is `false` if the call was not established.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'InstanceId' => ['description' => 'The ID of the call center instance.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'RingTime' => ['description' => 'The duration, in seconds, an agent\'s phone rings before it is answered or the customer abandons the call.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], 'SatisfactionSurveyOffered' => ['description' => 'Indicates if a satisfaction survey was offered.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'AgentNames' => ['description' => 'A comma-separated list of names for the agents involved in the call.', 'type' => 'string', 'example' => '云呼测试坐席', 'title' => ''], 'StartTime' => ['description' => 'The start time of the call, represented as a Unix timestamp in milliseconds. For an inbound call, this is when the call enters the IVR. For an outbound call, this is when dialing begins.', 'type' => 'integer', 'format' => 'int64', 'example' => '1631440860000', 'title' => ''], 'ContactId' => ['description' => 'The unique ID of the call.', 'type' => 'string', 'example' => 'job-2255019651513856', 'title' => ''], 'RecordingDuration' => ['description' => 'The recording duration in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], 'CallingNumber' => ['description' => 'The calling number.', 'type' => 'string', 'example' => '0533128****', 'title' => ''], 'QueueTime' => ['description' => 'The time, in seconds, from when a call enters an agent queue until it rings an agent, is abandoned, times out, or overflows.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'Broker' => ['description' => 'The broker number.', 'type' => 'string', 'example' => '053xxxx3127', 'title' => ''], 'SkillGroupIds' => ['description' => 'A comma-separated list of skill group IDs for agents who participated in the call.', 'type' => 'string', 'example' => 'skg-default@ccc-test', 'title' => ''], 'CallerLocation' => ['description' => 'The geographic location of the calling number.', 'type' => 'string', 'example' => '北京市-北京', 'title' => ''], 'CalleeLocation' => ['description' => 'The geographic location of the called number.', 'type' => 'string', 'example' => '山东省-济南', 'title' => ''], 'EarlyMediaState' => ['description' => 'The state of the early media.', 'type' => 'string', 'example' => 'NotConnected', 'title' => ''], 'ReleaseReason' => ['description' => 'The reason for call termination, derived from SIP protocol response codes. For details, see the SIP protocol specifications.', 'type' => 'string', 'example' => '486:USER_BUSY', 'title' => ''], 'DialingTime' => ['description' => 'The dialing duration in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TalkTime' => ['description' => 'The talk time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'HeldTime' => ['description' => 'The on-hold duration in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], 'EarlyMediaText' => ['description' => 'The text content of the early media.', 'type' => 'string', 'example' => '正在通话中', 'title' => ''], 'OffSiteAgentIds' => ['description' => 'A comma-separated list of IDs for off-site agents who participated in the call.', 'type' => 'string', 'example' => 'skg-default@ccc-test', 'title' => ''], 'OffsiteAgentDestinationNumbers' => ['description' => 'The destination number for a call routed to an off-site agent.', 'type' => 'string', 'example' => '80312348', 'title' => ''], 'MessagesSent' => ['description' => 'The total number of messages in the chat. This field is populated only when `MediaType` is `CHAT`.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], 'MessagesSentByCustomer' => ['description' => 'The number of messages sent by the customer. This field is populated only when `MediaType` is `CHAT`.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], 'MessagesSentByAgent' => ['description' => 'The number of messages sent by the agent. This field is populated only when `MediaType` is `CHAT`.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], 'FirstResponseTime' => ['description' => 'The time, in seconds, until an agent sent the first response. This field is populated only when `MediaType` is `CHAT`.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], 'MediaType' => ['description' => 'The media type.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'`AUDIO`: audio'."\n" ."\n" .'`CHAT`: chat message'."\n" ."\n" .'`VIDEO`: video', 'type' => 'string', 'example' => 'CHAT', 'title' => ''], 'TransferCount' => ['description' => 'The number of times the call was transferred.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'AccessChannelType' => ['description' => 'The channel type. This field is populated only when `MediaType` is `CHAT`.', 'type' => 'string', 'example' => 'Web', 'title' => ''], 'AccessChannelName' => ['description' => 'The name of the channel. This field is populated only when `MediaType` is `CHAT`.', 'type' => 'string', 'example' => '测试渠道', 'title' => ''], 'AccessChannelUserId' => ['description' => 'The visitor\'s user ID in the channel. This field is populated only when `MediaType` is `CHAT`.', 'type' => 'string', 'example' => 'test-user-id', 'title' => ''], 'AccessChannelUserName' => ['description' => 'The visitor\'s name in the channel. This field is populated only when `MediaType` is `CHAT`.', 'type' => 'string', 'example' => '测试访客', 'title' => ''], 'ClientIpAddress' => ['description' => 'The IP address of the visitor\'s client. This field is populated only when `MediaType` is `CHAT`.', 'type' => 'string', 'example' => '10.100.2.1', 'title' => ''], 'ClientLocation' => ['description' => 'The geographic location of the visitor\'s client. This field is populated only when `MediaType` is `CHAT`.', 'type' => 'string', 'example' => '---', 'title' => ''], 'ClientUserAgent' => ['description' => 'The User-Agent string of the visitor\'s client. This field is populated only when `MediaType` is `CHAT`.', 'type' => 'string', 'example' => 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36', 'title' => ''], 'ClientAppName' => ['description' => 'The name of the visitor\'s client application. This field is populated only when `MediaType` is `CHAT`.', 'type' => 'string', 'example' => '未知', 'title' => ''], 'OffsiteAgentOriginatorNumbers' => ['description' => 'The calling number used for transfers to an off-site agent.', 'type' => 'string', 'example' => '0101257****', 'title' => ''], 'CallIds' => ['description' => 'A comma-separated list of SIP Call-IDs.', 'type' => 'string', 'example' => 'dxxx1sdf,xkkwwwa', 'title' => ''], 'AnalyticsReportReady' => ['description' => 'Indicates if the AI-powered post-call analysis report is complete.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'AnalyticsReport' => [ 'description' => 'The post-call analysis report.', 'type' => 'object', 'properties' => [ 'ProblemSolving' => [ 'description' => 'Contains analysis of whether the customer\'s problem was resolved.', 'type' => 'object', 'properties' => [ 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '8bf18b7a10064b29a75946a8d5b8469a', 'title' => ''], 'Success' => ['description' => 'Indicates if the analysis task was successful.'."\n" ."\n" .'- **true**: The operation was successful.'."\n" ."\n" .'- **false**: The operation failed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Solved' => ['description' => 'Indicates if the customer\'s problem was solved.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Problem' => ['description' => 'A summary of the customer\'s problem, as determined by the analysis.', 'type' => 'string', 'example' => '告警问题', 'title' => ''], 'Solution' => ['description' => 'The solution for the customer\'s problem, as determined by the analysis.', 'type' => 'string', 'example' => '富化服务自动关闭原始告警', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Emotion' => [ 'description' => 'The emotion analysis.', 'type' => 'object', 'properties' => [ 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '0ff07fe35670423089dbdf12766d962f', 'title' => ''], 'Success' => ['description' => 'Indicates if the analysis task was successful.'."\n" ."\n" .'- **true**: The operation was successful.'."\n" ."\n" .'- **false**: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Type' => ['description' => 'The dominant emotion detected.', 'type' => 'string', 'example' => '中性', 'title' => ''], 'Confidence' => ['description' => 'The confidence score for the emotion analysis.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], 'Remark' => ['description' => 'A summary or notable events related to the emotion analysis.', 'type' => 'string', 'example' => '客户没情绪变化', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Satisfaction' => [ 'description' => 'The satisfaction analysis.', 'type' => 'object', 'properties' => [ 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'cb67479ce28243b28ff39948feaa0806', 'title' => ''], 'Success' => ['description' => 'Indicates if the analysis task was successful.'."\n" ."\n" .'- **true**: The operation was successful.'."\n" ."\n" .'- **false**: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'SatisfactionDescription' => ['description' => 'The overall customer satisfaction level, as determined by the analysis.', 'type' => 'string', 'example' => '满意', 'title' => ''], 'Remark' => ['description' => 'A summary or notable events related to the satisfaction analysis.', 'type' => 'string', 'example' => '客户表示满意', 'title' => ''], ], 'title' => '', 'example' => '', ], 'TodoList' => [ 'description' => 'Contains action items identified during the call.', 'type' => 'object', 'properties' => [ 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'cb67479ce28243b28ff39948feaa0806', 'title' => ''], 'Success' => ['description' => 'Indicates if the analysis task was successful.'."\n" ."\n" .'- **true**: The operation was successful.'."\n" ."\n" .'- **false**: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Tasks' => [ 'description' => 'A list of action items identified from the conversation.', 'type' => 'array', 'items' => ['description' => 'A single action item.', 'type' => 'string', 'example' => '回访', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'OutsideNumberReleaseReason' => ['description' => 'The reason for disconnection for a call transferred to an external number.', 'type' => 'string', 'example' => 'NoAnswer', 'title' => ''], 'SummaryIndex' => [ 'description' => 'Contains keywords extracted from the call.', 'type' => 'object', 'properties' => [ 'Keywords' => ['description' => 'Keywords extracted from the conversation.', 'type' => 'string', 'example' => '客服', 'title' => ''], ], 'title' => '', 'example' => '', ], 'VoicebotOriginatorNumber' => ['description' => 'The calling number for an outbound call transferred from a voicebot.', 'type' => 'string', 'example' => '021xxxxxxx', 'title' => ''], 'VoicebotDestinationNumber' => ['description' => 'The called number for an outbound call transferred from a voicebot.', 'type' => 'string', 'example' => '134xxxxxx', 'title' => ''], 'OffsiteAgentReleaseReason' => ['description' => 'The disconnection reason for the last assigned off-site agent.', 'type' => 'string', 'example' => 'IVRException', 'title' => ''], 'OutsideNumberDestinationNumber' => ['description' => 'The called number for a transfer to an external number.', 'type' => 'string', 'example' => '134xxxxxx', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid. %s', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"01B12EE4-6AF2-4730-8B78-EC15F4E5C025\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"ContactDisposition\\": \\"Success\\",\\n \\"ContactType\\": \\"OUTBOUND\\",\\n \\"EstablishedTime\\": 1532448000000,\\n \\"CalledNumber\\": \\"1332315****\\",\\n \\"AdditionalBroker\\": \\"0533128****\\",\\n \\"SatisfactionIndex\\": 1,\\n \\"SatisfactionSurveyChannel\\": \\"IVR\\",\\n \\"ReleaseTime\\": 1532707199000,\\n \\"WaitTime\\": 5,\\n \\"SkillGroupNames\\": \\"测试技能组1,测试技能组2\\",\\n \\"IvrTime\\": 8,\\n \\"SatisfactionDescription\\": \\"满意\\",\\n \\"ReleaseInitiator\\": \\"customer\\",\\n \\"AgentIds\\": \\"agent@ccc-test\\",\\n \\"CallDuration\\": \\"16\\",\\n \\"RecordingReady\\": true,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"RingTime\\": 5,\\n \\"SatisfactionSurveyOffered\\": true,\\n \\"AgentNames\\": \\"云呼测试坐席\\",\\n \\"StartTime\\": 1631440860000,\\n \\"ContactId\\": \\"job-2255019651513856\\",\\n \\"RecordingDuration\\": 10,\\n \\"CallingNumber\\": \\"0533128****\\",\\n \\"QueueTime\\": 0,\\n \\"Broker\\": \\"053xxxx3127\\",\\n \\"SkillGroupIds\\": \\"skg-default@ccc-test\\",\\n \\"CallerLocation\\": \\"北京市-北京\\",\\n \\"CalleeLocation\\": \\"山东省-济南\\",\\n \\"EarlyMediaState\\": \\"NotConnected\\",\\n \\"ReleaseReason\\": \\"486:USER_BUSY\\",\\n \\"DialingTime\\": 0,\\n \\"TalkTime\\": 0,\\n \\"HeldTime\\": 12,\\n \\"EarlyMediaText\\": \\"正在通话中\\",\\n \\"OffSiteAgentIds\\": \\"skg-default@ccc-test\\",\\n \\"OffsiteAgentDestinationNumbers\\": \\"80312348\\",\\n \\"MessagesSent\\": 10,\\n \\"MessagesSentByCustomer\\": 5,\\n \\"MessagesSentByAgent\\": 5,\\n \\"FirstResponseTime\\": 10,\\n \\"MediaType\\": \\"CHAT\\",\\n \\"TransferCount\\": 1,\\n \\"AccessChannelType\\": \\"Web\\",\\n \\"AccessChannelName\\": \\"测试渠道\\",\\n \\"AccessChannelUserId\\": \\"test-user-id\\",\\n \\"AccessChannelUserName\\": \\"测试访客\\",\\n \\"ClientIpAddress\\": \\"10.100.2.1\\",\\n \\"ClientLocation\\": \\"---\\",\\n \\"ClientUserAgent\\": \\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.0.0 Safari/537.36\\",\\n \\"ClientAppName\\": \\"未知\\",\\n \\"OffsiteAgentOriginatorNumbers\\": \\"0101257****\\",\\n \\"CallIds\\": \\"dxxx1sdf,xkkwwwa\\",\\n \\"AnalyticsReportReady\\": true,\\n \\"AnalyticsReport\\": {\\n \\"ProblemSolving\\": {\\n \\"TaskId\\": \\"8bf18b7a10064b29a75946a8d5b8469a\\",\\n \\"Success\\": false,\\n \\"Solved\\": true,\\n \\"Problem\\": \\"告警问题\\",\\n \\"Solution\\": \\"富化服务自动关闭原始告警\\"\\n },\\n \\"Emotion\\": {\\n \\"TaskId\\": \\"0ff07fe35670423089dbdf12766d962f\\",\\n \\"Success\\": true,\\n \\"Type\\": \\"中性\\",\\n \\"Confidence\\": 50,\\n \\"Remark\\": \\"客户没情绪变化\\"\\n },\\n \\"Satisfaction\\": {\\n \\"TaskId\\": \\"cb67479ce28243b28ff39948feaa0806\\",\\n \\"Success\\": true,\\n \\"SatisfactionDescription\\": \\"满意\\",\\n \\"Remark\\": \\"客户表示满意\\"\\n },\\n \\"TodoList\\": {\\n \\"TaskId\\": \\"cb67479ce28243b28ff39948feaa0806\\",\\n \\"Success\\": true,\\n \\"Tasks\\": [\\n \\"回访\\"\\n ]\\n }\\n },\\n \\"OutsideNumberReleaseReason\\": \\"NoAnswer\\",\\n \\"SummaryIndex\\": {\\n \\"Keywords\\": \\"客服\\"\\n },\\n \\"VoicebotOriginatorNumber\\": \\"021xxxxxxx\\",\\n \\"VoicebotDestinationNumber\\": \\"134xxxxxx\\",\\n \\"OffsiteAgentReleaseReason\\": \\"IVRException\\",\\n \\"OutsideNumberDestinationNumber\\": \\"134xxxxxx\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => 'Obtain Call Detail List', 'description' => 'The ListCallDetailRecordsV2 interface replaces ListCallDetailRecords. Future enhancements, such as adding new fields and query conditions, will be made only to ListCallDetailRecordsV2. To ensure query efficiency, the TotalCount field is populated only for the first page of results and is 0 for all subsequent pages.', 'changeSet' => [ ['createdAt' => '2025-07-15T12:01:46.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2025-06-12T11:54:29.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-09-06T02:26:17.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'ListCallSummaries' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ 'name' => 'ContactIdList', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'List of call IDs.', 'title' => 'List of call IDs', 'type' => 'array', 'items' => ['description' => 'Call ID.', 'type' => 'string', 'required' => false, 'example' => 'job-544789******759424', 'title' => ''], 'required' => false, 'example' => '', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ccc-test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'ListCallSummariesResponse', 'title' => 'ListCallSummariesResponse ', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'Data.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'TicketId' => ['title' => 'Summary ID ', 'description' => 'Summary ID.', 'type' => 'string', 'example' => 'ac0dd304-****-****-****-4a90010f0d38'], 'ContactId' => ['title' => 'Call ID ', 'description' => 'Call ID.', 'type' => 'string', 'example' => 'job-544789******759424'], 'Context' => ['title' => 'Summary information ', 'description' => 'Summary information.', 'type' => 'string', 'example' => '{'."\n" .' "_sys_field_config": ['."\n" .' {'."\n" .' "Array": false,'."\n" .' "Required": true,'."\n" .' "DisplayName": "主题",'."\n" .' "Attributes": "{}",'."\n" .' "DataType": "TEXT",'."\n" .' "EditorType": "TEXT",'."\n" .' "MaxLength": 30,'."\n" .' "System": true,'."\n" .' "Name": "summaryTitle"'."\n" .' },'."\n" .' {'."\n" .' "Array": false,'."\n" .' "DisplayName": "小结",'."\n" .' "Attributes": "{}",'."\n" .' "DataType": "TEXT",'."\n" .' "EditorType": "TEXTAREA",'."\n" .' "MaxLength": 1000,'."\n" .' "System": true,'."\n" .' "Name": "summaryContent"'."\n" .' },'."\n" .' {'."\n" .' "Array": true,'."\n" .' "DisplayName": "标签",'."\n" .' "Attributes": "{}",'."\n" .' "DataType": "TEXT",'."\n" .' "EditorType": "SELECT",'."\n" .' "System": true,'."\n" .' "Name": "keywords"'."\n" .' }'."\n" .' ],'."\n" .' "summaryContent": "小结内容",'."\n" .' "creator": "creator@ccc-test",'."\n" .' "bizType": "Summary",'."\n" .' "keywords": ['."\n" .' "标签1"'."\n" .' ],'."\n" .' "source": "Console",'."\n" .' "summaryTitle": "测试会话小结",'."\n" .' "instanceId": "ccc-test",'."\n" .' "externalInput": "{\\"summaryTitle\\":\\"测试会话小结\\",\\"summaryContent\\":\\"小结内容\\",\\"keywords\\":[\\"标签1\\"],\\"_sys_field_config\\":[{\\"DisplayName\\":\\"主题\\",\\"Name\\":\\"summaryTitle\\",\\"Required\\":true,\\"EditorType\\":\\"TEXT\\",\\"Array\\":false,\\"DataType\\":\\"TEXT\\",\\"System\\":true,\\"MaxLength\\":30,\\"Attributes\\":\\"{}\\"},{\\"DisplayName\\":\\"小结\\",\\"Name\\":\\"summaryContent\\",\\"EditorType\\":\\"TEXTAREA\\",\\"Array\\":false,\\"DataType\\":\\"TEXT\\",\\"System\\":true,\\"MaxLength\\":1000,\\"Attributes\\":\\"{}\\"},{\\"DisplayName\\":\\"标签\\",\\"Name\\":\\"keywords\\",\\"EditorType\\":\\"SELECT\\",\\"Array\\":true,\\"DataType\\":\\"TEXT\\",\\"System\\":true,\\"Attributes\\":\\"{}\\"}]}",'."\n" .' "templateName": "Summary-Ticket",'."\n" .' "bizId": "job-544789******759424",'."\n" .' "ticketStartTime": 1723449513735,'."\n" .' "ticketId": "ac0dd304-****-****-****-4a90010f0d38",'."\n" .' "definitionId": "Summary-Ticket:2:6881f43a-****-11ee-*****-6eb35a90a7a6"'."\n" .'}'], 'CreatedTime' => ['title' => 'Creation Time ', 'description' => 'Creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1723449513735'], 'Creator' => ['title' => 'Creator', 'description' => 'Creator.', 'type' => 'string', 'example' => 'creator@ccc-test'], 'Editor' => ['description' => 'Editor.', 'type' => 'string', 'example' => 'editor@ccc-test', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '932579BC-811A-503D-B322-4C2E57087CAA', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'Error message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Params' => [ 'description' => 'List of error parameters.', 'type' => 'array', 'items' => ['description' => 'Error parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"TicketId\\": \\"ac0dd304-****-****-****-4a90010f0d38\\",\\n \\"ContactId\\": \\"job-544789******759424\\",\\n \\"Context\\": \\"{\\\\n \\\\\\"_sys_field_config\\\\\\": [\\\\n {\\\\n \\\\\\"Array\\\\\\": false,\\\\n \\\\\\"Required\\\\\\": true,\\\\n \\\\\\"DisplayName\\\\\\": \\\\\\"主题\\\\\\",\\\\n \\\\\\"Attributes\\\\\\": \\\\\\"{}\\\\\\",\\\\n \\\\\\"DataType\\\\\\": \\\\\\"TEXT\\\\\\",\\\\n \\\\\\"EditorType\\\\\\": \\\\\\"TEXT\\\\\\",\\\\n \\\\\\"MaxLength\\\\\\": 30,\\\\n \\\\\\"System\\\\\\": true,\\\\n \\\\\\"Name\\\\\\": \\\\\\"summaryTitle\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"Array\\\\\\": false,\\\\n \\\\\\"DisplayName\\\\\\": \\\\\\"小结\\\\\\",\\\\n \\\\\\"Attributes\\\\\\": \\\\\\"{}\\\\\\",\\\\n \\\\\\"DataType\\\\\\": \\\\\\"TEXT\\\\\\",\\\\n \\\\\\"EditorType\\\\\\": \\\\\\"TEXTAREA\\\\\\",\\\\n \\\\\\"MaxLength\\\\\\": 1000,\\\\n \\\\\\"System\\\\\\": true,\\\\n \\\\\\"Name\\\\\\": \\\\\\"summaryContent\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"Array\\\\\\": true,\\\\n \\\\\\"DisplayName\\\\\\": \\\\\\"标签\\\\\\",\\\\n \\\\\\"Attributes\\\\\\": \\\\\\"{}\\\\\\",\\\\n \\\\\\"DataType\\\\\\": \\\\\\"TEXT\\\\\\",\\\\n \\\\\\"EditorType\\\\\\": \\\\\\"SELECT\\\\\\",\\\\n \\\\\\"System\\\\\\": true,\\\\n \\\\\\"Name\\\\\\": \\\\\\"keywords\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"summaryContent\\\\\\": \\\\\\"小结内容\\\\\\",\\\\n \\\\\\"creator\\\\\\": \\\\\\"creator@ccc-test\\\\\\",\\\\n \\\\\\"bizType\\\\\\": \\\\\\"Summary\\\\\\",\\\\n \\\\\\"keywords\\\\\\": [\\\\n \\\\\\"标签1\\\\\\"\\\\n ],\\\\n \\\\\\"source\\\\\\": \\\\\\"Console\\\\\\",\\\\n \\\\\\"summaryTitle\\\\\\": \\\\\\"测试会话小结\\\\\\",\\\\n \\\\\\"instanceId\\\\\\": \\\\\\"ccc-test\\\\\\",\\\\n \\\\\\"externalInput\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"summaryTitle\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"测试会话小结\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"summaryContent\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"小结内容\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"keywords\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"标签1\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"_sys_field_config\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"DisplayName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"主题\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"summaryTitle\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Required\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"EditorType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"TEXT\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Array\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"DataType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"TEXT\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"System\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"MaxLength\\\\\\\\\\\\\\":30,\\\\\\\\\\\\\\"Attributes\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{}\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"DisplayName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"小结\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"summaryContent\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"EditorType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"TEXTAREA\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Array\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"DataType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"TEXT\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"System\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"MaxLength\\\\\\\\\\\\\\":1000,\\\\\\\\\\\\\\"Attributes\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{}\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"DisplayName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"标签\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"keywords\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"EditorType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"SELECT\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Array\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"DataType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"TEXT\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"System\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"Attributes\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{}\\\\\\\\\\\\\\"}]}\\\\\\",\\\\n \\\\\\"templateName\\\\\\": \\\\\\"Summary-Ticket\\\\\\",\\\\n \\\\\\"bizId\\\\\\": \\\\\\"job-544789******759424\\\\\\",\\\\n \\\\\\"ticketStartTime\\\\\\": 1723449513735,\\\\n \\\\\\"ticketId\\\\\\": \\\\\\"ac0dd304-****-****-****-4a90010f0d38\\\\\\",\\\\n \\\\\\"definitionId\\\\\\": \\\\\\"Summary-Ticket:2:6881f43a-****-11ee-*****-6eb35a90a7a6\\\\\\"\\\\n}\\",\\n \\"CreatedTime\\": 1723449513735,\\n \\"Creator\\": \\"creator@ccc-test\\",\\n \\"Editor\\": \\"editor@ccc-test\\"\\n }\\n ],\\n \\"RequestId\\": \\"932579BC-811A-503D-B322-4C2E57087CAA\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', 'title' => 'Retrieve session summary', 'summary' => 'Use the ListCallSummaries operation to retrieve call summaries.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'ListCallTags' => [ 'summary' => 'You can invoke ListCallTags to obtain all number tags under a specified instance.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc1MRAID'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'Paging ordinal number, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The page size, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Data' => [ 'description' => 'The data.', 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'The page number, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The page size, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'TotalCount' => ['description' => 'The total count.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'List' => [ 'description' => 'The list of number tags.', 'type' => 'array', 'items' => [ 'description' => 'A number tag.', 'type' => 'object', 'properties' => [ 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'TagName' => ['description' => 'The name of the number tag.', 'type' => 'string', 'example' => 'TagA', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => ''], ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.DB', 'errorMessage' => 'An internal DB service error occurred. %s', 'description' => ''], ], ], 'title' => 'Obtain the List of Number Tags', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2022-02-24T13:00:36.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCallTags'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"TagName\\": \\"TagA\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'ListCampaignTrendingReport' => [ 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccQFUGXR'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['title' => 'Instance ID', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ccc-test'], ], [ 'name' => 'CampaignId', 'in' => 'query', 'schema' => ['title' => 'Activity ID', 'description' => 'The ID of the predictive outbound calling Activity.', 'type' => 'string', 'required' => true, 'example' => '6badb397-a8b5-40b6-21019d382a09'], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['title' => 'Start Time', 'description' => 'Start Time. This parameter is optional. The default value is the Start Time of the predictive outbound calling Activity.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2021-10-14 00:00:00'], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['title' => 'End Time', 'description' => 'The end time. This parameter is optional. The default value is the end time of the predictive outbound dialing activity.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2021-10-14 20:59:59'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '6CCEF32F-8614-535F-A1D9-D85B8C0DC4F0', 'title' => ''], 'Data' => [ 'description' => 'List of statistical data points.', 'type' => 'array', 'items' => [ 'description' => 'Statistical data point.', 'type' => 'object', 'properties' => [ 'Datetime' => ['description' => 'The timestamp for segmented statistics, formatted as a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1634037840000', 'title' => ''], 'Concurrency' => ['description' => 'The concurrent call volume, which refers to the number of simultaneous outbound calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'TalkAgents' => ['description' => 'Deprecated. Refer to TalkAgents.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'ReadyAgents' => ['description' => 'Number of idle agents.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], 'WorkAgents' => ['description' => 'Deprecated. Refer to WorkingAgents.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'LoggedInAgents' => ['description' => 'The number of published agents.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], 'BreakAgents' => ['description' => 'Number of agents on break.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'StatsTime' => ['description' => 'Time of the statistical data point, formatted as a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1604639129000', 'title' => ''], 'TalkingAgents' => ['description' => 'The number of agents in a call.', 'type' => 'integer', 'format' => 'int64', 'example' => '4', 'title' => ''], 'WorkingAgents' => ['description' => 'Number of agents in post-processing status.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'BreakingAgents' => ['description' => 'Number of agents in break status.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'OutboundScenarioReadyAgents' => ['description' => 'Number of agents in idle status under outbound-only mode.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'OutboundScenarioBreakingAgents' => ['description' => 'The number of agents in outbound-only mode who are on a break.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], 'OutboundScenarioTalkingAgents' => ['description' => 'The number of agents in outbound-only mode who are currently on a call.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'OutboundScenarioWorkingAgents' => ['description' => 'Number of agents in post-processing status under outbound-only mode.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'title' => 'Obtain the predictive outbound dialing activity trend report', 'summary' => 'Obtain the trend report of the predictive outbound calling activity with the specified ID under the specified instance.', 'changeSet' => [ ['createdAt' => '2023-11-22T01:05:27.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCampaignTrendingReport'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"6CCEF32F-8614-535F-A1D9-D85B8C0DC4F0\\",\\n \\"Data\\": [\\n {\\n \\"Datetime\\": 1634037840000,\\n \\"Concurrency\\": 1,\\n \\"TalkAgents\\": 0,\\n \\"ReadyAgents\\": 2,\\n \\"WorkAgents\\": 0,\\n \\"LoggedInAgents\\": 2,\\n \\"BreakAgents\\": 0,\\n \\"StatsTime\\": 1604639129000,\\n \\"TalkingAgents\\": 4,\\n \\"WorkingAgents\\": 0,\\n \\"BreakingAgents\\": 1,\\n \\"OutboundScenarioReadyAgents\\": 1,\\n \\"OutboundScenarioBreakingAgents\\": 2,\\n \\"OutboundScenarioTalkingAgents\\": 1,\\n \\"OutboundScenarioWorkingAgents\\": 2\\n }\\n ]\\n}","type":"json"}]', ], 'ListCampaigns' => [ 'summary' => 'Calls ListCampaigns to obtain the list of predictive dialing campaigns under a specified instance.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccQFUGXR'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'State', 'in' => 'query', 'schema' => [ 'description' => 'Filters campaigns by predictive dialing campaign state. This parameter is optional and defaults to empty.', 'enumValueTitles' => ['Draft' => 'draft.', 'Completed' => 'completed.', 'Executing' => 'executing.', 'Pending' => 'pending.', 'Aborted' => 'aborted.', 'Paused' => 'Paused'], 'type' => 'string', 'required' => false, 'example' => 'Draft', 'title' => '', ], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'Filters campaigns by predictive dialing campaign name. Fuzzy match is not supported. This parameter is optional and defaults to empty, which indicates no filtering.', 'type' => 'string', 'required' => false, 'example' => 'test-campaign', 'title' => ''], ], [ 'name' => 'PlanedStartTimeFrom', 'in' => 'query', 'schema' => ['description' => 'The planned start time of the campaign. This parameter is optional. By default, all time ranges are queried.', 'type' => 'string', 'required' => false, 'example' => '1780243200000', 'title' => ''], ], [ 'name' => 'PlanedStartTimeTo', 'in' => 'query', 'schema' => ['description' => 'The planned end time of the campaign. This parameter is optional. By default, all time ranges are queried.', 'type' => 'string', 'required' => false, 'example' => '1781798399000', 'title' => ''], ], [ 'name' => 'ActualStartTimeFrom', 'in' => 'query', 'schema' => ['description' => 'The actual start time of the campaign. This parameter is optional. By default, all time ranges are queried.', 'type' => 'string', 'required' => false, 'example' => '1780329600000', 'title' => ''], ], [ 'name' => 'ActualStartTimeTo', 'in' => 'query', 'schema' => ['description' => 'The actual end time of the campaign. This parameter is optional. By default, all time ranges are queried.', 'type' => 'string', 'required' => false, 'example' => '1781625600000', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The page size. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10', 'title' => ''], ], [ 'name' => 'QueueId', 'in' => 'query', 'schema' => ['description' => 'Filters campaigns by skill group ID. This parameter is optional and defaults to empty, which indicates no filtering.', 'type' => 'string', 'required' => false, 'example' => 'skillgroup@ccc-test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6CCEF32F-8614-535F-A1D9-D85B8C0DC4F0', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], 'Data' => [ 'description' => 'The data.', 'type' => 'object', 'properties' => [ 'List' => [ 'description' => 'The list of predictive dialing campaigns.', 'type' => 'array', 'items' => [ 'description' => 'The predictive dialing campaign information.', 'type' => 'object', 'properties' => [ 'ActualEndTime' => ['description' => 'The actual end time of the predictive dialing campaign. The value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1634008800000', 'title' => ''], 'ActualStartTime' => ['description' => 'The actual start time of the predictive dialing campaign. The value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1634000460000', 'title' => ''], 'CasesAborted' => ['description' => 'The number of aborted cases in the predictive dialing campaign. An aborted case indicates that the call to the contact was canceled.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CasesUncompleted' => ['description' => 'The number of uncompleted cases in the predictive dialing campaign. An uncompleted case indicates that the call was not connected and the maximum number of retry attempts was not reached.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CasesConnected' => ['description' => 'The number of connected cases in the predictive dialing campaign.', 'type' => 'integer', 'format' => 'int64', 'example' => '40', 'title' => ''], 'MaxAttemptCount' => ['description' => 'The maximum number of attempts for the predictive dialing campaign. This value specifies the maximum number of redial attempts when a call to a number fails.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'MinAttemptInterval' => ['description' => 'The minimum redial interval for the predictive dialing campaign. This value specifies the minimum interval between redial attempts after a failure. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'Name' => ['description' => 'The name of the predictive dialing campaign.', 'type' => 'string', 'example' => 'test-campaign', 'title' => ''], 'PlanedEndTime' => ['description' => 'The planned end time of the predictive dialing campaign. The value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1634054400000', 'title' => ''], 'PlanedStartTime' => ['description' => 'The planned start time of the predictive dialing campaign. The value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1633968000000', 'title' => ''], 'QueueName' => ['description' => 'The name of the skill group.', 'type' => 'string', 'example' => '测试技能组', 'title' => ''], 'TotalCases' => ['description' => 'The total number of phone numbers.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'State' => [ 'title' => '', 'description' => 'The state of the predictive dialing campaign.', 'enumValueTitles' => ['Draft' => 'draft.', 'Completed' => 'completed.', 'Executing' => 'executing.', 'Pending' => 'pending.', 'Aborted' => 'aborted.', 'Paused' => 'paused.'], 'type' => 'string', 'example' => 'Completed', ], 'CampaignId' => ['title' => '', 'description' => 'The ID of the predictive dialing campaign.', 'type' => 'string', 'example' => '6badb397-a8b5-40b6-21019d382a09'], 'StrategyType' => [ 'description' => 'The strategy mode of the predictive dialing campaign.', 'enumValueTitles' => ['PACING' => 'Fixed-ratio dialing. The number of outbound calls equals the number of idle agents multiplied by the ratio.', 'PID' => 'The system automatically adjusts the number of outbound calls based on the PID control strategy.'], 'type' => 'string', 'example' => 'PACING', 'title' => '', ], 'StrategyParameters' => ['description' => 'The strategy parameters of the predictive dialing campaign. Example for the PID strategy: {"abandonRate":"5","historicalConnectedRate":"35"}. Example for the PACING strategy: {"ratio":1}. abandonRate specifies the expected call abandon rate. historicalConnectedRate specifies the historical reference connection rate. ratio specifies the fixed dialing ratio.', 'type' => 'string', 'example' => '{"ratio":1}', 'title' => ''], 'QueueId' => ['description' => 'The ID of the associated skill group.', 'type' => 'string', 'example' => 'skillgroup@ccc-test', 'title' => ''], 'Simulation' => ['description' => 'Indicates whether the campaign is a simulated campaign.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'CompletionRate' => ['description' => 'The completion rate. This parameter is deprecated. You can calculate the completion rate by using the formula (TotalCases - CasesUnCompleted) / TotalCases.', 'type' => 'number', 'format' => 'float', 'example' => '无', 'title' => ''], 'ContactFlowId' => ['description' => 'The ID of the IVR contact flow associated with the phone number.', 'type' => 'string', 'example' => 'a3fb6c62-9b49-4942-ae5b-cf2abd4123ek', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'PageNumber' => ['description' => 'The page number. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The page size. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], 'TotalCount' => ['description' => 'The total count.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6CCEF32F-8614-535F-A1D9-D85B8C0DC4F0\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"ActualEndTime\\": 1634008800000,\\n \\"ActualStartTime\\": 1634000460000,\\n \\"CasesAborted\\": 0,\\n \\"CasesUncompleted\\": 0,\\n \\"CasesConnected\\": 40,\\n \\"MaxAttemptCount\\": 1,\\n \\"MinAttemptInterval\\": 1,\\n \\"Name\\": \\"test-campaign\\",\\n \\"PlanedEndTime\\": 1634054400000,\\n \\"PlanedStartTime\\": 1633968000000,\\n \\"QueueName\\": \\"测试技能组\\",\\n \\"TotalCases\\": 100,\\n \\"State\\": \\"Completed\\",\\n \\"CampaignId\\": \\"6badb397-a8b5-40b6-21019d382a09\\",\\n \\"StrategyType\\": \\"PACING\\",\\n \\"StrategyParameters\\": \\"{\\\\\\"ratio\\\\\\":1}\\",\\n \\"QueueId\\": \\"skillgroup@ccc-test\\",\\n \\"Simulation\\": false,\\n \\"CompletionRate\\": 0,\\n \\"ContactFlowId\\": \\"a3fb6c62-9b49-4942-ae5b-cf2abd4123ek\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'List predictive dialing campaigns', 'changeSet' => [ ['createdAt' => '2024-06-06T11:38:12.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-11-17T01:12:02.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCampaigns'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'ListCases' => [ 'summary' => 'Invoke ListCases to obtain the execution details list of the outbound contact list for the predictive dialing Activity corresponding to the specified ID under the specified instance.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccQFUGXR'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'CampaignId', 'in' => 'query', 'schema' => ['description' => 'Predictive outbound dialing activity ID.', 'type' => 'string', 'required' => true, 'example' => '6badb397-a8b5-40b6-21019d382a09', 'title' => ''], ], [ 'name' => 'PhoneNumber', 'in' => 'query', 'schema' => ['description' => 'Filters by phone number. Fuzzy Matching is not supported. This parameter is not Required and defaults to empty.', 'type' => 'string', 'required' => false, 'example' => '无', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The paging ordinal number, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'Page size, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100', 'title' => ''], ], [ 'name' => 'State', 'in' => 'query', 'schema' => ['description' => 'Pending (to be dialed)
'."\n" .'Executing (dialing in progress)
'."\n" .'Connected (contact succeeded)
'."\n" .'Failed (contact failed)
'."\n" .'Aborted (call stopped or canceled)
'."\n" .'Forbidden (call prohibited by rule, such as blacklist)', 'type' => 'string', 'required' => false, 'example' => 'Pending', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '7CC6523B-0E51-1B62-8DA5-6A9831CAE316', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'title' => 'data', 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'Page number, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'Page size, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalCount' => ['description' => 'Total count.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'List' => [ 'description' => 'List of contact list execution details.', 'type' => 'array', 'items' => [ 'description' => 'Contact list execution details.', 'type' => 'object', 'properties' => [ 'AbandonType' => [ 'description' => 'The type of call abandonment, that is, the reason why the call was not successfully connected.', 'enumValueTitles' => ['NA' => 'Not abandoned', 'IVR' => 'IVR interaction phase', 'Ringing' => 'Agent ringing phase', 'Queuing' => 'Queuing phase'], 'type' => 'string', 'example' => 'NA', 'title' => '', ], 'AttemptCount' => ['description' => 'Number of attempts, which is the total number of calls made to this contact.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'FailureReason' => [ 'description' => 'Reason for outbound call failure.', 'enumValueTitles' => [ 'AbandonedInQueue' => 'Abandoned in queue', 'AbandonedInRing' => 'Abandoned during ringing', 'AbandonedInIVR' => 'Abandoned in IVR', 'NoAnswer' => 'Customer did not answer', 'QueuingTimeout' => 'Queue timeout', 'Reject' => 'Customer rejected the call', 'Voicemail' => 'Transferred to voicemail', 'QueuingFailed' => 'Failed to transfer to agent', 'QueuingOverflow' => 'Queue overflow', 'AbandonedInVoiceNavigator' => 'Abandoned in Intelligent Voice Navigator', 'IVRException' => 'IVR abnormal', 'ForwardToOutsideNumber' => 'Forwarded to external number', ], 'type' => 'string', 'example' => '无', 'title' => '', ], 'PhoneNumber' => ['description' => 'Phone number.', 'type' => 'string', 'example' => '1888888****', 'title' => ''], 'State' => [ 'description' => 'Status.', 'enumValueTitles' => ['Connected' => 'Succeeded', 'Failed' => 'Failed', 'Executing' => 'Dialing', 'Pending' => 'Pending', 'Aborted' => 'Aborted'], 'type' => 'string', 'example' => 'Connected', 'title' => '', ], 'CaseId' => ['description' => 'System-generated contact ID. Customers do not need to concern themselves with this.', 'type' => 'string', 'example' => '60ecb1a2-4480-4d01-bede-c5b7655bfadf', 'title' => ''], 'CustomVariables' => ['description' => 'Custom variables defined by the customer, formatted as a JSON object. The object can contain up to 10 properties, each with a name and value defined by the customer. These can be configured when creating a predictive outbound dialing activity.', 'type' => 'string', 'example' => '{"name":"yy","客戶标签":"tag-yy"}', 'title' => ''], 'AbandonPhase' => ['description' => 'Phase at which the call was abandoned.'."\n" ."\n" .'- IVR (IVR interaction phase)'."\n" ."\n" .'- Queuing (queuing phase)'."\n" ."\n" .'- Ringing (agent ringing phase)', 'type' => 'string', 'example' => 'Ringing', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'title' => 'Retrieve predictive outbound dialing list', 'changeSet' => [ ['createdAt' => '2023-11-22T01:05:27.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCases'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7CC6523B-0E51-1B62-8DA5-6A9831CAE316\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 1,\\n \\"List\\": [\\n {\\n \\"AbandonType\\": \\"NA\\",\\n \\"AttemptCount\\": 1,\\n \\"FailureReason\\": \\"无\\",\\n \\"PhoneNumber\\": \\"1888888****\\",\\n \\"State\\": \\"Connected\\",\\n \\"CaseId\\": \\"60ecb1a2-4480-4d01-bede-c5b7655bfadf\\",\\n \\"CustomVariables\\": \\"{\\\\\\"name\\\\\\":\\\\\\"yy\\\\\\",\\\\\\"客戶标签\\\\\\":\\\\\\"tag-yy\\\\\\"}\\",\\n \\"AbandonPhase\\": \\"Ringing\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'ListCategories' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The category type.', 'enumValueTitles' => ['Ticket' => 'Ticket'], 'type' => 'string', 'required' => false, 'example' => 'Ticket', 'title' => '', ], ], [ 'name' => 'CategoryId', 'in' => 'query', 'schema' => ['description' => 'The ID of the ticket category. Specify this parameter to return information about the subcategories of the specified category. If you leave this parameter empty, information about all categories in the instance is returned.', 'type' => 'string', 'required' => false, 'example' => '43c2671b-***-***-86d0-6bd187905cc8', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'ListCategoriesResponse', 'title' => 'ListCategoriesResponse', 'type' => 'object', 'properties' => [ 'Data' => ['description' => 'The data. The category node information, in the format of a JSON string.', 'type' => 'string', 'example' => '[{\\"categoryId\\":\\"43c2671b-8939-4223-****-6bd187905cc8\\",\\"childCategoryList\\":[{\\"categoryId\\":\\"120816ad-4392-4edf-****-6d053d5cfa5a\\",\\"childCategoryList\\":[],\\"deleted\\":0,\\"editor\\":\\"283277706217028904\\",\\"editorName\\":\\"283277706217028904\\",\\"instanceId\\":\\"cccV2-kmz\\",\\"itemCount\\":0,\\"level\\":2,\\"name\\":\\"客户反馈\\",\\"parentCategoryId\\":\\"43c2671b-8939-****-86d0-6bd187905cc8\\",\\"type\\":\\"Ticket\\"}],\\"deleted\\":0,\\"editor\\":\\"283277706217028904\\",\\"editorName\\":\\"283277706217028904\\",\\"instanceId\\":\\"cccV2-kmz\\",\\"itemCount\\":10,\\"level\\":1,\\"name\\":\\"测试一01类目\\",\\"type\\":\\"Ticket\\"},{\\"categoryId\\":\\"4948fcd0-2972-****-81c6-1a00927e1802\\",\\"childCategoryList\\":[],\\"deleted\\":0,\\"editor\\":\\"283277706217028904\\",\\"editorName\\":\\"283277706217028904\\",\\"instanceId\\":\\"cccV2-kmz\\",\\"itemCount\\":0,\\"level\\":1,\\"name\\":\\"生产环境验证\\",\\"type\\":\\"Ticket\\"},{\\"categoryId\\":\\"c426bd7f-9661-47c3-****-2508f1a32f66\\",\\"childCategoryList\\":[],\\"deleted\\":0,\\"editor\\":\\"269801834095770945\\",\\"editorName\\":\\"269801834095770945\\",\\"instanceId\\":\\"cccV2-kmz\\",\\"itemCount\\":4,\\"level\\":1,\\"name\\":\\"测试环境测试\\",\\"type\\":\\"Ticket\\"}]', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Params' => [ 'description' => 'The list of incorrect parameters.', 'type' => 'array', 'items' => ['description' => 'The incorrect parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"[{\\\\\\\\\\\\\\"categoryId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"43c2671b-8939-4223-****-6bd187905cc8\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"childCategoryList\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"categoryId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"120816ad-4392-4edf-****-6d053d5cfa5a\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"childCategoryList\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"deleted\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"editor\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"283277706217028904\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"editorName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"283277706217028904\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cccV2-kmz\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"itemCount\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"level\\\\\\\\\\\\\\":2,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"客户反馈\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"parentCategoryId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"43c2671b-8939-****-86d0-6bd187905cc8\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Ticket\\\\\\\\\\\\\\"}],\\\\\\\\\\\\\\"deleted\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"editor\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"283277706217028904\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"editorName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"283277706217028904\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cccV2-kmz\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"itemCount\\\\\\\\\\\\\\":10,\\\\\\\\\\\\\\"level\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"测试一01类目\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Ticket\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"categoryId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"4948fcd0-2972-****-81c6-1a00927e1802\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"childCategoryList\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"deleted\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"editor\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"283277706217028904\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"editorName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"283277706217028904\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cccV2-kmz\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"itemCount\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"level\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"生产环境验证\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Ticket\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"categoryId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"c426bd7f-9661-47c3-****-2508f1a32f66\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"childCategoryList\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"deleted\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"editor\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"269801834095770945\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"editorName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"269801834095770945\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"instanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cccV2-kmz\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"itemCount\\\\\\\\\\\\\\":4,\\\\\\\\\\\\\\"level\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"测试环境测试\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Ticket\\\\\\\\\\\\\\"}]\\",\\n \\"RequestId\\": \\"DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', 'title' => 'Obtain categories', 'summary' => 'You can use ListCategories to retrieve category information.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'ListCommonTicketFields' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ccc-test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'GetSchemaResponse', 'title' => 'GetSchemaResponse', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'Id' => ['description' => 'Schema ID.', 'type' => 'string', 'example' => 'ticketing', 'title' => ''], 'Properties' => [ 'description' => 'List of fields.', 'additionalProperties' => [ 'description' => 'Field.', 'type' => 'object', 'properties' => [ 'DisplayName' => ['description' => 'Display name.', 'type' => 'string', 'example' => '姓名', 'title' => ''], 'Description' => ['description' => 'Description.', 'type' => 'string', 'example' => 'name', 'title' => ''], 'Name' => ['description' => 'Name.', 'type' => 'string', 'example' => 'name', 'title' => ''], 'DataType' => ['description' => 'Data type.', 'type' => 'string', 'example' => 'string', 'title' => ''], 'Pattern' => ['description' => 'Regular expression validation rule.', 'type' => 'string', 'example' => '^', 'title' => ''], 'PatternErrorMessage' => ['description' => 'Regular expression validation error message.', 'type' => 'string', 'example' => '不是有效的email地址', 'title' => ''], 'MinLength' => ['description' => 'Minimum length.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'MaxLength' => ['description' => 'Maximum length.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'Minimum' => ['description' => 'Minimum numeric value.', 'type' => 'number', 'format' => 'double', 'example' => '1', 'title' => ''], 'Maximum' => ['description' => 'Maximum numeric value.', 'type' => 'number', 'format' => 'double', 'example' => '10', 'title' => ''], 'Required' => ['description' => 'Whether the field is required.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'System' => ['description' => 'Whether the field is a system field.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Disabled' => ['description' => 'Whether the field is disabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Array' => ['description' => 'Whether the field is an array.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'ReadOnly' => ['description' => 'Whether the field is read-only.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'EditorType' => ['description' => 'Editor type.', 'type' => 'string', 'example' => 'textbox', 'title' => ''], 'Attributes' => ['description' => 'Extension attributes.', 'type' => 'string', 'example' => '{}'."\n", 'title' => ''], 'DisplayOrder' => ['description' => 'Display order in the list.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'CreatedTime' => ['description' => 'Creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1703517780627', 'title' => ''], 'UpdatedTime' => ['description' => 'Update time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1716211430928', 'title' => ''], 'Creator' => ['description' => 'Creator.', 'type' => 'string', 'example' => 'creator@ccc-test', 'title' => ''], ], 'title' => '', 'example' => '', ], 'type' => 'object', 'title' => '', 'example' => '', ], 'CreatedTime' => ['description' => 'Creation time.', 'type' => 'string', 'example' => '1703517780627', 'title' => ''], 'UpdatedTime' => ['description' => 'Last modification time.', 'type' => 'string', 'example' => '1716211430928', 'title' => ''], ], 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '30C7D235-DDCF-4C7F-A462-5E2598252C2B', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Params' => [ 'description' => 'List of error parameters.', 'type' => 'array', 'items' => ['description' => 'Error parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Id\\": \\"ticketing\\",\\n \\"Properties\\": {\\n \\"key\\": {\\n \\"DisplayName\\": \\"姓名\\",\\n \\"Description\\": \\"name\\",\\n \\"Name\\": \\"name\\",\\n \\"DataType\\": \\"string\\",\\n \\"Pattern\\": \\"^\\",\\n \\"PatternErrorMessage\\": \\"不是有效的email地址\\",\\n \\"MinLength\\": 1,\\n \\"MaxLength\\": 10,\\n \\"Minimum\\": 1,\\n \\"Maximum\\": 10,\\n \\"Required\\": false,\\n \\"System\\": false,\\n \\"Disabled\\": false,\\n \\"Array\\": false,\\n \\"ReadOnly\\": false,\\n \\"EditorType\\": \\"textbox\\",\\n \\"Attributes\\": \\"{}\\\\n\\",\\n \\"DisplayOrder\\": 1,\\n \\"CreatedTime\\": 1703517780627,\\n \\"UpdatedTime\\": 1716211430928,\\n \\"Creator\\": \\"creator@ccc-test\\"\\n }\\n },\\n \\"CreatedTime\\": \\"1703517780627\\",\\n \\"UpdatedTime\\": \\"1716211430928\\"\\n },\\n \\"RequestId\\": \\"30C7D235-DDCF-4C7F-A462-5E2598252C2B\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', 'title' => 'Retrieve ticket field definitions', 'summary' => 'Retrieves the ticket field types that are defined for an instance.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'ListConfigItems' => [ 'summary' => 'Retrieves the config items for a specified instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccTMAX45'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'ObjectId', 'in' => 'query', 'schema' => ['description' => 'The ID of the object to which the config item applies. This can be the ID of an Alibaba Cloud account, an instance, a skill group, or an agent.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'ObjectType', 'in' => 'query', 'schema' => [ 'description' => 'The type of the object.', 'enumValueTitles' => ['INSTANCE' => 'Instance-level configuration.', 'USER' => 'Agent-level configuration.', 'SKILL_GROUP' => 'Skill group-level configuration.', 'ALIYUN_UID' => 'Alibaba Cloud account-level configuration.'], 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'INSTANCE', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], 'Params' => [ 'description' => 'The list of dynamic response parameters.', 'type' => 'array', 'items' => ['description' => 'A response parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], 'Data' => [ 'description' => 'The list of config items.', 'type' => 'array', 'items' => [ 'description' => 'A config item.', 'type' => 'object', 'properties' => [ 'ObjectId' => ['description' => 'The ID of the object to which the config item applies.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'Value' => ['description' => 'The value of the config item.', 'type' => 'string', 'example' => '100', 'title' => ''], 'ObjectType' => ['description' => 'The type of the object to which the config item applies.', 'type' => 'string', 'example' => 'INSTANCE', 'title' => ''], 'InstanceId' => ['description' => 'The ID of the instance.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'Name' => [ 'description' => 'The name of the config item. A name can be system-defined or custom. You can customize the value of a system-defined item. You can also create custom items with custom names and values.', 'enumValueTitles' => ['AllowAudioDownload' => 'Controls whether an agent can download recordings. Valid values: `0` (No) and `1` (Yes).', 'RecordingStorageSetting' => 'The recording storage configuration for the instance.', 'AllowChooseSignedSkillGroup' => 'Determines if an agent must manually select which skill groups to sign in to. Valid values: `0` (The agent automatically signs in to all assigned skill groups) and `1` (The agent must manually select the skill groups to sign in to).', 'AgentRingingTimeoutSeconds' => 'The time in seconds before an unanswered call to an agent times out. The value must be an integer from 5 to 90.', 'ShowCalledID' => 'Controls the display of the caller ID for incoming calls. Valid values: `-1` (Hide the full number), `0` (Partially hide the number), and `1` (Show the full number).', 'ShowCalleeID' => 'Controls the display of the callee ID for outgoing calls. Valid values: `-1` (Hide the full number), `0` (Partially hide the number), and `1` (Show the full number).', 'AllowHangup' => 'Controls whether an agent can hang up an incoming call. Valid values: `0` (No) and `1` (Yes).', 'AutoAnswerCall' => 'Controls how an agent answers incoming calls. Valid values: `-1` (Manual answer) or `n` (The call is automatically answered after ringing for `n` seconds).'], 'type' => 'string', 'example' => 'config-item', 'title' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => ''], ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => ''], ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => ''], ], 403 => [ ['errorCode' => 'Permission.Unauthorized', 'errorMessage' => 'You are not authorized to perform this action. %s privileges are required.', 'description' => ''], ], [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Obtain the configuration item list ', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListConfigItems'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": [\\n {\\n \\"ObjectId\\": \\"ccc-test\\",\\n \\"Value\\": \\"100\\",\\n \\"ObjectType\\": \\"INSTANCE\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Name\\": \\"config-item\\"\\n }\\n ]\\n}","type":"json"}]', ], 'ListContactFlows' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. The value must be an integer that is greater than 0. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'Specifies the type of IVR flow to list. If you omit this parameter, IVR flows of all types are listed.', 'enumValueTitles' => ['SURVEY_FLOW' => 'A survey flow.', 'SUB_FLOW' => 'A subflow.', 'MAIN_FLOW' => 'A main flow.'], 'type' => 'string', 'required' => false, 'example' => 'MAIN_FLOW', 'title' => '', ], ], [ 'name' => 'SortOrder', 'in' => 'query', 'schema' => ['description' => 'The sort order. Valid values:'."\n" ."\n" .'- `ASC`: The results are sorted in ascending order.'."\n" ."\n" .'- `DESC`: The results are sorted in descending order. This is the default value.', 'type' => 'string', 'required' => false, 'example' => 'DESC', 'title' => ''], ], [ 'name' => 'OrderByField', 'in' => 'query', 'schema' => ['description' => 'The field by which to sort the results. Default value: updatedTime.', 'type' => 'string', 'required' => false, 'example' => 'updatedTime', 'title' => ''], ], [ 'name' => 'SearchPattern', 'in' => 'query', 'schema' => ['description' => 'A keyword to search for in the names or descriptions of IVR flows.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response object.', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], 'Data' => [ 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'List' => [ 'description' => 'A list of contact flows.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The type of the IVR contact flow.', 'enumValueTitles' => ['SURVEY_FLOW' => 'A satisfaction survey flow.', 'SUB_FLOW' => 'A subflow.', 'MAIN_FLOW' => 'A main flow.'], 'type' => 'string', 'example' => 'MAIN_FLOW', 'title' => '', ], 'Definition' => ['description' => 'The JSON-formatted definition of the IVR contact flow. This parameter is for internal use and is parsed by the backend.', 'type' => 'string', 'example' => '{"activities":[{"type":"INCOMING_CALL","id":"e98f0d47","name":"开始","properties":{"position":{"x":263,"y":164}},"events":[{"event":"complete","next":"2d3ad2c2","edgeId":"41f7dbd0"}],"nodeIndex":0},{"type":"HANGUP","id":"bd4f37e2","name":"挂机","properties":{"position":{"x":765,"y":185}},"events":[{"event":"complete","next":null}],"nodeIndex":999},{"type":"PLAY_SAY","id":"2d3ad2c2","name":"放音","properties":{"say":"您好，欢迎来到云联络中心。","audioResourceId":"","position":{"x":485.5,"y":153.5},"audioType":"tts","audioInterrupt":false},"events":[{"event":"complete","next":"bd4f37e2","edgeId":"e1af4f1f"}],"nodeIndex":1}],"description":""}', 'title' => ''], 'DraftId' => ['description' => 'The draft ID. This parameter is returned only when the contact flow is unpublished.', 'type' => 'string', 'example' => 'db07c0bb-6b1f-47d2-b37e-2451c617562d', 'title' => ''], 'Description' => ['description' => 'The description of the contact flow version.', 'type' => 'string', 'example' => '1.0', 'title' => ''], 'UpdatedTime' => ['description' => 'The last time the contact flow was updated.', 'type' => 'string', 'example' => '2021-03-08 15:34:49.0', 'title' => ''], 'Editor' => ['description' => 'The login name of the agent currently editing this draft.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'Published' => ['description' => 'Indicates whether the contact flow has been published.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'Name' => ['description' => 'The name of the IVR contact flow.', 'type' => 'string', 'example' => '默认流程', 'title' => ''], 'ContactFlowId' => ['description' => 'The ID of the IVR contact flow.', 'type' => 'string', 'example' => '78128960-bb00-4ddc-8e82-923a8c5bd22d', 'title' => ''], 'CreatedTime' => ['description' => 'When the contact flow was created.', 'type' => 'string', 'example' => '2021-03-05 17:35:45.0', 'title' => ''], 'NumberList' => [ 'description' => 'A list of phone numbers that are bound to the IVR contact flow.', 'type' => 'array', 'items' => ['description' => 'A phone number.', 'type' => 'string', 'example' => '400289****', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Retrieve contact flow list ', 'summary' => 'Call ListContactFlows to retrieve the IVR contact flows for a specified instance.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2025-06-18T03:18:59.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-11-06T05:44:49.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListContactFlows'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"List\\": [\\n {\\n \\"Type\\": \\"MAIN_FLOW\\",\\n \\"Definition\\": \\"{\\\\\\"activities\\\\\\":[{\\\\\\"type\\\\\\":\\\\\\"INCOMING_CALL\\\\\\",\\\\\\"id\\\\\\":\\\\\\"e98f0d47\\\\\\",\\\\\\"name\\\\\\":\\\\\\"开始\\\\\\",\\\\\\"properties\\\\\\":{\\\\\\"position\\\\\\":{\\\\\\"x\\\\\\":263,\\\\\\"y\\\\\\":164}},\\\\\\"events\\\\\\":[{\\\\\\"event\\\\\\":\\\\\\"complete\\\\\\",\\\\\\"next\\\\\\":\\\\\\"2d3ad2c2\\\\\\",\\\\\\"edgeId\\\\\\":\\\\\\"41f7dbd0\\\\\\"}],\\\\\\"nodeIndex\\\\\\":0},{\\\\\\"type\\\\\\":\\\\\\"HANGUP\\\\\\",\\\\\\"id\\\\\\":\\\\\\"bd4f37e2\\\\\\",\\\\\\"name\\\\\\":\\\\\\"挂机\\\\\\",\\\\\\"properties\\\\\\":{\\\\\\"position\\\\\\":{\\\\\\"x\\\\\\":765,\\\\\\"y\\\\\\":185}},\\\\\\"events\\\\\\":[{\\\\\\"event\\\\\\":\\\\\\"complete\\\\\\",\\\\\\"next\\\\\\":null}],\\\\\\"nodeIndex\\\\\\":999},{\\\\\\"type\\\\\\":\\\\\\"PLAY_SAY\\\\\\",\\\\\\"id\\\\\\":\\\\\\"2d3ad2c2\\\\\\",\\\\\\"name\\\\\\":\\\\\\"放音\\\\\\",\\\\\\"properties\\\\\\":{\\\\\\"say\\\\\\":\\\\\\"您好，欢迎来到云联络中心。\\\\\\",\\\\\\"audioResourceId\\\\\\":\\\\\\"\\\\\\",\\\\\\"position\\\\\\":{\\\\\\"x\\\\\\":485.5,\\\\\\"y\\\\\\":153.5},\\\\\\"audioType\\\\\\":\\\\\\"tts\\\\\\",\\\\\\"audioInterrupt\\\\\\":false},\\\\\\"events\\\\\\":[{\\\\\\"event\\\\\\":\\\\\\"complete\\\\\\",\\\\\\"next\\\\\\":\\\\\\"bd4f37e2\\\\\\",\\\\\\"edgeId\\\\\\":\\\\\\"e1af4f1f\\\\\\"}],\\\\\\"nodeIndex\\\\\\":1}],\\\\\\"description\\\\\\":\\\\\\"\\\\\\"}\\",\\n \\"DraftId\\": \\"db07c0bb-6b1f-47d2-b37e-2451c617562d\\",\\n \\"Description\\": \\"1.0\\",\\n \\"UpdatedTime\\": \\"2021-03-08 15:34:49.0\\",\\n \\"Editor\\": \\"ccc-test\\",\\n \\"Published\\": true,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Name\\": \\"默认流程\\",\\n \\"ContactFlowId\\": \\"78128960-bb00-4ddc-8e82-923a8c5bd22d\\",\\n \\"CreatedTime\\": \\"2021-03-05 17:35:45.0\\",\\n \\"NumberList\\": [\\n \\"400289****\\"\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'ListCustomCallTagging' => [ 'summary' => 'You can invoke ListCustomCallTagging to obtain the list of inbound number marks under a specified instance.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => true, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc1MRAID'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'Page number, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'Page size, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''], ], [ 'name' => 'SearchPattern', 'in' => 'query', 'schema' => ['description' => 'Perform fuzzy matching based on number or description. This parameter is optional and defaults to empty. An empty value indicates no filtering.', 'type' => 'string', 'docRequired' => false, 'required' => false, 'example' => '1312121****', 'title' => ''], ], [ 'name' => 'CallTagNameList', 'in' => 'query', 'schema' => ['description' => 'Filter by a list of number tag names. This parameter is optional and defaults to empty, which means no filtering is applied. The format is a JSON array string, where each array element is a number tag name.', 'type' => 'string', 'docRequired' => false, 'required' => false, 'example' => '["TagA"]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Data' => [ 'description' => 'The data.', 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'The page number, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The page size, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'TotalCount' => ['description' => 'The total count.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'List' => [ 'description' => 'The list of inbound number marks.', 'type' => 'array', 'items' => [ 'description' => 'The inbound number mark information.', 'type' => 'object', 'properties' => [ 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'Number' => ['description' => 'The number of the inbound number mark.', 'type' => 'string', 'example' => '1312121****', 'title' => ''], 'Description' => ['description' => 'The description of the inbound number mark.', 'type' => 'string', 'example' => '王先生', 'title' => ''], 'Creator' => ['description' => 'Creator.', 'type' => 'string', 'example' => 'agent', 'title' => ''], 'UpdateTime' => ['description' => 'Last update time.', 'type' => 'string', 'example' => '2020-07-05 00:00:00.0', 'title' => ''], 'CallTagList' => [ 'description' => 'List of number tags.', 'type' => 'array', 'items' => [ 'description' => 'Number tag information.', 'type' => 'object', 'properties' => [ 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'TagName' => ['description' => 'Number tag name.', 'type' => 'string', 'example' => 'TagA', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => ''], ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.DB', 'errorMessage' => 'An internal DB service error occurred. %s', 'description' => ''], ], ], 'staticInfo' => [ 'substitutions' => ['CCC::2020-07-01::ListCustomCallTaggings'], ], 'title' => 'Obtain the list of inbound number tags ', 'changeSet' => [ ['createdAt' => '2024-01-29T09:14:13.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-02-24T14:31:19.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCustomCallTagging'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Number\\": \\"1312121****\\",\\n \\"Description\\": \\"王先生\\",\\n \\"Creator\\": \\"agent\\",\\n \\"UpdateTime\\": \\"2020-07-05 00:00:00.0\\",\\n \\"CallTagList\\": [\\n {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"TagName\\": \\"TagA\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'ListDevices' => [ 'summary' => 'Obtain the device list of a specified agent under a specified instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'Agent ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], 'Params' => [ 'description' => 'List of response parameters.', 'type' => 'array', 'items' => ['description' => 'Response parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], 'Data' => [ 'description' => 'Device list.', 'type' => 'array', 'items' => [ 'description' => 'Device information.', 'type' => 'object', 'properties' => [ 'Extension' => ['description' => 'Agent extension number.', 'type' => 'string', 'example' => '8032****', 'title' => ''], 'Expires' => ['description' => 'Device registration expiration time, in UNIX timestamp format with millisecond precision. If the device does not re-register after expiration, it will go offline.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609118499750', 'title' => ''], 'Contact' => ['description' => 'Device address information.', 'type' => 'string', 'example' => 'sip:8032****@33.89.XX.XX:64189;transport=tcp;registering_acc=18_134_23_4', 'title' => ''], 'DeviceId' => ['description' => 'Device ID, which is the identity ID of a browser Web Real-Time Communication (WebRTC) softphone or a physical phone device. Only one type of device can be registered at a time.', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****', 'title' => ''], 'UserId' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'CallId' => ['description' => 'Call ID from the registration signaling initiated by the device.', 'type' => 'string', 'example' => 'd7b818c3-8d3a-732f-bc9e-1782wa16****', 'title' => ''], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'DeviceType' => ['description' => 'Device type.', 'type' => 'string', 'example' => 'CHAT', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ], 403 => [ ['errorCode' => 'Permission.User', 'errorMessage' => 'You have no permission to access user(s) %s.', 'description' => ''], ], [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Retrieve device list', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-11-06T05:44:49.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDevices'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": [\\n {\\n \\"Extension\\": \\"8032****\\",\\n \\"Expires\\": 1609118499750,\\n \\"Contact\\": \\"sip:8032****@33.89.XX.XX:64189;transport=tcp;registering_acc=18_134_23_4\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"CallId\\": \\"d7b818c3-8d3a-732f-bc9e-1782wa16****\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"DeviceType\\": \\"CHAT\\"\\n }\\n ]\\n}","type":"json"}]', ], 'ListDoNotCallNumbers' => [ 'summary' => 'Retrieves the list of prohibited outbound call numbers under a specified instance, filtered by specified search conditions. ', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'SearchPattern', 'in' => 'query', 'schema' => ['description' => 'Fuzzy matching based on phone number or remark. This parameter is optional, with a default value of empty, meaning no filtering is applied when empty. ', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'RemarkA', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'Page number, ranging from 1 to 100. ', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'Page size, ranging from 1 to 100. ', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''], ], [ 'name' => 'Scope', 'in' => 'query', 'schema' => [ 'enumValueTitles' => ['SYSTEM' => 'System-level Do Not Call configuration ', 'INSTANCE' => 'Instance-level Do Not Call configuration '], 'description' => 'Scope of application, including SYSTEM and INSTANCE. SYSTEM corresponds to system-level Do Not Call configurations associated with the Alibaba Cloud account to which the instance belongs. INSTANCE corresponds to custom Do Not Call configurations specific to the current instance. This parameter is optional, with a default value of INSTANCE. ', 'type' => 'string', 'required' => false, 'example' => 'INSTANCE', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code. ', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code. ', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message. ', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID. ', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', 'title' => ''], 'Data' => [ 'description' => 'Data. ', 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'Page number, ranging from 1 to 100. ', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'Page size, ranging from 1 to 100. ', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'TotalCount' => ['description' => 'Total count. ', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'List' => [ 'description' => 'List of prohibited outbound call numbers. ', 'type' => 'array', 'items' => [ 'description' => 'Information about a prohibited outbound call number. ', 'type' => 'object', 'properties' => [ 'Number' => ['description' => 'Phone number. ', 'type' => 'string', 'example' => '1900000****', 'title' => ''], 'Scope' => [ 'enumValueTitles' => ['SYSTEM' => 'System-level Do Not Call configuration ', 'INSTANCE' => 'Instance-level Do Not Call configuration '], 'description' => 'Scope of application. ', 'type' => 'string', 'example' => 'INSTANCE', 'title' => '', ], 'Remark' => ['description' => 'Remark. ', 'type' => 'string', 'example' => '测试', 'title' => ''], 'CreateTime' => ['description' => 'Creation time of the Do Not Call number configuration, in Unix timestamp format with millisecond precision. (Deprecated) ', 'type' => 'integer', 'format' => 'int64', 'example' => '1626962425000', 'title' => ''], 'Creator' => ['description' => 'Creator, which is the agent logon name of the agent who created this record. ', 'type' => 'string', 'example' => 'agent', 'title' => ''], 'CreatedTime' => ['description' => 'Creation time of the prohibited outbound call number configuration, in Unix timestamp format, in milliseconds. ', 'type' => 'integer', 'format' => 'int64', 'example' => '1631440860000', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'Params' => [ 'description' => 'List of response parameters. ', 'type' => 'array', 'items' => ['description' => 'Response parameter. ', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => ''], ['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => ''], ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"List\\": [\\n {\\n \\"Number\\": \\"1900000****\\",\\n \\"Scope\\": \\"INSTANCE\\",\\n \\"Remark\\": \\"测试\\",\\n \\"CreateTime\\": 1626962425000,\\n \\"Creator\\": \\"agent\\",\\n \\"CreatedTime\\": 1631440860000\\n }\\n ]\\n },\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', 'title' => 'Retrieve the Do Not Call number list ', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2022-02-24T13:00:36.000Z', 'description' => 'OpenAPI offline'], ], 'ramActions' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDoNotCallNumbers'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], ], 'ListDocuments' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'parameters' => [ [ 'name' => 'SchemaId', 'in' => 'formData', 'schema' => ['description' => 'The schema ID.', 'type' => 'string', 'required' => true, 'example' => 'profile', 'title' => ''], ], [ 'name' => 'SearchPattern', 'in' => 'formData', 'schema' => ['description' => 'The search conditional expression.', 'type' => 'string', 'required' => false, 'example' => '支持Lucene搜索语法', 'title' => ''], ], [ 'name' => 'Sorts', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'The custom sorting value.', 'type' => 'array', 'items' => [ 'description' => 'The custom sorting value.', 'type' => 'object', 'properties' => [ 'PropertyName' => ['description' => 'The field name.', 'type' => 'string', 'required' => false, 'example' => 'name', 'title' => ''], 'Order' => ['description' => 'The sorting order. Valid values:'."\n" ."\n" .'- ASC (default): ascending order.'."\n" ."\n" .'- DESC: descending order.', 'type' => 'string', 'required' => false, 'example' => 'desc', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'NextPageToken', 'in' => 'formData', 'schema' => ['description' => 'The token for the next page of results.', 'type' => 'string', 'required' => false, 'example' => 'eyJ0YWJsZUlkIjoiY2Y2MTQxYjA5NDY0NDUxMzk5YjFjMTA5YTMxZWNkMzEiLCJ0b2tlbiI6IjAwMDAwMDAwMDAwNzAzNzcifQ==', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''], ], [ 'name' => 'RequestId', 'in' => 'formData', 'schema' => ['description' => 'The request ID.', 'type' => 'string', 'required' => false, 'example' => 'EAF3C248-E123-441B-A545-B6CD02E98EED', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'd278629c-c687-4aa3-b044-4fe9b012e7ef', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'ListDocumentsResponse', 'title' => 'ListDocumentsResponse ', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The data.', 'type' => 'object', 'properties' => [ 'Schema' => [ 'description' => 'The schema.', 'type' => 'object', 'properties' => [ 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => '87b12784-8ce2-40b6-b21f-c49cb3b5501e', 'title' => ''], 'Id' => ['description' => 'The schema ID.', 'type' => 'string', 'example' => 'profile', 'title' => ''], 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => '-', 'title' => ''], 'Properties' => [ 'description' => 'The list of fields.', 'additionalProperties' => [ 'description' => 'The field.', 'type' => 'object', 'properties' => [ 'DisplayName' => ['description' => 'The display name of the field.', 'type' => 'string', 'example' => 'name', 'title' => ''], 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => '-', 'title' => ''], 'Name' => ['description' => 'The name.', 'type' => 'string', 'example' => 'name', 'title' => ''], 'DataType' => ['description' => 'The data type.', 'type' => 'string', 'example' => 'string', 'title' => ''], 'Pattern' => ['description' => 'The regular expression.', 'type' => 'string', 'example' => '*', 'title' => ''], 'PatternErrorMessage' => ['description' => 'The error message for the regular expression.', 'type' => 'string', 'example' => '格式错误', 'title' => ''], 'MinLength' => ['description' => 'The minimum length.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'MaxLength' => ['description' => 'The maximum length.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Minimum' => ['description' => 'The minimum value.', 'type' => 'number', 'format' => 'double', 'example' => '1', 'title' => ''], 'Maximum' => ['description' => 'The maximum value.', 'type' => 'number', 'format' => 'double', 'example' => '1', 'title' => ''], 'Required' => ['description' => 'Indicates whether the field is required.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'System' => ['description' => 'Indicates whether the field is a system field.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Disabled' => ['description' => 'Indicates whether the field is disabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Array' => ['description' => 'Indicates whether the field is an array.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'ReadOnly' => ['description' => 'Indicates whether the field is read-only.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'EditorType' => ['description' => 'The editor type.', 'type' => 'string', 'example' => 'textbox', 'title' => ''], 'Attributes' => ['description' => 'The extended properties.', 'type' => 'string', 'example' => '{}', 'title' => ''], 'DisplayOrder' => ['description' => 'The display order.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'CreatedTime' => ['description' => 'The time when the field was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '2020-10-14T09:53:53Z', 'title' => ''], 'UpdatedTime' => ['description' => 'The time when the field was last updated.', 'type' => 'integer', 'format' => 'int64', 'example' => '2020-10-14T09:53:53Z', 'title' => ''], 'Creator' => ['description' => 'The creator.', 'type' => 'string', 'example' => 'tom', 'title' => ''], ], 'title' => '', 'example' => '', ], 'type' => 'object', 'title' => '', 'example' => '', ], 'CreatedTime' => ['description' => 'The time when the schema was created.', 'type' => 'string', 'example' => '2020-10-14T09:53:53Z', 'title' => ''], 'UpdatedTime' => ['description' => 'The time when the schema was last updated.', 'type' => 'string', 'example' => '2020-10-14T09:53:53Z'."\n", 'title' => ''], 'Deleted' => ['description' => 'Indicates whether the schema is deleted.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Documents' => [ 'description' => 'The list of documents.', 'type' => 'array', 'items' => ['description' => 'The document content.', 'type' => 'object', 'example' => '{}', 'title' => ''], 'title' => '', 'example' => '', ], 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'NextPageToken' => ['description' => 'The token for the next page of results.', 'type' => 'string', 'example' => '54d1a616d95a4a01ba58967a9115b649', 'title' => ''], ], 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7BEEA660-A45A-45E3-98CC-AFC65E715C23', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Params' => [ 'description' => 'The response parameters.', 'type' => 'array', 'items' => ['description' => 'The response parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Schema\\": {\\n \\"InstanceId\\": \\"87b12784-8ce2-40b6-b21f-c49cb3b5501e\\",\\n \\"Id\\": \\"profile\\",\\n \\"Description\\": \\"-\\",\\n \\"Properties\\": {\\n \\"key\\": {\\n \\"DisplayName\\": \\"name\\",\\n \\"Description\\": \\"-\\",\\n \\"Name\\": \\"name\\",\\n \\"DataType\\": \\"string\\",\\n \\"Pattern\\": \\"*\\",\\n \\"PatternErrorMessage\\": \\"格式错误\\",\\n \\"MinLength\\": 1,\\n \\"MaxLength\\": 1,\\n \\"Minimum\\": 1,\\n \\"Maximum\\": 1,\\n \\"Required\\": false,\\n \\"System\\": false,\\n \\"Disabled\\": false,\\n \\"Array\\": false,\\n \\"ReadOnly\\": false,\\n \\"EditorType\\": \\"textbox\\",\\n \\"Attributes\\": \\"{}\\",\\n \\"DisplayOrder\\": 1,\\n \\"CreatedTime\\": 0,\\n \\"UpdatedTime\\": 0,\\n \\"Creator\\": \\"tom\\"\\n }\\n },\\n \\"CreatedTime\\": \\"2020-10-14T09:53:53Z\\",\\n \\"UpdatedTime\\": \\"2020-10-14T09:53:53Z\\\\n\\",\\n \\"Deleted\\": false\\n },\\n \\"Documents\\": [\\n {}\\n ],\\n \\"TotalCount\\": 1,\\n \\"NextPageToken\\": \\"54d1a616d95a4a01ba58967a9115b649\\"\\n },\\n \\"RequestId\\": \\"7BEEA660-A45A-45E3-98CC-AFC65E715C23\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', 'title' => 'Retrieve document list', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'summary' => '', ], 'ListFeedbacks' => [ 'summary' => 'Queries feedback records.', 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the CCC instance.', 'type' => 'string', 'required' => false, 'example' => 'ccc-test'."\n", 'title' => ''], ], [ 'name' => 'TaskIdList', 'in' => 'query', 'schema' => ['description' => 'A list of task IDs.', 'type' => 'string', 'required' => false, 'example' => '["20251216-8B9B7B02-16FE-54BE-942A-F59DE0656032"]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '26E54929-CA86-1035-9B42-0C8F291BB027'], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Data' => [ 'description' => 'The returned dataset.', 'type' => 'array', 'items' => [ 'description' => 'A returned data element.', 'type' => 'object', 'properties' => [ 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '20251216-8B9B7B02-16FE-54BE-942A-F59DE0656032', 'title' => ''], 'TaskName' => ['description' => 'The task name.', 'type' => 'string', 'example' => 'PostCallAnalyzer:solution', 'title' => ''], 'UserResponse' => ['description' => 'The data from user feedback.', 'type' => 'string', 'example' => 'xxxxxxx', 'title' => ''], 'UserRating' => ['description' => 'The user\'s rating for the task.', 'type' => 'integer', 'format' => 'int32', 'example' => '-1', 'title' => ''], 'ContactId' => ['description' => 'The call ID.', 'type' => 'string', 'example' => 'job-25920271311543****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExist.Instance', 'errorMessage' => 'Call center instance %s does not exist.', 'description' => 'The cloud contact center instance% s does not exist.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"26E54929-CA86-1035-9B42-0C8F291BB027\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": [\\n {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"TaskId\\": \\"20251216-8B9B7B02-16FE-54BE-942A-F59DE0656032\\",\\n \\"TaskName\\": \\"PostCallAnalyzer:solution\\",\\n \\"UserResponse\\": \\"xxxxxxx\\",\\n \\"UserRating\\": -1,\\n \\"ContactId\\": \\"job-25920271311543****\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'Query feedback records ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'ListFlashSmsApplications' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ 'name' => 'ProviderId', 'in' => 'query', 'schema' => ['description' => 'Flash SMS provider ID.', 'type' => 'string', 'required' => false, 'example' => 'Uincall', 'title' => ''], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'Flash SMS configuration name.', 'type' => 'string', 'required' => false, 'example' => '闪信', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'Page number. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'Page size. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Cloud Contact Center instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ccc-test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'ListFlashSmsApplicationResponse', 'title' => 'ListFlashSmsMetadataResponse ', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'TotalCount' => ['description' => 'Total count.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageNumber' => ['description' => 'Page number. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'Page size. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'List' => [ 'description' => 'List of flash SMS configurations.', 'type' => 'array', 'items' => [ 'description' => 'Flash SMS configuration.', 'type' => 'object', 'properties' => [ 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'ProviderId' => ['description' => 'Flash SMS provider ID.', 'type' => 'string', 'example' => 'Uincall', 'title' => ''], 'ApplicationId' => ['description' => 'Registration ID.', 'type' => 'string', 'example' => '71b396fa-***********-bd80e070b7c0', 'title' => ''], 'Name' => ['description' => 'Configuration name.', 'type' => 'string', 'example' => '闪信配置', 'title' => ''], 'Value' => ['description' => 'Configuration content.', 'type' => 'string', 'example' => '{"user":"600******_dev","pwd":"85abf3**********f494e","account":"6004******"}', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '7BEEA660-A45A-45E3-98CC-AFC65E715C23', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Params' => [ 'description' => 'List of error parameters.', 'type' => 'array', 'items' => ['description' => 'Error parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"List\\": [\\n {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"ProviderId\\": \\"Uincall\\",\\n \\"ApplicationId\\": \\"71b396fa-***********-bd80e070b7c0\\",\\n \\"Name\\": \\"闪信配置\\",\\n \\"Value\\": \\"{\\\\\\"user\\\\\\":\\\\\\"600******_dev\\\\\\",\\\\\\"pwd\\\\\\":\\\\\\"85abf3**********f494e\\\\\\",\\\\\\"account\\\\\\":\\\\\\"6004******\\\\\\"}\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"7BEEA660-A45A-45E3-98CC-AFC65E715C23\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', 'title' => 'Obtain flash message Configuration Information', 'summary' => 'You can use ListFlashSmsApplication to obtain third-party flash SMS configuration information.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'ListFlashSmsSettings' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'SkillGroupName', 'in' => 'query', 'schema' => ['description' => 'The name of the skill group.', 'type' => 'string', 'required' => false, 'example' => '闪信测试技能组', 'title' => ''], ], [ 'name' => 'SkillGroupIdList', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'A list of skill group IDs.', 'type' => 'array', 'items' => ['description' => 'A list of skill group IDs.', 'type' => 'string', 'required' => false, 'example' => '["skillgroup1@ccc-test"]', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. The value ranges from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. The value ranges from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the CC instance.', 'type' => 'string', 'required' => true, 'example' => 'ccc-test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'ListFlashSmsSettingsResponse', 'title' => 'ListFlashSmsSettingsResponse ', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The data.', 'type' => 'object', 'properties' => [ 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'List' => [ 'description' => 'A list of configurations.', 'type' => 'array', 'items' => [ 'description' => 'The configuration.', 'type' => 'object', 'properties' => [ 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'SkillGroupId' => ['description' => 'The skill group ID.', 'type' => 'string', 'example' => 'skillgroup1@ccc-test', 'title' => ''], 'Enabled' => ['description' => 'Indicates whether flash SMS is enabled for the skill group.'."\n" ."\n" .'- **true**: enabled.'."\n" ."\n" .'- **false**: disabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'SkillGroupName' => ['description' => 'The name of the skill group.', 'type' => 'string', 'example' => '闪信测试技能组', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Params' => [ 'description' => 'A list of incorrect parameters.', 'type' => 'array', 'items' => ['description' => 'The incorrect parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"List\\": [\\n {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"SkillGroupId\\": \\"skillgroup1@ccc-test\\",\\n \\"Enabled\\": true,\\n \\"SkillGroupName\\": \\"闪信测试技能组\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', 'title' => 'Obtain the flash SMS skill group configuration', 'summary' => 'Call the ListFlashSmsSettings operation to retrieve the flash SMS configurations for a specified skill group.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'ListFlashSmsTemplates' => [ 'summary' => 'Use ListFlashSmsTemplates to retrieve flash SMS template information.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccIPHVDY'], ], 'parameters' => [ [ 'name' => 'ProviderId', 'in' => 'query', 'schema' => ['description' => 'Flash SMS provider ID.', 'type' => 'string', 'required' => false, 'example' => 'Uincall', 'title' => ''], ], [ 'name' => 'ApplicationId', 'in' => 'query', 'schema' => ['description' => 'Flash SMS configuration ID.', 'type' => 'string', 'required' => false, 'example' => '71b396fa-1*********-70b7c0', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ccc-test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'ListFlashSmsTemplatesResponse', 'title' => 'ListFlashSmsTemplatesResponse ', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'Data.', 'type' => 'array', 'items' => [ 'description' => 'Flash SMS template.', 'type' => 'object', 'properties' => [ 'TemplateId' => ['description' => 'Template ID.', 'type' => 'string', 'example' => '1715*****38', 'title' => ''], 'TemplateName' => ['description' => 'Template name.', 'type' => 'string', 'example' => '测试模板', 'title' => ''], 'TemplateDetails' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '7BEEA660-A45A-45E3-98CC-AFC65E715C23', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Params' => [ 'description' => 'List of error parameters.', 'type' => 'array', 'items' => ['description' => 'Error parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"TemplateId\\": \\"1715*****38\\",\\n \\"TemplateName\\": \\"测试模板\\",\\n \\"TemplateDetails\\": \\"\\"\\n }\\n ],\\n \\"RequestId\\": \\"7BEEA660-A45A-45E3-98CC-AFC65E715C23\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', 'title' => 'Obtain flash SMS template information ', 'changeSet' => [ ['createdAt' => '2025-07-02T08:46:22.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'ListGroupChatMessages' => [ 'summary' => 'Retrieves the records of group chat messages.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'Call ID.', 'type' => 'string', 'required' => false, 'example' => 'chat-65382141036853491', 'title' => ''], ], [ 'name' => 'SortOrder', 'in' => 'query', 'schema' => ['description' => 'Sorting order. Default is descending.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'ASC: ascending.'."\n" ."\n" .'DESC: descending.', 'type' => 'string', 'required' => false, 'example' => 'DESC', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Cloud Contact Center instance.', 'type' => 'string', 'required' => false, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'Page size. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'NextPageToken', 'in' => 'query', 'schema' => ['description' => 'Token for the next page. This is a 32-character UUID. Leave this parameter empty when requesting the first page. For subsequent pages, use the NextPageToken value from the previous response.', 'type' => 'string', 'required' => false, 'example' => 'b2ad450b116e4f8396e58108acf5c020', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Response schema.', 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => '2263B273-AC1B-44EB-BA98-87F2322C6780'], 'HttpStatusCode' => ['description' => 'HTTP status code returned in the response. A value of 200 indicates a successful request.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'Messages' => [ 'description' => 'Message list.', 'type' => 'array', 'items' => [ 'description' => 'Message body.', 'type' => 'object', 'properties' => [ 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'chat-65382141036853491', 'title' => ''], 'SenderId' => ['description' => 'User ID of the message sender.', 'type' => 'string', 'example' => '64bb4ececc34fc5ec1ca1153', 'title' => ''], 'SenderType' => ['description' => 'Sender type.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- **ADMIN**: system'."\n" ."\n" .'- **CUSTOMER**: visitor'."\n" ."\n" .'- **AGENT**: agent', 'type' => 'string', 'example' => 'CUSTOMER', 'title' => ''], 'Timestamp' => ['description' => 'Message timestamp, in Unix timestamp format, measured in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1696126980371', 'title' => ''], 'Content' => ['description' => 'Message content.', 'type' => 'string', 'example' => '{"variables":{},"text":"

好的，不客气

","contentType":"Text","subContentType":"richtext"}', 'title' => ''], 'SenderName' => ['description' => 'Sender name.', 'type' => 'string', 'example' => 'test-agent@test-instanceId', 'title' => ''], 'SenderAvatarUrl' => ['description' => 'Sender profile picture URL.', 'type' => 'string', 'example' => 'http://xxxxx.com', 'title' => ''], 'Recalled' => ['description' => 'Indicates whether the message was revoked.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'NextPageToken' => ['description' => 'Token for the next page.', 'type' => 'string', 'example' => '54d1a616d95a4a01ba58967a9115b649', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'Permission.Unauthorized', 'errorMessage' => 'You are not authorized to perform this action. %s privileges are required.', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2263B273-AC1B-44EB-BA98-87F2322C6780\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Messages\\": [\\n {\\n \\"JobId\\": \\"chat-65382141036853491\\",\\n \\"SenderId\\": \\"64bb4ececc34fc5ec1ca1153\\",\\n \\"SenderType\\": \\"CUSTOMER\\",\\n \\"Timestamp\\": 1696126980371,\\n \\"Content\\": \\"{\\\\\\"variables\\\\\\":{},\\\\\\"text\\\\\\":\\\\\\"

好的，不客气

\\\\\\",\\\\\\"contentType\\\\\\":\\\\\\"Text\\\\\\",\\\\\\"subContentType\\\\\\":\\\\\\"richtext\\\\\\"}\\",\\n \\"SenderName\\": \\"test-agent@test-instanceId\\",\\n \\"SenderAvatarUrl\\": \\"http://xxxxx.com\\",\\n \\"Recalled\\": false\\n }\\n ],\\n \\"NextPageToken\\": \\"54d1a616d95a4a01ba58967a9115b649\\"\\n }\\n}","type":"json"}]', 'title' => 'Query message list', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'ListHistoricalAgentReport' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'Page number, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'Page size, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '100', 'title' => ''], ], [ 'name' => 'AgentIdList', 'in' => 'formData', 'schema' => ['description' => 'List of agent IDs, containing 0 to 100 entries.'."\n" ."\n" .'> If the agent ID list is not empty, the query is performed directly based on the provided agent ID list. In this case, the pageSize and pageNumber parameters are invalid, and the data is returned directly. For example, if the request parameter is pageNumber = 3, then the response parameter will also be pageNumber = 3.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '["agent1@ccc-test", "agent2@ccc-test"]', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'Start time of the historical data to retrieve. The default value is 00:00 of the current day. The earliest allowed time is 180 days before the current time. Time is rounded down to the nearest hour for statistical purposes, using a closed interval. The format is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1532448000000', 'title' => ''], ], [ 'name' => 'StopTime', 'in' => 'query', 'schema' => ['description' => 'End Time of the Historical Data to retrieve. The default value is the current time. The time precision for statistics is in hours, snapped backward to the nearest hour, forming an open interval. For example, if the Start Time is 11:12:20 and the End Time is 11:45:50, the snapped input parameter Time Range becomes \\[11:00:00, 12:00:00), meaning greater than or equal to 11:00:00 and less than 12:00:00. The format is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1532707199000', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'MediaType', 'in' => 'query', 'schema' => ['description' => 'Media type. The default value is Audio. Other valid values include Chat and Video.', 'type' => 'string', 'required' => false, 'example' => 'VIDEO', 'title' => ''], ], [ 'name' => 'SkillGroupId', 'in' => 'query', 'schema' => ['description' => 'Skill group ID.', 'type' => 'string', 'required' => false, 'example' => 'wwtest@test_yunhu', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'Page number, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'Page size, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'TotalCount' => ['description' => 'Total count.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'List' => [ 'description' => 'List of agent historical data.', 'type' => 'array', 'items' => [ 'description' => 'Agent historical data.', 'type' => 'object', 'properties' => [ 'AgentName' => ['description' => 'Agent name.', 'type' => 'string', 'example' => '坐席小王', 'title' => ''], 'AgentId' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => 'agent1@ccc-test', 'title' => ''], 'DisplayId' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => '001', 'title' => ''], 'Inbound' => [ 'description' => 'Inbound data.', 'type' => 'object', 'properties' => [ 'AverageRingTime' => ['description' => 'Average ring time. Calculation Formula: TotalRingTime / CallsRinged. Unit: seconds.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'CallsHandled' => ['description' => 'Acknowledgement count, which is the number of times agents answered calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalWorkTime' => ['description' => 'Total post-processing time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsAttendedTransferOut' => ['description' => 'Attended transfer-out count. If a single call is transferred out to other agents multiple times, each transfer-out is counted once.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxWorkTime' => ['description' => 'Maximum post-processing duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalHoldTime' => ['description' => 'Total hold time during calls, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageWorkTime' => ['description' => 'Average post-processing time. Calculation Formula: TotalWorkTime / CallsHandled. Unit: seconds.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'CallsBlindTransferIn' => ['description' => 'Number of blind transfer-in calls. If a single call is transferred in to this agent multiple times, each transfer counts as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionIndex' => ['description' => 'The satisfaction index, which is the average value of the single-digit satisfaction rating entered by customers.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'CallsRinged' => ['description' => 'The number of calls that rang for the agent.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsAttendedTransferIn' => ['description' => 'Number of attended transfer-in calls. If a single call is transferred to the agent multiple times, each transfer counts as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsBlindTransferOut' => ['description' => 'Number of blind transfer-out calls. If a single call is transferred out to other agents multiple times, each transfer counts as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalRingTime' => ['description' => 'The total ring duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxTalkTime' => ['description' => 'Maximum talk time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxRingTime' => ['description' => 'The maximum ring duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalTalkTime' => ['description' => 'Total talk time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsOffered' => ['description' => 'The assignment count, which refers to the number of calls assigned to this agent, including calls blindly transferred or consultation-transferred from other agents.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxHoldTime' => ['description' => 'Maximum hold time during calls, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageTalkTime' => ['description' => 'Average talk time, calculated using the formula: TotalTalkTime / CallsHandled, in seconds.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'SatisfactionRate' => ['description' => 'Satisfaction rate. Calculation Formula: Number of evaluations marked as satisfied / Count of satisfaction survey responses.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'CallsHold' => ['description' => 'The hold count, which refers to the number of times call hold occurred.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionSurveysOffered' => ['description' => 'Sending Count of satisfaction surveys.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'HandleRate' => ['description' => 'Acknowledgement rate. Calculation Formula: CallsHandled / CallsOffered (because acknowledgement events and assign events may fall into different time ranges, the result may exceed 100% in certain cases).', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'SatisfactionSurveysResponded' => ['description' => 'Response Count of satisfaction surveys.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageHoldTime' => ['description' => 'The average call hold duration, calculated using the formula: TotalHoldTime / CallsHold, in seconds.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'AccessChannelTypeDetails' => [ 'description' => 'Statistics for each Channel.', 'type' => 'array', 'items' => [ 'description' => 'Statistics for the channel.', 'type' => 'object', 'properties' => [ 'AccessChannelType' => ['description' => 'Channel Type.', 'type' => 'string', 'example' => 'Web', 'title' => ''], 'CallsOffered' => ['description' => 'Number of assigned sessions.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'AverageFirstResponseTime' => ['description' => 'Average first response time for chat sessions, in seconds.', 'type' => 'number', 'format' => 'float', 'example' => '10', 'title' => ''], 'AverageResponseTime' => ['description' => 'Average response time of chat sessions.', 'type' => 'number', 'format' => 'float', 'example' => '12', 'title' => ''], 'ServiceLevel15' => ['description' => 'Service level within 15 seconds.', 'type' => 'number', 'format' => 'float', 'example' => '0.85', 'title' => ''], 'TotalMessagesSent' => ['description' => 'Total number of messages sent in chat sessions.', 'type' => 'integer', 'format' => 'int64', 'example' => '16', 'title' => ''], 'TotalMessagesSentByAgent' => ['description' => 'The total number of messages sent by the agent in chat sessions.', 'type' => 'integer', 'format' => 'int64', 'example' => '7', 'title' => ''], 'TotalMessagesSentByCustomer' => ['description' => 'Total number of messages sent by the Customer in chat sessions.', 'type' => 'string', 'example' => '9', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Outbound' => [ 'description' => 'Outbound data.', 'type' => 'object', 'properties' => [ 'AverageRingTime' => ['description' => 'Average ring time. Calculation Formula: TotalRingTime / CallsRinged, in seconds.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'CallsDialed' => ['description' => 'Number of dialed calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsAnswered' => ['description' => 'Number of answered calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalWorkTime' => ['description' => 'Total post-processing duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsAttendedTransferOut' => ['description' => 'Number of attended transfer-out calls. If a single call is transferred out to other agents multiple times, each transfer-out counts as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxWorkTime' => ['description' => 'Maximum post-processing time per call, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalDialingTime' => ['description' => 'Total dial-up duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalHoldTime' => ['description' => 'Total call hold duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageWorkTime' => ['description' => 'Average post-processing time per call, calculated using the formula: TotalWorkTime / CallsDialed, in seconds.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'CallsBlindTransferIn' => ['description' => 'Number of blind transfer-in calls. If a single call is transferred in to this agent multiple times, each transfer counts as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionIndex' => ['description' => 'Satisfaction index, which is the average value of the satisfaction keypress digits (single-digit numbers).', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'CallsRinged' => ['description' => 'Number of calls that rang to the agent.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsAttendedTransferIn' => ['description' => 'Attended transfer-in count. If a single call is transferred to this agent multiple times, each transfer-in is counted once.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsBlindTransferOut' => ['description' => 'Number of blind transfer-out calls. If a single call is transferred out to other agents multiple times, each transfer counts as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalRingTime' => ['description' => 'Total ring duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxTalkTime' => ['description' => 'Maximum talk time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxRingTime' => ['description' => 'Maximum ring duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalTalkTime' => ['description' => 'Total talk time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxDialingTime' => ['description' => 'Maximum dialing time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AnswerRate' => ['description' => 'Answer rate. Calculation Formula: CallsAnswered / CallsDialed. (Because the answer event and the acknowledgement event may fall into different time ranges, the result may exceed 100% in certain cases.)', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'MaxHoldTime' => ['description' => 'Maximum call hold duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageTalkTime' => ['description' => 'Average talk time. Calculation Formula: TotalTalkTime / CallsAnswered, in seconds.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'SatisfactionRate' => ['description' => 'Satisfaction rate. Calculation Formula: Count of evaluations marked as satisfied divided by the number of satisfaction survey responses.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'CallsHold' => ['description' => 'Hold count, which is the number of times call hold occurred.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionSurveysOffered' => ['description' => 'Sending Count of satisfaction surveys.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionSurveysResponded' => ['description' => 'Response Count of satisfaction surveys.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageHoldTime' => ['description' => 'Average call hold duration. Calculation Formula: TotalHoldTime / CallsHold, in seconds.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'AverageDialingTime' => ['description' => 'Average dial-up duration. Calculation Formula: TotalDialingTime / CallsDialed, in seconds.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Overall' => [ 'description' => 'Overall data.', 'type' => 'object', 'properties' => [ 'TotalTalkTime' => ['description' => 'Total talk time. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalLoggedInTime' => ['description' => 'Total logon time, excluding break time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'OccupancyRate' => ['description' => 'Agent occupancy rate, calculated using the formula: (TotalWorkTime + TotalTalkTime) / TotalLoggedInTime.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'TotalWorkTime' => ['description' => 'Total post-processing time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxHoldTime' => ['description' => 'Maximum call hold duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxWorkTime' => ['description' => 'Maximum post-processing duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageBreakTime' => ['description' => 'Average break duration. Calculation Formula: TotalBreakTime / Count of breaks. The count of breaks is not an API statistics field. Unit: seconds.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'TotalHoldTime' => ['description' => 'Total hold time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionRate' => ['description' => 'Satisfaction rate. Calculation Formula: Number of evaluations marked as satisfied / Count of satisfaction survey responses.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'MaxBreakTime' => ['description' => 'Maximum break duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageWorkTime' => ['description' => 'Average post-processing time per call. Calculation formula: TotalWorkTime / TotalCalls, in seconds.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'AverageTalkTime' => ['description' => 'Average talk time, in seconds. Calculation Formula: TotalTalkTime / (CallsAnswered + CallsHandled).', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'SatisfactionIndex' => ['description' => 'Satisfaction index, which is the average of the satisfaction rating digits (single-digit numbers).', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'SatisfactionSurveysOffered' => ['description' => 'Sending Count of satisfaction surveys.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionSurveysResponded' => ['description' => 'Count of satisfaction survey responses.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxReadyTime' => ['description' => 'Maximum ready duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageReadyTime' => ['description' => 'Average ready time, in seconds. Calculation Formula: TotalReadyTime / Count of ready events. The count of ready events is a non-API statistical field.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'AverageHoldTime' => ['description' => 'Average hold time per call, in seconds. Calculation formula: TotalHoldTime / (Inbound CallsHold + Outbound CallsHold).', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'TotalReadyTime' => ['description' => 'Total ready time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalBreakTime' => ['description' => 'Total break time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxTalkTime' => ['description' => 'Maximum talk duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalCalls' => ['description' => 'Total call volume. Calculation Formula: CallsOffered + CallsDialed.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalOnSiteOnlineTime' => ['description' => 'Total on-site online time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '已弃用，请使用TotalOnSiteLoggedInTime代替此参数', 'title' => ''], 'TotalOffSiteOnlineTime' => ['description' => 'Total off-site online duration. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '已弃用，请使用TotalOffSiteLoggedInTime代替此参数', 'title' => ''], 'TotalOfficePhoneOnlineTime' => ['description' => 'Total online time in office phone pattern, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '已弃用，请使用TotalOfficePhoneLoggedInTime代替此参数', 'title' => ''], 'BreakCodeDetailList' => [ 'description' => 'Statistics for each break type.', 'type' => 'array', 'items' => [ 'description' => 'Break statistics', 'type' => 'object', 'properties' => [ 'BreakCode' => ['description' => 'Break type code.', 'type' => 'string', 'example' => '会议', 'title' => ''], 'Count' => ['description' => 'Number of occurrences of this break type.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], 'Duration' => ['description' => 'Total duration of this break type, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '120', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'FirstCheckInTime' => ['description' => 'Earliest check-in time, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1686030515000', 'title' => ''], 'LastCheckOutTime' => ['description' => 'Latest check-out time, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1686030515000', 'title' => ''], 'TotalOutboundScenarioTime' => ['description' => 'Total outbound-only online duration. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '已弃用，请使用TotalOutboundScenarioLoggedInTime代替此参数', 'title' => ''], 'TotalOutboundScenarioReadyTime' => ['description' => 'Total outbound-only ready time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalOfficePhoneLoggedInTime' => ['description' => 'Total logged-in time in office phone pattern, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '3600', 'title' => ''], 'TotalOffSiteLoggedInTime' => ['description' => 'Total off-site logged-in duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalOnSiteLoggedInTime' => ['description' => 'Total on-site logged-in duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalOutboundScenarioLoggedInTime' => ['description' => 'Total outbound-only logon time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], ], 'title' => '', 'example' => '', ], 'SkillGroupIds' => ['description' => 'List of skill group IDs to which the agent belongs, formatted as a JSON array string, where each array element is a skill group ID.', 'type' => 'string', 'example' => '["skillgroup1@ccc-test","skillgroup2@ccc-test"]', 'title' => ''], 'SkillGroupNames' => ['description' => 'A list of skill group names to which the agent belongs, formatted as a JSON array string, where each array element is a skill group name.', 'type' => 'string', 'example' => '["测试技能组1","测试技能组2"]', 'title' => ''], 'Back2Back' => [ 'description' => 'Back-to-back metric.', 'type' => 'object', 'properties' => [ 'CallsDialed' => ['description' => 'Dial-up volume.', 'type' => 'string', 'example' => '100', 'title' => ''], 'AnswerRate' => ['description' => 'Answer rate. Calculation Formula: CallsAnswered / CallsDialed. (Because management events for answering and acknowledgement might fall into different Time Ranges, the Result may exceed 100% in some cases.)', 'type' => 'string', 'example' => '0.6', 'title' => ''], 'CallsAnswered' => ['description' => 'Call connection quantity.', 'type' => 'string', 'example' => '100', 'title' => ''], 'TotalTalkTime' => ['description' => 'Total talk time, in seconds.', 'type' => 'string', 'example' => '100', 'title' => ''], 'MaxTalkTime' => ['description' => 'Maximum talk time, in seconds.', 'type' => 'string', 'example' => '100', 'title' => ''], 'AverageTalkTime' => ['description' => 'Average talk time, in seconds.', 'type' => 'string', 'example' => '100', 'title' => ''], 'TotalRingTime' => ['description' => 'Total ring time, in seconds.', 'type' => 'string', 'example' => '100', 'title' => ''], 'MaxRingTime' => ['description' => 'Maximum ring time, in seconds.', 'type' => 'string', 'example' => '100', 'title' => ''], 'AverageRingTime' => ['description' => 'Average ring time, in seconds.', 'type' => 'string', 'example' => '100', 'title' => ''], 'TotalCustomerRingTime' => ['description' => 'Total customer-side ring time, in seconds.', 'type' => 'string', 'example' => '100', 'title' => ''], 'MaxCustomerRingTime' => ['description' => 'Maximum customer-side ring time, in seconds.', 'type' => 'string', 'example' => '100', 'title' => ''], 'AverageCustomerRingTime' => ['description' => 'Average customer-side ring time, in seconds.', 'type' => 'string', 'example' => '100', 'title' => ''], 'CallsAgentHandled' => ['description' => 'Quantity of calls answered by agents.', 'type' => 'string', 'example' => '10', 'title' => ''], 'AgentHandleRate' => ['description' => 'Agent acknowledgement rate.', 'type' => 'string', 'example' => '1', 'title' => ''], 'CallsCustomerAnswered' => ['description' => 'Quantity of calls answered by customers.', 'type' => 'string', 'example' => '7', 'title' => ''], 'CustomerAnswerRate' => ['description' => 'Customer answer rate.', 'type' => 'string', 'example' => '0.7', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Internal' => [ 'description' => 'Internal call metrics.', 'type' => 'object', 'properties' => [ 'TotalTalkTime' => ['description' => 'Total talk time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'AverageTalkTime' => ['description' => 'Average talk time, in seconds.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], 'MaxTalkTime' => ['description' => 'Maximum talk time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'CallsOffered' => ['description' => 'Number of incoming calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'CallsHandled' => ['description' => 'Number of acknowledgements.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'CallsTalked' => ['description' => 'Number of calls participated in.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'CallsDialed' => ['description' => 'Number of dialed calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'CallsAnswered' => ['description' => 'Number of answered calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ], ], 'title' => 'Retrieve Agent Historical Data Report', 'summary' => 'You can invoke ListHistoricalAgentReport to obtain the Historical Data report for one or more agents under a specified instance.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-11-22T01:05:25.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2023-05-23T11:59:01.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-07-04T11:50:02.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListHistoricalAgentReport'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"AgentName\\": \\"坐席小王\\",\\n \\"AgentId\\": \\"agent1@ccc-test\\",\\n \\"DisplayId\\": \\"001\\",\\n \\"Inbound\\": {\\n \\"AverageRingTime\\": 0,\\n \\"CallsHandled\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"CallsAttendedTransferOut\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"TotalHoldTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"CallsBlindTransferIn\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"CallsRinged\\": 0,\\n \\"CallsAttendedTransferIn\\": 0,\\n \\"CallsBlindTransferOut\\": 0,\\n \\"TotalRingTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"MaxRingTime\\": 0,\\n \\"TotalTalkTime\\": 0,\\n \\"CallsOffered\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"CallsHold\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"HandleRate\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"AccessChannelTypeDetails\\": [\\n {\\n \\"AccessChannelType\\": \\"Web\\",\\n \\"CallsOffered\\": 3\\n }\\n ],\\n \\"AverageFirstResponseTime\\": 10,\\n \\"AverageResponseTime\\": 12,\\n \\"ServiceLevel15\\": 0.85,\\n \\"TotalMessagesSent\\": 16,\\n \\"TotalMessagesSentByAgent\\": 7,\\n \\"TotalMessagesSentByCustomer\\": \\"9\\"\\n },\\n \\"Outbound\\": {\\n \\"AverageRingTime\\": 0,\\n \\"CallsDialed\\": 0,\\n \\"CallsAnswered\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"CallsAttendedTransferOut\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"TotalDialingTime\\": 0,\\n \\"TotalHoldTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"CallsBlindTransferIn\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"CallsRinged\\": 0,\\n \\"CallsAttendedTransferIn\\": 0,\\n \\"CallsBlindTransferOut\\": 0,\\n \\"TotalRingTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"MaxRingTime\\": 0,\\n \\"TotalTalkTime\\": 0,\\n \\"MaxDialingTime\\": 0,\\n \\"AnswerRate\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"CallsHold\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"AverageDialingTime\\": 0\\n },\\n \\"Overall\\": {\\n \\"TotalTalkTime\\": 0,\\n \\"TotalLoggedInTime\\": 0,\\n \\"OccupancyRate\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"AverageBreakTime\\": 0,\\n \\"TotalHoldTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"MaxBreakTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"MaxReadyTime\\": 0,\\n \\"AverageReadyTime\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"TotalReadyTime\\": 0,\\n \\"TotalBreakTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"TotalCalls\\": 0,\\n \\"TotalOnSiteOnlineTime\\": 0,\\n \\"TotalOffSiteOnlineTime\\": 0,\\n \\"TotalOfficePhoneOnlineTime\\": 0,\\n \\"BreakCodeDetailList\\": [\\n {\\n \\"BreakCode\\": \\"会议\\",\\n \\"Count\\": 3,\\n \\"Duration\\": 120\\n }\\n ],\\n \\"FirstCheckInTime\\": 1686030515000,\\n \\"LastCheckOutTime\\": 1686030515000,\\n \\"TotalOutboundScenarioTime\\": 0,\\n \\"TotalOutboundScenarioReadyTime\\": 100,\\n \\"TotalOfficePhoneLoggedInTime\\": 3600,\\n \\"TotalOffSiteLoggedInTime\\": 100,\\n \\"TotalOnSiteLoggedInTime\\": 100,\\n \\"TotalOutboundScenarioLoggedInTime\\": 100\\n },\\n \\"SkillGroupIds\\": \\"[\\\\\\"skillgroup1@ccc-test\\\\\\",\\\\\\"skillgroup2@ccc-test\\\\\\"]\\",\\n \\"SkillGroupNames\\": \\"[\\\\\\"测试技能组1\\\\\\",\\\\\\"测试技能组2\\\\\\"]\\",\\n \\"Back2Back\\": {\\n \\"CallsDialed\\": \\"100\\",\\n \\"AnswerRate\\": \\"0.6\\",\\n \\"CallsAnswered\\": \\"100\\",\\n \\"TotalTalkTime\\": \\"100\\",\\n \\"MaxTalkTime\\": \\"100\\",\\n \\"AverageTalkTime\\": \\"100\\",\\n \\"TotalRingTime\\": \\"100\\",\\n \\"MaxRingTime\\": \\"100\\",\\n \\"AverageRingTime\\": \\"100\\",\\n \\"TotalCustomerRingTime\\": \\"100\\",\\n \\"MaxCustomerRingTime\\": \\"100\\",\\n \\"AverageCustomerRingTime\\": \\"100\\",\\n \\"CallsAgentHandled\\": \\"10\\",\\n \\"AgentHandleRate\\": \\"1\\",\\n \\"CallsCustomerAnswered\\": \\"7\\",\\n \\"CustomerAnswerRate\\": \\"0.7\\"\\n },\\n \\"Internal\\": {\\n \\"TotalTalkTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"MaxTalkTime\\": 100,\\n \\"CallsOffered\\": 100,\\n \\"CallsHandled\\": 100,\\n \\"CallsTalked\\": 100,\\n \\"CallsDialed\\": 100,\\n \\"CallsAnswered\\": 100\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'ListHistoricalAgentSkillGroupReport' => [ 'summary' => 'You can call ListHistoricalAgentSkillGroupReport to retrieve historical skill group reports for one or more agents in a specified instance.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccSI864G'], ], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'Page number. Valid values are 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'Page size. Valid values are 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''], ], [ 'name' => 'AgentIdList', 'in' => 'formData', 'schema' => ['description' => 'List of agent IDs. The list size is 0 to 100.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '["agent1@ccc-test", "agent2@ccc-test"]', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'Start timestamp. Defaults to 00:00 on the current day. The statistical time granularity is hourly, rounded down to the nearest hour, in a closed interval.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1634140800000', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'End time for historical data retrieval. Format is UNIX timestamp in milliseconds. Optional. Defaults to the current time. The statistical time granularity is hourly, rounded up to the nearest hour, in an open interval. For example, if the start time is 11:12:20 and the end time is 11:45:50, the aligned request parameter time range is \\[11:00:00, 12:00:00), meaning greater than or equal to 11:00 and less than 12:00.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1620273600000', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test'."\n", 'title' => ''], ], [ 'name' => 'SkillGroupIdList', 'in' => 'query', 'schema' => ['description' => 'List of skill group IDs. The list size is 0 to 100.', 'type' => 'string', 'required' => false, 'example' => '['."\n" .' "skg1@ccc-test",'."\n" .' "skg2@ccc-test"'."\n" .']', 'title' => ''], ], [ 'name' => 'MediaType', 'in' => 'query', 'schema' => ['description' => 'Media type. Defaults to Audio. Other optional parameters include Chat and Video.', 'type' => 'string', 'required' => false, 'example' => 'VIDEO', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', 'title' => ''], 'Data' => [ 'description' => 'List of historical agent skill group data.', 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'Page number. Valid values are 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'Page size. Valid values are 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'TotalCount' => ['description' => 'Total count. Data is available only when PageNumber is 1. Otherwise, the value is 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '11', 'title' => ''], 'List' => [ 'description' => 'List of historical agent skill group data.', 'type' => 'array', 'items' => [ 'description' => 'Historical agent skill group data.', 'type' => 'object', 'properties' => [ 'AgentName' => ['description' => 'Agent name.', 'type' => 'string', 'example' => '云呼测试坐席', 'title' => ''], 'AgentId' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => 'agent1@ccc-test', 'title' => ''], 'DisplayId' => ['description' => 'Agent\'s employee ID.', 'type' => 'string', 'example' => '1001', 'title' => ''], 'SkillGroupName' => ['description' => 'Skill group name.', 'type' => 'string', 'example' => 'Default', 'title' => ''], 'SkillGroupId' => ['description' => 'Skill group ID.', 'type' => 'string', 'example' => 'skillgroup1@ccc-test', 'title' => ''], 'Inbound' => [ 'description' => 'Inbound metrics.', 'type' => 'object', 'properties' => [ 'AverageRingTime' => ['description' => 'Average ring time in seconds. Formula: TotalRingTime/CallsRinged.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], 'CallsHandled' => ['description' => 'Number of calls handled, which is the number of times an agent answered a call.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalWorkTime' => ['description' => 'Total after-call work time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'CallsAttendedTransferOut' => ['description' => 'Number of attended transfers out. If a call is transferred multiple times to other agents, each transfer counts as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'MaxWorkTime' => ['description' => 'Maximum after-call work time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalHoldTime' => ['description' => 'Total call hold time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'AverageWorkTime' => ['description' => 'Average after-call work time in seconds. Formula: TotalWorkTime/CallsHandled.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], 'CallsBlindTransferIn' => ['description' => 'Number of blind transfers in. If a call is transferred multiple times to this agent, each transfer counts as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'SatisfactionIndex' => ['description' => 'Satisfaction index, which is the average value of the single-digit satisfaction key presses.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], 'CallsRinged' => ['description' => 'Number of calls that rang for the agent.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'CallsAttendedTransferIn' => ['description' => 'Number of attended transfers in. If a call is transferred multiple times to this agent, each transfer counts as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'CallsBlindTransferOut' => ['description' => 'Number of blind transfers out. If a call is transferred multiple times to other agents, each transfer counts as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalRingTime' => ['description' => 'Total ring time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'MaxTalkTime' => ['description' => 'Maximum talk time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'MaxRingTime' => ['description' => 'Maximum ring time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalTalkTime' => ['description' => 'Total talk time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'CallsOffered' => ['description' => 'Number of calls offered, which is the number of times calls were assigned to this agent, including blind transfers and attended transfers from other agents.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'MaxHoldTime' => ['description' => 'Maximum call hold time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'AverageTalkTime' => ['description' => 'Average talk time in seconds. Formula: TotalTalkTime/CallsHandled.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], 'SatisfactionRate' => ['description' => 'Satisfaction rate. Formula: Number of satisfied ratings/Number of satisfaction survey responses.', 'type' => 'number', 'format' => 'float', 'example' => '0.5', 'title' => ''], 'CallsHold' => ['description' => 'Number of calls on hold, which is the number of times a call was put on hold.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'SatisfactionSurveysOffered' => ['description' => 'Number of satisfaction surveys offered.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'HandleRate' => ['description' => 'Handle rate. Formula: CallsHandled/CallsOffered (Because answer events and offered events might fall into different time ranges, the result might sometimes exceed 100%).', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], 'SatisfactionSurveysResponded' => ['description' => 'Number of satisfaction survey responses.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'AverageHoldTime' => ['description' => 'Average call hold time in seconds. Formula: TotalHoldTime/CallsHold.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], 'TotalMessagesSent' => ['description' => 'Total messages sent in chat sessions.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], 'TotalMessagesSentByAgent' => ['description' => 'Total messages sent by agents in chat sessions.', 'type' => 'integer', 'format' => 'int64', 'example' => '6', 'title' => ''], 'TotalMessagesSentByCustomer' => ['description' => 'Total messages sent by customers in chat sessions.', 'type' => 'integer', 'format' => 'int64', 'example' => '6', 'title' => ''], 'AverageFirstResponseTime' => ['description' => 'Average first response time in chat sessions, in seconds.', 'type' => 'number', 'format' => 'float', 'example' => '8', 'title' => ''], 'AverageResponseTime' => ['description' => 'Average response time in chat sessions.', 'type' => 'number', 'format' => 'float', 'example' => '9', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Outbound' => [ 'description' => 'Outbound metrics.', 'type' => 'object', 'properties' => [ 'AverageRingTime' => ['description' => 'Average ring time in seconds.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], 'CallsDialed' => ['description' => 'Number of calls dialed.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'CallsAnswered' => ['description' => 'Number of calls answered.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalWorkTime' => ['description' => 'Total after-call work time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'CallsAttendedTransferOut' => ['description' => 'Number of attended transfers out. If a call is transferred multiple times to other agents, each transfer counts as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'MaxWorkTime' => ['description' => 'Maximum after-call work time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalDialingTime' => ['description' => 'Total dialing time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalHoldTime' => ['description' => 'Total call hold time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'AverageWorkTime' => ['description' => 'Average after-call work time in seconds. Formula: TotalWorkTime/CallsDialed.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], 'CallsBlindTransferIn' => ['description' => 'Number of blind transfers in. If a call is transferred multiple times to this agent, each transfer counts as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'SatisfactionIndex' => ['description' => 'Satisfaction index, which is the average value of the single-digit satisfaction key presses.', 'type' => 'number', 'format' => 'float', 'example' => '1.4', 'title' => ''], 'CallsRinged' => ['description' => 'Number of calls that rang for the agent.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'CallsAttendedTransferIn' => ['description' => 'Number of attended transfers in. If a call is transferred multiple times to this agent, each transfer counts as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'CallsBlindTransferOut' => ['description' => 'Number of blind transfers out. If a call is transferred multiple times to other agents, each transfer counts as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalRingTime' => ['description' => 'Total ring time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'MaxTalkTime' => ['description' => 'Maximum talk time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'MaxRingTime' => ['description' => 'Maximum ring time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalTalkTime' => ['description' => 'Total talk time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'MaxDialingTime' => ['description' => 'Maximum dialing time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'AnswerRate' => ['description' => 'Answer rate. Formula: CallsAnswered/CallsDialed (Because answer events and offered events might fall into different time ranges, the result might sometimes exceed 100%).', 'type' => 'number', 'format' => 'float', 'example' => '0.5', 'title' => ''], 'MaxHoldTime' => ['description' => 'Maximum call hold time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'AverageTalkTime' => ['description' => 'Average talk time in seconds. Formula: TotalTalkTime/CallsAnswered.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], 'SatisfactionRate' => ['description' => 'Satisfaction rate. Formula: Number of satisfied ratings/Number of satisfaction survey responses.', 'type' => 'number', 'format' => 'float', 'example' => '0.5', 'title' => ''], 'CallsHold' => ['description' => 'Number of calls on hold, which is the number of times a call was put on hold.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'SatisfactionSurveysOffered' => ['description' => 'Number of satisfaction surveys offered.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'SatisfactionSurveysResponded' => ['description' => 'Number of satisfaction survey responses.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'AverageHoldTime' => ['description' => 'Average call hold time in seconds. Formula: TotalHoldTime/CallsHold.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], 'AverageDialingTime' => ['description' => 'Average dialing time in seconds. Formula: TotalDialingTime/CallsDialed.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Overall' => [ 'description' => 'Overall metrics.', 'type' => 'object', 'properties' => [ 'TotalTalkTime' => ['description' => 'Total talk time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalLoggedInTime' => ['description' => 'Total logged-in time in seconds.'."\n" .'*Note: This does not include offline or break time.*', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'OccupancyRate' => ['description' => 'Agent occupancy rate.', 'type' => 'number', 'format' => 'float', 'example' => '0.5', 'title' => ''], 'TotalWorkTime' => ['description' => 'Total after-call work time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'MaxHoldTime' => ['description' => 'Maximum call hold time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'MaxWorkTime' => ['description' => 'Maximum after-call work time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'AverageBreakTime' => ['description' => 'Average break time in seconds.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], 'TotalHoldTime' => ['description' => 'Total hold time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'SatisfactionRate' => ['description' => 'Satisfaction rate. Formula: Number of satisfied ratings/Number of satisfaction survey responses.', 'type' => 'number', 'format' => 'float', 'example' => '0.5', 'title' => ''], 'MaxBreakTime' => ['description' => 'Maximum break time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'AverageWorkTime' => ['description' => 'Average after-call work time in seconds. Formula: TotalWorkTime/TotalCalls.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], 'AverageTalkTime' => ['description' => 'Average talk time in seconds. Formula: TotalTalkTime/(CallsAnswered+CallsHandled).', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], 'SatisfactionIndex' => ['description' => 'Satisfaction index, which is the average value of the single-digit satisfaction key presses.', 'type' => 'number', 'format' => 'float', 'example' => '1.4', 'title' => ''], 'SatisfactionSurveysOffered' => ['description' => 'Number of satisfaction surveys offered.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'SatisfactionSurveysResponded' => ['description' => 'Number of satisfaction survey responses.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'MaxReadyTime' => ['description' => 'Maximum ready time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'AverageReadyTime' => ['description' => 'Average ready time in seconds. Formula: TotalReadyTime/Number of ready events. The number of ready events is not an API statistical field.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], 'AverageHoldTime' => ['description' => 'Average call hold time in seconds. Formula: TotalHoldTime/(Inbound CallsHold + Outbound CallsHold).', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], 'TotalReadyTime' => ['description' => 'Total ready time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalBreakTime' => ['description' => 'Total break time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'MaxTalkTime' => ['description' => 'Maximum talk time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalCalls' => ['description' => 'Total number of calls. Formula: CallsOffered + CallsDialed.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'BreakCodeDetailList' => [ 'description' => 'List of break code details.', 'type' => 'array', 'items' => [ 'description' => 'Break code details.', 'type' => 'object', 'properties' => [ 'BreakCode' => ['description' => 'Break code.', 'type' => 'string', 'example' => '开会', 'title' => ''], 'Count' => ['description' => 'Count.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'Duration' => ['description' => 'Duration in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'FirstCheckInTime' => ['description' => 'Earliest check-in time. Format is UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1686030515000', 'title' => ''], 'LastCheckOutTime' => ['description' => 'Latest check-out time. Format is UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1686030515000', 'title' => ''], 'TotalOutboundScenarioTime' => ['description' => 'Total outbound-only online time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalOutboundScenarioReadyTime' => ['description' => 'Total outbound-only idle time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalOutboundScenarioLoggedInTime' => ['description' => 'Total outbound-only logged-in time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '120', 'title' => ''], 'TotalOfficePhoneLoggedInTime' => ['description' => 'Total office phone logged-in time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '120', 'title' => ''], 'TotalOffSiteLggedInTime' => ['description' => 'Total off-site logged-in time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '120', 'title' => ''], 'TotalOnSiteLoggedInTime' => ['description' => 'Total on-site logged-in time in seconds.', 'type' => 'string', 'example' => '120', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Internal' => [ 'description' => 'Internal call metrics.', 'type' => 'object', 'properties' => [ 'TotalTalkTime' => ['description' => 'Total talk time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'AverageTalkTime' => ['description' => 'Average talk time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'MaxTalkTime' => ['description' => 'Maximum talk time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'CallsOffered' => ['description' => 'Number of calls offered.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'CallsHandled' => ['description' => 'Number of calls handled.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'CallsTalk' => ['description' => 'Number of calls the agent participated in.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'CallsDialed' => ['description' => 'Number of calls dialed.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'CallsAnswered' => ['description' => 'Number of calls answered.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'CallsTalked' => ['description' => 'Number of calls participated in.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Back2Back' => [ 'description' => 'Back-to-back call metrics.', 'type' => 'object', 'properties' => [ 'CallsDialed' => ['description' => 'Number of calls dialed.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'AnswerRate' => ['description' => 'Answer rate. Formula: CallsAnswered/CallsDialed (Because answer events and offered events might fall into different time ranges, the result might sometimes exceed 100%).', 'type' => 'number', 'format' => 'float', 'example' => '0.6', 'title' => ''], 'CallsAnswered' => ['description' => 'Number of calls answered.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'AgentAnswerRate' => ['description' => 'Agent-side answer rate.', 'type' => 'number', 'format' => 'float', 'example' => '已弃用，请使用AgentHandleRate代替此参数', 'title' => ''], 'CallsCustomerHandled' => ['description' => 'Number of customer-side pickups.', 'type' => 'integer', 'format' => 'int64', 'example' => '已弃用，请使用CallsCustomerAnswered代替此参数', 'title' => ''], 'CustomerHandleRate' => ['description' => 'Customer-side handle rate.', 'type' => 'number', 'format' => 'float', 'example' => '已弃用，请使用CustomerAnswerRate代替此参数', 'title' => ''], 'TotalTalkTime' => ['description' => 'Total talk time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'MaxTalkTime' => ['description' => 'Maximum talk time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'AverageTalkTime' => ['description' => 'Average talk time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalRingTime' => ['description' => 'Total ring time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'MaxRingTime' => ['description' => 'Maximum ring time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'AverageRingTime' => ['description' => 'Average ring time in seconds.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], 'TotalCustomerRingTime' => ['description' => 'Total customer-side ring time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'MaxCustomerRingTime' => ['description' => 'Maximum customer-side ring time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'AverageCustomerRingTime' => ['description' => 'Average customer-side ring time in seconds.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], 'AgentHandleRate' => ['description' => 'Agent handle rate.', 'type' => 'number', 'format' => 'float', 'example' => '0.5', 'title' => ''], 'CallsCustomerAnswered' => ['description' => 'Number of calls answered by customers.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'CustomerAnswerRate' => ['description' => 'Customer answer rate.', 'type' => 'number', 'format' => 'float', 'example' => '0.5', 'title' => ''], 'CallsAgentHandled' => ['description' => 'Number of calls handled by agents.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Retrieve Historical Data Report for Group Agents', 'changeSet' => [ ['createdAt' => '2023-11-22T01:05:27.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListHistoricalAgentSkillGroupReport'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 11,\\n \\"List\\": [\\n {\\n \\"AgentName\\": \\"云呼测试坐席\\",\\n \\"AgentId\\": \\"agent1@ccc-test\\",\\n \\"DisplayId\\": \\"1001\\",\\n \\"SkillGroupName\\": \\"Default\\",\\n \\"SkillGroupId\\": \\"skillgroup1@ccc-test\\",\\n \\"Inbound\\": {\\n \\"AverageRingTime\\": 100,\\n \\"CallsHandled\\": 100,\\n \\"TotalWorkTime\\": 100,\\n \\"CallsAttendedTransferOut\\": 100,\\n \\"MaxWorkTime\\": 100,\\n \\"TotalHoldTime\\": 100,\\n \\"AverageWorkTime\\": 100,\\n \\"CallsBlindTransferIn\\": 100,\\n \\"SatisfactionIndex\\": 100,\\n \\"CallsRinged\\": 100,\\n \\"CallsAttendedTransferIn\\": 100,\\n \\"CallsBlindTransferOut\\": 100,\\n \\"TotalRingTime\\": 100,\\n \\"MaxTalkTime\\": 100,\\n \\"MaxRingTime\\": 100,\\n \\"TotalTalkTime\\": 100,\\n \\"CallsOffered\\": 100,\\n \\"MaxHoldTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"SatisfactionRate\\": 0.5,\\n \\"CallsHold\\": 100,\\n \\"SatisfactionSurveysOffered\\": 100,\\n \\"HandleRate\\": 100,\\n \\"SatisfactionSurveysResponded\\": 100,\\n \\"AverageHoldTime\\": 100,\\n \\"TotalMessagesSent\\": 12,\\n \\"TotalMessagesSentByAgent\\": 6,\\n \\"TotalMessagesSentByCustomer\\": 6,\\n \\"AverageFirstResponseTime\\": 8,\\n \\"AverageResponseTime\\": 9\\n },\\n \\"Outbound\\": {\\n \\"AverageRingTime\\": 100,\\n \\"CallsDialed\\": 100,\\n \\"CallsAnswered\\": 100,\\n \\"TotalWorkTime\\": 100,\\n \\"CallsAttendedTransferOut\\": 100,\\n \\"MaxWorkTime\\": 100,\\n \\"TotalDialingTime\\": 100,\\n \\"TotalHoldTime\\": 100,\\n \\"AverageWorkTime\\": 100,\\n \\"CallsBlindTransferIn\\": 100,\\n \\"SatisfactionIndex\\": 1.4,\\n \\"CallsRinged\\": 100,\\n \\"CallsAttendedTransferIn\\": 100,\\n \\"CallsBlindTransferOut\\": 100,\\n \\"TotalRingTime\\": 100,\\n \\"MaxTalkTime\\": 100,\\n \\"MaxRingTime\\": 100,\\n \\"TotalTalkTime\\": 100,\\n \\"MaxDialingTime\\": 100,\\n \\"AnswerRate\\": 0.5,\\n \\"MaxHoldTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"SatisfactionRate\\": 0.5,\\n \\"CallsHold\\": 100,\\n \\"SatisfactionSurveysOffered\\": 100,\\n \\"SatisfactionSurveysResponded\\": 100,\\n \\"AverageHoldTime\\": 100,\\n \\"AverageDialingTime\\": 100\\n },\\n \\"Overall\\": {\\n \\"TotalTalkTime\\": 100,\\n \\"TotalLoggedInTime\\": 100,\\n \\"OccupancyRate\\": 0.5,\\n \\"TotalWorkTime\\": 100,\\n \\"MaxHoldTime\\": 100,\\n \\"MaxWorkTime\\": 100,\\n \\"AverageBreakTime\\": 100,\\n \\"TotalHoldTime\\": 100,\\n \\"SatisfactionRate\\": 0.5,\\n \\"MaxBreakTime\\": 100,\\n \\"AverageWorkTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"SatisfactionIndex\\": 1.4,\\n \\"SatisfactionSurveysOffered\\": 100,\\n \\"SatisfactionSurveysResponded\\": 100,\\n \\"MaxReadyTime\\": 100,\\n \\"AverageReadyTime\\": 100,\\n \\"AverageHoldTime\\": 100,\\n \\"TotalReadyTime\\": 100,\\n \\"TotalBreakTime\\": 100,\\n \\"MaxTalkTime\\": 100,\\n \\"TotalCalls\\": 100,\\n \\"BreakCodeDetailList\\": [\\n {\\n \\"BreakCode\\": \\"开会\\",\\n \\"Count\\": 1,\\n \\"Duration\\": 100\\n }\\n ],\\n \\"FirstCheckInTime\\": 1686030515000,\\n \\"LastCheckOutTime\\": 1686030515000,\\n \\"TotalOutboundScenarioTime\\": 100,\\n \\"TotalOutboundScenarioReadyTime\\": 100,\\n \\"TotalOutboundScenarioLoggedInTime\\": 120,\\n \\"TotalOfficePhoneLoggedInTime\\": 120,\\n \\"TotalOffSiteLggedInTime\\": 120,\\n \\"TotalOnSiteLoggedInTime\\": \\"120\\"\\n },\\n \\"Internal\\": {\\n \\"TotalTalkTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"MaxTalkTime\\": 100,\\n \\"CallsOffered\\": 100,\\n \\"CallsHandled\\": 100,\\n \\"CallsTalk\\": 100,\\n \\"CallsDialed\\": 100,\\n \\"CallsAnswered\\": 100,\\n \\"CallsTalked\\": 5\\n },\\n \\"Back2Back\\": {\\n \\"CallsDialed\\": 100,\\n \\"AnswerRate\\": 0.6,\\n \\"CallsAnswered\\": 100,\\n \\"AgentAnswerRate\\": 0,\\n \\"CallsCustomerHandled\\": 0,\\n \\"CustomerHandleRate\\": 0,\\n \\"TotalTalkTime\\": 100,\\n \\"MaxTalkTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"TotalRingTime\\": 100,\\n \\"MaxRingTime\\": 100,\\n \\"AverageRingTime\\": 100,\\n \\"TotalCustomerRingTime\\": 100,\\n \\"MaxCustomerRingTime\\": 100,\\n \\"AverageCustomerRingTime\\": 100,\\n \\"AgentHandleRate\\": 0.5,\\n \\"CallsCustomerAnswered\\": 100,\\n \\"CustomerAnswerRate\\": 0.5,\\n \\"CallsAgentHandled\\": 100\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'ListHistoricalSkillGroupReport' => [ 'summary' => 'You can invoke ListHistoricalSkillGroupReport to obtain historical data reports for one or more skill groups under a specified instance. ', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccOQKOLI'], ], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'Page number, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'Page size, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1', 'example' => '100', 'title' => ''], ], [ 'name' => 'SkillGroupIdList', 'in' => 'formData', 'schema' => ['description' => 'List of skill group IDs to query, provided as a JSON array string. Each array element is a skill group ID. This parameter is optional. The default value is empty, which means all skill groups in the current page are queried.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '["skillgroup1@ccc-test", "skillgroup2@ccc-test2"]', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'Start time of the historical data to retrieve, formatted as a UNIX timestamp in milliseconds. This parameter is optional. The default value is 00:00:00 of the current day. The earliest allowed value is 180 days before the current time. The time precision for statistics is hourly, rounded down to the previous hour, and uses a closed interval.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1532448000000', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'End time of the historical data to retrieve, formatted as a UNIX timestamp in milliseconds. This parameter is optional. The default value is the current time. The time precision for statistics is hourly, rounded down to the previous hour, and uses an open interval. For example, if the start time is 11:12:20 and the end time is 11:45:50, the aligned input time range becomes [11:00:00, 12:00:00), meaning greater than or equal to 11:00:00 and less than 12:00:00.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1532707199000', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'MediaType', 'in' => 'query', 'schema' => ['description' => 'Media type. The default value is Audio. Other valid values include Chat and Video.', 'type' => 'string', 'required' => false, 'example' => 'VIDEO', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code. ', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message. ', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID. ', 'type' => 'string', 'example' => '26A34338-5CD9-4C95-A7A6-5BDCE76C6B94', 'title' => ''], 'Data' => [ 'description' => 'Data. ', 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'Page number, ranging from 1 to 100. ', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'Page size, ranging from 1 to 100. ', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'TotalCount' => ['description' => 'Total count. ', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], 'List' => [ 'description' => 'List of historical data for skill groups. ', 'type' => 'array', 'items' => [ 'description' => 'Historical data for a skill group. ', 'type' => 'object', 'properties' => [ 'SkillGroupName' => ['description' => 'Skill group name.', 'type' => 'string', 'example' => 'skillgroup', 'title' => ''], 'SkillGroupId' => ['description' => 'Skill group ID.', 'type' => 'string', 'example' => 'skillgroup@ccc-test', 'title' => ''], 'Inbound' => [ 'description' => 'Inbound metrics.', 'type' => 'object', 'properties' => [ 'AverageRingTime' => ['description' => 'Average ring time, in seconds. Calculation Formula: TotalRingTime / CallsRinged.', 'type' => 'number', 'format' => 'float', 'example' => '5', 'title' => ''], 'CallsOverflow' => ['description' => 'Overflow count, which is the number of calls that experienced queue (skill group) overflow. If a single call enters the same queue multiple times, each overflow is counted separately.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsAbandonedInRing' => ['description' => 'Ring abandonment count, which is the number of calls where the customer hung up while the agent\'s phone was ringing.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsHandled' => ['description' => 'Acknowledgement count, which is the number of times agents answered calls. For a single call that enters a queue multiple times, if it is answered by multiple agents after one queue entry, it is counted as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '7', 'title' => ''], 'TotalWorkTime' => ['description' => 'Total post-processing time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '85', 'title' => ''], 'TotalAbandonedInRingTime' => ['description' => 'Total ring abandonment duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxWorkTime' => ['description' => 'Maximum post-processing duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], 'CallsAttendedTransferOut' => ['description' => 'Quantity of attended transfer-out calls, which refers to the number of calls transferred from this skill group to another skill group via consultation. Transfers between agents within the same skill group are not counted.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageWaitTime' => ['description' => 'Average wait time, which is the average duration a caller waits before an agent answers the call. Calculation Formula: TotalWaitTime / CallsHandled.', 'type' => 'number', 'format' => 'float', 'example' => '5', 'title' => ''], 'TotalHoldTime' => ['description' => 'Total call hold duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxAbandonTime' => ['description' => 'Maximum abandonment duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageWorkTime' => ['description' => 'Average post-processing duration, in seconds. Calculation Formula: TotalWorkTime / CallsHandled.', 'type' => 'number', 'format' => 'float', 'example' => '13', 'title' => ''], 'CallsQueued' => ['description' => 'Number of inbound calls entering a queue (skill group). If a single call enters the same queue multiple times, each entry is counted separately.', 'type' => 'integer', 'format' => 'int64', 'example' => '7', 'title' => ''], 'CallsBlindTransferIn' => ['description' => 'Number of blind transfer-in calls, which refers to the number of calls directly transferred to this skill group from other skill groups. Transfers between agents within the same skill group are not counted. If an agent is signed into multiple skill groups simultaneously, the call is attributed to the first skill group the agent signed into. If a single call is transferred multiple times from other skill groups to this skill group, each transfer is counted separately. The same rule applies below.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionIndex' => ['description' => 'Satisfaction index, which is the average of the satisfaction keypress digits (single-digit numbers).', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'AverageAbandonedInRingTime' => ['description' => 'Average ringing abandonment duration, in seconds. Calculation Formula: TotalAbandonedInRingTime / CallsAbandonedInRing.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'AverageAbandonTime' => ['description' => 'Average abandonment duration, in seconds. Calculation Formula: TotalAbandonTime / CallsAbandoned.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'CallsRinged' => ['description' => 'Number of calls that rang to agents. Each time a call enters the queue and is assigned to multiple agents, resulting in ringing, it counts as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '7', 'title' => ''], 'CallsBlindTransferOut' => ['description' => 'Number of blind transfer-out calls, which refers to the number of calls directly transferred from this skill group to another skill group. Transfers between agents within the same skill group are not counted.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsAttendedTransferIn' => ['description' => 'Transfer-in volume, which refers to the number of calls transferred to this skill group from other skill groups. Transfers between agents within the same skill group are not counted. If an agent is signed into multiple skill groups simultaneously, the call is attributed to the first skill group the agent signed into. If a single call is transferred multiple times from other skill groups to this skill group, each transfer is counted separately. The same rule applies below.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsAbandoned' => ['description' => 'Quantity of abandoned calls. Calculation Formula: CallsAbandonedInQueue + CallsAbandonedInRing.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxAbandonedInQueueTime' => ['description' => 'Maximum queue abandonment duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalWaitTime' => ['description' => 'Total waiting duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '34', 'title' => ''], 'TotalRingTime' => ['description' => 'Total ringing duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '32', 'title' => ''], 'MaxTalkTime' => ['description' => 'Maximum talk duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxRingTime' => ['description' => 'Maximum ring duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], 'AbandonRate' => ['description' => 'Abandon rate. Calculation Formula: CallsAbandoned / CallsOffered (Because abandonment events and assignment events may fall into different time ranges, the result may exceed 100% in certain cases).', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'TotalTalkTime' => ['description' => 'Total talk time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '447', 'title' => ''], 'TotalAbandonTime' => ['description' => 'Total abandonment duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsOffered' => ['description' => 'Assigned call volume, which is the number of calls assigned to this skill group, including calls assigned through queues and calls assigned via transfers (consultation transfers and direct transfers). Calculation Formula: CallsQueued + CallsBlindTransferIn + CallsAttendedTransferIn.', 'type' => 'integer', 'format' => 'int64', 'example' => '7', 'title' => ''], 'MaxAbandonedInRingTime' => ['description' => 'Maximum ring abandonment duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxWaitTime' => ['description' => 'Maximum wait time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '13', 'title' => ''], 'AverageAbandonedInQueueTime' => ['description' => 'Average queue abandonment duration, in seconds. Calculation Formula: TotalAbandonedInQueueTime / CallsAbandonedInQueue.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'ServiceLevel20' => ['description' => 'Service level within 20 seconds: number of calls with wait time less than or equal to 20 seconds divided by CallsQueued.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'MaxHoldTime' => ['description' => 'Maximum call hold time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionRate' => ['description' => 'Satisfaction rate. Calculation Formula: Count of evaluations marked as satisfied / Count of satisfaction survey responses.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'AverageTalkTime' => ['description' => 'Average talk time, in seconds. Calculation Formula: TotalTalkTime / CallsHandled.', 'type' => 'number', 'format' => 'float', 'example' => '64', 'title' => ''], 'CallsHold' => ['description' => 'Hold count, which is the number of times calls were placed on hold. Each time a call enters the queue and experiences multiple holds, it counts as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionSurveysOffered' => ['description' => 'Sending Count of satisfaction surveys.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'HandleRate' => ['description' => 'Acknowledgement rate. Calculation Formula: CallsHandled / CallsOffered (because acknowledgement events and assign events may fall into different time ranges, the result may exceed 100% in certain cases).', 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''], 'CallsTimeout' => ['description' => 'Timeout count, which is the number of calls that experienced queue (skill group) timeout. If a single call enters the same queue multiple times, each timeout is counted separately.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionSurveysResponded' => ['description' => 'Count of satisfaction survey responses.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageHoldTime' => ['description' => 'Average call hold duration, in seconds. Calculation Formula: TotalHoldTime / CallsHold.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'TotalAbandonedInQueueTime' => ['description' => 'Total queue abandonment duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsAbandonedInQueue' => ['description' => 'Number of calls abandoned in queue, which refers to the number of calls where the customer hung up after entering the queue but before being answered.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsQueuingTimeout' => ['description' => 'Number of calls that timed out during the queuing phase.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsQueuingOverflow' => ['description' => 'Quantity of calls that overflowed from the queue. Queue overflow refers to calls that overflow while queuing in IVR.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AccessChannelTypeDetails' => [ 'description' => 'Statistics for each channel.', 'type' => 'array', 'items' => [ 'description' => 'Statistics for each channel.', 'type' => 'object', 'properties' => [ 'AccessChannelType' => ['description' => 'Channel Type.', 'type' => 'string', 'example' => 'Web', 'title' => ''], 'CallsOffered' => ['description' => 'Quantity of assigned sessions.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'AverageFirstResponseTime' => ['description' => 'Average first response time for chat sessions, in seconds.', 'type' => 'number', 'format' => 'float', 'example' => '6', 'title' => ''], 'AverageResponseTime' => ['description' => 'Average response time for chat sessions.', 'type' => 'number', 'format' => 'float', 'example' => '8', 'title' => ''], 'CallsQueuingFailed' => ['description' => 'Queue Failure Quantity, which is the number of calls where the customer hung up after entering the queue but before being answered.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'ServiceLevel15' => ['description' => 'Service level within 15 seconds.', 'type' => 'number', 'format' => 'float', 'example' => '0.7', 'title' => ''], 'ServiceLevel30' => ['description' => 'Service level within 30 seconds.', 'type' => 'number', 'format' => 'float', 'example' => '0.9', 'title' => ''], 'TotalMessagesSent' => ['description' => 'Total number of messages sent in chat sessions.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], 'TotalMessagesSentByAgent' => ['description' => 'Total number of messages sent by agents in chat sessions.', 'type' => 'integer', 'format' => 'int64', 'example' => '9', 'title' => ''], 'TotalMessagesSentByCustomer' => ['description' => 'Total number of messages sent by the customer in chat sessions.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Outbound' => [ 'description' => 'Outbound metrics. ', 'type' => 'object', 'properties' => [ 'AverageRingTime' => ['description' => 'Average ring time, in seconds. Calculation Formula: TotalRingTime / CallsRinged.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'CallsDialed' => ['description' => 'Number of dialed calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '6', 'title' => ''], 'CallsAnswered' => ['description' => 'Number of answered calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'TotalWorkTime' => ['description' => 'Total post-processing duration, in seconds. ', 'type' => 'integer', 'format' => 'int64', 'example' => '9', 'title' => ''], 'CallsAttendedTransferOut' => ['description' => 'Quantity of attended transfer-out calls, which refers to the number of calls transferred from this skill group to another skill group for consultation. Transfers between agents within the same skill group are not counted.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxWorkTime' => ['description' => 'Maximum post-processing duration per call, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalDialingTime' => ['description' => 'Total dial-up duration, in seconds. ', 'type' => 'integer', 'format' => 'int64', 'example' => '218', 'title' => ''], 'TotalHoldTime' => ['description' => 'Total call hold duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageWorkTime' => ['description' => 'Average post-processing duration per call, in seconds. Calculation Formula: TotalWorkTime / CallsDialed', 'type' => 'number', 'format' => 'float', 'example' => '2', 'title' => ''], 'CallsBlindTransferIn' => ['description' => 'Quantity of direct transfer-in calls, which refers to the number of calls directly transferred to this skill group from other skill groups. Transfers between agents within the same skill group are not counted. If an agent is signed into multiple skill groups simultaneously, the call is attributed to the first skill group the agent signed into. If a single call is transferred multiple times from other skill groups to this skill group, each transfer is counted separately. The same rule applies below.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionIndex' => ['description' => 'Satisfaction index, which is the average value of the single-digit satisfaction key presses.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'CallsRinged' => ['description' => 'Number of calls that rang to agents. Each time a call enters the queue and is assigned to multiple agents, resulting in ringing, it counts as one occurrence.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsAttendedTransferIn' => ['description' => 'Transfer-in volume for consultation, which refers to the number of calls transferred to this skill group from other skill groups for consultation. Transfers between agents within the same skill group are not counted. If an agent joins multiple skill groups simultaneously, the call is attributed to the first skill group the agent signed into. If a single call is transferred multiple times from other skill groups to this skill group, each transfer is counted separately. The same rule applies below.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsBlindTransferOut' => ['description' => 'Quantity of direct transfer-out calls, which refers to the number of calls directly transferred from this skill group to other skill groups. Transfers between agents within the same skill group are not counted.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalRingTime' => ['description' => 'Total ring duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxTalkTime' => ['description' => 'Maximum talk time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxRingTime' => ['description' => 'Maximum ring duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalTalkTime' => ['description' => 'Total talk time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], 'MaxDialingTime' => ['description' => 'Maximum dialing time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], 'AnswerRate' => ['description' => 'Answer rate. Calculation Formula: CallsAnswered / CallsDialed. (Because the call answering event and the acknowledgement event may fall into different time ranges, the result may exceed 100% in certain cases.)', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'MaxHoldTime' => ['description' => 'Maximum hold time during calls, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageTalkTime' => ['description' => 'Average talk time, in seconds. Calculation Formula: TotalTalkTime / CallsAnswered.', 'type' => 'number', 'format' => 'float', 'example' => '3', 'title' => ''], 'SatisfactionRate' => ['description' => 'Satisfaction rate. Calculation Formula: Quantity of evaluations marked as satisfied divided by the Count of satisfaction survey responses.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'CallsHold' => ['description' => 'Number of calls placed on hold. If a call is placed on hold multiple times before being transfer-out from the current skill group, it counts as one occurrence.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionSurveysOffered' => ['description' => 'Sending Count of satisfaction surveys.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionSurveysResponded' => ['description' => 'Response Count of satisfaction surveys.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageHoldTime' => ['description' => 'Average call hold duration, in seconds. Calculation Formula: TotalHoldTime / CallsHold.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'AverageDialingTime' => ['description' => 'Average dial-up duration, in seconds. Calculation Formula: TotalDialingTime / CallsDialed.', 'type' => 'number', 'format' => 'float', 'example' => '37', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Overall' => [ 'description' => 'Overall metrics.', 'type' => 'object', 'properties' => [ 'TotalTalkTime' => ['description' => 'Total talk time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '449', 'title' => ''], 'TotalLoggedInTime' => ['description' => 'Total logon time, in seconds. '."\n" .'_Note: Excludes offline and short break durations._', 'type' => 'integer', 'format' => 'int64', 'example' => '23218', 'title' => ''], 'OccupancyRate' => ['description' => 'Agent occupancy rate. Calculation formula: (TotalWorkTime + TotalTalkTime) / TotalLoggedInTime.', 'type' => 'number', 'format' => 'float', 'example' => '0.02332222293912065', 'title' => ''], 'TotalWorkTime' => ['description' => 'Total post-processing duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '94', 'title' => ''], 'MaxHoldTime' => ['description' => 'Maximum call hold duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxWorkTime' => ['description' => 'Maximum post-processing duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], 'AverageBreakTime' => ['description' => 'Average break duration, in seconds. Calculation Formula: TotalBreakTime / Break Count. Break Count is a non-API statistical field.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'TotalHoldTime' => ['description' => 'Total hold duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionRate' => ['description' => 'Satisfaction rate. Calculation Formula: Number of responses marked as satisfied / Count of satisfaction survey responses.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'MaxBreakTime' => ['description' => 'Maximum break duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'AverageWorkTime' => ['description' => 'Average post-processing time, in seconds. Calculation Formula: TotalWorkTime / TotalCalls.', 'type' => 'number', 'format' => 'float', 'example' => '8', 'title' => ''], 'AverageTalkTime' => ['description' => 'Average talk time, in seconds. Calculation formula: TotalTalkTime / (CallsAnswered + CallsHandled).', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'SatisfactionIndex' => ['description' => 'Satisfaction index, which is the average value of the satisfaction keypress digits (single-digit numbers).', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'SatisfactionSurveysOffered' => ['description' => 'Sending Count of satisfaction surveys.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionSurveysResponded' => ['description' => 'Count of satisfaction survey responses.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxReadyTime' => ['description' => 'Maximum ready time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '19328', 'title' => ''], 'AverageReadyTime' => ['description' => 'Average ready time, in seconds. Calculation Formula: TotalReadyTime / Count of ready events. The count of ready events is not an API statistics field.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'AverageHoldTime' => ['description' => 'Average call hold duration, in seconds. Calculation Formula: TotalHoldTime / (Inbound CallsHold + Outbound CallsHold).', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'TotalReadyTime' => ['description' => 'Total ready time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '22428', 'title' => ''], 'TotalBreakTime' => ['description' => 'Total break time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], 'MaxTalkTime' => ['description' => 'Maximum talk time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalCalls' => ['description' => 'Total call volume. Calculation Formula: CallsOffered + CallsDialed.', 'type' => 'integer', 'format' => 'int64', 'example' => '13', 'title' => ''], 'BreakCodeDetailList' => [ 'description' => 'List of break details.', 'type' => 'array', 'items' => [ 'description' => 'Break detail.', 'type' => 'object', 'properties' => [ 'BreakCode' => ['description' => 'Break type code.', 'type' => 'string', 'example' => '会议', 'title' => ''], 'Count' => ['description' => 'Number of occurrences of this break type.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], 'Duration' => ['description' => 'Total duration of this break type, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '3600', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'Back2Back' => [ 'description' => 'Back-to-back metric.', 'type' => 'object', 'properties' => [ 'CallsDialed' => ['description' => 'Number of dial-up calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'AnswerRate' => ['description' => 'Answer rate. Calculation Formula: CallsAnswered / CallsDialed. (Because acknowledgement events and answer events may fall into different time ranges, the result may exceed 100% in certain cases.)', 'type' => 'number', 'format' => 'float', 'example' => '0.6', 'title' => ''], 'CallsAnswered' => ['description' => 'Number of answered calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalTalkTime' => ['description' => 'Total talk time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'MaxTalkTime' => ['description' => 'Maximum talk time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'AverageTalkTime' => ['description' => 'Average talk time, in seconds.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], 'TotalRingTime' => ['description' => 'Total ring time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'MaxRingTime' => ['description' => 'Maximum ring time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'AverageRingTime' => ['description' => 'Average ring time, in seconds.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], 'TotalCustomerRingTime' => ['description' => 'Total Customer-side ring time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'MaxCustomerRingTime' => ['description' => 'Maximum Customer-side ring time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'AverageCustomerRingTime' => ['description' => 'Average customer-side ring time, in seconds.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], 'AgentHandleRate' => ['description' => 'Agent acknowledgement rate.', 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''], 'CallsCustomerAnswered' => ['description' => 'Number of calls answered by the customer.', 'type' => 'integer', 'format' => 'int64', 'example' => '8', 'title' => ''], 'CustomerAnswerRate' => ['description' => 'Customer answer rate.', 'type' => 'number', 'format' => 'float', 'example' => '0.8', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid. %s', 'description' => ''], ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"26A34338-5CD9-4C95-A7A6-5BDCE76C6B94\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 4,\\n \\"List\\": [\\n {\\n \\"SkillGroupName\\": \\"skillgroup\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Inbound\\": {\\n \\"AverageRingTime\\": 5,\\n \\"CallsOverflow\\": 0,\\n \\"CallsAbandonedInRing\\": 0,\\n \\"CallsHandled\\": 7,\\n \\"TotalWorkTime\\": 85,\\n \\"TotalAbandonedInRingTime\\": 0,\\n \\"MaxWorkTime\\": 12,\\n \\"CallsAttendedTransferOut\\": 0,\\n \\"AverageWaitTime\\": 5,\\n \\"TotalHoldTime\\": 0,\\n \\"MaxAbandonTime\\": 0,\\n \\"AverageWorkTime\\": 13,\\n \\"CallsQueued\\": 7,\\n \\"CallsBlindTransferIn\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"AverageAbandonedInRingTime\\": 0,\\n \\"AverageAbandonTime\\": 0,\\n \\"CallsRinged\\": 7,\\n \\"CallsBlindTransferOut\\": 0,\\n \\"CallsAttendedTransferIn\\": 0,\\n \\"CallsAbandoned\\": 0,\\n \\"MaxAbandonedInQueueTime\\": 0,\\n \\"TotalWaitTime\\": 34,\\n \\"TotalRingTime\\": 32,\\n \\"MaxTalkTime\\": 0,\\n \\"MaxRingTime\\": 12,\\n \\"AbandonRate\\": 0,\\n \\"TotalTalkTime\\": 447,\\n \\"TotalAbandonTime\\": 0,\\n \\"CallsOffered\\": 7,\\n \\"MaxAbandonedInRingTime\\": 0,\\n \\"MaxWaitTime\\": 13,\\n \\"AverageAbandonedInQueueTime\\": 0,\\n \\"ServiceLevel20\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"AverageTalkTime\\": 64,\\n \\"CallsHold\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"HandleRate\\": 1,\\n \\"CallsTimeout\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"TotalAbandonedInQueueTime\\": 0,\\n \\"CallsAbandonedInQueue\\": 0,\\n \\"CallsQueuingTimeout\\": 0,\\n \\"CallsQueuingOverflow\\": 0,\\n \\"AccessChannelTypeDetails\\": [\\n {\\n \\"AccessChannelType\\": \\"Web\\",\\n \\"CallsOffered\\": 2\\n }\\n ],\\n \\"AverageFirstResponseTime\\": 6,\\n \\"AverageResponseTime\\": 8,\\n \\"CallsQueuingFailed\\": 0,\\n \\"ServiceLevel15\\": 0.7,\\n \\"ServiceLevel30\\": 0.9,\\n \\"TotalMessagesSent\\": 12,\\n \\"TotalMessagesSentByAgent\\": 9,\\n \\"TotalMessagesSentByCustomer\\": 3\\n },\\n \\"Outbound\\": {\\n \\"AverageRingTime\\": 0,\\n \\"CallsDialed\\": 6,\\n \\"CallsAnswered\\": 1,\\n \\"TotalWorkTime\\": 9,\\n \\"CallsAttendedTransferOut\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"TotalDialingTime\\": 218,\\n \\"TotalHoldTime\\": 0,\\n \\"AverageWorkTime\\": 2,\\n \\"CallsBlindTransferIn\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"CallsRinged\\": 0,\\n \\"CallsAttendedTransferIn\\": 0,\\n \\"CallsBlindTransferOut\\": 0,\\n \\"TotalRingTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"MaxRingTime\\": 0,\\n \\"TotalTalkTime\\": 3,\\n \\"MaxDialingTime\\": 12,\\n \\"AnswerRate\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"AverageTalkTime\\": 3,\\n \\"SatisfactionRate\\": 0,\\n \\"CallsHold\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"AverageDialingTime\\": 37\\n },\\n \\"Overall\\": {\\n \\"TotalTalkTime\\": 449,\\n \\"TotalLoggedInTime\\": 23218,\\n \\"OccupancyRate\\": 0.02332222293912065,\\n \\"TotalWorkTime\\": 94,\\n \\"MaxHoldTime\\": 0,\\n \\"MaxWorkTime\\": 12,\\n \\"AverageBreakTime\\": 0,\\n \\"TotalHoldTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"MaxBreakTime\\": 1,\\n \\"AverageWorkTime\\": 8,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"MaxReadyTime\\": 19328,\\n \\"AverageReadyTime\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"TotalReadyTime\\": 22428,\\n \\"TotalBreakTime\\": 3,\\n \\"MaxTalkTime\\": 0,\\n \\"TotalCalls\\": 13,\\n \\"BreakCodeDetailList\\": [\\n {\\n \\"BreakCode\\": \\"会议\\",\\n \\"Count\\": 2,\\n \\"Duration\\": 3600\\n }\\n ]\\n },\\n \\"Back2Back\\": {\\n \\"CallsDialed\\": 100,\\n \\"AnswerRate\\": 0.6,\\n \\"CallsAnswered\\": 100,\\n \\"TotalTalkTime\\": 100,\\n \\"MaxTalkTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"TotalRingTime\\": 100,\\n \\"MaxRingTime\\": 100,\\n \\"AverageRingTime\\": 100,\\n \\"TotalCustomerRingTime\\": 100,\\n \\"MaxCustomerRingTime\\": 100,\\n \\"AverageCustomerRingTime\\": 100,\\n \\"AgentHandleRate\\": 1,\\n \\"CallsCustomerAnswered\\": 8,\\n \\"CustomerAnswerRate\\": 0.8\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => 'Obtain skill group Historical Data Report', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-11-22T01:05:26.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListHistoricalSkillGroupReport'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'ListInstances' => [ 'summary' => 'Invoke the ListInstances API to obtain the list of Cloud Contact Center instances under the current Alibaba Cloud account.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccTMAX45'], ], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The paging ordinal number, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The paging size, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '26A34338-5CD9-4C95-A7A6-5BDCE76C6B94', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'Page number, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'Page size, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'TotalCount' => ['description' => 'Total count.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'List' => [ 'description' => 'List.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'Instance status.', 'enumValueTitles' => ['RELEASED' => 'Released', 'RUNNING' => 'Running normally', 'STOPPED' => 'Stopped', 'CREATING' => 'Creating'], 'type' => 'string', 'example' => 'RUNNING', 'title' => '', ], 'ConsoleUrl' => ['description' => 'The URL of the Cloud Contact Center instance, used to access the homepage of the Cloud Call Center instance. It is composed of the specific Cloud Call Center URL followed by the instance ID.', 'type' => 'string', 'example' => 'https://ccc-v2.aliyun.com/#/workbench/ccc-test', 'title' => ''], 'Description' => ['description' => 'The instance description.', 'type' => 'string', 'example' => '云联络中心的测试实例。', 'title' => ''], 'CreateTime' => ['description' => 'The creation time of the instance.', 'type' => 'integer', 'format' => 'int64', 'example' => '1624679747000', 'title' => ''], 'AliyunUid' => ['description' => 'The Alibaba Cloud account ID to which the instance belongs.', 'type' => 'string', 'example' => '157123456789****', 'title' => ''], 'Name' => ['description' => 'The instance name.', 'type' => 'string', 'example' => '测试实例', 'title' => ''], 'DomainName' => ['description' => 'The domain name of the instance, which is globally unique.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'Id' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'AdminList' => [ 'description' => 'Administrator list.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'DisplayName' => ['description' => 'The administrator\'s name.', 'type' => 'string', 'example' => '测试坐席', 'title' => ''], 'Extension' => ['description' => 'Agent extension number.', 'type' => 'string', 'example' => '8032****'."\n", 'title' => ''], 'LoginName' => ['description' => 'Agent logon name.', 'type' => 'string', 'example' => 'agent', 'title' => ''], 'Email' => ['description' => 'Mailbox.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], 'WorkMode' => [ 'description' => 'Work mode.', 'enumValueTitles' => ['ON_SITE' => 'On-site mode', 'OFF_SITE' => 'Off-site mode', 'OFFICE_PHONE' => 'Office phone mode'], 'type' => 'string', 'example' => 'ON_SITE', 'title' => '', ], 'Mobile' => ['description' => 'The agent\'s personal phone number.', 'type' => 'string', 'example' => '1382114****', 'title' => ''], 'UserId' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'RoleName' => [ 'description' => 'Role name.', 'enumValueTitles' => ['Mannager' => 'Skill group leader', 'Agent' => 'Agent', 'Admin' => 'Administrator'], 'type' => 'string', 'example' => 'Admin', 'title' => '', ], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'RoleId' => ['description' => 'The role ID, in the format: role\\@instance ID.', 'type' => 'string', 'example' => 'Admin@ccc-test', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'NumberList' => [ 'description' => 'The list of numbers.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Number' => ['description' => 'The number.', 'type' => 'string', 'example' => '0830011****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Obtain the instance list', 'description' => 'If a RAM user needs to invoke this API, the RAM user must have the "Manage Cloud Call Center (CCC)" permission (AliyunCCCFullAccess).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstances'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"26A34338-5CD9-4C95-A7A6-5BDCE76C6B94\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"Status\\": \\"RUNNING\\",\\n \\"ConsoleUrl\\": \\"https://ccc-v2.aliyun.com/#/workbench/ccc-test\\",\\n \\"Description\\": \\"云联络中心的测试实例。\\",\\n \\"CreateTime\\": 1624679747000,\\n \\"AliyunUid\\": \\"157123456789****\\",\\n \\"Name\\": \\"测试实例\\",\\n \\"DomainName\\": \\"ccc-test\\",\\n \\"Id\\": \\"ccc-test\\",\\n \\"AdminList\\": [\\n {\\n \\"DisplayName\\": \\"测试坐席\\",\\n \\"Extension\\": \\"8032****\\\\n\\",\\n \\"LoginName\\": \\"agent\\",\\n \\"Email\\": \\"username@example.com\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"Mobile\\": \\"1382114****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"RoleName\\": \\"Admin\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"RoleId\\": \\"Admin@ccc-test\\"\\n }\\n ],\\n \\"NumberList\\": [\\n {\\n \\"Number\\": \\"0830011****\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'ListInstancesOfUser' => [ 'summary' => 'You can invoke ListInstancesOfUser to obtain the list of Cloud Contact Center instances to which the User belongs.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccTMAX45'], ], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'Paging ordinal number, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'Paging size, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '3969FC68-CEC2-4398-B76A-60D2F7EDEBAF', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'Page number, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'Page size, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'TotalCount' => ['description' => 'Total count.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'List' => [ 'description' => 'List.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'Instance status.', 'enumValueTitles' => ['RELEASED（已注销）' => 'RELEASED (log off)', 'CREATING（创建中）' => 'CREATING (Creation in progress)', 'RUNNING（正常运行中）' => 'RUNNING (running)', 'STOPPED（已停服）' => 'STOPPED (service stopped)'], 'type' => 'string', 'example' => 'RUNNING', 'title' => '', ], 'ConsoleUrl' => ['description' => 'The URL of the Cloud Contact Center instance, used to access the homepage of the Cloud Contact Center instance. It consists of the specific Cloud Contact Center URL followed by the instance ID.', 'type' => 'string', 'example' => 'https://ccc-v2.aliyun.com/#/workbench/ccc-test', 'title' => ''], 'Description' => ['description' => 'The instance description.', 'type' => 'string', 'example' => '云联络中心的测试实例。', 'title' => ''], 'AliyunUid' => ['description' => 'The Alibaba Cloud Account ID to which the instance belongs.', 'type' => 'string', 'example' => '157123456789****', 'title' => ''], 'Name' => ['description' => 'The instance name.', 'type' => 'string', 'example' => '测试实例', 'title' => ''], 'DomainName' => ['description' => 'The domain name of the instance, which is globally unique.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'Id' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'AdminList' => [ 'description' => 'Administrator list.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'DisplayName' => ['description' => 'The administrator\'s name.', 'type' => 'string', 'example' => '测试坐席', 'title' => ''], 'Extension' => ['description' => 'Agent extension number.', 'type' => 'string', 'example' => '8032****', 'title' => ''], 'LoginName' => ['description' => 'Agent logon name.', 'type' => 'string', 'example' => 'agent', 'title' => ''], 'Email' => ['description' => 'Mailbox.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], 'WorkMode' => [ 'description' => 'Work mode.', 'enumValueTitles' => ['OFF_SITE（场外模式）' => 'OFF\\_SITE (off-site mode)', 'ON_SITE（场内模式）' => 'ON\\_SITE (on-site mode)', 'OFFICE_PHONE（办公电话模式）' => 'OFFICE\\_PHONE (office phone mode)'], 'type' => 'string', 'example' => 'ON_SITE', 'title' => '', ], 'Mobile' => ['description' => 'The agent\'s personal phone number.', 'type' => 'string', 'example' => '1382114****', 'title' => ''], 'UserId' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'RoleName' => [ 'description' => 'Role name.', 'enumValueTitles' => ['Agent' => 'Agent', 'Manager（技能组组长）' => 'Manager (Skill Group Leader)', 'Admin（管理员）' => 'Admin (Administrator)'], 'type' => 'string', 'example' => 'Admin', 'title' => '', ], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'RoleId' => ['description' => 'The role ID, in the format: role\\@instance ID.', 'type' => 'string', 'example' => 'Admin@ccc-test', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'NumberList' => [ 'description' => 'List of numbers.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Active' => ['description' => 'Indicates whether the number is active.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'UserId' => ['description' => 'Agent ID. If this parameter is not empty, the number is a personal outbound number assigned to the agent.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'Number' => ['description' => 'The number.', 'type' => 'string', 'example' => '0830011****', 'title' => ''], 'City' => ['description' => 'The city of the phone number\'s registration location.', 'type' => 'string', 'example' => '乐山', 'title' => ''], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'Usage' => [ 'description' => 'The usage of the number.', 'enumValueTitles' => ['Bidirection（呼入及呼出）' => 'Bidirection (inbound and outbound)', 'Inbound（呼入）' => 'Inbound (incoming calls)', 'Outbound（呼出）' => 'Outbound (outgoing calls)'], 'type' => 'string', 'example' => 'Bidirection', 'title' => '', ], 'ContactFlowId' => ['description' => 'The contact flow ID (IVR) associated with this phone number.', 'type' => 'string', 'example' => 'a3fb6c62-9b49-4942-ae5b-cf2abd4123ek', 'title' => ''], 'Province' => ['description' => 'The province of the phone number\'s registration location.', 'type' => 'string', 'example' => '四川', 'title' => ''], 'SkillGroups' => [ 'description' => 'List of skill groups associated with the phone number.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'DisplayName' => ['description' => 'The display name of the skill group.', 'type' => 'string', 'example' => '测试技能组', 'title' => ''], 'Description' => ['description' => 'Skill group description.', 'type' => 'string', 'example' => '云联络中心的测试技能组。', 'title' => ''], 'PhoneNumberCount' => ['description' => 'Number of phone numbers associated with the skill group.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'SkillGroupId' => ['description' => 'The skill group ID.', 'type' => 'string', 'example' => 'skillgroup@ccc-test', 'title' => ''], 'UserCount' => ['description' => 'The number of agents associated with the skill group.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'Name' => ['description' => 'The name of the skill group.', 'type' => 'string', 'example' => 'skillgroup', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => ''], ], ], 'title' => 'Obtain the instance list to which the User belongs ', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstancesOfUser'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"3969FC68-CEC2-4398-B76A-60D2F7EDEBAF\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"Status\\": \\"RUNNING\\",\\n \\"ConsoleUrl\\": \\"https://ccc-v2.aliyun.com/#/workbench/ccc-test\\",\\n \\"Description\\": \\"云联络中心的测试实例。\\",\\n \\"AliyunUid\\": \\"157123456789****\\",\\n \\"Name\\": \\"测试实例\\",\\n \\"DomainName\\": \\"ccc-test\\",\\n \\"Id\\": \\"ccc-test\\",\\n \\"AdminList\\": [\\n {\\n \\"DisplayName\\": \\"测试坐席\\",\\n \\"Extension\\": \\"8032****\\",\\n \\"LoginName\\": \\"agent\\",\\n \\"Email\\": \\"username@example.com\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"Mobile\\": \\"1382114****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"RoleName\\": \\"Admin\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"RoleId\\": \\"Admin@ccc-test\\"\\n }\\n ],\\n \\"NumberList\\": [\\n {\\n \\"Active\\": true,\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Number\\": \\"0830011****\\",\\n \\"City\\": \\"乐山\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Usage\\": \\"Bidirection\\",\\n \\"ContactFlowId\\": \\"a3fb6c62-9b49-4942-ae5b-cf2abd4123ek\\",\\n \\"Province\\": \\"四川\\",\\n \\"SkillGroups\\": [\\n {\\n \\"DisplayName\\": \\"测试技能组\\",\\n \\"Description\\": \\"云联络中心的测试技能组。\\",\\n \\"PhoneNumberCount\\": 1,\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"UserCount\\": 2,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Name\\": \\"skillgroup\\"\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'ListIntervalAgentReport' => [ 'summary' => 'You can invoke ListIntervalAgentReport to obtain the segment statistical report of a specified agent under a specified instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'AgentId', 'in' => 'query', 'schema' => ['description' => 'Agent ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'agent@ccc-test', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'Start time, formatted as a UNIX timestamp in milliseconds. This parameter is optional. The default value is 00:00:00 of the current day. Time precision for statistics is at the hour level, rounded down to the previous full hour, using a closed interval.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1532448000000', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'End time, formatted as a UNIX timestamp in milliseconds. This parameter is optional. The default value is the current time. If Interval is Daily, the maximum interval between StartTime and EndTime is 180 days. If Interval is Hourly, the maximum interval is 10 days. Time precision for statistics is at the hour level, rounded down to the next full hour, using an open interval. For example, if the start time is 11:12:20 and the end time is 11:45:50, the aligned input time range becomes \\[11:00:00, 12:00:00), meaning greater than or equal to 11:00:00 and less than 12:00:00.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1532707199000', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'Interval', 'in' => 'query', 'schema' => [ 'description' => 'Segment statistics type. Optional. Default value is Daily (aggregated by Day).', 'enumValueTitles' => ['Hourly' => 'Hourly Statistics', 'Daily' => 'Daily Statistics'], 'type' => 'string', 'required' => false, 'example' => 'Hourly', 'title' => '', ], ], [ 'name' => 'MediaType', 'in' => 'query', 'schema' => ['description' => 'Media type. The default value is Audio. Other valid values include Chat and Video.', 'type' => 'string', 'required' => false, 'example' => 'VIDEO', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '943D8EF3-3321-471F-A104-51C96FCA94D6', 'title' => ''], 'Data' => [ 'description' => 'List of agent segment statistics.', 'type' => 'array', 'items' => [ 'description' => 'Agent segment statistics.', 'type' => 'object', 'properties' => [ 'StatsTime' => ['description' => 'Start time of the time segment, formatted as a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1620291600000', 'title' => ''], 'Inbound' => [ 'description' => 'Inbound metrics.', 'type' => 'object', 'properties' => [ 'AverageRingTime' => ['description' => 'Average ring time, in seconds. Calculation Formula: TotalRingTime / CallsRinged.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'CallsHandled' => ['description' => 'Acknowledgement count, which is the number of times agents answered calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalWorkTime' => ['description' => 'Total post-processing time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsAttendedTransferOut' => ['description' => 'Number of transfer-out calls. If a single call is transferred to other agents multiple times, each transfer counts as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxWorkTime' => ['description' => 'Maximum post-processing duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalHoldTime' => ['description' => 'Total hold time during calls, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageWorkTime' => ['description' => 'Average post-processing time, in seconds. Calculation Formula: TotalWorkTime / CallsHandled.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'CallsBlindTransferIn' => ['description' => 'Number of blind transfer-in calls. If a single call is transferred in to this agent multiple times, each transfer counts as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionIndex' => ['description' => 'Satisfaction Index, which is the average of the satisfaction rating digits (single-digit numbers) entered by users.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'CallsRinged' => ['description' => 'Number of calls that rang to the agent.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsAttendedTransferIn' => ['description' => 'Number of attended transfer-ins. If a single call is transferred to the agent multiple times, each transfer counts as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsBlindTransferOut' => ['description' => 'Number of blind transfer-out calls. If a single call is transferred out to other agents multiple times, each transfer counts as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalRingTime' => ['description' => 'Total ring time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxTalkTime' => ['description' => 'Maximum talk time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxRingTime' => ['description' => 'Maximum ring time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalTalkTime' => ['description' => 'Total talk time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsOffered' => ['description' => 'Assigned count, which refers to the number of calls assigned to this agent, including calls blindly transferred or consultatively transferred from other agents.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxHoldTime' => ['description' => 'Maximum call hold duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageTalkTime' => ['description' => 'Average talk time, in seconds. Calculation Formula: TotalTalkTime / CallsHandled.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'SatisfactionRate' => ['description' => 'Satisfaction rate. Calculation Formula: Number of evaluations marked as satisfied / Count of satisfaction survey responses.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'CallsHold' => ['description' => 'Number of calls placed on hold, that is, the count of occurrences where a call was held.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionSurveysOffered' => ['description' => 'Sending Count of satisfaction surveys.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'HandleRate' => ['description' => 'Acknowledgement rate. Calculation Formula: CallsHandled / CallsOffered (because acknowledgement events and assign events may fall into different time ranges, the result may exceed 100% in certain cases).', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'SatisfactionSurveysResponded' => ['description' => 'Response Count of satisfaction surveys.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageHoldTime' => ['description' => 'Average hold time during calls, in seconds. Calculation Formula: TotalHoldTime / CallsHold.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'AccessChannelTypeDetails' => [ 'description' => 'Statistics for each Channel.', 'type' => 'array', 'items' => [ 'description' => 'Statistics for each channel.', 'type' => 'object', 'properties' => [ 'AccessChannelType' => ['description' => 'Channel Type.', 'type' => 'string', 'example' => 'Web', 'title' => ''], 'CallsOffered' => ['description' => 'Number of assigned sessions.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'AverageFirstResponseTime' => ['description' => 'Average first response time for chat sessions, in seconds.', 'type' => 'number', 'format' => 'float', 'example' => '8', 'title' => ''], 'AverageResponseTime' => ['description' => 'Average response time for chat sessions.', 'type' => 'number', 'format' => 'float', 'example' => '10', 'title' => ''], 'ServiceLevel15' => ['description' => 'Service level within 15 seconds.', 'type' => 'number', 'format' => 'float', 'example' => '0.6', 'title' => ''], 'TotalMessagesSent' => ['description' => 'Total number of messages sent in chat sessions.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], 'TotalMessagesSentByAgent' => ['description' => 'Total number of messages sent by the agent in chat sessions.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], 'TotalMessagesSentByCustomer' => ['description' => 'Total number of messages sent by the Customer in chat sessions.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Outbound' => [ 'description' => 'Outbound metrics.', 'type' => 'object', 'properties' => [ 'AverageRingTime' => ['description' => 'Average ring time in seconds. Calculation Formula: TotalRingTime / CallsRinged.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'CallsDialed' => ['description' => 'Dial-up count.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], 'CallsAnswered' => ['description' => 'Answered call count.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalWorkTime' => ['description' => 'Total post-processing duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '4', 'title' => ''], 'CallsAttendedTransferOut' => ['description' => 'Number of transfer-out calls. If a single call is transferred out to other agents multiple times, each transfer-out counts as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxWorkTime' => ['description' => 'Maximum post-processing time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], 'TotalDialingTime' => ['description' => 'Total dial-up duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '148', 'title' => ''], 'TotalHoldTime' => ['description' => 'Total hold duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageWorkTime' => ['description' => 'Average post-processing time in seconds. Calculation Formula: TotalWorkTime / CallsDialed.', 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''], 'CallsBlindTransferIn' => ['description' => 'Number of blind transfer-in calls. If a single call is transferred to the agent multiple times, each transfer counts as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionIndex' => ['description' => 'Satisfaction index, which is the average value of the satisfaction key digits (single-digit numbers).', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'CallsRinged' => ['description' => 'Number of calls that rang for the agent.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsAttendedTransferIn' => ['description' => 'Number of attended transfer-in calls. If a single call is transferred to the agent multiple times, each transfer counts as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsBlindTransferOut' => ['description' => 'Number of blind transfer-out calls. If a single call is transferred to other agents multiple times, each transfer counts as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalRingTime' => ['description' => 'Total ring time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxTalkTime' => ['description' => 'Maximum talk time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxRingTime' => ['description' => 'Maximum ring time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalTalkTime' => ['description' => 'Total talk time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxDialingTime' => ['description' => 'Maximum dial-up duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '60', 'title' => ''], 'AnswerRate' => ['description' => 'Answer rate. Calculation Formula: CallsAnswered / CallsDialed. (Because answering events and acknowledgement events may fall into different Time Ranges, the Result may exceed 100% in certain cases.)', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'MaxHoldTime' => ['description' => 'Maximum hold time during calls, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageTalkTime' => ['description' => 'Average talk time, in seconds. Calculation Formula: TotalTalkTime / CallsAnswered.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'SatisfactionRate' => ['description' => 'Satisfaction rate. Calculation Formula: Count of evaluations marked as satisfied / Count of satisfaction survey responses.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'CallsHold' => ['description' => 'Hold count, which is the number of times call hold occurred.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionSurveysOffered' => ['description' => 'Sending Count of satisfaction surveys.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionSurveysResponded' => ['description' => 'Count of satisfaction survey responses.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageHoldTime' => ['description' => 'Average hold duration, in seconds. Calculation formula: TotalHoldTime / CallsHold.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'AverageDialingTime' => ['description' => 'Average dial-up duration, in seconds. Calculation Formula: TotalDialingTime / CallsDialed.', 'type' => 'number', 'format' => 'float', 'example' => '30', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Overall' => [ 'description' => 'Overall metrics.', 'type' => 'object', 'properties' => [ 'OccupancyRate' => ['description' => 'Agent occupancy rate. Calculation Formula: (TotalWorkTime + TotalTalkTime) / TotalLoggedInTime.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'TotalWorkTime' => ['description' => 'Total post-processing time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '4', 'title' => ''], 'MaxWorkTime' => ['description' => 'Maximum post-processing duration in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], 'TotalHoldTime' => ['description' => 'Total hold time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageWorkTime' => ['description' => 'Average post-processing duration per call, in seconds. Calculation Formula: TotalWorkTime / TotalCalls.', 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''], 'MaxBreakTime' => ['description' => 'Maximum break time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'SatisfactionIndex' => ['description' => 'Satisfaction index, which is the average value of the satisfaction keypress digits (single-digit numbers).', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'MaxReadyTime' => ['description' => 'Maximum ready time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '435', 'title' => ''], 'MaxTalkTime' => ['description' => 'Maximum talk time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalReadyTime' => ['description' => 'Total ready time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '763', 'title' => ''], 'LastCheckoutTime' => ['description' => 'This value is available only when the input parameter Interval is set to Daily, indicating the last unpublish time on that day.', 'type' => 'integer', 'format' => 'int64', 'example' => '已弃用，请使用LastCheckOutTime代替此参数。', 'title' => ''], 'LastCheckOutTime' => ['description' => 'This field has a value only when the input parameter Interval is Daily, representing the last unpublish time of the day.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalCalls' => ['description' => 'Total call volume. Calculation Formula: CallsOffered + CallsDialed.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], 'TotalLoggedInTime' => ['description' => 'Total logon duration, in seconds. Note: Exclude offline and break durations.', 'type' => 'integer', 'format' => 'int64', 'example' => '914', 'title' => ''], 'TotalTalkTime' => ['description' => 'Total talk duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxHoldTime' => ['description' => 'Maximum call hold time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageBreakTime' => ['description' => 'Average break duration, in seconds. Calculation Formula: TotalBreakTime / Count of breaks. The count of breaks is not an API statistics field.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'AverageTalkTime' => ['description' => 'Average talk time, in seconds. Calculation Formula: TotalTalkTime / (CallsAnswered + CallsHandled).', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'SatisfactionRate' => ['description' => 'Satisfaction rate. Calculation Formula: Number of evaluations marked as satisfied / Count of satisfaction survey responses.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'SatisfactionSurveysOffered' => ['description' => 'Sending Count of satisfaction surveys.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionSurveysResponded' => ['description' => 'Response Count of satisfaction surveys.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageHoldTime' => ['description' => 'Average call hold duration, in seconds. Calculation Formula: TotalHoldTime / (Inbound CallsHold + Outbound CallsHold).', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'AverageReadyTime' => ['description' => 'Average ready time, in seconds. Calculation Formula: TotalReadyTime / Count of ready events. The count of ready events is a non-API statistical field.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'TotalBreakTime' => ['description' => 'Total break time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'TotalOnSiteOnlineTime' => ['description' => 'Total on-site online duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '已弃用，请使用TotalOnSiteLoggedInTime代替此参数', 'title' => ''], 'TotalOffSiteOnlineTime' => ['description' => 'Total off-site online duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '已弃用，请使用TotalOffSiteLoggedInTime代替此参数', 'title' => ''], 'TotalOfficePhoneOnlineTime' => ['description' => 'Total office phone online time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '已弃用，请使用TotalOfficePhoneLoggedInTime代替此参数', 'title' => ''], 'BreakCodeDetailList' => [ 'description' => 'List of break details.', 'type' => 'array', 'items' => [ 'description' => 'Break detail.', 'type' => 'object', 'properties' => [ 'BreakCode' => ['description' => 'Break code.', 'type' => 'string', 'example' => '会议', 'title' => ''], 'Count' => ['description' => 'Quantity.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], 'Duration' => ['description' => 'Duration in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'TotalOutboundScenarioTime' => ['description' => 'Total outbound-only scenario duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '已弃用，请使用TotalOutboundScenarioLoggedInTime代替此参数', 'title' => ''], 'TotalOutboundScenarioReadyTime' => ['description' => 'Total idle time for outbound-only scenarios, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'FirstCheckInTime' => ['description' => 'This field has a value only when the input parameter Interval is Daily, representing the first publish time of the day.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalOfficePhoneLoggedInTime' => ['description' => 'Total office phone logged-in time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalOffSiteLoggedInTime' => ['description' => 'Total off-site logged-in duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalOnSiteLoggedInTime' => ['description' => 'Total on-site logged-in duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalOutboundScenarioLoggedInTime' => ['description' => 'Total online time for outbound-only scenarios, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Back2Back' => [ 'description' => 'Back-to-back call metric.', 'type' => 'object', 'properties' => [ 'CallsDialed' => ['description' => 'Number of dial-up calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'AnswerRate' => ['description' => 'Answer rate. Calculation Formula: CallsAnswered / CallsDialed. (Because answer events and acknowledgement events may fall into different time ranges, the result may exceed 100% in certain cases.)', 'type' => 'number', 'format' => 'float', 'example' => '0.5', 'title' => ''], 'CallsAnswered' => ['description' => 'Number of answered calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalTalkTime' => ['description' => 'Total talk time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'MaxTalkTime' => ['description' => 'Maximum talk time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'AverageTalkTime' => ['description' => 'Average talk time, in seconds.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], 'TotalRingTime' => ['description' => 'Total ring time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'MaxRingTime' => ['description' => 'Maximum ring duration in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'AverageRingTime' => ['description' => 'Average ring time, in seconds.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], 'TotalCustomerRingTime' => ['description' => 'Total customer-side ring time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'MaxCustomerRingTime' => ['description' => 'Maximum customer-side ring time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'AverageCustomerRingTime' => ['description' => 'Average customer-side ring duration in seconds.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], 'CallsAgentHandled' => ['description' => 'Number of calls answered by agents.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], 'AgentHandleRate' => ['description' => 'Agent acknowledgement rate.', 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''], 'CallsCustomerAnswered' => ['description' => 'Number of calls answered by customers.', 'type' => 'integer', 'format' => 'int64', 'example' => '9', 'title' => ''], 'CustomerAnswerRate' => ['description' => 'Customer answer rate.', 'type' => 'number', 'format' => 'float', 'example' => '0.75', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Internal' => [ 'description' => 'Internal call metrics.', 'type' => 'object', 'properties' => [ 'AverageTalkTime' => ['description' => 'Average talk time, in seconds.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], 'CallsAnswered' => ['description' => 'Number of answered calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'CallsDialed' => ['description' => 'Number of dial-up calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'CallsHandled' => ['description' => 'Number of acknowledgements, which refers to the number of times the agent acknowledged a call.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'CallsOffered' => ['description' => 'Number of assigned calls, which refers to the count of calls assigned to this agent, including calls blindly transferred or consultatively transferred from other agents.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'CallsTalked' => ['description' => 'Number of calls participated in.', 'type' => 'integer', 'format' => 'int64', 'example' => '80', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid. %s', 'description' => ''], ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => ''], ], ], 'title' => 'Retrieve Agent Segment Statistical Report', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-11-22T01:05:26.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2023-05-23T11:59:01.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntervalAgentReport'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"943D8EF3-3321-471F-A104-51C96FCA94D6\\",\\n \\"Data\\": [\\n {\\n \\"StatsTime\\": 1620291600000,\\n \\"Inbound\\": {\\n \\"AverageRingTime\\": 0,\\n \\"CallsHandled\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"CallsAttendedTransferOut\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"TotalHoldTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"CallsBlindTransferIn\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"CallsRinged\\": 0,\\n \\"CallsAttendedTransferIn\\": 0,\\n \\"CallsBlindTransferOut\\": 0,\\n \\"TotalRingTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"MaxRingTime\\": 0,\\n \\"TotalTalkTime\\": 0,\\n \\"CallsOffered\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"CallsHold\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"HandleRate\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"AccessChannelTypeDetails\\": [\\n {\\n \\"AccessChannelType\\": \\"Web\\",\\n \\"CallsOffered\\": 2\\n }\\n ],\\n \\"AverageFirstResponseTime\\": 8,\\n \\"AverageResponseTime\\": 10,\\n \\"ServiceLevel15\\": 0.6,\\n \\"TotalMessagesSent\\": 12,\\n \\"TotalMessagesSentByAgent\\": 10,\\n \\"TotalMessagesSentByCustomer\\": 2\\n },\\n \\"Outbound\\": {\\n \\"AverageRingTime\\": 0,\\n \\"CallsDialed\\": 5,\\n \\"CallsAnswered\\": 0,\\n \\"TotalWorkTime\\": 4,\\n \\"CallsAttendedTransferOut\\": 0,\\n \\"MaxWorkTime\\": 2,\\n \\"TotalDialingTime\\": 148,\\n \\"TotalHoldTime\\": 0,\\n \\"AverageWorkTime\\": 1,\\n \\"CallsBlindTransferIn\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"CallsRinged\\": 0,\\n \\"CallsAttendedTransferIn\\": 0,\\n \\"CallsBlindTransferOut\\": 0,\\n \\"TotalRingTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"MaxRingTime\\": 0,\\n \\"TotalTalkTime\\": 0,\\n \\"MaxDialingTime\\": 60,\\n \\"AnswerRate\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"CallsHold\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"AverageDialingTime\\": 30\\n },\\n \\"Overall\\": {\\n \\"OccupancyRate\\": 0,\\n \\"TotalWorkTime\\": 4,\\n \\"MaxWorkTime\\": 2,\\n \\"TotalHoldTime\\": 0,\\n \\"AverageWorkTime\\": 1,\\n \\"MaxBreakTime\\": 1,\\n \\"SatisfactionIndex\\": 0,\\n \\"MaxReadyTime\\": 435,\\n \\"MaxTalkTime\\": 0,\\n \\"TotalReadyTime\\": 763,\\n \\"LastCheckoutTime\\": 0,\\n \\"LastCheckOutTime\\": 0,\\n \\"TotalCalls\\": 5,\\n \\"TotalLoggedInTime\\": 914,\\n \\"TotalTalkTime\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"AverageBreakTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"AverageReadyTime\\": 0,\\n \\"TotalBreakTime\\": 1,\\n \\"TotalOnSiteOnlineTime\\": 0,\\n \\"TotalOffSiteOnlineTime\\": 0,\\n \\"TotalOfficePhoneOnlineTime\\": 0,\\n \\"BreakCodeDetailList\\": [\\n {\\n \\"BreakCode\\": \\"会议\\",\\n \\"Count\\": 10,\\n \\"Duration\\": 100\\n }\\n ],\\n \\"TotalOutboundScenarioTime\\": 0,\\n \\"TotalOutboundScenarioReadyTime\\": 100,\\n \\"FirstCheckInTime\\": 0,\\n \\"TotalOfficePhoneLoggedInTime\\": 100,\\n \\"TotalOffSiteLoggedInTime\\": 100,\\n \\"TotalOnSiteLoggedInTime\\": 100,\\n \\"TotalOutboundScenarioLoggedInTime\\": 100\\n },\\n \\"Back2Back\\": {\\n \\"CallsDialed\\": 100,\\n \\"AnswerRate\\": 0.5,\\n \\"CallsAnswered\\": 100,\\n \\"TotalTalkTime\\": 100,\\n \\"MaxTalkTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"TotalRingTime\\": 100,\\n \\"MaxRingTime\\": 100,\\n \\"AverageRingTime\\": 100,\\n \\"TotalCustomerRingTime\\": 100,\\n \\"MaxCustomerRingTime\\": 100,\\n \\"AverageCustomerRingTime\\": 100,\\n \\"CallsAgentHandled\\": 12,\\n \\"AgentHandleRate\\": 1,\\n \\"CallsCustomerAnswered\\": 9,\\n \\"CustomerAnswerRate\\": 0.75\\n },\\n \\"Internal\\": {\\n \\"AverageTalkTime\\": 100,\\n \\"CallsAnswered\\": 100,\\n \\"CallsDialed\\": 100,\\n \\"CallsHandled\\": 100,\\n \\"CallsOffered\\": 100,\\n \\"CallsTalked\\": 80\\n }\\n }\\n ]\\n}","type":"json"}]', ], 'ListIntervalAgentSkillGroupReport' => [ 'summary' => 'Retrieves the interval-based statistical report for a specified agent in a specified instance.', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccOQKOLI'], ], 'parameters' => [ [ 'name' => 'AgentId', 'in' => 'query', 'schema' => ['description' => 'The agent ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'agent@ccc-test', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The start timestamp. The default value is 00:00 on the current day. The statistics are measured in hours and rounded down to the nearest hour. This is a closed interval.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1532448000000', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end time. This is a UNIX timestamp in milliseconds. This parameter is not required. The default value is the current time. If Interval is set to Daily, the maximum interval between StartTime and EndTime is 180 days. If Interval is set to Hourly, the maximum interval is 10 days. The statistics are measured in hours and rounded up to the nearest hour. This is an open interval. For example, if the start time is 11:12:20 and the end time is 11:45:50, the aligned time range for the input parameters is \\[11:00:00, 12:00:00), which means greater than or equal to 11:00 and less than 12:00.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1558443508000', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'Interval', 'in' => 'query', 'schema' => [ 'description' => 'The type of interval-based statistics. This parameter is not required. The default value is Daily (summarized by day).', 'enumValueTitles' => ['Hourly' => 'Statistics are collected by the hour.', 'Daily' => 'Statistics are collected by the day.'], 'type' => 'string', 'required' => false, 'example' => 'Daily', 'title' => '', ], ], [ 'name' => 'SkillGroupId', 'in' => 'query', 'schema' => ['description' => 'The skill group ID.', 'type' => 'string', 'required' => true, 'example' => ' '."\n" .'skg-default@ccc-test'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2778FA12-EDD6-42AA-9B15-AF855072E5E5', 'title' => ''], 'Data' => [ 'description' => 'A list of interval-based statistical data for the agent in the skill group.', 'type' => 'array', 'items' => [ 'description' => 'The interval-based statistical data for the agent in the skill group.', 'type' => 'object', 'properties' => [ 'StatsTime' => ['description' => 'The start time of the time range. This is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1620291600000', 'title' => ''], 'Inbound' => [ 'description' => 'Inbound metrics.', 'type' => 'object', 'properties' => [ 'AverageRingTime' => ['description' => 'The average ring duration, in seconds.', 'type' => 'number', 'format' => 'float', 'example' => '11', 'title' => ''], 'CallsHandled' => ['description' => 'The number of answered calls. This is the number of times the agent answered a call.', 'type' => 'integer', 'format' => 'int64', 'example' => '7', 'title' => ''], 'TotalWorkTime' => ['description' => 'The total post-processing duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '85', 'title' => ''], 'CallsAttendedTransferOut' => ['description' => 'The number of consulted transfers-out. If a call is transferred to other agents multiple times, each transfer is counted as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], 'MaxWorkTime' => ['description' => 'The maximum post-processing duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalHoldTime' => ['description' => 'The total hold duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'AverageWorkTime' => ['description' => 'The average post-processing duration, in seconds. Formula: TotalWorkTime / CallsHandled.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], 'CallsBlindTransferIn' => ['description' => 'The number of blind transfers-in. If a call is transferred to the agent multiple times, each transfer is counted as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'SatisfactionIndex' => ['description' => 'The satisfaction index. This is the average value of the single-digit numbers pressed for satisfaction surveys.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], 'CallsRinged' => ['description' => 'The number of calls that rang for the agent.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'CallsAttendedTransferIn' => ['description' => 'The number of consulted transfers-in. If a call is transferred to the agent multiple times, each transfer is counted as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'CallsBlindTransferOut' => ['description' => 'The number of blind transfers-out. If a call is transferred to other agents multiple times, each transfer is counted as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalRingTime' => ['description' => 'The total ring duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'MaxTalkTime' => ['description' => 'The maximum talk duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'MaxRingTime' => ['description' => 'The maximum ring duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalTalkTime' => ['description' => 'The total talk duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'CallsOffered' => ['description' => 'The number of calls assigned to the agent. This includes calls that are blind transferred or consult transferred to the agent.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'MaxHoldTime' => ['description' => 'The maximum hold duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'AverageTalkTime' => ['description' => 'The average talk duration, in seconds. Formula: TotalTalkTime / CallsHandled.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], 'SatisfactionRate' => ['description' => 'The satisfaction rate. Formula: Number of satisfactory ratings / Number of satisfaction survey responses.', 'type' => 'number', 'format' => 'float', 'example' => '0.5', 'title' => ''], 'CallsHold' => ['description' => 'The number of held calls. This is the number of times a call was put on hold.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'SatisfactionSurveysOffered' => ['description' => 'The number of satisfaction surveys sent.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'HandleRate' => ['description' => 'The answer rate. Formula: CallsHandled / CallsOffered. The result may exceed 100% because the answer event and the assignment event may occur in different time ranges.', 'type' => 'number', 'format' => 'float', 'example' => '0.5', 'title' => ''], 'SatisfactionSurveysResponded' => ['description' => 'The number of satisfaction survey responses.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'AverageHoldTime' => ['description' => 'The average hold duration, in seconds. Formula: TotalHoldTime / CallsHold.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], 'AverageFirstResponseTime' => ['description' => 'The average first response time for chat sessions, in seconds.', 'type' => 'number', 'format' => 'float', 'example' => '6', 'title' => ''], 'AverageResponseTime' => ['description' => 'The average response time for chat sessions.', 'type' => 'number', 'format' => 'float', 'example' => '18', 'title' => ''], 'TotalMessagesSent' => ['description' => 'The total number of messages sent in chat sessions.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], 'TotalMessagesSentByAgent' => ['description' => 'The total number of messages sent by the agent in chat sessions.', 'type' => 'integer', 'format' => 'int64', 'example' => '8', 'title' => ''], 'TotalMessagesSentByCustomer' => ['description' => 'The total number of messages sent by the customer in chat sessions.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Outbound' => [ 'description' => 'Outbound metrics.', 'type' => 'object', 'properties' => [ 'AverageRingTime' => ['description' => 'The average ring duration, in seconds.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], 'CallsDialed' => ['description' => 'The number of dialed calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'CallsAnswered' => ['description' => 'The number of connected calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalWorkTime' => ['description' => 'The total post-processing duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'CallsAttendedTransferOut' => ['description' => 'The number of consulted transfers-out. If a call is transferred to other agents multiple times, each transfer is counted as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'MaxWorkTime' => ['description' => 'The maximum post-processing duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalDialingTime' => ['description' => 'The total dialing duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalHoldTime' => ['description' => 'The total hold duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'AverageWorkTime' => ['description' => 'The average post-processing duration, in seconds. Formula: TotalWorkTime / CallsDialed.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], 'CallsBlindTransferIn' => ['description' => 'The number of blind transfers-in. If a call is transferred to the agent multiple times, each transfer is counted as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'SatisfactionIndex' => ['description' => 'The satisfaction index. This is the average value of the single-digit numbers pressed for satisfaction surveys.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], 'CallsRinged' => ['description' => 'The number of calls that rang for the agent.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'CallsAttendedTransferIn' => ['description' => 'The number of consulted transfers-in. If a call is transferred to the agent multiple times, each transfer is counted as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'CallsBlindTransferOut' => ['description' => 'The number of blind transfers-out. If a call is transferred to other agents multiple times, each transfer is counted as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalRingTime' => ['description' => 'The total ring duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'MaxTalkTime' => ['description' => 'The maximum talk duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxRingTime' => ['description' => 'The maximum ring duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalTalkTime' => ['description' => 'The total talk duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'MaxDialingTime' => ['description' => 'The maximum dialing duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'AnswerRate' => ['description' => 'The connection rate. Formula: CallsAnswered / CallsDialed. The result may exceed 100% because the connection event and the answer event may occur in different time ranges.', 'type' => 'number', 'format' => 'float', 'example' => '0.5', 'title' => ''], 'MaxHoldTime' => ['description' => 'The maximum hold duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'AverageTalkTime' => ['description' => 'The average talk duration, in seconds. Formula: TotalTalkTime / CallsAnswered.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], 'SatisfactionRate' => ['description' => 'The satisfaction rate. Formula: Number of satisfactory ratings / Number of satisfaction survey responses.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], 'CallsHold' => ['description' => 'The number of held calls. This is the number of times a call was put on hold.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'SatisfactionSurveysOffered' => ['description' => 'The number of satisfaction surveys sent.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'SatisfactionSurveysResponded' => ['description' => 'The number of satisfaction survey responses.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'AverageHoldTime' => ['description' => 'The average hold duration, in seconds. Formula: TotalHoldTime / CallsHold.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], 'AverageDialingTime' => ['description' => 'The average dialing duration, in seconds. Formula: TotalDialingTime / CallsDialed.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Overall' => [ 'description' => 'Overall metrics.', 'type' => 'object', 'properties' => [ 'OccupancyRate' => ['description' => 'The agent occupancy rate.', 'type' => 'number', 'format' => 'float', 'example' => '0.4', 'title' => ''], 'TotalWorkTime' => ['description' => 'The total post-processing duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'MaxWorkTime' => ['description' => 'The maximum post-processing duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalHoldTime' => ['description' => 'The total hold duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'AverageWorkTime' => ['description' => 'The average post-processing duration, in seconds. Formula: TotalWorkTime / TotalCalls.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], 'MaxBreakTime' => ['description' => 'The maximum break duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'SatisfactionIndex' => ['description' => 'The satisfaction index. This is the average value of the single-digit numbers pressed for satisfaction surveys.', 'type' => 'number', 'format' => 'float', 'example' => '1.4', 'title' => ''], 'MaxReadyTime' => ['description' => 'The maximum ready duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'MaxTalkTime' => ['description' => 'The maximum talk duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalReadyTime' => ['description' => 'The total ready duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'LastCheckOutTime' => ['description' => 'The last check-out time. This is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1712548421000', 'title' => ''], 'TotalCalls' => ['description' => 'The total number of calls. Formula: CallsOffered + CallsDialed.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalLoggedInTime' => ['description' => 'The total logon duration, in seconds. *Note: This does not include offline and break durations.*', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalTalkTime' => ['description' => 'The total talk duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'MaxHoldTime' => ['description' => 'The maximum hold duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'AverageBreakTime' => ['description' => 'The average break duration, in seconds.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], 'AverageTalkTime' => ['description' => 'The average talk duration, in seconds. Formula: TotalTalkTime / (CallsAnswered + CallsHandled).', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], 'SatisfactionRate' => ['description' => 'The satisfaction rate. Formula: Number of satisfactory ratings / Number of satisfaction survey responses.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], 'SatisfactionSurveysOffered' => ['description' => 'The number of satisfaction surveys sent.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'FirstCheckInTime' => ['description' => 'This parameter has a value only when Interval is set to Daily. It indicates the first up time of the day.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'SatisfactionSurveysResponded' => ['description' => 'The number of satisfaction survey responses.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'AverageHoldTime' => ['description' => 'The average hold duration, in seconds. Formula: TotalHoldTime / (Inbound.CallsHold + Outbound.CallsHold).', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], 'AverageReadyTime' => ['description' => 'The average ready duration, in seconds. Formula: TotalReadyTime / Number of times in Ready state. The number of times in the Ready state is not a statistical field of the API.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], 'TotalBreakTime' => ['description' => 'The total break duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'BreakCodeDetailList' => [ 'description' => 'The list of break details.', 'type' => 'array', 'items' => [ 'description' => 'The break details.', 'type' => 'object', 'properties' => [ 'BreakCode' => ['description' => 'The break code.', 'type' => 'string', 'example' => '开会', 'title' => ''], 'Count' => ['description' => 'The number of times.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'Duration' => ['description' => 'The duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'TotalOutboundScenarioTime' => ['description' => 'The total duration of outbound-only scenarios, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalOutboundScenarioReadyTime' => ['description' => 'The total idle duration in outbound-only scenarios, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalOutboundScenarioLoggedInTime' => ['description' => 'The total online duration in outbound-only scenarios, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalOffSiteLoggedInTime' => ['description' => 'The total off-site online duration, in seconds.', 'type' => 'string', 'example' => '100', 'title' => ''], 'TotalOfficePhoneLoggedInTime' => ['description' => 'The online duration of the office phone, in seconds.', 'type' => 'string', 'example' => '100', 'title' => ''], 'TotalOnSiteLoggedInTime' => ['description' => 'The total on-site online duration, in seconds.', 'type' => 'string', 'example' => '100', 'title' => ''], 'LastCheckoutTime' => ['description' => 'The last check-out time. This is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Internal' => [ 'description' => 'Internal call metrics.', 'type' => 'object', 'properties' => [ 'TotalTalkTime' => ['description' => 'The total talk duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'AverageTalkTime' => ['description' => 'The average talk duration, in seconds.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], 'MaxTalkTime' => ['description' => 'The maximum talk duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'CallsOffered' => ['description' => 'The number of calls assigned to the agent. This includes calls that are blind transferred or consult transferred to the agent.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'CallsHandled' => ['description' => 'The number of answered calls. This is the number of times the agent answered a call. If a call enters a queue and is answered by multiple agents, it is counted as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'CallsTalk' => ['description' => 'This parameter is deprecated. Use CallsTalked instead.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'CallsDialed' => ['description' => 'The number of dialed calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'CallsAnswered' => ['description' => 'The number of connected calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'CallsTalked' => ['description' => 'The number of calls participated in.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Back2Back' => [ 'description' => 'Back-to-back call metrics.', 'type' => 'object', 'properties' => [ 'CallsDialed' => ['description' => 'The number of dialed calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'AnswerRate' => ['description' => 'The connection rate. Formula: CallsAnswered / CallsDialed. The result may exceed 100% because the connection event and the answer event may occur in different time ranges.', 'type' => 'number', 'format' => 'float', 'example' => '0.5', 'title' => ''], 'CallsAnswered' => ['description' => 'The number of connected calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'AgentAnswerRate' => ['description' => 'The answer rate on the agent side.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], 'CallsCustomerHandled' => ['description' => 'The number of calls answered on the customer side.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'CustomerHandleRate' => ['description' => 'The answer rate on the customer side.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], 'TotalTalkTime' => ['description' => 'The total talk duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'MaxTalkTime' => ['description' => 'The maximum talk duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'AverageTalkTime' => ['description' => 'The average talk duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalRingTime' => ['description' => 'The total ring duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'MaxRingTime' => ['description' => 'The maximum ring duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'AverageRingTime' => ['description' => 'The average ring duration, in seconds.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], 'TotalCustomerRingTime' => ['description' => 'The total ring duration on the customer side, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'MaxCustomerRingTime' => ['description' => 'The maximum ring duration on the customer side, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'AverageCustomerRingTime' => ['description' => 'The average ring duration on the customer side, in seconds.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], 'AgentHandleRate' => ['description' => 'The agent answer rate.', 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''], 'CallsCustomerAnswered' => ['description' => 'The number of calls answered by the customer.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], 'CustomerAnswerRate' => ['description' => 'The customer connection rate.', 'type' => 'number', 'format' => 'float', 'example' => '0.6', 'title' => ''], 'CallsAgentHandled' => ['description' => 'The number of calls answered by the agent.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid. %s', 'description' => ''], ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Obtain grouped agent segment statistical report', 'changeSet' => [ ['createdAt' => '2023-11-22T01:05:27.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntervalAgentSkillGroupReport'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"2778FA12-EDD6-42AA-9B15-AF855072E5E5\\",\\n \\"Data\\": [\\n {\\n \\"StatsTime\\": 1620291600000,\\n \\"Inbound\\": {\\n \\"AverageRingTime\\": 11,\\n \\"CallsHandled\\": 7,\\n \\"TotalWorkTime\\": 85,\\n \\"CallsAttendedTransferOut\\": 10,\\n \\"MaxWorkTime\\": 100,\\n \\"TotalHoldTime\\": 100,\\n \\"AverageWorkTime\\": 100,\\n \\"CallsBlindTransferIn\\": 100,\\n \\"SatisfactionIndex\\": 100,\\n \\"CallsRinged\\": 100,\\n \\"CallsAttendedTransferIn\\": 100,\\n \\"CallsBlindTransferOut\\": 100,\\n \\"TotalRingTime\\": 100,\\n \\"MaxTalkTime\\": 100,\\n \\"MaxRingTime\\": 100,\\n \\"TotalTalkTime\\": 100,\\n \\"CallsOffered\\": 100,\\n \\"MaxHoldTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"SatisfactionRate\\": 0.5,\\n \\"CallsHold\\": 100,\\n \\"SatisfactionSurveysOffered\\": 100,\\n \\"HandleRate\\": 0.5,\\n \\"SatisfactionSurveysResponded\\": 100,\\n \\"AverageHoldTime\\": 100,\\n \\"AverageFirstResponseTime\\": 6,\\n \\"AverageResponseTime\\": 18,\\n \\"TotalMessagesSent\\": 12,\\n \\"TotalMessagesSentByAgent\\": 8,\\n \\"TotalMessagesSentByCustomer\\": 5\\n },\\n \\"Outbound\\": {\\n \\"AverageRingTime\\": 100,\\n \\"CallsDialed\\": 100,\\n \\"CallsAnswered\\": 100,\\n \\"TotalWorkTime\\": 100,\\n \\"CallsAttendedTransferOut\\": 100,\\n \\"MaxWorkTime\\": 100,\\n \\"TotalDialingTime\\": 100,\\n \\"TotalHoldTime\\": 100,\\n \\"AverageWorkTime\\": 100,\\n \\"CallsBlindTransferIn\\": 100,\\n \\"SatisfactionIndex\\": 100,\\n \\"CallsRinged\\": 100,\\n \\"CallsAttendedTransferIn\\": 100,\\n \\"CallsBlindTransferOut\\": 100,\\n \\"TotalRingTime\\": 100,\\n \\"MaxTalkTime\\": 0,\\n \\"MaxRingTime\\": 100,\\n \\"TotalTalkTime\\": 100,\\n \\"MaxDialingTime\\": 100,\\n \\"AnswerRate\\": 0.5,\\n \\"MaxHoldTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"SatisfactionRate\\": 100,\\n \\"CallsHold\\": 100,\\n \\"SatisfactionSurveysOffered\\": 100,\\n \\"SatisfactionSurveysResponded\\": 100,\\n \\"AverageHoldTime\\": 100,\\n \\"AverageDialingTime\\": 100\\n },\\n \\"Overall\\": {\\n \\"OccupancyRate\\": 0.4,\\n \\"TotalWorkTime\\": 100,\\n \\"MaxWorkTime\\": 100,\\n \\"TotalHoldTime\\": 100,\\n \\"AverageWorkTime\\": 100,\\n \\"MaxBreakTime\\": 100,\\n \\"SatisfactionIndex\\": 1.4,\\n \\"MaxReadyTime\\": 100,\\n \\"MaxTalkTime\\": 100,\\n \\"TotalReadyTime\\": 100,\\n \\"LastCheckOutTime\\": 1712548421000,\\n \\"TotalCalls\\": 100,\\n \\"TotalLoggedInTime\\": 100,\\n \\"TotalTalkTime\\": 100,\\n \\"MaxHoldTime\\": 100,\\n \\"AverageBreakTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"SatisfactionRate\\": 100,\\n \\"SatisfactionSurveysOffered\\": 100,\\n \\"FirstCheckInTime\\": 100,\\n \\"SatisfactionSurveysResponded\\": 100,\\n \\"AverageHoldTime\\": 100,\\n \\"AverageReadyTime\\": 100,\\n \\"TotalBreakTime\\": 100,\\n \\"BreakCodeDetailList\\": [\\n {\\n \\"BreakCode\\": \\"开会\\",\\n \\"Count\\": 1,\\n \\"Duration\\": 100\\n }\\n ],\\n \\"TotalOutboundScenarioTime\\": 100,\\n \\"TotalOutboundScenarioReadyTime\\": 100,\\n \\"TotalOutboundScenarioLoggedInTime\\": 100,\\n \\"TotalOffSiteLoggedInTime\\": \\"100\\",\\n \\"TotalOfficePhoneLoggedInTime\\": \\"100\\",\\n \\"TotalOnSiteLoggedInTime\\": \\"100\\",\\n \\"LastCheckoutTime\\": 100\\n },\\n \\"Internal\\": {\\n \\"TotalTalkTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"MaxTalkTime\\": 100,\\n \\"CallsOffered\\": 100,\\n \\"CallsHandled\\": 100,\\n \\"CallsTalk\\": 100,\\n \\"CallsDialed\\": 100,\\n \\"CallsAnswered\\": 100,\\n \\"CallsTalked\\": 100\\n },\\n \\"Back2Back\\": {\\n \\"CallsDialed\\": 100,\\n \\"AnswerRate\\": 0.5,\\n \\"CallsAnswered\\": 100,\\n \\"AgentAnswerRate\\": 100,\\n \\"CallsCustomerHandled\\": 100,\\n \\"CustomerHandleRate\\": 100,\\n \\"TotalTalkTime\\": 100,\\n \\"MaxTalkTime\\": 100,\\n \\"AverageTalkTime\\": 100,\\n \\"TotalRingTime\\": 100,\\n \\"MaxRingTime\\": 100,\\n \\"AverageRingTime\\": 100,\\n \\"TotalCustomerRingTime\\": 100,\\n \\"MaxCustomerRingTime\\": 100,\\n \\"AverageCustomerRingTime\\": 100,\\n \\"AgentHandleRate\\": 1,\\n \\"CallsCustomerAnswered\\": 12,\\n \\"CustomerAnswerRate\\": 0.6,\\n \\"CallsAgentHandled\\": 5\\n }\\n }\\n ]\\n}","type":"json"}]', ], 'ListIntervalInstanceReport' => [ 'summary' => 'You can invoke ListIntervalInstanceReport to obtain the segment statistical report for a specified instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'Start Time, in UNIX timestamp format with millisecond precision. This parameter is optional. The default value is 00:00 of the current day. The time granularity for statistics is hourly, rounded down to the nearest hour, and uses a closed interval.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1620230400000', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'End Time, formatted as a UNIX timestamp in milliseconds. This parameter is optional. The default value is the current time. If Interval is Daily, the maximum interval between StartTime and EndTime is 180 days. If Interval is Hourly, the maximum interval is 10 days. The time precision for statistics is hourly, snapped backward to the start of the hour, using an open interval. For example, if the original Start Time is 11:12:20 and End Time is 11:45:50, the aligned time range becomes \\[11:00:00, 12:00:00), meaning greater than or equal to 11:00:00 and less than 12:00:00.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1620316799000', 'title' => ''], ], [ 'name' => 'Interval', 'in' => 'query', 'schema' => [ 'description' => 'Segment statistics type. This parameter is optional. The default value is Daily (daily aggregation).', 'enumValueTitles' => ['Hourly' => 'Hourly statistics', 'Daily' => 'Daily statistics'], 'type' => 'string', 'required' => false, 'example' => 'Hourly', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '943D8EF3-3321-471F-A104-51C96FCA94D6', 'title' => ''], 'Data' => [ 'description' => 'List of instance segment statistics data.', 'type' => 'array', 'items' => [ 'description' => 'Instance segment statistics data.', 'type' => 'object', 'properties' => [ 'StatsTime' => ['description' => 'Start Time, formatted as a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1620230400000', 'title' => ''], 'Inbound' => [ 'description' => 'Inbound metrics.', 'type' => 'object', 'properties' => [ 'AverageRingTime' => ['description' => 'Average ring time, in seconds. Calculation Formula: TotalRingTime / CallsRinged.', 'type' => 'number', 'format' => 'float', 'example' => '5', 'title' => ''], 'CallsVoicemail' => ['description' => 'The number of calls directed to voicemail.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxAbandonedInIVRTime' => ['description' => 'Maximum IVR abandonment duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsHandled' => ['description' => 'The acknowledgement count, which refers to the number of calls answered by agents. If a single call is answered by multiple agents, it is counted as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '7', 'title' => ''], 'CallsIVRException' => ['description' => 'The number of calls with IVR exceptions. A call is counted when the IVR enters a hang-up reason node and the hang-up reason configured for that node is "failed transfer to agent." In this case, the count increases by 1.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsAbandonedInIVR' => ['description' => 'Number of calls abandoned in IVR, which refers to the count of calls where the Customer hung up during the IVR flow after entering the IVR process.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxWorkTime' => ['description' => 'Maximum post-processing time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '17', 'title' => ''], 'TotalHoldTime' => ['description' => 'Total hold time during calls, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxAbandonTime' => ['description' => 'The maximum abandon time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageAbandonTime' => ['description' => 'The average abandon time, in seconds. Calculation Formula: TotalAbandonTime / CallsAbandoned.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'AbandonedRate' => ['description' => 'Deprecated. Refer to the AbandonRate field instead.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'CallsRinged' => ['description' => 'Number of calls that rang to agents. If a single call was assigned to multiple agents and rang for each, it is counted as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '7', 'title' => ''], 'CallsQueuingFailed' => ['description' => 'Queue Failure quantity, which refers to the number of calls where the customer hung up during queuing after the call entered the queue.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalRingTime' => ['description' => 'Total ring time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '32', 'title' => ''], 'TotalTalkTime' => ['description' => 'Total talk time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '447', 'title' => ''], 'MaxAbandonedInRingTime' => ['description' => 'Maximum ring abandonment duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsBlindTransferred' => ['description' => 'Quantity of blind transfers, which is the number of calls that were directly transferred. If a single call was transferred multiple times, it is counted as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageAbandonedInIVRTime' => ['description' => 'Average IVR abandonment time, in seconds. Calculation Formula: TotalAbandonedInIVRTime / CallsAbandonedInIVR.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'AverageAbandonedInQueueTime' => ['description' => 'Average queue abandonment duration, in seconds. Calculation Formula: TotalAbandonedInQueueTime / CallsAbandonedInQueue.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'MaxWaitTime' => ['description' => 'The maximum wait time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '13', 'title' => ''], 'AverageTalkTime' => ['description' => 'Average talk time, in seconds. Calculation Formula: TotalTalkTime / CallsHandled.', 'type' => 'number', 'format' => 'float', 'example' => '64', 'title' => ''], 'CallsAttendedTransferred' => ['description' => 'Number of consult transfers, which refers to the Count of calls that involved a consult transfer. If a single call initiated multiple transfers, it is counted as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalAbandonedInIVRTime' => ['description' => 'Total IVR abandonment duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsQueuingOverflow' => ['description' => 'Quantity of calls that overflowed from the queue, meaning calls that encountered queue overflow while waiting in the IVR queue.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsAbandonedInRing' => ['description' => 'Number of calls abandoned during ringing, which refers to the Quantity of calls where the Customer hung up while the agent\'s phone was ringing.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalAbandonedInRingTime' => ['description' => 'Total abandoned-in-ring time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalWorkTime' => ['description' => 'Total post-processing time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '85', 'title' => ''], 'AverageWaitTime' => ['description' => 'Average wait time, which is the average duration callers wait before an agent answers a call. Calculation Formula: TotalWaitTime / CallsHandled.', 'type' => 'number', 'format' => 'float', 'example' => '5', 'title' => ''], 'AverageWorkTime' => ['description' => 'Average post-processing time, in seconds. Calculation Formula: TotalWorkTime / CallsHandled.', 'type' => 'number', 'format' => 'float', 'example' => '13', 'title' => ''], 'CallsQueued' => ['description' => 'Number of calls that entered the queue. If a single call entered the queue multiple times, it is counted as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '7', 'title' => ''], 'AverageAbandonedInRingTime' => ['description' => 'Average abandoned-in-ring time, in seconds. Calculation Formula: TotalAbandonedInRingTime / CallsAbandonedInRing.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'SatisfactionIndex' => ['description' => 'Satisfaction index, which is the average value of the satisfaction keypress digits (single-digit numbers).', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'CallsAbandoned' => ['description' => 'Total abandoned calls. Calculation Formula: CallsAbandonedInIVR + CallsAbandonedInQueue + CallsAbandonedInRing.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxAbandonedInQueueTime' => ['description' => 'Maximum abandoned-in-queue time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsAbandonedInVoiceNavigator' => ['description' => 'The number of calls abandoned in the Intelligent Navigation module.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalWaitTime' => ['description' => 'The total wait time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '34', 'title' => ''], 'MaxTalkTime' => ['description' => 'Maximum talk time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '219', 'title' => ''], 'MaxRingTime' => ['description' => 'Maximum ring duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], 'TotalAbandonTime' => ['description' => 'Total abandon time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsOffered' => ['description' => 'Number of calls offered to Cloud Contact Center.', 'type' => 'integer', 'format' => 'int64', 'example' => '7', 'title' => ''], 'CallsQueuingTimeout' => ['description' => 'Number of calls that timed out during the queuing phase.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'ServiceLevel20' => ['description' => 'Service level within 20 seconds, calculated as the number of calls with wait time less than or equal to 20 seconds divided by CallsQueued.', 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''], 'MaxHoldTime' => ['description' => 'Maximum hold time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsForwardToOutsideNumber' => ['description' => 'The number of calls forwarded to an external number.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionRate' => ['description' => 'Satisfaction rate. Calculation Formula: Number of evaluations marked as satisfied / Count of satisfaction survey responses.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'CallsHold' => ['description' => 'Number of calls placed on hold. If a single call is placed on hold multiple times, it is counted as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionSurveysOffered' => ['description' => 'Sending Count of satisfaction surveys.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'HandleRate' => ['description' => 'Acknowledgement rate. Calculation Formula: CallsHandled / CallsOffered (because acknowledgement events and assign events may fall into different time ranges, the result may exceed 100% in certain cases).', 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''], 'SatisfactionSurveysResponded' => ['description' => 'The count of satisfaction survey responses.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageHoldTime' => ['description' => 'Average call hold duration, in seconds. Calculation Formula: TotalHoldTime / CallsHold.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'CallsAbandonedInQueue' => ['description' => 'The number of calls abandoned in the queue, which refers to calls where the customer hung up while waiting in the queue after entering it.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalAbandonedInQueueTime' => ['description' => 'Total abandoned-in-queue time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AbandonRate' => ['description' => 'Abandon rate. Calculation Formula: CallsAbandoned / CallsOffered (because management events related to abandonment and assignment may fall into different Time Ranges, the Result may exceed 100% in certain cases).', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'CallsCausedIVRException' => ['description' => 'Number of calls that caused IVR exceptions.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsToVoicemail' => ['description' => 'Quantity of calls transferred to voicemail.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'AverageFirstResponseTime' => ['description' => 'Average first response time for chat sessions, in seconds.', 'type' => 'number', 'format' => 'float', 'example' => '6', 'title' => ''], 'AverageResponseTime' => ['description' => 'Average response time (RT) of chat sessions.', 'type' => 'number', 'format' => 'float', 'example' => '15', 'title' => ''], 'TotalMessagesSent' => ['description' => 'Total number of messages sent in chat sessions.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], 'TotalMessagesSentByAgent' => ['description' => 'Total number of messages sent by agents in chat sessions.', 'type' => 'integer', 'format' => 'int64', 'example' => '8', 'title' => ''], 'TotalMessagesSentByCustomer' => ['description' => 'Total number of messages sent by the Customer in chat sessions.', 'type' => 'integer', 'format' => 'int64', 'example' => '4', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Outbound' => [ 'description' => 'Outbound metrics.', 'type' => 'object', 'properties' => [ 'AverageRingTime' => ['description' => 'Average ring time in seconds. Calculation Formula: TotalRingTime / CallsRinged.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'CallsDialed' => ['description' => 'Number of dialed calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsAnswered' => ['description' => 'Number of answered calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalWorkTime' => ['description' => 'Total post-processing duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxWorkTime' => ['description' => 'Maximum post-processing time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalDialingTime' => ['description' => 'Total dial-up duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalHoldTime' => ['description' => 'Total hold duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageWorkTime' => ['description' => 'Average post-processing time in seconds. Calculation Formula: TotalWorkTime / CallsDialed.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'SatisfactionIndex' => ['description' => 'Satisfaction index, which is the average value of the single-digit satisfaction key presses.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'CallsRinged' => ['description' => 'Number of calls that rang for agents. If a single call is assigned to multiple agents and rings for each, it is counted as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalRingTime' => ['description' => 'Total ring time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxTalkTime' => ['description' => 'Maximum talk time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxRingTime' => ['description' => 'Maximum ring time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalTalkTime' => ['description' => 'Total talk time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxDialingTime' => ['description' => 'Maximum dial-up duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsBlindTransferred' => ['description' => 'Quantity of blind transfers, which refers to the number of calls that were directly transferred. If a single call is transferred multiple times, it counts as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AnswerRate' => ['description' => 'Answer rate. Calculation Formula: CallsAnswered / CallsDialed (because management events for answering and acknowledgement may fall into different Time Ranges, the Result may exceed 100% in certain cases).', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'MaxHoldTime' => ['description' => 'Maximum hold time during calls, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageTalkTime' => ['description' => 'Average talk time, in seconds. Calculation Formula: TotalTalkTime / CallsAnswered.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'SatisfactionRate' => ['description' => 'Satisfaction rate. Calculation Formula: Quantity of evaluations marked as satisfied / Count of satisfaction survey responses.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'CallsAttendedTransferred' => ['description' => 'The number of calls transferred via consultation, which refers to the quantity of calls that underwent consultation-based transfer. If a single call was transferred multiple times, it is counted as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsHold' => ['description' => 'Number of calls placed on hold. If a single call is placed on hold multiple times, it is counted as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionSurveysOffered' => ['description' => 'Sending Count of satisfaction surveys.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionSurveysResponded' => ['description' => 'Count of satisfaction survey responses.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageHoldTime' => ['description' => 'Average hold duration, in seconds. Calculation formula: TotalHoldTime / CallsHold.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'AverageDialingTime' => ['description' => 'Average dial-up duration, in seconds. Calculation Formula: TotalDialingTime / CallsDialed.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Overall' => [ 'description' => 'Overall metrics.', 'type' => 'object', 'properties' => [ 'TotalTalkTime' => ['description' => 'Total talk time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalLoggedInTime' => ['description' => 'Total logon duration, in seconds. Exclude break time.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'OccupancyRate' => ['description' => 'Agent occupancy rate. Calculation Formula: (TotalWorkTime + TotalTalkTime) / TotalLoggedInTime.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'TotalWorkTime' => ['description' => 'Total post-processing time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxHoldTime' => ['description' => 'Maximum call hold time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxWorkTime' => ['description' => 'Maximum post-processing time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageBreakTime' => ['description' => 'Average break time, in seconds. Calculation Formula: TotalBreakTime / Break Count. Break Count is not an API statistics field.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'TotalHoldTime' => ['description' => 'Total hold time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionRate' => ['description' => 'Satisfaction rate. Calculation Formula: Count of evaluations marked as satisfied / Count of satisfaction survey responses.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'MaxBreakTime' => ['description' => 'Maximum break time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageWorkTime' => ['description' => 'Average post-processing time per call, in seconds. Calculation Formula: TotalWorkTime / TotalCalls.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'AverageTalkTime' => ['description' => 'Average talk time, in seconds. Calculation Formula: TotalTalkTime / (CallsAnswered + CallsHandled).', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'SatisfactionIndex' => ['description' => 'Satisfaction index, which is the average value of the satisfaction keypress digits (single-digit numbers).', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'SatisfactionSurveysOffered' => ['description' => 'Sending Count of satisfaction surveys.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionSurveysResponded' => ['description' => 'Response Count of satisfaction surveys.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxReadyTime' => ['description' => 'Maximum ready time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageReadyTime' => ['description' => 'Average ready time, in seconds. Calculation Formula: TotalReadyTime / Ready Count. Ready Count is not an API statistics field.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'AverageHoldTime' => ['description' => 'Average call hold time, in seconds. Calculation Formula: TotalHoldTime / (Inbound Calls on Hold + Outbound Calls on Hold).', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'TotalReadyTime' => ['description' => 'Total ready time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalBreakTime' => ['description' => 'Total break time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxTalkTime' => ['description' => 'Maximum talk time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalCalls' => ['description' => 'Total call volume. Calculation Formula: CallsOffered + CallsDialed.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ], ], 'title' => 'Retrieve instance segment statistical report', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-11-22T01:05:27.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntervalInstanceReport'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"943D8EF3-3321-471F-A104-51C96FCA94D6\\",\\n \\"Data\\": [\\n {\\n \\"StatsTime\\": 1620230400000,\\n \\"Inbound\\": {\\n \\"AverageRingTime\\": 5,\\n \\"CallsVoicemail\\": 0,\\n \\"MaxAbandonedInIVRTime\\": 0,\\n \\"CallsHandled\\": 7,\\n \\"CallsIVRException\\": 0,\\n \\"CallsAbandonedInIVR\\": 0,\\n \\"MaxWorkTime\\": 17,\\n \\"TotalHoldTime\\": 0,\\n \\"MaxAbandonTime\\": 0,\\n \\"AverageAbandonTime\\": 0,\\n \\"AbandonedRate\\": 0,\\n \\"CallsRinged\\": 7,\\n \\"CallsQueuingFailed\\": 0,\\n \\"TotalRingTime\\": 32,\\n \\"TotalTalkTime\\": 447,\\n \\"MaxAbandonedInRingTime\\": 0,\\n \\"CallsBlindTransferred\\": 0,\\n \\"AverageAbandonedInIVRTime\\": 0,\\n \\"AverageAbandonedInQueueTime\\": 0,\\n \\"MaxWaitTime\\": 13,\\n \\"AverageTalkTime\\": 64,\\n \\"CallsAttendedTransferred\\": 0,\\n \\"TotalAbandonedInIVRTime\\": 0,\\n \\"CallsQueuingOverflow\\": 0,\\n \\"CallsAbandonedInRing\\": 0,\\n \\"TotalAbandonedInRingTime\\": 0,\\n \\"TotalWorkTime\\": 85,\\n \\"AverageWaitTime\\": 5,\\n \\"AverageWorkTime\\": 13,\\n \\"CallsQueued\\": 7,\\n \\"AverageAbandonedInRingTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"CallsAbandoned\\": 0,\\n \\"MaxAbandonedInQueueTime\\": 0,\\n \\"CallsAbandonedInVoiceNavigator\\": 0,\\n \\"TotalWaitTime\\": 34,\\n \\"MaxTalkTime\\": 219,\\n \\"MaxRingTime\\": 12,\\n \\"TotalAbandonTime\\": 0,\\n \\"CallsOffered\\": 7,\\n \\"CallsQueuingTimeout\\": 0,\\n \\"ServiceLevel20\\": 1,\\n \\"MaxHoldTime\\": 0,\\n \\"CallsForwardToOutsideNumber\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"CallsHold\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"HandleRate\\": 1,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"CallsAbandonedInQueue\\": 0,\\n \\"TotalAbandonedInQueueTime\\": 0,\\n \\"AbandonRate\\": 0,\\n \\"CallsCausedIVRException\\": 0,\\n \\"CallsToVoicemail\\": 1,\\n \\"AverageFirstResponseTime\\": 6,\\n \\"AverageResponseTime\\": 15,\\n \\"TotalMessagesSent\\": 12,\\n \\"TotalMessagesSentByAgent\\": 8,\\n \\"TotalMessagesSentByCustomer\\": 4\\n },\\n \\"Outbound\\": {\\n \\"AverageRingTime\\": 0,\\n \\"CallsDialed\\": 0,\\n \\"CallsAnswered\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"TotalDialingTime\\": 0,\\n \\"TotalHoldTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"CallsRinged\\": 0,\\n \\"TotalRingTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"MaxRingTime\\": 0,\\n \\"TotalTalkTime\\": 0,\\n \\"MaxDialingTime\\": 0,\\n \\"CallsBlindTransferred\\": 0,\\n \\"AnswerRate\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"CallsAttendedTransferred\\": 0,\\n \\"CallsHold\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"AverageDialingTime\\": 0\\n },\\n \\"Overall\\": {\\n \\"TotalTalkTime\\": 0,\\n \\"TotalLoggedInTime\\": 0,\\n \\"OccupancyRate\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"AverageBreakTime\\": 0,\\n \\"TotalHoldTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"MaxBreakTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"MaxReadyTime\\": 0,\\n \\"AverageReadyTime\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"TotalReadyTime\\": 0,\\n \\"TotalBreakTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"TotalCalls\\": 0\\n }\\n }\\n ]\\n}","type":"json"}]', ], 'ListIntervalSkillGroupReport' => [ 'summary' => 'You can invoke ListIntervalSkillGroupReport to obtain the segment-based statistical report of a specified skill group under a specified instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccOQKOLI'], ], 'parameters' => [ [ 'name' => 'SkillGroupId', 'in' => 'query', 'schema' => ['description' => 'Skill group ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'skg-default@ccc-test', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'Start Time, formatted as a UNIX timestamp in milliseconds. This parameter is optional. The default value is 00:00 of the current day. Statistics are aggregated by hour, rounded down to the nearest hour, and the interval is closed.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1604639129000', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'End Time, formatted as a UNIX timestamp in milliseconds. This parameter is optional. The default value is the current time. If Interval is Daily, the maximum interval between StartTime and EndTime is 180 days. If Interval is Hourly, the maximum interval is 10 days. The time precision for statistics is hourly, snapped backward to the nearest hour, using an open interval. For example, if the Start Time is 11:12:20 and the End Time is 11:45:50, the aligned input parameter Time Range becomes \\[11:00:00, 12:00:00), meaning greater than or equal to 11:00:00 and less than 12:00:00.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1604725528000', 'title' => ''], ], [ 'name' => 'Interval', 'in' => 'query', 'schema' => [ 'description' => 'Segment statistics type. The default is Daily (aggregated by day).', 'enumValueTitles' => ['Hourly' => 'Hourly statistics', 'Daily' => 'Daily statistics'], 'type' => 'string', 'required' => false, 'example' => 'Hourly', 'title' => '', ], ], [ 'name' => 'MediaType', 'in' => 'query', 'schema' => ['description' => 'Media type. The default is Audio. Other valid values include Chat and Video.', 'type' => 'string', 'required' => false, 'example' => 'VIDEO', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '943D8EF3-3321-471F-A104-51C96FCA94D6', 'title' => ''], 'Data' => [ 'description' => 'List of segment-based statistics for the skill group.', 'type' => 'array', 'items' => [ 'description' => 'Segment-based statistics for the skill group.', 'type' => 'object', 'properties' => [ 'StatsTime' => ['description' => 'Start Time of the time segment, formatted as a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1604639129000', 'title' => ''], 'Inbound' => [ 'description' => 'Inbound metrics.', 'type' => 'object', 'properties' => [ 'AverageRingTime' => ['description' => 'Average ring time, in seconds. Calculation Formula: TotalRingTime / CallsRinged.', 'type' => 'number', 'format' => 'float', 'example' => '11', 'title' => ''], 'CallsOverflow' => ['description' => 'Overflow count, which is the number of calls that overflowed from a queue (skill group). If a single call enters the same queue multiple times, each overflow is counted separately.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsAbandonedInRing' => ['description' => 'Ring abandonment count, which refers to the number of calls abandoned by customers while ringing to an agent.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsHandled' => ['description' => 'Acknowledgement count, which is the number of times agents answered calls. For a single call that enters a queue multiple times, if it is answered by multiple agents after one queue entry, it is counted as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], 'TotalWorkTime' => ['description' => 'Total post-processing time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '23', 'title' => ''], 'TotalAbandonedInRingTime' => ['description' => 'Total ringing abandonment duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxWorkTime' => ['description' => 'Maximum post-processing duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '19', 'title' => ''], 'CallsAttendedTransferOut' => ['description' => 'Attended transfer-out count, which refers to the number of calls transferred from this skill group to another skill group for consultation. Transfers between agents within the same skill group are not counted.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageWaitTime' => ['description' => 'Average wait time, which is the average duration a caller waits before an agent answers the call. Calculation Formula: TotalWaitTime / CallsHandled.', 'type' => 'number', 'format' => 'float', 'example' => '11', 'title' => ''], 'TotalHoldTime' => ['description' => 'Total call hold time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxAbandonTime' => ['description' => 'Maximum abandonment time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageWorkTime' => ['description' => 'Average post-processing duration, in seconds. Calculation Formula: TotalWorkTime / CallsHandled.', 'type' => 'number', 'format' => 'float', 'example' => '8', 'title' => ''], 'CallsQueued' => ['description' => 'Number of inbound calls entering a queue (skill group). If a single call enters the same queue multiple times, each entry is counted separately.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], 'CallsBlindTransferIn' => ['description' => 'Quantity of blind transfer-in calls, which refers to the number of calls directly transferred into this skill group from other skill groups. Transfers between agents within the same skill group are not counted. If an agent is signed into multiple skill groups simultaneously, the call is attributed to the first skill group the agent signed into. If a single call is transferred multiple times from other skill groups into this skill group, each transfer is counted separately. The same rule applies below.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionIndex' => ['description' => 'Satisfaction index, which is the average value of the satisfaction rating digits (single-digit numbers) entered by callers.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'AverageAbandonedInRingTime' => ['description' => 'Average ringing abandonment duration, in seconds. Calculation Formula: TotalAbandonedInRingTime / CallsAbandonedInRing.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'AverageAbandonTime' => ['description' => 'Average abandonment duration, in seconds. Calculation Formula: TotalAbandonTime / CallsAbandoned.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'CallsRinged' => ['description' => 'Number of calls that rang to agents. Each time a call enters the queue and is assigned to multiple agents, resulting in ringing, it is counted as one occurrence.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], 'CallsBlindTransferOut' => ['description' => 'Quantity of blind transfer-out calls, which refers to the number of calls directly transferred out from this skill group to other skill groups. Transfers between agents within the same skill group are not counted.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsAttendedTransferIn' => ['description' => 'Attended transfer-in count, which is the number of calls transferred to this skill group via attended transfers initiated from other skill groups. Transfers between agents within the same skill group are not counted. If an agent signs in to multiple skill groups simultaneously, the call is attributed to the first skill group the agent signed in to. If a single call is transferred from another skill group to this skill group multiple times, each transfer is counted separately. The same rule applies below.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsAbandoned' => ['description' => 'Abandoned call quantity. Calculation Formula: CallsAbandonedInQueue + CallsAbandonedInRing.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxAbandonedInQueueTime' => ['description' => 'Maximum queue abandonment duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalWaitTime' => ['description' => 'Total wait time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '33', 'title' => ''], 'TotalRingTime' => ['description' => 'Total ringing duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '33', 'title' => ''], 'MaxTalkTime' => ['description' => 'Maximum talk duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '6', 'title' => ''], 'MaxRingTime' => ['description' => 'Maximum ring duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '18', 'title' => ''], 'AbandonRate' => ['description' => 'Abandon rate. Calculation Formula: CallsAbandoned / CallsOffered (because management events related to abandonment and assignment may fall into different time ranges, the result may exceed 100% in certain cases).', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'TotalTalkTime' => ['description' => 'Total talk duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '9', 'title' => ''], 'TotalAbandonTime' => ['description' => 'Total abandonment duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsOffered' => ['description' => 'Assigned call volume, which is the number of calls assigned to this skill group, including calls assigned through queues and calls assigned via transfers (consultation transfers and direct transfers). Calculation formula: CallsQueued + CallsBlindTransferIn + CallsAttendedTransferIn.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], 'MaxAbandonedInRingTime' => ['description' => 'Maximum ring abandonment duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxWaitTime' => ['description' => 'Maximum wait time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '18', 'title' => ''], 'AverageAbandonedInQueueTime' => ['description' => 'Average abandoned-in-queue duration, in seconds. Calculation Formula: TotalAbandonedInQueueTime / CallsAbandonedInQueue.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'ServiceLevel20' => ['description' => 'Service level within 20 seconds: the number of calls with waiting time less than or equal to 20 seconds divided by CallsQueued.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'MaxHoldTime' => ['description' => 'Maximum hold duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionRate' => ['description' => 'Satisfaction rate. Calculation Formula: Number of evaluations marked as satisfied divided by the count of satisfaction survey responses.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'AverageTalkTime' => ['description' => 'Average talk duration, in seconds. Calculation Formula: TotalTalkTime / CallsHandled.', 'type' => 'number', 'format' => 'float', 'example' => '5', 'title' => ''], 'CallsHold' => ['description' => 'Hold count, which is the number of times calls were placed on hold. If a single call enters the queue and is placed on hold multiple times, it is counted as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionSurveysOffered' => ['description' => 'Sending Count of satisfaction surveys.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'HandleRate' => ['description' => 'Acknowledgement rate. Calculation Formula: CallsHandled / CallsOffered (because acknowledgement events and assignment events may fall into different time ranges, the result may exceed 100% in certain cases).', 'type' => 'number', 'format' => 'float', 'example' => '0.6666666666666666', 'title' => ''], 'CallsTimeout' => ['description' => 'Timeout count, which is the number of calls that timed out in a queue (skill group). If a single call enters the same queue multiple times, each timeout is counted separately.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionSurveysResponded' => ['description' => 'Count of satisfaction survey responses.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageHoldTime' => ['description' => 'Average hold time during calls, in seconds. Calculation Formula: TotalHoldTime / CallsHold.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'TotalAbandonedInQueueTime' => ['description' => 'Total queue abandonment duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsAbandonedInQueue' => ['description' => 'Quantity of abandoned calls in queue, which refers to the number of calls where the customer hung up after entering the queue but before being answered.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsQueuingOverflow' => ['description' => 'Number of calls that overflowed from the queue, meaning calls that experienced queue overflow while waiting in the IVR queue.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsQueuingTimeout' => ['description' => 'Number of calls that timed out during the queuing phase.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalMessagesSent' => ['description' => 'Total number of messages sent in chat sessions.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], 'TotalMessagesSentByAgent' => ['description' => 'Total number of messages sent by agents in chat sessions.', 'type' => 'integer', 'format' => 'int64', 'example' => '7', 'title' => ''], 'TotalMessagesSentByCustomer' => ['description' => 'Total number of messages sent by the Customer in chat sessions.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], 'AverageFirstResponseTime' => ['description' => 'Average first response time for chat sessions, in seconds.', 'type' => 'number', 'format' => 'float', 'example' => '6', 'title' => ''], 'AverageResponseTime' => ['description' => 'Average response time for chat sessions.', 'type' => 'number', 'format' => 'float', 'example' => '18', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Outbound' => [ 'description' => 'Outbound metrics.', 'type' => 'object', 'properties' => [ 'AverageRingTime' => ['description' => 'Average ring time in seconds. Calculation Formula: TotalRingTime / CallsRinged.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'CallsDialed' => ['description' => 'Dialed call count.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], 'CallsAnswered' => ['description' => 'Answered call count.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'TotalWorkTime' => ['description' => 'Total post-processing duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], 'CallsAttendedTransferOut' => ['description' => 'Transfer-out call volume, which refers to the number of calls initiated by this skill group and transferred to other skill groups. Transfers between agents within the same skill group are not counted.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxWorkTime' => ['description' => 'Maximum post-processing time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '4', 'title' => ''], 'TotalDialingTime' => ['description' => 'Total dial-up duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '60', 'title' => ''], 'TotalHoldTime' => ['description' => 'Total hold time during calls, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageWorkTime' => ['description' => 'Average post-processing time in seconds. Calculation Formula: TotalWorkTime / CallsDialed.', 'type' => 'number', 'format' => 'float', 'example' => '3', 'title' => ''], 'CallsBlindTransferIn' => ['description' => 'Direct transfer-in calls, which refer to the number of calls directly transferred to this skill group from other skill groups. Transfers between agents within the same skill group are not counted. If an agent is signed into multiple skill groups simultaneously, the call is attributed to the first skill group the agent signed into. If a single call is transferred multiple times from other skill groups to this skill group, each transfer is counted separately. The same rule applies below.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionIndex' => ['description' => 'Satisfaction index, which is the average value of the satisfaction key digits (single-digit numbers).', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'CallsRinged' => ['description' => 'Number of calls that rang to agents. Each call is counted once per queue entry, even if it was assigned to multiple agents and rang multiple times.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsAttendedTransferIn' => ['description' => 'Transfer-in calls, which refer to the number of calls transferred to this skill group from other skill groups. Transfers between agents within the same skill group are not counted. If an agent is signed into multiple skill groups simultaneously, the call is attributed to the first skill group the agent signed into. If a single call is transferred multiple times from other skill groups to this skill group, each transfer is counted separately. The same rule applies below.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsBlindTransferOut' => ['description' => 'Direct transfer-out calls, which refer to the number of calls directly transferred from this skill group to other skill groups. Transfers between agents within the same skill group are not counted.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalRingTime' => ['description' => 'Total ring time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxTalkTime' => ['description' => 'Maximum talk time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], 'MaxRingTime' => ['description' => 'Maximum ring time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalTalkTime' => ['description' => 'Total talk time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], 'MaxDialingTime' => ['description' => 'Maximum dial-up duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '49', 'title' => ''], 'AnswerRate' => ['description' => 'Answer rate. Calculation Formula: CallsAnswered / CallsDialed (because management events for answering and acknowledgement may fall into different Time Ranges, the Result may exceed 100% in certain cases).', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'MaxHoldTime' => ['description' => 'Maximum hold time during a call, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageTalkTime' => ['description' => 'Average talk time, in seconds. Calculation Formula: TotalTalkTime / CallsAnswered.', 'type' => 'number', 'format' => 'float', 'example' => '5', 'title' => ''], 'SatisfactionRate' => ['description' => 'Satisfaction rate. Calculation Formula: number of evaluations marked as satisfied / Count of satisfaction survey responses.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'CallsHold' => ['description' => 'Hold count, which is the number of calls that were placed on hold. If a single call was placed on hold multiple times before being transferred out of the current skill group, it is counted as one.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionSurveysOffered' => ['description' => 'Sending Count of satisfaction surveys.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionSurveysResponded' => ['description' => 'Count of satisfaction survey responses.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageHoldTime' => ['description' => 'Average hold time during calls, in seconds. Calculation formula: TotalHoldTime / CallsHold.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'AverageDialingTime' => ['description' => 'Average dial-up duration, in seconds. Calculation Formula: TotalDialingTime / CallsDialed.', 'type' => 'number', 'format' => 'float', 'example' => '30', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Overall' => [ 'description' => 'Overall metrics.', 'type' => 'object', 'properties' => [ 'TotalTalkTime' => ['description' => 'Total talk time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '13', 'title' => ''], 'TotalLoggedInTime' => ['description' => 'Total logon duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '9236', 'title' => ''], 'OccupancyRate' => ['description' => 'Agent occupancy rate, calculated using the formula: (TotalWorkTime + TotalTalkTime) / TotalLoggedInTime.', 'type' => 'number', 'format' => 'float', 'example' => '0.00422315148470254', 'title' => ''], 'TotalWorkTime' => ['description' => 'Total post-processing time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '27', 'title' => ''], 'MaxHoldTime' => ['description' => 'Maximum call hold duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxWorkTime' => ['description' => 'Maximum post-processing duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '19', 'title' => ''], 'AverageBreakTime' => ['description' => 'Average break time, in seconds. Calculation Formula: TotalBreakTime / Count of breaks. The Count of breaks is not a field provided by the API.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'TotalHoldTime' => ['description' => 'Total hold time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionRate' => ['description' => 'Satisfaction rate. Calculation Formula: Number of evaluations marked as satisfied / Count of satisfaction survey responses.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'MaxBreakTime' => ['description' => 'Maximum break duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'AverageWorkTime' => ['description' => 'Average post-processing time, in seconds. Calculation Formula: TotalWorkTime / TotalCalls.', 'type' => 'number', 'format' => 'float', 'example' => '6', 'title' => ''], 'AverageTalkTime' => ['description' => 'Average talk time, in seconds. Calculation Formula: TotalTalkTime / (CallsAnswered + CallsHandled).', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'SatisfactionIndex' => ['description' => 'Satisfaction index, which is the average value of the single-digit satisfaction rating entered by users.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'SatisfactionSurveysOffered' => ['description' => 'Sending Count of satisfaction surveys.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionSurveysResponded' => ['description' => 'Count of satisfaction survey responses.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxReadyTime' => ['description' => 'Maximum ready time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '4927', 'title' => ''], 'AverageReadyTime' => ['description' => 'Average ready time, in seconds. Calculation Formula: TotalReadyTime / Count of ready events. The count of ready events is not an API statistical field.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'AverageHoldTime' => ['description' => 'Average call hold time, in seconds. Calculation Formula: TotalHoldTime / (Inbound CallsHold + Outbound CallsHold).', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'TotalReadyTime' => ['description' => 'Total ready time in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '9106', 'title' => ''], 'TotalBreakTime' => ['description' => 'Total break time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], 'MaxTalkTime' => ['description' => 'Maximum talk time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '6', 'title' => ''], 'TotalCalls' => ['description' => 'Total call volume. Calculation Formula: CallsOffered + CallsDialed.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], 'BreakCodeDetailList' => [ 'description' => 'Statistics for each break type.', 'type' => 'array', 'items' => [ 'description' => 'Break statistics.', 'type' => 'object', 'properties' => [ 'BreakCode' => ['description' => 'Break type code.', 'type' => 'string', 'example' => '会议', 'title' => ''], 'Count' => ['description' => 'Number of occurrences of this break type.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'Duration' => ['description' => 'Total duration of this break type, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '120', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'Back2Back' => [ 'description' => 'Back-to-back call metric.', 'type' => 'object', 'properties' => [ 'MaxRingTime' => ['description' => 'Maximum ring time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'AverageCustomerRingTime' => ['description' => 'Average ring time on the Customer side, in seconds.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], 'CallsCustomerAnswered' => ['description' => 'Quantity of calls answered by the Customer.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], 'CustomerAnswerRate' => ['description' => 'Customer answer rate.', 'type' => 'number', 'format' => 'float', 'example' => '0.6', 'title' => ''], 'TotalRingTime' => ['description' => 'Total ring time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'CallsDialed' => ['description' => 'Dial-up volume.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'CallsAnswered' => ['description' => 'Call connection volume.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalTalkTime' => ['description' => 'Total talk time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'AverageRingTime' => ['description' => 'Average ring time, in seconds.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'title' => ''], 'MaxCustomerRingTime' => ['description' => 'Maximum customer-side ring time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalCustomerRingTime' => ['description' => 'Total customer-side ring time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'AgentHandleRate' => ['description' => 'Agent acknowledgement rate.', 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''], 'MaxTalkTime' => ['description' => 'Maximum talk time, in seconds.', 'type' => 'string', 'example' => '100', 'title' => ''], 'AnswerRate' => ['description' => 'Answer rate. Calculation Formula: CallsAnswered / CallsDialed. (Because management events for answering and acknowledgement may fall into different Time Ranges, the Result may exceed 100% in certain cases.)', 'type' => 'string', 'example' => '0.5', 'title' => ''], 'AverageTalkTime' => ['description' => 'Average talk time, in seconds.', 'type' => 'string', 'example' => '100', 'title' => ''], 'CallsAgentHandled' => ['description' => 'Quantity of calls handled by agents.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ], ], 'title' => 'Obtain skill group segment statistical report', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-11-22T01:05:26.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntervalSkillGroupReport'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"943D8EF3-3321-471F-A104-51C96FCA94D6\\",\\n \\"Data\\": [\\n {\\n \\"StatsTime\\": 1604639129000,\\n \\"Inbound\\": {\\n \\"AverageRingTime\\": 11,\\n \\"CallsOverflow\\": 0,\\n \\"CallsAbandonedInRing\\": 0,\\n \\"CallsHandled\\": 2,\\n \\"TotalWorkTime\\": 23,\\n \\"TotalAbandonedInRingTime\\": 0,\\n \\"MaxWorkTime\\": 19,\\n \\"CallsAttendedTransferOut\\": 0,\\n \\"AverageWaitTime\\": 11,\\n \\"TotalHoldTime\\": 0,\\n \\"MaxAbandonTime\\": 0,\\n \\"AverageWorkTime\\": 8,\\n \\"CallsQueued\\": 3,\\n \\"CallsBlindTransferIn\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"AverageAbandonedInRingTime\\": 0,\\n \\"AverageAbandonTime\\": 0,\\n \\"CallsRinged\\": 3,\\n \\"CallsBlindTransferOut\\": 0,\\n \\"CallsAttendedTransferIn\\": 0,\\n \\"CallsAbandoned\\": 0,\\n \\"MaxAbandonedInQueueTime\\": 0,\\n \\"TotalWaitTime\\": 33,\\n \\"TotalRingTime\\": 33,\\n \\"MaxTalkTime\\": 6,\\n \\"MaxRingTime\\": 18,\\n \\"AbandonRate\\": 0,\\n \\"TotalTalkTime\\": 9,\\n \\"TotalAbandonTime\\": 0,\\n \\"CallsOffered\\": 3,\\n \\"MaxAbandonedInRingTime\\": 0,\\n \\"MaxWaitTime\\": 18,\\n \\"AverageAbandonedInQueueTime\\": 0,\\n \\"ServiceLevel20\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"AverageTalkTime\\": 5,\\n \\"CallsHold\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"HandleRate\\": 0.6666666666666666,\\n \\"CallsTimeout\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"TotalAbandonedInQueueTime\\": 0,\\n \\"CallsAbandonedInQueue\\": 0,\\n \\"CallsQueuingOverflow\\": 0,\\n \\"CallsQueuingTimeout\\": 0,\\n \\"TotalMessagesSent\\": 12,\\n \\"TotalMessagesSentByAgent\\": 7,\\n \\"TotalMessagesSentByCustomer\\": 5,\\n \\"AverageFirstResponseTime\\": 6,\\n \\"AverageResponseTime\\": 18\\n },\\n \\"Outbound\\": {\\n \\"AverageRingTime\\": 0,\\n \\"CallsDialed\\": 2,\\n \\"CallsAnswered\\": 1,\\n \\"TotalWorkTime\\": 5,\\n \\"CallsAttendedTransferOut\\": 0,\\n \\"MaxWorkTime\\": 4,\\n \\"TotalDialingTime\\": 60,\\n \\"TotalHoldTime\\": 0,\\n \\"AverageWorkTime\\": 3,\\n \\"CallsBlindTransferIn\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"CallsRinged\\": 0,\\n \\"CallsAttendedTransferIn\\": 0,\\n \\"CallsBlindTransferOut\\": 0,\\n \\"TotalRingTime\\": 0,\\n \\"MaxTalkTime\\": 5,\\n \\"MaxRingTime\\": 0,\\n \\"TotalTalkTime\\": 5,\\n \\"MaxDialingTime\\": 49,\\n \\"AnswerRate\\": 0,\\n \\"MaxHoldTime\\": 0,\\n \\"AverageTalkTime\\": 5,\\n \\"SatisfactionRate\\": 0,\\n \\"CallsHold\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"AverageDialingTime\\": 30\\n },\\n \\"Overall\\": {\\n \\"TotalTalkTime\\": 13,\\n \\"TotalLoggedInTime\\": 9236,\\n \\"OccupancyRate\\": 0.00422315148470254,\\n \\"TotalWorkTime\\": 27,\\n \\"MaxHoldTime\\": 0,\\n \\"MaxWorkTime\\": 19,\\n \\"AverageBreakTime\\": 0,\\n \\"TotalHoldTime\\": 0,\\n \\"SatisfactionRate\\": 0,\\n \\"MaxBreakTime\\": 1,\\n \\"AverageWorkTime\\": 6,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"MaxReadyTime\\": 4927,\\n \\"AverageReadyTime\\": 0,\\n \\"AverageHoldTime\\": 0,\\n \\"TotalReadyTime\\": 9106,\\n \\"TotalBreakTime\\": 5,\\n \\"MaxTalkTime\\": 6,\\n \\"TotalCalls\\": 5,\\n \\"BreakCodeDetailList\\": [\\n {\\n \\"BreakCode\\": \\"会议\\",\\n \\"Count\\": 1,\\n \\"Duration\\": 120\\n }\\n ]\\n },\\n \\"Back2Back\\": {\\n \\"MaxRingTime\\": 100,\\n \\"AverageCustomerRingTime\\": 100,\\n \\"CallsCustomerAnswered\\": 12,\\n \\"CustomerAnswerRate\\": 0.6,\\n \\"TotalRingTime\\": 100,\\n \\"CallsDialed\\": 100,\\n \\"CallsAnswered\\": 100,\\n \\"TotalTalkTime\\": 100,\\n \\"AverageRingTime\\": 100,\\n \\"MaxCustomerRingTime\\": 100,\\n \\"TotalCustomerRingTime\\": 100,\\n \\"AgentHandleRate\\": 1,\\n \\"MaxTalkTime\\": \\"100\\",\\n \\"AnswerRate\\": \\"0.5\\",\\n \\"AverageTalkTime\\": \\"100\\",\\n \\"CallsAgentHandled\\": 5\\n }\\n }\\n ]\\n}","type":"json"}]', ], 'ListIvrTrackingDetails' => [ 'summary' => 'Invoke ListIvrTrackingDetails to obtain the IVR tracking details of a specified call under a specified instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc5HY0NN'], ], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'Page number, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '1000', 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'Page size, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'title' => ''], ], [ 'name' => 'ContactId', 'in' => 'query', 'schema' => ['description' => 'The call ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-10963442671187****', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'D2RB671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'Page number, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'Page size, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'TotalCount' => ['description' => 'Total count.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], 'List' => [ 'description' => 'List of IVR tracking details.', 'type' => 'array', 'items' => [ 'description' => 'IVR tracking detail.', 'type' => 'object', 'properties' => [ 'Instance' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'Callee' => ['description' => 'Callee number.', 'type' => 'string', 'example' => '0533128****', 'title' => ''], 'EnterTime' => ['description' => 'The time when the call entered this IVR edge zone, in Unix timestamp format, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1621910542876', 'title' => ''], 'NodeVariables' => ['description' => 'Node variables.', 'type' => 'object', 'example' => '{"digits":"2"}', 'title' => ''], 'NodeExitCode' => [ 'description' => 'Status code of the edge zone.', 'enumValueTitles' => ['Timeout' => 'Queue/function/Digit collection timeout', 'Hangup' => 'Customer hung up', 'Default' => 'Default exit of logical judgment', 'Branch-A/B/C' => 'Exits of individual logical judgments', 'Success' => 'Succeeded', 'Failure' => 'Failed', 'Overflow' => 'Queue overflow'], 'type' => 'string', 'example' => 'Success', 'title' => '', ], 'FlowName' => ['description' => 'The name of the contact flow.', 'type' => 'string', 'example' => '测试IVR', 'title' => ''], 'FlowId' => ['description' => 'Contact flow ID.', 'type' => 'string', 'example' => 'abc99462-1058-47d0-a114-f145ea7444ff', 'title' => ''], 'NodeProperties' => ['description' => 'A collection of properties of the edge zone.', 'type' => 'object', 'example' => '{"say":"您好。"}', 'title' => ''], 'NodeType' => [ 'description' => 'File Type.', 'enumValueTitles' => [ 'ASR' => 'speech recognition', 'SUB' => 'child flow', 'INCOMING_CALL' => 'Start', 'GATHER_INPUT' => 'Collect input', 'SUB_END' => 'End child flow', 'BLIND_TRANSFER' => 'Blind transfer', 'JSON_PARSER' => 'JSON parse', 'SUB_START' => 'Start child flow', 'SATISFACTION_RATING' => 'Collect satisfaction rating', 'TRANSFER_TO_AGENT' => 'Transfer to agent', 'SPLIT' => 'branch', 'SET_VARIABLES' => 'Set Variables', 'VOICE_NAVIGATOR' => 'Intelligent Navigation', 'PLAY_SAY' => 'Play Audio', 'HANGUP_REASON' => 'Hangup Reason', 'HANGUP' => 'End', 'SMS' => 'Send Text Message', 'VOICE_MAIL' => 'Voicemail', 'RUN_FUNCTION' => 'Function Compute', 'HTTP_REQUEST' => 'HTTP Request', 'FORWARD_TO_OUTSIDE_NUMBER' => 'Forward to External Number', ], 'type' => 'string', 'example' => 'PLAY_SAY', 'title' => '', ], 'Caller' => ['description' => 'The calling number.', 'type' => 'string', 'example' => '1332315****', 'title' => ''], 'NodeName' => ['description' => 'Edge zone name.', 'type' => 'string', 'example' => '放音', 'title' => ''], 'ContactId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-10963442671187****', 'title' => ''], 'LeaveTime' => ['description' => 'Time when leaving this IVR node.', 'type' => 'integer', 'format' => 'int64', 'example' => '1621910545105', 'title' => ''], 'ChannelVariables' => ['description' => 'Channel-associated data.', 'type' => 'string', 'example' => 'A=B;C=D', 'title' => ''], 'ChannelId' => ['description' => 'Voice channel ID.', 'type' => 'string', 'example' => '65cp2c15-92ac-4e67-98b2-073a3c541c5d', 'title' => ''], 'NodeId' => ['description' => 'Node ID.', 'type' => 'string', 'example' => 'e0bc19a3', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid. %s', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => ''], ], ], 'title' => 'Retrieve IVR Trace Details List ', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIvrTrackingDetails'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"D2RB671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 3,\\n \\"List\\": [\\n {\\n \\"Instance\\": \\"ccc-test\\",\\n \\"Callee\\": \\"0533128****\\",\\n \\"EnterTime\\": 1621910542876,\\n \\"NodeVariables\\": {\\n \\"digits\\": \\"2\\"\\n },\\n \\"NodeExitCode\\": \\"Success\\",\\n \\"FlowName\\": \\"测试IVR\\",\\n \\"FlowId\\": \\"abc99462-1058-47d0-a114-f145ea7444ff\\",\\n \\"NodeProperties\\": {\\n \\"say\\": \\"您好。\\"\\n },\\n \\"NodeType\\": \\"PLAY_SAY\\",\\n \\"Caller\\": \\"1332315****\\",\\n \\"NodeName\\": \\"放音\\",\\n \\"ContactId\\": \\"job-10963442671187****\\",\\n \\"LeaveTime\\": 1621910545105,\\n \\"ChannelVariables\\": \\"A=B;C=D\\",\\n \\"ChannelId\\": \\"65cp2c15-92ac-4e67-98b2-073a3c541c5d\\",\\n \\"NodeId\\": \\"e0bc19a3\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'ListLegacyAgentEventLogs' => [ 'summary' => 'You can invoke ListLegacyAgentEventLogs to obtain the list of 1.0 legacy agent event logs. This API is available only to specific Users, and other Customers are not recommended to invoke it.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => true, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'Page number, ranging from 1 to 1000.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'Page size, ranging from 1 to 1000.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '100', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'Start Time, in Unix timestamp format, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1657853640015', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'End time, in Unix timestamp format, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1658026440011', 'title' => ''], ], [ 'name' => 'AgentId', 'in' => 'query', 'schema' => ['description' => 'Filter by agent ID. This parameter is optional and defaults to empty. An empty value indicates no filtering.', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '2802EE59-3B53-513A-A130-85E480AF689D', 'title' => ''], 'Success' => ['description' => 'Indicates whether the operation succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'Page number, ranging from 1 to 1000.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'Page size, ranging from 1 to 1000.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'TotalCount' => ['description' => 'Total count.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'List' => [ 'description' => 'List of agent event logs.', 'type' => 'array', 'items' => [ 'description' => 'Agent event log.', 'type' => 'object', 'properties' => [ 'TargetSelect' => ['description' => 'Skill group ID.', 'type' => 'string', 'example' => 'skillgroup@ccc-test', 'title' => ''], 'TargetRequest' => ['description' => 'Skill group ID.', 'type' => 'string', 'example' => 'skillgroup@ccc-test', 'title' => ''], 'StatisticDate' => ['description' => 'Statistics timestamp.', 'type' => 'string', 'example' => '2021-12-03T10:15:30', 'title' => ''], 'PhoneNo' => ['description' => 'Agent extension number.', 'type' => 'string', 'example' => '8012****', 'title' => ''], 'GroupNo' => ['description' => 'List of skill group IDs that the agent signed in to. Separate multiple skill group IDs with commas.', 'type' => 'string', 'example' => 'skillgroup1@ccc-test,skillgroup2@ccc-test', 'title' => ''], 'Event' => [ 'description' => 'Type of management event.', 'enumValueTitles' => ['拨号' => 'dial-up', '振铃' => 'ringing', '处理' => 'handling'], 'type' => 'string', 'example' => '拨号', 'title' => '', ], 'ConnId' => ['description' => 'Call channel ID.', 'type' => 'string', 'example' => '345467****', 'title' => ''], 'CallType' => [ 'description' => 'Call type.', 'enumValueTitles' => ['呼入' => 'Inbound', '呼出' => 'Outbound'], 'type' => 'string', 'example' => '呼入', 'title' => '', ], 'CallId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => '378654****', 'title' => ''], 'CallerId' => ['description' => 'Calling number.', 'type' => 'string', 'example' => '08331111****', 'title' => ''], 'CalleeId' => ['description' => 'Callee number.', 'type' => 'string', 'example' => '1312343****', 'title' => ''], 'AgentNo' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'AgentDropCall' => ['description' => 'Indicates whether the agent hung up the call.', 'type' => 'string', 'example' => 'false', 'title' => ''], 'TransferNumber' => ['description' => 'Transfer number.', 'type' => 'string', 'example' => '07518888****', 'title' => ''], 'CallDir' => [ 'description' => 'Call direction.', 'enumValueTitles' => ['内部' => 'Internal', '外部' => 'External'], 'type' => 'string', 'example' => '内部', 'title' => '', ], 'CallMode' => [ 'description' => 'Call pattern.', 'enumValueTitles' => ['呼入' => 'Inbound', '呼出' => 'Outbound'], 'type' => 'string', 'example' => '呼入', 'title' => '', ], 'TenantId' => ['description' => 'Tenant ID.', 'type' => 'string', 'example' => 'acc101', 'title' => ''], 'OutboundScenario' => ['description' => 'Indicates whether the agent is in outbound-only mode.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'staticInfo' => [ 'substitutions' => ['CCC::2020-07-01::ListAgentStateLogs'], ], 'title' => 'Obtain legacy agent event log list', 'changeSet' => [ ['createdAt' => '2022-07-05T09:31:24.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLegacyAgentEventLogs'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"2802EE59-3B53-513A-A130-85E480AF689D\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"TargetSelect\\": \\"skillgroup@ccc-test\\",\\n \\"TargetRequest\\": \\"skillgroup@ccc-test\\",\\n \\"StatisticDate\\": \\"2021-12-03T10:15:30\\",\\n \\"PhoneNo\\": \\"8012****\\",\\n \\"GroupNo\\": \\"skillgroup1@ccc-test,skillgroup2@ccc-test\\",\\n \\"Event\\": \\"拨号\\",\\n \\"ConnId\\": \\"345467****\\",\\n \\"CallType\\": \\"呼入\\",\\n \\"CallId\\": \\"378654****\\",\\n \\"CallerId\\": \\"08331111****\\",\\n \\"CalleeId\\": \\"1312343****\\",\\n \\"AgentNo\\": \\"agent@ccc-test\\",\\n \\"AgentDropCall\\": \\"false\\",\\n \\"TransferNumber\\": \\"07518888****\\",\\n \\"CallDir\\": \\"内部\\",\\n \\"CallMode\\": \\"呼入\\",\\n \\"TenantId\\": \\"acc101\\",\\n \\"OutboundScenario\\": false\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'ListLegacyAgentStatusLogs' => [ 'summary' => 'You can invoke ListLegacyAgentStatusLogs to obtain the list of legacy agent status logs for version 1.0. This API is available only to specific Users, and other Customers are not recommended to invoke it.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => true, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'Page number, ranging from 1 to 1000.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'Page size, ranging from 1 to 1000.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '100', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'Start Time, in UNIX timestamp format, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1657778840011', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'End time, in Unix timestamp format, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1657879880010', 'title' => ''], ], [ 'name' => 'AgentId', 'in' => 'query', 'schema' => ['description' => 'Filter by agent ID. This parameter is optional and defaults to empty. An empty value means no filtering is applied.', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '4C9A5D93-33A6-57F3-A423-4C83BD0A8455', 'title' => ''], 'Success' => ['description' => 'Indicates whether the operation succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'Page number, ranging from 1 to 1000.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'Page size, ranging from 1 to 1000.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'TotalCount' => ['description' => 'Total count.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'List' => [ 'description' => 'List of agent status data.', 'type' => 'array', 'items' => [ 'description' => 'Agent status data.', 'type' => 'object', 'properties' => [ 'TransferNo' => ['description' => 'Transfer number.', 'type' => 'string', 'example' => '07551231****', 'title' => ''], 'TargetSelect' => ['description' => 'Skill group ID.', 'type' => 'string', 'example' => 'skillgroup@ccc-test', 'title' => ''], 'TargetRequest' => ['description' => 'Skill group ID.', 'type' => 'string', 'example' => 'skillgroup@ccc-test', 'title' => ''], 'Status' => [ 'description' => 'Agent status.', 'enumValueTitles' => ['拨号' => 'dial-up', '振铃' => 'ringing', '处理' => 'handling', '小休' => 'break'], 'type' => 'string', 'example' => '振铃', 'title' => '', ], 'StatisticDate' => ['description' => 'The time when the statistics were collected.', 'type' => 'string', 'example' => '2021-12-03T10:15:30', 'title' => ''], 'StatisticTime' => ['description' => 'Duration of the status, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], 'PhoneNo' => ['description' => 'Agent extension number.', 'type' => 'string', 'example' => '8012****', 'title' => ''], 'MonitedAgentPhoneNo' => ['description' => 'The monitored agent phone number.', 'type' => 'string', 'example' => '8012****', 'title' => ''], 'MonitedAgentNo' => ['description' => 'The listener phone number.', 'type' => 'string', 'example' => '8032****', 'title' => ''], 'GroupNo' => ['description' => 'Skill group ID.', 'type' => 'string', 'example' => 'skillgroup@ccc-test', 'title' => ''], 'ConnId' => ['description' => 'Call channel ID.', 'type' => 'string', 'example' => '487326****', 'title' => ''], 'CallType' => [ 'description' => 'Call type.', 'enumValueTitles' => ['呼入' => 'Inbound', '呼出' => 'Outbound'], 'type' => 'string', 'example' => '呼入', 'title' => '', ], 'CallId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => '454326****', 'title' => ''], 'CallerId' => ['description' => 'Calling number.', 'type' => 'string', 'example' => '08337676****', 'title' => ''], 'CalleeId' => ['description' => 'The callee number.', 'type' => 'string', 'example' => '1312121****', 'title' => ''], 'CallDir' => [ 'description' => 'Call direction.', 'enumValueTitles' => ['内部' => 'Internal', '外部' => 'External'], 'type' => 'string', 'example' => '内部', 'title' => '', ], 'AgentNo' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'AgentDropCall' => ['description' => 'Indicates whether the agent hung up the call.', 'type' => 'string', 'example' => 'false', 'title' => ''], 'AliHangupCause' => ['description' => 'Hang-up reason.', 'type' => 'string', 'example' => '无', 'title' => ''], 'TransferNumber' => ['description' => 'Transfer number.', 'type' => 'string', 'example' => '05711231****', 'title' => ''], 'Extend1' => ['description' => 'Custom extension field.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Extend2' => ['description' => 'Custom extension field.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Extend3' => ['description' => 'Custom extension field.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Extend4' => ['description' => 'Custom extension field.', 'type' => 'string', 'example' => '无', 'title' => ''], 'TenantId' => ['description' => 'Tenant ID.', 'type' => 'string', 'example' => 'acc6736', 'title' => ''], 'OutboundScenario' => ['description' => 'Indicates whether the agent is in outbound-only mode.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'staticInfo' => [ 'substitutions' => ['CCC::2020-07-01::ListAgentStateLogs'], ], 'title' => 'Obtain the list of legacy agent status logs', 'changeSet' => [ ['createdAt' => '2022-07-05T09:31:24.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLegacyAgentStatusLogs'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"4C9A5D93-33A6-57F3-A423-4C83BD0A8455\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"TransferNo\\": \\"07551231****\\",\\n \\"TargetSelect\\": \\"skillgroup@ccc-test\\",\\n \\"TargetRequest\\": \\"skillgroup@ccc-test\\",\\n \\"Status\\": \\"振铃\\",\\n \\"StatisticDate\\": \\"2021-12-03T10:15:30\\",\\n \\"StatisticTime\\": 3,\\n \\"PhoneNo\\": \\"8012****\\",\\n \\"MonitedAgentPhoneNo\\": \\"8012****\\",\\n \\"MonitedAgentNo\\": \\"8032****\\",\\n \\"GroupNo\\": \\"skillgroup@ccc-test\\",\\n \\"ConnId\\": \\"487326****\\",\\n \\"CallType\\": \\"呼入\\",\\n \\"CallId\\": \\"454326****\\",\\n \\"CallerId\\": \\"08337676****\\",\\n \\"CalleeId\\": \\"1312121****\\",\\n \\"CallDir\\": \\"内部\\",\\n \\"AgentNo\\": \\"agent@ccc-test\\",\\n \\"AgentDropCall\\": \\"false\\",\\n \\"AliHangupCause\\": \\"无\\",\\n \\"TransferNumber\\": \\"05711231****\\",\\n \\"Extend1\\": \\"无\\",\\n \\"Extend2\\": \\"无\\",\\n \\"Extend3\\": \\"无\\",\\n \\"Extend4\\": \\"无\\",\\n \\"TenantId\\": \\"acc6736\\",\\n \\"OutboundScenario\\": false\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'ListLegacyQueueEventLogs' => [ 'summary' => 'You can invoke ListLegacyQueueEventLogs to obtain the list of 1.0 legacy queue event logs. This API is available only to specific Users, and other Customers are not recommended to invoke it.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'Page number for paging, ranging from 1 to 1000.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'Page size, ranging from 1 to 1000.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '100', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'Start Time, in UNIX timestamp format, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1657939540015', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'End time, in UNIX timestamp format, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1658026180018', 'title' => ''], ], [ 'name' => 'SkillGroupId', 'in' => 'query', 'schema' => ['description' => 'Filter by skill group ID. This parameter is optional and defaults to empty. An empty value means no filtering is applied.', 'type' => 'string', 'required' => false, 'example' => 'skillgroup@ccc-test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '1A5A8998-41F9-5F85-BFCF-EB2B6E376812', 'title' => ''], 'Success' => ['description' => 'Indicates whether the invocation succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'Page number, ranging from 1 to 1000.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'Page size, ranging from 1 to 1000.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'TotalCount' => ['description' => 'Total count.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'List' => [ 'description' => 'List of queue event logs.', 'type' => 'array', 'items' => [ 'description' => 'Queue event log.', 'type' => 'object', 'properties' => [ 'Vq' => ['description' => 'Queue name.', 'type' => 'string', 'example' => 'skillgroup@ccc-test', 'title' => ''], 'StatisticDate' => ['description' => 'Statistics date.', 'type' => 'string', 'example' => '2021-12-03T10:15:30', 'title' => ''], 'QueueTime' => ['description' => 'Queue duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], 'Ani' => ['description' => 'Calling party', 'type' => 'string', 'example' => '8012****', 'title' => ''], 'Dnis' => ['description' => 'Dialed number.', 'type' => 'string', 'example' => '1312211****', 'title' => ''], 'Cause' => [ 'description' => 'Hang-up reason.', 'enumValueTitles' => ['队列呼损' => 'Queue call loss', '正常' => 'Normal', '久振呼损' => 'Call loss due to prolonged ringing'], 'type' => 'string', 'example' => '正常', 'title' => '', ], 'AnswerTime' => ['description' => 'Acknowledgement duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '15', 'title' => ''], 'AnswerPhone' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'Acid' => ['description' => 'Call ID.', 'type' => 'string', 'example' => '456328****', 'title' => ''], 'TenantId' => ['description' => 'Tenant ID.', 'type' => 'string', 'example' => 'acc3733', 'title' => ''], 'Id' => ['description' => 'Primary key', 'type' => 'integer', 'format' => 'int64', 'example' => '109160', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'title' => 'Retrieve the list of legacy queue event logs', 'changeSet' => [ ['createdAt' => '2022-07-05T09:31:24.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLegacyQueueEventLogs'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"1A5A8998-41F9-5F85-BFCF-EB2B6E376812\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"Vq\\": \\"skillgroup@ccc-test\\",\\n \\"StatisticDate\\": \\"2021-12-03T10:15:30\\",\\n \\"QueueTime\\": 10,\\n \\"Ani\\": \\"8012****\\",\\n \\"Dnis\\": \\"1312211****\\",\\n \\"Cause\\": \\"正常\\",\\n \\"AnswerTime\\": 15,\\n \\"AnswerPhone\\": \\"agent@ccc-test\\",\\n \\"Acid\\": \\"456328****\\",\\n \\"TenantId\\": \\"acc3733\\",\\n \\"Id\\": 109160\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'ListMonoRecordings' => [ 'summary' => 'Call ListMonoRecordings to retrieve single-track recordings for each party in a specified call under a specified instance. During a call, each party has a channel, and each channel generates a combined track recording in WAV format.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc5HY0NN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'ContactId', 'in' => 'query', 'schema' => ['description' => 'The call ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-25697383427137****', 'title' => ''], ], [ 'name' => 'AgentChannelId', 'in' => 'query', 'schema' => ['title' => 'Agent conversation channel ID ', 'description' => 'The channel ID of the agent conversation.', 'type' => 'string', 'example' => 'ch-user-****-****-1772180844645-job-*****', 'required' => false], ], [ 'name' => 'AgentId', 'in' => 'query', 'schema' => ['title' => 'Agent ID ', 'description' => 'The agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E836EF2A-EDAE-5310-8921-F983C967D42D', 'title' => ''], 'Data' => [ 'description' => 'The list of recording information.', 'type' => 'array', 'items' => [ 'description' => 'The recording information.', 'type' => 'object', 'properties' => [ 'FileName' => ['description' => 'The name of the recording file.', 'type' => 'string', 'example' => 'job-25920271311543****-798f1e90-1f82-42da-914c-46580c8f4c85-1656926518491.wav', 'title' => ''], 'FileUrl' => ['description' => 'The Object Storage Service (OSS) download URL for the recording file. Note that the download URL is valid for one day.', 'type' => 'string', 'example' => 'https://ccc-v2-shanghai.oss-cn-shanghai.aliyuncs.com/ccc-test/job-25920271311543****-798f1e90-1f82-42da-914c-46580c8f4c85-1656926518491.wav?Expires=1657014031&OSSAccessKeyId=****&Signature=****', 'title' => ''], 'AgentId' => ['description' => 'The agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'AgentName' => ['description' => 'The agent name.', 'type' => 'string', 'example' => '坐席小王', 'title' => ''], 'StartTime' => ['description' => 'The start time of the recording. This is a UNIX timestamp in milliseconds.', 'type' => 'string', 'example' => '1620259200000', 'title' => ''], 'ContactId' => ['description' => 'The call ID.', 'type' => 'string', 'example' => 'job-25920271311543****', 'title' => ''], 'Duration' => ['description' => 'The duration of the recording in milliseconds.', 'type' => 'string', 'example' => '5903871', 'title' => ''], 'SkillGroupId' => ['description' => 'The skill group ID.', 'type' => 'string', 'example' => 'skillgroup@ccc-test', 'title' => ''], 'RamId' => ['description' => 'The ID of the Resource Access Management (RAM) account that corresponds to the agent.', 'type' => 'string', 'example' => '26972543893791****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"E836EF2A-EDAE-5310-8921-F983C967D42D\\",\\n \\"Data\\": [\\n {\\n \\"FileName\\": \\"job-25920271311543****-798f1e90-1f82-42da-914c-46580c8f4c85-1656926518491.wav\\",\\n \\"FileUrl\\": \\"https://ccc-v2-shanghai.oss-cn-shanghai.aliyuncs.com/ccc-test/job-25920271311543****-798f1e90-1f82-42da-914c-46580c8f4c85-1656926518491.wav?Expires=1657014031&OSSAccessKeyId=****&Signature=****\\",\\n \\"AgentId\\": \\"agent@ccc-test\\",\\n \\"AgentName\\": \\"坐席小王\\",\\n \\"StartTime\\": \\"1620259200000\\",\\n \\"ContactId\\": \\"job-25920271311543****\\",\\n \\"Duration\\": \\"5903871\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"RamId\\": \\"26972543893791****\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'Obtain the single-track recording list', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMonoRecordings'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'ListMultiChannelRecordings' => [ 'summary' => 'Call ListMultiChannelRecordings to retrieve the multi-channel recordings for each party in a specified call and instance. Each party has a call channel that corresponds to a multi-channel recording in MKV format.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc5HY0NN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'ContactId', 'in' => 'query', 'schema' => ['description' => 'Call ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-25920271311543****', 'title' => ''], ], [ 'name' => 'AgentChannelId', 'in' => 'query', 'schema' => ['title' => 'Agent Call Channel ID ', 'description' => 'Agent call channel ID.', 'type' => 'string', 'example' => 'ch-user-****-****-1772180844645-job-******', 'required' => false], ], [ 'name' => 'AgentId', 'in' => 'query', 'schema' => ['title' => 'Agent ID ', 'description' => 'Agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'B19CD719-9F65-56A6-8B79-DA4282EA4797', 'title' => ''], 'Data' => [ 'description' => 'Recording list.', 'type' => 'array', 'items' => [ 'description' => 'Recording.', 'type' => 'object', 'properties' => [ 'FileName' => ['description' => 'Recording file name.', 'type' => 'string', 'example' => 'job-25920271311543****-798f1e90-1f82-42da-914c-46580c8f4c85-1656926518491.mkv', 'title' => ''], 'FileUrl' => ['description' => 'OSS download URL for the recording file. Note the time-to-live (TTL) of the download URL. The download URL is valid for 1 day.', 'type' => 'string', 'example' => 'https://ccc-v2-shanghai.oss-cn-shanghai.aliyuncs.com/ccc-test/job-25920271311543****-798f1e90-1f82-42da-914c-46580c8f4c85-1656926518491.mkv?Expires=1657014031&OSSAccessKeyId=****&Signature=****', 'title' => ''], 'AgentId' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'AgentName' => ['description' => 'Agent name.', 'type' => 'string', 'example' => '坐席小王', 'title' => ''], 'StartTime' => ['description' => 'Recording start time, in UNIX timestamp format, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1656926518491', 'title' => ''], 'ContactId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-25920271311543****', 'title' => ''], 'Duration' => ['description' => 'Recording duration, in milliseconds.', 'type' => 'string', 'example' => '56321', 'title' => ''], 'SkillGroupId' => ['description' => 'Skill group ID.', 'type' => 'string', 'example' => 'skillgroup@ccc-test', 'title' => ''], 'RamId' => ['description' => 'RAM account ID for the agent.', 'type' => 'string', 'example' => '22807673106369****', 'title' => ''], 'AgentChannelId' => ['description' => 'Agent call channel ID.', 'type' => 'string', 'example' => 'ch-user-8526899****-8602****-1656926504363-job-25920271311543****', 'title' => ''], 'HoldTimeSegments' => [ 'description' => 'List of call hold time segments.', 'type' => 'array', 'items' => [ 'description' => 'Call hold time segment.', 'type' => 'object', 'properties' => [ 'StartTime' => ['description' => 'Call hold start time, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1673255098049', 'title' => ''], 'EndTime' => ['description' => 'The end time of the call hold, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1687860143925', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"B19CD719-9F65-56A6-8B79-DA4282EA4797\\",\\n \\"Data\\": [\\n {\\n \\"FileName\\": \\"job-25920271311543****-798f1e90-1f82-42da-914c-46580c8f4c85-1656926518491.mkv\\",\\n \\"FileUrl\\": \\"https://ccc-v2-shanghai.oss-cn-shanghai.aliyuncs.com/ccc-test/job-25920271311543****-798f1e90-1f82-42da-914c-46580c8f4c85-1656926518491.mkv?Expires=1657014031&OSSAccessKeyId=****&Signature=****\\",\\n \\"AgentId\\": \\"agent@ccc-test\\",\\n \\"AgentName\\": \\"坐席小王\\",\\n \\"StartTime\\": 1656926518491,\\n \\"ContactId\\": \\"job-25920271311543****\\",\\n \\"Duration\\": \\"56321\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"RamId\\": \\"22807673106369****\\",\\n \\"AgentChannelId\\": \\"ch-user-8526899****-8602****-1656926504363-job-25920271311543****\\",\\n \\"HoldTimeSegments\\": [\\n {\\n \\"StartTime\\": 1673255098049,\\n \\"EndTime\\": 1687860143925\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', 'title' => 'Retrieve the multi-channel recording list ', 'changeSet' => [ ['createdAt' => '2023-05-08T07:40:07.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMultiChannelRecordings'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'ListNotificationRecords' => [ 'summary' => 'Query notification records that were not sent using Message Queue (MQ).', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccUU766R'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the Cloud Contact Center instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'NotificationKeys', 'in' => 'query', 'schema' => ['description' => 'A list of notification keys to query. For example, if you specify a call ID, the API returns all notifications for that call ID.', 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => '["job-468a63a2-****-****-****-b1ecf726d4be","job-532a63a2-****-****-****-bcccc26d4cc"]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0630E5DF-CEB0-445B-8626-D5C7481181C3', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'type' => 'array', 'items' => [ 'description' => 'A list of notifications.', 'type' => 'object', 'properties' => [ 'NotificationType' => ['description' => 'The message type.', 'type' => 'string', 'example' => 'Dialing', 'title' => ''], 'NotificationKey' => ['description' => 'The notification key.', 'type' => 'string', 'example' => 'job-468a63a2-****-****-****-b1ecf726d4be', 'title' => ''], 'Content' => ['description' => 'The notification content.', 'type' => 'string', 'example' => '{'."\n" .' "agentId": "agent@ccc-test",'."\n" .' "callType": "OUTBOUND",'."\n" .' "callee": "13****00",'."\n" .' "caller": "05****81",'."\n" .' "channelId": "ch-user-13****00-05****81-1772619731285-job-*****",'."\n" .' "contactId": "job-*****",'."\n" .' "eventTime": "2026-03-04T10:22:11.309Z",'."\n" .' "eventType": "Dialing",'."\n" .' "instanceId": "ccc-test",'."\n" .' "mediaType": "AUDIO",'."\n" .' "skillGroupId": "skill@ccc-test"'."\n" .'}', 'title' => ''], 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Params' => [ 'description' => 'A list of invalid parameters.', 'type' => 'array', 'items' => ['description' => 'An invalid parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Query alert delivery records using non-MQ methods ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"0630E5DF-CEB0-445B-8626-D5C7481181C3\\",\\n \\"Data\\": [\\n {\\n \\"NotificationType\\": \\"Dialing\\",\\n \\"NotificationKey\\": \\"job-468a63a2-****-****-****-b1ecf726d4be\\",\\n \\"Content\\": \\"{\\\\n\\\\t\\\\\\"agentId\\\\\\": \\\\\\"agent@ccc-test\\\\\\",\\\\n\\\\t\\\\\\"callType\\\\\\": \\\\\\"OUTBOUND\\\\\\",\\\\n\\\\t\\\\\\"callee\\\\\\": \\\\\\"13****00\\\\\\",\\\\n\\\\t\\\\\\"caller\\\\\\": \\\\\\"05****81\\\\\\",\\\\n\\\\t\\\\\\"channelId\\\\\\": \\\\\\"ch-user-13****00-05****81-1772619731285-job-*****\\\\\\",\\\\n\\\\t\\\\\\"contactId\\\\\\": \\\\\\"job-*****\\\\\\",\\\\n\\\\t\\\\\\"eventTime\\\\\\": \\\\\\"2026-03-04T10:22:11.309Z\\\\\\",\\\\n\\\\t\\\\\\"eventType\\\\\\": \\\\\\"Dialing\\\\\\",\\\\n\\\\t\\\\\\"instanceId\\\\\\": \\\\\\"ccc-test\\\\\\",\\\\n\\\\t\\\\\\"mediaType\\\\\\": \\\\\\"AUDIO\\\\\\",\\\\n\\\\t\\\\\\"skillGroupId\\\\\\": \\\\\\"skill@ccc-test\\\\\\"\\\\n}\\",\\n \\"InstanceId\\": \\"ccc-test\\"\\n }\\n ],\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', ], 'ListOutboundNumbersOfUser' => [ 'summary' => '`ListOutboundNumbersOfUser` retrieves the outbound numbers for a specified agent in a specified instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'The agent ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''], ], [ 'name' => 'SkillGroupIdList', 'in' => 'query', 'schema' => ['description' => 'A JSON-formatted list of skill group IDs. If specified, the operation returns outbound numbers for the specified skill groups. If omitted, it returns outbound numbers for all skill groups associated with the agent. Note: The agent must be a member of the specified skill groups.', 'type' => 'string', 'required' => false, 'example' => '["skillgroup1@ccc-test","skillgroup2@ccc-test"]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], 'Data' => [ 'description' => 'The data.', 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'The page number. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'List' => [ 'description' => 'A list of phone numbers.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Number' => ['description' => 'The phone number.', 'type' => 'string', 'example' => '0830019****', 'title' => ''], 'City' => ['description' => 'The city where the phone number is located.', 'type' => 'string', 'example' => '乐山', 'title' => ''], 'Province' => ['description' => 'The province where the phone number is located.', 'type' => 'string', 'example' => '四川', 'title' => ''], 'Provider' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'ProviderCode' => ['type' => 'string', 'deprecated' => true, 'description' => '', 'title' => '', 'example' => ''], 'ProviderDisplayName' => ['type' => 'string', 'deprecated' => true, 'description' => '', 'title' => '', 'example' => ''], 'ProviderShortName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'ProviderType' => [ 'type' => 'string', 'enum' => ['THIRD_PARTY', 'SELF_HOSTED'], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => ''], ], ], 'title' => 'Obtain the outbound calling number list of an agent', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2025-07-15T12:01:46.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2025-06-12T11:54:29.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListOutboundNumbersOfUser'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"List\\": [\\n {\\n \\"Number\\": \\"0830019****\\",\\n \\"City\\": \\"乐山\\",\\n \\"Province\\": \\"四川\\",\\n \\"Provider\\": \\"\\",\\n \\"ProviderCode\\": \\"\\",\\n \\"ProviderDisplayName\\": \\"\\",\\n \\"ProviderShortName\\": \\"\\",\\n \\"ProviderType\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'ListPersonalNumbersOfUser' => [ 'summary' => 'You can invoke ListPersonalNumbersOfUser to obtain the list of personal outbound numbers for a specified agent under a specified instance. You can also use this API to retrieve the list of numbers that can be added as personal outbound numbers for an agent.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc1MRAID'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'Agent ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'user-test@ccc-test', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'Page number, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'Page size, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''], ], [ 'name' => 'IsMember', 'in' => 'query', 'schema' => ['description' => 'Indicates whether the phone numbers are associated with the agent. If true, the API queries the list of personal outbound phone numbers associated with the UserId. If false, it queries the list of personal outbound phone numbers that can be associated with but are not currently associated with the UserId. This parameter is typically used together with the AddPersonalNumbersToUser API.', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true', 'title' => ''], ], [ 'name' => 'SearchPattern', 'in' => 'query', 'schema' => ['description' => 'Fuzzy matching based on phone number. Optional. Default value is empty if not specified.', 'type' => 'string', 'required' => false, 'example' => '0833', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'Page number, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'Page size, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'TotalCount' => ['description' => 'Total count.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'List' => [ 'description' => 'List of numbers.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Active' => ['description' => 'Indicates whether the number is active.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Number' => ['description' => 'Number.', 'type' => 'string', 'example' => '08330011****', 'title' => ''], 'City' => ['description' => 'The city where the phone number is registered.', 'type' => 'string', 'example' => '乐山', 'title' => ''], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'ContactFlowId' => ['description' => 'ID of the IVR contact flow associated with this number.', 'type' => 'string', 'example' => 'a3fb6c62-9b49-4942-ae5b-cf2abd4123ek', 'title' => ''], 'Province' => ['description' => 'The province where the phone number is registered.', 'type' => 'string', 'example' => '四川', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => ''], ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Retrieve the list of personal phone numbers for an agent ', 'description' => 'Note: If a number is already attached to a skill group, it will not appear in the list of numbers available as personal outbound numbers.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPersonalNumbersOfUser'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"List\\": [\\n {\\n \\"Active\\": true,\\n \\"Number\\": \\"08330011****\\",\\n \\"City\\": \\"乐山\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"ContactFlowId\\": \\"a3fb6c62-9b49-4942-ae5b-cf2abd4123ek\\",\\n \\"Province\\": \\"四川\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'ListPhoneNumbers' => [ 'summary' => 'You can invoke ListPhoneNumbers to obtain the phone number list under a specified instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc1MRAID'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'SearchPattern', 'in' => 'query', 'schema' => ['description' => 'Performs fuzzy matching based on the number. This parameter is optional and defaults to empty. An empty value indicates no filtering.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '0833', 'title' => ''], ], [ 'name' => 'Usage', 'in' => 'query', 'schema' => [ 'description' => 'Usage of the number. This parameter is optional. The default value is empty, which means no filtering is applied.', 'enumValueTitles' => ['Outbound' => 'Outbound', 'Inbound' => 'Inbound', 'Bidirection' => 'Inbound and Outbound'], 'type' => 'string', 'required' => false, 'docRequired' => false, 'maxLength' => 200, 'minLength' => 1, 'example' => 'Bidirection', 'title' => '', ], ], [ 'name' => 'Active', 'in' => 'query', 'schema' => ['description' => 'Indicates whether the number is active. This parameter is optional. The default value is empty, which means no filtering is applied.', 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The paging ordinal number, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'Page size, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '20', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', 'title' => ''], 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'The page number, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The page size, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], 'TotalCount' => ['description' => 'The total count.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'List' => [ 'description' => 'The phone number list.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Active' => ['description' => 'Indicates whether the number is active.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'CreateTime' => ['description' => 'The number creation time, which is the time when the number was associated with the instance, in Unix timestamp format with millisecond precision.', 'type' => 'string', 'example' => '1617958538000', 'title' => ''], 'UserId' => ['description' => 'Agent ID. If this parameter is not empty, the number is dedicated to the agent.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'Tags' => ['description' => 'Business tags for the number, primarily used for labeling and extended business purposes. Ordinary customers do not need to concern themselves with this.', 'type' => 'string', 'example' => 'M1', 'title' => ''], 'City' => ['description' => 'The city where the number is registered.', 'type' => 'string', 'example' => '乐山', 'title' => ''], 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'Usage' => [ 'description' => 'The usage of the phone number.', 'enumValueTitles' => ['Outbound' => 'Outbound', 'Inbound' => 'Inbound', 'Bidirection' => 'Inbound and outbound'], 'type' => 'string', 'example' => 'Bidirection', 'title' => '', ], 'ContactFlowName' => ['description' => 'Name of the IVR contact flow associated with the number.', 'type' => 'string', 'example' => '默认联系流', 'title' => ''], 'Provider' => ['description' => 'Number provider name.', 'type' => 'string', 'example' => 'alicom', 'title' => ''], 'Number' => ['description' => 'Number.', 'type' => 'string', 'example' => '08330011****', 'title' => ''], 'ContactFlowId' => ['description' => 'The IVR contact flow ID associated with the phone number.', 'type' => 'string', 'example' => 'a3fb6c62-9b49-4942-ae5b-cf2abd4123ek', 'title' => ''], 'Province' => ['description' => 'The province where the number is registered.', 'type' => 'string', 'example' => '四川', 'title' => ''], 'SkillGroups' => [ 'description' => 'The list of skill groups associated with the number.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'DisplayName' => ['description' => 'The display name of the skill group.', 'type' => 'string', 'example' => '测试技能组', 'title' => ''], 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'Name' => ['description' => 'The name of the skill group.', 'type' => 'string', 'example' => 'skillgroup', 'title' => ''], 'SkillGroupId' => ['description' => 'The skill group ID.', 'type' => 'string', 'example' => 'skillgroup@ccc-test', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => ''], ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => ''], ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Obtain Number List ', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2022-06-30T08:58:18.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPhoneNumbers'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 1,\\n \\"List\\": [\\n {\\n \\"Active\\": true,\\n \\"CreateTime\\": \\"1617958538000\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Tags\\": \\"M1\\",\\n \\"City\\": \\"乐山\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Usage\\": \\"Bidirection\\",\\n \\"ContactFlowName\\": \\"默认联系流\\",\\n \\"Provider\\": \\"alicom\\",\\n \\"Number\\": \\"08330011****\\",\\n \\"ContactFlowId\\": \\"a3fb6c62-9b49-4942-ae5b-cf2abd4123ek\\",\\n \\"Province\\": \\"四川\\",\\n \\"SkillGroups\\": [\\n {\\n \\"DisplayName\\": \\"测试技能组\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Name\\": \\"skillgroup\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'ListPhoneNumbersOfSkillGroup' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc1MRAID'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'SkillGroupId', 'in' => 'query', 'schema' => ['description' => 'Skill group ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'skillgroup@ccc-test', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'Page number for paging. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'Page size for paging. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''], ], [ 'name' => 'IsMember', 'in' => 'query', 'schema' => ['description' => 'Indicates whether the phone numbers are associated with the skill group. If true, the API queries the list of phone numbers already associated with the specified SkillGroupId. If false, the API queries the list of phone numbers that can be associated with the specified SkillGroupId but are not currently associated. This parameter is typically used together with the AddNumbersToSkillGroup API.', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true', 'title' => ''], ], [ 'name' => 'SearchPattern', 'in' => 'query', 'schema' => ['description' => 'Performs Fuzzy Matching on phone numbers. This parameter is optional. The default value is empty, which means no filtering is applied.', 'type' => 'string', 'required' => false, 'example' => '0833', 'title' => ''], ], [ 'name' => 'Active', 'in' => 'query', 'schema' => ['description' => 'Indicates whether the phone number is active. This parameter is optional. The default value is empty, which means no filtering is applied.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'Page number, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'Page size, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'TotalCount' => ['description' => 'Total count.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'List' => [ 'description' => 'List of phone numbers.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Active' => ['description' => 'Whether the phone number is active.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Number' => ['description' => 'Phone number.', 'type' => 'string', 'example' => '08330011****', 'title' => ''], 'City' => ['description' => 'City where the phone number is registered.', 'type' => 'string', 'example' => '乐山', 'title' => ''], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'Usage' => [ 'description' => 'Usage of the phone number.', 'enumValueTitles' => ['Outbound' => 'Outbound', 'Inbound' => 'Inbound', 'Bidirection' => 'Inbound and outbound'], 'type' => 'string', 'example' => 'Bidirection', 'title' => '', ], 'ContactFlowId' => ['description' => 'IVR contact flow ID associated with the phone number.', 'type' => 'string', 'example' => 'a3fb6c62-9b49-4942-ae5b-cf2abd4123ek', 'title' => ''], 'Province' => ['description' => 'Province where the phone number is registered.', 'type' => 'string', 'example' => '四川', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => ''], ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.SkillGroupId', 'errorMessage' => 'The skill group ID %s does not exist in instance %s.', 'description' => ''], ], ], 'title' => 'Retrieve the list of phone numbers for a skill group ', 'summary' => 'You can invoke the ListPhoneNumbersOfSkillGroup API to obtain the list of phone numbers associated with a specified skill group under a specified instance. You can also use this API to query phone numbers that are not currently associated with the skill group but can be associated with it.', 'description' => 'Note: If a phone number is already used as a personal outbound number, it will not appear in the list of numbers available for association with a skill group.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPhoneNumbersOfSkillGroup'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"List\\": [\\n {\\n \\"Active\\": true,\\n \\"Number\\": \\"08330011****\\",\\n \\"City\\": \\"乐山\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Usage\\": \\"Bidirection\\",\\n \\"ContactFlowId\\": \\"a3fb6c62-9b49-4942-ae5b-cf2abd4123ek\\",\\n \\"Province\\": \\"四川\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'ListPrivilegesOfUser' => [ 'summary' => 'Invoke ListPrivilegesOfUser to obtain the permissions owned by the current User.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'Scope' => [ 'description' => 'Permission Scope.', 'enumValueTitles' => ['SELF_ONLY' => 'Can access only their own data.', 'INSTANCE' => 'Can access all data under the entire instance.', 'SKILL_GROUP' => 'Can access all data of the skill group to which they belong.'], 'type' => 'string', 'example' => 'SELF_ONLY', 'title' => '', ], 'Name' => ['description' => 'Permission Name. Regular Customers do not need to understand specific permission names; this API is primarily invoked by the Workbench.', 'type' => 'string', 'example' => 'Workbench:Call', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Obtain the agent\'s permission list', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPrivilegesOfUser'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": [\\n {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Scope\\": \\"SELF_ONLY\\",\\n \\"Name\\": \\"Workbench:Call\\"\\n }\\n ]\\n}","type":"json"}]', ], 'ListRamUsers' => [ 'summary' => 'Lists RAM users that have not been imported into a specified instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test ', 'title' => ''], ], [ 'name' => 'SearchPattern', 'in' => 'query', 'schema' => ['description' => 'The keyword to use for a fuzzy search based on the RAM user\'s logon name or display name. This parameter is optional. If you leave this parameter empty, no filtering is applied.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'agent', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number of the results to return. Valid values: 1 to 1,000.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100000', 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '24753D71-C91D-1A38-A8AD-372BF12453F6', 'title' => ''], 'Data' => [ 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'The returned page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'List' => [ 'description' => 'A list of RAM users.', 'type' => 'array', 'items' => [ 'description' => 'The details of a RAM user.', 'type' => 'object', 'properties' => [ 'DisplayName' => ['description' => 'The display name of the RAM user.', 'type' => 'string', 'example' => '测试账号', 'title' => ''], 'Email' => ['description' => 'The email address of the RAM user.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], 'LoginName' => ['description' => 'The logon name of the RAM user.', 'type' => 'string', 'example' => 'agent', 'title' => ''], 'Mobile' => ['description' => 'The mobile number of the RAM user.', 'type' => 'string', 'example' => '1382114****', 'title' => ''], 'AliyunUid' => ['description' => 'The UID of the Alibaba Cloud account to which the RAM user belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '15772400000****', 'title' => ''], 'Primary' => ['description' => 'Indicates whether the user is a primary account. A value of `false` indicates that the user is a RAM user.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'RamId' => ['description' => 'The ID of the RAM user.', 'type' => 'string', 'example' => '28036411123456****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'Params' => [ 'description' => 'The response parameters.', 'type' => 'array', 'items' => ['description' => 'A response parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Obtain the Resource Access Management (RAM) User List ', 'description' => 'A Resource Access Management (RAM) user can be imported as an agent into multiple Cloud Contact Center (CCC) instances. However, an agent can be associated with only one RAM account. When you create an agent in a CCC instance, a corresponding RAM account is also created. To avoid creating redundant RAM accounts when you set up a new instance, you can call the ListRamUsers operation to list RAM users that have not been imported into the instance. You can then call the operation that imports RAM users to add them to the new instance. This prevents creating unnecessary RAM accounts and conserves resources.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-11-06T05:44:48.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRamUsers'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"24753D71-C91D-1A38-A8AD-372BF12453F6\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"List\\": [\\n {\\n \\"DisplayName\\": \\"测试账号\\",\\n \\"Email\\": \\"username@example.com\\",\\n \\"LoginName\\": \\"agent\\",\\n \\"Mobile\\": \\"1382114****\\",\\n \\"AliyunUid\\": 0,\\n \\"Primary\\": false,\\n \\"RamId\\": \\"28036411123456****\\"\\n }\\n ]\\n },\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', ], 'ListRealtimeAgentStates' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '50572', 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'SkillGroupId', 'in' => 'query', 'schema' => ['description' => 'Filter by skill group ID. This parameter is optional and defaults to empty, which means no filtering is applied.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'skillgroup@ccc-test', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'Page number, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'Page size, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'AgentIdList', 'in' => 'formData', 'schema' => ['description' => 'List of agent IDs, formatted as a JSON array string. The array can contain up to 20 elements. This parameter is optional and defaults to empty, which matches all agents under the current instance.', 'type' => 'string', 'required' => false, 'example' => '["agent1@ccc-test", "agent2@ccc-test"]', 'title' => ''], ], [ 'name' => 'StateList', 'in' => 'formData', 'schema' => [ 'description' => 'Filters by a list of statuses. This parameter is optional and defaults to empty, which matches all statuses.', 'enumValueTitles' => ['Ready' => 'Ready', 'Talking' => 'Talking', 'ACW' => 'After-call work', 'Break' => 'Break', 'Ringing' => 'Ringing', 'Offline' => 'Offline', 'Dialing' => 'Dialing'], 'type' => 'string', 'required' => false, 'example' => '["ACW", "Dialing"]', 'title' => '', ], ], [ 'name' => 'AgentName', 'in' => 'query', 'schema' => ['description' => 'Perform fuzzy matching by agent name.', 'type' => 'string', 'required' => false, 'example' => 'agent', 'title' => ''], ], [ 'name' => 'WorkModeList', 'in' => 'query', 'schema' => [ 'description' => 'Filter by work mode list. This parameter is optional and defaults to empty, which means all work modes are matched.', 'enumValueTitles' => ['ON_SITE' => 'On-site mode', 'OFF_SITE' => 'Off-site mode', 'OFFICE_PHONE' => 'Office phone mode'], 'type' => 'string', 'required' => false, 'example' => '["OFFICE_PHONE","ON_SITE"]', 'title' => '', ], ], [ 'name' => 'OutboundScenario', 'in' => 'query', 'schema' => ['description' => 'Filters agents who are in outbound-only mode. This parameter is optional and defaults to empty, which means no filtering by outbound-only mode is applied.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'Query', 'in' => 'query', 'schema' => ['description' => 'Performs fuzzy filtering based on the full or partial agent display name, agent ID, or agent extension number. This parameter is optional and defaults to empty, which means no filtering is applied.', 'type' => 'string', 'required' => false, 'example' => 'agent', 'title' => ''], ], [ 'name' => 'CallTypeList', 'in' => 'query', 'schema' => [ 'description' => 'Filters by a list of call types. The value is a string in JSON array format, where each array element is a call type. This parameter is optional and defaults to empty, which matches all call types.', 'enumValueTitles' => ['Outbound' => 'Outbound', 'Back2Back' => 'Back-to-back', 'PrivacyDial' => 'Encrypted call', 'Internal' => 'Internal call', 'Predictive' => 'Predictive outbound call', 'Inbound' => 'Inbound call', 'Conference' => 'Conference'], 'type' => 'string', 'required' => false, 'example' => '["Inbound", "Outbound"]', 'title' => '', ], ], [ 'name' => 'MediaType', 'in' => 'query', 'schema' => ['description' => 'Media type. The default is Audio. Other options include Chat (text), Video, and ALL.', 'type' => 'string', 'required' => false, 'example' => 'AUDIO', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'Page number, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'Page size, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'TotalCount' => ['description' => 'Total count.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'List' => [ 'description' => 'List of real-time agent status data.', 'type' => 'array', 'items' => [ 'description' => 'Real-time agent status data.', 'type' => 'object', 'properties' => [ 'Extension' => ['description' => 'The agent\'s extension number.', 'type' => 'string', 'example' => '80317391', 'title' => ''], 'StateCode' => [ 'description' => 'Sub-status. In some scenarios, the agent\'s status cannot be fully represented by the State field alone, so a sub-status is required for clarification. For example, when an agent is being monitored, State=Talking and StateCode=Monitoring.', 'enumValueTitles' => ['Monitored' => 'Being listened to', 'Consulted' => 'Being consulted', 'Coaching' => 'Coaching in progress', 'Consulting' => 'Consulting in progress', 'Coached' => 'Coached', 'Conference' => 'Conference', 'Monitoring' => 'Listening in progress'], 'type' => 'string', 'example' => 'Monitored', 'title' => '', ], 'State' => [ 'description' => 'Agent status.', 'enumValueTitles' => ['Ready' => 'empty', 'Talking' => 'talking', 'ACW' => 'post-processing', 'Ringing' => 'ringing', 'Break' => 'break', 'Offline' => 'unpublish', 'Dialing' => 'dial-up'], 'type' => 'string', 'example' => 'ACW', 'title' => '', ], 'BreakCode' => ['description' => 'Break code.'."\n" ."\n" .'**Enumeration values:**'."\n" ."\n" .'- RingingTimeout: Break caused by agent ringing timeout.'."\n" ."\n" .'- RejectCall: Break caused by agent call rejection.'."\n" ."\n" .'- Warm-up: Temporary break state after the agent is published and before becoming idle.', 'type' => 'string', 'example' => 'Warm-up', 'title' => ''], 'AgentId' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => 'agent1@ccc-test', 'title' => ''], 'StateTime' => ['description' => 'Time when the status started.', 'type' => 'integer', 'format' => 'int64', 'example' => '1696670640774', 'title' => ''], 'AgentName' => ['description' => 'Agent name.', 'type' => 'string', 'example' => '坐席小王', 'title' => ''], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'CounterParty' => ['description' => 'Used in specific three-party scenarios, primarily for listener, coaching, and consultation. In three-party scenarios, it represents the third party—for example, the agent being monitored or coached in a listener or coaching scenario, or the agent or external number to which a call is transferred in a consultation scenario.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'SkillGroupIdList' => [ 'description' => 'List of skill group IDs that the agent has signed into.', 'type' => 'array', 'items' => ['description' => 'Skill group ID.', 'type' => 'string', 'example' => 'skillgroup1@ccc-test', 'title' => ''], 'title' => '', 'example' => '', ], 'SkillGroupNameList' => [ 'description' => 'List of skill group names that the agent has signed into.', 'type' => 'array', 'items' => ['description' => 'Skill group name.', 'type' => 'string', 'example' => '测试技能组', 'title' => ''], 'title' => '', 'example' => '', ], 'WorkMode' => [ 'description' => 'Work mode.', 'enumValueTitles' => ['ON_SITE' => 'On-site mode', 'OFF_SITE' => 'Off-site mode', 'OFFICE_PHONE' => 'Office phone mode'], 'type' => 'string', 'example' => 'ON_SITE', 'title' => '', ], 'OutboundScenario' => ['description' => 'Whether the agent is in outbound-only mode.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Mobile' => ['description' => 'The agent\'s personal phone number.', 'type' => 'string', 'example' => '1382114****', 'title' => ''], 'CallType' => [ 'description' => 'Call type.', 'enumValueTitles' => ['Outbound' => 'Outbound', 'Back2Back' => 'Double call', 'PrivacyDial' => 'Encrypted call', 'Internal' => 'Internal call', 'Predictive' => 'Predictive outbound', 'Inbound' => 'Inbound', 'Conference' => 'Conference'], 'type' => 'string', 'example' => 'Outbound', 'title' => '', ], 'Duration' => ['description' => 'Duration of the current status, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '16', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => ''], ], ], 'title' => 'Obtain real-time agent status report ', 'summary' => 'You can invoke ListRealtimeAgentStates to obtain a real-time status data report for one or more specified agents in a specified instance.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2025-02-13T02:21:10.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-06-21T06:52:28.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-07-12T04:33:02.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-06-24T03:34:23.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2021-12-21T12:54:51.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRealtimeAgentStates'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"List\\": [\\n {\\n \\"Extension\\": \\"80317391\\",\\n \\"StateCode\\": \\"Monitored\\",\\n \\"State\\": \\"ACW\\",\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"AgentId\\": \\"agent1@ccc-test\\",\\n \\"StateTime\\": 1696670640774,\\n \\"AgentName\\": \\"坐席小王\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"CounterParty\\": \\"agent@ccc-test\\",\\n \\"SkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ],\\n \\"SkillGroupNameList\\": [\\n \\"测试技能组\\"\\n ],\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1382114****\\",\\n \\"CallType\\": \\"Outbound\\",\\n \\"Duration\\": 16\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'ListRealtimeSkillGroupStates' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccOQKOLI'], ], 'parameters' => [ [ 'name' => 'SkillGroupIdList', 'in' => 'formData', 'schema' => ['description' => 'List of skill group IDs for which data is queried. If not specified, all skill groups under the current instance are queried. The format is a JSON array string, with each array element being a skill group ID.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '["skillgroup1@ccc-test", "skillgroup2@ccc-test"]', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'Page number, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'Page size, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'MediaType', 'in' => 'query', 'schema' => ['description' => 'Media type.'."\n" ."\n" .'Enumeration values:'."\n" ."\n" .'AUDIO: Voice.'."\n" ."\n" .'VIDEO: Video.'."\n" ."\n" .'CHAT: Message.'."\n" ."\n" .'ALL: All.', 'type' => 'string', 'required' => false, 'example' => 'AUDIO', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '26A34338-5CD9-4C95-A7A6-5BDCE76C6B94', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'Page number, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'Page size, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'TotalCount' => ['description' => 'Total count.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], 'List' => [ 'description' => 'List of real-time skill group status data.', 'type' => 'array', 'items' => [ 'description' => 'Real-time skill group status data.', 'type' => 'object', 'properties' => [ 'WorkingAgents' => ['description' => 'Number of agents currently in post-processing.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'LongestWaitingTime' => ['description' => 'Current maximum queue waiting time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'LoggedInAgents' => ['description' => 'Number of agents currently logged in.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], 'WaitingCalls' => ['description' => 'Number of calls currently in the queue.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'BreakingAgents' => ['description' => 'Number of agents currently on break.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TalkingAgents' => ['description' => 'Number of agents currently on a call.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SkillGroupName' => ['description' => 'Skill group name.', 'type' => 'string', 'example' => 'skillgroup', 'title' => ''], 'SkillGroupId' => ['description' => 'Skill group ID.', 'type' => 'string', 'example' => 'skillgroup@ccc-test', 'title' => ''], 'ReadyAgents' => ['description' => 'Number of agents currently idle.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'OutboundScenarioReadyAgents' => ['description' => 'Number of agents in outbound-only mode and in an idle status.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalAgents' => ['description' => 'Total number of agents.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], 'BreakCodeDetailList' => [ 'description' => 'Break statistics.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'BreakCode' => ['description' => 'Break status code', 'type' => 'string', 'example' => '客户自定义参数，比如午餐、会议等', 'title' => ''], 'Count' => ['description' => 'The number of times the break status occurred', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ], ], 'title' => 'Retrieve real-time skill group status report ', 'summary' => 'You can invoke ListRealtimeSkillGroupStates to obtain the real-time skill group status report for a specified instance.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2024-06-21T06:52:28.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-11-22T01:05:25.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRealtimeSkillGroupStates'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"26A34338-5CD9-4C95-A7A6-5BDCE76C6B94\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 2,\\n \\"List\\": [\\n {\\n \\"WorkingAgents\\": 0,\\n \\"LongestWaitingTime\\": 0,\\n \\"LoggedInAgents\\": 2,\\n \\"WaitingCalls\\": 0,\\n \\"BreakingAgents\\": 0,\\n \\"TalkingAgents\\": 0,\\n \\"SkillGroupName\\": \\"skillgroup\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"ReadyAgents\\": 2,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenarioReadyAgents\\": 0,\\n \\"TotalAgents\\": 12,\\n \\"BreakCodeDetailList\\": [\\n {\\n \\"BreakCode\\": \\"客户自定义参数，比如午餐、会议等\\",\\n \\"Count\\": 1\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'ListRecentCallDetailRecords' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc5HY0NN'], ], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'Page ordinal number, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'Page size, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'formData', 'schema' => ['description' => 'Start UNIX timestamp. The default value is the start time of the current day. The earliest allowed time is 180 days before the current time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1604638129000', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'End UNIX timestamp. The default value is the current time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '4133952000000', 'minimum' => '0', 'example' => '1604639129000', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'Criteria', 'in' => 'query', 'schema' => ['description' => 'Fuzzy search criteria in JSON object format. The object contains three properties that can be combined arbitrarily: phoneNumber (fuzzy search by calling or called number), callingNumber (fuzzy search by calling number), and calledNumber (fuzzy search by called number).', 'type' => 'string', 'required' => false, 'example' => '{"phoneNumber":"1312121****","callingNumber":"1312121****","calledNumber":"1312121****"}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'Page number, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'Page size, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'TotalCount' => ['description' => 'Total count. The actual total is returned only when PageNumber is 1; otherwise, it is 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '11', 'title' => ''], 'List' => [ 'description' => 'List of call records.', 'type' => 'array', 'items' => [ 'description' => 'Call record.', 'type' => 'object', 'properties' => [ 'StartTime' => ['description' => 'Call start time. For inbound calls, it starts when the call enters IVR. For outbound calls, it starts when the call is answered. The format is a Unix timestamp string in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1532448000000', 'title' => ''], 'ContactDisposition' => [ 'description' => 'The reason the call ended.', 'enumValueTitles' => [ 'AbandonedInQueue' => 'Abandoned in Queue', 'NoAnswer' => 'Customer Not Answered', 'QueuingTimeout' => 'Queuing Timeout', 'Voicemail' => 'Voicemail', 'QueuingFailed' => 'Transfer to Agent Failed', 'QueuingOverflow' => 'Queuing Overflow', 'AbandonedInVoiceNavigator' => 'Abandoned in Intelligent IVR', 'Success' => 'Normal End', 'IVRException' => 'IVR Abnormal', 'AbandonedInRing' => 'Abandoned in Ring', 'AbandonedInIVR' => 'Abandoned in IVR', 'Reject' => 'Rejected by Customer', 'ForwardToOutsideNumber' => 'Forwarded to Outside Number', ], 'type' => 'string', 'example' => 'Success', 'title' => '', ], 'ContactType' => [ 'description' => 'Call type.', 'enumValueTitles' => ['Outbound' => 'Outbound', 'Back2Back' => 'Back-to-back', 'PrivacyDial' => 'Encrypted Call', 'Internal' => 'Internal Call', 'Predictive' => 'Predictive Outbound', 'Inbound' => 'Inbound', 'Conference' => 'Conference'], 'type' => 'string', 'example' => 'Outbound', 'title' => '', ], 'AgentIds' => ['description' => 'List of agent IDs. Multiple values are separated by commas.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'ContactId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-7660472242845****', 'title' => ''], 'CallDuration' => ['description' => 'Call duration in seconds.', 'type' => 'string', 'example' => '16', 'title' => ''], 'CallingNumber' => ['description' => 'Calling number.', 'type' => 'string', 'example' => '0533128****', 'title' => ''], 'Duration' => ['description' => 'Call duration in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '16', 'title' => ''], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'CalledNumber' => ['description' => 'Called number.', 'type' => 'string', 'example' => '1332315****', 'title' => ''], 'SkillGroupIds' => ['description' => 'Skill groups to which the agent participating in the call belongs. Multiple skill groups are separated by commas.', 'type' => 'string', 'example' => 'skillgroup@ccc-test', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ], ], 'title' => 'Retrieve the list of recent call records for agents ', 'summary' => 'You can invoke ListRecentCallDetailRecords to obtain the list of recent call detail records for agents mapped to the current Resource Access Management (RAM) user under the specified instance.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRecentCallDetailRecords'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 11,\\n \\"List\\": [\\n {\\n \\"StartTime\\": 1532448000000,\\n \\"ContactDisposition\\": \\"Success\\",\\n \\"ContactType\\": \\"Outbound\\",\\n \\"AgentIds\\": \\"agent@ccc-test\\",\\n \\"ContactId\\": \\"job-7660472242845****\\",\\n \\"CallDuration\\": \\"16\\",\\n \\"CallingNumber\\": \\"0533128****\\",\\n \\"Duration\\": 16,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"CalledNumber\\": \\"1332315****\\",\\n \\"SkillGroupIds\\": \\"skillgroup@ccc-test\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'ListRoles' => [ 'summary' => 'You can invoke ListRoles to obtain all roles under a specified instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '711D948F-C616-4E23-8573-0F260513CE09', 'title' => ''], 'Data' => [ 'description' => 'List of roles.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Name' => [ 'description' => 'Role name.', 'enumValueTitles' => ['Agent' => 'Agent', 'Admin' => 'Administrator', 'Manager' => 'Skill Group Leader'], 'type' => 'string', 'example' => 'Admin', 'title' => '', ], 'RoleId' => ['description' => 'Role ID, in the format: role\\@instance ID.', 'type' => 'string', 'example' => 'Admin@ccc-test', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Invalid', 'errorMessage' => 'The parameter %s is invalid. %s.', 'description' => ''], ], ], 'title' => 'Obtain the role list', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRoles'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"711D948F-C616-4E23-8573-0F260513CE09\\",\\n \\"Data\\": [\\n {\\n \\"Name\\": \\"Admin\\",\\n \\"RoleId\\": \\"Admin@ccc-test\\"\\n }\\n ]\\n}","type":"json"}]', ], 'ListSkillGroupStates' => [ 'summary' => 'You can invoke the ListSkillgroupStates API to obtain the status list of specified skill groups under a specified instance. This API is only available to specific Users, and other Customers are not recommended to invoke it.', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => true, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccOQKOLI'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'SkillGroupIds', 'in' => 'query', 'schema' => ['description' => 'List of skill group IDs.', 'type' => 'string', 'required' => false, 'example' => '["skillgroup1@ccc-test","skillgroup2@ccc-test"]', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'Page number, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'Page size, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '1F69EBB0-63E9-5DDE-887F-9FC040ADF309', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'Page number, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'Page size, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'TotalCount' => ['description' => 'Total count.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'List' => [ 'description' => 'List of skill group status data.', 'type' => 'array', 'items' => [ 'description' => 'Skill group status data.', 'type' => 'object', 'properties' => [ 'WorkingAgents' => ['description' => 'The number of agents in post-processing.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'LoggedInAgents' => ['description' => 'Number of logged-in agents.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'BreakingAgents' => ['description' => 'Number of agents in break status.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'LongestCall' => ['description' => 'Maximum waiting duration.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'WaitingCalls' => ['description' => 'Number of calls currently in the queue.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TalkingAgents' => ['description' => 'The number of agents on calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SkillGroupName' => ['description' => 'Skill group name.', 'type' => 'string', 'example' => '测试技能组', 'title' => ''], 'SkillGroupId' => ['description' => 'The skill group ID.', 'type' => 'string', 'example' => 'skillgroup1@ccc-test', 'title' => ''], 'ReadyAgents' => ['description' => 'The number of idle agents.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'AverageWaitingTime' => ['description' => 'The average waiting time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], 'WaitingCallsLevel10' => ['description' => 'The number of calls with a waiting duration of less than 10 seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'WaitingCallsLevel20' => ['description' => 'Number of calls with waiting duration less than 20 seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'WaitingCallsLevel30' => ['description' => 'The number of calls with a waiting duration of less than 30 seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'OutboundScenarioReadyAgents' => ['description' => 'The number of agents who are idle and in outbound-only status.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'InboundTalkingAgents' => ['description' => 'The number of agents on calls in the inbound scenario.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'OutboundTalkingAgents' => ['description' => 'Number of agents on outbound calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'staticInfo' => [ 'substitutions' => ['CCC::2020-07-01::ListRealtimeSkillGroupStates'], ], 'title' => 'Obtain the skill group status list', 'changeSet' => [ ['createdAt' => '2022-11-25T02:02:44.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-07-04T11:51:59.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-06-15T03:10:11.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-06-06T09:08:50.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-02-28T02:23:24.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '250', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSkillGroupStates'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"1F69EBB0-63E9-5DDE-887F-9FC040ADF309\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"WorkingAgents\\": 0,\\n \\"LoggedInAgents\\": 0,\\n \\"BreakingAgents\\": 0,\\n \\"LongestCall\\": 0,\\n \\"WaitingCalls\\": 0,\\n \\"TalkingAgents\\": 0,\\n \\"SkillGroupName\\": \\"测试技能组\\",\\n \\"SkillGroupId\\": \\"skillgroup1@ccc-test\\",\\n \\"ReadyAgents\\": 1,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"AverageWaitingTime\\": 3,\\n \\"WaitingCallsLevel10\\": 0,\\n \\"WaitingCallsLevel20\\": 0,\\n \\"WaitingCallsLevel30\\": 0,\\n \\"OutboundScenarioReadyAgents\\": 0,\\n \\"InboundTalkingAgents\\": 0,\\n \\"OutboundTalkingAgents\\": 0\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'ListSkillGroupSummaryReportsSinceMidnight' => [ 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => true, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccOQKOLI'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'SkillGroups', 'in' => 'query', 'schema' => ['description' => 'A JSON-formatted string that contains the IDs of the skill groups to query. If this parameter is omitted, the query includes all skill groups.', 'type' => 'string', 'required' => false, 'example' => '["skillgroup1@ccc-test", "skillgroup2@ccc-test2"]'."\n", 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number to return. The value must be in the range of 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page. The value must be in the range of 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2B36CEBC-6D11-5451-9E6B-C6D1927841C5', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'PagedSkillGroupSummaryReport' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'The page number. The valid range is 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page. The valid range is 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], 'List' => [ 'description' => 'A list of skill group summary reports.', 'type' => 'array', 'items' => [ 'description' => 'A skill group summary record.', 'type' => 'object', 'properties' => [ 'Timestamp' => ['description' => 'The timestamp when the metrics were collected.', 'type' => 'string', 'example' => '2018-09-13 00:00:00', 'title' => ''], 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'SkillGroupName' => ['description' => 'The name of the skill group.', 'type' => 'string', 'example' => '测试技能组', 'title' => ''], 'SkillGroupId' => ['description' => 'The skill group ID.', 'type' => 'string', 'example' => 'skillgroup@ccc-test', 'title' => ''], 'Overall' => [ 'description' => 'Overall metrics.', 'type' => 'object', 'properties' => [ 'TotalLoggedInTime' => ['description' => 'The total logged-in time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalTalkTime' => ['description' => 'The total talk time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'OccupancyRate' => ['description' => 'The agent occupancy rate, expressed as a percentage (%).', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'TotalWorkTime' => ['description' => 'The total after-call work time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxWorkTime' => ['description' => 'The maximum after-call work time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageWorkTime' => ['description' => 'The average after-call work time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageTalkTime' => ['description' => 'The average talk time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionIndex' => ['description' => 'The satisfaction index, calculated as the average of single-digit keypad inputs from satisfaction surveys.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'SatisfactionSurveysOffered' => ['description' => 'The number of satisfaction surveys offered.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionSurveysResponded' => ['description' => 'The number of satisfaction surveys responded to.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxReadyTime' => ['description' => 'The maximum ready time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageReadyTime' => ['description' => 'The average ready time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalBreakTime' => ['description' => 'The total break time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalReadyTime' => ['description' => 'The total ready time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxTalkTime' => ['description' => 'The maximum talk time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalCalls' => ['description' => 'The total number of calls (`CallsOffered` + `CallsDialed`).', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Inbound' => [ 'description' => 'Inbound call metrics.', 'type' => 'object', 'properties' => [ 'AverageRingTime' => ['description' => 'The average ring time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsHandled' => ['description' => 'The number of handled inbound calls. Each call is counted once per queue entry, regardless of how many agents answer it.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalWorkTime' => ['description' => 'The total after-call work time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxWorkTime' => ['description' => 'The maximum after-call work time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'QueueMaxWaitTimeDuration' => ['description' => 'The maximum queue wait time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageWorkTime' => ['description' => 'The average after-call work time, in seconds (`TotalWorkTime` / `CallsHandled`).', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionIndex' => ['description' => 'The satisfaction index, calculated as the average of single-digit keypad inputs from satisfaction surveys.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'AnsweredByAgentOfQueueWaitTimeDuration' => ['description' => 'The total queue wait time for calls answered by an agent, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalRingTime' => ['description' => 'The total ring time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'InComingQueueOfQueueCount' => ['description' => 'The number of calls that entered the skill group queue.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxTalkTime' => ['description' => 'The maximum talk time, in seconds.', 'type' => 'string', 'example' => '0', 'title' => ''], 'MaxRingTime' => ['description' => 'The maximum ring time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalTalkTime' => ['description' => 'The total talk time for inbound calls, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsOffered' => ['description' => 'The number of calls offered to the skill group.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AbandonedInQueueOfQueueCount' => ['description' => 'The number of calls abandoned while waiting in the skill group queue.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'OverFlowInQueueOfQueueCount' => ['description' => 'The number of calls that overflowed from the skill group queue.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AnsweredByAgentOfQueueMaxWaitTimeDuration' => ['description' => 'The maximum queue wait time for a call answered by an agent.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'ServiceLevel20' => ['description' => 'The percentage of calls answered within 20 seconds.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'AverageTalkTime' => ['description' => 'The average talk time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AnsweredByAgentOfQueueCount' => ['description' => 'The number of calls routed to the skill group and answered by an agent.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionSurveysOffered' => ['description' => 'The number of satisfaction surveys offered.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'HandleRate' => ['description' => 'The handle rate (`CallsHandled` / `CallsOffered`). The value can exceed 100% because the handle and offer events might occur in different time windows.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'SatisfactionSurveysResponded' => ['description' => 'The number of satisfaction surveys responded to.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'GiveUpByAgentOfQueueCount' => ['description' => 'The number of calls that were abandoned while an agent in the skill group was being alerted.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'QueueWaitTimeDuration' => ['description' => 'The queue wait time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsServiceLevel20' => ['description' => 'The number of calls answered by an agent within 20 seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsServiceLevel30' => ['description' => 'The number of calls answered by an agent within 30 seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsServiceLevel10' => ['description' => 'The number of calls answered by an agent within 10 seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsAttendedTransferOut' => ['description' => 'The number of attended transfers initiated. If a call is transferred multiple times, each transfer is counted separately.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsBlindTransferOut' => ['description' => 'The number of blind transfers initiated. If a call is transferred multiple times, each transfer is counted separately.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsQueuingTimeout' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], 'CallsTimeout' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], 'CallsQueuingCanceled' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'CallsQueuingFailure' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'CallsQueuingRerouted' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'CallsAbandoned' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], 'CallsOverflow' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], 'Outbound' => [ 'description' => 'Outbound call metrics.', 'type' => 'object', 'properties' => [ 'TotalTalkTime' => ['description' => 'The total talk time for outbound calls, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxDialingTime' => ['description' => 'The maximum dialing time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsDialed' => ['description' => 'The number of outbound calls dialed.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsAnswered' => ['description' => 'The number of answered outbound calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AnswerRate' => ['description' => 'The answer rate, expressed as a percentage (%).', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'TotalWorkTime' => ['description' => 'The total after-call work time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxWorkTime' => ['description' => 'The maximum after-call work time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'TotalDialingTime' => ['description' => 'The total dialing time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageTalkTime' => ['description' => 'The average talk time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageWorkTime' => ['description' => 'The average after-call work time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionIndex' => ['description' => 'The satisfaction index, calculated as the average of single-digit keypad inputs from satisfaction surveys.', 'type' => 'number', 'format' => 'float', 'example' => '0', 'title' => ''], 'SatisfactionSurveysOffered' => ['description' => 'The number of satisfaction surveys offered.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'SatisfactionSurveysResponded' => ['description' => 'The number of satisfaction surveys responded to.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'MaxTalkTime' => ['description' => 'The maximum talk time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'AverageDialingTime' => ['description' => 'The average dialing time, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'CallsServiceLevel30' => ['description' => 'The number of calls answered by an agent within 30 seconds.', 'type' => 'string', 'example' => '0', 'title' => ''], 'CallsOffered' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], 'CallsAbandoned' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], 'CallsQueuingTimeout' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], 'CallsQueuingOverflow' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], 'CallsQueuingFailed' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], 'CallsQueuingRerouted' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], 'CallsQueuingCancelled' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], 'CallsQueuingFailure' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], 'TotalWaitTime' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], 'CallsAgentHandled' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], 'CallsServiceLevel30V2' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'staticInfo' => [ 'substitutions' => ['CCC::2020-07-01::ListHistoricalSkillGroupReport'], ], 'title' => 'Retrieve the list of skill group overview data', 'summary' => 'The `ListSkillgroupSummaryReportsSinceMidnight` operation retrieves historical summary reports, filtered by specified conditions, for skill groups in a specified instance. The report contains data from 00:00 (midnight) today to the time of the request. This operation is available to specific users only.', 'changeSet' => [ ['createdAt' => '2024-06-06T07:19:09.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-05-28T06:54:07.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-05-17T08:45:04.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-05-15T02:47:00.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-04-24T12:54:21.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-06-15T03:10:11.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-06-06T09:08:50.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-03-09T09:23:25.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-02-28T02:23:24.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '250', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSkillGroupSummaryReportsSinceMidnight'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"2B36CEBC-6D11-5451-9E6B-C6D1927841C5\\",\\n \\"Success\\": true,\\n \\"PagedSkillGroupSummaryReport\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 3,\\n \\"List\\": [\\n {\\n \\"Timestamp\\": \\"2018-09-13 00:00:00\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"SkillGroupName\\": \\"测试技能组\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Overall\\": {\\n \\"TotalLoggedInTime\\": 0,\\n \\"TotalTalkTime\\": 0,\\n \\"OccupancyRate\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"MaxReadyTime\\": 0,\\n \\"AverageReadyTime\\": 0,\\n \\"TotalBreakTime\\": 0,\\n \\"TotalReadyTime\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"TotalCalls\\": 0\\n },\\n \\"Inbound\\": {\\n \\"AverageRingTime\\": 0,\\n \\"CallsHandled\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"QueueMaxWaitTimeDuration\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"AnsweredByAgentOfQueueWaitTimeDuration\\": 0,\\n \\"TotalRingTime\\": 0,\\n \\"InComingQueueOfQueueCount\\": 0,\\n \\"MaxTalkTime\\": \\"0\\",\\n \\"MaxRingTime\\": 0,\\n \\"TotalTalkTime\\": 0,\\n \\"CallsOffered\\": 0,\\n \\"AbandonedInQueueOfQueueCount\\": 0,\\n \\"OverFlowInQueueOfQueueCount\\": 0,\\n \\"AnsweredByAgentOfQueueMaxWaitTimeDuration\\": 0,\\n \\"ServiceLevel20\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"AnsweredByAgentOfQueueCount\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"HandleRate\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"GiveUpByAgentOfQueueCount\\": 0,\\n \\"QueueWaitTimeDuration\\": 0,\\n \\"CallsServiceLevel20\\": 0,\\n \\"CallsServiceLevel30\\": 0,\\n \\"CallsServiceLevel10\\": 0,\\n \\"CallsAttendedTransferOut\\": 0,\\n \\"CallsBlindTransferOut\\": 0,\\n \\"CallsQueuingTimeout\\": 0,\\n \\"CallsTimeout\\": 0,\\n \\"CallsQueuingCanceled\\": \\"\\",\\n \\"CallsQueuingFailure\\": \\"\\",\\n \\"CallsQueuingRerouted\\": \\"\\",\\n \\"CallsAbandoned\\": 0,\\n \\"CallsOverflow\\": \\"\\"\\n },\\n \\"Outbound\\": {\\n \\"TotalTalkTime\\": 0,\\n \\"MaxDialingTime\\": 0,\\n \\"CallsDialed\\": 0,\\n \\"CallsAnswered\\": 0,\\n \\"AnswerRate\\": 0,\\n \\"TotalWorkTime\\": 0,\\n \\"MaxWorkTime\\": 0,\\n \\"TotalDialingTime\\": 0,\\n \\"AverageTalkTime\\": 0,\\n \\"AverageWorkTime\\": 0,\\n \\"SatisfactionIndex\\": 0,\\n \\"SatisfactionSurveysOffered\\": 0,\\n \\"SatisfactionSurveysResponded\\": 0,\\n \\"MaxTalkTime\\": 0,\\n \\"AverageDialingTime\\": 0,\\n \\"CallsServiceLevel30\\": \\"0\\",\\n \\"CallsOffered\\": 0,\\n \\"CallsAbandoned\\": 0,\\n \\"CallsQueuingTimeout\\": 0,\\n \\"CallsQueuingOverflow\\": 0,\\n \\"CallsQueuingFailed\\": 0,\\n \\"CallsQueuingRerouted\\": 0,\\n \\"CallsQueuingCancelled\\": 0,\\n \\"CallsQueuingFailure\\": 0,\\n \\"TotalWaitTime\\": 0,\\n \\"CallsAgentHandled\\": 0,\\n \\"CallsServiceLevel30V2\\": 0\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'ListSkillGroups' => [ 'summary' => 'You can invoke ListSkillGroups to obtain the list of skill groups under a specified instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccPBOQGO'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'SearchPattern', 'in' => 'query', 'schema' => ['description' => 'Performs fuzzy matching based on the skill group name or display name. This parameter is optional and defaults to empty, which means no filtering is applied.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '测试技能组', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The paging size, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''], ], [ 'name' => 'MediaType', 'in' => 'query', 'schema' => ['description' => 'The media type. The default is AUDIO. Other options include CHAT and VIDEO.', 'type' => 'string', 'required' => false, 'example' => 'Audio', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'Page number, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'Page size, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'TotalCount' => ['description' => 'Total count.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'List' => [ 'description' => 'List of skill groups.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'DisplayName' => ['description' => 'The display name of the skill group.', 'type' => 'string', 'example' => '测试技能组', 'title' => ''], 'Description' => ['description' => 'Description of the skill group.', 'type' => 'string', 'example' => '云联络中心的测试技能组。', 'title' => ''], 'PhoneNumberCount' => ['description' => 'Quantity of phone numbers associated with the skill group.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'SkillGroupId' => ['description' => 'The skill group ID.', 'type' => 'string', 'example' => 'skillgroup@ccc-test', 'title' => ''], 'SkillGroupName' => ['description' => 'Name of the skill group.', 'type' => 'string', 'example' => 'skillgroup', 'title' => ''], 'UserCount' => ['description' => 'The number of agents associated with the skill group.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'MediaType' => ['description' => 'The media type. The default is AUDIO. Other options include CHAT and VIDEO.', 'type' => 'string', 'example' => 'CHAT', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Retrieve the skill group list', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-11-06T05:44:48.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSkillGroups'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"List\\": [\\n {\\n \\"DisplayName\\": \\"测试技能组\\",\\n \\"Description\\": \\"云联络中心的测试技能组。\\",\\n \\"PhoneNumberCount\\": 1,\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"SkillGroupName\\": \\"skillgroup\\",\\n \\"UserCount\\": 2,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"MediaType\\": \\"CHAT\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'ListSkillLevelsOfUser' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'Agent ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test', 'title' => ''], ], [ 'name' => 'IsMember', 'in' => 'query', 'schema' => ['description' => 'Indicates whether to associate with the specified agent. If true, retrieves the skill levels of skill groups associated with the agent. If false, retrieves the list of skill groups that the agent can be associated with but is not currently associated with. The default value is true.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'Page number, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'Page size, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''], ], [ 'name' => 'SearchPattern', 'in' => 'query', 'schema' => ['description' => 'Perform fuzzy matching based on skill group name or display name. This parameter is optional and defaults to empty, which means no filtering is applied.', 'type' => 'string', 'required' => false, 'example' => 'skillgroup', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'Page number, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'Page size, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'TotalCount' => ['description' => 'Total count.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'List' => [ 'description' => 'List of skill group levels.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'SkillLevel' => ['description' => 'Skill level, with values ranging from 1 to 10. A smaller numeric value indicates stronger business capability and the ability to handle more calls per unit time.', 'type' => 'string', 'example' => '5', 'title' => ''], 'SkillGroupId' => ['description' => 'Skill group ID.', 'type' => 'string', 'example' => 'skillgroup@ccc-test', 'title' => ''], 'SkillGroupName' => ['description' => 'Skill group name.', 'type' => 'string', 'example' => 'skillgroup', 'title' => ''], 'MediaType' => ['description' => 'Media type. The default value is AUDIO. Other optional values include CHAT and VIDEO.', 'type' => 'string', 'example' => 'VIDEO', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => ''], ], ], 'title' => 'Retrieve the skill group level list of an agent ', 'summary' => 'You can use this API to retrieve the list of skill levels for skill groups associated with a specified agent under a specified instance. You can also use this API to query the list of skill groups that the agent can be associated with but is not currently associated with.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-11-06T05:44:48.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSkillLevelsOfUser'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10,\\n \\"List\\": [\\n {\\n \\"SkillLevel\\": \\"5\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"SkillGroupName\\": \\"skillgroup\\",\\n \\"MediaType\\": \\"VIDEO\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'ListSmsMetadata' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '251523', 'abilityTreeNodes' => ['FEATUREcccBM6DRP'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. The value ranges from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. The value ranges from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '100', 'title' => ''], ], [ 'name' => 'ScenarioListJson', 'in' => 'query', 'schema' => ['description' => 'The type of the scenario. Valid values:'."\n" ."\n" .'- SATISFACTION\\_SURVEY: satisfaction survey'."\n" ."\n" .'- CONTACT\\_FLOW\\_NODE: Interactive Voice Response (IVR) flow node'."\n" ."\n" .'- MISSED\\_CALL\\_NOTIFICATION: missed call notification'."\n" ."\n" .'- FLASH\\_SMS: Alibaba Cloud flash SMS notification', 'type' => 'string', 'required' => false, 'example' => '["SATISFACTION_SURVEY","CONTACT_FLOW_NODE"]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8707EB29-BAED-4302-B999-40BA61877437', 'title' => ''], 'Params' => [ 'description' => 'The list of incorrect parameters.', 'type' => 'array', 'items' => ['description' => 'The incorrect parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], 'Data' => [ 'description' => 'The data.', 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'List' => [ 'description' => 'The list of SMS configurations.', 'type' => 'array', 'items' => [ 'description' => 'The SMS configuration.', 'type' => 'object', 'properties' => [ 'SmsMetadataId' => ['description' => 'The ID of the SMS configuration.', 'type' => 'string', 'example' => '5ffc1c9a-4d3d-4019-*****-73255fb01d1c', 'title' => ''], 'TemplateCode' => ['description' => 'The template code.', 'type' => 'string', 'example' => 'SMS_468xxxx298', 'title' => ''], 'Description' => ['description' => 'The description of the configuration.', 'type' => 'string', 'example' => '漏话短信配置', 'title' => ''], 'Scenario' => ['description' => 'The scenario type.', 'type' => 'string', 'example' => 'MISSED_CALL_NOTIFICATION', 'title' => ''], 'AliyunUid' => ['description' => 'The Alibaba Cloud account ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '15772400000****', 'title' => ''], 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'Name' => ['description' => 'The name of the configuration.', 'type' => 'string', 'example' => '漏话短信提醒', 'title' => ''], 'SignName' => ['description' => 'The name of the SMS signature.', 'type' => 'string', 'example' => '云呼叫中心', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => ''], ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"8707EB29-BAED-4302-B999-40BA61877437\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 200,\\n \\"List\\": [\\n {\\n \\"SmsMetadataId\\": \\"5ffc1c9a-4d3d-4019-*****-73255fb01d1c\\",\\n \\"TemplateCode\\": \\"SMS_468xxxx298\\",\\n \\"Description\\": \\"漏话短信配置\\",\\n \\"Scenario\\": \\"MISSED_CALL_NOTIFICATION\\",\\n \\"AliyunUid\\": 0,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Name\\": \\"漏话短信提醒\\",\\n \\"SignName\\": \\"云呼叫中心\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => 'Obtain text message configuration details', 'summary' => 'Queries the details of SMS configurations.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'ListTicketTasks' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'TicketId', 'in' => 'query', 'schema' => ['description' => 'The ID of the ticket.', 'type' => 'string', 'required' => false, 'example' => '5491d3b4-14ee-4341-b5f1-db2c78beddeb', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'ListTicketTasksResponse', 'title' => 'ListTicketTasksResponse ', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The data returned.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'TaskName' => ['description' => 'The name of the node.', 'type' => 'string', 'example' => '节点1', 'title' => ''], 'Assignee' => ['description' => 'The ID of the assignee.', 'type' => 'string', 'example' => 'assignee@ccc-test', 'title' => ''], 'Comment' => ['description' => 'The comment.', 'type' => 'string', 'example' => '同意', 'title' => ''], 'StartTime' => ['description' => 'The start time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1620259200000', 'title' => ''], 'EndTime' => ['description' => 'The end time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1620269200000', 'title' => ''], 'AssigneeName' => ['description' => 'The name of the assignee.', 'type' => 'string', 'example' => 'assignee', 'title' => ''], 'TaskId' => ['description' => 'The ID of the node.', 'type' => 'string', 'example' => 'eb039a4a6a5742c6b44ccff0c1fca745', 'title' => ''], 'TicketId' => ['description' => 'The ID of the ticket.', 'type' => 'string', 'example' => '5491d3b4-14ee-4341-b5f1-db2c78beddeb'."\n", 'title' => ''], 'InstanceId' => ['description' => 'The ID of the instance.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'FileKeys' => [ 'description' => 'A list of files.', 'type' => 'array', 'items' => ['description' => 'A file.', 'type' => 'string', 'example' => '["ticket-file/xxx.png"]', 'title' => ''], 'title' => '', 'example' => '', ], 'FileUrls' => [ 'description' => 'A list of file access URLs.', 'type' => 'array', 'items' => ['description' => 'A file access URL.', 'type' => 'string', 'example' => '["http://oss-cn-hangzhou.com/bucket/ticket-file/xxx.png"]', 'title' => ''], 'title' => '', 'example' => '', ], 'TaskDefinitionNodeId' => ['description' => 'The ID of the ticket node in the process definition.', 'type' => 'string', 'example' => 'APPROVAL__6zu2QjAz', 'title' => ''], 'TaskDefinitionNodeType' => ['description' => 'The type of the ticket node in the process definition.', 'type' => 'string', 'example' => 'APPROVAL', 'title' => ''], 'Action' => ['description' => 'The action performed on the node.', 'type' => 'string', 'example' => 'CounterSignTask', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE ', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Params' => [ 'description' => 'A list of error parameters.', 'type' => 'array', 'items' => ['description' => 'An error parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"TaskName\\": \\"节点1\\",\\n \\"Assignee\\": \\"assignee@ccc-test\\",\\n \\"Comment\\": \\"同意\\",\\n \\"StartTime\\": 1620259200000,\\n \\"EndTime\\": 1620269200000,\\n \\"AssigneeName\\": \\"assignee\\",\\n \\"TaskId\\": \\"eb039a4a6a5742c6b44ccff0c1fca745\\",\\n \\"TicketId\\": \\"5491d3b4-14ee-4341-b5f1-db2c78beddeb\\\\n\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"FileKeys\\": [\\n \\"[\\\\\\"ticket-file/xxx.png\\\\\\"]\\"\\n ],\\n \\"FileUrls\\": [\\n \\"[\\\\\\"http://oss-cn-hangzhou.com/bucket/ticket-file/xxx.png\\\\\\"]\\"\\n ],\\n \\"TaskDefinitionNodeId\\": \\"APPROVAL__6zu2QjAz\\",\\n \\"TaskDefinitionNodeType\\": \\"APPROVAL\\",\\n \\"Action\\": \\"CounterSignTask\\"\\n }\\n ],\\n \\"RequestId\\": \\"DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\\\t\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', 'title' => 'Obtain ticket node information', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'summary' => '', ], 'ListTicketTemplates' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ 'name' => 'SearchPattern', 'in' => 'query', 'schema' => ['description' => 'The name of the template. Fuzzy search is supported.', 'type' => 'string', 'required' => false, 'example' => '模板1', 'title' => ''], ], [ 'name' => 'CategoryId', 'in' => 'query', 'schema' => ['description' => 'The ID of the ticket category.', 'type' => 'string', 'required' => false, 'example' => '43c2671b-********86d0-6bd187905cc8', 'title' => ''], ], [ 'name' => 'State', 'in' => 'query', 'schema' => ['description' => 'The status of the template.'."\n" ."\n" .'- Enabled: The template is published.'."\n" ."\n" .'- Disabled: The template is unpublished.', 'type' => 'string', 'required' => false, 'example' => 'Enabled', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. The value must be between 1 and 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. The value must be between 1 and 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ccc-test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'ListTicketTemplatesResponse', 'title' => 'ListTicketTemplatesResponse', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The data.', 'type' => 'object', 'properties' => [ 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '25', 'title' => ''], 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'List' => [ 'description' => 'The list of templates.', 'type' => 'array', 'items' => [ 'description' => 'The template.', 'type' => 'object', 'properties' => [ 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'example' => 'b5c21219-3a1e-4bc0-92e7-da66e057d2f6', 'title' => ''], 'Name' => ['description' => 'The name of the template.', 'type' => 'string', 'example' => '测试模板', 'title' => ''], 'State' => ['description' => 'The status.', 'type' => 'string', 'example' => 'Enabled', 'title' => ''], 'Editor' => ['description' => 'The user who last edited the template.', 'type' => 'string', 'example' => 'creator@ccc-test', 'title' => ''], 'TicketFields' => [ 'description' => 'The list of fields in the template.', 'type' => 'array', 'items' => [ 'description' => 'The field.', 'type' => 'object', 'properties' => [ 'DisplayName' => ['description' => 'The display name.', 'type' => 'string', 'example' => '姓名'."\n", 'title' => ''], 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => '姓名字段', 'title' => ''], 'Name' => ['description' => 'The name.', 'type' => 'string', 'example' => 'name', 'title' => ''], 'DataType' => ['description' => 'The data type.', 'type' => 'string', 'example' => 'String', 'title' => ''], 'Pattern' => ['description' => 'The regular expression that is used for validation.', 'type' => 'string', 'example' => '^', 'title' => ''], 'PatternErrorMessage' => ['description' => 'The error message that is returned when the regular expression validation fails.', 'type' => 'string', 'example' => '不是有效的email地址'."\n", 'title' => ''], 'MinLength' => ['description' => 'The minimum length.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'MaxLength' => ['description' => 'The maximum length.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], 'Minimum' => ['description' => 'The minimum value for a number.', 'type' => 'number', 'format' => 'double', 'example' => '1', 'title' => ''], 'Maximum' => ['description' => 'The maximum value for a number.', 'type' => 'number', 'format' => 'double', 'example' => '10', 'title' => ''], 'Required' => ['description' => 'Indicates whether the field is required.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'System' => ['description' => 'Indicates whether the field is a system field.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Disabled' => ['description' => 'Indicates whether the field is disabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Array' => ['description' => 'Indicates whether the field is an array.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'ReadOnly' => ['description' => 'Indicates whether the field is read-only.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'EditorType' => ['description' => 'The type of the editor.', 'type' => 'string', 'example' => 'textbox', 'title' => ''], 'Attribute' => ['description' => 'The extended properties.', 'type' => 'string', 'example' => '{}', 'title' => ''], 'DisplayOrder' => ['description' => 'The display order in the list.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'CreatedTime' => ['description' => 'The time when the field was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1715780670000', 'title' => ''], 'UpdatedTime' => ['description' => 'The time when the field was last updated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1715780670000', 'title' => ''], 'Creator' => ['description' => 'The creator.', 'type' => 'string', 'example' => 'creator', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'ProcessDefinition' => ['description' => 'The process information. This parameter is deprecated.', 'type' => 'string', 'example' => '无', 'title' => ''], 'UpdatedTime' => ['description' => 'The time when the template was last updated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1715780670000', 'title' => ''], 'CategoryId' => ['description' => 'The category ID.', 'type' => 'string', 'example' => '43c2671b-*****-4223-86d0-6bd187905cc8', 'title' => ''], 'AppliedVersion' => ['description' => 'The current working version.', 'type' => 'string', 'example' => '0', 'title' => ''], 'LatestVersion' => ['description' => 'The draft version.', 'type' => 'string', 'example' => '1715780670000', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8707EB29-BAED-4302-B999-40BA61877437', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Params' => [ 'description' => 'The list of invalid parameters.', 'type' => 'array', 'items' => ['description' => 'The invalid parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"TotalCount\\": 25,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"List\\": [\\n {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"TemplateId\\": \\"b5c21219-3a1e-4bc0-92e7-da66e057d2f6\\",\\n \\"Name\\": \\"测试模板\\",\\n \\"State\\": \\"Enabled\\",\\n \\"Editor\\": \\"creator@ccc-test\\",\\n \\"TicketFields\\": [\\n {\\n \\"DisplayName\\": \\"姓名\\\\n\\",\\n \\"Description\\": \\"姓名字段\\",\\n \\"Name\\": \\"name\\",\\n \\"DataType\\": \\"String\\",\\n \\"Pattern\\": \\"^\\",\\n \\"PatternErrorMessage\\": \\"不是有效的email地址\\\\n\\",\\n \\"MinLength\\": 1,\\n \\"MaxLength\\": 30,\\n \\"Minimum\\": 1,\\n \\"Maximum\\": 10,\\n \\"Required\\": false,\\n \\"System\\": false,\\n \\"Disabled\\": false,\\n \\"Array\\": false,\\n \\"ReadOnly\\": false,\\n \\"EditorType\\": \\"textbox\\",\\n \\"Attribute\\": \\"{}\\",\\n \\"DisplayOrder\\": 1,\\n \\"CreatedTime\\": 1715780670000,\\n \\"UpdatedTime\\": 1715780670000,\\n \\"Creator\\": \\"creator\\"\\n }\\n ],\\n \\"ProcessDefinition\\": \\"无\\",\\n \\"UpdatedTime\\": 1715780670000,\\n \\"CategoryId\\": \\"43c2671b-*****-4223-86d0-6bd187905cc8\\",\\n \\"AppliedVersion\\": \\"0\\",\\n \\"LatestVersion\\": \\"1715780670000\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"8707EB29-BAED-4302-B999-40BA61877437\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', 'title' => 'Obtain ticket template list', 'summary' => 'Retrieves a list of ticket templates.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'ListTickets' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'Paging size. Range: 1-100.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'Paging ordinal number. Range: 1-100.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'TicketId', 'in' => 'query', 'schema' => ['description' => 'Ticket ID.', 'type' => 'string', 'required' => false, 'example' => '5491d3b4-14ee-4341-b5f1-db2c78beddeb', 'title' => ''], ], [ 'name' => 'Title', 'in' => 'query', 'schema' => ['description' => 'Ticket title.', 'type' => 'string', 'required' => false, 'example' => '标题', 'title' => ''], ], [ 'name' => 'State', 'in' => 'query', 'schema' => ['description' => 'Ticket state.', 'type' => 'string', 'required' => false, 'example' => 'Processing', 'title' => ''], ], [ 'name' => 'CategoryId', 'in' => 'query', 'schema' => ['description' => 'Ticket category ID.', 'type' => 'string', 'required' => false, 'example' => '43c2671b-****-4223-86d0-6bd187905cc8', 'title' => ''], ], [ 'name' => 'Creator', 'in' => 'query', 'schema' => ['description' => 'Creator.', 'type' => 'string', 'required' => false, 'example' => 'creator@cccV2-kmz', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'Start time. Filter by ticket creation time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1646841600000', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'End time. Filter by ticket creation time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1646928000000', 'title' => ''], ], [ 'name' => 'CustomerId', 'in' => 'query', 'schema' => ['description' => 'Customer ID. The Cloud Contact Center customer profile ID.', 'type' => 'string', 'required' => false, 'example' => '51e155ce-3747-*****-b402-13c69597b920', 'title' => ''], ], [ 'name' => 'JobIdList', 'in' => 'query', 'schema' => ['description' => 'A list of contact IDs.', 'type' => 'string', 'required' => false, 'example' => '["job-12******","job-23****"]', 'title' => ''], ], [ 'name' => 'Assignee', 'in' => 'query', 'schema' => ['description' => 'Assignee ID.', 'type' => 'string', 'required' => false, 'example' => 'assignee@cccV2-kmz'."\n", 'title' => ''], ], [ 'name' => 'AssigneeType', 'in' => 'query', 'schema' => ['description' => 'Assignee type.', 'type' => 'string', 'required' => false, 'example' => 'Agent', 'title' => ''], ], [ 'name' => 'Participant', 'in' => 'query', 'schema' => ['description' => 'Participant ID.', 'type' => 'string', 'required' => false, 'example' => 'participant@cccV2-kmz'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '7BEEA660-A45A-45E3-98CC-AFC65E715C23', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'TotalCount' => ['description' => 'Total count.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], 'PageNumber' => ['description' => 'Paging ordinal number. Range: 1-100.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'Paging size. Range: 1-100.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], 'List' => [ 'description' => 'Tickets list.', 'type' => 'array', 'items' => [ 'description' => 'Ticket.', 'type' => 'object', 'properties' => [ 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'TicketId' => ['description' => 'Ticket ID.', 'type' => 'string', 'example' => 'feb83abd-9f08-49d2-9b56-41d1b66ca0ac', 'title' => ''], 'Title' => ['description' => 'Ticket title.', 'type' => 'string', 'example' => '标题', 'title' => ''], 'TemplateId' => ['description' => 'Template ID.', 'type' => 'string', 'example' => 'c844a5f0-496c-4c5b-8a0c-dd27686e8ff6', 'title' => ''], 'TemplateVersion' => ['description' => 'Template version.', 'type' => 'string', 'example' => '0', 'title' => ''], 'CategoryId' => ['description' => 'Ticket category ID.', 'type' => 'string', 'example' => '43c2671b-*****-4223-86d0-6bd187905cc8', 'title' => ''], 'CategoryName' => ['description' => 'Ticket category name.', 'type' => 'string', 'example' => '类目1', 'title' => ''], 'StartTime' => ['description' => 'Ticket start time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1631440860000', 'title' => ''], 'EndTime' => ['description' => 'Ticket end time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1631440860000', 'title' => ''], 'State' => ['description' => 'State.', 'type' => 'string', 'example' => 'Processing', 'title' => ''], 'CloseCode' => ['description' => 'Ticket close reason.', 'type' => 'string', 'example' => 'Completed', 'title' => ''], 'Assignee' => ['description' => 'Assignee ID.', 'type' => 'string', 'example' => 'assignee@ccc-test', 'title' => ''], 'Comment' => ['description' => 'Comment.', 'type' => 'string', 'example' => '无', 'title' => ''], 'AssigneeName' => ['description' => 'Assignee name.', 'type' => 'string', 'example' => 'Assignee', 'title' => ''], 'Creator' => ['description' => 'Creator ID.', 'type' => 'string', 'example' => 'creator@ccc-test'."\n", 'title' => ''], 'CreatorName' => ['description' => 'Creator name.', 'type' => 'string', 'example' => 'Creator', 'title' => ''], 'Context' => ['description' => 'Ticket form information.', 'type' => 'string', 'example' => '{"productName":"alynx"}', 'title' => ''], 'CreatedTime' => ['description' => 'Creation time.', 'type' => 'string', 'example' => '1631440860000', 'title' => ''], 'UpdatedTime' => ['description' => 'Update time.', 'type' => 'string', 'example' => '1631440860000', 'title' => ''], 'CurrentTaskId' => ['description' => 'Current node ID.', 'type' => 'string', 'example' => '0707dab6-34a8-11ef-9823-161e3802b2d4', 'title' => ''], 'CurrentTaskName' => ['description' => 'Current node name.', 'type' => 'string', 'example' => '节点1', 'title' => ''], 'CurrentTaskStartTime' => ['description' => 'Current node start time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1631440860000', 'title' => ''], 'CustomerId' => ['description' => 'Customer ID.', 'type' => 'string', 'example' => '51e155ce-*****1-b402-13c69597b920', 'title' => ''], 'JobId' => ['description' => 'Job ID.', 'type' => 'string', 'example' => 'job-47150***150396416', 'title' => ''], 'Source' => ['description' => 'Ticket source.', 'type' => 'string', 'example' => 'CHAT', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7BEEA660-A45A-45E3-98CC-AFC65E715C23\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"TotalCount\\": 10,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"List\\": [\\n {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"TicketId\\": \\"feb83abd-9f08-49d2-9b56-41d1b66ca0ac\\",\\n \\"Title\\": \\"标题\\",\\n \\"TemplateId\\": \\"c844a5f0-496c-4c5b-8a0c-dd27686e8ff6\\",\\n \\"TemplateVersion\\": \\"0\\",\\n \\"CategoryId\\": \\"43c2671b-*****-4223-86d0-6bd187905cc8\\",\\n \\"CategoryName\\": \\"类目1\\",\\n \\"StartTime\\": 1631440860000,\\n \\"EndTime\\": 1631440860000,\\n \\"State\\": \\"Processing\\",\\n \\"CloseCode\\": \\"Completed\\",\\n \\"Assignee\\": \\"assignee@ccc-test\\",\\n \\"Comment\\": \\"无\\",\\n \\"AssigneeName\\": \\"Assignee\\",\\n \\"Creator\\": \\"creator@ccc-test\\\\n\\",\\n \\"CreatorName\\": \\"Creator\\",\\n \\"Context\\": \\"{\\\\\\"productName\\\\\\":\\\\\\"alynx\\\\\\"}\\",\\n \\"CreatedTime\\": \\"1631440860000\\",\\n \\"UpdatedTime\\": \\"1631440860000\\",\\n \\"CurrentTaskId\\": \\"0707dab6-34a8-11ef-9823-161e3802b2d4\\",\\n \\"CurrentTaskName\\": \\"节点1\\",\\n \\"CurrentTaskStartTime\\": 1631440860000,\\n \\"CustomerId\\": \\"51e155ce-*****1-b402-13c69597b920\\",\\n \\"JobId\\": \\"job-47150***150396416\\",\\n \\"Source\\": \\"CHAT\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', 'title' => 'Obtain ticket list', 'summary' => 'Retrieves a list of tickets for an instance.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'ListUnassignedNumbers' => [ 'summary' => 'You can invoke ListUnassignedNumbers to obtain the list of numbers under your Alibaba Cloud account that have not been assigned to an instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc1MRAID'], ], 'parameters' => [ [ 'name' => 'SearchPattern', 'in' => 'query', 'schema' => ['description' => 'Performs Fuzzy Matching based on the number. This parameter is optional and defaults to empty. An empty value indicates no filtering.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '0833', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'Page number for paging, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'Page size, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F ', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'Page number, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'Page size, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'TotalCount' => ['description' => 'Total count.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], 'List' => [ 'description' => 'List of numbers.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Number' => ['description' => 'Number.', 'type' => 'string', 'example' => '08330011****', 'title' => ''], 'City' => ['description' => 'City where the number is registered.', 'type' => 'string', 'example' => '乐山', 'title' => ''], 'Province' => ['description' => 'Province where the number is registered.', 'type' => 'string', 'example' => '四川', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => ''], ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.ResourcePlatform', 'errorMessage' => 'An internal ResourcePlatform service error occurred. %s', 'description' => ''], ], ], 'title' => 'Obtain the list of unassigned numbers', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2024-02-02T03:52:26.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUnassignedNumbers'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\\\t\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 3,\\n \\"List\\": [\\n {\\n \\"Number\\": \\"08330011****\\",\\n \\"City\\": \\"乐山\\",\\n \\"Province\\": \\"四川\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'ListUserLevelsOfSkillGroup' => [ 'summary' => 'You can invoke the ListUserLevelsOfSkillGroup API to retrieve the list of agent skill levels under a specified skill group in a given instance. You can also use this API to retrieve the list of agents who can be associated with but are not currently associated with the specified skill group.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccPBOQGO'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'SkillGroupId', 'in' => 'query', 'schema' => ['description' => 'Skill group ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'skillgroup@ccc-test', 'title' => ''], ], [ 'name' => 'IsMember', 'in' => 'query', 'schema' => ['description' => 'Indicates whether to associate with the specified skill group. If the value is true, the operation retrieves the skill level list of agents associated with the skill group ID. If the value is false, the operation retrieves the list of agents that can be associated with but are not currently associated with the skill group ID. The default value is true.', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'Page number, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'Page size, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''], ], [ 'name' => 'SearchPattern', 'in' => 'query', 'schema' => ['description' => 'Perform fuzzy matching based on agent logon name or agent display name. This parameter is optional and defaults to empty, which means no filtering is applied.', 'type' => 'string', 'required' => false, 'example' => '测试坐席', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'Page number, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'Page size, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'TotalCount' => ['description' => 'Total count.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'List' => [ 'description' => 'List of skill levels.', 'type' => 'array', 'items' => [ 'description' => 'Skill level information.', 'type' => 'object', 'properties' => [ 'DisplayName' => ['description' => 'Agent display name.', 'type' => 'string', 'example' => '坐席小王', 'title' => ''], 'SkillLevel' => ['description' => 'Agent skill Level.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], 'LoginName' => ['description' => 'Agent logon name.', 'type' => 'string', 'example' => 'agent', 'title' => ''], 'UserId' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'SkillGroupId' => ['description' => 'Skill group ID.', 'type' => 'string', 'example' => 'skillgroup@ccc-test', 'title' => ''], 'SkillGroupName' => ['description' => 'Skill group Name.', 'type' => 'string', 'example' => 'skillgroup', 'title' => ''], 'RoleName' => [ 'description' => 'Role name.', 'enumValueTitles' => ['Agent' => 'Agent', 'Admin' => 'Administrator', 'Manager' => 'Skill group manager'], 'type' => 'string', 'example' => 'Admin', 'title' => '', ], 'RoleId' => ['description' => 'Role ID, in the format: role\\@instance ID.', 'type' => 'string', 'example' => 'Admin@ccc-test', 'title' => ''], 'RamId' => ['description' => 'The user\'s Resource Access Management (RAM) account.', 'type' => 'string', 'example' => '28036411123456****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => ''], ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => ''], ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.SkillGroupId', 'errorMessage' => 'The skill group ID %s does not exist in instance %s.', 'description' => ''], ], ], 'title' => 'Obtain the agent Level List of a skill group ', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUserLevelsOfSkillGroup'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"List\\": [\\n {\\n \\"DisplayName\\": \\"坐席小王\\",\\n \\"SkillLevel\\": 5,\\n \\"LoginName\\": \\"agent\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"SkillGroupName\\": \\"skillgroup\\",\\n \\"RoleName\\": \\"Admin\\",\\n \\"RoleId\\": \\"Admin@ccc-test\\",\\n \\"RamId\\": \\"28036411123456****\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'ListUsers' => [ 'summary' => 'Invoke ListUsers to obtain the agent list under a specified instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'SearchPattern', 'in' => 'query', 'schema' => ['description' => 'Fuzzy matching based on the agent logon name or agent display name. This parameter is optional and defaults to empty, which means no filtering is applied.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'agent', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'Page number, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'Page size, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''], ], [ 'name' => 'SkillGroupId', 'in' => 'query', 'schema' => ['description' => 'The skill group ID.', 'type' => 'string', 'required' => false, 'example' => 'ankedayaopin@zcwlwhkf', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'Page number, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'Page size, ranging from 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'TotalCount' => ['description' => 'Total count.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'List' => [ 'description' => 'Agent list.', 'type' => 'array', 'items' => [ 'description' => 'Agent information.', 'type' => 'object', 'properties' => [ 'DisplayName' => ['description' => 'Agent display name.', 'type' => 'string', 'example' => '坐席小王', 'title' => ''], 'LoginName' => ['description' => 'Agent logon name.', 'type' => 'string', 'example' => 'agent', 'title' => ''], 'Email' => ['description' => 'Mailbox.', 'type' => 'string', 'example' => 'username@example.com', 'title' => ''], 'WorkMode' => [ 'description' => 'Work mode.', 'enumValueTitles' => ['ON_SITE' => 'On-site mode', 'OFF_SITE' => 'Off-site mode', 'OFFICE_PHONE' => 'Office phone mode'], 'type' => 'string', 'example' => 'ON_SITE', 'title' => '', ], 'Mobile' => ['description' => 'The agent\'s personal phone number.', 'type' => 'string', 'example' => '1382114****', 'title' => ''], 'UserId' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'DisplayId' => ['description' => 'The agent\'s employee ID.', 'type' => 'string', 'example' => '1001', 'title' => ''], 'RoleName' => [ 'description' => 'The role name.', 'enumValueTitles' => ['Mannager' => 'Skill group leader', 'Agent' => 'Agent', 'Admin' => 'Administrator'], 'type' => 'string', 'example' => 'Admin', 'title' => '', ], 'RoleId' => ['description' => 'The role ID, in the format: role\\@instance ID.', 'type' => 'string', 'example' => 'Admin@ccc-test', 'title' => ''], 'PrimaryAccount' => ['description' => 'Indicates whether the RAM account mapped to the agent is a RAM primary account.', 'type' => 'boolean', 'default' => '已弃用，请使用Primary代替此参数', 'example' => '已弃用，请使用Primary代替此参数。', 'title' => ''], 'PersonalOutboundNumberList' => [ 'description' => 'List of personal outbound numbers for the agent.', 'type' => 'array', 'items' => [ 'description' => 'Number information.', 'type' => 'object', 'properties' => [ 'Number' => ['description' => 'Number.', 'type' => 'string', 'example' => '0830011****', 'title' => ''], 'Active' => ['description' => 'Whether the number is active.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'City' => ['description' => 'City where the number is registered.', 'type' => 'string', 'example' => '乐山', 'title' => ''], 'Usage' => [ 'description' => 'Usage of the number.', 'enumValueTitles' => ['Outbound' => 'Outbound', 'Inbound' => 'Inbound', 'Bidirection' => 'Inbound and outbound'], 'type' => 'string', 'example' => 'Bidirection', 'title' => '', ], 'Province' => ['description' => 'The province of the phone number\'s registration location.', 'type' => 'string', 'example' => '四川', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'SkillLevelList' => [ 'description' => 'The list of skill group levels associated with the agent.', 'type' => 'array', 'items' => [ 'description' => 'Information about the skill group level.', 'type' => 'object', 'properties' => [ 'SkillLevel' => ['description' => 'The skill level.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], 'SkillGroupId' => ['description' => 'The ID of the skill group.', 'type' => 'string', 'example' => 'skillgroup@ccc-test', 'title' => ''], 'SkillGroupName' => ['description' => 'The name of the skill group.', 'type' => 'string', 'example' => 'skillgroup', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'RamId' => ['description' => 'The UID of the Resource Access Management (RAM) user associated with the agent.', 'type' => 'integer', 'format' => 'int64', 'example' => '21234502254620****', 'title' => ''], 'Extension' => ['description' => 'The landline extension number.', 'type' => 'string', 'example' => '8031****', 'title' => ''], 'DeviceId' => ['description' => 'Device ID, which is the identity of a browser-based Web Real-Time Communication (WebRTC) softphone or a physical phone device. Only one type of device can be registered at a time.', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****', 'title' => ''], 'DeviceExt' => ['description' => 'SIP phone extension number. If the agent has registered a SIP phone, this parameter is the extension number of the SIP phone device.', 'type' => 'string', 'example' => '8033****', 'title' => ''], 'DeviceState' => [ 'description' => 'The status of the SIP phone device. If no SIP phone is registered, the status is UNREGISTERED (Unregistered). If a SIP phone is registered but offline, the status is OFFLINE (Offline). If a SIP phone is registered and online, the status is ONLINE (Online).', 'enumValueTitles' => ['UNREGISTERED' => 'Unregistered', 'OFFLINE' => 'Offline', 'ONLINE' => 'Online'], 'type' => 'string', 'example' => 'OFFLINE', 'title' => '', ], 'Primary' => ['description' => 'Indicates whether the RAM account mapped to the agent is a RAM root account.', 'type' => 'boolean', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'Params' => [ 'description' => 'Response parameters.', 'type' => 'array', 'items' => ['description' => 'Response parameters.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Obtain the agent list ', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-11-22T01:05:26.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2022-01-19T00:08:15.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUsers'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"List\\": [\\n {\\n \\"DisplayName\\": \\"坐席小王\\",\\n \\"LoginName\\": \\"agent\\",\\n \\"Email\\": \\"username@example.com\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"Mobile\\": \\"1382114****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"DisplayId\\": \\"1001\\",\\n \\"RoleName\\": \\"Admin\\",\\n \\"RoleId\\": \\"Admin@ccc-test\\",\\n \\"PrimaryAccount\\": true,\\n \\"PersonalOutboundNumberList\\": [\\n {\\n \\"Number\\": \\"0830011****\\",\\n \\"Active\\": true,\\n \\"City\\": \\"乐山\\",\\n \\"Usage\\": \\"Bidirection\\",\\n \\"Province\\": \\"四川\\"\\n }\\n ],\\n \\"SkillLevelList\\": [\\n {\\n \\"SkillLevel\\": 5,\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"SkillGroupName\\": \\"skillgroup\\"\\n }\\n ],\\n \\"RamId\\": 0,\\n \\"Extension\\": \\"8031****\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"DeviceExt\\": \\"8033****\\",\\n \\"DeviceState\\": \\"OFFLINE\\",\\n \\"Primary\\": false\\n }\\n ]\\n },\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', ], 'ListVisitorChatMessages' => [ 'summary' => 'You can use ListVisitorChatMessages to retrieve visitor chat records.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'SortOrder', 'in' => 'query', 'schema' => ['description' => 'Sorting order. Default is descending.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'ASC: ascending.'."\n" ."\n" .'DESC: descending.', 'type' => 'string', 'required' => false, 'example' => 'DESC', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Cloud Contact Center instance.', 'type' => 'string', 'required' => false, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'VisitorId', 'in' => 'query', 'schema' => ['description' => 'Visitor ID.', 'type' => 'string', 'required' => false, 'example' => 'fcd020fe-****-1a272a174a7d', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'Start time, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1647325450000', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'End time, in UNIX timestamp format. Unit: milliseconds.', 'type' => 'string', 'required' => false, 'example' => '1650316799000', 'title' => ''], ], [ 'name' => 'NextPageToken', 'in' => 'query', 'schema' => ['description' => 'Token for the next page. Do not include this parameter in your first request. The service returns it in the response. Include it in subsequent requests.', 'type' => 'string', 'required' => false, 'example' => '1737193352340::7463707254.EAUNIT', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'Number of records per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], ], [ 'name' => 'AccessToken', 'in' => 'query', 'schema' => ['description' => 'Web business channel token.', 'type' => 'string', 'required' => false, 'example' => '9XYGTGWtq2wXzVikKuip_zeVGl6O4VJ-l-*-*-JPofhap4P7fAevuE=', 'title' => ''], ], [ 'name' => 'AccessChannelId', 'in' => 'query', 'schema' => ['description' => 'Web business channel ID.', 'type' => 'string', 'required' => false, 'example' => 'cf584733-***-***-9699-cb77aa3b7aa6', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Response schema', 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'ID of the request', 'description' => 'Request ID', 'type' => 'string', 'example' => '8707EB29-BAED-4302-B999-40BA61877437'], 'HttpStatusCode' => ['description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message', 'type' => 'string', 'example' => '无', 'title' => ''], 'Code' => ['description' => 'Response code', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Data' => [ 'description' => 'Data', 'type' => 'object', 'properties' => [ 'NextPageToken' => ['description' => 'Token for the next page', 'type' => 'string', 'example' => '1737193352340::7463707254.EAUNIT'."\n", 'title' => ''], 'Messages' => [ 'description' => 'Message list', 'type' => 'array', 'items' => [ 'description' => 'Message', 'type' => 'object', 'properties' => [ 'JobId' => ['description' => 'Call ID', 'type' => 'string', 'example' => 'chat-65382141036853491', 'title' => ''], 'SenderId' => ['description' => 'Sender user ID', 'type' => 'string', 'example' => 'fcd020fe-****-1a272a174a7d'."\n", 'title' => ''], 'SenderType' => ['description' => 'Sender type'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- **ADMIN**: system'."\n" ."\n" .'- **CUSTOMER**: visitor'."\n" ."\n" .'- **AGENT**: agent', 'type' => 'string', 'example' => 'CUSTOMER', 'title' => ''], 'Timestamp' => ['description' => 'UNIX timestamp', 'type' => 'integer', 'format' => 'int64', 'example' => '1696126980371', 'title' => ''], 'Content' => ['description' => 'Message content', 'type' => 'string', 'example' => '{"variables":{},"text":"Hi，我是小云~ 很高兴遇见你！","contentType":"Text"}', 'title' => ''], 'SenderName' => ['description' => 'Sender name', 'type' => 'string', 'example' => '访客1', 'title' => ''], 'SenderAvatarUrl' => ['description' => 'Sender profile picture URL', 'type' => 'string', 'example' => 'http://xxxxx.com/avatar.png', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'Permission.Unauthorized', 'errorMessage' => 'You are not authorized to perform this action. %s privileges are required.', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8707EB29-BAED-4302-B999-40BA61877437\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": {\\n \\"NextPageToken\\": \\"1737193352340::7463707254.EAUNIT\\\\n\\",\\n \\"Messages\\": [\\n {\\n \\"JobId\\": \\"chat-65382141036853491\\",\\n \\"SenderId\\": \\"fcd020fe-****-1a272a174a7d\\\\n\\",\\n \\"SenderType\\": \\"CUSTOMER\\",\\n \\"Timestamp\\": 1696126980371,\\n \\"Content\\": \\"{\\\\\\"variables\\\\\\":{},\\\\\\"text\\\\\\":\\\\\\"Hi，我是小云~ 很高兴遇见你！\\\\\\",\\\\\\"contentType\\\\\\":\\\\\\"Text\\\\\\"}\\",\\n \\"SenderName\\": \\"访客1\\",\\n \\"SenderAvatarUrl\\": \\"http://xxxxx.com/avatar.png\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => 'Retrieve visitor chat records', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'ListVoicemails' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc0NRNJB'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the Cloud Contact Center (CC) instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The start time of the query range. This is a UNIX timestamp in milliseconds. The default value is 00:00 on the current day.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1532448000000', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end time of the query range. This is a UNIX timestamp in milliseconds. The default value is the current time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1532707199000', 'title' => ''], ], [ 'name' => 'ContactId', 'in' => 'query', 'schema' => ['description' => 'The ID of the call. You can use this parameter to query the record of a specific call. You can obtain the contact ID from the softphone SDK during a call. If you specify this parameter, other query parameters are ignored.', 'type' => 'string', 'required' => false, 'example' => 'job-125152394144124921', 'title' => ''], ], [ 'name' => 'Caller', 'in' => 'query', 'schema' => ['description' => 'The calling number.', 'type' => 'string', 'required' => false, 'example' => '073xxxx7539', 'title' => ''], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'The name of the voicemail.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'voicemail-test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], 'Data' => [ 'description' => 'The data.', 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'TotalCount' => ['description' => 'The total number of entries. This parameter is returned only when \\`PageNumber\\` is set to 1. For other values of \\`PageNumber\\`, this parameter returns 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '11', 'title' => ''], 'List' => [ 'description' => 'The list of voicemail records.', 'type' => 'array', 'items' => [ 'description' => 'The voicemail record.', 'type' => 'object', 'properties' => [ 'CdrStartTime' => ['description' => 'The start time of the call.', 'type' => 'integer', 'format' => 'int64', 'example' => '1532448000000，已废弃，请使用StartTime。', 'title' => ''], 'Caller' => ['description' => 'The calling number.', 'type' => 'string', 'example' => '073xxxx7539', 'title' => ''], 'ContactId' => ['description' => 'The call ID.', 'type' => 'string', 'example' => 'job-125152394144124921', 'title' => ''], 'RecordingDuration' => ['description' => 'The duration of the voicemail message in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '10，已废弃，请使用Duration', 'title' => ''], 'InstanceId' => ['description' => 'The ID of the CC instance.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'Name' => ['description' => 'The name of the voicemail.', 'type' => 'string', 'example' => 'voicemail-test', 'title' => ''], 'Callee' => ['description' => 'The called number.', 'type' => 'string', 'example' => '0533128****', 'title' => ''], 'StartTime' => ['description' => 'The start time of the voicemail.', 'type' => 'string', 'example' => '1631440860000', 'title' => ''], 'Duration' => ['description' => 'The duration of the voicemail message in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '16', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Retrieve Voice Mailbox List', 'summary' => 'You can call the ListVoicemails operation to retrieve a list of voicemails for a specified instance.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListVoicemails'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 11,\\n \\"List\\": [\\n {\\n \\"CdrStartTime\\": 0,\\n \\"Caller\\": \\"073xxxx7539\\",\\n \\"ContactId\\": \\"job-125152394144124921\\",\\n \\"RecordingDuration\\": 0,\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"Name\\": \\"voicemail-test\\",\\n \\"Callee\\": \\"0533128****\\",\\n \\"StartTime\\": \\"1631440860000\\",\\n \\"Duration\\": 16\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'ListWaitingChats' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'SkillGroupIdList', 'in' => 'query', 'schema' => ['description' => 'Skill group ID list.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '["skillgroup1@ccc-test", "skillgroup2@ccc-test"]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716', 'title' => ''], 'Data' => [ 'description' => 'Returned data.', 'type' => 'array', 'items' => [ 'description' => 'Session information.', 'type' => 'object', 'properties' => [ 'ChatConversationId' => ['description' => 'Chat session ID.', 'type' => 'string', 'example' => '$23086709$EAUNIT', 'title' => ''], 'BeingAssigned' => ['description' => 'Indicates whether the session has been assigned to an agent.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'JobId' => ['description' => 'Job ID.', 'type' => 'string', 'example' => 'chat-434537064047960064', 'title' => ''], 'EnqueueTime' => ['description' => 'Enqueue time, in Unix timestamp format, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1718868572094', 'title' => ''], 'AccessChannelId' => ['description' => 'Access channel ID.', 'type' => 'string', 'example' => '843073c2-*****-49fb-a616-738ddddfebdc', 'title' => ''], 'AccessChannelType' => ['description' => 'Access channel type.', 'type' => 'string', 'example' => 'Web', 'title' => ''], 'UserList' => [ 'description' => 'User list.', 'type' => 'array', 'items' => [ 'description' => 'User.', 'type' => 'object', 'properties' => [ 'UserName' => ['description' => 'User name.', 'type' => 'string', 'example' => '访客-1c***', 'title' => ''], 'UserId' => ['description' => 'User ID.', 'type' => 'string', 'example' => 'c361765f-******-4e07-b81c-4b5d9183fac6'."\n", 'title' => ''], 'UserType' => ['description' => 'User type.', 'type' => 'string', 'example' => 'CUSTOMER', 'title' => ''], 'AvatarUrl' => ['description' => 'Profile picture URL.', 'type' => 'string', 'example' => '无', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Messages' => [ 'description' => 'Message list.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'SenderId' => ['description' => 'Message sender ID.', 'type' => 'string', 'example' => 'c361765f-******-4e07-b81c-4b5d9183fac6', 'title' => ''], 'Content' => ['description' => 'Message content.', 'type' => 'string', 'example' => '测试消息', 'title' => ''], 'SenderType' => ['description' => 'Sender type. Valid values:'."\n" ."\n" .'- **CUSTOMER**: visitor'."\n" ."\n" .'- **AGENT**: agent', 'type' => 'string', 'example' => '{"variables":{},"text":"

这种的名片选单面还是双面

"}', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'SkillGroupId' => ['description' => 'The skill group information.', 'type' => 'string', 'example' => 'skill@ccc-test', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => ''], ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"03C67DAD-EB26-41D8-949D-9B0C470FB716\\",\\n \\"Data\\": [\\n {\\n \\"ChatConversationId\\": \\"$23086709$EAUNIT\\",\\n \\"BeingAssigned\\": false,\\n \\"JobId\\": \\"chat-434537064047960064\\",\\n \\"EnqueueTime\\": 1718868572094,\\n \\"AccessChannelId\\": \\"843073c2-*****-49fb-a616-738ddddfebdc\\",\\n \\"AccessChannelType\\": \\"Web\\",\\n \\"UserList\\": [\\n {\\n \\"UserName\\": \\"访客-1c***\\",\\n \\"UserId\\": \\"c361765f-******-4e07-b81c-4b5d9183fac6\\\\n\\",\\n \\"UserType\\": \\"CUSTOMER\\",\\n \\"AvatarUrl\\": \\"无\\"\\n }\\n ],\\n \\"Messages\\": [\\n {\\n \\"SenderId\\": \\"c361765f-******-4e07-b81c-4b5d9183fac6\\",\\n \\"Content\\": \\"测试消息\\",\\n \\"SenderType\\": \\"{\\\\\\"variables\\\\\\":{},\\\\\\"text\\\\\\":\\\\\\"

这种的名片选单面还是双面

\\\\\\"}\\"\\n }\\n ],\\n \\"SkillGroupId\\": \\"skill@ccc-test\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'Retrieve chats in a queue', 'summary' => 'The ListWaitingChats operation allows agents to retrieve chats that are waiting in a queue to be assigned or claimed.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'MakeCall' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '50581', 'abilityTreeNodes' => ['FEATUREcccIPHVDY'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID. '."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'Agent ID initiating the outbound call. This field is optional. If not specified, the system uses the agent mapped to the current RAM user by default. ', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test', 'title' => ''], ], [ 'name' => 'DeviceId', 'in' => 'query', 'schema' => ['description' => 'Device ID. This field is meaningless and can be filled with any value. ', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device', 'title' => ''], ], [ 'name' => 'Caller', 'in' => 'query', 'schema' => ['description' => 'Caller number. This parameter is invalid for internal calls. For outbound calls, specify an outbound number available to the current agent. Ensure that the number supports outbound calling and that the agent has permission to use it. Permission can be granted in two ways: either by attaching the number to the skill group the agent signed into, or by setting the number as the agent\'s personal outbound number. ', 'type' => 'string', 'required' => false, 'example' => '010989****', 'title' => ''], ], [ 'name' => 'Callee', 'in' => 'query', 'schema' => ['description' => 'Callee number. For internal calls, specify the target agent\'s extension number in this field. For outbound calls, specify the customer\'s phone number. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1318888****', 'title' => ''], ], [ 'name' => 'TimeoutSeconds', 'in' => 'query', 'schema' => ['description' => 'Timeout. If the call is not answered within the time specified by this parameter, the system automatically hangs up. Valid values range from 30 to 300 seconds. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '300', 'minimum' => '30', 'example' => '30', 'title' => ''], ], [ 'name' => 'Tags', 'in' => 'query', 'schema' => ['description' => 'Ingest endpoint data. The customer does not need to concern themselves with this.', 'type' => 'string', 'required' => false, 'example' => 'tags', 'title' => ''], ], [ 'name' => 'MaskedCallee', 'in' => 'query', 'schema' => ['description' => 'The desensitized callee number. If this field is not empty, it indicates that the callee number must be desensitized. The desensitization rule is defined by the customer. You only need to enter the desensitized callee number here. Using a desensitized callee number means that in certain scenarios, you will see the desensitized callee number and cannot view the real callee number.', 'type' => 'string', 'required' => false, 'example' => '131****8888', 'title' => ''], ], [ 'name' => 'MediaType', 'in' => 'query', 'schema' => ['description' => 'Media type. The default value is AUDIO. Other valid values include VIDEO. ', 'type' => 'string', 'required' => false, 'example' => 'AUDIO', 'title' => ''], ], [ 'name' => 'FlashSmsVariables', 'in' => 'query', 'schema' => ['description' => 'Flash SMS configuration ', 'type' => 'string', 'required' => false, 'example' => '{\\"applicationId\\":\\"6bd18325-ea7f-4881-8902-4d06283d3b3b\\",\\"templateId\\":\\"1722217249064\\"}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code. '."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.'."\n", 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.'."\n", 'type' => 'string', 'example' => '26A34338-5CD9-4C95-A7A6-5BDCE76C6B94', 'title' => ''], 'Params' => [ 'description' => 'List of response parameters.', 'type' => 'array', 'items' => ['description' => 'Response parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], 'Data' => [ 'description' => 'Data.'."\n", 'type' => 'object', 'properties' => [ 'ContextId' => ['description' => 'System auto-increment ID. Customers do not need to concern themselves with this.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', 'title' => ''], 'CallContext' => [ 'description' => 'Call context environment.', 'type' => 'object', 'properties' => [ 'CallType' => [ 'enumValueTitles' => [ 'INBOUND' => 'Inbound', 'BARGE' => 'Barge-in', 'CONSULTANT' => 'Consultation', 'CONFERENCE' => 'Conference', 'MONITOR' => 'listener ', 'INTERNAL' => 'Internal call ', 'OUTBOUND' => 'Outbound call ', 'INTERCEPT' => 'Forced disconnect ', 'BACK2BACK' => 'Dual-call ', 'PREDICTIVE' => 'Predictive outbound call ', 'COACH' => 'Coaching ', ], 'description' => 'Call type. ', 'type' => 'string', 'example' => 'OUTBOUND', 'title' => '', ], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'JobId' => ['description' => 'Call ID. ', 'type' => 'string', 'example' => 'job-6570007401392****', 'title' => ''], 'CallVariables' => ['description' => 'Ingest endpoint data. Custom data passed through SIP signaling.', 'type' => 'string', 'example' => 'a=b;c=d', 'title' => ''], 'ChannelContexts' => [ 'description' => 'List of call channels. ', 'type' => 'array', 'items' => [ 'description' => 'Call channel. ', 'type' => 'object', 'properties' => [ 'ReleaseInitiator' => ['description' => 'The party that initiated the release of the call channel, indicating who hung up first.', 'type' => 'string', 'example' => '无', 'title' => ''], 'ChannelState' => [ 'enumValueTitles' => ['CREATED' => 'Created', 'ANSWERED' => 'Answered', 'RELEASED' => 'Released', 'RETIRED' => 'Out Of Effect', 'EARLY_MEDIA' => 'Early Media', 'NONE' => 'Initial Status', 'RINGING' => 'Ringing'], 'description' => 'The status of the call channel.', 'type' => 'string', 'example' => 'NONE', 'title' => '', ], 'Destination' => ['description' => 'Callee of the call channel. ', 'type' => 'string', 'example' => '8001****', 'title' => ''], 'UserId' => ['description' => 'The agent ID associated with the channel. This field is empty for customer channels. ', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'ChannelFlags' => [ 'enumValueTitles' => ['COACHING' => 'Coaching ', 'MONITORING' => 'Monitoring ', 'MONITORED' => 'Monitored ', 'COACHED' => 'Coached ', 'HOLD' => 'Hold ', 'MUTED' => 'Muted '], 'description' => 'Channel flags. ', 'type' => 'string', 'example' => 'MONITORING', 'title' => '', ], 'Timestamp' => ['description' => 'The UNIX timestamp indicating the most recent status change of the channel, in milliseconds. ', 'type' => 'integer', 'format' => 'int64', 'example' => '1609225718295', 'title' => ''], 'ReleaseReason' => ['description' => 'The reason for releasing the channel. This value indicates why the current channel was disconnected and corresponds to a response code defined in the SIP protocol. Customers should refer to the SIP protocol to analyze the disconnection reason.', 'type' => 'string', 'example' => '无', 'title' => ''], 'CallType' => [ 'enumValueTitles' => [ 'INBOUND' => 'Inbound', 'BARGE' => 'Barge', 'CONSULTANT' => 'Consultation', 'CONFERENCE' => 'Conference', 'MONITOR' => 'listener ', 'INTERNAL' => 'internal call ', 'OUTBOUND' => 'outbound ', 'INTERCEPT' => 'forced disconnect ', 'BACK2BACK' => 'back-to-back call ', 'PREDICTIVE' => 'predictive outbound ', 'COACH' => 'coaching ', ], 'description' => 'The call type of the channel. ', 'type' => 'string', 'example' => 'OUTBOUND', 'title' => '', ], 'JobId' => ['description' => 'Call ID. ', 'type' => 'string', 'example' => 'job-6570007401392****', 'title' => ''], 'ChannelId' => ['description' => 'The channel ID. ', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****', 'title' => ''], 'Originator' => ['description' => 'The originator of the channel. ', 'type' => 'string', 'example' => '1318888****', 'title' => ''], 'UserExtension' => ['description' => 'The extension number of the agent associated with the channel.', 'type' => 'string', 'example' => '8001****', 'title' => ''], 'MediaType' => ['description' => 'Media type. The default value is AUDIO. Other valid values include VIDEO. ', 'type' => 'string', 'example' => 'Audio', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'UserContext' => [ 'description' => 'Agent context environment.', 'type' => 'object', 'properties' => [ 'Extension' => ['description' => 'Agent extension number.', 'type' => 'string', 'example' => '8001****', 'title' => ''], 'WorkMode' => [ 'enumValueTitles' => ['ON_SITE' => 'On-site mode', 'OFF_SITE' => 'Off-site mode', 'OFFICE_PHONE' => 'Office phone mode'], 'description' => 'Work mode.', 'type' => 'string', 'example' => 'ON_SITE', 'title' => '', ], 'DeviceId' => ['description' => 'Device ID, which is the identity ID of a browser-based Web Real-Time Communication (WebRTC) softphone or a physical phone device. Only one type of device can be registered at a time.', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****', 'title' => ''], 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-6570007401392****', 'title' => ''], 'UserId' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'BreakCode' => [ 'enumValueTitles' => ['RingingTimeout' => 'Break caused by agent ringing timeout', 'RejectCall' => 'Break caused by agent call rejection', 'Warm-up' => 'Temporary break state after agent is published and before becoming idle'], 'description' => 'Break status code, which can be either System-defined or Custom-defined. System-defined break codes include: Warm-up (temporary break state after agent is published and before becoming idle), RingingTimeout (break caused by agent ringing timeout), and RejectCall (break caused by agent call rejection). There are no restrictions on Custom-defined status codes, and Customers can define them according to their business needs.', 'type' => 'string', 'example' => 'Warm-up', 'title' => '', ], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'OutboundScenario' => ['description' => 'Indicates whether the agent is in outbound-only mode.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'UserState' => [ 'enumValueTitles' => ['READY' => 'Ready', 'WORKING' => 'Post-processing', 'DIALING' => 'Dialing', 'BREAK' => 'Break', 'OFFLINE' => 'Offline', 'TALKING' => 'Talking', 'RINGING' => 'Ringing'], 'description' => 'Agent status.', 'type' => 'string', 'example' => 'READY', 'title' => '', ], 'SignedSkillGroupIdList' => [ 'description' => 'List of skill group IDs that the agent has signed into.', 'type' => 'array', 'items' => ['description' => 'Skill group ID.', 'type' => 'string', 'example' => 'skillgroup1@ccc-test', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'UserBusy', 'errorMessage' => 'The user %s you called was busy. Please try again later.', 'description' => ''], ['errorCode' => 'InvalidOperation.ChannelState', 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', 'description' => ''], ['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => ''], ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.Extension', 'errorMessage' => 'No available extension number exists.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"26A34338-5CD9-4C95-A7A6-5BDCE76C6B94\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"ContextId\\": 123456,\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6570007401392****\\",\\n \\"CallVariables\\": \\"a=b;c=d\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"ReleaseInitiator\\": \\"无\\",\\n \\"ChannelState\\": \\"NONE\\",\\n \\"Destination\\": \\"8001****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"Timestamp\\": 1609225718295,\\n \\"ReleaseReason\\": \\"无\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6570007401392****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"Originator\\": \\"1318888****\\",\\n \\"UserExtension\\": \\"8001****\\",\\n \\"MediaType\\": \\"Audio\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8001****\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"JobId\\": \\"job-6570007401392****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"UserState\\": \\"READY\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","type":"json"}]', 'title' => 'Initiate a call ', 'summary' => 'You can invoke MakeCall to initiate a call. The callee can be an internal agent or an external customer.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2025-04-08T07:49:03.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-08-30T02:20:48.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-01-11T08:11:36.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2023-10-26T08:13:46.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2021-11-29T08:23:20.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2021-08-18T13:14:10.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MakeCall'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'ModifyAudioFile' => [ 'summary' => 'You can invoke ModifyAudioFile to modify the audio file associated with a specified audio resource ID under a given instance. You can update the audio file name, display name, and the OSS key of the audio file.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccKYIENB'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'AudioResourceId', 'in' => 'query', 'schema' => ['description' => 'Audio resource ID, which uniquely identifies an audio file.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'acc300c4-75c9-41ba-ba5e-2a365c96c248', 'title' => ''], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'Display name of the audio file. It must be 1 to 32 characters in length. The display name cannot be changed when modifying the audio file, so you must provide the original display name here.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '欢迎语', 'title' => ''], ], [ 'name' => 'OssFileKey', 'in' => 'query', 'schema' => ['description' => 'The OSS key of the audio file to be modified.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test/new-test-file.wav', 'title' => ''], ], [ 'name' => 'AudioFileName', 'in' => 'query', 'schema' => ['description' => 'Name of the audio file to be modified. You can specify new content for the audio file here.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'new-test-file.wav', 'title' => ''], ], [ 'name' => 'Usage', 'in' => 'query', 'schema' => ['description' => 'Usage of the audio file. The default value is General (used in scenarios such as IVR). Other valid values include HoldMusic (hold music during call waiting).', 'type' => 'string', 'required' => false, 'example' => 'General', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Data' => ['description' => 'Data.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'D2F84AAC-7C79-547F-8EE9-7B735F42B93F', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Modify an audio file'."\n", 'changeSet' => [ ['createdAt' => '2023-11-17T01:12:04.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyAudioFile'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"D2F84AAC-7C79-547F-8EE9-7B735F42B93F\\"\\n}","type":"json"}]', ], 'ModifyCampaignNumbers' => [ 'summary' => 'Modifies the calling numbers for a batch prediction outbound campaign.', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccQFUGXR'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'CampaignId', 'in' => 'query', 'schema' => ['title' => 'Activity ID', 'description' => 'The campaign ID.', 'type' => 'string', 'required' => true, 'example' => '6badb397-****-****-21019d382a09'], ], [ 'name' => 'InstGroupId', 'in' => 'query', 'schema' => ['title' => 'Number set ID', 'description' => 'The ID of the number collection.', 'type' => 'string', 'required' => false, 'example' => '3971876649-****-****-098763a382a09'."\n"], ], [ 'name' => 'NumberList', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The list of numbers.', 'title' => 'Number list', 'type' => 'array', 'items' => ['description' => 'A number.', 'type' => 'string', 'required' => false, 'example' => '["0830011xxxx", "0830312xxxx"]', 'title' => ''], 'required' => false, 'example' => '', ], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the Cloud Call Center (CCC) instance.', 'type' => 'string', 'required' => true, 'example' => 'ccc-test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'ModifyCampaignNumbersResponse', 'title' => 'ModifyCampaignNumbersResponse', 'type' => 'object', 'properties' => [ 'Data' => ['description' => 'The data.', 'type' => 'any', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Params' => [ 'description' => 'The list of error parameters.', 'type' => 'array', 'items' => ['description' => 'An error parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"DE803553-8AA9-4B9D-9E4E-A82BC69EDCEE\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', 'title' => 'Modify the caller number of a predictive outbound call campaign', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'ModifyCustomCallTagging' => [ 'summary' => 'You can invoke ModifyCustomCallTagging to modify the description and attached number tags of an inbound number mark for a specified number under a specified instance.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc1MRAID'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'Number', 'in' => 'query', 'schema' => ['description' => 'The number associated with the inbound number mark. The system matches the inbound number mark to be modified based on this number.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1312121****', 'title' => ''], ], [ 'name' => 'CallTagNameList', 'in' => 'query', 'schema' => ['description' => 'A list of number tag names. You must provide the complete list of number tags to be modified, and ensure that these number tags have already been created.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => '["TagA","TagB"]', 'title' => ''], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['description' => 'The new description for the inbound number mark. This parameter is optional. The default value is empty, which indicates that the description will not be modified.', 'type' => 'string', 'required' => false, 'example' => '王先生', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F'], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => ''], ['errorCode' => 'LimitExceed.CallTagsPerNumber', 'errorMessage' => 'The total number of call tag of numbers exceeds the limit %s.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.CustomCallTagging', 'errorMessage' => 'Custom call tagging %s does not exist in instance %s.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.DB', 'errorMessage' => 'An internal DB service error occurred. %s', 'description' => ''], ], ], 'title' => 'Modify Inbound Number Mark', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2022-02-24T14:31:19.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyCustomCallTagging'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\"\\n}","type":"json"}]', ], 'ModifyInstance' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccTMAX45'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['description' => 'Description of the instance. The description can be up to 256 characters in length.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '新的实例描述。', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '83TKE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], 'Data' => ['description' => 'Data.', 'type' => 'string', 'example' => '无', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Modify Instance', 'summary' => 'You can invoke ModifyInstance to modify a Cloud Contact Center instance.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyInstance'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"83TKE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": \\"无\\"\\n}","type":"json"}]', ], 'ModifyPhoneNumber' => [ 'summary' => 'You can invoke ModifyPhoneNumber to modify the information of a specified phone number under a specified instance, primarily to update the number\'s usage and the attached contact flow ID.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc1MRAID'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'Number', 'in' => 'query', 'schema' => ['description' => 'Phone number.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0102134****', 'title' => ''], ], [ 'name' => 'Usage', 'in' => 'query', 'schema' => [ 'description' => 'Number usage.', 'enumValueTitles' => ['Outbound' => 'Outbound', 'Inbound' => 'Inbound', 'Bidirection' => 'Inbound and Outbound'], 'type' => 'string', 'required' => true, 'docRequired' => true, 'maxLength' => 200, 'minLength' => 1, 'example' => 'Bidirection', 'title' => '', ], ], [ 'name' => 'ContactFlowId', 'in' => 'query', 'schema' => ['description' => 'The IVR contact flow ID attached to the number. This field is valid only when the number usage is Inbound or Bidirection.', 'type' => 'string', 'required' => false, 'example' => '78128960-bb00-4ddc-8a82-923a8c5bd22d', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.Number', 'errorMessage' => 'The specified number %s does not exist in instance %s.', 'description' => ''], ], ], 'title' => 'Modify Phone Number', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyPhoneNumber'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\"\\n}","type":"json"}]', ], 'ModifySkillGroup' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccPBOQGO'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'SkillGroupId', 'in' => 'query', 'schema' => ['description' => 'Skill group ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'skillgroup@ccc-test', 'title' => ''], ], [ 'name' => 'DisplayName', 'in' => 'query', 'schema' => ['description' => 'Display name of the skill group, which must be 1 to 64 characters in length.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'maxLength' => 200, 'minLength' => 1, 'example' => '新测试技能组', 'title' => ''], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['description' => 'Description of the skill group. This parameter is optional and defaults to empty.', 'type' => 'string', 'required' => false, 'example' => '云联络中心的新测试技能组。', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.SkillGroupId', 'errorMessage' => 'The skill group ID %s does not exist in instance %s.', 'description' => ''], ], ], 'title' => 'Modify Skill Group', 'summary' => 'You can invoke ModifySkillGroup to modify the information of a skill group associated with a specified skill group ID under a specified instance, primarily updating the skill group\'s display name and description.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifySkillGroup'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\"\\n}","type":"json"}]', ], 'ModifySkillLevelsOfUser' => [ 'summary' => 'Modify the skill level of a specified agent in one or more skill groups under a specified instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'Agent ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'agent@ccc-test', 'title' => ''], ], [ 'name' => 'SkillLevelList', 'in' => 'query', 'schema' => ['description' => 'A JSON-formatted string representing an array of objects specifying skill levels for skill groups. Each array element is an object containing two fields: skillGroupId and skillLevel. Set skillGroupId to the ID of the skill group you want to modify, and set skillLevel to the desired skill level, which must be an integer from 1 to 10. A lower value indicates stronger business capability and the ability to handle more calls per unit time.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[{"skillGroupId":"skillgroup1@ccc-test","skillLevel":1},{"skillGroupId":"skillgroup2@ccc-test","skillLevel":10}]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'E49D8B83-A3EC-44D4-A920-578BC3C698AD', 'title' => ''], 'Data' => ['description' => 'Data.', 'type' => 'string', 'example' => '无', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => ''], ], 403 => [ ['errorCode' => 'Permission.User', 'errorMessage' => 'You have no permission to access user(s) %s.', 'description' => ''], ['errorCode' => 'Permission.SkillGroup', 'errorMessage' => 'You have no permission to access skill group(s) %s.', 'description' => ''], ], [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Modify multiple skill levels of an agent', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-11-17T01:12:02.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifySkillLevelsOfUser'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"E49D8B83-A3EC-44D4-A920-578BC3C698AD\\",\\n \\"Data\\": \\"无\\"\\n}","type":"json"}]', ], 'ModifyUser' => [ 'summary' => 'You can invoke ModifyUser to modify the information of a specified agent under a specified instance. You can modify the phone number, work mode, role, and agent ID.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'Agent ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'user-test@ccc-test', 'title' => ''], ], [ 'name' => 'Mobile', 'in' => 'query', 'schema' => ['description' => 'Agent\'s personal phone number.', 'type' => 'string', 'required' => false, 'example' => '1382114****', 'title' => ''], ], [ 'name' => 'WorkMode', 'in' => 'query', 'schema' => [ 'description' => 'Work mode.', 'enumValueTitles' => ['ON_SITE' => 'On-site mode', 'OFF_SITE' => 'Off-site mode', 'OFFICE_PHONE' => 'Office phone mode'], 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ON_SITE', 'title' => '', ], ], [ 'name' => 'RoleId', 'in' => 'query', 'schema' => ['description' => 'Role ID, in the format: role\\@instance ID.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Admin@ccc-test', 'title' => ''], ], [ 'name' => 'DisplayId', 'in' => 'query', 'schema' => ['description' => 'Agent ID (employee ID).', 'type' => 'string', 'required' => false, 'example' => '1001', 'title' => ''], ], [ 'name' => 'DisplayName', 'in' => 'query', 'schema' => ['description' => 'User\'s full name.', 'type' => 'string', 'required' => false, 'example' => '张三疯', 'title' => ''], ], [ 'name' => 'Force', 'in' => 'query', 'schema' => ['description' => 'Whether to force the modification.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'Nickname', 'in' => 'query', 'schema' => ['description' => 'Agent nickname', 'type' => 'string', 'required' => false, 'example' => '老王', 'title' => ''], ], [ 'name' => 'AvatarUrl', 'in' => 'query', 'schema' => ['description' => 'Agent profile picture URL.', 'type' => 'string', 'required' => false, 'example' => 'http://abc.com/sam.jpb', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], 'Data' => ['description' => 'Data.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Params' => [ 'description' => 'Response parameters.', 'type' => 'array', 'items' => ['description' => 'Response parameters.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => ''], ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ], 403 => [ ['errorCode' => 'Permission.Common', 'errorMessage' => 'You have no permission to access. %s', 'description' => ''], ['errorCode' => 'Permission.SkillGroup', 'errorMessage' => 'You have no permission to access skill group(s) %s.', 'description' => ''], ], [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.RoleId', 'errorMessage' => 'Role %s does not exist.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => ''], ['errorCode' => 'InternalService.DB', 'errorMessage' => 'An internal DB service error occurred. %s', 'description' => ''], ], ], 'title' => 'Modify Agent', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-11-17T01:12:03.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2023-04-14T05:54:04.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2021-12-21T08:08:33.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyUser'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', ], 'ModifyUserLevelsOfSkillGroup' => [ 'summary' => 'You can invoke ModifyUserLevelsOfSkillGroup to modify the skill levels of one or more agents under a specified skill group in a specified instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'SkillGroupId', 'in' => 'query', 'schema' => ['description' => 'Skill group ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'skillgroup@ccc-test', 'title' => ''], ], [ 'name' => 'UserLevelList', 'in' => 'query', 'schema' => ['description' => 'A JSON-formatted string representing an array of agent skill levels. Each array element is an object containing two fields: userId and skillLevel. Specify the agent ID in userId and the desired skill level in skillLevel. The skill level must be an integer from 1 to 10, where a lower value indicates stronger business capability and the ability to handle more calls per unit time.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[{"userId":"agent1@ccc-test","skillLevel":1},{"userId":"agent2@ccc-test","skillLevel":10}]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Data' => ['description' => 'Data.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'E49D8B83-A3EC-44D4-A920-578BC3C698AD', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.SkillGroupId', 'errorMessage' => 'The skill group ID %s does not exist in instance %s.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.DB', 'errorMessage' => 'An internal DB service error occurred. %s', 'description' => ''], ], ], 'title' => 'Modify the skill levels of multiple agents in a skill group', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyUserLevelsOfSkillGroup'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"E49D8B83-A3EC-44D4-A920-578BC3C698AD\\"\\n}","type":"json"}]', ], 'MonitorCall' => [ 'summary' => 'You can invoke MonitorCall to listen to a call associated with a specified call ID under a specified instance. The call must be in a state where both the agent and the customer are normally connected, and the agent initiating the listening must have permission to monitor the target agent.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'Agent ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test', 'title' => ''], ], [ 'name' => 'DeviceId', 'in' => 'query', 'schema' => ['description' => 'Device ID. This parameter is meaningless and can be filled with any value.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device', 'title' => ''], ], [ 'name' => 'MonitoredUserId', 'in' => 'query', 'schema' => ['description' => 'The ID of the agent being monitored.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'agent2@ccc-test', 'title' => ''], ], [ 'name' => 'TimeoutSeconds', 'in' => 'query', 'schema' => ['description' => 'The timeout period for the listening operation, in seconds. If the listening operation does not succeed within the specified time, it is canceled. Normally, the listening operation succeeds immediately. The timeout setting is provided to handle abnormal scenarios. This field is optional and defaults to 30 seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], 'Params' => [ 'description' => 'List of response parameters.', 'type' => 'array', 'items' => ['description' => 'Response parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'CallContext' => [ 'description' => 'Call context environment.', 'type' => 'object', 'properties' => [ 'CallType' => [ 'description' => 'Call type.', 'enumValueTitles' => [ 'INBOUND' => 'Inbound', 'BARGE' => 'Barge-in', 'CONSULTANT' => 'Consultation', 'CONFERENCE' => 'Conference', 'MONITOR' => 'Monitor', 'INTERNAL' => 'Internal Call', 'OUTBOUND' => 'Outbound', 'INTERCEPT' => 'Intercept', 'BACK2BACK' => 'Back-to-Back', 'PREDICTIVE' => 'Predictive Outbound', 'COACH' => 'Coaching', ], 'type' => 'string', 'example' => 'OUTBOUND', 'title' => '', ], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'ChannelContexts' => [ 'description' => 'List of call channels.', 'type' => 'array', 'items' => [ 'description' => 'Call channel.', 'type' => 'object', 'properties' => [ 'Index' => ['description' => 'An auto increment ID generated by the system. Customers do not need to concern themselves with it.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'ReleaseInitiator' => ['description' => 'The party that initiated the release of the voice channel, indicating who hung up first.', 'type' => 'string', 'example' => '1390501****', 'title' => ''], 'ChannelState' => [ 'description' => 'The status of the voice channel.', 'enumValueTitles' => ['CREATED' => 'Created', 'ANSWERED' => 'Answered', 'RELEASED' => 'Released', 'RETIRED' => 'Out Of Effect', 'EARLY_MEDIA' => 'Early Media', 'NONE' => 'Initial Status', 'RINGING' => 'Ringing'], 'type' => 'string', 'example' => 'CREATED', 'title' => '', ], 'Destination' => ['description' => 'The callee of the voice channel.', 'type' => 'string', 'example' => '1390501****', 'title' => ''], 'UserId' => ['description' => 'The agent ID associated with the channel. This field is empty if the channel belongs to a customer.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'ChannelFlags' => [ 'description' => 'Channel flags.', 'enumValueTitles' => ['COACHING' => 'Coaching', 'MONITORING' => 'Monitoring', 'MONITORED' => 'Monitored', 'COACHED' => 'Coached', 'HOLD' => 'Hold', 'MUTED' => 'Muted'], 'type' => 'string', 'example' => 'MONITORING', 'title' => '', ], 'SkillGroupId' => ['description' => 'The skill group ID associated with the voice channel. In inbound scenarios, the associated skill group ID is determined by the skill group configured in the IVR transfer-to-agent module. In outbound scenarios, the associated skill group ID is the first skill group that the agent signed into.', 'type' => 'string', 'example' => 'skillgroup@ccc-test', 'title' => ''], 'Timestamp' => ['description' => 'The UNIX timestamp of the most recent status change of the voice channel, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315', 'title' => ''], 'ReleaseReason' => ['description' => 'The hang-up reason for the voice channel, indicating why the current voice channel was disconnected. The value corresponds to response codes defined in the SIP protocol. Customers should refer to the SIP protocol to analyze the hang-up reason.', 'type' => 'string', 'example' => '404 - No destination', 'title' => ''], 'CallType' => [ 'description' => 'The call type of the channel.', 'enumValueTitles' => [ 'INBOUND' => 'Inbound', 'BARGE' => 'Barge-in', 'CONSULTANT' => 'Consultation', 'CONFERENCE' => 'Conference', 'MONITOR' => 'Listener', 'INTERNAL' => 'Internal Call', 'OUTBOUND' => 'Outbound', 'INTERCEPT' => 'Intercept', 'BACK2BACK' => 'Back-to-Back', 'PREDICTIVE' => 'Predictive Outbound', 'COACH' => 'Coaching', ], 'type' => 'string', 'example' => 'OUTBOUND', 'title' => '', ], 'JobId' => ['description' => 'The call ID.', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'ChannelId' => ['description' => 'The voice channel ID.', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****', 'title' => ''], 'UserExtension' => ['description' => 'The extension number of the agent associated with the channel.', 'type' => 'string', 'example' => '8032****', 'title' => ''], 'Originator' => ['description' => 'The originator of the channel.', 'type' => 'string', 'example' => '0830019****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'UserContext' => [ 'description' => 'Agent context environment.', 'type' => 'object', 'properties' => [ 'Extension' => ['description' => 'Agent extension number.', 'type' => 'string', 'example' => '8032****', 'title' => ''], 'Heartbeat' => ['description' => 'The time when the last heartbeat was received from the agent, formatted as a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378', 'title' => ''], 'WorkMode' => [ 'description' => 'Work mode.', 'enumValueTitles' => ['ON_SITE' => 'On-site mode', 'OFF_SITE' => 'Off-site mode', 'OFFICE_PHONE' => '- OFFICE\\_PHONE (Office phone mode)'], 'type' => 'string', 'example' => 'ON_SITE', 'title' => '', ], 'DeviceId' => ['description' => 'Device ID, which is the identity ID of a browser-based Web Real-Time Communication (WebRTC) softphone or a physical phone device. Only one type of device can be registered at a time.', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****', 'title' => ''], 'UserId' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'Reserved' => ['description' => 'The time when the agent was most recently reserved. Being reserved means an incoming call will soon be assigned to the agent, formatted as a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378', 'title' => ''], 'BreakCode' => [ 'description' => 'Break status code, which can be either system-defined or customer-defined. System-defined break codes include: Warm-up (temporary break state after an agent is published and before becoming idle), RingingTimeout (break caused by agent ringing timeout), and RejectCall (break caused by agent call rejection). There are no restrictions on customer-defined status codes; customers can define them as needed for their business.', 'enumValueTitles' => ['RingingTimeout' => 'Break caused by agent ringing timeout', 'RejectCall' => 'Break caused by agent call rejection', 'Warm-up' => 'Temporary break state after an agent is published and before becoming idle'], 'type' => 'string', 'example' => 'Warm-up', 'title' => '', ], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'OutboundScenario' => ['description' => 'Indicates whether the agent is in outbound-only mode.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Mobile' => ['description' => 'The agent\'s personal phone number.', 'type' => 'string', 'example' => '1324730****', 'title' => ''], 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'UserState' => [ 'description' => 'Agent status.', 'enumValueTitles' => ['READY' => 'Idle', 'WORKING' => 'Post-processing', 'DIALING' => 'Dialing', 'BREAK' => 'Break', 'OFFLINE' => 'Offline', 'TALKING' => 'Talking', 'RINGING' => 'Ringing'], 'type' => 'string', 'example' => 'BREAK', 'title' => '', ], 'SignedSkillGroupIdList' => [ 'description' => 'List of skill group IDs that the agent has signed into.', 'type' => 'array', 'items' => ['description' => 'Skill group ID.', 'type' => 'string', 'example' => 'skillgroup1@ccc-test', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ['errorCode' => 'InvalidOperation.ChannelState', 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', 'description' => ''], ['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.ChannelId', 'errorMessage' => 'The specified channel %s does not exist in call %s.', 'description' => ''], ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => ''], ], ], 'title' => 'Listen to a call ', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-10-26T08:13:46.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MonitorCall'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 1,\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"CREATED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"UserExtension\\": \\"8032****\\",\\n \\"Originator\\": \\"0830019****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"BREAK\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","type":"json"}]', ], 'MuteCall' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'The agent ID to be muted.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test', 'title' => ''], ], [ 'name' => 'DeviceId', 'in' => 'query', 'schema' => ['description' => 'Device ID. This parameter is meaningless and can be filled with any value.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device', 'title' => ''], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The call ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6581536084722****', 'title' => ''], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => ['description' => 'The ID of the voice channel to be muted. This parameter is optional and defaults to empty. If it is empty, the voice channel of the agent corresponding to UserId will be muted.', 'type' => 'string', 'required' => false, 'example' => 'ch:user:1318888****->8001****:1609253204816:job-6581536084722****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'A275B008-A25B-494D-AB53-93CE253815B6', 'title' => ''], 'Params' => [ 'description' => 'List of response parameters.', 'type' => 'array', 'items' => ['description' => 'Response parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'CallContext' => [ 'description' => 'Call context environment.', 'type' => 'object', 'properties' => [ 'CallType' => [ 'description' => 'Call type.', 'enumValueTitles' => [ 'INBOUND' => 'Inbound', 'BARGE' => 'Barge-in', 'CONSULTANT' => 'Consultation', 'CONFERENCE' => 'Conference', 'MONITOR' => 'Listener', 'INTERNAL' => 'Internal Call', 'OUTBOUND' => 'Outbound', 'INTERCEPT' => 'Intercept', 'BACK2BACK' => 'Back-to-Back Call', 'PREDICTIVE' => 'Predictive Outbound', 'COACH' => 'Coaching', ], 'type' => 'string', 'example' => 'OUTBOUND', 'title' => '', ], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-6581536084722****', 'title' => ''], 'ChannelContexts' => [ 'description' => 'List of call channels.', 'type' => 'array', 'items' => [ 'description' => 'Call channel.', 'type' => 'object', 'properties' => [ 'Index' => ['description' => 'An auto-increment ID generated by the system. Customers do not need to concern themselves with it.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'ReleaseInitiator' => ['description' => 'The party that initiated the release of the call channel, indicating who hung up first.', 'type' => 'string', 'example' => '无', 'title' => ''], 'ChannelState' => [ 'description' => 'The status of the call channel.', 'enumValueTitles' => ['CREATED' => 'Created', 'ANSWERED' => 'Answered', 'RELEASED' => 'Released', 'RETIRED' => 'Out Of Effect', 'EARLY_MEDIA' => 'Early Media', 'NONE' => 'Initial Status', 'RINGING' => 'Ringing'], 'type' => 'string', 'example' => 'ANSWERED', 'title' => '', ], 'Destination' => ['description' => 'The callee of the call channel.', 'type' => 'string', 'example' => '8001****', 'title' => ''], 'UserId' => ['description' => 'The agent ID associated with the channel. This field is empty for a customer\'s channel.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'ChannelFlags' => [ 'description' => 'Channel flags.', 'enumValueTitles' => ['COACHING' => 'Coaching', 'MONITORING' => 'Monitoring', 'MONITORED' => 'Monitored', 'COACHED' => 'Coached', 'HOLD' => 'Hold', 'MUTED' => 'Muted'], 'type' => 'string', 'example' => '[MUTED]', 'title' => '', ], 'Timestamp' => ['description' => 'The UNIX timestamp of the most recent status change of the channel, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609253212511', 'title' => ''], 'ReleaseReason' => ['description' => 'The release reason for the channel, indicating why the current channel was disconnected. The value comes from the response codes defined in the SIP protocol. Customers should refer to the SIP protocol to analyze the disconnection reason.', 'type' => 'string', 'example' => '无', 'title' => ''], 'CallType' => [ 'description' => 'The call type of the channel.', 'enumValueTitles' => [ 'INBOUND' => 'Inbound', 'BARGE' => 'Barge-in', 'CONSULTANT' => 'Consultation', 'CONFERENCE' => 'Conference', 'MONITOR' => 'Listener', 'INTERNAL' => 'Internal Call', 'OUTBOUND' => 'Outbound', 'INTERCEPT' => 'Intercept', 'BACK2BACK' => 'Back-to-Back Call', 'PREDICTIVE' => 'Predictive Outbound', 'COACH' => 'Coaching', ], 'type' => 'string', 'example' => 'OUTBOUND', 'title' => '', ], 'JobId' => ['description' => 'The call ID.', 'type' => 'string', 'example' => 'job-6581536084722****', 'title' => ''], 'ChannelId' => ['description' => 'The channel ID.', 'type' => 'string', 'example' => 'ch:user:1318888****->8001****:1609253204816:job-6581536084722****', 'title' => ''], 'UserExtension' => ['description' => 'The extension number of the agent associated with the channel.', 'type' => 'string', 'example' => '8001****', 'title' => ''], 'Originator' => ['description' => 'The originator of the channel.', 'type' => 'string', 'example' => '1318888****', 'title' => ''], 'SkillGroupId' => ['description' => 'The skill group ID associated with the channel. In inbound scenarios, the associated skill group ID is determined by the skill group configured in the IVR transfer-to-agent module. In outbound scenarios, the associated skill group ID is the first skill group that the agent signed into.', 'type' => 'string', 'example' => 'skillgroup@ccc-test', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'UserContext' => [ 'description' => 'Agent context environment.', 'type' => 'object', 'properties' => [ 'Extension' => ['description' => 'Agent extension number.', 'type' => 'string', 'example' => '8001****', 'title' => ''], 'Heartbeat' => ['description' => 'The time when the last heartbeat was received from the agent, in UNIX timestamp format, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609253205896', 'title' => ''], 'WorkMode' => [ 'description' => 'Work mode.', 'enumValueTitles' => ['ON_SITE' => 'On-site mode', 'OFF_SITE' => 'Off-site mode', 'OFFICE_PHONE' => 'Office phone mode'], 'type' => 'string', 'example' => 'ON_SITE', 'title' => '', ], 'DeviceId' => ['description' => 'Device ID, which is the identity ID of a browser-based Web Real-Time Communication (WebRTC) softphone or a physical phone device. Only one type of device can be registered at a time.', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****', 'title' => ''], 'UserId' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'Reserved' => ['description' => 'The time when the agent was most recently reserved. Being reserved means an incoming call will soon be assigned to the agent, in UNIX timestamp format, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609253204811', 'title' => ''], 'BreakCode' => [ 'description' => 'Break status code, which can be either system-defined or customer-defined. System-defined break codes include: Warm-up (temporary break state after the agent is published and before becoming idle), RingingTimeout (break caused by agent ringing timeout), and RejectCall (break caused by agent call rejection). There are no restrictions on customer-defined status codes; customers can define them according to their business needs.', 'enumValueTitles' => ['RingingTimeout' => 'Break caused by agent ringing timeout', 'RejectCall' => 'Break caused by agent call rejection', 'Warm-up' => 'Temporary break state after the agent is published and before becoming idle'], 'type' => 'string', 'example' => 'Warm-up', 'title' => '', ], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'OutboundScenario' => ['description' => 'Indicates whether the agent is in outbound-only mode.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Mobile' => ['description' => 'The agent\'s personal phone number.', 'type' => 'string', 'example' => '1390000****', 'title' => ''], 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-6581536084722****', 'title' => ''], 'UserState' => [ 'description' => 'Agent status.', 'enumValueTitles' => ['READY' => 'Idle', 'WORKING' => 'Post-processing', 'DIALING' => 'Dialing', 'BREAK' => 'Break', 'OFFLINE' => 'Offline', 'TALKING' => 'Talking', 'RINGING' => 'Ringing'], 'type' => 'string', 'example' => 'TALKING', 'title' => '', ], 'SignedSkillGroupIdList' => [ 'description' => 'List of skill group IDs that the agent has signed into.', 'type' => 'array', 'items' => ['description' => 'Skill group ID.', 'type' => 'string', 'example' => 'skillgroup1@ccc-test', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ['errorCode' => 'InvalidOperation.ChannelState', 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', 'description' => ''], ['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.ChannelId', 'errorMessage' => 'The specified channel %s does not exist in call %s.', 'description' => ''], ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => ''], ], ], 'title' => 'Mute Call ', 'summary' => 'You can invoke MuteCall to mute the call associated with a specified call ID under a specified instance. This operation can only be invoked by an agent who is in a talking state, and the agent can only mute themselves. After the agent mutes themselves, the customer will no longer hear the agent\'s voice.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2024-01-18T12:07:41.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-11-06T05:44:48.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MuteCall'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"A275B008-A25B-494D-AB53-93CE253815B6\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6581536084722****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 1,\\n \\"ReleaseInitiator\\": \\"无\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"8001****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"[MUTED]\\",\\n \\"Timestamp\\": 1609253212511,\\n \\"ReleaseReason\\": \\"无\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6581536084722****\\",\\n \\"ChannelId\\": \\"ch:user:1318888****->8001****:1609253204816:job-6581536084722****\\",\\n \\"UserExtension\\": \\"8001****\\",\\n \\"Originator\\": \\"1318888****\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8001****\\",\\n \\"Heartbeat\\": 1609253205896,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609253204811,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1390000****\\",\\n \\"JobId\\": \\"job-6581536084722****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","type":"json"}]', ], 'PauseCampaign' => [ 'summary' => 'Invoke PauseCampaign to pause the predictive outbound calling Activity corresponding to the specified ID under the specified instance.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'CampaignId', 'in' => 'query', 'schema' => ['description' => 'The predictive outbound calling Activity ID.', 'type' => 'string', 'required' => true, 'example' => '6badb397-a8b5-40b6-21019d382a09', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'title' => 'Id of the request', 'type' => 'string', 'example' => '4A68E287-6888-5ADB-8048-DB488B4DEF35'], 'Code' => ['description' => 'The response code.', 'title' => 'code', 'type' => 'string', 'example' => 'OK'], 'Message' => ['description' => 'The response message.', 'title' => 'message', 'type' => 'string', 'example' => '无'], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'title' => 'httpStatusCode', 'type' => 'string', 'example' => '200'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4A68E287-6888-5ADB-8048-DB488B4DEF35\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', 'title' => 'Pause Predictive Outbound Calling Activity', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PauseCampaign'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'PickOutboundNumbers' => [ 'summary' => 'You can invoke PickOutboundNumbers to select an appropriate caller number based on the provided callee number. The number selection logic is controlled by an Intelligent algorithm.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc1MRAID'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'CalledNumber', 'in' => 'query', 'schema' => ['description' => 'Called number.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1388888****', 'title' => ''], ], [ 'name' => 'Count', 'in' => 'query', 'schema' => ['description' => 'The desired quantity of selectable numbers to return. Default is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '3', 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'SkillGroupIdList', 'in' => 'query', 'schema' => ['description' => 'A collection of skill group IDs, formatted as a JSON array string. Each array element is a skill group ID. Numbers are associated with skill groups, and this parameter specifies from which skill groups to select numbers.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["skillgroup@ccc-test"]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Callee' => [ 'description' => 'Callee number.', 'type' => 'object', 'properties' => [ 'Number' => ['description' => 'Number', 'type' => 'string', 'example' => '1388888****', 'title' => ''], 'City' => ['description' => 'City of number registration.', 'type' => 'string', 'example' => '北京', 'title' => ''], 'Province' => ['description' => 'Province of number registration.', 'type' => 'string', 'example' => '北京', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Caller' => [ 'description' => 'Caller number.', 'type' => 'object', 'properties' => [ 'Number' => ['description' => 'Number', 'type' => 'string', 'example' => '0108989****', 'title' => ''], 'City' => ['description' => 'City of number registration.', 'type' => 'string', 'example' => '北京', 'title' => ''], 'Province' => ['description' => 'Province of number registration.', 'type' => 'string', 'example' => '北京', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Select an outbound number', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": [\\n {\\n \\"Callee\\": {\\n \\"Number\\": \\"1388888****\\",\\n \\"City\\": \\"北京\\",\\n \\"Province\\": \\"北京\\"\\n },\\n \\"Caller\\": {\\n \\"Number\\": \\"0108989****\\",\\n \\"City\\": \\"北京\\",\\n \\"Province\\": \\"北京\\"\\n }\\n }\\n ]\\n}","type":"json"}]', ], 'PollUserStatus' => [ 'summary' => 'Polls the agent status of a specified agent under a specified instance. This operation is typically invoked by the frontend agent Workbench to synchronize agent status.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'The agent ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test', 'title' => ''], ], [ 'name' => 'DeviceId', 'in' => 'query', 'schema' => ['description' => 'The Device ID. This parameter is meaningless and can be filled with any value.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], 'Params' => [ 'description' => 'List of response parameters.', 'type' => 'array', 'items' => ['description' => 'Response parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'ContextId' => ['description' => 'System auto increment ID. Customers do not need to concern themselves with this.', 'type' => 'integer', 'format' => 'int64', 'example' => '103655', 'title' => ''], 'CallContext' => [ 'description' => 'Call context environment.', 'type' => 'object', 'properties' => [ 'CallType' => [ 'description' => 'Call type.', 'enumValueTitles' => [ 'INBOUND' => 'Inbound', 'BARGE' => 'Barge', 'CONSULTANT' => 'Consultant', 'CONFERENCE' => 'Conference', 'MONITOR' => 'Listener', 'INTERNAL' => 'Internal call', 'OUTBOUND' => 'Outbound', 'INTERCEPT' => 'Intercept', 'BACK2BACK' => 'Back-to-back', 'PREDICTIVE' => 'Predictive outbound', 'COACH' => 'Coaching', ], 'type' => 'string', 'example' => 'OUTBOUND', 'title' => '', ], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'ChannelContexts' => [ 'description' => 'List of call channels.', 'type' => 'array', 'items' => [ 'description' => 'Call channel.', 'type' => 'object', 'properties' => [ 'Index' => ['description' => 'Auto-incremented system ID. Customers do not need to concern themselves with this value.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'ReleaseInitiator' => ['description' => 'The party that initiated the hang-up of the call channel, indicating who first terminated the call.', 'type' => 'string', 'example' => '1390501****', 'title' => ''], 'ChannelState' => [ 'description' => 'The status of the call channel.', 'enumValueTitles' => ['CREATED' => 'Created', 'ANSWERED' => 'Answered', 'RELEASED' => 'Released', 'RETIRED' => 'Out Of Effect', 'EARLY_MEDIA' => 'Early Media', 'NONE' => 'Initial status', 'RINGING' => 'Ringing'], 'type' => 'string', 'example' => 'CREATED', 'title' => '', ], 'Destination' => ['description' => 'Callee of the call channel.', 'type' => 'string', 'example' => '1390501****', 'title' => ''], 'UserId' => ['description' => 'The agent ID associated with the voice channel. This field is empty if the channel belongs to a customer.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'ChannelFlags' => [ 'description' => 'Call channel flags.', 'enumValueTitles' => ['COACHING' => 'Coaching', 'MONITORING' => 'Monitoring', 'MONITORED' => 'Monitored', 'COACHED' => 'Coached', 'HOLD' => 'Hold', 'MUTED' => 'Muted'], 'type' => 'string', 'example' => 'MONITORING', 'title' => '', ], 'SkillGroupId' => ['description' => 'The skill group ID associated with the channel. In inbound scenarios, the associated skill group ID is determined by the skill group configured in the IVR transfer-to-agent module. In outbound scenarios, the associated skill group ID is the first skill group the agent signed into.', 'type' => 'string', 'example' => 'skillgroup@ccc-test', 'title' => ''], 'Timestamp' => ['description' => 'The UNIX timestamp indicating the most recent status change of the channel, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315', 'title' => ''], 'ReleaseReason' => ['description' => 'The hang-up reason for the call channel, indicating why the current call channel was disconnected. The value comes from the response codes defined in the SIP protocol. Customers should refer to the SIP protocol to analyze the hang-up reason.', 'type' => 'string', 'example' => '404 - No destination', 'title' => ''], 'CallType' => [ 'description' => 'The call type of the channel.', 'enumValueTitles' => [ 'INBOUND' => 'Inbound', 'BARGE' => 'Barge-in', 'CONSULTANT' => 'Consultation', 'CONFERENCE' => 'Conference', 'MONITOR' => 'Listener', 'INTERNAL' => 'Internal call', 'OUTBOUND' => 'Outbound', 'INTERCEPT' => 'Intercept', 'BACK2BACK' => 'Two-party call', 'PREDICTIVE' => 'Predictive outbound call', 'COACH' => 'Coaching', ], 'type' => 'string', 'example' => 'OUTBOUND', 'title' => '', ], 'ChannelVariables' => ['description' => 'Channel-associated data.', 'type' => 'string', 'example' => '123', 'title' => ''], 'JobId' => ['description' => 'The call ID.', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'ChannelId' => ['description' => 'The channel ID.', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****', 'title' => ''], 'UserExtension' => ['description' => 'The extension number of the agent associated with the voice channel.', 'type' => 'string', 'example' => '8032****', 'title' => ''], 'Originator' => ['description' => 'The calling party of the call channel.', 'type' => 'string', 'example' => '0830019****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'CallVariables' => ['description' => 'Ingest endpoint data. Custom data passed through SIP signaling.', 'type' => 'string', 'example' => 'a=b;c=d', 'title' => ''], ], 'title' => '', 'example' => '', ], 'UserContext' => [ 'description' => 'Agent context environment.', 'type' => 'object', 'properties' => [ 'Extension' => ['description' => 'Agent extension number.', 'type' => 'string', 'example' => '8032****', 'title' => ''], 'Heartbeat' => ['description' => 'The time when the last heartbeat was received from the agent, in Unix timestamp format, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378', 'title' => ''], 'WorkMode' => [ 'description' => 'Work mode.', 'enumValueTitles' => ['ON_SITE' => 'On-site mode', 'OFF_SITE' => 'Off-site mode', 'OFFICE_PHONE' => 'Office phone mode'], 'type' => 'string', 'example' => 'ON_SITE', 'title' => '', ], 'DeviceId' => ['description' => 'Device ID, the identity ID of a browser-based Web Real-Time Communication (WebRTC) softphone or a physical phone device. Only one type of device can be registered at a time.', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****', 'title' => ''], 'UserId' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'Reserved' => ['description' => 'The UNIX timestamp (in milliseconds) indicating when the agent was most recently reserved. Being reserved means an incoming call will soon be assigned to the agent.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378', 'title' => ''], 'BreakCode' => [ 'description' => 'Break status code, which can be either System-defined or Customer-defined. System-defined break codes include: Warm-up (temporary break state after an agent is published and before becoming idle), RingingTimeout (break caused by agent ringing timeout), and RejectCall (break caused by agent call rejection). There are no restrictions on Customer-defined status codes, and customers can define them according to their business needs.', 'enumValueTitles' => ['RingingTimeout' => 'Break caused by agent ringing timeout', 'RejectCall' => 'Break caused by agent call rejection', 'Warm-up' => 'Temporary break state after an agent is published and before becoming idle'], 'type' => 'string', 'example' => 'Warm-up', 'title' => '', ], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'OutboundScenario' => ['description' => 'Indicates whether the agent is in outbound-only mode.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Mobile' => ['description' => 'The agent\'s personal phone number.', 'type' => 'string', 'example' => '1324730****', 'title' => ''], 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'UserState' => [ 'description' => 'Agent status.', 'enumValueTitles' => ['READY' => 'Ready', 'WORKING' => 'Post-processing', 'DIALING' => 'Dialing', 'BREAK' => 'Break', 'OFFLINE' => 'Offline', 'TALKING' => 'Talking', 'RINGING' => 'Ringing'], 'type' => 'string', 'example' => 'BREAK', 'title' => '', ], 'SignedSkillGroupIdList' => [ 'description' => 'List of skill group IDs that the agent has signed into.', 'type' => 'array', 'items' => ['description' => 'Skill group ID.', 'type' => 'string', 'example' => 'skillgroup1@ccc-test', 'title' => ''], 'title' => '', 'example' => '', ], 'ParallelJobList' => [ 'description' => 'Chat sessions currently being handled or already handled by the agent', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'JobId' => ['description' => 'Session ID.', 'type' => 'string', 'example' => 'job-6538214103685****'."\n", 'title' => ''], 'Status' => ['description' => 'The agent\'s status in this session.'."\n" ."\n" .'### Enumeration values:'."\n" ."\n" .'- RINGING'."\n" ."\n" .'- TALKING'."\n" ."\n" .'- RELEASED (End)'."\n" ."\n" .'- MISSED (Missed)', 'type' => 'string', 'example' => 'RINGING', 'title' => ''], 'Timestamp' => ['description' => 'The time when the status changed.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'ChatContexts' => [ 'description' => 'Session context environment.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'JobId' => ['description' => 'Call job ID.', 'type' => 'string', 'example' => 'chat-65382141036853491'."\n", 'title' => ''], 'ChatType' => ['description' => 'Session type.', 'type' => 'string', 'example' => 'INBOUND', 'title' => ''], 'CallVariables' => ['description' => 'Ingest endpoint data.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Members' => [ 'description' => 'Information about the agents and customers participating in this chat session.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Index' => ['description' => 'System auto increment ID. Customers do not need to concern themselves with this value.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'UserId' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test'."\n", 'title' => ''], 'UserType' => ['description' => 'User type.'."\n" ."\n" .'Enumeration values:'."\n" ."\n" .'- CUSTOMER: Customer'."\n" ."\n" .'- AGENT: Agent', 'type' => 'string', 'example' => 'Manager', 'title' => ''], 'Status' => ['description' => 'The status of the agent in this session.'."\n" ."\n" .'Enumeration values:'."\n" ."\n" .'- RINGING'."\n" ."\n" .'- TALKING'."\n" ."\n" .'- RELEASED (End)'."\n" ."\n" .'- MISSED (Missed)', 'type' => 'string', 'example' => 'RINGING', 'title' => ''], 'SkillGroupId' => ['description' => 'Skill group ID.', 'type' => 'string', 'example' => 'a527a80a-75cf-448f-aba0-fca37c61946d', 'title' => ''], 'ReleaseInitiator' => ['description' => 'The party that initiated the hang-up.', 'type' => 'string', 'example' => 'User', 'title' => ''], 'ReleaseReason' => ['description' => 'The hang-up reason for the call channel, indicating why the current call channel was terminated. The value is derived from the response codes defined in the SIP protocol. Customers should refer to the SIP protocol for analysis of the hang-up reason.', 'type' => 'string', 'example' => '无', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => ''], ], ], 'title' => 'Polling agent status', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-11-17T01:12:03.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2022-11-28T06:51:14.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PollUserStatus'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"ContextId\\": 103655,\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 1,\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"CREATED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"ChannelVariables\\": \\"123\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"UserExtension\\": \\"8032****\\",\\n \\"Originator\\": \\"0830019****\\"\\n }\\n ],\\n \\"CallVariables\\": \\"a=b;c=d\\"\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"BREAK\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ],\\n \\"ParallelJobList\\": [\\n {\\n \\"JobId\\": \\"job-6538214103685****\\\\n\\",\\n \\"Status\\": \\"RINGING\\",\\n \\"Timestamp\\": 1609136956378\\n }\\n ]\\n },\\n \\"ChatContexts\\": [\\n {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"chat-65382141036853491\\\\n\\",\\n \\"ChatType\\": \\"INBOUND\\",\\n \\"CallVariables\\": \\"无\\",\\n \\"Members\\": [\\n {\\n \\"Index\\": 1,\\n \\"UserId\\": \\"agent@ccc-test\\\\n\\",\\n \\"UserType\\": \\"Manager\\",\\n \\"Status\\": \\"RINGING\\",\\n \\"SkillGroupId\\": \\"a527a80a-75cf-448f-aba0-fca37c61946d\\",\\n \\"ReleaseInitiator\\": \\"User\\",\\n \\"ReleaseReason\\": \\"无\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'ProcessCustomIMCallback' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '263383', 'abilityTreeNodes' => ['FEATUREcccD72NOC'], ], 'parameters' => [ [ 'name' => 'AccessChannelId', 'in' => 'formData', 'schema' => ['description' => 'The channel ID.', 'type' => 'string', 'required' => true, 'example' => 'cf584733-***-***-9699-cb77aa3b7aa6', 'title' => ''], ], [ 'name' => 'ConversationId', 'in' => 'formData', 'schema' => ['description' => 'The session ID.', 'type' => 'string', 'required' => true, 'example' => 'd165de4f-9851-445e-9535-66ebfa72fa51', 'title' => ''], ], [ 'name' => 'SenderId', 'in' => 'formData', 'schema' => ['description' => 'The user ID of the message sender.', 'type' => 'string', 'required' => true, 'example' => '63061274befd6b545aab4c83', 'title' => ''], ], [ 'name' => 'SenderName', 'in' => 'formData', 'schema' => ['description' => 'The name of the sender.', 'type' => 'string', 'required' => false, 'example' => 'tom', 'title' => ''], ], [ 'name' => 'RequestId', 'in' => 'formData', 'schema' => ['description' => 'The request ID.', 'type' => 'string', 'required' => false, 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', 'title' => ''], ], [ 'name' => 'SenderAvatarMediaId', 'in' => 'formData', 'schema' => ['description' => 'The profile picture ID.', 'type' => 'string', 'required' => false, 'example' => 'xxxx', 'title' => ''], ], [ 'name' => 'MessageContent', 'in' => 'formData', 'schema' => ['description' => 'The message content.', 'type' => 'string', 'required' => true, 'example' => '消息内容，格式如下：'."\n" ."\n\n" .'文本消息：'."\n" .'{ "contentType":"Text", "text":"你好 " }'."\n" ."\n" .'图片消息：'."\n" .'{ "contentType":"Image", "mediaId": "xxx-xxx-xxx", "fileType": "png", "fileSize": 1233 }'."\n" ."\n" .'视频消息：'."\n" .'{ "contentType":"Video", "mediaId": "xxx-xxx-xxx" "duration": 12, "fileSize": 1233, }'."\n" ."\n" .'音频消息：'."\n" .'{ "contentType":"Audio", "mediaId": "xxx-xxx-xxx" "duration": 12, "fileSize": 1233 }'."\n" ."\n" .'文件消息：'."\n" .'{ "contentType":"File", "mediaId": "xxx-xxx-xxx", "fileSize": 223232, "filename": "xyz. zip" }', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Response for processing a DingTalk robot callback.', 'title' => 'ProcessDingTalkRobotCallbackResponse ', 'type' => 'object', 'properties' => [ 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => 'chat-65382141036853491', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2778FA12-EDD6-42AA-9B15-AF855072E5E5', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Params' => [ 'description' => 'The response parameters.', 'type' => 'array', 'items' => ['description' => 'The response parameters.', 'type' => 'string', 'example' => '[\'OFFLINE\', \'BREAK,READY,WORKING\']', 'title' => ''], 'title' => '', 'example' => '', ], 'Data' => ['description' => 'The data.', 'type' => 'string', 'example' => '无', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"JobId\\": \\"chat-65382141036853491\\",\\n \\"RequestId\\": \\"2778FA12-EDD6-42AA-9B15-AF855072E5E5\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"[\'OFFLINE\', \'BREAK,READY,WORKING\']\\"\\n ],\\n \\"Data\\": \\"无\\"\\n}","type":"json"}]', 'title' => 'Third-party IM message callback ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'summary' => '', ], 'PublishContactFlow' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccTPIKHY'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'ContactFlowId', 'in' => 'query', 'schema' => ['description' => 'The contact flow ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'b0a063bf-f138-42a4-ad9f-9babe3ec1a9e', 'title' => ''], ], [ 'name' => 'DraftId', 'in' => 'query', 'schema' => ['description' => 'The draft ID. This is the ID of the draft version that corresponds to the current contact flow.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0e0b8e78-af3e-4360-a5c5-f9bb5c2b8af2', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BFB6788F-20D4-5767-BC67-99EAAC28F789', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Publish contact flow', 'summary' => 'Publishes a contact flow.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PublishContactFlow'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BFB6788F-20D4-5767-BC67-99EAAC28F789\\"\\n}","type":"json"}]', ], 'ReadyForService' => [ 'summary' => 'You can invoke ReadyForService to make a specified agent under a specified instance ready. After becoming ready, the agent enters the idle status.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'Agent ID. If not specified, it defaults to the agent mapped to the current RAM account.', 'type' => 'string', 'required' => false, 'example' => 'user-test@ccc-test', 'title' => ''], ], [ 'name' => 'DeviceId', 'in' => 'query', 'schema' => ['description' => 'Device ID. This parameter is meaningless and can be filled with any value.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device', 'title' => ''], ], [ 'name' => 'OutboundScenario', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enter outbound-only mode after being published. This parameter is optional and defaults to false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'CC49060B-87ED-489A-AD3D-00E57775DBFF', 'title' => ''], 'Params' => [ 'description' => 'List of response parameters.', 'type' => 'array', 'items' => ['description' => 'Response parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'Extension' => ['description' => 'Agent extension number.', 'type' => 'string', 'example' => '8001****', 'title' => ''], 'WorkMode' => [ 'description' => 'Work mode.', 'enumValueTitles' => ['ON_SITE' => 'On-site mode', 'OFF_SITE' => 'Off-site mode', 'OFFICE_PHONE' => 'Office phone mode'], 'type' => 'string', 'example' => 'ON_SITE', 'title' => '', ], 'DeviceId' => ['description' => 'Device ID, which is the identity ID of a browser-based Web Real-Time Communication (WebRTC) softphone or a physical phone device. Only one type of device can be registered at a time.', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****', 'title' => ''], 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'UserId' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'BreakCode' => [ 'description' => 'Break status code, which can be either System-defined or Custom-defined. System-defined break codes include: Warm-up (temporary break state after the agent is published and before becoming idle), RingingTimeout (break caused by agent ringing timeout), and RejectCall (break caused by agent rejecting a call). There are no restrictions on Custom-defined status codes; customers can define them according to their business needs.', 'enumValueTitles' => ['RingingTimeout' => 'Break caused by agent ringing timeout', 'RejectCall' => 'Break caused by agent rejecting a call', 'Warm-up' => 'Temporary break state after the agent is published and before becoming idle'], 'type' => 'string', 'example' => 'Warm-up'."\n", 'title' => '', ], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'OutboundScenario' => ['description' => 'Indicates whether the agent is in outbound-only mode.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'UserState' => [ 'description' => 'Agent status.', 'enumValueTitles' => ['READY' => 'Idle', 'WORKING' => 'Post-processing', 'DIALING' => 'Dialing', 'BREAK' => 'Break', 'OFFLINE' => 'Offline', 'TALKING' => 'Talking', 'RINGING' => 'Ringing'], 'type' => 'string', 'example' => 'READY', 'title' => '', ], 'SignedSkillGroupIdList' => [ 'description' => 'List of skill group IDs that the agent has signed into.', 'type' => 'array', 'items' => ['description' => 'Skill group ID.', 'type' => 'string', 'example' => 'skillgroup1@ccc-test', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidOperation.ChannelState', 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', 'description' => ''], ['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => ''], ], ], 'title' => 'Agent Ready ', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-10-26T08:13:46.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReadyForService'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"CC49060B-87ED-489A-AD3D-00E57775DBFF\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"Extension\\": \\"8001****\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"BreakCode\\": \\"Warm-up\\\\n\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"UserState\\": \\"READY\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n}","type":"json"}]', ], 'RedialCall' => [ 'summary' => 'Redial the number in the desensitized call record', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID of the call center.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'abc', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'User ID of the agent.', 'type' => 'string', 'required' => false, 'example' => 'samzhang@abc', 'title' => ''], ], [ 'name' => 'DeviceId', 'in' => 'query', 'schema' => ['description' => 'Unique ID provided by the agent endpoint to identify an agent Workbench.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'CCC-x.x.x.x-chrome102-bsdf911812c60f61e', 'title' => ''], ], [ 'name' => 'Caller', 'in' => 'query', 'schema' => ['description' => 'Caller number.', 'type' => 'string', 'required' => false, 'example' => '0109810****', 'title' => ''], ], [ 'name' => 'Callee', 'in' => 'query', 'schema' => ['description' => 'Callee number.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '1318888****', 'title' => ''], ], [ 'name' => 'TimeoutSeconds', 'in' => 'query', 'schema' => ['description' => 'Timeout. If the call is not answered within the time specified by this parameter, it is automatically disconnected.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '300', 'minimum' => '30', 'example' => '30', 'title' => ''], ], [ 'name' => 'Tags', 'in' => 'query', 'schema' => ['description' => 'Per-call data. It must not exceed 128 bytes and is primarily used for extension purposes. Ordinary customers do not need to pay attention to it.', 'type' => 'string', 'required' => false, 'example' => 'a=b', 'title' => ''], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'Call job ID. The job ID of the previous call used for redialing.', 'type' => 'string', 'required' => false, 'example' => 'job-6581536084722****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Status code. A return value of "OK" indicates that the request succeeded. For other error codes, see the error code list.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BF268B34-09C2-43FD-BAC4-5D31EA63****', 'title' => ''], 'Params' => [ 'description' => 'List of response parameters.', 'type' => 'array', 'items' => ['description' => 'Response parameter.', 'type' => 'string', 'example' => 'skillGroupId', 'title' => ''], 'title' => '', 'example' => '', ], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'ContextId' => ['description' => 'Context ID, strictly ordered and incrementing.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456789', 'title' => ''], 'CallContext' => [ 'description' => 'Call context environment.', 'type' => 'object', 'properties' => [ 'CallType' => [ 'description' => 'The call type, indicating the type of the call when it was initially initiated.', 'enumValueTitles' => [ 'INBOUND' => 'Inbound', 'BARGE' => 'Barge', 'CONSULTANT' => 'Consultation', 'CONFERENCE' => 'Conference', 'MONITOR' => 'Monitor', 'INTERNAL' => 'Internal Call', 'OUTBOUND' => 'Outbound', 'INTERCEPT' => 'Intercept', 'BACK2BACK' => 'Back-to-Back', 'PREDICTIVE' => 'Predictive Outbound', 'COACH' => 'Coach', ], 'type' => 'string', 'example' => 'OUTBOUND', 'title' => '', ], 'InstanceId' => ['description' => 'Cloud Contact Center instance ID.', 'type' => 'string', 'example' => 'abc', 'title' => ''], 'JobId' => ['description' => 'The call job ID.', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'ChannelContexts' => [ 'description' => 'The list of call channels.', 'type' => 'array', 'items' => [ 'description' => 'A call channel.', 'type' => 'object', 'properties' => [ 'ReleaseInitiator' => ['description' => 'The party that initiated the hang-up of the call channel, indicating who first terminated the call.', 'type' => 'string', 'example' => '139xxxx0501', 'title' => ''], 'ChannelState' => [ 'description' => 'The status of the voice channel.', 'enumValueTitles' => ['CREATED' => 'Created', 'ANSWERED' => 'Answered', 'RELEASED' => 'Released', 'RETIRED' => 'Out Of Effect', 'EARLY_MEDIA' => 'Early Media', 'NONE' => 'Initial Status', 'RINGING' => 'Ringing'], 'type' => 'string', 'example' => 'CREATED', 'title' => '', ], 'Destination' => ['description' => 'The callee of the voice channel.', 'type' => 'string', 'example' => '8001****', 'title' => ''], 'UserId' => ['description' => 'Agent User ID information.', 'type' => 'string', 'example' => 'samzhang@abc', 'title' => ''], 'ChannelFlags' => [ 'description' => 'Call channel flags.', 'enumValueTitles' => ['COACHING' => 'Coaching', 'MONITORING' => 'Monitoring', 'MONITORED' => 'Monitored', 'COACHED' => 'Coached', 'HOLD' => 'Hold', 'MUTED' => 'Muted'], 'type' => 'string', 'example' => 'COACHING', 'title' => '', ], 'Timestamp' => ['description' => 'UNIX timestamp of the last status change.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315', 'title' => ''], 'ReleaseReason' => ['description' => 'The release reason of the voice channel, indicating why the current voice channel was released. The value is derived from the response codes defined in the SIP protocol. Customers can refer to the SIP protocol to analyze the release reason.', 'type' => 'string', 'example' => '486:USER_BUSY', 'title' => ''], 'CallType' => [ 'description' => 'The call type of the channel.', 'enumValueTitles' => [ 'INBOUND' => 'Inbound', 'BARGE' => 'Barge', 'CONSULTANT' => 'Consultant', 'CONFERENCE' => 'Conference', 'MONITOR' => 'Monitor', 'INTERNAL' => 'Internal Call', 'OUTBOUND' => 'Outbound', 'INTERCEPT' => 'Intercept', 'BACK2BACK' => 'Back-to-Back', 'PREDICTIVE' => 'Predictive Dialing', 'COACH' => 'Coach', ], 'type' => 'string', 'example' => 'OUTBOUND', 'title' => '', ], 'JobId' => ['description' => 'Call job ID.', 'type' => 'string', 'example' => 'job-6573574060089****', 'title' => ''], 'ChannelId' => ['description' => 'Channel ID.', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****', 'title' => ''], 'Originator' => ['description' => 'The calling party of the call channel.', 'type' => 'string', 'example' => '1318888****', 'title' => ''], 'UserExtension' => ['description' => 'User extension number.', 'type' => 'string', 'example' => '8000****'."\n", 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'UserContext' => [ 'description' => 'Agent context environment.', 'type' => 'object', 'properties' => [ 'Extension' => ['description' => 'User extension number.', 'type' => 'string', 'example' => '8000****', 'title' => ''], 'WorkMode' => ['description' => 'Work mode. Enumeration values:'."\n" ."\n" .'- ON\\_SITE: On-site mode'."\n" ."\n" .'- OFF\\_SITE: Off-site mode'."\n" ."\n" .'- OFFICE\\_PHONE: Office phone mode', 'type' => 'string', 'example' => 'ON_SITE'."\n", 'title' => ''], 'DeviceId' => ['description' => 'Device ID, which is the identity of a browser-based Web Real-Time Communication (WebRTC) softphone or a physical phone device. Only one type of device can be registered at a time.', 'type' => 'string', 'example' => 'CCC-x.x.x.x-chrome102-bsdf911812c60f61e'."\n", 'title' => ''], 'JobId' => ['description' => 'Call job ID.', 'type' => 'string', 'example' => 'job-6573574060089****', 'title' => ''], 'UserId' => ['description' => 'Agent User ID information.', 'type' => 'string', 'example' => 'samzhang@abc'."\n", 'title' => ''], 'BreakCode' => ['description' => 'Break status code, which is divided into system-defined and customer-defined types.'."\n" ."\n" .'System-defined break codes:'."\n" ."\n" .'- Warm-up: A temporary break state after an agent is published but before becoming idle.'."\n" ."\n" .'- RingingTimeout: A break caused by ringing timeout for the agent.'."\n" ."\n" .'- RejectCall: A break caused by the agent rejecting a call.'."\n" ."\n" .'There are no restrictions on customer-defined status codes. Customers can define them according to their business needs.', 'type' => 'string', 'example' => 'Warm-up', 'title' => ''], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'abc', 'title' => ''], 'OutboundScenario' => ['description' => 'Indicates whether the agent is in outbound-only mode.', 'type' => 'boolean', 'example' => 'False', 'title' => ''], 'UserState' => ['description' => 'Agent status. Enumeration values:'."\n" ."\n" .'- READY: idle'."\n" ."\n" .'- WORKING: post-processing'."\n" ."\n" .'- DIALING: dial-up'."\n" ."\n" .'- BREAK: break'."\n" ."\n" .'- OFFLINE: offline'."\n" ."\n" .'- TALKING: talking'."\n" ."\n" .'- RINGING: ringing', 'type' => 'string', 'example' => 'READY', 'title' => ''], 'SignedSkillGroupIdList' => [ 'description' => 'List of skill group IDs that the agent has signed into.', 'type' => 'array', 'items' => ['description' => 'Skill group ID that the agent has signed into.', 'type' => 'string', 'example' => 'skillgroup1@abc', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'UserBusy', 'errorMessage' => 'The user %s you called was busy. Please try again later.', 'description' => ''], ['errorCode' => 'InvalidOperation.ChannelState', 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', 'description' => ''], ['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => ''], ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.Extension', 'errorMessage' => 'No available extension number exists.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => ''], ], ], 'title' => 'Redial ', 'changeSet' => [ ['createdAt' => '2023-10-26T08:13:46.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-12-30T02:49:39.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RedialCall'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BF268B34-09C2-43FD-BAC4-5D31EA63****\\",\\n \\"Params\\": [\\n \\"skillGroupId\\"\\n ],\\n \\"Data\\": {\\n \\"ContextId\\": 123456789,\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"abc\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"ReleaseInitiator\\": \\"139xxxx0501\\",\\n \\"ChannelState\\": \\"CREATED\\",\\n \\"Destination\\": \\"8001****\\",\\n \\"UserId\\": \\"samzhang@abc\\",\\n \\"ChannelFlags\\": \\"COACHING\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"486:USER_BUSY\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6573574060089****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"Originator\\": \\"1318888****\\",\\n \\"UserExtension\\": \\"8000****\\\\n\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8000****\\",\\n \\"WorkMode\\": \\"ON_SITE\\\\n\\",\\n \\"DeviceId\\": \\"CCC-x.x.x.x-chrome102-bsdf911812c60f61e\\\\n\\",\\n \\"JobId\\": \\"job-6573574060089****\\",\\n \\"UserId\\": \\"samzhang@abc\\\\n\\",\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"abc\\",\\n \\"OutboundScenario\\": true,\\n \\"UserState\\": \\"READY\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@abc\\"\\n ]\\n }\\n }\\n}","type":"json"}]', ], 'RegisterDevice' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'The agent ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test', 'title' => ''], ], [ 'name' => 'DeviceId', 'in' => 'query', 'schema' => ['description' => 'The custom device ID. No specific format is required.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-device', 'title' => ''], ], [ 'name' => 'Password', 'in' => 'query', 'schema' => ['description' => 'The password used to authenticate the SIP device during registration. Keep this password secure.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'password', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], 'Params' => [ 'description' => '', 'type' => 'array', 'items' => ['description' => 'A response parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be blank.', 'description' => ''], ], ], 'title' => 'Register Device', 'summary' => 'Registers a Session Initiation Protocol (SIP) device with a specified agent in an instance. A SIP device can be a physical SIP phone or a softphone.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RegisterDevice'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', ], 'RegisterDevices' => [ 'summary' => 'Registers one or more SIP devices to specified agents in an instance. A SIP device can be a SIP phone or a SIP softphone.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'UserIdListJson', 'in' => 'query', 'schema' => ['description' => 'A JSON string that contains an array of agent IDs.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '["user-test@ccc-test"]', 'title' => ''], ], [ 'name' => 'DeviceId', 'in' => 'query', 'schema' => ['description' => 'The device ID. Any string can be used, and there are no specific format requirements.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test-device', 'title' => ''], ], [ 'name' => 'Password', 'in' => 'query', 'schema' => ['description' => 'The device password. The SIP device uses this password for authentication during registration. Store this password securely.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'password', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', 'title' => ''], 'Params' => [ 'description' => '', 'type' => 'array', 'items' => ['description' => 'The response parameters.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ], ], 'title' => 'Register multiple devices', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2022-01-19T00:08:15.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RegisterDevices'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', ], 'RejectChat' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The call ID.', 'type' => 'string', 'required' => true, 'example' => 'chat-65382141036853491', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B59382D2-5755-4C6D-861F-FA2AAD8F89F7', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''], ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => ''], ['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid.', 'description' => ''], ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], 409 => [ ['errorCode' => 'AlreadyExists.SkillGroup', 'errorMessage' => 'The skill group %s already exists in instance %s.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"B59382D2-5755-4C6D-861F-FA2AAD8F89F7\\"\\n}","type":"json"}]', 'title' => 'Deny Chat', 'summary' => 'Rejects a chat assigned to an agent.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'RejectTicket' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'TicketId', 'in' => 'query', 'schema' => ['description' => 'The ticket ID.', 'type' => 'string', 'required' => false, 'example' => 'f2c6722b-cd13-442d-bf10-22a07c70d6d5', 'title' => ''], ], [ 'name' => 'Comment', 'in' => 'query', 'schema' => ['description' => 'The comment on the ticket.', 'type' => 'string', 'required' => false, 'example' => '请补充信息。', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'TurnDownTicketResponse', 'title' => 'TurnDownTicketResponse', 'type' => 'object', 'properties' => [ 'Data' => ['description' => 'The data.', 'type' => 'any', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '678F7002-CA01-4ABF-A112-585AFBDF3A3B', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Params' => [ 'description' => 'The list of error parameters.', 'type' => 'array', 'items' => ['description' => 'The error parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"678F7002-CA01-4ABF-A112-585AFBDF3A3B\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', 'title' => 'Return Ticket', 'summary' => 'Use the RejectTicket operation to reject a ticket. The ticket creator can add information to a rejected ticket and then resubmit it.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'ReleaseCall' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'Agent ID. If not specified, the agent mapped to the current Resource Access Management (RAM) user is used by default.', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test', 'title' => ''], ], [ 'name' => 'DeviceId', 'in' => 'query', 'schema' => ['description' => 'Device ID. This parameter is meaningless and can be filled with any value.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device', 'title' => ''], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'Call ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6538214103685****', 'title' => ''], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => ['description' => 'Channel ID of the call to hang up. This parameter is optional. If not specified, it defaults to the channel where the agent corresponding to the UserId is located.', 'type' => 'string', 'required' => false, 'example' => 'ch:user:1390501****->8032****:1609138902226:job-6538214103685****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], 'Params' => [ 'description' => 'List of response parameters.', 'type' => 'array', 'items' => ['description' => 'Response parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'CallContext' => [ 'description' => 'Call context environment.', 'type' => 'object', 'properties' => [ 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'ChannelContexts' => [ 'description' => 'List of call channels.', 'type' => 'array', 'items' => [ 'description' => 'Call channel.', 'type' => 'object', 'properties' => [ 'ReleaseInitiator' => ['description' => 'The party that initiated the hang-up of the call channel, indicating who first terminated the call.', 'type' => 'string', 'example' => '1390501****', 'title' => ''], 'ChannelState' => [ 'enumValueTitles' => ['CREATED' => 'Created ', 'ANSWERED' => 'Answered ', 'RELEASED' => 'Released ', 'RETIRED' => 'Out Of Effect ', 'EARLY_MEDIA' => 'Early Media ', 'NONE' => 'Initial Status ', 'RINGING' => 'Ringing '], 'description' => 'The status of the voice channel. ', 'type' => 'string', 'example' => 'CREATED', 'title' => '', ], 'Destination' => ['description' => 'The callee of the voice channel. ', 'type' => 'string', 'example' => '1390501****', 'title' => ''], 'UserId' => ['description' => 'The agent ID associated with the call channel. This field is empty if the call channel belongs to a Customer.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'Timestamp' => ['description' => 'The UNIX timestamp of the most recent status change of the channel, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315', 'title' => ''], 'ReleaseReason' => ['description' => 'The reason for releasing the voice channel, indicating why the current voice channel was disconnected. The value is derived from the response codes defined in the SIP protocol. Customers can refer to the SIP protocol to analyze the disconnection reason. ', 'type' => 'string', 'example' => '404 - No destination', 'title' => ''], 'CallType' => [ 'enumValueTitles' => [ 'INBOUND' => 'Inbound', 'BARGE' => 'Barge-in', 'CONSULTANT' => 'Consultation', 'CONFERENCE' => 'Conference', 'MONITOR' => 'Monitor', 'INTERNAL' => 'Internal Call', 'OUTBOUND' => 'Outbound', 'INTERCEPT' => 'Intercept', 'BACK2BACK' => 'Two-party call', 'PREDICTIVE' => 'Predictive outbound call', 'COACH' => 'Coaching', ], 'description' => 'The call type of the channel.', 'type' => 'string', 'example' => 'OUTBOUND', 'title' => '', ], 'JobId' => ['description' => 'The call ID.', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'ChannelId' => ['description' => 'The channel ID.', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****', 'title' => ''], 'Originator' => ['description' => 'The calling party of the call channel.', 'type' => 'string', 'example' => '0830019****', 'title' => ''], 'UserExtension' => ['description' => 'The extension number of the agent associated with the channel.', 'type' => 'string', 'example' => '8032****', 'title' => ''], 'ChannelVariables' => ['description' => 'Channel-associated data', 'type' => 'string', 'example' => 'a=b;c=d;', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'UserContext' => [ 'description' => 'Agent context environment.', 'type' => 'object', 'properties' => [ 'Extension' => ['description' => 'Agent extension number.', 'type' => 'string', 'example' => '8032****', 'title' => ''], 'WorkMode' => [ 'enumValueTitles' => ['ON_SITE' => 'On-site mode ', 'OFF_SITE' => 'Off-site mode ', 'OFFICE_PHONE' => 'Office phone mode'], 'description' => 'Work mode.', 'type' => 'string', 'example' => 'ON_SITE', 'title' => '', ], 'DeviceId' => ['description' => 'Device ID, which is the identity of a browser-based Web Real-Time Communication (WebRTC) softphone or a physical phone device. Only one type of device can be registered at a time. ', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****', 'title' => ''], 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'UserId' => ['description' => 'Agent ID. ', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'BreakCode' => [ 'enumValueTitles' => ['RingingTimeout' => 'Break caused by agent ringing timeout ', 'RejectCall' => 'Break caused by agent call rejection ', 'Warm-up' => 'Temporary break state after agent is published and before becoming idle '], 'description' => 'Break status code, which can be either system-defined or customer-defined. System-defined break codes include: Warm-up (temporary break state after agent is published and before becoming idle), RingingTimeout (break caused by agent ringing timeout), and RejectCall (break caused by agent call rejection). There are no restrictions on customer-defined status codes; customers can define them according to their business needs. ', 'type' => 'string', 'example' => 'Warm-up', 'title' => '', ], 'InstanceId' => ['description' => 'Instance ID. ', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'OutboundScenario' => ['description' => 'Indicates whether the agent is in outbound-only mode. ', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'UserState' => [ 'enumValueTitles' => ['READY' => 'Ready', 'WORKING' => 'Post-processing', 'DIALING' => 'Dialing', 'BREAK' => 'Break', 'OFFLINE' => 'Offline', 'TALKING' => 'Talking', 'RINGING' => 'Ringing'], 'description' => 'Agent status.', 'type' => 'string', 'example' => 'BREAK', 'title' => '', ], 'SignedSkillGroupIdList' => [ 'description' => 'List of skill group IDs that the agent has signed into.', 'type' => 'array', 'items' => ['description' => 'Skill group ID.', 'type' => 'string', 'example' => 'skillgroup1@ccc-test', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'ContextId' => ['description' => 'System auto-increment ID. Customers do not need to concern themselves with this.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"CREATED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"Originator\\": \\"0830019****\\",\\n \\"UserExtension\\": \\"8032****\\",\\n \\"ChannelVariables\\": \\"a=b;c=d;\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"UserState\\": \\"BREAK\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n },\\n \\"ContextId\\": 123456\\n }\\n}","type":"json"}]', 'title' => 'Hang up a call', 'summary' => 'You can invoke ReleaseCall to hang up the call associated with a specified call ID under a specified instance. The invoker must be an agent and currently in a call.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-10-26T08:13:45.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-06-05T23:22:12.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-01-19T00:08:15.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReleaseCall'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'ReleaseChat' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'Job ID.', 'type' => 'string', 'required' => true, 'example' => 'chat-6538214103685****', 'title' => ''], ], [ 'name' => 'UserType', 'in' => 'query', 'schema' => ['description' => 'User type.'."\n" ."\n" .'- CUSTOMER: visitor'."\n" ."\n" .'- AGENT: agent', 'type' => 'string', 'required' => true, 'example' => 'CUSTOMER', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'User ID. Visitor ID or agent ID.', 'type' => 'string', 'required' => false, 'example' => 'edbcf95a-ef9f-4296-a0a6-985ac9e36db3', 'title' => ''], ], [ 'name' => 'Token', 'in' => 'query', 'schema' => ['description' => 'Channel token for network services.', 'type' => 'string', 'required' => false, 'example' => '9XYGTGWtq2wFi_Bpg7aUnIoYi_vG_rO3bjEn0YtsxbHRHrYHlz1LDBLJAyZcLxieRQR4h_6AnWvTjJeNU5jg************Hwej7WgWrmA=', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'B06B3244-1B44-481B-90C4-F2F92E59D6B5', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''], ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => ''], ['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid.', 'description' => ''], ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], 409 => [ ['errorCode' => 'AlreadyExists.SkillGroup', 'errorMessage' => 'The skill group %s already exists in instance %s.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"B06B3244-1B44-481B-90C4-F2F92E59D6B5\\"\\n}","type":"json"}]', 'title' => 'End Chat', 'summary' => 'The ReleaseChat operation ends the current chat.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'RemoveBlacklistCallTagging' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc1MRAID'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'ID of the Cloud Contact Center instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'Number', 'in' => 'query', 'schema' => ['description' => 'Phone number.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1312121****', 'title' => ''], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'Call ID. Provide this field only for masked numbers (containing \\*). Do not provide it for unmasked numbers.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => 'job-6538214103685****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Response schema', 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'ID of the request', 'description' => 'ID of the request.', 'type' => 'string', 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716'], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => ''], ['errorCode' => 'LimitExceed.CallTagsPerNumber', 'errorMessage' => 'The total number of call tag of numbers exceeds the limit %s.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.CustomCallTagging', 'errorMessage' => 'Custom call tagging %s does not exist in instance %s.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.DB', 'errorMessage' => 'An internal DB service error occurred. %s', 'description' => ''], ], ], 'title' => 'Remove Number Blacklist Label', 'summary' => 'Removes the blacklist tag from a specified phone number.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"03C67DAD-EB26-41D8-949D-9B0C470FB716\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\"\\n}","type":"json"}]', ], 'RemoveDoNotCallNumbers' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc1MRAID'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'NumberList', 'in' => 'query', 'schema' => ['description' => 'List of Do Not Call numbers to be deleted, formatted as a JSON array string. The array length must be between 1 and 300.', 'type' => 'string', 'required' => false, 'example' => '["1900000****","1312211****"]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Data' => ['description' => 'Data.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', 'title' => ''], 'Params' => [ 'description' => 'Response parameters corresponding to placeholders in the error message.', 'type' => 'array', 'items' => ['description' => 'Response parameter.', 'type' => 'string', 'example' => 'numberList', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Delete Do Not Call Numbers', 'summary' => 'You can invoke RemoveDoNotCallNumbers to delete one or more Do Not Call number configuration items under a specified instance.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-11-06T05:44:48.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-02-24T13:00:36.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveDoNotCallNumbers'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Params\\": [\\n \\"numberList\\"\\n ]\\n}","type":"json"}]', ], 'RemovePersonalNumbersFromUser' => [ 'summary' => 'You can invoke RemovePersonalNumbersFromUser to delete one or more personal outbound numbers associated with a specified agent under a specified instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc1MRAID'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'Agent ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'agent@ccc-test', 'title' => ''], ], [ 'name' => 'NumberList', 'in' => 'query', 'schema' => ['description' => 'List of personal outbound numbers to delete. You can obtain the current list of personal outbound numbers associated with the agent by invoking ListPersonalNumbersOfUser.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["0101234****", "0105678****"]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => ''], ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Delete multiple numbers associated with an agent', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemovePersonalNumbersFromUser'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\"\\n}","type":"json"}]', ], 'RemovePhoneNumberFromSkillGroups' => [ 'summary' => 'You can invoke RemovePhoneNumberFromSkillGroups to delete the binding relationship between a specified phone number and one or more skill groups under a given instance. This operation removes only the association between the phone number and the skill groups, not the actual phone number itself.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccPBOQGO'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'Number', 'in' => 'query', 'schema' => ['description' => 'The phone number to detach.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0101234****', 'title' => ''], ], [ 'name' => 'SkillGroupIdList', 'in' => 'query', 'schema' => ['description' => 'List of skill group IDs to detach. Ensure that each skill group is already associated with the phone number.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["skillgroup1@ccc-test","skillgroup2@ccc-test"]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => ''], ['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid. %s', 'description' => ''], ['errorCode' => 'Parameter.Invalid', 'errorMessage' => 'The parameter %s is invalid. %s.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Detach a phone number from multiple skill groups', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemovePhoneNumberFromSkillGroups'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\"\\n}","type":"json"}]', ], 'RemovePhoneNumbers' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc1MRAID'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'NumberList', 'in' => 'query', 'schema' => ['description' => 'The list of numbers to remove.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["0101234****","0105678****"]', 'title' => ''], ], [ 'name' => 'Force', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to force the removal. If a number is associated with a skill group, contact flow, or agent, you must set this parameter to `true` to remove it. The default value is `false`.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], 'Data' => [ 'description' => 'The list of numbers that could not be removed.', 'type' => 'array', 'items' => ['description' => 'The number.', 'type' => 'string', 'example' => '0101234****', 'title' => ''], 'example' => '无', 'title' => '', ], 'Params' => [ 'description' => '', 'type' => 'array', 'items' => ['description' => 'The response parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Delete Phone Numbers', 'summary' => 'Removes one or more numbers from an instance. This action disassociates the numbers from the instance but does not permanently delete them. It also disassociates all associated resources, such as skill groups, contact flows, and agents.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-11-17T01:12:03.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemovePhoneNumbers'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": [\\n \\"0101234****\\"\\n ],\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', ], 'RemovePhoneNumbersFromSkillGroup' => [ 'summary' => 'You can invoke RemovePhoneNumbersFromSkillGroup to delete the association between one or more phone numbers and a specified skill group under a given instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccPBOQGO'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'NumberList', 'in' => 'query', 'schema' => ['description' => 'List of phone numbers.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["0101234****","0105678****"]', 'title' => ''], ], [ 'name' => 'SkillGroupId', 'in' => 'query', 'schema' => ['description' => 'Skill group ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'skillgroup@ccc-test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => ''], ['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid. %s', 'description' => ''], ['errorCode' => 'Parameter.Invalid', 'errorMessage' => 'The parameter %s is invalid. %s.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.SkillGroupId', 'errorMessage' => 'The skill group ID %s does not exist in instance %s.', 'description' => ''], ], ], 'title' => 'Delete multiple numbers associated with a skill group', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemovePhoneNumbersFromSkillGroup'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\"\\n}","type":"json"}]', ], 'RemoveSkillGroupsFromUser' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccPBOQGO'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'Agent ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'agent@ccc-test', 'title' => ''], ], [ 'name' => 'SkillGroupIdList', 'in' => 'query', 'schema' => ['description' => 'A list of skill group IDs to disassociate, formatted as a JSON array string, where each array element is a skill group ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["skillgroup1@ccc-test","skillgroup2@ccc-test"]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Data' => ['description' => 'Data.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Delete multiple skill groups associated with an agent', 'summary' => 'You can invoke RemoveSkillGroupsFromUser to delete the association between one or more skill groups and a specified agent under a specified instance.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveSkillGroupsFromUser'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\"\\n}","type":"json"}]', ], 'RemoveUsers' => [ 'summary' => 'You can invoke RemoveUsers to delete one or more agents from a specified instance. This operation only detaches the RAM accounts from the instance and removes the agents mapped to those RAM accounts from the instance. It does not delete the RAM accounts themselves.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'UserIdList', 'in' => 'query', 'schema' => ['description' => 'A JSON-formatted string representing an array of agent IDs. Each array element is an agent ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '["agent1@ccc-test","agent2@ccc-test"]', 'title' => ''], ], [ 'name' => 'Force', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to force delete.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'FilePath', 'in' => 'query', 'schema' => ['description' => 'The ObjectKey of the OSS object containing the file with the list of users to delete.', 'type' => 'string', 'required' => false, 'example' => 'temp/removeUsers.xlsx', 'title' => ''], ], [ 'name' => 'NotificationEmail', 'in' => 'query', 'schema' => ['description' => 'Notification email address.', 'type' => 'string', 'required' => false, 'example' => '123@abc.com', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], 'Params' => [ 'description' => 'Response parameters.', 'type' => 'array', 'items' => ['description' => 'Response parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Delete Agents', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-11-17T01:12:02.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-04-14T05:54:04.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveUsers'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', ], 'RemoveUsersFromSkillGroup' => [ 'summary' => 'You can invoke RemoveUsersFromSkillGroup to delete the association between one or more agents and a specified skill group under a specified instance. This operation only removes the association between the skill group and the agents and does not delete the agents themselves.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'SkillGroupId', 'in' => 'query', 'schema' => ['description' => 'Skill group ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'skillgroup@ccc-test', 'title' => ''], ], [ 'name' => 'UserIdList', 'in' => 'query', 'schema' => ['description' => 'List of agent IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["agent1@ccc-test","agent2@ccc-test"]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.SkillGroupId', 'errorMessage' => 'The skill group ID %s does not exist in instance %s.', 'description' => ''], ], ], 'title' => 'Delete multiple agents associated with a skill group', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveUsersFromSkillGroup'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\"\\n}","type":"json"}]', ], 'ResetAgentState' => [ 'summary' => 'Resets the state of a specific agent in a specific instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the Cloud Call Center (CCC) instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'The ID of the agent. This parameter is optional. If omitted, the agent mapped to the current RAM account is reset.', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test', 'title' => ''], ], [ 'name' => 'DeviceId', 'in' => 'query', 'schema' => ['description' => 'A string that identifies the device. The value is not processed by the system and can be any string.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Container for the response data.', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], 'Params' => [ 'description' => 'Reserved for future use.', 'type' => 'array', 'items' => ['description' => 'A reserved parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], 'Data' => [ 'description' => 'The response data.', 'type' => 'object', 'properties' => [ 'Extension' => ['description' => 'The agent\'s extension.', 'type' => 'string', 'example' => '8001****', 'title' => ''], 'WorkMode' => [ 'description' => 'The agent\'s work mode.', 'enumValueTitles' => ['ON_SITE' => 'On-site mode', 'OFF_SITE' => 'Off-site mode', 'OFFICE_PHONE' => 'Office phone mode'], 'type' => 'string', 'example' => 'ON_SITE', 'title' => '', ], 'DeviceId' => ['description' => 'The ID of the registered device, such as a browser-based WebRTC softphone or a physical phone. An agent can register only one device at a time.', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****', 'title' => ''], 'JobId' => ['description' => 'The ID of the call. This parameter is returned only if the agent is on a call.', 'type' => 'string', 'example' => '无', 'title' => ''], 'UserId' => ['description' => 'The ID of the agent.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'BreakCode' => [ 'description' => 'The reason code for the agent\'s break. This can be a system-defined or a custom code. System-defined codes include:', 'enumValueTitles' => ['RingingTimeout' => 'The agent did not answer a call before it timed out.', 'RejectCall' => 'The agent rejected an incoming call.', 'Warm-up' => 'A temporary break state that an agent enters after signing in and before becoming Ready.'], 'type' => 'string', 'example' => 'Warm-up', 'title' => '', ], 'InstanceId' => ['description' => 'The ID of the instance.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'OutboundScenario' => ['description' => 'Indicates whether the outbound-only mode is enabled for the agent.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'UserState' => [ 'description' => 'The current state of the agent.', 'enumValueTitles' => ['READY' => 'Available', 'WORKING' => 'After call work', 'DIALING' => 'Dialing', 'BREAK' => 'On break', 'OFFLINE' => 'Offline', 'TALKING' => 'On a call', 'RINGING' => 'Ringing'], 'type' => 'string', 'example' => 'OFFLINE', 'title' => '', ], 'SignedSkillGroupIdList' => [ 'description' => 'The IDs of the skill groups that the agent is signed in to.', 'type' => 'array', 'items' => ['description' => 'The ID of the skill group.', 'type' => 'string', 'example' => 'skillgroup@ccc-test', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => ''], ], ], 'title' => 'Reset agent status ', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-10-26T08:13:45.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetAgentState'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"Extension\\": \\"8001****\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"JobId\\": \\"无\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"UserState\\": \\"OFFLINE\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup@ccc-test\\"\\n ]\\n }\\n}","type":"json"}]', ], 'ResetUserPassword' => [ 'summary' => 'Invoke ResetUserPassword to reset the logon password of a specified agent under a specified instance. In practice, agents do not have logon passwords; this operation actually modifies the logon password of the RAM account associated with the agent. This is typically used in scenarios where a customer service representative forgets the logon password of their RAM account.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'Agent ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'agent@ccc-test', 'title' => ''], ], [ 'name' => 'Password', 'in' => 'query', 'schema' => ['description' => 'New password.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'password', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ], 403 => [ ['errorCode' => 'Permission.Role', 'errorMessage' => 'You have no permission to access role %s.', 'description' => ''], ], [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => ''], ['errorCode' => 'InternalService.RAM', 'errorMessage' => 'An internal RAM service error occurred. %s', 'description' => ''], ['errorCode' => 'InternalService.STS', 'errorMessage' => 'An internal STS service error occurred. %s', 'description' => ''], ], ], 'title' => 'Reset Agent Password', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetUserPassword'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\"\\n}","type":"json"}]', ], 'RestoreArchivedRecordings' => [ 'summary' => 'Restores call recordings for the specified instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccKYIENB'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Cloud Contact Center instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'ContactIds', 'in' => 'query', 'schema' => ['description' => 'List of contact IDs, in JSON format.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '[\\"job-216750038017142784\\"]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => 'Instance 0 does not exist.', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'F8066648-5D95-55AB-ACD3-2F4AD3BEA715', 'title' => ''], 'Data' => [ 'description' => 'Data.', 'type' => 'array', 'items' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'Exists' => ['description' => 'Is the recording file existing?', 'type' => 'string', 'example' => 'False', 'title' => ''], 'ContactId' => ['description' => 'Contact ID.', 'type' => 'string', 'example' => 'job-25920271311543****', 'title' => ''], 'Status' => ['description' => 'The recording\'s restored state. Values are Completed or Progressing.', 'type' => 'string', 'example' => 'Progressing', 'title' => ''], 'StorageType' => ['description' => 'Storage class of the recording file.', 'type' => 'string', 'example' => 'Standard', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Maximum', 'errorMessage' => 'The parameter %s must be less than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Minimum', 'errorMessage' => 'The parameter %s must be greater than or equal to %s.', 'description' => ''], ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s may not be null.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Restore Recording Files', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RestoreArchivedRecordings'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Instance 0 does not exist.\\",\\n \\"RequestId\\": \\"F8066648-5D95-55AB-ACD3-2F4AD3BEA715\\",\\n \\"Data\\": [\\n {\\n \\"Exists\\": \\"False\\",\\n \\"ContactId\\": \\"job-25920271311543****\\",\\n \\"Status\\": \\"Progressing\\",\\n \\"StorageType\\": \\"Standard\\"\\n }\\n ]\\n}","type":"json"}]', ], 'ResubmitTicket' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'TicketId', 'in' => 'query', 'schema' => ['description' => 'The ticket ID.', 'type' => 'string', 'required' => true, 'example' => 'f2c6722b-cd13-442d-bf10-22a07c70d6d5', 'title' => ''], ], [ 'name' => 'Comment', 'in' => 'query', 'schema' => ['description' => 'The handling comment.', 'type' => 'string', 'required' => false, 'example' => '信息已补充', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'CloseTicketResponse', 'title' => 'CloseTicketResponse ', 'type' => 'object', 'properties' => [ 'Data' => ['description' => 'Data.', 'type' => 'any', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Params' => [ 'description' => 'The list of error parameters.', 'type' => 'array', 'items' => ['description' => 'An error parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"03C67DAD-EB26-41D8-949D-9B0C470FB716\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', 'title' => 'Resubmit a ticket ', 'summary' => 'You can use the ResubmitTicket API to resubmit a rejected or returned ticket.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'ResumeCampaign' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccQFUGXR'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'CampaignId', 'in' => 'query', 'schema' => ['description' => 'The predictive outbound calling Activity ID.', 'type' => 'string', 'required' => true, 'example' => '6badb397-a8b5-40b6-21019d382a09', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F505C4C8-1E12-573A-9BA7-4BEAAD129553'], 'Code' => ['title' => 'code', 'description' => 'The response code.', 'type' => 'string', 'example' => 'OK'], 'Message' => ['title' => 'message', 'description' => 'The response message.', 'type' => 'string', 'example' => '无'], 'HttpStatusCode' => ['title' => 'httpStatusCode', 'description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200'], ], 'example' => '', ], ], ], 'title' => 'Recover Predictive Outbound Calling Activity', 'summary' => 'Invoke ResumeCampaign to recover the predictive outbound calling Activity corresponding to the specified ID under the specified instance.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResumeCampaign'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F505C4C8-1E12-573A-9BA7-4BEAAD129553\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', ], 'RetrieveCall' => [ 'summary' => 'You can invoke RetrieveCall to retrieve a call associated with a specified call ID under a specified instance. The call must be on hold for the retrieve operation to be performed.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'Agent ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test', 'title' => ''], ], [ 'name' => 'DeviceId', 'in' => 'query', 'schema' => ['description' => 'Device ID. This parameter is meaningless and can be filled with any value.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device', 'title' => ''], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'Call ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6538214103685****', 'title' => ''], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => ['description' => 'Channel ID of the call to retrieve.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ch:user:1390501****->8032****:1609138902226:job-6538214103685****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], 'Params' => [ 'description' => 'List of response parameters.', 'type' => 'array', 'items' => ['description' => 'Response parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'CallContext' => [ 'description' => 'Call context environment.', 'type' => 'object', 'properties' => [ 'CallType' => [ 'description' => 'Call type.', 'enumValueTitles' => [ 'INBOUND' => 'Inbound', 'BARGE' => 'Barge-in', 'CONSULTANT' => 'Consultation', 'CONFERENCE' => 'Conference', 'MONITOR' => 'Listener', 'INTERNAL' => 'Internal Call', 'OUTBOUND' => 'Outbound', 'INTERCEPT' => 'Intercept', 'BACK2BACK' => 'Back-to-Back Call', 'PREDICTIVE' => 'Predictive Outbound', 'COACH' => 'Coaching', ], 'type' => 'string', 'example' => 'OUTBOUND', 'title' => '', ], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'ChannelContexts' => [ 'description' => 'List of call channels.', 'type' => 'array', 'items' => [ 'description' => 'Call channel.', 'type' => 'object', 'properties' => [ 'ReleaseInitiator' => ['description' => 'The party that initiated the release of the call channel, indicating who first terminated the call.', 'type' => 'string', 'example' => '1390501****', 'title' => ''], 'ChannelState' => [ 'description' => 'The status of the call channel.', 'enumValueTitles' => ['CREATED' => 'Created', 'ANSWERED' => 'Answered', 'RELEASED' => 'Released', 'RETIRED' => 'Out Of Effect', 'EARLY_MEDIA' => 'Early Media', 'NONE' => 'Initial Status', 'RINGING' => 'Ringing'], 'type' => 'string', 'example' => 'CREATED', 'title' => '', ], 'Destination' => ['description' => 'Callee of the call channel.', 'type' => 'string', 'example' => '1390501****', 'title' => ''], 'UserId' => ['description' => 'The agent ID associated with the voice channel. This field is empty for Customer channels.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'SkillGroupId' => ['description' => 'The skill group ID associated with the channel. In inbound scenarios, the associated skill group ID is determined by the skill group configured in the IVR transfer-to-agent module. In outbound scenarios, the associated skill group ID is the ID of the first skill group the agent signed into.', 'type' => 'string', 'example' => 'skillgroup@ccc-test', 'title' => ''], 'Timestamp' => ['description' => 'The UNIX timestamp of the most recent status change of the channel, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315', 'title' => ''], 'ReleaseReason' => ['description' => 'The release reason of the call channel, indicating why the current call channel was released. The value is derived from the response codes defined in the SIP protocol. Customers can refer to the SIP protocol to analyze the release reason.', 'type' => 'string', 'example' => '404 - No destination', 'title' => ''], 'CallType' => [ 'description' => 'The call type of the channel.', 'enumValueTitles' => [ 'INBOUND' => 'Inbound', 'BARGE' => 'Barge', 'CONSULTANT' => 'Consultation', 'CONFERENCE' => 'Conference', 'MONITOR' => 'Listener', 'INTERNAL' => 'Internal Call', 'OUTBOUND' => 'Outbound', 'INTERCEPT' => 'Intercept', 'BACK2BACK' => 'Back-to-Back', 'PREDICTIVE' => 'Predictive outbound call', 'COACH' => 'Coaching', ], 'type' => 'string', 'example' => 'OUTBOUND', 'title' => '', ], 'JobId' => ['description' => 'The call ID.', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'ChannelId' => ['description' => 'The channel ID.', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****', 'title' => ''], 'Originator' => ['description' => 'The calling party of the voice channel.', 'type' => 'string', 'example' => '0830019****', 'title' => ''], 'UserExtension' => ['description' => 'The extension number of the agent associated with the channel.', 'type' => 'string', 'example' => '8032****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'UserContext' => [ 'description' => 'Agent context environment.', 'type' => 'object', 'properties' => [ 'Extension' => ['description' => 'The agent\'s extension number.', 'type' => 'string', 'example' => '8032****', 'title' => ''], 'Heartbeat' => ['description' => 'The time when the last heartbeat from the agent was received, in UNIX timestamp format, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378', 'title' => ''], 'WorkMode' => [ 'description' => 'Work mode.', 'enumValueTitles' => ['ON_SITE' => 'On-site mode', 'OFF_SITE' => 'Off-site mode', 'OFFICE_PHONE' => 'Office phone mode'], 'type' => 'string', 'example' => 'ON_SITE', 'title' => '', ], 'DeviceId' => ['description' => 'Device ID, the identity ID of a browser-based Web Real-Time Communication (WebRTC) softphone or a physical phone device. Only one type of device is allowed to register at a time.', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****', 'title' => ''], 'UserId' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'Reserved' => ['description' => 'The time when the agent was most recently reserved. Being reserved means an incoming call will be assigned to this agent shortly. The value is in UNIX timestamp format, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378', 'title' => ''], 'BreakCode' => [ 'description' => 'Break status code, which can be either System-defined or Custom-defined. System-defined break codes include: Warm-up (temporary break state after an agent is published and before becoming idle), RingingTimeout (break caused by agent ringing timeout), and RejectCall (break caused by agent rejecting a call). There are no restrictions on Custom-defined status codes; customers can define them according to their business needs.', 'enumValueTitles' => ['RingingTimeout' => 'Break due to agent ringing timeout', 'RejectCall' => 'Break due to agent call rejection', 'Warm-up' => 'Temporary break state after an agent is published and before becoming idle'], 'type' => 'string', 'example' => 'Warm-up', 'title' => '', ], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'OutboundScenario' => ['description' => 'Indicates whether the agent is in outbound-only mode.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Mobile' => ['description' => 'The agent\'s personal phone number.', 'type' => 'string', 'example' => '1324730****', 'title' => ''], 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'UserState' => [ 'description' => 'Agent status.', 'enumValueTitles' => ['READY' => 'Ready', 'WORKING' => 'Post-processing', 'DIALING' => 'Dialing', 'BREAK' => 'Break', 'OFFLINE' => 'Offline', 'TALKING' => 'Talking', 'RINGING' => 'Ringing'], 'type' => 'string', 'example' => 'BREAK', 'title' => '', ], 'SignedSkillGroupIdList' => [ 'description' => 'List of skill group IDs that the agent has signed into.', 'type' => 'array', 'items' => ['description' => 'Skill group ID.', 'type' => 'string', 'example' => 'skillgroup1@ccc-test', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ['errorCode' => 'InvalidOperation.ChannelState', 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', 'description' => ''], ['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.ChannelId', 'errorMessage' => 'The specified channel %s does not exist in call %s.', 'description' => ''], ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => ''], ], ], 'title' => 'Retrieve a call', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-10-26T08:13:45.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RetrieveCall'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"CREATED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"Originator\\": \\"0830019****\\",\\n \\"UserExtension\\": \\"8032****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"BREAK\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","type":"json"}]', ], 'SaveDocument' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'parameters' => [ [ 'name' => 'SchemaId', 'in' => 'formData', 'schema' => ['description' => 'schema id', 'type' => 'string', 'required' => true, 'example' => 'profile', 'title' => ''], ], [ 'name' => 'DocumentId', 'in' => 'formData', 'schema' => ['description' => 'Document ID', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], ], [ 'name' => 'DocumentJson', 'in' => 'formData', 'schema' => ['description' => 'The document content to save. It must conform to the rules defined in the schema.', 'type' => 'string', 'required' => true, 'example' => '{"name":"tom"}', 'title' => ''], ], [ 'name' => 'RequestId', 'in' => 'formData', 'schema' => ['description' => 'Request ID', 'type' => 'string', 'required' => false, 'example' => 'EAF3C248-E123-441B-A545-B6CD02E98EED', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'SaveDocumentResponse', 'title' => 'SaveDocumentResponse', 'type' => 'object', 'properties' => [ 'Data' => ['description' => 'Data.', 'type' => 'string', 'example' => '0101234****', 'title' => ''], 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '01B12EE4-6AF2-4730-8B78-EC15F4E5C025', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'Response message', 'type' => 'string', 'example' => '无', 'title' => ''], 'Params' => [ 'description' => 'Response parameters.', 'type' => 'array', 'items' => ['description' => 'Response parameters.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"0101234****\\",\\n \\"RequestId\\": \\"01B12EE4-6AF2-4730-8B78-EC15F4E5C025\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', 'title' => 'Save Document', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'summary' => '', ], 'SaveRTCStatsV2' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '50605', 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'CallId', 'in' => 'query', 'schema' => ['description' => 'Call ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '257e73de-1ee8-123b-0b9a-00163e0a****', 'title' => ''], ], [ 'name' => 'GeneralInfo', 'in' => 'query', 'schema' => ['description' => 'General information.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[null,"","","1647337928819","1647337888816","agent",null,"上海","10.10.XX.XX","11.1.XX.XX","2002"]', 'title' => ''], ], [ 'name' => 'SenderReport', 'in' => 'query', 'schema' => ['description' => 'Content of the sender report.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["11090","2055127460","0","2236","384592","ssrc_2055127460_send","2022-03-15T09:52:08.820Z","1"]', 'title' => ''], ], [ 'name' => 'ReceiverReport', 'in' => 'query', 'schema' => ['description' => 'Content of the receiver report.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["1","1649328987","40","PCMU","383560","89","49","ssrc_1649328987_recv","2022-03-15T09:52:08.820Z","","0","20000"]', 'title' => ''], ], [ 'name' => 'GoogAddress', 'in' => 'query', 'schema' => ['description' => 'Access point address.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["47.101.XX.XX","44368","47.104.XX.XX","37947"]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', 'title' => ''], 'Success' => ['description' => 'Indicates whether the operation succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'TimeStamp' => ['description' => 'Time when the record was generated, in Unix timestamp format, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1647309061000', 'title' => ''], 'RowCount' => ['description' => 'Number of rows.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'Permission.User', 'errorMessage' => 'You have no permission to access user(s) %s.', 'description' => ''], ], [ ['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => ''], ], ], 'title' => 'Report Agent-Side WebRTC Statistics Information ', 'summary' => 'Invoke SaveRTCStatsV2 to report Web Real-Time Communication (WebRTC) voice transmission statistics information from the agent side. This API is not relevant for regular customers.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"TimeStamp\\": 1647309061000,\\n \\"RowCount\\": 1\\n}","type":"json"}]', ], 'SaveTerminalLog' => [ 'summary' => 'Invoke the SaveTerminalLog API to report agent-side log information. Regular customers do not need to be concerned with this API.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '50606', 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'CallId', 'in' => 'query', 'schema' => ['description' => 'The CallId of the call channel, generated by the SIP protocol. Each SIP call has a unique CallId.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'e13c9740-1e37-123b-21b6-00163e352f9', 'title' => ''], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The call ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-b8b0ca63-330c-4e65-8ae3-9de2c7ce7683', 'title' => ''], ], [ 'name' => 'AppName', 'in' => 'query', 'schema' => ['description' => 'The AppName.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'CCCClient', 'title' => ''], ], [ 'name' => 'DataType', 'in' => 'query', 'schema' => ['description' => 'The data type. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '0', 'example' => '1', 'title' => ''], ], [ 'name' => 'Content', 'in' => 'query', 'schema' => ['description' => 'The content information.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'none', 'title' => ''], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => ['description' => 'The status information, either true or false.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'true', 'title' => ''], ], [ 'name' => 'UniqueRequestId', 'in' => 'query', 'schema' => ['description' => 'The method request ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'none', 'title' => ''], ], [ 'name' => 'MethodName', 'in' => 'query', 'schema' => ['description' => 'The method name.', 'type' => 'string', 'required' => false, 'example' => 'TurnServerTest', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', 'title' => ''], 'Success' => ['description' => 'Indicates whether the operation succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'TimeStamp' => ['description' => 'The time when the log was generated, in UNIX timestamp format, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1647309061000', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid. %s', 'description' => ''], ], 403 => [ ['errorCode' => 'Permission.Unauthorized', 'errorMessage' => 'You are not authorized to perform this action. %s privileges are required.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => ''], ], ], 'title' => 'Save Agent-Side Log Information', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SaveTerminalLog'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"TimeStamp\\": 1647309061000\\n}","type":"json"}]', ], 'SaveWebRTCStats' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '50608', 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'CallId', 'in' => 'query', 'schema' => ['description' => 'The call ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '257e73de-1ee8-123b-0b9a-00163e0a****', 'title' => ''], ], [ 'name' => 'GeneralInfo', 'in' => 'query', 'schema' => ['description' => 'General information.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[null,"","","1647337928819","1647337888816","agent",null,"上海","10.10.XX.XX","11.1.XX.XX","2002"]', 'title' => ''], ], [ 'name' => 'SenderReport', 'in' => 'query', 'schema' => ['description' => 'The content of the sender report.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["11090","2055127460","0","2236","384592","ssrc_2055127460_send","2022-03-15T09:52:08.820Z","1"]', 'title' => ''], ], [ 'name' => 'ReceiverReport', 'in' => 'query', 'schema' => ['description' => 'The content of the receiver report.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["1","1649328987","40","PCMU","383560","89","49","ssrc_1649328987_recv","2022-03-15T09:52:08.820Z","","0","20000"]', 'title' => ''], ], [ 'name' => 'GoogAddress', 'in' => 'query', 'schema' => ['description' => 'The access point address.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["47.101.XX.XX","44368","47.104.XX.XX","37947"]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'CF1C21B9-2D49-4B54-880F-FBE248C16903', 'title' => ''], 'Success' => ['description' => 'Indicates whether the operation succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'TimeStamp' => ['description' => 'The time when the record was generated, in Unix timestamp format, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1555492246000', 'title' => ''], 'RowCount' => ['description' => 'The number of rows.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'Permission.User', 'errorMessage' => 'You have no permission to access user(s) %s.', 'description' => ''], ], [ ['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => ''], ], ], 'title' => 'Report Agent-Side WebRTC Statistics Information', 'summary' => 'Invoke the SaveWebRTCStats API to report Web Real-Time Communication (WebRTC) voice transmission statistics information from the agent side. Regular customers do not need to concern themselves with this API.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"CF1C21B9-2D49-4B54-880F-FBE248C16903\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"TimeStamp\\": 1555492246000,\\n \\"RowCount\\": 1\\n}","type":"json"}]', ], 'SaveWebRtcInfo' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '50607', 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'CallId', 'in' => 'query', 'schema' => ['description' => 'The CallId of the call channel, generated by the SIP protocol. Each SIP call has a unique CallId.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'e13c9740-1e37-123b-21b6-00163e352f9', 'title' => ''], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The call ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-b8b0ca63-330c-4e65-8ae3-9de2c7ce7683', 'title' => ''], ], [ 'name' => 'ContentType', 'in' => 'query', 'schema' => ['description' => 'The reporting content. The value comes from the voice transmission quality data obtained via rtcPeerConnection.getStats(selector) in the frontend WebRTC. This parameter is used only on the public cloud platform of Cloud Contact Center and does not require attention from integration customers.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '4', 'title' => ''], ], [ 'name' => 'Content', 'in' => 'query', 'schema' => ['description' => 'The reporting content information. This parameter is used only on the public cloud platform of Cloud Contact Center and does not require attention from integration customers.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"media_source":{},"remote_inbound_rtp":{},"outbound_rtp":{},"inbound_rtp":{},"remote_outbound_rtp":{},"candidate":{},"basic":{"callId":"e13c9740-1e37-123b-21b6-00163e352f9","timestamp":"1647262108395","callStartTime":"1647262108393","uid":"user-test","access_point":"shanghai","browser":"90","ip":"127.0.0.1"}}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'CF1C21B9-2D49-4B54-880F-FBE248C16903', 'title' => ''], 'Success' => ['description' => 'Indicates whether the operation succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'TimeStamp' => ['description' => 'The time when the information was stored, formatted as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1647262108395', 'title' => ''], 'RowCount' => ['description' => 'The number of rows returned upon data storage, indicating how many records were successfully written. If this value is not 1, an abnormal condition may have occurred and requires attention.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'Permission.User', 'errorMessage' => 'You have no permission to access user(s) %s.', 'description' => ''], ], [ ['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.Common', 'errorMessage' => 'An internal service error occurred. %s', 'description' => ''], ], ], 'title' => 'Report WebRTC Status Information'."\n", 'summary' => 'Invoke the SaveWebRtcInfo API to report WebRTC call status information from the agent side, including call quality monitoring data, for backend statistics and monitoring. Customers do not need to concern themselves with this API.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"CF1C21B9-2D49-4B54-880F-FBE248C16903\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"TimeStamp\\": 1647262108395,\\n \\"RowCount\\": 1\\n}","type":"json"}]', ], 'SendDtmfSignaling' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'The agent ID that sends DTMF.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test', 'title' => ''], ], [ 'name' => 'DeviceId', 'in' => 'query', 'schema' => ['description' => 'Device ID. This parameter is meaningless and can be filled with any value.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device', 'title' => ''], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The call ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-6573574060089****', 'title' => ''], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => ['description' => 'The channel ID of the call to which DTMF tones are to be sent.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ch:customer:0108989****->1318888****:1609234221870:job-6573574060089****', 'title' => ''], ], [ 'name' => 'Dtmf', 'in' => 'query', 'schema' => ['description' => 'DTMF key information, which refers to the keys on a dial pad, including 0–9, \\*, and #.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'maxLength' => 1000000, 'minLength' => 0, 'example' => '5', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '842399EC-7D32-4472-AD08-9504C3F141FF', 'title' => ''], 'Params' => [ 'description' => 'List of response parameters.', 'type' => 'array', 'items' => ['description' => 'Response parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'CallContext' => [ 'description' => 'Call context environment.', 'type' => 'object', 'properties' => [ 'CallType' => [ 'description' => 'Call type.', 'enumValueTitles' => [ 'INBOUND' => 'Inbound', 'BARGE' => 'Barge-in', 'CONSULTANT' => 'Consultation', 'CONFERENCE' => 'Conference', 'MONITOR' => 'Listener', 'INTERNAL' => 'Internal Call', 'OUTBOUND' => 'Outbound', 'INTERCEPT' => 'Intercept', 'BACK2BACK' => 'Back-to-Back Call', 'PREDICTIVE' => 'Predictive Outbound', 'COACH' => 'Coaching', ], 'type' => 'string', 'example' => 'OUTBOUND', 'title' => '', ], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-6573574060089****', 'title' => ''], 'ChannelContexts' => [ 'description' => 'List of call channels.', 'type' => 'array', 'items' => [ 'description' => 'Call channel.', 'type' => 'object', 'properties' => [ 'Index' => ['description' => 'An auto-increment ID assigned by the system. Customers do not need to concern themselves with this value.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'ReleaseInitiator' => ['description' => 'The party that initiated the release of the call channel, indicating who first hung up the call.', 'type' => 'string', 'example' => '无', 'title' => ''], 'ChannelState' => [ 'description' => 'The status of the call channel.', 'enumValueTitles' => ['CREATED' => 'Created', 'ANSWERED' => 'Answered', 'RELEASED' => 'Released', 'RETIRED' => 'Out Of Effect', 'EARLY_MEDIA' => 'Early Media', 'NONE' => 'Initial Status', 'RINGING' => 'Ringing'], 'type' => 'string', 'example' => 'ANSWERED', 'title' => '', ], 'Destination' => ['description' => 'Callee of the call channel.', 'type' => 'string', 'example' => '8001****', 'title' => ''], 'UserId' => ['description' => 'The agent ID associated with the channel. This field is empty if the channel belongs to a Customer.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'ChannelFlags' => [ 'description' => 'Channel flags.', 'enumValueTitles' => ['COACHING' => 'Coaching', 'MONITORING' => 'Monitoring', 'MONITORED' => 'Monitored', 'COACHED' => 'Coached', 'HOLD' => 'Hold', 'MUTED' => 'Muted'], 'type' => 'string', 'example' => 'MONITORING', 'title' => '', ], 'SkillGroupId' => ['description' => 'The skill group ID associated with the voice channel. In inbound scenarios, the associated skill group ID is determined by the skill group configured in the IVR transfer-to-agent module. In outbound scenarios, the associated skill group ID is the first skill group that the agent signed into.', 'type' => 'string', 'example' => 'skillgroup@ccc-test', 'title' => ''], 'Timestamp' => ['description' => 'The UNIX timestamp of the most recent status change of the voice channel, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609234222367', 'title' => ''], 'ReleaseReason' => ['description' => 'The release reason for the voice channel, indicating why the current voice channel was disconnected. The value corresponds to response codes defined in the SIP protocol. Customers should refer to the SIP protocol to analyze the disconnection reason.', 'type' => 'string', 'example' => '无', 'title' => ''], 'CallType' => [ 'description' => 'The call type of the channel.', 'enumValueTitles' => [ 'INBOUND' => 'Inbound', 'BARGE' => 'Barge', 'CONSULTANT' => 'Consultation', 'CONFERENCE' => 'Conference', 'MONITOR' => 'Listener', 'INTERNAL' => 'Internal Call', 'OUTBOUND' => 'Outbound', 'INTERCEPT' => 'Intercept', 'BACK2BACK' => 'Back-to-Back Call', 'PREDICTIVE' => 'Predictive Outbound', 'COACH' => 'Coaching', ], 'type' => 'string', 'example' => 'OUTBOUND', 'title' => '', ], 'JobId' => ['description' => 'The call ID.', 'type' => 'string', 'example' => 'job-6573574060089****', 'title' => ''], 'ChannelId' => ['description' => 'The voice channel ID.', 'type' => 'string', 'example' => 'ch:user:131888****->8001****:1609234221870:job-6573574060089****', 'title' => ''], 'UserExtension' => ['description' => 'The extension number of the agent associated with the channel.', 'type' => 'string', 'example' => '8001****', 'title' => ''], 'Originator' => ['description' => 'The originator of the channel.', 'type' => 'string', 'example' => '0101234****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'UserContext' => [ 'description' => 'Agent context environment.', 'type' => 'object', 'properties' => [ 'Extension' => ['description' => 'The agent\'s extension number.', 'type' => 'string', 'example' => '8001****', 'title' => ''], 'Heartbeat' => ['description' => 'The time when the last heartbeat was received from the agent, in UNIX timestamp format, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609234222375', 'title' => ''], 'WorkMode' => [ 'description' => 'Work mode.', 'enumValueTitles' => ['ON_SITE' => 'On-site mode', 'OFF_SITE' => 'Off-site mode', 'OFFICE_PHONE' => 'Office phone mode'], 'type' => 'string', 'example' => 'ON_SITE', 'title' => '', ], 'DeviceId' => ['description' => 'Device ID, the identity ID of a browser-based Web Real-Time Communication (WebRTC) softphone or a physical phone device. Only one type of device can be registered at a time.', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****', 'title' => ''], 'UserId' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'Reserved' => ['description' => 'The most recent time when the agent was reserved. Being reserved means an incoming call will be assigned to the agent shortly. The value is in UNIX timestamp format, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609234221864', 'title' => ''], 'BreakCode' => [ 'description' => 'Break status code, which can be either System-defined or Custom-defined. System-defined break codes include: Warm-up (temporary break state after an agent is published and before becoming idle), RingingTimeout (break caused by agent ringing timeout), and RejectCall (break caused by agent rejecting a call). There are no restrictions on Custom-defined status codes; customers can define them according to their business needs.', 'enumValueTitles' => ['RingingTimeout' => 'Break caused by agent ringing timeout', 'RejectCall' => 'Break caused by agent rejecting a call', 'Warm-up' => 'Temporary break state after an agent is published and before becoming idle'], 'type' => 'string', 'example' => 'Warm-up', 'title' => '', ], 'InstanceId' => ['description' => 'instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'OutboundScenario' => ['description' => 'Indicates whether the agent is in outbound-only mode.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Mobile' => ['description' => 'The agent\'s personal phone number.', 'type' => 'string', 'example' => '1390000****', 'title' => ''], 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-6573574060089****', 'title' => ''], 'UserState' => [ 'description' => 'Agent status.', 'enumValueTitles' => ['READY' => 'empty', 'WORKING' => 'post-processing', 'DIALING' => 'dial-up', 'BREAK' => 'break', 'OFFLINE' => 'offline', 'TALKING' => 'talking', 'RINGING' => 'ringing'], 'type' => 'string', 'example' => 'TALKING', 'title' => '', ], 'SignedSkillGroupIdList' => [ 'description' => 'List of skill group IDs that the agent has signed into.', 'type' => 'array', 'items' => ['description' => 'Skill group ID.', 'type' => 'string', 'example' => 'skillgroup1@ccc-test', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'InvalidOperation.ChannelState', 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', 'description' => ''], ['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.ChannelId', 'errorMessage' => 'The specified channel %s does not exist in call %s.', 'description' => ''], ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => ''], ], ], 'title' => 'Send DTMF information ', 'summary' => 'You can invoke SendDtmfSignaling to send DTMF keypress information during a call.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-10-26T08:13:45.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendDtmfSignaling'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"842399EC-7D32-4472-AD08-9504C3F141FF\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6573574060089****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 1,\\n \\"ReleaseInitiator\\": \\"无\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"8001****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609234222367,\\n \\"ReleaseReason\\": \\"无\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6573574060089****\\",\\n \\"ChannelId\\": \\"ch:user:131888****->8001****:1609234221870:job-6573574060089****\\",\\n \\"UserExtension\\": \\"8001****\\",\\n \\"Originator\\": \\"0101234****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8001****\\",\\n \\"Heartbeat\\": 1609234222375,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609234221864,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1390000****\\",\\n \\"JobId\\": \\"job-6573574060089****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","type":"json"}]', ], 'SignInGroup' => [ 'summary' => 'You can invoke SignInGroup to sign an agent into a specified skill group under a specified instance, which is the operation for publishing the agent online.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'Agent ID. If not specified, the agent mapped to the current Resource Access Management (RAM) user is used by default.', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test', 'title' => ''], ], [ 'name' => 'DeviceId', 'in' => 'query', 'schema' => ['description' => 'Voice device ID. When multiple voice devices are active, use this parameter to specify one of them, such as a browser Web Real-Time Communication (WebRTC) endpoint or a SIP phone.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'CCC-xx.xx.xx.xx-chrome119-bse1b618bff3xxxxd', 'title' => ''], ], [ 'name' => 'SignedSkillGroupIdList', 'in' => 'query', 'schema' => ['description' => 'List of skill group IDs to sign in to, formatted as a JSON array string, where each array element is a skill group ID.', 'type' => 'string', 'required' => true, 'example' => '["skillgroup1@ccc-test","skillgroup2@ccc-test"]', 'title' => ''], ], [ 'name' => 'ChatDeviceId', 'in' => 'query', 'schema' => ['description' => 'Chat device ID.', 'type' => 'string', 'required' => false, 'example' => '4c51c9116c36537cb850dc1081d745df', 'title' => ''], ], [ 'name' => 'Additivity', 'in' => 'query', 'schema' => ['description' => 'If an agent has already signed in to some skill groups, setting this parameter to true allows the agent to sign in to additional skill groups.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], 'Params' => [ 'description' => 'List of response parameters.', 'type' => 'array', 'items' => ['description' => 'Response parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'Extension' => ['description' => 'Agent extension number.', 'type' => 'string', 'example' => '8032****', 'title' => ''], 'WorkMode' => [ 'description' => 'Work mode.', 'enumValueTitles' => ['ON_SITE' => 'On-site mode', 'OFF_SITE' => 'Off-site mode', 'OFFICE_PHONE' => 'Office phone mode'], 'type' => 'string', 'example' => 'ON_SITE', 'title' => '', ], 'DeviceId' => ['description' => 'Device ID, which is the identity of a browser Web Real-Time Communication (WebRTC) softphone or a physical phone device. Only one type of device can be registered at a time.', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****'."\n", 'title' => ''], 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => '无', 'title' => ''], 'UserId' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'BreakCode' => [ 'description' => 'Break status code, which can be either system-defined or customer-defined. System-defined break codes include: Warm-up (temporary break state after agent is published and before becoming idle), RingingTimeout (break caused by agent ringing timeout), and RejectCall (break caused by agent call rejection). There are no restrictions on customer-defined status codes; customers can define them as needed for their business.', 'enumValueTitles' => ['RingingTimeout' => 'Break caused by agent ringing timeout', 'RejectCall' => 'Break caused by agent call rejection', 'Warm-up' => 'Temporary break state after agent is published and before becoming idle'], 'type' => 'string', 'example' => 'Warm-up', 'title' => '', ], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'OutboundScenario' => ['description' => 'Indicates whether the agent is in outbound-only mode.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'UserState' => [ 'description' => 'Agent status.', 'enumValueTitles' => ['READY' => 'Idle', 'WORKING' => 'Post-processing', 'DIALING' => 'Dialing', 'BREAK' => 'Break', 'OFFLINE' => 'Offline', 'TALKING' => 'In a call', 'RINGING' => 'Ringing'], 'type' => 'string', 'example' => 'READY', 'title' => '', ], 'SignedSkillGroupIdList' => [ 'description' => 'List of skill group IDs that the agent has signed into.', 'type' => 'array', 'items' => ['description' => 'Skill group ID.', 'type' => 'string', 'example' => 'skillgroup1@ccc-test', 'title' => ''], 'title' => '', 'example' => '', ], 'ChatDeviceId' => ['description' => 'Chat device ID.', 'type' => 'string', 'example' => '4c51c9116c36537cb850dc1081d745df', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => ''], ], ], 'title' => 'Sign in to a skill group', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SignInGroup'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\\\n\\",\\n \\"JobId\\": \\"无\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"UserState\\": \\"READY\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ],\\n \\"ChatDeviceId\\": \\"4c51c9116c36537cb850dc1081d745df\\"\\n }\\n}","type":"json"}]', ], 'SignOutGroup' => [ 'summary' => 'You can call SignOutGroup to check out an agent from the skill group they are currently signed into, which is equivalent to performing an unpublish operation for the agent.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'Agent ID. If not specified, the agent mapped to the current Resource Access Management (RAM) user is used by default.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test', 'title' => ''], ], [ 'name' => 'DeviceId', 'in' => 'query', 'schema' => ['description' => 'Device ID. This parameter is meaningless and can be filled with any value.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => '200', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], 'Params' => [ 'description' => 'List of response parameters.', 'type' => 'array', 'items' => ['description' => 'Response parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'Extension' => ['description' => 'Agent extension number.', 'type' => 'string', 'example' => '8032****', 'title' => ''], 'Heartbeat' => ['description' => 'Time of the last received agent heartbeat, formatted as a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378', 'title' => ''], 'WorkMode' => [ 'description' => 'Work mode.', 'enumValueTitles' => ['ON_SITE' => 'On-site mode', 'OFF_SITE' => 'Off-site mode', 'OFFICE_PHONE' => 'Office phone mode'], 'type' => 'string', 'example' => 'ON_SITE', 'title' => '', ], 'DeviceId' => ['description' => 'Device ID, which is the identity of a browser-based Web Real-Time Communication (WebRTC) softphone or a physical phone device. Only one type of device can be registered at a time.', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****', 'title' => ''], 'UserId' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'Reserved' => ['description' => 'The UNIX timestamp (in milliseconds) indicating the most recent time the agent was reserved. Being reserved means an incoming call will be assigned to the agent shortly.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378', 'title' => ''], 'BreakCode' => [ 'description' => 'Break status code, which can be either System-defined or Custom-defined. System-defined break codes include: Warm-up (temporary break status after the agent is published but before becoming idle), RingingTimeout (break caused by ringing timeout), and RejectCall (break caused by the agent rejecting a call). There are no restrictions on Custom-defined status codes; customers can define them according to their business needs.', 'enumValueTitles' => ['RingingTimeout' => 'Break caused by agent ringing timeout', 'RejectCall' => 'Break caused by agent rejecting a call', 'Warm-up' => 'Temporary break status after agent is published but before becoming idle'], 'type' => 'string', 'example' => 'Warm-up', 'title' => '', ], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'OutboundScenario' => ['description' => 'Indicates whether the agent is in outbound-only mode.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Mobile' => ['description' => 'The agent\'s personal phone number.', 'type' => 'string', 'example' => '1324730****', 'title' => ''], 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'UserState' => [ 'description' => 'Agent status.', 'enumValueTitles' => ['READY' => 'Ready', 'WORKING' => 'Post-processing', 'DIALING' => 'Dialing', 'BREAK' => 'Break', 'OFFLINE' => 'Offline', 'TALKING' => 'Talking', 'RINGING' => 'Ringing'], 'type' => 'string', 'example' => 'BREAK', 'title' => '', ], 'SignedSkillGroupIdList' => [ 'description' => 'List of skill group IDs that the agent has signed into.', 'type' => 'array', 'items' => ['description' => 'Skill group ID.', 'type' => 'string', 'example' => 'skillgroup1@ccc-test', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ['errorCode' => 'InvalidOperation.ChannelState', 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', 'description' => ''], ['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => ''], ], ], 'title' => 'Check out of a skill group ', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-10-26T08:13:45.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SignOutGroup'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"BREAK\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n}","type":"json"}]', ], 'StartBack2BackCall' => [ 'summary' => 'You can invoke StartBack2BackCall to initiate a back-to-back call.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'Caller', 'in' => 'query', 'schema' => ['description' => 'Caller number.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1391814****', 'title' => ''], ], [ 'name' => 'Callee', 'in' => 'query', 'schema' => ['description' => 'The callee number.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1372168****', 'title' => ''], ], [ 'name' => 'TimeoutSeconds', 'in' => 'query', 'schema' => ['description' => 'The timeout for the dual-call, in seconds. If the call is not answered within the specified time, it will be automatically disconnected. This parameter is optional and defaults to 30 seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '3600', 'minimum' => '0', 'example' => '30', 'title' => ''], ], [ 'name' => 'Broker', 'in' => 'query', 'schema' => ['description' => 'The intermediate number, which must be an active outbound number under the instance. This number is used to sequentially call the caller and the callee in a double-call scenario.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0102157****', 'title' => ''], ], [ 'name' => 'AdditionalBroker', 'in' => 'query', 'schema' => ['description' => 'Additional intermediate number. If this parameter is provided, the intermediate number specified by the Broker parameter is used to call the caller, and the number specified by this parameter is used to call the callee. This parameter is optional and defaults to empty.', 'type' => 'string', 'required' => false, 'example' => '0102156****', 'title' => ''], ], [ 'name' => 'Tags', 'in' => 'query', 'schema' => ['description' => 'Ingest endpoint data. It must not exceed 128 bytes and is primarily used for extension purposes. Ordinary customers do not need to concern themselves with it.', 'type' => 'string', 'required' => false, 'example' => '无', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '26A34338-5CD9-4C95-A7A6-5BDCE76C6B94', 'title' => ''], 'Params' => [ 'description' => 'List of response parameters.', 'type' => 'array', 'items' => ['description' => 'Response parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'CallContext' => [ 'description' => 'The call context environment.', 'type' => 'object', 'properties' => [ 'CallType' => [ 'description' => 'The call type.', 'enumValueTitles' => [ 'INBOUND' => 'Inbound', 'BARGE' => 'Barge-in', 'CONSULTANT' => 'Consultation', 'CONFERENCE' => 'Conference', 'MONITOR' => 'Monitor', 'INTERNAL' => 'Internal Call', 'OUTBOUND' => 'Outbound', 'INTERCEPT' => 'Intercept', 'BACK2BACK' => 'Back-to-Back Call', 'PREDICTIVE' => 'Predictive Outbound', 'COACH' => 'Coaching', ], 'type' => 'string', 'example' => 'BACK2BACK', 'title' => '', ], 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-1034159089076****', 'title' => ''], 'ChannelContexts' => [ 'description' => 'List of call channels.', 'type' => 'array', 'items' => [ 'description' => 'Call channel.', 'type' => 'object', 'properties' => [ 'ReleaseInitiator' => ['description' => 'The party that initiated the release of the voice channel, indicating who first disconnected the channel.', 'type' => 'string', 'example' => '无', 'title' => ''], 'ChannelState' => [ 'description' => 'The status of the voice channel.', 'enumValueTitles' => ['CREATED' => 'Created', 'ANSWERED' => 'Answered', 'RELEASED' => 'Released', 'RETIRED' => 'Out Of Effect', 'EARLY_MEDIA' => 'Early Media', 'NONE' => 'Initial Status', 'RINGING' => 'Ringing'], 'type' => 'string', 'example' => 'NONE', 'title' => '', ], 'Destination' => ['description' => 'The called party of the call channel.', 'type' => 'string', 'example' => '1372168****', 'title' => ''], 'UserId' => ['description' => 'The agent ID associated with the voice channel. This field is empty if the channel belongs to a Customer.', 'type' => 'string', 'example' => '无', 'title' => ''], 'ChannelFlags' => [ 'description' => 'Flags of the voice channel.', 'enumValueTitles' => ['COACHING' => 'COACHING', 'MONITORING' => 'MONITORING', 'MONITORED' => 'MONITORED', 'COACHED' => 'COACHED', 'HOLD' => 'HOLD', 'MUTED' => 'MUTED'], 'type' => 'string', 'example' => 'MONITORING', 'title' => '', ], 'Timestamp' => ['description' => 'The UNIX timestamp indicating the most recent status change of the channel, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1618217874062', 'title' => ''], 'ReleaseReason' => ['description' => 'The reason for releasing the voice channel, indicating why the current voice channel was disconnected. The value is derived from the response codes defined in the SIP protocol. Customers should refer to the SIP protocol to analyze the disconnection reason.', 'type' => 'string', 'example' => '无', 'title' => ''], 'CallType' => [ 'description' => 'The call type of the channel.', 'enumValueTitles' => [ 'INBOUND' => 'INBOUND', 'BARGE' => 'BARGE', 'CONSULTANT' => 'CONSULTANT', 'CONFERENCE' => 'CONFERENCE', 'MONITOR' => 'MONITOR', 'INTERNAL' => 'INTERNAL', 'OUTBOUND' => 'OUTBOUND', 'INTERCEPT' => 'INTERCEPT', 'BACK2BACK' => 'BACK2BACK', 'PREDICTIVE' => 'PREDICTIVE', 'COACH' => 'COACH', ], 'type' => 'string', 'example' => 'BACK2BACK', 'title' => '', ], 'JobId' => ['description' => 'The call ID.', 'type' => 'string', 'example' => 'job-1034159089076****', 'title' => ''], 'ChannelId' => ['description' => 'The channel ID.', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-653821410368****', 'title' => ''], 'Originator' => ['description' => 'The originator of the voice channel', 'type' => 'string', 'example' => '0102157****', 'title' => ''], 'UserExtension' => ['description' => 'The extension number of the agent associated with the channel.', 'type' => 'string', 'example' => '8001****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'UserContext' => [ 'description' => 'Agent context environment.', 'type' => 'object', 'properties' => [ 'Extension' => ['description' => 'Agent extension number.', 'type' => 'string', 'example' => '8020****', 'title' => ''], 'Heartbeat' => ['description' => 'The time when the last heartbeat from the agent was received, in Unix timestamp format, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1618217872911', 'title' => ''], 'WorkMode' => [ 'description' => 'Work mode.', 'enumValueTitles' => ['ON_SITE' => 'On-site mode', 'OFF_SITE' => 'Off-site mode', 'OFFICE_PHONE' => 'Office phone mode'], 'type' => 'string', 'example' => 'ON_SITE', 'title' => '', ], 'DeviceId' => ['description' => 'Device ID, which is the identity of a browser-based Web Real-Time Communication (WebRTC) softphone or a physical phone device. Only one type of device can be registered at a time.', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****', 'title' => ''], 'UserId' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'Reserved' => ['description' => 'The UNIX timestamp (in milliseconds) indicating when the agent was most recently reserved. Being reserved means an incoming call will be assigned to the agent shortly.', 'type' => 'integer', 'format' => 'int64', 'example' => '1618217794599', 'title' => ''], 'BreakCode' => [ 'description' => 'Break status code, which can be either system-defined or customer-defined. System-defined break codes include: Warm-up (temporary break state after the agent is published and before becoming idle), RingingTimeout (break caused by agent ringing timeout), and RejectCall (break caused by agent call rejection). There are no restrictions on customer-defined status codes; customers can define them as needed for their business.', 'enumValueTitles' => ['RingingTimeout' => 'Break caused by agent ringing timeout', 'RejectCall' => 'Break caused by agent call rejection', 'Warm-up' => 'Temporary break state after agent is published and before becoming idle'], 'type' => 'string', 'example' => 'Warm-up', 'title' => '', ], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'OutboundScenario' => ['description' => 'Indicates whether the agent is in outbound-only mode.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'DeviceState' => [ 'description' => 'Device status.', 'enumValueTitles' => ['UNREGISTERED' => 'Unregistered', 'ONLINE' => 'Online', 'OFFLINE' => 'Offline'], 'type' => 'string', 'example' => '无', 'title' => '', ], 'Mobile' => ['description' => 'The agent\'s personal phone number.', 'type' => 'string', 'example' => '1324730****', 'title' => ''], 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-1034159089076****', 'title' => ''], 'UserState' => [ 'description' => 'Agent status.', 'enumValueTitles' => ['READY' => 'Idle', 'WORKING' => 'Post-processing', 'DIALING' => 'Dialing', 'BREAK' => 'Break', 'OFFLINE' => 'Offline', 'TALKING' => 'Talking', 'RINGING' => 'Ringing'], 'type' => 'string', 'example' => 'OFFLINE', 'title' => '', ], 'SignedSkillGroupIdList' => [ 'description' => 'List of skill group IDs that the agent has signed into.', 'type' => 'array', 'items' => ['description' => 'Skill group ID.', 'type' => 'string', 'example' => 'skillgroup1@ccc-test', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.Number', 'errorMessage' => 'The specified number %s does not exist in instance %s.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => ''], ], ], 'title' => 'Initiate a dual-call', 'description' => 'A back-to-back call differs from a traditional two-party call in that the caller does not directly call the callee. Instead, a Back-to-Back Agent is used. The Back-to-Back Agent first calls the caller, and after the connection is established, it calls the callee and then joins both parties into a single conference. In this mode, because all message streams of each call pass through the Back-to-Back Agent, the service provider (SP) can offer value-added services such as call timing, call recording, and number masking.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartBack2BackCall'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"26A34338-5CD9-4C95-A7A6-5BDCE76C6B94\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"BACK2BACK\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-1034159089076****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"ReleaseInitiator\\": \\"无\\",\\n \\"ChannelState\\": \\"NONE\\",\\n \\"Destination\\": \\"1372168****\\",\\n \\"UserId\\": \\"无\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"Timestamp\\": 1618217874062,\\n \\"ReleaseReason\\": \\"无\\",\\n \\"CallType\\": \\"BACK2BACK\\",\\n \\"JobId\\": \\"job-1034159089076****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-653821410368****\\",\\n \\"Originator\\": \\"0102157****\\",\\n \\"UserExtension\\": \\"8001****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8020****\\",\\n \\"Heartbeat\\": 1618217872911,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1618217794599,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"DeviceState\\": \\"无\\",\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-1034159089076****\\",\\n \\"UserState\\": \\"OFFLINE\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","type":"json"}]', ], 'StartChat' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'UserList', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The information about chat members.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'UserId' => ['description' => 'The member ID.', 'type' => 'string', 'required' => false, 'example' => 'fcd020fe-d8e4-40e5-8c77-1a272a174a7d', 'title' => ''], 'UserType' => ['description' => 'The type of the member.'."\n" ."\n" .'- AGENT: An agent.'."\n" ."\n" .'- CUSTOMER: A visitor.', 'type' => 'string', 'required' => false, 'example' => 'CUSTOMER', 'title' => ''], 'AvatarUrl' => ['description' => 'The URL of the member\'s profile picture.', 'type' => 'string', 'required' => false, 'example' => 'http://xxx.com/image', 'title' => ''], 'Nickname' => ['description' => 'The nickname of the member.', 'type' => 'string', 'required' => false, 'example' => '访客-1a272a174a7d', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'Token', 'in' => 'query', 'schema' => ['description' => 'The channel token for the web service.', 'type' => 'string', 'required' => false, 'example' => '9XYGTGWtq2wFi_Bpg7aUnIoYi_vG_rO3bjEn0YtsxbHRHrYHlz1LDBLJAyZcLxieRQR4h_6AnWvTjJeNU5jg************Hwej7WgWrmA=', 'title' => ''], ], [ 'name' => 'AccessChannelId', 'in' => 'query', 'schema' => ['description' => 'The ID of the web service channel.', 'type' => 'string', 'required' => false, 'example' => 'cf584733-***-***-9699-cb77aa3b7aa6', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], 'Data' => [ 'description' => 'The response data.', 'type' => 'object', 'properties' => [ 'ChatConversationId' => ['description' => 'The ID of the chat session.', 'type' => 'string', 'example' => '$23086709$EAUNIT', 'title' => ''], 'JobId' => ['description' => 'The job ID.', 'type' => 'string', 'example' => 'chat-525523618219921408', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''], ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => ''], ['errorCode' => 'Parameter.Format', 'errorMessage' => 'The format of parameter %s is invalid.', 'description' => ''], ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], 409 => [ ['errorCode' => 'AlreadyExists.SkillGroup', 'errorMessage' => 'The skill group %s already exists in instance %s.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Data\\": {\\n \\"ChatConversationId\\": \\"$23086709$EAUNIT\\",\\n \\"JobId\\": \\"chat-525523618219921408\\"\\n }\\n}","type":"json"}]', 'title' => 'Initiate Chat', 'summary' => 'Starts a chat session.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'StartConference' => [ 'summary' => 'You can invoke StartConference to initiate a conference.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'The agent ID initiating the conference call. This parameter is optional. If not specified, the agent mapped to the current RAM account is used by default.', 'type' => 'string', 'required' => false, 'example' => 'agent@ccc-test', 'title' => ''], ], [ 'name' => 'ParticipantListJson', 'in' => 'query', 'schema' => ['description' => 'A JSON-formatted string representing an array of participants. Each array element represents a participant. For internal calls to agents, the participant is the target agent\'s extension number. For external calls to customers, the participant is the customer\'s phone number.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["8045****","1317511****"]', 'title' => ''], ], [ 'name' => 'TimeoutSeconds', 'in' => 'query', 'schema' => ['description' => 'Timeout period. If the call is not answered within the time specified by this parameter, it will be automatically disconnected. This parameter is optional. The default value is 30 seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '3600', 'minimum' => '0', 'example' => '30', 'title' => ''], ], [ 'name' => 'Tags', 'in' => 'query', 'schema' => ['description' => 'Ingest endpoint data. It cannot exceed 128 bytes and is primarily used for extension requirements. Ordinary customers do not need to concern themselves with it.', 'type' => 'string', 'required' => false, 'example' => '无', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'FDD327D1-AB8A-596B-883F-F63582A73F1D', 'title' => ''], 'Params' => [ 'description' => 'List of response parameters.', 'type' => 'array', 'items' => ['description' => 'Response parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'CallContext' => [ 'description' => 'Call context environment.', 'type' => 'object', 'properties' => [ 'CallType' => [ 'description' => 'Call type.', 'enumValueTitles' => [ 'INBOUND' => 'Inbound', 'BARGE' => 'Barge-in', 'CONSULTANT' => 'Consultation', 'CONFERENCE' => 'Conference', 'MONITOR' => 'Monitor', 'INTERNAL' => 'Internal call', 'OUTBOUND' => 'Outbound', 'INTERCEPT' => 'Intercept', 'BACK2BACK' => 'Back-to-back call', 'PREDICTIVE' => 'Predictive outbound', 'COACH' => 'Coaching', ], 'type' => 'string', 'example' => 'OUTBOUND', 'title' => '', ], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'ChannelContexts' => [ 'description' => 'List of call channels.', 'type' => 'array', 'items' => [ 'description' => 'Call channel.', 'type' => 'object', 'properties' => [ 'ReleaseInitiator' => ['description' => 'The party that initiated the disconnection of the voice channel, indicating who first terminated the call.', 'type' => 'string', 'example' => '1390501****', 'title' => ''], 'ChannelState' => [ 'description' => 'Status of the call channel.', 'enumValueTitles' => ['CREATED' => 'Created', 'ANSWERED' => 'Answered', 'RELEASED' => 'Released', 'RETIRED' => 'Out Of Effect', 'EARLY_MEDIA' => 'Early Media', 'NONE' => 'Initial Status', 'RINGING' => 'Ringing'], 'type' => 'string', 'example' => 'ANSWERED', 'title' => '', ], 'Destination' => ['description' => 'The callee of the call channel.', 'type' => 'string', 'example' => '8001****', 'title' => ''], 'UserId' => ['description' => 'The agent ID associated with the voice channel. This field is empty if the channel belongs to a Customer.', 'type' => 'string', 'example' => 'agent@ccc-test'."\n", 'title' => ''], 'ChannelFlags' => [ 'description' => 'Voice channel flags.', 'enumValueTitles' => ['COACHING' => 'Coaching', 'MONITORING' => 'Monitoring', 'MONITORED' => 'Monitored', 'COACHED' => 'Coached', 'HOLD' => 'Hold', 'MUTED' => 'Muted'], 'type' => 'string', 'example' => 'MONITORING', 'title' => '', ], 'Timestamp' => ['description' => 'The UNIX timestamp indicating the most recent status change of the channel, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315', 'title' => ''], 'ReleaseReason' => ['description' => 'The release reason of the voice channel, indicating why the current voice channel was disconnected. The value is derived from the response codes defined in the SIP protocol. Customers should refer to the SIP protocol to analyze the disconnection reason.', 'type' => 'string', 'example' => '404 - No destination', 'title' => ''], 'CallType' => [ 'description' => 'The call type of the channel.', 'enumValueTitles' => [ 'INBOUND' => 'Inbound', 'BARGE' => 'Barge-in', 'CONSULTANT' => 'Consultation', 'CONFERENCE' => 'Conference', 'MONITOR' => 'Listener', 'INTERNAL' => 'Internal Call', 'OUTBOUND' => 'Outbound', 'INTERCEPT' => 'Intercept', 'BACK2BACK' => 'Back-to-Back Call', 'PREDICTIVE' => 'Predictive Outbound', 'COACH' => 'Coaching', ], 'type' => 'string', 'example' => 'OUTBOUND', 'title' => '', ], 'JobId' => ['description' => 'The call ID.', 'type' => 'string', 'example' => 'job-6573574060089****', 'title' => ''], 'ChannelId' => ['description' => 'The channel ID.', 'type' => 'string', 'example' => 'ch:user:131888****->8001****:1609225718294:job-65700074013925376', 'title' => ''], 'Originator' => ['description' => 'The calling party of the voice channel.', 'type' => 'string', 'example' => '1318888****', 'title' => ''], 'UserExtension' => ['description' => 'The extension number of the agent associated with the channel.', 'type' => 'string', 'example' => '8032****'."\n", 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'UserContext' => [ 'description' => 'Agent context environment.', 'type' => 'object', 'properties' => [ 'Extension' => ['description' => 'The agent\'s extension number.', 'type' => 'string', 'example' => '8032****', 'title' => ''], 'Heartbeat' => ['description' => 'The time when the last heartbeat was received from the agent, in Unix timestamp format with millisecond precision.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378', 'title' => ''], 'WorkMode' => [ 'description' => 'Work mode.', 'enumValueTitles' => ['ON_SITE' => 'On-site mode', 'OFF_SITE' => 'Off-site mode', 'OFFICE_PHONE' => 'Office phone mode'], 'type' => 'string', 'example' => 'ON_SITE', 'title' => '', ], 'DeviceId' => ['description' => 'Device ID, the identity ID of a browser-based Web Real-Time Communication (WebRTC) softphone or a physical phone device. Only one type of device is allowed to register at a time.', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****', 'title' => ''], 'UserId' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'Reserved' => ['description' => 'The time when the agent was most recently reserved. Being reserved means an incoming call will soon be assigned to this agent. The value is formatted as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378', 'title' => ''], 'BreakCode' => [ 'description' => 'Break status code, which can be either System-defined or Custom-defined. System-defined break codes include: Warm-up (temporary break state after agent is published and before becoming idle), RingingTimeout (break due to agent ringing timeout), and RejectCall (break due to agent call rejection). There are no restrictions on Custom-defined status codes; customers can define them according to their business needs.', 'enumValueTitles' => ['RingingTimeout' => 'Break due to agent ringing timeout', 'RejectCall' => 'Break due to agent call rejection', 'Warm-up' => 'Temporary break state after agent is published and before becoming idle'], 'type' => 'string', 'example' => 'Warm-up'."\n", 'title' => '', ], 'InstanceId' => ['description' => 'instance ID.', 'type' => 'string', 'example' => '1609136956378'."\n", 'title' => ''], 'OutboundScenario' => ['description' => 'Indicates whether the agent is in outbound-only mode.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'DeviceState' => [ 'description' => 'Device status.', 'enumValueTitles' => ['UNREGISTERED' => 'Unregistered', 'ONLINE' => 'Online', 'OFFLINE' => 'Offline'], 'type' => 'string', 'example' => 'false', 'title' => '', ], 'Mobile' => ['description' => 'The agent\'s personal phone number.', 'type' => 'string', 'example' => '1324730****', 'title' => ''], 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'UserState' => [ 'description' => 'Agent status.', 'enumValueTitles' => ['READY' => 'empty', 'WORKING' => 'post-processing', 'DIALING' => 'dial-up', 'BREAK' => 'break', 'OFFLINE' => 'offline', 'TALKING' => 'talking', 'RINGING' => 'ringing'], 'type' => 'string', 'example' => 'TALKING', 'title' => '', ], 'SignedSkillGroupIdList' => [ 'description' => 'List of skill group IDs that the agent has signed into.', 'type' => 'array', 'items' => ['description' => 'Skill group ID.', 'type' => 'string', 'example' => 'skillgroup1@ccc-test', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => ''], ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.Number', 'errorMessage' => 'The specified number %s does not exist in instance %s.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => ''], ], ], 'title' => 'Initiate a conference call', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartConference'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"FDD327D1-AB8A-596B-883F-F63582A73F1D\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"ANSWERED\\",\\n \\"Destination\\": \\"8001****\\",\\n \\"UserId\\": \\"agent@ccc-test\\\\n\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6573574060089****\\",\\n \\"ChannelId\\": \\"ch:user:131888****->8001****:1609225718294:job-65700074013925376\\",\\n \\"Originator\\": \\"1318888****\\",\\n \\"UserExtension\\": \\"8032****\\\\n\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8032****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\\\n\\",\\n \\"InstanceId\\": \\"1609136956378\\\\n\\",\\n \\"OutboundScenario\\": false,\\n \\"DeviceState\\": \\"false\\",\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","type":"json"}]', ], 'StartEditContactFlow' => [ 'summary' => 'Start editing a contact flow and generate a draft version.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccTPIKHY'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'ContactFlowId', 'in' => 'query', 'schema' => ['description' => 'The contact flow ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '798e83a9-5140-4039-afa1-761ca4cca2df', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Data' => ['description' => 'The data, which is the contact flow draft ID.', 'type' => 'string', 'example' => 'b3114362-9062-46c7-82dc-ae55ac168b2e', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BC2733CE-C470-564A-8C11-9DC02468823A', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Create a contact flow draft ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartEditContactFlow'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": \\"b3114362-9062-46c7-82dc-ae55ac168b2e\\",\\n \\"RequestId\\": \\"BC2733CE-C470-564A-8C11-9DC02468823A\\"\\n}","type":"json"}]', ], 'StartPredictiveCall' => [ 'summary' => 'Invoke StartPredictiveCall to initiate predictive outbound calling.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccQFUGXR'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'Caller', 'in' => 'query', 'schema' => ['description' => 'The caller number, which must be an active outbound number under the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0109810****', 'title' => ''], ], [ 'name' => 'Callee', 'in' => 'query', 'schema' => ['description' => 'The callee number.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1312353****', 'title' => ''], ], [ 'name' => 'TimeoutSeconds', 'in' => 'query', 'schema' => ['description' => 'The timeout period, in seconds. If the call is not answered within the specified time, it is automatically disconnected.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '3600', 'minimum' => '0', 'example' => '10', 'title' => ''], ], [ 'name' => 'ContactFlowId', 'in' => 'query', 'schema' => ['description' => 'The IVR contact flow ID. After the callee answers, the call is automatically transferred into this IVR flow.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9774c36c-12fe-4e37-adce-89bc77ce****', 'title' => ''], ], [ 'name' => 'Tags', 'in' => 'query', 'schema' => ['description' => 'The ingest endpoint data, primarily used for extension purposes. Regular users do not need to concern themselves with this.', 'type' => 'string', 'required' => false, 'example' => '无', 'title' => ''], ], [ 'name' => 'ContactFlowVariables', 'in' => 'query', 'schema' => ['description' => 'The contact flow variables passed in as a JSON-formatted string of an array. Each array element is a key-value pair, where the key is the variable name and the value is the variable value. To use these variables in the IVR flow, create a Custom Parameter with the same name in the start node of the IVR associated with the specified contact flow ID.', 'type' => 'string', 'required' => false, 'example' => '{"name":"王先生","time":"19点20分","address":"某某中心"}', 'title' => ''], ], [ 'name' => 'MaskedCallee', 'in' => 'query', 'schema' => ['description' => 'The desensitized callee number. If this field is not empty, it indicates that the callee number must be desensitized. The Desensitization Rule is defined by the Customer. Simply enter the desensitized callee number here. Using a desensitized callee number means that in certain scenarios, only the desensitized number is visible, and the real callee number cannot be viewed.', 'type' => 'string', 'required' => false, 'example' => '1312353****', 'title' => ''], ], [ 'name' => 'SkillGroupId', 'in' => 'query', 'schema' => ['description' => 'The skill group ID. This parameter is optional. If specified, the outbound number is selected only from the numbers associated with the specified skill group.', 'type' => 'string', 'required' => false, 'example' => 'skillgroup@ccc-test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '26A34338-5CD9-4C95-A7A6-5BDCE76C6B94', 'title' => ''], 'Params' => [ 'description' => 'List of response parameters.', 'type' => 'array', 'items' => ['description' => 'Response parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'CallContext' => [ 'description' => 'Call context environment.', 'type' => 'object', 'properties' => [ 'CallType' => [ 'description' => 'Call type.', 'enumValueTitles' => [ 'INBOUND' => 'Inbound', 'BARGE' => 'Barge', 'CONSULTANT' => 'Consultation', 'CONFERENCE' => 'Conference', 'MONITOR' => 'Monitor', 'INTERNAL' => 'Internal call', 'OUTBOUND' => 'Outbound', 'INTERCEPT' => 'Intercept', 'BACK2BACK' => 'Back-to-back', 'PREDICTIVE' => 'Predictive outbound', 'COACH' => '\\[responses\\_200\\_schema\\_properties\\_Data\\_properties\\_CallContext\\_properties\\_CallType\\_description]Call type.', ], 'type' => 'string', 'example' => 'OUTBOUND', 'title' => '', ], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-6570007401392****', 'title' => ''], 'ChannelContexts' => [ 'description' => 'List of call channels.', 'type' => 'array', 'items' => [ 'description' => 'Call channel.', 'type' => 'object', 'properties' => [ 'ReleaseInitiator' => ['description' => 'The party that initiated the disconnection of the voice channel, indicating who first hung up the call.', 'type' => 'string', 'example' => '无', 'title' => ''], 'ChannelState' => [ 'description' => 'The status of the voice channel.', 'enumValueTitles' => ['CREATED' => 'Created', 'ANSWERED' => 'Answered', 'RELEASED' => 'Released', 'RETIRED' => 'Out Of Effect', 'EARLY_MEDIA' => 'Early Media', 'NONE' => 'Initial Status', 'RINGING' => 'Ringing'], 'type' => 'string', 'example' => 'NONE', 'title' => '', ], 'Destination' => ['description' => 'Callee of the call channel.', 'type' => 'string', 'example' => '8001****', 'title' => ''], 'UserId' => ['description' => 'The agent ID associated with the call channel. This field is empty if the channel belongs to a Customer.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'ChannelFlags' => [ 'description' => 'Flags of the voice channel.', 'enumValueTitles' => ['COACHING' => 'Coaching', 'MONITORING' => 'Monitoring', 'MONITORED' => 'Monitored', 'COACHED' => 'Coached', 'HOLD' => 'Hold', 'MUTED' => 'Muted'], 'type' => 'string', 'example' => '[]', 'title' => '', ], 'Timestamp' => ['description' => 'The UNIX timestamp indicating the most recent status change of the channel, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609225718295', 'title' => ''], 'ReleaseReason' => ['description' => 'The release reason for the voice channel, indicating why the current voice channel was disconnected. The value comes from the response codes defined in the SIP protocol. Customers should refer to the SIP protocol to analyze the disconnection reason.', 'type' => 'string', 'example' => '无', 'title' => ''], 'CallType' => [ 'description' => 'The call type of the channel.', 'enumValueTitles' => [ 'INBOUND' => 'Inbound', 'BARGE' => 'Barge-in', 'CONSULTANT' => 'Consultation', 'CONFERENCE' => 'Conference', 'MONITOR' => 'Listener', 'INTERNAL' => 'Internal Call', 'OUTBOUND' => 'Outbound', 'INTERCEPT' => 'Intercept', 'BACK2BACK' => 'Back-to-Back', 'PREDICTIVE' => 'Predictive outbound call', 'COACH' => 'Coaching', ], 'type' => 'string', 'example' => 'OUTBOUND', 'title' => '', ], 'JobId' => ['description' => 'The call ID.', 'type' => 'string', 'example' => 'job-6570007401392****', 'title' => ''], 'ChannelId' => ['description' => 'The channel ID.', 'type' => 'string', 'example' => 'ch:user:131888****->8001****:1609225718294:job-6570007401392****', 'title' => ''], 'Originator' => ['description' => 'The originator of the call channel.', 'type' => 'string', 'example' => '1318888****', 'title' => ''], 'UserExtension' => ['description' => 'The extension number of the agent associated with the channel.', 'type' => 'string', 'example' => '8001****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'UserContext' => [ 'description' => 'Agent context environment.', 'type' => 'object', 'properties' => [ 'Extension' => ['description' => 'Agent extension number.', 'type' => 'string', 'example' => '8001****', 'title' => ''], 'Heartbeat' => ['description' => 'The time when the last heartbeat from the agent was received, in UNIX timestamp format, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378', 'title' => ''], 'WorkMode' => [ 'description' => 'Work mode.', 'enumValueTitles' => ['ON_SITE' => 'On-site mode', 'OFF_SITE' => 'Off-site mode', 'OFFICE_PHONE' => 'Office phone mode'], 'type' => 'string', 'example' => 'ON_SITE', 'title' => '', ], 'DeviceId' => ['description' => 'Device ID, which is the identity ID of a browser-based Web Real-Time Communication (WebRTC) softphone or a physical phone device. Only one type of device can be registered at a time.', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****', 'title' => ''], 'UserId' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'Reserved' => ['description' => 'The timestamp in milliseconds of the most recent time the agent was reserved. Being reserved means an incoming call will soon be assigned to this agent. The format is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378', 'title' => ''], 'BreakCode' => [ 'description' => 'Break code, which can be either system-defined or customer-defined. System-defined break codes include: Warm-up (temporary break state after an agent is published and before becoming idle), RingingTimeout (break caused by agent ringing timeout), and RejectCall (break caused by agent call rejection). There are no restrictions on customer-defined break codes; customers can define them as needed for their business.', 'enumValueTitles' => ['RingingTimeout' => 'Break caused by agent ringing timeout', 'RejectCall' => 'Break caused by agent call rejection', 'Warm-up' => 'Temporary break state after an agent is published and before becoming idle'], 'type' => 'string', 'example' => 'Warm-up', 'title' => '', ], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'OutboundScenario' => ['description' => 'Indicates whether the agent is in outbound-only mode.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'DeviceState' => [ 'description' => 'Device status.', 'enumValueTitles' => ['UNREGISTERED' => 'Unregistered', 'ONLINE' => 'Online', 'OFFLINE' => 'Offline'], 'type' => 'string', 'example' => 'ONLINE', 'title' => '', ], 'Mobile' => ['description' => 'The agent\'s personal phone number.', 'type' => 'string', 'example' => '1324730****', 'title' => ''], 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-6570007401392****', 'title' => ''], 'UserState' => [ 'description' => 'Agent status.', 'enumValueTitles' => ['READY' => 'Ready', 'WORKING' => 'Post-processing', 'DIALING' => 'Dialing', 'BREAK' => 'Break', 'OFFLINE' => 'Offline', 'TALKING' => 'Talking', 'RINGING' => 'Ringing'], 'type' => 'string', 'example' => 'READY', 'title' => '', ], 'SignedSkillGroupIdList' => [ 'description' => 'List of skill group IDs that the agent has signed into.', 'type' => 'array', 'items' => ['description' => 'Skill group ID.', 'type' => 'string', 'example' => 'skillgroup1@ccc-test', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.Number', 'errorMessage' => 'The specified number %s does not exist in instance %s.', 'description' => ''], ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Initiate a predictive outbound call ', 'description' => 'In addition to supporting agents initiating outbound calls from the agent Workbench, Cloud Call Center also enables your Operational System backend to initiate outbound calls and transfer the call to an agent after it is answered. This allows you to seamlessly embed Cloud Call Center features into your Business Process.
'."\n" .'For example, your Customer can enter their phone number on your WeChat Official Account and click a button to inquire about a product. Your backend system then invokes this API to call the Customer’s Phone. After the call is connected, the system plays back the message: “We have received your inquiry about our product via the Official Account. We are now connecting you to an advisor. Please wait.” The call is then transferred to an appropriate agent.
'."\n" .'Compared with the DialEX API in version 1.0, this API offers greater flexibility in configuration. In addition to customizing the IVR for transfer-in, you can also pass custom parameters, which can be played back by voice within the IVR to support notification scenarios.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2021-11-29T08:23:20.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2021-11-29T08:23:20.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2021-08-20T10:36:28.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartPredictiveCall'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"26A34338-5CD9-4C95-A7A6-5BDCE76C6B94\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6570007401392****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"ReleaseInitiator\\": \\"无\\",\\n \\"ChannelState\\": \\"NONE\\",\\n \\"Destination\\": \\"8001****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"[]\\",\\n \\"Timestamp\\": 1609225718295,\\n \\"ReleaseReason\\": \\"无\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6570007401392****\\",\\n \\"ChannelId\\": \\"ch:user:131888****->8001****:1609225718294:job-6570007401392****\\",\\n \\"Originator\\": \\"1318888****\\",\\n \\"UserExtension\\": \\"8001****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Extension\\": \\"8001****\\",\\n \\"Heartbeat\\": 1609136956378,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609136956378,\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"DeviceState\\": \\"ONLINE\\",\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6570007401392****\\",\\n \\"UserState\\": \\"READY\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","type":"json"}]', ], 'StartPrivacyCall' => [ 'summary' => 'Starts a privacy call.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the Cloud Contact Center (CCC) instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'AppId', 'in' => 'query', 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'ALIPUBB7A727C170949', 'title' => ''], ], [ 'name' => 'Caller', 'in' => 'query', 'schema' => ['description' => 'The caller\'s number.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0109810****', 'title' => ''], ], [ 'name' => 'Callee', 'in' => 'query', 'schema' => ['description' => 'The callee\'s number.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1888888****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0630E5DF-CEB0-445B-8626-D5C7481181C3', 'title' => ''], 'Params' => [ 'description' => 'The parameter information.', 'type' => 'array', 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], 'Data' => ['description' => 'The returned result, which is the call ID.', 'type' => 'string', 'example' => 'job-xxx', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => ''], ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.Number', 'errorMessage' => 'The specified number %s does not exist in instance %s.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"0630E5DF-CEB0-445B-8626-D5C7481181C3\\",\\n \\"Params\\": [\\n \\"\\"\\n ],\\n \\"Data\\": \\"job-xxx\\"\\n}","type":"json"}]', 'title' => 'Initiate a privacy call', 'changeSet' => [ ['createdAt' => '2022-09-07T01:59:54.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartPrivacyCall'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'SubmitCampaign' => [ 'summary' => 'Invoke SubmitCampaign to start the predictive outbound calling activity corresponding to the specified ID under the specified instance.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccQFUGXR'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'CampaignId', 'in' => 'query', 'schema' => ['description' => 'The predictive outbound calling activity ID.', 'type' => 'string', 'required' => true, 'example' => '6badb397-a8b5-40b6-21019d382a09', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '7CC6523B-0E51-1B62-8DA5-6A9831CAE315'], 'Code' => ['title' => 'code', 'description' => 'The response code.', 'type' => 'string', 'example' => 'OK'], 'Message' => ['title' => 'message', 'description' => 'The response message.', 'type' => 'string', 'example' => '无'], 'HttpStatusCode' => ['title' => 'httpStatusCode', 'description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200'], ], 'example' => '', ], ], ], 'title' => 'Start Predictive Outbound Calling Activity', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitCampaign'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7CC6523B-0E51-1B62-8DA5-6A9831CAE315\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","type":"json"}]', ], 'SwitchToConference' => [ 'summary' => 'You can invoke SwitchToConference to switch the status of a specified call under a specified instance to a three-party conference. This is typically used in scenarios where a consultation is converted into a conference.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'Agent ID. If not specified, the agent mapped to the current Resource Access Management (RAM) user is used by default.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test', 'title' => ''], ], [ 'name' => 'DeviceId', 'in' => 'query', 'schema' => ['description' => 'Invalid field. You can enter any value.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device', 'title' => ''], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'Call ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job-24114064019637****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'D9C96A73-09C9-5E2A-8CDB-85EC0BC246DA', 'title' => ''], 'Params' => [ 'description' => 'List of response parameters.', 'type' => 'array', 'items' => ['description' => 'Response parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'CallContext' => [ 'description' => 'Call context environment.', 'type' => 'object', 'properties' => [ 'CallType' => [ 'description' => 'Call type.', 'enumValueTitles' => [ 'INBOUND' => 'Inbound', 'BARGE' => 'Barge-in', 'CONSULTANT' => 'Consultation', 'CONFERENCE' => 'Conference', 'MONITOR' => 'Listener', 'INTERNAL' => 'Internal call', 'OUTBOUND' => 'Outbound', 'INTERCEPT' => 'Intercept', 'BACK2BACK' => 'Back-to-back call', 'PREDICTIVE' => 'Predictive outbound', 'COACH' => 'Coaching', ], 'type' => 'string', 'example' => 'OUTBOUND', 'title' => '', ], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'ChannelContexts' => [ 'description' => 'List of call channels.', 'type' => 'array', 'items' => [ 'description' => 'Call channel.', 'type' => 'object', 'properties' => [ 'Index' => ['description' => 'An auto-increment ID assigned by the system. Customers do not need to concern themselves with this.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'ReleaseInitiator' => ['description' => 'The party that initiated the release of the channel, indicating which party first hung up the call.', 'type' => 'string', 'example' => '1390501****', 'title' => ''], 'ChannelState' => [ 'description' => 'The status of the channel.', 'enumValueTitles' => ['CREATED' => 'Created', 'ANSWERED' => 'Answered', 'RELEASED' => 'Released', 'RETIRED' => 'Out Of Effect', 'EARLY_MEDIA' => 'Early Media', 'NONE' => 'Initial Status', 'RINGING' => 'Ringing'], 'type' => 'string', 'example' => 'NONE', 'title' => '', ], 'Destination' => ['description' => 'The called party of the channel.', 'type' => 'string', 'example' => '8001****', 'title' => ''], 'SkillGroupId' => ['description' => 'The skill group associated with this call. In inbound scenarios, the skill group is specified by the queue to which the call is routed in the IVR. In outbound scenarios, the skill group is the first one that the agent signs into.', 'type' => 'string', 'example' => 'skillgroup@ccc-test', 'title' => ''], 'UserId' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'ChannelFlags' => [ 'description' => 'Channel flags.', 'enumValueTitles' => ['COACHING' => 'Coaching', 'MONITORING' => 'Monitoring', 'MONITORED' => 'Monitored', 'COACHED' => 'Coached', 'HOLD' => 'Hold', 'MUTED' => 'Muted'], 'type' => 'string', 'example' => 'MONITORING', 'title' => '', ], 'Timestamp' => ['description' => 'The UNIX timestamp indicating when the channel last changed status, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609255716900', 'title' => ''], 'ReleaseReason' => ['description' => 'The reason for releasing the channel, indicating why the current channel was disconnected. The value corresponds to a response code defined in the SIP protocol. Customers should refer to the SIP protocol for Analysis of the release reason.', 'type' => 'string', 'example' => '404 - No destination', 'title' => ''], 'CallType' => [ 'description' => 'The call type of the channel.', 'enumValueTitles' => [ 'INBOUND' => 'Inbound', 'BARGE' => 'Barge', 'CONSULTANT' => 'Consultation', 'CONFERENCE' => 'Conference', 'MONITOR' => 'Monitor', 'INTERNAL' => 'Internal Call', 'OUTBOUND' => 'Outbound', 'INTERCEPT' => 'Intercept', 'BACK2BACK' => 'Back-to-Back', 'PREDICTIVE' => 'Predictive Outbound', 'COACH' => 'Coach', ], 'type' => 'string', 'example' => 'OUTBOUND', 'title' => '', ], 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'ChannelId' => ['description' => 'The channel ID.', 'type' => 'string', 'example' => 'ch:user:131888****->8001****:1609225718294:job-6538214103685****', 'title' => ''], 'Originator' => ['description' => 'The originator of the channel.', 'type' => 'string', 'example' => '1318888****', 'title' => ''], 'UserExtension' => ['description' => 'Extension number of the agent associated with the channel.', 'type' => 'string', 'example' => '8032****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'UserContext' => [ 'description' => 'Agent context environment.', 'type' => 'object', 'properties' => [ 'Heartbeat' => ['description' => 'The time when the last heartbeat from the agent was received, in Unix timestamp format, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => 'agent@ccc-test', 'title' => ''], 'Extension' => ['description' => 'The agent\'s extension number.', 'type' => 'string', 'example' => '8032****', 'title' => ''], 'WorkMode' => [ 'description' => 'Work mode.', 'enumValueTitles' => ['ON_SITE' => 'On-site mode', 'OFF_SITE' => 'Off-site mode', 'OFFICE_PHONE' => 'Office phone mode'], 'type' => 'string', 'example' => 'ON_SITE', 'title' => '', ], 'DeviceId' => ['description' => 'Device ID, the identity ID of a browser-based Web Real-Time Communication (WebRTC) softphone or a physical phone device. Only one type of device can be registered at a time.', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****', 'title' => ''], 'UserId' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => '1609136956378', 'title' => ''], 'BreakCode' => [ 'description' => 'Break status code, which can be either System-defined or Custom-defined. System-defined break codes include: Warm-up (temporary break state after an agent is published and before becoming idle), RingingTimeout (break due to agent ringing timeout), and RejectCall (break due to agent call rejection). There are no restrictions on Custom-defined status codes; customers can define them according to their business needs.', 'enumValueTitles' => ['RingingTimeout' => 'Break due to agent ringing timeout', 'RejectCall' => 'Break due to agent call rejection', 'Warm-up' => 'Temporary break state after an agent is published and before becoming idle'], 'type' => 'string', 'example' => 'Warm-up', 'title' => '', ], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'OutboundScenario' => ['description' => 'Indicates whether the agent is in outbound-only mode.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'DeviceState' => [ 'description' => 'Device status.', 'enumValueTitles' => ['UNREGISTERED' => 'Unregistered', 'ONLINE' => 'Online', 'OFFLINE' => 'Offline'], 'type' => 'string', 'example' => 'false', 'title' => '', ], 'Mobile' => ['description' => 'The agent\'s personal phone number.', 'type' => 'string', 'example' => '1324730****', 'title' => ''], 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'UserState' => [ 'description' => 'Agent status.', 'enumValueTitles' => ['READY' => 'empty', 'WORKING' => 'post-processing', 'DIALING' => 'dial-up', 'BREAK' => 'break', 'OFFLINE' => 'offline', 'TALKING' => 'talking', 'RINGING' => 'ringing'], 'type' => 'string', 'example' => 'TALKING', 'title' => '', ], 'SignedSkillGroupIdList' => [ 'description' => 'List of skill group IDs that the agent has signed into.', 'type' => 'array', 'items' => ['description' => 'Skill group ID.', 'type' => 'string', 'example' => 'skillgroup1@ccc-test'."\n", 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ['errorCode' => 'InvalidOperation.ChannelState', 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', 'description' => ''], ['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.ChannelId', 'errorMessage' => 'The specified channel %s does not exist in call %s.', 'description' => ''], ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => ''], ], ], 'title' => 'Transfer to conference ', 'changeSet' => [ ['createdAt' => '2023-10-26T08:13:44.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SwitchToConference'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"D9C96A73-09C9-5E2A-8CDB-85EC0BC246DA\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 1,\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"NONE\\",\\n \\"Destination\\": \\"8001****\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"Timestamp\\": 1609255716900,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:131888****->8001****:1609225718294:job-6538214103685****\\",\\n \\"Originator\\": \\"1318888****\\",\\n \\"UserExtension\\": \\"8032****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Heartbeat\\": 0,\\n \\"Extension\\": \\"8032****\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"1609136956378\\",\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"DeviceState\\": \\"false\\",\\n \\"Mobile\\": \\"1324730****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\\\n\\"\\n ]\\n }\\n }\\n}","type":"json"}]', ], 'TakeBreak' => [ 'summary' => 'You can invoke TakeBreak to set a specified agent in a specified instance to the break state.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'Agent ID. If not specified, the agent mapped to the current RAM account is used by default.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test', 'title' => ''], ], [ 'name' => 'DeviceId', 'in' => 'query', 'schema' => ['description' => 'Device ID. This parameter is meaningless and can be filled with any value.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device', 'title' => ''], ], [ 'name' => 'Code', 'in' => 'query', 'schema' => ['description' => 'Break status code. Customers can define any custom break status.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'lunchtime', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'B59382D2-5755-4C6D-861F-FA2AAD8F89F7', 'title' => ''], 'Params' => [ 'description' => 'List of response parameters.', 'type' => 'array', 'items' => ['description' => 'Response parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'Extension' => ['description' => 'The agent\'s extension number.', 'type' => 'string', 'example' => '8001****', 'title' => ''], 'Heartbeat' => ['description' => 'The time when the last heartbeat from the agent was received, formatted as a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609249563836', 'title' => ''], 'WorkMode' => [ 'description' => 'Work mode.', 'enumValueTitles' => ['ON_SITE' => 'On-site mode', 'OFF_SITE' => 'Off-site mode', 'OFFICE_PHONE' => 'Office phone mode'], 'type' => 'string', 'example' => 'ON_SITE', 'title' => '', ], 'DeviceId' => ['description' => 'Device ID, which is the identity ID of a browser-based Web Real-Time Communication (WebRTC) softphone or a physical phone device. Only one type of device can be registered at a time.', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****', 'title' => ''], 'UserId' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'Reserved' => ['description' => 'The UNIX timestamp (in milliseconds) indicating when the agent was most recently reserved. Being reserved means an incoming call will be assigned to the agent shortly.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609234221864', 'title' => ''], 'BreakCode' => [ 'description' => 'Break status code, which can be either System-defined or Custom-defined. System-defined break codes include: Warm-up (temporary break state after the agent is published but before becoming idle), RingingTimeout (break caused by ringing timeout), and RejectCall (break caused by the agent rejecting a call). There are no restrictions on Custom-defined status codes; customers can define them according to their business needs.', 'enumValueTitles' => ['RingingTimeout' => 'Break caused by agent ringing timeout', 'RejectCall' => 'Break caused by agent rejecting a call', 'Warm-up' => 'Temporary break state after agent is published but before becoming idle'], 'type' => 'string', 'example' => 'lunchtime', 'title' => '', ], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'OutboundScenario' => ['description' => 'Indicates whether the agent is in outbound-only mode.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Mobile' => ['description' => 'The agent\'s personal phone number.', 'type' => 'string', 'example' => '1390000****', 'title' => ''], 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => '无', 'title' => ''], 'UserState' => [ 'description' => 'Agent status.', 'enumValueTitles' => ['READY' => 'Idle', 'WORKING' => 'Post-processing', 'DIALING' => 'Dialing', 'BREAK' => 'Break', 'OFFLINE' => 'Offline', 'TALKING' => 'Talking', 'RINGING' => 'Ringing'], 'type' => 'string', 'example' => 'BREAK', 'title' => '', ], 'SignedSkillGroupIdList' => [ 'description' => 'List of skill group IDs that the agent has signed into.', 'type' => 'array', 'items' => ['description' => 'Skill group ID.', 'type' => 'string', 'example' => 'skillgroup1@ccc-test', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => ''], ], ], 'title' => 'Break', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-10-26T08:13:44.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TakeBreak'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"B59382D2-5755-4C6D-861F-FA2AAD8F89F7\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"Extension\\": \\"8001****\\",\\n \\"Heartbeat\\": 1609249563836,\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"Reserved\\": 1609234221864,\\n \\"BreakCode\\": \\"lunchtime\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"Mobile\\": \\"1390000****\\",\\n \\"JobId\\": \\"无\\",\\n \\"UserState\\": \\"BREAK\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n}","type":"json"}]', ], 'TerminateTicket' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'TicketId', 'in' => 'query', 'schema' => ['description' => 'The ticket ID.', 'type' => 'string', 'required' => false, 'example' => '5491d3b4-14ee-4341-b5f1-db2c78beddeb', 'title' => ''], ], [ 'name' => 'Comment', 'in' => 'query', 'schema' => ['description' => 'Resolution comments.', 'type' => 'string', 'required' => false, 'example' => '关单', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'CloseTicketResponse', 'title' => 'CloseTicketResponse', 'type' => 'object', 'properties' => [ 'Data' => ['description' => 'The data.', 'type' => 'any', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Params' => [ 'description' => 'The list of error parameters.', 'type' => 'array', 'items' => ['description' => 'The error parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"03C67DAD-EB26-41D8-949D-9B0C470FB716\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', 'title' => 'Close ticket', 'summary' => 'Closes a ticket.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'TransferTicketTask' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'TicketId', 'in' => 'query', 'schema' => ['description' => 'The ticket ID.', 'type' => 'string', 'required' => false, 'example' => '5491d3b4-14ee-4341-b5f1-db2c78beddeb', 'title' => ''], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => ['description' => 'The node ID.', 'type' => 'string', 'required' => false, 'example' => 'f780ade8-3ca9-458b-b067-63077946a570', 'title' => ''], ], [ 'name' => 'Assignee', 'in' => 'query', 'schema' => ['description' => 'The ID of the assignee.', 'type' => 'string', 'required' => true, 'example' => 'assignee@ccc-test', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'Comment', 'in' => 'query', 'schema' => ['description' => 'Comments.', 'type' => 'string', 'required' => false, 'example' => '请assignee处理', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'TransferTicketTaskResponse', 'title' => 'TransferTicketTaskResponse ', 'type' => 'object', 'properties' => [ 'Data' => ['description' => 'The data.', 'type' => 'any', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '678F7002-CA01-4ABF-A112-585AFBDF3A3B', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Params' => [ 'description' => 'The list of error parameters.', 'type' => 'array', 'items' => ['description' => 'The error parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"678F7002-CA01-4ABF-A112-585AFBDF3A3B\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', 'title' => 'Ticket Assignment ', 'summary' => 'You can call TransferTicketTask to transfer a ticket to another user.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'UnmuteCall' => [ 'summary' => '\\[responses_200_schema_properties_Data_properties_UserContext_properties_UserState_type]string', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'The agent ID to unmute. If not specified, defaults to the agent mapped to the current RAM account.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test', 'title' => ''], ], [ 'name' => 'DeviceId', 'in' => 'query', 'schema' => ['description' => 'Device ID. This parameter is meaningless and can be filled with any value.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'device', 'title' => ''], ], [ 'name' => 'JobId', 'in' => 'query', 'schema' => ['description' => 'The call ID.', 'type' => 'string', 'required' => false, 'example' => 'job-6538214103685****'."\n", 'title' => ''], ], [ 'name' => 'ChannelId', 'in' => 'query', 'schema' => ['description' => 'The channel ID to unmute. This parameter is optional and defaults to empty. If empty, the system unmutes the channel associated with the agent specified by UserId.', 'type' => 'string', 'required' => false, 'example' => 'ch:user:1390501****->8032****:1609138902226:job-6538214103685****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => '\\[responses\\_200\\_schema\\_properties\\_Data\\_properties\\_UserContext\\_properties\\_UserId\\_type]string', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => '\\[responses\\_200\\_schema\\_properties\\_Data\\_properties\\_UserContext\\_properties\\_InstanceId\\_type]string', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => '\\[responses\\_200\\_schema\\_properties\\_Data\\_properties\\_UserContext\\_properties\\_DeviceId\\_type]string', 'type' => 'string', 'example' => 'EEEE671A-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], 'Params' => [ 'description' => '\\[responses\\_200\\_schema\\_properties\\_Data\\_properties\\_UserContext\\_properties\\_BreakCode\\_enumValueTitles\\_RejectCall]Break caused by agent rejecting a call', 'type' => 'array', 'items' => ['description' => '\\[responses\\_200\\_schema\\_properties\\_Data\\_properties\\_UserContext\\_properties\\_BreakCode\\_description]Break status code, which can be either system-defined or customer-defined. System-defined break codes include: Warm-up (temporary break state after an agent goes online but before becoming idle), RingingTimeout (break caused by agent ringing timeout), and RejectCall (break caused by agent rejecting a call). Customer-defined status codes have no restrictions, and customers can define them according to their business needs.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], 'Data' => [ 'description' => '\\[responses\\_200\\_schema\\_properties\\_Data\\_properties\\_UserContext\\_properties\\_Heartbeat\\_description]The UNIX timestamp in milliseconds indicating when the last heartbeat was received from the agent.', 'type' => 'object', 'properties' => [ 'CallContext' => [ 'description' => '\\[responses\\_200\\_schema\\_properties\\_Data\\_properties\\_CallContext\\_properties\\_ChannelContexts\\_items\\_properties\\_ReleaseReason\\_type]string', 'type' => 'object', 'properties' => [ 'CallType' => [ 'description' => 'Call type.', 'enumValueTitles' => [ 'INBOUND' => '\\[responses\\_200\\_schema\\_properties\\_Data\\_properties\\_CallContext\\_properties\\_ChannelContexts\\_items\\_properties\\_ChannelFlags\\_enumValueTitles\\_COACHED]Coached', 'BARGE' => '\\[responses\\_200\\_schema\\_properties\\_Data\\_properties\\_CallContext\\_properties\\_ChannelContexts\\_items\\_properties\\_ChannelFlags\\_enumValueTitles\\_HOLD]Hold', 'CONSULTANT' => '\\[responses\\_200\\_schema\\_properties\\_Data\\_properties\\_CallContext\\_properties\\_ChannelContexts\\_items\\_properties\\_ChannelFlags\\_enumValueTitles\\_MUTED]Muted', 'CONFERENCE' => 'Conference', 'MONITOR' => 'Listener', 'INTERNAL' => 'Internal Call', 'OUTBOUND' => 'Outbound', 'INTERCEPT' => 'Intercept', 'BACK2BACK' => 'Back-to-Back Call', 'PREDICTIVE' => 'Predictive Outbound', 'COACH' => 'Coaching', ], 'type' => 'string', 'example' => 'OUTBOUND', 'title' => '', ], 'InstanceId' => ['description' => '\\[responses\\_200\\_schema\\_properties\\_Data\\_properties\\_CallContext\\_properties\\_ChannelContexts\\_items\\_properties\\_ChannelFlags\\_enumValueTitles\\_MONITORING]Monitoring', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'JobId' => ['description' => 'Call ID.', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'ChannelContexts' => [ 'description' => 'List of call channels.', 'type' => 'array', 'items' => [ 'description' => 'Call channel.', 'type' => 'object', 'properties' => [ 'Index' => ['description' => 'An auto-incremented ID assigned by the system. Customers do not need to concern themselves with this value.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'ReleaseInitiator' => ['description' => '\\[parameters\\_JobId\\_in]query', 'type' => 'string', 'example' => '1390501****', 'title' => ''], 'ChannelState' => [ 'description' => '\\[parameters\\_JobId\\_schema\\_description]The call ID.', 'enumValueTitles' => ['CREATED' => '\\[parameters\\_UserId\\_in]query', 'ANSWERED' => '\\[parameters\\_DeviceId\\_schema\\_description]Device ID. This parameter is meaningless and can be filled with any value.', 'RELEASED' => '\\[parameters\\_DeviceId\\_schema\\_type]string', 'RETIRED' => '\\[parameters\\_DeviceId\\_in]query', 'EARLY_MEDIA' => '\\[parameters\\_ChannelId\\_schema\\_description]The channel ID to unmute. This parameter is optional and defaults to empty. If empty, the system unmutes the channel associated with the agent specified by UserId.', 'NONE' => '\\[parameters\\_ChannelId\\_schema\\_type]string', 'RINGING' => '\\[parameters\\_ChannelId\\_in]query'], 'type' => 'string', 'example' => 'CREATED', 'title' => '', ], 'Destination' => ['description' => 'Called party of the call channel.', 'type' => 'string', 'example' => '1390501****', 'title' => ''], 'UserId' => ['description' => 'The agent ID associated with the channel. This field is empty if the channel belongs to a customer.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'ChannelFlags' => [ 'description' => 'Channel flags.', 'enumValueTitles' => ['COACHING' => 'Coaching', 'MONITORING' => 'Monitoring', 'MONITORED' => 'Monitored', 'COACHED' => 'Coached', 'HOLD' => 'Hold', 'MUTED' => 'Muted'], 'type' => 'string', 'example' => 'MONITORING', 'title' => '', ], 'SkillGroupId' => ['description' => 'The skill group associated with this call. In inbound scenarios, the skill group is specified by the queue routed through IVR. In outbound scenarios, the skill group is the first one the agent signs into.', 'type' => 'string', 'example' => 'skillgroup@ccc-test', 'title' => ''], 'Timestamp' => ['description' => 'The UNIX timestamp of the most recent status change of the channel, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609138903315', 'title' => ''], 'ReleaseReason' => ['description' => 'The reason for releasing the channel. This indicates why the current channel was disconnected. The value corresponds to a response code defined in the SIP protocol. Customers should refer to the SIP protocol to analyze the disconnection reason.', 'type' => 'string', 'example' => '404 - No destination', 'title' => ''], 'CallType' => [ 'description' => 'The call type of the channel.', 'enumValueTitles' => [ 'INBOUND' => '呼入', 'BARGE' => '强插', 'CONSULTANT' => 'Consultation', 'CONFERENCE' => 'Conference', 'MONITOR' => 'Monitoring', 'INTERNAL' => 'Internal Call', 'OUTBOUND' => 'Outbound', 'INTERCEPT' => 'Force Disconnect', 'BACK2BACK' => 'Dual Call', 'PREDICTIVE' => 'Predictive Outbound', 'COACH' => 'Coaching', ], 'type' => 'string', 'example' => 'OUTBOUND', 'title' => '', ], 'JobId' => ['description' => 'The call ID.', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'ChannelId' => ['description' => 'The channel ID.', 'type' => 'string', 'example' => 'ch:user:1390501****->8032****:1609138902226:job-6538214103685****', 'title' => ''], 'UserExtension' => ['description' => 'The extension number of the agent associated with the channel.', 'type' => 'string', 'example' => '8032****', 'title' => ''], 'Originator' => ['description' => 'The originator of the channel.', 'type' => 'string', 'example' => '0830019****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'UserContext' => [ 'description' => '\\[responses\\_200\\_schema\\_properties\\_Data\\_properties\\_UserContext\\_properties\\_OutboundScenario\\_description]Indicates whether the agent is in outbound-only mode.', 'type' => 'object', 'properties' => [ 'Heartbeat' => ['description' => 'The UNIX timestamp in milliseconds indicating when the last heartbeat was received from the agent.', 'type' => 'integer', 'format' => 'int64', 'example' => '1609136956378', 'title' => ''], 'Extension' => ['description' => '\\[responses\\_200\\_schema\\_properties\\_Data\\_properties\\_UserContext\\_properties\\_Mobile\\_description]The agent\'s personal phone number.', 'type' => 'string', 'example' => '8032****', 'title' => ''], 'WorkMode' => [ 'description' => '\\[responses\\_200\\_schema\\_properties\\_Data\\_properties\\_CallContext\\_properties\\_ChannelContexts\\_items\\_properties\\_Index\\_type]integer', 'enumValueTitles' => ['ON_SITE' => '\\[responses\\_200\\_schema\\_properties\\_Data\\_properties\\_CallContext\\_properties\\_ChannelContexts\\_items\\_properties\\_CallType\\_description]The call type of the channel.', 'OFF_SITE' => '\\[responses\\_200\\_schema\\_properties\\_Data\\_properties\\_CallContext\\_properties\\_ChannelContexts\\_items\\_properties\\_CallType\\_type]string', 'OFFICE_PHONE' => '\\[responses\\_200\\_schema\\_properties\\_Data\\_properties\\_CallContext\\_properties\\_ChannelContexts\\_items\\_properties\\_Index\\_description]An auto-incremented ID assigned by the system. Customers do not need to concern themselves with this value.'], 'type' => 'string', 'example' => 'ON_SITE', 'title' => '', ], 'Mobile' => ['description' => 'The agent\'s personal phone number.', 'type' => 'string', 'example' => '1324730****', 'title' => ''], 'DeviceId' => ['description' => 'Device ID, which is the identity ID of a browser-based Web Real-Time Communication (WebRTC) softphone or a physical phone device. Only one type of device can be registered at a time.', 'type' => 'string', 'example' => 'ACC-YUNBS-1.0.10-****', 'title' => ''], 'JobId' => ['description' => '\\[responses\\_200\\_schema\\_properties\\_Data\\_properties\\_CallContext\\_properties\\_ChannelContexts\\_items\\_properties\\_SkillGroupId\\_type]string', 'type' => 'string', 'example' => 'job-6538214103685****', 'title' => ''], 'UserId' => ['description' => 'Agent ID.', 'type' => 'string', 'example' => 'agent@ccc-test', 'title' => ''], 'BreakCode' => [ 'description' => 'Break status code, which can be either system-defined or customer-defined. System-defined break codes include: Warm-up (temporary break state after an agent goes online but before becoming idle), RingingTimeout (break caused by agent ringing timeout), and RejectCall (break caused by agent rejecting a call). Customer-defined status codes have no restrictions, and customers can define them according to their business needs.', 'enumValueTitles' => ['RingingTimeout' => 'Break caused by agent ringing timeout', 'RejectCall' => 'Break caused by agent rejecting a call', 'Warm-up' => 'Temporary break state after an agent goes online but before becoming idle'], 'type' => 'string', 'example' => 'Warm-up', 'title' => '', ], 'InstanceId' => ['description' => 'Instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'OutboundScenario' => ['description' => 'Indicates whether the agent is in outbound-only mode.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'UserState' => [ 'description' => '\\[responses\\_200\\_schema\\_properties\\_Data\\_properties\\_CallContext\\_properties\\_CallType\\_description]Call type.', 'enumValueTitles' => ['READY' => '\\[responses\\_200\\_schema\\_properties\\_Data\\_properties\\_CallContext\\_properties\\_CallType\\_enumValueTitles\\_MONITOR]Listener', 'WORKING' => '\\[responses\\_200\\_schema\\_properties\\_Data\\_properties\\_CallContext\\_properties\\_CallType\\_enumValueTitles\\_INTERNAL]Internal Call', 'DIALING' => '\\[responses\\_200\\_schema\\_properties\\_Data\\_properties\\_CallContext\\_properties\\_CallType\\_enumValueTitles\\_OUTBOUND]Outbound', 'BREAK' => '\\[responses\\_200\\_schema\\_properties\\_Data\\_properties\\_CallContext\\_properties\\_CallType\\_enumValueTitles\\_INTERCEPT]Intercept', 'OFFLINE' => '\\[responses\\_200\\_schema\\_properties\\_Data\\_properties\\_CallContext\\_properties\\_CallType\\_enumValueTitles\\_BACK2BACK]Back-to-Back Call', 'TALKING' => '\\[responses\\_200\\_schema\\_properties\\_Data\\_properties\\_CallContext\\_properties\\_CallType\\_enumValueTitles\\_PREDICTIVE]Predictive Outbound', 'RINGING' => '\\[responses\\_200\\_schema\\_properties\\_Data\\_properties\\_CallContext\\_properties\\_CallType\\_enumValueTitles\\_COACH]Coaching'], 'type' => 'string', 'example' => 'TALKING', 'title' => '', ], 'SignedSkillGroupIdList' => [ 'description' => '\\[responses\\_200\\_schema\\_properties\\_Data\\_properties\\_CallContext\\_properties\\_ChannelContexts\\_items\\_properties\\_ChannelId\\_type]string', 'type' => 'array', 'items' => ['description' => '\\[responses\\_200\\_schema\\_properties\\_Data\\_properties\\_CallContext\\_properties\\_ChannelContexts\\_items\\_properties\\_Timestamp\\_type]integer', 'type' => 'string', 'example' => 'skillgroup1@ccc-test', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s may not be null or blank.', 'description' => ''], ['errorCode' => 'InvalidOperation.ChannelState', 'errorMessage' => 'The operation is not allowed. Channel stats (%s) does not meet expectations (%s).', 'description' => ''], ['errorCode' => 'InvalidOperation.UserState', 'errorMessage' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.ChannelId', 'errorMessage' => 'The specified channel %s does not exist in call %s.', 'description' => ''], ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.JobId', 'errorMessage' => 'The call %s does not exist.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.CTI', 'errorMessage' => 'An internal CTI service error occurred. %s', 'description' => ''], ], ], 'title' => 'Cancel call mute', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-10-26T08:13:44.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnmuteCall'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"EEEE671A-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"CallContext\\": {\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelContexts\\": [\\n {\\n \\"Index\\": 1,\\n \\"ReleaseInitiator\\": \\"1390501****\\",\\n \\"ChannelState\\": \\"CREATED\\",\\n \\"Destination\\": \\"1390501****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"ChannelFlags\\": \\"MONITORING\\",\\n \\"SkillGroupId\\": \\"skillgroup@ccc-test\\",\\n \\"Timestamp\\": 1609138903315,\\n \\"ReleaseReason\\": \\"404 - No destination\\",\\n \\"CallType\\": \\"OUTBOUND\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"ChannelId\\": \\"ch:user:1390501****->8032****:1609138902226:job-6538214103685****\\",\\n \\"UserExtension\\": \\"8032****\\",\\n \\"Originator\\": \\"0830019****\\"\\n }\\n ]\\n },\\n \\"UserContext\\": {\\n \\"Heartbeat\\": 1609136956378,\\n \\"Extension\\": \\"8032****\\",\\n \\"WorkMode\\": \\"ON_SITE\\",\\n \\"Mobile\\": \\"1324730****\\",\\n \\"DeviceId\\": \\"ACC-YUNBS-1.0.10-****\\",\\n \\"JobId\\": \\"job-6538214103685****\\",\\n \\"UserId\\": \\"agent@ccc-test\\",\\n \\"BreakCode\\": \\"Warm-up\\",\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"OutboundScenario\\": false,\\n \\"UserState\\": \\"TALKING\\",\\n \\"SignedSkillGroupIdList\\": [\\n \\"skillgroup1@ccc-test\\"\\n ]\\n }\\n }\\n}","type":"json"}]', ], 'UnregisterDevice' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREccc8HB4RI'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'UserId', 'in' => 'query', 'schema' => ['description' => 'Agent ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'agent@ccc-test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'BA03159C-E808-4FF1-B27E-A61B6E888D7F', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => ''], ], 403 => [ ['errorCode' => 'Permission.User', 'errorMessage' => 'You have no permission to access user(s) %s.', 'description' => ''], ], [ ['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => ''], ], 500 => [ ['errorCode' => 'InternalService.DB', 'errorMessage' => 'An internal DB service error occurred. %s', 'description' => ''], ], ], 'title' => 'Delete registered device', 'summary' => 'You can invoke UnregisterDevice to delete the device registration record of a specified agent under a specified instance. After deletion, the SIP phone or SIP softphone associated with the agent becomes inactive.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnregisterDevice'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BA03159C-E808-4FF1-B27E-A61B6E888D7F\\"\\n}","type":"json"}]', ], 'UpdateCallSummary' => [ 'summary' => 'Updates a call summary.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccBCFPY3'], ], 'parameters' => [ [ 'name' => 'TicketId', 'in' => 'query', 'schema' => ['description' => 'Summary ID.', 'type' => 'string', 'required' => true, 'example' => 'f2c6722b-cd13-442d-bf10-22a07c70d6d5', 'title' => ''], ], [ 'name' => 'Context', 'in' => 'query', 'schema' => ['title' => 'Update Content ', 'description' => 'Content to update.', 'type' => 'string', 'required' => false, 'example' => '{"summaryTitle":"标题","summaryContent":"内容","keywords":"关键信息"}'], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ccc-test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'UpdateCallSummaryResponse', 'title' => 'UpdateCallSummaryResponse ', 'type' => 'object', 'properties' => [ 'Data' => ['description' => 'Data.', 'type' => 'any', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '9FBA26B0-462B-4D77-B78F-AF35560DBC71', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'Response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Params' => [ 'description' => 'List of invalid parameters.', 'type' => 'array', 'items' => ['description' => 'Invalid parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Update session summary ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"9FBA26B0-462B-4D77-B78F-AF35560DBC71\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', ], 'UpdateCampaign' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccQFUGXR'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'Cloud Contact Center instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'CampaignId', 'in' => 'query', 'schema' => ['description' => 'Predictive outbound campaign ID.', 'type' => 'string', 'required' => true, 'example' => 'ab11908b-6ebc-4b0c-b51e-3e17c7060', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'Start time, in Unix timestamp format, in milliseconds.', 'type' => 'string', 'required' => false, 'example' => '1689901200000', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'End time, in Unix timestamp format, in milliseconds.', 'type' => 'string', 'required' => false, 'example' => '1689933600000', 'title' => ''], ], [ 'name' => 'CallableTime', 'in' => 'query', 'schema' => ['description' => 'Callable time, supports multiple time segments.', 'type' => 'string', 'required' => false, 'example' => '['."\n" .' {'."\n" .' "beginTime": "09:00:00",'."\n" .' "endTime": "12:00:00"'."\n" .' }'."\n" .']', 'title' => ''], ], [ 'name' => 'StrategyParameters', 'in' => 'query', 'schema' => ['description' => 'Policy parameters.', 'type' => 'string', 'required' => false, 'example' => 'PACING策略，参考参数'."\n" .'{'."\n" .' "ratio": 2'."\n" .'}'."\n" ."\n" .'PID策略，参考参数'."\n" .'{'."\n" .' "abandonRate":5,'."\n" .' "historicalConnectedRate":45'."\n" .'}', 'title' => ''], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'Predictive outbound campaign name.', 'type' => 'string', 'required' => false, 'example' => '云联络中心测试', 'title' => ''], ], [ 'name' => 'ContactFlowId', 'in' => 'query', 'schema' => ['description' => 'Contact stream ID.', 'type' => 'string', 'required' => false, 'example' => '3a310f56-4d30-4081-ba24-5d87a3b7262e', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'BC976D32-AC4C-4E0F-8AA9-F4BC6C4E2B3E'], 'Code' => ['title' => 'code', 'description' => 'Response code.', 'type' => 'string', 'example' => 'OK'], 'Message' => ['title' => 'message', 'description' => 'Response message.', 'type' => 'string', 'example' => '无'], 'HttpStatusCode' => ['description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], ], 'example' => '', ], ], ], 'title' => 'Modify outbound call activity', 'summary' => 'Updates outbound campaign parameters.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BC976D32-AC4C-4E0F-8AA9-F4BC6C4E2B3E\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', ], 'UpdateChatRoutingProfile' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9cfad875-6260-4a53-ab6e-b13e3fb31f7d', 'title' => ''], ], [ 'name' => 'RoutingProfiles', 'in' => 'query', 'schema' => ['description' => 'The session assignment/transfer configuration.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{'."\n" .' "RoutingType": "Automatic",'."\n" .' "AgentConcurrencySettings": {'."\n" .' "AllowExceedingLimitWhenTransferring": false,'."\n" .' "ConcurrencyLimit": 4,'."\n" .' "AllowExceedingLimitWhenClaiming": true,'."\n" .' "Enabled": true'."\n" .' },'."\n" .' "ChatSettings": {'."\n" .' "IdleChatTimeoutSeconds": 300'."\n" .' },'."\n" .' "DistributionSettings": {'."\n" .' "Enabled": true,'."\n" .' "AgentRingTimeoutSeconds": 119,'."\n" .' "MaxNumberOfConversationsAgentCanMiss": 5,'."\n" .' "PostAgentMissingConversionsAction": "Nothing"'."\n" .' }'."\n" .'}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BC976D32-AC4C-4E0F-8AA9-F4BC6C4E2B3E', 'title' => ''], 'Params' => [ 'description' => 'The list of incorrect parameters.', 'type' => 'array', 'items' => ['description' => 'An incorrect parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''], ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => ''], ['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => ''], ['errorCode' => 'Parameter.Null', 'errorMessage' => 'The parameter %s must not be null.', 'description' => ''], ], 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission', 'description' => ''], ], [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => ''], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"BC976D32-AC4C-4E0F-8AA9-F4BC6C4E2B3E\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', 'title' => 'Update session transfer configuration', 'summary' => 'You can use UpdateChatRoutingProfile to configure session transfers.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'UpdateConfigItems' => [ 'summary' => 'Use the UpdateConfigItems operation to add or modify configuration items for an instance, such as hiding the caller ID for inbound calls or allowing agents to hang up.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'BearerToken' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccTMAX45'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'ObjectId', 'in' => 'query', 'schema' => ['description' => 'The ID of the object to be configured.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'ObjectType', 'in' => 'query', 'schema' => ['description' => 'The type of the object to be configured.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'INSTANCE', 'title' => ''], ], [ 'name' => 'ConfigItems', 'in' => 'query', 'schema' => [ 'description' => 'A JSON-formatted string representing an array of configuration items. Each object in the array must contain a name to identify the configuration item and its value. You can use system-defined items (which have fixed names and customizable values, such as agent permissions to hang up or the ring no answer timeout) or create custom items.', 'enumValueTitles' => ['AllowAudioDownload' => '`AllowAudioDownload`: Controls whether agents can download recordings. Valid values: `0` (No) and `1` (Yes).', 'RecordingStorageSetting' => 'The recording storage configuration for the instance.', 'AllowChooseSignedSkillGroup' => '`AllowChooseSignedSkillGroup`: Controls whether agents must manually select skill groups before signing in. Valid values: `0` (Agents are automatically signed into all their assigned skill groups) and `1` (Agents manually select which skill groups to sign into).', 'AgentRingingTimeoutSeconds' => '`AgentRingingTimeoutSeconds`: The duration in seconds before an inbound call is considered a ring no answer. The value must be an integer from 5 to 90.', 'ShowCalledID' => 'Controls how the caller ID is displayed to the agent for inbound calls. Valid values: `-1` (Hide the entire number), `0` (Hide part of the number), and `1` (Show the full number).', 'ShowCalleeID' => 'Controls how the callee\'s number is displayed to the agent for outbound calls. Valid values: `-1` (Hide the entire number), `0` (Hide part of the number), and `1` (Show the full number).', 'AllowHangup' => '`AllowHangup`: Controls whether an agent can hang up on an inbound call. Valid values: `0` (No) and `1` (Yes).', 'AutoAnswerCall' => 'Configures how agents answer inbound calls. Valid values: `-1` (Manual answer) and `n` (Automatically answer after ringing for n seconds).'], 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[{"name":"ShowCalledID","value":"-1"},{"name":"ShowCalleeID","value":"1"},{"name":"AllowHangup","value":"0"},{"name":"AutoAnswerCall","value":"-1"},{"name":"AllowAudioDownload","value":"1"},{"name":"AllowChooseSignedSkillGroup","value":"1"}]', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8E7Y5B39-3E24-4A04-81E6-6C4F5B39DF75', 'title' => ''], 'Params' => [ 'description' => '', 'type' => 'array', 'items' => ['description' => 'The response parameters.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ['errorCode' => 'NotExists.UserId', 'errorMessage' => 'The user %s does not exist in instance %s.', 'description' => ''], ], ], 'title' => 'Update Configuration Items'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', 'changeSet' => [ ['createdAt' => '2023-11-17T01:12:03.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateConfigItems'], ], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"8E7Y5B39-3E24-4A04-81E6-6C4F5B39DF75\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', ], 'UpdateSchemaProperty' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'parameters' => [ [ 'name' => 'SchemaId', 'in' => 'formData', 'schema' => ['description' => 'schema id', 'type' => 'string', 'required' => true, 'example' => 'profile', 'title' => ''], ], [ 'name' => 'Property', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Field', 'type' => 'object', 'properties' => [ 'DisplayName' => ['description' => 'Display name', 'type' => 'string', 'required' => false, 'example' => '姓名', 'title' => ''], 'Description' => ['description' => 'Description.', 'type' => 'string', 'required' => false, 'example' => '-', 'title' => ''], 'Name' => ['description' => 'Name', 'type' => 'string', 'required' => true, 'example' => 'name', 'title' => ''], 'DataType' => ['description' => 'Data type', 'type' => 'string', 'required' => true, 'example' => 'string', 'title' => ''], 'Pattern' => ['description' => 'Regular expression validation rule', 'type' => 'string', 'required' => false, 'example' => '(.*)', 'title' => ''], 'PatternErrorMessage' => ['description' => 'Regular expression validation error message', 'type' => 'string', 'required' => false, 'example' => '不是有效的email地址', 'title' => ''], 'MinLength' => ['description' => 'Minimum length', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], 'MaxLength' => ['description' => 'Maximum length', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], 'Minimum' => ['description' => 'Minimum value', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '10800', 'title' => ''], 'Maximum' => ['description' => 'Maximum value', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '11', 'title' => ''], 'Required' => ['description' => 'Required', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], 'Disabled' => ['description' => 'Indicates whether the property is disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], 'Array' => ['description' => 'Specifies whether the property is an array.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], 'ReadOnly' => ['description' => 'Read-only', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], 'EditorType' => ['description' => 'Editor type', 'type' => 'string', 'required' => false, 'example' => 'textbox', 'title' => ''], 'Attributes' => ['description' => 'Extension attributes', 'type' => 'string', 'required' => false, 'example' => '{\\"instanceId\\":\\"4cc3f160-ca64-49ff-bc70-390a044a4e83\\",\\"appId\\":\\"1684145288664\\",\\"commodityCode\\":\\"dide_pre\\",\\"dide_pre_set\\":\\"version_ent\\"}', 'title' => ''], 'DisplayOrder' => ['description' => 'Display order', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'RequestId', 'in' => 'formData', 'schema' => ['description' => 'Request ID', 'type' => 'string', 'required' => false, 'example' => 'BC976D32-AC4C-4E0F-8AA9-F4BC6C4E2B3E', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', 'schema' => ['description' => 'Instance ID', 'type' => 'string', 'required' => true, 'example' => 'b0eb2742-f37e-4c67-82d4-25c651c1xxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'UpdateSchemaPropertyResponse', 'title' => 'UpdateSchemaPropertyResponse ', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'A450574A-337F-43E2-BC59-9C6594C994C6', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'Response code', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Params' => [ 'description' => 'Response parameters.', 'type' => 'array', 'items' => ['description' => 'Parameter information.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A450574A-337F-43E2-BC59-9C6594C994C6\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', 'title' => 'Update schema field ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'summary' => '', ], 'UpdateSubscription' => [ 'summary' => 'Use the UpdateSubscription operation to configure message subscriptions.', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcccD5GAHN'], ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the Cloud Contact Center instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'AliyunUid', 'in' => 'query', 'schema' => ['description' => 'Leave blank.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '无', 'title' => ''], ], [ 'name' => 'ProducerId', 'in' => 'query', 'schema' => ['description' => 'For Message Queue (MQ), enter the Group ID. For webhook, enter PID\\_Webhook.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'GID_xxx', 'title' => ''], ], [ 'name' => 'DefaultTopic', 'in' => 'query', 'schema' => ['description' => 'For MQ, enter the topic name. For webhook, enter Topic\\_Webhook.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'ccc-event', 'title' => ''], ], [ 'name' => 'AccessPoint', 'in' => 'query', 'schema' => ['description' => 'The endpoint for MQ. The service endpoint for webhook.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rmq-cn-****.cn-shanghai.rmq.aliyuncs.com:8080', 'title' => ''], ], [ 'name' => 'EventSubscriptionsJson', 'in' => 'query', 'schema' => ['description' => 'The message subscription checklist.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[{"Name ":"StopConsultant ","Disabled ":true},{"Name ":"QueueingRerouted ","Disabled ":true},{"Name ":"IvrTracking ","Disabled ":true},{"Name ":"DualTrackRecordingReady ","Disabled ":true},{"Name ":"SatisfactionSurveyResponse ","Disabled ":true},{"Name ":"Dialing ","Disabled ":false},{"Name ":"Abandoned ","Disabled ":true},{"Name ":"QueueingCancelled ","Disabled ":true},{"Name ":"RecordingReady ","Disabled ":true},{"Name ":"StopCoach ","Disabled ":true},{"Name ":"Established ","Disabled ":true},{"Name ":"InitiateConsultant ","Disabled ":true},{"Name ":"Route2IVR ","Disabled ":false},{"Name ":"Retrieved ","Disabled ":true},{"Name ":"CampaignPaused ","Disabled ":true},{"Name ":"TextStream ","Disabled ":true},{"Name ":"AgentRelease ","Disabled ":true},{"Name ":"VoicemailReady ","Disabled ":true},{"Name ":"Released ","Disabled ":false},{"Name ":"CDRReady ","Disabled ":true},{"Name ":"CaseAttempted ","Disabled ":true},{"Name ":"AgentBreak ","Disabled ":true},{"Name ":"AgentRingingTimeout ","Disabled ":true},{"Name ":"AgentReady ","Disabled ":true},{"Name ":"CampaignResumed ","Disabled ":true},{"Name ":"AgentDialing ","Disabled ":true},{"Name ":"Ringing ","Disabled ":true},{"Name ":"StartConsultant ","Disabled ":false},{"Name ":"QueueingTimeout ","Disabled ":true},{"Name ":"AgentTalk ","Disabled ":true},{"Name ":"AgentRinging ","Disabled ":true},{"Name ":"StartMonitor ","Disabled ":true},{"Name ":"BlindTransfer ","Disabled ":true},{"Name ":"Intercept ","Disabled ":true},{"Name ":"RingingTimeout ","Disabled ":true},{"Name ":"StartConference ","Disabled ":true},{"Name ":"QueueingOverflow ","Disabled ":true},{"Name ":"BargeIn ","Disabled ":true},{"Name ":"StopConference ","Disabled ":true},{"Name ":"AgentCheckOut ","Disabled ":true},{"Name ":"CampaignSubmitted ","Disabled ":true},{"Name ":"AgentCheckIn ","Disabled ":true},{"Name ":"Enqueue ","Disabled ":false},{"Name ":"AttendedTransfer ","Disabled ":true},{"Name ":"StopMonitor ","Disabled ":true},{"Name ":"DispatchingFailure ","Disabled ":true},{"Name ":"SatisfactionSurveyOffer ","Disabled ":true},{"Name ":"CampaignCompleted ","Disabled ":true},{"Name ":"CampaignAborted ","Disabled ":true},{"Name ":"AssignAgent ","Disabled ":true},{"Name ":"Held ","Disabled ":true},{"Name ":"StartCoach ","Disabled ":true}]', 'title' => ''], ], [ 'name' => 'MqType', 'in' => 'query', 'schema' => ['description' => 'The message push type.'."\n" ."\n" .'- rocketmq4'."\n" ."\n" .'- rocketmq5'."\n" ."\n" .'- webhook', 'type' => 'string', 'required' => false, 'example' => 'rocketmq5', 'title' => ''], ], [ 'name' => 'Username', 'in' => 'query', 'schema' => ['description' => 'The MQ username. Specify this only when MqType is rocketmq5.', 'type' => 'string', 'required' => false, 'example' => 'username', 'title' => ''], ], [ 'name' => 'Password', 'in' => 'query', 'schema' => ['description' => 'The MQ password. Specify this only when MqType is rocketmq5.', 'type' => 'string', 'required' => false, 'example' => 'password', 'title' => ''], ], [ 'name' => 'MqInstanceId', 'in' => 'query', 'schema' => ['description' => 'The MQ instance ID. Specify this only when MqType is rocketmq4 or rocketmq5.', 'type' => 'string', 'required' => false, 'example' => 'rmq-cn-****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '03C67DAD-EB26-41D8-949D-9B0C470FB716', 'title' => ''], 'Params' => [ 'description' => 'The list of invalid parameters.', 'type' => 'array', 'items' => ['description' => 'An invalid parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], 'Data' => [ 'description' => 'Data.', 'type' => 'object', 'properties' => [ 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'ccc-test', 'title' => ''], 'ProducerId' => ['description' => 'For MQ, enter the Group ID. For webhook, enter PID\\_Webhook.', 'type' => 'string', 'example' => 'GID_xxx', 'title' => ''], 'Topic' => ['description' => 'For MQ, enter the topic name. For webhook, enter Topic\\_Webhook.', 'type' => 'string', 'example' => 'ccc-event', 'title' => ''], 'AccessPoint' => ['description' => 'The endpoint for MQ. The service endpoint for webhook.', 'type' => 'string', 'example' => 'rmq-cn-****.cn-shanghai.rmq.aliyuncs.com:8080', 'title' => ''], 'Username' => ['description' => 'The MQ username. Specify this only when MqType is rocketmq5.', 'type' => 'string', 'example' => 'username', 'title' => ''], 'MqType' => ['description' => 'The message push type.'."\n" ."\n" .'- rocketmq4'."\n" ."\n" .'- rocketmq5'."\n" ."\n" .'- webhook', 'type' => 'string', 'example' => 'rocketmq5', 'title' => ''], 'MqInstanceId' => ['description' => 'The MQ instance ID. Specify this only when MqType is rocketmq4 or rocketmq5.', 'type' => 'string', 'example' => 'rmq-cn-****', 'title' => ''], 'EventList' => [ 'description' => 'The event checklist.', 'type' => 'array', 'items' => [ 'description' => 'An event.', 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'The event name.', 'type' => 'string', 'example' => 'Dialing', 'title' => ''], 'Disabled' => ['description' => 'Indicates whether the push is disabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Topic' => ['description' => 'The event topic.', 'type' => 'string', 'example' => '无', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Parameter.Blank', 'errorMessage' => 'The parameter %s must not be null or empty.', 'description' => ''], ['errorCode' => 'Parameter.Enumeration', 'errorMessage' => 'The parameter %s must be one of the value of enumeration %s.', 'description' => ''], ['errorCode' => 'Parameter.Empty', 'errorMessage' => 'The parameter %s may not be null or empty.', 'description' => ''], ], 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'title' => 'Configure message subscription', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"03C67DAD-EB26-41D8-949D-9B0C470FB716\\",\\n \\"Params\\": [\\n \\"无\\"\\n ],\\n \\"Data\\": {\\n \\"InstanceId\\": \\"ccc-test\\",\\n \\"ProducerId\\": \\"GID_xxx\\",\\n \\"Topic\\": \\"ccc-event\\",\\n \\"AccessPoint\\": \\"rmq-cn-****.cn-shanghai.rmq.aliyuncs.com:8080\\",\\n \\"Username\\": \\"username\\",\\n \\"MqType\\": \\"rocketmq5\\",\\n \\"MqInstanceId\\": \\"rmq-cn-****\\",\\n \\"EventList\\": [\\n {\\n \\"Name\\": \\"Dialing\\",\\n \\"Disabled\\": true,\\n \\"Topic\\": \\"无\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'UpdateTicket' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ccc-test', 'title' => ''], ], [ 'name' => 'TicketId', 'in' => 'query', 'schema' => ['description' => 'The ticket ID.', 'type' => 'string', 'required' => true, 'example' => '5491d3b4-14ee-4341-b5f1-db2c78beddeb', 'title' => ''], ], [ 'name' => 'Title', 'in' => 'query', 'schema' => ['description' => 'The ticket title.', 'type' => 'string', 'required' => false, 'example' => '标题', 'title' => ''], ], [ 'name' => 'CustomerId', 'in' => 'query', 'schema' => ['description' => 'The user ID.', 'type' => 'string', 'required' => false, 'example' => '51e155ce-***-****-b402-13c69597b920', 'title' => ''], ], [ 'name' => 'Context', 'in' => 'query', 'schema' => ['description' => 'The ticket form information.', 'type' => 'string', 'required' => false, 'example' => '{"productName":"玩具1"}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'UpdateTicketResponse', 'title' => 'UpdateTicketResponse', 'type' => 'object', 'properties' => [ 'Data' => ['description' => 'The data.', 'type' => 'any', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7BEEA660-A45A-45E3-98CC-AFC65E715C23', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Params' => [ 'description' => 'The list of error parameters.', 'type' => 'array', 'items' => ['description' => 'The error parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"7BEEA660-A45A-45E3-98CC-AFC65E715C23\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', 'title' => 'Update ticket information', 'summary' => 'UpdateTicket updates the content of a ticket.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], 'WithdrawTicket' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'TicketId', 'in' => 'query', 'schema' => ['description' => 'The ticket ID.', 'type' => 'string', 'required' => true, 'example' => '5491d3b4-14ee-4341-b5f1-db2c78beddeb', 'title' => ''], ], [ 'name' => 'Comment', 'in' => 'query', 'schema' => ['description' => 'The comments.', 'type' => 'string', 'required' => true, 'example' => '撤回，补充信息', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ccc-test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'CancelTicketResponse', 'title' => 'CancelTicketResponse', 'type' => 'object', 'properties' => [ 'Data' => ['description' => 'The data.', 'type' => 'any', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2778FA12-EDD6-42AA-9B15-AF855072E5E5', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Params' => [ 'description' => 'The list of error parameters.', 'type' => 'array', 'items' => ['description' => 'The error parameter.', 'type' => 'string', 'example' => '无', 'title' => ''], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'NotExists.InstanceId', 'errorMessage' => 'The specified instance %s does not exist.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"无\\",\\n \\"RequestId\\": \\"2778FA12-EDD6-42AA-9B15-AF855072E5E5\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Params\\": [\\n \\"无\\"\\n ]\\n}","type":"json"}]', 'title' => 'Revoke Ticket', 'summary' => 'You can use WithdrawTicket to withdraw a ticket.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], 'product' => ['code' => 'ccc', 'title' => '云呼叫中心'], ], 'ramActions' => [], ], ], 'endpoints' => [ ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ccc.cn-shanghai.aliyuncs.com', 'endpoint' => 'ccc.cn-shanghai.aliyuncs.com', 'vpc' => 'ccc-vpc.cn-shanghai.aliyuncs.com'], ], 'errorCodes' => [ ['code' => 'AbnormalService.Ceased', 'message' => 'Service abnormal. The instance %s is stopped.', 'http_code' => 403, 'description' => ''], ['code' => 'AbnormalService.Creating', 'message' => 'Service abnormal. The instance %s is being created.', 'http_code' => 403, 'description' => ''], ['code' => 'AbnormalService.Disabled', 'message' => 'Service abnormal. Call center service of %s is not enabled.', 'http_code' => 403, 'description' => ''], ['code' => 'AlreadyExists.CustomNumber', 'message' => 'Custom number already exists.', 'http_code' => 409, 'description' => ''], ['code' => 'AlreadyExists.DomainName', 'message' => 'Instance %s already exists.', 'http_code' => 409, 'description' => 'The cloud contact center instance already exists.'], ['code' => 'AlreadyExists.InstanceId', 'message' => 'The instance %s already exists.', 'http_code' => 409, 'description' => 'The cloud contact center instance already exists.'], ['code' => 'AlreadyExists.PhoneNumber', 'message' => 'The specified number %s already exists in the instance.', 'http_code' => 409, 'description' => ''], ['code' => 'AlreadyExists.RamUser', 'message' => 'RAM user %s already exists.', 'http_code' => 409, 'description' => ''], ['code' => 'AlreadyExists.SkillGroupId', 'message' => 'Skill group %s already exists in instance %s.', 'http_code' => 409, 'description' => 'The specified skill group already exists in the cloud contact center instance.'], ['code' => 'AlreadyExists.User', 'message' => 'User %s already exists in instance %s.', 'http_code' => 409, 'description' => ''], ['code' => 'AlreadyExists.UserName', 'message' => 'User name %s already exists。', 'http_code' => 409, 'description' => ''], ['code' => 'Authentication.Signature', 'message' => 'Failed to generate signature for SIP authentication.', 'http_code' => 500, 'description' => ''], ['code' => 'InternalService.AC', 'message' => 'An internal AC service error occurred. %s', 'http_code' => 500, 'description' => ''], ['code' => 'InternalService.Account', 'message' => 'An internal Account service error occurred. %s', 'http_code' => 500, 'description' => ''], ['code' => 'InternalService.Common', 'message' => 'An internal service error occurred. %s', 'http_code' => 500, 'description' => ''], ['code' => 'InternalService.CTI', 'message' => 'An internal CTI service error occurred. %s', 'http_code' => 500, 'description' => ''], ['code' => 'InternalService.DB', 'message' => 'An internal DB service error occurred. %s', 'http_code' => 500, 'description' => ''], ['code' => 'InternalService.IVR', 'message' => 'An internal IVR service error occurred. %s', 'http_code' => 500, 'description' => ''], ['code' => 'InternalService.OSS', 'message' => 'An internal OSS service error occurred. %s', 'http_code' => 500, 'description' => ''], ['code' => 'InternalService.RAM', 'message' => 'An internal RAM service error occurred. %s', 'http_code' => 500, 'description' => ''], ['code' => 'InternalService.Redis', 'message' => 'An internal Redis service error occurred. %s', 'http_code' => 500, 'description' => ''], ['code' => 'InternalService.ResourcePlatform', 'message' => 'An internal ResourcePlatform service error occurred. %s', 'http_code' => 500, 'description' => ''], ['code' => 'InternalService.STS', 'message' => 'An internal STS service error occurred. %s', 'http_code' => 500, 'description' => ''], ['code' => 'InternalService.WorkFlow', 'message' => 'An internal WorkFlow service error occurred. %s', 'http_code' => 500, 'description' => ''], ['code' => 'InUse.Instance', 'message' => 'Instance %s is in use now.', 'http_code' => 400, 'description' => ''], ['code' => 'InUse.SkillGroup', 'message' => 'Skill group %s is in use now.', 'http_code' => 400, 'description' => ''], ['code' => 'InvalidOperation.ChannelState', 'message' => 'The operation is not allowed. Channel state (%s) does not meet expectations (%s).', 'http_code' => 400, 'description' => 'Invalid operation. The channel status does not meet expectations.'], ['code' => 'InvalidOperation.ContactFlow', 'message' => 'The operation is not allowed. Contact flow %s is edited by someone else.', 'http_code' => 400, 'description' => ''], ['code' => 'InvalidOperation.DeviceState', 'message' => 'The operation is not allowed. Device state (%s) does not meet expectations (%s).', 'http_code' => 400, 'description' => ''], ['code' => 'InvalidOperation.DraftContactFlow', 'message' => 'Draft %s of ContactFlow %s is edited by someone else.', 'http_code' => 400, 'description' => ''], ['code' => 'InvalidOperation.DuplicatedCallee', 'message' => 'The operation is not allowed. The called number %s already exists in call %s.', 'http_code' => 400, 'description' => ''], ['code' => 'InvalidOperation.SignedSkillGroup', 'message' => 'The operation is not allowed. User have not yet signed in any skill group.', 'http_code' => 400, 'description' => ''], ['code' => 'InvalidOperation.UserState', 'message' => 'The operation is not allowed. User state (%s) does not meet expectations (%s).', 'http_code' => 400, 'description' => ''], ['code' => 'LimitExceed.CallTagsPerInstance', 'message' => 'The total number of call tag of the instance exceeds the limit %s.', 'http_code' => 400, 'description' => ''], ['code' => 'LimitExceed.CallTagsPerNumber', 'message' => 'The total number of call tag of numbers exceeds the limit %s.', 'http_code' => 400, 'description' => ''], ['code' => 'LimitExceeded.File', 'message' => 'The size of the file exceeds the limit of %s MB.', 'http_code' => 400, 'description' => ''], ['code' => 'LimitExceeded.SkillGroup', 'message' => 'The total count of skill group exceeds the limit %s.', 'http_code' => 400, 'description' => ''], ['code' => 'LimitExceeded.SkillGroupsPerUser', 'message' => 'The total count of skill group of a user exceeds the limit %s.', 'http_code' => 400, 'description' => ''], ['code' => 'LimitExceeded.User', 'message' => 'The total count of user exceeds the limit %s.', 'http_code' => 400, 'description' => ''], ['code' => 'NoPermission.User', 'message' => 'User %s has no permission to %s.', 'http_code' => 403, 'description' => ''], ['code' => 'NotExist.Instance', 'message' => 'Call center instance %s does not exist.', 'http_code' => 404, 'description' => 'The cloud contact center instance% s does not exist.'], ['code' => 'NotExist.SkillGroup', 'message' => 'Skill group %s does not exist.', 'http_code' => 404, 'description' => ''], ['code' => 'NotExist.User', 'message' => 'User %s of instance %s does not exist.', 'http_code' => 404, 'description' => ''], ['code' => 'NotExists.AudioResourceFileKey', 'message' => 'Audio resource file key %s does not exist.', 'http_code' => 404, 'description' => ''], ['code' => 'NotExists.AudioResourceId', 'message' => 'Audio resource %s does not exists.', 'http_code' => 404, 'description' => ''], ['code' => 'NotExists.ChannelId', 'message' => 'The specified channel %s does not exist in call %s.', 'http_code' => 404, 'description' => ''], ['code' => 'NotExists.ContactFlowDraftId', 'message' => 'Draft %s of contact flow %s does not exist in instance %s.', 'http_code' => 404, 'description' => ''], ['code' => 'NotExists.ContactFlowId', 'message' => 'Contact flow %s does not exist in instance %s.', 'http_code' => 404, 'description' => 'The specified contact flow does not exist in the cloud contact center instance.'], ['code' => 'NotExists.ContactFlowSnapshotId', 'message' => 'Snapshot %s of contact flow %s does not exist in instance %s.', 'http_code' => 404, 'description' => 'The specified snapshot does not exist in the contact flow for the cloud contact center instance.'], ['code' => 'NotExists.CustomCallTagging', 'message' => 'Custom call tagging %s does not exist in instance %s.', 'http_code' => 404, 'description' => ''], ['code' => 'NotExists.Extension', 'message' => 'No available extension number exists.', 'http_code' => 404, 'description' => ''], ['code' => 'NotExists.FunctionMetaId', 'message' => 'Function meta %s does not exist in instance %s.', 'http_code' => 404, 'description' => ''], ['code' => 'NotExists.InstanceId', 'message' => 'The specified instance %s does not exist.', 'http_code' => 404, 'description' => ''], ['code' => 'NotExists.JobId', 'message' => 'The call %s does not exist.', 'http_code' => 404, 'description' => ''], ['code' => 'NotExists.Number', 'message' => 'The specified number %s does not exist in instance %s.', 'http_code' => 404, 'description' => ''], ['code' => 'NotExists.OutboundNumber', 'message' => 'A valid number for outbound call is not found.', 'http_code' => 404, 'description' => ''], ['code' => 'NotExists.RamId', 'message' => 'RAM user %s does not exist.', 'http_code' => 404, 'description' => ''], ['code' => 'NotExists.RoleId', 'message' => 'Role %s does not exist.', 'http_code' => 404, 'description' => ''], ['code' => 'NotExists.SkillGroupId', 'message' => 'The skill group ID %s does not exist in instance %s.', 'http_code' => 404, 'description' => ''], ['code' => 'NotExists.SkillGroupName', 'message' => 'The skill group name %s does not exist in instance %s.', 'http_code' => 404, 'description' => 'The specified skill group name does not exist in the cloud contact center instance.'], ['code' => 'NotExists.Switch', 'message' => 'The switch %s does not exist.', 'http_code' => 404, 'description' => ''], ['code' => 'NotExists.UserId', 'message' => 'The user %s does not exist in instance %s.', 'http_code' => 404, 'description' => ''], ['code' => 'NotExists.UserResourceFileKey', 'message' => 'User resource file key %s does not exist.', 'http_code' => 404, 'description' => ''], ['code' => 'NotFound.CallingNumber', 'message' => 'No available calling number found in the group %s.', 'http_code' => 404, 'description' => ''], ['code' => 'Parameter.Blank', 'message' => 'The parameter %s may not be null or blank.', 'http_code' => 400, 'description' => ''], ['code' => 'Parameter.Blank', 'message' => 'The parameter %s must not be null or empty.', 'http_code' => 400, 'description' => ''], ['code' => 'Parameter.CallerType', 'message' => 'Invalid caller type. Caller type (%s) does not meet expectations (%s).', 'http_code' => 400, 'description' => ''], ['code' => 'Parameter.Empty', 'message' => 'The parameter %s may not be null or empty.', 'http_code' => 400, 'description' => ''], ['code' => 'Parameter.Enumeration', 'message' => 'The parameter %s must be one of the value of enumeration %s.', 'http_code' => 400, 'description' => ''], ['code' => 'Parameter.Format', 'message' => 'The format of parameter %s is invalid. %s', 'http_code' => 400, 'description' => ''], ['code' => 'Parameter.Invalid', 'message' => 'The parameter %s is invalid. %s.', 'http_code' => 400, 'description' => ''], ['code' => 'Parameter.InvalidFileContent', 'message' => 'The content or format of the file (%s) is invalid.', 'http_code' => 400, 'description' => ''], ['code' => 'Parameter.Maximum', 'message' => 'The parameter %s must be less than or equal to %s.', 'http_code' => 400, 'description' => ''], ['code' => 'Parameter.Minimum', 'message' => 'The parameter %s must be greater than or equal to %s.', 'http_code' => 400, 'description' => ''], ['code' => 'Parameter.Null', 'message' => 'The parameter %s may not be null.', 'http_code' => 400, 'description' => ''], ['code' => 'Parameter.UnknownCaller', 'message' => 'Invalid caller. Caller UID is null.', 'http_code' => 400, 'description' => ''], ['code' => 'Permission.Common', 'message' => 'You have no permission to access. %s', 'http_code' => 403, 'description' => ''], ['code' => 'Permission.Instance', 'message' => 'You have no permission to access instance %s.', 'http_code' => 403, 'description' => ''], ['code' => 'Permission.PhoneNumber', 'message' => 'You have no permission to access number(s) %s.', 'http_code' => 403, 'description' => ''], ['code' => 'Permission.RAM', 'message' => 'You are not authorized to perform this action. RAM authorization is required.', 'http_code' => 403, 'description' => ''], ['code' => 'Permission.Role', 'message' => 'You have no permission to access role %s.', 'http_code' => 403, 'description' => ''], ['code' => 'Permission.SkillGroup', 'message' => 'You have no permission to access skill group(s) %s.', 'http_code' => 403, 'description' => ''], ['code' => 'Permission.StsToken', 'message' => 'You have no permission to access sts token %s.', 'http_code' => 403, 'description' => ''], ['code' => 'Permission.Unauthorized', 'message' => 'You are not authorized to perform this action. %s privileges are required.', 'http_code' => 403, 'description' => ''], ['code' => 'Permission.User', 'message' => 'You have no permission to access user(s) %s.', 'http_code' => 403, 'description' => ''], ['code' => 'UserBusy', 'message' => 'The user %s you called was busy. Please try again later.', 'http_code' => 400, 'description' => ''], ], 'changeSet' => [ [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'AppendCases'], ], 'createdAt' => '2025-11-13T08:46:40.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateCampaign'], ], 'createdAt' => '2025-11-13T08:46:38.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateInstance'], ], 'createdAt' => '2025-10-28T09:55:47.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'MakeCall'], ], 'createdAt' => '2025-04-08T07:49:31.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'ListRealtimeAgentStates'], ], 'createdAt' => '2025-02-13T02:21:36.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'GetConversationDetail'], ], 'createdAt' => '2024-12-12T15:21:10.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'BlindTransfer'], ], 'createdAt' => '2024-10-28T02:30:54.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListCallDetailRecordsV2'], ], 'createdAt' => '2024-09-06T02:26:42.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'MakeCall'], ], 'createdAt' => '2024-08-30T02:21:15.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'LaunchSurvey'], ], 'createdAt' => '2024-08-13T06:55:08.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'ListCallDetailRecords'], ], 'createdAt' => '2024-07-29T10:26:01.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'ListRealtimeAgentStates'], ['description' => 'Request parameters changed', 'api' => 'ListRealtimeSkillGroupStates'], ], 'createdAt' => '2024-06-21T06:52:51.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'LaunchSurvey'], ], 'createdAt' => '2024-06-21T06:40:38.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'GetCampaign'], ['description' => 'Response parameters changed', 'api' => 'ListCampaigns'], ], 'createdAt' => '2024-06-06T11:38:32.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'ListSkillGroupSummaryReportsSinceMidnight'], ], 'createdAt' => '2024-06-06T07:19:33.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'ListSkillGroupSummaryReportsSinceMidnight'], ], 'createdAt' => '2024-05-28T06:54:30.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'ListSkillGroupSummaryReportsSinceMidnight'], ], 'createdAt' => '2024-05-17T08:45:26.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'ListSkillGroupSummaryReportsSinceMidnight'], ], 'createdAt' => '2024-05-15T02:47:21.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'ListSkillGroupSummaryReportsSinceMidnight'], ], 'createdAt' => '2024-04-24T12:54:41.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'BlindTransfer'], ['description' => 'Request parameters changed', 'api' => 'InitiateAttendedTransfer'], ], 'createdAt' => '2024-04-01T09:23:20.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'AnswerCall'], ], 'createdAt' => '2024-02-05T03:20:31.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'ListUnassignedNumbers'], ], 'createdAt' => '2024-02-02T03:52:45.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'ListCustomCallTagging'], ], 'createdAt' => '2024-01-29T09:14:31.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'MuteCall'], ], 'createdAt' => '2024-01-18T12:07:59.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CoachCall'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'MakeCall'], ], 'createdAt' => '2024-01-11T08:11:54.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateUser'], ], 'createdAt' => '2023-12-22T03:22:19.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateAudioFile'], ['description' => 'Response parameters changed', 'api' => 'GetCampaign'], ['description' => 'Response parameters changed', 'api' => 'GetHistoricalCampaignReport'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetHistoricalInstanceReport'], ['description' => 'Response parameters changed', 'api' => 'ListCampaignTrendingReport'], ['description' => 'Response parameters changed', 'api' => 'ListCases'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListHistoricalAgentReport'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListHistoricalAgentSkillGroupReport'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListHistoricalSkillGroupReport'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListIntervalAgentReport'], ], 'createdAt' => '2023-11-22T01:05:50.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListAudioFiles'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListBriefSkillGroups'], ['description' => 'Response parameters changed', 'api' => 'ListCampaigns'], ['description' => 'Request parameters changed', 'api' => 'ModifyAudioFile'], ['description' => 'Response parameters changed', 'api' => 'ModifySkillLevelsOfUser'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ModifyUser'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'PollUserStatus'], ['description' => 'Response parameters changed', 'api' => 'RemovePhoneNumbers'], ], 'createdAt' => '2023-11-17T01:12:22.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'AddNumbersToSkillGroup'], ['description' => 'Request parameters changed', 'api' => 'BlindTransfer'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateUser'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetInstanceTrendingReport'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetLoginDetails'], ], 'createdAt' => '2023-11-07T07:22:42.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateSkillGroup'], ['description' => 'Response parameters changed', 'api' => 'ExportDoNotCallNumbers'], ['description' => 'Response parameters changed', 'api' => 'GetSkillGroup'], ['description' => 'Response parameters changed', 'api' => 'GetTurnCredentials'], ['description' => 'Response parameters changed', 'api' => 'GetTurnServerList'], ['description' => 'Response parameters changed', 'api' => 'ImportDoNotCallNumbers'], ['description' => 'Request parameters changed', 'api' => 'InterceptCall'], ['description' => 'Request parameters changed', 'api' => 'ListContactFlows'], ], 'createdAt' => '2023-11-06T05:45:10.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'BargeInCall'], ['description' => 'Request parameters changed', 'api' => 'CancelAttendedTransfer'], ['description' => 'Request parameters changed', 'api' => 'CompleteAttendedTransfer'], ['description' => 'Request parameters changed', 'api' => 'HoldCall'], ['description' => 'Request parameters changed', 'api' => 'InitiateAttendedTransfer'], ], 'createdAt' => '2023-10-26T08:14:09.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'AnswerCall'], ], 'createdAt' => '2023-10-26T07:16:03.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'ListCallDetailRecords'], ], 'createdAt' => '2023-10-09T15:22:58.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'AnswerCall'], ['description' => 'Response parameters changed', 'api' => 'ReleaseCall'], ], 'createdAt' => '2023-06-05T23:22:27.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetMonoRecording'], ], 'createdAt' => '2023-06-05T09:02:03.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'ListHistoricalAgentReport'], ['description' => 'Response parameters changed', 'api' => 'ListIntervalAgentReport'], ], 'createdAt' => '2023-05-23T11:59:19.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'ListAgentStateLogs'], ], 'createdAt' => '2023-05-10T07:29:56.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'ListMultiChannelRecordings'], ], 'createdAt' => '2023-05-08T07:40:22.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'BlindTransfer'], ['description' => 'Request parameters changed', 'api' => 'InitiateAttendedTransfer'], ], 'createdAt' => '2023-04-25T07:34:05.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ModifyUser'], ['description' => 'Request parameters changed', 'api' => 'RemoveUsers'], ], 'createdAt' => '2023-04-14T05:54:27.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'BlindTransfer'], ['description' => 'Request parameters changed', 'api' => 'InitiateAttendedTransfer'], ], 'createdAt' => '2023-04-12T02:15:44.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'ListCallDetailRecords'], ], 'createdAt' => '2023-03-24T08:21:09.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'RedialCall'], ], 'createdAt' => '2022-12-30T02:50:22.000Z', 'description' => 'Redia接口参数调整', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'ListCallDetailRecords'], ], 'createdAt' => '2022-12-07T10:57:14.000Z', 'description' => '- Support ListCallDetailRecords DialingTime response.', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'ListLegacyAppraiseLogs'], ], 'createdAt' => '2022-12-06T08:58:56.000Z', 'description' => '- Add ListAppraiseLogs api.', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'ChangeWorkMode'], ], 'createdAt' => '2022-11-28T07:11:28.000Z', 'description' => '修改工作模式增加签入技能组和移动号码参数', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'PollUserStatus'], ], 'createdAt' => '2022-11-28T06:52:47.000Z', 'description' => '增加CallVariables', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'ListSkillGroupStates'], ], 'createdAt' => '2022-11-25T02:04:46.000Z', 'description' => '- ListSkillGroupStates support inbound/outbound agent count by inbound/outbound.', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'GetAudioFile'], ['description' => 'Response parameters changed', 'api' => 'ListAudioFiles'], ], 'createdAt' => '2022-10-17T02:12:18.000Z', 'description' => '删除录音相关接口中无效的返回字段。', ], [ 'apis' => [ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListRealtimeAgentStates'], ], 'createdAt' => '2022-10-17T02:12:17.000Z', 'description' => '- ListRealtimeAgentStates支持Query和CallTypeList查询', ], [ 'apis' => [ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListAgentStates'], ], 'createdAt' => '2022-10-17T02:12:16.000Z', 'description' => '- 增加excludeOfflineUsers查询参数', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'GetCallDetailRecord'], ['description' => 'Response parameters changed', 'api' => 'ListCallDetailRecords'], ], 'createdAt' => '2022-10-14T06:48:16.000Z', 'description' => '- Supported releaseReason response', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'StartPrivacyCall'], ], 'createdAt' => '2022-09-07T02:00:28.000Z', 'description' => 'StartPrivacyCall提供Open Api', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'GetUploadAudioDataParams'], ], 'createdAt' => '2022-08-24T07:35:41.000Z', 'description' => '- support api for getting quality check params', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'ListRealtimeAgentStates'], ], 'createdAt' => '2022-07-12T04:34:09.000Z', 'description' => '变更ListRealtimeAgentStates接口的SkillgroupId参数的文档必填熟悉为关闭。', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'ListLegacyAgentEventLogs'], ['description' => 'OpenAPI offline', 'api' => 'ListLegacyAgentStatusLogs'], ['description' => 'OpenAPI offline', 'api' => 'ListLegacyQueueEventLogs'], ], 'createdAt' => '2022-07-05T09:31:50.000Z', 'description' => '- support legacy api', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'ListSkillGroupStates'], ], 'createdAt' => '2022-07-04T11:52:53.000Z', 'description' => '- 返回技能组仅外呼空闲坐席数量', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'ListHistoricalAgentReport'], ], 'createdAt' => '2022-07-04T11:50:45.000Z', 'description' => '- ListHistoricalAgentReport返回技能组相关信息', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'ListAgentStates'], ], 'createdAt' => '2022-07-01T13:18:19.000Z', 'description' => '- 新增仅外呼状态返回值', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'ListPhoneNumbers'], ], 'createdAt' => '2022-06-30T08:59:40.000Z', 'description' => '删除ListPhoneNumbers中无效的返回字段。', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'ListSkillGroupStates'], ['description' => 'Response parameters changed', 'api' => 'ListSkillGroupSummaryReportsSinceMidnight'], ], 'createdAt' => '2022-06-15T03:11:04.000Z', 'description' => '- 支持acc部分字段', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'ListSkillGroupStates'], ['description' => 'Response parameters changed', 'api' => 'ListSkillGroupSummaryReportsSinceMidnight'], ], 'createdAt' => '2022-06-07T11:35:47.000Z', 'description' => '- 增加10秒服务水平', ], [ 'apis' => [ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListRealtimeAgentStates'], ], 'createdAt' => '2022-05-25T03:04:15.000Z', 'description' => '- 增加ListRealtimeAgentStates返回参数WorkMode/OutboundScenario', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'ImportAdmins'], ], 'createdAt' => '2022-04-20T06:13:53.000Z', 'description' => 'Support ImportAdmin', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateCampaign'], ], 'createdAt' => '2022-04-18T03:06:59.000Z', 'description' => 'CreateCamapign支持SP参数', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'AnswerCall'], ['description' => 'Response parameters changed', 'api' => 'BlindTransfer'], ['description' => 'Response parameters changed', 'api' => 'LaunchSurvey'], ], 'createdAt' => '2022-03-15T12:26:19.000Z', 'description' => '增加消息顺序号', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'ListSkillGroupSummaryReportsSinceMidnight'], ], 'createdAt' => '2022-03-10T06:25:38.000Z', 'description' => '支持技能组30秒服务水平统计', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'GetCallDetailRecord'], ], 'createdAt' => '2022-03-03T08:33:51.000Z', 'description' => '增加坐席事件时长', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'GetUser'], ], 'createdAt' => '2022-02-28T07:49:12.000Z', 'description' => 'GetUser接口返回参数增加DisplayId工号字段', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'ListAgentSummaryReportsSinceMidnight'], ['description' => 'OpenAPI offline', 'api' => 'ListSkillGroupStates'], ['description' => 'OpenAPI offline', 'api' => 'ListSkillGroupSummaryReportsSinceMidnight'], ], 'createdAt' => '2022-02-28T02:23:52.000Z', 'description' => 'ACC专用接口', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'CreateCustomCallTagging'], ['description' => 'OpenAPI offline', 'api' => 'DeleteCustomCallTagging'], ['description' => 'OpenAPI offline', 'api' => 'ListCustomCallTagging'], ['description' => 'OpenAPI offline', 'api' => 'ModifyCustomCallTagging'], ], 'createdAt' => '2022-02-24T14:32:10.000Z', 'description' => '公开云呼2.0黑名单相关接口', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'CreateCallTags'], ['description' => 'OpenAPI offline', 'api' => 'DeleteCallTag'], ['description' => 'OpenAPI offline', 'api' => 'ExportCustomCallTagging'], ['description' => 'OpenAPI offline', 'api' => 'ExportDoNotCallNumbers'], ['description' => 'OpenAPI offline', 'api' => 'GetDoNotCallFileUploadParameters'], ['description' => 'OpenAPI offline', 'api' => 'ImportCustomCallTagging'], ['description' => 'OpenAPI offline', 'api' => 'ImportDoNotCallNumbers'], ['description' => 'OpenAPI offline', 'api' => 'ListCallTags'], ['description' => 'OpenAPI offline', 'api' => 'ListDoNotCallNumbers'], ['description' => 'OpenAPI offline', 'api' => 'RemoveDoNotCallNumbers'], ], 'createdAt' => '2022-02-24T13:01:42.000Z', 'description' => '公开云呼2.0黑名单相关接口', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'GetCallDetailRecord'], ], 'createdAt' => '2022-02-23T06:55:22.000Z', 'description' => 'GetCallDetailRecord接口返回值中，增加FlowType字段，MAIN_FLOW / SURVEY_FLOW， 分别标识主流成和满意度调查流程', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateUser'], ['description' => 'Request parameters changed', 'api' => 'ModifyUser'], ], 'createdAt' => '2022-02-21T07:56:04.000Z', 'description' => '创建/修改用户接口添加工号的入参。', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'GetLoginDetails'], ['description' => 'Response parameters changed', 'api' => 'GetUser'], ['description' => 'Response parameters changed', 'api' => 'ListUsers'], ['description' => 'OpenAPI offline', 'api' => 'RegisterDevices'], ['description' => 'Response parameters changed', 'api' => 'ReleaseCall'], ], 'createdAt' => '2022-01-19T15:24:03.000Z', 'description' => '支持SIP话机配置', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'GetLoginDetails'], ], 'createdAt' => '2021-12-22T06:06:04.000Z', 'description' => 'GetLoginDetails返回值增加WorkMode', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'StartPredictiveCall'], ], 'createdAt' => '2021-12-16T13:15:34.000Z', 'description' => 'Request增加技能组参数', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'MakeCall'], ['description' => 'Request parameters changed', 'api' => 'StartPredictiveCall'], ], 'createdAt' => '2021-12-01T09:27:12.000Z', 'description' => '增加注销话机接口', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'GetCallDetailRecord'], ['description' => 'Response parameters changed', 'api' => 'ListCallDetailRecords'], ], 'createdAt' => '2021-09-08T02:46:28.000Z', 'description' => '增加主叫归属地callerLocation和被叫归属地calleeLocation, 部分号码查询不到归属地信息时，该字段为null', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'StartPredictiveCall'], ], 'createdAt' => '2021-08-20T10:37:34.000Z', 'description' => '后台外呼接口上线', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'MakeCall'], ], 'createdAt' => '2021-08-18T13:14:49.000Z', 'description' => 'MakeCall增加随路数据', ], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetVoicemailRecording'], ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUsers'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHistoricalCampaignReport'], ['threshold' => '250', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSkillGroupSummaryReportsSinceMidnight'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAgentStateLogs'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCallTag'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ImportCorpNumbers'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemovePhoneNumberFromSkillGroups'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddPhoneNumbers'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCallTags'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDoNotCallFileUploadParameters'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveUsersFromSkillGroup'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExportDoNotCallNumbers'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ImportCustomCallTagging'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSkillLevelsOfUser'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUnassignedNumbers'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstancesOfUser'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RegisterDevices'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PauseCampaign'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListVoicemails'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIvrTrackingDetails'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListBriefSkillGroups'], ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnmuteCall'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAudioFiles'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AssignUsers'], ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateConfigItems'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCampaignTrendingReport'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEarlyMediaRecording'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPrivilegesOfUser'], ['threshold' => '250', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSkillGroupStates'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCallTags'], ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLegacyAgentEventLogs'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyCustomCallTagging'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListContactFlows'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPersonalNumbersOfUser'], ['threshold' => '1100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartPredictiveCall'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAudioFile'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAudioFileUploadParameters'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCampaign'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMultiChannelRecordings'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PublishContactFlow'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveSkillGroupsFromUser'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRealtimeAgentStates'], ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'LaunchAuthentication'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstances'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHistoricalInstanceReport'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCustomCallTagging'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveUsers'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAttempts'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUser'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetUserPassword'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCampaign'], ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTurnServerList'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ImportDoNotCallNumbers'], ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AnswerCall'], ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCallDetailRecords'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendDtmfSignaling'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRecentCallDetailRecords'], ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLegacyAgentStatusLogs'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifySkillGroup'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyUser'], ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDevices'], ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RetrieveCall'], ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSkillGroups'], ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'HoldCall'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemovePersonalNumbersFromUser'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAudioFile'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSkillGroup'], ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUploadAudioDataParams'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetContactFlow'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCaseFileUploadUrl'], ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReadyForService'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMultiChannelRecording'], ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BargeInCall'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartEditContactFlow'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRealtimeCampaignStats'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExportCustomCallTagging'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveDoNotCallNumbers'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHistoricalCallerReport'], ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartPrivacyCall'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyUserLevelsOfSkillGroup'], ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SaveTerminalLog'], ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReleaseCall'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateContactFlow'], ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetLoginDetails'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddSkillGroupsToUser'], ['threshold' => '400', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMonoRecording'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPhoneNumbers'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddNumbersToSkillGroup'], ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetAgentState'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyAudioFile'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeWorkMode'], ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTurnCredentials'], ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EndConference'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ImportAdmins'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntervalSkillGroupReport'], ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MonitorCall'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDoNotCallNumbers'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSkillGroup'], ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AppendCases'], ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BlindTransfer'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstanceTrendingReport'], ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SwitchToConference'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnregisterDevice'], ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'LaunchSurvey'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifySkillLevelsOfUser'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListUserLevelsOfSkillGroup'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DiscardEditingContactFlow'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRoles'], ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCallDetailRecord'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyPhoneNumber'], ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CoachCall'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateUser'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddPersonalNumbersToUser'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListHistoricalAgentReport'], ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InterceptCall'], ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RestoreArchivedRecordings'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAudioFileDownloadUrl'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntervalInstanceReport'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInstance'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntervalAgentSkillGroupReport'], ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAgentStates'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCustomCallTagging'], ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartBack2BackCall'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListHistoricalAgentSkillGroupReport'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemovePhoneNumbersFromSkillGroup'], ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CompleteAttendedTransfer'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCustomCallTagging'], ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetNumberLocation'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRamUsers'], ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MuteCall'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntervalAgentReport'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteContactFlow'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemovePhoneNumbers'], ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelAttendedTransfer'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResumeCampaign'], ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TakeBreak'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListHistoricalSkillGroupReport'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetConversationDetail'], ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InitiateAttendedTransfer'], ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MakeCall'], ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstance'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddUsersToSkillGroup'], ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListConfigItems'], ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SignInGroup'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAudioFile'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitCampaign'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRealtimeInstanceStates'], ['threshold' => '300', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RedialCall'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddPhoneNumberToSkillGroups'], ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartConference'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RegisterDevice'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCases'], ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListLegacyQueueEventLogs'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyInstance'], ['threshold' => '250', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAgentSummaryReportsSinceMidnight'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListOutboundNumbersOfUser'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMonoRecordings'], ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AddCases'], ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PollUserStatus'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AbortCampaign'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCampaigns'], ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPhoneNumbersOfSkillGroup'], ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SignOutGroup'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRealtimeSkillGroupStates'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSkillGroup'], ], 'product' => ['code' => 'ccc', 'title' => 'CCC'], ], 'ram' => [ 'productCode' => 'CloudCallCenter', 'productName' => 'Cloud Contact Center', 'ramCodes' => ['ccc'], 'ramLevel' => 'OPERATION', 'ramConditions' => [], 'ramActions' => [], 'resourceTypes' => [], ], ];