Help Center/ Cognitive Engagement Center/ API Reference/ Chatbot Management Interface Reference/ Dialog Interfaces (V2)/ Recognition Result Requesting Interface (inaction=13)
Updated on 2023-09-27 GMT+08:00
View PDF
Share

Recognition Result Requesting Interface (inaction=13)

inparams

Parameter

Type

Position

Mandatory

Description

call_id

String

Body

No

Unique call ID, which is the same as the value of userid and is used by the flow.

The value can contain a maximum of 64 characters.

call_sor_id

String

Body

No

User ID. (In the voice navigation and voice outbound call scenarios, the user number is transferred. In other interaction scenarios, the user ID is transferred.)

The value can contain a maximum of 64 characters.

call_dst_id

String

Body

Yes

Access ID.

1. In the voice navigation scenario, this parameter is set to the flow access code.

2. In the voice outbound call survey scenario, this parameter is set to the flow access code.

3. In other interaction scenarios, this parameter is set to the access ID.

The value can contain a maximum of 20 characters.

real_callee

String

Body

No

Called number for accessing the IVR. This parameter is valid in the voice navigation scenario.

The value can contain a maximum of 32 characters.

cti_callid

String

Body

No (special field in the voice navigation scenario)

Call ID of the CTI to which a call is connected, which is transferred by Huawei IVR. In other scenarios, this parameter is left empty.

The value can contain a maximum of 32 characters.

auth_token

String

Body

Yes

Authorization information, which is the token value returned by the access control system.

Request Example

{
    "userid": "1528780879-9581",
    "inaction": 13,
    "inparams": {
        "call_id": "1528780879-9581",
        "call_sor_id": "13500000001",
        "call_dst_id": "10086", 
        "auth_token":"eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE1MzgwMzg5MzUsImV4cCI6MTUzODA0MjUzNSwian"
    }
}

After receiving the request in which the value of inaction is 13, the ODFS checks whether the call recognition result queue reported by VoiceCyber contains data. If yes, the ODFS returns 1 to the IVR. If no, the ODFS returns 0.

Table 1 outparams (outaction=13: Recognition Result Feedback)

Parameter

Type

Position

Mandatory

Description

call_id

String

Body

Yes

Unique call ID, which is the same as the value of userid and is used by the flow.

recognize_type

String

Body

Yes

Whether the recognition result has been obtained.

  • 0: no
  • 1: yes

Response Example

{
    "ret":"0",
    "userid": "1528780879-9581",
    "outaction": "13",
     "outparams": {
        "call_id": "1528780879-9581",
        "recognize_type": "0"
     }
}
Parent topic: Dialog Interfaces (V2)