Updated on 2023-09-27 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, both the agent and 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:port/agentgateway/resource/voicecall/{agentid}/thirdPartyConfTransmitNum

In the URL, ip indicates the IP address of the CC-Gateway server, and port indicates the HTTPS port number of the CC-Gateway server.

Table 1 Parameter in the URI

No.

Parameter

Data Type

Mandatory (Yes/No)

Description

1

agentid

String

Yes

Agent ID. The value ranges from 101 to 59999.

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