readyDocs Open the appOpen the app

Call settings

Call recording is the same setting as Settings › Compliance › Call recordings in the app. Who rings for incoming calls has no screen in the app: set it here. Reading them needs the send_sms permission. Only the account owner or an admin can change call recording, and changing who rings needs manage_phones. Every route below answers 403 permission_denied when the key’s user lacks the permission it needs, and 500 internal_error when we couldn’t read or save the setting: nothing changed, so retry in a minute.

#Get call recording settings

Whether your account records calls, and whether the recording notice plays. These rules apply to every recorded call: Ready Dialer, click-to-call and calls to your numbers. Needs the send_sms permission.

Returns
data.record_callsboolean
Record calls. false means no call on the account is recorded.
data.record_every_callboolean
Every call is recorded: the Ready Dialer’s Record switch is locked on for your team.
data.dual_speakerboolean
Dual-speaker recording: each side of a recorded call is kept and transcribed on its own, and the transcript names who said each line. false (the default) keeps one mixed recording.
data.noticeboolean
Both people hear the recording notice before a call is recorded.
data.signedobject | null
When the notice is off: name and at, who signed the notice waiver and when.
data.attestationobject
The waiver statement to show before turning the notice off: version, text and min_name_chars, the shortest name we accept.
data.can_editboolean
Whether this key may change them.

#Change call recording settings

Send only what you want to change. Turning record_calls off also turns off record_every_call. To turn the notice off you sign the waiver: send attest: true and your full name. We keep a record of each change to the notice. Only the account owner or an admin can change these. Returns the settings as saved, without can_edit.

Parameters

record_callsboolean
Record calls on this account.
record_every_callboolean
Lock every team member’s Record switch on.
dual_speakerboolean
Keep each side of a recorded call on its own, with a transcript that names who said each line.
noticeboolean
Play the recording notice. false needs attest and name.
attestboolean
true: you agree to the statement in attestation.text.
namestring
The full name of the person signing. Up to 120 characters.
Errors
HTTPCodeWhen
400attestation_requirednotice: false without attest: true and a name.
400nothing_to_changeThe body has none of the settings above.
403OWNER_ONLYThe key is not for the account owner or an admin.

#Get who rings for incoming calls

Who the Ready Dialer rings when a lead calls one of your numbers. Needs the send_sms permission.

Returns
data.modeenum
everyone: every team member who is online. last_caller: the team member who last called that lead rings first.

#Change who rings for incoming calls

Needs the manage_phones permission. The first time an account saves this, missed-call text-back starts on only if one of your missed-call automations already sends a text.

Parameters

modeenumRequired
everyone or last_caller.
Errors
HTTPCodeWhen
400invalid_fieldmode is missing or not one of the two above.

#Get my Record switch

Where the Ready Dialer’s Record switch starts for the key’s own user. The account’s recording settings still win: with Record calls off nothing is recorded, and with every call recorded the switch is locked on. Needs the send_sms permission.

Returns
data.record_callsboolean | null
null until it’s first saved.

#Set my Record switch

Saves where the key’s own user’s Record switch starts in the Ready Dialer. Needs the send_sms permission.

Parameters

record_callsbooleanRequired
Start with Record on or off.