A recording consent item handles getting the callers consent to record the call.
The consent is stored into the call variable consent as 1 for consent or 0 for rejected.
If PBX settings says consent is not required, this just continues without doing anything.
If a previous consent has already been given and it is still valid - this just sets the call variable consent to 1 and continous.
This request will return a single recording consent item.
| URL | https://api.telecomx.dk/pbx/recordingconsent/RECORDING_CONSENT_ID | |
|---|---|---|
| Method | GET | |
| Access level | VIEWER, MANAGER or OWNER if user belongs to the customer. RESELLER if customer belongs to the reseller. RESELLER_ADMIN. ADMIN. |
|
| Param | RECORDING_CONSENT_ID | Id of the recording consent (24 hex-char string) |
| Query | expandGoto | [optional] True to expand goto id's into _id/type/number/name objects |
https://api.telecomx.dk/pbx/recordingconsent/1234567890ABCDEF12345678 https://api.telecomx.dk/pbx/recordingconsent/1234567890ABCDEF12345678?expandGoto=true
| JSON object | ||
|---|---|---|
| Property | Type | Description |
| _id | Id | Unique id of the recording consent. |
| type | String | Always 'RECORDING_CONSENT'. |
| customer | Id | Id of the customer the recording consent belongs to. |
| name | String | Name/description of the recording consent. |
| number | String | The phone number to dial to reach this recording consent locally, null if it is not dial-able. |
| startAudio | Id | A PBX audio item to playback when the recording consent is entered. It is an override for the default in PBX settings, or the system default. Null if not used. |
| redirect | String | Number to redirect to when execution starts. Used to quickly circumvent the recording consent item. |
| notes | String | Notes about the recording consent item. |
| consentGivenMessage | Id | A PBX audio item to playback after the caller has given consent. Overrides PBX settings default and system default. Null if not used. |
| consentRejectedMessage | Id | A PBX audio item to playback after the caller has rejected consent. Overrides PBX settings default and system default. Null if not used. |
| goto | Id | Dialplan item to goto when done. |
| x | Number | X position in visual dialplan. |
| y | Number | Y position in visual dialplan. |
{ _id: '12345678901234567890ABCD', type: 'RECORDING_CONSENT', customer: '12345678901234567890AAAA', name: 'Spørg efter samtykke til optagelse', number: '666', startAudio: '12345678901234567890BBBB', redirect: '', notes: '', consentGivenMessage: '12345678901234567890CCCC', consentRejectedMessage: '12345678901234567890DDDD', goto: '12345678901234567890FFFF', x: 2043, y: 1920 }
| Error code | Message | Description |
|---|---|---|
| 400 | bad_request | Id not found in requestURI |
| 404 | not_found | Recording consent not found |
| 403 | access_denied | Insufficient access level |
| 500 | internal_error | <Unspecified> |