Jump to

• Request
• Response

Get a channel communication

get

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

Request

Path Parameters

• MessageId(required): integer(int64)
  The unique identifier of the service request message.
• SrNumber(required): string
  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.
• ViaId(required): integer(int64)
  The unique identifier of the service request channel communication record.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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 Top

Response

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.

Body ()

Root Schema : serviceRequests-messages-channelCommunication-item-response

Type: object

Show Source

• ChannelAccountName: string
  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 [e-mail].
• ChannelDisplayName: string
  Title: Display Name

  Maximum Length: 400

  The display name of the channel.
• ChannelId: integer (int64)
  Title: Channel ID

  The unique identifier of the channel.
• ChannelShortName: string
  Title: Channel Short Name

  Maximum Length: 450

  The public unique identifier of the channel.
• ChannelTypeCd: string
  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.
• CollabId: string
  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.
• CollabName: string
  Title: Resource Name

  Read Only: true

  Maximum Length: 400

  The user name of the external user on the collaboration network.
• CollabResourceId: integer (int64)
  Title: Collaboration Resource Identifier

  The unique identifier of the collaboration network user that the internal users are communicating with.
• ContactPointId: integer (int64)
  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.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the communication channel.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the communication channel was created.
• InboundObjectId: integer (int64)
  Title: Inbound Message Object Identifier

  The unique identifier of the inbound object that resulted in the creation of the service request message.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the communication channel was last updated.
• LastUpdatedBy: string
  Title: Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the communication channel.
• LastUpdateLogin: string
  Title: Update Login

  Read Only: true

  Maximum Length: 32

  The session login associated to the user who last updated the communication channel.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MessageNumber: string
  Title: Message Number

  Read Only: true

  Maximum Length: 30

  The public unique identifier of the service request message.
• NetworkTypeCd: string
  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.
• ObjectId: integer (int64)
  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.
• ObjectTypeCd: string
  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.
• PartyId: integer (int64)
  Title: Party ID

  The unique party identifier of the person who is being communicated with.
• PartyName: string
  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.
• PartyNumber: string
  Title: Party Number

  Read Only: true

  Maximum Length: 30

  The public unique identifier of the contact associated with the service request message.
• PartyViaEndPoint: string
  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.
• PersonId: integer (int64)
  Title: Person ID

  The unique identifier of the person who is a contact on the service request.
• PostIdentifier: string
  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.
• ResourceId: integer (int64)
  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.
• ResourceTypeCd: string
  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.
• RoutingCd: string
  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.
• ViaId: integer (int64)
  Title: ID

  Read Only: true

  The unique identifier of the channel communication.

{
    "type":"object",
    "properties":{
        "ChannelAccountName":{
            "title":"Account Name",
            "maxLength":400,
            "type":"string",
            "description":"The account name associated with the channel. For example, for email, an account name would be the inbound mailbox for support like [e-mail].",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the communication channel was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NetworkTypeCd":{
            "title":"Network",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageNumber":{
            "title":"Message Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the service request message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ViaId":{
            "title":"ID",
            "type":"integer",
            "description":"The unique identifier of the channel communication.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CollabId":{
            "title":"Collaboration ID",
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier of the collaboration network user in the corresponding network. An example of this is the slack user Id. of a user.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChannelDisplayName":{
            "title":"Display Name",
            "maxLength":400,
            "type":"string",
            "description":"The display name of the channel.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Party Name",
            "maxLength":360,
            "type":"string",
            "description":"The party name of the person who is being communicated with. The user can be an internal resource or a customer contact.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CollabName":{
            "title":"Resource Name",
            "maxLength":400,
            "type":"string",
            "description":"The user name of the external user on the collaboration network.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChannelId":{
            "title":"Channel ID",
            "type":"integer",
            "description":"The unique identifier of the channel.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResourceTypeCd":{
            "title":"Resource Type",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RoutingCd":{
            "title":"Routing Code",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ContactPointId":{
            "title":"Contact Point ID",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectTypeCd":{
            "title":"Object Type",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "default":"SVC_SR_MESSAGES",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdatedBy":{
            "title":"Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the communication channel.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the communication channel.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectId":{
            "title":"Object ID",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PostIdentifier":{
            "title":"Post Identifier",
            "maxLength":1000,
            "type":"string",
            "description":"The unique identifier of the social media post record that was used to create the service request or the service request message.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyViaEndPoint":{
            "title":"Party Endpoint",
            "maxLength":1000,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"ChannelViaEO.PartyViaEndPoint",
                "protectionObjectTitle":"Party Endpoint",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Party Endpoint"
            },
            "x-queryable":true
        },
        "InboundObjectId":{
            "title":"Inbound Message Object Identifier",
            "type":"integer",
            "description":"The unique identifier of the inbound object that resulted in the creation of the service request message.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the contact associated with the service request message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique party identifier of the person who is being communicated with.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonId":{
            "title":"Person ID",
            "type":"integer",
            "description":"The unique identifier of the person who is a contact on the service request.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CollabResourceId":{
            "title":"Collaboration Resource Identifier",
            "type":"integer",
            "description":"The unique identifier of the collaboration network user that the internal users are communicating with.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChannelShortName":{
            "title":"Channel Short Name",
            "maxLength":450,
            "type":"string",
            "description":"The public unique identifier of the channel.",
            "nullable":false,
            "x-queryable":true
        },
        "ChannelTypeCd":{
            "title":"Channel Type",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the communication channel was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The session login associated to the user who last updated the communication channel.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

ChannelLOV

Operation: /crmRestApi/resources/11.13.18.05/channels

Parameters:

• finder: ChannelEnabledFinder

The channels resource is used to view the channels associated with a business unit. Channels used to listen and respond to customers.

RoutingCdLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_CHANNEL_ROUTING_CD

The standard lookups list of values resource is used to query the list of values of standard lookups, which list the available codes and translated meanings. Standard lookups are defined in the standard lookups view and store lookup codes that support reference data sharing.

Back to Top