logo.png recording/recordings/get JSON API function

JSON API » recording » recording/recordings/get

Gets the fields of a call recording.

Input parameters

Requires authentication and the record role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
recordgroupIntegerID of record group to get from.Yes
uniqueidStringUnique ID of call recording to get.Yes
recordidStringRecord ID of call recording to get.Yes

Responses

CodeDescription
200Success.
400Invalid input parameters specified. Check the key and message fields for more details.
401The authentication details provided are invalid.
402Your role does not allow this.
404The call recording does not exist, or you do not have permission to view it.

Data returned

Fields of call recording, including sound file (base64 encoded).

Example: With required parameters

https://www.015pbx.net/local/api/json/recording/recordings/get/?auth_username=user;auth_password=password;recordgroup=123;uniqueid=1234567890;recordid=1

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "uniqueid":"1234567890", ... } }