Workflow: Step-by-Step
A typical process for a partner to work with an API
Last updated
Was this helpful?
A typical process for a partner to work with an API
Last updated
Was this helpful?
The typical process unfolds as follows:
You'll create a demo channel specifically for your potential customers, directly within your own service, integration, or application platform.
Read more: Channel creation
Upon creating a channel, you'll receive a unique API Token. This key enables your system to manage the connected client phone via our API. Store this token in your database linked to the channel for secure, continuous access, allowing operations like messaging, participant management, and settings configuration.
You can get information about successful or unsuccessful authorization of a user via webhook. After successful authorization, it's time to tailor the channel to fit your specific needs. This involves setting up individual webhook URLs through our API for functionality.
Read more:
Dive deeper into webhook configurations and channel customization options available to you: Webhooks
It's time to connect your potential customer's phone number to the API. There are two authentication options for this: QR code or OTP (one-time password). Use the API token you saved earlier to call an endpoint that generates a QR code for the channel. Integrate this QR code as an image into your app/system. By scanning it, the customer can easily connect their phone to the gateway.
Now, integrate our WhatsApp API into your service's workflow. Use API endpoints for messaging and group management, and webhooks for real-time updates. This step varies by your service's unique logic and needs, shaping how you leverage the API to enhance your offerings.
Clients make payments directly to you (the partner), not to us. Your settlements with us occur according to our mutual agreement and typically involve prepayment. We've described more about how payment is handled here: Billing for Partners
Upon receiving payment from your client, you activate their channel, transitioning it from TRIAL
to LIVE
status using our API endpoint. This action removes any trial restrictions and ensures full functionality for your customer.
Read more: Changing channel mode
You have complete control over the channel's active duration, allocating any number of days (e.g., 1, 10, 30, 60, 180 days, etc.) based on your business model. This flexibility enables you to implement customized pricing, such as daily charges or annual subscriptions. Channel extensions are easily managed and automated via API calls.
If a client decides to discontinue using your service, you can delete their channel and reclaim any unused days back to your balance for future use. This unique feature sets us apart from competitors, ensuring you donβt lose out financially. Itβs a convenient and cost-effective way to manage your resources.
Our White Label Partner Program is designed to empower you with the tools and flexibility needed to seamlessly integrate our WhatsApp API into your offerings, ensuring both you and your clients can fully leverage the benefits of WhatsApp communication.
Read more: Channel deletion