outbox
Returns outbox message
get/v1/outbox/messages/{id}
Path parameters
idinteger required
Response
OK
contentstring
message content
subjectstring
subject
senderstring
sender identification
recipientsstring[]
recipient list
contactGroupIdsinteger[]
contact group id list
selectorsstring[]
selectors
sendOnstring date-time
send on (now if not specified)
timeSpreadinteger
time spread in hours
repeatstring
repeat period (hourly, daily, weekly, monthly, yearly)
repeatIntervalinteger
repeat interval
repeatIterationsinteger
repeat iterations
repeatEndDatestring date-time
repeat end datetime
deliveryReportboolean
request delivery report?
smsTypeinteger
SMS type (0 = default, 1 = flash, 2 = both)
predictedSmsCountinteger
predicted SMS count
contentCategorystring
content category (personal, advertisement or informational
messageTypestring
message type (default, sms, voice, rcs, whatsapp
attachmentIdinteger
attachment id
urlshorteningTypestring
urlshortening type
baseTemplateIdinteger
base templateId
customerChannelIdinteger
customerChannelId
idinteger required
message id
statusstring required
status
numberOfRecipientsinteger
number of recipients
numberOfContactGroupsinteger
number of contact groups
numberOfTotalRecipientsinteger
number of total recipients (msisdns + contact group members)
lastModifiedstring date-time
last modified
lastModifiedBystring
last modified by
attachmentMimeTypestring
attachment mime type
origin'api_http' | 'api_http_simple' | 'api_rest' | 'api_rest_simple' | 'api_rest_converged' | 'api_rest_customer_channel' | 'api_smpp' | 'api_smtp' | 'api_ftp' | 'sdk_java' | 'sdk_cpp' | 'sdk_csharp' | 'sdk_perl' | 'sdk_ruby' | 'sdk_python' | 'sdk_node' | 'sdk_php' | 'api_smtp_email2sms' | 'api_smtp_email2voice' | 'api_smtp_email2sms_ucs' | 'api_smtp_email2whatsapp' | 'oms' | 'oms_reply' | 'remotesms' | 'remotesms_msisdn_change' | 'remotesms_error' | 'group_subscription' | 'trigger_rule' | 'registration' | 'birthday_sms' | 'mycokemusic' | 'optin' | 'applet_optin' | 'applet_optout' | 'applet_quick_optin' | 'internex' | 'onlinesms_v2' | 'onlinesms_v3' | 'api_v1' | 'plugin_excel_365' | 'plugin_excel_2010' | 'plugin_google_sheets' | 'plugin_google_chrome' | 'unknown'
automatedboolean
is generated by an automation like Opt-Ins, PIN verification, etc.