Jump to

• Request
• Response
• Examples

Get a channel type

get

/services/rest/connect/v1.4/channelTypes/{id}

Request

Path Parameters

• id: integer
  The unique identifier of the channel type.

Back to Top

Response

Default Response

Body ()

Root Schema : channelTypes

Type: object

The social channels tracked in contact records when storing social account user names and associating social monitor incidents to contacts.

Show Source

• attributes(optional): object channelTypes-attributes
  The details about the channel type options.
• contactVisibility(optional): boolean
  Indicates whether the channel is available in the ChannelUsername collection. This attribute does not have a default value and is read-only.
• createdTime(optional): string
  The date and time when the channel type was created. This attribute is read-only.
• displayOrder(optional): integer
  Minimum Value: 1

  Maximum Value: 32767

  The position of the channel type in the list of channels.
• id(optional): integer
  Minimum Value: 1

  Maximum Value: 9.223372036854776E18

  The unique identifier of the channel type.
• lookupName(optional): string
  Maximum Length: 255

  The name used to look up the channel type.
• name(optional): string
  Maximum Length: 80

  The name of the channel type in the language of the current interface. This attribute is read-only.
• names(optional): object channelTypes-names
  The language-specific strings used for localization of fields. The label text cannot be empty or null. The labels are assembled in a list associated with a particular text field.
• updatedTime(optional): string
  The date and time when the channel type was last updated. This attribute is read-only.

{
    "type":"object",
    "description":"The social channels tracked in contact records when storing social account user names and associating social monitor incidents to contacts.",
    "properties":{
        "updatedTime":{
            "type":"string",
            "description":"The date and time when the channel type was last updated. This attribute is read-only."
        },
        "name":{
            "type":"string",
            "description":"The name of the channel type in the language of the current interface. This attribute is read-only.",
            "maxLength":80
        },
        "lookupName":{
            "type":"string",
            "description":"The name used to look up the channel type.",
            "maxLength":255
        },
        "contactVisibility":{
            "type":"boolean",
            "description":"Indicates whether the channel is available in the ChannelUsername collection. This attribute does not have a default value and is read-only."
        },
        "names":{
            "items":{
                "type":"object"
            },
            "type":"array",
            "description":"The list of names, one for each supported language.",
            "$ref":"#/definitions/channelTypes-names"
        },
        "createdTime":{
            "type":"string",
            "description":"The date and time when the channel type was created. This attribute is read-only."
        },
        "attributes":{
            "type":"object",
            "description":"The group of flags which enable certain features of ChannelType.",
            "$ref":"#/definitions/channelTypes-attributes"
        },
        "id":{
            "minimum":1,
            "type":"integer",
            "description":"The unique identifier of the channel type.",
            "maximum":9.223372036854776E18
        },
        "displayOrder":{
            "minimum":1,
            "type":"integer",
            "description":"The position of the channel type in the list of channels.",
            "maximum":32767
        }
    }
}

Nested Schema : channelTypes-attributes

Type: object

The details about the channel type options.

Show Source

• contactVisibility(optional): boolean
  Indicates whether the channel is visible to contacts. This attribute does not have a default value.
• incoming(optional): boolean
  Indicates whether it is an incoming channel. This attribute does not have a default value.
• monitoring(optional): boolean
  Indicates whether it is a monitoring channel. This attribute does not have a default value.
• outgoing(optional): boolean
  Indicates whether it is an outgoing channel. This attribute does not have a default value.
• subscription(optional): boolean
  Indicates whether it is a subscription channel. This attribute does not have a default value.

{
    "type":"object",
    "description":"The details about the channel type options.",
    "properties":{
        "contactVisibility":{
            "type":"boolean",
            "description":"Indicates whether the channel is visible to contacts. This attribute does not have a default value."
        },
        "outgoing":{
            "type":"boolean",
            "description":"Indicates whether it is an outgoing channel. This attribute does not have a default value."
        },
        "monitoring":{
            "type":"boolean",
            "description":"Indicates whether it is a monitoring channel. This attribute does not have a default value."
        },
        "incoming":{
            "type":"boolean",
            "description":"Indicates whether it is an incoming channel. This attribute does not have a default value."
        },
        "subscription":{
            "type":"boolean",
            "description":"Indicates whether it is a subscription channel. This attribute does not have a default value."
        }
    }
}

Nested Schema : channelTypes-names

Type: object

The language-specific strings used for localization of fields. The label text cannot be empty or null. The labels are assembled in a list associated with a particular text field.

Show Source

• labelText(optional): string
  Maximum Length: 80

  The language-specific label text. The value cannot be null or empty.
• language(optional): object namedIDs-channelTypes-names-language
  An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

{
    "type":"object",
    "description":"The language-specific strings used for localization of fields. The label text cannot be empty or null. The labels are assembled in a list associated with a particular text field.",
    "properties":{
        "labelText":{
            "type":"string",
            "description":"The language-specific label text. The value cannot be null or empty.",
            "maxLength":80
        },
        "language":{
            "type":"object",
            "description":"The ID of the language. This is the key for the list entry.",
            "$ref":"#/definitions/namedIDs-channelTypes-names-language"
        }
    }
}

Nested Schema : namedIDs-channelTypes-names-language

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

• id(optional): integer
  Minimum Value: 0

  ID value
• lookupName(optional): string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "id":{
            "minimum":0,
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":255
        }
    }
}

Back to Top

Examples

Use GET with the following syntax to retrieve data for a channel type object:

https://your_site_interface/services/rest/connect/version/channelTypes/channel_type_id

Request URI example

https://mysite.example.com/services/rest/connect/v1.4/channelTypes/9

Response body example

{
  "id": 9,
  "lookupName": "Email",
  "attributes": {
    "contactVisibility": false,
    "incoming": true,
    "monitoring": false,
    "outgoing": true,
    "subscription": false
  },
  "contactVisibility": false,
  "displayOrder": 9,
  "name": "Email",
  "names": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/channelTypes/9/names"
      }
    ]
  },
  "links": [
    {
      "rel": "self",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/channelTypes/9"
    },
    {
      "rel": "canonical",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/channelTypes/9"
    },
    {
      "rel": "describedby",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/channelTypes",
      "mediaType": "application/schema+json"
    }
  ]
}

Back to Top