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

Change History

Issue 24 (2025-06-30)

This issue is released with AICC 25.200.0.

No.

Interface

Type

Remarks

1

Downloading Recordings

Modified

The optional field recordFormat is added.

2

Setting the Number of Concurrent Agent Sessions: setcallnumsbymediatype

New

The interface for setting the number of agent sessions is added.

3

Offline Callback Event

New

Events are added.

4

Signing In

Modified

The request parameter signInMode is added.

5

Forcibly Signing In

Modified

The request parameter signInMode is added.

6

Synchronizing the Agent Status and Call Information When the Agent Page Is Refreshed

Modified

The response parameter signInMode is added.

7

This interface contains the agentid, workno, and workNo parameters.

Modified

The value ranges of agentid, workno, and workNo are changed to 101–999999.

8

Signing In

Modified

  • The value 8 is added for the status parameter.
  • The request parameters time and restcause are added.

9

Forcibly Signing In

Modified

  • The value 8 is added for the status parameter.
  • The request parameters time and restcause are added.

10

Enabling Intelligent Recognition for a Specified Call

New

This interface is added.

The error code 200-040 is added.

Issue 23 (2025-03-31)

This issue is released with AICC 25.100.0.

No.

Interface

Type

Remarks

1

-

New

The following CC-Gateway error codes are added:
  • 104-012
  • 108-019
  • 000-007
  • 100-021

2

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

Modified

The uuiData parameter is added.

Issue 22 (2025-01-15)

This issue is released with AICC 24.400.0.

No.

Interface

Type

Remarks

1

https://IP address:Port number/agentgateway/resource/recordplay/{agentid}/playrelocation

New

  • This interface is added.
  • The following CC-Gateway error codes are added:
    • 500-012
    • 500-013

2

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

Modified

  • The response parameter detailCode is added.
  • The error code 100-020 is added.

3

https://IP address:Port number/agentgateway/resource/onlineagent/{agentid}/forcelogin

4

https://IP address:Port number/agentgateway/resource/calldata/{agentid}/getNetCallId/{callid}

New

This interface is added.

5

https://IP address:Port number/agentgateway/resource/agentgroup/{agentid}/agentbyskill/{skillid}

Modified

The following response parameters are added:

  • preRestFlag
  • preBusyFlag

6

https://IP address:Port number/agentgateway/resource/agentgroup/{agentid}/agentbyworkno/{workno}

7

https://IP address:Port number/agentgateway/resource/agentgroup/{agentid}/allonlineagents

Issue 21 (2024-09-30)

This issue is released with AICC 24.300.0.

No.

Interface

Type

Remarks

1

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

New

This interface is added.

2

https://IP address:Port number/agentgateway/resource/agentgroup/{agentid}/agentbyskill/{skillid}

Modified

The agentLimit and agentStatus parameters are added to the message body.

3

-

Modified

CC-Gateway error code. Add the following:

100-019

Issue 20 (2024-06-30)

This issue is released with AICC 24.200.0.

No.

Interface

Type

Remarks

1

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

Modified

The verification of the address parameter is modified so only digits are allowed.

2

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

Modified

The request parameter userVideoDirection is added.

3

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

Modified

The request parameter videoDirection is added.

Issue 19 (2024-03-30)

This issue is released with AICC 24.100.0 and has no changes.

Issue 18 (2024-01-30)

This issue is released with AICC 23.400.0.

No.

Interface

Type

Remarks

1

https://IP address:Port number/agentgateway/resource/qualitycontrol/{agentid}/intercept/{workNo}/{callId}

New

The interface for intercepting a specified call is added.

Issue 17 (2023-10-30)

This issue is released with AICC 23.300.0 and has no changes.

Issue 16 (2023-07-30)

This issue is released with AICC 23.200.0 and has no changes.

Issue 15 (2023-04-30)

This issue is released with AICC 23.100.0 and has no changes.

Issue 14 (2023-01-30)

This issue is released with AICC 22.200.0.

No.

Interface

Type

Remarks

1

https://IP address:Port number/agentgateway/resource/onlineagent/{agentid}/setcustomstate?customstate={customstate}

New

The interface for an agent to customize status is added.

2

https://IP address:Port number/agentgateway/resource/onlineagent/{agentid}/cancelcustomstate

New

The interface for an agent to cancel status customization is added.

3

https://IP address:Port number/agentgateway/resource/onlineagent/{agentid}/querycustomstate

New

The interface for an agent to query customized status is added.

4

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

Modified

The request parameter skillId is added.

5

https://IP address:Port number/agentgateway/resource/mediacall/{agentid}/transfer

Modified

The request parameter skillId is added.

6

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

New

The interface for passing numbers in a conference is added.

7

https://IP address:Port number/agentgateway/resource/mediacall/{agentid}/sendmessage

Modified

The restrictions on the data parameter are modified.

Issue 13 (2022-07-30)

This issue is released with AICC 22.100.0.

No.

Interface

Type

Remarks

1

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

Modified

The system access code is added for the transfer type.

2

https://IP address:Port number/agentgateway/resource/mediacall/{agentid}/transfer

Modified

The system access code is added for the transfer type.

3

https://IP address:Port number/agentgateway/resource/onlineagent/{agentid}/logininfo

New

The interface for obtaining token information is added.

4

https://IP address:Port number/agentgateway/resource/mediacall/{agentid}/getconnectinfo

New

The interface for obtaining access information is added.

5

https://IP address:Port number/agentgateway/resource/mediacall/{agentid}/imagecapture

New

The screenshot interface is added.

Issue 12 (2022-01-30)

This issue is released with AICC 8.17.0.

No.

Interface

Type

Remarks

1

-

Modified

The "Error Code" section and CTI error code table are added.

2

https://IP address:Port number/agentgateway/resource/recordplay/{agentid}/netplay

New

Network call recording playback.

3

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

Modified

The phone linkage logic is added to the sign-in interface.

4

https://IP address:Port number/agentgateway/resource/onlineagent/{agentid}/forcelogin

Modified

The phone linkage logic is added to the forcible sign-in interface.

5

https://IP address:Port number/agentgateway/resource/onlineagent/{agentid}/resetskill/{autoflag}?skillid={skillid}&phonelinkage={phonelinkage}

Modified

The phone linkage logic is added to reset skill queues.

6

https://IP address:Port number/agentgateway/resource/voicecall/{agentid}/answer?{callid=XXXX}

Modified

The phone linkage logic is added to the call answering interface.

7

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

New

Physical phone off-hook interface.

8

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

New

Physical phone call rejection interface.

9

https://IP address:Port number/agentgateway/resource/calldata/{agentid}/statisticsEx

New

Extended interface for querying call information.

Issue 11 (2021-10-15)

This issue is released with AICC 8.16.0.

No.

Interface

Type

Remarks

1

https://IP address:Port number/agentgateway/resource/onlineagent/{agentid}/saybusy?reason={reason}&prolong={false}

Modified

Busy agents can set the states to busy again, and the prolong URL parameter is added.

2

https://IP address:Port number/agentgateway/resource/onlineagent/{agentid}/rest/{time}/{restcause}?prolong={false}

Modified

Rest agents can set the states to rest again, and the prolong URL parameter is added.

3

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

Modified

A three-party help call can be unheld, and the holdflag parameter is added.

4

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

Modified

A call can be unheld during release-after-three-way-talk forwarding, and the holdflag parameter is added.

Issue 10 (2021-08-23)

This issue is released with AICC 8.15.1.

No.

Interface

Type

Remarks

1

https://IP address:Port number/agentgateway/resource/voicecall/{agentid}/snatchpickup?destWorkNo={destWorkNo}

New

The interface for picking up a call for other agents is added.

2

https://IP address:Port number/agentgateway/resource/calldata/{agentid}/callinfo?isNoContainLastCall={isNoContainLastCall}

Modified

The call track extended attribute is added to the return value.

3

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

New

The interface for rejecting an inbound call is added.

Issue 09 (2021-06-30)

This issue is released with AICC 8.15.0.

No.

Interface

Type

Remarks

1

https://IP address:Port number/agentgateway/resource/recordfile/{agentid}/recordfiledownloadEx?callId= xxx&hwFileName=1

New

The extended interface for downloading recording files is added.

2

https://IP address:Port number/agentgateway/resource/agentconf/{agentid}/requestagentconf

New

The interface for applying for an agent conference is added.

3

https://IP address:Port number/agentgateway/resource/agentconf/{agentid}/answeragentconf

New

This interface is used by an agent to answer a conference call.

4

https://IP address:Port number/agentgateway/resource/agentconf/{agentid}/rejectagentconf

New

This interface is used by an agent to reject a conference call.

5

https://IP address:Port number/agentgateway/resource/agentconf/{agentid}/requestleaveagentconf

New

This interface is used by an agent to leave a conference.

6

https://IP address:Port number/agentgateway/resource/agentconf/{agentid}/releaseagentconf

New

This interface is used to release an agent conference.

7

https://IP address:Port number/agentgateway/resource/agentconf/{agentid}/holdparticipant

New

This interface is used to hold a participant.

8

https://IP address:Port number/agentgateway/resource/agentconf/{agentid}/unholdparticipant

New

This interface is used to unhold a participant.

9

https://IP address:Port number/agentgateway/resource/agentconf/{agentid}/prolongtime

New

This interface is used by a chairperson to apply for extending a conference.

10

https://IP address:Port number/agentgateway/resource/agentconf/{agentid}/applytoshiftpresident

New

This interface is used to transfer the chairperson permission.

11

https://IP address:Port number/agentgateway/resource/agentconf/{agentid}/batchaddparticipant

New

This interface is used to invite participants in batches.

12

https://IP address:Port number/agentgateway/resource/agentconf/{agentid}/batchremoveparticipant

New

This interface is used to delete participants in batches.

13

https://IP address:Port number/agentgateway/resource/agentconf/{agentid}/changeparticipantmode

New

This interface is used to modify participant attributes.

14

https://IP address:Port number/agentgateway/resource/agentconf/{agentid}/playvoicetoconf

New

This interface is used to play agent conference announcements.

15

https://IP address:Port number/agentgateway/resource/agentconf/{agentid}/stopvoicetoconf

New

This interface is used to stop playing agent conference announcements.

16

https://IP address:Port number/agentgateway/resource/agentconf/{agentid}/playvoicetoparticipant

New

This interface is used to play announcements for agent conference channels.

17

https://IP address:Port number/agentgateway/resource/agentconf/{agentid}/stopvoicetoparticipant

New

This interface is used to stop playing announcements for agent conference channels.

18

https://IP address:Port number/agentgateway/resource/agentconf/{agentid}/modifyconfresource

New

This interface is used to change the number of participants.

19

https://IP address:Port number/agentgateway/resource/agentconf/{agentid}/queryconfinfos

New

This interface is used to query conference information in batches.

20

https://IP address:Port number/agentgateway/resource/agentconf/{agentid}/querycallidonparticipant

New

This interface is used to query participant call IDs.

21

https://IP address:Port number/agentgateway/resource/agentconf/{agentid}/queryvdnconfid

New

This interface is used to query an ongoing conference ID in the VCC.

22

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

Modified

The description of the mediaability parameter is modified.

Issue 08 (2021-03-31)

This issue is released with AICC 8.14.0. The following interfaces are modified.

No.

Interface

Type

Remarks

1

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

Modified

The value 3 is added for the request parameter status to support sign-in in busy state.

2

https://IP address:Port number/agentgateway/resource/onlineagent/{agentid}/forcelogin

Modified

The value 3 is added for the request parameter status to support sign-in in busy state.

3

https://IP address:Port number/agentgateway/resource/onlineagent/{agentid}/loginex

Modified

The value 3 is added for the request parameter status to support sign-in in busy state.

4

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

New

The interface for making a previewed outbound call is added.

5

https://IP address:Port number/agentgateway/resource/agentgroup/{agentid}/allonlineagents

New

The interface for querying all online agents is added.

6

https://IP address:Port number/agentgateway/resource/voicecall/{agentid}/requestcall/ {callid}/{skilltype}?skillId={skillId}

New

The interface for requesting a specified call is added.

Issue 07 (2020-12-30)

This issue is released with AICC 8.13.0. The following interfaces are modified.

No.

Interface

Type

Remarks

1

https://IP address:Port number/agentgateway/resource/voicecall/{agentid}/mediaswitch?mediaType=3

New

This interface is used to support the switch between voice and video calls.

2

https://IP address:Port number/agentgateway/resource/calldata/{agentid}/holdlistex/{workno}

New

This interface is used by an inspector to query all calls placed on hold by a specified agent.

3

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

Modified

This interface is used to carry business employee IDs during sign-in.

4

https://IP address:Port number/agentgateway/resource/onlineagent/{agentid}/forcelogin

Modified

This interface is used to carry business employee IDs during sign-in.

5

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

New

This interface is used to control the image display of a three-party video call.

6

https://IP address:Port number/agentgateway/resource/recordplay/{agentid}/record

New

This interface is used to start recording.

7

https://IP address:Port number/agentgateway/resource/recordplay/{agentid}/stoprecord

New

This interface is used to stop recording.

8

https://IP address:Port number/agentgateway/resource/recordfile/{agentid}/videofiledownloadEx?recordId=xxx?locationId=xxx

New

This extended interface is used to download video files.

Issue 06 (2020-09-30)

This issue is released with AICC 8.12.0. The following interfaces are modified.

No.

Interface

Type

Remarks

1

https://IP address:Port number/agentgateway/resource/recordfile/{agentid}/videofiledownload?conferenceId=xxx&recordId=xxx&fileType=xxx

New

This interface is used to download video files.

2

https://IP address:Port number/agentgateway/resource/calldata/{agentid}/setcalldataex

Modified

The allowed call-associated data size is 16 KB.

3

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

Modified

The allowed call-associated data size is 16 KB.

4

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

Modified

The allowed call-associated data size is 16 KB.

5

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

Modified

The allowed call-associated data size is 16 KB.

6

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

Modified

The allowed call-associated data size is 16 KB.

7

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

Modified

The allowed call-associated data size is 16 KB.

8

https://IP address:Port number/agentgateway/resource/voicecall/{agentid}/mediaswitch?mediaType=3

New

A video agent can switch a voice call to a video call.

Issue 05 (2020-06-10)

This issue is released with AICC 8.11.0. The following interfaces are modified.

No.

Interface

Type

Remarks

1

https://IP address:Port number/agentgateway/resource/onlineagent/{agentid}/saybusy?reason={reason}

Modified

The cause code that shows busy is added.

2

https://IP address:Port number/agentgateway/resource/recordplay/{agentid}/startrecordscreen

New

This interface is used to start screen recording.

3

https://IP address:Port number/agentgateway/resource/recordplay/{agentid}/stoprecordscreen

New

This interface is used to stop screen recording.

4

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

Modified

The remaining validity period of an agent password is added to the result returned by the interface.

5

https://IP address:Port number/agentgateway/resource/onlineagent/{agentid}/forcelogin

Modified

The remaining validity period of an agent password is added to the result returned by the interface.

6

https://IP address:Port number/agentgateway/resource/onlineagent/{agentid}/loginex

Modified

The remaining validity period of an agent password is added to the result returned by the interface.

Issue 04 (2020-06-10)

This issue is released with AICC 8.10.0. The following interfaces are modified.

No.

Interface

Type

Remarks

1

https://IP address:Port number/agentgateway/resource/calldata/{agentid}/callinfo?isNoContainLastCall={isNoContainLastCall}

New

This interface is used to query call information.

2

All interfaces

Modified

Added the description about whether these interfaces support the video capability. Unless otherwise specified, all interfaces support voice and video capabilities.

3

https://IP address:Port number/agentgateway/resource/calldata/{agentid}/waitcallinfo/{skillid}

New

This interface is used to query Information about waiting calls in a specified skill queue.

4

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

Modified

When a call is transferred to an external number, the maximum value of mediaability is changed to 2.

5

https://IP address:Port number/agentgateway/resource/onlineagent/{agentid}/sendnoteletex

New

This interface is used to send notes.

Issue 03 (2020-01-22)

This issue is released with AICC 8.9.0. The following interfaces are modified.

No.

Interface

Type

Remarks

1

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

New

This interface is used to hold a connection.

2

https://IP address:Port number/agentgateway/resource/qualitycontrol/{agentid}/requestwhisperagent?whisperagentid={whisperagentid}

New

This interface is used to request a whisper.

3

https://IP address:Port number/agentgateway/resource/qualitycontrol/{agentid}/requeststopwhisperagent?whisperagentid={whisperagentid}

New

This interface is used to stop whispering.

4

https://IP address:Port number/agentgateway/resource/qualitycontrol/{agentid}/requestswitchinsertwhisperagent?whisperagentid={whisperagentid}&switchtype={switchtype}

New

This interface is used to switch the listening, insertion, and whisper operations.

Issue 02 (2019-07-03)

This issue is released with AICC 8.8.0. The following interfaces are modified.

No.

Interface

Type

Remarks

1

https://IP address:Port number/agentgateway/resource/mediacall/{agentid}/transfer

New

This is a multimedia transfer interface.

2

https://IP address:Port number/agentgateway/resource/mediacall/{agentid}/sendmessage

New

This interface is used to send multimedia messages.

3

https://IP address:Port number/agentgateway/resource/mediacall/{agentid}/setcallnums

New

This interface is used to set the number of multimedia sessions.

4

https://IP address:Port number/agentgateway/resource/recordfile/{agentid}?recordId= xxx&filetype=1

New

This interface is used to download recordings.

5

https://IP address:Port number/agentgateway/resource/queuedevice/{agentid}/ivrinfo

New

This interface is used to query the IVR Information of a VCC.

6

https://IP address:Port number/agentgateway/resource/voicecall/{agentid}/answer?{callid=XXXX}

Modified

The call ID can be carried in the manual answer message.

Issue 01 (2019-04-10)

This issue is the first official release.