Create a channel communication

post

/crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/messages/{MessageId}/child/channelCommunication

Request

Path Parameters
  • The unique identifier of the service request message.
  • The unique number that is used to identify a service request. You can configure the service request number to a format that is best suitable to your organizational requirements. For example, service request may have the formats service request0000012345, service request_000_12345, 12345_00_service request, and so on depending on your requirements.
Header Parameters
  • 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".
  • 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.
  • Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: Display Name
    Maximum Length: 400
    The display name of the channel.
  • Title: Channel ID
    The unique identifier of the channel.
  • Title: Channel Short Name
    Maximum Length: 450
    The public unique identifier of the channel.
  • Title: Collaboration Resource Identifier
    The unique identifier of the collaboration network user that the internal users are communicating with.
  • Title: Contact Point ID
    The unique identifier of the contact point record of the contact who is being communicated with. A contact point is a contact's identifier for a specific channel of communication. For example, the contact point for the email channel would be an email address and the contact point of a person for twitter would be the twitter handle.
  • Title: Inbound Message Object Identifier
    The unique identifier of the inbound object that resulted in the creation of the service request message.
  • Title: Object ID
    The unique identifier of the object. Depending on the object type, indicates the service request id or the service request message id associated with the channel communication.
  • Title: Party ID
    The unique party identifier of the person who is being communicated with.
  • Title: Party Endpoint
    Maximum Length: 1000
    The endpoint used to communicate with the Party_ID owner. For example, email address, phone number, and so on. When Party_ID is NULL and PartyViaEndPoint is not NULL, the endpoint belongs to an adhoc party.
  • Title: Person ID
    The unique identifier of the person who is a contact on the service request.
  • Title: Post Identifier
    Maximum Length: 1000
    The unique identifier of the social media post record that was used to create the service request or the service request message.
  • Title: Routing Code
    Maximum Length: 30
    The code indicating how the message was routed through the endpoint. For example, if the endpoint is email address the field indicates if the recipient was a TO, a CC, or a BCC recipient. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_ROUTING_CD.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : serviceRequests-messages-channelCommunication-item-response
Type: object
Show Source
  • Title: Account Name
    Read Only: true
    Maximum Length: 400
    The account name associated with the channel. For example, for email, an account name would be the inbound mailbox for support like support@abc.com.
  • Title: Display Name
    Maximum Length: 400
    The display name of the channel.
  • Title: Channel ID
    The unique identifier of the channel.
  • Title: Channel Short Name
    Maximum Length: 450
    The public unique identifier of the channel.
  • Title: Channel Type
    Read Only: true
    Maximum Length: 30
    The code indicating the channel type. For example, email, phone, social, and so on. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_TYPE_CD.
  • Title: Collaboration ID
    Read Only: true
    Maximum Length: 255
    The unique identifier of the collaboration network user in the corresponding network. An example of this is the slack user Id. of a user.
  • Title: Resource Name
    Read Only: true
    Maximum Length: 400
    The user name of the external user on the collaboration network.
  • Title: Collaboration Resource Identifier
    The unique identifier of the collaboration network user that the internal users are communicating with.
  • Title: Contact Point ID
    The unique identifier of the contact point record of the contact who is being communicated with. A contact point is a contact's identifier for a specific channel of communication. For example, the contact point for the email channel would be an email address and the contact point of a person for twitter would be the twitter handle.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the communication channel.
  • Title: Creation Date
    Read Only: true
    The date and time when the communication channel was created.
  • Title: Inbound Message Object Identifier
    The unique identifier of the inbound object that resulted in the creation of the service request message.
  • Title: Last Updated Date
    Read Only: true
    The date and time when the communication channel was last updated.
  • Title: Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the communication channel.
  • Title: Update Login
    Read Only: true
    Maximum Length: 32
    The session login associated to the user who last updated the communication channel.
  • Links
  • Title: Message Number
    Read Only: true
    Maximum Length: 30
    The public unique identifier of the service request message.
  • Title: Network
    Read Only: true
    Maximum Length: 30
    The code indicating the social network of the post. For example, Facebook, Twitter. A list of accepted values is defined in the lookup HZ_INSTANT_MESSENGER_TYPE.
  • Title: Object ID
    The unique identifier of the object. Depending on the object type, indicates the service request id or the service request message id associated with the channel communication.
  • Title: Object Type
    Read Only: true
    Maximum Length: 30
    Default Value: SVC_SR_MESSAGES
    The code indicating whether the channel communication record is associated to the service request or the service request message. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_OBJECT_TYPE_CD.
  • Title: Party ID
    The unique party identifier of the person who is being communicated with.
  • Title: Party Name
    Read Only: true
    Maximum Length: 360
    The party name of the person who is being communicated with. The user can be an internal resource or a customer contact.
  • Title: Party Number
    Read Only: true
    Maximum Length: 30
    The public unique identifier of the contact associated with the service request message.
  • Title: Party Endpoint
    Maximum Length: 1000
    The endpoint used to communicate with the Party_ID owner. For example, email address, phone number, and so on. When Party_ID is NULL and PartyViaEndPoint is not NULL, the endpoint belongs to an adhoc party.
  • Title: Person ID
    The unique identifier of the person who is a contact on the service request.
  • Title: Post Identifier
    Maximum Length: 1000
    The unique identifier of the social media post record that was used to create the service request or the service request message.
  • Title: Resource ID
    Read Only: true
    The unique identifier of the resource associated with the service request. This is a foreign key that can identify the collaboration network user the internal users are communicating with.
  • Title: Resource Type
    Read Only: true
    Maximum Length: 30
    The code indicating the type of the collaborative network user, such as USER, PUBLIC_CHANNEL, or PRIVATE_CHANNEL. A list of accepted values is defined in the lookup ORA_SVC_COLLAB_RES_TYPE_CD.
  • Title: Routing Code
    Maximum Length: 30
    The code indicating how the message was routed through the endpoint. For example, if the endpoint is email address the field indicates if the recipient was a TO, a CC, or a BCC recipient. A list of accepted values is defined in the lookup ORA_SVC_CHANNEL_ROUTING_CD.
  • Title: ID
    Read Only: true
    The unique identifier of the channel communication.
Back to Top

Examples

The following example shows how to create a channel communication by submitting a POST request on the REST resource.

Example of Request Header

The following shows an example of the request header.

POST /crmRestApi/resources/11.13.18.05/serviceRequests/SR0000002212/child/messages/300100092588985/child/channelCommunication HTTP/1.1
HOST: servername.fa.us2.oraclecloud.com
authorization: Basic U0FMRVNfQURNSU46V2VsY29tZTE=
content-type: application/vnd.oracle.adf.resourceitem+json

Example of Request Body

The following example shows the contents of the request body in JSON format.

{
"ChannelId":"1"
}

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 201: Created
Date: Wed, 16 Nov 2016 14:05:27 GMT
Server: Oracle-HTTP-Server-11g
Content-Type: application/vnd.oracle.adf.resourceitem+json
Content-Language: en

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
"ViaId": 300100093739406,
"ObjectTypeCd": "SVC_SR_MESSAGES",
"ObjectId": 300100092588985,
"ChannelId": 1,
"ChannelTypeCd": "ORA_SVC_WEB",
"ChannelAccountName": "Web",
"ChannelDisplayName": "Web-Updated",
"PartyViaEndPoint": null,
"PostIdentifier": null,
"RoutingCd": null,
"PartyId": null,
"PartyName": null,
"ContactPointId": null,
"CreatedBy": "SALES_ADMIN",
"CreationDate": "2016-11-16T06:05:27-08:00",
"LastUpdatedBy": "SALES_ADMIN",
"LastUpdateDate": "2016-11-16T06:05:27-08:00",
"LastUpdateLogin": "416A6650DC4C12CCE05307B3F20A5EFF",
"links": [
  
{
"rel": "self",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000002212/child/messages/300100092588985/child/channelCommunication/300100093739406",
"name": "channelCommunication",
"kind": "item",
"properties": 
{
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
}
}
,
  
{
"rel": "canonical",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000002212/child/messages/300100092588985/child/channelCommunication/300100093739406",
"name": "channelCommunication",
"kind": "item"
}
,
  
{
"rel": "parent",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000002212/child/messages/300100092588985",
"name": "messages",
"kind": "item"
}
,
  
{
"rel": "lov",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000002212/child/messages/300100092588985/child/channelCommunication/300100093739406/lov/RoutingCdLookup",
"name": "RoutingCdLookup",
"kind": "collection"
}
,
  
{
"rel": "lov",
"href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000002212/child/messages/300100092588985/child/channelCommunication/300100093739406/lov/ChannelLOV",
"name": "ChannelLOV",
"kind": "collection"
}
],
}
Back to Top