Voice

Set the greeting and recording length for this number

Requires inbox_update. HTTP 404 not_found when voice is off. HTTP 404 phone_number_not_found when the inbox has no active number. voice_greeting is at most 300 characters. Null or empty uses the default greeting. voice_max_seconds is an integer from 15 to 300. Null uses 120 seconds. Once the monthly minute allowance is used, inbound recordings are capped at 60 seconds.

patch/api/v1/inboxes/{id}/phone-number

Request

  • Base URL: https://cooperemail.com
  • URL: https://cooperemail.com/api/v1/inboxes/{id}/phone-number
  • Auth: HTTP bearer

Path parameters

idstring required

Request body

voice_greetingstring nullable
voice_max_secondsinteger nullable

Response

Updated phone number.

object'phone_number' required
idstring required
account_idstring required
inbox_idstring nullable
e164string required
providerstring required
provider_sidstring required
number_typestring required
capabilitiesstring[] required
status'pending' | 'active' | 'released' required
outboundstring required

disabled until a 10DLC brand is attached. enabled is required before POST /sms succeeds.

brand_idstring nullable
created_atstring date-time required
released_atstring date-time nullable
voice_greetingstring nullable

Spoken before a voicemail recording. Null uses the default greeting. Present when voice is on.

voice_max_secondsinteger nullable

Recording cap from 15 to 300. Null uses 120 seconds, or 60 once the minute allowance is used. Present when voice is on.

Changes

No recorded changes to this operation across all 1 revision of this API.