Redial the number in the desensitized call record
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| InstanceId |
string |
Yes |
Instance ID of the call center. |
abc |
| UserId |
string |
No |
User ID of the agent. |
samzhang@abc |
| DeviceId |
string |
No |
Unique ID provided by the agent endpoint to identify an agent Workbench. |
CCC-x.x.x.x-chrome102-bsdf911812c60f61e |
| Caller |
string |
No |
Caller number. |
0109810**** |
| Callee |
string |
No |
Callee number. |
1318888**** |
| TimeoutSeconds |
integer |
No |
Timeout. If the call is not answered within the time specified by this parameter, it is automatically disconnected. |
30 |
| Tags |
string |
No |
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. |
a=b |
| JobId |
string |
No |
Call job ID. The job ID of the previous call used for redialing. |
job-6581536084722**** |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| Code |
string |
Status code. A return value of "OK" indicates that the request succeeded. For other error codes, see the error code list. |
OK |
| HttpStatusCode |
integer |
HTTP status code. |
200 |
| Message |
string |
Response message |
无 |
| RequestId |
string |
Request ID. |
BF268B34-09C2-43FD-BAC4-5D31EA63**** |
| Params |
array |
List of response parameters. |
|
|
string |
Response parameter. |
skillGroupId |
|
| Data |
object |
Data. |
|
| ContextId |
integer |
Context ID, strictly ordered and incrementing. |
123456789 |
| CallContext |
object |
Call context environment. |
|
| CallType |
string |
The call type, indicating the type of the call when it was initially initiated. Valid values:
|
OUTBOUND |
| InstanceId |
string |
Cloud Contact Center instance ID. |
abc |
| JobId |
string |
The call job ID. |
job-6538214103685**** |
| ChannelContexts |
array<object> |
The list of call channels. |
|
|
object |
A call channel. |
||
| ReleaseInitiator |
string |
The party that initiated the hang-up of the call channel, indicating who first terminated the call. |
139xxxx0501 |
| ChannelState |
string |
The status of the voice channel. Valid values:
|
CREATED |
| Destination |
string |
The callee of the voice channel. |
8001**** |
| UserId |
string |
Agent User ID information. |
samzhang@abc |
| ChannelFlags |
string |
Call channel flags. Valid values:
|
COACHING |
| Timestamp |
integer |
UNIX timestamp of the last status change. |
1609138903315 |
| ReleaseReason |
string |
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. |
486:USER_BUSY |
| CallType |
string |
The call type of the channel. Valid values:
|
OUTBOUND |
| JobId |
string |
Call job ID. |
job-6573574060089**** |
| ChannelId |
string |
Channel ID. |
ch:user:1390501****->8032****:1609138902226:job-653821410368**** |
| Originator |
string |
The calling party of the call channel. |
1318888**** |
| UserExtension |
string |
User extension number. |
8000**** |
| UserContext |
object |
Agent context environment. |
|
| Extension |
string |
User extension number. |
8000**** |
| WorkMode |
string |
Work mode. Enumeration values:
|
ON_SITE |
| DeviceId |
string |
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. |
CCC-x.x.x.x-chrome102-bsdf911812c60f61e |
| JobId |
string |
Call job ID. |
job-6573574060089**** |
| UserId |
string |
Agent User ID information. |
samzhang@abc |
| BreakCode |
string |
Break status code, which is divided into system-defined and customer-defined types. System-defined break codes:
There are no restrictions on customer-defined status codes. Customers can define them according to their business needs. |
Warm-up |
| InstanceId |
string |
Instance ID. |
abc |
| OutboundScenario |
boolean |
Indicates whether the agent is in outbound-only mode. |
False |
| UserState |
string |
Agent status. Enumeration values:
|
READY |
| SignedSkillGroupIdList |
array |
List of skill group IDs that the agent has signed into. |
|
|
string |
Skill group ID that the agent has signed into. |
skillgroup1@abc |
Examples
Success response
JSON format
{
"Code": "OK",
"HttpStatusCode": 200,
"Message": "无",
"RequestId": "BF268B34-09C2-43FD-BAC4-5D31EA63****",
"Params": [
"skillGroupId"
],
"Data": {
"ContextId": 123456789,
"CallContext": {
"CallType": "OUTBOUND",
"InstanceId": "abc",
"JobId": "job-6538214103685****",
"ChannelContexts": [
{
"ReleaseInitiator": "139xxxx0501",
"ChannelState": "CREATED",
"Destination": "8001****",
"UserId": "samzhang@abc",
"ChannelFlags": "COACHING",
"Timestamp": 1609138903315,
"ReleaseReason": "486:USER_BUSY",
"CallType": "OUTBOUND",
"JobId": "job-6573574060089****",
"ChannelId": "ch:user:1390501****->8032****:1609138902226:job-653821410368****",
"Originator": "1318888****",
"UserExtension": "8000****\n"
}
]
},
"UserContext": {
"Extension": "8000****",
"WorkMode": "ON_SITE\n",
"DeviceId": "CCC-x.x.x.x-chrome102-bsdf911812c60f61e\n",
"JobId": "job-6573574060089****",
"UserId": "samzhang@abc\n",
"BreakCode": "Warm-up",
"InstanceId": "abc",
"OutboundScenario": true,
"UserState": "READY",
"SignedSkillGroupIdList": [
"skillgroup1@abc"
]
}
}
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | UserBusy | The user %s you called was busy. Please try again later. | |
| 400 | InvalidOperation.ChannelState | The operation is not allowed. Channel stats (%s) does not meet expectations (%s). | |
| 400 | InvalidOperation.UserState | The operation is not allowed. User state (%s) does not meet expectations (%s). | |
| 500 | InternalService.CTI | An internal CTI service error occurred. %s | |
| 404 | NotExists.UserId | The user %s does not exist in instance %s. | |
| 404 | NotExists.InstanceId | The specified instance %s does not exist. | |
| 404 | NotExists.Extension | No available extension number exists. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.