get https://{domainname}/CAServices/Call/Record.php
This API allows you to manage call recordings while on call, with the ability to pause and resume recordings as necessary during the conversation.
To access this API the following parameters MUST be passed.
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
Passing empty userName Value | {"status":"Error","message":"userName should not be empty"} |
Passing Invalid userName Value | {"status":"Error","message":"userName or apiKey is Invalid"} |
Missing apiKey Value | {"status":"Error","message":"apiKey should not be empty"} |
Passing Invalid apiKey Value | {"status":"Error","message":"userName or apiKey is Invalid"} |
Passing Invalid action Value | {"status":"Error","message":"action should be either pause or unPause"} |
Missing action Value | {"status":"Error","message":"action should not be empty"} |
Passing Invalid ucid Value | {"status":"Error","message":"ucid is Invalid"} |
Missing ucid Value | {"status":"Error","message":"ucid should not be empty"} |
Success response when action=pause | {"status":"Error","message":"{"status":"Success","message":"paused monitoring of the channel"}"} |
Success response when action=unPause | {"status":"Error","message":"{"status":"Success","message":"Unpaused monitoring of the channel"}"} |