Messages

Release a message that inbound screening held. Removes the held label, fires message.received, and creates a task when the sender is eligible. A message that is not held returns 409 message_not_held and fires nothing. Another account's message is 404.

post/api/v1/inboxes/{id}/messages/{msgId}/release

Request

  • Base URL: https://cooperemail.com
  • URL: https://cooperemail.com/api/v1/inboxes/{id}/messages/{msgId}/release
  • Auth: HTTP bearer

Path parameters

idstring required
msgIdstring required

Response

Released message

idstring
inbox_idstring
thread_idstring
direction'inbound' | 'outbound'
fromstring
tostring[]
subjectstring
textstring
htmlstring nullable
extracted_textstring
extracted_htmlstring
previewstring
status'queued' | 'ringing' | 'completed' | 'no-answer' | 'sent' | 'received' | 'delivered' | 'undelivered' | 'failed' | 'bounced' | 'complained'

SMS outbound starts as sent. A Twilio status callback sets delivered, undelivered, or failed. A voice call stores queued, ringing, completed, no-answer, or failed. Email uses queued, sent, received, failed, bounced, and complained.

channel'sms' | 'voicemail' | 'voice'

Present on SMS, voicemail, and voice messages. Email messages omit this field. voicemail is an inbound recording. voice is an outbound call.

type'voicemail'

Present on voicemail messages.

duration_secondsinteger nullable

Call or recording length in seconds. Present on voicemail and voice messages.

recording_urlstring nullable

Twilio recording URL for a voicemail, or null.

transcriptstring

Voicemail transcript. Empty while the message is held.

segmentsinteger nullable

SMS segment count for this message. Omitted on email.

otp_candidatesstring[]

Codes found in an SMS body. Empty while the message is held. Omitted on email.

ccstring[]
bccstring[]
reply_tostring nullable
in_reply_tostring nullable
referencesstring[]
labelsstring[]
providerstring nullable
client_idstring nullable
idempotentboolean
created_atstring date-time

Changes

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