get https://{domainname}/CAServices/Call/Record.php
Recording Control API
This API allows you to manage call recordings while on call, with the ability to pause and resume recordings as necessary during the conversation.
Required Parameters
| Parameter | Description |
|---|---|
| userName* | Your CloudAgent account user name. |
| apiKey* | API key of your account. Available in admin login. |
| action* | - 'pause' - to pause the recording - 'unPause' - to unpause the recording |
| ucid* | Unique identification number of the call. |
Possible Responses
Authentication Issues
Empty Username
{
"status": "Error",
"message": "userName should not be empty"
}Invalid Username
{
"status": "Error",
"message": "userName or apiKey is Invalid"
}Missing API Key
{
"status": "Error",
"message": "apiKey should not be empty"
}Invalid API Key
{
"status": "Error",
"message": "userName or apiKey is Invalid"
}Action Issues
Invalid Action
{
"status": "Error",
"message": "action should be either pause or unPause"
}Missing Action
{
"status": "Error",
"message": "action should not be empty"
}UCID Issues
Invalid UCID
{
"status": "Error",
"message": "ucid is Invalid"
}Missing UCID
{
"status": "Error",
"message": "ucid should not be empty"
}Success Responses
Pause Success
{
"status": "Error",
"message": "{\"status\":\"Success\",\"message\":\"paused monitoring of the channel\"}"
}Unpause Success
{
"status": "Error",
"message": "{\"status\":\"Success\",\"message\":\"Unpaused monitoring of the channel\"}"
}