DocumentazioneEngagement Platform API
Sign inGet started
Guides
API

Agent Management

GET
/workspaces/{workspaceId}/agents
List Agents
Parametri di query
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 by field specified
Possible values: createdAt, statusAssignedCount, assignedCount, name
name
string
Filter by agent name
email
string
Filter by agent email
agentStatuses
array
Filter by agent status
roleIds
array
Filter by agent role ids
lastStatusActivitySince
string
To filter agents by their last status change since.
lastStatusActivityUpto
string
To filter agents by their last status change activity time.
agentIds
array
To find specific agents by their ids. If this is specified, other parameters are ignored.
Payload della risposta
results
array of object
obbligatorio
Mostra attributi secondari
results.id
string
obbligatorio
results.status
string
Possible values: active, away, out-of-office
results.statusBeforeOffline
string
Possible values: active, away, out-of-office
results.name
string
results.overrideName
boolean
results.workspaceId
string
obbligatorio
results.type
string
Possible values: user, ai
results.userEmails
array of string
results.bio
string
results.avatarUrl
string
results.dropVms
array
Mostra attributi secondari
results.dropVms.name
string
results.dropVms.playback
object
obbligatorio
Mostra attributi secondari
results.dropVms.playback.media
array of string
obbligatorio
results.dropVms.playback.pauseMilliseconds
integer
results.tagCount
integer
results.wrapUpTime
integer
results.rootItemAssignedCount
integer
results.lastAssignedAt
string
results.lastSetToAwayAt
string
results.teams
array of object
Mostra attributi secondari
results.teams.id
string
The team's ID this agent belongs to.
results.teams.name
string
The name of the team this agent belongs to.
results.teams.memberSince
string
The timestamp of when this agent joined the team.
results.teams.activeMemberCount
integer
The number of active members in the team.
results.teams.pendingMemberCount
integer
The number of pending members in the team.
results.workload
object
Mostra attributi secondari
results.workload.id
string
results.workload.workload
object
Mostra attributi secondari
results.workload.workload.messaging
integer
results.workload.workload.email
integer
results.workload.rule
object
Mostra attributi secondari
results.workload.rule.id
string
obbligatorio
results.workload.rule.workspaceId
string
obbligatorio
results.workload.rule.name
string
obbligatorio
results.workload.rule.description
string
obbligatorio
results.workload.rule.default
boolean
results.workload.rule.capacity
object
obbligatorio
Mostra attributi secondari
results.workload.rule.capacity.messaging
integer
results.workload.rule.capacity.email
integer
results.workload.rule.assignedAgentIds
array of string
results.workload.rule.createdAt
string
results.workload.rule.updatedAt
string
results.workload.ruleId
string
results.workload.updatedAt
string
results.createdAt
string
obbligatorio
results.updatedAt
string
obbligatorio
results.availability
object
Mostra attributi secondari
results.availability.status
string
Possible values: active, away, out-of-office
results.availability.activity
string
Possible values: available, in-call, busy, wrap-up-time, do-not-disturb, offline, not-available, out-of-hours, custom
results.availability.activityTtl
integer
results.availability.activityText
string
results.availability.lastStatusSet
string
results.availability.lastActivitySet
string
results.availability.updatedAt
string
results.timezone
string
results.defaultCountryCode
string
results.defaultCallerId
string
results.forwardNumber
object
Mostra attributi secondari
results.forwardNumber.enabled
boolean
results.forwardNumber.number
string
results.forwardNumber.maskCaller
boolean
results.transcriptionLocale
string
Curated set of BCP47 locale identifiers supported by Bird speech-to-text products
Possible values: ar-AE, ar-SA, cmn-CN, cy-GB, da-DK, de-CH, de-DE, el-GR, en-AU, en-GB, en-GB-WLS, en-IE, en-IN, en-NZ, en-US, en-ZA, es-ES, es-MX, es-US, fr-CA, fr-FR, he-IL, hi-IN, id-ID, is-IS, it-IT, ja-JP, ko-KR, ms-MY, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, ta-IN, te-IN, th-TH, tr-TR, vi-VN, zh-CN, zh-HK, zh-TW, arb, af-ZA, bn-IN, ca-ES, cmn-TW, cs-CZ, fi-FI, fil-PH, gu-IN, hu-HU, kn-IN, lt-LT, lv-LV, ml-IN, mr-IN, pa-IN, sk-SK, sr-RS, uk-UA, yue-HK, no-NO
results.roles
array of object
Mostra attributi secondari
results.roles.id
string
obbligatorio
results.roles.type
string
obbligatorio
Possible values: organization, managed
results.roles.workspaces
array of string
results.user
object
Mostra attributi secondari
results.user.id
string
ID of the user
results.user.name
string
The display name for the user
results.user.avatarUrl
string
URL to the user's profile picture.
results.user.defaultEmail
string
The default email of the user in the list of emails.
results.user.phoneNumber
string
results.weeklySchedule
object
Mostra attributi secondari
results.weeklySchedule.monday
object
Mostra attributi secondari
results.weeklySchedule.monday.from
object
obbligatorio
Mostra attributi secondari
results.weeklySchedule.monday.from.hour
integer
obbligatorio
results.weeklySchedule.monday.from.minute
integer
results.weeklySchedule.monday.to
object
obbligatorio
Mostra attributi secondari
results.weeklySchedule.monday.to.hour
integer
obbligatorio
results.weeklySchedule.monday.to.minute
integer
results.weeklySchedule.tuesday
object
Mostra attributi secondari
results.weeklySchedule.tuesday.from
object
obbligatorio
Mostra attributi secondari
results.weeklySchedule.tuesday.from.hour
integer
obbligatorio
results.weeklySchedule.tuesday.from.minute
integer
results.weeklySchedule.tuesday.to
object
obbligatorio
Mostra attributi secondari
results.weeklySchedule.tuesday.to.hour
integer
obbligatorio
results.weeklySchedule.tuesday.to.minute
integer
results.weeklySchedule.wednesday
object
Mostra attributi secondari
results.weeklySchedule.wednesday.from
object
obbligatorio
Mostra attributi secondari
results.weeklySchedule.wednesday.from.hour
integer
obbligatorio
results.weeklySchedule.wednesday.from.minute
integer
results.weeklySchedule.wednesday.to
object
obbligatorio
Mostra attributi secondari
results.weeklySchedule.wednesday.to.hour
integer
obbligatorio
results.weeklySchedule.wednesday.to.minute
integer
results.weeklySchedule.thursday
object
Mostra attributi secondari
results.weeklySchedule.thursday.from
object
obbligatorio
Mostra attributi secondari
results.weeklySchedule.thursday.from.hour
integer
obbligatorio
results.weeklySchedule.thursday.from.minute
integer
results.weeklySchedule.thursday.to
object
obbligatorio
Mostra attributi secondari
results.weeklySchedule.thursday.to.hour
integer
obbligatorio
results.weeklySchedule.thursday.to.minute
integer
results.weeklySchedule.friday
object
Mostra attributi secondari
results.weeklySchedule.friday.from
object
obbligatorio
Mostra attributi secondari
results.weeklySchedule.friday.from.hour
integer
obbligatorio
results.weeklySchedule.friday.from.minute
integer
results.weeklySchedule.friday.to
object
obbligatorio
Mostra attributi secondari
results.weeklySchedule.friday.to.hour
integer
obbligatorio
results.weeklySchedule.friday.to.minute
integer
results.weeklySchedule.saturday
object
Mostra attributi secondari
results.weeklySchedule.saturday.from
object
obbligatorio
Mostra attributi secondari
results.weeklySchedule.saturday.from.hour
integer
obbligatorio
results.weeklySchedule.saturday.from.minute
integer
results.weeklySchedule.saturday.to
object
obbligatorio
Mostra attributi secondari
results.weeklySchedule.saturday.to.hour
integer
obbligatorio
results.weeklySchedule.saturday.to.minute
integer
results.weeklySchedule.sunday
object
Mostra attributi secondari
results.weeklySchedule.sunday.from
object
obbligatorio
Mostra attributi secondari
results.weeklySchedule.sunday.from.hour
integer
obbligatorio
results.weeklySchedule.sunday.from.minute
integer
results.weeklySchedule.sunday.to
object
obbligatorio
Mostra attributi secondari
results.weeklySchedule.sunday.to.hour
integer
obbligatorio
results.weeklySchedule.sunday.to.minute
integer
results.holidays
array of object
Mostra attributi secondari
results.holidays.name
string
obbligatorio
results.holidays.day
integer
obbligatorio
results.holidays.month
integer
obbligatorio
results.assignedSkills
array of object
Mostra attributi secondari
results.assignedSkills.id
string
obbligatorio
results.assignedSkills.name
string
obbligatorio
results.assignedSkills.selectedValues
array of object
obbligatorio
Mostra attributi secondari
results.assignedSkills.selectedValues.icon
string
results.assignedSkills.selectedValues.id
string
obbligatorio
results.assignedSkills.selectedValues.value
string
obbligatorio
results.assignedSkills.valueType
string
obbligatorio
AgentSkillValueType defines how can the Values of a Skill can be selected.
Possible values: single, multiple, boolean
results.defaultSenderId
string
The default Sender Profile to select for this agent when composing a new message.
results.outOfOfficeResponse
string
nextPageToken
string
The token that can be passed as pageToken in URL to retrieve the next set of results. If missing, no more results to display.
total
integer
The total number of results across all pages.
Esempio di codice
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/agents' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
POST
/workspaces/{workspaceId}/agents
Create a new agent with specified details like name, role, and basic bio.
Payload della richiesta
bio
string
type
string
obbligatorio
Possible values: user
userId
string
obbligatorio
teamId
string
teamIds
array of string
timezone
string
defaultCountryCode
string
weeklySchedule
object
Mostra parametri secondari
weeklySchedule.monday
object
Mostra parametri secondari
weeklySchedule.monday.from
object
obbligatorio
Mostra parametri secondari
weeklySchedule.monday.from.hour
integer
obbligatorio
weeklySchedule.monday.from.minute
integer
weeklySchedule.monday.to
object
obbligatorio
Mostra parametri secondari
weeklySchedule.monday.to.hour
integer
obbligatorio
weeklySchedule.monday.to.minute
integer
weeklySchedule.tuesday
object
Mostra parametri secondari
weeklySchedule.tuesday.from
object
obbligatorio
Mostra parametri secondari
weeklySchedule.tuesday.from.hour
integer
obbligatorio
weeklySchedule.tuesday.from.minute
integer
weeklySchedule.tuesday.to
object
obbligatorio
Mostra parametri secondari
weeklySchedule.tuesday.to.hour
integer
obbligatorio
weeklySchedule.tuesday.to.minute
integer
weeklySchedule.wednesday
object
Mostra parametri secondari
weeklySchedule.wednesday.from
object
obbligatorio
Mostra parametri secondari
weeklySchedule.wednesday.from.hour
integer
obbligatorio
weeklySchedule.wednesday.from.minute
integer
weeklySchedule.wednesday.to
object
obbligatorio
Mostra parametri secondari
weeklySchedule.wednesday.to.hour
integer
obbligatorio
weeklySchedule.wednesday.to.minute
integer
weeklySchedule.thursday
object
Mostra parametri secondari
weeklySchedule.thursday.from
object
obbligatorio
Mostra parametri secondari
weeklySchedule.thursday.from.hour
integer
obbligatorio
weeklySchedule.thursday.from.minute
integer
weeklySchedule.thursday.to
object
obbligatorio
Mostra parametri secondari
weeklySchedule.thursday.to.hour
integer
obbligatorio
weeklySchedule.thursday.to.minute
integer
weeklySchedule.friday
object
Mostra parametri secondari
weeklySchedule.friday.from
object
obbligatorio
Mostra parametri secondari
weeklySchedule.friday.from.hour
integer
obbligatorio
weeklySchedule.friday.from.minute
integer
weeklySchedule.friday.to
object
obbligatorio
Mostra parametri secondari
weeklySchedule.friday.to.hour
integer
obbligatorio
weeklySchedule.friday.to.minute
integer
weeklySchedule.saturday
object
Mostra parametri secondari
weeklySchedule.saturday.from
object
obbligatorio
Mostra parametri secondari
weeklySchedule.saturday.from.hour
integer
obbligatorio
weeklySchedule.saturday.from.minute
integer
weeklySchedule.saturday.to
object
obbligatorio
Mostra parametri secondari
weeklySchedule.saturday.to.hour
integer
obbligatorio
weeklySchedule.saturday.to.minute
integer
weeklySchedule.sunday
object
Mostra parametri secondari
weeklySchedule.sunday.from
object
obbligatorio
Mostra parametri secondari
weeklySchedule.sunday.from.hour
integer
obbligatorio
weeklySchedule.sunday.from.minute
integer
weeklySchedule.sunday.to
object
obbligatorio
Mostra parametri secondari
weeklySchedule.sunday.to.hour
integer
obbligatorio
weeklySchedule.sunday.to.minute
integer
holidays
array of object
Mostra parametri secondari
holidays.name
string
obbligatorio
holidays.day
integer
obbligatorio
holidays.month
integer
obbligatorio
Payload della risposta
id
string
obbligatorio
status
string
Possible values: active, away, out-of-office
statusBeforeOffline
string
Possible values: active, away, out-of-office
name
string
overrideName
boolean
workspaceId
string
obbligatorio
type
string
Possible values: user, ai
userEmails
array of string
bio
string
avatarUrl
string
dropVms
array
Mostra attributi secondari
dropVms.name
string
dropVms.playback
object
obbligatorio
Mostra attributi secondari
dropVms.playback.media
array of string
obbligatorio
dropVms.playback.pauseMilliseconds
integer
tagCount
integer
wrapUpTime
integer
rootItemAssignedCount
integer
lastAssignedAt
string
lastSetToAwayAt
string
teams
array of object
Mostra attributi secondari
teams.id
string
The team's ID this agent belongs to.
teams.name
string
The name of the team this agent belongs to.
teams.memberSince
string
The timestamp of when this agent joined the team.
teams.activeMemberCount
integer
The number of active members in the team.
teams.pendingMemberCount
integer
The number of pending members in the team.
workload
object
Mostra attributi secondari
workload.id
string
workload.workload
object
Mostra attributi secondari
workload.workload.messaging
integer
workload.workload.email
integer
workload.rule
object
Mostra attributi secondari
workload.rule.id
string
obbligatorio
workload.rule.workspaceId
string
obbligatorio
workload.rule.name
string
obbligatorio
workload.rule.description
string
obbligatorio
workload.rule.default
boolean
workload.rule.capacity
object
obbligatorio
Mostra attributi secondari
workload.rule.capacity.messaging
integer
workload.rule.capacity.email
integer
workload.rule.assignedAgentIds
array of string
workload.rule.createdAt
string
workload.rule.updatedAt
string
workload.ruleId
string
workload.updatedAt
string
createdAt
string
obbligatorio
updatedAt
string
obbligatorio
availability
object
Mostra attributi secondari
availability.status
string
Possible values: active, away, out-of-office
availability.activity
string
Possible values: available, in-call, busy, wrap-up-time, do-not-disturb, offline, not-available, out-of-hours, custom
availability.activityTtl
integer
availability.activityText
string
availability.lastStatusSet
string
availability.lastActivitySet
string
availability.updatedAt
string
timezone
string
defaultCountryCode
string
defaultCallerId
string
forwardNumber
object
Mostra attributi secondari
forwardNumber.enabled
boolean
forwardNumber.number
string
forwardNumber.maskCaller
boolean
transcriptionLocale
string
Curated set of BCP47 locale identifiers supported by Bird speech-to-text products
Possible values: ar-AE, ar-SA, cmn-CN, cy-GB, da-DK, de-CH, de-DE, el-GR, en-AU, en-GB, en-GB-WLS, en-IE, en-IN, en-NZ, en-US, en-ZA, es-ES, es-MX, es-US, fr-CA, fr-FR, he-IL, hi-IN, id-ID, is-IS, it-IT, ja-JP, ko-KR, ms-MY, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, ta-IN, te-IN, th-TH, tr-TR, vi-VN, zh-CN, zh-HK, zh-TW, arb, af-ZA, bn-IN, ca-ES, cmn-TW, cs-CZ, fi-FI, fil-PH, gu-IN, hu-HU, kn-IN, lt-LT, lv-LV, ml-IN, mr-IN, pa-IN, sk-SK, sr-RS, uk-UA, yue-HK, no-NO
roles
array of object
Mostra attributi secondari
roles.id
string
obbligatorio
roles.type
string
obbligatorio
Possible values: organization, managed
roles.workspaces
array of string
user
object
Mostra attributi secondari
user.id
string
ID of the user
user.name
string
The display name for the user
user.avatarUrl
string
URL to the user's profile picture.
user.defaultEmail
string
The default email of the user in the list of emails.
user.phoneNumber
string
weeklySchedule
object
Mostra attributi secondari
weeklySchedule.monday
object
Mostra attributi secondari
weeklySchedule.monday.from
object
obbligatorio
Mostra attributi secondari
weeklySchedule.monday.from.hour
integer
obbligatorio
weeklySchedule.monday.from.minute
integer
weeklySchedule.monday.to
object
obbligatorio
Mostra attributi secondari
weeklySchedule.monday.to.hour
integer
obbligatorio
weeklySchedule.monday.to.minute
integer
weeklySchedule.tuesday
object
Mostra attributi secondari
weeklySchedule.tuesday.from
object
obbligatorio
Mostra attributi secondari
weeklySchedule.tuesday.from.hour
integer
obbligatorio
weeklySchedule.tuesday.from.minute
integer
weeklySchedule.tuesday.to
object
obbligatorio
Mostra attributi secondari
weeklySchedule.tuesday.to.hour
integer
obbligatorio
weeklySchedule.tuesday.to.minute
integer
weeklySchedule.wednesday
object
Mostra attributi secondari
weeklySchedule.wednesday.from
object
obbligatorio
Mostra attributi secondari
weeklySchedule.wednesday.from.hour
integer
obbligatorio
weeklySchedule.wednesday.from.minute
integer
weeklySchedule.wednesday.to
object
obbligatorio
Mostra attributi secondari
weeklySchedule.wednesday.to.hour
integer
obbligatorio
weeklySchedule.wednesday.to.minute
integer
weeklySchedule.thursday
object
Mostra attributi secondari
weeklySchedule.thursday.from
object
obbligatorio
Mostra attributi secondari
weeklySchedule.thursday.from.hour
integer
obbligatorio
weeklySchedule.thursday.from.minute
integer
weeklySchedule.thursday.to
object
obbligatorio
Mostra attributi secondari
weeklySchedule.thursday.to.hour
integer
obbligatorio
weeklySchedule.thursday.to.minute
integer
weeklySchedule.friday
object
Mostra attributi secondari
weeklySchedule.friday.from
object
obbligatorio
Mostra attributi secondari
weeklySchedule.friday.from.hour
integer
obbligatorio
weeklySchedule.friday.from.minute
integer
weeklySchedule.friday.to
object
obbligatorio
Mostra attributi secondari
weeklySchedule.friday.to.hour
integer
obbligatorio
weeklySchedule.friday.to.minute
integer
weeklySchedule.saturday
object
Mostra attributi secondari
weeklySchedule.saturday.from
object
obbligatorio
Mostra attributi secondari
weeklySchedule.saturday.from.hour
integer
obbligatorio
weeklySchedule.saturday.from.minute
integer
weeklySchedule.saturday.to
object
obbligatorio
Mostra attributi secondari
weeklySchedule.saturday.to.hour
integer
obbligatorio
weeklySchedule.saturday.to.minute
integer
weeklySchedule.sunday
object
Mostra attributi secondari
weeklySchedule.sunday.from
object
obbligatorio
Mostra attributi secondari
weeklySchedule.sunday.from.hour
integer
obbligatorio
weeklySchedule.sunday.from.minute
integer
weeklySchedule.sunday.to
object
obbligatorio
Mostra attributi secondari
weeklySchedule.sunday.to.hour
integer
obbligatorio
weeklySchedule.sunday.to.minute
integer
holidays
array of object
Mostra attributi secondari
holidays.name
string
obbligatorio
holidays.day
integer
obbligatorio
holidays.month
integer
obbligatorio
assignedSkills
array of object
Mostra attributi secondari
assignedSkills.id
string
obbligatorio
assignedSkills.name
string
obbligatorio
assignedSkills.selectedValues
array of object
obbligatorio
Mostra attributi secondari
assignedSkills.selectedValues.icon
string
assignedSkills.selectedValues.id
string
obbligatorio
assignedSkills.selectedValues.value
string
obbligatorio
assignedSkills.valueType
string
obbligatorio
AgentSkillValueType defines how can the Values of a Skill can be selected.
Possible values: single, multiple, boolean
defaultSenderId
string
The default Sender Profile to select for this agent when composing a new message.
outOfOfficeResponse
string
Esempio di codice
curl -X POST 'https://api.bird.com/workspaces/{workspaceId}/agents' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
GET
/workspaces/{workspaceId}/all-agents
Lists all agents for a workspace returning only minimal fields for each agent.
Payload della risposta
results
array of object
obbligatorio
Mostra attributi secondari
results.id
string
obbligatorio
results.status
string
Possible values: active, away, out-of-office
results.activity
string
Possible values: available, in-call, busy, wrap-up-time, do-not-disturb, offline, not-available, out-of-hours, custom
results.name
string
results.avatarUrl
string
results.createdAt
string
obbligatorio
Esempio di codice
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/all-agents' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
GET
/workspaces/{workspaceId}/agents/{agentId}
Retrieve information about a specific agent, including their name, bio, status.
Payload della risposta
id
string
obbligatorio
status
string
Possible values: active, away, out-of-office
statusBeforeOffline
string
Possible values: active, away, out-of-office
name
string
overrideName
boolean
workspaceId
string
obbligatorio
type
string
Possible values: user, ai
userEmails
array of string
bio
string
avatarUrl
string
dropVms
array
Mostra attributi secondari
dropVms.name
string
dropVms.playback
object
obbligatorio
Mostra attributi secondari
dropVms.playback.media
array of string
obbligatorio
dropVms.playback.pauseMilliseconds
integer
tagCount
integer
wrapUpTime
integer
rootItemAssignedCount
integer
lastAssignedAt
string
lastSetToAwayAt
string
teams
array of object
Mostra attributi secondari
teams.id
string
The team's ID this agent belongs to.
teams.name
string
The name of the team this agent belongs to.
teams.memberSince
string
The timestamp of when this agent joined the team.
teams.activeMemberCount
integer
The number of active members in the team.
teams.pendingMemberCount
integer
The number of pending members in the team.
workload
object
Mostra attributi secondari
workload.id
string
workload.workload
object
Mostra attributi secondari
workload.workload.messaging
integer
workload.workload.email
integer
workload.rule
object
Mostra attributi secondari
workload.rule.id
string
obbligatorio
workload.rule.workspaceId
string
obbligatorio
workload.rule.name
string
obbligatorio
workload.rule.description
string
obbligatorio
workload.rule.default
boolean
workload.rule.capacity
object
obbligatorio
Mostra attributi secondari
workload.rule.capacity.messaging
integer
workload.rule.capacity.email
integer
workload.rule.assignedAgentIds
array of string
workload.rule.createdAt
string
workload.rule.updatedAt
string
workload.ruleId
string
workload.updatedAt
string
createdAt
string
obbligatorio
updatedAt
string
obbligatorio
availability
object
Mostra attributi secondari
availability.status
string
Possible values: active, away, out-of-office
availability.activity
string
Possible values: available, in-call, busy, wrap-up-time, do-not-disturb, offline, not-available, out-of-hours, custom
availability.activityTtl
integer
availability.activityText
string
availability.lastStatusSet
string
availability.lastActivitySet
string
availability.updatedAt
string
timezone
string
defaultCountryCode
string
defaultCallerId
string
forwardNumber
object
Mostra attributi secondari
forwardNumber.enabled
boolean
forwardNumber.number
string
forwardNumber.maskCaller
boolean
transcriptionLocale
string
Curated set of BCP47 locale identifiers supported by Bird speech-to-text products
Possible values: ar-AE, ar-SA, cmn-CN, cy-GB, da-DK, de-CH, de-DE, el-GR, en-AU, en-GB, en-GB-WLS, en-IE, en-IN, en-NZ, en-US, en-ZA, es-ES, es-MX, es-US, fr-CA, fr-FR, he-IL, hi-IN, id-ID, is-IS, it-IT, ja-JP, ko-KR, ms-MY, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, ta-IN, te-IN, th-TH, tr-TR, vi-VN, zh-CN, zh-HK, zh-TW, arb, af-ZA, bn-IN, ca-ES, cmn-TW, cs-CZ, fi-FI, fil-PH, gu-IN, hu-HU, kn-IN, lt-LT, lv-LV, ml-IN, mr-IN, pa-IN, sk-SK, sr-RS, uk-UA, yue-HK, no-NO
roles
array of object
Mostra attributi secondari
roles.id
string
obbligatorio
roles.type
string
obbligatorio
Possible values: organization, managed
roles.workspaces
array of string
user
object
Mostra attributi secondari
user.id
string
ID of the user
user.name
string
The display name for the user
user.avatarUrl
string
URL to the user's profile picture.
user.defaultEmail
string
The default email of the user in the list of emails.
user.phoneNumber
string
weeklySchedule
object
Mostra attributi secondari
weeklySchedule.monday
object
Mostra attributi secondari
weeklySchedule.monday.from
object
obbligatorio
Mostra attributi secondari
weeklySchedule.monday.from.hour
integer
obbligatorio
weeklySchedule.monday.from.minute
integer
weeklySchedule.monday.to
object
obbligatorio
Mostra attributi secondari
weeklySchedule.monday.to.hour
integer
obbligatorio
weeklySchedule.monday.to.minute
integer
weeklySchedule.tuesday
object
Mostra attributi secondari
weeklySchedule.tuesday.from
object
obbligatorio
Mostra attributi secondari
weeklySchedule.tuesday.from.hour
integer
obbligatorio
weeklySchedule.tuesday.from.minute
integer
weeklySchedule.tuesday.to
object
obbligatorio
Mostra attributi secondari
weeklySchedule.tuesday.to.hour
integer
obbligatorio
weeklySchedule.tuesday.to.minute
integer
weeklySchedule.wednesday
object
Mostra attributi secondari
weeklySchedule.wednesday.from
object
obbligatorio
Mostra attributi secondari
weeklySchedule.wednesday.from.hour
integer
obbligatorio
weeklySchedule.wednesday.from.minute
integer
weeklySchedule.wednesday.to
object
obbligatorio
Mostra attributi secondari
weeklySchedule.wednesday.to.hour
integer
obbligatorio
weeklySchedule.wednesday.to.minute
integer
weeklySchedule.thursday
object
Mostra attributi secondari
weeklySchedule.thursday.from
object
obbligatorio
Mostra attributi secondari
weeklySchedule.thursday.from.hour
integer
obbligatorio
weeklySchedule.thursday.from.minute
integer
weeklySchedule.thursday.to
object
obbligatorio
Mostra attributi secondari
weeklySchedule.thursday.to.hour
integer
obbligatorio
weeklySchedule.thursday.to.minute
integer
weeklySchedule.friday
object
Mostra attributi secondari
weeklySchedule.friday.from
object
obbligatorio
Mostra attributi secondari
weeklySchedule.friday.from.hour
integer
obbligatorio
weeklySchedule.friday.from.minute
integer
weeklySchedule.friday.to
object
obbligatorio
Mostra attributi secondari
weeklySchedule.friday.to.hour
integer
obbligatorio
weeklySchedule.friday.to.minute
integer
weeklySchedule.saturday
object
Mostra attributi secondari
weeklySchedule.saturday.from
object
obbligatorio
Mostra attributi secondari
weeklySchedule.saturday.from.hour
integer
obbligatorio
weeklySchedule.saturday.from.minute
integer
weeklySchedule.saturday.to
object
obbligatorio
Mostra attributi secondari
weeklySchedule.saturday.to.hour
integer
obbligatorio
weeklySchedule.saturday.to.minute
integer
weeklySchedule.sunday
object
Mostra attributi secondari
weeklySchedule.sunday.from
object
obbligatorio
Mostra attributi secondari
weeklySchedule.sunday.from.hour
integer
obbligatorio
weeklySchedule.sunday.from.minute
integer
weeklySchedule.sunday.to
object
obbligatorio
Mostra attributi secondari
weeklySchedule.sunday.to.hour
integer
obbligatorio
weeklySchedule.sunday.to.minute
integer
holidays
array of object
Mostra attributi secondari
holidays.name
string
obbligatorio
holidays.day
integer
obbligatorio
holidays.month
integer
obbligatorio
assignedSkills
array of object
Mostra attributi secondari
assignedSkills.id
string
obbligatorio
assignedSkills.name
string
obbligatorio
assignedSkills.selectedValues
array of object
obbligatorio
Mostra attributi secondari
assignedSkills.selectedValues.icon
string
assignedSkills.selectedValues.id
string
obbligatorio
assignedSkills.selectedValues.value
string
obbligatorio
assignedSkills.valueType
string
obbligatorio
AgentSkillValueType defines how can the Values of a Skill can be selected.
Possible values: single, multiple, boolean
defaultSenderId
string
The default Sender Profile to select for this agent when composing a new message.
outOfOfficeResponse
string
Esempio di codice
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/agents/{agentId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
GET
/workspaces/{workspaceId}/agents/{agentId}/presigned-upload
Retrieve the url and form data to post profile avatar directly.
Payload della risposta
mediaUrl
string
URL to download the media from
fileId
string
File ID
url
string
obbligatorio
URL to post the image to
formData
object
obbligatorio
expectedFields
array of string
Esempio di codice
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/agents/{agentId}/presigned-upload' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
POST
/workspaces/{workspaceId}/agents/{agentId}/presigned-upload/audio
Retrieve the url and form data to post audio files directly.
Payload della risposta
mediaUrl
string
URL to download the media from
fileId
string
File ID
url
string
obbligatorio
URL to post the image to
formData
object
obbligatorio
expectedFields
array of string
Esempio di codice
curl -X POST 'https://api.bird.com/workspaces/{workspaceId}/agents/{agentId}/presigned-upload/audio' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
GET
/workspaces/{workspaceId}/agents/{agentId}/media/{fileId}/download
Get media download from an agent
Esempio di codice
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/agents/{agentId}/media/{fileId}/download' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
PATCH
/workspaces/{workspaceId}/agents/{agentId}
Modify the details of a specific agent, such as their name, bio, status.
Payload della richiesta
name
string
bio
string
status
string
Possible values: active, away, out-of-office
avatarUrl
string
dropVms
array
Mostra parametri secondari
dropVms.name
string
dropVms.playback
object
obbligatorio
Mostra parametri secondari
dropVms.playback.media
array of string
obbligatorio
dropVms.playback.pauseMilliseconds
integer
wrapUpTime
integer
timezone
string
defaultCountryCode
string
defaultCallerId
string
forwardNumber
object
Mostra parametri secondari
forwardNumber.enabled
boolean
forwardNumber.number
string
forwardNumber.maskCaller
boolean
transcriptionLocale
string
Curated set of BCP47 locale identifiers supported by Bird speech-to-text products
Possible values: ar-AE, ar-SA, cmn-CN, cy-GB, da-DK, de-CH, de-DE, el-GR, en-AU, en-GB, en-GB-WLS, en-IE, en-IN, en-NZ, en-US, en-ZA, es-ES, es-MX, es-US, fr-CA, fr-FR, he-IL, hi-IN, id-ID, is-IS, it-IT, ja-JP, ko-KR, ms-MY, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, ta-IN, te-IN, th-TH, tr-TR, vi-VN, zh-CN, zh-HK, zh-TW, arb, af-ZA, bn-IN, ca-ES, cmn-TW, cs-CZ, fi-FI, fil-PH, gu-IN, hu-HU, kn-IN, lt-LT, lv-LV, ml-IN, mr-IN, pa-IN, sk-SK, sr-RS, uk-UA, yue-HK, no-NO
weeklySchedule
object
Mostra parametri secondari
weeklySchedule.monday
object
Mostra parametri secondari
weeklySchedule.monday.from
object
obbligatorio
Mostra parametri secondari
weeklySchedule.monday.from.hour
integer
obbligatorio
weeklySchedule.monday.from.minute
integer
weeklySchedule.monday.to
object
obbligatorio
Mostra parametri secondari
weeklySchedule.monday.to.hour
integer
obbligatorio
weeklySchedule.monday.to.minute
integer
weeklySchedule.tuesday
object
Mostra parametri secondari
weeklySchedule.tuesday.from
object
obbligatorio
Mostra parametri secondari
weeklySchedule.tuesday.from.hour
integer
obbligatorio
weeklySchedule.tuesday.from.minute
integer
weeklySchedule.tuesday.to
object
obbligatorio
Mostra parametri secondari
weeklySchedule.tuesday.to.hour
integer
obbligatorio
weeklySchedule.tuesday.to.minute
integer
weeklySchedule.wednesday
object
Mostra parametri secondari
weeklySchedule.wednesday.from
object
obbligatorio
Mostra parametri secondari
weeklySchedule.wednesday.from.hour
integer
obbligatorio
weeklySchedule.wednesday.from.minute
integer
weeklySchedule.wednesday.to
object
obbligatorio
Mostra parametri secondari
weeklySchedule.wednesday.to.hour
integer
obbligatorio
weeklySchedule.wednesday.to.minute
integer
weeklySchedule.thursday
object
Mostra parametri secondari
weeklySchedule.thursday.from
object
obbligatorio
Mostra parametri secondari
weeklySchedule.thursday.from.hour
integer
obbligatorio
weeklySchedule.thursday.from.minute
integer
weeklySchedule.thursday.to
object
obbligatorio
Mostra parametri secondari
weeklySchedule.thursday.to.hour
integer
obbligatorio
weeklySchedule.thursday.to.minute
integer
weeklySchedule.friday
object
Mostra parametri secondari
weeklySchedule.friday.from
object
obbligatorio
Mostra parametri secondari
weeklySchedule.friday.from.hour
integer
obbligatorio
weeklySchedule.friday.from.minute
integer
weeklySchedule.friday.to
object
obbligatorio
Mostra parametri secondari
weeklySchedule.friday.to.hour
integer
obbligatorio
weeklySchedule.friday.to.minute
integer
weeklySchedule.saturday
object
Mostra parametri secondari
weeklySchedule.saturday.from
object
obbligatorio
Mostra parametri secondari
weeklySchedule.saturday.from.hour
integer
obbligatorio
weeklySchedule.saturday.from.minute
integer
weeklySchedule.saturday.to
object
obbligatorio
Mostra parametri secondari
weeklySchedule.saturday.to.hour
integer
obbligatorio
weeklySchedule.saturday.to.minute
integer
weeklySchedule.sunday
object
Mostra parametri secondari
weeklySchedule.sunday.from
object
obbligatorio
Mostra parametri secondari
weeklySchedule.sunday.from.hour
integer
obbligatorio
weeklySchedule.sunday.from.minute
integer
weeklySchedule.sunday.to
object
obbligatorio
Mostra parametri secondari
weeklySchedule.sunday.to.hour
integer
obbligatorio
weeklySchedule.sunday.to.minute
integer
holidays
array of object
Mostra parametri secondari
holidays.name
string
obbligatorio
holidays.day
integer
obbligatorio
holidays.month
integer
obbligatorio
assignedSkills
array of object
Mostra parametri secondari
assignedSkills.id
string
obbligatorio
assignedSkills.name
string
obbligatorio
assignedSkills.selectedValues
array of object
obbligatorio
Mostra parametri secondari
assignedSkills.selectedValues.icon
string
assignedSkills.selectedValues.id
string
obbligatorio
assignedSkills.selectedValues.value
string
obbligatorio
assignedSkills.valueType
string
obbligatorio
AgentSkillValueType defines how can the Values of a Skill can be selected.
Possible values: single, multiple, boolean
defaultSenderId
string
The default Sender Profile to select for this agent when composing a new message.
outOfOfficeResponse
string
Payload della risposta
id
string
obbligatorio
status
string
Possible values: active, away, out-of-office
statusBeforeOffline
string
Possible values: active, away, out-of-office
name
string
overrideName
boolean
workspaceId
string
obbligatorio
type
string
Possible values: user, ai
userEmails
array of string
bio
string
avatarUrl
string
dropVms
array
Mostra attributi secondari
dropVms.name
string
dropVms.playback
object
obbligatorio
Mostra attributi secondari
dropVms.playback.media
array of string
obbligatorio
dropVms.playback.pauseMilliseconds
integer
tagCount
integer
wrapUpTime
integer
rootItemAssignedCount
integer
lastAssignedAt
string
lastSetToAwayAt
string
teams
array of object
Mostra attributi secondari
teams.id
string
The team's ID this agent belongs to.
teams.name
string
The name of the team this agent belongs to.
teams.memberSince
string
The timestamp of when this agent joined the team.
teams.activeMemberCount
integer
The number of active members in the team.
teams.pendingMemberCount
integer
The number of pending members in the team.
workload
object
Mostra attributi secondari
workload.id
string
workload.workload
object
Mostra attributi secondari
workload.workload.messaging
integer
workload.workload.email
integer
workload.rule
object
Mostra attributi secondari
workload.rule.id
string
obbligatorio
workload.rule.workspaceId
string
obbligatorio
workload.rule.name
string
obbligatorio
workload.rule.description
string
obbligatorio
workload.rule.default
boolean
workload.rule.capacity
object
obbligatorio
Mostra attributi secondari
workload.rule.capacity.messaging
integer
workload.rule.capacity.email
integer
workload.rule.assignedAgentIds
array of string
workload.rule.createdAt
string
workload.rule.updatedAt
string
workload.ruleId
string
workload.updatedAt
string
createdAt
string
obbligatorio
updatedAt
string
obbligatorio
availability
object
Mostra attributi secondari
availability.status
string
Possible values: active, away, out-of-office
availability.activity
string
Possible values: available, in-call, busy, wrap-up-time, do-not-disturb, offline, not-available, out-of-hours, custom
availability.activityTtl
integer
availability.activityText
string
availability.lastStatusSet
string
availability.lastActivitySet
string
availability.updatedAt
string
timezone
string
defaultCountryCode
string
defaultCallerId
string
forwardNumber
object
Mostra attributi secondari
forwardNumber.enabled
boolean
forwardNumber.number
string
forwardNumber.maskCaller
boolean
transcriptionLocale
string
Curated set of BCP47 locale identifiers supported by Bird speech-to-text products
Possible values: ar-AE, ar-SA, cmn-CN, cy-GB, da-DK, de-CH, de-DE, el-GR, en-AU, en-GB, en-GB-WLS, en-IE, en-IN, en-NZ, en-US, en-ZA, es-ES, es-MX, es-US, fr-CA, fr-FR, he-IL, hi-IN, id-ID, is-IS, it-IT, ja-JP, ko-KR, ms-MY, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, ta-IN, te-IN, th-TH, tr-TR, vi-VN, zh-CN, zh-HK, zh-TW, arb, af-ZA, bn-IN, ca-ES, cmn-TW, cs-CZ, fi-FI, fil-PH, gu-IN, hu-HU, kn-IN, lt-LT, lv-LV, ml-IN, mr-IN, pa-IN, sk-SK, sr-RS, uk-UA, yue-HK, no-NO
roles
array of object
Mostra attributi secondari
roles.id
string
obbligatorio
roles.type
string
obbligatorio
Possible values: organization, managed
roles.workspaces
array of string
user
object
Mostra attributi secondari
user.id
string
ID of the user
user.name
string
The display name for the user
user.avatarUrl
string
URL to the user's profile picture.
user.defaultEmail
string
The default email of the user in the list of emails.
user.phoneNumber
string
weeklySchedule
object
Mostra attributi secondari
weeklySchedule.monday
object
Mostra attributi secondari
weeklySchedule.monday.from
object
obbligatorio
Mostra attributi secondari
weeklySchedule.monday.from.hour
integer
obbligatorio
weeklySchedule.monday.from.minute
integer
weeklySchedule.monday.to
object
obbligatorio
Mostra attributi secondari
weeklySchedule.monday.to.hour
integer
obbligatorio
weeklySchedule.monday.to.minute
integer
weeklySchedule.tuesday
object
Mostra attributi secondari
weeklySchedule.tuesday.from
object
obbligatorio
Mostra attributi secondari
weeklySchedule.tuesday.from.hour
integer
obbligatorio
weeklySchedule.tuesday.from.minute
integer
weeklySchedule.tuesday.to
object
obbligatorio
Mostra attributi secondari
weeklySchedule.tuesday.to.hour
integer
obbligatorio
weeklySchedule.tuesday.to.minute
integer
weeklySchedule.wednesday
object
Mostra attributi secondari
weeklySchedule.wednesday.from
object
obbligatorio
Mostra attributi secondari
weeklySchedule.wednesday.from.hour
integer
obbligatorio
weeklySchedule.wednesday.from.minute
integer
weeklySchedule.wednesday.to
object
obbligatorio
Mostra attributi secondari
weeklySchedule.wednesday.to.hour
integer
obbligatorio
weeklySchedule.wednesday.to.minute
integer
weeklySchedule.thursday
object
Mostra attributi secondari
weeklySchedule.thursday.from
object
obbligatorio
Mostra attributi secondari
weeklySchedule.thursday.from.hour
integer
obbligatorio
weeklySchedule.thursday.from.minute
integer
weeklySchedule.thursday.to
object
obbligatorio
Mostra attributi secondari
weeklySchedule.thursday.to.hour
integer
obbligatorio
weeklySchedule.thursday.to.minute
integer
weeklySchedule.friday
object
Mostra attributi secondari
weeklySchedule.friday.from
object
obbligatorio
Mostra attributi secondari
weeklySchedule.friday.from.hour
integer
obbligatorio
weeklySchedule.friday.from.minute
integer
weeklySchedule.friday.to
object
obbligatorio
Mostra attributi secondari
weeklySchedule.friday.to.hour
integer
obbligatorio
weeklySchedule.friday.to.minute
integer
weeklySchedule.saturday
object
Mostra attributi secondari
weeklySchedule.saturday.from
object
obbligatorio
Mostra attributi secondari
weeklySchedule.saturday.from.hour
integer
obbligatorio
weeklySchedule.saturday.from.minute
integer
weeklySchedule.saturday.to
object
obbligatorio
Mostra attributi secondari
weeklySchedule.saturday.to.hour
integer
obbligatorio
weeklySchedule.saturday.to.minute
integer
weeklySchedule.sunday
object
Mostra attributi secondari
weeklySchedule.sunday.from
object
obbligatorio
Mostra attributi secondari
weeklySchedule.sunday.from.hour
integer
obbligatorio
weeklySchedule.sunday.from.minute
integer
weeklySchedule.sunday.to
object
obbligatorio
Mostra attributi secondari
weeklySchedule.sunday.to.hour
integer
obbligatorio
weeklySchedule.sunday.to.minute
integer
holidays
array of object
Mostra attributi secondari
holidays.name
string
obbligatorio
holidays.day
integer
obbligatorio
holidays.month
integer
obbligatorio
assignedSkills
array of object
Mostra attributi secondari
assignedSkills.id
string
obbligatorio
assignedSkills.name
string
obbligatorio
assignedSkills.selectedValues
array of object
obbligatorio
Mostra attributi secondari
assignedSkills.selectedValues.icon
string
assignedSkills.selectedValues.id
string
obbligatorio
assignedSkills.selectedValues.value
string
obbligatorio
assignedSkills.valueType
string
obbligatorio
AgentSkillValueType defines how can the Values of a Skill can be selected.
Possible values: single, multiple, boolean
defaultSenderId
string
The default Sender Profile to select for this agent when composing a new message.
outOfOfficeResponse
string
Esempio di codice
curl -X PATCH 'https://api.bird.com/workspaces/{workspaceId}/agents/{agentId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
DELETE
/workspaces/{workspaceId}/agents/{agentId}
Remove a specific agent from the system, permanently deleting their profile and associated data.
Esempio di codice
curl -X DELETE 'https://api.bird.com/workspaces/{workspaceId}/agents/{agentId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
GET
/workspaces/{workspaceId}/agents/me
Retrieve information about a specific agent, including their name, bio, status.
Payload della risposta
id
string
obbligatorio
status
string
Possible values: active, away, out-of-office
statusBeforeOffline
string
Possible values: active, away, out-of-office
name
string
overrideName
boolean
workspaceId
string
obbligatorio
type
string
Possible values: user, ai
userEmails
array of string
bio
string
avatarUrl
string
dropVms
array
Mostra attributi secondari
dropVms.name
string
dropVms.playback
object
obbligatorio
Mostra attributi secondari
dropVms.playback.media
array of string
obbligatorio
dropVms.playback.pauseMilliseconds
integer
tagCount
integer
wrapUpTime
integer
rootItemAssignedCount
integer
lastAssignedAt
string
lastSetToAwayAt
string
teams
array of object
Mostra attributi secondari
teams.id
string
The team's ID this agent belongs to.
teams.name
string
The name of the team this agent belongs to.
teams.memberSince
string
The timestamp of when this agent joined the team.
teams.activeMemberCount
integer
The number of active members in the team.
teams.pendingMemberCount
integer
The number of pending members in the team.
workload
object
Mostra attributi secondari
workload.id
string
workload.workload
object
Mostra attributi secondari
workload.workload.messaging
integer
workload.workload.email
integer
workload.rule
object
Mostra attributi secondari
workload.rule.id
string
obbligatorio
workload.rule.workspaceId
string
obbligatorio
workload.rule.name
string
obbligatorio
workload.rule.description
string
obbligatorio
workload.rule.default
boolean
workload.rule.capacity
object
obbligatorio
Mostra attributi secondari
workload.rule.capacity.messaging
integer
workload.rule.capacity.email
integer
workload.rule.assignedAgentIds
array of string
workload.rule.createdAt
string
workload.rule.updatedAt
string
workload.ruleId
string
workload.updatedAt
string
createdAt
string
obbligatorio
updatedAt
string
obbligatorio
availability
object
Mostra attributi secondari
availability.status
string
Possible values: active, away, out-of-office
availability.activity
string
Possible values: available, in-call, busy, wrap-up-time, do-not-disturb, offline, not-available, out-of-hours, custom
availability.activityTtl
integer
availability.activityText
string
availability.lastStatusSet
string
availability.lastActivitySet
string
availability.updatedAt
string
timezone
string
defaultCountryCode
string
defaultCallerId
string
forwardNumber
object
Mostra attributi secondari
forwardNumber.enabled
boolean
forwardNumber.number
string
forwardNumber.maskCaller
boolean
transcriptionLocale
string
Curated set of BCP47 locale identifiers supported by Bird speech-to-text products
Possible values: ar-AE, ar-SA, cmn-CN, cy-GB, da-DK, de-CH, de-DE, el-GR, en-AU, en-GB, en-GB-WLS, en-IE, en-IN, en-NZ, en-US, en-ZA, es-ES, es-MX, es-US, fr-CA, fr-FR, he-IL, hi-IN, id-ID, is-IS, it-IT, ja-JP, ko-KR, ms-MY, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, ta-IN, te-IN, th-TH, tr-TR, vi-VN, zh-CN, zh-HK, zh-TW, arb, af-ZA, bn-IN, ca-ES, cmn-TW, cs-CZ, fi-FI, fil-PH, gu-IN, hu-HU, kn-IN, lt-LT, lv-LV, ml-IN, mr-IN, pa-IN, sk-SK, sr-RS, uk-UA, yue-HK, no-NO
roles
array of object
Mostra attributi secondari
roles.id
string
obbligatorio
roles.type
string
obbligatorio
Possible values: organization, managed
roles.workspaces
array of string
user
object
Mostra attributi secondari
user.id
string
ID of the user
user.name
string
The display name for the user
user.avatarUrl
string
URL to the user's profile picture.
user.defaultEmail
string
The default email of the user in the list of emails.
user.phoneNumber
string
weeklySchedule
object
Mostra attributi secondari
weeklySchedule.monday
object
Mostra attributi secondari
weeklySchedule.monday.from
object
obbligatorio
Mostra attributi secondari
weeklySchedule.monday.from.hour
integer
obbligatorio
weeklySchedule.monday.from.minute
integer
weeklySchedule.monday.to
object
obbligatorio
Mostra attributi secondari
weeklySchedule.monday.to.hour
integer
obbligatorio
weeklySchedule.monday.to.minute
integer
weeklySchedule.tuesday
object
Mostra attributi secondari
weeklySchedule.tuesday.from
object
obbligatorio
Mostra attributi secondari
weeklySchedule.tuesday.from.hour
integer
obbligatorio
weeklySchedule.tuesday.from.minute
integer
weeklySchedule.tuesday.to
object
obbligatorio
Mostra attributi secondari
weeklySchedule.tuesday.to.hour
integer
obbligatorio
weeklySchedule.tuesday.to.minute
integer
weeklySchedule.wednesday
object
Mostra attributi secondari
weeklySchedule.wednesday.from
object
obbligatorio
Mostra attributi secondari
weeklySchedule.wednesday.from.hour
integer
obbligatorio
weeklySchedule.wednesday.from.minute
integer
weeklySchedule.wednesday.to
object
obbligatorio
Mostra attributi secondari
weeklySchedule.wednesday.to.hour
integer
obbligatorio
weeklySchedule.wednesday.to.minute
integer
weeklySchedule.thursday
object
Mostra attributi secondari
weeklySchedule.thursday.from
object
obbligatorio
Mostra attributi secondari
weeklySchedule.thursday.from.hour
integer
obbligatorio
weeklySchedule.thursday.from.minute
integer
weeklySchedule.thursday.to
object
obbligatorio
Mostra attributi secondari
weeklySchedule.thursday.to.hour
integer
obbligatorio
weeklySchedule.thursday.to.minute
integer
weeklySchedule.friday
object
Mostra attributi secondari
weeklySchedule.friday.from
object
obbligatorio
Mostra attributi secondari
weeklySchedule.friday.from.hour
integer
obbligatorio
weeklySchedule.friday.from.minute
integer
weeklySchedule.friday.to
object
obbligatorio
Mostra attributi secondari
weeklySchedule.friday.to.hour
integer
obbligatorio
weeklySchedule.friday.to.minute
integer
weeklySchedule.saturday
object
Mostra attributi secondari
weeklySchedule.saturday.from
object
obbligatorio
Mostra attributi secondari
weeklySchedule.saturday.from.hour
integer
obbligatorio
weeklySchedule.saturday.from.minute
integer
weeklySchedule.saturday.to
object
obbligatorio
Mostra attributi secondari
weeklySchedule.saturday.to.hour
integer
obbligatorio
weeklySchedule.saturday.to.minute
integer
weeklySchedule.sunday
object
Mostra attributi secondari
weeklySchedule.sunday.from
object
obbligatorio
Mostra attributi secondari
weeklySchedule.sunday.from.hour
integer
obbligatorio
weeklySchedule.sunday.from.minute
integer
weeklySchedule.sunday.to
object
obbligatorio
Mostra attributi secondari
weeklySchedule.sunday.to.hour
integer
obbligatorio
weeklySchedule.sunday.to.minute
integer
holidays
array of object
Mostra attributi secondari
holidays.name
string
obbligatorio
holidays.day
integer
obbligatorio
holidays.month
integer
obbligatorio
assignedSkills
array of object
Mostra attributi secondari
assignedSkills.id
string
obbligatorio
assignedSkills.name
string
obbligatorio
assignedSkills.selectedValues
array of object
obbligatorio
Mostra attributi secondari
assignedSkills.selectedValues.icon
string
assignedSkills.selectedValues.id
string
obbligatorio
assignedSkills.selectedValues.value
string
obbligatorio
assignedSkills.valueType
string
obbligatorio
AgentSkillValueType defines how can the Values of a Skill can be selected.
Possible values: single, multiple, boolean
defaultSenderId
string
The default Sender Profile to select for this agent when composing a new message.
outOfOfficeResponse
string
Esempio di codice
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/agents/me' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
PATCH
/workspaces/{workspaceId}/agents/me
Modify the details of a specific agent, such as their name, bio, status.
Payload della richiesta
name
string
bio
string
status
string
Possible values: active, away, out-of-office
avatarUrl
string
dropVms
array
Mostra parametri secondari
dropVms.name
string
dropVms.playback
object
obbligatorio
Mostra parametri secondari
dropVms.playback.media
array of string
obbligatorio
dropVms.playback.pauseMilliseconds
integer
wrapUpTime
integer
timezone
string
defaultCountryCode
string
defaultCallerId
string
forwardNumber
object
Mostra parametri secondari
forwardNumber.enabled
boolean
forwardNumber.number
string
forwardNumber.maskCaller
boolean
transcriptionLocale
string
Curated set of BCP47 locale identifiers supported by Bird speech-to-text products
Possible values: ar-AE, ar-SA, cmn-CN, cy-GB, da-DK, de-CH, de-DE, el-GR, en-AU, en-GB, en-GB-WLS, en-IE, en-IN, en-NZ, en-US, en-ZA, es-ES, es-MX, es-US, fr-CA, fr-FR, he-IL, hi-IN, id-ID, is-IS, it-IT, ja-JP, ko-KR, ms-MY, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, ta-IN, te-IN, th-TH, tr-TR, vi-VN, zh-CN, zh-HK, zh-TW, arb, af-ZA, bn-IN, ca-ES, cmn-TW, cs-CZ, fi-FI, fil-PH, gu-IN, hu-HU, kn-IN, lt-LT, lv-LV, ml-IN, mr-IN, pa-IN, sk-SK, sr-RS, uk-UA, yue-HK, no-NO
weeklySchedule
object
Mostra parametri secondari
weeklySchedule.monday
object
Mostra parametri secondari
weeklySchedule.monday.from
object
obbligatorio
Mostra parametri secondari
weeklySchedule.monday.from.hour
integer
obbligatorio
weeklySchedule.monday.from.minute
integer
weeklySchedule.monday.to
object
obbligatorio
Mostra parametri secondari
weeklySchedule.monday.to.hour
integer
obbligatorio
weeklySchedule.monday.to.minute
integer
weeklySchedule.tuesday
object
Mostra parametri secondari
weeklySchedule.tuesday.from
object
obbligatorio
Mostra parametri secondari
weeklySchedule.tuesday.from.hour
integer
obbligatorio
weeklySchedule.tuesday.from.minute
integer
weeklySchedule.tuesday.to
object
obbligatorio
Mostra parametri secondari
weeklySchedule.tuesday.to.hour
integer
obbligatorio
weeklySchedule.tuesday.to.minute
integer
weeklySchedule.wednesday
object
Mostra parametri secondari
weeklySchedule.wednesday.from
object
obbligatorio
Mostra parametri secondari
weeklySchedule.wednesday.from.hour
integer
obbligatorio
weeklySchedule.wednesday.from.minute
integer
weeklySchedule.wednesday.to
object
obbligatorio
Mostra parametri secondari
weeklySchedule.wednesday.to.hour
integer
obbligatorio
weeklySchedule.wednesday.to.minute
integer
weeklySchedule.thursday
object
Mostra parametri secondari
weeklySchedule.thursday.from
object
obbligatorio
Mostra parametri secondari
weeklySchedule.thursday.from.hour
integer
obbligatorio
weeklySchedule.thursday.from.minute
integer
weeklySchedule.thursday.to
object
obbligatorio
Mostra parametri secondari
weeklySchedule.thursday.to.hour
integer
obbligatorio
weeklySchedule.thursday.to.minute
integer
weeklySchedule.friday
object
Mostra parametri secondari
weeklySchedule.friday.from
object
obbligatorio
Mostra parametri secondari
weeklySchedule.friday.from.hour
integer
obbligatorio
weeklySchedule.friday.from.minute
integer
weeklySchedule.friday.to
object
obbligatorio
Mostra parametri secondari
weeklySchedule.friday.to.hour
integer
obbligatorio
weeklySchedule.friday.to.minute
integer
weeklySchedule.saturday
object
Mostra parametri secondari
weeklySchedule.saturday.from
object
obbligatorio
Mostra parametri secondari
weeklySchedule.saturday.from.hour
integer
obbligatorio
weeklySchedule.saturday.from.minute
integer
weeklySchedule.saturday.to
object
obbligatorio
Mostra parametri secondari
weeklySchedule.saturday.to.hour
integer
obbligatorio
weeklySchedule.saturday.to.minute
integer
weeklySchedule.sunday
object
Mostra parametri secondari
weeklySchedule.sunday.from
object
obbligatorio
Mostra parametri secondari
weeklySchedule.sunday.from.hour
integer
obbligatorio
weeklySchedule.sunday.from.minute
integer
weeklySchedule.sunday.to
object
obbligatorio
Mostra parametri secondari
weeklySchedule.sunday.to.hour
integer
obbligatorio
weeklySchedule.sunday.to.minute
integer
holidays
array of object
Mostra parametri secondari
holidays.name
string
obbligatorio
holidays.day
integer
obbligatorio
holidays.month
integer
obbligatorio
assignedSkills
array of object
Mostra parametri secondari
assignedSkills.id
string
obbligatorio
assignedSkills.name
string
obbligatorio
assignedSkills.selectedValues
array of object
obbligatorio
Mostra parametri secondari
assignedSkills.selectedValues.icon
string
assignedSkills.selectedValues.id
string
obbligatorio
assignedSkills.selectedValues.value
string
obbligatorio
assignedSkills.valueType
string
obbligatorio
AgentSkillValueType defines how can the Values of a Skill can be selected.
Possible values: single, multiple, boolean
defaultSenderId
string
The default Sender Profile to select for this agent when composing a new message.
outOfOfficeResponse
string
Payload della risposta
id
string
obbligatorio
status
string
Possible values: active, away, out-of-office
statusBeforeOffline
string
Possible values: active, away, out-of-office
name
string
overrideName
boolean
workspaceId
string
obbligatorio
type
string
Possible values: user, ai
userEmails
array of string
bio
string
avatarUrl
string
dropVms
array
Mostra attributi secondari
dropVms.name
string
dropVms.playback
object
obbligatorio
Mostra attributi secondari
dropVms.playback.media
array of string
obbligatorio
dropVms.playback.pauseMilliseconds
integer
tagCount
integer
wrapUpTime
integer
rootItemAssignedCount
integer
lastAssignedAt
string
lastSetToAwayAt
string
teams
array of object
Mostra attributi secondari
teams.id
string
The team's ID this agent belongs to.
teams.name
string
The name of the team this agent belongs to.
teams.memberSince
string
The timestamp of when this agent joined the team.
teams.activeMemberCount
integer
The number of active members in the team.
teams.pendingMemberCount
integer
The number of pending members in the team.
workload
object
Mostra attributi secondari
workload.id
string
workload.workload
object
Mostra attributi secondari
workload.workload.messaging
integer
workload.workload.email
integer
workload.rule
object
Mostra attributi secondari
workload.rule.id
string
obbligatorio
workload.rule.workspaceId
string
obbligatorio
workload.rule.name
string
obbligatorio
workload.rule.description
string
obbligatorio
workload.rule.default
boolean
workload.rule.capacity
object
obbligatorio
Mostra attributi secondari
workload.rule.capacity.messaging
integer
workload.rule.capacity.email
integer
workload.rule.assignedAgentIds
array of string
workload.rule.createdAt
string
workload.rule.updatedAt
string
workload.ruleId
string
workload.updatedAt
string
createdAt
string
obbligatorio
updatedAt
string
obbligatorio
availability
object
Mostra attributi secondari
availability.status
string
Possible values: active, away, out-of-office
availability.activity
string
Possible values: available, in-call, busy, wrap-up-time, do-not-disturb, offline, not-available, out-of-hours, custom
availability.activityTtl
integer
availability.activityText
string
availability.lastStatusSet
string
availability.lastActivitySet
string
availability.updatedAt
string
timezone
string
defaultCountryCode
string
defaultCallerId
string
forwardNumber
object
Mostra attributi secondari
forwardNumber.enabled
boolean
forwardNumber.number
string
forwardNumber.maskCaller
boolean
transcriptionLocale
string
Curated set of BCP47 locale identifiers supported by Bird speech-to-text products
Possible values: ar-AE, ar-SA, cmn-CN, cy-GB, da-DK, de-CH, de-DE, el-GR, en-AU, en-GB, en-GB-WLS, en-IE, en-IN, en-NZ, en-US, en-ZA, es-ES, es-MX, es-US, fr-CA, fr-FR, he-IL, hi-IN, id-ID, is-IS, it-IT, ja-JP, ko-KR, ms-MY, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, ta-IN, te-IN, th-TH, tr-TR, vi-VN, zh-CN, zh-HK, zh-TW, arb, af-ZA, bn-IN, ca-ES, cmn-TW, cs-CZ, fi-FI, fil-PH, gu-IN, hu-HU, kn-IN, lt-LT, lv-LV, ml-IN, mr-IN, pa-IN, sk-SK, sr-RS, uk-UA, yue-HK, no-NO
roles
array of object
Mostra attributi secondari
roles.id
string
obbligatorio
roles.type
string
obbligatorio
Possible values: organization, managed
roles.workspaces
array of string
user
object
Mostra attributi secondari
user.id
string
ID of the user
user.name
string
The display name for the user
user.avatarUrl
string
URL to the user's profile picture.
user.defaultEmail
string
The default email of the user in the list of emails.
user.phoneNumber
string
weeklySchedule
object
Mostra attributi secondari
weeklySchedule.monday
object
Mostra attributi secondari
weeklySchedule.monday.from
object
obbligatorio
Mostra attributi secondari
weeklySchedule.monday.from.hour
integer
obbligatorio
weeklySchedule.monday.from.minute
integer
weeklySchedule.monday.to
object
obbligatorio
Mostra attributi secondari
weeklySchedule.monday.to.hour
integer
obbligatorio
weeklySchedule.monday.to.minute
integer
weeklySchedule.tuesday
object
Mostra attributi secondari
weeklySchedule.tuesday.from
object
obbligatorio
Mostra attributi secondari
weeklySchedule.tuesday.from.hour
integer
obbligatorio
weeklySchedule.tuesday.from.minute
integer
weeklySchedule.tuesday.to
object
obbligatorio
Mostra attributi secondari
weeklySchedule.tuesday.to.hour
integer
obbligatorio
weeklySchedule.tuesday.to.minute
integer
weeklySchedule.wednesday
object
Mostra attributi secondari
weeklySchedule.wednesday.from
object
obbligatorio
Mostra attributi secondari
weeklySchedule.wednesday.from.hour
integer
obbligatorio
weeklySchedule.wednesday.from.minute
integer
weeklySchedule.wednesday.to
object
obbligatorio
Mostra attributi secondari
weeklySchedule.wednesday.to.hour
integer
obbligatorio
weeklySchedule.wednesday.to.minute
integer
weeklySchedule.thursday
object
Mostra attributi secondari
weeklySchedule.thursday.from
object
obbligatorio
Mostra attributi secondari
weeklySchedule.thursday.from.hour
integer
obbligatorio
weeklySchedule.thursday.from.minute
integer
weeklySchedule.thursday.to
object
obbligatorio
Mostra attributi secondari
weeklySchedule.thursday.to.hour
integer
obbligatorio
weeklySchedule.thursday.to.minute
integer
weeklySchedule.friday
object
Mostra attributi secondari
weeklySchedule.friday.from
object
obbligatorio
Mostra attributi secondari
weeklySchedule.friday.from.hour
integer
obbligatorio
weeklySchedule.friday.from.minute
integer
weeklySchedule.friday.to
object
obbligatorio
Mostra attributi secondari
weeklySchedule.friday.to.hour
integer
obbligatorio
weeklySchedule.friday.to.minute
integer
weeklySchedule.saturday
object
Mostra attributi secondari
weeklySchedule.saturday.from
object
obbligatorio
Mostra attributi secondari
weeklySchedule.saturday.from.hour
integer
obbligatorio
weeklySchedule.saturday.from.minute
integer
weeklySchedule.saturday.to
object
obbligatorio
Mostra attributi secondari
weeklySchedule.saturday.to.hour
integer
obbligatorio
weeklySchedule.saturday.to.minute
integer
weeklySchedule.sunday
object
Mostra attributi secondari
weeklySchedule.sunday.from
object
obbligatorio
Mostra attributi secondari
weeklySchedule.sunday.from.hour
integer
obbligatorio
weeklySchedule.sunday.from.minute
integer
weeklySchedule.sunday.to
object
obbligatorio
Mostra attributi secondari
weeklySchedule.sunday.to.hour
integer
obbligatorio
weeklySchedule.sunday.to.minute
integer
holidays
array of object
Mostra attributi secondari
holidays.name
string
obbligatorio
holidays.day
integer
obbligatorio
holidays.month
integer
obbligatorio
assignedSkills
array of object
Mostra attributi secondari
assignedSkills.id
string
obbligatorio
assignedSkills.name
string
obbligatorio
assignedSkills.selectedValues
array of object
obbligatorio
Mostra attributi secondari
assignedSkills.selectedValues.icon
string
assignedSkills.selectedValues.id
string
obbligatorio
assignedSkills.selectedValues.value
string
obbligatorio
assignedSkills.valueType
string
obbligatorio
AgentSkillValueType defines how can the Values of a Skill can be selected.
Possible values: single, multiple, boolean
defaultSenderId
string
The default Sender Profile to select for this agent when composing a new message.
outOfOfficeResponse
string
Esempio di codice
curl -X PATCH 'https://api.bird.com/workspaces/{workspaceId}/agents/me' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
GET
/workspaces/{workspaceId}/agents/{agentId}/availability
Retrieve information about availability of a specific agent.
Payload della risposta
status
string
Possible values: active, away, out-of-office
activity
string
Possible values: available, in-call, busy, wrap-up-time, do-not-disturb, offline, not-available, out-of-hours, custom
activityTtl
integer
activityText
string
lastStatusSet
string
lastActivitySet
string
updatedAt
string
Esempio di codice
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/agents/{agentId}/availability' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
PATCH
/workspaces/{workspaceId}/agents/{agentId}/availability
Modify the availability of a specific agent.
Payload della richiesta
status
string
obbligatorio
Possible values: active, away, out-of-office
activity
string
Possible values: available, in-call, busy, wrap-up-time, do-not-disturb, offline, not-available, out-of-hours, custom
activityTtl
integer
activityText
string
Payload della risposta
status
string
Possible values: active, away, out-of-office
activity
string
Possible values: available, in-call, busy, wrap-up-time, do-not-disturb, offline, not-available, out-of-hours, custom
activityTtl
integer
activityText
string
lastStatusSet
string
lastActivitySet
string
updatedAt
string
Esempio di codice
curl -X PATCH 'https://api.bird.com/workspaces/{workspaceId}/agents/{agentId}/availability' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
GET
/workspaces/{workspaceId}/agents/{agentId}/workload
Retrieve information about workload of a specific agent.
Payload della risposta
id
string
workload
object
Mostra attributi secondari
workload.messaging
integer
workload.email
integer
rule
object
Mostra attributi secondari
rule.id
string
obbligatorio
rule.workspaceId
string
obbligatorio
rule.name
string
obbligatorio
rule.description
string
obbligatorio
rule.default
boolean
rule.capacity
object
obbligatorio
Mostra attributi secondari
rule.capacity.messaging
integer
rule.capacity.email
integer
rule.assignedAgentIds
array of string
rule.createdAt
string
rule.updatedAt
string
ruleId
string
updatedAt
string
Esempio di codice
curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/agents/{agentId}/workload' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'