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

Passing Numbers in a Conference

Prerequisites

  • The agent has signed in.
  • The agent is in a three-party call with a customer and a third-party IVR.

Description

In a three-party call among an agent, a customer, and a third-party IVR, the customer can dial numbers for the third-party IVR to complete voice playback and digit collection. The customer's key presses need to be passed to the third-party IVR, and the number voices cannot be recorded on the agent side.

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}/thirdPartyConfTransmitNum

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 Parameter in the URI

No.

Parameter

Value Type

Mandatory (Yes/No)

Description

1

agentid

String

Yes

Agent ID. The value ranges from 101 to 999999.

Method Name in Logs

thirdPartyConfTransmitNum

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

10001

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": {}
    }