Dokumentasi Engagement Platform API

Sign in Get started

Engagement Platform API

🖥️ Welcome to the Bird API Docs
API Access
Conversations API
- Overview
- API reference
  - Overview
  - Channel configuration
    Overview
    Get conversations configuration
    Update conversations configuration
  - Conversations messaging
    Overview
    Create conversation message
    List conversation messages
    Get conversation message
    Update conversation message
    Delete conversation message
    Create pre-signed upload
  - Conversations management
    Overview
    Create conversation
    List conversations
    Get conversation
    Update conversation
    Delete conversation
  - Conversation Participants
    Overview
    Add participant to conversation
    List participants
    Get participant by ID
    Get participant by identifier key and value
    Update participant by ID
    Update participant by v key and value
    Delete participant
    List participant conversations by ID
  - Workspace settings
    Overview
    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
- Overview
- API reference
Channels API
- Overview
- Supported channels
- Message types
- Message status and interactions
  - Overview
  - Message Failure Codes
  - Message Failure Sources
    Overview
    SMS Platform Extended Error Codes
    WhatsApp Platform Extended Error Codes
- Send batch messages
- API reference
- Rate Limit
Voice API
Verify API
- Overview
- Verify API: Quick Start
Contacts API
- Overview
- Tracking Contact Events
  - Overview
  - API Reference
    Overview
    Get configuration
    Track events
- Tracking contact events
- API reference
  - Overview
  - Manage workspace contacts
    Overview
    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
    Overview
    Create contact identifier
    List contact identifiers
    Delete contact identifier
  - Manage contact attribute definition
    Overview
    Create attribute definition
    Get attribute definition
    List attribute definitions
  - Manage contact lists
    Overview
    Create a list
    Get a list
    List lists
    Update a list
    Delete a list
    Add contacts to a list
    Trigger double opt-in confirmations for a list
    Get contact list memberships
    List contacts in a list
    Remove contacts from a list
  - Manage contact suppressions
    Overview
    Upsert a workspace-platform-level suppression
    Get a suppression
    List workspace-platform-level suppressions
  - Manage custom objects
Numbers API
- Overview
- API reference
  - Overview
  - Search Available Numbers
  - Buy a Number
  - List your Numbers
  - Number Lookup
    Overview
    Network/Country information for a phone number
  - Get Long Code Number Details
  - Manage Endpoint Subscriptions
    Overview
    Cancel Number Subscription
  - Manage Endpoint Compliance Requirements
    Overview
    List Workspace compliance Requirements
    Get Workspace Compliance Requirements
    Update Workspace Compliance Requirements
  - 10DLC Compliance
    Overview
    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
    Overview
    Events
  - Long Code Numbers
  - Short Code Numbers
  - Alphanumeric Senders
  - Events
  - Destination management API
Know-Your-Customer (KYC) API
Reporting API
- Overview
- API reference
Accounts API
- Overview
- API reference
  - Overview
  - Current user
    Overview
    Change password
    Presigned upload
    Memberships
    Sessions
    Configurations
    Groups
    Keys
  - IAM policies
  - Organizations
    Overview
    Upload media
    Profile
    Workspaces
    Users
    Access keys
    Organization roles
    Organization policies
    Teams
    Members
    Approvals
    Runs
    Reviews
    Configurations
    Groups
    Keys
  - Region groups
Touchpoints API
- Overview
- Supported Projects
- Short Links in Message Templates
- API reference
  - Overview
  - Projects
  - Message Templates
    Overview
    Template Webhooks
  - Email Templates
Notifications API
- Overview
- API Reference
  - Overview
  - Webhook subscriptions
    Overview
    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
- Overview
- API reference
  - Overview
  - Documents
  - Folders
    Overview
    Import
  - Search
  - Presigned upload
Email API
- Overview
- SMTP API
Connectivity platform migration guide

Client SDKs

Applications
Contact Profiles
- Overview
- Signed Identity
Chat widget attributes
Push notifications
Event Tracking
- Overview
- Quick Start
- Track Events
App Inbox
SDK Integration
- Overview
- Android SDK
  - Overview
  - Notification Interactions
- Swift SDK
  - Overview
  - Notification Interactions
- Web SDK
  - Overview
  - Quick Start
  - Usage
  - API Reference
    Overview
    IdentityManager
    BirdSdkApi
    BirdTracker
    Ecommerce
    Conference
    Messaging
    Suppressions
    Subscription
    Survey
    Web
    Audiences
  - Web Push Notifications
    Overview
    Notification Interactions

Quickstarts

Conversations
Send an SMS message
Send an Email message
Send a WhatsApp message

Conversations management

The following APIs can be used to perform operations over conversations.

API Reference Guide

Create conversation
List conversations
Get conversation
Update conversation
Delete conversation

SebelumnyaCreate pre-signed upload

BerikutnyaCreate conversation

API Reference Guide

Produk

Email SMS Voice WhatsApp Apple Messages Verifikasi Lookup RCS Push eSIM Realtime

Sumber daya

Dokumentasi Quickstart Referensi API MCP Server Integrasi Pelanggan Panduan Penjelasan Pelajari Changelog Blog Karier

Perusahaan

Tentang Harga Authifly, merek verifikasi kami Hukum Ketentuan Privasi Pusat Kepercayaan

Sosial

© 2026 Bird

Semua sistem beroperasi

Hubungi dukungan