SMS

Read the active phone number on an inbox

Requires inbox_read. HTTP 404 not_found when COOPER_SMS is off, and in operators mode unless this account is an operator. HTTP 404 phone_number_not_found when the inbox has no active number. Another inbox on an inbox-scoped key is HTTP 404 inbox_not_found.

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

Active phone number. billing is omitted.

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.