Documentation · Gupshup × Bitrix24
Set up a new WhatsApp number or migrate a live number in Gupshup with Meta Embedded Signup, then connect it to a Bitrix24 Open Channel and test it.
All scenarios start with the same preparation. Pick yours to see what is different.
A number that can receive a code. It must be able to receive an SMS or a phone call. If it can receive only calls, it cannot be using an IVR.
Access to the company's Meta portfolio. You need a Meta administrator with full access. Gupshup recommends using an existing portfolio that someone in your company has already created and verified. Its owner either invites you as an administrator with full access, or you share the Direct Facebook Registration link with them.
A Gupshup account and its email. You can create only one Gupshup account per email address. Gupshup sends a verification code to the contact email during setup, so use a mailbox you can open.
Business details. The customer-facing display name, a business category and the business information. The display name must match how your business is branded on external sources such as your website, and it is reviewed against the display name guidelines.
Message API version. The new Meta account model (WAME) is not supported on /v1/msg for template and session messages. Use the /v2 or /v3 endpoints.
Same Meta Business Manager (BM). This flow covers a new number and the migration of an active WhatsApp API number within the same BM. To move a number from one BM to another, deregister it from the first BM, then start onboarding as described below.
Templates are not migrated automatically to the new PMA. Note the source WhatsApp Business Account (WABA) ID and enter it in the Gupshup Embedded Signup flow (step 5): Gupshup then copies the templates from the source WABA to the destination WABA. The source article announced a Partner API for this as coming soon.
Disable two-factor authentication at the source BSP. When you migrate a number with Embedded Signup, Gupshup requires 2FA to be disabled for that number at the current provider.
Tech Providers only: Meta does not yet support onboarding a number that is live on BSP A with Tech Provider 1 to BSP B through the same Tech Provider.
Disruptive workaround for Tech Providers. The original WAAC must be deleted first, including the source PMAs. Messaging stops until the number is onboarded on Gupshup/ODCEM. Gupshup has raised this with Meta for resolution.
Choose Coexistence if the number must keep working in the WhatsApp Business app. It requires WhatsApp Business app version 2.24.17 or later, a supported country (Nigeria and South Africa are not supported yet), the ability to scan a QR code from the app, a WhatsApp account that is three months old with active messaging, and no payment method linked to the app. Meta currently has issues with history events, contact sync and smb_message_echoes. Contact and history sync can be triggered only once, within 24 hours of onboarding. See Gupshup: Coexistence.
Sign in at apps.gupshup.io/whatsapp/dashboard and open Dashboard → WhatsApp. Select Create your first app, enter a unique name, submit it and select Go to Dashboard. You can also use an existing app that is not live yet.
The app name is internal: customers never see it and it does not become your WhatsApp display name. It needs at least six characters, no spaces or special characters, and it must be unique across Gupshup. An app unused for 60 days is deleted by the platform.
Required. The Bitrix24 connector works only with Gupshup apps linked to the AiApps.Pro partner account, and the link must exist before you start the Go Live process. This is the step most people miss.
Open the Gupshup app you created for this number.
Find the Add partner ID control. It offers two options: linking with a Partner ID and linking with a Partner Token.
Choose Link using partner ID and enter 117 (ANWEB, the AiApps.Pro partner account). This is the method the AiApps.Pro connector guide uses.
Submit the request, then start Go Live below.
Gupshup partners can turn off automatic approval. In that case the request waits until the AiApps.Pro team accepts it in the partner portal. If the request stays pending, contact support rather than creating a second app. If you delink the app, wait up to 24 hours before linking it again. If AiApps.Pro gives you a Partner Linking Token instead of an ID, choose Link with Partner Token and enter it. See Gupshup: Linking apps with a partner.
Linking by sharing the App ID and the app-level API key is deprecated since 5 November 2026. Do not share these credentials: use one of the options above.
Click Go Live on the app dashboard. If you have started the registration before, the button may read Complete FB Registration instead. Then select:
Gupshup then shows the data storage region and the WhatsApp fee for your country. Review them and select Proceed. Onboarding API users: once you have generated the Embedded Signup link, skip to step 4. For a migration through the API, run the Partner API that marks the app as migration at the end.
Enter the contact details and tick the boxes that accept the terms and policies (T&C, Privacy Policy, Business Policy and Commerce Policy). Gupshup sends an OTP to the email you entered: enter it, review your details and select Confirm. This is not the OTP for the phone number, which comes later from Meta.
Select Continue with Facebook, or share the Embedded Signup link with the customer. Gupshup opens a pop-up window on facebook.com: allow pop-ups in your browser, and do not close the pop-up or navigate to another page while it is open. If you have no access to the company's Facebook account, copy the Direct Facebook Registration URL and share it with the administrator, who completes the process.
The business completes these steps in Meta's Embedded Signup flow.
On the first Embedded Signup screen, click Continue.
Enter the new number, or the number to be migrated. For a migration by a Tech Provider, delete the original WAAC first. This step is disruptive (see the warning above).
Complete the OTP verification of the number. Some migrations do not require it. The code goes to the phone number itself, by SMS or phone call.
Create the WhatsApp Business account:
Enter the business details and continue. Enter the WhatsApp Business display name and select a category. Customers see the display name, and it is reviewed against the guidelines.
Review the details and continue. The setup begins. Meta enforces restrictions, and you will likely need to complete Meta Business Verification before the app can go live. Meta handles that verification, not Gupshup or AiApps.Pro.
The business admin may need to verify their identity with two-factor authentication on their own personal phone number. This does not happen every time. It is not the onboarding OTP, so Gupshup cannot provide this code. The process then continues.
When the setup completes, click Finish.
Skip these steps for a migration by a Tech Provider: it follows the fresh-number flow. Otherwise ask the business to do the following in its Facebook Business portfolio.
Open WhatsApp accounts and select the phone number. Both PMAs (named after the BSPs) appear under Messaging accounts.
Click Conversation Routing, then Manage.
Select ODCEM or Gupshup in all the dropdowns.
The business's steps on Facebook end here.
The WABA ID (PMA ID) is pre-filled. Select the phone number and continue.
For a migration, turn on Migrate templates from another provider and enter the source WABA ID. Gupshup then copies the templates.
The Gupshup setup begins. Wait until it shows that the setup is completed.
Gupshup asks you to confirm the WABA ID and the phone number. Save both: you need them for support. When the congratulations screen appears, select Go to dashboard and check two things on the app card:
The app is marked Live, not Not live.
The Sender is the number you registered.
The app is now ready to send messages through Gupshup. It is not connected to Bitrix24 yet.
The connector is the AiApps.Pro app WhatsApp Business API Gupshup for Bitrix24 Open Channels. If the portal does not have it yet, install it from the Bitrix24 marketplace. Installation also opens a 24/7 support chat inside the portal.
In Bitrix24 open Contact Center, select the WhatsApp Business API Gupshup connector, then CONNECT. If the portal has several Open Channels, select the one you want to connect and click CONNECT again.
In a new tab open Gupshup My Wallet, click your profile icon and copy the API Key from the pop-up window. Paste it into the Gupshup API key field. How to get the API key.
Copy the phone number from the Sender field of your app on the Gupshup dashboard into the Gupshup sender field.
Click To plug. After a successful connection you see Connector connected successfully and Copy callback URL and enter it in Gupshup settings. Copy the Gupshup callback URL with the Copy button.
On the Gupshup dashboard click Overview next to the live app and open the Webhooks tab. Edit your webhook with the callback URL. If you have not created a webhook yet, enter the callback URL and select Add Webhook.
Webhook events. Gupshup lets you select checkboxes for Message events and System events. By default the Enqueued and Failed message events are on. The AiApps.Pro connector guide uses the API key from My Wallet; if the connector asks for something else, follow its on-screen instructions or write to the support chat. See Gupshup: Webhooks.
A finished registration does not prove that the channel works. This takes two minutes:
From a separate WhatsApp account, such as your own phone and not the business number, send a short message to the registered number.
Accept the message in the Open Channel in Bitrix24 and write a response. Messages are processed according to the settings of the Open Channel.
Reply from Bitrix24 and confirm that the reply arrives on the test phone.
The connector supports text messages, images, videos, voice messages, files and location coordinates.
To write to a customer first, you need an approved message template. See Gupshup: Create a message template.
This preview is visible only to the business, not to the BSP or Tech Provider. A new number has a single PMA, so there is no conversation routing configuration. After a migration, both PMAs and the routing options are shown.
These failures stop onboarding most often. Work through them in this order: the earlier ones cause the later ones.
Partners can turn off automatic approval, so the linking request may be waiting for the AiApps.Pro team to approve it. If it stays pending, contact support. If you delinked the app earlier, wait up to 24 hours before linking it again. Do not create a second app.
Check the contact email entered in Gupshup, then its spam folder. The OTP is sent to that address only, so after a typo you need to enter the corrected address.
Pop-ups are probably blocked. Gupshup opens Meta in a pop-up window, so pop-ups must be allowed in the browser. Allow them and repeat step 3. Do not close the pop-up or navigate to another page while it is open.
Check the country code and the number you entered. The number must be able to receive an SMS or a phone call; if it can receive only calls, it cannot use an IVR. Fix the line before you retry.
Your Facebook account does not have full access to it. Ask its owner to invite you as an administrator with full access, or send them the Direct Facebook Registration link so they complete the WhatsApp Business account setup.
Display names are reviewed against Meta's guidelines. A name is not accepted if it is a generic term or a generic location, suggests verification (for example Official or Verified), contains a Meta product name (WhatsApp, Facebook, Messenger), or does not match your branding on external sources such as your website. See Gupshup: Display name guidelines.
Check four things in this order: the sender in the connector matches the live number exactly; the Open Channel you are watching is the one the connector was connected to; the Gupshup webhook holds the callback URL copied from the connector and was saved; the webhook subscriptions include message events. Then send a fresh test message.
When you contact support, include the app name, the WABA ID, the test time with your time zone and which direction failed.
If the number is in the WhatsApp Business app, use Coexistence. If another provider hosts it, choose Migrate a live phone number and disable two-factor authentication for the number at the source BSP first.
Next: get the Gupshup API key, then create your first template so the business can start conversations before the customer writes.