whatsapp: Ensure Sender Phone Number Registered

Basic Information

Name

appmixer.whatsapp.phoneNumbers.EnsurePhoneNumberRegistered

Label

Ensure Sender Phone Number Registered

Version

1.0.0

Visibility

Public

Description

Idempotent registration helper for YOUR business sender phone number — checks the number's current Cloud API registration status and only calls Register if it isn't already registered. Safe to run once per onboarding flow without re-checking. Does NOT register recipients.

Input Ports

in

Field	Type	Description
WhatsApp Business Account ID	text	Select the WhatsApp Business Account (WABA). If the dropdown is empty, enter your WABA ID manually — you can find it in Meta Business Manager (business.facebook.com → Settings → Accounts → WhatsApp Accounts).
Phone Number ID	text	ID of YOUR business sender phone number to ensure is registered. Pick from the dropdown (populated when the WABA above is filled in), or paste a Phone Number ID manually.
Two-step Verification PIN	text	6-digit PIN. Used only if the number is not yet registered. For Meta test numbers this is usually `000000`; for owned business numbers it is the PIN set during phone verification.
Data Localization Region	select	Optional. ISO 3166-1 alpha-2 region code if your WABA participates in data-localization. Leave blank for global.

Output Ports

out

Field	Type	Description
Registered	boolean	-
Was Already Registered	boolean	-
Platform Type	string	-

Full Metadata

#metadata-viewer { display: none; }{ "name": "appmixer.whatsapp.phoneNumbers.EnsurePhoneNumberRegistered", "author": "Appmixer <info@appmixer.com>", "label": "Ensure Sender Phone Number Registered", "description": "Idempotent registration helper for YOUR business sender phone number — checks the number's current Cloud API registration status and only calls Register if it isn't already registered. Safe to run once per onboarding flow without re-checking. Does NOT register recipients.", "version": "1.0.0", "private": false, "auth": { "service": "appmixer:whatsapp" }, "quota": { "manager": "appmixer:whatsapp", "resources": "requests", "scope": { "userId": "{{userId}}" } }, "inPorts": [ { "name": "in", "schema": { "type": "object", "properties": { "businessAccountId": { "type": "string" }, "phoneNumberId": { "type": "string" }, "pin": { "type": "string" }, "dataLocalizationRegion": { "type": "string" } }, "required": [ "businessAccountId", "phoneNumberId", "pin" ] }, "inspector": { "inputs": { "businessAccountId": { "type": "text", "index": 1, "label": "WhatsApp Business Account ID", "tooltip": "Select the WhatsApp Business Account (WABA). If the dropdown is empty, enter your WABA ID manually — you can find it in Meta Business Manager (business.facebook.com → Settings → Accounts → WhatsApp Accounts).", "source": { "url": "/component/appmixer/whatsapp/businessAccounts/ListBusinessAccounts?outPort=out", "data": { "properties": { "isSource": true }, "transform": "./ListBusinessAccounts#toSelectArray" } } }, "phoneNumberId": { "type": "text", "index": 2, "label": "Phone Number ID", "tooltip": "ID of YOUR business sender phone number to ensure is registered. Pick from the dropdown (populated when the WABA above is filled in), or paste a Phone Number ID manually.", "source": { "url": "/component/appmixer/whatsapp/phoneNumbers/ListPhoneNumbers?outPort=out", "data": { "messages": { "in/businessAccountId": "inputs/in/businessAccountId", "in/phoneNumberId": "any", "in/pin": "any" }, "transform": "./ListPhoneNumbers#toSelectArray", "properties": { "isSource": true } } } }, "pin": { "type": "text", "index": 3, "label": "Two-step Verification PIN", "tooltip": "6-digit PIN. Used only if the number is not yet registered. For Meta test numbers this is usually <code>000000</code>; for owned business numbers it is the PIN set during phone verification." }, "dataLocalizationRegion": { "type": "select", "index": 4, "label": "Data Localization Region", "tooltip": "Optional. ISO 3166-1 alpha-2 region code if your WABA participates in data-localization. Leave blank for global.", "options": [ { "label": "(none — global)", "value": "" }, { "label": "Australia (AU)", "value": "AU" }, { "label": "Brazil (BR)", "value": "BR" }, { "label": "Germany (DE)", "value": "DE" }, { "label": "India (IN)", "value": "IN" }, { "label": "Indonesia (ID)", "value": "ID" }, { "label": "United Kingdom (GB)", "value": "GB" } ] } } } } ], "outPorts": [ { "name": "out", "schema": { "type": "object", "properties": { "registered": { "type": "boolean", "title": "Registered", "example": true }, "wasAlreadyRegistered": { "type": "boolean", "title": "Was Already Registered", "example": false }, "platformType": { "type": "string", "title": "Platform Type", "example": "CLOUD_API" } } } } ], "icon": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI2MCIgaGVpZ2h0PSI2MCIgZmlsbC1ydWxlPSJldmVub2RkIiBjbGlwLXJ1bGU9ImV2ZW5vZGQiIHZpZXdCb3g9IjAgMCA0OCA0OCI+PHBhdGggZmlsbD0iI2ZmZiIgZD0ibTQuODY4IDQzLjMwMyAyLjY5NC05LjgzNWExOC45NCAxOC45NCAwIDAgMS0yLjUzNS05LjQ4OUM1LjAzMiAxMy41MTQgMTMuNTQ4IDUgMjQuMDE0IDVhMTguODcgMTguODcgMCAwIDEgMTMuNDMgNS41NjZBMTguODcgMTguODcgMCAwIDEgNDMgMjMuOTk0Yy0uMDA0IDEwLjQ2NS04LjUyMiAxOC45OC0xOC45ODYgMTguOThoLS4wMDhhMTkgMTkgMCAwIDEtOS4wNzMtMi4zMTF6Ii8+PHBhdGggZmlsbD0iI2ZmZiIgZD0iTTQuODY4IDQzLjgwM2EuNS41IDAgMCAxLS40ODItLjYzMWwyLjYzOS05LjYzNmExOS41IDE5LjUgMCAwIDEtMi40OTctOS41NTZDNC41MzIgMTMuMjM4IDEzLjI3MyA0LjUgMjQuMDE0IDQuNWExOS4zNyAxOS4zNyAwIDAgMSAxMy43ODQgNS43MTNBMTkuMzYgMTkuMzYgMCAwIDEgNDMuNSAyMy45OTRjLS4wMDQgMTAuNzQxLTguNzQ2IDE5LjQ4LTE5LjQ4NiAxOS40OGExOS41NCAxOS41NCAwIDAgMS05LjE0NC0yLjI3N2wtOS44NzUgMi41ODlhLjUuNSAwIDAgMS0uMTI3LjAxNyIvPjxwYXRoIGZpbGw9IiNjZmQ4ZGMiIGQ9Ik0yNC4wMTQgNWExOC44NyAxOC44NyAwIDAgMSAxMy40MyA1LjU2NkExOC44NyAxOC44NyAwIDAgMSA0MyAyMy45OTRjLS4wMDQgMTAuNDY1LTguNTIyIDE4Ljk4LTE4Ljk4NiAxOC45OGgtLjAwOGExOSAxOSAwIDAgMS05LjA3My0yLjMxMWwtMTAuMDY1IDIuNjQgMi42OTQtOS44MzVhMTguOTQgMTguOTQgMCAwIDEtMi41MzUtOS40ODlDNS4wMzIgMTMuNTE0IDEzLjU0OCA1IDI0LjAxNCA1bTAtMUMxMi45OTggNCA0LjAzMiAxMi45NjIgNC4wMjcgMjMuOTc5YTIwIDIwIDAgMCAwIDIuNDYxIDkuNjIyTDMuOTAzIDQzLjA0YS45OTguOTk4IDAgMCAwIDEuMjE5IDEuMjMxbDkuNjg3LTIuNTRhMjAgMjAgMCAwIDAgOS4xOTcgMi4yNDRjMTEuMDI0IDAgMTkuOTktOC45NjMgMTkuOTk1LTE5Ljk4QTE5Ljg2IDE5Ljg2IDAgMCAwIDM4LjE1MyA5Ljg2IDE5Ljg3IDE5Ljg3IDAgMCAwIDI0LjAxNCA0Ii8+PHBhdGggZmlsbD0iIzQwYzM1MSIgZD0iTTM1LjE3NiAxMi44MzJhMTUuNjcgMTUuNjcgMCAwIDAtMTEuMTU3LTQuNjI2Yy04LjcwNCAwLTE1Ljc4MyA3LjA3Ni0xNS43ODcgMTUuNzc0YTE1Ljc0IDE1Ljc0IDAgMCAwIDIuNDEzIDguMzk2bC4zNzYuNTk3LTEuNTk1IDUuODIxIDUuOTczLTEuNTY2LjU3Ny4zNDJhMTUuNzUgMTUuNzUgMCAwIDAgOC4wMzIgMi4xOTloLjAwNmM4LjY5OCAwIDE1Ljc3Ny03LjA3NyAxNS43OC0xNS43NzZhMTUuNjggMTUuNjggMCAwIDAtNC42MTgtMTEuMTYxIi8+PHBhdGggZmlsbD0iI2ZmZiIgZD0iTTE5LjI2OCAxNi4wNDVjLS4zNTUtLjc5LS43MjktLjgwNi0xLjA2OC0uODItLjI3Ny0uMDEyLS41OTMtLjAxMS0uOTA5LS4wMTFzLS44My4xMTktMS4yNjUuNTk0LTEuNjYxIDEuNjIyLTEuNjYxIDMuOTU2IDEuNyA0LjU5IDEuOTM3IDQuOTA2IDMuMjgyIDUuMjU5IDguMTA0IDcuMTYxYzQuMDA3IDEuNTggNC44MjMgMS4yNjYgNS42OTMgMS4xODdzMi44MDctMS4xNDcgMy4yMDItMi4yNTUuMzk1LTIuMDU3LjI3Ny0yLjI1NWMtLjExOS0uMTk4LS40MzUtLjMxNi0uOTA5LS41NTRzLTIuODA3LTEuMzg1LTMuMjQyLTEuNTQzLS43NTEtLjIzNy0xLjA2OC4yMzhjLS4zMTYuNDc0LTEuMjI1IDEuNTQzLTEuNTAyIDEuODU5cy0uNTU0LjM1Ny0xLjAyOC4xMTktMi4wMDItLjczOC0zLjgxNS0yLjM1NGMtMS40MS0xLjI1Ny0yLjM2Mi0yLjgxLTIuNjM5LTMuMjg1LS4yNzctLjQ3NC0uMDMtLjczMS4yMDgtLjk2OC4yMTMtLjIxMy40NzQtLjU1NC43MTItLjgzMS4yMzctLjI3Ny4zMTYtLjQ3NS40NzQtLjc5MXMuMDc5LS41OTQtLjA0LS44MzFjLS4xMTctLjIzOC0xLjAzOS0yLjU4NC0xLjQ2MS0zLjUyMiIvPjwvc3ZnPg==" }