Get all inbound messages
get
/crmRestApi/resources/11.13.18.05/inboundMessages
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds an inbound message with the specified primary key.
Finder Variables:- InboundMessageId; integer; The unique identifier of the inbound message.
- PrimaryKey: Finds an inbound message with the specified primary key.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AcknowledgedDate; string; The date when the inbound message was acknowledged.
- BUOrgId; integer; The unique ID of the business unit name associated to inbound email.
- BatchId; integer; The unique identifier of the batch in which the inbound message will be processed.
- ChannelId; integer; The unique identifier of the channel for the inbound message.
- ChannelTypeCdMeaning; string; The display value corresponding to the channel type lookup code for the inbound email.
- ConnectionTypeCd; string; Indicates the connection type that was used to read the inbound message.
- ConnectionTypeCdMeaning; string; Indicates the display value corresponding to the connection type lookup code for the inbound message.
- ContentTypeCd; string; The content type of the inbound message.
- ContentTypeCdMeaning; string; The display value corresponding to the content type lookup code for the inbound email.
- CreatedBy; string; The user who created the inbound message.
- CreationDate; string; The date when the inbound message was created.
- FusionRecipient; string; The account to which the service requests are forwarded.
- InboundMessageId; integer; The unique identifier of an inbound message.
- LastUpdateDate; string; The date when the inbound message was last updated.
- LastUpdatedBy; string; The user who last updated the inbound message.
- ObjectId; integer; The unique identifier of the business object associated with the inbound message.
- ObjectTypeCd; string; The type of business object associated with the inbound message, for example SVC_SERVICE_REQUESTS.
- ObjectTypeCdMeaning; string; The display value corresponding to the object type lookup code for the inbound email.
- ReceivedChannelCd; string; The channel type of the inbound message. For example E-Mail or SMS.
- ReceivedDateTime; string; Indicates the date and time when the mailbox received the email.
- RetryCount; integer; The number of times the system attempted to process the inbound messages.
- Sender; string; The sender of an inbound message.
- SenderPartyId; integer; The party identifier of the person who sent the message.
- SourceMessageId; string; The message ID in the source system.
- StatusCd; string; The current status of the inbound message. For example Received, Processed, or Deleted.
- StatusDetails; string; The details of the inbound email processing status.
- StatusTypeCdMeaning; string; The display value corresponding to the status type lookup code for the inbound email.
- StripeCd; string; The application context of inbound messages.
- StripeCdMeaning; string; The display value corresponding to the stripe type lookup code for the inbound email.
- StripeCode; string; The application stripe of the inbound message.
- Subject; string; The subject of the inbound message.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : inboundMessages
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : inboundMessages-item-response
Type:
Show Source
object
-
AcknowledgedDate: string
(date-time)
Title:
Acknowledged Date
The date when the inbound message was acknowledged. -
Attachments: array
Attachments
Title:
Attachments
The attachments resource is used to create, view, update, and delete the list of files sent as attachments with the inbound messages. For example, a document with a screenshot of an error message. -
BatchId: integer
(int64)
Title:
Batch ID
The unique identifier of the batch in which the inbound message will be processed. -
Body: string
(byte)
Title:
Body
The content of the inbound message. -
BUOrgId: integer
(int64)
Title:
Business Unit ID
Read Only:true
The unique ID of the business unit name associated to inbound email. -
ChannelId: integer
(int64)
Title:
Channel ID
The unique identifier of the channel for the inbound message. -
ChannelTypeCdMeaning: string
Title:
Channel Type Value
Maximum Length:255
The display value corresponding to the channel type lookup code for the inbound email. -
ConnectionTypeCd: string
Title:
Connection Type Code
Maximum Length:30
Default Value:ORA_SVC_UMS
Indicates the connection type that was used to read the inbound message. -
ConnectionTypeCdMeaning: string
Title:
Connection Type Value
Maximum Length:255
Indicates the display value corresponding to the connection type lookup code for the inbound message. -
ContentTypeCd: string
Title:
Content Type
Maximum Length:30
The content type of the inbound message. -
ContentTypeCdMeaning: string
Title:
Content Type Value
Maximum Length:255
The display value corresponding to the content type lookup code for the inbound email. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the inbound message. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the inbound message was created. -
DeleteFlag: boolean
Title:
Can Delete
Read Only:true
Indicates whether the inbound message can be deleted. -
FusionRecipient: string
Title:
Inbound Message Account
Maximum Length:320
The account to which the service requests are forwarded. -
InboundMessageId: integer
(int64)
Title:
Inbound Message ID
The unique identifier of an inbound message. -
InboundMsgParts: array
Inbound Message Parts
Title:
Inbound Message Parts
The inbound message parts resource is used to create, view, update, and delete the list of components of an inbound message, such as From, To, CC, and Importance. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the inbound message was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the inbound message. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectId: integer
(int64)
Title:
Object ID
The unique identifier of the business object associated with the inbound message. -
ObjectTypeCd: string
Title:
Object Type
Maximum Length:30
The type of business object associated with the inbound message, for example SVC_SERVICE_REQUESTS. -
ObjectTypeCdMeaning: string
Title:
Object Type Value
Maximum Length:255
The display value corresponding to the object type lookup code for the inbound email. -
PlainTextBody: string
(byte)
Title:
Plain Text Body
The plain text content of the inbound message. -
ReceivedChannelCd: string
Title:
Received Channel Code
Maximum Length:30
The channel type of the inbound message. For example E-Mail or SMS. -
ReceivedDateTime: string
(date-time)
Title:
Received Date Time
Indicates the date and time when the mailbox received the email. -
RetryCount: integer
(int64)
Title:
Retry Count
The number of times the system attempted to process the inbound messages. -
Sender: string
Title:
Sender
Maximum Length:320
The sender of an inbound message. -
SenderPartyId: integer
(int64)
Title:
Sender Party ID
The party identifier of the person who sent the message. -
SourceMessageId: string
Title:
Source Message ID
Maximum Length:2000
The message ID in the source system. -
StatusCd: string
Title:
Status Code
Maximum Length:30
The current status of the inbound message. For example Received, Processed, or Deleted. -
StatusDetails: string
Title:
Status Details
Maximum Length:1000
The details of the inbound email processing status. -
StatusTypeCdMeaning: string
Title:
Status Type Value
Maximum Length:255
The display value corresponding to the status type lookup code for the inbound email. -
StripeCd: string
Title:
Stripe Code
Maximum Length:30
The application context of inbound messages. -
StripeCdMeaning: string
Title:
Stripe Value
Maximum Length:255
The display value corresponding to the stripe type lookup code for the inbound email. -
StripeCode: string
Title:
Stripe Code
The application stripe of the inbound message. -
Subject: string
Title:
Subject
Maximum Length:400
The subject of the inbound message. -
UpdateFlag: boolean
Title:
Can Update
Read Only:true
Indicates whether the inbound message can be updated.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to create, view, update, and delete the list of files sent as attachments with the inbound messages. For example, a document with a screenshot of an error message.
Show Source
Nested Schema : Inbound Message Parts
Type:
array
Title:
Inbound Message Parts
The inbound message parts resource is used to create, view, update, and delete the list of components of an inbound message, such as From, To, CC, and Importance.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : inboundMessages-Attachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
The attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The name of the user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the attachment was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Indicates the data type of the attachment. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URL of the attached file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the attachment was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
The text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of the attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The login of the user associated with the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : inboundMessages-InboundMsgParts-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the inbound message part. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the inbound message part was created. -
DeleteFlag: boolean
Title:
Can Delete
Read Only:true
Indicates if the inbound message part can be deleted. -
InboundMessageId: integer
(int64)
Title:
Inbound Message ID
The unique identifier of the inbound message with which the message part is associated. -
InboundMsgPartId: integer
(int64)
Title:
Inbound Message Part ID
The unique identifier of the message part. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the inbound message part was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the inbound message part. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartName: string
Title:
Part Name
Maximum Length:64
The header name of the inbound message part. -
PartTypeCd: string
Title:
Part Type Code
Maximum Length:30
The type of the inbound message part. -
PartTypeCdMeaning: string
Title:
Part Type Value
Maximum Length:255
The display value corresponding to the part type lookup code for the inbound message. -
PartValue: string
Title:
Part Value
Maximum Length:2000
The value of the inbound message part. -
UpdateFlag: boolean
Title:
Can Update
Read Only:true
Indicates if the inbound message part can be updated.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- processInboundMessageList
-
Process inbound messages sent by customers.
Examples
Use GET with the following URI syntax to get all inbound messages:
Example of Request URI
The following shows an example of the request URL.
https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMessages/
Example of Request Header
The following shows an example of the request header.
GET /crmRestApi/resources/11.13.18.05/inboundMessages/ HTTP/1.1 HOST: servername.fa.us2.oraclecloud.com authorization: Basic U0FMRVNfQURNSU46V2VsY29tZTE= content-type: application/vnd.oracle.adf.resourceitem+json
Example of Response Header
The following shows an example of the response header.
HTTP/1.1 200: OK Date: Mon, 18 Jan 2017 09:10:04 GMT Server: Oracle-HTTP-Server-11g Content-Type: application/vnd.oracle.adf.resourceitem+json Content-Language: en
Example of Response Body
The following shows an example of the response body in JSON format.
Content type: { "items": [ { "InboundMessageId": 300100095258851, "Sender": "edwin.mitchell@us2.oraclecloud.com", "FusionRecipient": "incoming@service.us2.oraclecloud.com", "Subject": "SendEmailAUTOScriptOn_13012017_162851.476", "ContentTypeCd": "ORA_SVC_TEXT_HTML", "StatusCd": "ORA_SVC_RECEIVED", "ReceivedChannelCd": "ORA_SVC_EMAIL", "AcknowledgedDate": null, "CreationDate": "2017-01-13T16:29:03-08:00", "CreatedBy": "FUSION_APPS_CRM_ESS_APPID", "LastUpdateDate": "2017-01-13T16:29:03-08:00", "LastUpdatedBy": "FUSION_APPS_CRM_ESS_APPID", "ChannelId": 300100089980767, "ObjectId": null, "ObjectTypeCd": null, "BatchId": 300100095258850, "RetryCount": 0, "StripeCode": "ORA_SVC_CRM", "links": [ { "rel": "self", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMessages/300100095258851", "name": "inboundMessages", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178" } }, { "rel": "canonical", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMessages/300100095258851", "name": "inboundMessages", "kind": "item" }, { "rel": "child", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMessages/300100095258851/child/InboundMsgParts", "name": "InboundMsgParts", "kind": "collection" }, { "rel": "child", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMessages/300100095258851/child/Attachments", "name": "Attachments", "kind": "collection" }, { "rel": "enclosure", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMessages/300100095258851/enclosure/Body", "name": "Body", "kind": "other" }, { "rel": "enclosure", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMessages/300100095258851/enclosure/PlainTextBody", "name": "PlainTextBody", "kind": "other" } ] }, { "InboundMessageId": 300100095315827, "Sender": "service_test5@servername.fa.us2.oraclecloud.com", "FusionRecipient": "edwin.mitchell@us2.oraclecloud.com", "Subject": "SendEmailAUTOScriptOn_17012017_161417.423", "ContentTypeCd": "ORA_SVC_TEXT_HTML", "StatusCd": "ORA_SVC_PROCESSED", "ReceivedChannelCd": "ORA_SVC_EMAIL", "AcknowledgedDate": "2017-01-17T16:15:00-08:00", "CreationDate": "2017-01-17T16:14:57-08:00", "CreatedBy": "FUSION_APPS_CRM_ESS_APPID", "LastUpdateDate": "2017-01-17T16:15:00-08:00", "LastUpdatedBy": "FUSION_APPS_CRM_ESS_APPID", "ChannelId": 300100089980767, "ObjectId": 300100095315837, "ObjectTypeCd": "SVC_SERVICE_REQUESTS", "BatchId": 300100095315826, "RetryCount": 0, "StripeCode": "ORA_SVC_CRM", "links": [ { "rel": "self", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMessages/300100095315827", "name": "inboundMessages", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000278" } }, { "rel": "canonical", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMessages/300100095315827", "name": "inboundMessages", "kind": "item" }, { "rel": "child", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMessages/300100095315827/child/InboundMsgParts", "name": "InboundMsgParts", "kind": "collection" }, { "rel": "child", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMessages/300100095315827/child/Attachments", "name": "Attachments", "kind": "collection" }, { "rel": "enclosure", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMessages/300100095315827/enclosure/Body", "name": "Body", "kind": "other" }, { "rel": "enclosure", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMessages/300100095315827/enclosure/PlainTextBody", "name": "PlainTextBody", "kind": "other" } ] }, . . . } ], "count": 25, "hasMore": true, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/inboundMessages", "name": "inboundMessages", "kind": "collection" } ] }