Flow Status Change Interface
Interface Method
POST
URL
https://IP:PORT/oifde/rest/api/flow/changeWorkMode
Request
Parameter |
Type |
Position |
Mandatory |
Description |
---|---|---|---|---|
tenantId |
String |
Body |
Yes |
Tenant ID. |
callId |
String |
Body |
Yes |
Session ID. |
agentId |
String |
Body |
Yes |
Agent ID. |
workMode |
String |
Body |
Yes |
Session state, that is, the state of the flow to be switched. 0: common state 1: supervision state 2: insertion state 3: transfer state
NOTE:
This interface can be invoked to switch the status only in the supervision or insertion state. The new status is compared with the status of the current session.
|
callTransferRequest |
Object |
Body |
This parameter is mandatory when workMode is set to 3. |
For details about call transfer parameters, see Table 2. |
authToken |
String |
Body |
Yes |
Authentication token. For details, see C3 OIAP Interface Authentication. |
Parameter |
Type |
Position |
Mandatory |
Description |
---|---|---|---|---|
callTransferType |
String |
Body |
Yes |
Call transfer type. 1: transfer to the manual service (to a skill queue by routing code) 2: transfer to an IVR 3: transfer to the manual service (to a skill queue by skill name) 4: transfer to the manual service (to an agent by ID) 5: transfer to a third-party number 6: online digital assistance 7: transfer to the manual service (to the last agent. Currently, only multimedia is supported.) 8: transfer to the manual service (to the skill queue to which an agent belongs. Currently, only multimedia is supported.) 31: transfer to a multimedia message (to the last agent) 32: transfer to a multimedia message (to a skill queue) 33: transfer to a multimedia message (to an agent) |
callTransferRouteValue |
String |
Body |
Yes |
Call transfer route value.
|
callTransferTransData |
String |
Body |
No |
Channel-associated data. |
callTransferNumber |
String |
Body |
No |
Calling number. |
Response
Parameter |
Type |
Position |
Mandatory |
Description |
---|---|---|---|---|
errorCode |
String |
Body |
No |
Error code.
|
errorMsg |
String |
Body |
No |
Response description. |
Example
- Request
{ "tenantId":"XXX", "callId":"123123412300030010", "agentId":"88880002", "workMode":"3", "authToken": "t***********************", "callTransferRequest"{ "callTransferType":"5", "callTransferRouteValue":"88880006", "callTransferTransData":"", "callTransferNumber":"" } }
- Response
{ "errorCode" : "0", "errorMsg" : "" }
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