Updated on 2025-11-13 GMT+08:00

Enabling Intelligent Recognition for a Specified Call

Prerequisites

  • The agent has signed in.
  • The agent has a ringing call but does not answer the call.

Description

If the Enable ASR on the Service Side function is enabled on the WAS configuration console and an agent has a ringing call but does not answer the call, the agent can invoke this interface to enable intelligent ASR for the call.

This function is used only for the UAP9600 V300R025 series.

To use this function, log in to the UAP portal, choose System Manage > Config Parameters > Software Parameters, and set Parameter Index to 909, Bit to 3, and Bit Value to 1, indicating that the NLR operation can be performed when the NLR capability is not enabled in a conference.

Interface Method

The request method must be set to POST. This interface supports only the POST method.

URI

https://IP address:Port number/agentgateway/resource/voicecall/{agentid}/startasrbycallid

If the CC-Gateway is deployed in single-node mode, set IP address to the CC-Gateway server address and Port number to the HTTPS port number of the CC-Gateway server (the default value is 8043). If the CC-Gateway is deployed in cluster mode, set IP address to the NSLB address and Port number to the default value 8043.

For the CC-Gateway port number on the NSLB, log in to any NSLB node as the nslb user and run the ./nslbctl l command to query the port number. In the query result, the following port is opened by the CC-Gateway to third-party systems through the NSLB.

In the SaaS scenario, contact O&M personnel to obtain the values of IP address and Port number.

Table 1 Parameters in the URI

No.

Parameter

Value Type

Mandatory (Yes/No)

Description

1

agentid

String

Yes

Agent ID. The value ranges from 101 to 999999.

2

callId

String

Yes

Call ID.

Method Name in Logs

startASR

Request Description

  • Message header
    Table 2 Parameters in the request message header

    No.

    Parameter

    Value Type

    Mandatory (Yes/No)

    Description

    1

    Content-Type

    String

    Yes

    Coding mode of the message body. The default value is application/json; charset=UTF-8.

    2

    Guid

    String

    Yes

    GUID returned by the sign-in interface during static authentication (AUTHMODE is set to 1) or GUID returned by the polling event query interface during dynamic authentication (AUTHMODE is set to 2).

  • Message body

    None

Response Description

Table 3 Parameters in the message body

Parameter

Value Type

Description

message

String

Description.

retcode

String

Error code. The options are as follows:

0: success

Other values: failure

result

Object

Reserved field.

Triggered Event

None

Error Code

200-040

Example

  • Message header
    Content-Type:application/json; charset=UTF-8
    Guid: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
  • Request parameter

    None

  • Response parameter
    {
        "message": "",
        "retcode": "0",
        "result": {}
    }