Migrating WhatsApp channels

Bird CRM provides tools to seamlessly migrate your WhatsApp channels and templates from the Connectivity Platform (CP) to the Bird CRM. Whether through the user interface or programmatic methods, this guide walks you through the migration and synchronization process.

This guide covers:

1. Using the Bird CRM UI for migration.

2. Using programmatic migration of WhatsApp channels from CP to the Bird CRM

3. Synchronizing WhatsApp templates programmatically.

Using the UI for migration

This section provides a detailed guide on accessing and using the Migration Tool in the Bird CRM UI, enabling you to seamlessly migrate your WhatsApp channels.

1. Log in to Bird CRM.

2. Locate your organization's logo displayed in the top-left corner of the dashboard.

3. Click on the logo to open the navigation menu.

4. Select Manage Channels option to access the channel settings page.

   Alternatively, you can directly navigate to: https://app.bird.com/settings/channels.

5. Select WhatsApp Connectivity Migration to open the migration tool.

1. In the WhatsApp Connectivity Migration tool, input your CP AccessKey and click Get Channels

This key allows the system to identify channels that need migration.

1. Select the channels you wish to migrate and click Migrate selected channels.

1. To begin migrating WhatsApp templates from the Connectivity Platform (CP), click Migrate all templates.

   
2. Select WhatsApp and choose the WhatsApp Business Accounts for template migration and click Sync Templates.

Verifying successful migration

This structured process ensures a smooth and thorough migration from the CP to the Bird CRM, enabling a seamless transition of channels and templates.

1. The migration tool provides real-time status updates for each channel. Ensure all channels show a completed migration status.

2. To verify template migration, click on Message Templates in the navigation panel.

You should see all templates successfully migrated from the CP to the Bird CRM.

Using programmatic migration of WhatsApp channels from CP to the Bird CRM

This section explains how to programmatically migrate WhatsApp channels from the Connectivity Platform (CP) to Bird CRM using API requests and a Go implementation. The process includes retrieving channels from CP, creating equivalent channels in Bird CRM, and verifying the migration to ensure a seamless transition.

Overview of the migration process

1. Use the CP AccessKey to fetch all WhatsApp channels associated with your account.

2. Optionally, allow user input to decide which channels to migrate.

3. Use the Bird CRM API to create new WhatsApp channels in the Bird CRM workspace, using CP channel details.

4. Confirm the migration by reviewing the created connectors in Bird CRM.

HTTP Requests for Migration

1. Retrieve WhatsApp Channels from CP

• Endpoint:

  GET https://messaging.messagebird.com/v1/channels?limit=20&offset=0&platform=whatsapp

• Headers:

  • Authorization: AccessKey <CP_ACCESS_KEY>

  • Content-Type: application/json

Example response

A JSON object containing the list of WhatsApp channels.

{
  "count": 1,
  "channels": [
    {
      "id": "channel-id-1",
      "name": "Channel Name",
      "settings": {
        "waba_id": "waba-id",
        "msisdn": "31612345678",
        "phone_number_id": "phone-id",
        "pin": "12345",
        "display_name": "WhatsApp"
      }
    }
  ]
}

2. Create a WhatsApp Channel in the Bird CRM

• Endpoint:

  POST https://api.bird.com/workspaces/{workspace_id}/connectors

• Headers:

  • Authorization: AccessKey <BIRD_CRM_ACCESS_KEY>

  • Content-Type: application/json

Payload

{
  "connectorTemplateRef": "whatsapp:1",
  "name": "WhatsApp",
  "arguments": {
    "wabaId": "waba-id",
    "phoneId": "phone-id",
    "phoneNumber": "[phone]",
    "isCpMigrated": true,
    "cpChannelId": "channel-id-1",
    "cpAccessKey": "<CP_ACCESS_KEY>",
    "phoneRegistrationPin": "12345"
  }
}

Example response

A JSON object confirming the creation of the connector in the Bird CRM.

• {
    "id": "connector-id-1",
    "workspaceId": "workspace-id",
    "routingKey": "whatsapp/waba-id/phone-id",
    "region": "eu-west-1",
    "connectorTemplateId": "template-id",
    "connectorTemplateRef": "whatsapp:1",
    "name": "WhatsApp",
    "arguments": {
      "cpAccessKey": "<CP_ACCESS_KEY>",
      "cpChannelId": "channel-id-1",
      "isCpMigrated": true,
      "phoneId": "phone-id",
      "phoneNumber": "[phone]",
      "wabaId": "waba-id"
    },
    "channel": {
      "channelId": "channel-id",
      "platform": "whatsapp"
    },
    "createdAt": "2024-10-20T17:31:08.231Z",
    "updatedAt": "2024-10-20T17:31:08.231Z",
    "dataCapture": {
      "captureEndpoint": "https://capture.eu-west-1.api.sandbox.bird.one/whatsapp"
    }
  }

Synchronizing WhatsApp templates programmatically

This section provides a detailed explanation of how to programmatically synchronize WhatsApp templates from the Bird CRM using an example Go implementation. The process includes identifying WhatsApp Business Accounts (WABAs) in the Bird CRM and triggering template synchronization via API requests.

Overview of the Synchronization Process

1. Use the Bird CRM AccessKey and Workspace ID to fetch channel groups.

2. Identify groups corresponding to WhatsApp Business Accounts (WABAs).

   • In the channel groups response:

     • platformGroupId corresponds to the WABA ID.

     • platformGroupName represents the Business Account Name.

     • Only records where platformId is "whatsapp" are relevant.

3. For each WABA, make a request to start template synchronization.

4. Monitor and verify synchronization status in the Bird CRM UI.

HTTP requests for synchronization

1. Retrieve WhatsApp Channel Groups

• Endpoint:

GET https://api.bird.com/workspaces/{workspace_id}/channel-groups

• Headers:

  • Authorization: AccessKey <BIRD_CRM_ACCESS_KEY>

Example response

A JSON object containing a list of channel groups.

{
  "nextPageToken": null,
  "results": [
    {
      "id": "group-id-1",
      "platformId": "whatsapp",
      "platformGroupId": "waba-id-1",
      "platformGroupName": "Business Account 1",
      "channelIds": ["channel-id-1", "channel-id-2"],
      "createdAt": "2024-10-15T10:00:00Z",
      "updatedAt": "2024-10-20T10:00:00Z"
    }
  ]
}

2. Trigger Template Synchronisation

• Endpoint:

POST https://api.bird.com/workspaces/{workspace_id}/channel-groups/{channel_group_id}/sync-templates

• Headers:

  • Authorization: AccessKey <BIRD_CRM_ACCESS_KEY>

  • Content-Type: application/json

• Payload: an empty JSON object ({}).

Example response

Indicates the status of the synchronisation request.

{
  "status": "accepted",
  "message": "Template synchronisation triggered successfully."
}