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
  • 10dlc.brand
  • 10dlc.campaign
  • 10dlc.vetting

Was this helpful?

  1. Numbers API
  2. API reference
  3. 10DLC Compliance

Events

Last updated 1 month ago

Was this helpful?

Most 10DLC status changes are asynchronous, you can create a webhook subscription to listen to status change events (see API details )

10dlc supports three status change event webhook types

  • 10dlc.brand

  • 10dlc.campaign

  • 10dlc.vetting

10dlc.brand

This event refers to the brand status changes (you can read more about brand status ) .

  "brand": {
    "service": "numbers",
    "event": "10dlc.brand",
    "payload": {
      "id": "example-brand-id",
      "organizationId": "example-org-id",
      "workspaceId": [
        "example-workspace-id"
      ],
      "status": "PENDING",
      "entityType": "PRIVATE_PROFIT",
      "firstName": "Example",
      "lastName": "User",
      "displayName": "Example SMS Brand",
      "companyName": "Example Company",
      "ein": "123456789",
      "einIssuingCountry": "XX",
      "phone": "+15551234567",
      "street": "Example Street 123",
      "city": "Example City",
      "state": "Example State",
      "postalCode": "12345",
      "country": "XX",
      "email": "example@example.com",
      "website": "http://www.example.com",
      "vertical": "TECHNOLOGY",
      "altBusinessId": "",
      "altBusinessIdType": "NONE",
      "stockExchange": "NONE",
      "stockSymbol": "",
      "createdAt": "2025-03-27T08:39:48.091Z",
      "updatedAt": "2025-03-27T08:39:48.091Z"
    }
  }

  "rejection": {
    "description": "text"
  }

Rejection descriptions are part of the brand objects but NOT the brand status events

10dlc.campaign

  "campaign": {
    "service": "numbers",
    "event": "10dlc.campaign",
    "payload": {
      "id": "example-campaign-id",
      "organizationId": "example-org-id",
      "workspaceId": "example-workspace-id",
      "name": "Example SMS Campaign",
      "status": "PENDING",
      "usecase": "LOW_VOLUME",
      "subUsecases": [
        "2FA",
        "ACCOUNT_NOTIFICATION"
      ],
      "description": "This is an example campaign description.",
      "embeddedLink": false,
      "embeddedPhone": false,
      "numberPool": false,
      "ageGated": false,
      "directLending": false,
      "subscriberOptin": true,
      "subscriberOptout": true,
      "subscriberHelp": true,
      "samples": [
        "Example: your OTP is 123456. Send STOP to unsubscribe",
        "Example: your wallet needs to be topped up. Send STOP to unsubscribe"
      ],
      "messageFlow": "Users can share their number as part of the notification setting. Only transactional events generate SMS notifications. See example terms: https://www.example.com/terms",
      "helpMessage": "Example: For help write to example@example.com. Reply STOP to opt out of SMS, START to subscribe. Msg&data rates may apply",
      "optoutKeywords": "STOP",
      "helpKeywords": "HELP",
      "optinKeywords": "START",
      "optinMessage": "Example: You opted in to receive SMS. Reply HELP for help; STOP to opt-out. Msg&Data rates may apply",
      "optoutMessage": "Example: You have OPTED-OUT from SMS. Send START to OPT-IN. Msg&data rates may apply.",
      "termsAndConditions": true,
      "brandId": "example-brand-id",
      "createdAt": "2025-03-27T09:01:30.716Z",
      "updatedAt": "2025-03-27T09:01:30.716Z"
    }
  }
}

For rejected campaigns only campaigns with DECLINED status are eligible to be resubmitted. All other campaign rejections will require a new campaign to be created.

  "rejection": {
    "description": "text"
  }

Rejection descriptions are part of the campaign objects but NOT of the campaign status events

10dlc.vetting

{
  "brandVetting": {
    "service": "numbers",
    "event": "10dlc.brandVetting",
    "payload": {
      "ID": "example-brand-vetting-id",
      "OrganizationID": "example-org-id",
      "BrandID": "example-brand-id",
      "ExternalID": "",
      "Status": "PENDING",
      "VettingProviderID": "",
      "Token": "",
      "Score": "",
      "Class": "STANDARD",
      "Reasons": null,
      "createdAt": "2025-03-27T08:39:48.942Z",
      "updatedAt": "2025-03-27T08:39:48.942Z"
    }
  }

  "rejection": {
    "description": "text"
  }

Rejection descriptions are part of the Vetting objects but NOT of the rejection events

To get more information about the reason forREJECTED brand status it is possible to fetch the rejection reason . Rejection reasons are not always available for all brand rejections.

This event refers to the campaign status changes (you can read more about campaign status ) .

To get more information about the reason for DECLINED the campaign status it is possible to fetch the rejection reason

Campaign rejections are always accompanied by a reason (the full list of reasons can be found );

This event refers to brand vetting status changes (you can read more about vetting status ) .

To get more information about the reason forREJECTED vetting status it is possible to fetch the rejection reason for a given brand

by getting the brand object
by getting the campaign object
here
by listing all vetting
here
here
here
here