SMS

Release the inbox phone number

Requires inbox_update. Releases the number at the provider and marks it released. With COOPER_SMS_BILLING=stripe, the subscription quantity is lowered and Stripe prorates the charge. A failure to update Stripe is retried by the next provision or release, which recompute the quantity from the database. The same account waits 30 days before provisioning that E.164 again. HTTP 404 phone_number_not_found when there is no active number. HTTP 404 not_found when SMS is off.

delete/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

Response

Released number. inbox_id is null.

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.