LogoLogo
Get a demoLog inAcademyDevelopersMore docs
  • Bird CRM docs
    • Explore all products
    • Use cases
      • Bird for travel
        • Abandoned search recovery
        • Flight confirmation
        • Holiday search campaigns
        • Price change alerts
    • About Bird CRM
  • Inbox
    • Inbox
      • Concepts
        • Reports
      • Admin guide
        • Agents
          • Invite an agent to Inbox
          • Remove an agent from Inbox
          • FAQs
        • Tags
        • Routing
        • Teams
        • Feeds
        • Sender profiles
        • Reporting
      • Agent guide
        • 📚1. The basics
        • ⏰2. Your availability status
        • ✉️3. Send and receive messages
        • 💬4. Manage conversations
        • 👥5. View conversation participants
        • 👤6. View a contact's profile
  • Campaigns
    • Campaigns
      • Quickstarts
        • Send a campaign
      • Concepts
        • A/B tests
          • FAQs
        • Branded links
        • Calendar view
        • Campaign tags
        • Frequency limits
        • Scheduling
      • How-to
        • Schedule a campaign
        • Run an A/B test
        • Replicate a campaign
    • WhatsApp campaigns
      • How-to
        • Send a WhatsApp campaign
    • Email campaigns
      • How-to
        • Send an email campaign
    • SMS campaigns
      • Concepts
        • Best practices for MMS campaigns
      • How-to
        • Send an SMS campaign
    • Push notifications
      • How-to
        • Send a push notification campaign
    • New Campaign Builder
  • Automation
    • Journeys
      • Quickstarts
        • Create an abandoned cart recovery journey
      • Concepts
        • Journey templates
        • Journey runs
        • Journey insights
        • Journey reports
      • How-to
        • Use a send message step in a journey
        • Use a wait step in a journey
        • Use a conditional step in a journey
        • Use an update contact step in a journey
        • Use an end journey step in a journey
    • Flows
      • Quickstarts
        • Use template flows
        • Build an inbound flow
      • Concepts
        • Capabilities and limitations
        • Triggers
          • Agent triggers
          • Connector triggers
            • HubSpot triggers
          • Contact triggers
          • Conversation triggers
          • Feed item triggers
          • Message lifecycle triggers
          • Voice triggers
          • Webhook triggers
          • HTTP endpoint trigger
          • WhatsApp flow endpoint trigger
        • Actions
          • Bird API actions
            • Bots actions | API
            • Channel actions | API
            • Collaboration actions | API
            • Conversation actions | API
            • Engagements actions | API
            • Number management actions | API
          • Core actions
            • How to set up global variables in Flows
            • How to use the Filter Array Step
            • How to use the "Await Webhook" Step in Flows
          • Contact actions
          • Channel actions
          • Conversation actions
          • Connector actions
            • HubSpot actions
            • Open AI actions
          • Voice actions
      • How-to
        • Route conversations based on language
        • Route conversations based on sentiment
        • Set up a business hours auto-responder
        • Create a simple auto-responder
        • Set up conversational marketing
        • Create an FAQ bot
        • How to Match Regex in Flows
    • Approval Flow
  • Audience & Contacts
    • Sign-up forms
      • Quickstarts
        • Create a sign-up form
        • Create quizzes
      • Concepts
        • Sign-up process
        • Display
        • Colors
        • Targeting
        • Languages
        • Sign-up form analytics
    • Lists and segments
      • Quickstarts
        • Create a segment
      • Concepts
        • Segments
        • Lists
      • How-to
        • Create a segment based on contact activity
        • View contacts in a segment
        • Edit the setup of a segment
        • Delete a segment
        • Create a list
    • Contacts
      • Concepts
        • Contacts
        • Contacts directory
        • Contact profiles
        • Consent and subscriptions
          • Suppressions
          • Managing unsubscribes
          • Opt-ins, consent, and subscription statuses
            • Contacts with a 'blank' subscription status
      • How-to
        • Add contacts
        • Update the subscription status of your existing contacts
        • Send marketing campaigns to contacts with a 'blank' subscription status
        • Export contacts
        • How to bulk delete contacts
  • Content
    • Email templates
      • Concepts
        • Email content, styling, and personalization
        • Email design best practices
        • Advanced Email Templating
      • How-to
        • Create an email template
        • Import a custom HTML email
        • Use a prebuilt email template
        • Create personalized abandoned cart, browse and order placed emails
    • Message templates
      • Quickstarts
        • Create a message template
      • Concepts
        • Localization
        • Versioning
        • WhatsApp message templates
          • WhatsApp approved message templates
          • Reply to open conversation message template
          • Commerce messages
        • Apple Messages for Business
        • Push notifications
      • How-to
        • Localize a message template
        • Add variables to a message template
        • Create an SMS message template
        • Apple Messages for Business
          • Use dynamic variables in Apple Messages templates
          • Create a text Apple Messages template
          • Create an image Apple Messages template
          • Create a location Apple Messages template
          • Create a file Apple Messages template
          • Create a rich link Apple Messages template
          • Create a list picker Apple Messages template
          • Create authentication Apple Messages message types
          • Create a quick reply Apple Messages template
          • Create a time picker Apple Messages template
          • Create an iMessage App message template
          • Create a payment Apple Messages template
        • WhatsApp message templates
          • Create a WhatsApp approved message template
          • Create a reply to open conversation WhatsApp message template
          • Create a single product WhatsApp message template
          • Create a catalog WhatsApp message template
          • Create a coupon WhatsApp message template
          • Create an action WhatsApp message template
          • Create a limited time offer WhatsApp message template
          • Create a carousel WhatsApp message template
          • Create Approved WhatsApp Flows Template
          • Create reply to open conversation WhatsApp Flows Template
        • Create Push Notifications message templates
    • Chat widgets
      • Concepts
        • Send and receive messages
      • How-to
        • Build and install a chat widget on a Shopify store
        • Build and install a chat widget on your website
    • Media Library
      • How to Upload Images to the Media Library
    • Translation files
      • Creating and using translation files
    • External Data Sources
    • Lookup Tables
    • Discounts
    • Lookup tables
      • Managing lookup tables
      • Using lookup tables in Flows
    • Products
      • Custom Product Catalog Source
  • Analytics
    • Analytics
      • Concepts
        • Reporting metrics
        • Understanding the Attribution Model
        • List-unsubscribe in email headers
        • Understand Open Tracking
    • Channel analytics
      • Concepts
        • Channel logs
      • How-to
        • Analyze the performance of your channels
    • Campaign reports
      • Concepts
        • WhatsApp campaign reports
        • Email campaign reports
        • SMS campaign reports
      • How-to
        • View campaign reports
        • View A/B test campaign reports
        • See an overview campaign performance
  • Channels
    • Channels
      • Concepts
        • Quiet hours
      • Quickstarts
        • Find and install a channel
        • View information about an installed channel
        • View Channel Logs
      • Supported channels
        • Apple Messages for Business
          • Quickstarts
            • Install Apple Messages for Business
            • Use Apple Messages for Business
          • Concepts
            • Typing indicators
            • User device capabilities
          • How-to
            • Complete onboarding
            • Use entry points
            • Route messages
            • Send messages
            • Use Apple Pay
        • Email
          • Install email
          • Forwarding emails from Gmail
          • IP pools
          • Configure BIMI
        • Facebook Messenger
          • Install Facebook Messenger
          • Use Facebook Messenger
          • Facebook Messenger message types
        • Instagram Messaging
          • Install Instagram Messaging
          • Use Instagram Messaging
          • FAQs and Best Practices
          • Instagram message types
        • LINE
          • Install LINE
        • LinkedIn Pages Messaging
          • Install LinkedIn Pages messaging
          • Use LinkedIn Pages Messaging
          • LinkedIn Pages Messaging Types
        • Numbers
          • Quickstarts
            • Find and buy a new number
            • Activate a number
          • Concepts
            • Number types
            • Know-Your-Customer (KYC)
            • Activation, approval, and rejection
            • Number restrictions in China
          • How-to
            • Use a number
            • Cancel a number
            • Troubleshooting
            • FAQs
        • Push notifications
        • Google RCS
          • Create a Google RCS agent and install Google RCS as a channel
          • Testing and launching your agent
          • Create a Google RCS message template
          • RCS message template types
          • Create and send a Google RCS campaign
          • Create an RCS lead nurture journey with a fallback
          • Use RCS with an AI Agent
          • Grow RCS subscribers with a sign-up form
        • SMS
          • Quickstarts
            • Install SMS
            • Toubleshoot SMS Deliveries Faliures
            • (Missing) SMS delivery status
            • Troubleshoot Channel Health
          • Concepts
            • SMS parts and message length
            • SMS message types and compliance
            • Opt-in and opt-out compliance
            • Choose the right sender : Availability and restrictions by country
              • SMS Country Information Guide: Africa (A-L)
              • SMS Country Information Guide: Africa (M-Z)
                • South Africa
                • Nigeria
              • SMS Country Information Guide: Asia (A-K)
                • Japan
                • India
                • China
              • SMS Country Information Guide: Asia (L-Z)
                • Malaysia
                • Singapore
              • SMS Country Information Guide: Caribbean
              • SMS Country Information Guide: Central America
              • SMS Country Information Guide: Europe (A-M)
              • SMS Country Information Guide: Europe (N-Z)
              • SMS Country Information Guide: Middle East
                • United Arab Emirates
              • SMS Country Information Guide: North America
                • Messaging Best Practices - NORAM SMS / MMS
                • Canada
                • United States
                • Prohibited Content - NORAM SMS / MMS
              • SMS Country Information Guide: Oceania
                • New Zealand
                • Australia
              • SMS Country Information Guide: South America
            • MMS sizes and limitations
            • Automatic sender selection
            • SMS Registration
              • Use case requirements for SMS Registration
              • Setting up a SMS consent flow
              • SMS Privacy Policies
              • SMS Toll-free number
                • TFN Verification
                • Additional Costs for using TFN
                • How-to Guides
                  • Purchase a Toll Free Number via Bird
                  • Register a US or Canadian TFN for SMS via Bird
              • SMS 10DLC
                • How-to Guides
                  • Purchase a 10DLC number via Bird
                  • Register a 10DLC brand via Bird
                  • Register a 10DLC campaign via Bird
                  • Install SMS 10DLC
                  • Delete inactive 10DLC campaigns to avoid additional charges
                • Throughput and Daily Caps
                • Brand registration
                • Campaign registration
                • Additional costs for using 10DLC
                • 10DLC FAQs
            • Page 1
        • WhatsApp
          • Quickstarts
            • Before you start
            • Install WhatsApp
          • Concepts
            • WhatsApp for Business
            • Accounts and verification levels
              • Verified Facebook Business Manager Account
              • Official WhatsApp Business Account (Green tick)
            • Use WhatsApp
            • WhatsApp message types
            • WhatsApp's Customer Care Window
            • FAQs
          • How-to
            • Verify your Facebook Business Manager Account
            • Set up commerce messaging
              • Product inquiries
              • Product orders
            • Create a WhatsApp Flow
              • Create a flow
              • Testing your flow
              • Publishing and sending your flow
              • Handling Flow submission
            • Enable conversational components
            • Become a WhatsApp Tech Provider
              • Onboard as a Tech Provider
              • Connecting to Bird as solutions provider
              • Meta Tech Partner Migration 2024
            • Migrate from Bird to another BSP (Business Service Provider)
        • Telegram
          • Install Telegram
          • Bot commands setup
  • AI
    • AI
      • Quickstarts
        • Create an FAQ model
        • Build a detect intent model
      • Concepts
        • AI Assistants
          • Agent Assistant
          • Flows Assistant
          • Studio Assistant
          • FAQ Assistant
          • Audience Assistant
        • AI flow actions
        • AI integrations
        • Detect language: Supported languages
      • How-to
        • Set up and deploy automated FAQs
        • Set up and deploy detect intent models
    • AI Agents
      • Concepts
        • Knowledge bases
        • OpenAI token usage
      • How-to
        • Build a knowledge base
        • Set up an AI Agent
        • Deploy an AI Agent
  • Payments
    • Bird Pay (Beta)
      • Quick Start
        • How to get Bird Pay access?
      • Concepts
        • Onboarding
        • Payment Link
        • Wallet
          • Transfer
          • Recipient
        • Payments
          • Disputes
        • My customers
        • Payouts
        • Payment methods
        • Bird Pay Coverage
        • Strong Customer Authentication (SCA)
      • How-to
        • Create a Payment link
        • Refund a Payment
        • Manage Payout
        • Respond to a Dispute
        • How to set up MFA using the Authenticator app?
      • FAQs
        • Why was my onboarding unsuccessful?
        • How do I update my business address?
        • What are foreign currency fees on my Bird Payments?
        • How to raise an issue with Bird Pay with support?
  • Integrations
    • Integrations
      • Quickstarts
        • Find and install an integration
      • Concepts
        • Integration data sync
      • Supported integrations
        • ActiveCampaign
        • OPERA Cloud
        • Calendly
        • Easyship
        • Google Cloud Translation AI
        • HubSpot
        • Magento 1
        • Magento 2
        • Monday.com
        • Notion
        • OpenAI
        • Rebrandly
        • Salesforce
        • Shopify
        • SugarCRM
        • Zoho CRM
        • TikTok Ads
        • Typeform
        • WooCommerce
        • Zendesk Support
        • Google BigQuery
        • Snowflake
        • Amazon S3
        • Salesforce Marketing Cloud
        • Meta ads
        • Google Ads
      • How-to
        • How to integrate the Salesforce Connector on Bird?
        • How to Delete Contacts in Bird when Deleted in Salesforce
  • Account & Billing
    • Account
      • Organization settings
        • General
        • Single-Sign On (SSO)
          • Set up Single-Sign On (SSO)
          • Enforce Single-Sign On (SSO)
          • Entra ID
          • Google Workspaces
          • Okta
        • SCIM
          • Okta setup
          • Okta setup - Workspace IAM
          • Entra ID
        • Security Settings
        • Business profile
        • Workspaces
        • Plans & Billing
        • Wallets
        • Users
        • Access policies
        • Access roles
        • Access keys
        • How to find your Organization ID
        • How to find a Workspace ID
        • How to limit a user's access to a single workspace
        • How to download usage report?
        • How to pay (settle) invoices via wallet?
  • Help & Reference
    • Bird support
      • Invite Bird support
    • Deliverability & compliance
      • Email compliance - Bulk sending
      • United States SMS/MMS compliance
        • Key US Regulations
        • General US content restrictions
        • US SMS/MMS compliance
        • US Voice compliance
        • US state-level laws and regulations
        • US compliance & best practices checklist
        • US compliance FAQs
      • Singapore SMS Compliance
    • Data protection
      • Approved subprocessors
    • Release notes
    • Glossary
Powered by GitBook
On this page
  • Create call
  • Forward call
  • Get channel call action
  • Answer call
  • Hangup call
  • Play URL
  • Say TTS
  • Gather digits from a call
  • Record call
  • Transcribe recording
  • Get recording
  • Get transcription

Was this helpful?

  1. Automation
  2. Flows
  3. Concepts
  4. Actions

Voice actions

Last updated 11 months ago

Was this helpful?

Voice actions enable you to create, forward, answer or hang up a channel call in the automated flow. Additionally, it is also possible to perform actions like create or manage recordings, transcriptions or text-to-speech files. Check below the available voice actions.

You can also find more information in our API documentation for , and .

Create call

Flows offers the Create call step, allowing you to create channel calls seamlessly. You can specify the destination using either E.164 phone number format or a flow variable, ensuring compatibility with their desired endpoints.

Additionally, there are Advanced Configurations available, these options can be configured to customise the create call rules to your liking:

  • Step ID: Identifies the step of the corresponding flow.

  • Amd Settings: Answering Machine Detection (AMD) allows you to identify whether a call is answered by a human or answering machine, and adjust your call flow accordingly. It is possible to configure the following parameters:

    • Beep Timeout: If ifMachineNotifyAfter=beep and a machine is detected, we will wait for this amount of time for a beep.

    • If Machine Notify After: Select between beep or word count.

    • Speech Locale: Choose the language for machine detection (e.g., en-US).

    • Speech Timeout: The number of seconds words will be counted.

    • Word Count: Number of words to take into consideration when assessing machine or human. If actual words > wordCount, it will be considered a machine.

  • Flow start: Activate flow when call is ringing or call is answered.

  • From: If you want to override the CallerID. Set the number in E164 format. It must be one phone number of a channel installed in the same workspace.

  • Max Duration: Maximum duration of the call. Call is terminated after the max duration is reached.

  • Call Notification / URL: The URL used to publish webhooks for this call. Note: You need to have a webhook subscription created.

  • Record Start: Start recording the call from ringing or after the call being answered.

  • Send Keys: This attribute instructs the flow to play DTMF tones upon call connection. It proves beneficial when dialling a phone number along with an extension. After dialling the number, when the flow answers the call, the DTMF tones are sent to connect to the extension.

  • Ring Timeout: Maximum duration for ringing. Call is considered no-answer if not answered inside the ring timeout.

  • Workspace Id: The Workspace ID of the call.

  • Wait For Conditions:

    • Call was answered: Enable if you want to wait if the call is answered to proceed with the flow.

    • AMD finished: Enable if you want to wait for AMD results. You can then add a conditional to act differently for machine, human or beep.

Please note that each step within a flow is allocated a Step ID, which aids in identifying the step within its respective flow.

Forward call

When building a flow, you have the option to implement the Forward Call action on an incoming call. You can either populate the "To" field with the destination phone number you want to forward the call to (in an E.164 format), or with a SIP forwarding address of your choice.

Additionally, there are Advanced Configurations available, these options can be configured to customise the call forwarding rules to your liking:

  • Amd Settings: Answering Machine Detection (AMD) allows you to identify whether a call is answered by a human or answering machine, and adjust your call flow accordingly. It is possible to configure the following parameters:

    • Beep Timeout: If ifMachineNotifyAfter=beep and a machine is detected, we will wait for this amount of time for a beep.

    • If Machine Notify After: Select between beep or word count.

    • Speech Locale: Choose the language for machine detection (e.g., en-US).

    • Speech Timeout: The number of seconds words will be counted.

    • Word Count: Number of words to take into consideration when assessing machine or human. If actual words > wordCount, it will be considered a machine.

  • Max Duration: Maximum duration for the call. Call is terminated after the max duration is reached.

  • Ring Timeout: Maximum duration for ringing. Call is considered no-answer if not answered within the ringing timeout.

  • HangupAfterBridge: Disable this setting if you want the parent call to be continued after the forward call is terminated.This setting allows you to continue the flow after the forwarded call hangup.

  • From: Use this setting to override the CallerID. Set the number in E164 format. It must be the phone number of a channel installed in the same workspace.

  • Record Start: Start recording the call from ringing or after the call being answered.

  • CallNotification/URL: The URL used to publish webhooks for this call. Note: You need to have a webhook subscription created.

  • Ringtone: Force a ringtone. With this option you select the country ringtone you want to play to the caller. Note: this overrides the network ringtone and early announcements.

  • Call ID: Identifies the call that will be connected to the destinations

  • Voice Channel ID: The ChannelID that will be used to place the call. Defines the CallerID of the call.

  • Workspace ID: The Workspace ID of the call.

  • Wait For Conditions: Enable if you want to wait if the call is answered to proceed with the flow.

Get channel call action

Get channel call allows you to get a call resource from a voice channel - all metadata is collected for further processing.

Answer call

You can use Answer call in response to an incoming call, this will connect the call and allow you to respond or run additional steps in the flow while the call is ongoing.

Additionally, there are Advanced Configurations available, these options can be configured to customise the answer call rules to your liking:

  • Call ID: Identifies the call that will be connected to the destinations.

  • Voice Channel ID: The ChannelID that will be used to place the call. Defines the CallerID of the call.

  • Workspace Id: The Workspace ID of the call.

  • Wait For Conditions: Enable if you want to wait if the call is answered to proceed with the flow.

Hangup call

Terminate the channel call via Hangup call if the destination endpoint is either busy or rejects the call.

Additionally, there are Advanced Configurations available, these options can be configured to customise the hangup call rules to your liking:

  • Call ID: Identifies the call that will be connected to the destinations.

  • Voice Channel ID: The ChannelID that will be used to place the call. Defines the CallerID of the call.

  • Workspace Id: The Workspace ID of the call.

  • Wait For Conditions: Enable if you want to wait if the call is terminated to proceed with the flow.

Play URL

You are able to add media files from URLs into the voice flow through the Play URL step.

Additionally, there are Advanced Configurations available, these options can be configured to customise the play URL rules to your liking:

  • Loop: Number of times allowed to play the defined media file.

  • Timeout: Maximum duration of the playback in seconds.

  • Call ID: Identifies the call that will be connected to the destinations.

  • Voice Channel ID: The ChannelID that will be used to place the call. Defines the CallerID of the call.

  • Workspace Id: The Workspace ID of the call.

  • Wait For Conditions: Enable if you want to wait until the announcement was successfully played to proceed with the flow.

Say TTS

Play a message during the call using text-to-speech, all you need to do is provide the text you want to play and set the language and desired voice experience (male, female).

Additionally, there are Advanced Configurations available, these options can be configured to customise the Say TTS rules to your liking:

  • Loop:Number of times allowed to play the announcement.

  • Timeout: Maximum duration of the say text-to-speech in seconds.

  • Call ID: Identifies the call that will be connected to the destinations.

  • Voice Channel ID: The ChannelID that will be used to place the call. Defines the CallerID of the call.

  • Workspace Id: The Workspace ID of the call.

  • Wait For Conditions: Enable if you want to wait if the announcement was successfully played to proceed with the flow.

Gather digits from a call

The Gather Digits from a Call step facilitates input collection during calls (1-9, *, #). This is specially helpful when building an IVR and want the callee to select an option, press 1 to talk to sales, 2 to talk to support and so on. You have the option to play sounds or announcements defining the number of loops and timeouts or use the say text to call by selecting language (en-US), number of loops, text to be said, timeouts and voice experience (male, female).

Additionally, there are Advanced Configurations available, these options can be configured to customise the gather digits from a call rules to your liking:

  • End Key: Choose the input that concludes the digit gathering process. For instance, if you designate the End Key as # and the caller enters 1234#, the flow will cease waiting for further input once they press #.

  • Input: DTMF as default option.

  • Retries: Number of retries that are possible to insert input digits in case of failure.

  • Timeout: Maximum duration of the digits gathering process. Digits gathering is considered unsuccessful after the defined timeout in seconds.

  • Call ID: Identifies the call that will be connected to the destinations

  • Voice Channel ID: The ChannelID that will be used to place the call. Defines the CallerID of the call.

  • Workspace Id: The Workspace ID of the call.

  • Wait For Conditions: Enable if you want to wait if the digits were successfully collected to proceed with the flow.

Record call

The Record Call step allows you to start call recording from the caller's side. Recording can persist for a predefined duration or until a DTMF digit is pressed, offering end key options ranging from 1 to 9, as well as *, or #.

Additionally, there are Advanced Configurations available, these options can be configured to customise the record call rules to your liking:

  • End Key: Select the input to end the recording from 1 to 9, as well as *, or #.

  • Max Length: Maximum duration of the call recording in seconds.

  • Timeout: This attribute dictates the conclusion of recording after a specified duration of silence. To deactivate this function, set the timeout to 0.

  • Transcribe Locale: Choose the language for subsequent transcription (e.g., en-US).

  • Call ID: Identifies the call that will be connected to the destinations.

  • Voice Channel ID: The ChannelID that will be used to place the call. Defines the CallerID of the call.

  • Workspace Id: The Workspace ID of the call.

  • Wait For Conditions: Enable if you want to wait until the record is finished and is available to proceed with the flow.

Transcribe recording

Generate a transcription for a recording by choosing the previously collected recording ID variable and defining the desired language for the transcription (e.g. en-US).

Get recording

When building a flow, it is possible to include the Get Recording step, allowing to gather the recording metadata or the corresponding file. When issuing a GET request to /recordings/:recordingId, you will receive the metadata of the recording. However, if you issue a GET request to /recordings/:recordingId.mp3, you will receive the actual audio file.

Get transcription

When building a flow, you can retrieve a call transcription using the Get Transcription step, you can store the transcription file in formats like .json, .vtt, .txt or .srt.

Voice Calls API
Recording API
Transcription API