Updated on 2023-09-27 GMT+08:00

Querying the IVR Information of the VDN to Which an Agent Belongs

Prerequisites

  • The agent has signed in.

Description

This interface is used for an agent to query the IVR information of the VDN to which the agent belongs.

Interface Method

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

URI

https://ip:port/agentgateway/resource/queuedevice/{agentid}/ivrinfo

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

queryIVRInfoOnVdn

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

No.

Parameter

Value Type

Description

1

message

string

Description.

2

retcode

string

Error code. The options are as follows:

0: success

Other values: failure

3

result

int

Indicates the number of users in a skill queue returned after a successful query.

No result is returned if the query fails.

For details about the parameters of this object, see Table 4.

Table 4 Parameter description of result

No.

Parameter

Value Type

Description

3.1

access

string

Indicates the access code of the IVR flow.

3.2

id

int

Indicates the ID of the IVR flow.

3.3

description

string

Indicates the description of the IVR flow.

3.4

serviceNo

int

Indicates the service ID.

Triggered Event

None

Error Code

  • 600-004
  • 100-007
  • 100-006

Example

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

    None

  • Response parameter
    {
        "result": [
            {
                "access": "1321",
                "id": 1,
                "description": "252",
                "serviceNo": 1
            }
        ],
        "message": "success",
        "retcode": "0"
    }