Sign inGet started

Feeds

POST
/workspaces/{workspaceId}/feeds
Create a custom feed or view feed for a given workspace.
Corps de la requête
indexType
string
obligatoire
Possible values: custom, view, privateview
name
string
obligatoire
emoji
string
query
object
Afficher les paramètres enfants
query.conversationIds
array of string
query.sort
string
Possible values: createdAt, lastActivity, lastMessageByContact, slaExpires
query.countOnly
boolean
Return only the count of the results, not the results themselves
query.indexType
string
Possible values: channel, participant, team, agent, custom, task
query.indexId
string
query.itemIds
array of string
query.ticketNumbers
array of number
query.itemType
string
Possible values: conversation, conference, task
query.itemTypes
array of string
query.unassigned
boolean
Search for feed items that have no agent assigned.
query.agentIds
array of string
query.teamIds
array of string
query.closed
boolean
query.archived
boolean
query.replyStatus
string
Possible values: noFollowUp, noCustomerReply, noAgentReply
query.seen
boolean
query.tagIds
array of string
query.conversationName
string
query.conversationChannelIds
array of string
query.conversationStatuses
array of string
query.conferenceStatuses
array of string
query.conversationFeaturedParticipantIds
array of string
query.participants
object
Afficher les paramètres enfants
query.participants.contacts
array of string
query.participants.agents
array of string
query.conversationParticipantTypes
array of string
query.conversationExcludeParticipantTypes
array of string
query.conversationLastMessageSenderParticipantTypes
array of string
query.fromContact
object
Afficher les paramètres enfants
query.fromContact.id
string
obligatoire
query.dynamicFields
object
Afficher les paramètres enfants
query.dynamicFields.settingsId
string
Optional. Either the uuid settings id, or "default" to use the default settings.
If not specified, it will validate form input against the last saved form.
query.dynamicFields.fields
array of object
Afficher les paramètres enfants
query.dynamicFields.fields.id
string
query.dynamicFields.fields.selectedValueIds
array of string
query.dynamicFields.fields.valueText
string
query.dynamicFields.fields.valueNumber
number
query.dynamicFields.fields.valueBoolean
boolean
query.dynamicFields.fields.valueDate
string
The date value to set or search for.
query.dynamicFields.fields.valueDateBefore
string
The date value to set or search for.
query.dynamicFields.fields.valueDateAfter
string
The date value to set or search for.
query.conferenceId
string
query.itemStatuses
array of string
query.dateFrom
string
query.dateTo
string
query.searchTerm
string
query.slaPolicyId
string
query.hasSlaPolicy
boolean
query.slaPolicyStatus
string
Reflects the overall state of the SLA policy on a ticket.
  • ok: all metrics are green.
  • needsAttention: one or more metrics are in a warning state.
  • breached: one or more metrics are in a breached state.
Possible values: ok, needsAttention, breached
query.slaMetric
string
Possible values: firstReplyTime, nextReplyTime
query.slaStatus
string
Possible values: active, expired
query.slaExpiresBefore
string
query.slaExpiresAfter
string
query.query
object
Afficher les paramètres enfants
query.query.operator
string
Possible values: and, or, not
query.query.children
array of object
Afficher les paramètres enfants
query.query.children.operator
string
Possible values: and, or, not
query.query.children.children
array of object
query.query.children.attributeName
string
query.query.children.value
string or array of string
Afficher les paramètres enfants
ISO 8601 (RFC3339) date-time format, should contain timezone. UTC example: "2021-01-02T09:22:12.012Z". UTC+1 Example: "2021-01-01T09:22:12.012+01:00" There is one exception:
  • "date/is-on" operator should be formatted as YYYY-MM-DD e.g. "2021-12-31";
query.query.attributeName
string
query.query.value
string or array of string
Afficher les paramètres enfants
ISO 8601 (RFC3339) date-time format, should contain timezone. UTC example: "2021-01-02T09:22:12.012Z". UTC+1 Example: "2021-01-01T09:22:12.012+01:00" There is one exception:
  • "date/is-on" operator should be formatted as YYYY-MM-DD e.g. "2021-12-31";
query.spam
boolean
If true, only return spam. Otherwise, only non-spam.
itemListOptions
object
Afficher les paramètres enfants
itemListOptions.sort
string
obligatoire
Possible values: createdAt, lastActivity, lastMessageByContact, slaExpires
itemListOptions.reverse
boolean
obligatoire
itemListOptions.columns
array of string
obligatoire
A list of columns to display for each feed item.
accessEntities
array of object
Afficher les paramètres enfants
accessEntities.entityId
string
obligatoire
accessEntities.entityType
string
obligatoire
Possible values: inbox-team, inbox-agent, managed-role, organization-role
Corps de la réponse
id
string
obligatoire
indexType
string
obligatoire
indexId
string
obligatoire
name
string
obligatoire
emoji
string
query
object
Afficher les attributs enfants
query.conversationIds
array of string
query.sort
string
Possible values: createdAt, lastActivity, lastMessageByContact, slaExpires
query.countOnly
boolean
Return only the count of the results, not the results themselves
query.indexType
string
Possible values: channel, participant, team, agent, custom, task
query.indexId
string
query.itemIds
array of string
query.ticketNumbers
array of number
query.itemType
string
Possible values: conversation, conference, task
query.itemTypes
array of string
query.unassigned
boolean
Search for feed items that have no agent assigned.
query.agentIds
array of string
query.teamIds
array of string
query.closed
boolean
query.archived
boolean
query.replyStatus
string
Possible values: noFollowUp, noCustomerReply, noAgentReply
query.seen
boolean
query.tagIds
array of string
query.conversationName
string
query.conversationChannelIds
array of string
query.conversationStatuses
array of string
query.conferenceStatuses
array of string
query.conversationFeaturedParticipantIds
array of string
query.participants
object
Afficher les attributs enfants
query.participants.contacts
array of string
query.participants.agents
array of string
query.conversationParticipantTypes
array of string
query.conversationExcludeParticipantTypes
array of string
query.conversationLastMessageSenderParticipantTypes
array of string
query.fromContact
object
Afficher les attributs enfants
query.fromContact.id
string
obligatoire
query.dynamicFields
object
Afficher les attributs enfants
query.dynamicFields.settingsId
string
Optional. Either the uuid settings id, or "default" to use the default settings.
If not specified, it will validate form input against the last saved form.
query.dynamicFields.fields
array of object
Afficher les attributs enfants
query.dynamicFields.fields.id
string
query.dynamicFields.fields.selectedValueIds
array of string
query.dynamicFields.fields.valueText
string
query.dynamicFields.fields.valueNumber
number
query.dynamicFields.fields.valueBoolean
boolean
query.dynamicFields.fields.valueDate
string
The date value to set or search for.
query.dynamicFields.fields.valueDateBefore
string
The date value to set or search for.
query.dynamicFields.fields.valueDateAfter
string
The date value to set or search for.
query.conferenceId
string
query.itemStatuses
array of string
query.dateFrom
string
query.dateTo
string
query.searchTerm
string
query.slaPolicyId
string
query.hasSlaPolicy
boolean
query.slaPolicyStatus
string
Reflects the overall state of the SLA policy on a ticket.
  • ok: all metrics are green.
  • needsAttention: one or more metrics are in a warning state.
  • breached: one or more metrics are in a breached state.
Possible values: ok, needsAttention, breached
query.slaMetric
string
Possible values: firstReplyTime, nextReplyTime
query.slaStatus
string
Possible values: active, expired
query.slaExpiresBefore
string
query.slaExpiresAfter
string
query.query
object
Afficher les attributs enfants
query.query.operator
string
Possible values: and, or, not
query.query.children
array of object
Afficher les attributs enfants
query.query.children.operator
string
Possible values: and, or, not
query.query.children.children
array of object
query.query.children.attributeName
string
query.query.children.value
string or array of string
Afficher les attributs enfants
ISO 8601 (RFC3339) date-time format, should contain timezone. UTC example: "2021-01-02T09:22:12.012Z". UTC+1 Example: "2021-01-01T09:22:12.012+01:00" There is one exception:
  • "date/is-on" operator should be formatted as YYYY-MM-DD e.g. "2021-12-31";
query.query.attributeName
string
query.query.value
string or array of string
Afficher les attributs enfants
ISO 8601 (RFC3339) date-time format, should contain timezone. UTC example: "2021-01-02T09:22:12.012Z". UTC+1 Example: "2021-01-01T09:22:12.012+01:00" There is one exception:
  • "date/is-on" operator should be formatted as YYYY-MM-DD e.g. "2021-12-31";
query.spam
boolean
If true, only return spam. Otherwise, only non-spam.
itemListOptions
object
Afficher les attributs enfants
itemListOptions.sort
string
obligatoire
Possible values: createdAt, lastActivity, lastMessageByContact, slaExpires
itemListOptions.reverse
boolean
obligatoire
itemListOptions.columns
array of string
obligatoire
A list of columns to display for each feed item.
accessEntities
array of object
Afficher les attributs enfants
accessEntities.entityId
string
obligatoire
accessEntities.entityType
string
obligatoire
Possible values: inbox-team, inbox-agent, managed-role, organization-role
itemCount
integer
obligatoire
unseenCount
integer
Exemple de code
curl -X POST 'https://api.bird.com/workspaces/{workspaceId}/feeds' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
GET
/workspaces/{workspaceId}/feeds
Retrieve a list of custom and view feeds for administration purposes.
Paramètres de requête
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.
indexType
string
The type of feed.
Possible values: channel, participant, team, agent, custom, view, privateview, task
Corps de la réponse
results
array of object
obligatoire
Afficher les attributs enfants
results.id
string
obligatoire
results.indexType
string
obligatoire
results.indexId
string
obligatoire
results.name
string
obligatoire
results.emoji
string
results.query
object
Afficher les attributs enfants
results.query.conversationIds
array of string
results.query.sort
string
Possible values: createdAt, lastActivity, lastMessageByContact, slaExpires
results.query.countOnly
boolean
Return only the count of the results, not the results themselves
results.query.indexType
string
Possible values: channel, participant, team, agent, custom, task
results.query.indexId
string
results.query.itemIds
array of string
results.query.ticketNumbers
array of number
results.query.itemType
string
Possible values: conversation, conference, task
results.query.itemTypes
array of string
results.query.unassigned
boolean
Search for feed items that have no agent assigned.
results.query.agentIds
array of string
results.query.teamIds
array of string
results.query.closed
boolean
results.query.archived
boolean
results.query.replyStatus
string
Possible values: noFollowUp, noCustomerReply, noAgentReply
results.query.seen
boolean
results.query.tagIds
array of string
results.query.conversationName
string
results.query.conversationChannelIds
array of string
results.query.conversationStatuses
array of string
results.query.conferenceStatuses
array of string
results.query.conversationFeaturedParticipantIds
array of string
results.query.participants
object
Afficher les attributs enfants
results.query.participants.contacts
array of string
results.query.participants.agents
array of string
results.query.conversationParticipantTypes
array of string
results.query.conversationExcludeParticipantTypes
array of string
results.query.conversationLastMessageSenderParticipantTypes
array of string
results.query.fromContact
object
Afficher les attributs enfants
results.query.fromContact.id
string
obligatoire
results.query.dynamicFields
object
Afficher les attributs enfants
results.query.dynamicFields.settingsId
string
Optional. Either the uuid settings id, or "default" to use the default settings.
If not specified, it will validate form input against the last saved form.
results.query.dynamicFields.fields
array of object
Afficher les attributs enfants
results.query.dynamicFields.fields.id
string
results.query.dynamicFields.fields.selectedValueIds
array of string
results.query.dynamicFields.fields.valueText
string
results.query.dynamicFields.fields.valueNumber
number
results.query.dynamicFields.fields.valueBoolean
boolean
results.query.dynamicFields.fields.valueDate
string
The date value to set or search for.
results.query.dynamicFields.fields.valueDateBefore
string
The date value to set or search for.
results.query.dynamicFields.fields.valueDateAfter
string
The date value to set or search for.
results.query.conferenceId
string
results.query.itemStatuses
array of string
results.query.dateFrom
string
results.query.dateTo
string
results.query.searchTerm
string
results.query.slaPolicyId
string
results.query.hasSlaPolicy
boolean
results.query.slaPolicyStatus
string
Reflects the overall state of the SLA policy on a ticket.
  • ok: all metrics are green.
  • needsAttention: one or more metrics are in a warning state.
  • breached: one or more metrics are in a breached state.
Possible values: ok, needsAttention, breached
results.query.slaMetric
string
Possible values: firstReplyTime, nextReplyTime
results.query.slaStatus
string
Possible values: active, expired
results.query.slaExpiresBefore
string
results.query.slaExpiresAfter
string
results.query.query
object
Afficher les attributs enfants
results.query.query.operator
string
Possible values: and, or, not
results.query.query.children
array of object
Afficher les attributs enfants
results.query.query.children.operator
string
Possible values: and, or, not
results.query.query.children.children
array of object
results.query.query.children.attributeName
string
results.query.query.children.value
string or array of string
Afficher les attributs enfants
ISO 8601 (RFC3339) date-time format, should contain timezone. UTC example: "2021-01-02T09:22:12.012Z". UTC+1 Example: "2021-01-01T09:22:12.012+01:00" There is one exception:
  • "date/is-on" operator should be formatted as YYYY-MM-DD e.g. "2021-12-31";
results.query.query.attributeName
string
results.query.query.value
string or array of string
Afficher les attributs enfants
ISO 8601 (RFC3339) date-time format, should contain timezone. UTC example: "2021-01-02T09:22:12.012Z". UTC+1 Example: "2021-01-01T09:22:12.012+01:00" There is one exception:
  • "date/is-on" operator should be formatted as YYYY-MM-DD e.g. "2021-12-31";
results.query.spam
boolean
If true, only return spam. Otherwise, only non-spam.
results.itemListOptions
object
Afficher les attributs enfants
results.itemListOptions.sort
string
obligatoire
Possible values: createdAt, lastActivity, lastMessageByContact, slaExpires
results.itemListOptions.reverse
boolean
obligatoire
results.itemListOptions.columns
array of string
obligatoire
A list of columns to display for each feed item.
results.accessEntities
array of object
Afficher les attributs enfants
results.accessEntities.entityId
string
obligatoire
results.accessEntities.entityType
string
obligatoire
Possible values: inbox-team, inbox-agent, managed-role, organization-role
results.itemCount
integer
obligatoire
results.unseenCount
integer
Exemple de code
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/feeds' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
POST
/workspaces/{workspaceId}/search/feed-items
Retrieve a list of feed items based on the specified parameters.
Paramètres de requête
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.
countOnly
boolean
Return only the count of the results, not the results themselves
Corps de la requête
conversationIds
array of string
sort
string
Possible values: createdAt, lastActivity, lastMessageByContact, slaExpires
countOnly
boolean
Return only the count of the results, not the results themselves
indexType
string
Possible values: channel, participant, team, agent, custom, task
indexId
string
itemIds
array of string
ticketNumbers
array of number
itemType
string
Possible values: conversation, conference, task
itemTypes
array of string
unassigned
boolean
Search for feed items that have no agent assigned.
agentIds
array of string
teamIds
array of string
closed
boolean
archived
boolean
replyStatus
string
Possible values: noFollowUp, noCustomerReply, noAgentReply
seen
boolean
tagIds
array of string
conversationName
string
conversationChannelIds
array of string
conversationStatuses
array of string
conferenceStatuses
array of string
conversationFeaturedParticipantIds
array of string
participants
object
Afficher les paramètres enfants
participants.contacts
array of string
participants.agents
array of string
conversationParticipantTypes
array of string
conversationExcludeParticipantTypes
array of string
conversationLastMessageSenderParticipantTypes
array of string
fromContact
object
Afficher les paramètres enfants
fromContact.id
string
obligatoire
dynamicFields
object
Afficher les paramètres enfants
dynamicFields.settingsId
string
Optional. Either the uuid settings id, or "default" to use the default settings.
If not specified, it will validate form input against the last saved form.
dynamicFields.fields
array of object
Afficher les paramètres enfants
dynamicFields.fields.id
string
dynamicFields.fields.selectedValueIds
array of string
dynamicFields.fields.valueText
string
dynamicFields.fields.valueNumber
number
dynamicFields.fields.valueBoolean
boolean
dynamicFields.fields.valueDate
string
The date value to set or search for.
dynamicFields.fields.valueDateBefore
string
The date value to set or search for.
dynamicFields.fields.valueDateAfter
string
The date value to set or search for.
conferenceId
string
itemStatuses
array of string
dateFrom
string
dateTo
string
searchTerm
string
slaPolicyId
string
hasSlaPolicy
boolean
slaPolicyStatus
string
Reflects the overall state of the SLA policy on a ticket.
  • ok: all metrics are green.
  • needsAttention: one or more metrics are in a warning state.
  • breached: one or more metrics are in a breached state.
Possible values: ok, needsAttention, breached
slaMetric
string
Possible values: firstReplyTime, nextReplyTime
slaStatus
string
Possible values: active, expired
slaExpiresBefore
string
slaExpiresAfter
string
query
object
Afficher les paramètres enfants
query.operator
string
Possible values: and, or, not
query.children
array of object
Afficher les paramètres enfants
query.children.operator
string
Possible values: and, or, not
query.children.children
array of object
query.children.attributeName
string
query.children.value
string or array of string
Afficher les paramètres enfants
ISO 8601 (RFC3339) date-time format, should contain timezone. UTC example: "2021-01-02T09:22:12.012Z". UTC+1 Example: "2021-01-01T09:22:12.012+01:00" There is one exception:
  • "date/is-on" operator should be formatted as YYYY-MM-DD e.g. "2021-12-31";
query.attributeName
string
query.value
string or array of string
Afficher les paramètres enfants
ISO 8601 (RFC3339) date-time format, should contain timezone. UTC example: "2021-01-02T09:22:12.012Z". UTC+1 Example: "2021-01-01T09:22:12.012+01:00" There is one exception:
  • "date/is-on" operator should be formatted as YYYY-MM-DD e.g. "2021-12-31";
spam
boolean
If true, only return spam. Otherwise, only non-spam.
Corps de la réponse
results
array of object
Afficher les attributs enfants
results.id
string
obligatoire
results.feedId
string
results.feedIndexId
string
results.feedIndexType
string
results.agent
object
Afficher les attributs enfants
results.agent.id
string
obligatoire
results.agent.name
string
obligatoire
results.agent.avatarUrl
string
results.team
object
Afficher les attributs enfants
results.team.id
string
obligatoire
results.team.name
string
obligatoire
results.team.avatarUrl
string
results.number
integer
results.type
string
obligatoire
Possible values: conversation, conference, task
results.archived
boolean
obligatoire
results.closed
boolean
obligatoire
results.private
boolean
results.deleted
boolean
results.spam
boolean
results.senderBlocked
boolean
results.seen
boolean
results.seenBy
string
results.replySuggestion
string
results.createdAt
string
obligatoire
results.willBeDeletedAt
string
results.lastActivityAt
string
obligatoire
results.lastMessageByContactAt
string
results.tags
array of object
Afficher les attributs enfants
results.tags.id
string
obligatoire
results.tags.name
string
obligatoire
results.tags.status
string
obligatoire
Possible values: draft, active, deleted
results.tags.addedAt
string
obligatoire
results.tags.category
object
Afficher les attributs enfants
results.tags.category.id
string
results.tags.category.name
string
results.tags.category.emoji
string
results.attributes
array of object
Afficher les attributs enfants
results.attributes.key
string
results.attributes.value
string
results.customAttributes
object
Use dynamicFields instead.
results.filters
array of array of object
Afficher les attributs enfants
results.filters.key
string
results.filters.value
string
results.linkedItems
array of object
Afficher les attributs enfants
results.linkedItems.userId
string
The id of the user that set up this relation.
results.linkedItems.relation
string
Possible values: linkedTo, parentOf, childOf, parentOfTask, taskChildOf
results.linkedItems.itemId
string
The id of the linked item.
results.linkedItems.itemNumber
integer
results.linkedItems.itemSubject
string
results.linkedItems.createdAt
string
results.mergeInfo
object
Afficher les attributs enfants
results.mergeInfo.mergedFrom
array of object
Afficher les attributs enfants
results.mergeInfo.mergedFrom.userId
string
obligatoire
results.mergeInfo.mergedFrom.itemId
string
obligatoire
results.mergeInfo.mergedFrom.createdAt
string
obligatoire
results.mergeInfo.mergedInto
object
Afficher les attributs enfants
results.mergeInfo.mergedInto.userId
string
obligatoire
results.mergeInfo.mergedInto.itemId
string
obligatoire
results.mergeInfo.mergedInto.createdAt
string
obligatoire
results.dynamicFields
object
Afficher les attributs enfants
results.dynamicFields.settingsId
string
obligatoire
Either the uuid settings id, or "default" to use the default settings.
results.dynamicFields.fields
array of object
obligatoire
Afficher les attributs enfants
results.dynamicFields.fields.id
string
results.dynamicFields.fields.name
string
obligatoire
results.dynamicFields.fields.description
string
results.dynamicFields.fields.type
string
obligatoire
Possible values: single, multiple, numeric, text, boolean, date
results.dynamicFields.fields.values
array of object
Afficher les attributs enfants
results.dynamicFields.fields.values.id
string
obligatoire
results.dynamicFields.fields.values.value
string
obligatoire
results.dynamicFields.fields.values.icon
string
results.dynamicFields.fields.values.createdAt
string
obligatoire
results.dynamicFields.fields.values.selected
boolean
obligatoire
results.dynamicFields.fields.valueText
string
results.dynamicFields.fields.valueNumber
number
results.dynamicFields.fields.valueBoolean
boolean
results.dynamicFields.fields.valueDate
string
results.dynamicFields.fields.settings
object
results.summaryForm
object
Afficher les attributs enfants
results.summaryForm.settingsId
string
obligatoire
Either the uuid settings id, or "default" to use the default settings.
results.summaryForm.fields
array of object
obligatoire
Afficher les attributs enfants
results.summaryForm.fields.id
string
results.summaryForm.fields.name
string
obligatoire
results.summaryForm.fields.description
string
results.summaryForm.fields.type
string
obligatoire
Possible values: single, multiple, numeric, text, boolean, date
results.summaryForm.fields.values
array of object
Afficher les attributs enfants
results.summaryForm.fields.values.id
string
obligatoire
results.summaryForm.fields.values.value
string
obligatoire
results.summaryForm.fields.values.icon
string
results.summaryForm.fields.values.createdAt
string
obligatoire
results.summaryForm.fields.values.selected
boolean
obligatoire
results.summaryForm.fields.valueText
string
results.summaryForm.fields.valueNumber
number
results.summaryForm.fields.valueBoolean
boolean
results.summaryForm.fields.valueDate
string
results.summaryForm.fields.settings
object
results.queueInfo
object
Afficher les attributs enfants
results.queueInfo.queueId
string
obligatoire
results.queueInfo.queueName
string
obligatoire
results.queueInfo.queuedAt
string
obligatoire
results.conversation
object
Afficher les attributs enfants
results.conversation.accessibility
string
obligatoire
Possible values: open, invite-only, request-to-join, private
results.conversation.activeParticipantCount
integer
obligatoire
results.conversation.assigneeId
string
results.conversation.attributes
object
results.conversation.category
string
results.conversation.channelId
string
obligatoire
results.conversation.createdAt
string
obligatoire
results.conversation.description
string
results.conversation.directory
string
results.conversation.featuredParticipants
array of object
obligatoire
Afficher les attributs enfants
results.conversation.featuredParticipants.avatarUrl
string
results.conversation.featuredParticipants.contact
object
Afficher les attributs enfants
results.conversation.featuredParticipants.contact.identifierKey
string
obligatoire
results.conversation.featuredParticipants.contact.identifierValue
string
obligatoire
results.conversation.featuredParticipants.contact.platformAddress
string
results.conversation.featuredParticipants.contact.platformAddressSelector
string
results.conversation.featuredParticipants.conversationId
string
results.conversation.featuredParticipants.createdAt
string
results.conversation.featuredParticipants.displayName
string
results.conversation.featuredParticipants.id
string
obligatoire
results.conversation.featuredParticipants.resourceUri
string
results.conversation.featuredParticipants.status
string
Possible values: invited, pending, active, inactive
results.conversation.featuredParticipants.type
string
obligatoire
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
results.conversation.featuredParticipants.updatedAt
string
results.conversation.hasDraft
boolean
results.conversation.id
string
obligatoire
results.conversation.inbox
object
Afficher les attributs enfants
results.conversation.inbox.id
string
obligatoire
results.conversation.inbox.identifier
string
obligatoire
results.conversation.inbox.ownerId
string
obligatoire
results.conversation.inbox.ownerType
string
obligatoire
Possible values: user, group
results.conversation.inbox.type
string
obligatoire
Possible values: personal, shared, support
results.conversation.initiatingParticipant
object
Afficher les attributs enfants
results.conversation.initiatingParticipant.avatarUrl
string
results.conversation.initiatingParticipant.contact
object
Afficher les attributs enfants
results.conversation.initiatingParticipant.contact.identifierKey
string
obligatoire
results.conversation.initiatingParticipant.contact.identifierValue
string
obligatoire
results.conversation.initiatingParticipant.contact.platformAddress
string
results.conversation.initiatingParticipant.contact.platformAddressSelector
string
results.conversation.initiatingParticipant.conversationId
string
results.conversation.initiatingParticipant.createdAt
string
results.conversation.initiatingParticipant.displayName
string
results.conversation.initiatingParticipant.id
string
obligatoire
results.conversation.initiatingParticipant.resourceUri
string
results.conversation.initiatingParticipant.status
string
Possible values: invited, pending, active, inactive
results.conversation.initiatingParticipant.type
string
obligatoire
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
results.conversation.initiatingParticipant.updatedAt
string
results.conversation.lastMessage
object
Afficher les attributs enfants
results.conversation.lastMessage.createdAt
string
obligatoire
results.conversation.lastMessage.draft
boolean
obligatoire
results.conversation.lastMessage.id
string
obligatoire
results.conversation.lastMessage.preview
object
obligatoire
Afficher les attributs enfants
results.conversation.lastMessage.preview.text
string
results.conversation.lastMessage.recipients
array of object
Afficher les attributs enfants
results.conversation.lastMessage.recipients.contactAnnotation
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Afficher les attributs enfants
results.conversation.lastMessage.recipients.contactAnnotation.name
string
results.conversation.lastMessage.recipients.countryCode
string
results.conversation.lastMessage.recipients.id
string
The ID of the contact.
results.conversation.lastMessage.recipients.identifierKey
string
The identifier key for finding the contact (e.g. emailaddress, phonenumber). For WhatsApp channels with BSUID support, use whatsappbsuid to send to a contact by their Business-Scoped User ID.
results.conversation.lastMessage.recipients.identifierValue
string
The identifier value for finding the contact.
results.conversation.lastMessage.recipients.identifiers
array of object
Additional identifiers to augment the contact during resolution.
Afficher les attributs enfants
results.conversation.lastMessage.recipients.identifiers.identifierKey
string
obligatoire
The identifier key for finding the contact (e.g. emailaddress, phonenumber).
results.conversation.lastMessage.recipients.identifiers.identifierValue
string
obligatoire
The identifier value for finding the contact.
results.conversation.lastMessage.recipients.platformAddress
string
The resolved platform address used to deliver the message (e.g. phone number or email address).
results.conversation.lastMessage.recipients.platformAddressSelector
string
An expression that defines how we resolve the platform address from a contact. Optional override for the default resolution logic.
results.conversation.lastMessage.recipients.receiverExpression
string
results.conversation.lastMessage.recipients.receiverValue
string
results.conversation.lastMessage.recipients.type
string
The type of the receiver (e.g. to, cc, bcc for email).
results.conversation.lastMessage.sender
object
Afficher les attributs enfants
results.conversation.lastMessage.sender.email
string
results.conversation.lastMessage.sender.name
string
results.conversation.lastMessage.sender.avatarUrl
string
results.conversation.lastMessage.sender.contact
object
Afficher les attributs enfants
results.conversation.lastMessage.sender.contact.identifierKey
string
obligatoire
results.conversation.lastMessage.sender.contact.identifierValue
string
obligatoire
results.conversation.lastMessage.sender.contact.platformAddress
string
results.conversation.lastMessage.sender.contact.platformAddressSelector
string
results.conversation.lastMessage.sender.conversationId
string
results.conversation.lastMessage.sender.createdAt
string
results.conversation.lastMessage.sender.displayName
string
results.conversation.lastMessage.sender.id
string
obligatoire
results.conversation.lastMessage.sender.resourceUri
string
results.conversation.lastMessage.sender.status
string
Possible values: invited, pending, active, inactive
results.conversation.lastMessage.sender.type
string
obligatoire
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
results.conversation.lastMessage.sender.updatedAt
string
results.conversation.lastMessage.status
string
obligatoire
Possible values: accepted, processing, sent, sending_failed, delivered, delivery_failed, deleted
results.conversation.lastMessage.type
string
obligatoire
Possible values: text, html, image, file, gif, location, carousel, list, section, authentication, action, comment
results.conversation.lastMessageIncomingAt
string
results.conversation.lastMessageOutgoingAt
string
results.conversation.name
string
obligatoire
results.conversation.participants
array of object
Afficher les attributs enfants
results.conversation.participants.contact
object
Afficher les attributs enfants
results.conversation.participants.contact.identifierKey
string
obligatoire
results.conversation.participants.contact.identifierValue
string
obligatoire
results.conversation.participants.contact.platformAddress
string
results.conversation.participants.contact.platformAddressSelector
string
results.conversation.participants.id
string
obligatoire
results.conversation.participants.type
string
obligatoire
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
results.conversation.pendingParticipantCount
integer
results.conversation.platformStyle
string
obligatoire
Possible values: direct, email, direct-multiple, direct-threaded, group-multiple
results.conversation.privateAttributes
string
results.conversation.read
boolean
results.conversation.referral
object
Afficher les attributs enfants
results.conversation.referral.caption
string
results.conversation.referral.mediaType
string
results.conversation.referral.mediaUrl
string
results.conversation.referral.sourceId
string
obligatoire
results.conversation.referral.sourceType
string
results.conversation.referral.sourceUrl
string
results.conversation.referral.text
string
results.conversation.referral.timestamp
string
results.conversation.referral.title
string
results.conversation.referral.username
string
results.conversation.resource
object
Afficher les attributs enfants
results.conversation.resource.id
string
obligatoire
results.conversation.resource.type
string
obligatoire
Possible values: task, task-conversation, reimbursement, sales-lead, sales-opportunity, sales-account, expense, project
results.conversation.resourceUri
string
results.conversation.starred
boolean
results.conversation.status
string
obligatoire
Possible values: deleted, active, closed, spam, archived
results.conversation.style
string
obligatoire
Possible values: default, directMessage, chatChannel, personalInbox, resource, groupInbox, support
results.conversation.summary
string
results.conversation.tags
array of string
results.conversation.updatedAt
string
obligatoire
results.conversation.visibility
string
obligatoire
Possible values: public, private, direct, group
results.conference
object
Afficher les attributs enfants
results.task
object
results.slaPolicy
object
Afficher les attributs enfants
results.slaPolicy.policyId
string
obligatoire
results.slaPolicy.timers
array of object
obligatoire
Afficher les attributs enfants
results.slaPolicy.timers.expiresAt
string
results.slaPolicy.timers.metric
string
obligatoire
Possible values: firstReplyTime, nextReplyTime
results.slaPolicy.timers.severity
string
obligatoire
Possible values: breach, warning
results.slaPolicy.timers.status
string
obligatoire
Possible values: inactive, active, completed, expired
results.requiredSkills
array of object
Afficher les attributs enfants
results.requiredSkills.id
string
obligatoire
results.requiredSkills.name
string
obligatoire
results.requiredSkills.selectedValues
array of object
obligatoire
Afficher les attributs enfants
results.requiredSkills.selectedValues.icon
string
results.requiredSkills.selectedValues.id
string
obligatoire
results.requiredSkills.selectedValues.value
string
obligatoire
results.requiredSkills.valueType
string
obligatoire
AgentSkillValueType defines how can the Values of a Skill can be selected.
Possible values: single, multiple, boolean
results.status
string
The slug that identifies the status of the root item.
results.statusCategory
string
The category maps to the lifecycle of a root item in the system.
Possible values: new, inProgress, pending, closed
total
integer
The total number of results across all pages.
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.
Exemple de code
curl -X POST 'https://api.bird.com/workspaces/{workspaceId}/search/feed-items' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
GET
/workspaces/{workspaceId}/search/feed-items
Retrieve a list of feed items based on the specified parameters.
Paramètres de requête
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.
countOnly
boolean
Return only the count of the results, not the results themselves
sort
string
The results can optionally be sorted by one of these fields.
Possible values: createdAt, lastActivity, lastMessageByContact, slaExpires
indexType
string
The type of feed.
Possible values: channel, participant, team, agent, custom, view, privateview, task
indexId
string
The id for indexType.
itemIds
array
Filter by specific root item IDs (conversation IDs or conference IDs, or a combination of both).
itemType
string
The feed item type.
Possible values: conversation, conference, task
itemTypes
array
The feed item type.
ticketNumbers
array
Filter by specific ticket number.
unassigned
boolean
Search for feed items that have no agent assigned.
agentIds
array
The id of the agent(s) assigned to this item.
teamIds
array
The id of the team(s) assigned to this item.
closed
boolean
Whether to include closed feed items or not. All items are included by default
seen
boolean
Whether to include seen feed items or not. All items are included by default
archived
boolean
Whether to include archived feed items or not. All items are included by default
tagIds
array
Search for feed items containing these tags.
conversationIds
array
Filter items for a specific conversation(s).
conversationName
string
Filter items for a specific conversation name containing the term.
conversationChannelIds
array
Filter items for a specific conversation channel(s).
conversationStatuses
array
Filter items with a specific conversation status(es).
conferenceStatuses
array
Filter items with a specific conference status(es).
conferenceTypes
array
Filter items with a specific conference type.
conversationFeaturedParticipantIds
array
Participant IDs for conversation feed items.
conversationParticipantTypes
array
The types of participants in a conversation. It can be used for example to find out if there was any agent interaction in the conversation. This filter additionally filters out non-conversation feed items.
conversationExcludeParticipantTypes
array
If specified, matched conversations will not contain participants of these types. It can be used for example to find out if there was NO agent interaction in the conversation.
conversationLastMessageSenderParticipantTypes
string
The participant type that sent the last message in this feed item. It can match any of the specified types. This filter additionally filters out non-conversation feed items.
Possible values: user, contact, agent, flow, channel, connector
conferenceId
string
itemStatuses
array
Filter items with a specific status(es).
dateFrom
string
Find messages created after this date.
dateTo
string
Find messages created before this date.
searchTerm
string
If specified, matched conversations will contain one of the search terms in one of its fields. searchTerm will be split into individual terms, and filter items accordingly. This can be used, for example, to find items with specific conversationName and ticketNumbers. If specified between quotes, matched conversations will contain the whole phrase on conversationName or in the conversation body.
slaPolicyId
string
Find messages with the SLA policy attached.
hasSlaPolicy
boolean
Find messages that have a SLA policy attached.
slaPolicyStatus
string
Find messages with an SLA policy matching the given status.
Possible values: ok, needsAttention, breached
slaMetric
string
Find messages with an active SLA timer for this metric.
Possible values: firstReplyTime, nextReplyTime
slaStatus
string
Find message with a SLA timer with this status.
Possible values: active, expired
slaExpiresBefore
string
Find message where the next SLA breach is before this date.
slaExpiresAfter
string
Find message where the next SLA breach is after this date.
Corps de la réponse
results
array of object
Afficher les attributs enfants
results.id
string
obligatoire
results.feedId
string
results.feedIndexId
string
results.feedIndexType
string
results.agent
object
Afficher les attributs enfants
results.agent.id
string
obligatoire
results.agent.name
string
obligatoire
results.agent.avatarUrl
string
results.team
object
Afficher les attributs enfants
results.team.id
string
obligatoire
results.team.name
string
obligatoire
results.team.avatarUrl
string
results.number
integer
results.type
string
obligatoire
Possible values: conversation, conference, task
results.archived
boolean
obligatoire
results.closed
boolean
obligatoire
results.private
boolean
results.deleted
boolean
results.spam
boolean
results.senderBlocked
boolean
results.seen
boolean
results.seenBy
string
results.replySuggestion
string
results.createdAt
string
obligatoire
results.willBeDeletedAt
string
results.lastActivityAt
string
obligatoire
results.lastMessageByContactAt
string
results.tags
array of object
Afficher les attributs enfants
results.tags.id
string
obligatoire
results.tags.name
string
obligatoire
results.tags.status
string
obligatoire
Possible values: draft, active, deleted
results.tags.addedAt
string
obligatoire
results.tags.category
object
Afficher les attributs enfants
results.tags.category.id
string
results.tags.category.name
string
results.tags.category.emoji
string
results.attributes
array of object
Afficher les attributs enfants
results.attributes.key
string
results.attributes.value
string
results.customAttributes
object
Use dynamicFields instead.
results.filters
array of array of object
Afficher les attributs enfants
results.filters.key
string
results.filters.value
string
results.linkedItems
array of object
Afficher les attributs enfants
results.linkedItems.userId
string
The id of the user that set up this relation.
results.linkedItems.relation
string
Possible values: linkedTo, parentOf, childOf, parentOfTask, taskChildOf
results.linkedItems.itemId
string
The id of the linked item.
results.linkedItems.itemNumber
integer
results.linkedItems.itemSubject
string
results.linkedItems.createdAt
string
results.mergeInfo
object
Afficher les attributs enfants
results.mergeInfo.mergedFrom
array of object
Afficher les attributs enfants
results.mergeInfo.mergedFrom.userId
string
obligatoire
results.mergeInfo.mergedFrom.itemId
string
obligatoire
results.mergeInfo.mergedFrom.createdAt
string
obligatoire
results.mergeInfo.mergedInto
object
Afficher les attributs enfants
results.mergeInfo.mergedInto.userId
string
obligatoire
results.mergeInfo.mergedInto.itemId
string
obligatoire
results.mergeInfo.mergedInto.createdAt
string
obligatoire
results.dynamicFields
object
Afficher les attributs enfants
results.dynamicFields.settingsId
string
obligatoire
Either the uuid settings id, or "default" to use the default settings.
results.dynamicFields.fields
array of object
obligatoire
Afficher les attributs enfants
results.dynamicFields.fields.id
string
results.dynamicFields.fields.name
string
obligatoire
results.dynamicFields.fields.description
string
results.dynamicFields.fields.type
string
obligatoire
Possible values: single, multiple, numeric, text, boolean, date
results.dynamicFields.fields.values
array of object
Afficher les attributs enfants
results.dynamicFields.fields.values.id
string
obligatoire
results.dynamicFields.fields.values.value
string
obligatoire
results.dynamicFields.fields.values.icon
string
results.dynamicFields.fields.values.createdAt
string
obligatoire
results.dynamicFields.fields.values.selected
boolean
obligatoire
results.dynamicFields.fields.valueText
string
results.dynamicFields.fields.valueNumber
number
results.dynamicFields.fields.valueBoolean
boolean
results.dynamicFields.fields.valueDate
string
results.dynamicFields.fields.settings
object
results.summaryForm
object
Afficher les attributs enfants
results.summaryForm.settingsId
string
obligatoire
Either the uuid settings id, or "default" to use the default settings.
results.summaryForm.fields
array of object
obligatoire
Afficher les attributs enfants
results.summaryForm.fields.id
string
results.summaryForm.fields.name
string
obligatoire
results.summaryForm.fields.description
string
results.summaryForm.fields.type
string
obligatoire
Possible values: single, multiple, numeric, text, boolean, date
results.summaryForm.fields.values
array of object
Afficher les attributs enfants
results.summaryForm.fields.values.id
string
obligatoire
results.summaryForm.fields.values.value
string
obligatoire
results.summaryForm.fields.values.icon
string
results.summaryForm.fields.values.createdAt
string
obligatoire
results.summaryForm.fields.values.selected
boolean
obligatoire
results.summaryForm.fields.valueText
string
results.summaryForm.fields.valueNumber
number
results.summaryForm.fields.valueBoolean
boolean
results.summaryForm.fields.valueDate
string
results.summaryForm.fields.settings
object
results.queueInfo
object
Afficher les attributs enfants
results.queueInfo.queueId
string
obligatoire
results.queueInfo.queueName
string
obligatoire
results.queueInfo.queuedAt
string
obligatoire
results.conversation
object
Afficher les attributs enfants
results.conversation.accessibility
string
obligatoire
Possible values: open, invite-only, request-to-join, private
results.conversation.activeParticipantCount
integer
obligatoire
results.conversation.assigneeId
string
results.conversation.attributes
object
results.conversation.category
string
results.conversation.channelId
string
obligatoire
results.conversation.createdAt
string
obligatoire
results.conversation.description
string
results.conversation.directory
string
results.conversation.featuredParticipants
array of object
obligatoire
Afficher les attributs enfants
results.conversation.featuredParticipants.avatarUrl
string
results.conversation.featuredParticipants.contact
object
Afficher les attributs enfants
results.conversation.featuredParticipants.contact.identifierKey
string
obligatoire
results.conversation.featuredParticipants.contact.identifierValue
string
obligatoire
results.conversation.featuredParticipants.contact.platformAddress
string
results.conversation.featuredParticipants.contact.platformAddressSelector
string
results.conversation.featuredParticipants.conversationId
string
results.conversation.featuredParticipants.createdAt
string
results.conversation.featuredParticipants.displayName
string
results.conversation.featuredParticipants.id
string
obligatoire
results.conversation.featuredParticipants.resourceUri
string
results.conversation.featuredParticipants.status
string
Possible values: invited, pending, active, inactive
results.conversation.featuredParticipants.type
string
obligatoire
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
results.conversation.featuredParticipants.updatedAt
string
results.conversation.hasDraft
boolean
results.conversation.id
string
obligatoire
results.conversation.inbox
object
Afficher les attributs enfants
results.conversation.inbox.id
string
obligatoire
results.conversation.inbox.identifier
string
obligatoire
results.conversation.inbox.ownerId
string
obligatoire
results.conversation.inbox.ownerType
string
obligatoire
Possible values: user, group
results.conversation.inbox.type
string
obligatoire
Possible values: personal, shared, support
results.conversation.initiatingParticipant
object
Afficher les attributs enfants
results.conversation.initiatingParticipant.avatarUrl
string
results.conversation.initiatingParticipant.contact
object
Afficher les attributs enfants
results.conversation.initiatingParticipant.contact.identifierKey
string
obligatoire
results.conversation.initiatingParticipant.contact.identifierValue
string
obligatoire
results.conversation.initiatingParticipant.contact.platformAddress
string
results.conversation.initiatingParticipant.contact.platformAddressSelector
string
results.conversation.initiatingParticipant.conversationId
string
results.conversation.initiatingParticipant.createdAt
string
results.conversation.initiatingParticipant.displayName
string
results.conversation.initiatingParticipant.id
string
obligatoire
results.conversation.initiatingParticipant.resourceUri
string
results.conversation.initiatingParticipant.status
string
Possible values: invited, pending, active, inactive
results.conversation.initiatingParticipant.type
string
obligatoire
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
results.conversation.initiatingParticipant.updatedAt
string
results.conversation.lastMessage
object
Afficher les attributs enfants
results.conversation.lastMessage.createdAt
string
obligatoire
results.conversation.lastMessage.draft
boolean
obligatoire
results.conversation.lastMessage.id
string
obligatoire
results.conversation.lastMessage.preview
object
obligatoire
Afficher les attributs enfants
results.conversation.lastMessage.preview.text
string
results.conversation.lastMessage.recipients
array of object
Afficher les attributs enfants
results.conversation.lastMessage.recipients.contactAnnotation
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Afficher les attributs enfants
results.conversation.lastMessage.recipients.contactAnnotation.name
string
results.conversation.lastMessage.recipients.countryCode
string
results.conversation.lastMessage.recipients.id
string
The ID of the contact.
results.conversation.lastMessage.recipients.identifierKey
string
The identifier key for finding the contact (e.g. emailaddress, phonenumber). For WhatsApp channels with BSUID support, use whatsappbsuid to send to a contact by their Business-Scoped User ID.
results.conversation.lastMessage.recipients.identifierValue
string
The identifier value for finding the contact.
results.conversation.lastMessage.recipients.identifiers
array of object
Additional identifiers to augment the contact during resolution.
Afficher les attributs enfants
results.conversation.lastMessage.recipients.identifiers.identifierKey
string
obligatoire
The identifier key for finding the contact (e.g. emailaddress, phonenumber).
results.conversation.lastMessage.recipients.identifiers.identifierValue
string
obligatoire
The identifier value for finding the contact.
results.conversation.lastMessage.recipients.platformAddress
string
The resolved platform address used to deliver the message (e.g. phone number or email address).
results.conversation.lastMessage.recipients.platformAddressSelector
string
An expression that defines how we resolve the platform address from a contact. Optional override for the default resolution logic.
results.conversation.lastMessage.recipients.receiverExpression
string
results.conversation.lastMessage.recipients.receiverValue
string
results.conversation.lastMessage.recipients.type
string
The type of the receiver (e.g. to, cc, bcc for email).
results.conversation.lastMessage.sender
object
Afficher les attributs enfants
results.conversation.lastMessage.sender.email
string
results.conversation.lastMessage.sender.name
string
results.conversation.lastMessage.sender.avatarUrl
string
results.conversation.lastMessage.sender.contact
object
Afficher les attributs enfants
results.conversation.lastMessage.sender.contact.identifierKey
string
obligatoire
results.conversation.lastMessage.sender.contact.identifierValue
string
obligatoire
results.conversation.lastMessage.sender.contact.platformAddress
string
results.conversation.lastMessage.sender.contact.platformAddressSelector
string
results.conversation.lastMessage.sender.conversationId
string
results.conversation.lastMessage.sender.createdAt
string
results.conversation.lastMessage.sender.displayName
string
results.conversation.lastMessage.sender.id
string
obligatoire
results.conversation.lastMessage.sender.resourceUri
string
results.conversation.lastMessage.sender.status
string
Possible values: invited, pending, active, inactive
results.conversation.lastMessage.sender.type
string
obligatoire
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
results.conversation.lastMessage.sender.updatedAt
string
results.conversation.lastMessage.status
string
obligatoire
Possible values: accepted, processing, sent, sending_failed, delivered, delivery_failed, deleted
results.conversation.lastMessage.type
string
obligatoire
Possible values: text, html, image, file, gif, location, carousel, list, section, authentication, action, comment
results.conversation.lastMessageIncomingAt
string
results.conversation.lastMessageOutgoingAt
string
results.conversation.name
string
obligatoire
results.conversation.participants
array of object
Afficher les attributs enfants
results.conversation.participants.contact
object
Afficher les attributs enfants
results.conversation.participants.contact.identifierKey
string
obligatoire
results.conversation.participants.contact.identifierValue
string
obligatoire
results.conversation.participants.contact.platformAddress
string
results.conversation.participants.contact.platformAddressSelector
string
results.conversation.participants.id
string
obligatoire
results.conversation.participants.type
string
obligatoire
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
results.conversation.pendingParticipantCount
integer
results.conversation.platformStyle
string
obligatoire
Possible values: direct, email, direct-multiple, direct-threaded, group-multiple
results.conversation.privateAttributes
string
results.conversation.read
boolean
results.conversation.referral
object
Afficher les attributs enfants
results.conversation.referral.caption
string
results.conversation.referral.mediaType
string
results.conversation.referral.mediaUrl
string
results.conversation.referral.sourceId
string
obligatoire
results.conversation.referral.sourceType
string
results.conversation.referral.sourceUrl
string
results.conversation.referral.text
string
results.conversation.referral.timestamp
string
results.conversation.referral.title
string
results.conversation.referral.username
string
results.conversation.resource
object
Afficher les attributs enfants
results.conversation.resource.id
string
obligatoire
results.conversation.resource.type
string
obligatoire
Possible values: task, task-conversation, reimbursement, sales-lead, sales-opportunity, sales-account, expense, project
results.conversation.resourceUri
string
results.conversation.starred
boolean
results.conversation.status
string
obligatoire
Possible values: deleted, active, closed, spam, archived
results.conversation.style
string
obligatoire
Possible values: default, directMessage, chatChannel, personalInbox, resource, groupInbox, support
results.conversation.summary
string
results.conversation.tags
array of string
results.conversation.updatedAt
string
obligatoire
results.conversation.visibility
string
obligatoire
Possible values: public, private, direct, group
results.conference
object
Afficher les attributs enfants
results.task
object
results.slaPolicy
object
Afficher les attributs enfants
results.slaPolicy.policyId
string
obligatoire
results.slaPolicy.timers
array of object
obligatoire
Afficher les attributs enfants
results.slaPolicy.timers.expiresAt
string
results.slaPolicy.timers.metric
string
obligatoire
Possible values: firstReplyTime, nextReplyTime
results.slaPolicy.timers.severity
string
obligatoire
Possible values: breach, warning
results.slaPolicy.timers.status
string
obligatoire
Possible values: inactive, active, completed, expired
results.requiredSkills
array of object
Afficher les attributs enfants
results.requiredSkills.id
string
obligatoire
results.requiredSkills.name
string
obligatoire
results.requiredSkills.selectedValues
array of object
obligatoire
Afficher les attributs enfants
results.requiredSkills.selectedValues.icon
string
results.requiredSkills.selectedValues.id
string
obligatoire
results.requiredSkills.selectedValues.value
string
obligatoire
results.requiredSkills.valueType
string
obligatoire
AgentSkillValueType defines how can the Values of a Skill can be selected.
Possible values: single, multiple, boolean
results.status
string
The slug that identifies the status of the root item.
results.statusCategory
string
The category maps to the lifecycle of a root item in the system.
Possible values: new, inProgress, pending, closed
total
integer
The total number of results across all pages.
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.
Exemple de code
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/search/feed-items' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
GET
/workspaces/{workspaceId}/feeds/{feedId}
Retrieve the feed for a specific channel, participant, or team, containing updates, and interactions.
Corps de la réponse
id
string
obligatoire
indexType
string
obligatoire
indexId
string
obligatoire
name
string
obligatoire
emoji
string
query
object
Afficher les attributs enfants
query.conversationIds
array of string
query.sort
string
Possible values: createdAt, lastActivity, lastMessageByContact, slaExpires
query.countOnly
boolean
Return only the count of the results, not the results themselves
query.indexType
string
Possible values: channel, participant, team, agent, custom, task
query.indexId
string
query.itemIds
array of string
query.ticketNumbers
array of number
query.itemType
string
Possible values: conversation, conference, task
query.itemTypes
array of string
query.unassigned
boolean
Search for feed items that have no agent assigned.
query.agentIds
array of string
query.teamIds
array of string
query.closed
boolean
query.archived
boolean
query.replyStatus
string
Possible values: noFollowUp, noCustomerReply, noAgentReply
query.seen
boolean
query.tagIds
array of string
query.conversationName
string
query.conversationChannelIds
array of string
query.conversationStatuses
array of string
query.conferenceStatuses
array of string
query.conversationFeaturedParticipantIds
array of string
query.participants
object
Afficher les attributs enfants
query.participants.contacts
array of string
query.participants.agents
array of string
query.conversationParticipantTypes
array of string
query.conversationExcludeParticipantTypes
array of string
query.conversationLastMessageSenderParticipantTypes
array of string
query.fromContact
object
Afficher les attributs enfants
query.fromContact.id
string
obligatoire
query.dynamicFields
object
Afficher les attributs enfants
query.dynamicFields.settingsId
string
Optional. Either the uuid settings id, or "default" to use the default settings.
If not specified, it will validate form input against the last saved form.
query.dynamicFields.fields
array of object
Afficher les attributs enfants
query.dynamicFields.fields.id
string
query.dynamicFields.fields.selectedValueIds
array of string
query.dynamicFields.fields.valueText
string
query.dynamicFields.fields.valueNumber
number
query.dynamicFields.fields.valueBoolean
boolean
query.dynamicFields.fields.valueDate
string
The date value to set or search for.
query.dynamicFields.fields.valueDateBefore
string
The date value to set or search for.
query.dynamicFields.fields.valueDateAfter
string
The date value to set or search for.
query.conferenceId
string
query.itemStatuses
array of string
query.dateFrom
string
query.dateTo
string
query.searchTerm
string
query.slaPolicyId
string
query.hasSlaPolicy
boolean
query.slaPolicyStatus
string
Reflects the overall state of the SLA policy on a ticket.
  • ok: all metrics are green.
  • needsAttention: one or more metrics are in a warning state.
  • breached: one or more metrics are in a breached state.
Possible values: ok, needsAttention, breached
query.slaMetric
string
Possible values: firstReplyTime, nextReplyTime
query.slaStatus
string
Possible values: active, expired
query.slaExpiresBefore
string
query.slaExpiresAfter
string
query.query
object
Afficher les attributs enfants
query.query.operator
string
Possible values: and, or, not
query.query.children
array of object
Afficher les attributs enfants
query.query.children.operator
string
Possible values: and, or, not
query.query.children.children
array of object
query.query.children.attributeName
string
query.query.children.value
string or array of string
Afficher les attributs enfants
ISO 8601 (RFC3339) date-time format, should contain timezone. UTC example: "2021-01-02T09:22:12.012Z". UTC+1 Example: "2021-01-01T09:22:12.012+01:00" There is one exception:
  • "date/is-on" operator should be formatted as YYYY-MM-DD e.g. "2021-12-31";
query.query.attributeName
string
query.query.value
string or array of string
Afficher les attributs enfants
ISO 8601 (RFC3339) date-time format, should contain timezone. UTC example: "2021-01-02T09:22:12.012Z". UTC+1 Example: "2021-01-01T09:22:12.012+01:00" There is one exception:
  • "date/is-on" operator should be formatted as YYYY-MM-DD e.g. "2021-12-31";
query.spam
boolean
If true, only return spam. Otherwise, only non-spam.
itemListOptions
object
Afficher les attributs enfants
itemListOptions.sort
string
obligatoire
Possible values: createdAt, lastActivity, lastMessageByContact, slaExpires
itemListOptions.reverse
boolean
obligatoire
itemListOptions.columns
array of string
obligatoire
A list of columns to display for each feed item.
accessEntities
array of object
Afficher les attributs enfants
accessEntities.entityId
string
obligatoire
accessEntities.entityType
string
obligatoire
Possible values: inbox-team, inbox-agent, managed-role, organization-role
itemCount
integer
obligatoire
unseenCount
integer
Exemple de code
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/feeds/{feedId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
PATCH
/workspaces/{workspaceId}/feeds/{feedId}
Perform an update on a given feed.
Corps de la requête
name
string
emoji
string
query
object
Afficher les paramètres enfants
query.conversationIds
array of string
query.sort
string
Possible values: createdAt, lastActivity, lastMessageByContact, slaExpires
query.countOnly
boolean
Return only the count of the results, not the results themselves
query.indexType
string
Possible values: channel, participant, team, agent, custom, task
query.indexId
string
query.itemIds
array of string
query.ticketNumbers
array of number
query.itemType
string
Possible values: conversation, conference, task
query.itemTypes
array of string
query.unassigned
boolean
Search for feed items that have no agent assigned.
query.agentIds
array of string
query.teamIds
array of string
query.closed
boolean
query.archived
boolean
query.replyStatus
string
Possible values: noFollowUp, noCustomerReply, noAgentReply
query.seen
boolean
query.tagIds
array of string
query.conversationName
string
query.conversationChannelIds
array of string
query.conversationStatuses
array of string
query.conferenceStatuses
array of string
query.conversationFeaturedParticipantIds
array of string
query.participants
object
Afficher les paramètres enfants
query.participants.contacts
array of string
query.participants.agents
array of string
query.conversationParticipantTypes
array of string
query.conversationExcludeParticipantTypes
array of string
query.conversationLastMessageSenderParticipantTypes
array of string
query.fromContact
object
Afficher les paramètres enfants
query.fromContact.id
string
obligatoire
query.dynamicFields
object
Afficher les paramètres enfants
query.dynamicFields.settingsId
string
Optional. Either the uuid settings id, or "default" to use the default settings.
If not specified, it will validate form input against the last saved form.
query.dynamicFields.fields
array of object
Afficher les paramètres enfants
query.dynamicFields.fields.id
string
query.dynamicFields.fields.selectedValueIds
array of string
query.dynamicFields.fields.valueText
string
query.dynamicFields.fields.valueNumber
number
query.dynamicFields.fields.valueBoolean
boolean
query.dynamicFields.fields.valueDate
string
The date value to set or search for.
query.dynamicFields.fields.valueDateBefore
string
The date value to set or search for.
query.dynamicFields.fields.valueDateAfter
string
The date value to set or search for.
query.conferenceId
string
query.itemStatuses
array of string
query.dateFrom
string
query.dateTo
string
query.searchTerm
string
query.slaPolicyId
string
query.hasSlaPolicy
boolean
query.slaPolicyStatus
string
Reflects the overall state of the SLA policy on a ticket.
  • ok: all metrics are green.
  • needsAttention: one or more metrics are in a warning state.
  • breached: one or more metrics are in a breached state.
Possible values: ok, needsAttention, breached
query.slaMetric
string
Possible values: firstReplyTime, nextReplyTime
query.slaStatus
string
Possible values: active, expired
query.slaExpiresBefore
string
query.slaExpiresAfter
string
query.query
object
Afficher les paramètres enfants
query.query.operator
string
Possible values: and, or, not
query.query.children
array of object
Afficher les paramètres enfants
query.query.children.operator
string
Possible values: and, or, not
query.query.children.children
array of object
query.query.children.attributeName
string
query.query.children.value
string or array of string
Afficher les paramètres enfants
ISO 8601 (RFC3339) date-time format, should contain timezone. UTC example: "2021-01-02T09:22:12.012Z". UTC+1 Example: "2021-01-01T09:22:12.012+01:00" There is one exception:
  • "date/is-on" operator should be formatted as YYYY-MM-DD e.g. "2021-12-31";
query.query.attributeName
string
query.query.value
string or array of string
Afficher les paramètres enfants
ISO 8601 (RFC3339) date-time format, should contain timezone. UTC example: "2021-01-02T09:22:12.012Z". UTC+1 Example: "2021-01-01T09:22:12.012+01:00" There is one exception:
  • "date/is-on" operator should be formatted as YYYY-MM-DD e.g. "2021-12-31";
query.spam
boolean
If true, only return spam. Otherwise, only non-spam.
itemListOptions
object
Afficher les paramètres enfants
itemListOptions.sort
string
obligatoire
Possible values: createdAt, lastActivity, lastMessageByContact, slaExpires
itemListOptions.reverse
boolean
obligatoire
itemListOptions.columns
array of string
obligatoire
A list of columns to display for each feed item.
accessEntities
array of object
Afficher les paramètres enfants
accessEntities.entityId
string
obligatoire
accessEntities.entityType
string
obligatoire
Possible values: inbox-team, inbox-agent, managed-role, organization-role
Corps de la réponse
id
string
obligatoire
indexType
string
obligatoire
indexId
string
obligatoire
name
string
obligatoire
emoji
string
query
object
Afficher les attributs enfants
query.conversationIds
array of string
query.sort
string
Possible values: createdAt, lastActivity, lastMessageByContact, slaExpires
query.countOnly
boolean
Return only the count of the results, not the results themselves
query.indexType
string
Possible values: channel, participant, team, agent, custom, task
query.indexId
string
query.itemIds
array of string
query.ticketNumbers
array of number
query.itemType
string
Possible values: conversation, conference, task
query.itemTypes
array of string
query.unassigned
boolean
Search for feed items that have no agent assigned.
query.agentIds
array of string
query.teamIds
array of string
query.closed
boolean
query.archived
boolean
query.replyStatus
string
Possible values: noFollowUp, noCustomerReply, noAgentReply
query.seen
boolean
query.tagIds
array of string
query.conversationName
string
query.conversationChannelIds
array of string
query.conversationStatuses
array of string
query.conferenceStatuses
array of string
query.conversationFeaturedParticipantIds
array of string
query.participants
object
Afficher les attributs enfants
query.participants.contacts
array of string
query.participants.agents
array of string
query.conversationParticipantTypes
array of string
query.conversationExcludeParticipantTypes
array of string
query.conversationLastMessageSenderParticipantTypes
array of string
query.fromContact
object
Afficher les attributs enfants
query.fromContact.id
string
obligatoire
query.dynamicFields
object
Afficher les attributs enfants
query.dynamicFields.settingsId
string
Optional. Either the uuid settings id, or "default" to use the default settings.
If not specified, it will validate form input against the last saved form.
query.dynamicFields.fields
array of object
Afficher les attributs enfants
query.dynamicFields.fields.id
string
query.dynamicFields.fields.selectedValueIds
array of string
query.dynamicFields.fields.valueText
string
query.dynamicFields.fields.valueNumber
number
query.dynamicFields.fields.valueBoolean
boolean
query.dynamicFields.fields.valueDate
string
The date value to set or search for.
query.dynamicFields.fields.valueDateBefore
string
The date value to set or search for.
query.dynamicFields.fields.valueDateAfter
string
The date value to set or search for.
query.conferenceId
string
query.itemStatuses
array of string
query.dateFrom
string
query.dateTo
string
query.searchTerm
string
query.slaPolicyId
string
query.hasSlaPolicy
boolean
query.slaPolicyStatus
string
Reflects the overall state of the SLA policy on a ticket.
  • ok: all metrics are green.
  • needsAttention: one or more metrics are in a warning state.
  • breached: one or more metrics are in a breached state.
Possible values: ok, needsAttention, breached
query.slaMetric
string
Possible values: firstReplyTime, nextReplyTime
query.slaStatus
string
Possible values: active, expired
query.slaExpiresBefore
string
query.slaExpiresAfter
string
query.query
object
Afficher les attributs enfants
query.query.operator
string
Possible values: and, or, not
query.query.children
array of object
Afficher les attributs enfants
query.query.children.operator
string
Possible values: and, or, not
query.query.children.children
array of object
query.query.children.attributeName
string
query.query.children.value
string or array of string
Afficher les attributs enfants
ISO 8601 (RFC3339) date-time format, should contain timezone. UTC example: "2021-01-02T09:22:12.012Z". UTC+1 Example: "2021-01-01T09:22:12.012+01:00" There is one exception:
  • "date/is-on" operator should be formatted as YYYY-MM-DD e.g. "2021-12-31";
query.query.attributeName
string
query.query.value
string or array of string
Afficher les attributs enfants
ISO 8601 (RFC3339) date-time format, should contain timezone. UTC example: "2021-01-02T09:22:12.012Z". UTC+1 Example: "2021-01-01T09:22:12.012+01:00" There is one exception:
  • "date/is-on" operator should be formatted as YYYY-MM-DD e.g. "2021-12-31";
query.spam
boolean
If true, only return spam. Otherwise, only non-spam.
itemListOptions
object
Afficher les attributs enfants
itemListOptions.sort
string
obligatoire
Possible values: createdAt, lastActivity, lastMessageByContact, slaExpires
itemListOptions.reverse
boolean
obligatoire
itemListOptions.columns
array of string
obligatoire
A list of columns to display for each feed item.
accessEntities
array of object
Afficher les attributs enfants
accessEntities.entityId
string
obligatoire
accessEntities.entityType
string
obligatoire
Possible values: inbox-team, inbox-agent, managed-role, organization-role
itemCount
integer
obligatoire
unseenCount
integer
Exemple de code
curl -X PATCH 'https://api.bird.com/workspaces/{workspaceId}/feeds/{feedId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
DELETE
/workspaces/{workspaceId}/feeds/{feedId}
Permanently delete a feed.
Exemple de code
curl -X DELETE 'https://api.bird.com/workspaces/{workspaceId}/feeds/{feedId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
GET
/workspaces/{workspaceId}/feeds/{feedId}/items
Obtain a list of items within the feed.
Paramètres de requête
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.
sortBy
string
Sort applied to the list
Possible values: lastActivity, lastMessageByContact, createdAt, slaExpires
ticketNumbers
array
Filter by specific ticket number.
unassigned
boolean
Search for feed items that have no agent assigned.
agentIds
array
The id of the agent(s) assigned to this item.
teamIds
array
The id of the team(s) assigned to this item.
closed
boolean
Whether to include closed feed items or not. All items are included by default
seen
boolean
Whether to include seen feed items or not. All items are included by default
archived
boolean
Whether to include archived feed items or not. All items are included by default
tagIds
array
Search for feed items containing these tags.
conversationIds
array
Filter items for a specific conversation(s).
conversationChannelIds
array
Filter items for a specific conversation channel(s).
conversationName
string
Filter items for a specific conversation name containing the term.
conversationStatuses
array
Filter items with a specific conversation status(es).
conferenceStatuses
array
Filter items with a specific conference status(es).
conferenceTypes
array
Filter items with a specific conference type.
conversationFeaturedParticipantIds
array
Participant IDs for conversation feed items.
conversationParticipantTypes
array
The types of participants in a conversation. It can be used for example to find out if there was any agent interaction in the conversation. This filter additionally filters out non-conversation feed items.
conversationExcludeParticipantTypes
array
If specified, matched conversations will not contain participants of these types. It can be used for example to find out if there was NO agent interaction in the conversation.
conversationLastMessageSenderParticipantTypes
string
The participant type that sent the last message in this feed item. It can match any of the specified types. This filter additionally filters out non-conversation feed items.
Possible values: user, contact, agent, flow, channel, connector
itemStatuses
array
Filter items with a specific status(es).
Corps de la réponse
results
array of object
Afficher les attributs enfants
results.id
string
obligatoire
results.feedId
string
results.feedIndexId
string
results.feedIndexType
string
results.agent
object
Afficher les attributs enfants
results.agent.id
string
obligatoire
results.agent.name
string
obligatoire
results.agent.avatarUrl
string
results.team
object
Afficher les attributs enfants
results.team.id
string
obligatoire
results.team.name
string
obligatoire
results.team.avatarUrl
string
results.number
integer
results.type
string
obligatoire
Possible values: conversation, conference, task
results.archived
boolean
obligatoire
results.closed
boolean
obligatoire
results.private
boolean
results.deleted
boolean
results.spam
boolean
results.senderBlocked
boolean
results.seen
boolean
results.seenBy
string
results.replySuggestion
string
results.createdAt
string
obligatoire
results.willBeDeletedAt
string
results.lastActivityAt
string
obligatoire
results.lastMessageByContactAt
string
results.tags
array of object
Afficher les attributs enfants
results.tags.id
string
obligatoire
results.tags.name
string
obligatoire
results.tags.status
string
obligatoire
Possible values: draft, active, deleted
results.tags.addedAt
string
obligatoire
results.tags.category
object
Afficher les attributs enfants
results.tags.category.id
string
results.tags.category.name
string
results.tags.category.emoji
string
results.attributes
array of object
Afficher les attributs enfants
results.attributes.key
string
results.attributes.value
string
results.customAttributes
object
Use dynamicFields instead.
results.filters
array of array of object
Afficher les attributs enfants
results.filters.key
string
results.filters.value
string
results.linkedItems
array of object
Afficher les attributs enfants
results.linkedItems.userId
string
The id of the user that set up this relation.
results.linkedItems.relation
string
Possible values: linkedTo, parentOf, childOf, parentOfTask, taskChildOf
results.linkedItems.itemId
string
The id of the linked item.
results.linkedItems.itemNumber
integer
results.linkedItems.itemSubject
string
results.linkedItems.createdAt
string
results.mergeInfo
object
Afficher les attributs enfants
results.mergeInfo.mergedFrom
array of object
Afficher les attributs enfants
results.mergeInfo.mergedFrom.userId
string
obligatoire
results.mergeInfo.mergedFrom.itemId
string
obligatoire
results.mergeInfo.mergedFrom.createdAt
string
obligatoire
results.mergeInfo.mergedInto
object
Afficher les attributs enfants
results.mergeInfo.mergedInto.userId
string
obligatoire
results.mergeInfo.mergedInto.itemId
string
obligatoire
results.mergeInfo.mergedInto.createdAt
string
obligatoire
results.dynamicFields
object
Afficher les attributs enfants
results.dynamicFields.settingsId
string
obligatoire
Either the uuid settings id, or "default" to use the default settings.
results.dynamicFields.fields
array of object
obligatoire
Afficher les attributs enfants
results.dynamicFields.fields.id
string
results.dynamicFields.fields.name
string
obligatoire
results.dynamicFields.fields.description
string
results.dynamicFields.fields.type
string
obligatoire
Possible values: single, multiple, numeric, text, boolean, date
results.dynamicFields.fields.values
array of object
Afficher les attributs enfants
results.dynamicFields.fields.values.id
string
obligatoire
results.dynamicFields.fields.values.value
string
obligatoire
results.dynamicFields.fields.values.icon
string
results.dynamicFields.fields.values.createdAt
string
obligatoire
results.dynamicFields.fields.values.selected
boolean
obligatoire
results.dynamicFields.fields.valueText
string
results.dynamicFields.fields.valueNumber
number
results.dynamicFields.fields.valueBoolean
boolean
results.dynamicFields.fields.valueDate
string
results.dynamicFields.fields.settings
object
results.summaryForm
object
Afficher les attributs enfants
results.summaryForm.settingsId
string
obligatoire
Either the uuid settings id, or "default" to use the default settings.
results.summaryForm.fields
array of object
obligatoire
Afficher les attributs enfants
results.summaryForm.fields.id
string
results.summaryForm.fields.name
string
obligatoire
results.summaryForm.fields.description
string
results.summaryForm.fields.type
string
obligatoire
Possible values: single, multiple, numeric, text, boolean, date
results.summaryForm.fields.values
array of object
Afficher les attributs enfants
results.summaryForm.fields.values.id
string
obligatoire
results.summaryForm.fields.values.value
string
obligatoire
results.summaryForm.fields.values.icon
string
results.summaryForm.fields.values.createdAt
string
obligatoire
results.summaryForm.fields.values.selected
boolean
obligatoire
results.summaryForm.fields.valueText
string
results.summaryForm.fields.valueNumber
number
results.summaryForm.fields.valueBoolean
boolean
results.summaryForm.fields.valueDate
string
results.summaryForm.fields.settings
object
results.queueInfo
object
Afficher les attributs enfants
results.queueInfo.queueId
string
obligatoire
results.queueInfo.queueName
string
obligatoire
results.queueInfo.queuedAt
string
obligatoire
results.conversation
object
Afficher les attributs enfants
results.conversation.accessibility
string
obligatoire
Possible values: open, invite-only, request-to-join, private
results.conversation.activeParticipantCount
integer
obligatoire
results.conversation.assigneeId
string
results.conversation.attributes
object
results.conversation.category
string
results.conversation.channelId
string
obligatoire
results.conversation.createdAt
string
obligatoire
results.conversation.description
string
results.conversation.directory
string
results.conversation.featuredParticipants
array of object
obligatoire
Afficher les attributs enfants
results.conversation.featuredParticipants.avatarUrl
string
results.conversation.featuredParticipants.contact
object
Afficher les attributs enfants
results.conversation.featuredParticipants.contact.identifierKey
string
obligatoire
results.conversation.featuredParticipants.contact.identifierValue
string
obligatoire
results.conversation.featuredParticipants.contact.platformAddress
string
results.conversation.featuredParticipants.contact.platformAddressSelector
string
results.conversation.featuredParticipants.conversationId
string
results.conversation.featuredParticipants.createdAt
string
results.conversation.featuredParticipants.displayName
string
results.conversation.featuredParticipants.id
string
obligatoire
results.conversation.featuredParticipants.resourceUri
string
results.conversation.featuredParticipants.status
string
Possible values: invited, pending, active, inactive
results.conversation.featuredParticipants.type
string
obligatoire
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
results.conversation.featuredParticipants.updatedAt
string
results.conversation.hasDraft
boolean
results.conversation.id
string
obligatoire
results.conversation.inbox
object
Afficher les attributs enfants
results.conversation.inbox.id
string
obligatoire
results.conversation.inbox.identifier
string
obligatoire
results.conversation.inbox.ownerId
string
obligatoire
results.conversation.inbox.ownerType
string
obligatoire
Possible values: user, group
results.conversation.inbox.type
string
obligatoire
Possible values: personal, shared, support
results.conversation.initiatingParticipant
object
Afficher les attributs enfants
results.conversation.initiatingParticipant.avatarUrl
string
results.conversation.initiatingParticipant.contact
object
Afficher les attributs enfants
results.conversation.initiatingParticipant.contact.identifierKey
string
obligatoire
results.conversation.initiatingParticipant.contact.identifierValue
string
obligatoire
results.conversation.initiatingParticipant.contact.platformAddress
string
results.conversation.initiatingParticipant.contact.platformAddressSelector
string
results.conversation.initiatingParticipant.conversationId
string
results.conversation.initiatingParticipant.createdAt
string
results.conversation.initiatingParticipant.displayName
string
results.conversation.initiatingParticipant.id
string
obligatoire
results.conversation.initiatingParticipant.resourceUri
string
results.conversation.initiatingParticipant.status
string
Possible values: invited, pending, active, inactive
results.conversation.initiatingParticipant.type
string
obligatoire
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
results.conversation.initiatingParticipant.updatedAt
string
results.conversation.lastMessage
object
Afficher les attributs enfants
results.conversation.lastMessage.createdAt
string
obligatoire
results.conversation.lastMessage.draft
boolean
obligatoire
results.conversation.lastMessage.id
string
obligatoire
results.conversation.lastMessage.preview
object
obligatoire
Afficher les attributs enfants
results.conversation.lastMessage.preview.text
string
results.conversation.lastMessage.recipients
array of object
Afficher les attributs enfants
results.conversation.lastMessage.recipients.contactAnnotation
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Afficher les attributs enfants
results.conversation.lastMessage.recipients.contactAnnotation.name
string
results.conversation.lastMessage.recipients.countryCode
string
results.conversation.lastMessage.recipients.id
string
The ID of the contact.
results.conversation.lastMessage.recipients.identifierKey
string
The identifier key for finding the contact (e.g. emailaddress, phonenumber). For WhatsApp channels with BSUID support, use whatsappbsuid to send to a contact by their Business-Scoped User ID.
results.conversation.lastMessage.recipients.identifierValue
string
The identifier value for finding the contact.
results.conversation.lastMessage.recipients.identifiers
array of object
Additional identifiers to augment the contact during resolution.
Afficher les attributs enfants
results.conversation.lastMessage.recipients.identifiers.identifierKey
string
obligatoire
The identifier key for finding the contact (e.g. emailaddress, phonenumber).
results.conversation.lastMessage.recipients.identifiers.identifierValue
string
obligatoire
The identifier value for finding the contact.
results.conversation.lastMessage.recipients.platformAddress
string
The resolved platform address used to deliver the message (e.g. phone number or email address).
results.conversation.lastMessage.recipients.platformAddressSelector
string
An expression that defines how we resolve the platform address from a contact. Optional override for the default resolution logic.
results.conversation.lastMessage.recipients.receiverExpression
string
results.conversation.lastMessage.recipients.receiverValue
string
results.conversation.lastMessage.recipients.type
string
The type of the receiver (e.g. to, cc, bcc for email).
results.conversation.lastMessage.sender
object
Afficher les attributs enfants
results.conversation.lastMessage.sender.email
string
results.conversation.lastMessage.sender.name
string
results.conversation.lastMessage.sender.avatarUrl
string
results.conversation.lastMessage.sender.contact
object
Afficher les attributs enfants
results.conversation.lastMessage.sender.contact.identifierKey
string
obligatoire
results.conversation.lastMessage.sender.contact.identifierValue
string
obligatoire
results.conversation.lastMessage.sender.contact.platformAddress
string
results.conversation.lastMessage.sender.contact.platformAddressSelector
string
results.conversation.lastMessage.sender.conversationId
string
results.conversation.lastMessage.sender.createdAt
string
results.conversation.lastMessage.sender.displayName
string
results.conversation.lastMessage.sender.id
string
obligatoire
results.conversation.lastMessage.sender.resourceUri
string
results.conversation.lastMessage.sender.status
string
Possible values: invited, pending, active, inactive
results.conversation.lastMessage.sender.type
string
obligatoire
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
results.conversation.lastMessage.sender.updatedAt
string
results.conversation.lastMessage.status
string
obligatoire
Possible values: accepted, processing, sent, sending_failed, delivered, delivery_failed, deleted
results.conversation.lastMessage.type
string
obligatoire
Possible values: text, html, image, file, gif, location, carousel, list, section, authentication, action, comment
results.conversation.lastMessageIncomingAt
string
results.conversation.lastMessageOutgoingAt
string
results.conversation.name
string
obligatoire
results.conversation.participants
array of object
Afficher les attributs enfants
results.conversation.participants.contact
object
Afficher les attributs enfants
results.conversation.participants.contact.identifierKey
string
obligatoire
results.conversation.participants.contact.identifierValue
string
obligatoire
results.conversation.participants.contact.platformAddress
string
results.conversation.participants.contact.platformAddressSelector
string
results.conversation.participants.id
string
obligatoire
results.conversation.participants.type
string
obligatoire
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
results.conversation.pendingParticipantCount
integer
results.conversation.platformStyle
string
obligatoire
Possible values: direct, email, direct-multiple, direct-threaded, group-multiple
results.conversation.privateAttributes
string
results.conversation.read
boolean
results.conversation.referral
object
Afficher les attributs enfants
results.conversation.referral.caption
string
results.conversation.referral.mediaType
string
results.conversation.referral.mediaUrl
string
results.conversation.referral.sourceId
string
obligatoire
results.conversation.referral.sourceType
string
results.conversation.referral.sourceUrl
string
results.conversation.referral.text
string
results.conversation.referral.timestamp
string
results.conversation.referral.title
string
results.conversation.referral.username
string
results.conversation.resource
object
Afficher les attributs enfants
results.conversation.resource.id
string
obligatoire
results.conversation.resource.type
string
obligatoire
Possible values: task, task-conversation, reimbursement, sales-lead, sales-opportunity, sales-account, expense, project
results.conversation.resourceUri
string
results.conversation.starred
boolean
results.conversation.status
string
obligatoire
Possible values: deleted, active, closed, spam, archived
results.conversation.style
string
obligatoire
Possible values: default, directMessage, chatChannel, personalInbox, resource, groupInbox, support
results.conversation.summary
string
results.conversation.tags
array of string
results.conversation.updatedAt
string
obligatoire
results.conversation.visibility
string
obligatoire
Possible values: public, private, direct, group
results.conference
object
Afficher les attributs enfants
results.task
object
results.slaPolicy
object
Afficher les attributs enfants
results.slaPolicy.policyId
string
obligatoire
results.slaPolicy.timers
array of object
obligatoire
Afficher les attributs enfants
results.slaPolicy.timers.expiresAt
string
results.slaPolicy.timers.metric
string
obligatoire
Possible values: firstReplyTime, nextReplyTime
results.slaPolicy.timers.severity
string
obligatoire
Possible values: breach, warning
results.slaPolicy.timers.status
string
obligatoire
Possible values: inactive, active, completed, expired
results.requiredSkills
array of object
Afficher les attributs enfants
results.requiredSkills.id
string
obligatoire
results.requiredSkills.name
string
obligatoire
results.requiredSkills.selectedValues
array of object
obligatoire
Afficher les attributs enfants
results.requiredSkills.selectedValues.icon
string
results.requiredSkills.selectedValues.id
string
obligatoire
results.requiredSkills.selectedValues.value
string
obligatoire
results.requiredSkills.valueType
string
obligatoire
AgentSkillValueType defines how can the Values of a Skill can be selected.
Possible values: single, multiple, boolean
results.status
string
The slug that identifies the status of the root item.
results.statusCategory
string
The category maps to the lifecycle of a root item in the system.
Possible values: new, inProgress, pending, closed
total
integer
The total number of results across all pages.
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.
Exemple de code
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/feeds/{feedId}/items' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
PATCH
/workspaces/{workspaceId}/feeds/{feedId}/items
Perform bulk updates on multiple items within a feed, modifying their content, status, or other attributes.
Corps de la requête
agentId
string
Exemple de code
curl -X PATCH 'https://api.bird.com/workspaces/{workspaceId}/feeds/{feedId}/items' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
GET
/workspaces/{workspaceId}/me/feeds/{alias}
Retrieve the feed for currently logged in agent.
Corps de la réponse
id
string
obligatoire
indexType
string
obligatoire
indexId
string
obligatoire
name
string
obligatoire
emoji
string
query
object
Afficher les attributs enfants
query.conversationIds
array of string
query.sort
string
Possible values: createdAt, lastActivity, lastMessageByContact, slaExpires
query.countOnly
boolean
Return only the count of the results, not the results themselves
query.indexType
string
Possible values: channel, participant, team, agent, custom, task
query.indexId
string
query.itemIds
array of string
query.ticketNumbers
array of number
query.itemType
string
Possible values: conversation, conference, task
query.itemTypes
array of string
query.unassigned
boolean
Search for feed items that have no agent assigned.
query.agentIds
array of string
query.teamIds
array of string
query.closed
boolean
query.archived
boolean
query.replyStatus
string
Possible values: noFollowUp, noCustomerReply, noAgentReply
query.seen
boolean
query.tagIds
array of string
query.conversationName
string
query.conversationChannelIds
array of string
query.conversationStatuses
array of string
query.conferenceStatuses
array of string
query.conversationFeaturedParticipantIds
array of string
query.participants
object
Afficher les attributs enfants
query.participants.contacts
array of string
query.participants.agents
array of string
query.conversationParticipantTypes
array of string
query.conversationExcludeParticipantTypes
array of string
query.conversationLastMessageSenderParticipantTypes
array of string
query.fromContact
object
Afficher les attributs enfants
query.fromContact.id
string
obligatoire
query.dynamicFields
object
Afficher les attributs enfants
query.dynamicFields.settingsId
string
Optional. Either the uuid settings id, or "default" to use the default settings.
If not specified, it will validate form input against the last saved form.
query.dynamicFields.fields
array of object
Afficher les attributs enfants
query.dynamicFields.fields.id
string
query.dynamicFields.fields.selectedValueIds
array of string
query.dynamicFields.fields.valueText
string
query.dynamicFields.fields.valueNumber
number
query.dynamicFields.fields.valueBoolean
boolean
query.dynamicFields.fields.valueDate
string
The date value to set or search for.
query.dynamicFields.fields.valueDateBefore
string
The date value to set or search for.
query.dynamicFields.fields.valueDateAfter
string
The date value to set or search for.
query.conferenceId
string
query.itemStatuses
array of string
query.dateFrom
string
query.dateTo
string
query.searchTerm
string
query.slaPolicyId
string
query.hasSlaPolicy
boolean
query.slaPolicyStatus
string
Reflects the overall state of the SLA policy on a ticket.
  • ok: all metrics are green.
  • needsAttention: one or more metrics are in a warning state.
  • breached: one or more metrics are in a breached state.
Possible values: ok, needsAttention, breached
query.slaMetric
string
Possible values: firstReplyTime, nextReplyTime
query.slaStatus
string
Possible values: active, expired
query.slaExpiresBefore
string
query.slaExpiresAfter
string
query.query
object
Afficher les attributs enfants
query.query.operator
string
Possible values: and, or, not
query.query.children
array of object
Afficher les attributs enfants
query.query.children.operator
string
Possible values: and, or, not
query.query.children.children
array of object
query.query.children.attributeName
string
query.query.children.value
string or array of string
Afficher les attributs enfants
ISO 8601 (RFC3339) date-time format, should contain timezone. UTC example: "2021-01-02T09:22:12.012Z". UTC+1 Example: "2021-01-01T09:22:12.012+01:00" There is one exception:
  • "date/is-on" operator should be formatted as YYYY-MM-DD e.g. "2021-12-31";
query.query.attributeName
string
query.query.value
string or array of string
Afficher les attributs enfants
ISO 8601 (RFC3339) date-time format, should contain timezone. UTC example: "2021-01-02T09:22:12.012Z". UTC+1 Example: "2021-01-01T09:22:12.012+01:00" There is one exception:
  • "date/is-on" operator should be formatted as YYYY-MM-DD e.g. "2021-12-31";
query.spam
boolean
If true, only return spam. Otherwise, only non-spam.
itemListOptions
object
Afficher les attributs enfants
itemListOptions.sort
string
obligatoire
Possible values: createdAt, lastActivity, lastMessageByContact, slaExpires
itemListOptions.reverse
boolean
obligatoire
itemListOptions.columns
array of string
obligatoire
A list of columns to display for each feed item.
accessEntities
array of object
Afficher les attributs enfants
accessEntities.entityId
string
obligatoire
accessEntities.entityType
string
obligatoire
Possible values: inbox-team, inbox-agent, managed-role, organization-role
itemCount
integer
obligatoire
unseenCount
integer
Exemple de code
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/me/feeds/{alias}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
GET
/workspaces/{workspaceId}/me/feeds/{alias}/items
Obtain a list of items within the feed of currently logged in agent.
Corps de la réponse
results
array of object
Afficher les attributs enfants
results.id
string
obligatoire
results.feedId
string
results.feedIndexId
string
results.feedIndexType
string
results.agent
object
Afficher les attributs enfants
results.agent.id
string
obligatoire
results.agent.name
string
obligatoire
results.agent.avatarUrl
string
results.team
object
Afficher les attributs enfants
results.team.id
string
obligatoire
results.team.name
string
obligatoire
results.team.avatarUrl
string
results.number
integer
results.type
string
obligatoire
Possible values: conversation, conference, task
results.archived
boolean
obligatoire
results.closed
boolean
obligatoire
results.private
boolean
results.deleted
boolean
results.spam
boolean
results.senderBlocked
boolean
results.seen
boolean
results.seenBy
string
results.replySuggestion
string
results.createdAt
string
obligatoire
results.willBeDeletedAt
string
results.lastActivityAt
string
obligatoire
results.lastMessageByContactAt
string
results.tags
array of object
Afficher les attributs enfants
results.tags.id
string
obligatoire
results.tags.name
string
obligatoire
results.tags.status
string
obligatoire
Possible values: draft, active, deleted
results.tags.addedAt
string
obligatoire
results.tags.category
object
Afficher les attributs enfants
results.tags.category.id
string
results.tags.category.name
string
results.tags.category.emoji
string
results.attributes
array of object
Afficher les attributs enfants
results.attributes.key
string
results.attributes.value
string
results.customAttributes
object
Use dynamicFields instead.
results.filters
array of array of object
Afficher les attributs enfants
results.filters.key
string
results.filters.value
string
results.linkedItems
array of object
Afficher les attributs enfants
results.linkedItems.userId
string
The id of the user that set up this relation.
results.linkedItems.relation
string
Possible values: linkedTo, parentOf, childOf, parentOfTask, taskChildOf
results.linkedItems.itemId
string
The id of the linked item.
results.linkedItems.itemNumber
integer
results.linkedItems.itemSubject
string
results.linkedItems.createdAt
string
results.mergeInfo
object
Afficher les attributs enfants
results.mergeInfo.mergedFrom
array of object
Afficher les attributs enfants
results.mergeInfo.mergedFrom.userId
string
obligatoire
results.mergeInfo.mergedFrom.itemId
string
obligatoire
results.mergeInfo.mergedFrom.createdAt
string
obligatoire
results.mergeInfo.mergedInto
object
Afficher les attributs enfants
results.mergeInfo.mergedInto.userId
string
obligatoire
results.mergeInfo.mergedInto.itemId
string
obligatoire
results.mergeInfo.mergedInto.createdAt
string
obligatoire
results.dynamicFields
object
Afficher les attributs enfants
results.dynamicFields.settingsId
string
obligatoire
Either the uuid settings id, or "default" to use the default settings.
results.dynamicFields.fields
array of object
obligatoire
Afficher les attributs enfants
results.dynamicFields.fields.id
string
results.dynamicFields.fields.name
string
obligatoire
results.dynamicFields.fields.description
string
results.dynamicFields.fields.type
string
obligatoire
Possible values: single, multiple, numeric, text, boolean, date
results.dynamicFields.fields.values
array of object
Afficher les attributs enfants
results.dynamicFields.fields.values.id
string
obligatoire
results.dynamicFields.fields.values.value
string
obligatoire
results.dynamicFields.fields.values.icon
string
results.dynamicFields.fields.values.createdAt
string
obligatoire
results.dynamicFields.fields.values.selected
boolean
obligatoire
results.dynamicFields.fields.valueText
string
results.dynamicFields.fields.valueNumber
number
results.dynamicFields.fields.valueBoolean
boolean
results.dynamicFields.fields.valueDate
string
results.dynamicFields.fields.settings
object
results.summaryForm
object
Afficher les attributs enfants
results.summaryForm.settingsId
string
obligatoire
Either the uuid settings id, or "default" to use the default settings.
results.summaryForm.fields
array of object
obligatoire
Afficher les attributs enfants
results.summaryForm.fields.id
string
results.summaryForm.fields.name
string
obligatoire
results.summaryForm.fields.description
string
results.summaryForm.fields.type
string
obligatoire
Possible values: single, multiple, numeric, text, boolean, date
results.summaryForm.fields.values
array of object
Afficher les attributs enfants
results.summaryForm.fields.values.id
string
obligatoire
results.summaryForm.fields.values.value
string
obligatoire
results.summaryForm.fields.values.icon
string
results.summaryForm.fields.values.createdAt
string
obligatoire
results.summaryForm.fields.values.selected
boolean
obligatoire
results.summaryForm.fields.valueText
string
results.summaryForm.fields.valueNumber
number
results.summaryForm.fields.valueBoolean
boolean
results.summaryForm.fields.valueDate
string
results.summaryForm.fields.settings
object
results.queueInfo
object
Afficher les attributs enfants
results.queueInfo.queueId
string
obligatoire
results.queueInfo.queueName
string
obligatoire
results.queueInfo.queuedAt
string
obligatoire
results.conversation
object
Afficher les attributs enfants
results.conversation.accessibility
string
obligatoire
Possible values: open, invite-only, request-to-join, private
results.conversation.activeParticipantCount
integer
obligatoire
results.conversation.assigneeId
string
results.conversation.attributes
object
results.conversation.category
string
results.conversation.channelId
string
obligatoire
results.conversation.createdAt
string
obligatoire
results.conversation.description
string
results.conversation.directory
string
results.conversation.featuredParticipants
array of object
obligatoire
Afficher les attributs enfants
results.conversation.featuredParticipants.avatarUrl
string
results.conversation.featuredParticipants.contact
object
Afficher les attributs enfants
results.conversation.featuredParticipants.contact.identifierKey
string
obligatoire
results.conversation.featuredParticipants.contact.identifierValue
string
obligatoire
results.conversation.featuredParticipants.contact.platformAddress
string
results.conversation.featuredParticipants.contact.platformAddressSelector
string
results.conversation.featuredParticipants.conversationId
string
results.conversation.featuredParticipants.createdAt
string
results.conversation.featuredParticipants.displayName
string
results.conversation.featuredParticipants.id
string
obligatoire
results.conversation.featuredParticipants.resourceUri
string
results.conversation.featuredParticipants.status
string
Possible values: invited, pending, active, inactive
results.conversation.featuredParticipants.type
string
obligatoire
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
results.conversation.featuredParticipants.updatedAt
string
results.conversation.hasDraft
boolean
results.conversation.id
string
obligatoire
results.conversation.inbox
object
Afficher les attributs enfants
results.conversation.inbox.id
string
obligatoire
results.conversation.inbox.identifier
string
obligatoire
results.conversation.inbox.ownerId
string
obligatoire
results.conversation.inbox.ownerType
string
obligatoire
Possible values: user, group
results.conversation.inbox.type
string
obligatoire
Possible values: personal, shared, support
results.conversation.initiatingParticipant
object
Afficher les attributs enfants
results.conversation.initiatingParticipant.avatarUrl
string
results.conversation.initiatingParticipant.contact
object
Afficher les attributs enfants
results.conversation.initiatingParticipant.contact.identifierKey
string
obligatoire
results.conversation.initiatingParticipant.contact.identifierValue
string
obligatoire
results.conversation.initiatingParticipant.contact.platformAddress
string
results.conversation.initiatingParticipant.contact.platformAddressSelector
string
results.conversation.initiatingParticipant.conversationId
string
results.conversation.initiatingParticipant.createdAt
string
results.conversation.initiatingParticipant.displayName
string
results.conversation.initiatingParticipant.id
string
obligatoire
results.conversation.initiatingParticipant.resourceUri
string
results.conversation.initiatingParticipant.status
string
Possible values: invited, pending, active, inactive
results.conversation.initiatingParticipant.type
string
obligatoire
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
results.conversation.initiatingParticipant.updatedAt
string
results.conversation.lastMessage
object
Afficher les attributs enfants
results.conversation.lastMessage.createdAt
string
obligatoire
results.conversation.lastMessage.draft
boolean
obligatoire
results.conversation.lastMessage.id
string
obligatoire
results.conversation.lastMessage.preview
object
obligatoire
Afficher les attributs enfants
results.conversation.lastMessage.preview.text
string
results.conversation.lastMessage.recipients
array of object
Afficher les attributs enfants
results.conversation.lastMessage.recipients.contactAnnotation
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Afficher les attributs enfants
results.conversation.lastMessage.recipients.contactAnnotation.name
string
results.conversation.lastMessage.recipients.countryCode
string
results.conversation.lastMessage.recipients.id
string
The ID of the contact.
results.conversation.lastMessage.recipients.identifierKey
string
The identifier key for finding the contact (e.g. emailaddress, phonenumber). For WhatsApp channels with BSUID support, use whatsappbsuid to send to a contact by their Business-Scoped User ID.
results.conversation.lastMessage.recipients.identifierValue
string
The identifier value for finding the contact.
results.conversation.lastMessage.recipients.identifiers
array of object
Additional identifiers to augment the contact during resolution.
Afficher les attributs enfants
results.conversation.lastMessage.recipients.identifiers.identifierKey
string
obligatoire
The identifier key for finding the contact (e.g. emailaddress, phonenumber).
results.conversation.lastMessage.recipients.identifiers.identifierValue
string
obligatoire
The identifier value for finding the contact.
results.conversation.lastMessage.recipients.platformAddress
string
The resolved platform address used to deliver the message (e.g. phone number or email address).
results.conversation.lastMessage.recipients.platformAddressSelector
string
An expression that defines how we resolve the platform address from a contact. Optional override for the default resolution logic.
results.conversation.lastMessage.recipients.receiverExpression
string
results.conversation.lastMessage.recipients.receiverValue
string
results.conversation.lastMessage.recipients.type
string
The type of the receiver (e.g. to, cc, bcc for email).
results.conversation.lastMessage.sender
object
Afficher les attributs enfants
results.conversation.lastMessage.sender.email
string
results.conversation.lastMessage.sender.name
string
results.conversation.lastMessage.sender.avatarUrl
string
results.conversation.lastMessage.sender.contact
object
Afficher les attributs enfants
results.conversation.lastMessage.sender.contact.identifierKey
string
obligatoire
results.conversation.lastMessage.sender.contact.identifierValue
string
obligatoire
results.conversation.lastMessage.sender.contact.platformAddress
string
results.conversation.lastMessage.sender.contact.platformAddressSelector
string
results.conversation.lastMessage.sender.conversationId
string
results.conversation.lastMessage.sender.createdAt
string
results.conversation.lastMessage.sender.displayName
string
results.conversation.lastMessage.sender.id
string
obligatoire
results.conversation.lastMessage.sender.resourceUri
string
results.conversation.lastMessage.sender.status
string
Possible values: invited, pending, active, inactive
results.conversation.lastMessage.sender.type
string
obligatoire
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
results.conversation.lastMessage.sender.updatedAt
string
results.conversation.lastMessage.status
string
obligatoire
Possible values: accepted, processing, sent, sending_failed, delivered, delivery_failed, deleted
results.conversation.lastMessage.type
string
obligatoire
Possible values: text, html, image, file, gif, location, carousel, list, section, authentication, action, comment
results.conversation.lastMessageIncomingAt
string
results.conversation.lastMessageOutgoingAt
string
results.conversation.name
string
obligatoire
results.conversation.participants
array of object
Afficher les attributs enfants
results.conversation.participants.contact
object
Afficher les attributs enfants
results.conversation.participants.contact.identifierKey
string
obligatoire
results.conversation.participants.contact.identifierValue
string
obligatoire
results.conversation.participants.contact.platformAddress
string
results.conversation.participants.contact.platformAddressSelector
string
results.conversation.participants.id
string
obligatoire
results.conversation.participants.type
string
obligatoire
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
results.conversation.pendingParticipantCount
integer
results.conversation.platformStyle
string
obligatoire
Possible values: direct, email, direct-multiple, direct-threaded, group-multiple
results.conversation.privateAttributes
string
results.conversation.read
boolean
results.conversation.referral
object
Afficher les attributs enfants
results.conversation.referral.caption
string
results.conversation.referral.mediaType
string
results.conversation.referral.mediaUrl
string
results.conversation.referral.sourceId
string
obligatoire
results.conversation.referral.sourceType
string
results.conversation.referral.sourceUrl
string
results.conversation.referral.text
string
results.conversation.referral.timestamp
string
results.conversation.referral.title
string
results.conversation.referral.username
string
results.conversation.resource
object
Afficher les attributs enfants
results.conversation.resource.id
string
obligatoire
results.conversation.resource.type
string
obligatoire
Possible values: task, task-conversation, reimbursement, sales-lead, sales-opportunity, sales-account, expense, project
results.conversation.resourceUri
string
results.conversation.starred
boolean
results.conversation.status
string
obligatoire
Possible values: deleted, active, closed, spam, archived
results.conversation.style
string
obligatoire
Possible values: default, directMessage, chatChannel, personalInbox, resource, groupInbox, support
results.conversation.summary
string
results.conversation.tags
array of string
results.conversation.updatedAt
string
obligatoire
results.conversation.visibility
string
obligatoire
Possible values: public, private, direct, group
results.conference
object
Afficher les attributs enfants
results.task
object
results.slaPolicy
object
Afficher les attributs enfants
results.slaPolicy.policyId
string
obligatoire
results.slaPolicy.timers
array of object
obligatoire
Afficher les attributs enfants
results.slaPolicy.timers.expiresAt
string
results.slaPolicy.timers.metric
string
obligatoire
Possible values: firstReplyTime, nextReplyTime
results.slaPolicy.timers.severity
string
obligatoire
Possible values: breach, warning
results.slaPolicy.timers.status
string
obligatoire
Possible values: inactive, active, completed, expired
results.requiredSkills
array of object
Afficher les attributs enfants
results.requiredSkills.id
string
obligatoire
results.requiredSkills.name
string
obligatoire
results.requiredSkills.selectedValues
array of object
obligatoire
Afficher les attributs enfants
results.requiredSkills.selectedValues.icon
string
results.requiredSkills.selectedValues.id
string
obligatoire
results.requiredSkills.selectedValues.value
string
obligatoire
results.requiredSkills.valueType
string
obligatoire
AgentSkillValueType defines how can the Values of a Skill can be selected.
Possible values: single, multiple, boolean
results.status
string
The slug that identifies the status of the root item.
results.statusCategory
string
The category maps to the lifecycle of a root item in the system.
Possible values: new, inProgress, pending, closed
total
integer
The total number of results across all pages.
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.
Exemple de code
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/me/feeds/{alias}/items' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
GET
/workspaces/{workspaceId}/feeds/items
Retrieve information about a specific item.
Corps de la réponse
id
string
feedId
string
feedIndexId
string
feedIndexType
string
type
string
Possible values: conversation, conference
Exemple de code
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/feeds/items' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
GET
/workspaces/{workspaceId}/feeds/items/{itemId}
Retrieve information about a specific item.
Corps de la réponse
id
string
feedId
string
feedIndexId
string
feedIndexType
string
type
string
Possible values: conversation, conference
Exemple de code
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/feeds/items/{itemId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
GET
/workspaces/{workspaceId}/feeds/{feedId}/items/{itemId}
Retrieve information about a specific item within a feed.
Corps de la réponse
id
string
obligatoire
feedId
string
feedIndexId
string
feedIndexType
string
agent
object
Afficher les attributs enfants
agent.id
string
obligatoire
agent.name
string
obligatoire
agent.avatarUrl
string
team
object
Afficher les attributs enfants
team.id
string
obligatoire
team.name
string
obligatoire
team.avatarUrl
string
number
integer
type
string
obligatoire
Possible values: conversation, conference, task
archived
boolean
obligatoire
closed
boolean
obligatoire
private
boolean
deleted
boolean
spam
boolean
senderBlocked
boolean
seen
boolean
seenBy
string
replySuggestion
string
createdAt
string
obligatoire
willBeDeletedAt
string
lastActivityAt
string
obligatoire
lastMessageByContactAt
string
tags
array of object
Afficher les attributs enfants
tags.id
string
obligatoire
tags.name
string
obligatoire
tags.status
string
obligatoire
Possible values: draft, active, deleted
tags.addedAt
string
obligatoire
tags.category
object
Afficher les attributs enfants
tags.category.id
string
tags.category.name
string
tags.category.emoji
string
attributes
array of object
Afficher les attributs enfants
attributes.key
string
attributes.value
string
customAttributes
object
Use dynamicFields instead.
filters
array of array of object
Afficher les attributs enfants
filters.key
string
filters.value
string
linkedItems
array of object
Afficher les attributs enfants
linkedItems.userId
string
The id of the user that set up this relation.
linkedItems.relation
string
Possible values: linkedTo, parentOf, childOf, parentOfTask, taskChildOf
linkedItems.itemId
string
The id of the linked item.
linkedItems.itemNumber
integer
linkedItems.itemSubject
string
linkedItems.createdAt
string
mergeInfo
object
Afficher les attributs enfants
mergeInfo.mergedFrom
array of object
Afficher les attributs enfants
mergeInfo.mergedFrom.userId
string
obligatoire
mergeInfo.mergedFrom.itemId
string
obligatoire
mergeInfo.mergedFrom.createdAt
string
obligatoire
mergeInfo.mergedInto
object
Afficher les attributs enfants
mergeInfo.mergedInto.userId
string
obligatoire
mergeInfo.mergedInto.itemId
string
obligatoire
mergeInfo.mergedInto.createdAt
string
obligatoire
dynamicFields
object
Afficher les attributs enfants
dynamicFields.settingsId
string
obligatoire
Either the uuid settings id, or "default" to use the default settings.
dynamicFields.fields
array of object
obligatoire
Afficher les attributs enfants
dynamicFields.fields.id
string
dynamicFields.fields.name
string
obligatoire
dynamicFields.fields.description
string
dynamicFields.fields.type
string
obligatoire
Possible values: single, multiple, numeric, text, boolean, date
dynamicFields.fields.values
array of object
Afficher les attributs enfants
dynamicFields.fields.values.id
string
obligatoire
dynamicFields.fields.values.value
string
obligatoire
dynamicFields.fields.values.icon
string
dynamicFields.fields.values.createdAt
string
obligatoire
dynamicFields.fields.values.selected
boolean
obligatoire
dynamicFields.fields.valueText
string
dynamicFields.fields.valueNumber
number
dynamicFields.fields.valueBoolean
boolean
dynamicFields.fields.valueDate
string
dynamicFields.fields.settings
object
summaryForm
object
Afficher les attributs enfants
summaryForm.settingsId
string
obligatoire
Either the uuid settings id, or "default" to use the default settings.
summaryForm.fields
array of object
obligatoire
Afficher les attributs enfants
summaryForm.fields.id
string
summaryForm.fields.name
string
obligatoire
summaryForm.fields.description
string
summaryForm.fields.type
string
obligatoire
Possible values: single, multiple, numeric, text, boolean, date
summaryForm.fields.values
array of object
Afficher les attributs enfants
summaryForm.fields.values.id
string
obligatoire
summaryForm.fields.values.value
string
obligatoire
summaryForm.fields.values.icon
string
summaryForm.fields.values.createdAt
string
obligatoire
summaryForm.fields.values.selected
boolean
obligatoire
summaryForm.fields.valueText
string
summaryForm.fields.valueNumber
number
summaryForm.fields.valueBoolean
boolean
summaryForm.fields.valueDate
string
summaryForm.fields.settings
object
queueInfo
object
Afficher les attributs enfants
queueInfo.queueId
string
obligatoire
queueInfo.queueName
string
obligatoire
queueInfo.queuedAt
string
obligatoire
conversation
object
Afficher les attributs enfants
conversation.accessibility
string
obligatoire
Possible values: open, invite-only, request-to-join, private
conversation.activeParticipantCount
integer
obligatoire
conversation.assigneeId
string
conversation.attributes
object
conversation.category
string
conversation.channelId
string
obligatoire
conversation.createdAt
string
obligatoire
conversation.description
string
conversation.directory
string
conversation.featuredParticipants
array of object
obligatoire
Afficher les attributs enfants
conversation.featuredParticipants.avatarUrl
string
conversation.featuredParticipants.contact
object
Afficher les attributs enfants
conversation.featuredParticipants.contact.identifierKey
string
obligatoire
conversation.featuredParticipants.contact.identifierValue
string
obligatoire
conversation.featuredParticipants.contact.platformAddress
string
conversation.featuredParticipants.contact.platformAddressSelector
string
conversation.featuredParticipants.conversationId
string
conversation.featuredParticipants.createdAt
string
conversation.featuredParticipants.displayName
string
conversation.featuredParticipants.id
string
obligatoire
conversation.featuredParticipants.resourceUri
string
conversation.featuredParticipants.status
string
Possible values: invited, pending, active, inactive
conversation.featuredParticipants.type
string
obligatoire
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
conversation.featuredParticipants.updatedAt
string
conversation.hasDraft
boolean
conversation.id
string
obligatoire
conversation.inbox
object
Afficher les attributs enfants
conversation.inbox.id
string
obligatoire
conversation.inbox.identifier
string
obligatoire
conversation.inbox.ownerId
string
obligatoire
conversation.inbox.ownerType
string
obligatoire
Possible values: user, group
conversation.inbox.type
string
obligatoire
Possible values: personal, shared, support
conversation.initiatingParticipant
object
Afficher les attributs enfants
conversation.initiatingParticipant.avatarUrl
string
conversation.initiatingParticipant.contact
object
Afficher les attributs enfants
conversation.initiatingParticipant.contact.identifierKey
string
obligatoire
conversation.initiatingParticipant.contact.identifierValue
string
obligatoire
conversation.initiatingParticipant.contact.platformAddress
string
conversation.initiatingParticipant.contact.platformAddressSelector
string
conversation.initiatingParticipant.conversationId
string
conversation.initiatingParticipant.createdAt
string
conversation.initiatingParticipant.displayName
string
conversation.initiatingParticipant.id
string
obligatoire
conversation.initiatingParticipant.resourceUri
string
conversation.initiatingParticipant.status
string
Possible values: invited, pending, active, inactive
conversation.initiatingParticipant.type
string
obligatoire
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
conversation.initiatingParticipant.updatedAt
string
conversation.lastMessage
object
Afficher les attributs enfants
conversation.lastMessage.createdAt
string
obligatoire
conversation.lastMessage.draft
boolean
obligatoire
conversation.lastMessage.id
string
obligatoire
conversation.lastMessage.preview
object
obligatoire
Afficher les attributs enfants
conversation.lastMessage.preview.text
string
conversation.lastMessage.recipients
array of object
Afficher les attributs enfants
conversation.lastMessage.recipients.contactAnnotation
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Afficher les attributs enfants
conversation.lastMessage.recipients.contactAnnotation.name
string
conversation.lastMessage.recipients.countryCode
string
conversation.lastMessage.recipients.id
string
The ID of the contact.
conversation.lastMessage.recipients.identifierKey
string
The identifier key for finding the contact (e.g. emailaddress, phonenumber). For WhatsApp channels with BSUID support, use whatsappbsuid to send to a contact by their Business-Scoped User ID.
conversation.lastMessage.recipients.identifierValue
string
The identifier value for finding the contact.
conversation.lastMessage.recipients.identifiers
array of object
Additional identifiers to augment the contact during resolution.
Afficher les attributs enfants
conversation.lastMessage.recipients.identifiers.identifierKey
string
obligatoire
The identifier key for finding the contact (e.g. emailaddress, phonenumber).
conversation.lastMessage.recipients.identifiers.identifierValue
string
obligatoire
The identifier value for finding the contact.
conversation.lastMessage.recipients.platformAddress
string
The resolved platform address used to deliver the message (e.g. phone number or email address).
conversation.lastMessage.recipients.platformAddressSelector
string
An expression that defines how we resolve the platform address from a contact. Optional override for the default resolution logic.
conversation.lastMessage.recipients.receiverExpression
string
conversation.lastMessage.recipients.receiverValue
string
conversation.lastMessage.recipients.type
string
The type of the receiver (e.g. to, cc, bcc for email).
conversation.lastMessage.sender
object
Afficher les attributs enfants
conversation.lastMessage.sender.email
string
conversation.lastMessage.sender.name
string
conversation.lastMessage.sender.avatarUrl
string
conversation.lastMessage.sender.contact
object
Afficher les attributs enfants
conversation.lastMessage.sender.contact.identifierKey
string
obligatoire
conversation.lastMessage.sender.contact.identifierValue
string
obligatoire
conversation.lastMessage.sender.contact.platformAddress
string
conversation.lastMessage.sender.contact.platformAddressSelector
string
conversation.lastMessage.sender.conversationId
string
conversation.lastMessage.sender.createdAt
string
conversation.lastMessage.sender.displayName
string
conversation.lastMessage.sender.id
string
obligatoire
conversation.lastMessage.sender.resourceUri
string
conversation.lastMessage.sender.status
string
Possible values: invited, pending, active, inactive
conversation.lastMessage.sender.type
string
obligatoire
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
conversation.lastMessage.sender.updatedAt
string
conversation.lastMessage.status
string
obligatoire
Possible values: accepted, processing, sent, sending_failed, delivered, delivery_failed, deleted
conversation.lastMessage.type
string
obligatoire
Possible values: text, html, image, file, gif, location, carousel, list, section, authentication, action, comment
conversation.lastMessageIncomingAt
string
conversation.lastMessageOutgoingAt
string
conversation.name
string
obligatoire
conversation.participants
array of object
Afficher les attributs enfants
conversation.participants.contact
object
Afficher les attributs enfants
conversation.participants.contact.identifierKey
string
obligatoire
conversation.participants.contact.identifierValue
string
obligatoire
conversation.participants.contact.platformAddress
string
conversation.participants.contact.platformAddressSelector
string
conversation.participants.id
string
obligatoire
conversation.participants.type
string
obligatoire
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
conversation.pendingParticipantCount
integer
conversation.platformStyle
string
obligatoire
Possible values: direct, email, direct-multiple, direct-threaded, group-multiple
conversation.privateAttributes
string
conversation.read
boolean
conversation.referral
object
Afficher les attributs enfants
conversation.referral.caption
string
conversation.referral.mediaType
string
conversation.referral.mediaUrl
string
conversation.referral.sourceId
string
obligatoire
conversation.referral.sourceType
string
conversation.referral.sourceUrl
string
conversation.referral.text
string
conversation.referral.timestamp
string
conversation.referral.title
string
conversation.referral.username
string
conversation.resource
object
Afficher les attributs enfants
conversation.resource.id
string
obligatoire
conversation.resource.type
string
obligatoire
Possible values: task, task-conversation, reimbursement, sales-lead, sales-opportunity, sales-account, expense, project
conversation.resourceUri
string
conversation.starred
boolean
conversation.status
string
obligatoire
Possible values: deleted, active, closed, spam, archived
conversation.style
string
obligatoire
Possible values: default, directMessage, chatChannel, personalInbox, resource, groupInbox, support
conversation.summary
string
conversation.tags
array of string
conversation.updatedAt
string
obligatoire
conversation.visibility
string
obligatoire
Possible values: public, private, direct, group
conference
object
Afficher les attributs enfants
task
object
slaPolicy
object
Afficher les attributs enfants
slaPolicy.policyId
string
obligatoire
slaPolicy.timers
array of object
obligatoire
Afficher les attributs enfants
slaPolicy.timers.expiresAt
string
slaPolicy.timers.metric
string
obligatoire
Possible values: firstReplyTime, nextReplyTime
slaPolicy.timers.severity
string
obligatoire
Possible values: breach, warning
slaPolicy.timers.status
string
obligatoire
Possible values: inactive, active, completed, expired
requiredSkills
array of object
Afficher les attributs enfants
requiredSkills.id
string
obligatoire
requiredSkills.name
string
obligatoire
requiredSkills.selectedValues
array of object
obligatoire
Afficher les attributs enfants
requiredSkills.selectedValues.icon
string
requiredSkills.selectedValues.id
string
obligatoire
requiredSkills.selectedValues.value
string
obligatoire
requiredSkills.valueType
string
obligatoire
AgentSkillValueType defines how can the Values of a Skill can be selected.
Possible values: single, multiple, boolean
status
string
The slug that identifies the status of the root item.
statusCategory
string
The category maps to the lifecycle of a root item in the system.
Possible values: new, inProgress, pending, closed
Exemple de code
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/feeds/{feedId}/items/{itemId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
PATCH
/workspaces/{workspaceId}/feeds/{feedId}/items/{itemId}
Modify the content of a specific item within a feed.
Corps de la requête
agentId
string
teamId
string
archived
boolean
spam
boolean
blockSender
boolean
closed
boolean
seen
boolean
private
boolean
replySuggestion
string
customAttributes
object
dynamicFields
object
Afficher les paramètres enfants
dynamicFields.settingsId
string
Optional. Either the uuid settings id, or "default" to use the default settings.
If not specified, it will validate form input against the last saved form.
dynamicFields.fields
array of object
Afficher les paramètres enfants
dynamicFields.fields.id
string
dynamicFields.fields.selectedValueIds
array of string
dynamicFields.fields.valueText
string
dynamicFields.fields.valueNumber
number
dynamicFields.fields.valueBoolean
boolean
dynamicFields.fields.valueDate
string
The date value to set or search for.
dynamicFields.fields.valueDateBefore
string
The date value to set or search for.
dynamicFields.fields.valueDateAfter
string
The date value to set or search for.
summaryForm
object
Afficher les paramètres enfants
summaryForm.settingsId
string
Optional. Either the uuid settings id, or "default" to use the default settings.
If not specified, it will validate form input against the last saved form.
summaryForm.fields
array of object
Afficher les paramètres enfants
summaryForm.fields.id
string
summaryForm.fields.selectedValueIds
array of string
summaryForm.fields.valueText
string
summaryForm.fields.valueNumber
number
summaryForm.fields.valueBoolean
boolean
summaryForm.fields.valueDate
string
The date value to set or search for.
summaryForm.fields.valueDateBefore
string
The date value to set or search for.
summaryForm.fields.valueDateAfter
string
The date value to set or search for.
slaPolicyId
string
requiredSkills
array of object
Afficher les paramètres enfants
requiredSkills.id
string
obligatoire
requiredSkills.name
string
obligatoire
requiredSkills.selectedValues
array of object
obligatoire
Afficher les paramètres enfants
requiredSkills.selectedValues.icon
string
requiredSkills.selectedValues.id
string
obligatoire
requiredSkills.selectedValues.value
string
obligatoire
requiredSkills.valueType
string
obligatoire
AgentSkillValueType defines how can the Values of a Skill can be selected.
Possible values: single, multiple, boolean
status
string
The slug of the status to set on the feed item.
Corps de la réponse
id
string
obligatoire
feedId
string
feedIndexId
string
feedIndexType
string
agent
object
Afficher les attributs enfants
agent.id
string
obligatoire
agent.name
string
obligatoire
agent.avatarUrl
string
team
object
Afficher les attributs enfants
team.id
string
obligatoire
team.name
string
obligatoire
team.avatarUrl
string
number
integer
type
string
obligatoire
Possible values: conversation, conference, task
archived
boolean
obligatoire
closed
boolean
obligatoire
private
boolean
deleted
boolean
spam
boolean
senderBlocked
boolean
seen
boolean
seenBy
string
replySuggestion
string
createdAt
string
obligatoire
willBeDeletedAt
string
lastActivityAt
string
obligatoire
lastMessageByContactAt
string
tags
array of object
Afficher les attributs enfants
tags.id
string
obligatoire
tags.name
string
obligatoire
tags.status
string
obligatoire
Possible values: draft, active, deleted
tags.addedAt
string
obligatoire
tags.category
object
Afficher les attributs enfants
tags.category.id
string
tags.category.name
string
tags.category.emoji
string
attributes
array of object
Afficher les attributs enfants
attributes.key
string
attributes.value
string
customAttributes
object
Use dynamicFields instead.
filters
array of array of object
Afficher les attributs enfants
filters.key
string
filters.value
string
linkedItems
array of object
Afficher les attributs enfants
linkedItems.userId
string
The id of the user that set up this relation.
linkedItems.relation
string
Possible values: linkedTo, parentOf, childOf, parentOfTask, taskChildOf
linkedItems.itemId
string
The id of the linked item.
linkedItems.itemNumber
integer
linkedItems.itemSubject
string
linkedItems.createdAt
string
mergeInfo
object
Afficher les attributs enfants
mergeInfo.mergedFrom
array of object
Afficher les attributs enfants
mergeInfo.mergedFrom.userId
string
obligatoire
mergeInfo.mergedFrom.itemId
string
obligatoire
mergeInfo.mergedFrom.createdAt
string
obligatoire
mergeInfo.mergedInto
object
Afficher les attributs enfants
mergeInfo.mergedInto.userId
string
obligatoire
mergeInfo.mergedInto.itemId
string
obligatoire
mergeInfo.mergedInto.createdAt
string
obligatoire
dynamicFields
object
Afficher les attributs enfants
dynamicFields.settingsId
string
obligatoire
Either the uuid settings id, or "default" to use the default settings.
dynamicFields.fields
array of object
obligatoire
Afficher les attributs enfants
dynamicFields.fields.id
string
dynamicFields.fields.name
string
obligatoire
dynamicFields.fields.description
string
dynamicFields.fields.type
string
obligatoire
Possible values: single, multiple, numeric, text, boolean, date
dynamicFields.fields.values
array of object
Afficher les attributs enfants
dynamicFields.fields.values.id
string
obligatoire
dynamicFields.fields.values.value
string
obligatoire
dynamicFields.fields.values.icon
string
dynamicFields.fields.values.createdAt
string
obligatoire
dynamicFields.fields.values.selected
boolean
obligatoire
dynamicFields.fields.valueText
string
dynamicFields.fields.valueNumber
number
dynamicFields.fields.valueBoolean
boolean
dynamicFields.fields.valueDate
string
dynamicFields.fields.settings
object
summaryForm
object
Afficher les attributs enfants
summaryForm.settingsId
string
obligatoire
Either the uuid settings id, or "default" to use the default settings.
summaryForm.fields
array of object
obligatoire
Afficher les attributs enfants
summaryForm.fields.id
string
summaryForm.fields.name
string
obligatoire
summaryForm.fields.description
string
summaryForm.fields.type
string
obligatoire
Possible values: single, multiple, numeric, text, boolean, date
summaryForm.fields.values
array of object
Afficher les attributs enfants
summaryForm.fields.values.id
string
obligatoire
summaryForm.fields.values.value
string
obligatoire
summaryForm.fields.values.icon
string
summaryForm.fields.values.createdAt
string
obligatoire
summaryForm.fields.values.selected
boolean
obligatoire
summaryForm.fields.valueText
string
summaryForm.fields.valueNumber
number
summaryForm.fields.valueBoolean
boolean
summaryForm.fields.valueDate
string
summaryForm.fields.settings
object
queueInfo
object
Afficher les attributs enfants
queueInfo.queueId
string
obligatoire
queueInfo.queueName
string
obligatoire
queueInfo.queuedAt
string
obligatoire
conversation
object
Afficher les attributs enfants
conversation.accessibility
string
obligatoire
Possible values: open, invite-only, request-to-join, private
conversation.activeParticipantCount
integer
obligatoire
conversation.assigneeId
string
conversation.attributes
object
conversation.category
string
conversation.channelId
string
obligatoire
conversation.createdAt
string
obligatoire
conversation.description
string
conversation.directory
string
conversation.featuredParticipants
array of object
obligatoire
Afficher les attributs enfants
conversation.featuredParticipants.avatarUrl
string
conversation.featuredParticipants.contact
object
Afficher les attributs enfants
conversation.featuredParticipants.contact.identifierKey
string
obligatoire
conversation.featuredParticipants.contact.identifierValue
string
obligatoire
conversation.featuredParticipants.contact.platformAddress
string
conversation.featuredParticipants.contact.platformAddressSelector
string
conversation.featuredParticipants.conversationId
string
conversation.featuredParticipants.createdAt
string
conversation.featuredParticipants.displayName
string
conversation.featuredParticipants.id
string
obligatoire
conversation.featuredParticipants.resourceUri
string
conversation.featuredParticipants.status
string
Possible values: invited, pending, active, inactive
conversation.featuredParticipants.type
string
obligatoire
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
conversation.featuredParticipants.updatedAt
string
conversation.hasDraft
boolean
conversation.id
string
obligatoire
conversation.inbox
object
Afficher les attributs enfants
conversation.inbox.id
string
obligatoire
conversation.inbox.identifier
string
obligatoire
conversation.inbox.ownerId
string
obligatoire
conversation.inbox.ownerType
string
obligatoire
Possible values: user, group
conversation.inbox.type
string
obligatoire
Possible values: personal, shared, support
conversation.initiatingParticipant
object
Afficher les attributs enfants
conversation.initiatingParticipant.avatarUrl
string
conversation.initiatingParticipant.contact
object
Afficher les attributs enfants
conversation.initiatingParticipant.contact.identifierKey
string
obligatoire
conversation.initiatingParticipant.contact.identifierValue
string
obligatoire
conversation.initiatingParticipant.contact.platformAddress
string
conversation.initiatingParticipant.contact.platformAddressSelector
string
conversation.initiatingParticipant.conversationId
string
conversation.initiatingParticipant.createdAt
string
conversation.initiatingParticipant.displayName
string
conversation.initiatingParticipant.id
string
obligatoire
conversation.initiatingParticipant.resourceUri
string
conversation.initiatingParticipant.status
string
Possible values: invited, pending, active, inactive
conversation.initiatingParticipant.type
string
obligatoire
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
conversation.initiatingParticipant.updatedAt
string
conversation.lastMessage
object
Afficher les attributs enfants
conversation.lastMessage.createdAt
string
obligatoire
conversation.lastMessage.draft
boolean
obligatoire
conversation.lastMessage.id
string
obligatoire
conversation.lastMessage.preview
object
obligatoire
Afficher les attributs enfants
conversation.lastMessage.preview.text
string
conversation.lastMessage.recipients
array of object
Afficher les attributs enfants
conversation.lastMessage.recipients.contactAnnotation
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Afficher les attributs enfants
conversation.lastMessage.recipients.contactAnnotation.name
string
conversation.lastMessage.recipients.countryCode
string
conversation.lastMessage.recipients.id
string
The ID of the contact.
conversation.lastMessage.recipients.identifierKey
string
The identifier key for finding the contact (e.g. emailaddress, phonenumber). For WhatsApp channels with BSUID support, use whatsappbsuid to send to a contact by their Business-Scoped User ID.
conversation.lastMessage.recipients.identifierValue
string
The identifier value for finding the contact.
conversation.lastMessage.recipients.identifiers
array of object
Additional identifiers to augment the contact during resolution.
Afficher les attributs enfants
conversation.lastMessage.recipients.identifiers.identifierKey
string
obligatoire
The identifier key for finding the contact (e.g. emailaddress, phonenumber).
conversation.lastMessage.recipients.identifiers.identifierValue
string
obligatoire
The identifier value for finding the contact.
conversation.lastMessage.recipients.platformAddress
string
The resolved platform address used to deliver the message (e.g. phone number or email address).
conversation.lastMessage.recipients.platformAddressSelector
string
An expression that defines how we resolve the platform address from a contact. Optional override for the default resolution logic.
conversation.lastMessage.recipients.receiverExpression
string
conversation.lastMessage.recipients.receiverValue
string
conversation.lastMessage.recipients.type
string
The type of the receiver (e.g. to, cc, bcc for email).
conversation.lastMessage.sender
object
Afficher les attributs enfants
conversation.lastMessage.sender.email
string
conversation.lastMessage.sender.name
string
conversation.lastMessage.sender.avatarUrl
string
conversation.lastMessage.sender.contact
object
Afficher les attributs enfants
conversation.lastMessage.sender.contact.identifierKey
string
obligatoire
conversation.lastMessage.sender.contact.identifierValue
string
obligatoire
conversation.lastMessage.sender.contact.platformAddress
string
conversation.lastMessage.sender.contact.platformAddressSelector
string
conversation.lastMessage.sender.conversationId
string
conversation.lastMessage.sender.createdAt
string
conversation.lastMessage.sender.displayName
string
conversation.lastMessage.sender.id
string
obligatoire
conversation.lastMessage.sender.resourceUri
string
conversation.lastMessage.sender.status
string
Possible values: invited, pending, active, inactive
conversation.lastMessage.sender.type
string
obligatoire
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
conversation.lastMessage.sender.updatedAt
string
conversation.lastMessage.status
string
obligatoire
Possible values: accepted, processing, sent, sending_failed, delivered, delivery_failed, deleted
conversation.lastMessage.type
string
obligatoire
Possible values: text, html, image, file, gif, location, carousel, list, section, authentication, action, comment
conversation.lastMessageIncomingAt
string
conversation.lastMessageOutgoingAt
string
conversation.name
string
obligatoire
conversation.participants
array of object
Afficher les attributs enfants
conversation.participants.contact
object
Afficher les attributs enfants
conversation.participants.contact.identifierKey
string
obligatoire
conversation.participants.contact.identifierValue
string
obligatoire
conversation.participants.contact.platformAddress
string
conversation.participants.contact.platformAddressSelector
string
conversation.participants.id
string
obligatoire
conversation.participants.type
string
obligatoire
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
conversation.pendingParticipantCount
integer
conversation.platformStyle
string
obligatoire
Possible values: direct, email, direct-multiple, direct-threaded, group-multiple
conversation.privateAttributes
string
conversation.read
boolean
conversation.referral
object
Afficher les attributs enfants
conversation.referral.caption
string
conversation.referral.mediaType
string
conversation.referral.mediaUrl
string
conversation.referral.sourceId
string
obligatoire
conversation.referral.sourceType
string
conversation.referral.sourceUrl
string
conversation.referral.text
string
conversation.referral.timestamp
string
conversation.referral.title
string
conversation.referral.username
string
conversation.resource
object
Afficher les attributs enfants
conversation.resource.id
string
obligatoire
conversation.resource.type
string
obligatoire
Possible values: task, task-conversation, reimbursement, sales-lead, sales-opportunity, sales-account, expense, project
conversation.resourceUri
string
conversation.starred
boolean
conversation.status
string
obligatoire
Possible values: deleted, active, closed, spam, archived
conversation.style
string
obligatoire
Possible values: default, directMessage, chatChannel, personalInbox, resource, groupInbox, support
conversation.summary
string
conversation.tags
array of string
conversation.updatedAt
string
obligatoire
conversation.visibility
string
obligatoire
Possible values: public, private, direct, group
conference
object
Afficher les attributs enfants
task
object
slaPolicy
object
Afficher les attributs enfants
slaPolicy.policyId
string
obligatoire
slaPolicy.timers
array of object
obligatoire
Afficher les attributs enfants
slaPolicy.timers.expiresAt
string
slaPolicy.timers.metric
string
obligatoire
Possible values: firstReplyTime, nextReplyTime
slaPolicy.timers.severity
string
obligatoire
Possible values: breach, warning
slaPolicy.timers.status
string
obligatoire
Possible values: inactive, active, completed, expired
requiredSkills
array of object
Afficher les attributs enfants
requiredSkills.id
string
obligatoire
requiredSkills.name
string
obligatoire
requiredSkills.selectedValues
array of object
obligatoire
Afficher les attributs enfants
requiredSkills.selectedValues.icon
string
requiredSkills.selectedValues.id
string
obligatoire
requiredSkills.selectedValues.value
string
obligatoire
requiredSkills.valueType
string
obligatoire
AgentSkillValueType defines how can the Values of a Skill can be selected.
Possible values: single, multiple, boolean
status
string
The slug that identifies the status of the root item.
statusCategory
string
The category maps to the lifecycle of a root item in the system.
Possible values: new, inProgress, pending, closed
Exemple de code
curl -X PATCH 'https://api.bird.com/workspaces/{workspaceId}/feeds/{feedId}/items/{itemId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
POST
/workspaces/{workspaceId}/feeds/{feedId}/items/{itemId}
Add an existent item to an existent feed.
Corps de la réponse
id
string
obligatoire
feedId
string
feedIndexId
string
feedIndexType
string
agent
object
Afficher les attributs enfants
agent.id
string
obligatoire
agent.name
string
obligatoire
agent.avatarUrl
string
team
object
Afficher les attributs enfants
team.id
string
obligatoire
team.name
string
obligatoire
team.avatarUrl
string
number
integer
type
string
obligatoire
Possible values: conversation, conference, task
archived
boolean
obligatoire
closed
boolean
obligatoire
private
boolean
deleted
boolean
spam
boolean
senderBlocked
boolean
seen
boolean
seenBy
string
replySuggestion
string
createdAt
string
obligatoire
willBeDeletedAt
string
lastActivityAt
string
obligatoire
lastMessageByContactAt
string
tags
array of object
Afficher les attributs enfants
tags.id
string
obligatoire
tags.name
string
obligatoire
tags.status
string
obligatoire
Possible values: draft, active, deleted
tags.addedAt
string
obligatoire
tags.category
object
Afficher les attributs enfants
tags.category.id
string
tags.category.name
string
tags.category.emoji
string
attributes
array of object
Afficher les attributs enfants
attributes.key
string
attributes.value
string
customAttributes
object
Use dynamicFields instead.
filters
array of array of object
Afficher les attributs enfants
filters.key
string
filters.value
string
linkedItems
array of object
Afficher les attributs enfants
linkedItems.userId
string
The id of the user that set up this relation.
linkedItems.relation
string
Possible values: linkedTo, parentOf, childOf, parentOfTask, taskChildOf
linkedItems.itemId
string
The id of the linked item.
linkedItems.itemNumber
integer
linkedItems.itemSubject
string
linkedItems.createdAt
string
mergeInfo
object
Afficher les attributs enfants
mergeInfo.mergedFrom
array of object
Afficher les attributs enfants
mergeInfo.mergedFrom.userId
string
obligatoire
mergeInfo.mergedFrom.itemId
string
obligatoire
mergeInfo.mergedFrom.createdAt
string
obligatoire
mergeInfo.mergedInto
object
Afficher les attributs enfants
mergeInfo.mergedInto.userId
string
obligatoire
mergeInfo.mergedInto.itemId
string
obligatoire
mergeInfo.mergedInto.createdAt
string
obligatoire
dynamicFields
object
Afficher les attributs enfants
dynamicFields.settingsId
string
obligatoire
Either the uuid settings id, or "default" to use the default settings.
dynamicFields.fields
array of object
obligatoire
Afficher les attributs enfants
dynamicFields.fields.id
string
dynamicFields.fields.name
string
obligatoire
dynamicFields.fields.description
string
dynamicFields.fields.type
string
obligatoire
Possible values: single, multiple, numeric, text, boolean, date
dynamicFields.fields.values
array of object
Afficher les attributs enfants
dynamicFields.fields.values.id
string
obligatoire
dynamicFields.fields.values.value
string
obligatoire
dynamicFields.fields.values.icon
string
dynamicFields.fields.values.createdAt
string
obligatoire
dynamicFields.fields.values.selected
boolean
obligatoire
dynamicFields.fields.valueText
string
dynamicFields.fields.valueNumber
number
dynamicFields.fields.valueBoolean
boolean
dynamicFields.fields.valueDate
string
dynamicFields.fields.settings
object
summaryForm
object
Afficher les attributs enfants
summaryForm.settingsId
string
obligatoire
Either the uuid settings id, or "default" to use the default settings.
summaryForm.fields
array of object
obligatoire
Afficher les attributs enfants
summaryForm.fields.id
string
summaryForm.fields.name
string
obligatoire
summaryForm.fields.description
string
summaryForm.fields.type
string
obligatoire
Possible values: single, multiple, numeric, text, boolean, date
summaryForm.fields.values
array of object
Afficher les attributs enfants
summaryForm.fields.values.id
string
obligatoire
summaryForm.fields.values.value
string
obligatoire
summaryForm.fields.values.icon
string
summaryForm.fields.values.createdAt
string
obligatoire
summaryForm.fields.values.selected
boolean
obligatoire
summaryForm.fields.valueText
string
summaryForm.fields.valueNumber
number
summaryForm.fields.valueBoolean
boolean
summaryForm.fields.valueDate
string
summaryForm.fields.settings
object
queueInfo
object
Afficher les attributs enfants
queueInfo.queueId
string
obligatoire
queueInfo.queueName
string
obligatoire
queueInfo.queuedAt
string
obligatoire
conversation
object
Afficher les attributs enfants
conversation.accessibility
string
obligatoire
Possible values: open, invite-only, request-to-join, private
conversation.activeParticipantCount
integer
obligatoire
conversation.assigneeId
string
conversation.attributes
object
conversation.category
string
conversation.channelId
string
obligatoire
conversation.createdAt
string
obligatoire
conversation.description
string
conversation.directory
string
conversation.featuredParticipants
array of object
obligatoire
Afficher les attributs enfants
conversation.featuredParticipants.avatarUrl
string
conversation.featuredParticipants.contact
object
Afficher les attributs enfants
conversation.featuredParticipants.contact.identifierKey
string
obligatoire
conversation.featuredParticipants.contact.identifierValue
string
obligatoire
conversation.featuredParticipants.contact.platformAddress
string
conversation.featuredParticipants.contact.platformAddressSelector
string
conversation.featuredParticipants.conversationId
string
conversation.featuredParticipants.createdAt
string
conversation.featuredParticipants.displayName
string
conversation.featuredParticipants.id
string
obligatoire
conversation.featuredParticipants.resourceUri
string
conversation.featuredParticipants.status
string
Possible values: invited, pending, active, inactive
conversation.featuredParticipants.type
string
obligatoire
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
conversation.featuredParticipants.updatedAt
string
conversation.hasDraft
boolean
conversation.id
string
obligatoire
conversation.inbox
object
Afficher les attributs enfants
conversation.inbox.id
string
obligatoire
conversation.inbox.identifier
string
obligatoire
conversation.inbox.ownerId
string
obligatoire
conversation.inbox.ownerType
string
obligatoire
Possible values: user, group
conversation.inbox.type
string
obligatoire
Possible values: personal, shared, support
conversation.initiatingParticipant
object
Afficher les attributs enfants
conversation.initiatingParticipant.avatarUrl
string
conversation.initiatingParticipant.contact
object
Afficher les attributs enfants
conversation.initiatingParticipant.contact.identifierKey
string
obligatoire
conversation.initiatingParticipant.contact.identifierValue
string
obligatoire
conversation.initiatingParticipant.contact.platformAddress
string
conversation.initiatingParticipant.contact.platformAddressSelector
string
conversation.initiatingParticipant.conversationId
string
conversation.initiatingParticipant.createdAt
string
conversation.initiatingParticipant.displayName
string
conversation.initiatingParticipant.id
string
obligatoire
conversation.initiatingParticipant.resourceUri
string
conversation.initiatingParticipant.status
string
Possible values: invited, pending, active, inactive
conversation.initiatingParticipant.type
string
obligatoire
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
conversation.initiatingParticipant.updatedAt
string
conversation.lastMessage
object
Afficher les attributs enfants
conversation.lastMessage.createdAt
string
obligatoire
conversation.lastMessage.draft
boolean
obligatoire
conversation.lastMessage.id
string
obligatoire
conversation.lastMessage.preview
object
obligatoire
Afficher les attributs enfants
conversation.lastMessage.preview.text
string
conversation.lastMessage.recipients
array of object
Afficher les attributs enfants
conversation.lastMessage.recipients.contactAnnotation
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Afficher les attributs enfants
conversation.lastMessage.recipients.contactAnnotation.name
string
conversation.lastMessage.recipients.countryCode
string
conversation.lastMessage.recipients.id
string
The ID of the contact.
conversation.lastMessage.recipients.identifierKey
string
The identifier key for finding the contact (e.g. emailaddress, phonenumber). For WhatsApp channels with BSUID support, use whatsappbsuid to send to a contact by their Business-Scoped User ID.
conversation.lastMessage.recipients.identifierValue
string
The identifier value for finding the contact.
conversation.lastMessage.recipients.identifiers
array of object
Additional identifiers to augment the contact during resolution.
Afficher les attributs enfants
conversation.lastMessage.recipients.identifiers.identifierKey
string
obligatoire
The identifier key for finding the contact (e.g. emailaddress, phonenumber).
conversation.lastMessage.recipients.identifiers.identifierValue
string
obligatoire
The identifier value for finding the contact.
conversation.lastMessage.recipients.platformAddress
string
The resolved platform address used to deliver the message (e.g. phone number or email address).
conversation.lastMessage.recipients.platformAddressSelector
string
An expression that defines how we resolve the platform address from a contact. Optional override for the default resolution logic.
conversation.lastMessage.recipients.receiverExpression
string
conversation.lastMessage.recipients.receiverValue
string
conversation.lastMessage.recipients.type
string
The type of the receiver (e.g. to, cc, bcc for email).
conversation.lastMessage.sender
object
Afficher les attributs enfants
conversation.lastMessage.sender.email
string
conversation.lastMessage.sender.name
string
conversation.lastMessage.sender.avatarUrl
string
conversation.lastMessage.sender.contact
object
Afficher les attributs enfants
conversation.lastMessage.sender.contact.identifierKey
string
obligatoire
conversation.lastMessage.sender.contact.identifierValue
string
obligatoire
conversation.lastMessage.sender.contact.platformAddress
string
conversation.lastMessage.sender.contact.platformAddressSelector
string
conversation.lastMessage.sender.conversationId
string
conversation.lastMessage.sender.createdAt
string
conversation.lastMessage.sender.displayName
string
conversation.lastMessage.sender.id
string
obligatoire
conversation.lastMessage.sender.resourceUri
string
conversation.lastMessage.sender.status
string
Possible values: invited, pending, active, inactive
conversation.lastMessage.sender.type
string
obligatoire
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
conversation.lastMessage.sender.updatedAt
string
conversation.lastMessage.status
string
obligatoire
Possible values: accepted, processing, sent, sending_failed, delivered, delivery_failed, deleted
conversation.lastMessage.type
string
obligatoire
Possible values: text, html, image, file, gif, location, carousel, list, section, authentication, action, comment
conversation.lastMessageIncomingAt
string
conversation.lastMessageOutgoingAt
string
conversation.name
string
obligatoire
conversation.participants
array of object
Afficher les attributs enfants
conversation.participants.contact
object
Afficher les attributs enfants
conversation.participants.contact.identifierKey
string
obligatoire
conversation.participants.contact.identifierValue
string
obligatoire
conversation.participants.contact.platformAddress
string
conversation.participants.contact.platformAddressSelector
string
conversation.participants.id
string
obligatoire
conversation.participants.type
string
obligatoire
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
conversation.pendingParticipantCount
integer
conversation.platformStyle
string
obligatoire
Possible values: direct, email, direct-multiple, direct-threaded, group-multiple
conversation.privateAttributes
string
conversation.read
boolean
conversation.referral
object
Afficher les attributs enfants
conversation.referral.caption
string
conversation.referral.mediaType
string
conversation.referral.mediaUrl
string
conversation.referral.sourceId
string
obligatoire
conversation.referral.sourceType
string
conversation.referral.sourceUrl
string
conversation.referral.text
string
conversation.referral.timestamp
string
conversation.referral.title
string
conversation.referral.username
string
conversation.resource
object
Afficher les attributs enfants
conversation.resource.id
string
obligatoire
conversation.resource.type
string
obligatoire
Possible values: task, task-conversation, reimbursement, sales-lead, sales-opportunity, sales-account, expense, project
conversation.resourceUri
string
conversation.starred
boolean
conversation.status
string
obligatoire
Possible values: deleted, active, closed, spam, archived
conversation.style
string
obligatoire
Possible values: default, directMessage, chatChannel, personalInbox, resource, groupInbox, support
conversation.summary
string
conversation.tags
array of string
conversation.updatedAt
string
obligatoire
conversation.visibility
string
obligatoire
Possible values: public, private, direct, group
conference
object
Afficher les attributs enfants
task
object
slaPolicy
object
Afficher les attributs enfants
slaPolicy.policyId
string
obligatoire
slaPolicy.timers
array of object
obligatoire
Afficher les attributs enfants
slaPolicy.timers.expiresAt
string
slaPolicy.timers.metric
string
obligatoire
Possible values: firstReplyTime, nextReplyTime
slaPolicy.timers.severity
string
obligatoire
Possible values: breach, warning
slaPolicy.timers.status
string
obligatoire
Possible values: inactive, active, completed, expired
requiredSkills
array of object
Afficher les attributs enfants
requiredSkills.id
string
obligatoire
requiredSkills.name
string
obligatoire
requiredSkills.selectedValues
array of object
obligatoire
Afficher les attributs enfants
requiredSkills.selectedValues.icon
string
requiredSkills.selectedValues.id
string
obligatoire
requiredSkills.selectedValues.value
string
obligatoire
requiredSkills.valueType
string
obligatoire
AgentSkillValueType defines how can the Values of a Skill can be selected.
Possible values: single, multiple, boolean
status
string
The slug that identifies the status of the root item.
statusCategory
string
The category maps to the lifecycle of a root item in the system.
Possible values: new, inProgress, pending, closed
Exemple de code
curl -X POST 'https://api.bird.com/workspaces/{workspaceId}/feeds/{feedId}/items/{itemId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
DELETE
/workspaces/{workspaceId}/feeds/{feedId}/items/{itemId}
Removes an item from a feed.
Exemple de code
curl -X DELETE 'https://api.bird.com/workspaces/{workspaceId}/feeds/{feedId}/items/{itemId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
POST
/workspaces/{workspaceId}/feeds/{feedId}/merge-items
Merges the feed item in the URL into the one specified in the request body.
Corps de la requête
mergeFrom
object
obligatoire
Afficher les paramètres enfants
mergeFrom.itemId
string
obligatoire
mergeFrom.message
object
Afficher les paramètres enfants
mergeFrom.message.reference
string
mergeFrom.message.participantId
string
obligatoire
mergeFrom.message.participantType
string
obligatoire
Possible values: user, contact, agent, flow
mergeFrom.message.recipients
array of object
obligatoire
Afficher les paramètres enfants
mergeFrom.message.recipients.id
string
mergeFrom.message.recipients.identifierKey
string
mergeFrom.message.recipients.identifierValue
string
mergeFrom.message.recipients.platformAddress
string
mergeFrom.message.recipients.platformAddressSelector
string
mergeFrom.message.recipients.type
string
Possible values: to, cc, bcc
mergeFrom.message.addMissingParticipants
boolean
mergeFrom.message.body
object
obligatoire
Afficher les paramètres enfants
mergeFrom.message.body.text
object
obligatoire
Afficher les paramètres enfants
mergeFrom.message.body.text.actions
array of object
Afficher les paramètres enfants
mergeFrom.message.body.text.actions.link
object
obligatoire
Afficher les paramètres enfants
mergeFrom.message.body.text.actions.link.metadata
object
Afficher les paramètres enfants
mergeFrom.message.body.text.actions.link.metadata.description
object
Afficher les paramètres enfants
mergeFrom.message.body.text.actions.link.metadata.description.label
string
obligatoire
mergeFrom.message.body.text.actions.link.text
string
obligatoire
mergeFrom.message.body.text.actions.link.url
string
obligatoire
mergeFrom.message.body.text.actions.type
string
obligatoire
Possible values: link
mergeFrom.message.body.text.attachments
array of object
Afficher les paramètres enfants
mergeFrom.message.body.text.attachments.content
string
mergeFrom.message.body.text.attachments.contentId
string
mergeFrom.message.body.text.attachments.contentType
string
mergeFrom.message.body.text.attachments.filename
string
obligatoire
mergeFrom.message.body.text.attachments.inline
boolean
mergeFrom.message.body.text.attachments.mediaUrl
string
obligatoire
mergeFrom.message.body.text.metadata
object
Afficher les paramètres enfants
mergeFrom.message.body.text.metadata.apple
object
Afficher les paramètres enfants
mergeFrom.message.body.text.metadata.apple.appClipPreview
boolean
mergeFrom.message.body.text.metadata.apple.appClipRegion
string
mergeFrom.message.body.text.metadata.apple.summaryText
string
mergeFrom.message.body.text.metadata.headers
object
mergeFrom.message.body.text.metadata.line
object
Afficher les paramètres enfants
mergeFrom.message.body.text.metadata.line.emoji
object
Afficher les paramètres enfants
mergeFrom.message.body.text.metadata.line.emoji.items
array of object
Afficher les paramètres enfants
mergeFrom.message.body.text.metadata.line.emoji.items.emojiId
string
obligatoire
mergeFrom.message.body.text.metadata.line.emoji.items.index
integer
obligatoire
mergeFrom.message.body.text.metadata.line.emoji.items.length
integer
mergeFrom.message.body.text.metadata.line.emoji.items.productId
string
obligatoire
mergeFrom.message.body.text.metadata.paymentDetails
object
Afficher les paramètres enfants
mergeFrom.message.body.text.metadata.paymentDetails.amount
string
obligatoire
mergeFrom.message.body.text.metadata.paymentDetails.currency
string
obligatoire
mergeFrom.message.body.text.metadata.paymentDetails.sessionIdentifier
string
mergeFrom.message.body.text.metadata.paymentDetails.state
string
obligatoire
mergeFrom.message.body.text.metadata.subject
string
mergeFrom.message.body.text.metadata.telegram
object
Afficher les paramètres enfants
mergeFrom.message.body.text.metadata.telegram.parseMode
string
mergeFrom.message.body.text.metadata.whatsapp
object
Afficher les paramètres enfants
mergeFrom.message.body.text.metadata.whatsapp.callPermissionExpiration
string
mergeFrom.message.body.text.metadata.whatsapp.callPermissionResponse
string
Possible values: accept, reject
mergeFrom.message.body.text.metadata.whatsapp.previewUrl
boolean
obligatoire
mergeFrom.message.body.text.metadata.whatsapp.sharedContacts
array of object
Afficher les paramètres enfants
mergeFrom.message.body.text.metadata.whatsapp.sharedContacts.origin
string
obligatoire
mergeFrom.message.body.text.metadata.whatsapp.sharedContacts.phones
array of object
Afficher les paramètres enfants
mergeFrom.message.body.text.metadata.whatsapp.sharedContacts.phones.phone
string
obligatoire
mergeFrom.message.body.text.metadata.whatsapp.sharedContacts.phones.type
string
obligatoire
mergeFrom.message.body.text.metadata.whatsapp.sharedContacts.phones.waId
string
obligatoire
mergeFrom.message.body.text.metadata.whatsapp.sharedContacts.vcard
string
mergeFrom.message.body.text.text
string
obligatoire
mergeFrom.message.body.type
string
obligatoire
Possible values: text
mergeFrom.comment
object
Afficher les paramètres enfants
mergeFrom.comment.body
object
obligatoire
Afficher les paramètres enfants
mergeFrom.comment.body.type
string
obligatoire
Possible values: text
mergeFrom.comment.body.text
object
obligatoire
Afficher les paramètres enfants
mergeFrom.comment.body.text.text
string
obligatoire
mergeFrom.comment.mentions
object
Afficher les paramètres enfants
mergeFrom.comment.mentions.notify
object
Notify are notification settings for mentions in comments. Every new mentioned individual will be notified the moment they are added as a mention. If OnUpdate is true, existing mentions will be notified when a comment is changed. If OnDelete is true, mentions will get notified when the comment gets deleted.
Afficher les paramètres enfants
mergeFrom.comment.mentions.notify.onUpdate
boolean
mergeFrom.comment.mentions.notify.onDelete
boolean
mergeFrom.comment.mentions.identifiers
array of object
obligatoire
Afficher les paramètres enfants
mergeFrom.comment.mentions.identifiers.id
string
Only agent IDs are supported at the moment.
mergeFrom.comment.replyTo
object
Afficher les paramètres enfants
mergeFrom.comment.replyTo.id
string
obligatoire
mergeFrom.comment.replyTo.type
string
obligatoire
Possible values: comment, message
mergeInto
object
obligatoire
Afficher les paramètres enfants
mergeInto.itemId
string
obligatoire
mergeInto.message
object
Afficher les paramètres enfants
mergeInto.message.reference
string
mergeInto.message.participantId
string
obligatoire
mergeInto.message.participantType
string
obligatoire
Possible values: user, contact, agent, flow
mergeInto.message.recipients
array of object
obligatoire
Afficher les paramètres enfants
mergeInto.message.recipients.id
string
mergeInto.message.recipients.identifierKey
string
mergeInto.message.recipients.identifierValue
string
mergeInto.message.recipients.platformAddress
string
mergeInto.message.recipients.platformAddressSelector
string
mergeInto.message.recipients.type
string
Possible values: to, cc, bcc
mergeInto.message.addMissingParticipants
boolean
mergeInto.message.body
object
obligatoire
Afficher les paramètres enfants
mergeInto.message.body.text
object
obligatoire
Afficher les paramètres enfants
mergeInto.message.body.text.actions
array of object
Afficher les paramètres enfants
mergeInto.message.body.text.actions.link
object
obligatoire
Afficher les paramètres enfants
mergeInto.message.body.text.actions.link.metadata
object
Afficher les paramètres enfants
mergeInto.message.body.text.actions.link.metadata.description
object
Afficher les paramètres enfants
mergeInto.message.body.text.actions.link.metadata.description.label
string
obligatoire
mergeInto.message.body.text.actions.link.text
string
obligatoire
mergeInto.message.body.text.actions.link.url
string
obligatoire
mergeInto.message.body.text.actions.type
string
obligatoire
Possible values: link
mergeInto.message.body.text.attachments
array of object
Afficher les paramètres enfants
mergeInto.message.body.text.attachments.content
string
mergeInto.message.body.text.attachments.contentId
string
mergeInto.message.body.text.attachments.contentType
string
mergeInto.message.body.text.attachments.filename
string
obligatoire
mergeInto.message.body.text.attachments.inline
boolean
mergeInto.message.body.text.attachments.mediaUrl
string
obligatoire
mergeInto.message.body.text.metadata
object
Afficher les paramètres enfants
mergeInto.message.body.text.metadata.apple
object
Afficher les paramètres enfants
mergeInto.message.body.text.metadata.apple.appClipPreview
boolean
mergeInto.message.body.text.metadata.apple.appClipRegion
string
mergeInto.message.body.text.metadata.apple.summaryText
string
mergeInto.message.body.text.metadata.headers
object
mergeInto.message.body.text.metadata.line
object
Afficher les paramètres enfants
mergeInto.message.body.text.metadata.line.emoji
object
Afficher les paramètres enfants
mergeInto.message.body.text.metadata.line.emoji.items
array of object
Afficher les paramètres enfants
mergeInto.message.body.text.metadata.line.emoji.items.emojiId
string
obligatoire
mergeInto.message.body.text.metadata.line.emoji.items.index
integer
obligatoire
mergeInto.message.body.text.metadata.line.emoji.items.length
integer
mergeInto.message.body.text.metadata.line.emoji.items.productId
string
obligatoire
mergeInto.message.body.text.metadata.paymentDetails
object
Afficher les paramètres enfants
mergeInto.message.body.text.metadata.paymentDetails.amount
string
obligatoire
mergeInto.message.body.text.metadata.paymentDetails.currency
string
obligatoire
mergeInto.message.body.text.metadata.paymentDetails.sessionIdentifier
string
mergeInto.message.body.text.metadata.paymentDetails.state
string
obligatoire
mergeInto.message.body.text.metadata.subject
string
mergeInto.message.body.text.metadata.telegram
object
Afficher les paramètres enfants
mergeInto.message.body.text.metadata.telegram.parseMode
string
mergeInto.message.body.text.metadata.whatsapp
object
Afficher les paramètres enfants
mergeInto.message.body.text.metadata.whatsapp.callPermissionExpiration
string
mergeInto.message.body.text.metadata.whatsapp.callPermissionResponse
string
Possible values: accept, reject
mergeInto.message.body.text.metadata.whatsapp.previewUrl
boolean
obligatoire
mergeInto.message.body.text.metadata.whatsapp.sharedContacts
array of object
Afficher les paramètres enfants
mergeInto.message.body.text.metadata.whatsapp.sharedContacts.origin
string
obligatoire
mergeInto.message.body.text.metadata.whatsapp.sharedContacts.phones
array of object
Afficher les paramètres enfants
mergeInto.message.body.text.metadata.whatsapp.sharedContacts.phones.phone
string
obligatoire
mergeInto.message.body.text.metadata.whatsapp.sharedContacts.phones.type
string
obligatoire
mergeInto.message.body.text.metadata.whatsapp.sharedContacts.phones.waId
string
obligatoire
mergeInto.message.body.text.metadata.whatsapp.sharedContacts.vcard
string
mergeInto.message.body.text.text
string
obligatoire
mergeInto.message.body.type
string
obligatoire
Possible values: text
mergeInto.comment
object
Afficher les paramètres enfants
mergeInto.comment.body
object
obligatoire
Afficher les paramètres enfants
mergeInto.comment.body.type
string
obligatoire
Possible values: text
mergeInto.comment.body.text
object
obligatoire
Afficher les paramètres enfants
mergeInto.comment.body.text.text
string
obligatoire
mergeInto.comment.mentions
object
Afficher les paramètres enfants
mergeInto.comment.mentions.notify
object
Notify are notification settings for mentions in comments. Every new mentioned individual will be notified the moment they are added as a mention. If OnUpdate is true, existing mentions will be notified when a comment is changed. If OnDelete is true, mentions will get notified when the comment gets deleted.
Afficher les paramètres enfants
mergeInto.comment.mentions.notify.onUpdate
boolean
mergeInto.comment.mentions.notify.onDelete
boolean
mergeInto.comment.mentions.identifiers
array of object
obligatoire
Afficher les paramètres enfants
mergeInto.comment.mentions.identifiers.id
string
Only agent IDs are supported at the moment.
mergeInto.comment.replyTo
object
Afficher les paramètres enfants
mergeInto.comment.replyTo.id
string
obligatoire
mergeInto.comment.replyTo.type
string
obligatoire
Possible values: comment, message
Corps de la réponse
mergedFrom
object
obligatoire
Afficher les attributs enfants
mergedFrom.id
string
obligatoire
mergedFrom.feedId
string
mergedFrom.feedIndexId
string
mergedFrom.feedIndexType
string
mergedFrom.agent
object
Afficher les attributs enfants
mergedFrom.agent.id
string
obligatoire
mergedFrom.agent.name
string
obligatoire
mergedFrom.agent.avatarUrl
string
mergedFrom.team
object
Afficher les attributs enfants
mergedFrom.team.id
string
obligatoire
mergedFrom.team.name
string
obligatoire
mergedFrom.team.avatarUrl
string
mergedFrom.number
integer
mergedFrom.type
string
obligatoire
Possible values: conversation, conference, task
mergedFrom.archived
boolean
obligatoire
mergedFrom.closed
boolean
obligatoire
mergedFrom.private
boolean
mergedFrom.deleted
boolean
mergedFrom.spam
boolean
mergedFrom.senderBlocked
boolean
mergedFrom.seen
boolean
mergedFrom.seenBy
string
mergedFrom.replySuggestion
string
mergedFrom.createdAt
string
obligatoire
mergedFrom.willBeDeletedAt
string
mergedFrom.lastActivityAt
string
obligatoire
mergedFrom.lastMessageByContactAt
string
mergedFrom.tags
array of object
Afficher les attributs enfants
mergedFrom.tags.id
string
obligatoire
mergedFrom.tags.name
string
obligatoire
mergedFrom.tags.status
string
obligatoire
Possible values: draft, active, deleted
mergedFrom.tags.addedAt
string
obligatoire
mergedFrom.tags.category
object
Afficher les attributs enfants
mergedFrom.tags.category.id
string
mergedFrom.tags.category.name
string
mergedFrom.tags.category.emoji
string
mergedFrom.attributes
array of object
Afficher les attributs enfants
mergedFrom.attributes.key
string
mergedFrom.attributes.value
string
mergedFrom.customAttributes
object
Use dynamicFields instead.
mergedFrom.filters
array of array of object
Afficher les attributs enfants
mergedFrom.filters.key
string
mergedFrom.filters.value
string
mergedFrom.linkedItems
array of object
Afficher les attributs enfants
mergedFrom.linkedItems.userId
string
The id of the user that set up this relation.
mergedFrom.linkedItems.relation
string
Possible values: linkedTo, parentOf, childOf, parentOfTask, taskChildOf
mergedFrom.linkedItems.itemId
string
The id of the linked item.
mergedFrom.linkedItems.itemNumber
integer
mergedFrom.linkedItems.itemSubject
string
mergedFrom.linkedItems.createdAt
string
mergedFrom.mergeInfo
object
Afficher les attributs enfants
mergedFrom.mergeInfo.mergedFrom
array of object
Afficher les attributs enfants
mergedFrom.mergeInfo.mergedFrom.userId
string
obligatoire
mergedFrom.mergeInfo.mergedFrom.itemId
string
obligatoire
mergedFrom.mergeInfo.mergedFrom.createdAt
string
obligatoire
mergedFrom.mergeInfo.mergedInto
object
Afficher les attributs enfants
mergedFrom.mergeInfo.mergedInto.userId
string
obligatoire
mergedFrom.mergeInfo.mergedInto.itemId
string
obligatoire
mergedFrom.mergeInfo.mergedInto.createdAt
string
obligatoire
mergedFrom.dynamicFields
object
Afficher les attributs enfants
mergedFrom.dynamicFields.settingsId
string
obligatoire
Either the uuid settings id, or "default" to use the default settings.
mergedFrom.dynamicFields.fields
array of object
obligatoire
Afficher les attributs enfants
mergedFrom.dynamicFields.fields.id
string
mergedFrom.dynamicFields.fields.name
string
obligatoire
mergedFrom.dynamicFields.fields.description
string
mergedFrom.dynamicFields.fields.type
string
obligatoire
Possible values: single, multiple, numeric, text, boolean, date
mergedFrom.dynamicFields.fields.values
array of object
Afficher les attributs enfants
mergedFrom.dynamicFields.fields.values.id
string
obligatoire
mergedFrom.dynamicFields.fields.values.value
string
obligatoire
mergedFrom.dynamicFields.fields.values.icon
string
mergedFrom.dynamicFields.fields.values.createdAt
string
obligatoire
mergedFrom.dynamicFields.fields.values.selected
boolean
obligatoire
mergedFrom.dynamicFields.fields.valueText
string
mergedFrom.dynamicFields.fields.valueNumber
number
mergedFrom.dynamicFields.fields.valueBoolean
boolean
mergedFrom.dynamicFields.fields.valueDate
string
mergedFrom.dynamicFields.fields.settings
object
mergedFrom.summaryForm
object
Afficher les attributs enfants
mergedFrom.summaryForm.settingsId
string
obligatoire
Either the uuid settings id, or "default" to use the default settings.
mergedFrom.summaryForm.fields
array of object
obligatoire
Afficher les attributs enfants
mergedFrom.summaryForm.fields.id
string
mergedFrom.summaryForm.fields.name
string
obligatoire
mergedFrom.summaryForm.fields.description
string
mergedFrom.summaryForm.fields.type
string
obligatoire
Possible values: single, multiple, numeric, text, boolean, date
mergedFrom.summaryForm.fields.values
array of object
Afficher les attributs enfants
mergedFrom.summaryForm.fields.values.id
string
obligatoire
mergedFrom.summaryForm.fields.values.value
string
obligatoire
mergedFrom.summaryForm.fields.values.icon
string
mergedFrom.summaryForm.fields.values.createdAt
string
obligatoire
mergedFrom.summaryForm.fields.values.selected
boolean
obligatoire
mergedFrom.summaryForm.fields.valueText
string
mergedFrom.summaryForm.fields.valueNumber
number
mergedFrom.summaryForm.fields.valueBoolean
boolean
mergedFrom.summaryForm.fields.valueDate
string
mergedFrom.summaryForm.fields.settings
object
mergedFrom.queueInfo
object
Afficher les attributs enfants
mergedFrom.queueInfo.queueId
string
obligatoire
mergedFrom.queueInfo.queueName
string
obligatoire
mergedFrom.queueInfo.queuedAt
string
obligatoire
mergedFrom.conversation
object
Afficher les attributs enfants
mergedFrom.conversation.accessibility
string
obligatoire
Possible values: open, invite-only, request-to-join, private
mergedFrom.conversation.activeParticipantCount
integer
obligatoire
mergedFrom.conversation.assigneeId
string
mergedFrom.conversation.attributes
object
mergedFrom.conversation.category
string
mergedFrom.conversation.channelId
string
obligatoire
mergedFrom.conversation.createdAt
string
obligatoire
mergedFrom.conversation.description
string
mergedFrom.conversation.directory
string
mergedFrom.conversation.featuredParticipants
array of object
obligatoire
Afficher les attributs enfants
mergedFrom.conversation.featuredParticipants.avatarUrl
string
mergedFrom.conversation.featuredParticipants.contact
object
Afficher les attributs enfants
mergedFrom.conversation.featuredParticipants.contact.identifierKey
string
obligatoire
mergedFrom.conversation.featuredParticipants.contact.identifierValue
string
obligatoire
mergedFrom.conversation.featuredParticipants.contact.platformAddress
string
mergedFrom.conversation.featuredParticipants.contact.platformAddressSelector
string
mergedFrom.conversation.featuredParticipants.conversationId
string
mergedFrom.conversation.featuredParticipants.createdAt
string
mergedFrom.conversation.featuredParticipants.displayName
string
mergedFrom.conversation.featuredParticipants.id
string
obligatoire
mergedFrom.conversation.featuredParticipants.resourceUri
string
mergedFrom.conversation.featuredParticipants.status
string
Possible values: invited, pending, active, inactive
mergedFrom.conversation.featuredParticipants.type
string
obligatoire
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
mergedFrom.conversation.featuredParticipants.updatedAt
string
mergedFrom.conversation.hasDraft
boolean
mergedFrom.conversation.id
string
obligatoire
mergedFrom.conversation.inbox
object
Afficher les attributs enfants
mergedFrom.conversation.inbox.id
string
obligatoire
mergedFrom.conversation.inbox.identifier
string
obligatoire
mergedFrom.conversation.inbox.ownerId
string
obligatoire
mergedFrom.conversation.inbox.ownerType
string
obligatoire
Possible values: user, group
mergedFrom.conversation.inbox.type
string
obligatoire
Possible values: personal, shared, support
mergedFrom.conversation.initiatingParticipant
object
Afficher les attributs enfants
mergedFrom.conversation.initiatingParticipant.avatarUrl
string
mergedFrom.conversation.initiatingParticipant.contact
object
Afficher les attributs enfants
mergedFrom.conversation.initiatingParticipant.contact.identifierKey
string
obligatoire
mergedFrom.conversation.initiatingParticipant.contact.identifierValue
string
obligatoire
mergedFrom.conversation.initiatingParticipant.contact.platformAddress
string
mergedFrom.conversation.initiatingParticipant.contact.platformAddressSelector
string
mergedFrom.conversation.initiatingParticipant.conversationId
string
mergedFrom.conversation.initiatingParticipant.createdAt
string
mergedFrom.conversation.initiatingParticipant.displayName
string
mergedFrom.conversation.initiatingParticipant.id
string
obligatoire
mergedFrom.conversation.initiatingParticipant.resourceUri
string
mergedFrom.conversation.initiatingParticipant.status
string
Possible values: invited, pending, active, inactive
mergedFrom.conversation.initiatingParticipant.type
string
obligatoire
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
mergedFrom.conversation.initiatingParticipant.updatedAt
string
mergedFrom.conversation.lastMessage
object
Afficher les attributs enfants
mergedFrom.conversation.lastMessage.createdAt
string
obligatoire
mergedFrom.conversation.lastMessage.draft
boolean
obligatoire
mergedFrom.conversation.lastMessage.id
string
obligatoire
mergedFrom.conversation.lastMessage.preview
object
obligatoire
Afficher les attributs enfants
mergedFrom.conversation.lastMessage.preview.text
string
mergedFrom.conversation.lastMessage.recipients
array of object
Afficher les attributs enfants
mergedFrom.conversation.lastMessage.recipients.contactAnnotation
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Afficher les attributs enfants
mergedFrom.conversation.lastMessage.recipients.contactAnnotation.name
string
mergedFrom.conversation.lastMessage.recipients.countryCode
string
mergedFrom.conversation.lastMessage.recipients.id
string
The ID of the contact.
mergedFrom.conversation.lastMessage.recipients.identifierKey
string
The identifier key for finding the contact (e.g. emailaddress, phonenumber). For WhatsApp channels with BSUID support, use whatsappbsuid to send to a contact by their Business-Scoped User ID.
mergedFrom.conversation.lastMessage.recipients.identifierValue
string
The identifier value for finding the contact.
mergedFrom.conversation.lastMessage.recipients.identifiers
array of object
Additional identifiers to augment the contact during resolution.
Afficher les attributs enfants
mergedFrom.conversation.lastMessage.recipients.identifiers.identifierKey
string
obligatoire
The identifier key for finding the contact (e.g. emailaddress, phonenumber).
mergedFrom.conversation.lastMessage.recipients.identifiers.identifierValue
string
obligatoire
The identifier value for finding the contact.
mergedFrom.conversation.lastMessage.recipients.platformAddress
string
The resolved platform address used to deliver the message (e.g. phone number or email address).
mergedFrom.conversation.lastMessage.recipients.platformAddressSelector
string
An expression that defines how we resolve the platform address from a contact. Optional override for the default resolution logic.
mergedFrom.conversation.lastMessage.recipients.receiverExpression
string
mergedFrom.conversation.lastMessage.recipients.receiverValue
string
mergedFrom.conversation.lastMessage.recipients.type
string
The type of the receiver (e.g. to, cc, bcc for email).
mergedFrom.conversation.lastMessage.sender
object
Afficher les attributs enfants
mergedFrom.conversation.lastMessage.sender.email
string
mergedFrom.conversation.lastMessage.sender.name
string
mergedFrom.conversation.lastMessage.sender.avatarUrl
string
mergedFrom.conversation.lastMessage.sender.contact
object
Afficher les attributs enfants
mergedFrom.conversation.lastMessage.sender.contact.identifierKey
string
obligatoire
mergedFrom.conversation.lastMessage.sender.contact.identifierValue
string
obligatoire
mergedFrom.conversation.lastMessage.sender.contact.platformAddress
string
mergedFrom.conversation.lastMessage.sender.contact.platformAddressSelector
string
mergedFrom.conversation.lastMessage.sender.conversationId
string
mergedFrom.conversation.lastMessage.sender.createdAt
string
mergedFrom.conversation.lastMessage.sender.displayName
string
mergedFrom.conversation.lastMessage.sender.id
string
obligatoire
mergedFrom.conversation.lastMessage.sender.resourceUri
string
mergedFrom.conversation.lastMessage.sender.status
string
Possible values: invited, pending, active, inactive
mergedFrom.conversation.lastMessage.sender.type
string
obligatoire
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
mergedFrom.conversation.lastMessage.sender.updatedAt
string
mergedFrom.conversation.lastMessage.status
string
obligatoire
Possible values: accepted, processing, sent, sending_failed, delivered, delivery_failed, deleted
mergedFrom.conversation.lastMessage.type
string
obligatoire
Possible values: text, html, image, file, gif, location, carousel, list, section, authentication, action, comment
mergedFrom.conversation.lastMessageIncomingAt
string
mergedFrom.conversation.lastMessageOutgoingAt
string
mergedFrom.conversation.name
string
obligatoire
mergedFrom.conversation.participants
array of object
Afficher les attributs enfants
mergedFrom.conversation.participants.contact
object
Afficher les attributs enfants
mergedFrom.conversation.participants.contact.identifierKey
string
obligatoire
mergedFrom.conversation.participants.contact.identifierValue
string
obligatoire
mergedFrom.conversation.participants.contact.platformAddress
string
mergedFrom.conversation.participants.contact.platformAddressSelector
string
mergedFrom.conversation.participants.id
string
obligatoire
mergedFrom.conversation.participants.type
string
obligatoire
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
mergedFrom.conversation.pendingParticipantCount
integer
mergedFrom.conversation.platformStyle
string
obligatoire
Possible values: direct, email, direct-multiple, direct-threaded, group-multiple
mergedFrom.conversation.privateAttributes
string
mergedFrom.conversation.read
boolean
mergedFrom.conversation.referral
object
Afficher les attributs enfants
mergedFrom.conversation.referral.caption
string
mergedFrom.conversation.referral.mediaType
string
mergedFrom.conversation.referral.mediaUrl
string
mergedFrom.conversation.referral.sourceId
string
obligatoire
mergedFrom.conversation.referral.sourceType
string
mergedFrom.conversation.referral.sourceUrl
string
mergedFrom.conversation.referral.text
string
mergedFrom.conversation.referral.timestamp
string
mergedFrom.conversation.referral.title
string
mergedFrom.conversation.referral.username
string
mergedFrom.conversation.resource
object
Afficher les attributs enfants
mergedFrom.conversation.resource.id
string
obligatoire
mergedFrom.conversation.resource.type
string
obligatoire
Possible values: task, task-conversation, reimbursement, sales-lead, sales-opportunity, sales-account, expense, project
mergedFrom.conversation.resourceUri
string
mergedFrom.conversation.starred
boolean
mergedFrom.conversation.status
string
obligatoire
Possible values: deleted, active, closed, spam, archived
mergedFrom.conversation.style
string
obligatoire
Possible values: default, directMessage, chatChannel, personalInbox, resource, groupInbox, support
mergedFrom.conversation.summary
string
mergedFrom.conversation.tags
array of string
mergedFrom.conversation.updatedAt
string
obligatoire
mergedFrom.conversation.visibility
string
obligatoire
Possible values: public, private, direct, group
mergedFrom.conference
object
Afficher les attributs enfants
mergedFrom.task
object
mergedFrom.slaPolicy
object
Afficher les attributs enfants
mergedFrom.slaPolicy.policyId
string
obligatoire
mergedFrom.slaPolicy.timers
array of object
obligatoire
Afficher les attributs enfants
mergedFrom.slaPolicy.timers.expiresAt
string
mergedFrom.slaPolicy.timers.metric
string
obligatoire
Possible values: firstReplyTime, nextReplyTime
mergedFrom.slaPolicy.timers.severity
string
obligatoire
Possible values: breach, warning
mergedFrom.slaPolicy.timers.status
string
obligatoire
Possible values: inactive, active, completed, expired
mergedFrom.requiredSkills
array of object
Afficher les attributs enfants
mergedFrom.requiredSkills.id
string
obligatoire
mergedFrom.requiredSkills.name
string
obligatoire
mergedFrom.requiredSkills.selectedValues
array of object
obligatoire
Afficher les attributs enfants
mergedFrom.requiredSkills.selectedValues.icon
string
mergedFrom.requiredSkills.selectedValues.id
string
obligatoire
mergedFrom.requiredSkills.selectedValues.value
string
obligatoire
mergedFrom.requiredSkills.valueType
string
obligatoire
AgentSkillValueType defines how can the Values of a Skill can be selected.
Possible values: single, multiple, boolean
mergedFrom.status
string
The slug that identifies the status of the root item.
mergedFrom.statusCategory
string
The category maps to the lifecycle of a root item in the system.
Possible values: new, inProgress, pending, closed
mergedInto
object
obligatoire
Afficher les attributs enfants
mergedInto.id
string
obligatoire
mergedInto.feedId
string
mergedInto.feedIndexId
string
mergedInto.feedIndexType
string
mergedInto.agent
object
Afficher les attributs enfants
mergedInto.agent.id
string
obligatoire
mergedInto.agent.name
string
obligatoire
mergedInto.agent.avatarUrl
string
mergedInto.team
object
Afficher les attributs enfants
mergedInto.team.id
string
obligatoire
mergedInto.team.name
string
obligatoire
mergedInto.team.avatarUrl
string
mergedInto.number
integer
mergedInto.type
string
obligatoire
Possible values: conversation, conference, task
mergedInto.archived
boolean
obligatoire
mergedInto.closed
boolean
obligatoire
mergedInto.private
boolean
mergedInto.deleted
boolean
mergedInto.spam
boolean
mergedInto.senderBlocked
boolean
mergedInto.seen
boolean
mergedInto.seenBy
string
mergedInto.replySuggestion
string
mergedInto.createdAt
string
obligatoire
mergedInto.willBeDeletedAt
string
mergedInto.lastActivityAt
string
obligatoire
mergedInto.lastMessageByContactAt
string
mergedInto.tags
array of object
Afficher les attributs enfants
mergedInto.tags.id
string
obligatoire
mergedInto.tags.name
string
obligatoire
mergedInto.tags.status
string
obligatoire
Possible values: draft, active, deleted
mergedInto.tags.addedAt
string
obligatoire
mergedInto.tags.category
object
Afficher les attributs enfants
mergedInto.tags.category.id
string
mergedInto.tags.category.name
string
mergedInto.tags.category.emoji
string
mergedInto.attributes
array of object
Afficher les attributs enfants
mergedInto.attributes.key
string
mergedInto.attributes.value
string
mergedInto.customAttributes
object
Use dynamicFields instead.
mergedInto.filters
array of array of object
Afficher les attributs enfants
mergedInto.filters.key
string
mergedInto.filters.value
string
mergedInto.linkedItems
array of object
Afficher les attributs enfants
mergedInto.linkedItems.userId
string
The id of the user that set up this relation.
mergedInto.linkedItems.relation
string
Possible values: linkedTo, parentOf, childOf, parentOfTask, taskChildOf
mergedInto.linkedItems.itemId
string
The id of the linked item.
mergedInto.linkedItems.itemNumber
integer
mergedInto.linkedItems.itemSubject
string
mergedInto.linkedItems.createdAt
string
mergedInto.mergeInfo
object
Afficher les attributs enfants
mergedInto.mergeInfo.mergedFrom
array of object
Afficher les attributs enfants
mergedInto.mergeInfo.mergedFrom.userId
string
obligatoire
mergedInto.mergeInfo.mergedFrom.itemId
string
obligatoire
mergedInto.mergeInfo.mergedFrom.createdAt
string
obligatoire
mergedInto.mergeInfo.mergedInto
object
Afficher les attributs enfants
mergedInto.mergeInfo.mergedInto.userId
string
obligatoire
mergedInto.mergeInfo.mergedInto.itemId
string
obligatoire
mergedInto.mergeInfo.mergedInto.createdAt
string
obligatoire
mergedInto.dynamicFields
object
Afficher les attributs enfants
mergedInto.dynamicFields.settingsId
string
obligatoire
Either the uuid settings id, or "default" to use the default settings.
mergedInto.dynamicFields.fields
array of object
obligatoire
Afficher les attributs enfants
mergedInto.dynamicFields.fields.id
string
mergedInto.dynamicFields.fields.name
string
obligatoire
mergedInto.dynamicFields.fields.description
string
mergedInto.dynamicFields.fields.type
string
obligatoire
Possible values: single, multiple, numeric, text, boolean, date
mergedInto.dynamicFields.fields.values
array of object
Afficher les attributs enfants
mergedInto.dynamicFields.fields.values.id
string
obligatoire
mergedInto.dynamicFields.fields.values.value
string
obligatoire
mergedInto.dynamicFields.fields.values.icon
string
mergedInto.dynamicFields.fields.values.createdAt
string
obligatoire
mergedInto.dynamicFields.fields.values.selected
boolean
obligatoire
mergedInto.dynamicFields.fields.valueText
string
mergedInto.dynamicFields.fields.valueNumber
number
mergedInto.dynamicFields.fields.valueBoolean
boolean
mergedInto.dynamicFields.fields.valueDate
string
mergedInto.dynamicFields.fields.settings
object
mergedInto.summaryForm
object
Afficher les attributs enfants
mergedInto.summaryForm.settingsId
string
obligatoire
Either the uuid settings id, or "default" to use the default settings.
mergedInto.summaryForm.fields
array of object
obligatoire
Afficher les attributs enfants
mergedInto.summaryForm.fields.id
string
mergedInto.summaryForm.fields.name
string
obligatoire
mergedInto.summaryForm.fields.description
string
mergedInto.summaryForm.fields.type
string
obligatoire
Possible values: single, multiple, numeric, text, boolean, date
mergedInto.summaryForm.fields.values
array of object
Afficher les attributs enfants
mergedInto.summaryForm.fields.values.id
string
obligatoire
mergedInto.summaryForm.fields.values.value
string
obligatoire
mergedInto.summaryForm.fields.values.icon
string
mergedInto.summaryForm.fields.values.createdAt
string
obligatoire
mergedInto.summaryForm.fields.values.selected
boolean
obligatoire
mergedInto.summaryForm.fields.valueText
string
mergedInto.summaryForm.fields.valueNumber
number
mergedInto.summaryForm.fields.valueBoolean
boolean
mergedInto.summaryForm.fields.valueDate
string
mergedInto.summaryForm.fields.settings
object
mergedInto.queueInfo
object
Afficher les attributs enfants
mergedInto.queueInfo.queueId
string
obligatoire
mergedInto.queueInfo.queueName
string
obligatoire
mergedInto.queueInfo.queuedAt
string
obligatoire
mergedInto.conversation
object
Afficher les attributs enfants
mergedInto.conversation.accessibility
string
obligatoire
Possible values: open, invite-only, request-to-join, private
mergedInto.conversation.activeParticipantCount
integer
obligatoire
mergedInto.conversation.assigneeId
string
mergedInto.conversation.attributes
object
mergedInto.conversation.category
string
mergedInto.conversation.channelId
string
obligatoire
mergedInto.conversation.createdAt
string
obligatoire
mergedInto.conversation.description
string
mergedInto.conversation.directory
string
mergedInto.conversation.featuredParticipants
array of object
obligatoire
Afficher les attributs enfants
mergedInto.conversation.featuredParticipants.avatarUrl
string
mergedInto.conversation.featuredParticipants.contact
object
Afficher les attributs enfants
mergedInto.conversation.featuredParticipants.contact.identifierKey
string
obligatoire
mergedInto.conversation.featuredParticipants.contact.identifierValue
string
obligatoire
mergedInto.conversation.featuredParticipants.contact.platformAddress
string
mergedInto.conversation.featuredParticipants.contact.platformAddressSelector
string
mergedInto.conversation.featuredParticipants.conversationId
string
mergedInto.conversation.featuredParticipants.createdAt
string
mergedInto.conversation.featuredParticipants.displayName
string
mergedInto.conversation.featuredParticipants.id
string
obligatoire
mergedInto.conversation.featuredParticipants.resourceUri
string
mergedInto.conversation.featuredParticipants.status
string
Possible values: invited, pending, active, inactive
mergedInto.conversation.featuredParticipants.type
string
obligatoire
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
mergedInto.conversation.featuredParticipants.updatedAt
string
mergedInto.conversation.hasDraft
boolean
mergedInto.conversation.id
string
obligatoire
mergedInto.conversation.inbox
object
Afficher les attributs enfants
mergedInto.conversation.inbox.id
string
obligatoire
mergedInto.conversation.inbox.identifier
string
obligatoire
mergedInto.conversation.inbox.ownerId
string
obligatoire
mergedInto.conversation.inbox.ownerType
string
obligatoire
Possible values: user, group
mergedInto.conversation.inbox.type
string
obligatoire
Possible values: personal, shared, support
mergedInto.conversation.initiatingParticipant
object
Afficher les attributs enfants
mergedInto.conversation.initiatingParticipant.avatarUrl
string
mergedInto.conversation.initiatingParticipant.contact
object
Afficher les attributs enfants
mergedInto.conversation.initiatingParticipant.contact.identifierKey
string
obligatoire
mergedInto.conversation.initiatingParticipant.contact.identifierValue
string
obligatoire
mergedInto.conversation.initiatingParticipant.contact.platformAddress
string
mergedInto.conversation.initiatingParticipant.contact.platformAddressSelector
string
mergedInto.conversation.initiatingParticipant.conversationId
string
mergedInto.conversation.initiatingParticipant.createdAt
string
mergedInto.conversation.initiatingParticipant.displayName
string
mergedInto.conversation.initiatingParticipant.id
string
obligatoire
mergedInto.conversation.initiatingParticipant.resourceUri
string
mergedInto.conversation.initiatingParticipant.status
string
Possible values: invited, pending, active, inactive
mergedInto.conversation.initiatingParticipant.type
string
obligatoire
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
mergedInto.conversation.initiatingParticipant.updatedAt
string
mergedInto.conversation.lastMessage
object
Afficher les attributs enfants
mergedInto.conversation.lastMessage.createdAt
string
obligatoire
mergedInto.conversation.lastMessage.draft
boolean
obligatoire
mergedInto.conversation.lastMessage.id
string
obligatoire
mergedInto.conversation.lastMessage.preview
object
obligatoire
Afficher les attributs enfants
mergedInto.conversation.lastMessage.preview.text
string
mergedInto.conversation.lastMessage.recipients
array of object
Afficher les attributs enfants
mergedInto.conversation.lastMessage.recipients.contactAnnotation
object
Annotations add extra information to a sender or receiver. For email messages, the name annotation overrides the display name.
Afficher les attributs enfants
mergedInto.conversation.lastMessage.recipients.contactAnnotation.name
string
mergedInto.conversation.lastMessage.recipients.countryCode
string
mergedInto.conversation.lastMessage.recipients.id
string
The ID of the contact.
mergedInto.conversation.lastMessage.recipients.identifierKey
string
The identifier key for finding the contact (e.g. emailaddress, phonenumber). For WhatsApp channels with BSUID support, use whatsappbsuid to send to a contact by their Business-Scoped User ID.
mergedInto.conversation.lastMessage.recipients.identifierValue
string
The identifier value for finding the contact.
mergedInto.conversation.lastMessage.recipients.identifiers
array of object
Additional identifiers to augment the contact during resolution.
Afficher les attributs enfants
mergedInto.conversation.lastMessage.recipients.identifiers.identifierKey
string
obligatoire
The identifier key for finding the contact (e.g. emailaddress, phonenumber).
mergedInto.conversation.lastMessage.recipients.identifiers.identifierValue
string
obligatoire
The identifier value for finding the contact.
mergedInto.conversation.lastMessage.recipients.platformAddress
string
The resolved platform address used to deliver the message (e.g. phone number or email address).
mergedInto.conversation.lastMessage.recipients.platformAddressSelector
string
An expression that defines how we resolve the platform address from a contact. Optional override for the default resolution logic.
mergedInto.conversation.lastMessage.recipients.receiverExpression
string
mergedInto.conversation.lastMessage.recipients.receiverValue
string
mergedInto.conversation.lastMessage.recipients.type
string
The type of the receiver (e.g. to, cc, bcc for email).
mergedInto.conversation.lastMessage.sender
object
Afficher les attributs enfants
mergedInto.conversation.lastMessage.sender.email
string
mergedInto.conversation.lastMessage.sender.name
string
mergedInto.conversation.lastMessage.sender.avatarUrl
string
mergedInto.conversation.lastMessage.sender.contact
object
Afficher les attributs enfants
mergedInto.conversation.lastMessage.sender.contact.identifierKey
string
obligatoire
mergedInto.conversation.lastMessage.sender.contact.identifierValue
string
obligatoire
mergedInto.conversation.lastMessage.sender.contact.platformAddress
string
mergedInto.conversation.lastMessage.sender.contact.platformAddressSelector
string
mergedInto.conversation.lastMessage.sender.conversationId
string
mergedInto.conversation.lastMessage.sender.createdAt
string
mergedInto.conversation.lastMessage.sender.displayName
string
mergedInto.conversation.lastMessage.sender.id
string
obligatoire
mergedInto.conversation.lastMessage.sender.resourceUri
string
mergedInto.conversation.lastMessage.sender.status
string
Possible values: invited, pending, active, inactive
mergedInto.conversation.lastMessage.sender.type
string
obligatoire
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
mergedInto.conversation.lastMessage.sender.updatedAt
string
mergedInto.conversation.lastMessage.status
string
obligatoire
Possible values: accepted, processing, sent, sending_failed, delivered, delivery_failed, deleted
mergedInto.conversation.lastMessage.type
string
obligatoire
Possible values: text, html, image, file, gif, location, carousel, list, section, authentication, action, comment
mergedInto.conversation.lastMessageIncomingAt
string
mergedInto.conversation.lastMessageOutgoingAt
string
mergedInto.conversation.name
string
obligatoire
mergedInto.conversation.participants
array of object
Afficher les attributs enfants
mergedInto.conversation.participants.contact
object
Afficher les attributs enfants
mergedInto.conversation.participants.contact.identifierKey
string
obligatoire
mergedInto.conversation.participants.contact.identifierValue
string
obligatoire
mergedInto.conversation.participants.contact.platformAddress
string
mergedInto.conversation.participants.contact.platformAddressSelector
string
mergedInto.conversation.participants.id
string
obligatoire
mergedInto.conversation.participants.type
string
obligatoire
Possible values: user, contact, agent, flow, bot, accessKey, channel, connector, collaborationAutomation
mergedInto.conversation.pendingParticipantCount
integer
mergedInto.conversation.platformStyle
string
obligatoire
Possible values: direct, email, direct-multiple, direct-threaded, group-multiple
mergedInto.conversation.privateAttributes
string
mergedInto.conversation.read
boolean
mergedInto.conversation.referral
object
Afficher les attributs enfants
mergedInto.conversation.referral.caption
string
mergedInto.conversation.referral.mediaType
string
mergedInto.conversation.referral.mediaUrl
string
mergedInto.conversation.referral.sourceId
string
obligatoire
mergedInto.conversation.referral.sourceType
string
mergedInto.conversation.referral.sourceUrl
string
mergedInto.conversation.referral.text
string
mergedInto.conversation.referral.timestamp
string
mergedInto.conversation.referral.title
string
mergedInto.conversation.referral.username
string
mergedInto.conversation.resource
object
Afficher les attributs enfants
mergedInto.conversation.resource.id
string
obligatoire
mergedInto.conversation.resource.type
string
obligatoire
Possible values: task, task-conversation, reimbursement, sales-lead, sales-opportunity, sales-account, expense, project
mergedInto.conversation.resourceUri
string
mergedInto.conversation.starred
boolean
mergedInto.conversation.status
string
obligatoire
Possible values: deleted, active, closed, spam, archived
mergedInto.conversation.style
string
obligatoire
Possible values: default, directMessage, chatChannel, personalInbox, resource, groupInbox, support
mergedInto.conversation.summary
string
mergedInto.conversation.tags
array of string
mergedInto.conversation.updatedAt
string
obligatoire
mergedInto.conversation.visibility
string
obligatoire
Possible values: public, private, direct, group
mergedInto.conference
object
Afficher les attributs enfants
mergedInto.task
object
mergedInto.slaPolicy
object
Afficher les attributs enfants
mergedInto.slaPolicy.policyId
string
obligatoire
mergedInto.slaPolicy.timers
array of object
obligatoire
Afficher les attributs enfants
mergedInto.slaPolicy.timers.expiresAt
string
mergedInto.slaPolicy.timers.metric
string
obligatoire
Possible values: firstReplyTime, nextReplyTime
mergedInto.slaPolicy.timers.severity
string
obligatoire
Possible values: breach, warning
mergedInto.slaPolicy.timers.status
string
obligatoire
Possible values: inactive, active, completed, expired
mergedInto.requiredSkills
array of object
Afficher les attributs enfants
mergedInto.requiredSkills.id
string
obligatoire
mergedInto.requiredSkills.name
string
obligatoire
mergedInto.requiredSkills.selectedValues
array of object
obligatoire
Afficher les attributs enfants
mergedInto.requiredSkills.selectedValues.icon
string
mergedInto.requiredSkills.selectedValues.id
string
obligatoire
mergedInto.requiredSkills.selectedValues.value
string
obligatoire
mergedInto.requiredSkills.valueType
string
obligatoire
AgentSkillValueType defines how can the Values of a Skill can be selected.
Possible values: single, multiple, boolean
mergedInto.status
string
The slug that identifies the status of the root item.
mergedInto.statusCategory
string
The category maps to the lifecycle of a root item in the system.
Possible values: new, inProgress, pending, closed
mergedFromMessageSentId
string
mergedIntoMessageSentId
string
mergedFromCommentCreatedId
string
mergedIntoCommentCreatedId
string
Exemple de code
curl -X POST 'https://api.bird.com/workspaces/{workspaceId}/feeds/{feedId}/merge-items' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'