Seitenvergleich

...

Universal Messenger ChannelList REST interface

See also REST API doc

Request

• URL: <um-rest-url>/de.pinuts.cmsbs.restapi.Channels/index

• Parameters:

  • umopen: API Keytoken (prior to UM 7.56)

  • (optional) semtag: Tenant semtag string as a filter

• Headers (UM 7.56 or newer):

  • Authorization: Basic Auth credentials of API key with permission de.pinuts.cmsbs.restapi:ListChannels
    See also https://pinutswiki.atlassian.net/wiki/spaces/UMDOC/pages/4541349948/Universal+Messenger+7.56.0+EN#Securing-REST-endpoints-with-API-keys

Response

• Format: JSON

• Body: Array of channel objects with the following attributes:

  • id: internal name, this must be used as a value for both <destination> of personalization filter.
    If the CMS can only store flat strings, this is the string to store.

  • title: can be used as a label for the editors

  • isPublic: is a public channel (might not be relevant but can be used as a filter for the editors)

  • isVChannel: indicated whether objects represents a segment (VCHannel) or a list (Channel), this determines which syntax must be used (see below)

  • oid: internal ID, if the CMS implementation needs an ID for the stored object this attribute can be used

  • estimatedCount: contains an estimation of the the number of members (recipients)

...

<event>
  <destination>
    for each group
      if group.isVChannel
        <vchannel>group.id</vchannel>
      else
        <channel>group.id</channel>
      end
    end
  </destination>
  ...
</event>

...