Starting Voice Recording
- This interface is available only in private cloud mode.
- The inspector cannot perform recording operations in insertion, listening, or whispering mode.
- Video recording is not supported.
- The IF_ENABLE_AGENT_SELFRECORD parameter in the basic.properties file determines whether the interface can be used.
Description
This interface is used to start voice recording for an agent.
Interface Method
The request method must be set to PUT. This interface supports only the PUT method.
URI
https://ip:port/agentgateway/resource/recordplay/{agentid}/record
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.
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
beginRecord
Request Description
-
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).
-
Table 3 Parameters in the message body No.
Parameter
Value Type
Mandatory (Yes/No)
Description
1
fileName
string
No
Path for storing recording files. The value can contain a maximum of 100 characters and can be left empty.
If this parameter is not transferred or is left empty, the system automatically generates a value in the following format:
Drive letter:\VDN\Media type ID\YYYYMMDD\work ID\file name+suffix
The drive letter is specified by MAPPINGDISK in the basic.properties file. The default value is Y.
2
mediaType
int
Yes
Type of the recorded media. Currently, the value can only be 5 (common voice).
3
recordMode
int
No
Recoding mode.
0: to overwrite
1: to add
If this parameter is not set or is set to another value, the default value 0 is used.
4
recordFormat
int
No
Format of a recorded file.
0: The voice file is played in the default format configured on the resource side. The default format of the voice file is configured on the recording resource side.
1: 24KVOX
2: 32KVOX
3: 64KALAW
If this parameter is not set, the default value 0 is used.
NOTE:Only one recording format can be used in an environment. The same recording format is required event for different calls.
The delivered recording format must be the same as the voice playing format configured on the UAP.
Response Description
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 |
Map |
Returned result information object. For details about the parameters of this object, see Table 5. |
Triggered Event
- AgentMediaEvent_Record
- AgentMediaEvent_Record_Fail
- AgentOther_PhoneAlerting
- AgentOther_PhoneOffhook
Error Code
- 000-002
- 100-006
- 100-007
- 500-008
- 500-011
Example
- Message header
Content-Type:application/json; charset=UTF-8 Guid: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1
- Request parameter
{ "fileName": "Y:/15/0/20201119/186/142702.V3", "mediaType": 5, "recordMode": 0, "recordFormat": 0 }
- Response parameter
{ "result": { "taskId": "5086" }, "message": "success", "retcode": "0" }
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot