DokumentationEngagement Platform API
Sign inGet started
Guides
API

Channels management

Retrieving channels

Retrieve list of channels

GET
/workspaces/{workspaceId}/channels
Get the channels configured for a workspace
Abfrageparameter
limit
integer
Limits the number of results to return.
pageToken
string
The cursor that keeps track of the current position in the results.
reverse
boolean
Reverses the order in which the results are returned.
platform
Filter based on platform name
conferencial
boolean
Filter based on conferencial flag
onlyMyChannels
boolean
Filter only channels I have access to
status
Filter based on channel status
useCaseType
string
Possible values: otp, transactional, marketing, conversation
channelIds
array
Filter based on channel IDs
resourceOwnerId
array
Filter based on resource owner IDs
resourceOwnerIdentifier
array
Filter based on resource owner identifiers
suite
array
Filter entities by Suite
Antwort-Payload
results
array of object
Untergeordnete Attribute anzeigen
results.id
string
erforderlich
results.platformId
string
erforderlich
results.name
string
erforderlich
results.connectorId
string
erforderlich
results.identifier
string
results.status
string
erforderlich
Possible values: pending, setting-up, active, inactive, failed, deleted, warning
results.contactIdentifierKeyOverride
string
results.contactIdentifierFormatOverride
object
Untergeordnete Attribute anzeigen
results.contactIdentifierFormatOverride.type
string
Possible values: none, pattern, phonenumber, emailaddress
results.contactIdentifierFormatOverride.pattern
string
results.platformServiceUrlOverride
string
results.platformServiceVersionOverride
string
Possible values: 1.0
results.platformServiceProtocolOverride
string
Possible values: http, https
results.platformMessageJsonSchemaOverride
object
results.platformTemplateEngineOverride
string
Possible values: default, liquid
results.capabilities
object
Untergeordnete Attribute anzeigen
results.capabilities.messaging
object
Untergeordnete Attribute anzeigen
results.capabilities.messaging.messaging
object
Untergeordnete Attribute anzeigen
results.capabilities.messaging.messaging.displayName
string
results.capabilities.messaging.messaging.status
string
erforderlich
results.capabilities.messaging.messaging.name
string
erforderlich
results.capabilities.messaging.messaging.version
number
erforderlich
results.capabilities.messaging.messaging.updatedAt
string
erforderlich
results.capabilities.messaging.messaging.createdAt
string
erforderlich
results.capabilities.messaging.messaging.expiresAt
string
results.capabilities.messaging.messaging.outgoing
object
erforderlich
Untergeordnete Attribute anzeigen
results.capabilities.messaging.messaging.outgoing.displayName
string
results.capabilities.messaging.messaging.outgoing.status
string
erforderlich
results.capabilities.messaging.messaging.outgoing.name
string
erforderlich
results.capabilities.messaging.messaging.outgoing.version
number
results.capabilities.messaging.messaging.outgoing.updatedAt
string
results.capabilities.messaging.messaging.outgoing.createdAt
string
results.capabilities.messaging.messaging.outgoing.expiresAt
string
results.capabilities.messaging.messaging.outgoing.mms
object
Untergeordnete Attribute anzeigen
results.capabilities.messaging.messaging.outgoing.mms.displayName
string
results.capabilities.messaging.messaging.outgoing.mms.status
string
erforderlich
results.capabilities.messaging.messaging.outgoing.mms.name
string
erforderlich
results.capabilities.messaging.messaging.outgoing.mms.version
number
erforderlich
results.capabilities.messaging.messaging.outgoing.mms.paused
boolean
results.capabilities.messaging.messaging.outgoing.mms.updatedAt
string
erforderlich
results.capabilities.messaging.messaging.outgoing.mms.createdAt
string
erforderlich
results.capabilities.messaging.messaging.outgoing.mms.expiresAt
string
results.capabilities.messaging.messaging.outgoing.media
object
Untergeordnete Attribute anzeigen
results.capabilities.messaging.messaging.outgoing.media.textFallback
object
Untergeordnete Attribute anzeigen
results.capabilities.messaging.messaging.outgoing.media.textFallback.displayName
string
results.capabilities.messaging.messaging.outgoing.media.textFallback.status
string
erforderlich
results.capabilities.messaging.messaging.outgoing.media.textFallback.name
string
erforderlich
results.capabilities.messaging.messaging.outgoing.media.textFallback.version
number
erforderlich
results.capabilities.messaging.messaging.outgoing.media.textFallback.paused
boolean
results.capabilities.messaging.messaging.outgoing.media.textFallback.updatedAt
string
erforderlich
results.capabilities.messaging.messaging.outgoing.media.textFallback.createdAt
string
erforderlich
results.capabilities.messaging.messaging.outgoing.media.textFallback.expiresAt
string
results.capabilities.messaging.messaging.outgoing.mmLite
object
Untergeordnete Attribute anzeigen
results.capabilities.messaging.messaging.outgoing.mmLite.displayName
string
results.capabilities.messaging.messaging.outgoing.mmLite.status
string
erforderlich
results.capabilities.messaging.messaging.outgoing.mmLite.name
string
erforderlich
results.capabilities.messaging.messaging.outgoing.mmLite.version
number
erforderlich
results.capabilities.messaging.messaging.outgoing.mmLite.paused
boolean
results.capabilities.messaging.messaging.outgoing.mmLite.updatedAt
string
erforderlich
results.capabilities.messaging.messaging.outgoing.mmLite.createdAt
string
erforderlich
results.capabilities.messaging.messaging.outgoing.mmLite.expiresAt
string
results.capabilities.messaging.messaging.incoming
object
erforderlich
Untergeordnete Attribute anzeigen
results.capabilities.messaging.messaging.incoming.displayName
string
results.capabilities.messaging.messaging.incoming.status
string
erforderlich
results.capabilities.messaging.messaging.incoming.name
string
erforderlich
results.capabilities.messaging.messaging.incoming.version
number
results.capabilities.messaging.messaging.incoming.updatedAt
string
results.capabilities.messaging.messaging.incoming.createdAt
string
results.capabilities.messaging.messaging.incoming.expiresAt
string
results.capabilities.messaging.messaging.incoming.mms
object
Untergeordnete Attribute anzeigen
results.capabilities.messaging.messaging.incoming.mms.displayName
string
results.capabilities.messaging.messaging.incoming.mms.status
string
erforderlich
results.capabilities.messaging.messaging.incoming.mms.name
string
erforderlich
results.capabilities.messaging.messaging.incoming.mms.version
number
erforderlich
results.capabilities.messaging.messaging.incoming.mms.paused
boolean
results.capabilities.messaging.messaging.incoming.mms.updatedAt
string
erforderlich
results.capabilities.messaging.messaging.incoming.mms.createdAt
string
erforderlich
results.capabilities.messaging.messaging.incoming.mms.expiresAt
string
results.capabilities.voice
object
Untergeordnete Attribute anzeigen
results.capabilities.voice.voice
object
Untergeordnete Attribute anzeigen
results.capabilities.voice.voice.displayName
string
results.capabilities.voice.voice.status
string
erforderlich
results.capabilities.voice.voice.name
string
erforderlich
results.capabilities.voice.voice.version
number
erforderlich
results.capabilities.voice.voice.updatedAt
string
erforderlich
results.capabilities.voice.voice.createdAt
string
erforderlich
results.capabilities.voice.voice.expiresAt
string
results.capabilities.voice.voice.recording
object
erforderlich
Untergeordnete Attribute anzeigen
results.capabilities.voice.voice.recording.displayName
string
results.capabilities.voice.voice.recording.status
string
erforderlich
results.capabilities.voice.voice.recording.name
string
erforderlich
results.capabilities.voice.voice.recording.version
number
erforderlich
results.capabilities.voice.voice.recording.paused
boolean
results.capabilities.voice.voice.recording.updatedAt
string
erforderlich
results.capabilities.voice.voice.recording.createdAt
string
erforderlich
results.capabilities.voice.voice.recording.expiresAt
string
results.settings
array of object
Untergeordnete Attribute anzeigen
results.settings.key
string
erforderlich
results.settings.value
string
erforderlich
results.settings.displayName
string
results.settings.description
string
results.settings.visibility
string
Possible values: public, internal, secret
results.connectionParams
array of object
Untergeordnete Attribute anzeigen
results.connectionParams.key
string
erforderlich
results.connectionParams.value
string
erforderlich
results.connectionParams.displayName
string
results.connectionParams.description
string
results.connectionParams.visibility
string
Possible values: public, internal, secret
results.preferences
object
Untergeordnete Attribute anzeigen
results.preferences.disableProfileFetching
boolean
When enabled, it skips fetching the sender profile details on incoming messages, and, therefore, contacts won't have profile details (first name, last name, display name, country, etc.). In case this preference is not provided during channel creation, the PII strategy defined in the workspace will be used.
results.preferences.explicitMarketingOptOut
boolean
When enabled, if a contact does not have a subscription attribute set for the corresponding platform, the contact will be treated as if it were subscribed when messaged through this channel. In case this preference is not provided during channel creation, the default value will be false.
results.preferences.trackAdInitiatedThreads
When enabled, it tracks the threads initiated by advertisements. In case this preference is not provided during channel creation, the default value will be false.
results.preferences.ignoreSuppressionChecks
boolean
When enabled, it skips the suppression checks for the messages sent through this channel. In case this preference is not provided during channel creation, the default value will be false.
results.preferences.isPrivate
boolean
When enabled, it allows the channel to be marked as private - that is, the items which arrive via it, should, in turn, be marked as private.
results.preferences.disallowMmLite
boolean
When enabled, Cloud API is used to send marketing messages.
results.useCaseId
string
results.useCaseType
string
Possible values: transactional, marketing, conversation
results.channelMessageType
string
Possible values: promotional, 2fa, conversational, transactional, emergency
results.suites
array of string
results.resourceOwners
object
The map of resource owners that are allowed to use this channel. Example: { "resourceOwnerIdentifier1": { "id": "resourceOwnerUUID1", "type": "user" }, "resourceOwnerIdentifier2": { "id": "resourceOwnerUUID2", "type": "group" } }
results.createdAt
string
erforderlich
results.updatedAt
string
nextPageToken
string
The token that can be passed as pageToken in URL to retrieve the next set of results. If missing, no more results to display.
Codebeispiel
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/channels' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'

Retrieve a specific channel

GET
/workspaces/{workspaceId}/channels/{channelId}
Retrieve a specific workspace channel
Antwort-Payload
id
string
erforderlich
platformId
string
erforderlich
name
string
erforderlich
connectorId
string
erforderlich
identifier
string
status
string
erforderlich
Possible values: pending, setting-up, active, inactive, failed, deleted, warning
contactIdentifierKeyOverride
string
contactIdentifierFormatOverride
object
Untergeordnete Attribute anzeigen
contactIdentifierFormatOverride.type
string
Possible values: none, pattern, phonenumber, emailaddress
contactIdentifierFormatOverride.pattern
string
platformServiceUrlOverride
string
platformServiceVersionOverride
string
Possible values: 1.0
platformServiceProtocolOverride
string
Possible values: http, https
platformMessageJsonSchemaOverride
object
platformTemplateEngineOverride
string
Possible values: default, liquid
capabilities
object
Untergeordnete Attribute anzeigen
capabilities.messaging
object
Untergeordnete Attribute anzeigen
capabilities.messaging.messaging
object
Untergeordnete Attribute anzeigen
capabilities.messaging.messaging.displayName
string
capabilities.messaging.messaging.status
string
erforderlich
capabilities.messaging.messaging.name
string
erforderlich
capabilities.messaging.messaging.version
number
erforderlich
capabilities.messaging.messaging.updatedAt
string
erforderlich
capabilities.messaging.messaging.createdAt
string
erforderlich
capabilities.messaging.messaging.expiresAt
string
capabilities.messaging.messaging.outgoing
object
erforderlich
Untergeordnete Attribute anzeigen
capabilities.messaging.messaging.outgoing.displayName
string
capabilities.messaging.messaging.outgoing.status
string
erforderlich
capabilities.messaging.messaging.outgoing.name
string
erforderlich
capabilities.messaging.messaging.outgoing.version
number
capabilities.messaging.messaging.outgoing.updatedAt
string
capabilities.messaging.messaging.outgoing.createdAt
string
capabilities.messaging.messaging.outgoing.expiresAt
string
capabilities.messaging.messaging.outgoing.mms
object
Untergeordnete Attribute anzeigen
capabilities.messaging.messaging.outgoing.mms.displayName
string
capabilities.messaging.messaging.outgoing.mms.status
string
erforderlich
capabilities.messaging.messaging.outgoing.mms.name
string
erforderlich
capabilities.messaging.messaging.outgoing.mms.version
number
erforderlich
capabilities.messaging.messaging.outgoing.mms.paused
boolean
capabilities.messaging.messaging.outgoing.mms.updatedAt
string
erforderlich
capabilities.messaging.messaging.outgoing.mms.createdAt
string
erforderlich
capabilities.messaging.messaging.outgoing.mms.expiresAt
string
capabilities.messaging.messaging.outgoing.media
object
Untergeordnete Attribute anzeigen
capabilities.messaging.messaging.outgoing.media.textFallback
object
Untergeordnete Attribute anzeigen
capabilities.messaging.messaging.outgoing.media.textFallback.displayName
string
capabilities.messaging.messaging.outgoing.media.textFallback.status
string
erforderlich
capabilities.messaging.messaging.outgoing.media.textFallback.name
string
erforderlich
capabilities.messaging.messaging.outgoing.media.textFallback.version
number
erforderlich
capabilities.messaging.messaging.outgoing.media.textFallback.paused
boolean
capabilities.messaging.messaging.outgoing.media.textFallback.updatedAt
string
erforderlich
capabilities.messaging.messaging.outgoing.media.textFallback.createdAt
string
erforderlich
capabilities.messaging.messaging.outgoing.media.textFallback.expiresAt
string
capabilities.messaging.messaging.outgoing.mmLite
object
Untergeordnete Attribute anzeigen
capabilities.messaging.messaging.outgoing.mmLite.displayName
string
capabilities.messaging.messaging.outgoing.mmLite.status
string
erforderlich
capabilities.messaging.messaging.outgoing.mmLite.name
string
erforderlich
capabilities.messaging.messaging.outgoing.mmLite.version
number
erforderlich
capabilities.messaging.messaging.outgoing.mmLite.paused
boolean
capabilities.messaging.messaging.outgoing.mmLite.updatedAt
string
erforderlich
capabilities.messaging.messaging.outgoing.mmLite.createdAt
string
erforderlich
capabilities.messaging.messaging.outgoing.mmLite.expiresAt
string
capabilities.messaging.messaging.incoming
object
erforderlich
Untergeordnete Attribute anzeigen
capabilities.messaging.messaging.incoming.displayName
string
capabilities.messaging.messaging.incoming.status
string
erforderlich
capabilities.messaging.messaging.incoming.name
string
erforderlich
capabilities.messaging.messaging.incoming.version
number
capabilities.messaging.messaging.incoming.updatedAt
string
capabilities.messaging.messaging.incoming.createdAt
string
capabilities.messaging.messaging.incoming.expiresAt
string
capabilities.messaging.messaging.incoming.mms
object
Untergeordnete Attribute anzeigen
capabilities.messaging.messaging.incoming.mms.displayName
string
capabilities.messaging.messaging.incoming.mms.status
string
erforderlich
capabilities.messaging.messaging.incoming.mms.name
string
erforderlich
capabilities.messaging.messaging.incoming.mms.version
number
erforderlich
capabilities.messaging.messaging.incoming.mms.paused
boolean
capabilities.messaging.messaging.incoming.mms.updatedAt
string
erforderlich
capabilities.messaging.messaging.incoming.mms.createdAt
string
erforderlich
capabilities.messaging.messaging.incoming.mms.expiresAt
string
capabilities.voice
object
Untergeordnete Attribute anzeigen
capabilities.voice.voice
object
Untergeordnete Attribute anzeigen
capabilities.voice.voice.displayName
string
capabilities.voice.voice.status
string
erforderlich
capabilities.voice.voice.name
string
erforderlich
capabilities.voice.voice.version
number
erforderlich
capabilities.voice.voice.updatedAt
string
erforderlich
capabilities.voice.voice.createdAt
string
erforderlich
capabilities.voice.voice.expiresAt
string
capabilities.voice.voice.recording
object
erforderlich
Untergeordnete Attribute anzeigen
capabilities.voice.voice.recording.displayName
string
capabilities.voice.voice.recording.status
string
erforderlich
capabilities.voice.voice.recording.name
string
erforderlich
capabilities.voice.voice.recording.version
number
erforderlich
capabilities.voice.voice.recording.paused
boolean
capabilities.voice.voice.recording.updatedAt
string
erforderlich
capabilities.voice.voice.recording.createdAt
string
erforderlich
capabilities.voice.voice.recording.expiresAt
string
settings
array of object
Untergeordnete Attribute anzeigen
settings.key
string
erforderlich
settings.value
string
erforderlich
settings.displayName
string
settings.description
string
settings.visibility
string
Possible values: public, internal, secret
connectionParams
array of object
Untergeordnete Attribute anzeigen
connectionParams.key
string
erforderlich
connectionParams.value
string
erforderlich
connectionParams.displayName
string
connectionParams.description
string
connectionParams.visibility
string
Possible values: public, internal, secret
preferences
object
Untergeordnete Attribute anzeigen
preferences.disableProfileFetching
boolean
When enabled, it skips fetching the sender profile details on incoming messages, and, therefore, contacts won't have profile details (first name, last name, display name, country, etc.). In case this preference is not provided during channel creation, the PII strategy defined in the workspace will be used.
preferences.explicitMarketingOptOut
boolean
When enabled, if a contact does not have a subscription attribute set for the corresponding platform, the contact will be treated as if it were subscribed when messaged through this channel. In case this preference is not provided during channel creation, the default value will be false.
preferences.trackAdInitiatedThreads
When enabled, it tracks the threads initiated by advertisements. In case this preference is not provided during channel creation, the default value will be false.
preferences.ignoreSuppressionChecks
boolean
When enabled, it skips the suppression checks for the messages sent through this channel. In case this preference is not provided during channel creation, the default value will be false.
preferences.isPrivate
boolean
When enabled, it allows the channel to be marked as private - that is, the items which arrive via it, should, in turn, be marked as private.
preferences.disallowMmLite
boolean
When enabled, Cloud API is used to send marketing messages.
useCaseId
string
useCaseType
string
Possible values: transactional, marketing, conversation
channelMessageType
string
Possible values: promotional, 2fa, conversational, transactional, emergency
suites
array of string
resourceOwners
object
The map of resource owners that are allowed to use this channel. Example: { "resourceOwnerIdentifier1": { "id": "resourceOwnerUUID1", "type": "user" }, "resourceOwnerIdentifier2": { "id": "resourceOwnerUUID2", "type": "group" } }
createdAt
string
erforderlich
updatedAt
string
Codebeispiel
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/channels/{channelId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'

Check if customer service window is open

For some channels it is only possible to send non template messages if the customer service window is open. The following endpoint will return the expiry time for any active service windows
GET
/workspaces/{workspaceId}/channels/{channelId}/contacts/{contactId}
Retrieve channel information for a given contact.
Abfrageparameter
contactIdentifierValue
string
The receiver identifier value.
Antwort-Payload
serviceWindowExpireAt
string
erforderlich
isPermanentSession
boolean
metadata
object
Codebeispiel
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/channels/{channelId}/contacts/{contactId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'