Retrieve a list of SMS
get
/api/rest/2.0/assets/sms
Retrieves all SMS that match the criteria specified by the request parameters.
Request
Supported Media Types
- application/json
Query Parameters
-
count: integer
Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
-
depth: string
Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth:
minimal
,partial
, andcomplete
. Any other values passed are reset tominimal
by default. -
lastUpdatedAt: integer
The date and time an sms was last updated.
-
orderBy: string
Specifies the field by which list results are ordered.
-
page: integer
Specifies which page of entities to return (the count parameter defines the number of entities per page). If the page parameter is not supplied, 1 will be used by default.
-
search: string
Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : QueryResultSms
Type:
object
Title:
Show Source
QueryResultSms
-
elements:
array elements
Array of sms fields.
-
page:
integer
The specified page.
-
pageSize:
integer
The page size.
-
total:
integer
The total amount of results.
-
type:
string
The asset's type in Eloqua.
Nested Schema : elements
Type:
array
Array of sms fields.
Show Source
-
Array of:
object Sms
Title:
Sms
Nested Schema : Sms
Type:
object
Title:
Show Source
Sms
-
archived:
string
Whether or not the sms is archived
-
content:
string
Sms Content
-
createdAt:
string
Read Only:
true
The date and time the sms was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login id of the user who created the sms -
currentStatus:
string
The sms's current status. This is a read-only property
-
depth:
string
Read Only:
true
Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth:minimal
,partial
, andcomplete
. For more information, see Request depth. -
description:
string
Description of the sms
-
fieldMerges:
array fieldMerges
Field Merges associated with the sms
-
folderId:
string
Read Only:
true
The folder id of the folder which contains the sms -
hyperLinks:
array hyperLinks
Hyperlinks associated with the sms
-
id:
string
Read Only:
true
Id of the sms. This is a read-only property. -
initiationType:
string
Type of initiation
-
keywordResponses:
array keywordResponses
Keyword responses associated with the sms
-
name:
string
Name of the sms
-
permissions:
array permissions
The permissions for the sms granted to your current instance. This is a read-only property.
-
scheduledFor:
string
Read Only:
true
This property is not used -
senderCodes:
array senderCodes
Sender codes associated with the sms
-
smsType:
string
Purpose of sms.
-
sourceTemplateId:
string
Id of the template used to create the asset.
-
templateId:
string
Id of the template associated with the sms
-
type:
string
The asset's type in Eloqua. This is a read-only property.
-
updatedAt:
string
Read Only:
true
Unix timestamp for the date and time the sms was last updated. This is a read-only property. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the sms.
Nested Schema : fieldMerges
Type:
array
Field Merges associated with the sms
Show Source
-
Array of:
object FieldMerge
Title:
FieldMerge
Nested Schema : hyperLinks
Type:
array
Hyperlinks associated with the sms
Show Source
-
Array of:
object SmsLink
Title:
SmsLink
Nested Schema : keywordResponses
Type:
array
Keyword responses associated with the sms
Show Source
-
Array of:
object KeywordResponse
Title:
KeywordResponse
Nested Schema : permissions
Type:
array
The permissions for the sms granted to your current instance. This is a read-only property.
Show Source
Nested Schema : senderCodes
Type:
array
Sender codes associated with the sms
Show Source
-
Array of:
object SmsSenderCode
Title:
SmsSenderCode
Nested Schema : FieldMerge
Type:
object
Title:
Show Source
FieldMerge
-
accountFieldId:
string
Id of the associated account field.
-
allowUrlsInValue:
string
Whether or not URLs are allowed in this field merge. False by default. Using URLs in a field merge can be a security risk. By default, when Oracle Eloqua attempts to insert the field merge, it removes any URLs while still inserting the remaining data. However, you can override this security feature by selecting the Allow URLs in field merge check box in the Eloqua user interface.
-
contactFieldId:
string
Id of the associated contact field.
-
createdAt:
string
Read Only:
true
The date and time the field merge was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login id of the user who created the field merge. -
currentStatus:
string
The field merge's current status.
-
customObjectFieldId:
string
Id of the associated custom object field.
-
customObjectId:
string
Id of the associated custom object.
-
customObjectSort:
string
The associated custom object sort type.
-
defaultValue:
string
The default value of the field merge.
-
depth:
string
Read Only:
true
Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth:minimal
,partial
, andcomplete
. Any other values passed are reset tocomplete
by default. For more information, see Request depth. -
description:
string
The description of the field merge.
-
eventFieldId:
string
Id of the associated event field.
-
eventId:
string
Id of the associated event.
-
eventSessionFieldId:
string
Id of the associated event session field.
-
fieldConditions:
array fieldConditions
Array of field condition fields.
-
folderId:
string
Read Only:
true
Id of the associated folder. -
id:
string
Read Only:
true
Id of the field merge. This is a read-only property. -
mergeType:
string
Type of the field merge. Possible values include:
contactField
,accountField
,eventField
,eventSessionField
, andcustomObjectField
. -
name:
string
Name of the field merge.
-
permissions:
array permissions
The permissions for the field merge granted to your current instance.
-
queryStringKey:
string
The key value if the field merge contains a query string. See the Help Center to learn more about field merges with query strings. This is a read-only property.
-
scheduledFor:
string
Read Only:
true
This property is not used for field merges. -
sourceTemplateId:
string
The id of the source template.
-
syntax:
string
The syntax of the field merge.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
-
updatedAt:
string
Read Only:
true
Unix timestamp for the date and time the field merge was last updated. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the field merge.
Nested Schema : fieldConditions
Type:
array
Array of field condition fields.
Show Source
-
Array of:
object FieldCondition
Title:
FieldCondition
Nested Schema : permissions
Type:
array
The permissions for the field merge granted to your current instance.
Show Source
Nested Schema : FieldCondition
Type:
object
Title:
Show Source
FieldCondition
-
condition:
object Condition
Title:
Condition
-
createdAt:
string
Read Only:
true
-
createdBy:
string
Read Only:
true
-
currentStatus:
string
-
depth:
string
Read Only:
true
-
description:
string
-
fieldId:
string
-
folderId:
string
Read Only:
true
-
id:
string
Read Only:
true
-
name:
string
-
permissions:
array permissions
-
scheduledFor:
string
Read Only:
true
-
sourceTemplateId:
string
-
type:
string
-
updatedAt:
string
Read Only:
true
-
updatedBy:
string
Read Only:
true
Nested Schema : Condition
Type:
object
Title:
Show Source
Condition
-
type:
string
The asset's type in Eloqua. This is a read-only property.
Nested Schema : SmsLink
Type:
object
Title:
Show Source
SmsLink
-
createdAt:
string
Read Only:
true
The date and time the sms link was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login id of the user who created the sms link. -
currentStatus:
string
The sms link current status. This is a read-only property.
-
depth:
string
Read Only:
true
Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth:minimal
,partial
, andcomplete
. For more information, see Request depth. -
description:
string
Description of the sms link.
-
folderId:
string
Read Only:
true
The folder id of the folder which contains the sms link. -
href:
string
Url represented by sms link.
-
hyperlinkType:
string
Type of hyperlink represented by sms link.
-
id:
string
Read Only:
true
Id of the sms link. This is a read-only property. -
name:
string
Name of the sms link.
-
permissions:
array permissions
The permissions for the sms link granted to your current instance. This is a read-only property.
-
scheduledFor:
string
Read Only:
true
This property is not used -
sourceTemplateId:
string
Id of the template used to create the asset.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
-
updatedAt:
string
Read Only:
true
Unix timestamp for the date and time the sms link was last updated. This is a read-only property. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the sms link.
Nested Schema : permissions
Type:
array
The permissions for the sms link granted to your current instance. This is a read-only property.
Show Source
Nested Schema : KeywordResponse
Type:
object
Title:
Show Source
KeywordResponse
-
createdAt:
string
Read Only:
true
The date and time the keyword response was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login id of the user who created the keyword response. -
currentStatus:
string
The keyword response current status. This is a read-only property
-
depth:
string
Read Only:
true
Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth:minimal
,partial
, andcomplete
. For more information, see Request depth. -
description:
string
Description of the keyword response.
-
folderId:
string
Read Only:
true
The folder id of the folder which contains the keyword response. -
id:
string
Read Only:
true
Id of the keyword response. This is a read-only property. -
keyword:
string
Keyword associated with keyword response.
-
keywordType:
string
The type of the keyword.
-
permissions:
array permissions
The permissions for the keyword response granted to your current instance. This is a read-only property.
-
response:
string
Response associated with the keyword.
-
scheduledFor:
string
Read Only:
true
This property is not used -
sourceTemplateId:
string
Id of the template used to create the asset.
-
templateId:
string
Id of the template associated with the keyword response.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
-
updatedAt:
string
Read Only:
true
Unix timestamp for the date and time the keyword response was last updated. This is a read-only property. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the keyword response.
Nested Schema : permissions
Type:
array
The permissions for the keyword response granted to your current instance. This is a read-only property.
Show Source
Nested Schema : SmsSenderCode
Type:
object
Title:
Show Source
SmsSenderCode
-
countryCode:
string
Associated country code.
-
createdAt:
string
Read Only:
true
The date and time the sms sender code was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login id of the user who created the sms sender code. -
currentStatus:
string
The sms sender code current status. This is a read-only property.
-
depth:
string
Read Only:
true
Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth:minimal
,partial
, andcomplete
. For more information, see Request depth. -
description:
string
Description of the sms sender code.
-
folderId:
string
Read Only:
true
The folder id of the folder which contains the sms sender code. -
id:
string
Read Only:
true
Id of the sms sender code. This is a read-only property. -
name:
string
Name of the sms sender code.
-
permissions:
array permissions
The permissions for the sms sender code granted to your current instance. This is a read-only property.
-
scheduledFor:
string
Read Only:
true
This property is not used -
senderCode:
string
Associated sender code.
-
senderCodeId:
string
Id of the associated sender code.
-
sourceTemplateId:
string
Id of the template used to create the asset.
-
type:
string
The asset's type in Eloqua. This is a read-only property.
-
updatedAt:
string
Read Only:
true
Unix timestamp for the date and time the sms sender code was last updated. This is a read-only property. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the sms sender code.
Nested Schema : permissions
Type:
array
The permissions for the sms sender code granted to your current instance. This is a read-only property.
Show Source
400 Response
Bad request. See Status Codes for information about other possible HTTP status codes.
401 Response
Unauthorized. See Status Codes for information about other possible HTTP status codes.
403 Response
Forbidden. See Status Codes for information about other possible HTTP status codes.
404 Response
The requested resource was not found. See Status Codes for information about other possible HTTP status codes.
500 Response
The service has encountered an error. See Status Codes for information about other possible HTTP status codes.