- Service Overview
- Getting Started
-
User Guide
- CEC Operation Guide
-
Tenant Administrator Guide
- Tenant Space
- Configuring the Employee Center
-
Enabling Manual Services
- Voice and Video Services
-
Agent Workbench
- Configuring Call Reasons
- Configuring Rest Reasons
- Configuring Contact Record Data Items
- Configuring the Voice Notification Function
- Configuring the One-Click Bidirectional Call Function
- Configuring Screen Pop-ups
- Configuring Pages
- Configuring Dynamic Data Tables
- Querying Table Data
- Managing the Multimedia Library
- Configuring Identity Authentication Processes
-
Other Configurations
- Configuring the Fault Prompt Tone
- Configuring Satisfaction Surveys
- Configuring the Customized Tone (Agent Ringback Tone)
- Configuring Page Message Notifications
- Configuring Voice Silent Agents
- Managing Messages
- Viewing Contact Records
- Viewing Bidirectional Call Records
- Configuring the Online Chat Service Time
- Viewing Skill Queue Adjustment Records
- Viewing Identity Authentication Records
- Managing Documents
- Managing Harassment Records
- Configuring Service Guidance
- Configuring SmartCare Integration Information
- Configuring a Mobile Agent
-
Configuring Multimedia Channels
- Configuring the WeChat Channel
- Configuring the Web Channel
- Configuring the X (Twitter) Channel
- Configuring AICC Information
- Configuring the 5G RCS Channel
- Configuring the Email Channel
- Configuring the LINE Channel
- Configuring the WhatsApp Channel
- Configuring the SMS Channel
- Configuring the Instagram Channel
- Configuring the Telegram Channel
-
FAQ
- How Do I Set the Click-to-Dial Called Route?
- How Do I Enable the Last Agent Mode?
- How Do I Set Session End Due to No Customer Reply?
- How Do I Set Session Transfer Due to No Agent Reply?
- How Do I Set Session Transfer?
- How Do I Set the Third-Party Authentication Key?
- How Do I Enable Offline Messages?
- How Do I Enable Message Push?
- How Do I Enable the Auto Reply and Non-Workday Reply Functions?
- How Do I Enable Connection to the Intelligent Robot?
- How Do I Enable Connection to the Robot Assistant?
- Creating an App Using a Facebook Developer Account
- How Do I Set Automatic Email Reply?
-
Robot Management and Configuration Guide
- Getting Started
-
Configuring an Intelligent Robot
- Overview
- Configuring an Appointment Chatbot (Task-oriented Robot)
- Adding a Q&A-oriented Robot
-
Other Operations
- Managing Variables
- Maintaining Stored Procedures
- Creating Work Calendar Templates
- Adding Data Tables
- Adding Domains
- Adding Entities
- Adding Sensitive Words
- Adding Knowledge Gray Rules
- Managing Models
- Managing Robot Test Cases
- Reviewing a Historical Message
- Processing a Question Clustering Task
- Setting Intelligent Engine Parameters
- Managing the Call History
- Viewing Flow Analysis
- Checking Flows
- Adding Gray Rules
- Configuring 2D Virtual Humans
- Configuring the SmartCare Intelligent Robot
-
Reference
-
Diagram Elements
- Start
- Robot Reply
- Conversation Analysis
- Subflow
- Call Ending
- Switching Between Voice and Video Calls
- Voice Playback
- Voice Playback and Digit Collection
- Language Selection
- Semantic Recognition
- Menu Configuration
- Call Transfer
- Error Count Clearance
- Branch Judgment
- Logic Loop
- Variable Assignment
- Rule Validation V2
- Time Selection
- Interface Invocation
- Data Table
- Stored Procedure
- Information Query
- User Level
- Message Leaving
- SMS
- Satisfaction Configuration
- Key Recognition (Expired and Not Recommended)
- Rule Verification (Expired and Not Recommended)
- Date Processing (Expired and Not Recommended)
- SMS Sending (Expired and Not Recommended)
- JSON Data Invoking (Expired and Not Recommended)
- Composite
- Avatar Reply
- Connection Lines Between Diagram Elements
- Parameters
-
TUC Interfaces
- /chatbot/rest/tuc/v1/nlp/detectRegularEntity
- /chatbot/rest/tuc/v1/nlp/identify
- /chatbot/rest/tuc/v1/recommendFaq
- /chatbot/rest/tuc/v1/qualityInspection/qiOnline/recognize
- /chatbot/rest/tuc/v1/nlp/feedback
- /chatbot/rest/tuc/v1/nlp/textClassify
- /chatbot/rest/tuc/v1/nlp/detectEntity
- /chatbot/rest/tuc/v1/qualityInspection
- Built-in Functions
-
Diagram Elements
-
FAQs
- Why Do I Need to Configure Stop Words?
- Why Are Some Intentions Matched Despite Low Matching Rates?
- Why TTS Cannot Identify the Date Format?
- How Do I Configure the Scenario Where Multiple Slots Are Filled Repeatedly?
- How Do I Resolve the Problem of Infinite Loop During Interaction Between the IVR and ODFS?
- How Do I Configure the Number of Voice Recognition Errors in a Flow?
- How Do I Configure an Entity That Matches Any Character String?
- What Causes Incorrect ASR?
- How Do I Transfer the Disconnection Reason Code to the Specified Business Interface?
- How Do I Configure the Language Recognition Interface?
- How Do I Configure Dynamic Flow Variables?
- How Do I Use a Rule Corpus?
- How Do I Assign Values to and Use Lists and Objects?
- How Do I Parse Call-associated Data?
- How Do I Press a Key to Collect Digits or Return to the Upper-Level Menu When the Play Voice & Collect Digit Diagram Element Does Not Support the Asterisk (*) Key?
-
Operator: Configuring a Common IVR
- Introduction to the IVR Flow
- Managing Voice and Video Resources
- Configuring a Common IVR
- Configuring Robot Tracking
- Configuring a Called Route
- Configuring a Flow Track
- Configuring IVR Recording
- Querying Flow Transfer Records
- Typical Configuration Example
-
Diagram Elements
- Start
- Subflow
- Call Ending
- Switching Between Voice and Video Calls
- Voice Playback
- Voice Playback and Digit Collection
- Language Selection
- Menu Configuration
- Call Transfer
- Error Count Clearance
- Branch Judgment
- Logic Loop
- Variable Assignment
- Rule Validation V2
- Interface Invocation
- Data Table
- Stored Procedure
- Time Selection
- Information Query
- User Level
- Message Leaving
- SMS
- Survey
- Satisfaction Configuration
- Call Ending (Expired and Not Recommended)
- Condition Judgment (Expired and Not Recommended)
- Ringing (Expired and Not Recommended)
- Response (Expired and Not Recommended)
- User Level (Expired and Not Recommended)
- Time Selection (Expired and Not Recommended)
- Assignment (Expired and Not Recommended)
- Transfer (Expired and Not Recommended)
- Interface Invocation (Expired and Not Recommended)
- Configuring the Preconfiguration Intelligent Flows
- Large Language Model Service Zone
- Small Language Model Zone
- IVR Journey Analysis
- Monitoring Outbound Call Risks
- Managing Cases
-
Managing Inspections
- Overview on Inspection Management
- Typical Scenario: Configuring Manual Inspection Tasks
- Managing Manual Inspections
- Typical Scenario: Configuring AI Inspection Tasks
- Managing AI Inspections (Self-Developed)
- Managing the Notification Center
- Managing the Customer Center
-
Making Intelligent Outbound Calls
- Overview of Outbound Call Tasks
-
Preparations for Creating Outbound Call Tasks
- Managing Special Dates
- Managing Blocklisted Outbound Numbers
- Defining Business Results
- Defining Outbound Call Data Attributes
- Defining Outbound Call Results
- Creating Outbound Call Templates
- Managing the Special List
- Configuring an Outbound Call File Server
- Importing Mapping Rules
- Managing Task Groups
-
Managing Outbound Call Tasks
- Creating Common IVR Outbound Call Tasks or Intelligent Robot Outbound Call Tasks
- Creating Predicted Outbound Call Tasks
- Creating Previewed Outbound Call Tasks
- Creating Preempted Outbound Call Tasks
- Creating Fixed Outbound Call Tasks
- Creating Manual Outbound Call Tasks
- Configuring an Outbound Call Task
- Managing Outbound Call Tasks in Batches
- Managing Multimedia Marketing
- Managing Outbound Call Task Reports
- Managing Surveys
- Managing Intelligent Training
- Configuring the Knowledge Base
-
Configuring Public Resources
- Modifying Policy Information
- Viewing Interconnection Parameters
- Configuring Parameters
- Adding Customer Numbers to the Special List
- Configuring the Channel Special List
- Managing a Certificate
- Configuring Email Special List Rules
- Configuring SMS Special List Rules
- Configuring Resource Dump Tasks
- Managing Menus
- Managing Email Signatures
- Configuring Message Flow Control Rules
- Configuring UC Integration
- Managing Emails
- Configuring External Numbers
- Querying Operation Logs
- Querying Sign-in Logs
- Managing Business Fault Bypass
- Co-browsing
- Social Media Operations
- Performance Management
-
Agent Guide(AICC)
- Introducing Agent Workbenches
- Switching the Agent Status
- Allowing Browser Pop-up Notifications
- Handling Voice Businesses
- Handling Video Businesses
- Handling Multimedia Chat Businesses
-
Performing Other Agent Operations
- Configuring the Personal Center
- Querying Historical Contacts
- Viewing Inbound Call Information
- Setting the Handled Number
- Setting Call Reasons
- Setting the Online Chat Service Time
- Configuring Personalized Common Phrases
- Sending Notifications
- Viewing Skill Queue Adjustment Records
- Viewing Identity Authentication Records
- Performing Identity Authentication
- Viewing Customer Information
- Managing Documents
- Creating Harassment Records
- Editing Customer Information
- Querying Sign-In Records
- Performing Screen Recording for Agents
- SmartCare Fault Demarcation
- Intelligent Case Filling
- Creating a Case by One Click
- Searching for Satisfaction Statistics
- Managing Inspection Results
- Typical Scenarios
- Viewing Training Tasks
-
Intelligent Outbound Call Tasks
-
Agent Outbound Call Task
- Introduction to the Outbound Call Task of an Agent
- Manually Making an Outbound Call
- Viewing and Executing a Previewed Outbound Call
- Viewing a Predicted Outbound Call
- Viewing a Preempted Outbound Call
- Creating a Reserved Outbound Call Task
- Adding a Customer Number to the Blocklist
- Changing an Outbound Number
- Viewing Outbound Call Results
- Reserved Manual or Automatic Outbound Call
-
Agent Outbound Call Task
- OpenEye Help Document
- Implementing Intelligent Case Filling
-
Inspector Guide
- Processing Manual Post-Event Inspections
- AI Inspection
-
Performing Agent Monitoring and Inspections
- Monitoring Configuration
- Monitoring Management
-
Report Query
- VDN Traffic Report
- VDN Traffic Report by Access Code
- IVR Traffic Report
- IVR Traffic Report by Access Code
- Skill Queue Traffic Report
- Skill Queue Traffic Report by Access Code
- Traffic Summary Report
- Agent Traffic Report
- Agent Outbound Call Report
- Agent Operation Report
- Abandoned Call in Ringing Report
- Interval-based VDN Traffic Report
- IVR Outbound Call Report
- System Performance Report
- Agent Timesheet Report
- Price Details
-
Developer Guide
-
Development Overview
- Development Map
-
Development Solutions
- Multimedia Channel Access Solution
- Self-Service (IVR) Integration Solution
- Voice and Video Agent Integration Solution
- Multimedia Agent Integration Solution
- Mobile Agent Integration Solution
- Screen Pop-up Integration Solution
- Intelligence Solution
- Operations Monitoring and Report Integration Solution
- Automatic Outbound Call Integration Solution
- CDR Download and Recording Backhaul Integration Solution
- Development Preparations
- Contact Us
- User Access-VoIP Voice and Video Access
-
User Access-Web Lightweight Client Integration (JS)
- Lightweight Web Chat Control Integration (Token Mode)
- Lightweight Web Chat Control Integration (Authorization Mode)
-
User Access--Web Client Access (RESTful)
- Overview
- Machine-Machine Interface, AK/SK-based Authentication Interface
- Third-party Request Authentication
- Query Queue Information
- Proactively Poll Information Sent by Agents
- Submit Customer Satisfaction Evaluation Results
- Send Message
- Send Files by Customer
- Receive Document by Customer
- Associate Common Phrases
- Create Click-to-dial Call
- Get Click-to-dial Event
- Check Whether Support Click-to-dial
- Release Click-to-dial Call
- Submit Offline Messages by Customer
- Create an Anonymous Call
- Submit Customer Satisfaction with Robots
-
Agent Integration-Agent Lightweight Connection Block Integration (JS)
- Overview
- Integration Principles
- Integration Procedure
- Preparations
- Integration Development
- (Optional) Developing Other Functions
- Test and Verification
- Agent Integration--CC-Gateway Development Guide
-
Agent Integration-OpenEye H5 Softphone Interface Integration
- Change History
- OpenEye H5 Softphone Interface Overview
- OpenEye Installation Guide
- Development Guide to H5 Softphone Integration on the Agent Side
- Voice Call Interfaces
-
Voice and Video Call Interface Extension
- Voice and Video Calls
-
Device Management
- getMediaDevices (Obtaining the Device List)
- setMicIndex (Setting the Microphone)
- mediaGetMicIndex (Querying the Microphone in Use)
- setSpeakIndex (Setting the Speaker)
- mediaGetSpeakIndex (Querying the Speaker in Use)
- setMicVol (Setting the Microphone Volume)
- getMicVol (Querying the Current Microphone Volume)
- setSpkVol (Setting the Speaker Volume)
- getSpkVol (Querying the Current Speaker Volume)
- setVideoWindowParam (Setting the Position, Width, and Height of the Video Window)
- setVideoLayoutMode (Setting the Video Window Layout Mode)
- setVideoDisplayMode (Setting the Image Cropping Mode in the Video Window)
- openCamera (Turning on the Camera)
- closeCamera (Turning off the Camera)
- Screen Sharing
- Screenshot
- Screen Recording
- Error Codes
-
Operation Management - Agent Workbench Integration with Third-Party Web Pages
- Overview
- Scenario 1: Integration by Using a URL (in GET Parameter Transfer Mode)
- Scenario 2: Integration by Using a URL (in POST Parameter Transfer Mode)
-
Scenario 3: Integration by Using a URL (in Page JavaScript Invocation Mode)
- Overview
- Development Procedure
- Preparation
-
Integration Development
- Importing AICC.Support.js
- Developing the Function of Registering Listening Events
- Developing the Function of Removing Listening Events
- Developing the Function of Making One-Click Outbound Calls
- Developing the Function of Obtaining the Identity Authentication Result
- Development Example
- Post-development Configuration
- Test and Verification
-
Appendix - Process Description
- Overall Working Process
- Process of Registering a Listening Event (addHandler)
- Process of Removing a Listening Event (removeHandler)
- Process of Executing a One-Click Outbound Call (clickToOutbound)
- Process of Executing the Handling Method of a Registered Event
- Process of Executing the One-Click Outbound Call Method
- Process of Obtaining the Identity Authentication Result
- Scenario 4: Integration by Invoking an Enterprise API
- Scenario 5: Integration by Recording Information to the CEC
-
Development Overview
-
API Reference
- Interface Overview
- Glossary
- Change History
- Interface Authentication Modes
-
Call Center Configuration Interface Reference
-
Agent Management
- Creating a Single Agent Account (agentAccount/create)
- Deleting a Specified Agent Account (agentAccount/delete)
- Modifying Information About an Agent Account (agentAccount/update)
- Querying Agent Account Information (agentAccount/query)
- Binding an Agent to a Skill Queue (addSkillsToAgent)
- Unbinding an Agent from a Skill Queue (releaseAgentBySkillId)
- Querying Agent Information by Skill Queue ID (queryAgentInfoBySkillId)
- Changing the SIP Phone Number Login Password of an Agent (updateSipPhonePassword)
- Querying Softphone Information of All Agents, Excluding Business Accounts (querySysInfo)
- Querying Softphone Information of All Agents, Including Business Accounts (queryAgentInfo)
- Querying the Account Sign-in Result (queryAgentLoginParams)
- Querying Agent Information by Sign-in Account (queryAgentInfoByAccount)
- Deleting Data by Customer Number (cleancustpersonaldata)
-
Skill Queue Management
- Creating a Skill Queue (createSkill)
- Deleting a Skill Queue (deleteSkill)
- Modifying a Skill Queue (modifySkill)
- Querying Skill Queues (querySkills)
- Obtaining the Total Number of Users in a Configured Skill Queue
- Obtaining the Number of Users in a Skill Queue to Which an Agent Has Signed In
- Obtaining the Skill Queue Information of the Home VDN of an Agent
- Obtaining the Total Number of Users in a Specified Skill Queue
- Querying the Statistics About a Set of Skill Queues
- Querying the IVR Information of the VDN to Which an Agent Belongs
- Querying Information About Agents That Have Signed In to a Skill Queue
- Querying the Details About a Specified Agent
- Querying the Details About All Online Agents That Have Signed In to a Skill Queue
-
Number Management
- Querying Access Codes (queryAccessCodeList)
- Creating a Binding Relationship Between an Access Code, Skill Queue, and IVR (createCalledRoute)
- Deleting the Binding Relationships Between Access Codes, Skill Queues, and IVR Flows (deleteCalledRoute)
- Modifying a Binding Relationship Between an Access Code, Skill Queue, and IVR (modifyCalledRoute)
- Querying the Binding Relationships Between Access Codes, Skill Queues, and IVR Flows (queryCalledRoute)
- Querying the Home Area of a Number (getPhoneNoRegionInfo)
-
IVR Flow Management
- Querying All IVR Flows of a Specified Tenant Space (queryIVRFlowList)
- Querying Satisfaction Survey Information (querySatisfactionConfig)
- Querying Satisfaction Survey Results (satisfaction /query)
- Uploading IVR Voice Files (importVoiceFile/upload)
- Uploading a TTS Template for Voice Notifications (createVoiceTemplate)
-
Agent Management
-
Agent Workbench Interface Reference
-
Agent Control
-
Agent Operation Interfaces: onlineagent
- Signing In
- Forcibly Signing In
- Maintaining the Heartbeat by an Agent
- Sending Notes
- Querying Configured Skill Queues
- Querying Configured Skill Queues of Specified Agents
- Setting Automatic Answering
- Resetting Skill Queues
- Setting Idle
- Setting Busy
- Canceling the Busy State
- Applying for Rest
- Canceling Rest
- Entering the Work State
- Quitting the Work State
- Changing the Password (Extended)
- Setting Whether to Enter the Idle State
- Signing Out
- Forcibly Signing Out
- Forcibly Signing Out with a Cause Code
- Getting Agent Status
- Setting Whether to Answer Inbound Calls
- Signing In to the Platform by an Agent
- Actively Requesting to Update the GUID When the Agent Page Is Refreshed
- Synchronizing the Agent Status and Call Information When the Agent Page Is Refreshed
- Obtaining Token Information
- Customizing Status by an Agent
- Querying Customized Status by an Agent
- Canceling Status Customization by an Agent
-
Call Control Interfaces: voicecall
- Making a Common Outbound Call
- Making a Previewed Outbound Call
- Answering a Call
- Making an Internal Call
- Asking for Internal Help
- Muting a Call
- Unmuting a Muted Call
- Holding a Call
- Holding a Call
- Unholding a Call
- Transferring a Call
- Canceling Transfer
- Performing Two-Stage Dialing (Extended)
- Making a Three-Party Call
- Disconnecting a Call of a Specified ID
- Dropping a Call
- Releasing a Connection of a Specified Number
- Switching Between Voice and Video Calls
- Controlling the Image Display Mode of a Three-Party Video Call
- Requesting a Specified Call
- Picking Up a Call for Other Agents
- Rejecting an Inbound Call
- Taking the Phone Off the Hook
- Rejecting a Call
- Passing Numbers in a Conference
- Answering Calls on a Mobile Phone (login)
- Exiting the Function of Answering Calls on a Mobile Phone (logout)
- Querying Whether a Specified Agent Answers Calls on a Mobile Phone (isOfflineAgent)
-
Call Data (calldata)
- Querying Call Information
- Querying Call-Associated Data
- Configuring Call-Associated Data (Extended)
- Querying the List of Held Calls
- Querying Call Information Before Answering a Call
- Querying Call Information by Call ID
- Querying Call IDs of a Specified Agent
- Querying the Number of Current Calls of an Agent
- Querying Current Call Statistics Information About an Agent
- Querying the Current Call Statistics of an Agent (Extended)
- Querying Information About Calls Waiting in a Specified Skill Queue
- Querying All Calls Placed on Hold by a Specified Agent
- Agent Event: agentevent
- Multimedia: mediaCall
-
Agent Conference: agentconf
- Applying for an Agent Conference
- Answering an Agent Conference Call
- Rejecting an Agent Conference Call
- Leaving an Agent Conference
- Releasing an Agent Conference
- Holding a Participant in a Conference
- Unholding a Participant in a Conference
- Applying for Extending a Conference
- Transferring the Chairperson Permission
- Inviting Participants in Batches
- Deleting Participants in Batches
- Modifying Participant Attributes
- Playing an Announcement in an Agent Conference
- Stopping Conference Announcement Playing
- Playing an Announcement in an Agent Conference Channel
- Stopping Announcement Playing in an Agent Conference Channel
- Changing the Number of Conference Participants
- Querying Conference Information in Batches
- Querying an Ongoing Conference ID in the VDN
-
Agent Operation Interfaces: onlineagent
-
Agent Bidirectional Calls
- Creating a Bidirectional Call (V1.0.0) (createCall)
- Creating a Bidirectional Call (V3.0.0) (createCall)
- Querying Call History Records (queryCallDetailRecord)
- Querying Call Status (queryCallState)
- Obtaining the Recording File URL (getRecordingAddress)
- Querying Allocated Softphone Numbers (V1.0.0) (queryPhone)
- Querying Allocated Softphone Numbers (V2.0.0) (queryPhone)
- Obtaining the Information About the Destination Device of a Call (getCalledInfo)
- Creating a Voice Outbound Call (V1.0.0) (createVoiceNotification)
- Creating a Voice Outbound Call (V2.0.0) (createVoiceNotification)
- Querying Contact Records (queryUserContactLimit)
- Querying Call Information (queryCallInfoByCallId)
- Sending an ITA Bidirectional Call Result Notification (statusnotify)
- Callback Interface
-
Voice Recognition Result Subscription Interfaces
- Subscription
- Subscription Modification
- Unsubscription
- Handshake
- Handshake (Extended)
- Recognition Result Notification
-
Error Code Definition
- Error Codes Returned by the CC-Gateway
- Common Voice Recognition Result Subscription Interface Error Codes
- Common Error Codes Returned by the CTI Platform
- VDN Configuration Interface Error Codes Returned by the CTI Platform
- System Configuration Interface Error Codes Returned by the CTI Platform
- Error Code Returned by UAP
- Role Permission Bit Description
- App Personal Settings
-
Appendix
-
Events
- Events Related to Agent State
-
Audio and Video Call Event
- Entering the Talking State
- Customer Ringing
- Holding Success
- Entering Three-Party Conversation Successfully
- Making an Outgoing Call Unsuccessfully
- Outbound Call Failure Cause Detected
- Making an Internal Call Unsuccessfully
- No Answer from an Agent for a Long Time
- Agent Exiting a Call
- User Exiting a Call
- Automatically Answering a Call
- Notifying the Agent of an Inbound Call
- Connection Failure
- Consultation Failure
- Notifying the Transfer Success Result
- Returning from IVR
- Switching Between Audio and Video Calls
- Media Capability Check
- Inbound Call Notification
- Events Related to Outgoing Call
- Recording Events
- Events Related to Voice Playback by Quality Checks
- Events Related to Real-time Quality Control
- Events Related to Physical Phone
- Other Agent-Related Events
- Events Related to Multimedia
- Agent Conference Event
- Events Related to Disaster Recovery
- Phone Linkage Events
- Error Codes
- Agent Status
- Call Type
- Device Type
- Interface Parameters
-
Events
-
Agent Control
-
Telemarketing Outbound Call Interface Reference
-
Outbound Campaign Management Interfaces
- Adding an Outbound Campaign (V1)
- Adding an Outbound Campaign (V2)
- Modifying an Outbound Campaign (V1)
- Modifying an Outbound Campaign (V2)
- Deleting an Outbound Campaign
- Querying Details About an Outbound Campaign
- Querying All Outbound Campaigns
- Suspending an Outbound Campaign
- Resuming an Outbound Campaign
- Setting the Retry Policy of an Outbound Campaign
- Querying the Retry Policy of an Outbound Campaign
- Adding the Definition of an Outbound Call Business Result
- Querying the Definitions of Outbound Call Business Results
- Collecting Outbound Call Exception Statistics
- Adding Calling Numbers
- Deleting Calling Numbers
- Interfaces for Managing Outbound Campaign Holidays
- Interface for Outbound Blacklist Management
-
Outbound Call Data Interfaces
- Adding Outbound Numbers
- Adding Outbound Numbers (V2)
- Deleting an Outbound Number
- Adding Number Types
- Querying Number Types
- Querying Outbound Numbers
- Collecting Outbound Call Statistics on the Current Day
- Importing an Outbound Call Data File from the Server
- Querying Outbound Call Data File Import Results
- Outbound Result Interface
- Outbound Callback
- Business Result Writeback
- File Server Management Interfaces
- Outbound Call External Result Definition Interfaces
- Querying Interface Invocation Records
-
Outbound Campaign Management Interfaces
- Survey Interface Reference
- iKBS Interface Reference
-
Chatbot Management Interface Reference
- Overview
- Domain Query Interface
- Dialog ID Binding Interfaces
- Flow Query Interface
- Dialog Interfaces
- Dialog Interfaces (V2)
- Interaction Record Query Interface
- Session Record Query Interface
-
FAQ Configuration Interface
- FAQ Group Query Interface
- FAQ Group Creation Interface
- FAQ Group Modification Interface
- FAQ Group Deletion Interface
- FAQ Group Status Change Interface
- Q&A Query Interface
- Q&A Creation Interface
- FAQ Modification Interface
- Q&A Deletion Interface
- Specific FAQ Group Test Interface
- FAQ Group Test and Activation Interface
- Intention List Query Interface
- Dedicated Interfaces for Silent Agents
- Interface for Pushing Packet Capture Recording Request Results
- Spelling Check Interface
- Specifications of the Interface for Connecting the ODFS to a Third-Party Robot System
- Statistics Report
- Querying the Offline Analysis of Outbound Call Failure Causes
- Intelligent Case Interface
- Interface for Querying the Recordings of Calls Transferred to a Third Party
- Semantic Recognition Interface
- GTS RPA Integration Interfaces
- Interface for Generating TTS Voices Based on Texts
- Offline Conversion Callback Interface
- Health Check Interface
-
Web Client Access Interface Reference
- Performing Third-Party Request Authentication (applyToken)
- Querying Queuing Information (queryQueueInfo)
- Proactively Polling Messages Sent by Agents (poll)
- Submitting the Customer Satisfaction Evaluation Result (saveSatisfaction)
- Sending a Message (send)
- Sending a File by a Customer (uploadFileStream)
- Receiving a File by a Customer (downloadFileStream)
- Associating Common Phrases Based on the Customer Input (queryPhraseByKeyword)
- Checking Whether the Current Tenant Space Supports the Click-to-dial Function (checkClickToCallSupport)
- Creating a Click-to-Dial Call (createClickToCall)
- Obtaining a Click-to-Dial Event (getClickToCallEvents)
- Releasing a Click-to-Dial Call (dropClickToCall)
- Creating an Anonymous Call (createcall)
- Submitting a Message by a Customer (doLeaveMessage)
- Submitting the Chatbot Satisfaction Evaluation Result (feedbacksatisfaction)
- Querying Historical Messages (queryHistoryChatMessage)
- Discarding an Email (chat_dropMail)
- Sending an MT WhatsApp Message (sendWhatsappMessage)
- Querying Information About the Current Chat on the Online Chat Workbench (getUserInfoBycallId)
- Querying the Satisfaction Survey Configuration (getSatisfactionSurveyMode)
-
Inspection, Monitoring, and Statistics Collection Interface Reference
-
Real-time Inspection: qualitycontrol
- Inserting
- Listening
- Intercepting
- Canceling Listening and Inserting
- Indicating an Agent in Busy State Forcibly
- Indicating an Agent in Idle State Forcibly
- Forcibly Signing Out
- Releasing a Call Forcibly
- Adjusting the Skill Queue of a Specified Agent
- Switching Between Listening and Inserting
- Forcing an Agent to Rest
- Requesting for Whispering
- Stopping Whispering
- Switching Among Whispering, Listening, and Barging
-
Intelligent Quality Check
-
scoresetting
- POST /CCSQM/rest/ccisqm/v1/appraisescore/createAppraiseScore
- POST /CCSQM/rest/ccisqm/v1/appraisescore/applyAppraiseScore
- POST /CCSQM/rest/ccisqm/v1/appraisescore/removeAppraiseScore
- POST /CCSQM/rest/ccisqm/v1/appraisescore/queryAppraiseScore
- POST /CCSQM/rest/ccisqm/v1/appraisescore/modifyAppraiseScore
-
sentencemanagement
- POST /CCSQM/rest/ccisqm/v1/sentencemanage/createSentenceCategory
- POST /CCSQM/rest/ccisqm/v1/sentencemanage/moveSentenceToCategory
- POST /CCSQM/rest/ccisqm/v1/sentencemanage/deleteSentence
- POST /CCSQM/rest/ccisqm/v1/sentencemanage/querySentence
- POST /CCSQM/rest/ccisqm/v1/sentencemanage/querySentenceByCategoryId
- POST /CCSQM/rest/ccisqm/v1/sentencemanage/updateSentence
- POST /CCSQM/rest/ccisqm/v1/sentencemanage/updateSentenceCategory
- POST /CCSQM/rest/ccisqm/v1/sentencemanage/deleteSentenceCategory
- POST /CCSQM/rest/ccisqm/v1/sentencemanage/querySentenceCategory
- POST /CCSQM/rest/ccisqm/v1/sentencemanage/createSentence
-
sensitiveWordManage
- POST /CCSQM/rest/ccisqm/v1/sensitiveWordManage/deleteSensitiveWord
- POST /CCSQM/rest/ccisqm/v1/sensitiveWordManage/querySensitiveWordList
- POST /CCSQM/rest/ccisqm/v1/sensitiveWordManage/deleteSensitiveCategory
- POST /CCSQM/rest/ccisqm/v1/sensitiveWordManage/updateSensitiveWord
- POST /CCSQM/rest/ccisqm/v1/sensitiveWordManage/querySensitiveCategoryList
- POST /CCSQM/rest/ccisqm/v1/sensitiveWordManage/querySensitiveWordsByCategoryId
- POST /CCSQM/rest/ccisqm/v1/sensitiveWordManage/createSensitiveCategory
- POST /CCSQM/rest/ccisqm/v1/sensitiveWordManage/moveSensitiveWordToCategory
- POST /CCSQM/rest/ccisqm/v1/sensitiveWordManage/createSensitiveWord
- POST /CCSQM/rest/ccisqm/v1/sensitiveWordManage/updateSensitiveCategory
- POST /CCSQM/rest/ccisqm/v1/sensitiveWordManage/querySensitiveWordDetail
- conversationspecific
- SemanticKeywordTraining
- conversationflow
- conversationrules
-
interposalrules
- POST /CCSQM/rest/ccisqm/v1/interposal-rules/getInterposalRuleById
- POST /CCSQM/rest/ccisqm/v1/interposal-rules/queryInterposalRules
- POST /CCSQM/rest/ccisqm/v1/interposal-rules/deleteInterposalRule
- POST /CCSQM/rest/ccisqm/v1/interposal-rules/addInterposalRule
- POST /CCSQM/rest/ccisqm/v1/interposal-rules/updateInterposalRule
- Common Parameter Structure
- silencerule
- speedrule
-
scenariomanage
- POST /CCSQM/rest/ccisqm/v1/scenariomanage/deleteScenario
- POST /CCSQM/rest/ccisqm/v1/scenariomanage/updateScenarioStatus
- POST /CCSQM/rest/ccisqm/v1/scenariomanage/createScenario
- POST /CCSQM/rest/ccisqm/v1/scenariomanage/queryScenario
- POST /CCSQM/rest/ccisqm/v1/scenariomanage/updateScenario
- POST /CCSQM/rest/ccisqm/v1/scenariomanage/queryAllScenario
- qualitycheckmanage
-
regularQualityTask
- POST /CCSQM/rest/ccisqm/v1/regularqualitytask/addQualityTask
- POST /CCSQM/rest/ccisqm/v1/regularqualitytask/beginQualityTask
- POST /CCSQM/rest/ccisqm/v1/regularqualitytask/updateQualityTask
- POST /CCSQM/rest/ccisqm/v1/regularqualitytask/deleteQualityTask
- POST /CCSQM/rest/ccisqm/v1/regularqualitytask/queryQualityTask
- POST /CCSQM/rest/ccisqm/v1/regularqualitytask/stopQualityTask
-
qualitytask
- POST /CCSQM/rest/ccisqm/v1/qualitytask/deleteQualityTask
- POST /CCSQM/rest/ccisqm/v1/qualitytask/updateQualityTask
- POST /CCSQM/rest/ccisqm/v1/qualitytask/terminateQualityTask
- POST /CCSQM/rest/ccisqm/v1/qualitytask/takeEffectQualityTask
- POST /CCSQM/rest/ccisqm/v1/qualitytask/queryQualityTask
- POST /CCSQM/rest/ccisqm/v1/qualitytask/appointQualityTask
- POST /CCSQM/rest/ccisqm/v1/qualitytask/createQualityTask
- qualitytaskdetail
-
qualityitem
- POST /CCSQM/rest/ccisqm/v1/qualityitem/reassginQualityTask
- POST /CCSQM/rest/ccisqm/v1/qualityitem/modifyQualityItemResult
- POST /CCSQM/rest/ccisqm/v1/qualityitem/appealItem
- POST /CCSQM/rest/ccisqm/v1/qualityitem/queryQualityItem
- POST /CCSQM/rest/ccisqm/v1/qualityitem/queryQualityItemDetail
- POST /CCSQM/rest/ccisqm/v1/qualityitem/queryQualityItemResult
- POST /CCSQM/rest/ccisqm/v1/qualityitem/queryQualityHistory
- asrtrans
-
scoresetting
-
Monitoring and Statistics Collection
-
Real-Time Data Query
-
Real-Time Interfaces for VDNs
- Querying Information About System Access Codes in a Specified VDN
- Querying Agent Rest Information in a Specified VDN
- Querying Agent Phone Numbers in a Specified VDN
- Querying Information About All Agents in a Specified VDN
- Querying Information About the Current Status of All Agents in a Specified VDN
- Querying Information About Static Configurations of All Agents in a Specified VDN
- Querying IVR Status Details in a Specified VDN
- Querying Information About IVR Flow Access Codes in a Specified VDN
- Querying Information about Each Skill Queue in a Specified VDN
- Querying All Rest Reason Codes in a Specific VDN
- Querying Information About Calls of a Specified Access Code
- Querying Call Information in a Specified VDN
- (V2) Querying Call Information in a Specified VDN
- Querying the Call track Data in a Specific VDN
- Querying Static Configuration Information About All Agents in a Specified VDN (Not Supported by CTI 3.6)
- Querying Information About All Agents in a Specified VDN (Not Supported by CTI 3.6)
- Obtaining Real-Time Monitoring Indicators by VDN
-
Real-Time Interfaces for Skill Queues
- Querying Signed-in Agents in Skill Queues in Batches
- Querying Extended Information About Skill Queues in Batches
- Querying Call Statistics of Skill Queues in the Current 5 Minutes in Batches
- Querying Information About Status of a Specified Skill Queue
- Querying Information About Skill Queue Configurations in Batches
- Querying Statistics Details of Skill Queues in Batches
- Querying All Calls Queuing in a Skill Queue in Batches
- Querying the Number of Calls that Each Queue Answers from Other Queues in Batches When Calls are Queuing in Multiple Skill Queues
- Querying the Number of Agents in Each State in a Skill Group
- Querying Details About Signed-in Agents in a Skill Queue
- Querying Service Quality for Skill Queues in Batches
- Obtaining Real-Time Monitoring Indicators by Skill Queue
-
Real-Time Interfaces for Agents
- Querying Skill Queues to Which Agents Sign In in Batches
- Querying Agent Information in Batches
- Querying the Current Call ID of a Specified Agent
- Querying Call Information About All Agents in Batches
- Querying Private Calls of a Specified Agent
- Querying the Number of Agents in the Agent State in batches
- Querying Details of a Specified Agent
- Querying Agent Rest Information
- Checking Whether an Agent Is Processing a Call
- Querying System Status by Agent
- Obtaining Real-Time Monitoring Indicators by Agent
- Obtaining Agent Operation Details
- Querying Agent Information by Agent Status in Pagination Mode
- Real-Time Interfaces for Call Details
-
Real-Time Interfaces for VDNs
-
Historical Data Query
- Obtaining Historical Monitoring Indicators by VDN
- Querying Information About Missed Calls in a Specified VDN
- Obtaining Historical IVR Monitoring Indicators
- Obtaining Historical Monitoring Indicators by Skill
- Obtaining Historical Monitoring Indicators by Agent
- Obtaining Historical Monitoring Indicators in a Specified Time Range by Skill
- Obtaining Historical Monitoring Indicators in a Specified Month Range by Skill
- Obtaining Historical Monitoring Indicators in a Specified Time Range by Agent
- Obtaining Historical Monitoring Indicators in Specified Month by Agent
- Collecting Statistics on Result Sets in Daily Settlement Table for Inbound Calls
- Collecting Statistics on Result Sets in Daily Settlement Table for Outbound Calls
-
Configuration Data Query
- Querying Information about All VDNs in a Specified Call Center
- Querying Information About All Agents by VDN ID
- Obtaining All Called Routes in a VDN
- Querying Information About All Agents by Tenant Space ID
- Querying Skill Groups in a Specified VDN
- Querying Information About All Tenants Accessible to an Access User
-
Inspection Relationship Maintenance Interfaces
- Querying a User Group Member
- Deleting Members from a Group in Batches
- Adding Members to a Group in Batches
- Querying All User Groups
- Adding a User Group
- Deleting a User Group
- Updating User Group Information
- Setting Inspection Relationships
- Deleting Configured Inspection Relationships
- Adding an Agent to a User Group
- Updating Agent Names
- Querying Outbound Call Task Lists
-
Interfaces for Querying System Indicators
- Querying UAP Performance Information
- Querying Key Information About Control Blocks
- Querying the Registration Status of a Terminal
- Interface for Querying UAP Performance Indicator Statistics
- Interface for Querying UAP Terminal Statistics
- Interface for Querying CTI System Indicators
- Querying the Time of the CTI Platform Server
- Querying the Current License Usage in the System
- Checking Cluster Health Status
-
Appendix
- Indicator Code Reference
- Error Code Reference
- CTI Platform Agent Status Code Reference
- Description of Call Media Types
- Description of Call Submedia Types
- Description of Call Types
- Description of Agent Types
- Call Features
- Reasons for Leaving the Device of the Call
- Cause Code
- Device Types
- Agent Operation Types
- Interfaces of Earlier Versions (Versions Earlier Than 8.13.0)
-
Real-Time Data Query
-
Real-time Inspection: qualitycontrol
-
Recording and CDR Interface Reference
- Recording
-
CDR Download and Recording Playback and Download
-
Data Access Interface
- Obtaining a Recording Download and Playback URL
- Generating CDRs and Recording Indexes
- Downloading CDRs and Recording Indexes
- Downloading a Recording File
- Downloading a Recording File (Extended)
- Generating Indexes of Agent Operation Details
- Downloading Indexes of Agent Operation Details
- Requesting to Play Back a Recording File
- Playing Back a Recording File
- Downloading an Intelligent IVR Recording File
- Downloading IVR Voice Messages
- Downloading a Recording File as a Third Party
- Uploading a File as a Third Party
- Generating a File Hash Value as a Third Party
- Deleting an Uploaded File as a Third Party
- Index File Definition
- Reference Description
-
Data Access Interface
- Voice Notification Interface Reference
- OMA Interface Reference
- DataProcess Interface Reference
- Other Interfaces Reference
- FAQs
- General Reference
Copied.
Applying for Connecting to a Self-Owned Access Code
Prerequisites
To connect enterprise self-owned access codes that support SIP to the CEC, the following conditions must be met:
- Device: The device supports the full SIP protocol and has a fixed public IP address and port number.
- Network quality: The voice call quality depends on the stability of the data network. The packet loss rate between the enterprise and the CEC must be less than 1%, the network jitter must be less than or equal to 60 ms, and the delay must be less than 200 ms. If the network does not meet this requirement, the voice may be intermittent and the other party cannot hear clearly.
- Network bandwidth: The voice media protocol used by the CEC is G.711 A, the average traffic is 100 Kbit/s, and the uplink and downlink traffic is equal. Bandwidth is calculated as follows: Network bandwidth = (Number of concurrent users x 100 Kbit/s)/1024
Assume that there are 100 concurrent customers, the required bandwidth is (100 x 100 Kbit/s)/1024, that is, 9.7 Mbps. The required uplink and downlink bandwidth is 10 Mbit/s.
- Access code: Access codes that support SIP with signaling IP addresses and port numbers can be connected.
- Common fixed-line phone number and 95 number: Enterprises can submit applications themselves or Huawei helps enterprises submit applications to carriers.
- 400 number: You can directly apply for connecting to access codes that support SIP. For access codes that do not support SIP, contact the carrier to configure the forwarding of calls to a SIP fixed-line phone and apply for connecting to this self-owned access code. Common virtual numbers and mobile numbers cannot be connected.
Context
Introduction to SIP
Session Initialization Protocol (SIP) is a multimedia communication protocol developed by the Internet Engineering Task Force (IETF,https://www.ietf.org/). It is a text-based application-layer control protocol and is used to establish, modify, and release sessions of one or more participants. SIP is independent of transmission-layer protocols, and can be carried over different transmission protocols, such as UDP, TCP, TLS, and SCTP. SIP alone cannot complete a multimedia call. It establishes a complete multimedia communication system with other protocols. It must cooperate with protocols such as RTP/RTCP, SDP, MGCP, and DNS to complete a multimedia session process.
SIP only describes how to establish, modify, or release a session but does not describe the session contents. Therefore, SIP can carry any session contents, such as voices, videos, and games.
SIP protocol example
The SIP protocol content varies according to the line and scenario. The following is the SIP protocol content in a voice call successfully initiated by the CEC. You can refer to this example to understand the SIP protocol in use.
INVITE sip:18012345678@10.11.56.68:5060;user=phone SIP/2.0 /*Request line. It consists of Method, Request-URI, and SIP Version. The Request-URI header field specifies the called number 18012345678 obtained by the UAP.*/ /*SIP Header-start*/ Via: SIP/2.0/UDP 10.11.56.61:5060;branch=z9hG4bK9njqrkwmmvg6or9gnjml6hvwv;Role=3;Hpt=8e48_16 /*Message header. It is used to record the path that a request passes through, so that the response can be correctly returned along this path. The SIP URI carried in the Via header field identifies the host name or network address of the customer who initiates the request. The UAP obtains the signaling address of the peer end from the Via header field, for example, 10.11.56.61:5060.*/ Record-Route: <sip:10.11.56.61:5060;transport=udp;lr;Hpt=8e48_16;CxtId=4;TRC=ffffffff-ffffffff;X-HwB2bUaCookie=2717> /*Forcible routing. It is used to force a request to pass through a series of proxies.*/ Call-ID: isbcjiwwievb2zvydwesyf2w0dxvdzsszefd@UAP9600 /*Unique call ID. The value is a string of random characters.*/ From: <sip:02160123456@10.11.56.61;user=phone>;tag=yv20ze22-CC-57 /*Initiator of the request. The calling number can be obtained. For the first message, only the From field contains tag, and the To field does not contain tag.*/ To: <sip:18012345678@10.11.56.68;user=phone> /*Recipient of the request. During registration, it specifies the public customer to be registered. During a session, it specifies the recipient of the request and carries the URI of the recipient. For details about the tag field, see the description of the From field. The To header field in an initial request may not carry tag, but any request or response in a session must carry tag. IP address:Port number obtained by the UAP from the To field is the local signaling address. The UAP obtains the original called number from the Historyinfo or Diversion field first. If the Historyinfo or Diversion field does not contain the required information, the UAP obtains the original called number from the To field.*/ CSeq: 1 INVITE /*Sequence number of a transaction. The sequence number is incremented by 1.*/ Allow: INVITE,ACK,OPTIONS,BYE,CANCEL,REGISTER,INFO,PRACK,SUBSCRIBE,NOTIFY,UPDATE,MESSAGE,REFER /*Header field. It is used to list all SIP methods supported by the UA.*/ Contact: <sip:02160123456@10.11.56.61:5060;transport=udp;Hpt=8e48_16;CxtId=4;TRC=ffffffff-ffffffff> /*Address for subsequent direct communication with the customer. The SIP URI indicates the address for receiving responses.*/ Max-Forwards: 69 /*Maximum times that a request can be forwarded before it arrives at the destination. The value decreases by 1 each time the request is forwarded. This header field is used to prevent proxy resources from being continuously consumed when a loop occurs. The value ranges from 0 to 255. The recommended value is 70.*/ Supported: 100rel /*All SIP extension methods supported by the UAC or UAS.*/ User-Agent: Huawei UAP9600 V100R005C00 Content-Length: 236 //Length of the message body, in bytes.*/ Content-Type: application/sdp /*Type of the message body. In this example, the type is SDP.*/ /*SIP Header-end*/ /*SIP Body-start*/ v=0 /*Protocol version. In this example, the protocol version is 0. (The protocol version used by the SDP is 0.)*/ o=- 929076 929076 IN IP4 10.11.56.61 /*The first parameter: - indicates the name of the session initiator. This parameter is optional. The second parameter: 929076 indicates the session identifier of the calling party. The third parameter: 929076 indicates the version of the calling party. When the session data changes, the version number is increased by 1. The fourth parameter: IN indicates the network type Internet. Only this type of network is supported. The fifth parameter: IP4 indicates the IP address type. IPv4 and IPv6 are supported. The sixth parameter: 10.11.56.61 indicates the IP address of the session initiator, which is a signaling plane IP address.*/ s=SBC call /*Name of the current session.*/ c=IN IP4 10.11.56.61 /*Connection information. The "c=" line identifies the media receiving address of the UE. If the media-level "c=" line also exists, the media-level "c=" line is used. This parameter is mandatory in any case. The first parameter: IN indicates the network type Internet. Only this type of network is supported. The second parameter: IP4 indicates the IP address type. IPv4 and IPv6 are supported. The third parameter: 10.11.56.61 indicates the actual IP address used by multimedia streams.*/ t=0 0 /*The first parameter indicates the start time, and the second parameter indicates the stop time. The start time and stop time are Network Time Protocol (NTP) time in decimal format. If the values are both 0, the session is persistent.*/ m=audio 59354 RTP/AVP 8 0 97 /*m=<media> <port> <transport> <fmt list>. media indicates the media type, which can be audio or video. Currently, audio, video, application, data, and control are defined. port indicates the media port number. transport indicates the transport protocol. Currently, RTP/AVP is used. fmt list indicates the format list.*/ a=rtpmap:8 PCMA/8000 a=rtpmap:0 PCMU/8000 /*rtpmap indicates the keyword, which is in the format of {PT value} {Stream name}/{Sampling rate}.*/ a=rtpmap:97 telephone-event/8000 a=ptime:20 /*Media encapsulation duration (media duration that can be encapsulated in each packet, in milliseconds). In this example, the duration is 20 ms.*/ a=fmtp:97 0-15 a=sendrecv /*Media direction. In this example, the media direction is bidirectional. The media direction can be inactive, sendonly, recvonly, or sendrecv.*/ /*SIP Body-end*/
- SIP header is a signaling message used by the sending party to notify the receiving party of the basic information about the call.
The signaling messages may be understood as:
Call 10.11.56.68:5060.
I'm sending you a SIP message from 10.11.56.61:5060.
The call ID is xxxx.
The call is from 10.11.56.61:5060.
I need to send the message to 10.11.56.68:5060.
This is the first Invite message sent in the call request.
If you receive the message, reply to me at 10.11.56.61:5060.
This is Huawei UAP9600 V100R005C00. You can reply to me with INVITE, ACK, BYE, and other messages.
The signaling message contains 236 characters in the SDP format.
- The SIP body is a media message, that is, SDP. Media messages are mandatory in SIP messages. Signaling messages only enable the sending party and receiving party to know that they are connected. Media messages enable both parties to know the specific content of the messages.
The media messages may be understood as:
My version is 0.
The message is sent to you through the signaling address 10.11.56.61, and the media address is 10.11.56.61 (the server that processes the signaling may be different from the server that processes the media). The audio media stream port is 10002, and data is transmitted using RTP. The video media stream port is 10004, and data is also transmitted using RTP.
Not all terminals support video media. Therefore, when a SIP message is received, the peer end may receive only the audio media information. This is determined based on the negotiation result.
NOTICE:
Currently, the supported media transmission type is RTP/AVP, that is, the UDP channel is used to ensure the real-time audio and video transmission. The TCP-based RTP/SAVP media transmission type is not used.
Common SIP request and response messages are as follows.
Request |
Response |
Scenario |
---|---|---|
INVITE |
1XX |
Negotiation request, which is used when a session starts. If a 1XX message from the peer end is received, the SIP network is connected and the session can be started. |
ACK |
2XX |
When the signaling and media negotiation or registration is successful, the local system notifies the peer system of the success and establishes an RTP channel. |
OPTIONS |
3XX |
Redirection request, which is used to check trunks or MRCP links (for example, MRCP links used when the TTS or ASR is connected). |
BYE |
4XX |
Used when a call ends in normal cases. |
CANCEL |
5XX |
If a session is interrupted due to insufficient resources, the two ends of the SIP session need to forcibly release the call using the CANCEL request. |
REGISTER |
6XX |
Used for registration. |
- The CEC side uses the OPTIONS request to query the information and functions of the called party every minute to check whether the link status is normal. The link is considered normal and calls can be made only when the enterprise side returns a 200ok response.
- When the PRACK request is used for renegotiation, the CEC side requires that the 18x message (for example, 180 ringing) returned by the peer end contain the Require:100rel field and the INVITE request sent by the peer end contain the Supported:100rel field. Otherwise, no sound can be heard during the call.
- When the CEC side uses the UPDATE request for renegotiation, this mode is used for a normal call with an agent. When the INVITE request is used for renegotiation, this mode is used for the call that is connected to the intelligent IVR or transferred through the common IVR. Some carriers do not support renegotiation using the second INVITE request. As a result, some functions, such as the virtual number service, are unavailable.
Introduction to the call process
The process for a customer to initiate an incoming call to the CEC is as follows:
- The customer initiates a call and sends an INVITE request to the SBC of the CEC.
- The CEC side returns a ringing message and a link connection success (200) message.
- After receiving the message, the customer side returns a final response to the INVITE request.
- The CEC side receives the reply and sends a renegotiation message to the customer side.
- After receiving the message, the customer side returns a link connection success (200) message.
- After the CEC returns a response to the request, the customer and agent start a conversation.

Business Scenario
The solution for connecting enterprise self-owned access codes that support SIP to the CEC is as follows:

Typical scenario 1
The enterprise has local access code resources and directly connects to the CEC.
Connection solution:
- The enterprise applies for access code resources from the carrier. The resource type can be E1, private line, or SIP.
- After the application is successful, the enterprise needs to use the local voice gateway to convert the non-SIP lines of the carrier to the SIP lines for the communication with the public cloud SBC platform of the CEC. For details about the devices, see the local device recommendation in FAQs > Product Consulting.
- After referring to the procedure of applying for connecting to a self-owned access code, the enterprise sends an email to the CEC operations personnel to apply for the signaling IP address, port number, and media port number of the CEC, which are used to set the whitelist on the local firewall and connect to the line.
Typical scenario 2
The enterprise applies for access codes that support SIP from the carrier, and the carrier interconnects with Huawei.
Connection solution:
- The enterprise applies for access code and line resources from the carrier. The resource type can only be SIP.
- After access codes are successfully applied for, the enterprise submits an application to the CEC requiring Huawei to directly interconnect with the carrier. The enterprise does not need to connect to the access codes and lines.
Procedure
Perform the following steps to add a self-owned access code.
- Log in to Huawei Cloud.
- Choose
Service List > Business Applications > Cognitive Engagement Center.
- Choose Resource Management > Access Code.
- Click the Self-Owned Access Code tab page and click Click here to apply for connecting to a self-owned access code. in the upper right corner. On the page that is displayed, set the access code, signaling and media IP addresses and port numbers, and click OK.
Follow-up Procedure
You need to wait for the CEC operations personnel to configure the connection between Huawei Cloud and the self-owned access code. After the configuration is complete, the connection status of the access code is Completed on the Self-Owned Access Code page. You can click Associate Call Center Instance to associate the access code with an existing call center instance.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot