Field | Description |
free | Idle |
busy | In line |
arrange | After-call-work |
notReady | Busy |
rest | On break |
Field | Description |
staffSeat | Web agent type |
staffPhoneSeat | Agent's mobile type |
miniProgramSeat | Mini program type |
staffExtensionSeat | Telephone type |
Parameter | Type | Required | Remarks | |
options | status | 'success' |'error' | Yes | Result of SDK API call. Returns 'success' on success, and 'error' on failure. |
| errorMsg | string | No | Error message, returned when status is 'error' |
Parameter | Type | Required | Remarks | |
options | phoneNumber | String | Yes | Contact Number |
| phoneDesc | String | No | Number remarks, which will replace the number displayed in the call bar |
| uui | String | No | |
| skillGroupId | String | No | The bound outbound number in the skill group |
| callerPhoneNumber | String | No | Outbound number |
| servingNumberGroupIds | String[] | No | Number ID list |
| phoneEncodeType | 'number' | No | Currently, only 'number' is supported, forcing the use of actual numbers when number mapping is enabled. |
Parameter | Type | Required | Remarks | |
response | sessionId | String | Yes | Session ID |
| calleeLocation | String | No | Called number's location |
| calleePhoneNumber | String | Yes | Contact Number |
| callerPhoneNumber | String | Yes | The calling number used for making an outbound call |
| serverType | String | Yes | Type of the endpoint used for making an outbound call. Optional values are: staffSeat, staffPhoneSeat, and staffExtensionSeat. For details, see Session Service Type. |
| remark | String | No | Called number remarks |
Parameter | Type | Required | Remarks | |
options | sessionId | String | Yes | Session ID, obtained from the tccc.events.callIn event |
Parameter | Type | Required | Remarks | |
options | sessionId | String | Yes | Session ID |
Parameter | Type | Required | Remarks | |
options | sessionId | String | Yes | Session ID |
Parameter | Type | Required | Remarks | |
options | sessionId | String | Yes | Session ID |
Parameter | Type | Required | Remarks | |
options | sessionId | String | Yes | Session ID |
Parameter | Type | Required | Remarks | |
options | sessionId | String | Yes | Session ID |
Parameter | Type | Required | Remarks | |
options | calleeUserId | String | Yes | Called agent account |
| useMobile | Boolean | No | Whether to call their mobile phone or not |
Parameter | Type | Required | Remarks | |
options | sessionId | String | Yes | Session ID |
| skillGroupId | String | No | Transfers to a specified skill group. |
| userId | String | No | Transfers to a specified agent. |
Parameter | Type | Required | Remarks | |
options | sessionId | String | Yes | Session ID |
Parameter | Type | Required | Remarks | |
options | sessionId | String | Yes | Session ID |
Parameter | Type | Required | Remarks | |
options | sessionId | String | Yes | Session ID |
| dtmfText | String | No | The extension number to be sent |
Parameter | Type | Required | Remarks | |
options | sessionId | String | Yes | Session ID |
Parameter | Type | Required | Remarks | |
options | sessionId | String | Yes | Session ID |
Parameter | Type | Required | Remarks | |
options | sessionId | String | Yes | Session ID |
| skillGroupId | String | No | Transfers to a specified skill group. |
| userId | String | No | Transfers to a specified agent. |
Parameter | Type | Required | Remarks | |
options | sessionId | String | Yes | Session ID |
Parameter | Type | Required | Remarks | |
options | sessionId | String | Yes | Session ID |
Parameter | Type | Required | Remarks | |
options | sessionId | String | Yes | Session ID |
Parameter | Type | Required | Remarks | |
options | sessionId | String | Yes | Session ID |
Parameter | Type | Required | Remarks | |
options | sessionId | String | Yes | Session ID |
Parameter | Type | Required | Remarks | |
options | sessionId | String | Yes | Session ID |
Parameter | Type | Required | Remarks | |
options | sessionId | String | Yes | Session ID |
| skillGroupId | String | No | Transfers to a specified skill group. |
| userId | String | No | Transfers to a specified agent. |
Parameter | Type | Required | Remarks | |
options | status | String | Yes | Agent status, valid values: free: Idle rest: On break arrange: After-call-work notReady: Busy stopNotReady: Stops showing busy |
| restReason | String | No | On break reason |
Parameter | Type | Required | Remarks | |
options | sessionId | String | Yes | Session ID |
| type | 'phone' | Yes | Telephone session type |
| timeout | Number | Yes | Session access timeout duration, with 0 representing no timeout |
| calleePhoneNumber | String | Yes | Contact Number |
| callerPhoneNumber | String | No | Caller Number |
| callerLocation | String | No | Caller's location |
| remark | String | No | Remarks |
| ivrPath | {key: String, label: String}[] | - | User's IVR key path. key represents the corresponding key, and label represents the corresponding key tag. |
| protectedCallee | String | No | When mapping is enabled, the number represents the called party. |
| protectedCaller | String | No | When mapping is enabled, the number represents the caller. |
| serverType | 'staffSeat' | 'staffPhoneSeat' | 'staffExtensionSeat' | Yes | Indicates the type of the agent the call goes to. staffSeat: Default value, indicating Web agent
StaffPhoneSeat: Agent's mobile
MiniProgramSeat: Mini program agent staffExtensionSeat: Telephone bound to the agent |
Parameter | Type | Required | Remarks | |
options | sessionId | String | Yes | Session ID |
| type | 'phone' | Yes | Telephone session type |
| timeout | Number | Yes | Session access timeout duration, with 0 representing no timeout |
| nickname | String | Yes | User's nickname |
| avatar | String | No | User's profile photo |
| remark | String | No | Remarks |
| peerSource | String | No | Channel source |
| channelName | String | No | Custom parameter |
| clientData | String | No | User-defined parameter |
Parameter | Type | Required | Remarks | |
options | sessionId | String | Yes | Session ID |
| type | 'voip' | Yes | Audio session type |
| timeout | Number | Yes | Session access timeout duration, with 0 representing no timeout |
| callee | String | Yes | Channel entry |
| calleeRemark | String | No | Channel entry remarks |
| userId | String | Yes | User's openId |
| nickname | String | No | Users will get a WeChat nickname after authorization. |
| avatar | String | No | Users will receive a WeChat profile photo after authorization. |
| remark | String | No | Remarks |
| peerSource | String | No | Caller's location |
| ivrPath | {key: String, label: String}[] | No | User's IVR key path. key represents the corresponding key, and label represents the corresponding key tag. |
| clientData | String | No | User-defined parameter |
Parameter | Type | Required | Remarks | |
options | sessionId | String | Yes | Session ID |
| type | 'video' | Yes | Video session type |
| timeout | String | Yes | Session access timeout duration, with 0 representing no timeout |
| userId | String | Yes | User's openId |
| nickname | String | No | Users will get a WeChat nickname after authorization. |
| avatar | String | No | Users will receive a WeChat profile photo after authorization. |
| remark | String | No | Remarks |
| | | | |
Parameter | Type | Required | Remarks | |
options | sessionId | String | Yes | Session ID |
| type | 'internal' | Yes | Internal session type |
| timeout | Number | Yes | Session access timeout duration, with 0 representing no timeout |
| peerUserId | String | Yes | Caller's account |
Parameter | Type | Required | Remarks | |
options | sessionId | String | Yes | Session ID |
Parameter | Type | Required | Remarks | |
options | sessionId | String | Yes | Session ID |
Parameter | Type | Required | Remarks | |
options | sessionId | String | Yes | Session ID |
| closeBy | String | Yes | Indicates the hang-up party: client: Hang up by user seat: Hang up by agent admin: Hang up by system timer: Hang up by timer |
| mainReason | String | No | Only exists in telephone type, and when the hang-up party is "admin", indicating the reason for hang-up. |
| subReason | String | No | Only exists in telephone type, and when the hang-up party is "admin", indicating the detailed reason for hang-up. |
Parameter | Type | Required | Remarks | |
options | sessionId | String | Yes | Session ID |
Parameter | Type | Required | Remarks | |
options | sessionId | String | Yes | Session ID |
Parameter | Type | Required | Remarks | |
options | sessionId | String | Yes | Session ID |
Parameter | Type | Required | Remarks | | |
options | status | No | |
Parameter | Type | Required | Remarks | | |
options | sessionId | String | Yes | Session ID | |
| result | ASR recognition result | Yes | Automatic Speech Recognition result structure | |
| flow | 'IN' | 'OUT' | Yes | Recognition direction IN: User side OUT: Agent side | |
Was this page helpful?