LogoLogo
No-code docsResources
  • 🖥️Welcome to the Bird API Docs
  • API Access
    • Access Policies
    • Access Roles
    • API Authorization
    • Common API usage
  • Conversations API
    • API reference
      • Channel configuration
        • Get conversations configuration
        • Update conversations configuration
      • Conversations messaging
        • Create conversation message
        • List conversation messages
        • Get conversation message
        • Update conversation message
        • Delete conversation message
        • Create pre-signed upload
      • Conversations management
        • Create conversation
        • List conversations
        • Get conversation
        • Update conversation
        • Delete conversation
      • Conversation Participants
        • Add participant to conversation
        • List participants
        • Get participant by ID
        • Get participant by identifier key and value
        • Update participant by ID
        • Update participant by identifier key and value
        • Delete participant
        • List participant conversations by ID
        • List participant conversations by identifier key and value
      • Workspace settings
        • Get antispam setting
        • Update antispam setting
        • Create allow/block rule
        • Get allow/block rule
        • List allow/block rules
        • Update allow/block rule
        • Delete allow/block rule
        • Add allow/block rules in bulk
        • Get allow/block bulk upload status
      • Events
  • Collaborations API
    • API reference
      • Agent Management
      • Team Management
      • Feeds
      • Feed item activity
      • Tags
      • Automation Rules
      • Business Hours
      • Capacity Rules
      • Routing Queues
      • Skills
      • SLA Policies
      • Macros
      • Sender Profiles
      • Ticket fields
  • Channels API
    • Supported channels
      • Programmable WhatsApp
        • Sending WhatsApp messages
        • Customer service window
        • Receiving messages
        • Message interactions
        • WhatsApp ISV integration
          • Setting up your customer workspaces
            • API Access
            • Associating your Facebook solution ID and business ID with your Bird CRM Organization
            • Creating a workspace for your customer
            • Buying a number through Bird
            • Subscribing to channel created webhooks
          • WhatsApp channel onboarding
            • Setting up the WhatsApp Embedded flow
            • Install WhatsApp phone number in Bird CRM
            • Subscribe to channel webhooks
      • Programmable SMS
        • Installing an SMS channel
          • US 10DLC API Installation
          • Toll-Free Numbers Verification API
        • Sending SMS messages
        • Receiving messages
        • Twilio Exit API
          • Using Twilio PHP SDK
          • Using Twilio Go SDK
          • Using Twilio Ruby SDK
        • Sinch Exit API
      • Programmable RCS
        • Sending messages
        • Receiving messages
        • Message interactions
      • Programmable Email
        • Sending Emails
        • Receiving messages
        • Message status
        • Message interactions
      • Programmable Line
        • Sending messages
        • Receiving messages
        • Message interactions
      • Programmable Telegram
        • Sending messages
        • Receiving messages
        • Message interactions
    • Message types
      • Text
      • Images
      • Files
      • List
      • Carousel
      • Template
    • Message status and interactions
      • Message Failure Codes
      • Message Failure Sources
        • SMS Platform Extended Error Codes
    • Send batch messages
    • API reference
      • Channel Groups
      • Messaging
      • Channels management
      • Channel connectors
      • Navigators
      • Compliance Keywords Messages
      • Conversions Sharing
      • Events
    • Rate Limit
  • Voice API
    • Installing a Voice channel
    • Voice Calls API
      • Initiate an outbound call
      • List calls from a channel
      • Get a call
      • Update a call
      • Answer a call
      • Ring a call
      • Hangup a call
      • Play a message in a call
      • Say Text-To-Speech (TTS)
      • Gather DTMF from a call
      • Forward a call
      • Record a Call
      • Record a call session
      • Update a call recording
      • List call recordings of a call
      • Get a call recording
      • Get a call insights
      • Get calls log
    • Recordings API
      • List Recordings
      • Get a Recording
      • Delete a Recording
      • List recording storage metrics
    • Transcriptions API
      • Initiate a Transcription
      • List Transcriptions
      • Get a Transcription
      • Delete a Transcription
    • Voice webhooks
    • Flash Calling API
  • Verify API
    • Verify API: Quick Start
  • Contacts API
    • Tracking Contact Events
      • API Reference
        • Get configuration
        • Track events
    • API reference
      • Manage workspace contacts
        • Create a contact
        • Get a contact
        • List contacts
        • Search contact by identifier
        • Update a contact
        • Create or update a contact by identifier
        • Delete a contact
      • Manage contact identifiers
        • Create contact identifier
        • List contact identifiers
        • Delete contact identifier
      • Manage contact attribute definition
        • Create attribute definition
        • Get attribute definition
        • List attribute definitions
      • Manage contact lists
        • Create a list
        • Get a list
        • List lists
        • Update a list
        • Delete a list
        • Add contacts to a list
        • Get contact list memberships
        • List contacts in a list
        • Remove contacts from a list
      • Lookup
        • Network/Country information for a phone number
  • Numbers API
    • API reference
      • Search Available Numbers
      • Buy a Number
      • List your Numbers
      • Get Long Code Number Details
      • Manage Endpoint Subscriptions
        • Cancel Number Subscription
      • Manage Endpoint Compliance Requirements
        • List Workspace compliace Requirements
        • Get Workspace Compliace Requirements
        • Update Workspace Compliace Requirements
      • 10DLC Compliance
        • Brands - Organization
          • Create a brand
          • List all brands
          • Get a brand
          • Update a brand
          • Delete a brand
          • Create a brand vetting
        • Brands - workspace
          • Create a brand
          • List all brands
          • Get a brand
          • Update a brand
          • Delete a brand
          • Create a brand vetting
          • List brand vettings
        • Campaigns
          • Optional: acting as Reseller
          • Create a campaign
          • List all campaigns
          • Get a campaign
          • Update a campaign
          • Delete a campaign
        • TCR Enums
        • Events
      • Toll-Free Numbers Verification API
      • Long Code Numbers
      • Short Code Numbers
      • Alphanumeric Senders
      • Events
  • Know-Your-Customer (KYC) API
    • List KYC forms
    • Get KYC form
    • Create KYC form entry
    • Update KYC form entry
    • List KYC form entries
    • Get a KYC form entry details
  • Reporting API
    • API reference
      • Channel Metrics
      • Flow Run Metrics
      • Wallet Metrics
      • Campaign Metrics
      • Message Metrics
  • Accounts API
    • API reference
      • Current user
        • Change password
        • Presigned upload
        • Memberships
        • Sessions
        • Configurations
          • Groups
            • Keys
      • IAM policies
      • Organizations
        • Upload media
        • Profile
        • Workspaces
        • Users
        • Access keys
        • Organization roles
        • Organization policies
        • Teams
          • Members
        • Approvals
          • Runs
            • Reviews
        • Configurations
          • Groups
            • Keys
      • Region groups
  • Touchpoints API
    • Supported Projects
      • Whatsapp Approved Message Templates
        • Creating WhatsApp Message templates
          • Text template blocks
          • Blocks Documentation
    • API reference
      • Projects
      • Message Templates
  • Notifications API
    • API Reference
      • Webhook subscriptions
        • Create a webhook subscription
        • List available webhook events
        • Get a webhook subscription
        • List webhook subscriptions
        • Update a webhook subscription
        • Delete a webhook subscription
        • Verifying a webhook subscription
        • Webhook subscription logs
  • Knowledge Base (KB) API
    • API reference
      • Documents
      • Folders
        • Import
      • Search
      • Presigned upload
  • Email API
    • Transmissions
  • Connectivity platform migration guide
    • Channels API and Conversations API
    • Migrating conversations API actions
    • Migrating WhatsApp channels
  • Client SDKs
    • Applications
    • Contact Profiles
      • Signed Identity
    • Push notifications
      • Quick Start
      • Subscribe contacts to push notification campaigns
      • Notification Display Priority
    • Event Tracking
      • Quick Start
      • Track Events
        • App
        • Audiences
        • Conference
        • Ecommerce
        • Hospitality
        • Lists
        • Messaging
        • Payments
        • Subscription
        • Suppressions
        • Survey
        • Web
    • App Inbox
      • Quick Start
      • Usage
      • Subscribe contacts to app inbox campaigns
    • SDK Integration
      • Android SDK
        • Notification Interactions
      • Swift SDK
        • Notification Interactions
      • Web SDK
        • Quick Start
        • Usage
        • API Reference
          • IdentityManager
          • BirdSdkApi
          • BirdTracker
            • Ecommerce
            • Conference
            • Messaging
            • Suppressions
            • Subscription
            • Survey
            • Web
            • Audiences
        • Web Push Notifications
          • Notification Interactions
  • Quickstarts
    • Conversations
    • Send an SMS message
    • Send an Email message
    • Send a WhatsApp message
Powered by GitBook
On this page

Was this helpful?

  1. Channels API
  2. Supported channels
  3. Programmable SMS

Twilio Exit API

Last updated 1 year ago

Was this helpful?

If you already have an integration using the Twilio SMS API to send and receive SMS messages (basic send and receive only), you can use this guide to start sending your SMS messages through Bird without having to rewrite your API integration.

The Bird Twilio Exit API allows you to send SMS messages through Bird's Engagement Platform, using your existing Twilio Integration. It acts as an adapter that translates the requests and responses from the Twilio format to Bird format and vice versa.

How does it work?

Your Twilio integration will send the request using the Twilio API format to the Bird Twilio Exit API. Our API will accept the Twilio formatted request, translate it to Bird's format, process the message, and then translate our response to the Twilio API response format you're expecting, ta-da! You don't have to rewrite all of your integration to start sending messages via Bird.

Setup the integration

  1. Setup your Bird Engagement Platform account

  2. Install an SMS channel

  3. Copy your main keys

  4. Update your Twilio integration URL and keys

  5. Setup your Webhook to receive events and incoming messages

Setup your Bird account

Login to your Bird Engagement Platform account or for a new account if you don't have one.

Install an SMS channel

You will need to install an SMS channel on a working phone number, follow this guide on how to .

Copy your main keys

You will need:

  • The phone number of the SMS channel you're sending messages from

Update your Twilio Integration

Now that you have all the keys you need, you will need to do minimal change to your existing Twilio integration.

  1. Update the domain name from https://api.twilio.com to one of the following domains:

    • EU (for Europe region): https://eu-west-1.twilio.to.api.bird.com

    • US (for US region): https://us-west-1.twilio.to.api.bird.com

  2. Update your AccountSid to use your Bird WorkspaceID

    • To change your WorkspaceID into a AccountSid, simply remove all the dashes and prefix it with AC

      eg: e5181997-2c83-4a0d-959a-612248ff5a19 → ACe51819972c834a0d959a612248ff5a19

  3. Update your Token to use your Bird AccessKey

  4. Update the “From” number to the phone number you used to setup the SMS channel on our end

That's it! You're ready to start sending SMS messages via Bird.

If you are using one of Twilio's SDKs we also advise you to go through the following guides for additional tips:

Setup a Webhook subscription

Setting up a webhook subscription can currently be done via the API using the following endpoint:

Here is an example of such a request

{
    "service": "channels",
    "event": "sms.inbound",
    "eventFilters": [{
        "key": "channelId",
        "value": "{{channel_id}}"
    }],
    "template": "twilio",
    "url": "https://your.site/webhook/url",
    "signingKey": "your-secret-signing-key"
}

Unlike Twilio, Bird does not sign webhooks with your AccessKey/ApiToken. Instead, webhooks are signed using the SigningKey specified during your webhook subscription.

Make sure you keep your SigningKey safe, as it's used to verify the authenticity of the webhook requests.

Setup a Webhook subscription to receive incoming messages

Setting up a webhook subscription is an optional step, and is only needed if you need to receive inbound messages (2-way messaging use case). Much like Twilio, Bird's webhooks are set up by channel instance. So, for SMS, webhooks are set up by number.

To receive webhooks for incoming SMS messages on your SMS channel, you need to set up a webhook subscription by using the above request. For incoming messages, set the event to sms.inbound. You can choose to receive this webhook in the twilio format by setting the template parameter to twilio.

Setup webhook subscription for status reports for outbound messages

You can also set up webhooks for status reports for outbound messages by using the sms.outbound event. This is required to make webhooks work for outbound messages, since we need a singing key to sign the request.

When you use StatusCallback to subscribe to webhooks for outgoing messages, this URL overwrites the default URL set in the above request and sets the template to use the twilio template, regardless of the subscription settings.

Bird also employs a more secure way of signing requests. When using the twilio template, we will sign our requests in two ways: the Twilio method, using the Twilio header, and the Bird method, with the Bird header.

Twilio Exit API Explained

Our Twilio Exit API translates requests using the Twilio format to the Bird format, before sending it to the Bird API. And on receiving a response form our API, it translates it back into the Twilio format. This section explains which endpoints are supported and how we translate and map fields between both APIs.

Endpoints

Currently, the Twilio Exit API is limited to sending SMS messages exclusively through your Twilio Integration. The supported endpoints are:

Operation
Endpoint

Send message

POST /2010-04-01/Accounts/{{workspaceID}}/Messages.json

Fetch message

GET /2010-04-01/Accounts/{{workspaceID}}/Messages/{{messageID}}.json

Delete message

DELETE /2010-04-01/Accounts/{{workspaceID}}/Messages/{{messageID}}.json

List messages

GET /2010-04-01/Accounts/{{workspaceID}}/Messages.json

Message response

The message object's response resembles Twilio's, though some fields may be empty. Below is an example of our responses:

JSON field
Status
Bird field
Example

body

body.text.text

"body": "Hello World!"

direction

direction

"direction": "outbound-api"

from

sender.connector.identifierValue

"from": "+1234567890"

date_updated

updatedAt

"date_updated": "Fri, 18 Aug 2023 09:13:21 +0000"

uri

-

"uri": "/2010-04-01/Accounts/{account_sid}/Messages/{message_sid}.json"

account_sid

-

"account_sid":"ACe22001f4705b4f97b58b897891f60000"

to

receiver.contacts.

identifierValue

"to":"+31623456789"

It is possible to send to more than 1 recipient in Bird. We will always return the first recipient.

date_created

createdAt

"date_created": "Fri, 18 Aug 2023 09:13:21 +0000"

status

status

"status": "queued"

"status": "delivered"

sid

id

"sid": "SM2c315abb9c2f418ea6b0d5bedc530000"

api_version

-

"api_version": "2010-04-01"

subresource_uris

-

"subresource_uris": {"media": "....."}

subresource_uris.media

-

"media": "/2010-04-

01/Accounts/ACe22001f4705b4f97b58b897891f60000/Messages/S

M2c315abb9c2f418ea6b0d5bedc530000/Media.json"

subresource_uris.feedback

-

-

num_media

-

"num_media": "0"

SMS has no media

messaging_service_sid

-

"messaging_

service_sid": null

price

-

"price": null

price_unit

-

"price_unit": ""

error_code

-

"error_code": null

error_message

-

"error_message": null

num_segments

-

"num_segments": "1"

date_sent

-

"date_sent": null

Create message

Form field
Status

AccountSid (Path)

From (Required)

To (Required)

Body (Optional)

StatusCallback (Optional)

ProvideFeedback (Optional)

Attempt (Optional)

SmartEncoded (Optional)

ShortenUrls (Optional)

SendAsMms (Optional)

ApplicationSid (Optional)

MaxPrice (Optional)

ValidityPeriod (Optional)

ForceDelivery (Optional)

ContentRetention (Optional)

AddressRetention (Optional)

PersistentAction (Optional)

ScheduleType (Optional)

SendAt (Optional)

ContentVariables (Optional)

RiskCheck (Optional)

MessagingServiceSid (Optional)

MediaUrl (Optional)

ContentSid (Optional)

Response

List messages

Request

Filtering messages can be done using the following query string parameters:

Query parameter
Status

AccountSid (Path)

Page (Optional)

PageSize (Optional)

PageToken (Optional)

From (Optional)

To (Optional)

DateSent (Optional )

Response

JSON response
Channels field

page

page_size

start

end

first_page_url

previous_page_url

url

next_page_url

messages

Webhooks

Request for outgoing messages:

Key
Description

AccountSid

SmsSid

MessageSid

SmsStatus

MessageStatus

To

From

ApiVersion

RawDlrDoneDate

Request for incoming messages:

Key
Description

AccountSid

SmsSid

SmsMessageSid

MessageSid

SmsStatus

Body

From

To

ApiVersion

NumMedia

NumSegments

ToCountry

ToState

ToZip

FromCountry

FromState

FromCity

FromZip

Your (click Edit workspace to see your ID)

Full webhooks API documentation can be found .

Supported

Supported

Supported

Supported

Supported

Supported

Supported

Supported

Supported

Supported

Supported

Supported

Returned but not supported

Not returned

Always "0" for SMS

Always null

Always null

Always ""

Always null

Always null

Always "1"

Always null

Use your Bird WorkspaceID

Supported. Must be the number of an active SMS channel in Bird.

Supported

Supported

Supported

Ignored

Ignored

Always true, returns error if false

Always true, returns error if false

Always true, returns error if false

Returns error if used

Returns error if used

Returns error if used

Returns error if used

Returns error if used

Returns error if used

Returns error if used

Returns error if used

Returns error if used

Returns error if used

Returns error if used

Returns error if used

Returns error if used

Returns error if used

See .

Use your Bird WorkspaceID

Supported

Supported, but with a maximum of 100

Supported, but not a UUID Twilio example: PASMd37199c9492c41d6aba793e6420f70df Adapter example: WyJ3b3Jrc3BhY2UjNjViNzU1ZTItNGRmNS00MTE0LTg3NWItNmZmY2Y5NzllNDk2I21lc3NhZ2VzI2VlOThhMTZlLTMyNDEtNDhkMy04Y2Q1LTg5OTBlMmM2OTkwMSIsIm1lc3NhZ2UiLCJjaGFubmVsIzVlNzg3ZGQxLWQzNjEtNDU3Ni1hY2MwLTNiOWUxMTRmMWY4OCNtZXNzYWdlcyIsIm1lc3NhZ2UjMTY5MjExODg4ODQ0NCNlZTk4YTE2ZS0zMjQxLTQ4ZDMtOGNkNS04OTkwZTJjNjk5MDEiXQ==

Required parameter

Returns error if used

Returns error if used

Supported

Supported

Supported

Supported

Supported

Always null

Supported

Supported

Supported: See message response

Supported

Supported

Supported

Supported

Supported

Supported

Supported

Supported

Not set

Supported

Supported

Supported

Supported

Supported

Supported

Supported

Supported

Supported

Always "0"

Always "1"

Always ""

Always ""

Always ""

Always ""

Always ""

Always ""

Always ""

Sign up
install an SMS channel
workspace ID
Access key
I am using Twilio's PHP SDK
I am using Twilio's Go SDK
I am using Twilio's Ruby SDK
here
message response
🟢
🟢
🟢
🟢
🟢
🟢
🟢
🟢
🟢
🟢
🟢
🟢
🟡
🟡
🟡
🟡
🔴
🔴
🔴
🔴
🔴
🔴
🟢
🟢
🟢
🟢
🟢
🟡
🟡
🟠
🟠
🟠
🔴
🔴
🔴
🔴
🔴
🔴
🔴
🔴
🔴
🔴
🔴
🔴
🔴
🔴
🟢
🟢
🟡
🟡
🟠
🔴
🔴
🟢
🟢
🟢
🟢
🟢
🟠
🟢
🟢
🟢
🟢
🟢
🟢
🟢
🟢
🟢
🟢
🟢
🔴
🟢
🟢
🟢
🟢
🟢
🟢
🟢
🟢
🟢
🟠
🟠
🟠
🟠
🟠
🟠
🟠
🟠
🟠
  • How does it work?
  • Setup the integration
  • Setup your Bird account
  • Install an SMS channel
  • Copy your main keys
  • Update your Twilio Integration
  • Setup a Webhook subscription
  • POSTSet up a webhook subscription
  • Twilio Exit API Explained
  • Endpoints
  • Message response
  • Create message
  • List messages
  • Webhooks

Set up a webhook subscription

post
Path parameters
organization_idstringRequired

The ID of the organization

workspace_idstringRequired

The ID of the workspace

Body
servicestringOptional
eventstringOptional
templatestringOptional
urlstringOptional
signingKeystringOptional
Responses
200
Successful response
400
Bad request
post
POST /organizations/{organization_id}/workspaces/{workspace_id}/webhook-subscription HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 131

{
  "service": "text",
  "event": "text",
  "eventFilters": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "template": "text",
  "url": "text",
  "signingKey": "text"
}

No content